@mxpicture/gcp-functions-common 1.1.3 → 1.1.4

package/dist/decorator/Decorator.d.ts

@@ -1,33 +1,126 @@
 import { DecoImport, DecoRoutes } from "../types/types.deco.common.js";
 import { DecoProperties } from "./DecoProperty.js";
 import { AnnotationsHeader } from "../types/types.annotation.js";
+/**
+ * Data structure that holds all metadata for a single decorator definition.
+ *
+ * @remarks
+ * Combines user-supplied configuration (name, title, routes, properties) with
+ * file-system context derived from the input file path.
+ */
 export interface DecoratorData {
+    /** Unique name identifying this decorator. */
     name: string;
+    /** Human-readable display title. */
     title?: string;
+    /** Optional namespace used for grouping related decorators. */
     namespace?: string;
+    /** Route definitions associated with this decorator. */
     routes?: DecoRoutes;
+    /** Extra import declarations required by generated code. */
     additionalImports?: DecoImport[];
+    /** Whether this decorator is the leading/primary decorator. */
     lead?: boolean;
+    /** Map of property names to their decorator property definitions. */
     properties?: DecoProperties;
+    /** Computed decorator path used for file-system resolution. */
     decoPath: string;
+    /** Directory path of the input file. */
     inputDirPath: string;
+    /** Basename of the input file. */
     inputFilename: string;
+    /** Full path to the input file. */
     inputFilePath: string;
 }
+/**
+ * Creates a curried factory function that produces {@link Decorator} instances bound to a file path.
+ *
+ * @param filePath - Absolute path to the source file containing the decorator definitions.
+ * @returns A function that accepts a decorator name and returns a new {@link Decorator}.
+ */
 export declare const createDecorator: (filePath: string) => (name: string) => Decorator;
+/** A record mapping decorator names to their {@link Decorator} instances. */
 export type Decorators = Record<string, Decorator>;
+/**
+ * Fluent builder that assembles metadata for a single decorator definition.
+ *
+ * @remarks
+ * Use {@link createDecorator} for a convenient factory. All setter methods
+ * return `this` to support method chaining.
+ */
 export declare class Decorator {
     readonly name: string;
     protected data: DecoratorData;
+    /**
+     * Creates a new Decorator instance.
+     *
+     * @param name - Unique identifier for the decorator.
+     * @param inputFilePath - Absolute path to the source file that defines this decorator.
+     */
     constructor(name: string, inputFilePath: string);
+    /**
+     * Sets the human-readable display title.
+     *
+     * @param val - The title string.
+     * @returns This instance for chaining.
+     */
     title(val: string): this;
+    /**
+     * Sets the namespace for grouping related decorators.
+     *
+     * @param val - The namespace string.
+     * @returns This instance for chaining.
+     */
     namespace(val: string): this;
+    /**
+     * Merges the given properties into this decorator's property map.
+     *
+     * @param properties - A record of property names to {@link DecoProperty} instances.
+     * @returns This instance for chaining.
+     */
     properties(properties: DecoProperties): this;
+    /**
+     * Appends additional import declarations required by generated code.
+     *
+     * @param imps - One or more import declarations to add.
+     * @returns This instance for chaining.
+     */
     additionalImports(...imps: DecoImport[]): this;
+    /**
+     * Merges the given route definitions into this decorator's route map.
+     *
+     * @param routes - A record of route names to {@link DecoRouteParams}.
+     * @returns This instance for chaining.
+     */
     routes(routes: DecoRoutes): this;
+    /**
+     * Adds the standard CRUD route set derived from the decorator name.
+     *
+     * @returns This instance for chaining.
+     */
     routesCrud(): this;
+    /**
+     * Marks this decorator as the leading/primary decorator.
+     *
+     * @param lead - Whether the decorator is the lead. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     lead(lead?: boolean): this;
+    /**
+     * Extracts a deep-cloned snapshot of the decorator's raw data.
+     *
+     * @returns A plain {@link DecoratorData} object safe to mutate independently.
+     */
     extractRaw(): DecoratorData;
+    /**
+     * Extracts annotations header metadata from this decorator and its properties.
+     *
+     * @remarks
+     * Object-type properties receive special handling to preserve the live
+     * {@link Decorator} reference that `structuredClone` would otherwise strip.
+     *
+     * @returns An {@link AnnotationsHeader} derived from the current decorator state.
+     */
     extractAnnotations(): AnnotationsHeader;
 }
 //# sourceMappingURL=Decorator.d.ts.map

package/dist/decorator/Decorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Decorator.d.ts","sourceRoot":"","sources":["../../src/decorator/Decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AASvE,OAAO,EAAE,cAAc,EAAgB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGjE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,CAAC;IAG5B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,eAAe,GACzB,UAAU,MAAM,MAChB,MAAM,MAAM,KAAG,SACe,CAAC;AAElC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD,qBAAa,SAAS;aAIF,IAAI,EAAE,MAAM;IAH9B,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;gBAGZ,IAAI,EAAE,MAAM,EAC5B,aAAa,EAAE,MAAM;IAQhB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI5B,UAAU,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;IAM5C,iBAAiB,CAAC,GAAG,IAAI,EAAE,UAAU,EAAE,GAAG,IAAI;IAK9C,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAMhC,UAAU,IAAI,IAAI;IAGlB,IAAI,CAAC,IAAI,GAAE,OAAc,GAAG,IAAI;IAKhC,UAAU,IAAI,aAAa;IAQ3B,kBAAkB,IAAI,iBAAiB;CAiB/C"}
+{"version":3,"file":"Decorator.d.ts","sourceRoot":"","sources":["../../src/decorator/Decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AASvE,OAAO,EAAE,cAAc,EAAgB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGjE;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wDAAwD;IACxD,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;IACjC,+DAA+D;IAC/D,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,qEAAqE;IACrE,UAAU,CAAC,EAAE,cAAc,CAAC;IAG5B,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GACzB,UAAU,MAAM,MAChB,MAAM,MAAM,KAAG,SACe,CAAC;AAElC,6EAA6E;AAC7E,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD;;;;;;GAMG;AACH,qBAAa,SAAS;aAUF,IAAI,EAAE,MAAM;IAT9B,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;IAE9B;;;;;OAKG;gBAEe,IAAI,EAAE,MAAM,EAC5B,aAAa,EAAE,MAAM;IAQvB;;;;;OAKG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI/B;;;;;OAKG;IACI,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;OAKG;IACI,UAAU,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;IAMnD;;;;;OAKG;IACI,iBAAiB,CAAC,GAAG,IAAI,EAAE,UAAU,EAAE,GAAG,IAAI;IAKrD;;;;;OAKG;IACI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAMvC;;;;OAIG;IACI,UAAU,IAAI,IAAI;IAGzB;;;;;OAKG;IACI,IAAI,CAAC,IAAI,GAAE,OAAc,GAAG,IAAI;IAKvC;;;;OAIG;IACI,UAAU,IAAI,aAAa;IAQlC;;;;;;;;OAQG;IACI,kBAAkB,IAAI,iBAAiB;CAiB/C"}

package/dist/decorator/Decorator.js

@@ -3,10 +3,29 @@ import { DecoPropertyType } from "./deco.enum.js";
 import { toDecoPath } from "./deco.paths.js";
 import { crudRoutes } from "./deco.routes.js";
 import { mapAnnotationsHeader } from "../annotation/anno.head.js";
+/**
+ * Creates a curried factory function that produces {@link Decorator} instances bound to a file path.
+ *
+ * @param filePath - Absolute path to the source file containing the decorator definitions.
+ * @returns A function that accepts a decorator name and returns a new {@link Decorator}.
+ */
 export const createDecorator = (filePath) => (name) => new Decorator(name, filePath);
+/**
+ * Fluent builder that assembles metadata for a single decorator definition.
+ *
+ * @remarks
+ * Use {@link createDecorator} for a convenient factory. All setter methods
+ * return `this` to support method chaining.
+ */
 export class Decorator {
     name;
     data;
+    /**
+     * Creates a new Decorator instance.
+     *
+     * @param name - Unique identifier for the decorator.
+     * @param inputFilePath - Absolute path to the source file that defines this decorator.
+     */
     constructor(name, inputFilePath) {
         this.name = name;
         const inputDirPath = dirname(inputFilePath);
@@ -14,14 +33,32 @@ export class Decorator {
         const decoPath = toDecoPath(name, inputDirPath, inputFilename);
         this.data = { name, inputDirPath, inputFilename, decoPath, inputFilePath };
     }
+    /**
+     * Sets the human-readable display title.
+     *
+     * @param val - The title string.
+     * @returns This instance for chaining.
+     */
     title(val) {
         this.data.title = val;
         return this;
     }
+    /**
+     * Sets the namespace for grouping related decorators.
+     *
+     * @param val - The namespace string.
+     * @returns This instance for chaining.
+     */
     namespace(val) {
         this.data.namespace = val;
         return this;
     }
+    /**
+     * Merges the given properties into this decorator's property map.
+     *
+     * @param properties - A record of property names to {@link DecoProperty} instances.
+     * @returns This instance for chaining.
+     */
     properties(properties) {
         if (!this.data.properties)
             this.data.properties = {};
@@ -29,12 +66,24 @@ export class Decorator {
             this.data.properties[key] = prop;
         return this;
     }
+    /**
+     * Appends additional import declarations required by generated code.
+     *
+     * @param imps - One or more import declarations to add.
+     * @returns This instance for chaining.
+     */
     additionalImports(...imps) {
         if (!this.data.additionalImports)
             this.data.additionalImports = [];
         this.data.additionalImports.push(...imps);
         return this;
     }
+    /**
+     * Merges the given route definitions into this decorator's route map.
+     *
+     * @param routes - A record of route names to {@link DecoRouteParams}.
+     * @returns This instance for chaining.
+     */
     routes(routes) {
         if (!this.data.routes)
             this.data.routes = {};
@@ -42,13 +91,29 @@ export class Decorator {
             this.data.routes[key] = route;
         return this;
     }
+    /**
+     * Adds the standard CRUD route set derived from the decorator name.
+     *
+     * @returns This instance for chaining.
+     */
     routesCrud() {
         return this.routes(crudRoutes(`${this.data.name}Doc`));
     }
+    /**
+     * Marks this decorator as the leading/primary decorator.
+     *
+     * @param lead - Whether the decorator is the lead. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     lead(lead = true) {
         this.data.lead = lead;
         return this;
     }
+    /**
+     * Extracts a deep-cloned snapshot of the decorator's raw data.
+     *
+     * @returns A plain {@link DecoratorData} object safe to mutate independently.
+     */
     extractRaw() {
         const { properties, ...rest } = this.data;
         return {
@@ -56,6 +121,15 @@ export class Decorator {
             ...(properties ? { properties: { ...properties } } : {}),
         };
     }
+    /**
+     * Extracts annotations header metadata from this decorator and its properties.
+     *
+     * @remarks
+     * Object-type properties receive special handling to preserve the live
+     * {@link Decorator} reference that `structuredClone` would otherwise strip.
+     *
+     * @returns An {@link AnnotationsHeader} derived from the current decorator state.
+     */
     extractAnnotations() {
         const rawProperties = {};
         for (const [key, prop] of Object.entries(this.data.properties ?? {})) {

package/dist/decorator/Decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"Decorator.js","sourceRoot":"","sources":["../../src/decorator/Decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAMzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAkBlE,MAAM,CAAC,MAAM,eAAe,GAC1B,CAAC,QAAgB,EAAE,EAAE,CACrB,CAAC,IAAY,EAAa,EAAE,CAC1B,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAIlC,MAAM,OAAO,SAAS;IAIF;IAHR,IAAI,CAAgB;IAE9B,YACkB,IAAY,EAC5B,aAAqB;QADL,SAAI,GAAJ,IAAI,CAAQ;QAG5B,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,SAAS,CAAC,GAAW;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,UAA0B;QAC1C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,iBAAiB,CAAC,GAAG,IAAkB;QAC5C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB;YAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IACM,MAAM,CAAC,MAAkB;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;IACM,IAAI,CAAC,OAAgB,IAAI;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,UAAU;QACf,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1C,OAAO;YACL,GAAG,eAAe,CAAC,IAAI,CAAC;YACxB,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,GAAG,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACzD,CAAC;IACJ,CAAC;IAEM,kBAAkB;QACvB,MAAM,aAAa,GAAsD,EAAE,CAAC;QAC5E,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;YACrE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAC9B,oFAAoF;YACpF,IACE,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM;gBACzC,MAAM,IAAK,IAAqC,CAAC,MAAM,CAAC,EACxD,CAAC;gBACA,GAAG,CAAC,IAAuB,CAAC,IAAI,GAC/B,IACD,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;YACjB,CAAC;YACD,aAAa,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;QAC3B,CAAC;QACD,OAAO,oBAAoB,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;CACF"}
+{"version":3,"file":"Decorator.js","sourceRoot":"","sources":["../../src/decorator/Decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAMzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAoClE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAC1B,CAAC,QAAgB,EAAE,EAAE,CACrB,CAAC,IAAY,EAAa,EAAE,CAC1B,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAKlC;;;;;;GAMG;AACH,MAAM,OAAO,SAAS;IAUF;IATR,IAAI,CAAgB;IAE9B;;;;;OAKG;IACH,YACkB,IAAY,EAC5B,aAAqB;QADL,SAAI,GAAJ,IAAI,CAAQ;QAG5B,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC7E,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,SAAS,CAAC,GAAW;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,UAAU,CAAC,UAA0B;QAC1C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,iBAAiB,CAAC,GAAG,IAAkB;QAC5C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB;YAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,MAAkB;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;IACD;;;;;OAKG;IACI,IAAI,CAAC,OAAgB,IAAI;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,UAAU;QACf,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1C,OAAO;YACL,GAAG,eAAe,CAAC,IAAI,CAAC;YACxB,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,GAAG,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACzD,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,kBAAkB;QACvB,MAAM,aAAa,GAAsD,EAAE,CAAC;QAC5E,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;YACrE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAC9B,oFAAoF;YACpF,IACE,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM;gBACzC,MAAM,IAAK,IAAqC,CAAC,MAAM,CAAC,EACxD,CAAC;gBACA,GAAG,CAAC,IAAuB,CAAC,IAAI,GAC/B,IACD,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;YACjB,CAAC;YACD,aAAa,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;QAC3B,CAAC;QACD,OAAO,oBAAoB,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;CACF"}

package/dist/decorator/deco.cast.d.ts

@@ -1,9 +1,51 @@
 import { DecoArrayOptions, DecoBooleanOptions, DecoDateOptions, DecoNumberOptions, DecoObjectOptions, DecoPropertyBase, DecoStringOptions } from "../types/types.deco.property.js";
+/**
+ * Casts a property to a key-typed string option if it is a string marked as a key.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast {@link DecoStringOptions} when the property is a key string, or `null` otherwise.
+ */
 export declare const castDecoKey: (prop: DecoPropertyBase) => DecoStringOptions | null;
+/**
+ * Casts a property to {@link DecoNumberOptions} if it is a number type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export declare const castDecoNumber: (prop: DecoPropertyBase) => DecoNumberOptions | null;
+/**
+ * Casts a property to {@link DecoStringOptions} if it is a string type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export declare const castDecoString: (prop: DecoPropertyBase) => DecoStringOptions | null;
+/**
+ * Casts a property to {@link DecoBooleanOptions} if it is a boolean type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export declare const castDecoBoolean: (prop: DecoPropertyBase) => DecoBooleanOptions | null;
+/**
+ * Casts a property to {@link DecoDateOptions} if it is a date type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export declare const castDecoDate: (prop: DecoPropertyBase) => DecoDateOptions | null;
+/**
+ * Casts a property to {@link DecoArrayOptions} if it is an array type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export declare const castDecoArray: (prop: DecoPropertyBase) => DecoArrayOptions | null;
+/**
+ * Casts a property to {@link DecoObjectOptions} if it is an object type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export declare const castDecoObject: (prop: DecoPropertyBase) => DecoObjectOptions | null;
 //# sourceMappingURL=deco.cast.d.ts.map

package/dist/decorator/deco.cast.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deco.cast.d.ts","sourceRoot":"","sources":["../../src/decorator/deco.cast.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,iCAAiC,CAAC;AAIzC,eAAO,MAAM,WAAW,GACtB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IAGtB,CAAC;AAEF,eAAO,MAAM,cAAc,GACzB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IACqD,CAAC;AAE7E,eAAO,MAAM,cAAc,GACzB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IACqD,CAAC;AAE7E,eAAO,MAAM,eAAe,GAC1B,MAAM,gBAAgB,KACrB,kBAAkB,GAAG,IACsD,CAAC;AAE/E,eAAO,MAAM,YAAY,GAAI,MAAM,gBAAgB,KAAG,eAAe,GAAG,IACA,CAAC;AAEzE,eAAO,MAAM,aAAa,GACxB,MAAM,gBAAgB,KACrB,gBAAgB,GAAG,IACoD,CAAC;AAE3E,eAAO,MAAM,cAAc,GACzB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IACqD,CAAC"}
+{"version":3,"file":"deco.cast.d.ts","sourceRoot":"","sources":["../../src/decorator/deco.cast.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,iCAAiC,CAAC;AAIzC;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IAGtB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IACqD,CAAC;AAE7E;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IACqD,CAAC;AAE7E;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,MAAM,gBAAgB,KACrB,kBAAkB,GAAG,IACsD,CAAC;AAE/E;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,gBAAgB,KAAG,eAAe,GAAG,IACA,CAAC;AAEzE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GACxB,MAAM,gBAAgB,KACrB,gBAAgB,GAAG,IACoD,CAAC;AAE3E;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,gBAAgB,KACrB,iBAAiB,GAAG,IACqD,CAAC"}

package/dist/decorator/deco.cast.js

@@ -1,13 +1,55 @@
 import { DecoPropertyType } from "./deco.enum.js";
 // ----- Properties ----------------------------------------------------------------
+/**
+ * Casts a property to a key-typed string option if it is a string marked as a key.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast {@link DecoStringOptions} when the property is a key string, or `null` otherwise.
+ */
 export const castDecoKey = (prop) => {
     const casted = castDecoString(prop);
     return casted?.isKey === true ? casted : null;
 };
+/**
+ * Casts a property to {@link DecoNumberOptions} if it is a number type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export const castDecoNumber = (prop) => prop.type === DecoPropertyType.number ? prop : null;
+/**
+ * Casts a property to {@link DecoStringOptions} if it is a string type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export const castDecoString = (prop) => prop.type === DecoPropertyType.string ? prop : null;
+/**
+ * Casts a property to {@link DecoBooleanOptions} if it is a boolean type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export const castDecoBoolean = (prop) => prop.type === DecoPropertyType.boolean ? prop : null;
+/**
+ * Casts a property to {@link DecoDateOptions} if it is a date type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export const castDecoDate = (prop) => prop.type === DecoPropertyType.date ? prop : null;
+/**
+ * Casts a property to {@link DecoArrayOptions} if it is an array type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export const castDecoArray = (prop) => prop.type === DecoPropertyType.array ? prop : null;
+/**
+ * Casts a property to {@link DecoObjectOptions} if it is an object type.
+ *
+ * @param prop - The base property to inspect.
+ * @returns The cast options or `null` when the type does not match.
+ */
 export const castDecoObject = (prop) => prop.type === DecoPropertyType.object ? prop : null;
 //# sourceMappingURL=deco.cast.js.map

package/dist/decorator/deco.cast.js.map

@@ -1 +1 @@
-{"version":3,"file":"deco.cast.js","sourceRoot":"","sources":["../../src/decorator/deco.cast.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,oFAAoF;AACpF,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAsB,EACI,EAAE;IAC5B,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAsB,EACI,EAAE,CAC5B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAE,IAA0B,CAAC,CAAC,CAAC,IAAI,CAAC;AAE7E,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAsB,EACI,EAAE,CAC5B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAE,IAA0B,CAAC,CAAC,CAAC,IAAI,CAAC;AAE7E,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,IAAsB,EACK,EAAE,CAC7B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAE,IAA2B,CAAC,CAAC,CAAC,IAAI,CAAC;AAE/E,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAsB,EAA0B,EAAE,CAC7E,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAE,IAAwB,CAAC,CAAC,CAAC,IAAI,CAAC;AAEzE,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,IAAsB,EACG,EAAE,CAC3B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAyB,CAAC,CAAC,CAAC,IAAI,CAAC;AAE3E,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAsB,EACI,EAAE,CAC5B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAE,IAA0B,CAAC,CAAC,CAAC,IAAI,CAAC"}
+{"version":3,"file":"deco.cast.js","sourceRoot":"","sources":["../../src/decorator/deco.cast.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,oFAAoF;AACpF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAsB,EACI,EAAE;IAC5B,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAsB,EACI,EAAE,CAC5B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAE,IAA0B,CAAC,CAAC,CAAC,IAAI,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAsB,EACI,EAAE,CAC5B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAE,IAA0B,CAAC,CAAC,CAAC,IAAI,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,IAAsB,EACK,EAAE,CAC7B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAE,IAA2B,CAAC,CAAC,CAAC,IAAI,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAsB,EAA0B,EAAE,CAC7E,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAE,IAAwB,CAAC,CAAC,CAAC,IAAI,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,IAAsB,EACG,EAAE,CAC3B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAyB,CAAC,CAAC,CAAC,IAAI,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAsB,EACI,EAAE,CAC5B,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAE,IAA0B,CAAC,CAAC,CAAC,IAAI,CAAC"}

package/dist/decorator/deco.enum.d.ts

@@ -1,3 +1,4 @@
+/** Enumeration of output file types generated from decorator definitions. */
 export declare enum DecoFileType {
     doc = "doc",
     template = "template",
@@ -7,18 +8,39 @@ export declare enum DecoFileType {
     zod = "zod",
     annotations = "annotations"
 }
+/**
+ * Type guard that validates whether an unknown value is a valid {@link DecoFileType}.
+ *
+ * @param type - The value to check.
+ * @returns The narrowed {@link DecoFileType} or `null` when invalid.
+ */
 export declare const guardDecoFileType: (type: unknown) => DecoFileType | null;
+/** Supported file extensions for generated decorator output files. */
 export declare enum DecoFileExtension {
     ts = "ts",
     json = "json"
 }
+/**
+ * Type guard that validates whether an unknown value is a valid {@link DecoFileExtension}.
+ *
+ * @param type - The value to check.
+ * @returns The narrowed {@link DecoFileExtension} or `null` when invalid.
+ */
 export declare const guardDecoFileExtension: (type: unknown) => DecoFileExtension | null;
+/** Target platform for generated code output. */
 export declare enum DecoTargetType {
     common = "common",
     frontend = "frontend",
     backend = "backend"
 }
+/**
+ * Type guard that validates whether an unknown value is a valid {@link DecoTargetType}.
+ *
+ * @param type - The value to check.
+ * @returns The narrowed {@link DecoTargetType} or `null` when invalid.
+ */
 export declare const guardDecoTargetType: (type: unknown) => DecoTargetType | null;
+/** Discriminator values for the supported decorator property types. */
 export declare enum DecoPropertyType {
     string = "string",
     number = "number",
@@ -27,15 +49,18 @@ export declare enum DecoPropertyType {
     array = "array",
     object = "object"
 }
+/** Header type classification for decorator display. */
 export declare enum DecoHeadType {
     default = "default",
     leading = "leading"
 }
+/** Supported date serialization formats for date properties. */
 export declare enum DecoDateFormat {
     timestamp = "timestamp",
     time = "time",
     date = "date"
 }
+/** Standard CRUD operation route names. */
 export declare enum CrudRouteName {
     create = "create",
     update = "update",
@@ -45,6 +70,18 @@ export declare enum CrudRouteName {
     count = "count",
     exists = "exists"
 }
+/**
+ * Checks whether a route name corresponds to a standard CRUD operation.
+ *
+ * @param routeName - The route name to test.
+ * @returns `true` if the name matches a {@link CrudRouteName} value.
+ */
 export declare const isCrudRoute: (routeName: string) => boolean;
+/**
+ * Checks whether any route name in the array is a standard CRUD operation.
+ *
+ * @param routeNames - Array of route names to test.
+ * @returns `true` if at least one name matches a {@link CrudRouteName} value.
+ */
 export declare const hasCrudRoute: (routeNames: string[]) => boolean;
 //# sourceMappingURL=deco.enum.d.ts.map

package/dist/decorator/deco.enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deco.enum.d.ts","sourceRoot":"","sources":["../../src/decorator/deco.enum.ts"],"names":[],"mappings":"AACA,oBAAY,YAAY;IACtB,GAAG,QAAQ;IACX,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,GAAG,QAAQ;IACX,WAAW,gBAAgB;CAC5B;AAED,eAAO,MAAM,iBAAiB,GAAI,MAAM,OAAO,KAAG,YAAY,GAAG,IAIvD,CAAC;AAGX,oBAAY,iBAAiB;IAC3B,EAAE,OAAO;IACT,IAAI,SAAS;CACd;AAED,eAAO,MAAM,sBAAsB,GACjC,MAAM,OAAO,KACZ,iBAAiB,GAAG,IAIb,CAAC;AAGX,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,mBAAmB,GAAI,MAAM,OAAO,KAAG,cAAc,GAAG,IAI3D,CAAC;AAGX,oBAAY,gBAAgB;IAC1B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAGD,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAGD,oBAAY,cAAc;IACxB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAGD,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,WAAW,GAAI,WAAW,MAAM,KAAG,OACa,CAAC;AAE9D,eAAO,MAAM,YAAY,GAAI,YAAY,MAAM,EAAE,KAAG,OACM,CAAC"}
+{"version":3,"file":"deco.enum.d.ts","sourceRoot":"","sources":["../../src/decorator/deco.enum.ts"],"names":[],"mappings":"AACA,6EAA6E;AAC7E,oBAAY,YAAY;IACtB,GAAG,QAAQ;IACX,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,GAAG,QAAQ;IACX,WAAW,gBAAgB;CAC5B;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,OAAO,KAAG,YAAY,GAAG,IAIvD,CAAC;AAGX,sEAAsE;AACtE,oBAAY,iBAAiB;IAC3B,EAAE,OAAO;IACT,IAAI,SAAS;CACd;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,MAAM,OAAO,KACZ,iBAAiB,GAAG,IAIb,CAAC;AAGX,iDAAiD;AACjD,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,MAAM,OAAO,KAAG,cAAc,GAAG,IAI3D,CAAC;AAGX,uEAAuE;AACvE,oBAAY,gBAAgB;IAC1B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAGD,wDAAwD;AACxD,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAGD,gEAAgE;AAChE,oBAAY,cAAc;IACxB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAGD,2CAA2C;AAC3C,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,WAAW,MAAM,KAAG,OACa,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,YAAY,MAAM,EAAE,KAAG,OACM,CAAC"}

package/dist/decorator/deco.enum.js

@@ -1,4 +1,5 @@
 // ----- DecoFileType --------------------------------------
+/** Enumeration of output file types generated from decorator definitions. */
 export var DecoFileType;
 (function (DecoFileType) {
     DecoFileType["doc"] = "doc";
@@ -9,32 +10,53 @@ export var DecoFileType;
     DecoFileType["zod"] = "zod";
     DecoFileType["annotations"] = "annotations";
 })(DecoFileType || (DecoFileType = {}));
+/**
+ * Type guard that validates whether an unknown value is a valid {@link DecoFileType}.
+ *
+ * @param type - The value to check.
+ * @returns The narrowed {@link DecoFileType} or `null` when invalid.
+ */
 export const guardDecoFileType = (type) => typeof type === "string" &&
     Object.values(DecoFileType).includes(type)
     ? type
     : null;
 // ----- DecoFileExtension --------------------------------------
+/** Supported file extensions for generated decorator output files. */
 export var DecoFileExtension;
 (function (DecoFileExtension) {
     DecoFileExtension["ts"] = "ts";
     DecoFileExtension["json"] = "json";
 })(DecoFileExtension || (DecoFileExtension = {}));
+/**
+ * Type guard that validates whether an unknown value is a valid {@link DecoFileExtension}.
+ *
+ * @param type - The value to check.
+ * @returns The narrowed {@link DecoFileExtension} or `null` when invalid.
+ */
 export const guardDecoFileExtension = (type) => typeof type === "string" &&
     Object.values(DecoFileExtension).includes(type)
     ? type
     : null;
 // ----- DecoTargetType --------------------------------------
+/** Target platform for generated code output. */
 export var DecoTargetType;
 (function (DecoTargetType) {
     DecoTargetType["common"] = "common";
     DecoTargetType["frontend"] = "frontend";
     DecoTargetType["backend"] = "backend";
 })(DecoTargetType || (DecoTargetType = {}));
+/**
+ * Type guard that validates whether an unknown value is a valid {@link DecoTargetType}.
+ *
+ * @param type - The value to check.
+ * @returns The narrowed {@link DecoTargetType} or `null` when invalid.
+ */
 export const guardDecoTargetType = (type) => typeof type === "string" &&
     Object.values(DecoTargetType).includes(type)
     ? type
     : null;
 // ----- DecoPropertyType --------------------------------------
+/** Discriminator values for the supported decorator property types. */
 export var DecoPropertyType;
 (function (DecoPropertyType) {
     DecoPropertyType["string"] = "string";
@@ -45,12 +67,14 @@ export var DecoPropertyType;
     DecoPropertyType["object"] = "object";
 })(DecoPropertyType || (DecoPropertyType = {}));
 // ----- DecoHeadType --------------------------------------
+/** Header type classification for decorator display. */
 export var DecoHeadType;
 (function (DecoHeadType) {
     DecoHeadType["default"] = "default";
     DecoHeadType["leading"] = "leading";
 })(DecoHeadType || (DecoHeadType = {}));
 // ----- DecoDateFormat --------------------------------------
+/** Supported date serialization formats for date properties. */
 export var DecoDateFormat;
 (function (DecoDateFormat) {
     DecoDateFormat["timestamp"] = "timestamp";
@@ -58,6 +82,7 @@ export var DecoDateFormat;
     DecoDateFormat["date"] = "date";
 })(DecoDateFormat || (DecoDateFormat = {}));
 // ----- CrudRouteName --------------------------------------
+/** Standard CRUD operation route names. */
 export var CrudRouteName;
 (function (CrudRouteName) {
     CrudRouteName["create"] = "create";
@@ -68,6 +93,18 @@ export var CrudRouteName;
     CrudRouteName["count"] = "count";
     CrudRouteName["exists"] = "exists";
 })(CrudRouteName || (CrudRouteName = {}));
+/**
+ * Checks whether a route name corresponds to a standard CRUD operation.
+ *
+ * @param routeName - The route name to test.
+ * @returns `true` if the name matches a {@link CrudRouteName} value.
+ */
 export const isCrudRoute = (routeName) => !!Object.values(CrudRouteName).find((r) => r === routeName);
+/**
+ * Checks whether any route name in the array is a standard CRUD operation.
+ *
+ * @param routeNames - Array of route names to test.
+ * @returns `true` if at least one name matches a {@link CrudRouteName} value.
+ */
 export const hasCrudRoute = (routeNames) => !!routeNames.find((routeName) => isCrudRoute(routeName));
 //# sourceMappingURL=deco.enum.js.map

package/dist/decorator/deco.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"deco.enum.js","sourceRoot":"","sources":["../../src/decorator/deco.enum.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;IACX,2CAA2B,CAAA;AAC7B,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAa,EAAuB,EAAE,CACtE,OAAO,IAAI,KAAK,QAAQ;IACxB,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,IAAoB,CAAC;IACxD,CAAC,CAAE,IAAqB;IACxB,CAAC,CAAC,IAAI,CAAC;AAEX,iEAAiE;AACjE,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,8BAAS,CAAA;IACT,kCAAa,CAAA;AACf,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,IAAa,EACa,EAAE,CAC5B,OAAO,IAAI,KAAK,QAAQ;IACxB,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,IAAyB,CAAC;IAClE,CAAC,CAAE,IAA0B;IAC7B,CAAC,CAAC,IAAI,CAAC;AAEX,8DAA8D;AAC9D,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;IACrB,qCAAmB,CAAA;AACrB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAa,EAAyB,EAAE,CAC1E,OAAO,IAAI,KAAK,QAAQ;IACxB,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,IAAsB,CAAC;IAC5D,CAAC,CAAE,IAAuB;IAC1B,CAAC,CAAC,IAAI,CAAC;AAEX,gEAAgE;AAChE,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,uCAAmB,CAAA;IACnB,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AAED,4DAA4D;AAC5D,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;AACrB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAED,8DAA8D;AAC9D,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,+BAAa,CAAA;IACb,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAED,6DAA6D;AAC7D,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,4BAAW,CAAA;IACX,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,kCAAiB,CAAA;AACnB,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAW,EAAE,CACxD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,UAAoB,EAAW,EAAE,CAC5D,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC"}
+{"version":3,"file":"deco.enum.js","sourceRoot":"","sources":["../../src/decorator/deco.enum.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,6EAA6E;AAC7E,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;IACX,2CAA2B,CAAA;AAC7B,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAa,EAAuB,EAAE,CACtE,OAAO,IAAI,KAAK,QAAQ;IACxB,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,IAAoB,CAAC;IACxD,CAAC,CAAE,IAAqB;IACxB,CAAC,CAAC,IAAI,CAAC;AAEX,iEAAiE;AACjE,sEAAsE;AACtE,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,8BAAS,CAAA;IACT,kCAAa,CAAA;AACf,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,IAAa,EACa,EAAE,CAC5B,OAAO,IAAI,KAAK,QAAQ;IACxB,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,IAAyB,CAAC;IAClE,CAAC,CAAE,IAA0B;IAC7B,CAAC,CAAC,IAAI,CAAC;AAEX,8DAA8D;AAC9D,iDAAiD;AACjD,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;IACrB,qCAAmB,CAAA;AACrB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAa,EAAyB,EAAE,CAC1E,OAAO,IAAI,KAAK,QAAQ;IACxB,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,IAAsB,CAAC;IAC5D,CAAC,CAAE,IAAuB;IAC1B,CAAC,CAAC,IAAI,CAAC;AAEX,gEAAgE;AAChE,uEAAuE;AACvE,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,uCAAmB,CAAA;IACnB,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AAED,4DAA4D;AAC5D,wDAAwD;AACxD,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;AACrB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAED,8DAA8D;AAC9D,gEAAgE;AAChE,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,+BAAa,CAAA;IACb,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAED,6DAA6D;AAC7D,2CAA2C;AAC3C,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,4BAAW,CAAA;IACX,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,kCAAiB,CAAA;AACnB,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAW,EAAE,CACxD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,UAAoB,EAAW,EAAE,CAC5D,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC"}

package/dist/decorator/deco.names.d.ts

@@ -1,20 +1,48 @@
 import { DecoTargetType } from "./deco.enum.js";
+/**
+ * Shape describing all generated name variants derived from a decorator.
+ *
+ * @remarks
+ * Each property represents a conventional name used in code generation
+ * (e.g., API client, store module, Zod schema).
+ */
 export interface DecoNames {
+    /** Target platform for the generated output. */
     targetType: DecoTargetType;
+    /** Original base name of the decorator. */
     basename: string;
+    /** Lower-case variant of the base name. */
     basenameLower: string;
+    /** Upper-case variant of the base name. */
     basenameUpper: string;
+    /** Document type name. */
     doc: string;
+    /** Routes file name. */
     routes: string;
+    /** Routes constant name. */
     routesName: string;
+    /** API client name. */
     api: string;
+    /** Cloud function name. */
     func: string;
+    /** Store module name. */
     store: string;
+    /** Shape type name. */
     shape: string;
+    /** Zod schema name. */
     schema: string;
+    /** Annotations constant name. */
     annotations: string;
+    /** Factory/initialisation function name. */
     initialFunc: string;
+    /** Cloud Function entry-point name. */
     functionName: string;
 }
+/**
+ * Array of all property keys defined on {@link DecoNames}.
+ *
+ * @remarks
+ * Derived at module load time from the private `decoNames` sentinel object.
+ */
 export declare const decoNamesProperties: (keyof DecoNames)[];
 //# sourceMappingURL=deco.names.d.ts.map