@aws-amplify/data-schema 1.9.2 → 1.10.1

package/dist/cjs/{ModelRelationalField.js → ModelRelationshipField.js}

@@ -7,6 +7,9 @@ const Authorization_1 = require("./Authorization");
  * Used to "attach" auth types to ModelField without exposing them on the builder.
  */
 exports.__auth = Symbol('__auth');
+/**
+ * Model relationship types
+ */
 var ModelRelationshipTypes;
 (function (ModelRelationshipTypes) {
     ModelRelationshipTypes["hasOne"] = "hasOne";
@@ -18,7 +21,7 @@ const relationModifierMap = {
     hasMany: ['valueRequired', 'authorization'],
     hasOne: ['required', 'authorization'],
 };
-function _modelRelationalField(type, relatedModel, references) {
+function _modelRelationshipField(type, relatedModel, references) {
     const data = {
         relatedModel,
         type,
@@ -80,7 +83,7 @@ function _modelRelationalField(type, relatedModel, references) {
  * @returns a one-to-one relationship definition
  */
 function hasOne(relatedModel, references) {
-    return _modelRelationalField(ModelRelationshipTypes.hasOne, relatedModel, Array.isArray(references) ? references : [references]);
+    return _modelRelationshipField(ModelRelationshipTypes.hasOne, relatedModel, Array.isArray(references) ? references : [references]);
 }
 exports.hasOne = hasOne;
 /**
@@ -110,7 +113,7 @@ exports.hasOne = hasOne;
  * @returns a one-to-many relationship definition
  */
 function hasMany(relatedModel, references) {
-    return _modelRelationalField(ModelRelationshipTypes.hasMany, relatedModel, Array.isArray(references) ? references : [references]);
+    return _modelRelationshipField(ModelRelationshipTypes.hasMany, relatedModel, Array.isArray(references) ? references : [references]);
 }
 exports.hasMany = hasMany;
 /**
@@ -161,7 +164,7 @@ exports.hasMany = hasMany;
  * @returns a belong-to relationship definition
  */
 function belongsTo(relatedModel, references) {
-    return _modelRelationalField(ModelRelationshipTypes.belongsTo, relatedModel, Array.isArray(references) ? references : [references]);
+    return _modelRelationshipField(ModelRelationshipTypes.belongsTo, relatedModel, Array.isArray(references) ? references : [references]);
 }
 exports.belongsTo = belongsTo;
-//# sourceMappingURL=ModelRelationalField.js.map
+//# sourceMappingURL=ModelRelationshipField.js.map

package/dist/cjs/ModelRelationshipField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelRelationshipField.js","sources":["../../src/ModelRelationshipField.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 = 'modelRelationshipField';\n/**\n * Model relationship types\n */\nvar ModelRelationshipTypes;\n(function (ModelRelationshipTypes) {\n    ModelRelationshipTypes[\"hasOne\"] = \"hasOne\";\n    ModelRelationshipTypes[\"hasMany\"] = \"hasMany\";\n    ModelRelationshipTypes[\"belongsTo\"] = \"belongsTo\";\n})(ModelRelationshipTypes || (exports.ModelRelationshipTypes = ModelRelationshipTypes = {}));\nconst relationshipModifiers = [\n    'required',\n    'valueRequired',\n    'authorization',\n];\nconst relationModifierMap = {\n    belongsTo: ['authorization'],\n    hasMany: ['valueRequired', 'authorization'],\n    hasOne: ['required', 'authorization'],\n};\nfunction _modelRelationshipField(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 _modelRelationshipField(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 _modelRelationshipField(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 _modelRelationshipField(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;AACA;AACA;AACA,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,uBAAuB,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE;AACjE,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,uBAAuB,CAAC,sBAAsB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACvI,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,uBAAuB,CAAC,sBAAsB,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACxI,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,uBAAuB,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AAC1I,CAAC;AACD,OAAO,CAAC,SAAS,GAAG,SAAS;;"}

package/dist/cjs/SchemaProcessor.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.processSchema = void 0;
 const tslib_1 = require("tslib");
 const ModelField_1 = require("./ModelField");
-const ModelRelationalField_1 = require("./ModelRelationalField");
+const ModelRelationshipField_1 = require("./ModelRelationshipField");
 const Authorization_1 = require("./Authorization");
 const CustomOperation_1 = require("./CustomOperation");
 const util_1 = require("./util");
@@ -163,7 +163,9 @@ function transformFunctionHandler(handlers, functionFieldName) {
         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 {
@@ -842,11 +844,12 @@ const schemaPreprocessor = (schema) => {
     // - 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);
+        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));
     const { schemaAuth, functionSchemaAccess } = extractFunctionSchemaAccess(schema.data.authorization);
@@ -1024,7 +1027,9 @@ function validateCustomOperations(typeDef, typeName, authRules, getRefType) {
         (opType === 'Query' || opType === 'Mutation' || opType === 'Generation')) {
         // 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][Brand_1.brandSymbol] !== 'asyncFunctionHandler') {
+        if (!handlers ||
+            handlers.length === 0 ||
+            handlers[handlers.length - 1][Brand_1.brandSymbol] !== 'asyncFunctionHandler') {
             const typeDescription = opType === 'Generation' ? 'Generation Route' : `Custom ${opType}`;
             throw new Error(`Invalid ${typeDescription} definition. A ${typeDescription} must include a return type. ${typeName} has no return type specified.`);
         }
@@ -1082,10 +1087,12 @@ const isCustomHandler = (handler) => {
     return Array.isArray(handler) && (0, util_1.getBrand)(handler[0]) === 'customHandler';
 };
 const isFunctionHandler = (handler) => {
-    return Array.isArray(handler) && ['functionHandler', 'asyncFunctionHandler'].includes((0, util_1.getBrand)(handler[0]));
+    return (Array.isArray(handler) &&
+        ['functionHandler', 'asyncFunctionHandler'].includes((0, util_1.getBrand)(handler[0])));
 };
 const finalHandlerIsAsyncFunctionHandler = (handler) => {
-    return Array.isArray(handler) && (0, util_1.getBrand)(handler[handler.length - 1]) === 'asyncFunctionHandler';
+    return (Array.isArray(handler) &&
+        (0, util_1.getBrand)(handler[handler.length - 1]) === 'asyncFunctionHandler');
 };
 const normalizeDataSourceName = (dataSource) => {
     // default data source
@@ -1148,11 +1155,11 @@ const eventInvocationResponseCustomType = {
                     required: true,
                     array: false,
                     arrayRequired: false,
-                }
-            }
+                },
+            },
         },
-        type: 'customType'
-    }
+        type: 'customType',
+    },
 };
 function transformCustomOperations(typeDef, typeName, authRules, databaseType, getRefType) {
     const { typeName: opType, handlers } = typeDef.data;
@@ -1244,8 +1251,8 @@ function validateRelationships(typeName, record, getInternalModel) {
         // Create a structure representing the relationship for validation.
         const relationship = getModelRelationship(typeName, { name: name, def: field.data }, getInternalModel);
         // Validate that the references defined in the relationship follow the
-        // relational definition rules.
-        validateRelationalReferences(relationship);
+        // relationship definition rules.
+        validateRelationshipReferences(relationship);
     }
 }
 /**
@@ -1271,7 +1278,7 @@ function describeConnectFieldRelationship(sourceField, sourceModelName) {
  * 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) {
+function validateRelationshipReferences(relationship) {
     const { parent, parentConnectionField, child, childConnectionField, references, } = relationship;
     const parentIdentifiers = getIndentifierTypes(parent);
     const childReferenceTypes = [];
@@ -1326,11 +1333,11 @@ function validateRelationalReferences(relationship) {
  */
 function associatedRelationshipTypes(relationshipType) {
     switch (relationshipType) {
-        case ModelRelationalField_1.ModelRelationshipTypes.hasOne:
-        case ModelRelationalField_1.ModelRelationshipTypes.hasMany:
-            return [ModelRelationalField_1.ModelRelationshipTypes.belongsTo];
-        case ModelRelationalField_1.ModelRelationshipTypes.belongsTo:
-            return [ModelRelationalField_1.ModelRelationshipTypes.hasOne, ModelRelationalField_1.ModelRelationshipTypes.hasMany];
+        case ModelRelationshipField_1.ModelRelationshipTypes.hasOne:
+        case ModelRelationshipField_1.ModelRelationshipTypes.hasMany:
+            return [ModelRelationshipField_1.ModelRelationshipTypes.belongsTo];
+        case ModelRelationshipField_1.ModelRelationshipTypes.belongsTo:
+            return [ModelRelationshipField_1.ModelRelationshipTypes.hasOne, ModelRelationshipField_1.ModelRelationshipTypes.hasMany];
         default:
             return []; // TODO: Remove this case on types are updated.
     }
@@ -1378,7 +1385,7 @@ function getAssociatedConnectionField(sourceModelName, sourceConnectionField, as
         }
         // 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 &&
             associatedRelationshipOptions.includes(connectionField.data.type) &&
@@ -1427,8 +1434,8 @@ function getModelRelationship(sourceModelName, sourceModelConnectionField, getIn
     const associatedModel = getInternalModel(sourceModelConnectionField.def.relatedModel, sourceModelName);
     const relatedModelConnectionField = getAssociatedConnectionField(sourceModelName, sourceModelConnectionField, associatedModel);
     switch (sourceModelConnectionField.def.type) {
-        case ModelRelationalField_1.ModelRelationshipTypes.hasOne:
-        case ModelRelationalField_1.ModelRelationshipTypes.hasMany:
+        case ModelRelationshipField_1.ModelRelationshipTypes.hasOne:
+        case ModelRelationshipField_1.ModelRelationshipTypes.hasMany:
             return {
                 parent: sourceModel,
                 parentConnectionField: sourceModelConnectionField,
@@ -1436,7 +1443,7 @@ function getModelRelationship(sourceModelName, sourceModelConnectionField, getIn
                 childConnectionField: relatedModelConnectionField,
                 references: sourceModelConnectionField.def.references,
             };
-        case ModelRelationalField_1.ModelRelationshipTypes.belongsTo:
+        case ModelRelationshipField_1.ModelRelationshipTypes.belongsTo:
             return {
                 parent: associatedModel,
                 parentConnectionField: relatedModelConnectionField,