@arkstack/common 0.15.5 → 0.16.0

package/dist/index.d.ts

@@ -345,6 +345,15 @@ type HookFor<N extends string> = N extends keyof HookRegistry ? HookRegistry[N]
 type HookPos<N extends string, P extends string> = N extends keyof HookRegistry ? P extends keyof HookRegistry[N] ? HookRegistry[N][P] : (...args: any[]) => void : (...args: any[]) => void;
 type HookPositions<N extends string> = N extends keyof HookRegistry ? keyof HookRegistry[N] : Position;
 type HookArgs<N extends string, P extends string> = N extends keyof HookRegistry ? P extends keyof HookRegistry[N] ? HookRegistry[N][P] extends ((...args: infer A) => any) ? A : any[] : any[] : any[];
+type Choice<Value> = {
+  value: Value;
+  name?: string;
+  description?: string;
+  short?: string;
+  disabled?: boolean | string;
+  type?: never;
+};
+type Choices = readonly string[] | readonly Choice<string>[];
 /**
 * A single source → destination mapping a package wants to publish into the
 * consuming application.
@@ -362,7 +371,9 @@ interface PublishEntry {
  * A group of publishable artifacts registered by a package.
  */
 interface PublishGroup {
-  /** The package registering the artifacts, e.g. `@arkstack/cache`. */
+  /**
+   * The package registering the artifacts, e.g. `@arkstack/cache`.
+   */
   package: string;
   /**
    * Optional tag for selective publishing (`ark publish --tag <tag>`). A
@@ -377,6 +388,30 @@ interface PublishFilter {
   package?: string;
   tag?: string;
 }
+/** Optional filter applied when reading the registry. */
+interface PublishConfirmation {
+  /**
+   * The package registering the confirmation, e.g. `@arkstack/cache`.
+   */
+  package: string;
+  /**
+   * A message describing what the confirmation is
+   * for, e.g. "Are you sure you want to publish the cache migrations?"
+   */
+  message: string;
+  /**
+   * Options to choose from.
+   */
+  options: Choices;
+  /**
+   * A callback function to handle the selected choice and the stub file.
+   *
+   * @param choice
+   * @param stub
+   * @returns
+   */
+  callback?: (choice: Choice<string>['value'], stub: string) => string | Promise<string>;
+}
 //#endregion
 //#region src/system.d.ts
 /**
@@ -629,7 +664,13 @@ declare const logUnhandledError: typeof ErrorHandler.logUnhandledError;
  * shared instance even across duplicated module copies.
  */
 declare class Publisher {
-  /** The shared, global-symbol-backed registry of publishable groups. */
+  /**
+   * The shared, global-symbol-backed registry of publishable groups confirmations.
+   */
+  private static get confirmations();
+  /**
+   * The shared, global-symbol-backed registry of publishable groups.
+   */
   private static get registry();
   /**
    * Register artifacts a package wants to publish into the application.
@@ -654,8 +695,24 @@ declare class Publisher {
    * @returns       The matching publishable groups.
    */
   static publishables(filter?: PublishFilter): PublishGroup[];
-  /** Remove every registered publishable group (primarily for tests). */
+  /**
+   * Remove every registered publishable group and confirmation (primarily for
+   * tests).
+   */
   static clear(): void;
+  /**
+   * Ask to confirm what tag needs to be published.
+   *
+   * @param confirmation
+   */
+  static confirm(confirmation: PublishConfirmation | PublishConfirmation[]): void;
+  /**
+   * Read the registered confirmable groups
+   *
+   * @param pkg  The package for which to find confirmations.
+   * @returns    The matching confirmables groups.
+   */
+  static confirmables(pkg: string | true): PublishConfirmation[];
 }
 //#endregion
 //#region src/Hook.d.ts
@@ -813,4 +870,4 @@ declare const devTlsCredentials: (host?: string) => Promise<TlsCredentials>;
  */
 declare const localNetworkAddress: () => string | undefined;
 //#endregion
-export { AbstractModelConstructor, AppConfig, AppException, ArkstackErrorPayload, ArkstackErrorShape, CONFIG_KEY, ConfigLoader, ConfigRegistry, ConfigShape, DotPath, DotPathValue, Encryption, EnvKey, EnvLoader, EnvLookup, EnvRegistry, EnvReturn, ErrorHandler, Exception, FileImporter, GlobalConfig, GlobalEnv, Hash, Hook, HookArgs, HookFor, HookName, HookPos, HookPositions, HookRegistry, IHook, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, MergedConfig, ModelConstructor, ModelRegistry, Primitive, PublishEntry, PublishFilter, PublishGroup, Publisher, RequestException, TlsCredentials, UnionToIntersection, abort, abortIf, appKey, appUrl, assertFound, bindGracefulShutdown, bootWithDetectedPort, config, configLoader, createErrorPayload, devTlsCredentials, discoverCommands, env, envLoader, getErrorLogger, getModel, getPrimaryError, getValidationErrors, importFile, initializeGlobalContext, interopDefault, isClass, isModelNotFoundError, isValidationError, loadPrototypes, localNetworkAddress, logUnhandledError, nodeEnv, normalizeStatusCode, outputDir, perPage, rebuildOutput, renderError, resolveRuntimeDir, resolveRuntimeModule, serializeError, shouldHideStack, shouldLogError, toErrorShape, toOutputPath };
+export { AbstractModelConstructor, AppConfig, AppException, ArkstackErrorPayload, ArkstackErrorShape, CONFIG_KEY, Choice, Choices, ConfigLoader, ConfigRegistry, ConfigShape, DotPath, DotPathValue, Encryption, EnvKey, EnvLoader, EnvLookup, EnvRegistry, EnvReturn, ErrorHandler, Exception, FileImporter, GlobalConfig, GlobalEnv, Hash, Hook, HookArgs, HookFor, HookName, HookPos, HookPositions, HookRegistry, IHook, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, MergedConfig, ModelConstructor, ModelRegistry, Primitive, PublishConfirmation, PublishEntry, PublishFilter, PublishGroup, Publisher, RequestException, TlsCredentials, UnionToIntersection, abort, abortIf, appKey, appUrl, assertFound, bindGracefulShutdown, bootWithDetectedPort, config, configLoader, createErrorPayload, devTlsCredentials, discoverCommands, env, envLoader, getErrorLogger, getModel, getPrimaryError, getValidationErrors, importFile, initializeGlobalContext, interopDefault, isClass, isModelNotFoundError, isValidationError, loadPrototypes, localNetworkAddress, logUnhandledError, nodeEnv, normalizeStatusCode, outputDir, perPage, rebuildOutput, renderError, resolveRuntimeDir, resolveRuntimeModule, serializeError, shouldHideStack, shouldLogError, toErrorShape, toOutputPath };

package/dist/index.js

@@ -1,10 +1,9 @@
 import { _ as ConfigLoader, a as env, c as nodeEnv, d as resolveRuntimeDir, f as resolveRuntimeModule, g as CONFIG_KEY, h as envLoader, i as discoverCommands, l as outputDir, m as EnvLoader, n as appUrl, o as importFile, p as toOutputPath, r as config, s as interopDefault, t as appKey, u as rebuildOutput, v as configLoader } from "./system-BRlEuM_u.js";
-import { _ as Hash, c as abortIf, d as initializeGlobalContext, f as isClass, g as Exception, h as AppException, l as assertFound, m as RequestException, p as perPage, s as abort, u as getModel, v as Encryption } from "./utils-DH3mXX5o.js";
+import { _ as Hash, c as abortIf, d as initializeGlobalContext, f as isClass, g as Exception, h as AppException, l as assertFound, m as RequestException, p as perPage, s as abort, u as getModel, v as Encryption } from "./utils-BbOOTGzA.js";
 import { Hook as Hook$1 } from "@arkstack/foundry";
 import { Arkstack } from "@arkstack/contract";
 import { str } from "@h3ravel/support";
 import path from "node:path";
-import { ModelNotFoundException } from "arkormx";
 import { detect } from "detect-port";
 import pino from "pino";
 import chalk from "chalk";
@@ -150,11 +149,12 @@ var ErrorHandler = class ErrorHandler {
 	}
 	static isModelNotFoundError(error) {
 		const candidate = ErrorHandler.toErrorShape(error);
-		if (error.cause && error.cause instanceof ModelNotFoundException) {
-			error.getModelName = error.cause.getModelName;
+		const cause = error?.cause;
+		if (cause && typeof cause.getModelName === "function") {
+			error.getModelName = cause.getModelName;
 			return true;
 		}
-		return typeof candidate?.getModelName === "function" || error instanceof ModelNotFoundException;
+		return typeof candidate?.getModelName === "function";
 	}
 	static shouldHideStack() {
 		const value = process.env.HIDE_ERROR_STACK;
@@ -215,6 +215,7 @@ const logUnhandledError = ErrorHandler.logUnhandledError;
 //#endregion
 //#region src/Publisher.ts
 const REGISTRY_KEY = Symbol.for("arkstack.publishables");
+const CONFIRMATION_REGISTRY_KEY = Symbol.for("arkstack.confirmables");
 /**
 * Registry of artifacts packages want to publish into the consuming application.
 *
@@ -224,7 +225,15 @@ const REGISTRY_KEY = Symbol.for("arkstack.publishables");
 * shared instance even across duplicated module copies.
 */
 var Publisher = class {
-	/** The shared, global-symbol-backed registry of publishable groups. */
+	/** 
+	* The shared, global-symbol-backed registry of publishable groups confirmations. 
+	*/
+	static get confirmations() {
+		return globalThis[CONFIRMATION_REGISTRY_KEY] ??= [];
+	}
+	/** 
+	* The shared, global-symbol-backed registry of publishable groups. 
+	*/
 	static get registry() {
 		return globalThis[REGISTRY_KEY] ??= [];
 	}
@@ -255,9 +264,30 @@ var Publisher = class {
 	static publishables(filter = {}) {
 		return this.registry.filter((group) => (!filter.package || group.package === filter.package) && (!filter.tag || group.tag === filter.tag));
 	}
-	/** Remove every registered publishable group (primarily for tests). */
+	/**
+	* Remove every registered publishable group and confirmation (primarily for
+	* tests).
+	*/
 	static clear() {
 		this.registry.length = 0;
+		this.confirmations.length = 0;
+	}
+	/** 
+	* Ask to confirm what tag needs to be published. 
+	* 
+	* @param confirmation 
+	*/
+	static confirm(confirmation) {
+		this.confirmations.push(...Array.isArray(confirmation) ? confirmation : [confirmation]);
+	}
+	/**
+	* Read the registered confirmable groups
+	*
+	* @param pkg  The package for which to find confirmations.
+	* @returns    The matching confirmables groups.
+	*/
+	static confirmables(pkg) {
+		return this.confirmations.filter((group) => typeof pkg === "boolean" ? pkg : pkg === group.package);
 	}
 };
 //#endregion

package/dist/utils/index.js

@@ -1,2 +1,2 @@
-import { _ as Hash, a as use, c as abortIf, d as initializeGlobalContext, f as isClass, i as trait, l as assertFound, n as crc32, o as uses, p as perPage, r as getTraitMethods, s as abort, t as callTraitMethods, u as getModel, v as Encryption } from "../utils-DH3mXX5o.js";
+import { _ as Hash, a as use, c as abortIf, d as initializeGlobalContext, f as isClass, i as trait, l as assertFound, n as crc32, o as uses, p as perPage, r as getTraitMethods, s as abort, t as callTraitMethods, u as getModel, v as Encryption } from "../utils-BbOOTGzA.js";
 export { Encryption, Hash, abort, abortIf, assertFound, callTraitMethods, crc32, getModel, getTraitMethods, initializeGlobalContext, isClass, perPage, trait, use, uses };

package/dist/{utils-DH3mXX5o.js → utils-BbOOTGzA.js}

@@ -4,7 +4,6 @@ import { Arkstack } from "@arkstack/contract";
 import path from "node:path";
 import { Secret, TOTP } from "otpauth";
 import { compare, genSalt, hash } from "bcryptjs";
-import { getUserConfig } from "arkormx";
 //#region src/utils/encryption.ts
 var Encryption = class {
 	static algorithm = "aes-256-gcm";
@@ -186,6 +185,7 @@ async function getModel(modelName) {
 		return module.default ?? module[modelName] ?? module;
 	};
 	const isModelModule = (value) => typeof value === "object" && value !== null;
+	const { getUserConfig } = await import("arkormx");
 	const modelPath = getUserConfig().paths?.models || "./src/models";
 	const model = resolveModelExport(await importFile(resolveRuntimeModule(path.join(path.isAbsolute(modelPath) ? modelPath : path.join(Arkstack.rootDir(), modelPath), modelName))), path.basename(modelName, path.extname(modelName)));
 	if (typeof model !== "function") throw new Error(`Model "${modelName}" not found`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/common",
-  "version": "0.15.5",
+  "version": "0.16.0",
   "type": "module",
   "description": "Core utilities, primitives, and shared infrastructure for the Arkstack ecosystem.",
   "homepage": "https://arkstack.toneflix.net",
@@ -44,10 +44,10 @@
     "selfsigned": "^2.4.1"
   },
   "peerDependencies": {
-    "@h3ravel/support": "^2.2.0",
+    "@h3ravel/support": "^2.2.1",
     "arkormx": "^2.10.1",
-    "@arkstack/contract": "^0.15.5",
-    "@arkstack/foundry": "^0.15.5"
+    "@arkstack/contract": "^0.16.0",
+    "@arkstack/foundry": "^0.16.0"
   },
   "optionalDependencies": {
     "@faker-js/faker": "^10.4.0"