@ghentcdh/json-forms-vue 0.8.5 → 1.0.1

package/forms/modal/FormModal.properties.d.ts

@@ -0,0 +1,64 @@
+import { ExtractPublicPropTypes, PropType } from 'vue';
+import { SizeType } from '../../../../core/src/index.ts';
+import { FormEventPayload } from '../../composables/useFormEvents';
+import { ErrorMode } from '../errorMode';
+export declare const FormModalProperties: {
+    /** Title displayed in the modal header. */
+    modalTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Label for the save button. */
+    saveLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Label for the cancel button. */
+    cancelLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** JSON schema describing the shape of the form data. */
+    schema: {
+        type: PropType<any>;
+        required: true;
+    };
+    /** UI schema describing the layout and controls. */
+    uiSchema: {
+        type: PropType<any>;
+        required: true;
+    };
+    /** Modal width (`'xs'`, `'sm'`, `'md'`, `'lg'`, `'xl'`). */
+    modalSize: {
+        type: PropType<SizeType>;
+        default: string;
+    };
+    /** Callback invoked when the modal closes (with result or `null` on cancel). */
+    onClose: {
+        type: PropType<(result: any) => void>;
+        required: true;
+    };
+    /** Callback for form events dispatched by custom renderers. */
+    onEvents: {
+        type: PropType<(payload: FormEventPayload) => void>;
+    };
+    /** Initial form data to populate the form with. */
+    data: {
+        type: PropType<any>;
+        required: true;
+    };
+    /** When validation errors are shown. */
+    errorMode: {
+        type: PropType<ErrorMode>;
+        default: "onBlur";
+    };
+};
+export type FormModalProp = ExtractPublicPropTypes<typeof FormModalProperties>;
+export declare const FormModalEmits: string[];
+/** Result payload returned when the modal is submitted. */
+export type FormModalResult<DATA = any> = {
+    /** The form data at the time of submission. */
+    data: DATA;
+    /** Whether the form passed validation. */
+    valid: boolean;
+};

package/forms/modal/FormModal.vue.d.ts

@@ -0,0 +1,275 @@
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        'content-before'?(_: {}): any;
+        'content-after'?(_: {}): any;
+    };
+    refs: {
+        formRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+            id: {
+                type: StringConstructor;
+                required: true;
+            };
+            name: {
+                type: StringConstructor;
+                default: string;
+            };
+            schema: {
+                type: import('vue').PropType<any>;
+                required: true;
+            };
+            uiSchema: {
+                type: import('vue').PropType<any>;
+                required: true;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            formData: {
+                type: import('vue').PropType<import('../FormComponent.properties').Data>;
+                default: () => {};
+            };
+            errorMode: {
+                type: import('vue').PropType<import('../errorMode').ErrorMode>;
+                default: "onChanges";
+            };
+        }>> & Readonly<{}>, {
+            markSubmitted: () => void;
+        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+            errorMode: import('../errorMode').ErrorMode;
+            disabled: boolean;
+            name: string;
+            formData: import('../FormComponent.properties').Data;
+        }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, HTMLFormElement, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import('vue').ExtractPropTypes<{
+            id: {
+                type: StringConstructor;
+                required: true;
+            };
+            name: {
+                type: StringConstructor;
+                default: string;
+            };
+            schema: {
+                type: import('vue').PropType<any>;
+                required: true;
+            };
+            uiSchema: {
+                type: import('vue').PropType<any>;
+                required: true;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            formData: {
+                type: import('vue').PropType<import('../FormComponent.properties').Data>;
+                default: () => {};
+            };
+            errorMode: {
+                type: import('vue').PropType<import('../errorMode').ErrorMode>;
+                default: "onChanges";
+            };
+        }>> & Readonly<{}>, {
+            markSubmitted: () => void;
+        }, {}, {}, {}, {
+            errorMode: import('../errorMode').ErrorMode;
+            disabled: boolean;
+            name: string;
+            formData: import('../FormComponent.properties').Data;
+        }> | null;
+    };
+    rootEl: HTMLDialogElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    modalTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+    saveLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    cancelLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    schema: {
+        type: import('vue').PropType<any>;
+        required: true;
+    };
+    uiSchema: {
+        type: import('vue').PropType<any>;
+        required: true;
+    };
+    modalSize: {
+        type: import('vue').PropType<import('../../../../core/src/index.ts').SizeType>;
+        default: string;
+    };
+    onClose: {
+        type: import('vue').PropType<(result: any) => void>;
+        required: true;
+    };
+    onEvents: {
+        type: import('vue').PropType<(payload: import('../..').FormEventPayload) => void>;
+    };
+    data: {
+        type: import('vue').PropType<any>;
+        required: true;
+    };
+    errorMode: {
+        type: import('vue').PropType<import('../errorMode').ErrorMode>;
+        default: "onBlur";
+    };
+    modelValue: {
+        type: import('vue').PropType<any>;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: any) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    modalTitle: {
+        type: StringConstructor;
+        required: true;
+    };
+    saveLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    cancelLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    schema: {
+        type: import('vue').PropType<any>;
+        required: true;
+    };
+    uiSchema: {
+        type: import('vue').PropType<any>;
+        required: true;
+    };
+    modalSize: {
+        type: import('vue').PropType<import('../../../../core/src/index.ts').SizeType>;
+        default: string;
+    };
+    onClose: {
+        type: import('vue').PropType<(result: any) => void>;
+        required: true;
+    };
+    onEvents: {
+        type: import('vue').PropType<(payload: import('../..').FormEventPayload) => void>;
+    };
+    data: {
+        type: import('vue').PropType<any>;
+        required: true;
+    };
+    errorMode: {
+        type: import('vue').PropType<import('../errorMode').ErrorMode>;
+        default: "onBlur";
+    };
+    modelValue: {
+        type: import('vue').PropType<any>;
+    };
+}>> & Readonly<{
+    "onUpdate:modelValue"?: ((value: any) => any) | undefined;
+}>, {
+    errorMode: import('../errorMode').ErrorMode;
+    saveLabel: string;
+    cancelLabel: string;
+    modalSize: "xs" | "sm" | "lg" | "xl";
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
+    formRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+        id: {
+            type: StringConstructor;
+            required: true;
+        };
+        name: {
+            type: StringConstructor;
+            default: string;
+        };
+        schema: {
+            type: import('vue').PropType<any>;
+            required: true;
+        };
+        uiSchema: {
+            type: import('vue').PropType<any>;
+            required: true;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        formData: {
+            type: import('vue').PropType<import('../FormComponent.properties').Data>;
+            default: () => {};
+        };
+        errorMode: {
+            type: import('vue').PropType<import('../errorMode').ErrorMode>;
+            default: "onChanges";
+        };
+    }>> & Readonly<{}>, {
+        markSubmitted: () => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+        errorMode: import('../errorMode').ErrorMode;
+        disabled: boolean;
+        name: string;
+        formData: import('../FormComponent.properties').Data;
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, HTMLFormElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import('vue').ExtractPropTypes<{
+        id: {
+            type: StringConstructor;
+            required: true;
+        };
+        name: {
+            type: StringConstructor;
+            default: string;
+        };
+        schema: {
+            type: import('vue').PropType<any>;
+            required: true;
+        };
+        uiSchema: {
+            type: import('vue').PropType<any>;
+            required: true;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        formData: {
+            type: import('vue').PropType<import('../FormComponent.properties').Data>;
+            default: () => {};
+        };
+        errorMode: {
+            type: import('vue').PropType<import('../errorMode').ErrorMode>;
+            default: "onChanges";
+        };
+    }>> & Readonly<{}>, {
+        markSubmitted: () => void;
+    }, {}, {}, {}, {
+        errorMode: import('../errorMode').ErrorMode;
+        disabled: boolean;
+        name: string;
+        formData: import('../FormComponent.properties').Data;
+    }> | null;
+}, HTMLDialogElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/{modal/form-modal.service.d.ts → forms/modal/FormModalService.d.ts}

@@ -1,7 +1,7 @@
-import { SizeType } from '../../../core/src/index.ts';
-import { FormModalResult } from './index';
-import { FormEventPayload } from '../composables/useFormEvents';
-export declare class FormModalService {
+import { SizeType } from '../../../../core/src/index.ts';
+import { FormModalResult } from './FormModal.properties';
+import { FormEventPayload } from '../../composables/useFormEvents';
+export declare class JsonFormModalService {
     static openModal<DATA = any>({ initialData, modalTitle, schema, uiSchema, modalSize, onClose, onEvents, }: {
         initialData?: DATA;
         schema: any;
@@ -9,7 +9,6 @@ export declare class FormModalService {
         modalSize?: SizeType;
         modalTitle: string;
         onClose: (result: FormModalResult) => void;
-        /** Callback for form events dispatched by custom renderers inside the modal. */
         onEvents?: (payload: FormEventPayload) => void;
     }): void;
 }

package/forms/renderer-registry.d.ts

@@ -0,0 +1,7 @@
+import { JsonSchema, UISchemaElement } from '@jsonforms/core';
+import { Component } from 'vue';
+export interface RendererEntry {
+    tester: (uischema: UISchemaElement, schema: JsonSchema, context?: unknown) => number;
+    renderer: Component;
+}
+export declare function findRenderer(registry: RendererEntry[], uischema: UISchemaElement, schema: JsonSchema): Component | null;

package/forms/renderers/array/ArrayRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { JsonSchema, UISchemaElement } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: UISchemaElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/forms/renderers/array/ArrayRenderers.d.ts

@@ -0,0 +1,10 @@
+export declare const arrayRenderers: {
+    tester: (uischema: import('@jsonforms/core').UISchemaElement, schema: import('@jsonforms/core').JsonSchema, context: import('@jsonforms/core').TesterContext) => number;
+    renderer: import('vue').DefineComponent<{
+        uischema: import('@jsonforms/core').UISchemaElement;
+        schema: import('@jsonforms/core').JsonSchema;
+    }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+        uischema: import('@jsonforms/core').UISchemaElement;
+        schema: import('@jsonforms/core').JsonSchema;
+    }> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+}[];

package/forms/renderers/controls/AutocompleteControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/forms/renderers/controls/BooleanControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/forms/renderers/controls/MarkdownControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLFieldSetElement>;
+export default _default;

package/forms/renderers/controls/MultiSelectControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/forms/renderers/controls/NumberControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLFieldSetElement>;
+export default _default;

package/forms/renderers/controls/SelectControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/forms/renderers/controls/StringControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLFieldSetElement>;
+export default _default;

package/forms/renderers/controls/TextAreaControlRenderer.vue.d.ts

@@ -0,0 +1,7 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+type __VLS_Props = {
+    uischema: ControlElement;
+    schema: JsonSchema;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLFieldSetElement>;
+export default _default;

package/forms/renderers/controls/composable/UseControlBinding.d.ts

@@ -0,0 +1,29 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+import { FieldContext } from 'vee-validate';
+import { Ref } from 'vue';
+import { ControlOption } from '../../../../../../core/src/index.ts';
+import { UseInputOptions } from './UseInput';
+export type useCustomProps = (uischema: ControlElement, schema: JsonSchema, field: FieldContext, options: any) => Ref<any>;
+export declare const useCustomControlBinding: <CONTROL_OPTION extends ControlOption = ControlOption>({ useProps, setDefaultValue, }?: {
+    useProps?: useCustomProps;
+    setDefaultValue?: (field: FieldContext) => void;
+}) => (uischema: ControlElement, schema: JsonSchema, options?: {}) => {
+    wrapper: import('vue').ComputedRef<any>;
+    value: Ref<unknown, unknown>;
+    field: FieldContext<unknown>;
+    onBlur: () => void;
+    onChange: () => void;
+    appliedOptions: import('vue').ComputedRef<{
+        [key: string]: any;
+    } | CONTROL_OPTION>;
+};
+export declare const useControlBinding: (uischema: ControlElement, schema: JsonSchema, options?: UseInputOptions) => {
+    wrapper: import('vue').ComputedRef<any>;
+    value: Ref<unknown, unknown>;
+    field: FieldContext<unknown>;
+    onBlur: () => void;
+    onChange: () => void;
+    appliedOptions: import('vue').ComputedRef<ControlOption | {
+        [key: string]: any;
+    }>;
+};

package/forms/renderers/controls/composable/UseFetchOption.d.ts

@@ -0,0 +1,16 @@
+import { AutocompleteAllOptions } from '../../../../../../core/src/index.ts';
+/**
+ * Resolves autocomplete configuration from control options.
+ *
+ * Dispatches to either {@link useRemoteOption} (when `uri` is set) or
+ * {@link useResourceOptions} (when `resource` is set). Returns a unified
+ * config object with `fetchOptions`, label/value keys, and optional
+ * inline-create form details.
+ */
+export declare const useFetchOptions: (options: AutocompleteAllOptions) => Promise<{
+    fetchOptions: null;
+    labelKey: string | undefined;
+    valueKey: string | undefined;
+    enableCreate: boolean;
+    form: null;
+}>;

package/forms/renderers/controls/composable/UseInput.d.ts

@@ -0,0 +1,24 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+import { FieldContext } from 'vee-validate';
+import { MyStyles } from '../../../../../../../ui/src/index.ts';
+export interface InputProps {
+    id: string;
+    placeholder?: string;
+    description?: string;
+    errors?: string;
+    label: string;
+    visible: boolean;
+    required: boolean;
+    enabled: boolean;
+    isFocused: boolean;
+    isTouched: boolean;
+    hideLabel: boolean;
+    styles: MyStyles;
+    width: string;
+    type: string;
+}
+export interface UseInputOptions {
+    overrides?: Partial<InputProps>;
+    defaultType?: string;
+}
+export declare const useInputProps: (uischema: ControlElement, schema: JsonSchema, field: FieldContext, options?: UseInputOptions) => import('vue').ComputedRef<InputProps>;

package/forms/renderers/controls/composable/UseSelectBinding.d.ts

@@ -0,0 +1,23 @@
+import { ControlElement, JsonSchema } from '@jsonforms/core';
+import { FieldContext } from 'vee-validate';
+import { AutocompleteAllOptions, SelectOptions } from '../../../../../../core/src/index.ts';
+export declare const useSelectBinding: (uischema: ControlElement, schema: JsonSchema, options?: {}) => {
+    wrapper: import('vue').ComputedRef<any>;
+    value: import('vue').Ref<unknown, unknown>;
+    field: FieldContext<unknown>;
+    onBlur: () => void;
+    onChange: () => void;
+    appliedOptions: import('vue').ComputedRef<SelectOptions | {
+        [key: string]: any;
+    }>;
+};
+export declare const useAutocompleteBinding: (uischema: ControlElement, schema: JsonSchema, options?: {}) => {
+    wrapper: import('vue').ComputedRef<any>;
+    value: import('vue').Ref<unknown, unknown>;
+    field: FieldContext<unknown>;
+    onBlur: () => void;
+    onChange: () => void;
+    appliedOptions: import('vue').ComputedRef<AutocompleteAllOptions | {
+        [key: string]: any;
+    }>;
+};