@mxpicture/gcp-functions-common 2.1.34 → 2.1.35

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

@@ -7,13 +7,33 @@ import type { DocumentData } from "../types/types.document.js";
  * @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;
+/**
+ * Returns a deep clone of an object with all top-level `undefined` properties removed.
+ *
+ * @typeParam T - The document data shape.
+ * @param obj - The source object to clone and strip.
+ * @returns A `structuredClone` of `obj` with any keys whose value is `undefined` removed.
+ */
 export declare const stripUndefined: <T extends DocumentData>(obj: T) => T;
+/**
+ * Type guard that narrows an unknown value to a plain object (not array, not null).
+ *
+ * @param value - The value to inspect.
+ * @returns `true` if `value` is a non-null, non-array object; `false` otherwise.
+ */
 export declare const compareIsObject: (value: unknown) => value is Record<string, unknown>;
 /**
+ * Recursively compares two objects and returns the set of dot-delimited paths that differ.
+ *
+ * @remarks
+ * - Primitives are compared by strict equality (`NaN === NaN` is treated as equal).
+ * - Arrays are compared by JSON serialization at their location; the array's path is
+ *   reported once when they differ rather than per-element.
+ * - Nested objects are walked recursively, producing paths such as `address.city`.
  *
- * @param a - Object A
- * @param b - Object B
- * @returns changed paths array
+ * @param a - The first object to compare.
+ * @param b - The second object to compare.
+ * @returns An array of dot-delimited paths where `a` and `b` differ.
  */
 export declare const compare: (a: Record<string, unknown>, b: Record<string, unknown>) => string[];
 //# 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,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE/D;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,EAC1C,OAAO,CAAC,EACR,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,KACvB,CAKF,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,YAAY,EAAE,KAAK,CAAC,KAAG,CAM/D,CAAC;AAEF,eAAO,MAAM,eAAe,GAC1B,OAAO,OAAO,KACb,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CACoC,CAAC;AAEvE;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAClB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACzB,MAAM,EA8BR,CAAC"}
+{"version":3,"file":"helper.object.d.ts","sourceRoot":"","sources":["../../src/helper/helper.object.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE/D;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,EAC1C,OAAO,CAAC,EACR,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,KACvB,CAKF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,YAAY,EAAE,KAAK,CAAC,KAAG,CAM/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,OAAO,KACb,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CACoC,CAAC;AAEvE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,GAClB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACzB,MAAM,EA8BR,CAAC"}

package/dist/helper/helper.object.js

@@ -12,17 +12,37 @@ export const stripObject = (route, allowedKeys) => {
             result[allowedKey] = route[allowedKey];
     return result;
 };
+/**
+ * Returns a deep clone of an object with all top-level `undefined` properties removed.
+ *
+ * @typeParam T - The document data shape.
+ * @param obj - The source object to clone and strip.
+ * @returns A `structuredClone` of `obj` with any keys whose value is `undefined` removed.
+ */
 export const stripUndefined = (obj) => {
     const clone = structuredClone(obj);
     Object.keys(clone).forEach((key) => clone[key] === undefined && delete clone[key]);
     return clone;
 };
+/**
+ * Type guard that narrows an unknown value to a plain object (not array, not null).
+ *
+ * @param value - The value to inspect.
+ * @returns `true` if `value` is a non-null, non-array object; `false` otherwise.
+ */
 export const compareIsObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 /**
+ * Recursively compares two objects and returns the set of dot-delimited paths that differ.
+ *
+ * @remarks
+ * - Primitives are compared by strict equality (`NaN === NaN` is treated as equal).
+ * - Arrays are compared by JSON serialization at their location; the array's path is
+ *   reported once when they differ rather than per-element.
+ * - Nested objects are walked recursively, producing paths such as `address.city`.
  *
- * @param a - Object A
- * @param b - Object B
- * @returns changed paths array
+ * @param a - The first object to compare.
+ * @param b - The second object to compare.
+ * @returns An array of dot-delimited paths where `a` and `b` differ.
  */
 export const compare = (a, b) => {
     const changes = [];

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

@@ -1 +1 @@
-{"version":3,"file":"helper.object.js","sourceRoot":"","sources":["../../src/helper/helper.object.ts"],"names":[],"mappings":"AAEA;;;;;;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;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAyB,GAAM,EAAK,EAAE;IAClE,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CACxB,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,CACvD,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,KAAc,EACoB,EAAE,CACpC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,CAA0B,EAC1B,CAA0B,EAChB,EAAE;IACZ,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,MAAM,IAAI,GAAG,CAAC,IAAa,EAAE,KAAc,EAAE,IAAI,GAAG,EAAE,EAAQ,EAAE;QAC9D,mCAAmC;QACnC,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO;QAE1E,iBAAiB;QACjB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QAED,8BAA8B;QAC9B,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEpE,KAAK,MAAM,GAAG,IAAI,IAAI;gBACpB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAE7D,OAAO;QACT,CAAC;QAED,6BAA6B;QAC7B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC,CAAC;IAEF,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEX,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
+{"version":3,"file":"helper.object.js","sourceRoot":"","sources":["../../src/helper/helper.object.ts"],"names":[],"mappings":"AAEA;;;;;;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;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAyB,GAAM,EAAK,EAAE;IAClE,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CACxB,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,CACvD,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,KAAc,EACoB,EAAE,CACpC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,CAA0B,EAC1B,CAA0B,EAChB,EAAE;IACZ,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,MAAM,IAAI,GAAG,CAAC,IAAa,EAAE,KAAc,EAAE,IAAI,GAAG,EAAE,EAAQ,EAAE;QAC9D,mCAAmC;QACnC,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO;QAE1E,iBAAiB;QACjB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QAED,8BAA8B;QAC9B,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEpE,KAAK,MAAM,GAAG,IAAI,IAAI;gBACpB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAE7D,OAAO;QACT,CAAC;QAED,6BAA6B;QAC7B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC,CAAC;IAEF,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEX,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}

package/dist/helper/helper.string.d.ts

@@ -12,6 +12,23 @@ export declare const lowerFirstLetter: (val: string) => string;
  * @returns The string with its first character upper-cased.
  */
 export declare const upperFirstLetter: (val: string) => string;
+/**
+ * Converts a string to kebab-case.
+ *
+ * @remarks
+ * Inserts hyphens at camelCase boundaries (both `aB` and `AB`) and replaces
+ * whitespace and underscores with hyphens. Case is preserved; use
+ * {@link kebabCaseLower} for an all-lowercase result.
+ *
+ * @param str - The input string.
+ * @returns The kebab-cased string.
+ */
 export declare const kebabCase: (str: string) => string;
+/**
+ * Converts a string to lowercase kebab-case via {@link kebabCase}.
+ *
+ * @param str - The input string.
+ * @returns The kebab-cased string, lower-cased.
+ */
 export declare const kebabCaseLower: (str: string) => string;
 //# sourceMappingURL=helper.string.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helper.string.d.ts","sourceRoot":"","sources":["../../src/helper/helper.string.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,WAGf,CAAC;AAE9B;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,WAGrB,CAAC;AAExB,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,KAAG,MAIZ,CAAC;AAE7B,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG,MACf,CAAC"}
+{"version":3,"file":"helper.string.d.ts","sourceRoot":"","sources":["../../src/helper/helper.string.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,WAGf,CAAC;AAE9B;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,WAGrB,CAAC;AAExB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,KAAG,MAIZ,CAAC;AAE7B;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG,MACf,CAAC"}

package/dist/helper/helper.string.js

@@ -16,9 +16,26 @@ export const lowerFirstLetter = (val) => val.length > 1
 export const upperFirstLetter = (val) => val.length > 1
     ? val.charAt(0).toUpperCase() + val.slice(1)
     : val.toUpperCase();
+/**
+ * Converts a string to kebab-case.
+ *
+ * @remarks
+ * Inserts hyphens at camelCase boundaries (both `aB` and `AB`) and replaces
+ * whitespace and underscores with hyphens. Case is preserved; use
+ * {@link kebabCaseLower} for an all-lowercase result.
+ *
+ * @param str - The input string.
+ * @returns The kebab-cased string.
+ */
 export const kebabCase = (str) => str
     .replace(/([A-Z])([A-Z])/g, "$1-$2")
     .replace(/([a-z])([A-Z])/g, "$1-$2")
     .replace(/[\s_]+/g, "-");
+/**
+ * Converts a string to lowercase kebab-case via {@link kebabCase}.
+ *
+ * @param str - The input string.
+ * @returns The kebab-cased string, lower-cased.
+ */
 export const kebabCaseLower = (str) => kebabCase(str).toLowerCase();
 //# sourceMappingURL=helper.string.js.map

package/dist/helper/helper.string.js.map

@@ -1 +1 @@
-{"version":3,"file":"helper.string.js","sourceRoot":"","sources":["../../src/helper/helper.string.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,EAAE,CAC9C,GAAG,CAAC,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;AAE9B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,EAAE,CAC9C,GAAG,CAAC,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;AAExB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAU,EAAE,CAC/C,GAAG;KACA,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;KACnC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;KACnC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE7B,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE,CACpD,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC"}
+{"version":3,"file":"helper.string.js","sourceRoot":"","sources":["../../src/helper/helper.string.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,EAAE,CAC9C,GAAG,CAAC,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;AAE9B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,EAAE,CAC9C,GAAG,CAAC,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;AAExB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAU,EAAE,CAC/C,GAAG;KACA,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;KACnC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;KACnC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE,CACpD,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC"}

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

@@ -29,6 +29,10 @@ export interface DecoRouteParams {
     requestType: string;
     /** Fully-qualified type name of the response payload. */
     responseType: string;
+    /**
+     * Internal marker set by {@link crudRoutes} so {@link isCrudRoute} / {@link isCustomCrudRoute}
+     * can later classify the route. Not intended for direct use.
+     */
     _internalCrudType?: CrudType;
 }
 /**
@@ -39,22 +43,45 @@ export type DecoRoutes = Record<string, DecoRouteParams>;
  * Represents a single import statement required by generated code.
  */
 export interface DecoImport {
-    /** Named exports to import. */
+    /** Named value exports to import. */
     valueProps: string[];
+    /** Named type-only exports to import (emitted as `import type`). */
     typeProps: string[];
     /** Module specifier / path to import from. */
     path: string;
 }
+/**
+ * A single named import grouped under a shared module specifier.
+ */
 export interface DecoSingleImport {
+    /** The imported binding name. */
     prop: string;
 }
+/**
+ * Resolution strategy for a single import — how the path is written and which file it targets.
+ */
 export interface DecoResolveItem {
+    /** Whether to emit a relative or package-qualified path. */
     mode: DecoResolveMode;
+    /** Whether to point at the source file directly or its barrel re-export. */
     target: DecoResolveTarget;
 }
+/**
+ * Resolution policy applied during code generation.
+ *
+ * @remarks
+ * `default` is used for cross-package imports; when `samePkg` is supplied, it
+ * overrides the policy for imports that resolve to the same workspace package
+ * as the emitting file.
+ */
 export interface DecoResolve {
+    /** Overriding policy used when both modules belong to the same package. */
     samePkg?: DecoResolveItem;
+    /** Fallback policy used when no more specific rule matches. */
     default: DecoResolveItem;
 }
+/**
+ * Map of enum key to human-readable label, accepted by {@link Decorator.registerEnum}.
+ */
 export type DecoEnumEntries = Record<string, string>;
 //# 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,EACV,QAAQ,EACR,eAAe,EACf,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AACnC,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;AASN;;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;IACrB,iBAAiB,CAAC,EAAE,QAAQ,CAAC;CAC9B;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,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC"}
+{"version":3,"file":"types.deco.common.d.ts","sourceRoot":"","sources":["../../src/types/types.deco.common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AACnC,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;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,QAAQ,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,qCAAqC;IACrC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,oEAAoE;IACpE,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,IAAI,EAAE,eAAe,CAAC;IACtB,4EAA4E;IAC5E,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,+DAA+D;IAC/D,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC"}

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

@@ -15,6 +15,8 @@ export interface DecoPropertyBase {
     /** Allows additional, type-specific options. */
     [key: string]: unknown;
 }
+/** Direction in which a virtual (non-stored) field flows. */
+export type DecoVirtualDirection = "input" | "output" | "both";
 /**
  * Shared presentational and behavioural options applicable to any decorator property.
  */
@@ -31,8 +33,17 @@ export interface DecoPropertyCommon {
     sortable?: boolean;
     /** Whether the property supports filtering. */
     filterable?: boolean;
-    /** Whether the property is virtual. */
-    virtual?: boolean;
+    /**
+     * Direction in which a non-stored field flows.
+     *
+     * - `'output'` — computed server-side on read, never present in input.
+     * - `'input'` — client-supplied to trigger behaviour, validated, stripped before storage.
+     * - `'both'` — accepted on input AND populated on output.
+     *
+     * Use {@link isOutputVirtual} / {@link isInputVirtual} / {@link isAnyVirtual}
+     * to query this field — do not compare strings directly at call sites.
+     */
+    virtual?: DecoVirtualDirection;
     /** Whether the property change triggers side effects. */
     sideEffects?: boolean;
     /** Whether the property should be hidden from the UI. */
@@ -44,6 +55,12 @@ export interface DecoPropertyCommon {
     /** Display order for the property. */
     order?: DecoParamsKind<number>;
 }
+/** True if the field is populated on read (computed server-side). */
+export declare const isOutputVirtual: (common: DecoPropertyCommon) => boolean;
+/** True if the field is accepted on input (validated, stripped before storage). */
+export declare const isInputVirtual: (common: DecoPropertyCommon) => boolean;
+/** True if the field is virtual in any direction. */
+export declare const isAnyVirtual: (common: DecoPropertyCommon) => boolean;
 /**
  * Wraps a decorator property's shared and type-specific options.
  *
@@ -55,8 +72,13 @@ export interface DecoPropertyRaw<T extends DecoPropertyBase> {
     /** Type-specific decorator options. */
     data: T;
 }
+/**
+ * Descriptor for a virtual (non-stored) property contributed by a decorator.
+ */
 export interface DecoPropertyVirtual {
+    /** Property key on the document. */
     key: string;
+    /** Whether the property is optional. */
     optional?: boolean;
 }
 /**
@@ -96,15 +118,19 @@ export interface DecoStringOptions extends DecoPropertyBase {
     regex?: string;
     /** Whether this string property acts as a unique key. */
     isKey?: boolean;
+    /** Whether this string represents a password value (hides input in UIs). */
     password?: boolean;
 }
 /**
- * Decorator options for a enum property.
+ * Decorator options for an enum property.
  */
 export interface DecoEnumOptions extends DecoPropertyBase {
     type: DecoPropertyType.enum;
+    /** Map of enum key to human-readable label. */
     keys: EnumRegistryKeys;
+    /** When set, the generated enum reuses the enum defined for this decorator basename. */
     linkBasename?: string;
+    /** When set, the generated enum reuses the enum defined for this property key. */
     linkKey?: string;
 }
 /**
@@ -136,7 +162,9 @@ export interface DecoDateOptions extends DecoPropertyBase {
     type: DecoPropertyType.date;
     /** Display / serialization format for the date. */
     dateFormat: DecoDateFormat;
+    /** Initial date strategy (e.g. `now`, `today`, `date1970`); `null` when no default applies. */
     dateType: DecoDateType | null;
+    /** Day offset added to the initial date computed from {@link DecoDateOptions.dateType}. */
     dateOffsetDays: number | null;
 }
 /**

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,EACd,YAAY,EACb,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEjE;;;;;;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,uCAAuC;IACvC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,yDAAyD;IACzD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,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;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;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,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6BAA6B;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,+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;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAGD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAC5B,IAAI,EAAE,gBAAgB,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;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;IAC3B,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;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"}
+{"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,EACd,YAAY,EACb,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEjE;;;;;;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,6DAA6D;AAC7D,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE/D;;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;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,yDAAyD;IACzD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,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,qEAAqE;AACrE,eAAO,MAAM,eAAe,GAAI,QAAQ,kBAAkB,KAAG,OACH,CAAC;AAE3D,mFAAmF;AACnF,eAAO,MAAM,cAAc,GAAI,QAAQ,kBAAkB,KAAG,OACH,CAAC;AAE1D,qDAAqD;AACrD,eAAO,MAAM,YAAY,GAAI,QAAQ,kBAAkB,KAAG,OACxC,CAAC;AAEnB;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,gBAAgB;IACzD,6BAA6B;IAC7B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,uCAAuC;IACvC,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;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,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6BAA6B;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,+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;IAChB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAGD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAC5B,+CAA+C;IAC/C,IAAI,EAAE,gBAAgB,CAAC;IACvB,wFAAwF;IACxF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kFAAkF;IAClF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;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;IAC3B,+FAA+F;IAC/F,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IAC9B,2FAA2F;IAC3F,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;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.deco.property.js

@@ -1,2 +1,7 @@
-export {};
+/** True if the field is populated on read (computed server-side). */
+export const isOutputVirtual = (common) => common.virtual === "output" || common.virtual === "both";
+/** True if the field is accepted on input (validated, stripped before storage). */
+export const isInputVirtual = (common) => common.virtual === "input" || common.virtual === "both";
+/** True if the field is virtual in any direction. */
+export const isAnyVirtual = (common) => !!common.virtual;
 //# sourceMappingURL=types.deco.property.js.map

package/dist/types/types.deco.property.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.deco.property.js","sourceRoot":"","sources":["../../src/types/types.deco.property.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.deco.property.js","sourceRoot":"","sources":["../../src/types/types.deco.property.ts"],"names":[],"mappings":"AAiEA,qEAAqE;AACrE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAA0B,EAAW,EAAE,CACrE,MAAM,CAAC,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC;AAE3D,mFAAmF;AACnF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAA0B,EAAW,EAAE,CACpE,MAAM,CAAC,OAAO,KAAK,OAAO,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC;AAE1D,qDAAqD;AACrD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAA0B,EAAW,EAAE,CAClE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC"}

package/dist/types/types.enum.registry.d.ts

@@ -1,6 +1,18 @@
+/**
+ * Map of enum key to human-readable label.
+ *
+ * @remarks
+ * The shape used by {@link EnumRegistry}, {@link Decorator}, and the code
+ * generator to describe the entries of a generated enum.
+ */
 export type EnumRegistryKeys = Record<string, string>;
+/**
+ * A single registered enum: its unique name and its key/label entries.
+ */
 export interface EnumRegistryItem {
+    /** Unique enum name, typically built via {@link buildEnumName}. */
     name: string;
+    /** Map of enum key to human-readable label. */
     keys: EnumRegistryKeys;
 }
 //# sourceMappingURL=types.enum.registry.d.ts.map

package/dist/types/types.enum.registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.enum.registry.d.ts","sourceRoot":"","sources":["../../src/types/types.enum.registry.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;CACxB"}
+{"version":3,"file":"types.enum.registry.d.ts","sourceRoot":"","sources":["../../src/types/types.enum.registry.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,IAAI,EAAE,gBAAgB,CAAC;CACxB"}

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

@@ -1,4 +1,4 @@
-import type { CreateInput, DocumentKey, DocumentKeyAdmin, UpdateInput } from "./types.document.js";
+import type { CreateInput, DocumentData, DocumentKey, DocumentKeyAdmin, UpdateInput } from "./types.document.js";
 import type { ApiFilter } from "./types.filter.js";
 /**
  * Defines the request and response types for a single API route.
@@ -31,9 +31,9 @@ export type WithRoutes<R extends RoutesMap> = R;
  *
  * @typeParam DTO - The base document data type.
  */
-export type CrudRoutes<DTO extends DocumentKeyAdmin> = WithRoutes<{
-    create: RouteDef<CreateInput<DTO>, DTO>;
-    update: RouteDef<UpdateInput<DTO>, DTO>;
+export type CrudRoutes<DTO extends DocumentKeyAdmin, INPUT_DTO extends DocumentData = DTO> = WithRoutes<{
+    create: RouteDef<CreateInput<INPUT_DTO>, DTO>;
+    update: RouteDef<UpdateInput<INPUT_DTO>, DTO>;
     delete: RouteDef<DocumentKey, {
         deleted: true;
     }>;
@@ -55,6 +55,13 @@ export type CrudRoutes<DTO extends DocumentKeyAdmin> = WithRoutes<{
 export type ApiFromRoutes<R extends RoutesMap> = {
     [K in keyof R]: (request: R[K]["request"]) => Promise<R[K]["response"]>;
 };
+/**
+ * Untyped route description accepted as raw input by the generator.
+ *
+ * @remarks
+ * Either a `name → handler-symbol` map, or an array of route names whose
+ * handler symbol matches the name 1:1.
+ */
 export type RoutesRaw = {
     [key: string]: string;
 } | string[];

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,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;;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,gBAAgB,IAAI,UAAU,CAAC;IAChE,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IACxC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IACxC,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACjD,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAChC,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC7D,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;AAEF,MAAM,MAAM,SAAS,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,MAAM,EAAE,CAAC"}
+{"version":3,"file":"types.routes.d.ts","sourceRoot":"","sources":["../../src/types/types.routes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;;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,CACpB,GAAG,SAAS,gBAAgB,EAC5B,SAAS,SAAS,YAAY,GAAG,GAAG,IAClC,UAAU,CAAC;IACb,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC;IAC9C,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC;IAC9C,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACjD,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAChC,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC7D,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;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,MAAM,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxpicture/gcp-functions-common",
-  "version": "2.1.34",
+  "version": "2.1.35",
   "description": "Utils for google cloud functions, publishing both CommonJS and ESM builds",
   "type": "module",
   "author": "MXPicture",