@aws-amplify/data-schema 1.5.1 → 1.6.1

package/dist/esm/Handler.mjs

@@ -60,6 +60,7 @@ function custom(customHandler) {
     };
 }
 const functionHandlerBrand = 'functionHandler';
+const asyncFunctionHandlerBrand = 'asyncFunctionHandler';
 /**
  * Use a function created via `defineFunction` to handle the custom query/mutation/subscription. In your function handler,
  * you can use the `Schema["YOUR_QUERY_OR_MUTATION_NAME"]["functionHandler"]` utility type to type the handler function.
@@ -96,7 +97,25 @@ const functionHandlerBrand = 'functionHandler';
  * @returns A handler for the query / mutation / subscription
  */
 function fcn(fn) {
-    return { [dataSymbol]: fn, ...buildHandler(functionHandlerBrand) };
+    return {
+        [dataSymbol]: {
+            handler: fn,
+            invocationType: 'RequestResponse',
+        },
+        async() {
+            return _async(this);
+        },
+        ...buildHandler(functionHandlerBrand),
+    };
+}
+function _async(fnHandler) {
+    return {
+        [dataSymbol]: {
+            handler: fnHandler[dataSymbol].handler,
+            invocationType: 'Event',
+        },
+        ...buildHandler(asyncFunctionHandlerBrand),
+    };
 }
 //#endregion
 const handler = {

package/dist/esm/Handler.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"Handler.mjs","sources":["../../src/Handler.ts"],"sourcesContent":["import { brand } from './util';\nconst dataSymbol = Symbol('Data');\nfunction buildHandler(brandName) {\n    return brand(brandName);\n}\nexport function getHandlerData(handler) {\n    return handler[dataSymbol];\n}\n//#region handler.inlineSql\nconst inlineSqlBrand = 'inlineSql';\nfunction inlineSql(sql) {\n    return { [dataSymbol]: sql, ...buildHandler(inlineSqlBrand) };\n}\n//#endregion\n//#region handler.sqlReference\nconst sqlReferenceBrand = 'sqlReference';\nfunction sqlReference(sqlFilePath) {\n    // used to determine caller directory in order to resolve relative path downstream\n    const stack = new Error().stack;\n    return {\n        [dataSymbol]: { stack, entry: sqlFilePath },\n        ...buildHandler(sqlReferenceBrand),\n    };\n}\nconst customHandlerBrand = 'customHandler';\n/**\n * Use a custom JavaScript resolver to handle a query, mutation, or subscription.\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/custom-business-logic/#step-2---configure-custom-business-logic-handler-code}\n * @param customHandler `{ entry: \"path-to-javascript-resolver-file.js\", dataSource: \"Data Source name added via \"backend.data.add*DataSoruce(...)\"}`\n * @returns A JavaScript resolver attached to the query, mutation, or subscription.\n * @example\n * const schema = a.schema({\n *   Post: a.model({\n *     content: a.string(),\n *     likes: a.integer()\n *       .authorization(allow => [allow.authenticated().to(['read'])])\n *   }).authorization(allow => [\n *     allow.owner(),\n *     allow.authenticated().to(['read'])\n *   ]),\n *\n *   likePost: a\n *     .mutation()\n *     .arguments({ postId: a.id() })\n *     .returns(a.ref('Post'))\n *     .authorization(allow => [allow.authenticated()])\n *     .handler(a.handler.custom({\n *       dataSource: a.ref('Post'),\n *       entry: './increment-like.js'\n *     }))\n * });\n */\nfunction custom(customHandler) {\n    // used to determine caller directory in order to resolve relative path downstream\n    const stack = new Error().stack;\n    return {\n        [dataSymbol]: { ...customHandler, stack },\n        ...buildHandler(customHandlerBrand),\n    };\n}\nconst functionHandlerBrand = 'functionHandler';\n/**\n * Use a function created via `defineFunction` to handle the custom query/mutation/subscription. In your function handler,\n * you can use the `Schema[\"YOUR_QUERY_OR_MUTATION_NAME\"][\"functionHandler\"]` utility type to type the handler function.\n * @example\n * import {\n *   type ClientSchema,\n *   a,\n *   defineData,\n *   defineFunction // 1.Import \"defineFunction\" to create new functions\n * } from '@aws-amplify/backend';\n *\n * // 2. define a function\n * const echoHandler = defineFunction({\n *   entry: './echo-handler/handler.ts'\n * })\n *\n * const schema = a.schema({\n *   EchoResponse: a.customType({\n *     content: a.string(),\n *     executionDuration: a.float()\n *   }),\n *\n *   echo: a\n *     .query()\n *     .arguments({ content: a.string() })\n *     .returns(a.ref('EchoResponse'))\n *     .authorization(allow => [allow.publicApiKey()])\n *     // 3. set the function has the handler\n *     .handler(a.handler.function(echoHandler))\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/custom-business-logic/}\n * @param fn A function created via `defineFunction`. Alternatively, you can pass in a \"string\" of the function name and pass\n * in a corresponding value into the `functionMap` property of defineData.\n * @returns A handler for the query / mutation / subscription\n */\nfunction fcn(fn) {\n    return { [dataSymbol]: fn, ...buildHandler(functionHandlerBrand) };\n}\n//#endregion\nexport const handler = {\n    inlineSql,\n    sqlReference,\n    custom,\n    function: fcn,\n};\n"],"names":[],"mappings":";;AACA,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAClC,SAAS,YAAY,CAAC,SAAS,EAAE;AACjC,IAAI,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC;AAC5B,CAAC;AACM,SAAS,cAAc,CAAC,OAAO,EAAE;AACxC,IAAI,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC;AACD;AACA,MAAM,cAAc,GAAG,WAAW,CAAC;AACnC,SAAS,SAAS,CAAC,GAAG,EAAE;AACxB,IAAI,OAAO,EAAE,CAAC,UAAU,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;AAClE,CAAC;AACD;AACA;AACA,MAAM,iBAAiB,GAAG,cAAc,CAAC;AACzC,SAAS,YAAY,CAAC,WAAW,EAAE;AACnC;AACA,IAAI,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;AACpC,IAAI,OAAO;AACX,QAAQ,CAAC,UAAU,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE;AACnD,QAAQ,GAAG,YAAY,CAAC,iBAAiB,CAAC;AAC1C,KAAK,CAAC;AACN,CAAC;AACD,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAC3C;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,MAAM,CAAC,aAAa,EAAE;AAC/B;AACA,IAAI,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;AACpC,IAAI,OAAO;AACX,QAAQ,CAAC,UAAU,GAAG,EAAE,GAAG,aAAa,EAAE,KAAK,EAAE;AACjD,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC;AAC3C,KAAK,CAAC;AACN,CAAC;AACD,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AAC/C;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,GAAG,CAAC,EAAE,EAAE;AACjB,IAAI,OAAO,EAAE,CAAC,UAAU,GAAG,EAAE,EAAE,GAAG,YAAY,CAAC,oBAAoB,CAAC,EAAE,CAAC;AACvE,CAAC;AACD;AACY,MAAC,OAAO,GAAG;AACvB,IAAI,SAAS;AACb,IAAI,YAAY;AAChB,IAAI,MAAM;AACV,IAAI,QAAQ,EAAE,GAAG;AACjB;;;;"}
+{"version":3,"file":"Handler.mjs","sources":["../../src/Handler.ts"],"sourcesContent":["import { brand } from './util';\nconst dataSymbol = Symbol('Data');\nfunction buildHandler(brandName) {\n    return brand(brandName);\n}\nexport function getHandlerData(handler) {\n    return handler[dataSymbol];\n}\n//#region handler.inlineSql\nconst inlineSqlBrand = 'inlineSql';\nfunction inlineSql(sql) {\n    return { [dataSymbol]: sql, ...buildHandler(inlineSqlBrand) };\n}\n//#endregion\n//#region handler.sqlReference\nconst sqlReferenceBrand = 'sqlReference';\nfunction sqlReference(sqlFilePath) {\n    // used to determine caller directory in order to resolve relative path downstream\n    const stack = new Error().stack;\n    return {\n        [dataSymbol]: { stack, entry: sqlFilePath },\n        ...buildHandler(sqlReferenceBrand),\n    };\n}\nconst customHandlerBrand = 'customHandler';\n/**\n * Use a custom JavaScript resolver to handle a query, mutation, or subscription.\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/custom-business-logic/#step-2---configure-custom-business-logic-handler-code}\n * @param customHandler `{ entry: \"path-to-javascript-resolver-file.js\", dataSource: \"Data Source name added via \"backend.data.add*DataSoruce(...)\"}`\n * @returns A JavaScript resolver attached to the query, mutation, or subscription.\n * @example\n * const schema = a.schema({\n *   Post: a.model({\n *     content: a.string(),\n *     likes: a.integer()\n *       .authorization(allow => [allow.authenticated().to(['read'])])\n *   }).authorization(allow => [\n *     allow.owner(),\n *     allow.authenticated().to(['read'])\n *   ]),\n *\n *   likePost: a\n *     .mutation()\n *     .arguments({ postId: a.id() })\n *     .returns(a.ref('Post'))\n *     .authorization(allow => [allow.authenticated()])\n *     .handler(a.handler.custom({\n *       dataSource: a.ref('Post'),\n *       entry: './increment-like.js'\n *     }))\n * });\n */\nfunction custom(customHandler) {\n    // used to determine caller directory in order to resolve relative path downstream\n    const stack = new Error().stack;\n    return {\n        [dataSymbol]: { ...customHandler, stack },\n        ...buildHandler(customHandlerBrand),\n    };\n}\nconst functionHandlerBrand = 'functionHandler';\nconst asyncFunctionHandlerBrand = 'asyncFunctionHandler';\n/**\n * Use a function created via `defineFunction` to handle the custom query/mutation/subscription. In your function handler,\n * you can use the `Schema[\"YOUR_QUERY_OR_MUTATION_NAME\"][\"functionHandler\"]` utility type to type the handler function.\n * @example\n * import {\n *   type ClientSchema,\n *   a,\n *   defineData,\n *   defineFunction // 1.Import \"defineFunction\" to create new functions\n * } from '@aws-amplify/backend';\n *\n * // 2. define a function\n * const echoHandler = defineFunction({\n *   entry: './echo-handler/handler.ts'\n * })\n *\n * const schema = a.schema({\n *   EchoResponse: a.customType({\n *     content: a.string(),\n *     executionDuration: a.float()\n *   }),\n *\n *   echo: a\n *     .query()\n *     .arguments({ content: a.string() })\n *     .returns(a.ref('EchoResponse'))\n *     .authorization(allow => [allow.publicApiKey()])\n *     // 3. set the function has the handler\n *     .handler(a.handler.function(echoHandler))\n * });\n * @see {@link https://docs.amplify.aws/react/build-a-backend/data/custom-business-logic/}\n * @param fn A function created via `defineFunction`. Alternatively, you can pass in a \"string\" of the function name and pass\n * in a corresponding value into the `functionMap` property of defineData.\n * @returns A handler for the query / mutation / subscription\n */\nfunction fcn(fn) {\n    return {\n        [dataSymbol]: {\n            handler: fn,\n            invocationType: 'RequestResponse',\n        },\n        async() {\n            return _async(this);\n        },\n        ...buildHandler(functionHandlerBrand),\n    };\n}\nfunction _async(fnHandler) {\n    return {\n        [dataSymbol]: {\n            handler: fnHandler[dataSymbol].handler,\n            invocationType: 'Event',\n        },\n        ...buildHandler(asyncFunctionHandlerBrand),\n    };\n}\n//#endregion\nexport const handler = {\n    inlineSql,\n    sqlReference,\n    custom,\n    function: fcn,\n};\n"],"names":[],"mappings":";;AACA,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAClC,SAAS,YAAY,CAAC,SAAS,EAAE;AACjC,IAAI,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC;AAC5B,CAAC;AACM,SAAS,cAAc,CAAC,OAAO,EAAE;AACxC,IAAI,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC;AACD;AACA,MAAM,cAAc,GAAG,WAAW,CAAC;AACnC,SAAS,SAAS,CAAC,GAAG,EAAE;AACxB,IAAI,OAAO,EAAE,CAAC,UAAU,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;AAClE,CAAC;AACD;AACA;AACA,MAAM,iBAAiB,GAAG,cAAc,CAAC;AACzC,SAAS,YAAY,CAAC,WAAW,EAAE;AACnC;AACA,IAAI,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;AACpC,IAAI,OAAO;AACX,QAAQ,CAAC,UAAU,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE;AACnD,QAAQ,GAAG,YAAY,CAAC,iBAAiB,CAAC;AAC1C,KAAK,CAAC;AACN,CAAC;AACD,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAC3C;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,MAAM,CAAC,aAAa,EAAE;AAC/B;AACA,IAAI,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;AACpC,IAAI,OAAO;AACX,QAAQ,CAAC,UAAU,GAAG,EAAE,GAAG,aAAa,EAAE,KAAK,EAAE;AACjD,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC;AAC3C,KAAK,CAAC;AACN,CAAC;AACD,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AAC/C,MAAM,yBAAyB,GAAG,sBAAsB,CAAC;AACzD;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,GAAG,CAAC,EAAE,EAAE;AACjB,IAAI,OAAO;AACX,QAAQ,CAAC,UAAU,GAAG;AACtB,YAAY,OAAO,EAAE,EAAE;AACvB,YAAY,cAAc,EAAE,iBAAiB;AAC7C,SAAS;AACT,QAAQ,KAAK,GAAG;AAChB,YAAY,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;AAChC,SAAS;AACT,QAAQ,GAAG,YAAY,CAAC,oBAAoB,CAAC;AAC7C,KAAK,CAAC;AACN,CAAC;AACD,SAAS,MAAM,CAAC,SAAS,EAAE;AAC3B,IAAI,OAAO;AACX,QAAQ,CAAC,UAAU,GAAG;AACtB,YAAY,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC,OAAO;AAClD,YAAY,cAAc,EAAE,OAAO;AACnC,SAAS;AACT,QAAQ,GAAG,YAAY,CAAC,yBAAyB,CAAC;AAClD,KAAK,CAAC;AACN,CAAC;AACD;AACY,MAAC,OAAO,GAAG;AACvB,IAAI,SAAS;AACb,IAAI,YAAY;AAChB,IAAI,MAAM;AACV,IAAI,QAAQ,EAAE,GAAG;AACjB;;;;"}

package/dist/esm/SchemaProcessor.mjs

@@ -2,7 +2,7 @@ import { ModelFieldType, string } from './ModelField.mjs';
 import { ModelRelationshipTypes } from './ModelRelationalField.mjs';
 import { accessData, accessSchemaData } from './Authorization.mjs';
 import { CustomOperationNames } from './CustomOperation.mjs';
-import { getBrand } from './util/Brand.mjs';
+import { getBrand, brandSymbol } from './util/Brand.mjs';
 import { getHandlerData } from './Handler.mjs';
 import * as os from 'os';
 import * as path from 'path';
@@ -149,19 +149,23 @@ function transformFunctionHandler(handlers, functionFieldName) {
     const lambdaFunctionDefinition = {};
     handlers.forEach((handler, idx) => {
         const handlerData = getHandlerData(handler);
-        if (typeof handlerData === 'string') {
-            gqlHandlerContent += `@function(name: "${handlerData}") `;
+        if (typeof handlerData.handler === 'string') {
+            gqlHandlerContent += `@function(name: "${handlerData.handler}") `;
         }
-        else if (typeof handlerData.getInstance === 'function') {
+        else if (typeof handlerData.handler.getInstance === 'function') {
             const fnName = `Fn${capitalize(functionFieldName)}${idx === 0 ? '' : `${idx + 1}`}`;
-            lambdaFunctionDefinition[fnName] = handlerData;
-            gqlHandlerContent += `@function(name: "${fnName}") `;
+            lambdaFunctionDefinition[fnName] = handlerData.handler;
+            const invocationTypeArg = handlerData.invocationType === 'Event' ? ', invocationType: Event)' : ')';
+            gqlHandlerContent += `@function(name: "${fnName}"${invocationTypeArg} `;
         }
         else {
             throw new Error(`Invalid value specified for ${functionFieldName} handler.function(). Expected: defineFunction or string.`);
         }
     });
-    return { gqlHandlerContent, lambdaFunctionDefinition };
+    return {
+        gqlHandlerContent,
+        lambdaFunctionDefinition,
+    };
 }
 function customOperationToGql(typeName, typeDef, authorization, isCustom = false, databaseType, getRefType) {
     const { arguments: fieldArgs, typeName: opType, returnType, handlers, subscriptionSource, } = typeDef.data;
@@ -814,6 +818,18 @@ const schemaPreprocessor = (schema) => {
         ? 'dynamodb'
         : 'sql';
     const staticSchema = databaseType === 'sql';
+    // If the schema contains a custom operation with an async lambda handler,
+    // we need to add the EventInvocationResponse custom type to the schema.
+    // 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);
+    });
+    if (containsAsyncLambdaCustomOperation) {
+        schema.data.types['EventInvocationResponse'] = eventInvocationResponseCustomType;
+    }
     const topLevelTypes = sortTopLevelTypes(Object.entries(schema.data.types));
     const { schemaAuth, functionSchemaAccess } = extractFunctionSchemaAccess(schema.data.authorization);
     const getRefType = getRefTypeForSchema(schema);
@@ -976,14 +992,22 @@ function validateCustomOperations(typeDef, typeName, authRules, getRefType) {
             configuredHandlers.add(getBrand(handler));
         }
         if (configuredHandlers.size > 1) {
-            const configuredHandlersStr = JSON.stringify(Array.from(configuredHandlers));
-            throw new Error(`Field handlers must be of the same type. ${typeName} has been configured with ${configuredHandlersStr}`);
+            configuredHandlers.delete('asyncFunctionHandler');
+            configuredHandlers.delete('functionHandler');
+            if (configuredHandlers.size > 0) {
+                const configuredHandlersStr = JSON.stringify(Array.from(configuredHandlers));
+                throw new Error(`Field handlers must be of the same type. ${typeName} has been configured with ${configuredHandlersStr}`);
+            }
         }
     }
     if (typeDef.data.returnType === null &&
         (opType === 'Query' || opType === 'Mutation' || opType === 'Generation')) {
-        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.`);
+        // 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') {
+            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.`);
+        }
     }
     if (opType !== 'Subscription' && subscriptionSource.length > 0) {
         throw new Error(`The .for() modifier function can only be used with a custom subscription. ${typeName} is not a custom subscription.`);
@@ -1038,7 +1062,10 @@ const isCustomHandler = (handler) => {
     return Array.isArray(handler) && getBrand(handler[0]) === 'customHandler';
 };
 const isFunctionHandler = (handler) => {
-    return Array.isArray(handler) && getBrand(handler[0]) === 'functionHandler';
+    return Array.isArray(handler) && ['functionHandler', 'asyncFunctionHandler'].includes(getBrand(handler[0]));
+};
+const finalHandlerIsAsyncFunctionHandler = (handler) => {
+    return Array.isArray(handler) && getBrand(handler[handler.length - 1]) === 'asyncFunctionHandler';
 };
 const normalizeDataSourceName = (dataSource) => {
     // default data source
@@ -1092,6 +1119,21 @@ const handleCustom = (handlers, opType, typeName) => {
     };
     return jsFn;
 };
+const eventInvocationResponseCustomType = {
+    data: {
+        fields: {
+            success: {
+                data: {
+                    fieldType: ModelFieldType.Boolean,
+                    required: true,
+                    array: false,
+                    arrayRequired: false,
+                }
+            }
+        },
+        type: 'customType'
+    }
+};
 function transformCustomOperations(typeDef, typeName, authRules, databaseType, getRefType) {
     const { typeName: opType, handlers } = typeDef.data;
     let jsFunctionForField = undefined;