@flowscripter/dynamic-cli-framework-api 1.2.0 → 1.3.0

package/dist/src/service/core/SpawnService.d.ts

@@ -4,7 +4,7 @@ export declare const SPAWN_SERVICE_ID = "@flowscripter/dynamic-cli-framework/spa
  *
  * `ok` is `true` only when the process launched and exited with code `0`. A launch failure (e.g.
  * the binary was not found) sets `error` with no `exitCode`; a non-zero exit sets `exitCode` with
- * no `error`.
+ * no `error`; a process that did not exit within {@link SpawnOptions.timeoutMs} sets `timedOut`.
  */
 export type SpawnResult = {
     ok: true;
@@ -13,6 +13,9 @@ export type SpawnResult = {
     ok: false;
     exitCode?: number;
     error?: Error;
+} | {
+    ok: false;
+    timedOut: true;
 };
 /**
  * Options for {@link SpawnService.spawn}.
@@ -40,6 +43,12 @@ export interface SpawnOptions {
      * `true`.
      */
     longRunning?: boolean;
+    /**
+     * If specified, the spawned process is aborted (`SIGTERM`, followed by `SIGKILL` if it has not
+     * exited after a grace period) if it has not exited within this many milliseconds. Defaults to
+     * unbounded.
+     */
+    timeoutMs?: number;
 }
 /**
  * Service allowing a {@link Command} to spawn a child process, with output optionally captured

package/dist/src/service/core/SpawnService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpawnService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/SpawnService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,sDAAsD,CAAC;AAEpF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,QAAQ,KAAK,IAAI,CAAC;IAE/D;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,YAAY;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACrF"}
+{"version":3,"file":"SpawnService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/SpawnService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,sDAAsD,CAAC;AAEpF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAC/C;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,QAAQ,KAAK,IAAI,CAAC;IAE/D;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,YAAY;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACrF"}

package/dist/src/service/core/UpgradeService.d.ts

@@ -88,5 +88,18 @@ export default interface UpgradeService {
      * @return the {@link UpgradeResult}. Never rejects.
      */
     upgrade(os?: SupportedOs, arch?: SupportedArch, installMethod?: InstallMethod): Promise<UpgradeResult>;
+    /**
+     * Returns the result of the version check that was started eagerly once this service's
+     * dependencies were set (or starts one now, with default/no-override detection, if none has
+     * started yet). Every call is backed by the same cached promise.
+     *
+     * @param waitForResult if `true`, waits for the check to fully resolve. If `false` (default),
+     * gives up and resolves to `undefined` after an internal bounded delay, so callers on a
+     * startup/opportunistic path are never blocked by a slow network/spawn call.
+     *
+     * @return the {@link UpgradeCheckResult}, or `undefined` if unsupported/unconfigured or the
+     * bounded wait elapsed. Never rejects.
+     */
+    getUpgradeCheckResult(waitForResult?: boolean): Promise<UpgradeCheckResult | undefined>;
 }
 //# sourceMappingURL=UpgradeService.d.ts.map

package/dist/src/service/core/UpgradeService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UpgradeService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/UpgradeService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,wDAAwD,CAAC;AAExF;;GAEG;AACH,oBAAY,WAAW;IACrB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,GAAG,QAAQ;IACX,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,cAAc;IACrC;;;;OAIG;IACH,QAAQ,IAAI,WAAW,GAAG,SAAS,CAAC;IAEpC;;;;OAIG;IACH,UAAU,IAAI,aAAa,GAAG,SAAS,CAAC;IAExC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IACH,eAAe,CACb,EAAE,CAAC,EAAE,WAAW,EAChB,IAAI,CAAC,EAAE,aAAa,EACpB,aAAa,CAAC,EAAE,aAAa,GAC5B,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAE3C;;;;;;;;OAQG;IACH,OAAO,CACL,EAAE,CAAC,EAAE,WAAW,EAChB,IAAI,CAAC,EAAE,aAAa,EACpB,aAAa,CAAC,EAAE,aAAa,GAC5B,OAAO,CAAC,aAAa,CAAC,CAAC;CAC3B"}
+{"version":3,"file":"UpgradeService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/UpgradeService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,wDAAwD,CAAC;AAExF;;GAEG;AACH,oBAAY,WAAW;IACrB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,GAAG,QAAQ;IACX,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,cAAc;IACrC;;;;OAIG;IACH,QAAQ,IAAI,WAAW,GAAG,SAAS,CAAC;IAEpC;;;;OAIG;IACH,UAAU,IAAI,aAAa,GAAG,SAAS,CAAC;IAExC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IACH,eAAe,CACb,EAAE,CAAC,EAAE,WAAW,EAChB,IAAI,CAAC,EAAE,aAAa,EACpB,aAAa,CAAC,EAAE,aAAa,GAC5B,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAE3C;;;;;;;;OAQG;IACH,OAAO,CACL,EAAE,CAAC,EAAE,WAAW,EAChB,IAAI,CAAC,EAAE,aAAa,EACpB,aAAa,CAAC,EAAE,aAAa,GAC5B,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;CACzF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework-api",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "API for https://github.com/flowscripter/dynamic-cli-framework",
   "keywords": [
     "bun",

package/src/service/core/SpawnService.ts

@@ -5,11 +5,12 @@ export const SPAWN_SERVICE_ID = "@flowscripter/dynamic-cli-framework/spawn-servi
  *
  * `ok` is `true` only when the process launched and exited with code `0`. A launch failure (e.g.
  * the binary was not found) sets `error` with no `exitCode`; a non-zero exit sets `exitCode` with
- * no `error`.
+ * no `error`; a process that did not exit within {@link SpawnOptions.timeoutMs} sets `timedOut`.
  */
 export type SpawnResult =
   | { ok: true; exitCode: number }
-  | { ok: false; exitCode?: number; error?: Error };
+  | { ok: false; exitCode?: number; error?: Error }
+  | { ok: false; timedOut: true };
 
 /**
  * Options for {@link SpawnService.spawn}.
@@ -40,6 +41,13 @@ export interface SpawnOptions {
    * `true`.
    */
   longRunning?: boolean;
+
+  /**
+   * If specified, the spawned process is aborted (`SIGTERM`, followed by `SIGKILL` if it has not
+   * exited after a grace period) if it has not exited within this many milliseconds. Defaults to
+   * unbounded.
+   */
+  timeoutMs?: number;
 }
 
 /**

package/src/service/core/UpgradeService.ts

@@ -106,4 +106,18 @@ export default interface UpgradeService {
     arch?: SupportedArch,
     installMethod?: InstallMethod,
   ): Promise<UpgradeResult>;
+
+  /**
+   * Returns the result of the version check that was started eagerly once this service's
+   * dependencies were set (or starts one now, with default/no-override detection, if none has
+   * started yet). Every call is backed by the same cached promise.
+   *
+   * @param waitForResult if `true`, waits for the check to fully resolve. If `false` (default),
+   * gives up and resolves to `undefined` after an internal bounded delay, so callers on a
+   * startup/opportunistic path are never blocked by a slow network/spawn call.
+   *
+   * @return the {@link UpgradeCheckResult}, or `undefined` if unsupported/unconfigured or the
+   * bounded wait elapsed. Never rejects.
+   */
+  getUpgradeCheckResult(waitForResult?: boolean): Promise<UpgradeCheckResult | undefined>;
 }