@aws-cdk/mixins-preview 2.241.0-alpha.0 → 2.242.0-alpha.0

package/lib/util/property-mixins.js

@@ -1,169 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepMerge = deepMerge;
-exports.shallowAssign = shallowAssign;
-const core_1 = require("aws-cdk-lib/core");
-/**
- * Deep merge utility for nested objects
- * @param target The target object to merge into
- * @param source The source object to merge from
- * @param mergeOnly The explicit list of property keys to copy from source
- */
-function deepMerge(target, source, mergeOnly) {
-    for (const key of mergeOnly) {
-        if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
-            continue;
-        }
-        if (!(key in source)) {
-            continue;
-        }
-        const sourceValue = source[key];
-        const targetValue = target[key];
-        if (typeof sourceValue === 'object' && sourceValue != null && !Array.isArray(sourceValue) &&
-            typeof targetValue === 'object' && targetValue != null && !Array.isArray(targetValue)) {
-            target[key] = deepMergeCopy(Object.create(null), targetValue, sourceValue);
-        }
-        else {
-            target[key] = sourceValue;
-        }
-    }
-    return target;
-}
-/**
- * Object keys that deepMerge should not consider. Currently these include
- * CloudFormation intrinsics
- *
- * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html
- */
-const MERGE_EXCLUDE_KEYS = [
-    'Ref',
-    'Fn::Base64',
-    'Fn::Cidr',
-    'Fn::FindInMap',
-    'Fn::GetAtt',
-    'Fn::GetAZs',
-    'Fn::ImportValue',
-    'Fn::Join',
-    'Fn::Select',
-    'Fn::Split',
-    'Fn::Sub',
-    'Fn::Transform',
-    'Fn::And',
-    'Fn::Equals',
-    'Fn::If',
-    'Fn::Not',
-    'Fn::Or',
-];
-/**
- * This is an unchanged copy from packages/aws-cdk-lib/core/lib/cfn-resource.ts
- * The intention will be to use this function from core once the package is merged.
- *
- * Merges `source` into `target`, overriding any existing values.
- * `null`s will cause a value to be deleted.
- */
-function deepMergeCopy(target, ...sources) {
-    for (const source of sources) {
-        if (typeof (source) !== 'object' || typeof (target) !== 'object') {
-            throw new core_1.AssumptionError(`Invalid usage. Both source (${JSON.stringify(source)}) and target (${JSON.stringify(target)}) must be objects`);
-        }
-        for (const key of Object.keys(source)) {
-            if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
-                continue;
-            }
-            const value = source[key];
-            if (typeof (value) === 'object' && value != null && !Array.isArray(value)) {
-                // if the value at the target is not an object, override it with an
-                // object so we can continue the recursion
-                if (typeof (target[key]) !== 'object') {
-                    target[key] = {};
-                    /**
-                     * If we have something that looks like:
-                     *
-                     *   target: { Type: 'MyResourceType', Properties: { prop1: { Ref: 'Param' } } }
-                     *   sources: [ { Properties: { prop1: [ 'Fn::Join': ['-', 'hello', 'world'] ] } } ]
-                     *
-                     * Eventually we will get to the point where we have
-                     *
-                     *   target: { prop1: { Ref: 'Param' } }
-                     *   sources: [ { prop1: { 'Fn::Join': ['-', 'hello', 'world'] } } ]
-                     *
-                     * We need to recurse 1 more time, but if we do we will end up with
-                     *   { prop1: { Ref: 'Param', 'Fn::Join': ['-', 'hello', 'world'] } }
-                     * which is not what we want.
-                     *
-                     * Instead we check to see whether the `target` value (i.e. target.prop1)
-                     * is an object that contains a key that we don't want to recurse on. If it does
-                     * then we essentially drop it and end up with:
-                     *
-                     *   { prop1: { 'Fn::Join': ['-', 'hello', 'world'] } }
-                     */
-                }
-                else if (Object.keys(target[key]).length === 1) {
-                    if (MERGE_EXCLUDE_KEYS.includes(Object.keys(target[key])[0])) {
-                        target[key] = {};
-                    }
-                }
-                /**
-                 * There might also be the case where the source is an intrinsic
-                 *
-                 *    target: {
-                 *      Type: 'MyResourceType',
-                 *      Properties: {
-                 *        prop1: { subprop: { name: { 'Fn::GetAtt': 'abc' } } }
-                 *      }
-                 *    }
-                 *    sources: [ {
-                 *      Properties: {
-                 *        prop1: { subprop: { 'Fn::If': ['SomeCondition', {...}, {...}] }}
-                 *      }
-                 *    } ]
-                 *
-                 * We end up in a place that is the reverse of the above check, the source
-                 * becomes an intrinsic before the target
-                 *
-                 *   target: { subprop: { name: { 'Fn::GetAtt': 'abc' } } }
-                 *   sources: [{
-                 *     'Fn::If': [ 'MyCondition', {...}, {...} ]
-                 *   }]
-                 */
-                if (Object.keys(value).length === 1) {
-                    if (MERGE_EXCLUDE_KEYS.includes(Object.keys(value)[0])) {
-                        target[key] = {};
-                    }
-                }
-                deepMergeCopy(target[key], value);
-                // if the result of the merge is an empty object, it's because the
-                // eventual value we assigned is `undefined`, and there are no
-                // sibling concrete values alongside, so we can delete this tree.
-                const output = target[key];
-                if (typeof (output) === 'object' && Object.keys(output).length === 0) {
-                    delete target[key];
-                }
-            }
-            else if (value === undefined) {
-                delete target[key];
-            }
-            else {
-                target[key] = value;
-            }
-        }
-    }
-    return target;
-}
-/**
- * Shallow assign utility that explicitly assigns each property
- * @param target The target object to assign properties to
- * @param source The source object to read properties from
- * @param assignOnly The explicit list of property keys that are allowed to be assigned
- */
-function shallowAssign(target, source, assignOnly) {
-    for (const key of assignOnly) {
-        if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
-            continue;
-        }
-        if (key in source) {
-            target[key] = source[key];
-        }
-    }
-    return target;
-}

package/scripts/airlift-custom-resource-handlers.sh

@@ -1,31 +0,0 @@
-#!/bin/bash
-
-scriptdir=$(cd $(dirname $0) && pwd)
-targetdir=${scriptdir}/..
-customresourcedir=$(node -p "path.dirname(require.resolve('@aws-cdk/custom-resource-handlers/package.json'))")
-
-function airlift() {
-    mkdir -p $targetdir/lib/custom-resource-handlers/$1
-    cp $customresourcedir/$2 $targetdir/lib/custom-resource-handlers/$1
-}
-
-function recurse() {
-  local dir=$1
-
-  for file in $dir/*; do
-    if [ -f $file ]; then
-      case $file in
-        $customresourcedir/dist/aws-s3/*/index.js)
-          cr=$(echo $file | rev | cut -d "/" -f 2-4 | rev)
-          airlift $cr $cr/index.js
-          ;;
-      esac
-    fi
-
-    if [ -d $file ]; then
-      recurse $file
-    fi
-  done
-}
-
-recurse $customresourcedir/dist

package/scripts/spec2mixins/builder.d.ts

@@ -1,21 +0,0 @@
-import type { Resource, Service } from '@aws-cdk/service-spec-types';
-import { ExternalModule } from '@cdklabs/typewriter';
-import type { AddServiceProps, LibraryBuilderProps } from '@aws-cdk/spec2cdk/lib/cdk/library-builder';
-import { LibraryBuilder } from '@aws-cdk/spec2cdk/lib/cdk/library-builder';
-import type { ServiceSubmoduleProps } from '@aws-cdk/spec2cdk/lib/cdk/service-submodule';
-import { BaseServiceSubmodule } from '@aws-cdk/spec2cdk/lib/cdk/service-submodule';
-declare class MixinsServiceModule extends BaseServiceSubmodule {
-    readonly constructLibModule: ExternalModule;
-    constructor(props: ServiceSubmoduleProps);
-}
-export interface MixinsBuilderProps extends LibraryBuilderProps {
-}
-export declare class MixinsBuilder extends LibraryBuilder<MixinsServiceModule> {
-    private readonly filePattern;
-    constructor(props: MixinsBuilderProps);
-    protected createServiceSubmodule(service: Service, submoduleName: string): MixinsServiceModule;
-    protected addResourceToSubmodule(submodule: MixinsServiceModule, resource: Resource, _props?: AddServiceProps): void;
-    private createMixinsModule;
-    private obtainMixinsModule;
-}
-export {};

package/scripts/spec2mixins/builder.js

@@ -1,214 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MixinsBuilder = void 0;
-const spec2cdk_1 = require("@aws-cdk/spec2cdk");
-const cdk_1 = require("@aws-cdk/spec2cdk/lib/cdk/cdk");
-const resource_decider_1 = require("@aws-cdk/spec2cdk/lib/cdk/resource-decider");
-const type_converter_1 = require("@aws-cdk/spec2cdk/lib/cdk/type-converter");
-const relationship_decider_1 = require("@aws-cdk/spec2cdk/lib/cdk/relationship-decider");
-const typewriter_1 = require("@cdklabs/typewriter");
-const helpers_1 = require("./helpers");
-const library_builder_1 = require("@aws-cdk/spec2cdk/lib/cdk/library-builder");
-const service_submodule_1 = require("@aws-cdk/spec2cdk/lib/cdk/service-submodule");
-class MixinsServiceModule extends service_submodule_1.BaseServiceSubmodule {
-    constructLibModule;
-    constructor(props) {
-        super(props);
-        this.constructLibModule = new typewriter_1.ExternalModule(`aws-cdk-lib/${props.submoduleName}`);
-    }
-}
-class MixinsBuilder extends library_builder_1.LibraryBuilder {
-    filePattern;
-    constructor(props) {
-        super(props);
-        this.filePattern = '%moduleName%/cfn-props-mixins.generated.ts';
-    }
-    createServiceSubmodule(service, submoduleName) {
-        return new MixinsServiceModule({
-            submoduleName,
-            service,
-        });
-    }
-    addResourceToSubmodule(submodule, resource, _props) {
-        const service = this.db.incoming('hasResource', resource).only().entity;
-        const mixins = this.obtainMixinsModule(submodule, service);
-        const l1PropsMixin = new L1PropsMixin(mixins.module, this.db, resource, submodule.constructLibModule);
-        submodule.registerResource(resource.cloudFormationType, l1PropsMixin);
-        l1PropsMixin.build();
-    }
-    createMixinsModule(submodule, service) {
-        const module = new typewriter_1.Module(`@aws-cdk/mixins-preview/${submodule.submoduleName}/mixins`);
-        const filePath = this.pathFor(this.filePattern, submodule.submoduleName, service);
-        submodule.registerModule({ module, filePath });
-        cdk_1.CDK_CORE.import(module, 'cdk');
-        cdk_1.CONSTRUCTS.import(module, 'constructs');
-        helpers_1.MIXINS_COMMON.import(module, 'mixins', { fromLocation: '../../mixins' });
-        helpers_1.MIXINS_UTILS.import(module, 'helpers', { fromLocation: '../../util/property-mixins' });
-        submodule.constructLibModule.import(module, 'service');
-        return { module, filePath };
-    }
-    obtainMixinsModule(submodule, service) {
-        const mod = this.createMixinsModule(submodule, service);
-        if (this.modules.has(mod.filePath)) {
-            return {
-                module: this.modules.get(mod.filePath),
-                filePath: mod.filePath,
-            };
-        }
-        return this.rememberModule(mod);
-    }
-}
-exports.MixinsBuilder = MixinsBuilder;
-class L1PropsMixin extends typewriter_1.ClassType {
-    db;
-    resource;
-    constructLibModule;
-    scope;
-    propsType;
-    decider;
-    relationshipDecider;
-    converter;
-    constructor(scope, db, resource, constructLibModule) {
-        super(scope, {
-            export: true,
-            name: `${spec2cdk_1.naming.classNameFromResource(resource)}PropsMixin`,
-            implements: [cdk_1.CONSTRUCTS.IMixin],
-            extends: cdk_1.CDK_CORE.Mixin,
-            docs: {
-                summary: `L1 property mixin for ${resource.cloudFormationType}`,
-                ...spec2cdk_1.util.splitDocumentation(resource.documentation),
-                stability: typewriter_1.Stability.External,
-                docTags: {
-                    cloudformationResource: resource.cloudFormationType,
-                    mixin: 'true',
-                },
-                see: spec2cdk_1.naming.cloudFormationDocLink({
-                    resourceType: resource.cloudFormationType,
-                }),
-            },
-        });
-        this.db = db;
-        this.resource = resource;
-        this.constructLibModule = constructLibModule;
-        this.scope = scope;
-        this.propsType = new typewriter_1.StructType(this.scope, {
-            export: true,
-            name: `${spec2cdk_1.naming.classNameFromResource(resource)}MixinProps`,
-            docs: {
-                summary: `Properties for ${this.name}`,
-                stability: typewriter_1.Stability.External,
-                see: spec2cdk_1.naming.cloudFormationDocLink({
-                    resourceType: this.resource.cloudFormationType,
-                }),
-            },
-        });
-        this.relationshipDecider = new relationship_decider_1.RelationshipDecider(this.resource, db, {
-            enableRelationships: false,
-            enableNestedRelationships: false,
-            refsImportLocation: 'aws-cdk-lib/interfaces',
-        });
-        this.converter = type_converter_1.TypeConverter.forMixin({
-            db: db,
-            resource: this.resource,
-            resourceClass: this,
-            relationshipDecider: this.relationshipDecider,
-        });
-        this.decider = new resource_decider_1.ResourceDecider(this.resource, this.converter, this.relationshipDecider);
-    }
-    /**
-     * Build the elements of the L1PropsMixin Class and types
-     */
-    build() {
-        // Build the props type with all properties optional
-        for (const prop of this.decider.propsProperties) {
-            if (prop.propertySpec.type.fqn) {
-                continue;
-            }
-            this.propsType.addProperty({
-                ...prop.propertySpec,
-                optional: true,
-            });
-        }
-        this.makeConstructor();
-        const supports = this.makeSupportsMethod();
-        this.makeApplyToMethod(supports);
-    }
-    makeConstructor() {
-        const optionsType = helpers_1.MIXINS_COMMON.CfnPropertyMixinOptions;
-        this.addProperty({
-            name: 'CFN_PROPERTY_KEYS',
-            type: typewriter_1.Type.arrayOf(typewriter_1.Type.STRING),
-            protected: true,
-            immutable: true,
-            static: true,
-            initializer: typewriter_1.expr.list(this.propsType.properties.map(p => typewriter_1.expr.lit(p.name))),
-        });
-        this.addProperty({
-            name: 'props',
-            type: this.propsType.type,
-            protected: true,
-            immutable: true,
-        });
-        this.addProperty({
-            name: 'strategy',
-            type: helpers_1.MIXINS_COMMON.PropertyMergeStrategy,
-            protected: true,
-            immutable: true,
-        });
-        const init = this.addInitializer({
-            docs: {
-                summary: `Create a mixin to apply properties to \`${this.resource.cloudFormationType}\`.`,
-            },
-        });
-        const props = init.addParameter({
-            name: 'props',
-            type: this.propsType.type,
-            documentation: 'L1 properties to apply',
-        });
-        const options = init.addParameter({
-            name: 'options',
-            type: optionsType,
-            optional: true,
-            default: typewriter_1.expr.object(),
-            documentation: 'Mixin options',
-        });
-        init.addBody(typewriter_1.expr.sym(new typewriter_1.ThingSymbol('super', this.scope)).call(), typewriter_1.stmt.assign(typewriter_1.$this.props, props), typewriter_1.stmt.assign(typewriter_1.$this.strategy, typewriter_1.expr.binOp(options?.prop('strategy'), '??', helpers_1.MIXINS_COMMON.PropertyMergeStrategy.MERGE)));
-    }
-    makeSupportsMethod() {
-        const resourceClassName = spec2cdk_1.naming.classNameFromResource(this.resource);
-        const resourceClass = typewriter_1.Type.fromName(this.constructLibModule, resourceClassName);
-        const method = this.addMethod({
-            name: 'supports',
-            returnType: typewriter_1.Type.ambient(`construct is service.${resourceClass.symbol}`),
-            docs: {
-                summary: 'Check if this mixin supports the given construct',
-            },
-        });
-        const construct = method.addParameter({
-            name: 'construct',
-            type: cdk_1.CONSTRUCTS.IConstruct,
-        });
-        method.addBody(typewriter_1.stmt.ret(typewriter_1.expr.binOp(typewriter_1.CallableProxy.fromName('CfnResource.isCfnResource', cdk_1.CDK_CORE).invoke(construct), '&&', (0, typewriter_1.$T)(resourceClass)[`is${resourceClassName}`](construct))));
-        return method;
-    }
-    makeApplyToMethod(supports) {
-        const method = this.addMethod({
-            name: 'applyTo',
-            returnType: typewriter_1.Type.VOID,
-            docs: {
-                summary: 'Apply the mixin properties to the construct',
-            },
-        });
-        const construct = method.addParameter({
-            name: 'construct',
-            type: cdk_1.CONSTRUCTS.IConstruct,
-        });
-        const CFN_PROPERTY_KEYS = (0, typewriter_1.$T)(this.type).CFN_PROPERTY_KEYS;
-        method.addBody(typewriter_1.stmt
-            .if_(typewriter_1.CallableProxy.fromMethod(supports).invoke(construct))
-            .then(typewriter_1.stmt.block(typewriter_1.stmt
-            .if_(typewriter_1.expr.eq(typewriter_1.$this.strategy, helpers_1.MIXINS_COMMON.PropertyMergeStrategy.MERGE))
-            .then(typewriter_1.stmt.block(helpers_1.MIXINS_UTILS.deepMerge(construct, typewriter_1.$this.props, CFN_PROPERTY_KEYS)))
-            .else(typewriter_1.stmt.block(helpers_1.MIXINS_UTILS.shallowAssign(construct, typewriter_1.$this.props, CFN_PROPERTY_KEYS))))));
-    }
-}

package/scripts/spec2mixins/generate.d.ts

@@ -1,6 +0,0 @@
-import type { GenerateOptions as Spec2CdkOptions } from '@aws-cdk/spec2cdk';
-import { MixinsBuilder } from './builder';
-import { type ModuleMap } from '@aws-cdk/spec2cdk/lib/module-topology';
-type GenerateOptions = Pick<Spec2CdkOptions<typeof MixinsBuilder>, 'outputPath' | 'clearOutput' | 'debug'>;
-export declare function generateAll(options: GenerateOptions): Promise<ModuleMap>;
-export {};

package/scripts/spec2mixins/generate.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateAll = generateAll;
-const spec2cdk_1 = require("@aws-cdk/spec2cdk");
-const builder_1 = require("./builder");
-const config_1 = require("../config");
-const module_topology_1 = require("@aws-cdk/spec2cdk/lib/module-topology");
-async function generateAll(options) {
-    const db = await (0, spec2cdk_1.loadPatchedSpec)();
-    const services = await db.all('service');
-    const moduleMap = (0, module_topology_1.loadModuleMap)({
-        packageBases: config_1.MIXINS_PREVIEW_BASE_NAMES,
-        respectOverrides: false,
-    });
-    const moduleRequests = {};
-    // request all known services
-    for (const service of services) {
-        if (moduleMap[service.name]) {
-            moduleRequests[service.name] = {
-                services: [{ namespace: service.cloudFormationNamespace }],
-            };
-        }
-    }
-    const generated = await (0, spec2cdk_1.generate)(moduleRequests, {
-        ...options,
-        db,
-        astBuilder: builder_1.MixinsBuilder,
-    });
-    return Object.fromEntries(Object.entries(generated.modules).map(([moduleName, moduleInfo]) => [
-        moduleName,
-        {
-            files: moduleInfo.outputFiles,
-            name: moduleName,
-            resources: moduleInfo.resources,
-            scopes: moduleMap[moduleName]?.scopes ?? [],
-            definition: moduleMap[moduleName]?.definition,
-            targets: moduleMap[moduleName]?.targets,
-        },
-    ]));
-}

package/scripts/spec2mixins/helpers.d.ts

@@ -1,12 +0,0 @@
-import { Type, ExternalModule } from '@cdklabs/typewriter';
-declare class MixinsCommon extends ExternalModule {
-    readonly PropertyMergeStrategy: import("@cdklabs/typewriter").TypeExpressionProxy<Type>;
-    readonly CfnPropertyMixinOptions: Type;
-}
-declare class MixinsUtils extends ExternalModule {
-    readonly deepMerge: import("@cdklabs/typewriter").ExpressionProxy<import("@cdklabs/typewriter").Expression>;
-    readonly shallowAssign: import("@cdklabs/typewriter").ExpressionProxy<import("@cdklabs/typewriter").Expression>;
-}
-export declare const MIXINS_COMMON: MixinsCommon;
-export declare const MIXINS_UTILS: MixinsUtils;
-export {};

package/scripts/spec2mixins/helpers.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIXINS_UTILS = exports.MIXINS_COMMON = void 0;
-const typewriter_1 = require("@cdklabs/typewriter");
-class MixinsCommon extends typewriter_1.ExternalModule {
-    PropertyMergeStrategy = (0, typewriter_1.$T)(typewriter_1.Type.fromName(this, 'PropertyMergeStrategy'));
-    CfnPropertyMixinOptions = typewriter_1.Type.fromName(this, 'CfnPropertyMixinOptions');
-}
-class MixinsUtils extends typewriter_1.ExternalModule {
-    deepMerge = (0, typewriter_1.$E)(typewriter_1.expr.sym(new typewriter_1.ThingSymbol('deepMerge', this)));
-    shallowAssign = (0, typewriter_1.$E)(typewriter_1.expr.sym(new typewriter_1.ThingSymbol('shallowAssign', this)));
-}
-exports.MIXINS_COMMON = new MixinsCommon('@aws-cdk/mixins-preview/mixins');
-exports.MIXINS_UTILS = new MixinsUtils('@aws-cdk/mixins-preview/util/property-mixins');