@ms-cloudpack/cli 0.49.0 → 0.49.2

package/lib/types/CommandAction.d.ts

@@ -2,20 +2,47 @@ import type { TaskReporter } from '@ms-cloudpack/task-reporter';
 import type { CloudpackConfig } from '@ms-cloudpack/config';
 import type { TelemetryClient } from '@ms-cloudpack/telemetry';
 import type { AutoDispose } from './AutoDispose.js';
+import type { SharedOptions } from '../types/SharedOptions.js';
 export type CommandActionOptions<TOptions> = {
+    /**
+     * Command-specific options, parsed from `process.argv`.
+     * Types are generally defined in each command's `src/commands/<name>/types/<Name>Types.ts` module.
+     * The command line options are defined in each command's `src/commands/<name>/index.ts` module.
+     */
     options: TOptions;
     reporter: TaskReporter;
-    cwd: string;
-    initialize: (appPath: string) => Promise<{
+    abortSignal: AbortSignal;
+    /**
+     * Function that can be called with any `Disposable`s that should be cleaned up automatically
+     * when the program exits. (See `AutoDisposableList.add` for implementation.)
+     */
+    autoDispose: AutoDispose;
+    /**
+     * This should be called at or near the beginning of the action to initialize the config,
+     * telemetry, and reporting. (See `createInitializeFunction` for implementation.)
+     */
+    initialize: (initializeOptions: {
+        appPath: string;
+        overrideOptions?: Partial<SharedOptions>;
+    }) => Promise<{
         telemetryClient: TelemetryClient;
         config: CloudpackConfig;
     }>;
-    autoDispose: AutoDispose;
-    abortSignal: AbortSignal;
+    /**
+     * This should be called at the end of the action to dispose resources, log completion,
+     * and exit the program. (See `createExitFunction` for implementation.)
+     */
     exit: (result: {
         exitCode: number;
         message?: string;
     }) => Promise<void>;
 };
-export type CommandAction<TOptions> = (options: CommandActionOptions<TOptions>) => Promise<void>;
+/**
+ * Command action function. This is the type of the `execute` function which should be exported
+ * from each command's `src/commands/<name>/execute.ts` module.
+ */
+export type CommandAction<TOptions> = (options: CommandActionOptions<TOptions & SharedOptions>) => Promise<void>;
+export type CommandActionModule<TOptions> = {
+    execute: CommandAction<TOptions>;
+};
 //# sourceMappingURL=CommandAction.d.ts.map

package/lib/types/CommandAction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CommandAction.d.ts","sourceRoot":"","sources":["../../src/types/CommandAction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,MAAM,oBAAoB,CAAC,QAAQ,IAAI;IAC3C,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,EAAE,YAAY,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;QACvC,eAAe,EAAE,eAAe,CAAC;QACjC,MAAM,EAAE,eAAe,CAAC;KACzB,CAAC,CAAC;IACH,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,IAAI,EAAE,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACzE,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,QAAQ,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"CommandAction.d.ts","sourceRoot":"","sources":["../../src/types/CommandAction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,MAAM,MAAM,oBAAoB,CAAC,QAAQ,IAAI;IAC3C;;;;OAIG;IACH,OAAO,EAAE,QAAQ,CAAC;IAElB,QAAQ,EAAE,YAAY,CAAC;IAEvB,WAAW,EAAE,WAAW,CAAC;IAEzB;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;OAGG;IACH,UAAU,EAAE,CAAC,iBAAiB,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;KAAE,KAAK,OAAO,CAAC;QACxG,eAAe,EAAE,eAAe,CAAC;QACjC,MAAM,EAAE,eAAe,CAAC;KACzB,CAAC,CAAC;IAEH;;;OAGG;IACH,IAAI,EAAE,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACzE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,QAAQ,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,QAAQ,GAAG,aAAa,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjH,MAAM,MAAM,mBAAmB,CAAC,QAAQ,IAAI;IAC1C,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;CAClC,CAAC"}

package/lib/types/CommandAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommandAction.js","sourceRoot":"","sources":["../../src/types/CommandAction.ts"],"names":[],"mappings":"","sourcesContent":["import type { TaskReporter } from '@ms-cloudpack/task-reporter';\nimport type { CloudpackConfig } from '@ms-cloudpack/config';\nimport type { TelemetryClient } from '@ms-cloudpack/telemetry';\nimport type { AutoDispose } from './AutoDispose.js';\n\nexport type CommandActionOptions<TOptions> = {\n  options: TOptions;\n  reporter: TaskReporter;\n  cwd: string;\n  initialize: (appPath: string) => Promise<{\n    telemetryClient: TelemetryClient;\n    config: CloudpackConfig;\n  }>;\n  autoDispose: AutoDispose;\n  abortSignal: AbortSignal;\n  exit: (result: { exitCode: number; message?: string }) => Promise<void>;\n};\n\nexport type CommandAction<TOptions> = (options: CommandActionOptions<TOptions>) => Promise<void>;\n"]}
+{"version":3,"file":"CommandAction.js","sourceRoot":"","sources":["../../src/types/CommandAction.ts"],"names":[],"mappings":"","sourcesContent":["import type { TaskReporter } from '@ms-cloudpack/task-reporter';\nimport type { CloudpackConfig } from '@ms-cloudpack/config';\nimport type { TelemetryClient } from '@ms-cloudpack/telemetry';\nimport type { AutoDispose } from './AutoDispose.js';\nimport type { SharedOptions } from '../types/SharedOptions.js';\n\nexport type CommandActionOptions<TOptions> = {\n  /**\n   * Command-specific options, parsed from `process.argv`.\n   * Types are generally defined in each command's `src/commands/<name>/types/<Name>Types.ts` module.\n   * The command line options are defined in each command's `src/commands/<name>/index.ts` module.\n   */\n  options: TOptions;\n\n  reporter: TaskReporter;\n\n  abortSignal: AbortSignal;\n\n  /**\n   * Function that can be called with any `Disposable`s that should be cleaned up automatically\n   * when the program exits. (See `AutoDisposableList.add` for implementation.)\n   */\n  autoDispose: AutoDispose;\n\n  /**\n   * This should be called at or near the beginning of the action to initialize the config,\n   * telemetry, and reporting. (See `createInitializeFunction` for implementation.)\n   */\n  initialize: (initializeOptions: { appPath: string; overrideOptions?: Partial<SharedOptions> }) => Promise<{\n    telemetryClient: TelemetryClient;\n    config: CloudpackConfig;\n  }>;\n\n  /**\n   * This should be called at the end of the action to dispose resources, log completion,\n   * and exit the program. (See `createExitFunction` for implementation.)\n   */\n  exit: (result: { exitCode: number; message?: string }) => Promise<void>;\n};\n\n/**\n * Command action function. This is the type of the `execute` function which should be exported\n * from each command's `src/commands/<name>/execute.ts` module.\n */\nexport type CommandAction<TOptions> = (options: CommandActionOptions<TOptions & SharedOptions>) => Promise<void>;\n\nexport type CommandActionModule<TOptions> = {\n  execute: CommandAction<TOptions>;\n};\n"]}

package/lib/types/CommandInitFunction.d.ts

@@ -0,0 +1,14 @@
+import type { Command } from 'commander';
+/**
+ * Initialize a command object for a sub-command.
+ * This is the type for the `init` function exported by each `src/commands/<name>/index.ts` module.
+ * @param program Command object for the program.
+ */
+export type CommandInitFunction = (program: Command) => void;
+/**
+ * Type for each `src/commands/<name>/index.ts` module.
+ */
+export type CommandInitModule = {
+    init: CommandInitFunction;
+};
+//# sourceMappingURL=CommandInitFunction.d.ts.map

package/lib/types/CommandInitFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandInitFunction.d.ts","sourceRoot":"","sources":["../../src/types/CommandInitFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,mBAAmB,CAAC;CAC3B,CAAC"}

package/lib/types/CommandInitFunction.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CommandInitFunction.js.map

package/lib/types/CommandInitFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandInitFunction.js","sourceRoot":"","sources":["../../src/types/CommandInitFunction.ts"],"names":[],"mappings":"","sourcesContent":["import type { Command } from 'commander';\n\n/**\n * Initialize a command object for a sub-command.\n * This is the type for the `init` function exported by each `src/commands/<name>/index.ts` module.\n * @param program Command object for the program.\n */\nexport type CommandInitFunction = (program: Command) => void;\n\n/**\n * Type for each `src/commands/<name>/index.ts` module.\n */\nexport type CommandInitModule = {\n  init: CommandInitFunction;\n};\n"]}

package/lib/types/SharedOptions.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Shared options for all commands.
+ */
+export interface SharedOptions {
+    /**
+     * The current working directory (mainly customized for tests).
+     * @default process.cwd()
+     */
+    cwd: string;
+    /**
+     * Whether to enable debug logging (superset of --verbose).
+     */
+    debug?: boolean;
+    /**
+     * Whether to enable verbose logging.
+     */
+    verbose?: boolean;
+    /**
+     * Whether to enable colors. Available on the command line as `--no-color`.
+     */
+    color?: boolean;
+    /**
+     * Whether to disable non-essential logging.
+     */
+    quiet?: boolean;
+    /**
+     * Experimental feature names to enable.
+     */
+    features?: string[];
+}
+//# sourceMappingURL=SharedOptions.d.ts.map

package/lib/types/SharedOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SharedOptions.d.ts","sourceRoot":"","sources":["../../src/types/SharedOptions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB"}

package/lib/types/SharedOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SharedOptions.js.map

package/lib/types/SharedOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SharedOptions.js","sourceRoot":"","sources":["../../src/types/SharedOptions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Shared options for all commands.\n */\nexport interface SharedOptions {\n  /**\n   * The current working directory (mainly customized for tests).\n   * @default process.cwd()\n   */\n  cwd: string;\n\n  /**\n   * Whether to enable debug logging (superset of --verbose).\n   */\n  debug?: boolean;\n\n  /**\n   * Whether to enable verbose logging.\n   */\n  verbose?: boolean;\n\n  /**\n   * Whether to enable colors. Available on the command line as `--no-color`.\n   */\n  color?: boolean;\n\n  /**\n   * Whether to disable non-essential logging.\n   */\n  quiet?: boolean;\n\n  /**\n   * Experimental feature names to enable.\n   */\n  features?: string[];\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/cli",
-  "version": "0.49.0",
+  "version": "0.49.2",
   "description": "The Cloudpack command line interface - a tool for managing fast inner and outer looping in web apps.",
   "license": "MIT",
   "type": "module",
@@ -11,15 +11,15 @@
   },
   "dependencies": {
     "@lage-run/target-graph": "^0.8.7",
-    "@ms-cloudpack/api-server": "^0.21.3",
-    "@ms-cloudpack/config": "^0.14.0",
+    "@ms-cloudpack/api-server": "^0.21.5",
+    "@ms-cloudpack/config": "^0.14.1",
     "@ms-cloudpack/create-express-app": "^1.3.12",
     "@ms-cloudpack/json-utilities": "^0.0.8",
-    "@ms-cloudpack/overlay": "^0.16.5",
-    "@ms-cloudpack/package-utilities": "^5.1.10",
+    "@ms-cloudpack/overlay": "^0.16.7",
+    "@ms-cloudpack/package-utilities": "^5.1.11",
     "@ms-cloudpack/path-string-parsing": "^1.1.1",
     "@ms-cloudpack/path-utilities": "^2.3.5",
-    "@ms-cloudpack/task-reporter": "^0.8.2",
+    "@ms-cloudpack/task-reporter": "^0.9.0",
     "@ms-cloudpack/telemetry": "^0.4.0",
     "commander": "^11.0.0",
     "cross-spawn": "^7.0.3",

package/lib/types/CommandFunction.d.ts

@@ -1,4 +0,0 @@
-import type { Command } from 'commander';
-import type { CreateCommandAction } from '../common/createCommandActionFunction.js';
-export type CommandFunction = (command: Command, createAction: CreateCommandAction) => void;
-//# sourceMappingURL=CommandFunction.d.ts.map

package/lib/types/CommandFunction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommandFunction.d.ts","sourceRoot":"","sources":["../../src/types/CommandFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAEpF,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,mBAAmB,KAAK,IAAI,CAAC"}

package/lib/types/CommandFunction.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=CommandFunction.js.map

package/lib/types/CommandFunction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommandFunction.js","sourceRoot":"","sources":["../../src/types/CommandFunction.ts"],"names":[],"mappings":"","sourcesContent":["import type { Command } from 'commander';\nimport type { CreateCommandAction } from '../common/createCommandActionFunction.js';\n\nexport type CommandFunction = (command: Command, createAction: CreateCommandAction) => void;\n"]}

package/lib/types/CreateCommandActionOptions.d.ts

@@ -1,7 +0,0 @@
-import type { CommandAction } from './CommandAction.js';
-export interface CreateCommandActionOptions<TOptions> {
-    execute: Promise<{
-        execute: CommandAction<TOptions>;
-    }>;
-}
-//# sourceMappingURL=CreateCommandActionOptions.d.ts.map

package/lib/types/CreateCommandActionOptions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CreateCommandActionOptions.d.ts","sourceRoot":"","sources":["../../src/types/CreateCommandActionOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,WAAW,0BAA0B,CAAC,QAAQ;IAClD,OAAO,EAAE,OAAO,CAAC;QACf,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;KAClC,CAAC,CAAC;CACJ"}

package/lib/types/CreateCommandActionOptions.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=CreateCommandActionOptions.js.map

package/lib/types/CreateCommandActionOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CreateCommandActionOptions.js","sourceRoot":"","sources":["../../src/types/CreateCommandActionOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { CommandAction } from './CommandAction.js';\n\nexport interface CreateCommandActionOptions<TOptions> {\n  execute: Promise<{\n    execute: CommandAction<TOptions>;\n  }>;\n}\n"]}