feat(service-spec-importers): registry schema importers accept patches

.projenrc.ts

@@ -156,20 +156,20 @@ const awsServiceSpec = new TypeScriptWorkspace({
   releasableCommits: pj.ReleasableCommits.featuresAndFixes('. ../service-spec-types ../../../sources'),
 });
 
-awsServiceSpec.tsconfigDev.addInclude('scripts');
+awsServiceSpec.tsconfigDev.addInclude('build');
 
 // Needs to be added to 'compile' task, because the integ tests will 'compile' everything (but not run the tests and linter).
 awsServiceSpec.compileTask.prependSpawn(
   awsServiceSpec.tasks.addTask('build:db', {
-    exec: `ts-node scripts/build-db.ts`,
+    exec: `ts-node build/build-db.ts`,
   }),
 );
 
 awsServiceSpec.gitignore.addPatterns('db.json');
 awsServiceSpec.gitignore.addPatterns('db.json.gz');
 awsServiceSpec.gitignore.addPatterns('build-report');
 awsServiceSpec.npmignore?.addPatterns('build-report');
-awsServiceSpec.npmignore?.addPatterns('/scripts/');
+awsServiceSpec.npmignore?.addPatterns('/build/');
 
 // Add integration test with aws-cdk
 new AwsCdkIntegrationTest(repo, {

packages/@aws-cdk/aws-service-spec/scripts/full-database.ts → packages/@aws-cdk/aws-service-spec/build/full-database.ts

@@ -3,6 +3,8 @@ import { SpecDatabase } from '@aws-cdk/service-spec-types';
 import { DatabaseBuilder, DatabaseBuilderOptions, ReportAudience } from '@aws-cdk/service-spec-importers';
 import { Augmentations } from './augmentations';
 import { Scrutinies } from './scrutinies';
+import { patchSamTemplateSpec } from './patches/sam-patches';
+import { patchCloudFormationRegistry } from './patches/registry-patches';
 
 const SOURCES = path.join(__dirname, '../../../../sources');
 
@@ -14,8 +16,8 @@ export class FullDatabase extends DatabaseBuilder {
 
     this.importCloudFormationResourceSpec(path.join(SOURCES, 'CloudFormationResourceSpecification'))
       .importSamResourceSpec(path.join(SOURCES, 'CloudFormationResourceSpecification/us-east-1/100_sam'))
-      .importCloudFormationRegistryResources(path.join(SOURCES, 'CloudFormationSchema'))
-      .importSamJsonSchema(path.join(SOURCES, 'SAMSpec/sam.schema.json'))
+      .importCloudFormationRegistryResources(path.join(SOURCES, 'CloudFormationSchema'), patchCloudFormationRegistry)
+      .importSamJsonSchema(path.join(SOURCES, 'SAMSpec/sam.schema.json'), patchSamTemplateSpec)
       .importCloudFormationDocs(path.join(SOURCES, 'CloudFormationDocumentation/CloudFormationDocumentation.json'))
       .importStatefulResources(path.join(SOURCES, 'StatefulResources/StatefulResources.json'))
       .importCannedMetrics(

packages/@aws-cdk/aws-service-spec/build/patches/registry-patches.ts

@@ -0,0 +1,10 @@
+import { EXCEPTIONS_PATCHERS } from './service-patches';
+import { patching, patches } from '@aws-cdk/service-spec-importers';
+
+/**
+ * Patchers that apply to the CloudFormation Registry source files
+ */
+export const patchCloudFormationRegistry = patching.makeCompositePatcher(
+  patches.patchCloudFormationRegistry,
+  ...EXCEPTIONS_PATCHERS,
+);

packages/@aws-cdk/service-spec-importers/src/patches/sam-patches.ts → packages/@aws-cdk/aws-service-spec/build/patches/sam-patches.ts

@@ -1,34 +1,34 @@
-import { normalizeJsonSchema } from './json-schema-patches';
+import { patching, patches, types } from '@aws-cdk/service-spec-importers';
 import { addDefinitions, replaceDefinition, replaceDefinitionProperty } from './service-patches/core';
-import { JsonObjectLens, JsonObjectPatcher, Patcher, Reason, makeCompositePatcher, onlyObjects } from '../patching';
-import { jsonschema } from '../types';
 
-const serverlessApi: Patcher<JsonObjectLens> = (lens) => {
+const serverlessApi: patching.Patcher<patching.JsonObjectLens> = (lens) => {
   replaceSamResourceProperty(
     'AWS::Serverless::Api',
     'EndpointConfiguration',
     {
       anyOf: [{ $ref: '#/definitions/AWS::Serverless::Api.EndpointConfiguration' }, { type: 'string' }],
     },
-    Reason.backwardsCompat('Make the EndpointConfiguration property of AWS::Serverless::Api have a union type'),
+    patching.Reason.backwardsCompat(
+      'Make the EndpointConfiguration property of AWS::Serverless::Api have a union type',
+    ),
   )(lens);
 
   replaceSamResourceProperty(
     'AWS::Serverless::Api',
     'GatewayResponses',
     { type: 'object' },
-    Reason.backwardsCompat('Make the GatewayResponses property of AWS::Serverless::Api accept JSON'),
+    patching.Reason.backwardsCompat('Make the GatewayResponses property of AWS::Serverless::Api accept JSON'),
   )(lens);
   replaceSamResourceProperty(
     'AWS::Serverless::Api',
     'Models',
     { type: 'object' },
-    Reason.backwardsCompat('Make the Models property of AWS::Serverless::Api accept JSON'),
+    patching.Reason.backwardsCompat('Make the Models property of AWS::Serverless::Api accept JSON'),
   )(lens);
 };
 
-const serverlessFunction: Patcher<JsonObjectLens> = (lens) => {
-  const hooksReason = Reason.sourceIssue('Use of pattern properties but type is actually well-known.');
+const serverlessFunction: patching.Patcher<patching.JsonObjectLens> = (lens) => {
+  const hooksReason = patching.Reason.sourceIssue('Use of pattern properties but type is actually well-known.');
 
   replaceDefinitionProperty(
     'AWS::Serverless::Function.DeploymentPreference',
@@ -59,7 +59,7 @@ const serverlessFunction: Patcher<JsonObjectLens> = (lens) => {
     {
       type: 'object',
     },
-    Reason.backwardsCompat(
+    patching.Reason.backwardsCompat(
       'This was once typed as Json, and adding types now is a breaking change. Keep them as Json forever',
     ),
   )(lens);
@@ -74,18 +74,18 @@ const serverlessFunction: Patcher<JsonObjectLens> = (lens) => {
       type: 'object',
       required: ['SkillId'],
     },
-    Reason.sourceIssue('SAM docs claim this is optional, but it is the only possible property'),
+    patching.Reason.sourceIssue('SAM docs claim this is optional, but it is the only possible property'),
   )(lens);
 };
 
-const serverlessStateMachine: Patcher<JsonObjectLens> = (lens) => {
+const serverlessStateMachine: patching.Patcher<patching.JsonObjectLens> = (lens) => {
   replaceDefinitionProperty(
     'AWS::Serverless::StateMachine.IAMPolicyDocument',
     'Statement',
     {
       type: 'object',
     },
-    Reason.backwardsCompat(
+    patching.Reason.backwardsCompat(
       'This was once typed as Json, and adding types now is a breaking change. Keep them as Json forever',
     ),
   )(lens);
@@ -94,9 +94,9 @@ const serverlessStateMachine: Patcher<JsonObjectLens> = (lens) => {
 /**
  * Patchers that apply to the SAM Template spec file
  */
-export const patchSamTemplateSpec = makeCompositePatcher(
-  normalizeJsonSchema,
-  onlyObjects(makeCompositePatcher(serverlessApi, serverlessFunction, serverlessStateMachine)),
+export const patchSamTemplateSpec = patching.makeCompositePatcher(
+  patches.normalizeJsonSchema,
+  patching.onlyObjects(patching.makeCompositePatcher(serverlessApi, serverlessFunction, serverlessStateMachine)),
 );
 
 /**
@@ -107,9 +107,9 @@ export const patchSamTemplateSpec = makeCompositePatcher(
 function replaceSamResourceProperty(
   resource: string,
   propertyName: string,
-  newSchema: jsonschema.Schema,
-  reason: Reason,
-): JsonObjectPatcher {
+  newSchema: types.jsonschema.Schema,
+  reason: patching.Reason,
+): patching.JsonObjectPatcher {
   return (lens) => {
     if (lens.jsonPointer === `/definitions/${resource}/properties/Properties/properties/${propertyName}`) {
       lens.replaceValue(reason.reason, newSchema);

packages/@aws-cdk/service-spec-importers/src/patches/service-patches/autoscaling.ts → packages/@aws-cdk/aws-service-spec/build/patches/service-patches/autoscaling.ts

@@ -1,7 +1,7 @@
 import { forResource, fp, registerServicePatches, removeResourceProperty } from './core';
-import { Reason } from '../../patching';
+import { patching } from '@aws-cdk/service-spec-importers';
 
-const reason = Reason.sourceIssue('Remove (presumed wrongly included) autoscaling group attribute');
+const reason = patching.Reason.sourceIssue('Remove (presumed wrongly included) autoscaling group attribute');
 
 registerServicePatches(
   fp.removeFromReadOnlyProperties('AWS::AutoScaling::AutoScalingGroup', ['LaunchTemplateSpecification'], reason),

packages/@aws-cdk/service-spec-importers/src/patches/service-patches/batch.ts → packages/@aws-cdk/aws-service-spec/build/patches/service-patches/batch.ts

@@ -1,9 +1,9 @@
 import { forResource, registerServicePatches, renameDefinition } from './core';
-import { Reason } from '../../patching';
+import { patching } from '@aws-cdk/service-spec-importers';
 
 registerServicePatches(
   forResource('AWS::Batch::JobDefinition', (lens) => {
-    const reason = Reason.upstreamTypeNameChange();
+    const reason = patching.Reason.upstreamTypeNameChange();
 
     renameDefinition('EksEmptyDir', 'EmptyDir', reason)(lens);
     renameDefinition('EksHostPath', 'HostPath', reason)(lens);

packages/@aws-cdk/service-spec-importers/src/patches/service-patches/cloudformation.ts → packages/@aws-cdk/aws-service-spec/build/patches/service-patches/cloudformation.ts

@@ -1,7 +1,7 @@
 import { forResource, registerServicePatches, removeResourceProperty } from './core';
-import { Reason } from '../../patching';
+import { patching } from '@aws-cdk/service-spec-importers';
 
-const reason = Reason.sourceIssue('Property is only supported by the CCAPI');
+const reason = patching.Reason.sourceIssue('Property is only supported by the CCAPI');
 
 registerServicePatches(
   forResource('AWS::CloudFormation::Stack', (lens) => {

packages/@aws-cdk/service-spec-importers/src/patches/service-patches/codebuild.ts → packages/@aws-cdk/aws-service-spec/build/patches/service-patches/codebuild.ts

@@ -1,12 +1,12 @@
 import { addDefinitions, forResource, registerServicePatches, replaceDefinition } from './core';
-import { Reason } from '../../patching';
+import { patching } from '@aws-cdk/service-spec-importers';
 
 /**
  * Add missing types for AWS::CodeBuild::Project
  */
 registerServicePatches(
   forResource('AWS::CodeBuild::Project', (lens) => {
-    const reason = Reason.sourceIssue(
+    const reason = patching.Reason.sourceIssue(
       'The elements of AWS::CodeBuild::Project.Triggers.FilterGroups used to be well-typed in the Resource Specification. In the Resource Schema it is incorrectly an untyped object.',
     );
 

packages/@aws-cdk/service-spec-importers/src/patches/service-patches/cognito.ts → packages/@aws-cdk/aws-service-spec/build/patches/service-patches/cognito.ts

@@ -1,5 +1,5 @@
 import { addDefinitions, forResource, registerServicePatches, replaceResourceProperty } from './core';
-import { Reason } from '../../patching';
+import { patching } from '@aws-cdk/service-spec-importers';
 
 /**
  * Make the use of the AWS::Cognito::IdentityPoolRoleAttachment.RoleMapings property safer
@@ -19,7 +19,7 @@ registerServicePatches(
         type: 'object',
         additionalProperties: { $ref: '#/definitions/RoleMapping' },
       },
-      Reason.other('Make the use of RoleMappings more type safe'),
+      patching.Reason.other('Make the use of RoleMappings more type safe'),
     )(lens);
 
     addDefinitions(
@@ -67,7 +67,7 @@ registerServicePatches(
         },
       },
 
-      Reason.other('Make the use of RoleMappings more type safe'),
+      patching.Reason.other('Make the use of RoleMappings more type safe'),
     )(lens);
   }),
 );

packages/@aws-cdk/service-spec-importers/src/patches/service-patches/config.ts → packages/@aws-cdk/aws-service-spec/build/patches/service-patches/config.ts

@@ -1,9 +1,9 @@
 import { addDefinitions, forResource, registerServicePatches, replaceResourceProperty } from './core';
-import { Reason } from '../../patching';
+import { patching } from '@aws-cdk/service-spec-importers';
 
 registerServicePatches(
   forResource('AWS::Config::RemediationConfiguration', (lens) => {
-    const reason = Reason.sourceIssue('Unused property type in Spec, now missing in Schema');
+    const reason = patching.Reason.sourceIssue('Unused property type in Spec, now missing in Schema');
     replaceResourceProperty(
       'Parameters',
       {