@ghentcdh/json-forms-vue 1.1.0 → 2.0.0

package/forms/renderers/controls/resource.d.ts

@@ -0,0 +1,262 @@
+import { z } from 'zod';
+import { HttpClient } from '../../../http-client';
+/** Supported HTTP methods for resource operations. */
+export declare const MethodSchema: z.ZodEnum<{
+    delete: "delete";
+    get: "get";
+    post: "post";
+    put: "put";
+    patch: "patch";
+    GET: "GET";
+    POST: "POST";
+    DELETE: "DELETE";
+    PUT: "PUT";
+    PATCH: "PATCH";
+}>;
+export type Method = z.infer<typeof MethodSchema>;
+export declare const OperationSchema: z.ZodObject<{
+    uri: z.ZodString;
+    method: z.ZodEnum<{
+        delete: "delete";
+        get: "get";
+        post: "post";
+        put: "put";
+        patch: "patch";
+        GET: "GET";
+        POST: "POST";
+        DELETE: "DELETE";
+        PUT: "PUT";
+        PATCH: "PATCH";
+    }>;
+}, z.core.$strip>;
+export type Operation = z.infer<typeof OperationSchema>;
+export declare const OperationsSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
+    uri: z.ZodString;
+    method: z.ZodEnum<{
+        delete: "delete";
+        get: "get";
+        post: "post";
+        put: "put";
+        patch: "patch";
+        GET: "GET";
+        POST: "POST";
+        DELETE: "DELETE";
+        PUT: "PUT";
+        PATCH: "PATCH";
+    }>;
+}, z.core.$strip>]>;
+export declare const BooleanOperationSchema: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+    uri: z.ZodString;
+    method: z.ZodEnum<{
+        delete: "delete";
+        get: "get";
+        post: "post";
+        put: "put";
+        patch: "patch";
+        GET: "GET";
+        POST: "POST";
+        DELETE: "DELETE";
+        PUT: "PUT";
+        PATCH: "PATCH";
+    }>;
+}, z.core.$strip>]>>>;
+/**
+ * Zod schema that validates and transforms a resource definition from the API.
+ *
+ * Accepts a resource descriptor with an `id`, base `uri`, CRUD `operations`,
+ * and optional `schema` (JSON Schema + UI schema). During parsing:
+ *
+ * - If `schema.data` is present but `schema.ui` is missing, a UI schema is
+ *   auto-generated via {@link uiFromJsonSchema} using a GridLayout.
+ * - Each operation is normalized to `{ uri, method }` or `null` based on
+ *   its value (`true` inherits the base uri, a string overrides the uri,
+ *   an object is used as-is, `false`/`undefined` maps to `null`).
+ */
+export declare const ResourceSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    uri: z.ZodString;
+    operations: z.ZodObject<{
+        findAll: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+            uri: z.ZodString;
+            method: z.ZodEnum<{
+                delete: "delete";
+                get: "get";
+                post: "post";
+                put: "put";
+                patch: "patch";
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PUT: "PUT";
+                PATCH: "PATCH";
+            }>;
+        }, z.core.$strip>]>>>;
+        findOne: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+            uri: z.ZodString;
+            method: z.ZodEnum<{
+                delete: "delete";
+                get: "get";
+                post: "post";
+                put: "put";
+                patch: "patch";
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PUT: "PUT";
+                PATCH: "PATCH";
+            }>;
+        }, z.core.$strip>]>>>;
+        create: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+            uri: z.ZodString;
+            method: z.ZodEnum<{
+                delete: "delete";
+                get: "get";
+                post: "post";
+                put: "put";
+                patch: "patch";
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PUT: "PUT";
+                PATCH: "PATCH";
+            }>;
+        }, z.core.$strip>]>>>;
+        update: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+            uri: z.ZodString;
+            method: z.ZodEnum<{
+                delete: "delete";
+                get: "get";
+                post: "post";
+                put: "put";
+                patch: "patch";
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PUT: "PUT";
+                PATCH: "PATCH";
+            }>;
+        }, z.core.$strip>]>>>;
+        delete: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+            uri: z.ZodString;
+            method: z.ZodEnum<{
+                delete: "delete";
+                get: "get";
+                post: "post";
+                put: "put";
+                patch: "patch";
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PUT: "PUT";
+                PATCH: "PATCH";
+            }>;
+        }, z.core.$strip>]>>>;
+        lookup: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+            uri: z.ZodString;
+            method: z.ZodEnum<{
+                delete: "delete";
+                get: "get";
+                post: "post";
+                put: "put";
+                patch: "patch";
+                GET: "GET";
+                POST: "POST";
+                DELETE: "DELETE";
+                PUT: "PUT";
+                PATCH: "PATCH";
+            }>;
+        }, z.core.$strip>]>>;
+    }, z.core.$strip>;
+    schema: z.ZodOptional<z.ZodObject<{
+        ui: z.ZodOptional<z.ZodAny>;
+        data: z.ZodAny;
+    }, z.core.$strip>>;
+    schemas: z.ZodOptional<z.ZodObject<{
+        form: z.ZodOptional<z.ZodObject<{
+            ui: z.ZodOptional<z.ZodAny>;
+            data: z.ZodAny;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodTransform<{
+    schema: {
+        data: any;
+        ui?: any;
+    };
+    operations: Record<"delete" | "create" | "update" | "findAll" | "findOne" | "lookup", {
+        uri: string;
+        method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+    } | null>;
+    id: string;
+    uri: string;
+    schemas?: {
+        form?: {
+            data: any;
+            ui?: any;
+        } | undefined;
+    } | undefined;
+}, {
+    id: string;
+    uri: string;
+    operations: {
+        findAll: boolean | {
+            uri: string;
+            method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+        };
+        findOne: boolean | {
+            uri: string;
+            method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+        };
+        create: boolean | {
+            uri: string;
+            method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+        };
+        update: boolean | {
+            uri: string;
+            method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+        };
+        delete: boolean | {
+            uri: string;
+            method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+        };
+        lookup?: string | {
+            uri: string;
+            method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+        } | undefined;
+    };
+    schema?: {
+        data: any;
+        ui?: any;
+    } | undefined;
+    schemas?: {
+        form?: {
+            data: any;
+            ui?: any;
+        } | undefined;
+    } | undefined;
+}>>;
+/**
+ * Fetches and validates a resource definition from the given URI.
+ *
+ * @param resourceUri - Endpoint that returns the resource descriptor JSON.
+ * @param skipAuth - When `true`, uses plain axios instead of the authenticated API client.
+ * @returns Parsed and normalized resource with resolved operations and schemas.
+ * @throws If the response does not match {@link ResourceSchema}.
+ */
+export declare const getResourceSchema: (resourceUri: string, http: HttpClient) => Promise<{
+    schema: {
+        data: any;
+        ui?: any;
+    };
+    operations: Record<"delete" | "create" | "update" | "findAll" | "findOne" | "lookup", {
+        uri: string;
+        method: "delete" | "get" | "post" | "put" | "patch" | "GET" | "POST" | "DELETE" | "PUT" | "PATCH";
+    } | null>;
+    id: string;
+    uri: string;
+    schemas?: {
+        form?: {
+            data: any;
+            ui?: any;
+        } | undefined;
+    } | undefined;
+}>;

package/forms/renderers/index.d.ts

@@ -0,0 +1,43 @@
+export * from './array/ArrayRenderers';
+export * from './controls';
+export * from './controls/composables/useControlBinding';
+export * from './controls/readonly';
+export * from './layout/LayoutRenderers';
+export declare const customRenderers: ({
+    tester: import('../../testers/jsonforms-testers').RankedTester;
+    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, {}, any>;
+} | {
+    tester: import('../../testers/jsonforms-testers').RankedTester;
+    renderer: import('vue').DefineComponent<{
+        uischema: import('@jsonforms/core').ControlElement;
+        schema: import('@jsonforms/core').JsonSchema;
+    }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+        uischema: import('@jsonforms/core').ControlElement;
+        schema: import('@jsonforms/core').JsonSchema;
+    }> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+})[];
+export declare const readonlyRenderers: ({
+    tester: import('../../testers/jsonforms-testers').RankedTester;
+    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>;
+} | {
+    tester: import('../../testers/jsonforms-testers').RankedTester;
+    renderer: import('vue').DefineComponent<{
+        uischema: import('@jsonforms/core').ControlElement;
+        schema: import('@jsonforms/core').JsonSchema;
+    }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+        uischema: import('@jsonforms/core').ControlElement;
+        schema: import('@jsonforms/core').JsonSchema;
+    }> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+})[];

package/forms/renderers/layout/CollapseLayoutRenderer.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/layout/LayoutRenderer.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, {}, any>;
+export default _default;

package/forms/renderers/layout/LayoutRenderers.d.ts

@@ -0,0 +1,20 @@
+export declare const layoutRenderers: {
+    tester: import('../../../testers/jsonforms-testers').RankedTester;
+    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, {}, any>;
+}[];
+export declare const readonlyLayoutRenderers: {
+    tester: import('../../../testers/jsonforms-testers').RankedTester;
+    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/layout/ReadOnlyLayoutRenderer.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/layout/colspan.d.ts

@@ -0,0 +1 @@
+export declare const COLSPAN: Record<number, string>;

package/forms/renderers/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/scope.d.ts

@@ -0,0 +1,4 @@
+import { JsonSchema } from '@jsonforms/core';
+export declare const scopeToPath: (scope: string) => string;
+export declare const resolveSchema: (root: JsonSchema, scope: string) => JsonSchema;
+export declare const labelFromScope: (scope: string) => string;

package/forms/types.d.ts

@@ -0,0 +1,36 @@
+export type { JsonSchema } from '@jsonforms/core';
+export interface UiElementOptions {
+    format?: string;
+    colspan?: number;
+    styles?: {
+        width?: string;
+        control?: {
+            wrapper?: string;
+        };
+    };
+    uri?: string;
+    valueKey?: string;
+    labelKey?: string;
+    enableCreate?: boolean;
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    placeholder?: string;
+    label?: string;
+    hideLabel?: boolean;
+    readonly?: boolean;
+    visible?: boolean;
+    layout?: 'row' | 'column';
+    hideActions?: boolean;
+    dataField?: string;
+    skipAuth?: boolean;
+    type?: string;
+}
+export interface UiElement {
+    type: 'Control' | 'GridLayout' | 'VerticalLayout' | 'HorizontalLayout' | 'CollapseLayout';
+    scope?: string;
+    elements?: UiElement[];
+    options?: UiElementOptions;
+    label?: string;
+}

package/http-client.d.ts

@@ -0,0 +1,14 @@
+export interface HttpClient {
+    get<T = any>(url: string, config?: any): Promise<{
+        data: T;
+    }>;
+    post<T = any>(url: string, data?: any, config?: any): Promise<{
+        data: T;
+    }>;
+    patch<T = any>(url: string, data?: any, config?: any): Promise<{
+        data: T;
+    }>;
+    delete<T = any>(url: string, config?: any): Promise<{
+        data: T;
+    }>;
+}

package/index.d.ts

@@ -1,12 +1,19 @@
-export * from './forms/modal/FormModal.properties';
-export * from './table';
-export * from './repository';
-export * from './composables/useFormEvents';
+export { default as ReadonlyLabel } from './forms/renderers/controls/readonly/ReadonlyLabel.vue';
 export type { ErrorMode } from './forms/errorMode';
-export { formatError, registerZodErrorMap } from './forms/errorMessages';
+export type { HttpClient } from './http-client';
+export type { FormModalProp, FormModalResult, } from './forms/modal/FormModal.properties';
+export { useControlBinding, useCustomControlBinding, } from './forms/renderers/controls/composables/useControlBinding';
+export * from './forms/renderers/controls/composables/useReadonlyBinding';
+export { useDisplayValue } from './forms/renderers/controls/readonly/useDisplayValue';
+export * from './composables/useFormEvents';
+export { provideHttpClient, useHttpClient } from './composables/useHttpClient';
 export { default as JsonForm } from './forms/FormComponent.vue';
-export { default as JsonFormWithActions } from './forms/FormWithActions.vue';
-export { default as JsonFormWithTable } from './forms/FormWithTable.vue';
 export { default as JsonFormModal } from './forms/modal/FormModal.vue';
+export { FormModalEmits, FormModalProperties, } from './forms/modal/FormModal.properties';
 export { JsonFormModalService } from './forms/modal/FormModalService';
-export { customRenderes as veeRenderers } from './forms/renderes';
+export { customRenderers, readonlyRenderers } from './forms/renderers';
+export { optionIsIgnoreCase } from './testers/tester';
+export { formatError, registerZodErrorMap } from './forms/errorMessages';
+export * from './repository';
+export * from './table';
+export * from './forms/renderers/controls/readonly/displayValue';