@aws-amplify/graphql-transformer-interfaces
Advanced tools
@aws-amplify/graphql-transformer-interfaces - npm Package Compare versions
Comparing version 3.3.1 to 3.3.2
100
API.md
@@ -148,12 +148,2 @@ ## API Report File for "@aws-amplify/graphql-transformer-interfaces" | ||
| // @public (undocumented) | ||
| export interface CustomSqlDataSourceStrategy { | ||
| // (undocumented) | ||
| readonly dataSourceType: DataSourceType; | ||
| // (undocumented) | ||
| readonly fieldName: string; | ||
| // (undocumented) | ||
| readonly typeName: 'Query' | 'Mutation'; | ||
| } | ||
| // Warning: (ae-forgotten-export) The symbol "NoneDataSourceProvider" needs to be exported by the entry point index.d.ts | ||
@@ -177,24 +167,10 @@ // | ||
| // @public (undocumented) | ||
| export type DataSourceProvisionStrategy = DynamoDBProvisionStrategy | SQLLambdaModelProvisionStrategy; | ||
| // @public (undocumented) | ||
| export interface DataSourceStrategiesProvider { | ||
| // (undocumented) | ||
| customSqlDataSourceStrategies: CustomSqlDataSourceStrategy[]; | ||
| } | ||
| // @public (undocumented) | ||
| export interface DataSourceType { | ||
| dataSourceStrategies: Record<string, ModelDataSourceStrategy>; | ||
| // (undocumented) | ||
| dbType: DBType; | ||
| // (undocumented) | ||
| provisionDB: boolean; | ||
| // (undocumented) | ||
| provisionStrategy: DataSourceProvisionStrategy; | ||
| sqlDirectiveDataSourceStrategies?: SqlDirectiveDataSourceStrategy[]; | ||
| } | ||
| // @public (undocumented) | ||
| export type DBType = 'DDB' | SQLDBType; | ||
| // @public (undocumented) | ||
| export interface DefaultDynamoDbModelDataSourceStrategy extends ModelDataSourceStrategyBase { | ||
@@ -214,10 +190,2 @@ // (undocumented) | ||
| // @public (undocumented) | ||
| export const enum DynamoDBProvisionStrategy { | ||
| // (undocumented) | ||
| AMPLIFY_TABLE = "AMPLIFY_TABLE", | ||
| // (undocumented) | ||
| DEFAULT = "DEFAULT" | ||
| } | ||
| // @public (undocumented) | ||
| export type FieldMapEntry = { | ||
@@ -281,5 +249,8 @@ originalFieldName: string; | ||
| // @public (undocumented) | ||
| export type ModelDataSourceStrategyDbType = 'DYNAMODB' | 'MYSQL' | 'POSTGRES'; | ||
| export type ModelDataSourceStrategyDbType = 'DYNAMODB' | ModelDataSourceStrategySqlDbType; | ||
| // @public (undocumented) | ||
| export type ModelDataSourceStrategySqlDbType = 'MYSQL' | 'POSTGRES'; | ||
| // @public (undocumented) | ||
| export type ModelFieldMap = { | ||
@@ -332,2 +303,8 @@ addMappedField: (entry: FieldMapEntry) => ModelFieldMap; | ||
| // @public (undocumented) | ||
| export interface RDSLayerMappingProvider { | ||
| // (undocumented) | ||
| rdsLayerMapping?: RDSLayerMapping; | ||
| } | ||
| // @public (undocumented) | ||
| type ReadonlyArray_2<T> = Readonly<Array<Readonly<T>>>; | ||
@@ -377,3 +354,12 @@ export { ReadonlyArray_2 as ReadonlyArray } | ||
| // @public (undocumented) | ||
| export type SQLDBType = 'MySQL' | 'Postgres'; | ||
| export interface SqlDirectiveDataSourceStrategy { | ||
| // (undocumented) | ||
| readonly customSqlStatements?: Record<string, string>; | ||
| // (undocumented) | ||
| readonly fieldName: string; | ||
| // (undocumented) | ||
| readonly strategy: SQLLambdaModelDataSourceStrategy; | ||
| // (undocumented) | ||
| readonly typeName: 'Query' | 'Mutation'; | ||
| } | ||
@@ -383,7 +369,5 @@ // @public (undocumented) | ||
| // (undocumented) | ||
| readonly customSqlStatements?: Record<string, string>; | ||
| // (undocumented) | ||
| readonly dbConnectionConfig: SqlModelDataSourceDbConnectionConfig; | ||
| // (undocumented) | ||
| readonly dbType: 'MYSQL' | 'POSTGRES'; | ||
| readonly dbType: ModelDataSourceStrategySqlDbType; | ||
| // (undocumented) | ||
@@ -398,8 +382,2 @@ readonly name: string; | ||
| // @public (undocumented) | ||
| export const enum SQLLambdaModelProvisionStrategy { | ||
| // (undocumented) | ||
| DEFAULT = "DEFAULT" | ||
| } | ||
| // @public (undocumented) | ||
| export interface SqlModelDataSourceDbConnectionConfig { | ||
@@ -469,3 +447,3 @@ // (undocumented) | ||
| // @public (undocumented) | ||
| export type TransformerBeforeStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'modelToDatasourceMap' | 'customSqlDataSourceStrategies' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'authConfig' | 'stackManager' | 'synthParameters'>; | ||
| export type TransformerBeforeStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'dataSourceStrategies' | 'sqlDirectiveDataSourceStrategies' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'authConfig' | 'stackManager' | 'synthParameters'>; | ||
@@ -475,7 +453,7 @@ // @public (undocumented) | ||
| // (undocumented) | ||
| get<T>(key: string): T | undefined; | ||
| get: <T>(key: string) => T | undefined; | ||
| // (undocumented) | ||
| has(key: string): boolean; | ||
| has: (key: string) => boolean; | ||
| // (undocumented) | ||
| set<T>(key: string, value: T): void; | ||
| set: <T>(key: string, value: T) => void; | ||
| } | ||
@@ -542,3 +520,3 @@ | ||
| // @public (undocumented) | ||
| export interface TransformerContextProvider { | ||
| export interface TransformerContextProvider extends DataSourceStrategiesProvider, RDSLayerMappingProvider { | ||
| // (undocumented) | ||
@@ -549,20 +527,12 @@ api: GraphQLAPIProvider; | ||
| // (undocumented) | ||
| customQueries: Map<string, string>; | ||
| // (undocumented) | ||
| customSqlDataSourceStrategies?: CustomSqlDataSourceStrategy[]; | ||
| // (undocumented) | ||
| dataSources: TransformerDataSourceManagerProvider; | ||
| // (undocumented) | ||
| datasourceSecretParameterLocations: Map<string, TransformerSecrets>; | ||
| getResolverConfig: <ResolverConfig>() => ResolverConfig | undefined; | ||
| // (undocumented) | ||
| getResolverConfig<ResolverConfig>(): ResolverConfig | undefined; | ||
| // (undocumented) | ||
| inputDocument: DocumentNode; | ||
| // (undocumented) | ||
| isProjectUsingDataStore(): boolean; | ||
| isProjectUsingDataStore: () => boolean; | ||
| // (undocumented) | ||
| metadata: TransformerContextMetadataProvider; | ||
| // (undocumented) | ||
| modelToDatasourceMap: Map<string, DataSourceType>; | ||
| // (undocumented) | ||
| output: TransformerContextOutputProvider; | ||
@@ -572,4 +542,2 @@ // (undocumented) | ||
| // (undocumented) | ||
| readonly rdsLayerMapping?: RDSLayerMapping; | ||
| // (undocumented) | ||
| resolvers: TransformerResolversManagerProvider; | ||
@@ -579,6 +547,2 @@ // (undocumented) | ||
| // (undocumented) | ||
| readonly sqlLambdaProvisionedConcurrencyConfig?: ProvisionedConcurrencyConfig; | ||
| // (undocumented) | ||
| readonly sqlLambdaVpcConfig?: VpcConfig; | ||
| // (undocumented) | ||
| stackManager: StackManagerProvider; | ||
@@ -832,3 +796,3 @@ // (undocumented) | ||
| // @public (undocumented) | ||
| export type TransformerSchemaVisitStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'modelToDatasourceMap' | 'customSqlDataSourceStrategies' | 'output' | 'providerRegistry' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper'>; | ||
| export type TransformerSchemaVisitStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'dataSourceStrategies' | 'sqlDirectiveDataSourceStrategies' | 'output' | 'providerRegistry' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper'>; | ||
@@ -844,3 +808,3 @@ // @public (undocumented) | ||
| // @public (undocumented) | ||
| export type TransformerValidationStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'modelToDatasourceMap' | 'customSqlDataSourceStrategies' | 'output' | 'providerRegistry' | 'dataSources' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper' | 'resolvers' | 'stackManager' | 'synthParameters'>; | ||
| export type TransformerValidationStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'dataSourceStrategies' | 'sqlDirectiveDataSourceStrategies' | 'output' | 'providerRegistry' | 'dataSources' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper' | 'resolvers' | 'stackManager' | 'synthParameters'>; | ||
@@ -847,0 +811,0 @@ // @public (undocumented) |
@@ -6,2 +6,6 @@ # Change Log | ||
| ## [3.3.2](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-transformer-interfaces@3.3.1...@aws-amplify/graphql-transformer-interfaces@3.3.2) (2023-12-06) | ||
| **Note:** Version bump only for package @aws-amplify/graphql-transformer-interfaces | ||
| ## [3.3.1](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-transformer-interfaces@3.3.0...@aws-amplify/graphql-transformer-interfaces@3.3.1) (2023-11-22) | ||
@@ -8,0 +12,0 @@ |
@@ -1,2 +0,1 @@ | ||
| import { DataSourceType } from '../transformer-context/transformer-datasource-provider'; | ||
| export type ModelDataSourceStrategy = DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy; | ||
@@ -6,3 +5,4 @@ export interface ModelDataSourceStrategyBase { | ||
| } | ||
| export type ModelDataSourceStrategyDbType = 'DYNAMODB' | 'MYSQL' | 'POSTGRES'; | ||
| export type ModelDataSourceStrategyDbType = 'DYNAMODB' | ModelDataSourceStrategySqlDbType; | ||
| export type ModelDataSourceStrategySqlDbType = 'MYSQL' | 'POSTGRES'; | ||
| export interface DefaultDynamoDbModelDataSourceStrategy extends ModelDataSourceStrategyBase { | ||
@@ -18,6 +18,5 @@ readonly dbType: 'DYNAMODB'; | ||
| readonly name: string; | ||
| readonly dbType: 'MYSQL' | 'POSTGRES'; | ||
| readonly dbType: ModelDataSourceStrategySqlDbType; | ||
| readonly dbConnectionConfig: SqlModelDataSourceDbConnectionConfig; | ||
| readonly vpcConfiguration?: VpcConfig; | ||
| readonly customSqlStatements?: Record<string, string>; | ||
| readonly sqlLambdaProvisionedConcurrencyConfig?: ProvisionedConcurrencyConfig; | ||
@@ -44,9 +43,11 @@ } | ||
| } | ||
| export interface CustomSqlDataSourceStrategy { | ||
| export interface SqlDirectiveDataSourceStrategy { | ||
| readonly typeName: 'Query' | 'Mutation'; | ||
| readonly fieldName: string; | ||
| readonly dataSourceType: DataSourceType; | ||
| readonly strategy: SQLLambdaModelDataSourceStrategy; | ||
| readonly customSqlStatements?: Record<string, string>; | ||
| } | ||
| export interface DataSourceStrategiesProvider { | ||
| customSqlDataSourceStrategies: CustomSqlDataSourceStrategy[]; | ||
| dataSourceStrategies: Record<string, ModelDataSourceStrategy>; | ||
| sqlDirectiveDataSourceStrategies?: SqlDirectiveDataSourceStrategy[]; | ||
| } | ||
@@ -58,2 +59,5 @@ export interface RDSLayerMapping { | ||
| } | ||
| export interface RDSLayerMappingProvider { | ||
| rdsLayerMapping?: RDSLayerMapping; | ||
| } | ||
| //# sourceMappingURL=types.d.ts.map |
@@ -1,2 +0,2 @@ | ||
| export { DataSourceProvider, TransformerDataSourceManagerProvider, AppSyncDataSourceType, DataSourceInstance, DataSourceType, DBType, DataSourceProvisionStrategy, DynamoDBProvisionStrategy, SQLLambdaModelProvisionStrategy, SQLDBType, } from './transformer-datasource-provider'; | ||
| export { DataSourceProvider, TransformerDataSourceManagerProvider, AppSyncDataSourceType, DataSourceInstance, } from './transformer-datasource-provider'; | ||
| export { TransformerContextOutputProvider } from './transformer-context-output-provider'; | ||
@@ -3,0 +3,0 @@ export { TransformerProviderRegistry } from './transformer-provider-registry'; |
@@ -17,8 +17,6 @@ "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| exports.SQLLambdaModelProvisionStrategy = exports.DynamoDBProvisionStrategy = exports.AppSyncDataSourceType = void 0; | ||
| exports.AppSyncDataSourceType = void 0; | ||
| var transformer_datasource_provider_1 = require("./transformer-datasource-provider"); | ||
| Object.defineProperty(exports, "AppSyncDataSourceType", { enumerable: true, get: function () { return transformer_datasource_provider_1.AppSyncDataSourceType; } }); | ||
| Object.defineProperty(exports, "DynamoDBProvisionStrategy", { enumerable: true, get: function () { return transformer_datasource_provider_1.DynamoDBProvisionStrategy; } }); | ||
| Object.defineProperty(exports, "SQLLambdaModelProvisionStrategy", { enumerable: true, get: function () { return transformer_datasource_provider_1.SQLLambdaModelProvisionStrategy; } }); | ||
| __exportStar(require("./resource-resource-provider"), exports); | ||
| //# sourceMappingURL=index.js.map |
| import { DocumentNode } from 'graphql'; | ||
| import { AppSyncAuthConfiguration, GraphQLAPIProvider } from '../graphql-api-provider'; | ||
| import { CustomSqlDataSourceStrategy, ProvisionedConcurrencyConfig, RDSLayerMapping, VpcConfig } from '../model-datasource'; | ||
| import { TransformerDataSourceManagerProvider, DataSourceType } from './transformer-datasource-provider'; | ||
| import { DataSourceStrategiesProvider, RDSLayerMappingProvider } from '../model-datasource'; | ||
| import { TransformerDataSourceManagerProvider } from './transformer-datasource-provider'; | ||
| import { TransformerProviderRegistry } from './transformer-provider-registry'; | ||
@@ -13,5 +13,5 @@ import { TransformerContextOutputProvider } from './transformer-context-output-provider'; | ||
| export interface TransformerContextMetadataProvider { | ||
| set<T>(key: string, value: T): void; | ||
| get<T>(key: string): T | undefined; | ||
| has(key: string): boolean; | ||
| set: <T>(key: string, value: T) => void; | ||
| get: <T>(key: string) => T | undefined; | ||
| has: (key: string) => boolean; | ||
| } | ||
@@ -21,3 +21,3 @@ export type TransformerSecrets = { | ||
| }; | ||
| export interface TransformerContextProvider { | ||
| export interface TransformerContextProvider extends DataSourceStrategiesProvider, RDSLayerMappingProvider { | ||
| metadata: TransformerContextMetadataProvider; | ||
@@ -28,5 +28,2 @@ resolvers: TransformerResolversManagerProvider; | ||
| inputDocument: DocumentNode; | ||
| modelToDatasourceMap: Map<string, DataSourceType>; | ||
| customSqlDataSourceStrategies?: CustomSqlDataSourceStrategy[]; | ||
| datasourceSecretParameterLocations: Map<string, TransformerSecrets>; | ||
| output: TransformerContextOutputProvider; | ||
@@ -39,14 +36,10 @@ stackManager: StackManagerProvider; | ||
| synthParameters: SynthParameters; | ||
| customQueries: Map<string, string>; | ||
| isProjectUsingDataStore(): boolean; | ||
| getResolverConfig<ResolverConfig>(): ResolverConfig | undefined; | ||
| readonly sqlLambdaVpcConfig?: VpcConfig; | ||
| readonly rdsLayerMapping?: RDSLayerMapping; | ||
| readonly sqlLambdaProvisionedConcurrencyConfig?: ProvisionedConcurrencyConfig; | ||
| isProjectUsingDataStore: () => boolean; | ||
| getResolverConfig: <ResolverConfig>() => ResolverConfig | undefined; | ||
| } | ||
| export type TransformerBeforeStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'modelToDatasourceMap' | 'customSqlDataSourceStrategies' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'authConfig' | 'stackManager' | 'synthParameters'>; | ||
| export type TransformerSchemaVisitStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'modelToDatasourceMap' | 'customSqlDataSourceStrategies' | 'output' | 'providerRegistry' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper'>; | ||
| export type TransformerValidationStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'modelToDatasourceMap' | 'customSqlDataSourceStrategies' | 'output' | 'providerRegistry' | 'dataSources' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper' | 'resolvers' | 'stackManager' | 'synthParameters'>; | ||
| export type TransformerBeforeStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'dataSourceStrategies' | 'sqlDirectiveDataSourceStrategies' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'authConfig' | 'stackManager' | 'synthParameters'>; | ||
| export type TransformerSchemaVisitStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'dataSourceStrategies' | 'sqlDirectiveDataSourceStrategies' | 'output' | 'providerRegistry' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper'>; | ||
| export type TransformerValidationStepContextProvider = Pick<TransformerContextProvider, 'inputDocument' | 'dataSourceStrategies' | 'sqlDirectiveDataSourceStrategies' | 'output' | 'providerRegistry' | 'dataSources' | 'transformParameters' | 'isProjectUsingDataStore' | 'getResolverConfig' | 'metadata' | 'authConfig' | 'resourceHelper' | 'resolvers' | 'stackManager' | 'synthParameters'>; | ||
| export type TransformerPrepareStepContextProvider = TransformerValidationStepContextProvider; | ||
| export type TransformerTransformSchemaStepContextProvider = TransformerValidationStepContextProvider; | ||
| //# sourceMappingURL=transformer-context-provider.d.ts.map |
@@ -25,17 +25,2 @@ import { BackedDataSource, HttpDataSource } from 'aws-cdk-lib/aws-appsync'; | ||
| } | ||
| export type DBType = 'DDB' | SQLDBType; | ||
| export type SQLDBType = 'MySQL' | 'Postgres'; | ||
| export type DataSourceProvisionStrategy = DynamoDBProvisionStrategy | SQLLambdaModelProvisionStrategy; | ||
| export declare const enum DynamoDBProvisionStrategy { | ||
| DEFAULT = "DEFAULT", | ||
| AMPLIFY_TABLE = "AMPLIFY_TABLE" | ||
| } | ||
| export declare const enum SQLLambdaModelProvisionStrategy { | ||
| DEFAULT = "DEFAULT" | ||
| } | ||
| export interface DataSourceType { | ||
| dbType: DBType; | ||
| provisionDB: boolean; | ||
| provisionStrategy: DataSourceProvisionStrategy; | ||
| } | ||
| //# sourceMappingURL=transformer-datasource-provider.d.ts.map |
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| exports.SQLLambdaModelProvisionStrategy = exports.DynamoDBProvisionStrategy = exports.AppSyncDataSourceType = void 0; | ||
| exports.AppSyncDataSourceType = void 0; | ||
| var AppSyncDataSourceType; | ||
@@ -13,11 +13,2 @@ (function (AppSyncDataSourceType) { | ||
| })(AppSyncDataSourceType = exports.AppSyncDataSourceType || (exports.AppSyncDataSourceType = {})); | ||
| var DynamoDBProvisionStrategy; | ||
| (function (DynamoDBProvisionStrategy) { | ||
| DynamoDBProvisionStrategy["DEFAULT"] = "DEFAULT"; | ||
| DynamoDBProvisionStrategy["AMPLIFY_TABLE"] = "AMPLIFY_TABLE"; | ||
| })(DynamoDBProvisionStrategy = exports.DynamoDBProvisionStrategy || (exports.DynamoDBProvisionStrategy = {})); | ||
| var SQLLambdaModelProvisionStrategy; | ||
| (function (SQLLambdaModelProvisionStrategy) { | ||
| SQLLambdaModelProvisionStrategy["DEFAULT"] = "DEFAULT"; | ||
| })(SQLLambdaModelProvisionStrategy = exports.SQLLambdaModelProvisionStrategy || (exports.SQLLambdaModelProvisionStrategy = {})); | ||
| //# sourceMappingURL=transformer-datasource-provider.js.map |
| { | ||
| "name": "@aws-amplify/graphql-transformer-interfaces", | ||
| "version": "3.3.1", | ||
| "version": "3.3.2", | ||
| "description": "Amplify GraphQL transformer interface definitions", | ||
@@ -50,5 +50,9 @@ "repository": { | ||
| ], | ||
| "collectCoverage": true | ||
| "collectCoverage": true, | ||
| "coverageReporters": [ | ||
| "clover", | ||
| "text" | ||
| ] | ||
| }, | ||
| "gitHead": "5256b5955ee204dd56f8074a43406852f8206c54" | ||
| "gitHead": "6e450d037cf84098b51ce787a99d6023cbc0e39d" | ||
| } |
@@ -1,3 +0,1 @@ | ||
| import { DataSourceType } from '../transformer-context/transformer-datasource-provider'; | ||
| // ######################################################################################################################################### | ||
@@ -20,6 +18,13 @@ // If you change types in this file (the internal implementation), be sure to make corresponding necessary changes to | ||
| // TODO: Make this the source of truth for database type definitions used throughout the construct & transformer | ||
| export type ModelDataSourceStrategyDbType = 'DYNAMODB' | 'MYSQL' | 'POSTGRES'; | ||
| /** | ||
| * All supported database types that can be used to resolve models. | ||
| */ | ||
| export type ModelDataSourceStrategyDbType = 'DYNAMODB' | ModelDataSourceStrategySqlDbType; | ||
| /** | ||
| * All supported SQL database types that can be used to resolve models. | ||
| */ | ||
| export type ModelDataSourceStrategySqlDbType = 'MYSQL' | 'POSTGRES'; | ||
| /** | ||
| * Use default CloudFormation type 'AWS::DynamoDB::Table' to provision table. | ||
@@ -43,2 +48,4 @@ */ | ||
| * | ||
| * Note: The implementation type is different from the interface type: the interface type contains the custom SQL statements that are | ||
| * reference by the `@sql` `reference` attribute, while the implementation moves those into the SqlDirectiveDataSourceStrategy type. | ||
| */ | ||
@@ -55,3 +62,3 @@ export interface SQLLambdaModelDataSourceStrategy extends ModelDataSourceStrategyBase { | ||
| */ | ||
| readonly dbType: 'MYSQL' | 'POSTGRES'; | ||
| readonly dbType: ModelDataSourceStrategySqlDbType; | ||
@@ -69,8 +76,2 @@ /** | ||
| /** | ||
| * Custom SQL statements. The key is the value of the `references` attribute of the `@sql` directive in the `schema`; the value is the SQL | ||
| * to be executed. | ||
| */ | ||
| readonly customSqlStatements?: Record<string, string>; | ||
| /** | ||
| * The configuration for the provisioned concurrency of the Lambda. | ||
@@ -144,20 +145,43 @@ */ | ||
| export interface CustomSqlDataSourceStrategy { | ||
| /** | ||
| * The internal implementation type for defining a ModelDataSourceStrategy used to resolve a field annotated with a `@sql` directive. | ||
| * | ||
| * Note: The implementation type is different from the interface type: it directly contains the SQL statement to be executed rather than | ||
| * passing a map. | ||
| */ | ||
| export interface SqlDirectiveDataSourceStrategy { | ||
| /** The built-in type (either "Query" or "Mutation") with which the custom SQL is associated */ | ||
| readonly typeName: 'Query' | 'Mutation'; | ||
| /** The field name with which the custom SQL is associated */ | ||
| readonly fieldName: string; | ||
| // TODO: Replace this when we support heterogeneous SQL data sources in a single API | ||
| readonly dataSourceType: DataSourceType; | ||
| /** The strategy used to create the datasource that will resolve the custom SQL statement. */ | ||
| readonly strategy: SQLLambdaModelDataSourceStrategy; | ||
| /** | ||
| * Custom SQL statements to be executed to resolve this field. | ||
| * | ||
| * Note: It's overkill to make this a map: a SqlDirectiveDataSourceStrategy will only ever use at most one statement (and maybe not even | ||
| * that if the directive uses inline statements). However, to avoid having to parse the directive configuration in multiple places, we'll | ||
| * pass the entire map as specified in the CDK construct definition, and let the directive transformer use it to look up references. | ||
| */ | ||
| readonly customSqlStatements?: Record<string, string>; | ||
| } | ||
| /** | ||
| * Defines types that vend a dataSourceStrategies and optional customSqlDataSourceStrategies field. Primarily used for transformer context. | ||
| */ | ||
| export interface DataSourceStrategiesProvider { | ||
| /** Maps GraphQL model names to the ModelDataSourceStrategy used to resolve it. The key of the record is the GraphQL type name. */ | ||
| // TODO: Add this back during combine feature | ||
| // dataSourceStrategies: Record<string, ModelDataSourceStrategy>; | ||
| dataSourceStrategies: Record<string, ModelDataSourceStrategy>; | ||
| /** Maps custom Query and Mutation fields to the ModelDataSourceStrategy used to resolve them. */ | ||
| customSqlDataSourceStrategies: CustomSqlDataSourceStrategy[]; | ||
| sqlDirectiveDataSourceStrategies?: SqlDirectiveDataSourceStrategy[]; | ||
| } | ||
| /** | ||
| * Maps a given AWS region to the SQL Lambda layer version ARN for that region. TODO: Rename to SQLLambdaLayerMapping | ||
| * Maps a given AWS region to the SQL Lambda layer version ARN for that region. TODO: Once we remove SQL imports from Gen1 CLI, remove this | ||
| * from the transformer interfaces package in favor of the model generator, which is the only place that needs it now that we always resolve | ||
| * the layer mapping at deploy time. | ||
| */ | ||
@@ -169,1 +193,9 @@ export interface RDSLayerMapping { | ||
| } | ||
| /** | ||
| * Defines types that vend an rdsLayerMapping field. This is used solely for the Gen1 CLI import API flow, since wiring the custom resource | ||
| * provider used by the CDK isn't worth the cost. TODO: Remove this once we remove SQL imports from Gen1 CLI. | ||
| */ | ||
| export interface RDSLayerMappingProvider { | ||
| rdsLayerMapping?: RDSLayerMapping; | ||
| } |
@@ -6,8 +6,2 @@ export { | ||
| DataSourceInstance, | ||
| DataSourceType, | ||
| DBType, | ||
| DataSourceProvisionStrategy, | ||
| DynamoDBProvisionStrategy, | ||
| SQLLambdaModelProvisionStrategy, | ||
| SQLDBType, | ||
| } from './transformer-datasource-provider'; | ||
@@ -14,0 +8,0 @@ export { TransformerContextOutputProvider } from './transformer-context-output-provider'; |
| import { DocumentNode } from 'graphql'; | ||
| import { AppSyncAuthConfiguration, GraphQLAPIProvider } from '../graphql-api-provider'; | ||
| import { CustomSqlDataSourceStrategy, ProvisionedConcurrencyConfig, RDSLayerMapping, VpcConfig } from '../model-datasource'; | ||
| import { TransformerDataSourceManagerProvider, DataSourceType } from './transformer-datasource-provider'; | ||
| import { DataSourceStrategiesProvider, RDSLayerMappingProvider } from '../model-datasource'; | ||
| import { TransformerDataSourceManagerProvider } from './transformer-datasource-provider'; | ||
| import { TransformerProviderRegistry } from './transformer-provider-registry'; | ||
@@ -14,5 +14,5 @@ import { TransformerContextOutputProvider } from './transformer-context-output-provider'; | ||
| export interface TransformerContextMetadataProvider { | ||
| set<T>(key: string, value: T): void; | ||
| get<T>(key: string): T | undefined; | ||
| has(key: string): boolean; | ||
| set: <T>(key: string, value: T) => void; | ||
| get: <T>(key: string) => T | undefined; | ||
| has: (key: string) => boolean; | ||
| } | ||
@@ -22,3 +22,3 @@ | ||
| export interface TransformerContextProvider { | ||
| export interface TransformerContextProvider extends DataSourceStrategiesProvider, RDSLayerMappingProvider { | ||
| metadata: TransformerContextMetadataProvider; | ||
@@ -30,5 +30,2 @@ resolvers: TransformerResolversManagerProvider; | ||
| inputDocument: DocumentNode; | ||
| modelToDatasourceMap: Map<string, DataSourceType>; | ||
| customSqlDataSourceStrategies?: CustomSqlDataSourceStrategy[]; | ||
| datasourceSecretParameterLocations: Map<string, TransformerSecrets>; | ||
| output: TransformerContextOutputProvider; | ||
@@ -41,9 +38,5 @@ stackManager: StackManagerProvider; | ||
| synthParameters: SynthParameters; | ||
| customQueries: Map<string, string>; | ||
| isProjectUsingDataStore(): boolean; | ||
| getResolverConfig<ResolverConfig>(): ResolverConfig | undefined; | ||
| readonly sqlLambdaVpcConfig?: VpcConfig; | ||
| readonly rdsLayerMapping?: RDSLayerMapping; | ||
| readonly sqlLambdaProvisionedConcurrencyConfig?: ProvisionedConcurrencyConfig; | ||
| isProjectUsingDataStore: () => boolean; | ||
| getResolverConfig: <ResolverConfig>() => ResolverConfig | undefined; | ||
| } | ||
@@ -54,4 +47,4 @@ | ||
| | 'inputDocument' | ||
| | 'modelToDatasourceMap' | ||
| | 'customSqlDataSourceStrategies' | ||
| | 'dataSourceStrategies' | ||
| | 'sqlDirectiveDataSourceStrategies' | ||
| | 'transformParameters' | ||
@@ -68,4 +61,4 @@ | 'isProjectUsingDataStore' | ||
| | 'inputDocument' | ||
| | 'modelToDatasourceMap' | ||
| | 'customSqlDataSourceStrategies' | ||
| | 'dataSourceStrategies' | ||
| | 'sqlDirectiveDataSourceStrategies' | ||
| | 'output' | ||
@@ -84,4 +77,4 @@ | 'providerRegistry' | ||
| | 'inputDocument' | ||
| | 'modelToDatasourceMap' | ||
| | 'customSqlDataSourceStrategies' | ||
| | 'dataSourceStrategies' | ||
| | 'sqlDirectiveDataSourceStrategies' | ||
| | 'output' | ||
@@ -88,0 +81,0 @@ | 'providerRegistry' |
@@ -29,44 +29,1 @@ import { BackedDataSource, HttpDataSource } from 'aws-cdk-lib/aws-appsync'; | ||
| export interface DataSourceProvider extends BackedDataSource {} | ||
| /** | ||
| * Supported transformable database types. TODO: Remove this when we normalize database type handling throughout | ||
| */ | ||
| export type DBType = 'DDB' | SQLDBType; | ||
| /** | ||
| * Supported transformable SQL database types. TODO: Remove this when we normalize database type handling throughout | ||
| */ | ||
| export type SQLDBType = 'MySQL' | 'Postgres'; | ||
| // TODO: add strategy for the RDS. TODO: Move this to amplify-graphql-api-construct | ||
| export type DataSourceProvisionStrategy = DynamoDBProvisionStrategy | SQLLambdaModelProvisionStrategy; | ||
| /** | ||
| * Provisioning configuration for a DynamoDB datasource. TODO: Remove this type in favor of strategy definitions in | ||
| * amplify-graphql-api-construct | ||
| */ | ||
| export const enum DynamoDBProvisionStrategy { | ||
| /** | ||
| * Use default CloudFormation resource of `AWS::DynamoDB::Table` | ||
| */ | ||
| DEFAULT = 'DEFAULT', | ||
| /** | ||
| * Use custom resource type `Custom::AmplifyDynamoDBTable` | ||
| */ | ||
| AMPLIFY_TABLE = 'AMPLIFY_TABLE', | ||
| } | ||
| // TODO: Remove this type in favor of fully-specified SQLLambdaModelDataSourceStrategy from amplify-graphql-api-construct | ||
| export const enum SQLLambdaModelProvisionStrategy { | ||
| /** | ||
| * A strategy that creates a Lambda to connect to a pre-existing SQL table to resolve model data. | ||
| */ | ||
| DEFAULT = 'DEFAULT', | ||
| } | ||
| // TODO: Replace usages of this type with ModelDataSourceStrategy | ||
| export interface DataSourceType { | ||
| dbType: DBType; | ||
| provisionDB: boolean; | ||
| provisionStrategy: DataSourceProvisionStrategy; | ||
| } |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.65%
550868
- Lines of code
- decreased by-2.65%
1873
No dependency changes