@aws-amplify/data-schema 1.9.2 → 1.10.0

package/src/ModelType.ts

@@ -6,10 +6,10 @@ import {
 } from './util';
 import type { InternalField, BaseModelField } from './ModelField';
 import type {
-  ModelRelationalField,
-  InternalRelationalField,
-  ModelRelationalFieldParamShape,
-} from './ModelRelationalField';
+  ModelRelationshipField,
+  InternalRelationshipField,
+  ModelRelationshipFieldParamShape,
+} from './ModelRelationshipField';
 import { type AllowModifier, type Authorization, allow } from './Authorization';
 import type { RefType, RefTypeParamShape } from './RefType';
 import type { EnumType } from './EnumType';
@@ -32,7 +32,7 @@ export type deferredRefResolvingPrefix = 'deferredRefResolving:';
 type ModelFields = Record<
   string,
   | BaseModelField
-  | ModelRelationalField<any, string, any, any>
+  | ModelRelationshipField<any, string, any, any>
   | RefType<any, any, any>
   | EnumType
   | CustomType<CustomTypeParamShape>
@@ -40,7 +40,7 @@ type ModelFields = Record<
 
 type InternalModelFields = Record<
   string,
-  InternalField | InternalRelationalField
+  InternalField | InternalRelationshipField
 >;
 
 export type DisableOperationsOptions =
@@ -168,7 +168,7 @@ export type AddRelationshipFieldsToModelTypeFields<
   Model,
   RelationshipFields extends Record<
     string,
-    ModelRelationalField<ModelRelationalFieldParamShape, string, any, any>
+    ModelRelationshipField<ModelRelationshipFieldParamShape, string, any, any>
   >,
 > =
   Model extends ModelType<
@@ -217,6 +217,12 @@ export type BaseModelType<T extends ModelTypeParamShape = ModelTypeParamShape> =
 
 export type UsableModelTypeKey = methodKeyOf<ModelType>;
 
+/**
+ * Model type definition interface
+ *
+ * @param T - The shape of the model type
+ * @param UsedMethod - The method keys already defined
+ */
 export type ModelType<
   T extends ModelTypeParamShape = ModelTypeParamShape,
   UsedMethod extends UsableModelTypeKey = never,
@@ -299,7 +305,7 @@ export type SchemaModelType<
       relationships<
         Param extends Record<
           string,
-          ModelRelationalField<any, string, any, any>
+          ModelRelationshipField<any, string, any, any>
         > = Record<never, never>,
       >(
         relationships: Param,
@@ -385,6 +391,13 @@ export const isSchemaModelType = (
   );
 };
 
+/**
+ * Model default identifier
+ *
+ * @param pk - primary key
+ * @param sk - secondary key
+ * @param compositeSk - composite secondary key
+ */
 export type ModelDefaultIdentifier = {
   pk: { readonly id: string };
   sk: never;

package/src/RefType.ts

@@ -26,6 +26,12 @@ export type RefTypeParamShape = {
 
 type MutationOperations = 'create' | 'update' | 'delete';
 
+/**
+ * Reference type definition interface
+ *
+ * @param T - The shape of the reference type
+ * @param K - The keys already defined
+ */
 export type RefType<
   T extends RefTypeParamShape,
   K extends keyof RefType<T> = never,

package/src/SchemaProcessor.ts

@@ -9,8 +9,8 @@ import {
 } from './ModelField';
 import {
   ModelRelationshipTypes,
-  type InternalRelationalField,
-} from './ModelRelationalField';
+  type InternalRelationshipField,
+} from './ModelRelationshipField';
 import type { InternalModel, DisableOperationsOptions } from './ModelType';
 import type { InternalModelIndexType } from './ModelIndex';
 import {
@@ -44,7 +44,7 @@ import {
   type CustomHandler,
   type SqlReferenceHandler,
   FunctionHandler,
-  AsyncFunctionHandler
+  AsyncFunctionHandler,
 } from './Handler';
 import * as os from 'os';
 import * as path from 'path';
@@ -61,7 +61,7 @@ import {
 type ScalarFieldDef = Exclude<InternalField['data'], { fieldType: 'model' }>;
 
 type ModelFieldDef = Extract<
-  InternalRelationalField['data'],
+  InternalRelationshipField['data'],
   { fieldType: 'model' }
 >;
 
@@ -301,10 +301,12 @@ function transformFunctionHandler(
     } else if (typeof handlerData.handler.getInstance === 'function') {
       const fnName = `Fn${capitalize(functionFieldName)}${idx === 0 ? '' : `${idx + 1}`}`;
       lambdaFunctionDefinition[fnName] = handlerData.handler;
-      const invocationTypeArg = handlerData.invocationType === 'Event' ? ', invocationType: Event)' : ')'
+      const invocationTypeArg =
+        handlerData.invocationType === 'Event'
+          ? ', invocationType: Event)'
+          : ')';
       gqlHandlerContent += `@function(name: "${fnName}"${invocationTypeArg} `;
-    }
-    else {
+    } else {
       throw new Error(
         `Invalid value specified for ${functionFieldName} handler.function(). Expected: defineFunction or string.`,
       );
@@ -1299,13 +1301,18 @@ const schemaPreprocessor = (
   // This is done here so that:
   // - it only happens once per schema
   // - downstream validation based on `getRefTypeForSchema` finds the EventInvocationResponse type
-  const containsAsyncLambdaCustomOperation = Object.entries(schema.data.types).find(([_, typeDef]) => {
-    return isCustomOperation(typeDef)
-    && finalHandlerIsAsyncFunctionHandler(typeDef.data.handlers);
+  const containsAsyncLambdaCustomOperation = Object.entries(
+    schema.data.types,
+  ).find(([_, typeDef]) => {
+    return (
+      isCustomOperation(typeDef) &&
+      finalHandlerIsAsyncFunctionHandler(typeDef.data.handlers)
+    );
   });
 
   if (containsAsyncLambdaCustomOperation) {
-    schema.data.types['EventInvocationResponse'] = eventInvocationResponseCustomType;
+    schema.data.types['EventInvocationResponse'] =
+      eventInvocationResponseCustomType;
   }
 
   const topLevelTypes = sortTopLevelTypes(Object.entries(schema.data.types));
@@ -1442,7 +1449,10 @@ const schemaPreprocessor = (
         }
       } else if (isConversationRoute(typeDef)) {
         // TODO: add inferenceConfiguration values to directive.
-        const { field, functionHandler } = createConversationField(typeDef, typeName);
+        const { field, functionHandler } = createConversationField(
+          typeDef,
+          typeName,
+        );
         customMutations.push(field);
         Object.assign(lambdaFunctions, functionHandler);
         shouldAddConversationTypes = true;
@@ -1629,7 +1639,11 @@ function validateCustomOperations(
   ) {
     // TODO: There should be a more elegant and readable way to handle this check.
     // Maybe it's not even necessary anymore since we're the setting returnType in the handler() method.
-    if (!handlers || handlers.length === 0 || handlers[handlers.length - 1][brandSymbol] !== 'asyncFunctionHandler') {
+    if (
+      !handlers ||
+      handlers.length === 0 ||
+      handlers[handlers.length - 1][brandSymbol] !== 'asyncFunctionHandler'
+    ) {
       const typeDescription =
         opType === 'Generation' ? 'Generation Route' : `Custom ${opType}`;
       throw new Error(
@@ -1721,14 +1735,20 @@ const isCustomHandler = (
 const isFunctionHandler = (
   handler: HandlerType[] | null,
 ): handler is (FunctionHandler | AsyncFunctionHandler)[] => {
-  return Array.isArray(handler) && ['functionHandler', 'asyncFunctionHandler'].includes(getBrand(handler[0]));
+  return (
+    Array.isArray(handler) &&
+    ['functionHandler', 'asyncFunctionHandler'].includes(getBrand(handler[0]))
+  );
 };
 
 const finalHandlerIsAsyncFunctionHandler = (
   handler: HandlerType[] | null,
 ): handler is AsyncFunctionHandler[] => {
-  return Array.isArray(handler) && getBrand(handler[handler.length - 1]) === 'asyncFunctionHandler';
-}
+  return (
+    Array.isArray(handler) &&
+    getBrand(handler[handler.length - 1]) === 'asyncFunctionHandler'
+  );
+};
 
 const normalizeDataSourceName = (
   dataSource: undefined | string | RefType<any, any, any>,
@@ -1820,11 +1840,11 @@ const eventInvocationResponseCustomType = {
           required: true,
           array: false,
           arrayRequired: false,
-        }
-      }
+        },
+      },
     },
-    type: 'customType'
-  }
+    type: 'customType',
+  },
 };
 
 function transformCustomOperations(
@@ -1988,8 +2008,8 @@ function validateRelationships(
     );
 
     // Validate that the references defined in the relationship follow the
-    // relational definition rules.
-    validateRelationalReferences(relationship);
+    // relationship definition rules.
+    validateRelationshipReferences(relationship);
   }
 }
 
@@ -2024,7 +2044,7 @@ function describeConnectFieldRelationship(
  * Validates that the types of child model's reference fields match the types of the parent model's identifier fields.
  * @param relationship The {@link ModelRelationship} to validate.
  */
-function validateRelationalReferences(relationship: ModelRelationship) {
+function validateRelationshipReferences(relationship: ModelRelationship) {
   const {
     parent,
     parentConnectionField,
@@ -2101,7 +2121,7 @@ type ConnectionField = {
 /**
  * An internal representation of a model relationship used by validation functions.
  * Use {@link getModelRelationship} to create this.
- * See {@link validateRelationalReferences} for validation example.
+ * See {@link validateRelationshipReferences} for validation example.
  */
 type ModelRelationship = {
   /**
@@ -2212,7 +2232,7 @@ function getAssociatedConnectionField(
 
     // In order to find that associated connection field, we need to do some validation that we'll depend on further downstream.
     // 1. Field type matches the source model's type.
-    // 2. A valid counterpart relational modifier is defined on the field. See `associatedRelationshipTypes` for more information.
+    // 2. A valid counterpart relationship modifier is defined on the field. See `associatedRelationshipTypes` for more information.
     // 3. The reference arguments provided to the field match (element count + string comparison) references passed to the source connection field.
     return (
       connectionField.data.relatedModel === sourceModelName &&

package/src/a.ts

@@ -18,7 +18,7 @@ import {
   ipAddress,
 } from './ModelField';
 import { ref } from './RefType';
-import { hasOne, hasMany, belongsTo } from './ModelRelationalField';
+import { hasOne, hasMany, belongsTo } from './ModelRelationshipField';
 import { customType } from './CustomType';
 import { enumType } from './EnumType';
 import { query, mutation, subscription, generation } from './CustomOperation';

package/src/index.ts

@@ -4,3 +4,17 @@ import { ClientSchema } from './ClientSchema';
 export { a };
 
 export type { ClientSchema };
+
+export type { Authorization } from './Authorization';
+export type { CustomOperation } from './CustomOperation';
+export type { ModelField, Nullable, Json } from './ModelField';
+export type { ModelSchema } from './ModelSchema';
+export type { ModelType, ModelDefaultIdentifier } from './ModelType';
+export type { RefType } from './RefType';
+export type { CustomType } from './CustomType';
+export type {
+  ModelRelationshipField,
+  ModelRelationshipTypes,
+  ModelRelationshipTypeArgFactory,
+} from './ModelRelationshipField';
+export type { EnumType } from './EnumType';

package/src/runtime/client/index.ts

@@ -48,7 +48,7 @@ type Model = Record<string, any>;
 /**
  * Currently this omits any object-type fields. Update this when we add custom types/enums.
  */
-type NonRelationalFields<M extends Model> = {
+type NonRelationshipFields<M extends Model> = {
   [Field in keyof M as UnwrapArray<M[Field]> extends Record<string, unknown>
     ? never
     : Field]: M[Field];
@@ -166,7 +166,11 @@ type DeepPickFromPath<
       : Path extends `${infer Head}.${infer Tail}`
         ? Head extends keyof FlatModel
           ? Tail extends '*'
-            ? { [k in Head]: NonRelationalFields<UnwrapArray<FlatModel[Head]>> }
+            ? {
+                [k in Head]: NonRelationshipFields<
+                  UnwrapArray<FlatModel[Head]>
+                >;
+              }
             : { [k in Head]: DeepPickFromPath<FlatModel[Head], Tail> }
           : never
         : Path extends keyof FlatModel
@@ -275,7 +279,7 @@ type ResolvedModel<
   Depth extends number = 7,
   RecursionLoop extends number[] = [-1, 0, 1, 2, 3, 4, 5, 6],
 > = {
-  done: NonRelationalFields<Model>;
+  done: NonRelationshipFields<Model>;
   recur: {
     [Field in keyof Model]: Model[Field] extends (
       ...args: any

package/src/runtime/internals/APIClient.ts

@@ -207,7 +207,7 @@ export function initializeModel(
     if (record === null || record === undefined) {
       return record;
     }
-    const initializedRelationalFields: Record<string, any> = {};
+    const initializedRelationshipFields: Record<string, any> = {};
     for (const fieldName of modelFields) {
       const modelField = introModelFields[fieldName];
       const modelFieldType = modelField?.type as ModelFieldType;
@@ -255,7 +255,7 @@ export function initializeModel(
           }
 
           if (context) {
-            initializedRelationalFields[fieldName] = (
+            initializedRelationshipFields[fieldName] = (
               contextSpec: AmplifyServer.ContextSpec,
               options?: LazyLoadOptions,
             ) => {
@@ -276,7 +276,7 @@ export function initializeModel(
               return { data: null };
             };
           } else {
-            initializedRelationalFields[fieldName] = (
+            initializedRelationshipFields[fieldName] = (
               options?: LazyLoadOptions,
             ) => {
               if (record[targetNames[0]]) {
@@ -347,7 +347,7 @@ export function initializeModel(
             }
 
             if (context) {
-              initializedRelationalFields[fieldName] = (
+              initializedRelationshipFields[fieldName] = (
                 contextSpec: AmplifyServer.ContextSpec,
                 options?: LazyLoadOptions,
               ) => {
@@ -373,7 +373,7 @@ export function initializeModel(
                 return [];
               };
             } else {
-              initializedRelationalFields[fieldName] = (
+              initializedRelationshipFields[fieldName] = (
                 options?: LazyLoadOptions,
               ) => {
                 if (record[parentPk]) {
@@ -418,7 +418,7 @@ export function initializeModel(
           }
 
           if (context) {
-            initializedRelationalFields[fieldName] = (
+            initializedRelationshipFields[fieldName] = (
               contextSpec: AmplifyServer.ContextSpec,
               options?: LazyLoadOptions,
             ) => {
@@ -444,7 +444,7 @@ export function initializeModel(
               return [];
             };
           } else {
-            initializedRelationalFields[fieldName] = (
+            initializedRelationshipFields[fieldName] = (
               options?: LazyLoadOptions,
             ) => {
               if (record[parentPk]) {
@@ -477,7 +477,7 @@ export function initializeModel(
       }
     }
 
-    return { ...record, ...initializedRelationalFields };
+    return { ...record, ...initializedRelationshipFields };
   });
 }
 

package/dist/cjs/ModelRelationalField.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModelRelationalField.js","sources":["../../src/ModelRelationalField.ts"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.belongsTo = exports.hasMany = exports.hasOne = exports.ModelRelationshipTypes = exports.__auth = void 0;\nconst Authorization_1 = require(\"./Authorization\");\n/**\n * Used to \"attach\" auth types to ModelField without exposing them on the builder.\n */\nexports.__auth = Symbol('__auth');\nconst brandName = 'modelRelationalField';\nvar ModelRelationshipTypes;\n(function (ModelRelationshipTypes) {\n    ModelRelationshipTypes[\"hasOne\"] = \"hasOne\";\n    ModelRelationshipTypes[\"hasMany\"] = \"hasMany\";\n    ModelRelationshipTypes[\"belongsTo\"] = \"belongsTo\";\n})(ModelRelationshipTypes || (exports.ModelRelationshipTypes = ModelRelationshipTypes = {}));\nconst relationalModifiers = [\n    'required',\n    'valueRequired',\n    'authorization',\n];\nconst relationModifierMap = {\n    belongsTo: ['authorization'],\n    hasMany: ['valueRequired', 'authorization'],\n    hasOne: ['required', 'authorization'],\n};\nfunction _modelRelationalField(type, relatedModel, references) {\n    const data = {\n        relatedModel,\n        type,\n        fieldType: 'model',\n        array: false,\n        valueRequired: false,\n        arrayRequired: false,\n        references,\n        authorization: [],\n    };\n    data.array = type === 'hasMany';\n    const relationshipBuilderFunctions = {\n        required() {\n            data.arrayRequired = true;\n            return this;\n        },\n        valueRequired() {\n            data.valueRequired = true;\n            return this;\n        },\n        authorization(callback) {\n            const rules = callback(Authorization_1.allow);\n            data.authorization = Array.isArray(rules) ? rules : [rules];\n            return this;\n        },\n    };\n    const builder = Object.fromEntries(relationModifierMap[type].map((key) => [\n        key,\n        relationshipBuilderFunctions[key],\n    ]));\n    return {\n        ...builder,\n        data,\n    };\n}\n/**\n * Create one-to-one relationship between two models using the `hasOne(\"MODEL_NAME\", \"REFERENCE_FIELD(s)\")` method.\n * A hasOne relationship always uses a reference to the related model's identifier. Typically this is the `id` field\n * unless overwritten with the `identifier()` method.\n * @example\n * const schema = a.schema({\n *   Cart: a.model({\n *     items: a.string().required().array(),\n *     // 1. Create reference field\n *     customerId: a.id(),\n *     // 2. Create relationship field with the reference field\n *     customer: a.belongsTo('Customer', 'customerId'),\n *   }),\n *   Customer: a.model({\n *     name: a.string(),\n *     // 3. Create relationship field with the reference field\n *     //    from the Cart model\n *     activeCart: a.hasOne('Cart', 'customerId')\n *   }),\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/data-modeling/relationships/#model-a-one-to-one-relationship}\n * @param relatedModel the name of the related model\n * @param references the field(s) that should be used to reference the related model\n * @returns a one-to-one relationship definition\n */\nfunction hasOne(relatedModel, references) {\n    return _modelRelationalField(ModelRelationshipTypes.hasOne, relatedModel, Array.isArray(references) ? references : [references]);\n}\nexports.hasOne = hasOne;\n/**\n * Create a one-directional one-to-many relationship between two models using the `hasMany(\"MODEL_NAME\", \"REFERENCE_FIELD(s)\")` method.\n * @example\n * const schema = a.schema({\n *   Member: a.model({\n *     name: a.string().required(),\n *     // 1. Create a reference field\n *     teamId: a.id(),\n *     // 2. Create a belongsTo relationship with the reference field\n *     team: a.belongsTo('Team', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n *\n *   Team: a.model({\n *     mantra: a.string().required(),\n *     // 3. Create a hasMany relationship with the reference field\n *     //    from the `Member`s model.\n *     members: a.hasMany('Member', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/data-modeling/relationships/#model-one-to-many-relationships}\n * @param relatedModel the name of the related model\n * @param references the field(s) that should be used to reference the related model\n * @returns a one-to-many relationship definition\n */\nfunction hasMany(relatedModel, references) {\n    return _modelRelationalField(ModelRelationshipTypes.hasMany, relatedModel, Array.isArray(references) ? references : [references]);\n}\nexports.hasMany = hasMany;\n/**\n * Use `belongsTo()` to create a field to query the related `hasOne()` or `hasMany()` relationship.\n * The belongsTo() method requires that a hasOne() or hasMany() relationship already exists from\n * parent to the related model.\n *\n * @example\n * // one-to-many relationship\n * const schema = a.schema({\n *   Member: a.model({\n *     name: a.string().required(),\n *     // 1. Create a reference field\n *     teamId: a.id(),\n *     // 2. Create a belongsTo relationship with the reference field\n *     team: a.belongsTo('Team', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n *\n *   Team: a.model({\n *     mantra: a.string().required(),\n *     // 3. Create a hasMany relationship with the reference field\n *     //    from the `Member`s model.\n *     members: a.hasMany('Member', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n * });\n * @example\n * // one-to-one relationship\n * const schema = a.schema({\n *   Cart: a.model({\n *     items: a.string().required().array(),\n *     // 1. Create reference field\n *     customerId: a.id(),\n *     // 2. Create relationship field with the reference field\n *     customer: a.belongsTo('Customer', 'customerId'),\n *   }),\n *   Customer: a.model({\n *     name: a.string(),\n *     // 3. Create relationship field with the reference field\n *     //    from the Cart model\n *     activeCart: a.hasOne('Cart', 'customerId')\n *   }),\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/data-modeling/relationships/}\n * @param relatedModel name of the related `.hasOne()` or `.hasMany()` model\n * @param references the field(s) that should be used to reference the related model\n * @returns a belong-to relationship definition\n */\nfunction belongsTo(relatedModel, references) {\n    return _modelRelationalField(ModelRelationshipTypes.belongsTo, relatedModel, Array.isArray(references) ? references : [references]);\n}\nexports.belongsTo = belongsTo;\n"],"names":[],"mappings":";;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9D,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,sBAAsB,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;AAChH,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACnD;AACA;AACA;AACA,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AAElC,IAAI,sBAAsB,CAAC;AAC3B,CAAC,UAAU,sBAAsB,EAAE;AACnC,IAAI,sBAAsB,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAChD,IAAI,sBAAsB,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAClD,IAAI,sBAAsB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;AACtD,CAAC,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,GAAG,sBAAsB,GAAG,EAAE,CAAC,CAAC,CAAC;AAM7F,MAAM,mBAAmB,GAAG;AAC5B,IAAI,SAAS,EAAE,CAAC,eAAe,CAAC;AAChC,IAAI,OAAO,EAAE,CAAC,eAAe,EAAE,eAAe,CAAC;AAC/C,IAAI,MAAM,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC;AACzC,CAAC,CAAC;AACF,SAAS,qBAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE;AAC/D,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,YAAY;AACpB,QAAQ,IAAI;AACZ,QAAQ,SAAS,EAAE,OAAO;AAC1B,QAAQ,KAAK,EAAE,KAAK;AACpB,QAAQ,aAAa,EAAE,KAAK;AAC5B,QAAQ,aAAa,EAAE,KAAK;AAC5B,QAAQ,UAAU;AAClB,QAAQ,aAAa,EAAE,EAAE;AACzB,KAAK,CAAC;AACN,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,SAAS,CAAC;AACpC,IAAI,MAAM,4BAA4B,GAAG;AACzC,QAAQ,QAAQ,GAAG;AACnB,YAAY,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;AACtC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,GAAG;AACxB,YAAY,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;AACtC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAY,MAAM,KAAK,GAAG,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;AAC1D,YAAY,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;AACxE,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,KAAK,CAAC;AACN,IAAI,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK;AAC9E,QAAQ,GAAG;AACX,QAAQ,4BAA4B,CAAC,GAAG,CAAC;AACzC,KAAK,CAAC,CAAC,CAAC;AACR,IAAI,OAAO;AACX,QAAQ,GAAG,OAAO;AAClB,QAAQ,IAAI;AACZ,KAAK,CAAC;AACN,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE;AAC1C,IAAI,OAAO,qBAAqB,CAAC,sBAAsB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACrI,CAAC;AACD,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;AACxB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,OAAO,CAAC,YAAY,EAAE,UAAU,EAAE;AAC3C,IAAI,OAAO,qBAAqB,CAAC,sBAAsB,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACtI,CAAC;AACD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,SAAS,CAAC,YAAY,EAAE,UAAU,EAAE;AAC7C,IAAI,OAAO,qBAAqB,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACxI,CAAC;AACD,OAAO,CAAC,SAAS,GAAG,SAAS;;"}

package/dist/esm/ModelRelationalField.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModelRelationalField.mjs","sources":["../../src/ModelRelationalField.ts"],"sourcesContent":["import { allow } from './Authorization';\n/**\n * Used to \"attach\" auth types to ModelField without exposing them on the builder.\n */\nexport const __auth = Symbol('__auth');\nconst brandName = 'modelRelationalField';\nexport var ModelRelationshipTypes;\n(function (ModelRelationshipTypes) {\n    ModelRelationshipTypes[\"hasOne\"] = \"hasOne\";\n    ModelRelationshipTypes[\"hasMany\"] = \"hasMany\";\n    ModelRelationshipTypes[\"belongsTo\"] = \"belongsTo\";\n})(ModelRelationshipTypes || (ModelRelationshipTypes = {}));\nconst relationalModifiers = [\n    'required',\n    'valueRequired',\n    'authorization',\n];\nconst relationModifierMap = {\n    belongsTo: ['authorization'],\n    hasMany: ['valueRequired', 'authorization'],\n    hasOne: ['required', 'authorization'],\n};\nfunction _modelRelationalField(type, relatedModel, references) {\n    const data = {\n        relatedModel,\n        type,\n        fieldType: 'model',\n        array: false,\n        valueRequired: false,\n        arrayRequired: false,\n        references,\n        authorization: [],\n    };\n    data.array = type === 'hasMany';\n    const relationshipBuilderFunctions = {\n        required() {\n            data.arrayRequired = true;\n            return this;\n        },\n        valueRequired() {\n            data.valueRequired = true;\n            return this;\n        },\n        authorization(callback) {\n            const rules = callback(allow);\n            data.authorization = Array.isArray(rules) ? rules : [rules];\n            return this;\n        },\n    };\n    const builder = Object.fromEntries(relationModifierMap[type].map((key) => [\n        key,\n        relationshipBuilderFunctions[key],\n    ]));\n    return {\n        ...builder,\n        data,\n    };\n}\n/**\n * Create one-to-one relationship between two models using the `hasOne(\"MODEL_NAME\", \"REFERENCE_FIELD(s)\")` method.\n * A hasOne relationship always uses a reference to the related model's identifier. Typically this is the `id` field\n * unless overwritten with the `identifier()` method.\n * @example\n * const schema = a.schema({\n *   Cart: a.model({\n *     items: a.string().required().array(),\n *     // 1. Create reference field\n *     customerId: a.id(),\n *     // 2. Create relationship field with the reference field\n *     customer: a.belongsTo('Customer', 'customerId'),\n *   }),\n *   Customer: a.model({\n *     name: a.string(),\n *     // 3. Create relationship field with the reference field\n *     //    from the Cart model\n *     activeCart: a.hasOne('Cart', 'customerId')\n *   }),\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/data-modeling/relationships/#model-a-one-to-one-relationship}\n * @param relatedModel the name of the related model\n * @param references the field(s) that should be used to reference the related model\n * @returns a one-to-one relationship definition\n */\nexport function hasOne(relatedModel, references) {\n    return _modelRelationalField(ModelRelationshipTypes.hasOne, relatedModel, Array.isArray(references) ? references : [references]);\n}\n/**\n * Create a one-directional one-to-many relationship between two models using the `hasMany(\"MODEL_NAME\", \"REFERENCE_FIELD(s)\")` method.\n * @example\n * const schema = a.schema({\n *   Member: a.model({\n *     name: a.string().required(),\n *     // 1. Create a reference field\n *     teamId: a.id(),\n *     // 2. Create a belongsTo relationship with the reference field\n *     team: a.belongsTo('Team', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n *\n *   Team: a.model({\n *     mantra: a.string().required(),\n *     // 3. Create a hasMany relationship with the reference field\n *     //    from the `Member`s model.\n *     members: a.hasMany('Member', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/data-modeling/relationships/#model-one-to-many-relationships}\n * @param relatedModel the name of the related model\n * @param references the field(s) that should be used to reference the related model\n * @returns a one-to-many relationship definition\n */\nexport function hasMany(relatedModel, references) {\n    return _modelRelationalField(ModelRelationshipTypes.hasMany, relatedModel, Array.isArray(references) ? references : [references]);\n}\n/**\n * Use `belongsTo()` to create a field to query the related `hasOne()` or `hasMany()` relationship.\n * The belongsTo() method requires that a hasOne() or hasMany() relationship already exists from\n * parent to the related model.\n *\n * @example\n * // one-to-many relationship\n * const schema = a.schema({\n *   Member: a.model({\n *     name: a.string().required(),\n *     // 1. Create a reference field\n *     teamId: a.id(),\n *     // 2. Create a belongsTo relationship with the reference field\n *     team: a.belongsTo('Team', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n *\n *   Team: a.model({\n *     mantra: a.string().required(),\n *     // 3. Create a hasMany relationship with the reference field\n *     //    from the `Member`s model.\n *     members: a.hasMany('Member', 'teamId'),\n *   })\n *   .authorization(allow => [allow.publicApiKey()]),\n * });\n * @example\n * // one-to-one relationship\n * const schema = a.schema({\n *   Cart: a.model({\n *     items: a.string().required().array(),\n *     // 1. Create reference field\n *     customerId: a.id(),\n *     // 2. Create relationship field with the reference field\n *     customer: a.belongsTo('Customer', 'customerId'),\n *   }),\n *   Customer: a.model({\n *     name: a.string(),\n *     // 3. Create relationship field with the reference field\n *     //    from the Cart model\n *     activeCart: a.hasOne('Cart', 'customerId')\n *   }),\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/data-modeling/relationships/}\n * @param relatedModel name of the related `.hasOne()` or `.hasMany()` model\n * @param references the field(s) that should be used to reference the related model\n * @returns a belong-to relationship definition\n */\nexport function belongsTo(relatedModel, references) {\n    return _modelRelationalField(ModelRelationshipTypes.belongsTo, relatedModel, Array.isArray(references) ? references : [references]);\n}\n"],"names":[],"mappings":";;AACA;AACA;AACA;AACY,MAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE;AAE7B,IAAC,uBAAuB;AAClC,CAAC,UAAU,sBAAsB,EAAE;AACnC,IAAI,sBAAsB,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAChD,IAAI,sBAAsB,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAClD,IAAI,sBAAsB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;AACtD,CAAC,EAAE,sBAAsB,KAAK,sBAAsB,GAAG,EAAE,CAAC,CAAC,CAAC;AAM5D,MAAM,mBAAmB,GAAG;AAC5B,IAAI,SAAS,EAAE,CAAC,eAAe,CAAC;AAChC,IAAI,OAAO,EAAE,CAAC,eAAe,EAAE,eAAe,CAAC;AAC/C,IAAI,MAAM,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC;AACzC,CAAC,CAAC;AACF,SAAS,qBAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE;AAC/D,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,YAAY;AACpB,QAAQ,IAAI;AACZ,QAAQ,SAAS,EAAE,OAAO;AAC1B,QAAQ,KAAK,EAAE,KAAK;AACpB,QAAQ,aAAa,EAAE,KAAK;AAC5B,QAAQ,aAAa,EAAE,KAAK;AAC5B,QAAQ,UAAU;AAClB,QAAQ,aAAa,EAAE,EAAE;AACzB,KAAK,CAAC;AACN,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,SAAS,CAAC;AACpC,IAAI,MAAM,4BAA4B,GAAG;AACzC,QAAQ,QAAQ,GAAG;AACnB,YAAY,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;AACtC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,GAAG;AACxB,YAAY,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;AACtC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAY,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC1C,YAAY,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;AACxE,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,KAAK,CAAC;AACN,IAAI,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK;AAC9E,QAAQ,GAAG;AACX,QAAQ,4BAA4B,CAAC,GAAG,CAAC;AACzC,KAAK,CAAC,CAAC,CAAC;AACR,IAAI,OAAO;AACX,QAAQ,GAAG,OAAO;AAClB,QAAQ,IAAI;AACZ,KAAK,CAAC;AACN,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE;AACjD,IAAI,OAAO,qBAAqB,CAAC,sBAAsB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACrI,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,OAAO,CAAC,YAAY,EAAE,UAAU,EAAE;AAClD,IAAI,OAAO,qBAAqB,CAAC,sBAAsB,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACtI,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,SAAS,CAAC,YAAY,EAAE,UAAU,EAAE;AACpD,IAAI,OAAO,qBAAqB,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACxI;;;;"}