@mxpicture/gcp-functions-common 1.1.2 → 1.1.4

package/dist/helper/helper.object.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Creates a shallow copy of an object containing only the specified keys.
+ *
+ * @param route - The source object to strip.
+ * @param allowedKeys - The keys to retain in the resulting object.
+ * @returns A new object containing only the allowed keys that exist on `route`.
+ */
 export declare const stripObject: <T extends object>(route: T, allowedKeys: (keyof T)[]) => T;
 //# sourceMappingURL=helper.object.d.ts.map

package/dist/helper/helper.object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helper.object.d.ts","sourceRoot":"","sources":["../../src/helper/helper.object.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,EAC1C,OAAO,CAAC,EACR,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,KACvB,CAKF,CAAC"}
+{"version":3,"file":"helper.object.d.ts","sourceRoot":"","sources":["../../src/helper/helper.object.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,EAC1C,OAAO,CAAC,EACR,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,KACvB,CAKF,CAAC"}

package/dist/helper/helper.object.js

@@ -1,3 +1,10 @@
+/**
+ * Creates a shallow copy of an object containing only the specified keys.
+ *
+ * @param route - The source object to strip.
+ * @param allowedKeys - The keys to retain in the resulting object.
+ * @returns A new object containing only the allowed keys that exist on `route`.
+ */
 export const stripObject = (route, allowedKeys) => {
     const result = {};
     for (const allowedKey of allowedKeys)

package/dist/helper/helper.object.js.map

@@ -1 +1 @@
-{"version":3,"file":"helper.object.js","sourceRoot":"","sources":["../../src/helper/helper.object.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,KAAQ,EACR,WAAwB,EACrB,EAAE;IACL,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,KAAK,MAAM,UAAU,IAAI,WAAW;QAClC,IAAI,UAAU,IAAI,KAAK;YAAE,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,OAAO,MAAW,CAAC;AACrB,CAAC,CAAC"}
+{"version":3,"file":"helper.object.js","sourceRoot":"","sources":["../../src/helper/helper.object.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,KAAQ,EACR,WAAwB,EACrB,EAAE;IACL,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,KAAK,MAAM,UAAU,IAAI,WAAW;QAClC,IAAI,UAAU,IAAI,KAAK;YAAE,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,OAAO,MAAW,CAAC;AACrB,CAAC,CAAC"}

package/dist/path/path.common.d.ts

@@ -1,7 +1,15 @@
+/**
+ * Enumerates the high-level base directory categories within the repository.
+ */
 export declare enum BasePathType {
+    /** The `packages` directory that holds all workspace packages. */
     packages = "packages",
+    /** The repository root directory. */
     root = "root"
 }
+/**
+ * Enumerates the workspace package names within the `packages` directory.
+ */
 export declare enum WsPathType {
     backend = "backend",
     common = "common",
@@ -9,16 +17,56 @@ export declare enum WsPathType {
     fs = "fs",
     generator = "generator"
 }
+/**
+ * Maps each {@link BasePathType} to its resolved absolute file-system path.
+ */
 export type BasePath = Record<BasePathType, string>;
+/**
+ * Pre-resolved absolute paths for the base directory categories.
+ */
 export declare const basePaths: BasePath;
+/**
+ * Maps each {@link WsPathType} to its resolved absolute file-system path.
+ */
 export type WsPath = Record<WsPathType, string>;
+/**
+ * Pre-resolved absolute paths for every workspace package directory.
+ */
 export declare const wsPaths: WsPath;
+/**
+ * Extended path information for a specific workspace, including the
+ * package directory name, workspace name, and `package.json` location.
+ */
 export interface CurrentPaths extends BasePath {
+    /** Name of the top-level directory (expected to be `"packages"`). */
     pkgDirName: string;
+    /** The workspace name (one of the {@link WsPathType} values). */
     wsName: string;
+    /** Absolute path to the workspace's `package.json`. */
     packageJsonPath: string;
 }
+/**
+ * Absolute path to the repository-level `changelog.json` file.
+ */
 export declare const changelogPath: string;
+/**
+ * Returns the absolute path to the `package.json` of the given workspace.
+ *
+ * @param type - The workspace whose `package.json` path is requested.
+ * @returns The resolved absolute path.
+ */
 export declare const packageJsonPath: (type: WsPathType) => string;
+/**
+ * Derives {@link CurrentPaths} for the workspace that contains the given file path.
+ *
+ * @remarks
+ * Accepts both absolute and relative paths. The path must reside within one of
+ * the known workspace directories under `packages/`. Throws if the path does
+ * not match the expected layout.
+ *
+ * @param currentPath - A file-system path within a workspace.
+ * @returns Resolved path information for the containing workspace.
+ * @throws If the path does not start with `packages/` or names an unknown workspace.
+ */
 export declare const createCurrentWsPaths: (currentPath: string) => CurrentPaths;
 //# sourceMappingURL=path.common.d.ts.map

package/dist/path/path.common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"path.common.d.ts","sourceRoot":"","sources":["../../src/path/path.common.ts"],"names":[],"mappings":"AAMA,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAED,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,EAAE,OAAO;IACT,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAEpD,eAAO,MAAM,SAAS,EAAE,QAGvB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAEhD,eAAO,MAAM,OAAO,EAAE,MAMrB,CAAC;AAEF,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,aAAa,QAAyC,CAAC;AAEpE,eAAO,MAAM,eAAe,GAAI,MAAM,UAAU,WACX,CAAC;AAEtC,eAAO,MAAM,oBAAoB,GAAI,aAAa,MAAM,KAAG,YAyB1D,CAAC"}
+{"version":3,"file":"path.common.d.ts","sourceRoot":"","sources":["../../src/path/path.common.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,oBAAY,YAAY;IACtB,kEAAkE;IAClE,QAAQ,aAAa;IACrB,qCAAqC;IACrC,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,EAAE,OAAO;IACT,SAAS,cAAc;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,QAGvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,MAMrB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;IACnB,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,QAAyC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,UAAU,WACX,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,GAAI,aAAa,MAAM,KAAG,YAyB1D,CAAC"}

package/dist/path/path.common.js

@@ -1,12 +1,18 @@
-import { dirname, isAbsolute, join, relative, resolve, sep } from "path";
-import { fileURLToPath } from "url";
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const packagesDir = resolve(__dirname, "../../..");
+import { isAbsolute, join, relative, resolve, sep } from "path";
+const packagesDir = resolve(import.meta.dirname, "../../..");
+/**
+ * Enumerates the high-level base directory categories within the repository.
+ */
 export var BasePathType;
 (function (BasePathType) {
+    /** The `packages` directory that holds all workspace packages. */
     BasePathType["packages"] = "packages";
+    /** The repository root directory. */
     BasePathType["root"] = "root";
 })(BasePathType || (BasePathType = {}));
+/**
+ * Enumerates the workspace package names within the `packages` directory.
+ */
 export var WsPathType;
 (function (WsPathType) {
     WsPathType["backend"] = "backend";
@@ -15,10 +21,16 @@ export var WsPathType;
     WsPathType["fs"] = "fs";
     WsPathType["generator"] = "generator";
 })(WsPathType || (WsPathType = {}));
+/**
+ * Pre-resolved absolute paths for the base directory categories.
+ */
 export const basePaths = {
     [BasePathType.packages]: packagesDir,
     [BasePathType.root]: resolve(packagesDir, ".."),
 };
+/**
+ * Pre-resolved absolute paths for every workspace package directory.
+ */
 export const wsPaths = {
     [WsPathType.backend]: join(packagesDir, WsPathType.backend),
     [WsPathType.common]: join(packagesDir, WsPathType.common),
@@ -26,8 +38,29 @@ export const wsPaths = {
     [WsPathType.fs]: join(packagesDir, WsPathType.fs),
     [WsPathType.generator]: join(packagesDir, WsPathType.generator),
 };
+/**
+ * Absolute path to the repository-level `changelog.json` file.
+ */
 export const changelogPath = join(basePaths.root, "changelog.json");
+/**
+ * Returns the absolute path to the `package.json` of the given workspace.
+ *
+ * @param type - The workspace whose `package.json` path is requested.
+ * @returns The resolved absolute path.
+ */
 export const packageJsonPath = (type) => join(wsPaths[type], "package.json");
+/**
+ * Derives {@link CurrentPaths} for the workspace that contains the given file path.
+ *
+ * @remarks
+ * Accepts both absolute and relative paths. The path must reside within one of
+ * the known workspace directories under `packages/`. Throws if the path does
+ * not match the expected layout.
+ *
+ * @param currentPath - A file-system path within a workspace.
+ * @returns Resolved path information for the containing workspace.
+ * @throws If the path does not start with `packages/` or names an unknown workspace.
+ */
 export const createCurrentWsPaths = (currentPath) => {
     const res = isAbsolute(currentPath)
         ? relative(basePaths.root, changelogPath)

package/dist/path/path.common.js.map

@@ -1 +1 @@
-{"version":3,"file":"path.common.js","sourceRoot":"","sources":["../../src/path/path.common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1D,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAEnD,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,6BAAa,CAAA;AACf,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAED,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,uBAAS,CAAA;IACT,qCAAuB,CAAA;AACzB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAID,MAAM,CAAC,MAAM,SAAS,GAAa;IACjC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,WAAW;IACpC,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC;CAChD,CAAC;AAIF,MAAM,CAAC,MAAM,OAAO,GAAW;IAC7B,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC;IAC3D,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC;IACzD,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC7D,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;IACjD,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC;CAChE,CAAC;AAQF,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAEpE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAgB,EAAE,EAAE,CAClD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;AAEtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAgB,EAAE;IACxE,MAAM,GAAG,GAAG,UAAU,CAAC,WAAW,CAAC;QACjC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;QACzC,CAAC,CAAC,WAAW,CAAC;IAEhB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE7B,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;IACjC,IAAI,UAAU,KAAK,UAAU;QAC3B,MAAM,IAAI,KAAK,CAAC,mDAAmD,GAAG,EAAE,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;IAC9B,IAAI,CAAC,OAAO;QACV,MAAM,IAAI,KAAK,CAAC,mDAAmD,GAAG,EAAE,CAAC,CAAC;IAE5E,MAAM,MAAM,GAAG,OAAqB,CAAC;IACrC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAC;IAEjD,OAAO;QACL,GAAG,SAAS;QACZ,UAAU;QACV,MAAM;QACN,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC;KACzC,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"path.common.js","sourceRoot":"","sources":["../../src/path/path.common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEhE,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,kEAAkE;IAClE,qCAAqB,CAAA;IACrB,qCAAqC;IACrC,6BAAa,CAAA;AACf,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,uBAAS,CAAA;IACT,qCAAuB,CAAA;AACzB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAa;IACjC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,WAAW;IACpC,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC;CAChD,CAAC;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAW;IAC7B,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC;IAC3D,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC;IACzD,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC7D,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;IACjD,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC;CAChE,CAAC;AAeF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAgB,EAAE,EAAE,CAClD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAgB,EAAE;IACxE,MAAM,GAAG,GAAG,UAAU,CAAC,WAAW,CAAC;QACjC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;QACzC,CAAC,CAAC,WAAW,CAAC;IAEhB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE7B,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;IACjC,IAAI,UAAU,KAAK,UAAU;QAC3B,MAAM,IAAI,KAAK,CAAC,mDAAmD,GAAG,EAAE,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;IAC9B,IAAI,CAAC,OAAO;QACV,MAAM,IAAI,KAAK,CAAC,mDAAmD,GAAG,EAAE,CAAC,CAAC;IAE5E,MAAM,MAAM,GAAG,OAAqB,CAAC;IACrC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAC;IAEjD,OAAO;QACL,GAAG,SAAS;QACZ,UAAU;QACV,MAAM;QACN,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC;KACzC,CAAC;AACJ,CAAC,CAAC"}

package/dist/types/types.annotation.d.ts

@@ -1,25 +1,53 @@
 import { DecoImport, DecoRouteParams } from "./types.deco.common.js";
 import { DecoPropertyBase, DecoPropertyCommon } from "./types.deco.property.js";
+/**
+ * Describes a single route derived from decorator annotations.
+ */
 export interface AnnotationsRoute extends DecoRouteParams {
+    /** Unique name identifying this route. */
     name: string;
 }
+/**
+ * Describes a single property within a decorated class, including its metadata.
+ *
+ * @typeParam T - The specific decorator property options type.
+ */
 export interface AnnotationsProperty<T extends DecoPropertyBase> {
+    /** The property key on the decorated class. */
     propertyKey: string;
+    /** The TypeScript type of the property (e.g. `"string"`, `"number"`). */
     propertyType: string;
+    /** Shared presentational / behavioural options for this property. */
     common: DecoPropertyCommon;
+    /** Type-specific decorator options. */
     data: T;
+    /** Optional nested annotation header when the property is itself a decorated object. */
     sub?: AnnotationsHeader;
 }
+/**
+ * Top-level annotation metadata collected from a decorated class.
+ */
 export interface AnnotationsHeader {
+    /** Class or model name. */
     name: string;
+    /** Optional namespace used to group related models. */
     namespace?: string;
+    /** Property descriptors extracted from the class. */
     properties: AnnotationsProperty<DecoPropertyBase>[];
+    /** Route definitions attached to the class, if any. */
     routes?: AnnotationsRoute[];
+    /** Extra imports required by generated code for this model. */
     additionalImports?: DecoImport[];
 }
+/**
+ * Represents a validation or processing error linked to a specific property.
+ */
 export interface AnnotationsError {
+    /** The property key that caused the error. */
     propertyKey: string;
+    /** Short human-readable error title. */
     title: string;
+    /** Detailed error message. */
     error: string;
 }
 //# sourceMappingURL=types.annotation.d.ts.map

package/dist/types/types.annotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.annotation.d.ts","sourceRoot":"","sources":["../../src/types/types.annotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAGhF,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,MAAM,CAAC;CACd;AAGD,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,gBAAgB;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC;IACR,GAAG,CAAC,EAAE,iBAAiB,CAAC;CACzB;AAGD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACpD,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;CAClC;AAGD,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"types.annotation.d.ts","sourceRoot":"","sources":["../../src/types/types.annotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAGhF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;CACd;AAGD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,gBAAgB;IAC7D,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,YAAY,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,MAAM,EAAE,kBAAkB,CAAC;IAC3B,uCAAuC;IACvC,IAAI,EAAE,CAAC,CAAC;IACR,wFAAwF;IACxF,GAAG,CAAC,EAAE,iBAAiB,CAAC;CACzB;AAGD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,UAAU,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACpD,uDAAuD;IACvD,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC5B,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;CAClC;AAGD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf"}

package/dist/types/types.deco.common.d.ts

@@ -1,21 +1,47 @@
 import type { Decorator } from "../decorator/Decorator.js";
+/**
+ * Allows a decorator parameter to be specified either as a plain value
+ * or as an object with optional `facet` and `item` variants.
+ *
+ * @typeParam T - The underlying value type.
+ */
 export type DecoParamsKind<T> = {
     facet?: T;
     item?: T;
 } | T;
+/**
+ * Describes a template file together with the decorators it contains.
+ */
 export interface DecoFile {
+    /** Absolute path to the template file on disk. */
     templateFilePath: string;
+    /** Repository-relative path to the template file. */
     templateRepoFilePath: string;
+    /** Decorators discovered in the template file. */
     decorators: Decorator[];
 }
+/**
+ * Request and response type names for a single route endpoint.
+ */
 export interface DecoRouteParams {
+    /** Fully-qualified type name of the request payload. */
     requestType: string;
+    /** Fully-qualified type name of the response payload. */
     responseType: string;
 }
+/**
+ * Maps route names to their corresponding {@link DecoRouteParams}.
+ */
 export type DecoRoutes = Record<string, DecoRouteParams>;
+/**
+ * Represents a single import statement required by generated code.
+ */
 export interface DecoImport {
+    /** Named exports to import. */
     props: string[];
+    /** Module specifier / path to import from. */
     path: string;
+    /** When `true`, the import is a type-only import. */
     isType?: boolean;
 }
 //# sourceMappingURL=types.deco.common.d.ts.map

package/dist/types/types.deco.common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.deco.common.d.ts","sourceRoot":"","sources":["../../src/types/types.deco.common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE3D,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB;IACE,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,IAAI,CAAC,EAAE,CAAC,CAAC;CACV,GACD,CAAC,CAAC;AAEN,MAAM,WAAW,QAAQ;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEzD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"types.deco.common.d.ts","sourceRoot":"","sources":["../../src/types/types.deco.common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB;IACE,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,IAAI,CAAC,EAAE,CAAC,CAAC;CACV,GACD,CAAC,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,kDAAkD;IAClD,gBAAgB,EAAE,MAAM,CAAC;IACzB,qDAAqD;IACrD,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kDAAkD;IAClD,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}

package/dist/types/types.deco.property.d.ts

@@ -1,62 +1,129 @@
 import type { DecoPropertyType, DecoDateFormat } from "../decorator/deco.enum.js";
 import type { Decorator } from "../decorator/Decorator.js";
 import type { DecoParamsKind } from "./types.deco.common.js";
+/**
+ * Base interface for all decorator property option objects.
+ *
+ * @remarks
+ * Every concrete property-options interface (e.g. {@link DecoNumberOptions})
+ * extends this base and narrows the `type` discriminant.
+ */
 export interface DecoPropertyBase {
+    /** Discriminant identifying the property type. */
     type: DecoPropertyType;
+    /** Allows additional, type-specific options. */
     [key: string]: unknown;
 }
+/**
+ * Shared presentational and behavioural options applicable to any decorator property.
+ */
 export interface DecoPropertyCommon {
+    /** Human-readable title for the property. */
     title?: DecoParamsKind<string>;
+    /** Longer description of the property. */
     description?: DecoParamsKind<string>;
+    /** Whether the property is optional. */
     optional?: boolean;
+    /** Whether the property can be edited by the user. */
     editable?: boolean;
+    /** Whether the property supports sorting in a table view. */
     sortable?: boolean;
+    /** Whether the property supports filtering. */
     filterable?: boolean;
+    /** Whether the property should be hidden from the UI. */
     hidden?: DecoParamsKind<boolean>;
+    /** CSS width hint for the property column. */
     width?: string;
+    /** Whether the property depends on a popin container. */
     depandPopin?: boolean;
+    /** Display order for the property. */
     order?: DecoParamsKind<number>;
 }
+/**
+ * Wraps a decorator property's shared and type-specific options.
+ *
+ * @typeParam T - The specific decorator property options type.
+ */
 export interface DecoPropertyRaw<T extends DecoPropertyBase> {
+    /** Shared common options. */
     common: DecoPropertyCommon;
+    /** Type-specific decorator options. */
     data: T;
 }
+/**
+ * Decorator options for a numeric property.
+ */
 export interface DecoNumberOptions extends DecoPropertyBase {
     type: DecoPropertyType.number;
+    /** Default numeric value. */
     default?: number;
+    /** Minimum allowed value. */
     min?: number;
+    /** Whether the minimum bound is inclusive. */
     minInclusive?: boolean;
+    /** Maximum allowed value. */
     max?: number;
+    /** Whether the maximum bound is inclusive. */
     maxInclusive?: boolean;
+    /** Value must be a multiple of this number. */
     multipleOf?: number;
+    /** Maximum number of fraction digits to display. */
     fractionDigits?: number;
 }
+/**
+ * Decorator options for a string property.
+ */
 export interface DecoStringOptions extends DecoPropertyBase {
     type: DecoPropertyType.string;
+    /** Default string value. */
     default?: string;
+    /** Minimum allowed string length. */
     minLength?: number;
+    /** Maximum allowed string length. */
     maxLength?: number;
+    /** The string must be exactly this length. */
     exactLength?: number;
+    /** Regular expression the value must match. */
     regex?: string;
+    /** Whether this string property acts as a unique key. */
     isKey?: boolean;
 }
+/**
+ * Decorator options for an array property.
+ */
 export interface DecoArrayOptions extends DecoPropertyBase {
     type: DecoPropertyType.array;
+    /** Decorator describing the array element type. */
     sub: Decorator;
+    /** Minimum number of elements. */
     minLength?: number;
+    /** Maximum number of elements. */
     maxLength?: number;
+    /** The array must contain exactly this many elements. */
     exactLength?: number;
 }
+/**
+ * Decorator options for a nested object property.
+ */
 export interface DecoObjectOptions extends DecoPropertyBase {
     type: DecoPropertyType.object;
+    /** Decorator describing the nested object type. */
     sub: Decorator;
 }
+/**
+ * Decorator options for a date property.
+ */
 export interface DecoDateOptions extends DecoPropertyBase {
     type: DecoPropertyType.date;
+    /** Display / serialization format for the date. */
     dateFormat: DecoDateFormat;
 }
+/**
+ * Decorator options for a boolean property.
+ */
 export interface DecoBooleanOptions extends DecoPropertyBase {
     type: DecoPropertyType.boolean;
+    /** Default boolean value. */
     default?: boolean;
 }
 //# sourceMappingURL=types.deco.property.d.ts.map

package/dist/types/types.deco.property.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.deco.property.d.ts","sourceRoot":"","sources":["../../src/types/types.deco.property.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACf,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,gBAAgB,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/B,WAAW,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,gBAAgB;IACzD,MAAM,EAAE,kBAAkB,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC;CACT;AAGD,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAGD,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAGD,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAC7B,GAAG,EAAE,SAAS,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAGD,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC9B,GAAG,EAAE,SAAS,CAAC;CAChB;AAGD,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAC5B,UAAU,EAAE,cAAc,CAAC;CAC5B;AAGD,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,gBAAgB,CAAC,OAAO,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}
+{"version":3,"file":"types.deco.property.d.ts","sourceRoot":"","sources":["../../src/types/types.deco.property.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACf,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,IAAI,EAAE,gBAAgB,CAAC;IACvB,gDAAgD;IAChD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,6CAA6C;IAC7C,KAAK,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,wCAAwC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yDAAyD;IACzD,MAAM,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,sCAAsC;IACtC,KAAK,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,gBAAgB;IACzD,6BAA6B;IAC7B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,uCAAuC;IACvC,IAAI,EAAE,CAAC,CAAC;CACT;AAGD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC9B,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,6BAA6B;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAGD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC9B,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAGD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAC7B,mDAAmD;IACnD,GAAG,EAAE,SAAS,CAAC;IACf,kCAAkC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAGD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC9B,mDAAmD;IACnD,GAAG,EAAE,SAAS,CAAC;CAChB;AAGD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAC5B,mDAAmD;IACnD,UAAU,EAAE,cAAc,CAAC;CAC5B;AAGD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,gBAAgB,CAAC,OAAO,CAAC;IAC/B,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/dist/types/types.document.d.ts

@@ -1,15 +1,44 @@
+/**
+ * Represents any value that may be stored in a Firestore document field.
+ */
 export type DocumentFieldValue = any;
+/**
+ * A generic Firestore document represented as a string-keyed map of field values.
+ */
 export type DocumentData = {
     [field: string]: DocumentFieldValue;
 };
+/**
+ * Identifies a Firestore document by its unique `id`.
+ */
 export interface DocumentKey {
+    /** Unique document identifier. */
     id: string;
 }
+/**
+ * Administrative timestamps automatically managed by Firestore.
+ */
 export interface DocumentAdmin {
+    /** Timestamp when the document was created. */
     createTime?: Date;
+    /** Timestamp of the most recent update. */
     updateTime?: Date;
 }
+/**
+ * Combines {@link DocumentKey} and {@link DocumentAdmin} into a single type
+ * representing all Firestore administrative fields.
+ */
 export type DocumentKeyAdmin = DocumentKey & DocumentAdmin;
+/**
+ * Augments a DTO with Firestore administrative fields (`id`, `createTime`, `updateTime`).
+ *
+ * @typeParam DTO - The base document data type.
+ */
 export type WithKey<DTO extends DocumentData> = DocumentKey & DocumentAdmin & DTO;
+/**
+ * Strips Firestore administrative fields from a DTO type.
+ *
+ * @typeParam DTO - The base document data type.
+ */
 export type WithoutKey<DTO extends DocumentData> = Omit<DTO, keyof DocumentKeyAdmin>;
 //# sourceMappingURL=types.document.d.ts.map

package/dist/types/types.document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.document.d.ts","sourceRoot":"","sources":["../../src/types/types.document.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC;AACrC,MAAM,MAAM,YAAY,GAAG;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAA;CAAE,CAAC;AAEnE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,aAAa,CAAC;AAE3D,MAAM,MAAM,OAAO,CAAC,GAAG,SAAS,YAAY,IAAI,WAAW,GACzD,aAAa,GACb,GAAG,CAAC;AAEN,MAAM,MAAM,UAAU,CAAC,GAAG,SAAS,YAAY,IAAI,IAAI,CACrD,GAAG,EACH,MAAM,gBAAgB,CACvB,CAAC"}
+{"version":3,"file":"types.document.d.ts","sourceRoot":"","sources":["../../src/types/types.document.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAA;CAAE,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,+CAA+C;IAC/C,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,aAAa,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,OAAO,CAAC,GAAG,SAAS,YAAY,IAAI,WAAW,GACzD,aAAa,GACb,GAAG,CAAC;AAEN;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,GAAG,SAAS,YAAY,IAAI,IAAI,CACrD,GAAG,EACH,MAAM,gBAAgB,CACvB,CAAC"}

package/dist/types/types.filter.d.ts

@@ -1,14 +1,27 @@
 import { ApiFilterOp } from "../config/config.api.js";
+/**
+ * A single filter criterion composed of an operator and a comparison value.
+ */
 export interface ApiFilterItem {
+    /** The comparison operator to apply. */
     op: ApiFilterOp;
+    /** The value to compare the field against. */
     value: string | number | Date;
 }
+/**
+ * A map of field names to their {@link ApiFilterItem} criteria,
+ * with an optional `parentId` for hierarchical queries.
+ */
 export type ApiFilterItems = {
     [key: string]: ApiFilterItem;
 } & {
     parentId?: string;
 };
+/**
+ * Encapsulates an optional set of API query filters.
+ */
 export interface ApiFilter {
+    /** The filter criteria to apply, keyed by field name. */
     filters?: ApiFilterItems;
 }
 //# sourceMappingURL=types.filter.d.ts.map

package/dist/types/types.filter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.filter.d.ts","sourceRoot":"","sources":["../../src/types/types.filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,WAAW,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC;CAC9B,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1B,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}
+{"version":3,"file":"types.filter.d.ts","sourceRoot":"","sources":["../../src/types/types.filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,wCAAwC;IACxC,EAAE,EAAE,WAAW,CAAC;IAChB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC;CAC9B,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,yDAAyD;IACzD,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}

package/dist/types/types.function.d.ts

@@ -1,11 +1,31 @@
 import { RoutesMap } from "./types.routes.js";
+/**
+ * Typed request payload for a callable cloud function.
+ *
+ * @typeParam DOC - The shape of the request data.
+ */
 export interface FunctionRequest<DOC> {
+    /** The route identifier for the function being invoked. */
     route: string;
+    /** The request payload. */
     data: DOC;
 }
+/**
+ * Typed response envelope returned by a callable cloud function.
+ *
+ * @typeParam DOC - The shape of the response data.
+ */
 export interface FunctionResponse<DOC> {
+    /** The response payload. */
     data: DOC;
 }
+/**
+ * Maps each route key in a {@link RoutesMap} to a callable function that
+ * accepts the route's request type and returns a promise of its response type
+ * wrapped in a {@link FunctionResponse}.
+ *
+ * @typeParam R - A routes map defining request/response pairs per route key.
+ */
 export type FunctionFromRoutes<R extends RoutesMap> = {
     [K in keyof R]: (request: R[K]["request"]) => Promise<FunctionResponse<R[K]["response"]>>;
 };

package/dist/types/types.function.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.function.d.ts","sourceRoot":"","sources":["../../src/types/types.function.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,MAAM,WAAW,eAAe,CAAC,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,WAAW,gBAAgB,CAAC,GAAG;IACnC,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,SAAS,IAAI;KACnD,CAAC,IAAI,MAAM,CAAC,GAAG,CACd,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KACrB,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;CACjD,CAAC"}
+{"version":3,"file":"types.function.d.ts","sourceRoot":"","sources":["../../src/types/types.function.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,GAAG;IAClC,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,GAAG;IACnC,4BAA4B;IAC5B,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,SAAS,IAAI;KACnD,CAAC,IAAI,MAAM,CAAC,GAAG,CACd,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KACrB,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;CACjD,CAAC"}

package/dist/types/types.routes.d.ts

@@ -1,11 +1,36 @@
 import type { DocumentData, DocumentKey, WithKey, WithoutKey } from "./types.document.js";
 import { ApiFilter } from "./types.filter.js";
+/**
+ * Defines the request and response types for a single API route.
+ *
+ * @typeParam REQ - The request payload type.
+ * @typeParam RES - The response payload type.
+ */
 export type RouteDef<REQ, RES> = {
     request: REQ;
     response: RES;
 };
+/**
+ * Maps route names to their {@link RouteDef} request/response pairs.
+ *
+ * @typeParam DEF - The route definition shape (defaults to `RouteDef<any, any>`).
+ */
 export type RoutesMap<DEF = RouteDef<any, any>> = Record<string, DEF>;
+/**
+ * Identity helper that constrains a record to be a valid {@link RoutesMap}.
+ *
+ * @typeParam R - A routes map type.
+ */
 export type WithRoutes<R extends RoutesMap> = R;
+/**
+ * Pre-defined CRUD route map for a Firestore document DTO.
+ *
+ * @remarks
+ * Provides typed route definitions for `create`, `update`, `delete`, `get`,
+ * `query`, `count`, and `exists` operations.
+ *
+ * @typeParam DTO - The base document data type.
+ */
 export type CrudRoutes<DTO extends DocumentData> = WithRoutes<{
     create: RouteDef<WithoutKey<DTO>, WithKey<DTO>>;
     update: RouteDef<WithKey<Partial<DTO>>, WithKey<DTO>>;
@@ -21,6 +46,12 @@ export type CrudRoutes<DTO extends DocumentData> = WithRoutes<{
         exists: boolean;
     }>;
 }>;
+/**
+ * Maps each route key in a {@link RoutesMap} to an async function
+ * accepting the route's request type and returning a promise of its response.
+ *
+ * @typeParam R - A routes map defining request/response pairs per route key.
+ */
 export type ApiFromRoutes<R extends RoutesMap> = {
     [K in keyof R]: (request: R[K]["request"]) => Promise<R[K]["response"]>;
 };

package/dist/types/types.routes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.routes.d.ts","sourceRoot":"","sources":["../../src/types/types.routes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,WAAW,EACX,OAAO,EACP,UAAU,EACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,MAAM,MAAM,QAAQ,CAAC,GAAG,EAAE,GAAG,IAAI;IAC/B,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;CACf,CAAC;AAGF,MAAM,MAAM,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEtE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,CAAC;AAEhD,MAAM,MAAM,UAAU,CAAC,GAAG,SAAS,YAAY,IAAI,UAAU,CAAC;IAC5D,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACtD,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACjD,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtE,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACzE,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACpD,CAAC,CAAC;AAEH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,SAAS,IAAI;KAC9C,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;CACxE,CAAC"}
+{"version":3,"file":"types.routes.d.ts","sourceRoot":"","sources":["../../src/types/types.routes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,WAAW,EACX,OAAO,EACP,UAAU,EACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,GAAG,EAAE,GAAG,IAAI;IAC/B,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;CACf,CAAC;AAEF;;;;GAIG;AAEH,MAAM,MAAM,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,CAAC;AAEhD;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,CAAC,GAAG,SAAS,YAAY,IAAI,UAAU,CAAC;IAC5D,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACtD,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACjD,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtE,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACzE,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACpD,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,SAAS,IAAI;KAC9C,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;CACxE,CAAC"}