@aws-amplify/graphql-api-construct 1.18.3-ai-next.0 → 1.18.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/graphql-api-construct",
-  "version": "1.18.3-ai-next.0",
+  "version": "1.18.3",
   "description": "AppSync GraphQL Api Construct using Amplify GraphQL Transformer.",
   "repository": {
     "type": "git",
@@ -34,6 +34,7 @@
     "access": "public"
   },
   "bundledDependencies": [
+    "@aws-amplify/ai-constructs",
     "@aws-amplify/backend-output-schemas",
     "@aws-amplify/backend-output-storage",
     "@aws-amplify/graphql-auth-transformer",
@@ -55,56 +56,50 @@
     "@aws-amplify/graphql-transformer-interfaces",
     "@aws-amplify/platform-core",
     "@aws-amplify/plugin-types",
-    "@aws-amplify/ai-constructs",
-    "@aws-sdk/client-bedrock-runtime",
-    "@smithy/eventstream-serde-browser",
-    "@smithy/eventstream-serde-config-resolver",
-    "@smithy/eventstream-serde-node",
-    "@smithy/eventstream-serde-universal",
-    "@smithy/eventstream-codec",
+    "@aws-cdk/assert",
+    "@aws-cdk/cfnspec",
+    "@aws-cdk/cloudformation-diff",
     "@aws-crypto/crc32",
-    "charenc",
-    "crypt",
-    "fs-extra",
-    "graceful-fs",
-    "graphql",
-    "graphql-mapping-template",
-    "graphql-transformer-common",
-    "hjson",
-    "immer",
-    "is-buffer",
-    "jsonfile",
-    "libphonenumber-js",
-    "lodash",
-    "md5",
-    "object-hash",
-    "pluralize",
-    "ts-dedent",
-    "universalify",
-    "zod",
-    "@aws-sdk/client-sts",
-    "is-ci",
-    "lodash.mergewith",
-    "uuid",
     "@aws-crypto/sha256-browser",
     "@aws-crypto/sha256-js",
+    "@aws-crypto/supports-web-crypto",
+    "@aws-crypto/util",
+    "@aws-sdk/client-bedrock-runtime",
+    "@aws-sdk/client-sso",
     "@aws-sdk/client-sso-oidc",
+    "@aws-sdk/client-sts",
     "@aws-sdk/core",
+    "@aws-sdk/credential-provider-env",
+    "@aws-sdk/credential-provider-http",
+    "@aws-sdk/credential-provider-ini",
     "@aws-sdk/credential-provider-node",
+    "@aws-sdk/credential-provider-process",
+    "@aws-sdk/credential-provider-sso",
+    "@aws-sdk/credential-provider-web-identity",
     "@aws-sdk/middleware-host-header",
     "@aws-sdk/middleware-logger",
     "@aws-sdk/middleware-recursion-detection",
     "@aws-sdk/middleware-user-agent",
     "@aws-sdk/region-config-resolver",
+    "@aws-sdk/token-providers",
     "@aws-sdk/types",
     "@aws-sdk/util-endpoints",
+    "@aws-sdk/util-locate-window",
     "@aws-sdk/util-user-agent-browser",
     "@aws-sdk/util-user-agent-node",
+    "@smithy/abort-controller",
     "@smithy/config-resolver",
     "@smithy/core",
+    "@smithy/credential-provider-imds",
+    "@smithy/eventstream-codec",
+    "@smithy/eventstream-serde-browser",
+    "@smithy/eventstream-serde-config-resolver",
+    "@smithy/eventstream-serde-node",
+    "@smithy/eventstream-serde-universal",
     "@smithy/fetch-http-handler",
     "@smithy/hash-node",
     "@smithy/invalid-dependency",
+    "@smithy/is-array-buffer",
     "@smithy/middleware-content-length",
     "@smithy/middleware-endpoint",
     "@smithy/middleware-retry",
@@ -112,74 +107,107 @@
     "@smithy/middleware-stack",
     "@smithy/node-config-provider",
     "@smithy/node-http-handler",
+    "@smithy/property-provider",
     "@smithy/protocol-http",
+    "@smithy/querystring-builder",
+    "@smithy/querystring-parser",
+    "@smithy/service-error-classification",
+    "@smithy/shared-ini-file-loader",
+    "@smithy/signature-v4",
     "@smithy/smithy-client",
     "@smithy/types",
     "@smithy/url-parser",
     "@smithy/util-base64",
     "@smithy/util-body-length-browser",
     "@smithy/util-body-length-node",
+    "@smithy/util-buffer-from",
+    "@smithy/util-config-provider",
     "@smithy/util-defaults-mode-browser",
     "@smithy/util-defaults-mode-node",
     "@smithy/util-endpoints",
+    "@smithy/util-hex-encoding",
     "@smithy/util-middleware",
     "@smithy/util-retry",
+    "@smithy/util-stream",
+    "@smithy/util-uri-escape",
     "@smithy/util-utf8",
-    "tslib",
+    "ajv",
+    "ansi-regex",
+    "ansi-styles",
+    "astral-regex",
+    "at-least-node",
+    "bowser",
+    "chalk",
+    "charenc",
     "ci-info",
-    "@aws-crypto/supports-web-crypto",
-    "@aws-crypto/util",
-    "@aws-sdk/util-locate-window",
-    "@smithy/signature-v4",
+    "color-convert",
+    "color-name",
+    "crypt",
+    "diff",
+    "emoji-regex",
+    "fast-deep-equal",
+    "fast-uri",
     "fast-xml-parser",
-    "@aws-sdk/credential-provider-env",
-    "@aws-sdk/credential-provider-http",
-    "@aws-sdk/credential-provider-ini",
-    "@aws-sdk/credential-provider-process",
-    "@aws-sdk/credential-provider-sso",
-    "@aws-sdk/credential-provider-web-identity",
-    "@smithy/credential-provider-imds",
-    "@smithy/property-provider",
-    "@smithy/shared-ini-file-loader",
-    "@smithy/util-config-provider",
-    "bowser",
-    "@smithy/querystring-builder",
-    "@smithy/util-buffer-from",
-    "@smithy/service-error-classification",
-    "@smithy/abort-controller",
-    "@smithy/util-stream",
-    "@smithy/querystring-parser",
-    "@smithy/is-array-buffer",
-    "@smithy/util-hex-encoding",
-    "@smithy/util-uri-escape",
+    "fs-extra",
+    "graceful-fs",
+    "graphql",
+    "graphql-mapping-template",
+    "graphql-transformer-common",
+    "has-flag",
+    "hjson",
+    "immer",
+    "is-buffer",
+    "is-ci",
+    "is-fullwidth-code-point",
+    "json-schema-traverse",
+    "jsonfile",
+    "libphonenumber-js",
+    "lodash",
+    "lodash.mergewith",
+    "lodash.truncate",
+    "md5",
+    "object-hash",
+    "pluralize",
+    "require-from-string",
+    "semver",
+    "slice-ansi",
+    "string-width",
+    "strip-ansi",
     "strnum",
-    "@aws-sdk/token-providers",
-    "@aws-sdk/client-sso",
-    "semver"
+    "supports-color",
+    "table",
+    "ts-dedent",
+    "tslib",
+    "universalify",
+    "uuid",
+    "zod"
   ],
   "dependencies": {
     "@aws-amplify/ai-constructs": "^1.0.0",
     "@aws-amplify/backend-output-schemas": "^1.0.0",
     "@aws-amplify/backend-output-storage": "^1.0.0",
-    "@aws-amplify/graphql-auth-transformer": "4.1.7",
-    "@aws-amplify/graphql-conversation-transformer": "1.1.3-ai-next.0",
-    "@aws-amplify/graphql-default-value-transformer": "3.1.4",
-    "@aws-amplify/graphql-directives": "2.6.0",
-    "@aws-amplify/graphql-function-transformer": "3.1.6",
-    "@aws-amplify/graphql-generation-transformer": "1.1.0",
-    "@aws-amplify/graphql-http-transformer": "3.0.9",
-    "@aws-amplify/graphql-index-transformer": "3.0.9",
-    "@aws-amplify/graphql-maps-to-transformer": "4.0.9",
-    "@aws-amplify/graphql-model-transformer": "3.1.1",
-    "@aws-amplify/graphql-predictions-transformer": "3.0.9",
-    "@aws-amplify/graphql-relational-transformer": "3.1.1",
-    "@aws-amplify/graphql-searchable-transformer": "3.0.9",
-    "@aws-amplify/graphql-sql-transformer": "0.4.9",
-    "@aws-amplify/graphql-transformer": "2.2.3-ai-next.0",
-    "@aws-amplify/graphql-transformer-core": "3.3.1",
-    "@aws-amplify/graphql-transformer-interfaces": "4.2.0",
+    "@aws-amplify/graphql-auth-transformer": "4.1.8",
+    "@aws-amplify/graphql-conversation-transformer": "1.1.3",
+    "@aws-amplify/graphql-default-value-transformer": "3.1.5",
+    "@aws-amplify/graphql-directives": "2.6.1",
+    "@aws-amplify/graphql-function-transformer": "3.1.7",
+    "@aws-amplify/graphql-generation-transformer": "1.1.1",
+    "@aws-amplify/graphql-http-transformer": "3.0.10",
+    "@aws-amplify/graphql-index-transformer": "3.0.10",
+    "@aws-amplify/graphql-maps-to-transformer": "4.0.10",
+    "@aws-amplify/graphql-model-transformer": "3.1.2",
+    "@aws-amplify/graphql-predictions-transformer": "3.0.10",
+    "@aws-amplify/graphql-relational-transformer": "3.1.2",
+    "@aws-amplify/graphql-searchable-transformer": "3.0.10",
+    "@aws-amplify/graphql-sql-transformer": "0.4.10",
+    "@aws-amplify/graphql-transformer": "2.2.3",
+    "@aws-amplify/graphql-transformer-core": "3.3.2",
+    "@aws-amplify/graphql-transformer-interfaces": "4.2.1",
     "@aws-amplify/platform-core": "^1.0.0",
     "@aws-amplify/plugin-types": "^1.0.0",
+    "@aws-cdk/assert": "^2.68.0",
+    "@aws-cdk/cfnspec": "2.68.0",
+    "@aws-cdk/cloudformation-diff": "2.68.0",
     "@aws-crypto/crc32": "5.2.0",
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "^5.2.0",
@@ -252,29 +280,51 @@
     "@smithy/util-stream": "^3.1.3",
     "@smithy/util-uri-escape": "^3.0.0",
     "@smithy/util-utf8": "^3.0.0",
+    "ajv": "^8.0.1",
+    "ansi-regex": "^5.0.1",
+    "ansi-styles": "^4.1.0",
+    "astral-regex": "^2.0.0",
+    "at-least-node": "^1.0.0",
     "bowser": "^2.11.0",
+    "chalk": "^4",
     "charenc": "^0.0.2",
     "ci-info": "^3.2.0",
+    "color-convert": "^2.0.1",
+    "color-name": "~1.1.4",
     "crypt": "^0.0.2",
+    "diff": "^5.1.0",
+    "emoji-regex": "^8.0.0",
+    "fast-deep-equal": "^3.1.3",
+    "fast-uri": "^3.0.1",
     "fast-xml-parser": "4.4.1",
     "fs-extra": "^8.1.0",
     "graceful-fs": "^4.2.0",
     "graphql": "^15.5.0",
-    "graphql-mapping-template": "5.0.1",
-    "graphql-transformer-common": "5.1.1",
+    "graphql-mapping-template": "5.0.2",
+    "graphql-transformer-common": "5.1.2",
+    "has-flag": "^4.0.0",
     "hjson": "^3.2.2",
     "immer": "^9.0.12",
     "is-buffer": "~1.1.6",
     "is-ci": "^3.0.1",
+    "is-fullwidth-code-point": "^3.0.0",
+    "json-schema-traverse": "^1.0.0",
     "jsonfile": "^4.0.0",
     "libphonenumber-js": "1.9.47",
     "lodash": "^4.17.21",
     "lodash.mergewith": "^4.6.2",
+    "lodash.truncate": "^4.4.2",
     "md5": "^2.2.1",
     "object-hash": "^3.0.0",
     "pluralize": "8.0.0",
+    "require-from-string": "^2.0.2",
     "semver": "^7.6.3",
+    "slice-ansi": "^4.0.0",
+    "string-width": "^4.2.3",
+    "strip-ansi": "^6.0.1",
     "strnum": "^1.0.5",
+    "supports-color": "^7.1.0",
+    "table": "^6.8.1",
     "ts-dedent": "^2.0.0",
     "tslib": "^2.6.2",
     "universalify": "^0.1.0",
@@ -282,21 +332,20 @@
     "zod": "^3.22.2"
   },
   "devDependencies": {
-    "@aws-amplify/graphql-transformer-test-utils": "1.0.8",
+    "@aws-amplify/graphql-transformer-test-utils": "1.0.9",
     "@types/fs-extra": "^8.0.1",
     "@types/node": "^18.0.0",
-    "aws-cdk-lib": "2.158.0",
+    "aws-cdk-lib": "2.168.0",
     "constructs": "10.3.0",
     "jsii": "^5.4.23",
     "jsii-docgen": "9.1.2",
     "jsii-pacmak": "^1.84.0",
     "jsii-rosetta": "^5.4.23",
     "rimraf": "^3.0.0",
-    "ts-jest": "^29.0.0",
     "ts-node": "^8.10.1"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "^2.158.0",
+    "aws-cdk-lib": "^2.168.0",
     "constructs": "^10.3.0"
   },
   "stability": "stable",
@@ -313,45 +362,5 @@
       "outDir": "lib"
     }
   },
-  "jest": {
-    "testEnvironmentOptions": {
-      "url": "http://localhost"
-    },
-    "transform": {
-      "^.+\\.tsx?$": "ts-jest"
-    },
-    "testRegex": "((\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx",
-      "json",
-      "node"
-    ],
-    "collectCoverage": true,
-    "coverageProvider": "v8",
-    "coverageThreshold": {
-      "global": {
-        "branches": 89,
-        "functions": 90,
-        "lines": 58
-      }
-    },
-    "coverageReporters": [
-      "clover",
-      "text"
-    ],
-    "collectCoverageFrom": [
-      "src/**/*.ts"
-    ],
-    "coveragePathIgnorePatterns": [
-      "/__tests__/"
-    ],
-    "snapshotFormat": {
-      "escapeString": true,
-      "printBasicPrototype": true
-    }
-  },
-  "gitHead": "0a000c454da053608a1c150c3d617c7c09cc8ee7"
+  "gitHead": "9c5ee69a82e52f094f57da66bc7940758c0b2263"
 }

package/src/amplify-graphql-api.ts

@@ -160,6 +160,7 @@ export class AmplifyGraphqlApi extends Construct {
       functionNameMap,
       outputStorageStrategy,
       dataStoreConfiguration,
+      logging,
     } = props;
 
     // TODO: GEN1_GEN2_MIGRATION
@@ -250,6 +251,7 @@ export class AmplifyGraphqlApi extends Construct {
       rdsLayerMapping: undefined,
       rdsSnsTopicMapping: undefined,
       ...getDataSourceStrategiesProvider(definition),
+      logging,
     };
 
     executeTransform(executeTransformConfig);

package/src/index.ts

@@ -46,3 +46,5 @@ export {
 } from './amplify-dynamodb-table-wrapper';
 export { SQLLambdaModelDataSourceStrategyFactory } from './sql-model-datasource-strategy';
 export * from './model-datasource-strategy-types';
+export type { LogConfig, Logging } from './log-config-types';
+export { FieldLogLevel, RetentionDays } from './log-config-types';

package/src/log-config-types.ts

@@ -0,0 +1,84 @@
+import { FieldLogLevel } from 'aws-cdk-lib/aws-appsync';
+import { RetentionDays } from 'aws-cdk-lib/aws-logs';
+
+// Reimporting and reexporting FieldLogLevel and RetentionDays to reduce the number of imports required to use logConfig.
+export { FieldLogLevel, RetentionDays };
+
+/**
+ * Customizable logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.
+ *
+ * **WARNING**: Verbose logging will log the full incoming query including user parameters.
+ * Sensitive information may be exposed in CloudWatch logs. Ensure that your IAM policies only grant access to authorized users.
+ *
+ * For information on LogConfig, refer to https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html.
+ * For information on RetentionDays, refer to https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.RetentionDays.html.
+ *
+ * @default excludeVerboseContent: true, fieldLogLevel: FieldLogLevel.NONE, retention: RetentionDays.ONE_WEEK
+ */
+export interface LogConfig {
+  /**
+   * The number of days log events are kept in CloudWatch Logs.
+   *
+   * @default RetentionDays.ONE_WEEK
+   * @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.RetentionDays.html
+   */
+  readonly retention?: RetentionDays;
+
+  /**
+   * When set to `true`, excludes verbose information from the logs, such as:
+   * - GraphQL Query
+   * - Request Headers
+   * - Response Headers
+   * - Context
+   * - Evaluated Mapping Templates
+   *
+   * This setting applies regardless of the specified logging level.
+   *
+   * **WARNING**: Verbose logging will log the full incoming query including user parameters.
+   * Sensitive information may be exposed in CloudWatch logs. Ensure that your IAM policies only grant access to authorized users.
+   *
+   * @default true
+   */
+  readonly excludeVerboseContent?: boolean;
+
+  /**
+   * The field logging level. Values can be `NONE`, `ERROR`, `INFO`, `DEBUG`, or `ALL`.
+   *
+   * - **NONE**: No field-level logs are captured.
+   * - **ERROR**: Logs the following information only for the fields that are in the error category:
+   *   - The error section in the server response.
+   *   - Field-level errors.
+   *   - The generated request/response functions that got resolved for error fields.
+   * - **INFO**: Logs the following information only for the fields that are in the info and error categories:
+   *   - Info-level messages.
+   *   - The user messages sent through `$util.log.info` and `console.log`.
+   *   - Field-level tracing and mapping logs are not shown.
+   * - **DEBUG**: Logs the following information only for the fields that are in the debug, info, and error categories:
+   *   - Debug-level messages.
+   *   - The user messages sent through `$util.log.info`, `$util.log.debug`, `console.log`, and `console.debug`.
+   *   - Field-level tracing and mapping logs are not shown.
+   * - **ALL**: The following information is logged for all fields in the query:
+   *   - Field-level tracing information.
+   *   - The generated request/response functions that were resolved for each field.
+   *
+   * @default FieldLogLevel.NONE
+   */
+  readonly fieldLogLevel?: FieldLogLevel;
+}
+
+/**
+ * The logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.
+ * Values can be `true` or a `LogConfig` object.
+ *
+ * ### Defaults
+ * Default settings will be applied when logging is set to `true` or an empty object, or for unspecified fields:
+ * - `excludeVerboseContent`: `true`
+ * - `fieldLogLevel`: `FieldLogLevel.NONE`
+ * - `retention`: `RetentionDays.ONE_WEEK`
+ *
+ * **WARNING**: Verbose logging will log the full incoming query including user parameters.
+ * Sensitive information may be exposed in CloudWatch logs. Ensure that your IAM policies only grant access to authorized users.
+ *
+ * For information on LogConfig, refer to https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html.
+ */
+export type Logging = true | LogConfig;

package/src/types.ts

@@ -19,7 +19,7 @@ import { IFunction, CfnFunction } from 'aws-cdk-lib/aws-lambda';
 import { IBucket } from 'aws-cdk-lib/aws-s3';
 import { AmplifyDynamoDbTableWrapper } from './amplify-dynamodb-table-wrapper';
 import { CustomSqlDataSourceStrategy, ModelDataSourceStrategy } from './model-datasource-strategy-types';
-
+import { Logging } from './log-config-types';
 /**
  * Configuration for IAM Authorization on the Graphql Api.
  * @struct - required since this interface begins with an 'I'
@@ -762,6 +762,11 @@ export interface AmplifyGraphqlApiProps {
    * For more information, refer to https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js/
    */
   readonly dataStoreConfiguration?: DataStoreConfiguration;
+
+  /**
+   * Specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.
+   */
+  readonly logging?: Logging;
 }
 
 /**