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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/API.md +40 -156
  2. package/CHANGELOG.md +6 -0
  3. package/lib/asset-provider.d.ts +16 -0
  4. package/lib/asset-provider.d.ts.map +1 -0
  5. package/lib/{transformer-context/overrides-provider.js → asset-provider.js} +1 -1
  6. package/lib/asset-provider.js.map +1 -0
  7. package/lib/index.d.ts +2 -2
  8. package/lib/index.d.ts.map +1 -1
  9. package/lib/index.js.map +1 -1
  10. package/lib/nested-stack-provider.d.ts +6 -0
  11. package/lib/nested-stack-provider.d.ts.map +1 -0
  12. package/lib/{amplify-api-resource-stack-types.js → nested-stack-provider.js} +1 -1
  13. package/lib/nested-stack-provider.js.map +1 -0
  14. package/lib/transform-host-provider.d.ts +10 -9
  15. package/lib/transform-host-provider.d.ts.map +1 -1
  16. package/lib/transformer-context/index.d.ts +1 -0
  17. package/lib/transformer-context/index.d.ts.map +1 -1
  18. package/lib/transformer-context/stack-manager-provider.d.ts +4 -5
  19. package/lib/transformer-context/stack-manager-provider.d.ts.map +1 -1
  20. package/lib/transformer-context/synth-parameters.d.ts +8 -0
  21. package/lib/transformer-context/synth-parameters.d.ts.map +1 -0
  22. package/lib/{deployment-resources.js → transformer-context/synth-parameters.js} +1 -1
  23. package/lib/transformer-context/synth-parameters.js.map +1 -0
  24. package/lib/transformer-context/transformer-context-provider.d.ts +4 -2
  25. package/lib/transformer-context/transformer-context-provider.d.ts.map +1 -1
  26. package/lib/transformer-context/transformer-resolver-provider.d.ts +2 -2
  27. package/lib/transformer-context/transformer-resolver-provider.d.ts.map +1 -1
  28. package/package.json +2 -2
  29. package/src/asset-provider.ts +18 -0
  30. package/src/index.ts +2 -9
  31. package/src/nested-stack-provider.ts +6 -0
  32. package/src/transform-host-provider.ts +10 -9
  33. package/src/transformer-context/index.ts +1 -0
  34. package/src/transformer-context/stack-manager-provider.ts +4 -5
  35. package/src/transformer-context/synth-parameters.ts +7 -0
  36. package/src/transformer-context/transformer-context-provider.ts +4 -0
  37. package/src/transformer-context/transformer-resolver-provider.ts +2 -2
  38. package/tsconfig.tsbuildinfo +1 -1
  39. package/lib/amplify-api-resource-stack-types.d.ts +0 -77
  40. package/lib/amplify-api-resource-stack-types.d.ts.map +0 -1
  41. package/lib/amplify-api-resource-stack-types.js.map +0 -1
  42. package/lib/deployment-resources.d.ts +0 -34
  43. package/lib/deployment-resources.d.ts.map +0 -1
  44. package/lib/deployment-resources.js.map +0 -1
  45. package/lib/transformer-context/overrides-provider.d.ts +0 -5
  46. package/lib/transformer-context/overrides-provider.d.ts.map +0 -1
  47. package/lib/transformer-context/overrides-provider.js.map +0 -1
  48. package/src/amplify-api-resource-stack-types.ts +0 -91
  49. package/src/deployment-resources.ts +0 -49
  50. package/src/transformer-context/overrides-provider.ts +0 -5
@@ -0,0 +1,18 @@
1
+ import { Construct } from 'constructs';
2
+
3
+ export type AssetProps = {
4
+ readonly fileContent: string;
5
+ readonly fileName: string;
6
+ };
7
+
8
+ export type S3Asset = {
9
+ assetHash: string;
10
+ httpUrl: string;
11
+ s3BucketName: string;
12
+ s3ObjectKey: string;
13
+ s3ObjectUrl: string;
14
+ };
15
+
16
+ export type AssetProvider = {
17
+ provide: (scope: Construct, name: string, props: AssetProps) => S3Asset;
18
+ };
package/src/index.ts CHANGED
@@ -32,14 +32,7 @@ export {
32
32
  RDSLayerMapping,
33
33
  } from './graphql-api-provider';
34
34
  export { TransformHostProvider, DynamoDbDataSourceOptions } from './transform-host-provider';
35
- export { DeploymentResources, NestedStacks, ResolversFunctionsAndSchema, StackMapping, Template } from './deployment-resources';
36
35
  export { TransformerLog, TransformerLogLevel } from './transformer-log';
37
- export {
38
- AmplifyApiGraphQlResourceStackTemplate,
39
- AppsyncStackCommon,
40
- FunctionDirectiveStack,
41
- HttpsDirectiveStack,
42
- ModelDirectiveStack,
43
- OpenSearchDirectiveStack,
44
- } from './amplify-api-resource-stack-types';
45
36
  export type { TransformParameters } from './transformer-context/transform-parameters';
37
+ export type { NestedStackProvider } from './nested-stack-provider';
38
+ export type { AssetProps, AssetProvider, S3Asset } from './asset-provider';
@@ -0,0 +1,6 @@
1
+ import { Construct } from 'constructs';
2
+ import { Stack } from 'aws-cdk-lib';
3
+
4
+ export type NestedStackProvider = {
5
+ provide: (scope: Construct, name: string) => Stack;
6
+ };
@@ -1,4 +1,4 @@
1
- import { Duration, Stack } from 'aws-cdk-lib';
1
+ import { Duration } from 'aws-cdk-lib';
2
2
  import {
3
3
  BaseDataSource,
4
4
  DynamoDbDataSource,
@@ -11,6 +11,7 @@ import { CfnResolver } from 'aws-cdk-lib/aws-appsync';
11
11
  import { ITable } from 'aws-cdk-lib/aws-dynamodb';
12
12
  import { IFunction, ILayerVersion, Runtime } from 'aws-cdk-lib/aws-lambda';
13
13
  import { IRole } from 'aws-cdk-lib/aws-iam';
14
+ import { Construct } from 'constructs';
14
15
  import {
15
16
  AppSyncFunctionConfigurationProvider,
16
17
  DataSourceOptions,
@@ -29,16 +30,16 @@ export interface DynamoDbDataSourceOptions extends DataSourceOptions {
29
30
  export interface TransformHostProvider {
30
31
  setAPI(api: GraphqlApiBase): void;
31
32
 
32
- addHttpDataSource(name: string, endpoint: string, options?: DataSourceOptions, stack?: Stack): HttpDataSource;
33
- addDynamoDbDataSource(name: string, table: ITable, options?: DynamoDbDataSourceOptions, stack?: Stack): DynamoDbDataSource;
34
- addNoneDataSource(name: string, options?: DataSourceOptions, stack?: Stack): NoneDataSource;
35
- addLambdaDataSource(name: string, lambdaFunction: IFunction, options?: DataSourceOptions, stack?: Stack): LambdaDataSource;
33
+ addHttpDataSource(name: string, endpoint: string, options?: DataSourceOptions, scope?: Construct): HttpDataSource;
34
+ addDynamoDbDataSource(name: string, table: ITable, options?: DynamoDbDataSourceOptions, scope?: Construct): DynamoDbDataSource;
35
+ addNoneDataSource(name: string, options?: DataSourceOptions, scope?: Construct): NoneDataSource;
36
+ addLambdaDataSource(name: string, lambdaFunction: IFunction, options?: DataSourceOptions, scope?: Construct): LambdaDataSource;
36
37
  addSearchableDataSource(
37
38
  name: string,
38
39
  endpoint: string,
39
40
  region: string,
40
41
  options?: SearchableDataSourceOptions,
41
- stack?: Stack,
42
+ scope?: Construct,
42
43
  ): BaseDataSource;
43
44
 
44
45
  addAppSyncFunction: (
@@ -46,7 +47,7 @@ export interface TransformHostProvider {
46
47
  requestMappingTemplate: MappingTemplateProvider,
47
48
  responseMappingTemplate: MappingTemplateProvider,
48
49
  dataSourceName: string,
49
- stack?: Stack,
50
+ scope?: Construct,
50
51
  ) => AppSyncFunctionConfigurationProvider;
51
52
 
52
53
  addResolver: (
@@ -57,7 +58,7 @@ export interface TransformHostProvider {
57
58
  resolverLogicalId?: string,
58
59
  dataSourceName?: string,
59
60
  pipelineConfig?: string[],
60
- stack?: Stack,
61
+ scope?: Construct,
61
62
  ) => CfnResolver;
62
63
 
63
64
  addLambdaFunction: (
@@ -70,7 +71,7 @@ export interface TransformHostProvider {
70
71
  role?: IRole,
71
72
  environment?: { [key: string]: string },
72
73
  timeout?: Duration,
73
- stack?: Stack,
74
+ scope?: Construct,
74
75
  vpc?: VpcConfig,
75
76
  ) => IFunction;
76
77
 
@@ -20,3 +20,4 @@ export {
20
20
  export { TransformerSchemaHelperProvider } from './schema-helper-provider';
21
21
  export { TransformerPreProcessContextProvider } from './transformer-preprocess-context-provider';
22
22
  export { StackManagerProvider } from './stack-manager-provider';
23
+ export { SynthParameters } from './synth-parameters';
@@ -1,11 +1,10 @@
1
- import { CfnParameter, CfnParameterProps, Stack } from 'aws-cdk-lib';
1
+ import { Stack } from 'aws-cdk-lib';
2
+ import { Construct } from 'constructs';
2
3
 
3
4
  export interface StackManagerProvider {
4
- readonly rootStack: Stack;
5
+ readonly scope: Construct;
5
6
  getStack: (stackName: string) => Stack;
6
7
  createStack: (stackName: string) => Stack;
7
8
  hasStack: (stackName: string) => boolean;
8
- getStackFor: (resourceId: string, defaultStackName?: string) => Stack;
9
- addParameter: (name: string, props: CfnParameterProps) => CfnParameter;
10
- getParameter: (name: string) => CfnParameter | void;
9
+ getScopeFor: (resourceId: string, defaultStackName?: string) => Construct;
11
10
  }
@@ -0,0 +1,7 @@
1
+ export type SynthParameters = {
2
+ amplifyEnvironmentName: string;
3
+ apiName: string;
4
+ authenticatedUserRoleName?: string;
5
+ unauthenticatedUserRoleName?: string;
6
+ userPoolId?: string;
7
+ };
@@ -7,6 +7,7 @@ import { StackManagerProvider } from './stack-manager-provider';
7
7
  import { TransformerResourceHelperProvider } from './resource-resource-provider';
8
8
  import { TransformParameters } from './transform-parameters';
9
9
  import { TransformerResolversManagerProvider } from './transformer-resolver-provider';
10
+ import { SynthParameters } from './synth-parameters';
10
11
 
11
12
  export interface TransformerContextMetadataProvider {
12
13
  set<T>(key: string, value: T): void;
@@ -31,6 +32,7 @@ export interface TransformerContextProvider {
31
32
  resourceHelper: TransformerResourceHelperProvider;
32
33
  authConfig: AppSyncAuthConfiguration;
33
34
  transformParameters: TransformParameters;
35
+ synthParameters: SynthParameters;
34
36
 
35
37
  isProjectUsingDataStore(): boolean;
36
38
  getResolverConfig<ResolverConfig>(): ResolverConfig | undefined;
@@ -47,6 +49,7 @@ export type TransformerBeforeStepContextProvider = Pick<
47
49
  | 'getResolverConfig'
48
50
  | 'authConfig'
49
51
  | 'stackManager'
52
+ | 'synthParameters'
50
53
  >;
51
54
 
52
55
  export type TransformerSchemaVisitStepContextProvider = Pick<
@@ -78,6 +81,7 @@ export type TransformerValidationStepContextProvider = Pick<
78
81
  | 'resourceHelper'
79
82
  | 'resolvers'
80
83
  | 'stackManager'
84
+ | 'synthParameters'
81
85
  >;
82
86
 
83
87
  export type TransformerPrepareStepContextProvider = TransformerValidationStepContextProvider;
@@ -1,4 +1,4 @@
1
- import { Stack } from 'aws-cdk-lib';
1
+ import { Construct } from 'constructs';
2
2
  import { GraphQLAPIProvider, MappingTemplateProvider } from '../graphql-api-provider';
3
3
  import { DataSourceProvider } from './transformer-datasource-provider';
4
4
  import { TransformerContextProvider } from './transformer-context-provider';
@@ -11,7 +11,7 @@ export interface TransformerResolverProvider {
11
11
  dataSource?: DataSourceProvider,
12
12
  ) => void;
13
13
  synthesize: (context: TransformerContextProvider, api: GraphQLAPIProvider) => void;
14
- mapToStack: (stack: Stack) => void;
14
+ setScope: (scope: Construct) => void;
15
15
  }
16
16
 
17
17
  export interface TransformerResolversManagerProvider {