@ghentcdh/json-forms-vue 0.6.9 → 0.7.0

package/modal/form-modal.props.d.ts

@@ -1,15 +1,30 @@
-import { JsonFormsLayout } from '../../../core/src/index.ts';
-import { FormEventListener } from '../state/form.state';
+import { SizeType } from '../../../core/src/index.ts';
+import { FormEventPayload } from '../composables/useFormEvents';
+/** Props for the `FormModal` component. */
 export type FormModalProps = {
+    /** Title displayed in the modal header. */
     modalTitle: string;
+    /** Label for the save button. */
     saveLabel?: string;
+    /** Label for the cancel button. */
     cancelLabel?: string;
-    formSchema: JsonFormsLayout;
-    eventListener?: FormEventListener;
+    /** JSON schema describing the shape of the form data. */
+    schema: any;
+    /** UI schema describing the layout and controls. */
+    uiSchema: any;
+    /** Modal width (`'xs'`, `'sm'`, `'lg'`, `'xl'`). */
+    modalSize?: SizeType;
+    /** Callback invoked when the modal closes (with result or `null` on cancel). */
     onClose: (result: any) => void;
+    /** Callback for form events dispatched by custom renderers (e.g. "create"). */
+    onEvents?: (payload: FormEventPayload) => void;
+    /** Initial form data to populate the form with. */
     data: any;
 };
+/** 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/modal/form-modal.service.d.ts

@@ -1,10 +1,15 @@
-import { JsonFormsLayout } from '../../../core/src/index.ts';
+import { SizeType } from '../../../core/src/index.ts';
 import { FormModalResult } from './index';
+import { FormEventPayload } from '../composables/useFormEvents';
 export declare class FormModalService {
-    static openModal<DATA = any>({ initialData, modalTitle, formSchema, onClose, }: {
+    static openModal<DATA = any>({ initialData, modalTitle, schema, uiSchema, modalSize, onClose, onEvents, }: {
         initialData?: DATA;
-        formSchema: JsonFormsLayout;
+        schema: any;
+        uiSchema: any;
+        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/modal/form-modal.vue.d.ts

@@ -15,13 +15,16 @@ declare function __VLS_template(): {
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     closeModal: (...args: any[]) => void;
+    events: (...args: any[]) => void;
     "update:modelValue": (value: any) => void;
 }, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
     onCloseModal?: ((...args: any[]) => any) | undefined;
     "onUpdate:modelValue"?: ((value: any) => any) | undefined;
+    onEvents?: ((...args: any[]) => any) | undefined;
 }>, {
     cancelLabel: string;
     saveLabel: string;
+    modalSize: import('../../../core/src/index.ts').SizeType;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDialogElement>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghentcdh/json-forms-vue",
-  "version": "0.6.9",
+  "version": "0.7.0",
   "main": "./index.js",
   "module": "./index.mjs",
   "types": "./index.d.ts",

package/renderes/layouts/GridLayout.vue.d.ts

@@ -0,0 +1,73 @@
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    schema: {
+        required: true;
+        type: import('vue').PropType<import('@jsonforms/core').JsonSchema>;
+    };
+    uischema: {
+        required: true;
+        type: import('vue').PropType<import('@jsonforms/core').UISchemaElement>;
+    };
+    path: {
+        required: true;
+        type: StringConstructor;
+    };
+    enabled: {
+        required: false;
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    renderers: {
+        required: boolean;
+        type: import('vue').PropType<import('@jsonforms/core').JsonFormsRendererRegistryEntry[]>;
+        default: undefined;
+    };
+    cells: {
+        required: boolean;
+        type: import('vue').PropType<import('@jsonforms/core').JsonFormsCellRendererRegistryEntry[]>;
+        default: undefined;
+    };
+    config: {
+        required: boolean;
+        type: ObjectConstructor;
+        default: undefined;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    schema: {
+        required: true;
+        type: import('vue').PropType<import('@jsonforms/core').JsonSchema>;
+    };
+    uischema: {
+        required: true;
+        type: import('vue').PropType<import('@jsonforms/core').UISchemaElement>;
+    };
+    path: {
+        required: true;
+        type: StringConstructor;
+    };
+    enabled: {
+        required: false;
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    renderers: {
+        required: boolean;
+        type: import('vue').PropType<import('@jsonforms/core').JsonFormsRendererRegistryEntry[]>;
+        default: undefined;
+    };
+    cells: {
+        required: boolean;
+        type: import('vue').PropType<import('@jsonforms/core').JsonFormsCellRendererRegistryEntry[]>;
+        default: undefined;
+    };
+    config: {
+        required: boolean;
+        type: ObjectConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    enabled: boolean;
+    renderers: import('@jsonforms/core').JsonFormsRendererRegistryEntry[];
+    cells: import('@jsonforms/core').JsonFormsCellRendererRegistryEntry[];
+    config: Record<string, any>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+export default _default;

package/renderes/tester.d.ts

@@ -6,3 +6,4 @@ export declare const isArrayRenderer: import('@jsonforms/core/src/testers/tester
 export declare const isCustomControl: (customType: string) => import('@jsonforms/core/src/testers/testers').Tester;
 export declare const isMultiselectControl: import('@jsonforms/core/src/testers/testers').Tester;
 export declare const isSelectControl: import('@jsonforms/core/src/testers/testers').Tester;
+export declare const isBooleanControl: import('@jsonforms/core/src/testers/testers').Tester;

package/repository/crud.repository.d.ts

@@ -1,5 +1,4 @@
 import { AxiosRequestInterceptorUse } from 'axios';
-import { FormSchemaModel } from '../../../core/src/index.ts';
 type RequestOptions = {
     skipAuth?: boolean;
     queryParams?: Record<string, any>;
@@ -21,7 +20,9 @@ type RepositoryOptions = {
 };
 export declare const createRepository: <T extends {
     id?: string;
-}>(formSchemaModel: Pick<FormSchemaModel, "uri">, httpRequest: HttpRequest<T>, options?: RepositoryOptions) => {
+}>(formSchemaModel: {
+    uri: string;
+}, httpRequest: HttpRequest<T>, options?: RepositoryOptions) => {
     create: (object: T, options?: RequestOptions) => any;
     patch: (id: string, object: T, options?: RequestOptions) => any;
     createMulti: (objects: T[], options?: RequestOptions) => Promise<any>;

package/table/index.d.ts

@@ -1 +1,2 @@
 export { default as TableComponent } from './table.component.vue';
+export * from './table.component.properties';

package/table/table.component.properties.d.ts

@@ -0,0 +1,34 @@
+import { JsonSchema, Layout } from '@jsonforms/core';
+import { PropType } from 'vue';
+import { TableAction } from '../../../../ui/src/index.ts';
+export declare const TableComponentProperties: {
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    uiSchema: {
+        type: PropType<Layout>;
+        required: true;
+    };
+    schema: {
+        type: PropType<JsonSchema>;
+        required: true;
+    };
+    filterUiSchema: {
+        type: PropType<Layout>;
+    };
+    filterSchema: {
+        type: PropType<JsonSchema>;
+    };
+    uri: {
+        type: StringConstructor;
+        required: true;
+    };
+    reload: {
+        type: NumberConstructor;
+    };
+    actions: {
+        type: PropType<TableAction[]>;
+    };
+};
+export declare const TableComponentEmits: string[];

package/table/table.component.vue.d.ts

@@ -1,18 +1,60 @@
-import { JsonFormsLayout } from '../../../core/src/index.ts';
-import { TableAction } from '../../../../ui/src/index.ts';
-type __VLS_Props = {
-    id: string;
-    layout: JsonFormsLayout;
-    filterLayout?: JsonFormsLayout;
-    uri: string;
-    reload?: number;
-    actions?: TableAction[];
-};
-declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-    edit: (...args: any[]) => void;
-    delete: (...args: any[]) => void;
-}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onEdit?: ((...args: any[]) => any) | undefined;
-    onDelete?: ((...args: any[]) => any) | undefined;
-}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    uiSchema: {
+        type: import('vue').PropType<import('@jsonforms/core').Layout>;
+        required: true;
+    };
+    schema: {
+        type: import('vue').PropType<import('@jsonforms/core').JsonSchema>;
+        required: true;
+    };
+    filterUiSchema: {
+        type: import('vue').PropType<import('@jsonforms/core').Layout>;
+    };
+    filterSchema: {
+        type: import('vue').PropType<import('@jsonforms/core').JsonSchema>;
+    };
+    uri: {
+        type: StringConstructor;
+        required: true;
+    };
+    reload: {
+        type: NumberConstructor;
+    };
+    actions: {
+        type: import('vue').PropType<import('../../../../ui/src/index.ts').TableAction[]>;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    uiSchema: {
+        type: import('vue').PropType<import('@jsonforms/core').Layout>;
+        required: true;
+    };
+    schema: {
+        type: import('vue').PropType<import('@jsonforms/core').JsonSchema>;
+        required: true;
+    };
+    filterUiSchema: {
+        type: import('vue').PropType<import('@jsonforms/core').Layout>;
+    };
+    filterSchema: {
+        type: import('vue').PropType<import('@jsonforms/core').JsonSchema>;
+    };
+    uri: {
+        type: StringConstructor;
+        required: true;
+    };
+    reload: {
+        type: NumberConstructor;
+    };
+    actions: {
+        type: import('vue').PropType<import('../../../../ui/src/index.ts').TableAction[]>;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
 export default _default;

package/demo/owner.d.ts

@@ -1,55 +0,0 @@
-export declare const OwnerWithRelationsFormDetail: {
-    type: string;
-    properties: {
-        id: {
-            type: string;
-        };
-        createdAt: {
-            type: string;
-            format: string;
-        };
-        name: {
-            type: string;
-        };
-        firstname: {
-            type: string;
-        };
-        age: {
-            type: string;
-        };
-        total: {
-            type: string;
-        };
-        boolean: {
-            type: string;
-        };
-        comment: {
-            type: string;
-        };
-        autocomplete: {
-            type: string;
-        };
-        emails: {
-            type: string;
-            items: {
-                type: string;
-                properties: {
-                    id: {
-                        type: string;
-                    };
-                    createdAt: {
-                        type: string;
-                        format: string;
-                    };
-                    email: {
-                        type: string;
-                    };
-                };
-                required: string[];
-                additionalProperties: boolean;
-            };
-        };
-    };
-    required: string[];
-    additionalProperties: boolean;
-};

package/renderes/array/map-array-actions.d.ts

@@ -1,9 +0,0 @@
-import { Router } from 'vue-router';
-import { ArrayAction } from '../../../../core/src/index.ts';
-import { IconEnum } from '../../../../../ui/src/index.ts';
-export type Action = {
-    label: string;
-    icon: IconEnum;
-    show: (element: any) => boolean;
-};
-export declare const mapArrayActions: (router: Router, actions: ArrayAction[]) => Action[];

package/state/form.state.d.ts

@@ -1,12 +0,0 @@
-export type FormEventType = any;
-export type FormEventListener = (type: FormEventType, data: any) => void;
-declare class FormState {
-    static instance: FormState;
-    private readonly events;
-    private constructor();
-    static getInstance(): FormState;
-    registerEventListener(formName: string, callback: FormEventListener): void;
-    dispatchEvent(formName: string, event: FormEventType, data: any): void;
-}
-export declare const useFormState: (form: any) => FormState;
-export {};