terraconstructs 0.0.25 → 0.1.1

package/go.mod

@@ -37,7 +37,7 @@ require (
 	github.com/jmespath/go-jmespath v0.4.0
 	github.com/spf13/afero v1.11.0
 	github.com/stretchr/testify v1.9.0
-	github.com/terraconstructs/go-synth v0.0.0-20241223031117-f10d006646ea
+	github.com/terraconstructs/go-synth v0.0.0-20250722181906-13022f215955
 	go.uber.org/zap v1.27.0
 )
 

package/go.sum

@@ -268,8 +268,8 @@ github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-github.com/terraconstructs/go-synth v0.0.0-20241223031117-f10d006646ea h1:lvZloFxnepMV74+YzRQEEQOSqIWAJ+tEUZzxlBVjZsE=
-github.com/terraconstructs/go-synth v0.0.0-20241223031117-f10d006646ea/go.mod h1:7GFolxuciYvFS9/4Sfs156mp3qc3BPN2Cy45I2JZcfE=
+github.com/terraconstructs/go-synth v0.0.0-20250722181906-13022f215955 h1:/X3dGAekF8+c3r4bV67ydNECD1Ndd2rkbiAhGqdAHxg=
+github.com/terraconstructs/go-synth v0.0.0-20250722181906-13022f215955/go.mod h1:7GFolxuciYvFS9/4Sfs156mp3qc3BPN2Cy45I2JZcfE=
 github.com/tidwall/gjson v1.17.0 h1:/Jocvlh98kcTfpN2+JzGQWQcqrPQwDrVEMApx/M5ZwM=
 github.com/tidwall/gjson v1.17.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
 github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=

package/lib/asset-manager.d.ts

@@ -0,0 +1,23 @@
+import { DockerImageAssetLocation, DockerImageAssetSource, FileAssetLocation, FileAssetSource } from "./assets";
+/**
+ * Interface for managing assets (files and Docker images) in infrastructure stacks.
+ *
+ * This interface abstracts asset management to avoid circular dependencies between
+ * stack implementations and storage constructs.
+ */
+export interface IAssetManager {
+    /**
+     * Register a file asset and return its location details.
+     *
+     * @param asset The file asset source information
+     * @returns Location details for the uploaded file asset
+     */
+    addFileAsset(asset: FileAssetSource): FileAssetLocation;
+    /**
+     * Register a Docker image asset and return its location details.
+     *
+     * @param asset The Docker image asset source information
+     * @returns Location details for the built and pushed Docker image
+     */
+    addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocation;
+}

package/lib/asset-manager.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXNzZXQtbWFuYWdlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9hc3NldC1tYW5hZ2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge1xuICBEb2NrZXJJbWFnZUFzc2V0TG9jYXRpb24sXG4gIERvY2tlckltYWdlQXNzZXRTb3VyY2UsXG4gIEZpbGVBc3NldExvY2F0aW9uLFxuICBGaWxlQXNzZXRTb3VyY2UsXG59IGZyb20gXCIuL2Fzc2V0c1wiO1xuXG4vKipcbiAqIEludGVyZmFjZSBmb3IgbWFuYWdpbmcgYXNzZXRzIChmaWxlcyBhbmQgRG9ja2VyIGltYWdlcykgaW4gaW5mcmFzdHJ1Y3R1cmUgc3RhY2tzLlxuICpcbiAqIFRoaXMgaW50ZXJmYWNlIGFic3RyYWN0cyBhc3NldCBtYW5hZ2VtZW50IHRvIGF2b2lkIGNpcmN1bGFyIGRlcGVuZGVuY2llcyBiZXR3ZWVuXG4gKiBzdGFjayBpbXBsZW1lbnRhdGlvbnMgYW5kIHN0b3JhZ2UgY29uc3RydWN0cy5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBJQXNzZXRNYW5hZ2VyIHtcbiAgLyoqXG4gICAqIFJlZ2lzdGVyIGEgZmlsZSBhc3NldCBhbmQgcmV0dXJuIGl0cyBsb2NhdGlvbiBkZXRhaWxzLlxuICAgKlxuICAgKiBAcGFyYW0gYXNzZXQgVGhlIGZpbGUgYXNzZXQgc291cmNlIGluZm9ybWF0aW9uXG4gICAqIEByZXR1cm5zIExvY2F0aW9uIGRldGFpbHMgZm9yIHRoZSB1cGxvYWRlZCBmaWxlIGFzc2V0XG4gICAqL1xuICBhZGRGaWxlQXNzZXQoYXNzZXQ6IEZpbGVBc3NldFNvdXJjZSk6IEZpbGVBc3NldExvY2F0aW9uO1xuXG4gIC8qKlxuICAgKiBSZWdpc3RlciBhIERvY2tlciBpbWFnZSBhc3NldCBhbmQgcmV0dXJuIGl0cyBsb2NhdGlvbiBkZXRhaWxzLlxuICAgKlxuICAgKiBAcGFyYW0gYXNzZXQgVGhlIERvY2tlciBpbWFnZSBhc3NldCBzb3VyY2UgaW5mb3JtYXRpb25cbiAgICogQHJldHVybnMgTG9jYXRpb24gZGV0YWlscyBmb3IgdGhlIGJ1aWx0IGFuZCBwdXNoZWQgRG9ja2VyIGltYWdlXG4gICAqL1xuICBhZGREb2NrZXJJbWFnZUFzc2V0KGFzc2V0OiBEb2NrZXJJbWFnZUFzc2V0U291cmNlKTogRG9ja2VySW1hZ2VBc3NldExvY2F0aW9uO1xufVxuIl19

package/lib/asset-staging.d.ts

@@ -0,0 +1,178 @@
+import { Construct } from "constructs";
+import { AssetOptions, FileAssetPackaging } from "./assets";
+import { FingerprintOptions } from "./fs";
+import { StackBase } from "./stack-base";
+/**
+ * Initialization properties for `AssetStaging`.
+ */
+export interface AssetStagingProps extends FingerprintOptions, AssetOptions {
+    /**
+     * The source file or directory to copy from.
+     */
+    readonly sourcePath: string;
+}
+/**
+ * Stages a file or directory from a location on the file system into a staging
+ * directory.
+ *
+ * This is controlled by the context key 'aws:cdk:asset-staging' and enabled
+ * by the CLI by default in order to ensure that when the CDK app exists, all
+ * assets are available for deployment. Otherwise, if an app references assets
+ * in temporary locations, those will not be available when it exists (see
+ * https://github.com/aws/aws-cdk/issues/1716).
+ *
+ * The `stagedPath` property is a stringified token that represents the location
+ * of the file or directory after staging. It will be resolved only during the
+ * "prepare" stage and may be either the original path or the staged path
+ * depending on the context setting.
+ *
+ * The file/directory are staged based on their content hash (fingerprint). This
+ * means that only if content was changed, copy will happen.
+ */
+export declare class AssetStaging extends Construct {
+    /**
+     * The directory inside the bundling container into which the asset sources will be mounted.
+     */
+    static readonly BUNDLING_INPUT_DIR = "/asset-input";
+    /**
+     * The directory inside the bundling container into which the bundled output should be written.
+     */
+    static readonly BUNDLING_OUTPUT_DIR = "/asset-output";
+    /**
+     * Clears the asset hash cache
+     */
+    static clearAssetHashCache(): void;
+    /**
+     * Cache of asset hashes based on asset configuration to avoid repeated file
+     * system and bundling operations.
+     */
+    private static assetCache;
+    /**
+     * Absolute path to the asset data.
+     *
+     * If asset staging is disabled, this will just be the source path or
+     * a temporary directory used for bundling.
+     *
+     * If asset staging is enabled it will be the staged path.
+     *
+     * IMPORTANT: If you are going to call `addFileAsset()`, use
+     * `relativeStagedPath()` instead.
+     *
+     * @deprecated - Use `absoluteStagedPath` instead.
+     */
+    readonly stagedPath: string;
+    /**
+     * Absolute path to the asset data.
+     *
+     * If asset staging is disabled, this will just be the source path or
+     * a temporary directory used for bundling.
+     *
+     * If asset staging is enabled it will be the staged path.
+     *
+     * IMPORTANT: If you are going to call `addFileAsset()`, use
+     * `relativeStagedPath()` instead.
+     */
+    readonly absoluteStagedPath: string;
+    /**
+     * The absolute path of the asset as it was referenced by the user.
+     */
+    readonly sourcePath: string;
+    /**
+     * A cryptographic hash of the asset.
+     */
+    readonly assetHash: string;
+    /**
+     * How this asset should be packaged.
+     */
+    readonly packaging: FileAssetPackaging;
+    /**
+     * Whether this asset is an archive (zip or jar).
+     */
+    readonly isArchive: boolean;
+    private readonly fingerprintOptions;
+    private readonly hashType;
+    private readonly assetOutdir;
+    /**
+     * A custom source fingerprint given by the user
+     *
+     * Will not be used literally, always hashed later on.
+     */
+    private customSourceFingerprint?;
+    private readonly cacheKey;
+    private readonly sourceStats;
+    constructor(scope: Construct, id: string, props: AssetStagingProps);
+    /**
+     * A cryptographic hash of the asset.
+     *
+     * @deprecated see `assetHash`.
+     */
+    get sourceHash(): string;
+    /**
+     * Return the path to the staged asset, relative to the Manifest workingDirectory of the given stack
+     *
+     * Only returns a relative path if the asset was staged, returns an absolute path if
+     * it was not staged.
+     *
+     * A bundled asset might end up in the outDir and still not count as
+     * "staged"; if asset staging is disabled we're technically expected to
+     * reference source directories, but we don't have a source directory for the
+     * bundled outputs (as the bundle output is written to a temporary
+     * directory). Nevertheless, we will still return an absolute path.
+     *
+     * A non-obvious directory layout may look like this:
+     *
+     * ```
+     *   MANIFEST ROOT
+     *     +-- asset.12345abcdef/
+     *     +-- assembly-Stage
+     *           +-- MyStack.template.json
+     *           +-- MyStack.assets.json <- will contain { "path": "../asset.12345abcdef" }
+     * ```
+     */
+    relativeStagedPath(_stack: StackBase): string;
+    /**
+     * Stage the source to the target by copying
+     *
+     * Optionally skip if staging is disabled, in which case we pretend we did something but we don't really.
+     */
+    private stageByCopying;
+    /**
+     * Stage the source to the target by bundling
+     *
+     * Optionally skip, in which case we pretend we did something but we don't really.
+     */
+    private stageByBundling;
+    /**
+     * Whether staging has been disabled
+     */
+    private get stagingDisabled();
+    /**
+     * Copies or moves the files from sourcePath to targetPath.
+     *
+     * Moving implies the source directory is temporary and can be trashed.
+     *
+     * Will not do anything if source and target are the same.
+     */
+    private stageAsset;
+    /**
+     * Determine the directory where we're going to write the bundling output
+     *
+     * This is the target directory where we're going to write the staged output
+     * files if we can (if the hash is fully known), or a temporary directory
+     * otherwise.
+     */
+    private determineBundleDir;
+    /**
+     * Bundles an asset to the given directory
+     *
+     * If the given directory already exists, assume that everything's already
+     * in order and don't do anything.
+     *
+     * @param options Bundling options
+     * @param bundleDir Where to create the bundle directory
+     * @returns The fully resolved bundle output directory.
+     */
+    private bundle;
+    private calculateHash;
+    private renderStagedPath;
+}