@aws-cdk/toolkit-lib 0.2.0 → 0.3.0

package/lib/api/shared-public.d.ts

@@ -1112,7 +1112,7 @@ export interface StackSelector {
 /**
  * The current action being performed by the CLI. 'none' represents the absence of an action.
  */
-export type ToolkitAction = "assembly" | "bootstrap" | "synth" | "list" | "diff" | "deploy" | "rollback" | "watch" | "destroy" | "doctor" | "gc" | "import" | "metadata" | "init" | "migrate";
+export type ToolkitAction = "assembly" | "bootstrap" | "synth" | "list" | "diff" | "deploy" | "rollback" | "watch" | "destroy" | "doctor" | "gc" | "import" | "metadata" | "init" | "migrate" | "refactor";
 /**
  * The reporting level of the message.
  * All messages are always reported, it's up to the IoHost to decide what to log.
@@ -1641,66 +1641,6 @@ export interface StackSelectionDetails {
 	 */
 	readonly stacks: StackSelector;
 }
-/**
- * The computed file watch settings
- */
-export interface WatchSettings {
-	/**
-	 * The directory observed for file changes
-	 */
-	readonly watchDir: string;
-	/**
-	 * List of include patterns for watching files
-	 */
-	readonly includes: string[];
-	/**
-	 * List of excludes patterns for watching files
-	 */
-	readonly excludes: string[];
-}
-export interface FileWatchEvent {
-	/**
-	 * The change to the path
-	 */
-	readonly event: string;
-	/**
-	 * The path that has an observed event
-	 */
-	readonly path?: string;
-}
-/**
- * Payload when stack monitoring is starting or stopping for a given stack deployment.
- */
-export interface CloudWatchLogMonitorControlEvent {
-	/**
-	 * A unique identifier for a monitor
-	 *
-	 * Use this value to attribute events received for concurrent log monitoring.
-	 */
-	readonly monitor: string;
-	/**
-	 * The names of monitored log groups
-	 */
-	readonly logGroupNames: string[];
-}
-/**
- * Represents a CloudWatch Log Event that will be
- * printed to the terminal
- */
-export interface CloudWatchLogEvent {
-	/**
-	 * The log event message
-	 */
-	readonly message: string;
-	/**
-	 * The name of the log group
-	 */
-	readonly logGroupName: string;
-	/**
-	 * The time at which the event occurred
-	 */
-	readonly timestamp: Date;
-}
 interface IDifference<ValueType> {
 	readonly oldValue: ValueType | undefined;
 	readonly newValue: ValueType | undefined;
@@ -1761,6 +1701,87 @@ interface Resource {
 	};
 	[key: string]: any;
 }
+interface TypedMapping {
+	readonly type: string;
+	readonly sourcePath: string;
+	readonly destinationPath: string;
+}
+/**
+ * Output of the refactor command
+ */
+export interface RefactorResult {
+	/**
+	 * Mappings along with the resource type
+	 */
+	readonly typedMappings?: TypedMapping[];
+	/**
+	 * Ambiguous path correspondences, if any
+	 */
+	readonly ambiguousPaths?: [
+		string[],
+		string[]
+	][];
+}
+/**
+ * The computed file watch settings
+ */
+export interface WatchSettings {
+	/**
+	 * The directory observed for file changes
+	 */
+	readonly watchDir: string;
+	/**
+	 * List of include patterns for watching files
+	 */
+	readonly includes: string[];
+	/**
+	 * List of excludes patterns for watching files
+	 */
+	readonly excludes: string[];
+}
+export interface FileWatchEvent {
+	/**
+	 * The change to the path
+	 */
+	readonly event: string;
+	/**
+	 * The path that has an observed event
+	 */
+	readonly path?: string;
+}
+/**
+ * Payload when stack monitoring is starting or stopping for a given stack deployment.
+ */
+export interface CloudWatchLogMonitorControlEvent {
+	/**
+	 * A unique identifier for a monitor
+	 *
+	 * Use this value to attribute events received for concurrent log monitoring.
+	 */
+	readonly monitor: string;
+	/**
+	 * The names of monitored log groups
+	 */
+	readonly logGroupNames: string[];
+}
+/**
+ * Represents a CloudWatch Log Event that will be
+ * printed to the terminal
+ */
+export interface CloudWatchLogEvent {
+	/**
+	 * The log event message
+	 */
+	readonly message: string;
+	/**
+	 * The name of the log group
+	 */
+	readonly logGroupName: string;
+	/**
+	 * The time at which the event occurred
+	 */
+	readonly timestamp: Date;
+}
 /**
  * A resource affected by a change
  */

package/lib/toolkit/private/index.d.ts

@@ -10,6 +10,10 @@ export interface ToolkitServices {
 }
 /**
  * Creates a Toolkit internal CloudAssembly from a CloudAssemblySource.
+ *
+ * The caller assumes ownership of the returned `StackAssembly`, and `dispose()`
+ * should be called on this object after use.
+ *
  * @param assemblySource the source for the cloud assembly
  * @param cache if the assembly should be cached, default: `true`
  * @returns the CloudAssembly object

package/lib/toolkit/private/index.js

@@ -4,6 +4,10 @@ exports.assemblyFromSource = assemblyFromSource;
 const private_1 = require("../../api/cloud-assembly/private");
 /**
  * Creates a Toolkit internal CloudAssembly from a CloudAssemblySource.
+ *
+ * The caller assumes ownership of the returned `StackAssembly`, and `dispose()`
+ * should be called on this object after use.
+ *
  * @param assemblySource the source for the cloud assembly
  * @param cache if the assembly should be cached, default: `true`
  * @returns the CloudAssembly object
@@ -13,8 +17,9 @@ async function assemblyFromSource(ioHelper, assemblySource, cache = true) {
         return assemblySource;
     }
     if (cache) {
-        return new private_1.StackAssembly(await new private_1.CachedCloudAssemblySource(assemblySource).produce(), ioHelper);
+        const ret = new private_1.StackAssembly(await assemblySource.produce(), ioHelper);
+        return ret;
     }
     return new private_1.StackAssembly(await assemblySource.produce(), ioHelper);
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQW1CQSxnREFVQztBQTNCRCw4REFBNEY7QUFXNUY7Ozs7O0dBS0c7QUFDSSxLQUFLLFVBQVUsa0JBQWtCLENBQUMsUUFBa0IsRUFBRSxjQUFvQyxFQUFFLFFBQWlCLElBQUk7SUFDdEgsSUFBSSxjQUFjLFlBQVksdUJBQWEsRUFBRSxDQUFDO1FBQzVDLE9BQU8sY0FBYyxDQUFDO0lBQ3hCLENBQUM7SUFFRCxJQUFJLEtBQUssRUFBRSxDQUFDO1FBQ1YsT0FBTyxJQUFJLHVCQUFhLENBQUMsTUFBTSxJQUFJLG1DQUF5QixDQUFDLGNBQWMsQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQ3BHLENBQUM7SUFFRCxPQUFPLElBQUksdUJBQWEsQ0FBQyxNQUFNLGNBQWMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxRQUFRLENBQUMsQ0FBQztBQUNyRSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiXG5pbXBvcnQgdHlwZSB7IElDbG91ZEFzc2VtYmx5U291cmNlIH0gZnJvbSAnLi4vLi4vYXBpL2Nsb3VkLWFzc2VtYmx5JztcbmltcG9ydCB7IENhY2hlZENsb3VkQXNzZW1ibHlTb3VyY2UsIFN0YWNrQXNzZW1ibHkgfSBmcm9tICcuLi8uLi9hcGkvY2xvdWQtYXNzZW1ibHkvcHJpdmF0ZSc7XG5pbXBvcnQgdHlwZSB7IFNka1Byb3ZpZGVyLCBJb0hlbHBlciB9IGZyb20gJy4uLy4uL2FwaS9zaGFyZWQtcHJpdmF0ZSc7XG5cbi8qKlxuICogSGVscGVyIHN0cnVjdCB0byBwYXNzIGludGVybmFsIHNlcnZpY2VzIGFyb3VuZC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBUb29sa2l0U2VydmljZXMge1xuICBzZGtQcm92aWRlcjogU2RrUHJvdmlkZXI7XG4gIGlvSGVscGVyOiBJb0hlbHBlcjtcbn1cblxuLyoqXG4gKiBDcmVhdGVzIGEgVG9vbGtpdCBpbnRlcm5hbCBDbG91ZEFzc2VtYmx5IGZyb20gYSBDbG91ZEFzc2VtYmx5U291cmNlLlxuICogQHBhcmFtIGFzc2VtYmx5U291cmNlIHRoZSBzb3VyY2UgZm9yIHRoZSBjbG91ZCBhc3NlbWJseVxuICogQHBhcmFtIGNhY2hlIGlmIHRoZSBhc3NlbWJseSBzaG91bGQgYmUgY2FjaGVkLCBkZWZhdWx0OiBgdHJ1ZWBcbiAqIEByZXR1cm5zIHRoZSBDbG91ZEFzc2VtYmx5IG9iamVjdFxuICovXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gYXNzZW1ibHlGcm9tU291cmNlKGlvSGVscGVyOiBJb0hlbHBlciwgYXNzZW1ibHlTb3VyY2U6IElDbG91ZEFzc2VtYmx5U291cmNlLCBjYWNoZTogYm9vbGVhbiA9IHRydWUpOiBQcm9taXNlPFN0YWNrQXNzZW1ibHk+IHtcbiAgaWYgKGFzc2VtYmx5U291cmNlIGluc3RhbmNlb2YgU3RhY2tBc3NlbWJseSkge1xuICAgIHJldHVybiBhc3NlbWJseVNvdXJjZTtcbiAgfVxuXG4gIGlmIChjYWNoZSkge1xuICAgIHJldHVybiBuZXcgU3RhY2tBc3NlbWJseShhd2FpdCBuZXcgQ2FjaGVkQ2xvdWRBc3NlbWJseVNvdXJjZShhc3NlbWJseVNvdXJjZSkucHJvZHVjZSgpLCBpb0hlbHBlcik7XG4gIH1cblxuICByZXR1cm4gbmV3IFN0YWNrQXNzZW1ibHkoYXdhaXQgYXNzZW1ibHlTb3VyY2UucHJvZHVjZSgpLCBpb0hlbHBlcik7XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQXVCQSxnREFXQztBQWhDRCw4REFBaUU7QUFXakU7Ozs7Ozs7OztHQVNHO0FBQ0ksS0FBSyxVQUFVLGtCQUFrQixDQUFDLFFBQWtCLEVBQUUsY0FBb0MsRUFBRSxRQUFpQixJQUFJO0lBQ3RILElBQUksY0FBYyxZQUFZLHVCQUFhLEVBQUUsQ0FBQztRQUM1QyxPQUFPLGNBQWMsQ0FBQztJQUN4QixDQUFDO0lBRUQsSUFBSSxLQUFLLEVBQUUsQ0FBQztRQUNWLE1BQU0sR0FBRyxHQUFHLElBQUksdUJBQWEsQ0FBQyxNQUFNLGNBQWMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxRQUFRLENBQUMsQ0FBQztRQUN4RSxPQUFPLEdBQUcsQ0FBQztJQUNiLENBQUM7SUFFRCxPQUFPLElBQUksdUJBQWEsQ0FBQyxNQUFNLGNBQWMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxRQUFRLENBQUMsQ0FBQztBQUNyRSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiXG5pbXBvcnQgdHlwZSB7IElDbG91ZEFzc2VtYmx5U291cmNlIH0gZnJvbSAnLi4vLi4vYXBpL2Nsb3VkLWFzc2VtYmx5JztcbmltcG9ydCB7IFN0YWNrQXNzZW1ibHkgfSBmcm9tICcuLi8uLi9hcGkvY2xvdWQtYXNzZW1ibHkvcHJpdmF0ZSc7XG5pbXBvcnQgdHlwZSB7IFNka1Byb3ZpZGVyLCBJb0hlbHBlciB9IGZyb20gJy4uLy4uL2FwaS9zaGFyZWQtcHJpdmF0ZSc7XG5cbi8qKlxuICogSGVscGVyIHN0cnVjdCB0byBwYXNzIGludGVybmFsIHNlcnZpY2VzIGFyb3VuZC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBUb29sa2l0U2VydmljZXMge1xuICBzZGtQcm92aWRlcjogU2RrUHJvdmlkZXI7XG4gIGlvSGVscGVyOiBJb0hlbHBlcjtcbn1cblxuLyoqXG4gKiBDcmVhdGVzIGEgVG9vbGtpdCBpbnRlcm5hbCBDbG91ZEFzc2VtYmx5IGZyb20gYSBDbG91ZEFzc2VtYmx5U291cmNlLlxuICpcbiAqIFRoZSBjYWxsZXIgYXNzdW1lcyBvd25lcnNoaXAgb2YgdGhlIHJldHVybmVkIGBTdGFja0Fzc2VtYmx5YCwgYW5kIGBkaXNwb3NlKClgXG4gKiBzaG91bGQgYmUgY2FsbGVkIG9uIHRoaXMgb2JqZWN0IGFmdGVyIHVzZS5cbiAqXG4gKiBAcGFyYW0gYXNzZW1ibHlTb3VyY2UgdGhlIHNvdXJjZSBmb3IgdGhlIGNsb3VkIGFzc2VtYmx5XG4gKiBAcGFyYW0gY2FjaGUgaWYgdGhlIGFzc2VtYmx5IHNob3VsZCBiZSBjYWNoZWQsIGRlZmF1bHQ6IGB0cnVlYFxuICogQHJldHVybnMgdGhlIENsb3VkQXNzZW1ibHkgb2JqZWN0XG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBhc3NlbWJseUZyb21Tb3VyY2UoaW9IZWxwZXI6IElvSGVscGVyLCBhc3NlbWJseVNvdXJjZTogSUNsb3VkQXNzZW1ibHlTb3VyY2UsIGNhY2hlOiBib29sZWFuID0gdHJ1ZSk6IFByb21pc2U8U3RhY2tBc3NlbWJseT4ge1xuICBpZiAoYXNzZW1ibHlTb3VyY2UgaW5zdGFuY2VvZiBTdGFja0Fzc2VtYmx5KSB7XG4gICAgcmV0dXJuIGFzc2VtYmx5U291cmNlO1xuICB9XG5cbiAgaWYgKGNhY2hlKSB7XG4gICAgY29uc3QgcmV0ID0gbmV3IFN0YWNrQXNzZW1ibHkoYXdhaXQgYXNzZW1ibHlTb3VyY2UucHJvZHVjZSgpLCBpb0hlbHBlcik7XG4gICAgcmV0dXJuIHJldDtcbiAgfVxuXG4gIHJldHVybiBuZXcgU3RhY2tBc3NlbWJseShhd2FpdCBhc3NlbWJseVNvdXJjZS5wcm9kdWNlKCksIGlvSGVscGVyKTtcbn1cbiJdfQ==

package/lib/toolkit/toolkit.d.ts

@@ -1,14 +1,17 @@
+import type { TemplateDiff } from '@aws-cdk/cloudformation-diff';
 import type { DeployResult, DestroyResult, RollbackResult } from './types';
 import type { BootstrapEnvironments, BootstrapOptions, BootstrapResult } from '../actions/bootstrap';
 import { type DeployOptions } from '../actions/deploy';
 import { type DestroyOptions } from '../actions/destroy';
 import type { DiffOptions } from '../actions/diff';
 import { type ListOptions } from '../actions/list';
+import type { RefactorOptions } from '../actions/refactor';
 import { type RollbackOptions } from '../actions/rollback';
 import { type SynthOptions } from '../actions/synth';
 import type { WatchOptions } from '../actions/watch';
 import { type SdkConfig } from '../api/aws-auth';
 import type { ICloudAssemblySource } from '../api/cloud-assembly';
+import { CachedCloudAssembly } from '../api/cloud-assembly';
 import { CloudAssemblySourceBuilder } from '../api/cloud-assembly/private';
 import type { IIoHost } from '../api/io';
 import type { StackDetails } from '../api/shared-public';
@@ -73,12 +76,17 @@ export declare class Toolkit extends CloudAssemblySourceBuilder {
     bootstrap(environments: BootstrapEnvironments, options: BootstrapOptions): Promise<BootstrapResult>;
     /**
      * Synth Action
+     *
+     * The caller assumes ownership of the `CachedCloudAssembly` and is responsible for calling `dispose()` on
+     * it after use.
      */
-    synth(cx: ICloudAssemblySource, options?: SynthOptions): Promise<ICloudAssemblySource>;
+    synth(cx: ICloudAssemblySource, options?: SynthOptions): Promise<CachedCloudAssembly>;
     /**
      * Diff Action
      */
-    diff(cx: ICloudAssemblySource, options: DiffOptions): Promise<void>;
+    diff(cx: ICloudAssemblySource, options: DiffOptions): Promise<{
+        [name: string]: TemplateDiff;
+    }>;
     /**
      * List Action
      *
@@ -114,6 +122,11 @@ export declare class Toolkit extends CloudAssemblySourceBuilder {
      * Helper to allow rollback being called as part of the deploy or watch action.
      */
     private _rollback;
+    /**
+     * Refactor Action. Moves resources from one location (stack + logical ID) to another.
+     */
+    refactor(cx: ICloudAssemblySource, options?: RefactorOptions): Promise<void>;
+    private _refactor;
     /**
      * Destroy Action
      *