@aws-amplify/data-schema 1.3.10 → 1.4.0

package/dist/cjs/ModelType.js

@@ -12,6 +12,7 @@ function _model(fields) {
         identifier: ['id'],
         secondaryIndexes: [],
         authorization: [],
+        disabledOperations: [],
     };
     const builder = {
         identifier(identifier) {
@@ -22,6 +23,10 @@ function _model(fields) {
             data.secondaryIndexes = callback(ModelIndex_1.modelIndex);
             return this;
         },
+        disableOperations(ops) {
+            data.disabledOperations = ops;
+            return this;
+        },
         authorization(callback) {
             const { resource: _, ...rest } = Authorization_1.allow;
             const rules = callback(rest);

package/dist/cjs/ModelType.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelType.js","sources":["../../src/ModelType.ts"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.model = exports.isSchemaModelType = void 0;\nconst util_1 = require(\"./util\");\nconst Authorization_1 = require(\"./Authorization\");\nconst ModelIndex_1 = require(\"./ModelIndex\");\nconst brandName = 'modelType';\nfunction _model(fields) {\n    const data = {\n        fields,\n        identifier: ['id'],\n        secondaryIndexes: [],\n        authorization: [],\n    };\n    const builder = {\n        identifier(identifier) {\n            data.identifier = identifier;\n            return this;\n        },\n        secondaryIndexes(callback) {\n            data.secondaryIndexes = callback(ModelIndex_1.modelIndex);\n            return this;\n        },\n        authorization(callback) {\n            const { resource: _, ...rest } = Authorization_1.allow;\n            const rules = callback(rest);\n            data.authorization = Array.isArray(rules) ? rules : [rules];\n            return this;\n        },\n        ...(0, util_1.brand)(brandName),\n    };\n    return {\n        ...builder,\n        data,\n        relationships(relationships) {\n            data.fields = { ...data.fields, ...relationships };\n        },\n        fields: data.fields,\n    };\n}\n/**\n * Model Type type guard\n * @param modelType - api-next ModelType\n * @returns true if the given value is a ModelSchema\n */\nconst isSchemaModelType = (modelType) => {\n    const internalType = modelType;\n    return (typeof internalType === 'object' &&\n        internalType.data !== undefined &&\n        internalType.data.fields !== undefined &&\n        internalType.data.authorization !== undefined &&\n        internalType.data.identifier !== undefined &&\n        internalType.data.secondaryIndexes !== undefined &&\n        typeof internalType.relationships === 'function');\n};\nexports.isSchemaModelType = isSchemaModelType;\n/**\n * A data model that creates a matching Amazon DynamoDB table and provides create, read (list and get), update,\n * delete, and subscription APIs.\n *\n * @param fields database table fields. Supports scalar types and relationship types.\n * @returns a data model definition\n */\nfunction model(fields) {\n    return _model(fields);\n}\nexports.model = model;\n"],"names":[],"mappings":";;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9D,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,iBAAiB,GAAG,KAAK,CAAC,CAAC;AACnD,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AACjC,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACnD,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAC7C,MAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,SAAS,MAAM,CAAC,MAAM,EAAE;AACxB,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,MAAM;AACd,QAAQ,UAAU,EAAE,CAAC,IAAI,CAAC;AAC1B,QAAQ,gBAAgB,EAAE,EAAE;AAC5B,QAAQ,aAAa,EAAE,EAAE;AACzB,KAAK,CAAC;AACN,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,UAAU,CAAC,UAAU,EAAE;AAC/B,YAAY,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;AACzC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,gBAAgB,CAAC,QAAQ,EAAE;AACnC,YAAY,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AACtE,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAY,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC;AACnE,YAAY,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACzC,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,QAAQ,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC;AACvC,KAAK,CAAC;AACN,IAAI,OAAO;AACX,QAAQ,GAAG,OAAO;AAClB,QAAQ,IAAI;AACZ,QAAQ,aAAa,CAAC,aAAa,EAAE;AACrC,YAAY,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,aAAa,EAAE,CAAC;AAC/D,SAAS;AACT,QAAQ,MAAM,EAAE,IAAI,CAAC,MAAM;AAC3B,KAAK,CAAC;AACN,CAAC;AACD;AACA;AACA;AACA;AACA;AACA,MAAM,iBAAiB,GAAG,CAAC,SAAS,KAAK;AACzC,IAAI,MAAM,YAAY,GAAG,SAAS,CAAC;AACnC,IAAI,QAAQ,OAAO,YAAY,KAAK,QAAQ;AAC5C,QAAQ,YAAY,CAAC,IAAI,KAAK,SAAS;AACvC,QAAQ,YAAY,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS;AAC9C,QAAQ,YAAY,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS;AACrD,QAAQ,YAAY,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS;AAClD,QAAQ,YAAY,CAAC,IAAI,CAAC,gBAAgB,KAAK,SAAS;AACxD,QAAQ,OAAO,YAAY,CAAC,aAAa,KAAK,UAAU,EAAE;AAC1D,CAAC,CAAC;AACF,OAAO,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AAC9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,KAAK,CAAC,MAAM,EAAE;AACvB,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AACD,OAAO,CAAC,KAAK,GAAG,KAAK;;"}
+{"version":3,"file":"ModelType.js","sources":["../../src/ModelType.ts"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.model = exports.isSchemaModelType = void 0;\nconst util_1 = require(\"./util\");\nconst Authorization_1 = require(\"./Authorization\");\nconst ModelIndex_1 = require(\"./ModelIndex\");\nconst brandName = 'modelType';\nfunction _model(fields) {\n    const data = {\n        fields,\n        identifier: ['id'],\n        secondaryIndexes: [],\n        authorization: [],\n        disabledOperations: [],\n    };\n    const builder = {\n        identifier(identifier) {\n            data.identifier = identifier;\n            return this;\n        },\n        secondaryIndexes(callback) {\n            data.secondaryIndexes = callback(ModelIndex_1.modelIndex);\n            return this;\n        },\n        disableOperations(ops) {\n            data.disabledOperations = ops;\n            return this;\n        },\n        authorization(callback) {\n            const { resource: _, ...rest } = Authorization_1.allow;\n            const rules = callback(rest);\n            data.authorization = Array.isArray(rules) ? rules : [rules];\n            return this;\n        },\n        ...(0, util_1.brand)(brandName),\n    };\n    return {\n        ...builder,\n        data,\n        relationships(relationships) {\n            data.fields = { ...data.fields, ...relationships };\n        },\n        fields: data.fields,\n    };\n}\n/**\n * Model Type type guard\n * @param modelType - api-next ModelType\n * @returns true if the given value is a ModelSchema\n */\nconst isSchemaModelType = (modelType) => {\n    const internalType = modelType;\n    return (typeof internalType === 'object' &&\n        internalType.data !== undefined &&\n        internalType.data.fields !== undefined &&\n        internalType.data.authorization !== undefined &&\n        internalType.data.identifier !== undefined &&\n        internalType.data.secondaryIndexes !== undefined &&\n        typeof internalType.relationships === 'function');\n};\nexports.isSchemaModelType = isSchemaModelType;\n/**\n * A data model that creates a matching Amazon DynamoDB table and provides create, read (list and get), update,\n * delete, and subscription APIs.\n *\n * @param fields database table fields. Supports scalar types and relationship types.\n * @returns a data model definition\n */\nfunction model(fields) {\n    return _model(fields);\n}\nexports.model = model;\n"],"names":[],"mappings":";;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9D,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,iBAAiB,GAAG,KAAK,CAAC,CAAC;AACnD,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AACjC,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACnD,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAC7C,MAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,SAAS,MAAM,CAAC,MAAM,EAAE;AACxB,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,MAAM;AACd,QAAQ,UAAU,EAAE,CAAC,IAAI,CAAC;AAC1B,QAAQ,gBAAgB,EAAE,EAAE;AAC5B,QAAQ,aAAa,EAAE,EAAE;AACzB,QAAQ,kBAAkB,EAAE,EAAE;AAC9B,KAAK,CAAC;AACN,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,UAAU,CAAC,UAAU,EAAE;AAC/B,YAAY,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;AACzC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,gBAAgB,CAAC,QAAQ,EAAE;AACnC,YAAY,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AACtE,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,iBAAiB,CAAC,GAAG,EAAE;AAC/B,YAAY,IAAI,CAAC,kBAAkB,GAAG,GAAG,CAAC;AAC1C,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAY,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC;AACnE,YAAY,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACzC,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,QAAQ,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC;AACvC,KAAK,CAAC;AACN,IAAI,OAAO;AACX,QAAQ,GAAG,OAAO;AAClB,QAAQ,IAAI;AACZ,QAAQ,aAAa,CAAC,aAAa,EAAE;AACrC,YAAY,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,aAAa,EAAE,CAAC;AAC/D,SAAS;AACT,QAAQ,MAAM,EAAE,IAAI,CAAC,MAAM;AAC3B,KAAK,CAAC;AACN,CAAC;AACD;AACA;AACA;AACA;AACA;AACA,MAAM,iBAAiB,GAAG,CAAC,SAAS,KAAK;AACzC,IAAI,MAAM,YAAY,GAAG,SAAS,CAAC;AACnC,IAAI,QAAQ,OAAO,YAAY,KAAK,QAAQ;AAC5C,QAAQ,YAAY,CAAC,IAAI,KAAK,SAAS;AACvC,QAAQ,YAAY,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS;AAC9C,QAAQ,YAAY,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS;AACrD,QAAQ,YAAY,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS;AAClD,QAAQ,YAAY,CAAC,IAAI,CAAC,gBAAgB,KAAK,SAAS;AACxD,QAAQ,OAAO,YAAY,CAAC,aAAa,KAAK,UAAU,EAAE;AAC1D,CAAC,CAAC;AACF,OAAO,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AAC9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,KAAK,CAAC,MAAM,EAAE;AACvB,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AACD,OAAO,CAAC,KAAK,GAAG,KAAK;;"}

package/dist/cjs/SchemaProcessor.js

@@ -907,7 +907,9 @@ const schemaPreprocessor = (schema) => {
             const { gqlFields, implicitTypes } = processFields(typeName, fields, authFields, fieldLevelAuthRules, identifier, partitionKey, transformedSecondaryIndexes);
             topLevelTypes.push(...implicitTypes);
             const joined = gqlFields.join('\n  ');
-            const model = `type ${typeName} @model ${authString}\n{\n  ${joined}\n}`;
+            const modelAttrs = modelAttributesFromDisabledOps(typeDef.data.disabledOperations);
+            const modelDirective = modelAttrs ? `@model(${modelAttrs})` : '@model';
+            const model = `type ${typeName} ${modelDirective} ${authString}\n{\n  ${joined}\n}`;
             gqlModels.push(model);
         }
     }
@@ -1352,6 +1354,61 @@ function getModelRelationship(sourceModelName, sourceModelConnectionField, getIn
             throw new Error(`"${sourceModelConnectionField.def.type}" is not a valid relationship type.`);
     }
 }
+/**
+ *
+ * @param disabledOps
+ * @returns sanitized string @model directive attribute; can be passed in as-is
+ *
+ * @example
+ * ```ts
+ * const disabledOps = ["subscriptions", "create"];
+ * ```
+ * returns
+ * ```
+ * subscriptions:null,mutations:{create:null}
+ * ```
+ */
+function modelAttributesFromDisabledOps(disabledOps) {
+    const fineCoarseMap = {
+        onCreate: 'subscriptions',
+        onUpdate: 'subscriptions',
+        onDelete: 'subscriptions',
+        create: 'mutations',
+        update: 'mutations',
+        delete: 'mutations',
+        list: 'queries',
+        get: 'queries',
+    };
+    const coarseGrainedOps = ['queries', 'mutations', 'subscriptions'];
+    const coarseFirstSorted = disabledOps
+        // disabledOps is readOnly; create a copy w/ slice
+        .slice()
+        .sort((a, b) => {
+        if (coarseGrainedOps.includes(a) && !coarseGrainedOps.includes(b)) {
+            return -1;
+        }
+        if (!coarseGrainedOps.includes(a) && coarseGrainedOps.includes(b)) {
+            return 1;
+        }
+        return 0;
+    });
+    const modelAttrs = {};
+    for (const op of coarseFirstSorted) {
+        if (coarseGrainedOps.includes(op)) {
+            modelAttrs[op] = null;
+            continue;
+        }
+        const coarseOp = fineCoarseMap[op];
+        if (modelAttrs[coarseOp] !== null) {
+            modelAttrs[coarseOp] = modelAttrs[coarseOp] || {};
+            modelAttrs[coarseOp][op] = null;
+        }
+    }
+    const modelAttrsStr = JSON.stringify(modelAttrs)
+        .replace(/"/g, '') // remove quotes
+        .slice(1, -1); // drop outer curlies {}
+    return modelAttrsStr;
+}
 /**
  * Returns API definition from ModelSchema or string schema
  * @param arg - { schema }