@aws-cdk/toolkit-lib 0.1.3 → 0.1.4

package/lib/api/shared-private.js

@@ -0,0 +1,82 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// lib/api/shared-private.ts
+var shared_private_exports = {};
+__export(shared_private_exports, {
+  debug: () => debug,
+  error: () => error,
+  info: () => info,
+  result: () => result,
+  trace: () => trace,
+  warn: () => warn,
+  withAction: () => withAction
+});
+module.exports = __toCommonJS(shared_private_exports);
+
+// ../tmp-toolkit-helpers/src/api/io/private/action-aware.ts
+function withAction(ioHost, action) {
+  return {
+    notify: async (msg) => {
+      await ioHost.notify({
+        ...msg,
+        action
+      });
+    },
+    requestResponse: async (msg) => {
+      return ioHost.requestResponse({
+        ...msg,
+        action
+      });
+    }
+  };
+}
+
+// ../tmp-toolkit-helpers/src/api/io/private/message-maker.ts
+function generic(level, details) {
+  const msg = (message, data) => ({
+    time: /* @__PURE__ */ new Date(),
+    level,
+    code: details.code,
+    message,
+    data
+  });
+  return {
+    ...details,
+    level,
+    msg
+  };
+}
+var trace = (details) => generic("trace", details);
+var debug = (details) => generic("debug", details);
+var info = (details) => generic("info", details);
+var warn = (details) => generic("warn", details);
+var error = (details) => generic("error", details);
+var result = (details) => generic("result", details);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  debug,
+  error,
+  info,
+  result,
+  trace,
+  warn,
+  withAction
+});
+//# sourceMappingURL=shared-private.js.map

package/lib/api/shared-private.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["shared-private.ts", "../../../tmp-toolkit-helpers/src/api/io/private/action-aware.ts", "../../../tmp-toolkit-helpers/src/api/io/private/message-maker.ts"],
+  "sourcesContent": ["/* eslint-disable import/no-restricted-paths */\n\nexport * from '../../../tmp-toolkit-helpers/src/api/io/private';\n", "import { IIoHost } from '../io-host';\nimport { IoMessage, IoRequest } from '../io-message';\nimport { ToolkitAction } from '../toolkit-action';\n\nexport type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;\nexport type SimplifiedMessage<T> = Pick<IoMessage<T>, 'level' | 'code' | 'message' | 'data'>;\nexport type ActionLessMessage<T> = Omit<IoMessage<T>, 'action'>;\nexport type ActionLessRequest<T, U> = Omit<IoRequest<T, U>, 'action'>;\n\n/**\n * Helper type for IoHosts that are action aware\n */\nexport interface ActionAwareIoHost extends IIoHost {\n  notify<T>(msg: ActionLessMessage<T>): Promise<void>;\n  requestResponse<T, U>(msg: ActionLessRequest<T, U>): Promise<U>;\n}\n\n/**\n * An IoHost wrapper that adds the given action to an actionless message before\n * sending the message to the given IoHost\n */\nexport function withAction(ioHost: IIoHost, action: ToolkitAction): ActionAwareIoHost {\n  return {\n    notify: async <T>(msg: Omit<IoMessage<T>, 'action'>) => {\n      await ioHost.notify({\n        ...msg,\n        action,\n      });\n    },\n    requestResponse: async <T, U>(msg: Omit<IoRequest<T, U>, 'action'>) => {\n      return ioHost.requestResponse({\n        ...msg,\n        action,\n      });\n    },\n  };\n}\n", "import { IoMessageCode, IoMessageLevel } from '../io-message';\nimport { ActionLessMessage } from './action-aware';\n\n/**\n * Information for each IO Message Code.\n */\ninterface CodeInfo {\n  /**\n   * The message code.\n   */\n  code: IoMessageCode;\n\n  /**\n   * A brief description of the meaning of this IO Message.\n   */\n  description: string;\n\n  /**\n   * The name of the payload interface, if applicable.\n   * Some Io Messages include a payload, with a specific interface. The name of\n   * the interface is specified here so that it can be linked with the message\n   * when documentation is generated.\n   *\n   * The interface _must_ be exposed directly from toolkit-lib, so that it will\n   * have a documentation page generated (that can be linked to).\n   */\n  interface?: string;\n}\n\n/**\n * Information for each IO Message\n */\ninterface MessageInfo extends CodeInfo {\n  /**\n   * The message level\n   */\n  level: IoMessageLevel;\n}\n\n/**\n * An interface that can produce messages for a specific code.\n */\nexport interface IoMessageMaker<T> extends MessageInfo {\n  /**\n   * Create a message for this code, with or without payload.\n   */\n  msg: [T] extends [never] ? (message: string) => ActionLessMessage<never> : (message: string, data: T) => ActionLessMessage<T>;\n}\n\n/**\n * Produce an IoMessageMaker for the provided level and code info.\n */\nfunction generic<T = never>(level: IoMessageLevel, details: CodeInfo): IoMessageMaker<T> {\n  const msg = (message: string, data: T) => ({\n    time: new Date(),\n    level,\n    code: details.code,\n    message: message,\n    data: data,\n  } as ActionLessMessage<T>);\n\n  return {\n    ...details,\n    level,\n    msg: msg as any,\n  };\n}\n\n// Create `IoMessageMaker`s for a given level and type check that calls with payload are using the correct interface\ntype CodeInfoMaybeInterface<T> = [T] extends [never] ? Omit<CodeInfo, 'interface'> : Required<CodeInfo>;\n\nexport const trace = <T = never>(details: CodeInfoMaybeInterface<T>) => generic<T>('trace', details);\nexport const debug = <T = never>(details: CodeInfoMaybeInterface<T>) => generic<T>('debug', details);\nexport const info = <T = never>(details: CodeInfoMaybeInterface<T>) => generic<T>('info', details);\nexport const warn = <T = never>(details: CodeInfoMaybeInterface<T>) => generic<T>('warn', details);\nexport const error = <T = never>(details: CodeInfoMaybeInterface<T>) => generic<T>('error', details);\nexport const result = <T extends object>(details: Required<CodeInfo>) => generic<T extends object ? T : never>('result', details);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACqBO,SAAS,WAAW,QAAiB,QAA0C;AACpF,SAAO;AAAA,IACL,QAAQ,OAAU,QAAsC;AACtD,YAAM,OAAO,OAAO;AAAA,QAClB,GAAG;AAAA,QACH;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IACA,iBAAiB,OAAa,QAAyC;AACrE,aAAO,OAAO,gBAAgB;AAAA,QAC5B,GAAG;AAAA,QACH;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;;;ACgBA,SAAS,QAAmB,OAAuB,SAAsC;AACvF,QAAM,MAAM,CAAC,SAAiB,UAAa;AAAA,IACzC,MAAM,oBAAI,KAAK;AAAA,IACf;AAAA,IACA,MAAM,QAAQ;AAAA,IACd;AAAA,IACA;AAAA,EACF;AAEA,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,EACF;AACF;AAKO,IAAM,QAAQ,CAAY,YAAuC,QAAW,SAAS,OAAO;AAC5F,IAAM,QAAQ,CAAY,YAAuC,QAAW,SAAS,OAAO;AAC5F,IAAM,OAAO,CAAY,YAAuC,QAAW,QAAQ,OAAO;AAC1F,IAAM,OAAO,CAAY,YAAuC,QAAW,QAAQ,OAAO;AAC1F,IAAM,QAAQ,CAAY,YAAuC,QAAW,SAAS,OAAO;AAC5F,IAAM,SAAS,CAAmB,YAAgC,QAAsC,UAAU,OAAO;",
+  "names": []
+}

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

@@ -1 +1,130 @@
-export * from '../../../tmp-toolkit-helpers/src/api';
+/**
+ * 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";
+/**
+ * The reporting level of the message.
+ * All messages are always reported, it's up to the IoHost to decide what to log.
+ */
+export type IoMessageLevel = "error" | "result" | "warn" | "info" | "debug" | "trace";
+/**
+ * A valid message code.
+ */
+export type IoMessageCode = `CDK_${string}_${"E" | "W" | "I"}${number}${number}${number}${number}`;
+/**
+ * An IO message emitted.
+ */
+export interface IoMessage<T> {
+	/**
+	 * The time the message was emitted.
+	 */
+	readonly time: Date;
+	/**
+	 * The recommended log level of the message.
+	 *
+	 * This is an indicative level and should not be used to explicitly match messages, instead match the `code`.
+	 * The level of a message may change without notice.
+	 */
+	readonly level: IoMessageLevel;
+	/**
+	 * The action that triggered the message.
+	 */
+	readonly action: ToolkitAction;
+	/**
+	 * A short message code uniquely identifying a message type using the format CDK_[CATEGORY]_[E/W/I][0000-9999].
+	 *
+	 * The level indicator follows these rules:
+	 * - 'E' for error level messages
+	 * - 'W' for warning level messages
+	 * - 'I' for info/debug/trace level messages
+	 *
+	 * Codes ending in 000 0 are generic messages, while codes ending in 0001-9999 are specific to a particular message.
+	 * The following are examples of valid and invalid message codes:
+	 * ```ts
+	 * 'CDK_ASSETS_I0000'       // valid: generic assets info message
+	 * 'CDK_TOOLKIT_E0002'      // valid: specific toolkit error message
+	 * 'CDK_SDK_W0023'          // valid: specific sdk warning message
+	 * ```
+	 *
+	 * @see https://github.com/aws/aws-cdk-cli/blob/main/packages/%40aws-cdk/toolkit-lib/CODE_REGISTRY.md
+	 */
+	readonly code: IoMessageCode;
+	/**
+	 * The message text.
+	 * This is safe to print to an end-user.
+	 */
+	readonly message: string;
+	/**
+	 * The data attached to the message.
+	 */
+	readonly data?: T;
+}
+/**
+ * An IO request emitted.
+ */
+export interface IoRequest<T, U> extends IoMessage<T> {
+	/**
+	 * The default response that will be used if no data is returned.
+	 */
+	readonly defaultResponse: U;
+}
+export interface IIoHost {
+	/**
+	 * Notifies the host of a message.
+	 * The caller waits until the notification completes.
+	 */
+	notify<T>(msg: IoMessage<T>): Promise<void>;
+	/**
+	 * Notifies the host of a message that requires a response.
+	 *
+	 * If the host does not return a response the suggested
+	 * default response from the input message will be used.
+	 */
+	requestResponse<T, U>(msg: IoRequest<T, U>): Promise<U>;
+}
+/**
+ * Represents a general toolkit error in the AWS CDK Toolkit.
+ */
+export declare class ToolkitError extends Error {
+	/**
+	 * Determines if a given error is an instance of ToolkitError.
+	 */
+	static isToolkitError(x: any): x is ToolkitError;
+	/**
+	 * Determines if a given error is an instance of AuthenticationError.
+	 */
+	static isAuthenticationError(x: any): x is AuthenticationError;
+	/**
+	 * Determines if a given error is an instance of AssemblyError.
+	 */
+	static isAssemblyError(x: any): x is AssemblyError;
+	/**
+	 * Determines if a given error is an instance of AssemblyError.
+	 */
+	static isContextProviderError(x: any): x is ContextProviderError;
+	/**
+	 * The type of the error, defaults to "toolkit".
+	 */
+	readonly type: string;
+	constructor(message: string, type?: string);
+}
+/**
+ * Represents an authentication-specific error in the AWS CDK Toolkit.
+ */
+export declare class AuthenticationError extends ToolkitError {
+	constructor(message: string);
+}
+/**
+ * Represents an authentication-specific error in the AWS CDK Toolkit.
+ */
+export declare class AssemblyError extends ToolkitError {
+	constructor(message: string);
+}
+/**
+ * Represents an error originating from a Context Provider
+ */
+export declare class ContextProviderError extends ToolkitError {
+	constructor(message: string);
+}
+
+export {};

package/lib/api/shared-public.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["shared-public.ts", "../../../tmp-toolkit-helpers/src/api/toolkit-error.ts"],
-  "sourcesContent": ["/* eslint-disable import/no-restricted-paths */\n\n// APIs\nexport * from '../../../tmp-toolkit-helpers/src/api';\n", "const TOOLKIT_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.ToolkitError');\nconst AUTHENTICATION_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.AuthenticationError');\nconst ASSEMBLY_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.AssemblyError');\nconst CONTEXT_PROVIDER_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.ContextProviderError');\n\n/**\n * Represents a general toolkit error in the AWS CDK Toolkit.\n */\nexport class ToolkitError extends Error {\n  /**\n   * Determines if a given error is an instance of ToolkitError.\n   */\n  public static isToolkitError(x: any): x is ToolkitError {\n    return x !== null && typeof(x) === 'object' && TOOLKIT_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * Determines if a given error is an instance of AuthenticationError.\n   */\n  public static isAuthenticationError(x: any): x is AuthenticationError {\n    return this.isToolkitError(x) && AUTHENTICATION_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * Determines if a given error is an instance of AssemblyError.\n   */\n  public static isAssemblyError(x: any): x is AssemblyError {\n    return this.isToolkitError(x) && ASSEMBLY_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * Determines if a given error is an instance of AssemblyError.\n   */\n  public static isContextProviderError(x: any): x is ContextProviderError {\n    return this.isToolkitError(x) && CONTEXT_PROVIDER_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * The type of the error, defaults to \"toolkit\".\n   */\n  public readonly type: string;\n\n  constructor(message: string, type: string = 'toolkit') {\n    super(message);\n    Object.setPrototypeOf(this, ToolkitError.prototype);\n    Object.defineProperty(this, TOOLKIT_ERROR_SYMBOL, { value: true });\n    this.name = new.target.name;\n    this.type = type;\n  }\n}\n\n/**\n * Represents an authentication-specific error in the AWS CDK Toolkit.\n */\nexport class AuthenticationError extends ToolkitError {\n  constructor(message: string) {\n    super(message, 'authentication');\n    Object.setPrototypeOf(this, AuthenticationError.prototype);\n    Object.defineProperty(this, AUTHENTICATION_ERROR_SYMBOL, { value: true });\n  }\n}\n\n/**\n * Represents an authentication-specific error in the AWS CDK Toolkit.\n */\nexport class AssemblyError extends ToolkitError {\n  constructor(message: string) {\n    super(message, 'assembly');\n    Object.setPrototypeOf(this, AssemblyError.prototype);\n    Object.defineProperty(this, ASSEMBLY_ERROR_SYMBOL, { value: true });\n  }\n}\n\n/**\n * Represents an error originating from a Context Provider\n */\nexport class ContextProviderError extends ToolkitError {\n  constructor(message: string) {\n    super(message, 'context-provider');\n    Object.setPrototypeOf(this, ContextProviderError.prototype);\n    Object.defineProperty(this, CONTEXT_PROVIDER_ERROR_SYMBOL, { value: true });\n  }\n}\n"],
+  "sourcesContent": ["/* eslint-disable import/no-restricted-paths */\n\nexport * from '../../../tmp-toolkit-helpers/src/api';\n", "const TOOLKIT_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.ToolkitError');\nconst AUTHENTICATION_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.AuthenticationError');\nconst ASSEMBLY_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.AssemblyError');\nconst CONTEXT_PROVIDER_ERROR_SYMBOL = Symbol.for('@aws-cdk/toolkit.ContextProviderError');\n\n/**\n * Represents a general toolkit error in the AWS CDK Toolkit.\n */\nexport class ToolkitError extends Error {\n  /**\n   * Determines if a given error is an instance of ToolkitError.\n   */\n  public static isToolkitError(x: any): x is ToolkitError {\n    return x !== null && typeof(x) === 'object' && TOOLKIT_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * Determines if a given error is an instance of AuthenticationError.\n   */\n  public static isAuthenticationError(x: any): x is AuthenticationError {\n    return this.isToolkitError(x) && AUTHENTICATION_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * Determines if a given error is an instance of AssemblyError.\n   */\n  public static isAssemblyError(x: any): x is AssemblyError {\n    return this.isToolkitError(x) && ASSEMBLY_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * Determines if a given error is an instance of AssemblyError.\n   */\n  public static isContextProviderError(x: any): x is ContextProviderError {\n    return this.isToolkitError(x) && CONTEXT_PROVIDER_ERROR_SYMBOL in x;\n  }\n\n  /**\n   * The type of the error, defaults to \"toolkit\".\n   */\n  public readonly type: string;\n\n  constructor(message: string, type: string = 'toolkit') {\n    super(message);\n    Object.setPrototypeOf(this, ToolkitError.prototype);\n    Object.defineProperty(this, TOOLKIT_ERROR_SYMBOL, { value: true });\n    this.name = new.target.name;\n    this.type = type;\n  }\n}\n\n/**\n * Represents an authentication-specific error in the AWS CDK Toolkit.\n */\nexport class AuthenticationError extends ToolkitError {\n  constructor(message: string) {\n    super(message, 'authentication');\n    Object.setPrototypeOf(this, AuthenticationError.prototype);\n    Object.defineProperty(this, AUTHENTICATION_ERROR_SYMBOL, { value: true });\n  }\n}\n\n/**\n * Represents an authentication-specific error in the AWS CDK Toolkit.\n */\nexport class AssemblyError extends ToolkitError {\n  constructor(message: string) {\n    super(message, 'assembly');\n    Object.setPrototypeOf(this, AssemblyError.prototype);\n    Object.defineProperty(this, ASSEMBLY_ERROR_SYMBOL, { value: true });\n  }\n}\n\n/**\n * Represents an error originating from a Context Provider\n */\nexport class ContextProviderError extends ToolkitError {\n  constructor(message: string) {\n    super(message, 'context-provider');\n    Object.setPrototypeOf(this, ContextProviderError.prototype);\n    Object.defineProperty(this, CONTEXT_PROVIDER_ERROR_SYMBOL, { value: true });\n  }\n}\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAM,uBAAuB,OAAO,IAAI,+BAA+B;AACvE,IAAM,8BAA8B,OAAO,IAAI,sCAAsC;AACrF,IAAM,wBAAwB,OAAO,IAAI,gCAAgC;AACzE,IAAM,gCAAgC,OAAO,IAAI,uCAAuC;AAKjF,IAAM,eAAN,MAAM,sBAAqB,MAAM;AAAA;AAAA;AAAA;AAAA,EAItC,OAAc,eAAe,GAA2B;AACtD,WAAO,MAAM,QAAQ,OAAO,MAAO,YAAY,wBAAwB;AAAA,EACzE;AAAA;AAAA;AAAA;AAAA,EAKA,OAAc,sBAAsB,GAAkC;AACpE,WAAO,KAAK,eAAe,CAAC,KAAK,+BAA+B;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA,EAKA,OAAc,gBAAgB,GAA4B;AACxD,WAAO,KAAK,eAAe,CAAC,KAAK,yBAAyB;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA,EAKA,OAAc,uBAAuB,GAAmC;AACtE,WAAO,KAAK,eAAe,CAAC,KAAK,iCAAiC;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA,EAKgB;AAAA,EAEhB,YAAY,SAAiB,OAAe,WAAW;AACrD,UAAM,OAAO;AACb,WAAO,eAAe,MAAM,cAAa,SAAS;AAClD,WAAO,eAAe,MAAM,sBAAsB,EAAE,OAAO,KAAK,CAAC;AACjE,SAAK,OAAO,WAAW;AACvB,SAAK,OAAO;AAAA,EACd;AACF;AAKO,IAAM,sBAAN,MAAM,6BAA4B,aAAa;AAAA,EACpD,YAAY,SAAiB;AAC3B,UAAM,SAAS,gBAAgB;AAC/B,WAAO,eAAe,MAAM,qBAAoB,SAAS;AACzD,WAAO,eAAe,MAAM,6BAA6B,EAAE,OAAO,KAAK,CAAC;AAAA,EAC1E;AACF;AAKO,IAAM,gBAAN,MAAM,uBAAsB,aAAa;AAAA,EAC9C,YAAY,SAAiB;AAC3B,UAAM,SAAS,UAAU;AACzB,WAAO,eAAe,MAAM,eAAc,SAAS;AACnD,WAAO,eAAe,MAAM,uBAAuB,EAAE,OAAO,KAAK,CAAC;AAAA,EACpE;AACF;AAKO,IAAM,uBAAN,MAAM,8BAA6B,aAAa;AAAA,EACrD,YAAY,SAAiB;AAC3B,UAAM,SAAS,kBAAkB;AACjC,WAAO,eAAe,MAAM,sBAAqB,SAAS;AAC1D,WAAO,eAAe,MAAM,+BAA+B,EAAE,OAAO,KAAK,CAAC;AAAA,EAC5E;AACF;",
   "names": []
 }

package/lib/private/util.d.ts

@@ -0,0 +1 @@
+export * from '../../../tmp-toolkit-helpers/src/util';