@aws-cdk/toolkit-lib 0.1.0

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

@@ -0,0 +1,9 @@
+import { SdkProvider } from '../../api/aws-cdk';
+import { ActionAwareIoHost } from '../../api/io/private';
+/**
+ * Helper struct to pass internal services around.
+ */
+export interface ToolkitServices {
+    sdkProvider: SdkProvider;
+    ioHost: ActionAwareIoHost;
+}

package/lib/toolkit/private/index.js

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

package/lib/toolkit/toolkit.d.ts

@@ -0,0 +1,142 @@
+import { ToolkitServices } from './private';
+import { type DeployOptions } from '../actions/deploy';
+import { type DestroyOptions } from '../actions/destroy';
+import { type ListOptions } from '../actions/list';
+import { type RollbackOptions } from '../actions/rollback';
+import { type SynthOptions } from '../actions/synth';
+import { WatchOptions } from '../actions/watch';
+import { type SdkConfig } from '../api/aws-auth';
+import { StackDetails } from '../api/aws-cdk';
+import { ICloudAssemblySource } from '../api/cloud-assembly';
+import { CloudAssemblySourceBuilder } from '../api/cloud-assembly/private';
+import { IIoHost } from '../api/io';
+/**
+ * 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 interface ToolkitOptions {
+    /**
+     * The IoHost implementation, handling the inline interactions between the Toolkit and an integration.
+     */
+    ioHost?: IIoHost;
+    /**
+     * Allow emojis in messages sent to the IoHost.
+     *
+     * @default true
+     */
+    emojis?: boolean;
+    /**
+     * Whether to allow ANSI colors and formatting in IoHost messages.
+     * Setting this value to `false` enforces that no color or style shows up
+     * in messages sent to the IoHost.
+     * Setting this value to true is a no-op; it is equivalent to the default.
+     *
+     * @default - detects color from the TTY status of the IoHost
+     */
+    color?: boolean;
+    /**
+     * Configuration options for the SDK.
+     */
+    sdkConfig?: SdkConfig;
+    /**
+     * Name of the toolkit stack to be used.
+     *
+     * @default "CDKToolkit"
+     */
+    toolkitStackName?: string;
+    /**
+     * Fail Cloud Assemblies
+     *
+     * @default "error"
+     */
+    assemblyFailureAt?: 'error' | 'warn' | 'none';
+}
+/**
+ * The AWS CDK Programmatic Toolkit
+ */
+export declare class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposable {
+    private readonly props;
+    /**
+     * The toolkit stack name used for bootstrapping resources.
+     */
+    readonly toolkitStackName: string;
+    /**
+     * The IoHost of this Toolkit
+     */
+    readonly ioHost: IIoHost;
+    private _sdkProvider?;
+    constructor(props?: ToolkitOptions);
+    dispose(): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
+    /**
+     * Access to the AWS SDK
+     */
+    private sdkProvider;
+    /**
+     * Helper to provide the CloudAssemblySourceBuilder with required toolkit services
+     */
+    protected sourceBuilderServices(): Promise<ToolkitServices>;
+    /**
+     * Synth Action
+     */
+    synth(cx: ICloudAssemblySource, options?: SynthOptions): Promise<ICloudAssemblySource>;
+    /**
+     * List Action
+     *
+     * List selected stacks and their dependencies
+     */
+    list(cx: ICloudAssemblySource, options?: ListOptions): Promise<StackDetails[]>;
+    /**
+     * Deploy Action
+     *
+     * Deploys the selected stacks into an AWS account
+     */
+    deploy(cx: ICloudAssemblySource, options?: DeployOptions): Promise<void>;
+    /**
+     * Helper to allow deploy being called as part of the watch action.
+     */
+    private _deploy;
+    /**
+     * Watch Action
+     *
+     * Continuously observe project files and deploy the selected stacks automatically when changes are detected.
+     * Implies hotswap deployments.
+     */
+    watch(cx: ICloudAssemblySource, options: WatchOptions): Promise<void>;
+    /**
+     * Rollback Action
+     *
+     * Rolls back the selected stacks.
+     */
+    rollback(cx: ICloudAssemblySource, options: RollbackOptions): Promise<void>;
+    /**
+     * Helper to allow rollback being called as part of the deploy or watch action.
+     */
+    private _rollback;
+    /**
+     * Destroy Action
+     *
+     * Destroys the selected Stacks.
+     */
+    destroy(cx: ICloudAssemblySource, options: DestroyOptions): Promise<void>;
+    /**
+     * Helper to allow destroy being called as part of the deploy action.
+     */
+    private _destroy;
+    /**
+     * Validate the stacks for errors and warnings according to the CLI's current settings
+     */
+    private validateStacksMetadata;
+    /**
+     * Creates a Toolkit internal CloudAssembly from a CloudAssemblySource.
+     * @param assemblySource the source for the cloud assembly
+     * @param cache if the assembly should be cached, default: `true`
+     * @returns the CloudAssembly object
+     */
+    private assemblyFromSource;
+    /**
+     * Create a deployments class
+     */
+    private deploymentsForAction;
+    private invokeDeployFromWatch;
+}