deviceEvoluSchema - API reference

API reference › @evolu/common › local‑first/Auth › deviceEvoluSchema

const deviceEvoluSchema: {
  _evolu_appOwner: {
    id: BrandType<
      BrandType<
        Type<
          "String",
          string,
          string,
          TypeOfError<"String">,
          null,
          TypeOfError<"String">,
          never,
          string,
          true
        >,
        "Id",
        IdError
      >,
      "OwnerId",
      never
    >;
    lastOpenedAt: UnionType<
      readonly [
        BrandType<
          Type<
            "String",
            string,
            string,
            TypeOfError<"String">,
            null,
            TypeOfError<"String">,
            never,
            string,
            true
          >,
          "DateIso",
          DateIsoError
        >,
        LiteralType<null>,
      ]
    >;
    name: UnionType<
      readonly [
        BrandType<
          BrandType<
            BrandType<
              Type<
                "String",
                string,
                string,
                TypeOfError<"String">,
                null,
                TypeOfError<"String">,
                never,
                string,
                true
              >,
              "Trimmed",
              TrimmedError
            >,
            "MinLength1",
            MinLengthError<1>
          >,
          "MaxLength100",
          MaxLengthError<100>
        >,
        LiteralType<null>,
      ]
    >;
    secret: BrandType<
      UnionType<
        readonly [
          BrandType<
            BrandType<
              Type<
                "Uint8Array",
                Uint8Array<ArrayBufferLike>,
                Uint8Array<ArrayBufferLike>,
                ObjectTagError<"Uint8Array">,
                null,
                ObjectTagError<"Uint8Array">,
                never,
                Uint8Array<ArrayBufferLike>,
                true
              >,
              "Entropy",
              never
            >,
            "Length16",
            LengthError<16>
          >,
          BrandType<
            BrandType<
              Type<
                "Uint8Array",
                Uint8Array<ArrayBufferLike>,
                Uint8Array<ArrayBufferLike>,
                ObjectTagError<"Uint8Array">,
                null,
                ObjectTagError<"Uint8Array">,
                never,
                Uint8Array<ArrayBufferLike>,
                true
              >,
              "Entropy",
              never
            >,
            "Length20",
            LengthError<20>
          >,
          BrandType<
            BrandType<
              Type<
                "Uint8Array",
                Uint8Array<ArrayBufferLike>,
                Uint8Array<ArrayBufferLike>,
                ObjectTagError<"Uint8Array">,
                null,
                ObjectTagError<"Uint8Array">,
                never,
                Uint8Array<ArrayBufferLike>,
                true
              >,
              "Entropy",
              never
            >,
            "Length24",
            LengthError<24>
          >,
          BrandType<
            BrandType<
              Type<
                "Uint8Array",
                Uint8Array<ArrayBufferLike>,
                Uint8Array<ArrayBufferLike>,
                ObjectTagError<"Uint8Array">,
                null,
                ObjectTagError<"Uint8Array">,
                never,
                Uint8Array<ArrayBufferLike>,
                true
              >,
              "Entropy",
              never
            >,
            "Length28",
            LengthError<28>
          >,
          BrandType<
            BrandType<
              Type<
                "Uint8Array",
                Uint8Array<ArrayBufferLike>,
                Uint8Array<ArrayBufferLike>,
                ObjectTagError<"Uint8Array">,
                null,
                ObjectTagError<"Uint8Array">,
                never,
                Uint8Array<ArrayBufferLike>,
                true
              >,
              "Entropy",
              never
            >,
            "Length32",
            LengthError<32>
          >,
        ]
      >,
      "OwnerSecret",
      never
    >;
  };
};

Defined in: packages/common/src/local-first/Auth.ts:315

Evolu's tables of the device database. Its table and column names are permanent once shipped.

Type Declaration

Name	Type	Default value	Defined in
`_evolu_appOwner`	{ `id`: `BrandType`<`BrandType`<`Type`<`"String"`, `string`, `string`, `TypeOfError`<`"String"`>, `null`, `TypeOfError`<`"String"`>, `never`, `string`, `true`>, `"Id"`, `IdError`>, `"OwnerId"`, `never`>; `lastOpenedAt`: `UnionType`<readonly [`BrandType`<`Type`<`"String"`, `string`, `string`, `TypeOfError`<`"String"`>, `null`, `TypeOfError`<`"String"`>, `never`, `string`, `true`>, `"DateIso"`, `DateIsoError`>, `LiteralType`<`null`>]>; `name`: `UnionType`<readonly [`BrandType`<`BrandType`<`BrandType`<`Type`<`"String"`, `string`, `string`, `TypeOfError`<`"String"`>, `null`, `TypeOfError`<`"String"`>, `never`, `string`, `true`>, `"Trimmed"`, `TrimmedError`>, `"MinLength1"`, `MinLengthError`<`1`>>, `"MaxLength100"`, `MaxLengthError`<`100`>>, `LiteralType`<`null`>]>; `secret`: `BrandType`<`UnionType`<readonly [`BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length16"`, `LengthError`<`16`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length20"`, `LengthError`<`20`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length24"`, `LengthError`<`24`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length28"`, `LengthError`<`28`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length32"`, `LengthError`<`32`>>]>, `"OwnerSecret"`, `never`>; }	-	packages/common/src/local-first/Auth.ts:316
`_evolu_appOwner.id`	`BrandType`<`BrandType`<`Type`<`"String"`, `string`, `string`, `TypeOfError`<`"String"`>, `null`, `TypeOfError`<`"String"`>, `never`, `string`, `true`>, `"Id"`, `IdError`>, `"OwnerId"`, `never`>	`OwnerId`	packages/common/src/local-first/Auth.ts:317
`_evolu_appOwner.lastOpenedAt`	`UnionType`<readonly [`BrandType`<`Type`<`"String"`, `string`, `string`, `TypeOfError`<`"String"`>, `null`, `TypeOfError`<`"String"`>, `never`, `string`, `true`>, `"DateIso"`, `DateIsoError`>, `LiteralType`<`null`>]>	-	packages/common/src/local-first/Auth.ts:320
`_evolu_appOwner.name`	`UnionType`<readonly [`BrandType`<`BrandType`<`BrandType`<`Type`<`"String"`, `string`, `string`, `TypeOfError`<`"String"`>, `null`, `TypeOfError`<`"String"`>, `never`, `string`, `true`>, `"Trimmed"`, `TrimmedError`>, `"MinLength1"`, `MinLengthError`<`1`>>, `"MaxLength100"`, `MaxLengthError`<`100`>>, `LiteralType`<`null`>]>	-	packages/common/src/local-first/Auth.ts:319
`_evolu_appOwner.secret`	`BrandType`<`UnionType`<readonly [`BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length16"`, `LengthError`<`16`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length20"`, `LengthError`<`20`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length24"`, `LengthError`<`24`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length28"`, `LengthError`<`28`>>, `BrandType`<`BrandType`<`Type`<`"Uint8Array"`, `Uint8Array`<`ArrayBufferLike`>, `Uint8Array`<`ArrayBufferLike`>, `ObjectTagError`<`"Uint8Array"`>, `null`, `ObjectTagError`<`"Uint8Array"`>, `never`, `Uint8Array`<`ArrayBufferLike`>, `true`>, `"Entropy"`, `never`>, `"Length32"`, `LengthError`<`32`>>]>, `"OwnerSecret"`, `never`>	`OwnerSecret`	packages/common/src/local-first/Auth.ts:318