@aws-amplify/graphql-transformer-interfaces 3.1.0 → 3.1.1

package/API.md

@@ -7,6 +7,7 @@
 import { BackedDataSource } from 'aws-cdk-lib/aws-appsync';
 import { BaseDataSource } from 'aws-cdk-lib/aws-appsync';
 import { CfnDomain } from 'aws-cdk-lib/aws-elasticsearch';
+import { CfnParameter } from 'aws-cdk-lib';
 import { CfnResolver } from 'aws-cdk-lib/aws-appsync';
 import { CfnResource } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
@@ -297,10 +298,14 @@ export interface StackManagerProvider {
     // (undocumented)
     createStack: (stackName: string) => Stack;
     // (undocumented)
+    getParameter: (name: string) => CfnParameter | void;
+    // (undocumented)
     getScopeFor: (resourceId: string, defaultStackName?: string) => Construct;
     // (undocumented)
     getStack: (stackName: string) => Stack;
     // (undocumented)
+    getStackFor: (resourceId: string, defaultStackName?: string) => Construct;
+    // (undocumented)
     hasStack: (stackName: string) => boolean;
     // (undocumented)
     readonly scope: Construct;
@@ -614,6 +619,8 @@ export interface TransformerResolverProvider {
     // (undocumented)
     addToSlot: (slotName: string, requestMappingTemplate?: MappingTemplateProvider, responseMappingTemplate?: MappingTemplateProvider, dataSource?: DataSourceProvider) => void;
     // (undocumented)
+    mapToStack: (stack: Stack) => void;
+    // (undocumented)
     setScope: (scope: Construct) => void;
     // (undocumented)
     synthesize: (context: TransformerContextProvider, api: GraphQLAPIProvider) => void;
@@ -717,6 +724,12 @@ export interface TransformHostProvider {
     setAPI(api: GraphqlApiBase): void;
 }
 
+// @public (undocumented)
+export interface TransformParameterProvider {
+    // (undocumented)
+    provide: (name: string) => CfnParameter | void;
+}
+
 // @public (undocumented)
 export type TransformParameters = {
     shouldDeepMergeDirectiveConfigDefaults: boolean;

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.1](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-transformer-interfaces@3.1.0...@aws-amplify/graphql-transformer-interfaces@3.1.1) (2023-08-28)
+
+**Note:** Version bump only for package @aws-amplify/graphql-transformer-interfaces
+
 # [3.1.0](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-transformer-interfaces@2.3.0...@aws-amplify/graphql-transformer-interfaces@3.1.0) (2023-08-09)
 
 ### Features

package/lib/transformer-context/index.d.ts

@@ -8,4 +8,5 @@ export { TransformerSchemaHelperProvider } from './schema-helper-provider';
 export { TransformerPreProcessContextProvider } from './transformer-preprocess-context-provider';
 export { StackManagerProvider } from './stack-manager-provider';
 export { SynthParameters } from './synth-parameters';
+export { TransformParameterProvider } from './transform-parameter-provider';
 //# sourceMappingURL=index.d.ts.map

package/lib/transformer-context/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transformer-context/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,oCAAoC,EACpC,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AACzF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,2BAA2B,EAAE,mCAAmC,EAAE,MAAM,iCAAiC,CAAC;AACnH,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EACL,0BAA0B,EAC1B,6CAA6C,EAC7C,oCAAoC,EACpC,qCAAqC,EACrC,yCAAyC,EACzC,wCAAwC,EACxC,kBAAkB,GACnB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAE,oCAAoC,EAAE,MAAM,2CAA2C,CAAC;AACjG,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transformer-context/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,oCAAoC,EACpC,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AACzF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,2BAA2B,EAAE,mCAAmC,EAAE,MAAM,iCAAiC,CAAC;AACnH,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EACL,0BAA0B,EAC1B,6CAA6C,EAC7C,oCAAoC,EACpC,qCAAqC,EACrC,yCAAyC,EACzC,wCAAwC,EACxC,kBAAkB,GACnB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAE,oCAAoC,EAAE,MAAM,2CAA2C,CAAC;AACjG,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC"}

package/lib/transformer-context/stack-manager-provider.d.ts

@@ -1,4 +1,4 @@
-import { Stack } from 'aws-cdk-lib';
+import { CfnParameter, Stack } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 export interface StackManagerProvider {
     readonly scope: Construct;
@@ -6,5 +6,7 @@ export interface StackManagerProvider {
     createStack: (stackName: string) => Stack;
     hasStack: (stackName: string) => boolean;
     getScopeFor: (resourceId: string, defaultStackName?: string) => Construct;
+    getStackFor: (resourceId: string, defaultStackName?: string) => Construct;
+    getParameter: (name: string) => CfnParameter | void;
 }
 //# sourceMappingURL=stack-manager-provider.d.ts.map

package/lib/transformer-context/stack-manager-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stack-manager-provider.d.ts","sourceRoot":"","sources":["../../src/transformer-context/stack-manager-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,KAAK,CAAC;IACvC,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,KAAK,CAAC;IAC1C,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;IACzC,WAAW,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC;CAC3E"}
+{"version":3,"file":"stack-manager-provider.d.ts","sourceRoot":"","sources":["../../src/transformer-context/stack-manager-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,KAAK,CAAC;IACvC,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,KAAK,CAAC;IAC1C,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;IACzC,WAAW,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC;IAM1E,WAAW,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC;IAM1E,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,YAAY,GAAG,IAAI,CAAC;CACrD"}

package/lib/transformer-context/transform-parameter-provider.d.ts

@@ -0,0 +1,5 @@
+import { CfnParameter } from 'aws-cdk-lib';
+export interface TransformParameterProvider {
+    provide: (name: string) => CfnParameter | void;
+}
+//# sourceMappingURL=transform-parameter-provider.d.ts.map

package/lib/transformer-context/transform-parameter-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-parameter-provider.d.ts","sourceRoot":"","sources":["../../src/transformer-context/transform-parameter-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAK3C,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,YAAY,GAAG,IAAI,CAAC;CAChD"}

package/lib/transformer-context/transform-parameter-provider.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=transform-parameter-provider.js.map

package/lib/transformer-context/transform-parameter-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-parameter-provider.js","sourceRoot":"","sources":["../../src/transformer-context/transform-parameter-provider.ts"],"names":[],"mappings":""}

package/lib/transformer-context/transformer-resolver-provider.d.ts

@@ -1,4 +1,5 @@
 import { Construct } from 'constructs';
+import { Stack } from 'aws-cdk-lib';
 import { GraphQLAPIProvider, MappingTemplateProvider } from '../graphql-api-provider';
 import { DataSourceProvider } from './transformer-datasource-provider';
 import { TransformerContextProvider } from './transformer-context-provider';
@@ -6,6 +7,7 @@ export interface TransformerResolverProvider {
     addToSlot: (slotName: string, requestMappingTemplate?: MappingTemplateProvider, responseMappingTemplate?: MappingTemplateProvider, dataSource?: DataSourceProvider) => void;
     synthesize: (context: TransformerContextProvider, api: GraphQLAPIProvider) => void;
     setScope: (scope: Construct) => void;
+    mapToStack: (stack: Stack) => void;
 }
 export interface TransformerResolversManagerProvider {
     addResolver: (typeName: string, fieldName: string, resolver: TransformerResolverProvider) => TransformerResolverProvider;

package/lib/transformer-context/transformer-resolver-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transformer-resolver-provider.d.ts","sourceRoot":"","sources":["../../src/transformer-context/transformer-resolver-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC;AAE5E,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,CACT,QAAQ,EAAE,MAAM,EAChB,sBAAsB,CAAC,EAAE,uBAAuB,EAChD,uBAAuB,CAAC,EAAE,uBAAuB,EACjD,UAAU,CAAC,EAAE,kBAAkB,KAC5B,IAAI,CAAC;IACV,UAAU,EAAE,CAAC,OAAO,EAAE,0BAA0B,EAAE,GAAG,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACnF,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,2BAA2B,KAAK,2BAA2B,CAAC;IACzH,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,2BAA2B,GAAG,IAAI,CAAC;IACzF,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;IAC9D,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,2BAA2B,CAAC;IACrF,gBAAgB,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IAEjE,qBAAqB,EAAE,CACrB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,MAAM,EACzB,UAAU,EAAE,kBAAkB,EAC9B,sBAAsB,EAAE,uBAAuB,EAC/C,uBAAuB,EAAE,uBAAuB,KAC7C,2BAA2B,CAAC;IAEjC,wBAAwB,EAAE,CACxB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,MAAM,EACzB,UAAU,EAAE,kBAAkB,EAC9B,sBAAsB,EAAE,uBAAuB,EAC/C,uBAAuB,EAAE,uBAAuB,KAC7C,2BAA2B,CAAC;IAEjC,4BAA4B,EAAE,CAC5B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,MAAM,EACzB,sBAAsB,EAAE,uBAAuB,EAC/C,uBAAuB,EAAE,uBAAuB,KAC7C,2BAA2B,CAAC;CAClC"}
+{"version":3,"file":"transformer-resolver-provider.d.ts","sourceRoot":"","sources":["../../src/transformer-context/transformer-resolver-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC;AAE5E,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,CACT,QAAQ,EAAE,MAAM,EAChB,sBAAsB,CAAC,EAAE,uBAAuB,EAChD,uBAAuB,CAAC,EAAE,uBAAuB,EACjD,UAAU,CAAC,EAAE,kBAAkB,KAC5B,IAAI,CAAC;IACV,UAAU,EAAE,CAAC,OAAO,EAAE,0BAA0B,EAAE,GAAG,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACnF,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAMrC,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,2BAA2B,KAAK,2BAA2B,CAAC;IACzH,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,2BAA2B,GAAG,IAAI,CAAC;IACzF,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;IAC9D,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,2BAA2B,CAAC;IACrF,gBAAgB,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IAEjE,qBAAqB,EAAE,CACrB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,MAAM,EACzB,UAAU,EAAE,kBAAkB,EAC9B,sBAAsB,EAAE,uBAAuB,EAC/C,uBAAuB,EAAE,uBAAuB,KAC7C,2BAA2B,CAAC;IAEjC,wBAAwB,EAAE,CACxB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,MAAM,EACzB,UAAU,EAAE,kBAAkB,EAC9B,sBAAsB,EAAE,uBAAuB,EAC/C,uBAAuB,EAAE,uBAAuB,KAC7C,2BAA2B,CAAC;IAEjC,4BAA4B,EAAE,CAC5B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,MAAM,EACzB,sBAAsB,EAAE,uBAAuB,EAC/C,uBAAuB,EAAE,uBAAuB,KAC7C,2BAA2B,CAAC;CAClC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/graphql-transformer-interfaces",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "Amplify GraphQL transformer interface definitions",
   "repository": {
     "type": "git",
@@ -49,5 +49,5 @@
     ],
     "collectCoverage": true
   },
-  "gitHead": "de6751fd91228eecae518326515833f72509afa0"
+  "gitHead": "a53a49c3c7784dddf44bdbd81dfee2359207476a"
 }

package/src/transformer-context/index.ts

@@ -21,3 +21,4 @@ export { TransformerSchemaHelperProvider } from './schema-helper-provider';
 export { TransformerPreProcessContextProvider } from './transformer-preprocess-context-provider';
 export { StackManagerProvider } from './stack-manager-provider';
 export { SynthParameters } from './synth-parameters';
+export { TransformParameterProvider } from './transform-parameter-provider';

package/src/transformer-context/stack-manager-provider.ts

@@ -1,4 +1,4 @@
-import { Stack } from 'aws-cdk-lib';
+import { CfnParameter, Stack } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 
 export interface StackManagerProvider {
@@ -7,4 +7,16 @@ export interface StackManagerProvider {
   createStack: (stackName: string) => Stack;
   hasStack: (stackName: string) => boolean;
   getScopeFor: (resourceId: string, defaultStackName?: string) => Construct;
+
+  /**
+   * Retrieve the given scope for a stack name.
+   * @deprecated use getScopeFor instead.
+   */
+  getStackFor: (resourceId: string, defaultStackName?: string) => Construct;
+
+  /**
+   * Try and retrieve a parameter for the given name.
+   * @deprecated use context.synthParameters instead.
+   */
+  getParameter: (name: string) => CfnParameter | void;
 }

package/src/transformer-context/transform-parameter-provider.ts

@@ -0,0 +1,8 @@
+import { CfnParameter } from 'aws-cdk-lib';
+
+/**
+ * Provider in order to facilitate existing 3p transformers which may depend on `env` parameters, for example.
+ */
+export interface TransformParameterProvider {
+  provide: (name: string) => CfnParameter | void;
+}

package/src/transformer-context/transformer-resolver-provider.ts

@@ -1,4 +1,5 @@
 import { Construct } from 'constructs';
+import { Stack } from 'aws-cdk-lib';
 import { GraphQLAPIProvider, MappingTemplateProvider } from '../graphql-api-provider';
 import { DataSourceProvider } from './transformer-datasource-provider';
 import { TransformerContextProvider } from './transformer-context-provider';
@@ -12,6 +13,12 @@ export interface TransformerResolverProvider {
   ) => void;
   synthesize: (context: TransformerContextProvider, api: GraphQLAPIProvider) => void;
   setScope: (scope: Construct) => void;
+
+  /**
+   * Map the given resolver to a stack.
+   * @deprecated use setScope instead.
+   */
+  mapToStack: (stack: Stack) => void;
 }
 
 export interface TransformerResolversManagerProvider {