@antelopejs/interface-dms 0.9.1 → 0.10.1

package/dist/base/data-types/default/relations.d.ts

@@ -0,0 +1,267 @@
+/** Stable relation data types. @packageDocumentation */
+import type { ControllerClass } from "@antelopejs/interface-api";
+import { z } from "zod";
+import type { FormContainerPageTexts } from "../../table-view/options";
+import { DataType } from "../core";
+/** {@link FormComponents.RelationFilterBy}, `field` typed on the related row. */
+export interface RelationFilterBy<T extends ControllerClass> {
+    field: keyof InstanceType<T> & string;
+    from: string;
+}
+export declare class RelationType<T extends ControllerClass> extends DataType {
+    readonly options: {
+        placeholder?: string;
+        multiple?: boolean;
+        deselectable?: boolean;
+        dataApiController: T;
+        index?: string;
+        keyMapping?: {
+            label?: keyof InstanceType<T> & string;
+            value?: keyof InstanceType<T> & string;
+            avatar?: keyof InstanceType<T> & string;
+            disabled?: keyof InstanceType<T> & string;
+        };
+        fallback?: string;
+        /**
+         * Use the relation purely as a native FILTER, without resolving the
+         * related row into the `/list` output.
+         *
+         * By default a relation column applies a `Foreign(...)` join
+         * (see {@link decorateField}) so list rows carry the resolved related
+         * object (e.g. `{ name: "..." }`) instead of the raw foreign-key id.
+         * That join is right for grid/form display but wrong for a column that
+         * is only meant to drive the funnel filter on a read-only list: it
+         * rewrites the scalar id away and (because the join also rebuilds the
+         * list projection) can drop the row's own id key from the pluck.
+         *
+         * With `filterOnly: true` the join is skipped entirely. The column keeps
+         * its relation `compareModes` and `filterComponents` (the searchable
+         * relation picker in the funnel) and, when declared `filterable: true`,
+         * the backend `@Filter` still runs equality on the RAW scalar column —
+         * so the funnel filters correctly while `/list` rows keep the raw id
+         * under its key and keep the row id key (`_id`/`rowIdKey`) untouched.
+         *
+         * The backend filter operates on the stored scalar, which already holds
+         * exactly the value the relation picker emits (`keyMapping.value`, or
+         * the `index` value), so equality filtering stays correct without the
+         * join.
+         */
+        filterOnly?: boolean;
+        /**
+         * Title and description of the drawer the picker's "add" entry
+         * opens, e.g. "New user". `$`-prefixed: i18n keys. Default to "New
+         * entry".
+         */
+        addForm?: FormContainerPageTexts;
+        /**
+         * Lists only the related rows whose `field` equals the form's value
+         * of `from`, e.g. `{ field: "customer", from: "customer" }` for a
+         * ticket's site. `field` must be filterable on the related
+         * controller: declaring it otherwise throws at registration.
+         */
+        filterBy?: RelationFilterBy<T>;
+    };
+    constructor(options: {
+        placeholder?: string;
+        multiple?: boolean;
+        deselectable?: boolean;
+        dataApiController: T;
+        index?: string;
+        keyMapping?: {
+            label?: keyof InstanceType<T> & string;
+            value?: keyof InstanceType<T> & string;
+            avatar?: keyof InstanceType<T> & string;
+            disabled?: keyof InstanceType<T> & string;
+        };
+        fallback?: string;
+        /**
+         * Use the relation purely as a native FILTER, without resolving the
+         * related row into the `/list` output.
+         *
+         * By default a relation column applies a `Foreign(...)` join
+         * (see {@link decorateField}) so list rows carry the resolved related
+         * object (e.g. `{ name: "..." }`) instead of the raw foreign-key id.
+         * That join is right for grid/form display but wrong for a column that
+         * is only meant to drive the funnel filter on a read-only list: it
+         * rewrites the scalar id away and (because the join also rebuilds the
+         * list projection) can drop the row's own id key from the pluck.
+         *
+         * With `filterOnly: true` the join is skipped entirely. The column keeps
+         * its relation `compareModes` and `filterComponents` (the searchable
+         * relation picker in the funnel) and, when declared `filterable: true`,
+         * the backend `@Filter` still runs equality on the RAW scalar column —
+         * so the funnel filters correctly while `/list` rows keep the raw id
+         * under its key and keep the row id key (`_id`/`rowIdKey`) untouched.
+         *
+         * The backend filter operates on the stored scalar, which already holds
+         * exactly the value the relation picker emits (`keyMapping.value`, or
+         * the `index` value), so equality filtering stays correct without the
+         * join.
+         */
+        filterOnly?: boolean;
+        /**
+         * Title and description of the drawer the picker's "add" entry
+         * opens, e.g. "New user". `$`-prefixed: i18n keys. Default to "New
+         * entry".
+         */
+        addForm?: FormContainerPageTexts;
+        /**
+         * Lists only the related rows whose `field` equals the form's value
+         * of `from`, e.g. `{ field: "customer", from: "customer" }` for a
+         * ticket's site. `field` must be filterable on the related
+         * controller: declaring it otherwise throws at registration.
+         */
+        filterBy?: RelationFilterBy<T>;
+    });
+    protected defaultInputComponent(): import("../../..").ComponentInfoSerialized<{
+        placeholder: string | undefined;
+        multiple: boolean | undefined;
+        deselectable: boolean | undefined;
+        searchUrl: string;
+        keyMapping: {
+            label?: keyof InstanceType<T> & string;
+            value?: keyof InstanceType<T> & string;
+            avatar?: keyof InstanceType<T> & string;
+            disabled?: keyof InstanceType<T> & string;
+        } | undefined;
+        filterBy: RelationFilterBy<T> | undefined;
+        addForm: import("../../..").ComponentInfoSerialized<import("../..").FormPropsSerialized> | undefined;
+        addPermissionIds: string[] | undefined;
+        addFormTexts: FormContainerPageTexts | undefined;
+    }>;
+    filterComponents(): {
+        default: import("../../..").ComponentInfoSerialized<{
+            placeholder: string | undefined;
+            multiple: boolean | undefined;
+            deselectable: boolean | undefined;
+            searchUrl: string;
+            keyMapping: {
+                label?: keyof InstanceType<T> & string;
+                value?: keyof InstanceType<T> & string;
+                avatar?: keyof InstanceType<T> & string;
+                disabled?: keyof InstanceType<T> & string;
+            } | undefined;
+            filterBy: RelationFilterBy<T> | undefined;
+            addForm: import("../../..").ComponentInfoSerialized<import("../..").FormPropsSerialized> | undefined;
+            addPermissionIds: string[] | undefined;
+            addFormTexts: FormContainerPageTexts | undefined;
+        }>;
+    };
+    describedInputComponent(): import("../../..").ComponentInfoSerialized<{
+        placeholder: string | undefined;
+        multiple: boolean | undefined;
+        deselectable: boolean | undefined;
+        searchUrl: string;
+        keyMapping: {
+            label?: keyof InstanceType<T> & string;
+            value?: keyof InstanceType<T> & string;
+            avatar?: keyof InstanceType<T> & string;
+            disabled?: keyof InstanceType<T> & string;
+        } | undefined;
+        filterBy: RelationFilterBy<T> | undefined;
+        addForm: import("../../..").ComponentInfoSerialized<import("../..").FormPropsSerialized> | undefined;
+        addPermissionIds: string[] | undefined;
+        addFormTexts: FormContainerPageTexts | undefined;
+    }>;
+    private relationInput;
+    getValidation(): z.ZodType;
+    private assertFilterByFilterable;
+    decorateField(target: unknown, key: PropertyKey, descriptor?: PropertyDescriptor): void;
+}
+/**
+ * Relation to a self-referencing table rendered as a cascader.
+ *
+ * The target controller exposes a flat list through its `select` endpoint
+ * (the `parent` field of `keyMapping` must be decorated with `@Select()`);
+ * the widget rebuilds the tree client-side and displays the full path
+ * (e.g. `Electronics / Audio / Headphones`) in table cells.
+ */
+export declare class CascaderRelationType<T extends ControllerClass> extends DataType {
+    readonly options: {
+        placeholder?: string;
+        multiple?: boolean;
+        deselectable?: boolean;
+        dataApiController: T;
+        index?: string;
+        keyMapping: {
+            label: keyof InstanceType<T> & string;
+            value: keyof InstanceType<T> & string;
+            parent: keyof InstanceType<T> & string;
+            disabled?: keyof InstanceType<T> & string;
+        };
+        maxDepth?: number;
+        leafOnly?: boolean;
+        fallback?: string;
+        /**
+         * Use the cascader relation purely as a native FILTER, without
+         * resolving the related row into the `/list` output.
+         *
+         * @see RelationType `filterOnly` for the full rationale: the relation
+         * picker and the backend `@Filter` keep working on the raw scalar id,
+         * while the join (which would rewrite the value and can drop the row id
+         * key) is skipped.
+         */
+        filterOnly?: boolean;
+    };
+    constructor(options: {
+        placeholder?: string;
+        multiple?: boolean;
+        deselectable?: boolean;
+        dataApiController: T;
+        index?: string;
+        keyMapping: {
+            label: keyof InstanceType<T> & string;
+            value: keyof InstanceType<T> & string;
+            parent: keyof InstanceType<T> & string;
+            disabled?: keyof InstanceType<T> & string;
+        };
+        maxDepth?: number;
+        leafOnly?: boolean;
+        fallback?: string;
+        /**
+         * Use the cascader relation purely as a native FILTER, without
+         * resolving the related row into the `/list` output.
+         *
+         * @see RelationType `filterOnly` for the full rationale: the relation
+         * picker and the backend `@Filter` keep working on the raw scalar id,
+         * while the join (which would rewrite the value and can drop the row id
+         * key) is skipped.
+         */
+        filterOnly?: boolean;
+    });
+    protected defaultInputComponent(): import("../../..").ComponentInfoSerialized<{
+        placeholder: string | undefined;
+        multiple: boolean | undefined;
+        deselectable: boolean | undefined;
+        searchUrl: string;
+        keyMapping: {
+            label: keyof InstanceType<T> & string;
+            value: keyof InstanceType<T> & string;
+            parent: keyof InstanceType<T> & string;
+            disabled?: keyof InstanceType<T> & string;
+        };
+        maxDepth: number | undefined;
+        leafOnly: boolean | undefined;
+        fallback: string | undefined;
+    }>;
+    filterComponents(): {
+        default: import("../../..").ComponentInfoSerialized<{
+            placeholder: string | undefined;
+            multiple: boolean | undefined;
+            deselectable: boolean | undefined;
+            searchUrl: string;
+            keyMapping: {
+                label: keyof InstanceType<T> & string;
+                value: keyof InstanceType<T> & string;
+                parent: keyof InstanceType<T> & string;
+                disabled?: keyof InstanceType<T> & string;
+            };
+            maxDepth: number | undefined;
+            leafOnly: boolean | undefined;
+            fallback: string | undefined;
+        }>;
+    };
+    private cascaderInput;
+    getValidation(): z.ZodType;
+    decorateField(target: unknown, key: PropertyKey, descriptor?: PropertyDescriptor): void;
+}

package/dist/base/data-types/default/relations.js

@@ -0,0 +1,149 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CascaderRelationType = exports.RelationType = void 0;
+const interface_core_1 = require("@antelopejs/interface-core");
+const metadata_1 = require("@antelopejs/interface-data-api/metadata");
+const zod_1 = require("zod");
+const form_schema_1 = require("../../form-schema");
+const core_1 = require("../core");
+const compare_types_1 = require("../internal/compare-types");
+const relation_add_form_1 = require("../internal/relation-add-form");
+const relation_endpoints_1 = require("../internal/relation-endpoints");
+const compare_types_2 = require("../compare-types");
+function relationCompareModes(multiple) {
+    return [
+        multiple ? compare_types_2.DefaultDataCompareTypes.Include : compare_types_2.DefaultDataCompareTypes.Is,
+        multiple ? compare_types_2.DefaultDataCompareTypes.Exclude : compare_types_2.DefaultDataCompareTypes.IsNot,
+        compare_types_2.DefaultDataCompareTypes.IsEmpty,
+        compare_types_2.DefaultDataCompareTypes.IsNotEmpty,
+    ];
+}
+function relationDefaultCompareMode(multiple) {
+    return multiple
+        ? compare_types_2.DefaultDataCompareTypes.Include
+        : compare_types_2.DefaultDataCompareTypes.Is;
+}
+let RelationType = class RelationType extends core_1.DataType {
+    options;
+    constructor(options) {
+        super(relationCompareModes(options.multiple), relationDefaultCompareMode(options.multiple), options);
+        this.options = options;
+    }
+    defaultInputComponent() {
+        return this.relationInput(true, this.options.multiple);
+    }
+    filterComponents() {
+        return { default: this.relationInput(false, false) };
+    }
+    describedInputComponent() {
+        return this.relationInput(false, this.options.multiple);
+    }
+    relationInput(canAdd, multiple) {
+        const controller = this.options.dataApiController;
+        const addOptions = canAdd
+            ? (0, relation_add_form_1.buildOutsideCycle)(controller, () => (0, relation_endpoints_1.relationAddOptions)(controller))
+            : undefined;
+        return form_schema_1.FormComponents.InputRelation({
+            placeholder: this.options.placeholder,
+            multiple,
+            deselectable: this.options.deselectable,
+            searchUrl: (0, relation_endpoints_1.selectUrl)(controller),
+            keyMapping: this.options.keyMapping,
+            filterBy: this.options.filterBy,
+            addForm: addOptions?.addForm,
+            addPermissionIds: addOptions?.addPermissionIds,
+            addFormTexts: this.options.addForm,
+        });
+    }
+    getValidation() {
+        return this.options.multiple ? zod_1.z.array(zod_1.z.string()) : zod_1.z.string();
+    }
+    assertFilterByFilterable(key) {
+        const field = this.options.filterBy?.field;
+        if (!field)
+            return;
+        const { filters } = (0, interface_core_1.GetMetadata)(this.options.dataApiController, metadata_1.DataAPIMeta);
+        if (filters[field])
+            return;
+        throw new Error(`Relation "${String(key)}": filterBy.field "${field}" is not filterable on ${this.options.dataApiController.name}; declare it filterable: true there.`);
+    }
+    decorateField(
+    // oxlint-disable-next-line anti-slop/no-unknown-parameters -- Preserve DataType's decorator target contract.
+    target, key, descriptor) {
+        this.assertFilterByFilterable(key);
+        if (this.options.filterOnly) {
+            return;
+        }
+        const meta = (0, interface_core_1.GetMetadata)(this.options.dataApiController, metadata_1.DataAPIMeta);
+        (0, compare_types_1.absolutizeJoinedSchemas)(meta);
+        const { tableName, pluck } = meta;
+        (0, metadata_1.Foreign)(tableName, this.options.index, this.options.multiple, Array.from(pluck.select?.keys() || []), meta.schemaName, meta)(target, key, descriptor ?? {});
+    }
+};
+exports.RelationType = RelationType;
+exports.RelationType = RelationType = __decorate([
+    (0, core_1.RegisterDataType)("relation"),
+    __metadata("design:paramtypes", [Object])
+], RelationType);
+/**
+ * Relation to a self-referencing table rendered as a cascader.
+ *
+ * The target controller exposes a flat list through its `select` endpoint
+ * (the `parent` field of `keyMapping` must be decorated with `@Select()`);
+ * the widget rebuilds the tree client-side and displays the full path
+ * (e.g. `Electronics / Audio / Headphones`) in table cells.
+ */
+let CascaderRelationType = class CascaderRelationType extends core_1.DataType {
+    options;
+    constructor(options) {
+        super(relationCompareModes(options.multiple), relationDefaultCompareMode(options.multiple), options);
+        this.options = options;
+    }
+    defaultInputComponent() {
+        return this.cascaderInput(this.options.multiple);
+    }
+    filterComponents() {
+        return { default: this.cascaderInput(false) };
+    }
+    cascaderInput(multiple) {
+        return form_schema_1.FormComponents.InputCascader({
+            placeholder: this.options.placeholder,
+            multiple,
+            deselectable: this.options.deselectable,
+            searchUrl: (0, relation_endpoints_1.selectUrl)(this.options.dataApiController),
+            keyMapping: this.options.keyMapping,
+            maxDepth: this.options.maxDepth,
+            leafOnly: this.options.leafOnly,
+            fallback: this.options.fallback,
+        });
+    }
+    getValidation() {
+        return this.options.multiple ? zod_1.z.array(zod_1.z.string()) : zod_1.z.string();
+    }
+    decorateField(
+    // oxlint-disable-next-line anti-slop/no-unknown-parameters -- Preserve DataType's decorator target contract.
+    target, key, descriptor) {
+        if (this.options.filterOnly) {
+            return;
+        }
+        const meta = (0, interface_core_1.GetMetadata)(this.options.dataApiController, metadata_1.DataAPIMeta);
+        (0, compare_types_1.absolutizeJoinedSchemas)(meta);
+        const { tableName, pluck } = meta;
+        (0, metadata_1.Foreign)(tableName, this.options.index, this.options.multiple, Array.from(pluck.select?.keys() || []), meta.schemaName, meta)(target, key, descriptor ?? {});
+    }
+};
+exports.CascaderRelationType = CascaderRelationType;
+exports.CascaderRelationType = CascaderRelationType = __decorate([
+    (0, core_1.RegisterDataType)("cascader_relation"),
+    __metadata("design:paramtypes", [Object])
+], CascaderRelationType);
+//# sourceMappingURL=relations.js.map

package/dist/base/data-types/default/relations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relations.js","sourceRoot":"","sources":["../../../../src/base/data-types/default/relations.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,+DAAyD;AACzD,sEAA+E;AAC/E,6BAAwB;AACxB,mDAAmD;AAEnD,kCAAqD;AACrD,6DAAoE;AACpE,qEAAkE;AAClE,uEAA+E;AAC/E,oDAA2D;AAQ3D,SAAS,oBAAoB,CAAC,QAAkB;IAC9C,OAAO;QACL,QAAQ,CAAC,CAAC,CAAC,uCAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,uCAAuB,CAAC,EAAE;QACvE,QAAQ,CAAC,CAAC,CAAC,uCAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,uCAAuB,CAAC,KAAK;QAC1E,uCAAuB,CAAC,OAAO;QAC/B,uCAAuB,CAAC,UAAU;KACnC,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,QAAkB;IACpD,OAAO,QAAQ;QACb,CAAC,CAAC,uCAAuB,CAAC,OAAO;QACjC,CAAC,CAAC,uCAAuB,CAAC,EAAE,CAAC;AACjC,CAAC;AAGM,IAAM,YAAY,GAAlB,MAAM,YAAwC,SAAQ,eAAQ;IAEjD;IADlB,YACkB,OAmDf;QAED,KAAK,CACH,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,EACtC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,CAAC,EAC5C,OAAO,CACR,CAAC;QAzDc,YAAO,GAAP,OAAO,CAmDtB;IAOH,CAAC;IAES,qBAAqB;QAC7B,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAEQ,gBAAgB;QACvB,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;IACvD,CAAC;IAEM,uBAAuB;QAC5B,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEO,aAAa,CAAC,MAAe,EAAE,QAA6B;QAClE,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;QAClD,MAAM,UAAU,GAAG,MAAM;YACvB,CAAC,CAAC,IAAA,qCAAiB,EAAC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAA,uCAAkB,EAAC,UAAU,CAAC,CAAC;YACrE,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO,4BAAc,CAAC,aAAa,CAAC;YAClC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,QAAQ;YACR,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;YACvC,SAAS,EAAE,IAAA,8BAAS,EAAC,UAAU,CAAC;YAChC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;YACnC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;YAC/B,OAAO,EAAE,UAAU,EAAE,OAAO;YAC5B,gBAAgB,EAAE,UAAU,EAAE,gBAAgB;YAC9C,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;SACnC,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAClE,CAAC;IAEO,wBAAwB,CAAC,GAAgB;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC3C,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,4BAAW,EAC7B,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAC9B,sBAAW,CACZ,CAAC;QACF,IAAI,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO;QAC3B,MAAM,IAAI,KAAK,CACb,aAAa,MAAM,CAAC,GAAG,CAAC,sBAAsB,KAAK,0BAA0B,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,sCAAsC,CACvJ,CAAC;IACJ,CAAC;IAEM,aAAa;IAClB,6GAA6G;IAC7G,MAAe,EACf,GAAgB,EAChB,UAA+B;QAE/B,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,sBAAW,CAAC,CAAC;QACtE,IAAA,uCAAuB,EAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAClC,IAAA,kBAAO,EACL,SAAS,EACT,IAAI,CAAC,OAAO,CAAC,KAAK,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,EACrB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EACtC,IAAI,CAAC,UAAU,EACf,IAAI,CACL,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC;IACnC,CAAC;CACF,CAAA;AApIY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,uBAAgB,EAAC,UAAU,CAAC;;GAChB,YAAY,CAoIxB;AAED;;;;;;;GAOG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAgD,SAAQ,eAAQ;IAEzD;IADlB,YACkB,OAyBf;QAED,KAAK,CACH,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,EACtC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,CAAC,EAC5C,OAAO,CACR,CAAC;QA/Bc,YAAO,GAAP,OAAO,CAyBtB;IAOH,CAAC;IAES,qBAAqB;QAC7B,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEQ,gBAAgB;QACvB,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;IAChD,CAAC;IAEO,aAAa,CAAC,QAA6B;QACjD,OAAO,4BAAc,CAAC,aAAa,CAAC;YAClC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,QAAQ;YACR,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;YACvC,SAAS,EAAE,IAAA,8BAAS,EAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACpD,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;YACnC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;YAC/B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;YAC/B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;SAChC,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAClE,CAAC;IAEM,aAAa;IAClB,6GAA6G;IAC7G,MAAe,EACf,GAAgB,EAChB,UAA+B;QAE/B,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,sBAAW,CAAC,CAAC;QACtE,IAAA,uCAAuB,EAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAClC,IAAA,kBAAO,EACL,SAAS,EACT,IAAI,CAAC,OAAO,CAAC,KAAK,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,EACrB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EACtC,IAAI,CAAC,UAAU,EACf,IAAI,CACL,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC;IACnC,CAAC;CACF,CAAA;AAlFY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,uBAAgB,EAAC,mBAAmB,CAAC;;GACzB,oBAAoB,CAkFhC"}

package/dist/base/data-types/default/strings.d.ts

@@ -0,0 +1,35 @@
+/** Stable formatted-string data types. @packageDocumentation */
+import { z } from "zod";
+import { FormComponents } from "../../form-schema";
+import { DataType } from "../core";
+import { EmailTypeOptions, ColorTypeOptions, PasswordTypeOptions, UrlTypeOptions, PhoneTypeOptions } from "./options";
+export declare class EmailType extends DataType {
+    readonly options: EmailTypeOptions;
+    constructor(options?: EmailTypeOptions);
+    protected defaultInputComponent(): import("../../..").ComponentInfoSerialized<FormComponents.InputEmailOptions>;
+    getValidation(): z.ZodString;
+}
+export declare class ColorType extends DataType {
+    readonly options: ColorTypeOptions;
+    constructor(options?: ColorTypeOptions);
+    protected defaultInputComponent(): import("../../..").ComponentInfoSerialized<FormComponents.InputColorOptions>;
+    getValidation(): z.ZodString;
+}
+export declare class PasswordType extends DataType {
+    readonly options: PasswordTypeOptions;
+    constructor(options?: PasswordTypeOptions);
+    protected defaultInputComponent(): import("../../..").ComponentInfoSerialized<FormComponents.InputPasswordOptions>;
+    getValidation(): z.ZodString;
+}
+export declare class UrlType extends DataType {
+    readonly options: UrlTypeOptions;
+    constructor(options?: UrlTypeOptions);
+    protected defaultInputComponent(): import("../../..").ComponentInfoSerialized<FormComponents.InputTextOptions>;
+    getValidation(): z.ZodString;
+}
+export declare class PhoneType extends DataType {
+    readonly options: PhoneTypeOptions;
+    constructor(options?: PhoneTypeOptions);
+    protected defaultInputComponent(): import("../../..").ComponentInfoSerialized<FormComponents.InputPhoneOptions>;
+    getValidation(): z.ZodString;
+}

package/dist/base/data-types/default/strings.js

@@ -0,0 +1,154 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhoneType = exports.UrlType = exports.PasswordType = exports.ColorType = exports.EmailType = void 0;
+/** Stable formatted-string data types. @packageDocumentation */
+const zod_1 = require("zod");
+const form_schema_1 = require("../../form-schema");
+const core_1 = require("../core");
+const compare_types_1 = require("../compare-types");
+let EmailType = class EmailType extends core_1.DataType {
+    options;
+    constructor(options = {}) {
+        super([
+            compare_types_1.DefaultDataCompareTypes.Is,
+            compare_types_1.DefaultDataCompareTypes.IsNot,
+            compare_types_1.DefaultDataCompareTypes.Contains,
+            compare_types_1.DefaultDataCompareTypes.NotContains,
+            compare_types_1.DefaultDataCompareTypes.IsEmpty,
+            compare_types_1.DefaultDataCompareTypes.IsNotEmpty,
+        ], compare_types_1.DefaultDataCompareTypes.Contains, options);
+        this.options = options;
+    }
+    defaultInputComponent() {
+        return form_schema_1.FormComponents.InputEmail({
+            placeholder: this.options.placeholder,
+        });
+    }
+    getValidation() {
+        return zod_1.z.string().email();
+    }
+};
+exports.EmailType = EmailType;
+exports.EmailType = EmailType = __decorate([
+    (0, core_1.RegisterDataType)("email"),
+    __metadata("design:paramtypes", [Object])
+], EmailType);
+let ColorType = class ColorType extends core_1.DataType {
+    options;
+    constructor(options = {}) {
+        super([
+            compare_types_1.DefaultDataCompareTypes.Is,
+            compare_types_1.DefaultDataCompareTypes.IsNot,
+            compare_types_1.DefaultDataCompareTypes.IsEmpty,
+            compare_types_1.DefaultDataCompareTypes.IsNotEmpty,
+        ], compare_types_1.DefaultDataCompareTypes.Is, options);
+        this.options = options;
+    }
+    defaultInputComponent() {
+        return form_schema_1.FormComponents.InputColor({
+            placeholder: this.options.placeholder,
+        });
+    }
+    getValidation() {
+        return zod_1.z.string().regex(/^#[0-9a-fA-F]{6}$/);
+    }
+};
+exports.ColorType = ColorType;
+exports.ColorType = ColorType = __decorate([
+    (0, core_1.RegisterDataType)("color"),
+    __metadata("design:paramtypes", [Object])
+], ColorType);
+let PasswordType = class PasswordType extends core_1.DataType {
+    options;
+    constructor(options = {}) {
+        super([], undefined, options);
+        this.options = options;
+    }
+    defaultInputComponent() {
+        return form_schema_1.FormComponents.InputPassword({
+            placeholder: this.options.placeholder,
+            minLength: this.options.minLength,
+            confirmPassword: this.options.confirmPassword,
+            confirmPlaceholder: this.options.confirmPlaceholder,
+        });
+    }
+    getValidation() {
+        let schema = zod_1.z.string();
+        if (this.options.minLength !== undefined) {
+            schema = schema.min(this.options.minLength);
+        }
+        return schema;
+    }
+};
+exports.PasswordType = PasswordType;
+exports.PasswordType = PasswordType = __decorate([
+    (0, core_1.RegisterDataType)("password"),
+    __metadata("design:paramtypes", [Object])
+], PasswordType);
+let UrlType = class UrlType extends core_1.DataType {
+    options;
+    constructor(options = {}) {
+        super([
+            compare_types_1.DefaultDataCompareTypes.Is,
+            compare_types_1.DefaultDataCompareTypes.IsNot,
+            compare_types_1.DefaultDataCompareTypes.IsEmpty,
+            compare_types_1.DefaultDataCompareTypes.IsNotEmpty,
+        ], compare_types_1.DefaultDataCompareTypes.Is, options);
+        this.options = options;
+    }
+    defaultInputComponent() {
+        return form_schema_1.FormComponents.InputText({
+            placeholder: this.options.placeholder,
+            preview: this.options.preview,
+        });
+    }
+    getValidation() {
+        return zod_1.z.string().url();
+    }
+};
+exports.UrlType = UrlType;
+exports.UrlType = UrlType = __decorate([
+    (0, core_1.RegisterDataType)("url"),
+    __metadata("design:paramtypes", [Object])
+], UrlType);
+let PhoneType = class PhoneType extends core_1.DataType {
+    options;
+    constructor(options = {}) {
+        super([
+            compare_types_1.DefaultDataCompareTypes.Is,
+            compare_types_1.DefaultDataCompareTypes.IsNot,
+            compare_types_1.DefaultDataCompareTypes.Contains,
+            compare_types_1.DefaultDataCompareTypes.NotContains,
+            compare_types_1.DefaultDataCompareTypes.IsEmpty,
+            compare_types_1.DefaultDataCompareTypes.IsNotEmpty,
+        ], compare_types_1.DefaultDataCompareTypes.Contains, options);
+        this.options = options;
+    }
+    defaultInputComponent() {
+        return form_schema_1.FormComponents.InputPhone({
+            placeholder: this.options.placeholder,
+            requiredPrefix: this.options.requiredPrefix,
+        });
+    }
+    getValidation() {
+        if (this.options.requiredPrefix) {
+            return zod_1.z.string().regex(/^\+[1-9]\d{1,14}$/);
+        }
+        return zod_1.z.string();
+    }
+};
+exports.PhoneType = PhoneType;
+exports.PhoneType = PhoneType = __decorate([
+    (0, core_1.RegisterDataType)("phone"),
+    __metadata("design:paramtypes", [Object])
+], PhoneType);
+//# sourceMappingURL=strings.js.map

package/dist/base/data-types/default/strings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings.js","sourceRoot":"","sources":["../../../../src/base/data-types/default/strings.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gEAAgE;AAChE,6BAAwB;AACxB,mDAAmD;AACnD,kCAAqD;AACrD,oDAA2D;AAUpD,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,eAAQ;IACT;IAA5B,YAA4B,UAA4B,EAAE;QACxD,KAAK,CACH;YACE,uCAAuB,CAAC,EAAE;YAC1B,uCAAuB,CAAC,KAAK;YAC7B,uCAAuB,CAAC,QAAQ;YAChC,uCAAuB,CAAC,WAAW;YACnC,uCAAuB,CAAC,OAAO;YAC/B,uCAAuB,CAAC,UAAU;SACnC,EACD,uCAAuB,CAAC,QAAQ,EAChC,OAAO,CACR,CAAC;QAZwB,YAAO,GAAP,OAAO,CAAuB;IAa1D,CAAC;IAES,qBAAqB;QAC7B,OAAO,4BAAc,CAAC,UAAU,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;SACtC,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,OAAO,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;CACF,CAAA;AAzBY,8BAAS;oBAAT,SAAS;IADrB,IAAA,uBAAgB,EAAC,OAAO,CAAC;;GACb,SAAS,CAyBrB;AAGM,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,eAAQ;IACT;IAA5B,YAA4B,UAA4B,EAAE;QACxD,KAAK,CACH;YACE,uCAAuB,CAAC,EAAE;YAC1B,uCAAuB,CAAC,KAAK;YAC7B,uCAAuB,CAAC,OAAO;YAC/B,uCAAuB,CAAC,UAAU;SACnC,EACD,uCAAuB,CAAC,EAAE,EAC1B,OAAO,CACR,CAAC;QAVwB,YAAO,GAAP,OAAO,CAAuB;IAW1D,CAAC;IAES,qBAAqB;QAC7B,OAAO,4BAAc,CAAC,UAAU,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;SACtC,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,OAAO,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC/C,CAAC;CACF,CAAA;AAvBY,8BAAS;oBAAT,SAAS;IADrB,IAAA,uBAAgB,EAAC,OAAO,CAAC;;GACb,SAAS,CAuBrB;AAGM,IAAM,YAAY,GAAlB,MAAM,YAAa,SAAQ,eAAQ;IACZ;IAA5B,YAA4B,UAA+B,EAAE;QAC3D,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QADJ,YAAO,GAAP,OAAO,CAA0B;IAE7D,CAAC;IAES,qBAAqB;QAC7B,OAAO,4BAAc,CAAC,aAAa,CAAC;YAClC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;YACjC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;YAC7C,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB;SACpD,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,IAAI,MAAM,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC;QAExB,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AAvBY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,uBAAgB,EAAC,UAAU,CAAC;;GAChB,YAAY,CAuBxB;AAGM,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,eAAQ;IACP;IAA5B,YAA4B,UAA0B,EAAE;QACtD,KAAK,CACH;YACE,uCAAuB,CAAC,EAAE;YAC1B,uCAAuB,CAAC,KAAK;YAC7B,uCAAuB,CAAC,OAAO;YAC/B,uCAAuB,CAAC,UAAU;SACnC,EACD,uCAAuB,CAAC,EAAE,EAC1B,OAAO,CACR,CAAC;QAVwB,YAAO,GAAP,OAAO,CAAqB;IAWxD,CAAC;IAES,qBAAqB;QAC7B,OAAO,4BAAc,CAAC,SAAS,CAAC;YAC9B,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;SAC9B,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,OAAO,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;IAC1B,CAAC;CACF,CAAA;AAxBY,0BAAO;kBAAP,OAAO;IADnB,IAAA,uBAAgB,EAAC,KAAK,CAAC;;GACX,OAAO,CAwBnB;AAGM,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,eAAQ;IACT;IAA5B,YAA4B,UAA4B,EAAE;QACxD,KAAK,CACH;YACE,uCAAuB,CAAC,EAAE;YAC1B,uCAAuB,CAAC,KAAK;YAC7B,uCAAuB,CAAC,QAAQ;YAChC,uCAAuB,CAAC,WAAW;YACnC,uCAAuB,CAAC,OAAO;YAC/B,uCAAuB,CAAC,UAAU;SACnC,EACD,uCAAuB,CAAC,QAAQ,EAChC,OAAO,CACR,CAAC;QAZwB,YAAO,GAAP,OAAO,CAAuB;IAa1D,CAAC;IAES,qBAAqB;QAC7B,OAAO,4BAAc,CAAC,UAAU,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;SAC5C,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAChC,OAAO,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,OAAC,CAAC,MAAM,EAAE,CAAC;IACpB,CAAC;CACF,CAAA;AA9BY,8BAAS;oBAAT,SAAS;IADrB,IAAA,uBAAgB,EAAC,OAAO,CAAC;;GACb,SAAS,CA8BrB"}