@mxpicture/gcp-functions-common 1.1.2 → 1.1.4

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

@@ -1 +1 @@
-{"version":3,"file":"DecoNumber.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,UAAU,kBAAyB,CAAC;AAEjD,qBAAa,UAAW,SAAQ,YAAY,CAAC,cAAc,CAAC;;IAKnD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI1B,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAIpB,OAAO,CAAC,IAAI,GAAE,OAAc,GAAG,IAAI;IAInC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAIpB,OAAO,CAAC,IAAI,GAAE,OAAc,GAAG,IAAI;IAInC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI7B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAItC"}
+{"version":3,"file":"DecoNumber.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,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,+CAA+C;IAC/C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,kBAAyB,CAAC;AAEjD;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,YAAY,CAAC,cAAc,CAAC;IAC1D,mEAAmE;;IAKnE;;;;;OAKG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIjC;;;;;OAKG;IACI,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAI3B;;;;;OAKG;IACI,OAAO,CAAC,IAAI,GAAE,OAAc,GAAG,IAAI;IAI1C;;;;;OAKG;IACI,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAI3B;;;;;OAKG;IACI,OAAO,CAAC,IAAI,GAAE,OAAc,GAAG,IAAI;IAI1C;;;;;OAKG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIpC;;;;;OAKG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAItC"}

package/dist/decorator/DecoNumber.js

@@ -1,34 +1,89 @@
 import { DecoPropertyType } from "./deco.enum.js";
 import { DecoProperty } from "./DecoProperty.js";
+/**
+ * Factory function that creates a new {@link DecoNumber} instance.
+ *
+ * @returns A fresh number property builder.
+ */
 export const decoNumber = () => new DecoNumber();
+/**
+ * Fluent builder for configuring number-type decorator properties.
+ *
+ * @remarks
+ * Supports range constraints (min/max with optional exclusivity), multiples,
+ * and fractional digit limits.
+ */
 export class DecoNumber extends DecoProperty {
+    /** Creates a new number property builder with default settings. */
     constructor() {
         super(DecoPropertyType.number, {});
     }
+    /**
+     * Sets the default numeric value.
+     *
+     * @param def - The default value.
+     * @returns This instance for chaining.
+     */
     default(def) {
         this.data.default = def;
         return this;
     }
+    /**
+     * Sets the minimum allowed value.
+     *
+     * @param m - The minimum value.
+     * @returns This instance for chaining.
+     */
     min(m) {
         this.data.min = m;
         return this;
     }
+    /**
+     * Sets whether the minimum bound is exclusive.
+     *
+     * @param excl - `true` for exclusive minimum. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     minExcl(excl = true) {
         this.data.minExcl = excl;
         return this;
     }
+    /**
+     * Sets the maximum allowed value.
+     *
+     * @param m - The maximum value.
+     * @returns This instance for chaining.
+     */
     max(m) {
         this.data.max = m;
         return this;
     }
+    /**
+     * Sets whether the maximum bound is exclusive.
+     *
+     * @param excl - `true` for exclusive maximum. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     maxExcl(excl = true) {
         this.data.maxExcl = excl;
         return this;
     }
+    /**
+     * Constrains the value to be a multiple of the given number.
+     *
+     * @param val - The divisor.
+     * @returns This instance for chaining.
+     */
     multipleOf(val) {
         this.data.multipleOf = val;
         return this;
     }
+    /**
+     * Sets the number of fractional digits to preserve.
+     *
+     * @param digits - Maximum fraction digits.
+     * @returns This instance for chaining.
+     */
     fraction(digits) {
         this.data.fractionDigits = digits;
         return this;

package/dist/decorator/DecoNumber.js.map

@@ -1 +1 @@
-{"version":3,"file":"DecoNumber.js","sourceRoot":"","sources":["../../src/decorator/DecoNumber.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAYjD,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;AAEjD,MAAM,OAAO,UAAW,SAAQ,YAA4B;IAC1D;QACE,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,GAAG,CAAC,CAAS;QAClB,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,OAAO,CAAC,OAAgB,IAAI;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,GAAG,CAAC,CAAS;QAClB,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,OAAO,CAAC,OAAgB,IAAI;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,GAAW;QAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,MAAc;QAC5B,IAAI,CAAC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"DecoNumber.js","sourceRoot":"","sources":["../../src/decorator/DecoNumber.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAsBjD;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;AAEjD;;;;;;GAMG;AACH,MAAM,OAAO,UAAW,SAAQ,YAA4B;IAC1D,mEAAmE;IACnE;QACE,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,GAAG,CAAC,CAAS;QAClB,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,OAAO,CAAC,OAAgB,IAAI;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,GAAG,CAAC,CAAS;QAClB,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,OAAO,CAAC,OAAgB,IAAI;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,UAAU,CAAC,GAAW;QAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,QAAQ,CAAC,MAAc;QAC5B,IAAI,CAAC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/decorator/DecoObject.d.ts

@@ -1,11 +1,32 @@
 import { DecoPropertyBase } from "../types/types.deco.property.js";
 import { DecoProperty } from "./DecoProperty.js";
 import { Decorator } from "./Decorator.js";
+/**
+ * Configuration data for an object-type decorator property.
+ */
 export interface DecoObjectData extends DecoPropertyBase {
+    /** Reference to the nested {@link Decorator} that describes the object shape. */
     deco: Decorator;
 }
+/**
+ * Factory function that creates a new {@link DecoObject} instance.
+ *
+ * @param deco - The {@link Decorator} that describes the nested object.
+ * @returns A fresh object property builder.
+ */
 export declare const decoObject: (deco: Decorator) => DecoObject;
+/**
+ * Fluent builder for configuring object-type decorator properties.
+ *
+ * @remarks
+ * Wraps a nested {@link Decorator} to represent complex sub-document structures.
+ */
 export declare class DecoObject extends DecoProperty<DecoObjectData> {
+    /**
+     * Creates a new object property builder.
+     *
+     * @param deco - The {@link Decorator} describing the nested object structure.
+     */
     constructor(deco: Decorator);
 }
 //# sourceMappingURL=DecoObject.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DecoObject.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,eAAO,MAAM,UAAU,GAAI,MAAM,SAAS,eAAyB,CAAC;AAEpE,qBAAa,UAAW,SAAQ,YAAY,CAAC,cAAc,CAAC;gBACvC,IAAI,EAAE,SAAS;CAGnC"}
+{"version":3,"file":"DecoObject.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,iFAAiF;IACjF,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,SAAS,eAAyB,CAAC;AAEpE;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,YAAY,CAAC,cAAc,CAAC;IAC1D;;;;OAIG;gBACgB,IAAI,EAAE,SAAS;CAGnC"}

package/dist/decorator/DecoObject.js

@@ -1,7 +1,24 @@
 import { DecoPropertyType } from "./deco.enum.js";
 import { DecoProperty } from "./DecoProperty.js";
+/**
+ * Factory function that creates a new {@link DecoObject} instance.
+ *
+ * @param deco - The {@link Decorator} that describes the nested object.
+ * @returns A fresh object property builder.
+ */
 export const decoObject = (deco) => new DecoObject(deco);
+/**
+ * Fluent builder for configuring object-type decorator properties.
+ *
+ * @remarks
+ * Wraps a nested {@link Decorator} to represent complex sub-document structures.
+ */
 export class DecoObject extends DecoProperty {
+    /**
+     * Creates a new object property builder.
+     *
+     * @param deco - The {@link Decorator} describing the nested object structure.
+     */
     constructor(deco) {
         super(DecoPropertyType.object, { deco });
     }

package/dist/decorator/DecoObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"DecoObject.js","sourceRoot":"","sources":["../../src/decorator/DecoObject.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAOjD,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAe,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;AAEpE,MAAM,OAAO,UAAW,SAAQ,YAA4B;IAC1D,YAAmB,IAAe;QAChC,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF"}
+{"version":3,"file":"DecoObject.js","sourceRoot":"","sources":["../../src/decorator/DecoObject.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAWjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAe,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,YAA4B;IAC1D;;;;OAIG;IACH,YAAmB,IAAe;QAChC,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/decorator/DecoProperty.d.ts

@@ -2,26 +2,121 @@ import type { DecoPropertyType } from "./deco.enum.js";
 import type { DecoParamsKind } from "../types/types.deco.common.js";
 import { DecoPropertyBase, DecoPropertyCommon, DecoPropertyRaw } from "../types/types.deco.property.js";
 import { AnnotationsProperty } from "../types/types.annotation.js";
+/** A record mapping property names to their {@link DecoProperty} instances. */
 export type DecoProperties = Record<string, DecoProperty<DecoPropertyBase>>;
+/**
+ * Generic fluent builder for decorator property metadata.
+ *
+ * @remarks
+ * Serves as the base class for all typed property builders (string, number,
+ * boolean, date, array, object). Common display and behaviour attributes are
+ * managed through the {@link DecoPropertyCommon} fields while type-specific
+ * data lives in the generic `T` payload.
+ *
+ * @typeParam T - The type-specific data interface extending {@link DecoPropertyBase}.
+ */
 export declare class DecoProperty<T extends DecoPropertyBase> {
     protected common: DecoPropertyCommon;
     protected data: T;
+    /**
+     * Creates a new property builder.
+     *
+     * @param type - The property type discriminator.
+     * @param initData - Initial type-specific data (excluding the `type` field).
+     */
     constructor(type: DecoPropertyType, initData: Omit<T, "type">);
+    /**
+     * Replaces common and/or type-specific data with the provided values via deep clone.
+     *
+     * @param p - Object containing optional `common` and `data` payloads.
+     * @returns This instance for chaining.
+     */
     setAll(p: {
         common?: DecoPropertyCommon;
         data?: T;
     }): this;
+    /**
+     * Sets the human-readable title for this property.
+     *
+     * @param val - Title string or kind-parameterised value.
+     * @returns This instance for chaining.
+     */
     title(val: DecoParamsKind<string>): this;
+    /**
+     * Sets the description text for this property.
+     *
+     * @param val - Description string or kind-parameterised value.
+     * @returns This instance for chaining.
+     */
     description(val: DecoParamsKind<string>): this;
+    /**
+     * Marks this property as optional.
+     *
+     * @param val - Whether the property is optional. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     optional(val?: boolean): this;
+    /**
+     * Marks this property as editable in the UI.
+     *
+     * @param val - Whether the property is editable. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     editable(val?: boolean): this;
+    /**
+     * Marks this property as sortable in table views.
+     *
+     * @param val - Whether the property is sortable. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     sortable(val?: boolean): this;
+    /**
+     * Marks this property as filterable in table views.
+     *
+     * @param val - Whether the property is filterable. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     filterable(val?: boolean): this;
+    /**
+     * Marks this property as hidden in the UI.
+     *
+     * @param val - Whether the property is hidden, or a kind-parameterised flag. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     hidden(val?: DecoParamsKind<boolean>): this;
+    /**
+     * Sets the display width for this property in table views.
+     *
+     * @param val - CSS-compatible width string (e.g. `"200px"`).
+     * @returns This instance for chaining.
+     */
     width(val: string): this;
+    /**
+     * Marks this property as dependent on the popin (responsive detail) column.
+     *
+     * @param val - Whether popin dependency is enabled. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     depandPopin(val?: boolean): this;
+    /**
+     * Sets the display order for this property.
+     *
+     * @param val - Numeric order or kind-parameterised value.
+     * @returns This instance for chaining.
+     */
     order(val: DecoParamsKind<number>): this;
+    /**
+     * Extracts a deep-cloned snapshot of the property's raw common and type-specific data.
+     *
+     * @returns A plain {@link DecoPropertyRaw} object safe to mutate independently.
+     */
     extractRaw(): DecoPropertyRaw<T>;
+    /**
+     * Converts this property into an {@link AnnotationsProperty} for code generation.
+     *
+     * @param propertyKey - The key/name of the property within its parent decorator.
+     * @returns The mapped annotations property representation.
+     */
     extractAnnotations(propertyKey: string): AnnotationsProperty<T>;
 }
 //# sourceMappingURL=DecoProperty.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DecoProperty.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAGnE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC;AAE5E,qBAAa,YAAY,CAAC,CAAC,SAAS,gBAAgB;IAClD,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACrC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;gBAEC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC;IAK7D,MAAM,CAAC,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,kBAAkB,CAAC;QAAC,IAAI,CAAC,EAAE,CAAC,CAAA;KAAE,GAAG,IAAI;IAU1D,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI;IAIxC,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI;IAI9C,QAAQ,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAInC,QAAQ,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAInC,QAAQ,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAInC,UAAU,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAIrC,MAAM,CAAC,GAAG,GAAE,cAAc,CAAC,OAAO,CAAQ,GAAG,IAAI;IAIjD,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB,WAAW,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAItC,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI;IAKxC,UAAU,IAAI,eAAe,CAAC,CAAC,CAAC;IAOhC,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,mBAAmB,CAAC,CAAC,CAAC;CAGvE"}
+{"version":3,"file":"DecoProperty.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAGnE,+EAA+E;AAC/E,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC;AAE5E;;;;;;;;;;GAUG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,gBAAgB;IAClD,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACrC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAElB;;;;;OAKG;gBACgB,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC;IAKpE;;;;;OAKG;IACI,MAAM,CAAC,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,kBAAkB,CAAC;QAAC,IAAI,CAAC,EAAE,CAAC,CAAA;KAAE,GAAG,IAAI;IAUjE;;;;;OAKG;IACI,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI;IAI/C;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI;IAIrD;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAI1C;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAI1C;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAI1C;;;;;OAKG;IACI,UAAU,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAI5C;;;;;OAKG;IACI,MAAM,CAAC,GAAG,GAAE,cAAc,CAAC,OAAO,CAAQ,GAAG,IAAI;IAIxD;;;;;OAKG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI/B;;;;;OAKG;IACI,WAAW,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;IAI7C;;;;;OAKG;IACI,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI;IAK/C;;;;OAIG;IACI,UAAU,IAAI,eAAe,CAAC,CAAC,CAAC;IAOvC;;;;;OAKG;IACI,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,mBAAmB,CAAC,CAAC,CAAC;CAGvE"}

package/dist/decorator/DecoProperty.js

@@ -1,11 +1,34 @@
 import { mapAnnotationsProperty } from "../annotation/anno.property.js";
+/**
+ * Generic fluent builder for decorator property metadata.
+ *
+ * @remarks
+ * Serves as the base class for all typed property builders (string, number,
+ * boolean, date, array, object). Common display and behaviour attributes are
+ * managed through the {@link DecoPropertyCommon} fields while type-specific
+ * data lives in the generic `T` payload.
+ *
+ * @typeParam T - The type-specific data interface extending {@link DecoPropertyBase}.
+ */
 export class DecoProperty {
     common;
     data;
+    /**
+     * Creates a new property builder.
+     *
+     * @param type - The property type discriminator.
+     * @param initData - Initial type-specific data (excluding the `type` field).
+     */
     constructor(type, initData) {
         this.common = {};
         this.data = { ...initData, type };
     }
+    /**
+     * Replaces common and/or type-specific data with the provided values via deep clone.
+     *
+     * @param p - Object containing optional `common` and `data` payloads.
+     * @returns This instance for chaining.
+     */
     setAll(p) {
         if (p.common)
             this.common = structuredClone(p.common);
@@ -15,52 +38,123 @@ export class DecoProperty {
         }
         return this;
     }
+    /**
+     * Sets the human-readable title for this property.
+     *
+     * @param val - Title string or kind-parameterised value.
+     * @returns This instance for chaining.
+     */
     title(val) {
         this.common.title = val;
         return this;
     }
+    /**
+     * Sets the description text for this property.
+     *
+     * @param val - Description string or kind-parameterised value.
+     * @returns This instance for chaining.
+     */
     description(val) {
         this.common.description = val;
         return this;
     }
+    /**
+     * Marks this property as optional.
+     *
+     * @param val - Whether the property is optional. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     optional(val = true) {
         this.common.optional = val;
         return this;
     }
+    /**
+     * Marks this property as editable in the UI.
+     *
+     * @param val - Whether the property is editable. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     editable(val = true) {
         this.common.editable = val;
         return this;
     }
+    /**
+     * Marks this property as sortable in table views.
+     *
+     * @param val - Whether the property is sortable. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     sortable(val = true) {
         this.common.sortable = val;
         return this;
     }
+    /**
+     * Marks this property as filterable in table views.
+     *
+     * @param val - Whether the property is filterable. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     filterable(val = true) {
         this.common.filterable = val;
         return this;
     }
+    /**
+     * Marks this property as hidden in the UI.
+     *
+     * @param val - Whether the property is hidden, or a kind-parameterised flag. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     hidden(val = true) {
         this.common.hidden = val;
         return this;
     }
+    /**
+     * Sets the display width for this property in table views.
+     *
+     * @param val - CSS-compatible width string (e.g. `"200px"`).
+     * @returns This instance for chaining.
+     */
     width(val) {
         this.common.width = val;
         return this;
     }
+    /**
+     * Marks this property as dependent on the popin (responsive detail) column.
+     *
+     * @param val - Whether popin dependency is enabled. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     depandPopin(val = true) {
         this.common.depandPopin = val;
         return this;
     }
+    /**
+     * Sets the display order for this property.
+     *
+     * @param val - Numeric order or kind-parameterised value.
+     * @returns This instance for chaining.
+     */
     order(val) {
         this.common.order = val;
         return this;
     }
+    /**
+     * Extracts a deep-cloned snapshot of the property's raw common and type-specific data.
+     *
+     * @returns A plain {@link DecoPropertyRaw} object safe to mutate independently.
+     */
     extractRaw() {
         return structuredClone({
             common: this.common,
             data: this.data,
         });
     }
+    /**
+     * Converts this property into an {@link AnnotationsProperty} for code generation.
+     *
+     * @param propertyKey - The key/name of the property within its parent decorator.
+     * @returns The mapped annotations property representation.
+     */
     extractAnnotations(propertyKey) {
         return mapAnnotationsProperty(propertyKey, this.extractRaw());
     }

package/dist/decorator/DecoProperty.js.map

@@ -1 +1 @@
-{"version":3,"file":"DecoProperty.js","sourceRoot":"","sources":["../../src/decorator/DecoProperty.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAIxE,MAAM,OAAO,YAAY;IACb,MAAM,CAAqB;IAC3B,IAAI,CAAI;IAElB,YAAmB,IAAsB,EAAE,QAAyB;QAClE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAO,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,CAA4C;QACxD,IAAI,CAAC,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,GAA2B;QACtC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,WAAW,CAAC,GAA2B;QAC5C,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,MAAe,IAAI;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,MAAe,IAAI;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,MAAe,IAAI;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,MAAe,IAAI;QACnC,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,MAAM,CAAC,MAA+B,IAAI;QAC/C,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,WAAW,CAAC,MAAe,IAAI;QACpC,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,GAA2B;QACtC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,UAAU;QACf,OAAO,eAAe,CAAC;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAEM,kBAAkB,CAAC,WAAmB;QAC3C,OAAO,sBAAsB,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}
+{"version":3,"file":"DecoProperty.js","sourceRoot":"","sources":["../../src/decorator/DecoProperty.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAKxE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,YAAY;IACb,MAAM,CAAqB;IAC3B,IAAI,CAAI;IAElB;;;;;OAKG;IACH,YAAmB,IAAsB,EAAE,QAAyB;QAClE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAO,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,CAA4C;QACxD,IAAI,CAAC,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAA2B;QACtC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,WAAW,CAAC,GAA2B;QAC5C,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,QAAQ,CAAC,MAAe,IAAI;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,QAAQ,CAAC,MAAe,IAAI;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,QAAQ,CAAC,MAAe,IAAI;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,UAAU,CAAC,MAAe,IAAI;QACnC,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,MAA+B,IAAI;QAC/C,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,WAAW,CAAC,MAAe,IAAI;QACpC,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,GAA2B;QACtC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,UAAU;QACf,OAAO,eAAe,CAAC;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,WAAmB;QAC3C,OAAO,sBAAsB,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}

package/dist/decorator/DecoString.d.ts

@@ -1,21 +1,78 @@
 import { DecoPropertyBase } from "../types/types.deco.property.js";
 import { DecoProperty } from "./DecoProperty.js";
+/**
+ * Configuration data for a string-type decorator property.
+ */
 export interface DecoStringData extends DecoPropertyBase {
+    /** Default string value. */
     default?: string;
+    /** Minimum character length. */
     minLength?: number;
+    /** Maximum character length. */
     maxLength?: number;
+    /** Exact character length required. */
     exactLength?: number;
+    /** Regular expression pattern the value must match. */
     regex?: string;
+    /** Whether this string serves as the document key. */
     key?: boolean;
 }
+/**
+ * Factory function that creates a new {@link DecoString} instance.
+ *
+ * @returns A fresh string property builder.
+ */
 export declare const decoString: () => DecoString;
+/**
+ * Fluent builder for configuring string-type decorator properties.
+ *
+ * @remarks
+ * Supports length constraints, regex validation, default values, and key designation.
+ */
 export declare class DecoString extends DecoProperty<DecoStringData> {
+    /** Creates a new string property builder with default settings. */
     constructor();
+    /**
+     * Sets the default string value.
+     *
+     * @param val - The default value.
+     * @returns This instance for chaining.
+     */
     default(val: string): this;
+    /**
+     * Sets the minimum character length.
+     *
+     * @param val - Minimum number of characters.
+     * @returns This instance for chaining.
+     */
     minLength(val: number): this;
+    /**
+     * Sets the maximum character length.
+     *
+     * @param val - Maximum number of characters.
+     * @returns This instance for chaining.
+     */
     maxLength(val: number): this;
+    /**
+     * Sets the exact character length required.
+     *
+     * @param val - Required number of characters.
+     * @returns This instance for chaining.
+     */
     exactLength(val: number): this;
+    /**
+     * Sets a regular expression pattern the value must match.
+     *
+     * @param val - The regex pattern string.
+     * @returns This instance for chaining.
+     */
     regex(val: string): this;
+    /**
+     * Marks this string as the document key field.
+     *
+     * @param val - Whether this is a key field. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     key(val?: boolean): this;
 }
 //# sourceMappingURL=DecoString.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DecoString.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,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,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,eAAO,MAAM,UAAU,kBAAyB,CAAC;AAEjD,qBAAa,UAAW,SAAQ,YAAY,CAAC,cAAc,CAAC;;IAKnD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI1B,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI5B,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI5B,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI9B,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxB,GAAG,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;CAItC"}
+{"version":3,"file":"DecoString.d.ts","sourceRoot":"","sources":["../../src/decorator/DecoString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,kBAAyB,CAAC;AAEjD;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,YAAY,CAAC,cAAc,CAAC;IAC1D,mEAAmE;;IAKnE;;;;;OAKG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIjC;;;;;OAKG;IACI,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;OAKG;IACI,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIrC;;;;;OAKG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI/B;;;;;OAKG;IACI,GAAG,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI;CAItC"}

package/dist/decorator/DecoString.js

@@ -1,30 +1,78 @@
 import { DecoPropertyType } from "./deco.enum.js";
 import { DecoProperty } from "./DecoProperty.js";
+/**
+ * Factory function that creates a new {@link DecoString} instance.
+ *
+ * @returns A fresh string property builder.
+ */
 export const decoString = () => new DecoString();
+/**
+ * Fluent builder for configuring string-type decorator properties.
+ *
+ * @remarks
+ * Supports length constraints, regex validation, default values, and key designation.
+ */
 export class DecoString extends DecoProperty {
+    /** Creates a new string property builder with default settings. */
     constructor() {
         super(DecoPropertyType.string, {});
     }
+    /**
+     * Sets the default string value.
+     *
+     * @param val - The default value.
+     * @returns This instance for chaining.
+     */
     default(val) {
         this.data.default = val;
         return this;
     }
+    /**
+     * Sets the minimum character length.
+     *
+     * @param val - Minimum number of characters.
+     * @returns This instance for chaining.
+     */
     minLength(val) {
         this.data.minLength = val;
         return this;
     }
+    /**
+     * Sets the maximum character length.
+     *
+     * @param val - Maximum number of characters.
+     * @returns This instance for chaining.
+     */
     maxLength(val) {
         this.data.maxLength = val;
         return this;
     }
+    /**
+     * Sets the exact character length required.
+     *
+     * @param val - Required number of characters.
+     * @returns This instance for chaining.
+     */
     exactLength(val) {
         this.data.exactLength = val;
         return this;
     }
+    /**
+     * Sets a regular expression pattern the value must match.
+     *
+     * @param val - The regex pattern string.
+     * @returns This instance for chaining.
+     */
     regex(val) {
         this.data.regex = val;
         return this;
     }
+    /**
+     * Marks this string as the document key field.
+     *
+     * @param val - Whether this is a key field. Defaults to `true`.
+     * @returns This instance for chaining.
+     */
     key(val = true) {
         this.data.key = val;
         return this;

package/dist/decorator/DecoString.js.map

@@ -1 +1 @@
-{"version":3,"file":"DecoString.js","sourceRoot":"","sources":["../../src/decorator/DecoString.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAWjD,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;AAEjD,MAAM,OAAO,UAAW,SAAQ,YAA4B;IAC1D;QACE,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACxB,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,SAAS,CAAC,GAAW;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,WAAW,CAAC,GAAW;QAC5B,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,GAAG,CAAC,MAAe,IAAI;QAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"DecoString.js","sourceRoot":"","sources":["../../src/decorator/DecoString.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAoBjD;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,YAA4B;IAC1D,mEAAmE;IACnE;QACE,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACxB,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,SAAS,CAAC,GAAW;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,WAAW,CAAC,GAAW;QAC5B,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,GAAG,CAAC,MAAe,IAAI;QAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}