@dativa-lv/lx-builders 2.1.10 → 2.2.2

package/README.md

@@ -1,3 +1,76 @@
+<h1 align="center">lx/builders</h1>
+
+<p align="center">
+ Declarative <strong>Vue.js 3</strong> tools that transform schemas and configuration into consistent, production-ready user interfaces <a href="https://github.com/dativa-lv/lx-ui">powered by <strong>LX/UI</strong></a>.
+</p>
+<p align="center">
+    JSON Schema in. LX/UI view out.
+</p>
+
+<p align="center">
+    <img alt="NPM Downloads" src="https://img.shields.io/npm/dw/%40dativa-lv%2Flx-builders?color=green" />
+    <img alt="NPM Version" src="https://img.shields.io/npm/v/%40dativa-lv%2Flx-builders?color=green" />
+    <img alt="NPM License" src="https://img.shields.io/npm/l/%40dativa-lv%2Flx-builders?color=white" />
+    <a href="https://github.com/dativa-lv/lx-ui"><img alt="Powered by LX/UI" src="https://img.shields.io/badge/powered%20by-lx%2Fui-0960BC"/></a>
+</p>
+
+<p align="center">
+ <img src="https://img.shields.io/github/package-json/dependency-version/dativa-lv/lx-builders/peer/@dativa-lv/lx-ui" alt="LX/UI Version" />
+  <img src="https://img.shields.io/github/package-json/dependency-version/dativa-lv/lx-ui/peer/vue" alt="Vue.js Version" />
+  <img src="https://img.shields.io/github/package-json/dependency-version/dativa-lv/lx-ui/dev/vite" alt="Vite Version" />
+  <img src="https://img.shields.io/github/package-json/packageManager/dativa-lv/lx-builders?label=package%20manager" alt="Package Manager" />
+</p>
+
 ![lx/builders](https://raw.githubusercontent.com/dativa-lv/lx-builders/main/public/imgs/cover.png)
 
-# lx/builders
+## Play around
+
+Check out our [🌐&nbsp;Form Builder Demo](https://lx-ui.dev/resources/forms/builder) or try the <a href="https://lx-ui.dev/resources/constructor-dashboard">🛠️&nbsp;LxConstructor<sup>(beta)</sup></a> live.
+
+## Design with
+- <a href="https://json-schema.org">🌐&nbsp;JSON Schema</a>
+- <a href="/docs/Constructor.md">ℹ️&nbsp;LxConstructor<sup>(beta)</sup></a>
+
+## Render with
+- <a href="/docs/ViewBuilder.md">ℹ️&nbsp;LxViewBuilder</a>
+- <a href="/docs/FormBuilder.md">ℹ️&nbsp;LxFormBuilder</a>
+- ℹ️&nbsp;LxFilterBuilder
+
+## Get
+
+Get using bun:
+```bash
+bun add '@dativa-lv/lx-builders@latest'
+```
+
+Get using pnpm:
+```bash
+pnpm i '@dativa-lv/lx-builders@latest'
+```
+
+For migration tips refer to [ℹ️&nbsp;Migration Guide](https://github.com/dativa-lv/lx-builders/blob/main/MIGRATION.md)
+
+## Use
+
+Use together with lx/ui library:
+```js
+import { createPinia } from 'pinia';
+import { createLx } from '@dativa-lv/lx-ui';
+import { createLxBuilders } from '@dativa-lv/lx-builders';
+import App from '@/App.vue';
+…
+const myApp = createApp(App);
+myApp.use(createPinia());
+myApp.use(createLx());
+myApp.use(createLxBuilders());
+…
+```
+
+## Develop
+
+```bash
+pnpm i
+pnpm build
+```
+
+Read more about development in [ℹ️&nbsp;Development manual](https://github.com/dativa-lv/lx-builders/blob/main/DEVELOPMENT.md)

package/dist/src/App.vue.d.ts

@@ -0,0 +1,3 @@
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/src/components/AppendableListSimple.vue.d.ts

@@ -1,5 +1,10 @@
 import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
-declare const _default: __VLS_WithTemplateSlots<DefineComponent<{}, {
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & (new () => {
+    $slots: S;
+});
+declare const __VLS_component: DefineComponent<{}, {
     $emit: (event: "update:modelValue", ...args: any[]) => void;
     readOnly: boolean;
     columnCount: number;
@@ -17,13 +22,15 @@ declare const _default: __VLS_WithTemplateSlots<DefineComponent<{}, {
         readonly texts?: Record<string, any>;
         readonly modelValue?: unknown[];
     };
-}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>, {
-    customItem?(_: {
-        item: unknown;
-        index: number;
-    }): any;
-}>;
-export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & (new () => {
-    $slots: S;
-});
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, HTMLDivElement>;
+type __VLS_TemplateResult = {
+    attrs: Partial<{}>;
+    slots: {
+        customItem?(_: {
+            item: unknown;
+            index: number;
+        }): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};

package/dist/src/components/FilterBuilder.vue.d.ts

@@ -1,4 +1,5 @@
-import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions, ComponentInternalInstance, VNodeProps, AllowedComponentProps, ComponentCustomProps, Attrs, Slot, ComponentPublicInstance, ComponentOptionsBase, GlobalComponents, GlobalDirectives, DebuggerEvent, nextTick, WatchOptions, WatchStopHandle, ComponentCustomProperties, ShallowUnwrapRef, CreateComponentPublicInstanceWithMixins } from 'vue';
+import { OnCleanup } from '@vue/reactivity';
 declare const _default: DefineComponent<{}, {
     validateModel: typeof validateModel;
     clearValidations: typeof clearValidations;
@@ -6,7 +7,346 @@ declare const _default: DefineComponent<{}, {
     $props: {
         readonly [x: string]: any;
     };
-}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {
+    filterElement: {
+        $: ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{}> & Omit<{} & VNodeProps & AllowedComponentProps & ComponentCustomProps, never>;
+        $attrs: {
+            [x: string]: unknown;
+        };
+        $refs: {
+            [x: string]: unknown;
+        } & {
+            expander: {
+                $: ComponentInternalInstance;
+                $data: {};
+                $props: Partial<{}> & Omit<{} & VNodeProps & AllowedComponentProps & ComponentCustomProps, never>;
+                $attrs: Attrs;
+                $refs: {
+                    [x: string]: unknown;
+                } & {
+                    expanderHeader: HTMLElement;
+                };
+                $slots: Readonly<{
+                    [name: string]: Slot<any>;
+                }>;
+                $root: ComponentPublicInstance | null;
+                $parent: ComponentPublicInstance | null;
+                $host: Element | null;
+                $emit: (event: string, ...args: any[]) => void;
+                $el: HTMLDivElement;
+                $options: ComponentOptionsBase<Readonly<{}> & Readonly<{}>, {
+                    focus: () => void;
+                    $emit: (event: "update:modelValue" | "selectAll" | "resetFilters", ...args: any[]) => void;
+                    invalid: boolean;
+                    iconSet: string;
+                    variant: string;
+                    customClass: string;
+                    texts: Record<string, any>;
+                    id: string;
+                    modelValue: boolean;
+                    kind: string;
+                    disabled: boolean;
+                    badge: string;
+                    badgeType: string;
+                    region: boolean;
+                    renderMode: string;
+                    hasShortlistReset: boolean;
+                    hasSelectButton: boolean;
+                    selectStatus: string;
+                    label?: string;
+                    description?: string;
+                    icon?: string;
+                    tooltip?: string;
+                    ariaLabel?: string;
+                    badgeIcon?: string;
+                    badgeTitle?: string;
+                    invalidationMessage?: string;
+                    $props: {
+                        readonly invalid?: boolean;
+                        readonly iconSet?: string;
+                        readonly variant?: string;
+                        readonly customClass?: string;
+                        readonly texts?: Record<string, any>;
+                        readonly id?: string;
+                        readonly modelValue?: boolean;
+                        readonly kind?: string;
+                        readonly disabled?: boolean;
+                        readonly badge?: string;
+                        readonly badgeType?: string;
+                        readonly region?: boolean;
+                        readonly renderMode?: string;
+                        readonly hasShortlistReset?: boolean;
+                        readonly hasSelectButton?: boolean;
+                        readonly selectStatus?: string;
+                        readonly label?: string;
+                        readonly description?: string;
+                        readonly icon?: string;
+                        readonly tooltip?: string;
+                        readonly ariaLabel?: string;
+                        readonly badgeIcon?: string;
+                        readonly badgeTitle?: string;
+                        readonly invalidationMessage?: string;
+                    };
+                }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {}, {}, string, {}, GlobalComponents, GlobalDirectives, string, ComponentProvideOptions> & {
+                    beforeCreate?: (() => void) | (() => void)[];
+                    created?: (() => void) | (() => void)[];
+                    beforeMount?: (() => void) | (() => void)[];
+                    mounted?: (() => void) | (() => void)[];
+                    beforeUpdate?: (() => void) | (() => void)[];
+                    updated?: (() => void) | (() => void)[];
+                    activated?: (() => void) | (() => void)[];
+                    deactivated?: (() => void) | (() => void)[];
+                    beforeDestroy?: (() => void) | (() => void)[];
+                    beforeUnmount?: (() => void) | (() => void)[];
+                    destroyed?: (() => void) | (() => void)[];
+                    unmounted?: (() => void) | (() => void)[];
+                    renderTracked?: ((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[];
+                    renderTriggered?: ((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[];
+                    errorCaptured?: ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void)[];
+                };
+                $forceUpdate: () => void;
+                $nextTick: nextTick;
+                $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, OnCleanup]) => any : (...args: [any, any, OnCleanup]) => any, options?: WatchOptions): WatchStopHandle;
+            } & Readonly<{}> & Omit<Readonly<{}> & Readonly<{}>, "focus" | "invalid" | "$props" | "$emit" | "label" | "iconSet" | "variant" | "customClass" | "texts" | "id" | "modelValue" | "kind" | "description" | "icon" | "tooltip" | "disabled" | "ariaLabel" | "badge" | "badgeIcon" | "badgeType" | "badgeTitle" | "invalidationMessage" | "region" | "renderMode" | "hasShortlistReset" | "hasSelectButton" | "selectStatus"> & {
+                focus: () => void;
+                $emit: (event: "update:modelValue" | "selectAll" | "resetFilters", ...args: any[]) => void;
+                invalid: boolean;
+                iconSet: string;
+                variant: string;
+                customClass: string;
+                texts: Record<string, any>;
+                id: string;
+                modelValue: boolean;
+                kind: string;
+                disabled: boolean;
+                badge: string;
+                badgeType: string;
+                region: boolean;
+                renderMode: string;
+                hasShortlistReset: boolean;
+                hasSelectButton: boolean;
+                selectStatus: string;
+                label?: string;
+                description?: string;
+                icon?: string;
+                tooltip?: string;
+                ariaLabel?: string;
+                badgeIcon?: string;
+                badgeTitle?: string;
+                invalidationMessage?: string;
+                $props: {
+                    readonly invalid?: boolean;
+                    readonly iconSet?: string;
+                    readonly variant?: string;
+                    readonly customClass?: string;
+                    readonly texts?: Record<string, any>;
+                    readonly id?: string;
+                    readonly modelValue?: boolean;
+                    readonly kind?: string;
+                    readonly disabled?: boolean;
+                    readonly badge?: string;
+                    readonly badgeType?: string;
+                    readonly region?: boolean;
+                    readonly renderMode?: string;
+                    readonly hasShortlistReset?: boolean;
+                    readonly hasSelectButton?: boolean;
+                    readonly selectStatus?: string;
+                    readonly label?: string;
+                    readonly description?: string;
+                    readonly icon?: string;
+                    readonly tooltip?: string;
+                    readonly ariaLabel?: string;
+                    readonly badgeIcon?: string;
+                    readonly badgeTitle?: string;
+                    readonly invalidationMessage?: string;
+                };
+            } & {} & ComponentCustomProperties & {} & {
+                $slots: {
+                    customHeader?(_: {
+                        invalid: boolean;
+                        iconSet: string;
+                        variant: string;
+                        customClass: string;
+                        texts: Record<string, any>;
+                        id: string;
+                        modelValue: boolean;
+                        kind: string;
+                        disabled: boolean;
+                        badge: string;
+                        badgeType: string;
+                        region: boolean;
+                        renderMode: string;
+                        hasShortlistReset: boolean;
+                        hasSelectButton: boolean;
+                        selectStatus: string;
+                        label?: string;
+                        description?: string;
+                        icon?: string;
+                        tooltip?: string;
+                        ariaLabel?: string;
+                        badgeIcon?: string;
+                        badgeTitle?: string;
+                        invalidationMessage?: string;
+                    }): any;
+                    additionalInfo?(_: {}): any;
+                    default?(_: {}): any;
+                };
+            };
+            filterBody: HTMLDivElement;
+        };
+        $slots: Readonly<{
+            [name: string]: Slot<any>;
+        }>;
+        $root: ComponentPublicInstance | null;
+        $parent: ComponentPublicInstance | null;
+        $host: Element | null;
+        $emit: (event: string, ...args: any[]) => void;
+        $el: HTMLDivElement;
+        $options: ComponentOptionsBase<Readonly<{}>, {
+            toggleExpander: (value?: any) => void;
+            focus: () => void;
+            $emit: (event: "filter" | "resetFilters" | "update:expanded" | "fastFilterClick" | "saveFilter" | "editFilter", ...args: any[]) => void;
+            texts: Record<string, any>;
+            disabled: boolean;
+            badge: string;
+            badgeType: string;
+            builderOptions: Record<string, any>;
+            hasShortlistReset: boolean;
+            expanded: boolean;
+            columnCount: number;
+            usesFilters: boolean;
+            filterButtonKind: string;
+            fastFilters: unknown[];
+            enableFilterEditing: boolean;
+            fastIdAttribute: string;
+            fastNameAttribute: string;
+            shortlistColumnCount: number;
+            label?: string;
+            id?: string;
+            description?: string;
+            badgeIcon?: string;
+            badgeTitle?: string;
+            $props: {
+                readonly texts?: Record<string, any>;
+                readonly disabled?: boolean;
+                readonly badge?: string;
+                readonly badgeType?: string;
+                readonly builderOptions?: Record<string, any>;
+                readonly hasShortlistReset?: boolean;
+                readonly expanded?: boolean;
+                readonly columnCount?: number;
+                readonly usesFilters?: boolean;
+                readonly filterButtonKind?: string;
+                readonly fastFilters?: unknown[];
+                readonly enableFilterEditing?: boolean;
+                readonly fastIdAttribute?: string;
+                readonly fastNameAttribute?: string;
+                readonly shortlistColumnCount?: number;
+                readonly label?: string;
+                readonly id?: string;
+                readonly description?: string;
+                readonly badgeIcon?: string;
+                readonly badgeTitle?: string;
+            };
+        }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {}, {}, string, {}, GlobalComponents, GlobalDirectives, string, ComponentProvideOptions> & {
+            beforeCreate?: (() => void) | (() => void)[];
+            created?: (() => void) | (() => void)[];
+            beforeMount?: (() => void) | (() => void)[];
+            mounted?: (() => void) | (() => void)[];
+            beforeUpdate?: (() => void) | (() => void)[];
+            updated?: (() => void) | (() => void)[];
+            activated?: (() => void) | (() => void)[];
+            deactivated?: (() => void) | (() => void)[];
+            beforeDestroy?: (() => void) | (() => void)[];
+            beforeUnmount?: (() => void) | (() => void)[];
+            destroyed?: (() => void) | (() => void)[];
+            unmounted?: (() => void) | (() => void)[];
+            renderTracked?: ((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[];
+            renderTriggered?: ((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[];
+            errorCaptured?: ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void)[];
+        };
+        $forceUpdate: () => void;
+        $nextTick: nextTick;
+        $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, OnCleanup]) => any : (...args: [any, any, OnCleanup]) => any, options?: WatchOptions): WatchStopHandle;
+    } & Readonly<{}> & Omit<Readonly<{}>, "focus" | "$props" | "$emit" | "columnCount" | "texts" | "id" | "builderOptions" | "label" | "disabled" | "badge" | "badgeType" | "badgeIcon" | "badgeTitle" | "description" | "usesFilters" | "filterButtonKind" | "expanded" | "fastFilters" | "fastIdAttribute" | "fastNameAttribute" | "hasShortlistReset" | "toggleExpander" | "enableFilterEditing" | "shortlistColumnCount"> & ShallowUnwrapRef<{
+        toggleExpander: (value?: any) => void;
+        focus: () => void;
+        $emit: (event: "filter" | "resetFilters" | "update:expanded" | "fastFilterClick" | "saveFilter" | "editFilter", ...args: any[]) => void;
+        texts: Record<string, any>;
+        disabled: boolean;
+        badge: string;
+        badgeType: string;
+        builderOptions: Record<string, any>;
+        hasShortlistReset: boolean;
+        expanded: boolean;
+        columnCount: number;
+        usesFilters: boolean;
+        filterButtonKind: string;
+        fastFilters: unknown[];
+        enableFilterEditing: boolean;
+        fastIdAttribute: string;
+        fastNameAttribute: string;
+        shortlistColumnCount: number;
+        label?: string;
+        id?: string;
+        description?: string;
+        badgeIcon?: string;
+        badgeTitle?: string;
+        $props: {
+            readonly texts?: Record<string, any>;
+            readonly disabled?: boolean;
+            readonly badge?: string;
+            readonly badgeType?: string;
+            readonly builderOptions?: Record<string, any>;
+            readonly hasShortlistReset?: boolean;
+            readonly expanded?: boolean;
+            readonly columnCount?: number;
+            readonly usesFilters?: boolean;
+            readonly filterButtonKind?: string;
+            readonly fastFilters?: unknown[];
+            readonly enableFilterEditing?: boolean;
+            readonly fastIdAttribute?: string;
+            readonly fastNameAttribute?: string;
+            readonly shortlistColumnCount?: number;
+            readonly label?: string;
+            readonly id?: string;
+            readonly description?: string;
+            readonly badgeIcon?: string;
+            readonly badgeTitle?: string;
+        };
+    }> & {} & ComponentCustomProperties & {} & {
+        $slots: {
+            default?(_: {}): any;
+            shortlist?(_: {}): any;
+        };
+    };
+    formBuilder: CreateComponentPublicInstanceWithMixins<Readonly<{}> & Readonly<{}>, {
+        validateModel: () => any[];
+        clearValidations: () => void;
+        componentSelect: (row: any, name: any) => string;
+        $emit: (event: "update:modelValue" | "rowActionClick" | "emit" | "filterBuilderFilter", ...args: any[]) => void;
+        $props: {
+            readonly [x: string]: any;
+        };
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {}, true, {}, {}, GlobalComponents, GlobalDirectives, string, {}, any, ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{}> & Readonly<{}>, {
+        validateModel: () => any[];
+        clearValidations: () => void;
+        componentSelect: (row: any, name: any) => string;
+        $emit: (event: "update:modelValue" | "rowActionClick" | "emit" | "filterBuilderFilter", ...args: any[]) => void;
+        $props: {
+            readonly [x: string]: any;
+        };
+    }, {}, {}, {}, {}>;
+}, HTMLDivElement>;
 export default _default;
 declare function validateModel(): any;
 declare function clearValidations(): void;

package/dist/src/components/FormBuilder.vue.d.ts

@@ -3,7 +3,7 @@ declare const _default: DefineComponent<{}, {
     validateModel: typeof validateModel;
     clearValidations: typeof clearValidations;
     componentSelect: typeof componentSelect;
-    $emit: (event: "emit" | "update:modelValue" | "rowActionClick" | "filterBuilderFilter", ...args: any[]) => void;
+    $emit: (event: "update:modelValue" | "rowActionClick" | "emit" | "filterBuilderFilter", ...args: any[]) => void;
     $props: {
         readonly [x: string]: any;
     };

package/dist/src/components/FormBuilderItem.vue.d.ts

@@ -1,6 +1,6 @@
 import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
 declare const _default: DefineComponent<{}, {
-    $emit: (event: "emit" | "update:modelValue" | "rowActionClick" | "filterBuilderFilter", ...args: any[]) => void;
+    $emit: (event: "update:modelValue" | "rowActionClick" | "emit" | "filterBuilderFilter", ...args: any[]) => void;
     readOnly: boolean;
     texts: Record<string, any>;
     builderOptions: Record<string, any>;

package/dist/src/components/ViewBuilder.vue.d.ts

@@ -2,7 +2,7 @@ import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOp
 declare const _default: DefineComponent<{}, {
     validateModel: typeof validateModel;
     clearValidations: typeof clearValidations;
-    $emit: (event: "emit" | "update:modelValue" | "rowActionClick", ...args: any[]) => void;
+    $emit: (event: "update:modelValue" | "rowActionClick" | "emit", ...args: any[]) => void;
     $props: {
         readonly [x: string]: any;
     };