@shell-shock/plugin-upgrade 0.1.5 → 0.1.7

package/dist/index.mjs

@@ -16,10 +16,16 @@ const plugin = (options = {}) => {
 		name: "shell-shock:upgrade",
 		config() {
 			this.debug("Providing default configuration for the Shell Shock `upgrade` plugin.");
-			return { upgrade: defu(options, {
-				type: "confirm",
-				staleTime: 2160 * 60 * 1e3
-			}) };
+			return {
+				upgrade: defu(options, {
+					type: "confirm",
+					staleTime: 2160 * 60 * 1e3
+				}),
+				env: {
+					types: "@shell-shock/plugin-upgrade/types/env#ShellShockUpgradePluginEnv",
+					validate: false
+				}
+			};
 		},
 		configResolved() {
 			this.debug("Adding the CLI upgrade commands to the application context.");

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["render","getAppTitle","joinPaths","defu","UpgradeBuiltin","UpgradeCommand","plugin","options","name","config","debug","upgrade","type","staleTime","configResolved","inputs","some","input","id","info","push","alias","path","segments","title","description","entry","file","entryPath","isVirtual","prepare","_$createComponent"],"sources":["../src/index.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport defu from \"defu\";\nimport type { Plugin } from \"powerlines\";\nimport { UpgradeBuiltin, UpgradeCommand } from \"./components\";\nimport type {\n  UpgradePluginContext,\n  UpgradePluginOptions\n} from \"./types/plugin\";\n\n/**\n * The Upgrade - Shell Shock plugin to add version check functionality and upgrade commands to a Shell Shock application.\n */\nexport const plugin = <\n  TContext extends UpgradePluginContext = UpgradePluginContext\n>(\n  options: UpgradePluginOptions = {}\n): Plugin<TContext> => {\n  return {\n    name: \"shell-shock:upgrade\",\n    config() {\n      this.debug(\n        \"Providing default configuration for the Shell Shock `upgrade` plugin.\"\n      );\n\n      return {\n        upgrade: defu(options, {\n          type: \"confirm\",\n          staleTime: 36 * 60 * 60 * 1000 // 36 hours\n        })\n      };\n    },\n    configResolved() {\n      this.debug(\"Adding the CLI upgrade commands to the application context.\");\n\n      this.inputs ??= [];\n      if (this.inputs.some(input => input.id === \"upgrade\")) {\n        this.info(\n          \"The `upgrade` command already exists in the commands list. If you would like the upgrade command to be managed by the `@shell-shock/plugin-upgrade` package, please remove or rename the command.\"\n        );\n      } else {\n        this.inputs.push({\n          id: \"upgrade\",\n          name: \"upgrade\",\n          alias: [\"up\", \"update\"],\n          path: \"upgrade\",\n          segments: [\"upgrade\"],\n          title: \"Upgrade\",\n          description: `A command for checking and upgrading the version of the ${getAppTitle(\n            this\n          )}.`,\n          entry: {\n            file: joinPaths(this.entryPath, \"upgrade\", \"command.ts\"),\n            input: {\n              file: joinPaths(this.entryPath, \"upgrade\", \"command.ts\")\n            }\n          },\n          isVirtual: false\n        });\n      }\n    },\n    async prepare() {\n      this.debug(\n        \"Rendering upgrade built-in and command modules for the Shell Shock `upgrade` plugin.\"\n      );\n\n      return render(\n        this,\n        <>\n          <UpgradeBuiltin />\n          <UpgradeCommand />\n        </>\n      );\n    }\n  };\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;AAgCA,MAAaM,UAGXC,UAAgC,EAAE,KACb;AACrB,QAAO;EACLC,MAAM;EACNC,SAAS;AACP,QAAKC,MACH,wEACD;AAED,UAAO,EACLC,SAASR,KAAKI,SAAS;IACrBK,MAAM;IACNC,WAAW,OAAU,KAAK;IAC3B,CAAA,EACF;;EAEHC,iBAAiB;AACf,QAAKJ,MAAM,8DAA8D;AAEzE,QAAKK,WAAW,EAAE;AAClB,OAAI,KAAKA,OAAOC,MAAKC,UAASA,MAAMC,OAAO,UAAU,CACnD,MAAKC,KACH,oMACD;OAED,MAAKJ,OAAOK,KAAK;IACfF,IAAI;IACJV,MAAM;IACNa,OAAO,CAAC,MAAM,SAAS;IACvBC,MAAM;IACNC,UAAU,CAAC,UAAU;IACrBC,OAAO;IACPC,aAAa,2DAA2DxB,YACtE,KACD,CAAA;IACDyB,OAAO;KACLC,MAAMzB,UAAU,KAAK0B,WAAW,WAAW,aAAa;KACxDX,OAAO,EACLU,MAAMzB,UAAU,KAAK0B,WAAW,WAAW,aAAY,EACzD;KACD;IACDC,WAAW;IACZ,CAAC;;EAGN,MAAMC,UAAU;AACd,QAAKpB,MACH,uFACD;AAED,UAAOV,OACL,MAAI,CAAA+B,gBAED3B,gBAAc,EAAA,CAAA,EAAA2B,gBACd1B,gBAAc,EAAA,CAAA,CAEnB,CAAC;;EAEJ;;AAGH,kBAAeC"}
+{"version":3,"file":"index.mjs","names":["render","getAppTitle","joinPaths","defu","UpgradeBuiltin","UpgradeCommand","plugin","options","name","config","debug","upgrade","type","staleTime","env","types","validate","configResolved","inputs","some","input","id","info","push","alias","path","segments","title","description","entry","file","entryPath","isVirtual","prepare","_$createComponent"],"sources":["../src/index.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport defu from \"defu\";\nimport type { Plugin } from \"powerlines\";\nimport { UpgradeBuiltin, UpgradeCommand } from \"./components\";\nimport type {\n  UpgradePluginContext,\n  UpgradePluginOptions\n} from \"./types/plugin\";\n\n/**\n * The Upgrade - Shell Shock plugin to add version check functionality and upgrade commands to a Shell Shock application.\n */\nexport const plugin = <\n  TContext extends UpgradePluginContext = UpgradePluginContext\n>(\n  options: UpgradePluginOptions = {}\n): Plugin<TContext> => {\n  return {\n    name: \"shell-shock:upgrade\",\n    config() {\n      this.debug(\n        \"Providing default configuration for the Shell Shock `upgrade` plugin.\"\n      );\n\n      return {\n        upgrade: defu(options, {\n          type: \"confirm\",\n          staleTime: 36 * 60 * 60 * 1000 // 36 hours\n        }),\n        env: {\n          types:\n            \"@shell-shock/plugin-upgrade/types/env#ShellShockUpgradePluginEnv\",\n          validate: false\n        }\n      };\n    },\n    configResolved() {\n      this.debug(\"Adding the CLI upgrade commands to the application context.\");\n\n      this.inputs ??= [];\n      if (this.inputs.some(input => input.id === \"upgrade\")) {\n        this.info(\n          \"The `upgrade` command already exists in the commands list. If you would like the upgrade command to be managed by the `@shell-shock/plugin-upgrade` package, please remove or rename the command.\"\n        );\n      } else {\n        this.inputs.push({\n          id: \"upgrade\",\n          name: \"upgrade\",\n          alias: [\"up\", \"update\"],\n          path: \"upgrade\",\n          segments: [\"upgrade\"],\n          title: \"Upgrade\",\n          description: `A command for checking and upgrading the version of the ${getAppTitle(\n            this\n          )}.`,\n          entry: {\n            file: joinPaths(this.entryPath, \"upgrade\", \"command.ts\"),\n            input: {\n              file: joinPaths(this.entryPath, \"upgrade\", \"command.ts\")\n            }\n          },\n          isVirtual: false\n        });\n      }\n    },\n    async prepare() {\n      this.debug(\n        \"Rendering upgrade built-in and command modules for the Shell Shock `upgrade` plugin.\"\n      );\n\n      return render(\n        this,\n        <>\n          <UpgradeBuiltin />\n          <UpgradeCommand />\n        </>\n      );\n    }\n  };\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;AAgCA,MAAaM,UAGXC,UAAgC,EAAE,KACb;AACrB,QAAO;EACLC,MAAM;EACNC,SAAS;AACP,QAAKC,MACH,wEACD;AAED,UAAO;IACLC,SAASR,KAAKI,SAAS;KACrBK,MAAM;KACNC,WAAW,OAAU,KAAK;KAC3B,CAAC;IACFC,KAAK;KACHC,OACE;KACFC,UAAU;KACZ;IACD;;EAEHC,iBAAiB;AACf,QAAKP,MAAM,8DAA8D;AAEzE,QAAKQ,WAAW,EAAE;AAClB,OAAI,KAAKA,OAAOC,MAAKC,UAASA,MAAMC,OAAO,UAAU,CACnD,MAAKC,KACH,oMACD;OAED,MAAKJ,OAAOK,KAAK;IACfF,IAAI;IACJb,MAAM;IACNgB,OAAO,CAAC,MAAM,SAAS;IACvBC,MAAM;IACNC,UAAU,CAAC,UAAU;IACrBC,OAAO;IACPC,aAAa,2DAA2D3B,YACtE,KACD,CAAA;IACD4B,OAAO;KACLC,MAAM5B,UAAU,KAAK6B,WAAW,WAAW,aAAa;KACxDX,OAAO,EACLU,MAAM5B,UAAU,KAAK6B,WAAW,WAAW,aAAY,EACzD;KACD;IACDC,WAAW;IACZ,CAAC;;EAGN,MAAMC,UAAU;AACd,QAAKvB,MACH,uFACD;AAED,UAAOV,OACL,MAAI,CAAAkC,gBAED9B,gBAAc,EAAA,CAAA,EAAA8B,gBACd7B,gBAAc,EAAA,CAAA,CAEnB,CAAC;;EAEJ;;AAGH,kBAAeC"}

package/dist/types/env.d.cts

@@ -0,0 +1,14 @@
+import { ShellShockEnv } from "@shell-shock/core/types/env";
+
+//#region src/types/env.d.ts
+interface ShellShockUpgradePluginEnv extends ShellShockEnv {
+  /**
+   * An environment variable that can be set to skip the version check when determining if a check for updates is required. If this variable is set to any value, the `isCheckForUpdatesRequired` function will return `false`, indicating that a check for updates is not required. This can be useful in CI environments or other non-interactive contexts where you want to avoid performing a version check, which may involve file system operations or network requests. By setting this environment variable, you can ensure that the upgrade process proceeds without checking for updates, which can help speed up the process in certain scenarios.
+   *
+   * @defaultValue false
+   */
+  SKIP_VERSION_CHECK?: boolean;
+}
+//#endregion
+export { ShellShockUpgradePluginEnv };
+//# sourceMappingURL=env.d.cts.map

package/dist/types/env.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.cts","names":[],"sources":["../../src/types/env.ts"],"sourcesContent":[],"mappings":";;;UAoBiB,0BAAA,SAAmC;;AAApD"}

package/dist/types/env.d.mts

@@ -0,0 +1,14 @@
+import { ShellShockEnv } from "@shell-shock/core/types/env";
+
+//#region src/types/env.d.ts
+interface ShellShockUpgradePluginEnv extends ShellShockEnv {
+  /**
+   * An environment variable that can be set to skip the version check when determining if a check for updates is required. If this variable is set to any value, the `isCheckForUpdatesRequired` function will return `false`, indicating that a check for updates is not required. This can be useful in CI environments or other non-interactive contexts where you want to avoid performing a version check, which may involve file system operations or network requests. By setting this environment variable, you can ensure that the upgrade process proceeds without checking for updates, which can help speed up the process in certain scenarios.
+   *
+   * @defaultValue false
+   */
+  SKIP_VERSION_CHECK?: boolean;
+}
+//#endregion
+export { ShellShockUpgradePluginEnv };
+//# sourceMappingURL=env.d.mts.map

package/dist/types/env.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.mts","names":[],"sources":["../../src/types/env.ts"],"sourcesContent":[],"mappings":";;;UAoBiB,0BAAA,SAAmC;;AAApD"}

package/dist/types/env.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/types/index.d.cts

@@ -1,3 +1,3 @@
-import { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig, UpgradeType } from "./plugin.cjs";
+import { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig } from "./plugin.cjs";
 import { PACKAGE_MANAGERS, PACKAGE_MANAGER_LOCKFILE_MAP, PackageManager } from "./package-manager.cjs";
-export { PACKAGE_MANAGERS, PACKAGE_MANAGER_LOCKFILE_MAP, PackageManager, UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig, UpgradeType };
+export { PACKAGE_MANAGERS, PACKAGE_MANAGER_LOCKFILE_MAP, PackageManager, UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig };

package/dist/types/index.d.mts

@@ -1,3 +1,3 @@
-import { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig, UpgradeType } from "./plugin.mjs";
+import { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig } from "./plugin.mjs";
 import { PACKAGE_MANAGERS, PACKAGE_MANAGER_LOCKFILE_MAP, PackageManager } from "./package-manager.mjs";
-export { PACKAGE_MANAGERS, PACKAGE_MANAGER_LOCKFILE_MAP, PackageManager, UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig, UpgradeType };
+export { PACKAGE_MANAGERS, PACKAGE_MANAGER_LOCKFILE_MAP, PackageManager, UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig };

package/dist/types/plugin.d.cts

@@ -2,21 +2,7 @@ import { ResolvedConfig, UserConfig } from "@shell-shock/core/types/config";
 import { Context } from "@shell-shock/core/types/context";
 
 //#region src/types/plugin.d.ts
-type UpgradeType = "confirm" | "auto" | "display" | "command";
 interface UpgradePluginOptions {
-  /**
-   * The type of upgrade to perform. This option determines how the upgrade process will be handled.
-   *
-   * @remarks
-   * The upgrade logic will behave differently based on the value of this field:
-   * - `"confirm"` - the user will be prompted to confirm the upgrade before it is performed. This is the default behavior and is recommended for most users, as it provides an extra layer of safety against unintended upgrades.
-   * - `"auto"` - the upgrade will be performed automatically without any user confirmation. This option is suitable for advanced users who want a seamless upgrade experience and are confident in the stability of new versions.
-   * - `"display"` - the command will only display the latest available version without performing any upgrade. This option is useful for users who want to check for updates without making any changes to their system.
-   * - `"command"` - the upgrade will be triggered by a specific command. This option allows users to manually initiate the upgrade process through a dedicated command.
-   *
-   * @defaultValue "confirm"
-   */
-  type?: UpgradeType;
   /**
    * The time in milliseconds after which previously retrieved version data is considered stale.
    *
@@ -41,5 +27,5 @@ type UpgradePluginResolvedConfig = ResolvedConfig & {
 };
 type UpgradePluginContext<TResolvedConfig extends UpgradePluginResolvedConfig = UpgradePluginResolvedConfig> = Context<TResolvedConfig>;
 //#endregion
-export { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig, UpgradeType };
+export { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig };
 //# sourceMappingURL=plugin.d.cts.map

package/dist/types/plugin.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;KAwBY,WAAA;UAEK,oBAAA;EAFL;AAEZ;AA0BA;AAOA;;;;;AAOA;;;;EAGI,IAAA,CAAA,EA9BK,WA8BL;EAAO;;;;;;;;;;KAjBC,uBAAA,GAA0B;;;;WAI3B;;KAGC,2BAAA,GAA8B;;;;WAI/B,SAAS;;KAGR,6CACc,8BACtB,+BACA,QAAQ"}
+{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;UAwBiB,oBAAA;;AAAjB;AAYA;AAOA;;;;;EAOY,SAAA,CAAA,EAAA,MAAA;;AAER,KAhBQ,uBAAA,GAA0B,UAgBlC,GAAA;EACQ;;;WAbD;;KAGC,2BAAA,GAA8B;;;;WAI/B,SAAS;;KAGR,6CACc,8BACtB,+BACA,QAAQ"}

package/dist/types/plugin.d.mts

@@ -2,21 +2,7 @@ import { ResolvedConfig, UserConfig } from "@shell-shock/core/types/config";
 import { Context } from "@shell-shock/core/types/context";
 
 //#region src/types/plugin.d.ts
-type UpgradeType = "confirm" | "auto" | "display" | "command";
 interface UpgradePluginOptions {
-  /**
-   * The type of upgrade to perform. This option determines how the upgrade process will be handled.
-   *
-   * @remarks
-   * The upgrade logic will behave differently based on the value of this field:
-   * - `"confirm"` - the user will be prompted to confirm the upgrade before it is performed. This is the default behavior and is recommended for most users, as it provides an extra layer of safety against unintended upgrades.
-   * - `"auto"` - the upgrade will be performed automatically without any user confirmation. This option is suitable for advanced users who want a seamless upgrade experience and are confident in the stability of new versions.
-   * - `"display"` - the command will only display the latest available version without performing any upgrade. This option is useful for users who want to check for updates without making any changes to their system.
-   * - `"command"` - the upgrade will be triggered by a specific command. This option allows users to manually initiate the upgrade process through a dedicated command.
-   *
-   * @defaultValue "confirm"
-   */
-  type?: UpgradeType;
   /**
    * The time in milliseconds after which previously retrieved version data is considered stale.
    *
@@ -41,5 +27,5 @@ type UpgradePluginResolvedConfig = ResolvedConfig & {
 };
 type UpgradePluginContext<TResolvedConfig extends UpgradePluginResolvedConfig = UpgradePluginResolvedConfig> = Context<TResolvedConfig>;
 //#endregion
-export { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig, UpgradeType };
+export { UpgradePluginContext, UpgradePluginOptions, UpgradePluginResolvedConfig, UpgradePluginUserConfig };
 //# sourceMappingURL=plugin.d.mts.map

package/dist/types/plugin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;KAwBY,WAAA;UAEK,oBAAA;EAFL;AAEZ;AA0BA;AAOA;;;;;AAOA;;;;EAGI,IAAA,CAAA,EA9BK,WA8BL;EAAO;;;;;;;;;;KAjBC,uBAAA,GAA0B;;;;WAI3B;;KAGC,2BAAA,GAA8B;;;;WAI/B,SAAS;;KAGR,6CACc,8BACtB,+BACA,QAAQ"}
+{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;UAwBiB,oBAAA;;AAAjB;AAYA;AAOA;;;;;EAOY,SAAA,CAAA,EAAA,MAAA;;AAER,KAhBQ,uBAAA,GAA0B,UAgBlC,GAAA;EACQ;;;WAbD;;KAGC,2BAAA,GAA8B;;;;WAI/B,SAAS;;KAGR,6CACc,8BACtB,+BACA,QAAQ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shell-shock/plugin-upgrade",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "type": "module",
   "description": "A package containing a Shell Shock plugin to manage upgrading the local application's version.",
   "repository": {
@@ -112,6 +112,20 @@
         "default": "./dist/types/index.mjs"
       }
     },
+    "./types/env": {
+      "require": {
+        "types": "./dist/types/env.d.cts",
+        "default": "./dist/types/env.cjs"
+      },
+      "import": {
+        "types": "./dist/types/env.d.mts",
+        "default": "./dist/types/env.mjs"
+      },
+      "default": {
+        "types": "./dist/types/env.d.mts",
+        "default": "./dist/types/env.mjs"
+      }
+    },
     "./types/package-manager": {
       "require": {
         "types": "./dist/types/package-manager.d.cts",
@@ -154,16 +168,16 @@
   "dependencies": {
     "@alloy-js/core": "0.23.0-dev.8",
     "@alloy-js/typescript": "0.23.0-dev.4",
-    "@powerlines/deepkit": "^0.6.67",
-    "@powerlines/plugin-alloy": "^0.23.17",
-    "@powerlines/plugin-plugin": "^0.12.238",
-    "@shell-shock/core": "^0.9.1",
+    "@powerlines/deepkit": "^0.6.69",
+    "@powerlines/plugin-alloy": "^0.23.19",
+    "@powerlines/plugin-plugin": "^0.12.240",
+    "@shell-shock/core": "^0.9.3",
     "@stryke/path": "0.26.6",
-    "powerlines": "^0.38.54",
+    "powerlines": "^0.38.56",
     "defu": "6.1.4"
   },
   "devDependencies": {
-    "@powerlines/plugin-deepkit": "^0.11.166",
+    "@powerlines/plugin-deepkit": "^0.11.168",
     "@types/node": "^25.3.0"
   },
   "publishConfig": {
@@ -181,5 +195,5 @@
       "./package.json": "./package.json"
     }
   },
-  "gitHead": "b94dfbfbfd27471351cac0596afe1f550d8dca57"
+  "gitHead": "4cf65f37aca1c43ffac57a86bf21e184134437f1"
 }