@warp-drive-types/core-types 5.4.0-alpha.150 → 5.4.0-alpha.151

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive-types/core-types",
-  "version": "5.4.0-alpha.150",
+  "version": "5.4.0-alpha.151",
   "files": [
     "unstable-preview-types",
     "README.md",

package/unstable-preview-types/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iDAAiD,CAAC;AAIlF,QAAA,MAAM,aAAa,EAAE;IAAE,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;CAE/C,CAAC;AAOH,wBAAgB,gBAAgB,IAAI,OAAO,aAAa,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAG5D"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iDAAiD,CAAC;AAIlF,QAAA,MAAM,aAAa,EAAE;IAAE,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;CAE/C,CAAC;AAkBH,wBAAgB,gBAAgB,IAAI,OAAO,aAAa,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAG5D"}

package/unstable-preview-types/schema/fields.d.ts

@@ -17,14 +17,29 @@ declare module '@warp-drive/core-types/schema/fields' {
    * "type" points to a new-style transform on "field"
    * that a record implmentation *must* use.
    *
-   * @typedoc
+   * @class <Type> GenericField
+   * @public
    */
   export interface GenericField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'field'} kind
+       * @public
+       */
       kind: 'field';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * the name of the transform to use, if any
-       * @typedoc
+       *
+       * @property {string | undefined} type
+       * @public
        */
       type?: string;
       /**
@@ -33,7 +48,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * Must comply to the specific transform's options
        * schema.
        *
-       * @typedoc
+       * @property {ObjectValue | undefined} options
+       * @public
        */
       options?: ObjectValue;
   }
@@ -63,16 +79,36 @@ declare module '@warp-drive/core-types/schema/fields' {
    * an AliasField could be used to expose both a string and a Date version of the
    * same field, with both being capable of being written to.
    *
-   * @typedoc
+   * @class <Type> LegacyAliasField
+   * @public
    */
   export interface LegacyAliasField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'alias'} kind
+       * @public
+       */
       kind: 'alias';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
+      /**
+       * Always null (for now)
+       *
+       * @property {null} type
+       * @public
+       */
       type: null;
       /**
        * The field def for which this is an alias.
        *
-       * @typedoc
+       * @property {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField} options
+       * @public
        */
       options: GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField;
   }
@@ -102,16 +138,36 @@ declare module '@warp-drive/core-types/schema/fields' {
    * an AliasField could be used to expose both a string and a Date version of the
    * same field, with both being capable of being written to.
    *
-   * @typedoc
+   * @class <Type> PolarisAliasField
+   * @public
    */
   export interface PolarisAliasField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'alias'} kind
+       * @public
+       */
       kind: 'alias';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
+      /**
+       * Always null (for now)
+       *
+       * @property {null} type
+       * @public
+       */
       type: null;
       /**
        * The field def for which this is an alias.
        *
-       * @typedoc
+       * @property {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LinksModeBelongsToField | LinksModeHasManyField} options
+       * @public
        */
       options: GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LinksModeBelongsToField | LinksModeHasManyField;
   }
@@ -141,16 +197,36 @@ declare module '@warp-drive/core-types/schema/fields' {
    * an AliasField could be used to expose both a string and a Date version of the
    * same field, with both being capable of being written to.
    *
-   * @typedoc
+   * @class <Type> ObjectAliasField
+   * @public
    */
   export interface ObjectAliasField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'alias'} kind
+       * @public
+       */
       kind: 'alias';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
+      /**
+       * Always null (for now)
+       *
+       * @property {null} type
+       * @public
+       */
       type: null;
       /**
        * The field def for which this is an alias.
        *
-       * @typedoc
+       * @property {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField} options
+       * @public
        */
       options: GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField;
   }
@@ -166,15 +242,23 @@ declare module '@warp-drive/core-types/schema/fields' {
    * 'uuid', 'urn' or 'entityUrn' or 'primaryKey' as their
    * primary key field instead of 'id'.
    *
-   * @typedoc
+   * @class <Type> IdentityField
+   * @public
    */
   export interface IdentityField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'@id'} kind
+       * @public
+       */
       kind: '@id';
       /**
        * The name of the field that serves as the
        * primary key for the resource.
        *
-       * @typedoc
+       * @property {string} name
+       * @public
        */
       name: string;
   }
@@ -199,9 +283,16 @@ declare module '@warp-drive/core-types/schema/fields' {
    * it should be placed in the `ResourceSchema`'s `@id` field
    * in place of an `IdentityField`.
    *
-   * @typedoc
+   * @class <Type> HashField
+   * @public
    */
   export interface HashField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'@hash'} kind
+       * @public
+       */
       kind: '@hash';
       /**
        * The name of the field that serves as the
@@ -210,7 +301,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * Only required if access to this value by
        * the UI is desired, it can be `null` otherwise.
        *
-       * @typedoc
+       * @property {string | null} name
+       * @public
        */
       name: string | null;
       /**
@@ -218,14 +310,16 @@ declare module '@warp-drive/core-types/schema/fields' {
        * The function will only have access to the cached
        * data for the record.
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
        * Any options that should be provided to the hash
        * function.
        *
-       * @typedoc
+       * @property {ObjectValue | undefined} options
+       * @public
        */
       options?: ObjectValue;
   }
@@ -245,8 +339,8 @@ declare module '@warp-drive/core-types/schema/fields' {
    * For this reason Local fields should be used sparingly.
    *
    * Currently, while we document this feature here,
-   * only allow our own SchemaRecord should utilize them
-   * and the feature should be considered private.
+   * only allow our own SchemaRecord default fields to
+   * utilize them and the feature should be considered private.
    *
    * Example use cases that drove the creation of local
    * fields are states like `isDestroying` and `isDestroyed`
@@ -256,18 +350,38 @@ declare module '@warp-drive/core-types/schema/fields' {
    *
    * Don't make us regret this decision.
    *
-   * @typedoc
+   * @class <Type> LocalField
+   * @public
    */
   export interface LocalField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'@local'} kind
+       * @public
+       */
       kind: '@local';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * Not currently utilized, we are considering
        * allowing transforms to operate on local fields
        *
-       * @typedoc
+       * @property {string | undefined} type
+       * @public
        */
       type?: string;
+      /**
+       * Options for the field.
+       *
+       * @property {ObjectValue | undefined} options
+       * @public
+       */
       options?: {
           defaultValue?: PrimitiveValue;
       };
@@ -281,16 +395,30 @@ declare module '@warp-drive/core-types/schema/fields' {
    * if the key/value pairs have well-defined shape,
    * use 'schema-object' instead.
    *
-   * @typedoc
+   * @class <Type> ObjectField
+   * @public
    */
   export interface ObjectField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'object'} kind
+       * @public
+       */
       kind: 'object';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of a transform to pass the entire object
        * through before displaying or serializing it.
        *
-       * @typedoc
+       * @property {string | undefined} type
+       * @public
        */
       type?: string;
       /**
@@ -299,7 +427,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * Must comply to the specific transform's options
        * schema.
        *
-       * @typedoc
+       * @property {ObjectValue | undefined} options
+       * @public
        */
       options?: ObjectValue;
   }
@@ -311,20 +440,42 @@ declare module '@warp-drive/core-types/schema/fields' {
    * If the object's structure is not well-defined,
    * use 'object' instead.
    *
-   * @typedoc
+   * @class <Type> SchemaObjectField
+   * @public
    */
   export interface SchemaObjectField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'schema-object'} kind
+       * @public
+       */
       kind: 'schema-object';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
-       * The name of the schema that describes the
+       * The name of the ObjectSchema that describes the
        * structure of the object.
        *
-       * These schemas
-       *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
+      /**
+       * Options for configuring the behavior of the
+       * SchemaObject.
+       *
+       * - `polymorphic` : Whether this SchemaObject is Polymorphic.
+       * - `type` : If the SchemaObject is Polymorphic, the key on the raw cache data to use as the "resource-type" value for the schema-object.
+       *
+       * @property {ObjectValue | undefined} options
+       * @public
+       */
       options?: {
           /**
            * Whether this SchemaObject is Polymorphic.
@@ -352,17 +503,31 @@ declare module '@warp-drive/core-types/schema/fields' {
    * If the array's elements are not primitive
    * values, use 'schema-array' instead.
    *
-   * @typedoc
+   * @class <Type> ArrayField
+   * @public
    */
   export interface ArrayField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'array'} kind
+       * @public
+       */
       kind: 'array';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of a transform to pass each item
        * in the array through before displaying or
        * or serializing it.
        *
-       * @typedoc
+       * @property {string | undefined} type
+       * @public
        */
       type?: string;
       /**
@@ -371,7 +536,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * Must comply to the specific transform's options
        * schema.
        *
-       * @typedoc
+       * @property {ObjectValue | undefined} options
+       * @public
        */
       options?: ObjectValue;
   }
@@ -383,29 +549,61 @@ declare module '@warp-drive/core-types/schema/fields' {
    * If the array's elements are not well-defined,
    * use 'array' instead.
    *
-   * @typedoc
+   * @class <Type> SchemaArrayField
+   * @public
    */
   export interface SchemaArrayField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'schema-array'} kind
+       * @public
+       */
       kind: 'schema-array';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
-       * The name of the schema that describes the
+       * The name of the ObjectSchema that describes the
        * structure of the objects in the array.
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
        * Options for configuring the behavior of the
        * SchemaArray.
        *
-       * @typedoc
-       */
-      /**
-       * Options for configuring the behavior of the
-       * SchemaArray.
+       * - `key`
        *
-       * @typedoc
+       * Configures how the SchemaArray determines whether an object in the cache is the same
+       * as an object previously used to instantiate one of the schema-objects it contains.
+       *
+       * The default is `'@identity'`.
+       *
+       * Valid options are:
+       *
+       * - `'@identity'` (default) : the cached object's referential identity will be used.
+       *       This may result in significant instability when resource data is updated from the API
+       * - `'@index'`              : the cached object's index in the array will be used.
+       *       This is only a good choice for arrays that rarely if ever change membership
+       * - `'@hash'`               : will lookup the `@hash` function supplied in the ResourceSchema for
+       *       The contained schema-object and use the computed result to determine and compare identity.
+       * - <field-name> (string)   : the name of a field to use as the key, only GenericFields (kind `field`)
+       *       Are valid field names for this purpose. The cache state without transforms applied will be
+       *       used when comparing values. The field value should be unique enough to guarantee two schema-objects
+       *       of the same type will not collide.
+       *
+       * - `polymorphic` : Whether this SchemaArray is Polymorphic.
+       * - `type` : If the SchemaArray is Polymorphic, the key on the raw cache data to use as the "resource-type" value for the schema-object.
+       *
+       * @property {ObjectValue | undefined} options
+       * @public
        */
       options?: {
           /**
@@ -465,10 +663,23 @@ declare module '@warp-drive/core-types/schema/fields' {
    * or that require access to related resources
    * that may not be loaded should be avoided.
    *
-   * @typedoc
+   * @class <Type> DerivedField
+   * @public
    */
   export interface DerivedField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'derived'} kind
+       * @public
+       */
       kind: 'derived';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of the derivation to use.
@@ -487,7 +698,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * Derivation functions must be explicitly
        * registered with the schema service.
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
@@ -496,7 +708,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * Must comply to the specific derivation's
        * options schema.
        *
-       * @typedoc
+       * @property {ObjectValue | undefined} options
+       * @public
        */
       options?: ObjectValue;
   }
@@ -507,10 +720,23 @@ declare module '@warp-drive/core-types/schema/fields' {
    * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED
    * BY SchemaRecord
    *
-   * @typedoc
+   * @class <Type> ResourceField
+   * @public
    */
   export interface ResourceField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'resource'} kind
+       * @public
+       */
       kind: 'resource';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of the resource that this field
@@ -518,7 +744,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * relationship, this should be the trait
        * or abstract type.
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
@@ -526,7 +753,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * not present, all options are presumed
        * to be falsey
        *
-       * @typedoc
+       * @property {ObjectValue | undefined} options
+       * @public
        */
       options?: {
           /**
@@ -579,10 +807,23 @@ declare module '@warp-drive/core-types/schema/fields' {
    * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED
    * BY SchemaRecord
    *
-   * @typedoc
+   * @class <Type> CollectionField
+   * @public
    */
   export interface CollectionField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'collection'} kind
+       * @public
+       */
       kind: 'collection';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of the resource that this field
@@ -590,7 +831,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * relationship, this should be the trait
        * or abstract type.
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
@@ -669,15 +911,29 @@ declare module '@warp-drive/core-types/schema/fields' {
    * that a serializer *might* use, but their usage
    * is not guaranteed.
    *
-   * @typedoc
+   * @class <Type> LegacyAttributeField
+   * @public
    */
   export interface LegacyAttributeField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'attribute'} kind
+       * @public
+       */
       kind: 'attribute';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of the transform to use, if any
        *
-       * @typedoc
+       * @property {string | undefined | null} type
+       * @public
        */
       type?: string | null;
       /**
@@ -699,10 +955,23 @@ declare module '@warp-drive/core-types/schema/fields' {
    *
    * This is the legacy version of the `ResourceField`.
    *
-   * @typedoc
+   * @class <Type> LegacyBelongsToField
+   * @public
    */
   export interface LegacyBelongsToField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'belongsTo'} kind
+       * @public
+       */
       kind: 'belongsTo';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of the resource that this field
@@ -710,7 +979,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * relationship, this should be the trait
        * or abstract type.
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
@@ -819,10 +1089,23 @@ declare module '@warp-drive/core-types/schema/fields' {
    *
    * This is the legacy version of the `ResourceField`.
    *
-   * @typedoc
+   * @class <Type> LinksModeBelongsToField
+   * @public
    */
   export interface LinksModeBelongsToField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'belongsTo'} kind
+       * @public
+       */
       kind: 'belongsTo';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
       /**
        * The name of the resource that this field
@@ -830,7 +1113,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * relationship, this should be the trait
        * or abstract type.
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
@@ -938,11 +1222,33 @@ declare module '@warp-drive/core-types/schema/fields' {
    *
    * This is the legacy version of the `CollectionField`.
    *
-   * @typedoc
+   * @class <Type> LegacyHasManyField
+   * @public
    */
   export interface LegacyHasManyField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'hasMany'} kind
+       * @public
+       */
       kind: 'hasMany';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
+      /**
+       * the name of the resource that this field
+       * refers to. In the case of a polymorphic
+       * relationship, this should be the trait
+       * or abstract type.
+       *
+       * @property {string} type
+       * @public
+       */
       type: string;
       /**
        * Options for hasMany are mandatory.
@@ -1055,11 +1361,33 @@ declare module '@warp-drive/core-types/schema/fields' {
    *
    * This is the legacy version of the `CollectionField`.
    *
-   * @typedoc
+   * @class <Type> LinksModeHasManyField
+   * @public
    */
   export interface LinksModeHasManyField {
+      /**
+       * The kind of field this is.
+       *
+       * @property {'hasMany'} kind
+       * @public
+       */
       kind: 'hasMany';
+      /**
+       * The name of the field.
+       *
+       * @property {string} name
+       * @public
+       */
       name: string;
+      /**
+       * the name of the resource that this field
+       * refers to. In the case of a polymorphic
+       * relationship, this should be the trait
+       * or abstract type.
+       *
+       * @property {string} type
+       * @public
+       */
       type: string;
       /**
        * Options for hasMany are mandatory.
@@ -1172,13 +1500,46 @@ declare module '@warp-drive/core-types/schema/fields' {
   /**
    * A union of all possible LegacyMode field schemas.
    *
-   * @typedoc
+   * Available field schemas are:
+   *
+   * - [GenericField](../classes/<Type>%20GenericField)
+   * - [LegacyAliasField](../classes/<Type>%20LegacyAliasField)
+   * - [LocalField](../classes/<Type>%20LocalField)
+   * - [ObjectField](../classes/<Type>%20ObjectField)
+   * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)
+   * - [ArrayField](../classes/<Type>%20ArrayField)
+   * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)
+   * - [DerivedField](../classes/<Type>%20DerivedField)
+   * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)
+   * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)
+   * - [LegacyAttributeField](../classes/<Type>%20LegacyAttributeField)
+   * - [LegacyBelongsToField](../classes/<Type>%20LegacyBelongsToField)
+   * - [LegacyHasManyField](../classes/<Type>%20LegacyHasManyField)
+   *
+   * @class <Type> LegacyModeFieldSchema
+   * @public
    */
   export type LegacyModeFieldSchema = GenericField | LegacyAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField;
   /**
    * A union of all possible PolarisMode field schemas.
    *
-   * @typedoc
+   * Available field schemas are:
+   *
+   * - [GenericField](../classes/<Type>%20GenericField)
+   * - [PolarisAliasField](../classes/<Type>%20PolarisAliasField)
+   * - [LocalField](../classes/<Type>%20LocalField)
+   * - [ObjectField](../classes/<Type>%20ObjectField)
+   * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)
+   * - [ArrayField](../classes/<Type>%20ArrayField)
+   * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)
+   * - [DerivedField](../classes/<Type>%20DerivedField)
+   * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)
+   * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)
+   * - [LinksModeBelongsToField](../classes/<Type>%20LinksModeBelongsToField)
+   * - [LinksModeHasManyField](../classes/<Type>%20LinksModeHasManyField)
+   *
+   * @class <Type> PolarisModeFieldSchema
+   * @public
    */
   export type PolarisModeFieldSchema = GenericField | PolarisAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField | LinksModeBelongsToField | LinksModeHasManyField;
   /**
@@ -1190,14 +1551,16 @@ declare module '@warp-drive/core-types/schema/fields' {
    * as appropriate as they are more specific and will
    * provide better guidance around what is valid.
    *
-   * @typedoc
+   * @class <Type> FieldSchema
+   * @public
    */
   export type FieldSchema = GenericField | LegacyAliasField | PolarisAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField | ResourceField | CollectionField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField | LinksModeBelongsToField | LinksModeHasManyField;
   /**
    * A union of all possible field schemas that can be
    * used in an ObjectSchema.
    *
-   * @typedoc
+   * @class <Type> ObjectFieldSchema
+   * @public
    */
   export type ObjectFieldSchema = GenericField | ObjectAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField;
   /**
@@ -1207,7 +1570,8 @@ declare module '@warp-drive/core-types/schema/fields' {
    * own which may allow them to appear in relationships, or in multiple
    * response documents.
    *
-   * @typedoc
+   * @class <Type> PolarisResourceSchema
+   * @public
    */
   export interface PolarisResourceSchema {
       legacy?: false;
@@ -1216,7 +1580,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        *
        * for schema-objects, this should be either a HashField or null
        *
-       * @typedoc
+       * @property {IdentityField} identity
+       * @public
        */
       identity: IdentityField;
       /**
@@ -1238,13 +1603,15 @@ declare module '@warp-drive/core-types/schema/fields' {
        * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`
        * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
        * The fields that make up the shape of the resource
        *
-       * @typedoc
+       * @property {PolarisModeFieldSchema[]} fields
+       * @public
        */
       fields: PolarisModeFieldSchema[];
       /**
@@ -1255,7 +1622,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * resource schema. The trait can be abstract and reference a resource
        * type that is never defined as a schema.
        *
-       * @typedoc
+       * @property {string[]} traits
+       * @public
        */
       traits?: string[];
   }
@@ -1266,16 +1634,26 @@ declare module '@warp-drive/core-types/schema/fields' {
    * own which may allow them to appear in relationships, or in multiple
    * response documents.
    *
-   * @typedoc
+   * @class <Type> LegacyResourceSchema
+   * @public
    */
   export interface LegacyResourceSchema {
+      /**
+       * A flag indicating that this is a legacy resource schema
+       *
+       * @property {true} legacy
+       * @public
+       */
       legacy: true;
       /**
-       * For primary resources, this should be an IdentityField
+       * This should be an IdentityField.
        *
-       * for schema-objects, this should be either a HashField or null
+       * To maximize compatibility with Model where `id` was the
+       * name of the identity field, we recommend using `{ kind: '@id', name: 'id' }`
+       * for records in legacy mode, but this is not required.
        *
-       * @typedoc
+       * @property {IdentityField} identity
+       * @public
        */
       identity: IdentityField;
       /**
@@ -1284,9 +1662,6 @@ declare module '@warp-drive/core-types/schema/fields' {
        * For cacheable resources, this should be the
        * primary resource type.
        *
-       * For object schemas, this should be the name
-       * of the object schema.
-       *
        * The names of object and resource schemas share
        * a single namespace and must not conflict.
        *
@@ -1297,13 +1672,15 @@ declare module '@warp-drive/core-types/schema/fields' {
        * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`
        * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
        * The fields that make up the shape of the resource
        *
-       * @typedoc
+       * @property {LegacyModeFieldSchema[]} fields
+       * @public
        */
       fields: LegacyModeFieldSchema[];
       /**
@@ -1314,7 +1691,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * resource schema. The trait can be abstract and reference a resource
        * type that is never defined as a schema.
        *
-       * @typedoc
+       * @property {string[]} traits
+       * @public
        */
       traits?: string[];
   }
@@ -1336,7 +1714,8 @@ declare module '@warp-drive/core-types/schema/fields' {
    *
    * ObjectSchemas may not currently contain relationships.
    *
-   * @typedoc
+   * @class <Type> ObjectSchema
+   * @public
    */
   export interface ObjectSchema {
       /**
@@ -1346,7 +1725,8 @@ declare module '@warp-drive/core-types/schema/fields' {
        * on the referential identity of the object in the cache itself
        * when an identity is needed.
        *
-       * @typedoc
+       * @property {HashField | null} identity
+       * @public
        */
       identity: HashField | null;
       /**
@@ -1362,13 +1742,15 @@ declare module '@warp-drive/core-types/schema/fields' {
        * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`
        * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`
        *
-       * @typedoc
+       * @property {string} type
+       * @public
        */
       type: string;
       /**
        * The fields that make up the shape of the object
        *
-       * @typedoc
+       * @property {ObjectFieldSchema[]} fields
+       * @public
        */
       fields: ObjectFieldSchema[];
   }
@@ -1387,7 +1769,7 @@ declare module '@warp-drive/core-types/schema/fields' {
    * @static
    * @for @warp-drive/core-types
    * @param {ResourceSchema} schema
-   * @returns {ResourceSchema} the passed in schema
+   * @return {ResourceSchema} the passed in schema
    * @public
    */
   export function resourceSchema<T extends ResourceSchema>(schema: T): T;
@@ -1401,7 +1783,7 @@ declare module '@warp-drive/core-types/schema/fields' {
    * @static
    * @for @warp-drive/core-types
    * @param {ObjectSchema} schema
-   * @returns {ObjectSchema} the passed in schema
+   * @return {ObjectSchema} the passed in schema
    * @public
    */
   export function objectSchema<T extends ObjectSchema>(schema: T): T;
@@ -1412,7 +1794,7 @@ declare module '@warp-drive/core-types/schema/fields' {
    * @static
    * @for @warp-drive/core-types
    * @param schema
-   * @returns {boolean}
+   * @return {boolean}
    * @public
    */
   export function isResourceSchema(schema: ResourceSchema | ObjectSchema): schema is ResourceSchema;
@@ -1423,7 +1805,7 @@ declare module '@warp-drive/core-types/schema/fields' {
    * @static
    * @for @warp-drive/core-types
    * @param schema
-   * @returns {boolean}
+   * @return {boolean}
    * @public
    */
   export function isLegacyResourceSchema(schema: ResourceSchema | ObjectSchema): schema is LegacyResourceSchema;

package/unstable-preview-types/schema/fields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/schema/fields.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE/D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC;IAEX;;;;OAIG;IACH,OAAO,EACH,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAGhB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC;IAEX;;;;OAIG;IACH,OAAO,EACH,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAGhB,uBAAuB,GACvB,qBAAqB,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC;IAEX;;;;OAIG;IACH,OAAO,EAAE,YAAY,GAAG,WAAW,GAAG,iBAAiB,GAAG,UAAU,GAAG,gBAAgB,CAAC;CACzF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,KAAK,CAAC;IAEZ;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,cAAc,CAAA;KAAE,CAAC;CAC7C;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,CAAC,EAAE;QACR;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IAEH;;;;;OAKG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,GAAG,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;QAEhD;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;;;;WASG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;;;;;;;WASG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;;;;;;;WASG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;;;;;;WAWG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,SAAS,CAAC,EAAE,IAAI,CAAC;QAEjB;;;;;;;;;;;;WAYG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;KAC7B,CAAC;CACH;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;WAMG;QACH,KAAK,EAAE,KAAK,CAAC;QAEb;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;QACH,SAAS,EAAE,IAAI,CAAC;QAEhB;;;;;;;;;;;;;;WAcG;QACH,mBAAmB,EAAE,KAAK,CAAC;KAC5B,CAAC;CACH;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;;;;;;;;;;;WAgBG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,SAAS,CAAC,EAAE,IAAI,CAAC;QAEjB;;;;;;;;;;;;WAYG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;KAC7B,CAAC;CACH;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;;;;;;;;;;;;;WAkBG;QACH,KAAK,EAAE,KAAK,CAAC;QAEb;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;QACH,SAAS,EAAE,IAAI,CAAC;QAEhB;;;;;;;;;;;;;;WAcG;QACH,mBAAmB,EAAE,KAAK,CAAC;KAC5B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,GAGZ,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,CAAC;AAEvB;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAC9B,YAAY,GACZ,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,GAGZ,uBAAuB,GACvB,qBAAqB,CAAC;AAE1B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,GACnB,YAAY,GACZ,gBAAgB,GAChB,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,GACZ,aAAa,GACb,eAAe,GACf,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,qBAAqB,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GACzB,YAAY,GACZ,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,CAAC;AAEjB;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf;;;;;;OAMG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,sBAAsB,EAAE,CAAC;IAEjC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,IAAI,CAAC;IAEb;;;;;;OAMG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,qBAAqB,EAAE,CAAC;IAEhC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG,oBAAoB,CAAC;AAE1E;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;OAQG;IACH,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC;IAE3B;;;;;;;;;;;;;;OAcG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,iBAAiB,EAAE,CAAC;CAC7B;AAED,MAAM,MAAM,MAAM,GAAG,cAAc,GAAG,YAAY,CAAC;AAEnD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAErE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,YAAY,GAAG,MAAM,IAAI,cAAc,CAEhG;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,cAAc,GAAG,YAAY,GAAG,MAAM,IAAI,oBAAoB,CAE5G;AAED,MAAM,MAAM,WAAW,GACnB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,qBAAqB,CAAC;AAC1B,MAAM,MAAM,uBAAuB,GAC/B,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,qBAAqB,CAAC"}
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/schema/fields.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE/D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;OAKG;IACH,OAAO,EACH,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAGhB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;OAKG;IACH,OAAO,EACH,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAGhB,uBAAuB,GACvB,qBAAqB,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;OAKG;IACH,OAAO,EAAE,YAAY,GAAG,WAAW,GAAG,iBAAiB,GAAG,UAAU,GAAG,gBAAgB,CAAC;CACzF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;OAKG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,cAAc,CAAA;KAAE,CAAC;CAC7C;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,IAAI,EAAE,eAAe,CAAC;IAEtB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,GAAG,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;QAEhD;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;;;;WASG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;;;;;;;WASG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;;;;;;;WASG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;;;;;;WAWG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,SAAS,CAAC,EAAE,IAAI,CAAC;QAEjB;;;;;;;;;;;;WAYG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;KAC7B,CAAC;CACH;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;WAMG;QACH,KAAK,EAAE,KAAK,CAAC;QAEb;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;QACH,SAAS,EAAE,IAAI,CAAC;QAEhB;;;;;;;;;;;;;;WAcG;QACH,mBAAmB,EAAE,KAAK,CAAC;KAC5B,CAAC;CACH;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;;;;;;;;;;;WAgBG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,SAAS,CAAC,EAAE,IAAI,CAAC;QAEjB;;;;;;;;;;;;WAYG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;KAC7B,CAAC;CACH;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE;QACP;;;;;;;;;;;;;;;;;;WAkBG;QACH,KAAK,EAAE,KAAK,CAAC;QAEb;;;;;;;;;WASG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;QACH,SAAS,EAAE,IAAI,CAAC;QAEhB;;;;;;;;;;;;;;WAcG;QACH,mBAAmB,EAAE,KAAK,CAAC;KAC5B,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,GAGZ,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,sBAAsB,GAC9B,YAAY,GACZ,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,GAGZ,uBAAuB,GACvB,qBAAqB,CAAC;AAE1B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,GACnB,YAAY,GACZ,gBAAgB,GAChB,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,GACZ,aAAa,GACb,eAAe,GACf,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,qBAAqB,CAAC;AAE1B;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GACzB,YAAY,GACZ,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,gBAAgB,GAChB,YAAY,CAAC;AAEjB;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf;;;;;;;OAOG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,MAAM,EAAE,sBAAsB,EAAE,CAAC;IAEjC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,MAAM,EAAE,IAAI,CAAC;IAEb;;;;;;;;;OASG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,MAAM,EAAE,qBAAqB,EAAE,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG,oBAAoB,CAAC;AAE1E;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;OASG;IACH,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,MAAM,EAAE,iBAAiB,EAAE,CAAC;CAC7B;AAED,MAAM,MAAM,MAAM,GAAG,cAAc,GAAG,YAAY,CAAC;AAEnD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAErE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,YAAY,GAAG,MAAM,IAAI,cAAc,CAEhG;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,cAAc,GAAG,YAAY,GAAG,MAAM,IAAI,oBAAoB,CAE5G;AAED,MAAM,MAAM,WAAW,GACnB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,qBAAqB,CAAC;AAC1B,MAAM,MAAM,uBAAuB,GAC/B,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,qBAAqB,CAAC"}