@aws-cdk/cloud-assembly-api 0.0.1 → 2.0.0

package/lib/cloud-artifact.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudArtifact = void 0;
+const cxschema = require("@aws-cdk/cloud-assembly-schema");
+const metadata_1 = require("./metadata");
+const error_1 = require("./private/error");
+/**
+ * Represents an artifact within a cloud assembly.
+ */
+class CloudArtifact {
+    /**
+     * Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.
+     *
+     * @param assembly - The cloud assembly from which to load the artifact
+     * @param id - The artifact ID
+     * @param artifact - The artifact manifest
+     * @returns the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.
+     */
+    static fromManifest(assembly, id, artifact) {
+        // Implementation is defined in a separate file to break cyclic dependencies
+        void (assembly), void (id), void (artifact);
+        throw new error_1.CloudAssemblyError('Implementation not overridden yet');
+    }
+    constructor(assembly, id, manifest) {
+        this.assembly = assembly;
+        this.id = id;
+        this.manifest = manifest;
+        this.messages = this.renderMessages();
+        this._dependencyIDs = manifest.dependencies || [];
+    }
+    /**
+     * Returns all the artifacts that this artifact depends on.
+     */
+    get dependencies() {
+        if (this._deps) {
+            return this._deps;
+        }
+        this._deps = this._dependencyIDs.map(id => {
+            const dep = this.assembly.tryGetArtifact(id);
+            if (!dep) {
+                throw new error_1.CloudAssemblyError(`Artifact ${this.id} depends on non-existing artifact ${id}`);
+            }
+            return dep;
+        });
+        return this._deps;
+    }
+    /**
+     * @returns all the metadata entries of a specific type in this artifact.
+     */
+    findMetadataByType(type) {
+        const result = new Array();
+        for (const path of Object.keys(this.manifest.metadata || {})) {
+            for (const entry of (this.manifest.metadata || {})[path]) {
+                if (entry.type === type) {
+                    result.push({ path, ...entry });
+                }
+            }
+        }
+        return result;
+    }
+    renderMessages() {
+        const messages = new Array();
+        for (const [id, metadata] of Object.entries(this.manifest.metadata || {})) {
+            for (const entry of metadata) {
+                let level;
+                switch (entry.type) {
+                    case cxschema.ArtifactMetadataEntryType.WARN:
+                        level = metadata_1.SynthesisMessageLevel.WARNING;
+                        break;
+                    case cxschema.ArtifactMetadataEntryType.ERROR:
+                        level = metadata_1.SynthesisMessageLevel.ERROR;
+                        break;
+                    case cxschema.ArtifactMetadataEntryType.INFO:
+                        level = metadata_1.SynthesisMessageLevel.INFO;
+                        break;
+                    default:
+                        continue;
+                }
+                messages.push({ level, entry, id });
+            }
+        }
+        return messages;
+    }
+    /**
+     * An identifier that shows where this artifact is located in the tree
+     * of nested assemblies, based on their manifests. Defaults to the normal
+     * id. Should only be used in user interfaces.
+     */
+    get hierarchicalId() {
+        return this.manifest.displayName ?? this.id;
+    }
+}
+exports.CloudArtifact = CloudArtifact;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"cloud-artifact.js","sourceRoot":"","sources":["cloud-artifact.ts"],"names":[],"mappings":";;;AAAA,2DAA2D;AAG3D,yCAAmD;AACnD,2CAAqD;AA8BrD;;GAEG;AACH,MAAa,aAAa;IACxB;;;;;;;OAOG;IACI,MAAM,CAAC,YAAY,CAAC,QAAuB,EAAE,EAAU,EAAE,QAAmC;QACjG,4EAA4E;QAC5E,KAAI,CAAC,QAAQ,CAAC,EAAE,KAAI,CAAC,EAAE,CAAC,EAAE,KAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,IAAI,0BAAkB,CAAC,mCAAmC,CAAC,CAAC;IACpE,CAAC;IAuBD,YAAsC,QAAuB,EAAkB,EAAU,EAAE,QAAmC;QAAxF,aAAQ,GAAR,QAAQ,CAAe;QAAkB,OAAE,GAAF,EAAE,CAAQ;QACvF,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YACxC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,MAAM,IAAI,0BAAkB,CAAC,YAAY,IAAI,CAAC,EAAE,qCAAqC,EAAE,EAAE,CAAC,CAAC;YAC7F,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,IAAY;QACpC,MAAM,MAAM,GAAG,IAAI,KAAK,EAAuB,CAAC;QAChD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;YAC7D,KAAK,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzD,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACxB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,cAAc;QACpB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAoB,CAAC;QAE/C,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAG,CAAC,EAAE,CAAC;YAC3E,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,IAAI,KAA4B,CAAC;gBACjC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,QAAQ,CAAC,yBAAyB,CAAC,IAAI;wBAC1C,KAAK,GAAG,gCAAqB,CAAC,OAAO,CAAC;wBACtC,MAAM;oBACR,KAAK,QAAQ,CAAC,yBAAyB,CAAC,KAAK;wBAC3C,KAAK,GAAG,gCAAqB,CAAC,KAAK,CAAC;wBACpC,MAAM;oBACR,KAAK,QAAQ,CAAC,yBAAyB,CAAC,IAAI;wBAC1C,KAAK,GAAG,gCAAqB,CAAC,IAAI,CAAC;wBACnC,MAAM;oBACR;wBACE,SAAS;gBACb,CAAC;gBAED,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,EAAE,CAAC;IAC9C,CAAC;CACF;AA/GD,sCA+GC","sourcesContent":["import * as cxschema from '@aws-cdk/cloud-assembly-schema';\nimport type { CloudAssembly } from './cloud-assembly';\nimport type { MetadataEntryResult, SynthesisMessage } from './metadata';\nimport { SynthesisMessageLevel } from './metadata';\nimport { CloudAssemblyError } from './private/error';\n\n/**\n * Artifact properties for CloudFormation stacks.\n */\nexport interface AwsCloudFormationStackProperties {\n  /**\n   * A file relative to the assembly root which contains the CloudFormation template for this stack.\n   */\n  readonly templateFile: string;\n\n  /**\n   * Values for CloudFormation stack parameters that should be passed when the stack is deployed.\n   */\n  readonly parameters?: { [id: string]: string };\n\n  /**\n   * The name to use for the CloudFormation stack.\n   * @default - name derived from artifact ID\n   */\n  readonly stackName?: string;\n\n  /**\n   * Whether to enable termination protection for this stack.\n   *\n   * @default false\n   */\n  readonly terminationProtection?: boolean;\n}\n\n/**\n * Represents an artifact within a cloud assembly.\n */\nexport class CloudArtifact {\n  /**\n   * Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.\n   *\n   * @param assembly - The cloud assembly from which to load the artifact\n   * @param id - The artifact ID\n   * @param artifact - The artifact manifest\n   * @returns the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.\n   */\n  public static fromManifest(assembly: CloudAssembly, id: string, artifact: cxschema.ArtifactManifest): CloudArtifact | undefined {\n    // Implementation is defined in a separate file to break cyclic dependencies\n    void(assembly), void(id), void(artifact);\n    throw new CloudAssemblyError('Implementation not overridden yet');\n  }\n\n  /**\n   * The artifact's manifest\n   */\n  public readonly manifest: cxschema.ArtifactManifest;\n\n  /**\n   * The set of messages extracted from the artifact's metadata.\n   */\n  public readonly messages: SynthesisMessage[];\n\n  /**\n   * IDs of all dependencies. Used when topologically sorting the artifacts within the cloud assembly.\n   * @internal\n   */\n  public readonly _dependencyIDs: string[];\n\n  /**\n   * Cache of resolved dependencies.\n   */\n  private _deps?: CloudArtifact[];\n\n  protected constructor(public readonly assembly: CloudAssembly, public readonly id: string, manifest: cxschema.ArtifactManifest) {\n    this.manifest = manifest;\n    this.messages = this.renderMessages();\n    this._dependencyIDs = manifest.dependencies || [];\n  }\n\n  /**\n   * Returns all the artifacts that this artifact depends on.\n   */\n  public get dependencies(): CloudArtifact[] {\n    if (this._deps) {\n      return this._deps;\n    }\n\n    this._deps = this._dependencyIDs.map(id => {\n      const dep = this.assembly.tryGetArtifact(id);\n      if (!dep) {\n        throw new CloudAssemblyError(`Artifact ${this.id} depends on non-existing artifact ${id}`);\n      }\n      return dep;\n    });\n\n    return this._deps;\n  }\n\n  /**\n   * @returns all the metadata entries of a specific type in this artifact.\n   */\n  public findMetadataByType(type: string): MetadataEntryResult[] {\n    const result = new Array<MetadataEntryResult>();\n    for (const path of Object.keys(this.manifest.metadata || {})) {\n      for (const entry of (this.manifest.metadata || {})[path]) {\n        if (entry.type === type) {\n          result.push({ path, ...entry });\n        }\n      }\n    }\n    return result;\n  }\n\n  private renderMessages() {\n    const messages = new Array<SynthesisMessage>();\n\n    for (const [id, metadata] of Object.entries(this.manifest.metadata || { })) {\n      for (const entry of metadata) {\n        let level: SynthesisMessageLevel;\n        switch (entry.type) {\n          case cxschema.ArtifactMetadataEntryType.WARN:\n            level = SynthesisMessageLevel.WARNING;\n            break;\n          case cxschema.ArtifactMetadataEntryType.ERROR:\n            level = SynthesisMessageLevel.ERROR;\n            break;\n          case cxschema.ArtifactMetadataEntryType.INFO:\n            level = SynthesisMessageLevel.INFO;\n            break;\n          default:\n            continue;\n        }\n\n        messages.push({ level, entry, id });\n      }\n    }\n\n    return messages;\n  }\n\n  /**\n   * An identifier that shows where this artifact is located in the tree\n   * of nested assemblies, based on their manifests. Defaults to the normal\n   * id. Should only be used in user interfaces.\n   */\n  public get hierarchicalId(): string {\n    return this.manifest.displayName ?? this.id;\n  }\n}\n"]}

package/lib/cloud-assembly.d.ts

@@ -0,0 +1,266 @@
+import type { ICloudAssembly } from '@aws-cdk/cloud-assembly-schema';
+import * as cxschema from '@aws-cdk/cloud-assembly-schema/lib';
+import { CloudFormationStackArtifact } from './artifacts/cloudformation-artifact';
+import { NestedCloudAssemblyArtifact } from './artifacts/nested-cloud-assembly-artifact';
+import { TreeCloudArtifact } from './artifacts/tree-cloud-artifact';
+import { CloudArtifact } from './cloud-artifact';
+/**
+ * Represents a deployable cloud application.
+ */
+export declare class CloudAssembly implements ICloudAssembly {
+    /**
+     * Return whether the given object is a CloudAssembly.
+     *
+     * We do attribute detection since we can't reliably use 'instanceof'.
+     */
+    static isCloudAssembly(x: any): x is CloudAssembly;
+    /**
+     * Cleans up any temporary assembly directories that got created in this process
+     *
+     * If a Cloud Assembly is emitted to a temporary directory, its directory gets
+     * added to a list. This function iterates over that list and deletes each
+     * directory in it, to free up disk space.
+     *
+     * This function will normally be called automatically during Node process
+     * exit and so you don't need to call this. However, some test environments do
+     * not properly trigger Node's `exit` event. Notably: Jest does not trigger
+     * the `exit` event (<https://github.com/jestjs/jest/issues/10927>).
+     *
+     * ## Cleaning up temporary directories in jest
+     *
+     * For Jest, you have to make sure this function is called at the end of the
+     * test suite instead:
+     *
+     * ```js
+     * import { CloudAssembly } from 'aws-cdk-lib/cx-api';
+     *
+     * afterAll(CloudAssembly.cleanupTemporaryDirectories);
+     * ```
+     *
+     * Alternatively, you can use the `setupFilesAfterEnv` feature and use a
+     * provided helper script to automatically inject the above into every
+     * test file, so you don't have to do it by hand.
+     *
+     * ```
+     * $ npx jest --setupFilesAfterEnv aws-cdk-lib/testhelpers/jest-autoclean
+     * ```
+     *
+     * Or put the following into `jest.config.js`:
+     *
+     * ```js
+     * module.exports = {
+     *   // ...
+     *   setupFilesAfterEnv: ['aws-cdk-lib/testhelpers/jest-cleanup'],
+     * };
+     * ```
+     */
+    static cleanupTemporaryDirectories(): void;
+    /**
+     * The root directory of the cloud assembly.
+     */
+    readonly directory: string;
+    /**
+     * The schema version of the assembly manifest.
+     */
+    readonly version: string;
+    /**
+     * All artifacts included in this assembly.
+     */
+    readonly artifacts: CloudArtifact[];
+    /**
+     * Runtime information such as module versions used to synthesize this assembly.
+     */
+    readonly runtime: cxschema.RuntimeInfo;
+    /**
+     * The raw assembly manifest.
+     */
+    readonly manifest: cxschema.AssemblyManifest;
+    /**
+     * Reads a cloud assembly from the specified directory.
+     * @param directory - The root directory of the assembly.
+     */
+    constructor(directory: string, loadOptions?: cxschema.LoadManifestOptions);
+    /**
+     * Attempts to find an artifact with a specific identity.
+     * @returns A `CloudArtifact` object or `undefined` if the artifact does not exist in this assembly.
+     * @param id - The artifact ID
+     */
+    tryGetArtifact(id: string): CloudArtifact | undefined;
+    /**
+     * Returns a CloudFormation stack artifact from this assembly.
+     *
+     * Will only search the current assembly.
+     *
+     * @param stackName - the name of the CloudFormation stack.
+     * @throws if there is no stack artifact by that name
+     * @throws if there is more than one stack with the same stack name. You can
+     * use `getStackArtifact(stack.artifactId)` instead.
+     * @returns a `CloudFormationStackArtifact` object.
+     */
+    getStackByName(stackName: string): CloudFormationStackArtifact;
+    /**
+     * Returns a CloudFormation stack artifact by name from this assembly.
+     * @deprecated renamed to `getStackByName` (or `getStackArtifact(id)`)
+     */
+    getStack(stackName: string): CloudFormationStackArtifact;
+    /**
+     * Returns a CloudFormation stack artifact from this assembly.
+     *
+     * @param artifactId - the artifact id of the stack (can be obtained through `stack.artifactId`).
+     * @throws if there is no stack artifact with that id
+     * @returns a `CloudFormationStackArtifact` object.
+     */
+    getStackArtifact(artifactId: string): CloudFormationStackArtifact;
+    private tryGetArtifactRecursively;
+    /**
+     * Returns all the stacks, including the ones in nested assemblies
+     */
+    get stacksRecursively(): CloudFormationStackArtifact[];
+    /**
+     * Returns a nested assembly artifact.
+     *
+     * @param artifactId - The artifact ID of the nested assembly
+     */
+    getNestedAssemblyArtifact(artifactId: string): NestedCloudAssemblyArtifact;
+    /**
+     * Returns a nested assembly.
+     *
+     * @param artifactId - The artifact ID of the nested assembly
+     */
+    getNestedAssembly(artifactId: string): CloudAssembly;
+    /**
+     * Returns the tree metadata artifact from this assembly.
+     * @throws if there is no metadata artifact by that name
+     * @returns a `TreeCloudArtifact` object if there is one defined in the manifest, `undefined` otherwise.
+     */
+    tree(): TreeCloudArtifact | undefined;
+    /**
+     * @returns all the CloudFormation stack artifacts that are included in this assembly.
+     */
+    get stacks(): CloudFormationStackArtifact[];
+    /**
+     * The nested assembly artifacts in this assembly
+     */
+    get nestedAssemblies(): NestedCloudAssemblyArtifact[];
+    private validateDeps;
+    private renderArtifacts;
+}
+/**
+ * Construction properties for CloudAssemblyBuilder
+ */
+export interface CloudAssemblyBuilderProps {
+    /**
+     * Use the given asset output directory
+     *
+     * @default - Same as the manifest outdir
+     */
+    readonly assetOutdir?: string;
+    /**
+     * If this builder is for a nested assembly, the parent assembly builder
+     *
+     * @default - This is a root assembly
+     */
+    readonly parentBuilder?: CloudAssemblyBuilder;
+}
+/**
+ * Can be used to build a cloud assembly.
+ */
+export declare class CloudAssemblyBuilder {
+    /**
+     * The root directory of the resulting cloud assembly.
+     */
+    readonly outdir: string;
+    /**
+     * The directory where assets of this Cloud Assembly should be stored
+     */
+    readonly assetOutdir: string;
+    private readonly artifacts;
+    private readonly missing;
+    private readonly parentBuilder?;
+    /**
+     * Initializes a cloud assembly builder.
+     * @param outdir - The output directory, uses temporary directory if undefined
+     */
+    constructor(outdir?: string, props?: CloudAssemblyBuilderProps);
+    /**
+     * Adds an artifact into the cloud assembly.
+     * @param id - The ID of the artifact.
+     * @param manifest - The artifact manifest
+     */
+    addArtifact(id: string, manifest: cxschema.ArtifactManifest): void;
+    /**
+     * Reports that some context is missing in order for this cloud assembly to be fully synthesized.
+     * @param missing - Missing context information.
+     */
+    addMissing(missing: cxschema.MissingContext): void;
+    /**
+     * Finalizes the cloud assembly into the output directory returns a
+     * `CloudAssembly` object that can be used to inspect the assembly.
+     */
+    buildAssembly(options?: AssemblyBuildOptions): CloudAssembly;
+    /**
+     * Creates a nested cloud assembly
+     */
+    createNestedAssembly(artifactId: string, displayName: string): CloudAssemblyBuilder;
+    /**
+     * Delete the cloud assembly directory
+     */
+    delete(): void;
+}
+/**
+ * Backwards compatibility for when `RuntimeInfo`
+ * was defined here. This is necessary because its used as an input in the stable
+ * @aws-cdk/core library.
+ *
+ * @deprecated moved to package 'cloud-assembly-schema'
+ * @see core.ConstructNode.synth
+ */
+export interface RuntimeInfo extends cxschema.RuntimeInfo {
+}
+/**
+ * Backwards compatibility for when `MetadataEntry`
+ * was defined here. This is necessary because its used as an input in the stable
+ * @aws-cdk/core library.
+ *
+ * @deprecated moved to package 'cloud-assembly-schema'
+ * @see core.ConstructNode.metadata
+ */
+export interface MetadataEntry extends cxschema.MetadataEntry {
+}
+/**
+ * Backwards compatibility for when `MissingContext`
+ * was defined here. This is necessary because its used as an input in the stable
+ * @aws-cdk/core library.
+ *
+ * @deprecated moved to package 'cloud-assembly-schema'
+ * @see core.Stack.reportMissingContext
+ */
+export interface MissingContext {
+    /**
+     * The missing context key.
+     */
+    readonly key: string;
+    /**
+     * The provider from which we expect this context key to be obtained.
+     *
+     * (This is the old untyped definition, which is necessary for backwards compatibility.
+     * See cxschema for a type definition.)
+     */
+    readonly provider: string;
+    /**
+     * A set of provider-specific options.
+     *
+     * (This is the old untyped definition, which is necessary for backwards compatibility.
+     * See cxschema for a type definition.)
+     */
+    readonly props: Record<string, any>;
+}
+export interface AssemblyBuildOptions {
+    /**
+     * Include the specified runtime information (module versions) in manifest.
+     * @default - if this option is not specified, runtime info will not be included
+     * @deprecated All template modifications that should result from this should
+     * have already been inserted into the template.
+     */
+    readonly runtimeInfo?: RuntimeInfo;
+}