react-formule 1.4.0 → 1.6.0

package/dist/store/configureStore.d.ts

@@ -20,6 +20,10 @@ declare const store: import('@reduxjs/toolkit/dist/configureStore').ToolkitStore
         id: string;
         field: {};
         formData: {};
+        files: {
+            new: {};
+            deleted: string[];
+        };
     };
 }, import('redux').AnyAction, import('@reduxjs/toolkit').MiddlewareArray<[import('redux-thunk').ThunkMiddleware<{
     schemaWizard: {
@@ -39,6 +43,10 @@ declare const store: import('@reduxjs/toolkit/dist/configureStore').ToolkitStore
         id: string;
         field: {};
         formData: {};
+        files: {
+            new: {};
+            deleted: string[];
+        };
     };
 }, import('redux').AnyAction>, ({ getState }: {
     getState: any;

package/dist/store/schemaWizard.d.ts

@@ -15,12 +15,23 @@ export declare const initialState: {
     id: string;
     field: {};
     formData: {};
+    files: {
+        new: {};
+        deleted: string[];
+    };
 };
 export type SchemaWizardState = typeof initialState;
 export declare const schemaInit: import('@reduxjs/toolkit').ActionCreatorWithPayload<{
     data: any;
     id: any;
-}, "schemaWizard/schemaInit">, enableCreateMode: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<"schemaWizard/enableCreateMode">, selectProperty: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/selectProperty">, updateSchemaByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateSchemaByPath">, updateUiSchemaByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateUiSchemaByPath">, addByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/addByPath">, deleteByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/deleteByPath">, renameIdByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/renameIdByPath">, updateRequired: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateRequired">, updateFormData: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateFormData">;
+}, "schemaWizard/schemaInit">, enableCreateMode: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<"schemaWizard/enableCreateMode">, selectProperty: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/selectProperty">, updateByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateByPath">, updateSchemaByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateSchemaByPath">, updateUiSchemaByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateUiSchemaByPath">, addByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/addByPath">, deleteByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/deleteByPath">, renameIdByPath: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/renameIdByPath">, updateRequired: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateRequired">, updateFormData: import('@reduxjs/toolkit').ActionCreatorWithPayload<any, "schemaWizard/updateFormData">, addFile: import('@reduxjs/toolkit').ActionCreatorWithPayload<{
+    uid: string;
+    objectUrl: string;
+}, "schemaWizard/addFile">, removeNewFile: import('@reduxjs/toolkit').ActionCreatorWithPayload<{
+    uid: string;
+}, "schemaWizard/removeNewFile">, removeExistingFile: import('@reduxjs/toolkit').ActionCreatorWithPayload<{
+    uid: string;
+}, "schemaWizard/removeExistingFile">;
 declare const _default: import('redux').Reducer<{
     current: {
         schema: {
@@ -38,5 +49,9 @@ declare const _default: import('redux').Reducer<{
     id: string;
     field: {};
     formData: {};
+    files: {
+        new: {};
+        deleted: string[];
+    };
 }>;
 export default _default;

package/dist/types/index.d.ts

@@ -0,0 +1,108 @@
+import { ReactNode } from 'react';
+import { ThemeConfig } from 'antd';
+import { SchemaWizardState } from '../store/schemaWizard';
+
+export type CustomFunctions = {
+    file?: {
+        /**
+         * Function to fetch a file based on a file UID. Formule will call this function with
+         * each of the file UIDs in a Files field's formData to initialize it with the files
+         * fetched from the URL returned by this function.
+         * @param uid The UID of the file to fetch
+         * @returns An object URL for the file which can be a promise. This can be:
+         *      - Simply a url to your backend, requiring no processing from your side
+         *      - If you have a more complex use case, where you need to configure authentication,
+         *          etc, you can instead fetch the file inside this function using your custom logic
+         *          and then create and return an object URL with URL.createObjectURL()
+         */
+        fetchFile: (uid: string) => string | Promise<string>;
+    };
+};
+export type TokenUsage = {
+    prompt: number;
+    completion: number;
+    total: number;
+    cached?: number;
+};
+export type AISuggestion = {
+    schema: object;
+    uiSchema: object;
+    usage?: TokenUsage;
+};
+export type AIError = {
+    error: string;
+    usage?: TokenUsage;
+};
+export type AIResponse = AISuggestion | AIError;
+/**
+ * Configuration for an AI Provider. New providers will override the defaults.
+ * If you want to add a new provider while keeping the defaults, you can import
+ * and include `...defaultProviders`.
+ */
+export type AIProvider = {
+    /** Label for the AI provider in the UI */
+    label: ReactNode;
+    /**
+     * Optional provider API key. If not provided here, you should request it from the user,
+     * for example using the `AiSettingsDialog` component.
+     */
+    apiKey?: string;
+    /**
+     * Optional model identifier. If not provided, you need to pass a
+     * `fetchModels` function to be called by `AiSettingsDialog`.
+     */
+    model?: string;
+    /** Show this model as a recommended default in the `AiSettingsDialog` panel.
+     * If not provided, no model will be recommended.
+     */
+    recommendedModel?: {
+        id: string;
+        name: string;
+    };
+    /**
+     * Function to retrieve available models (used in the AiSettingsDialog component).
+     * Not needed when the api key and model are provided directly.
+     * @param apiKey - Provider API key
+     * @returns Promise containing an array of available models with their IDs and display names
+     */
+    fetchModels?: (apiKey: string) => Promise<{
+        id: string;
+        name: string;
+    }[]>;
+    /**
+     * Main function to generate schema modifications. You must use your own system prompt.
+     * @param prompt - User prompt
+     * @param currentSchema - Current form state (schema and uiSchema)
+     * @param fieldTypes - Field type specification
+     * @param apiKey - Provider API key
+     * @param model - Model identifier to use
+     * @returns Promise containing the generated schema (or otherwise error) with optional token usage information
+     */
+    generateSchema: (prompt: string, currentSchema: object, fieldTypes: object, apiKey: string, model: string) => Promise<AIResponse>;
+};
+export type AIConfig = {
+    providers: {
+        [key: string]: AIProvider;
+    };
+};
+export type FormuleContextProps = {
+    children: ReactNode;
+    customFieldTypes?: object;
+    customFields?: object;
+    customWidgets?: object;
+    customPublishedFields?: object;
+    customPublishedWidgets?: object;
+    customFunctions?: CustomFunctions;
+    theme?: ThemeConfig;
+    separator?: string;
+    errorBoundary?: ReactNode;
+    synchronizeState?: (state: SchemaWizardState) => void;
+    transformSchema?: (schema: object) => object;
+    ai?: AIConfig;
+};
+export type CustomizationContextProps = Omit<FormuleContextProps, "children" | "customFieldTypes" | "synchronizeState" | "theme"> & {
+    allFieldTypes: object;
+    separator: string;
+    transformSchema: (schema: object) => object;
+    ai: AIConfig;
+};

package/dist/utils/CodeDiffViewer.d.ts

@@ -3,6 +3,7 @@ type CodeDiffViewerProps = {
     right: string;
     lang?: string;
     height?: string;
+    unified?: boolean;
 };
-declare const CodeDiffViewer: ({ left, right, lang, height }: CodeDiffViewerProps) => import("react/jsx-runtime").JSX.Element;
+declare const CodeDiffViewer: ({ left, right, lang, height, unified, }: CodeDiffViewerProps) => import("react/jsx-runtime").JSX.Element;
 export default CodeDiffViewer;

package/dist/utils/FieldMessageTag.d.ts

@@ -0,0 +1,4 @@
+export declare const FieldMessageTag: ({ color, children }: {
+    color: any;
+    children: any;
+}) => import("react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-formule",
   "private": false,
-  "version": "1.4.0",
+  "version": "1.6.0",
   "author": "CERN",
   "license": "MIT",
   "repository": {
@@ -13,6 +13,7 @@
     "dist"
   ],
   "types": "./dist/index.d.ts",
+  "main": "./dist/react-formule.umd.cjs",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -31,6 +32,7 @@
     "prepare": "husky"
   },
   "dependencies": {
+    "@ant-design/icons": "^5.6.1",
     "@ant-design/pro-layout": "^7.16.4",
     "@codemirror/lang-json": "^6.0.1",
     "@codemirror/language": "^6.8.0",
@@ -42,11 +44,12 @@
     "@rjsf/core": "^5.21.0",
     "@rjsf/utils": "^5.21.0",
     "@rjsf/validator-ajv8": "^5.21.0",
-    "antd": "^5.7.3",
+    "ajv": "^8.17.1",
+    "antd": "^5.21.0",
     "axios": "^1.4.0",
     "codemirror": "^6.0.1",
     "codemirror-json-schema": "0.7.1",
-    "immutability-helper": "^3.1.1",
+    "just-diff": "^6.0.2",
     "katex": "^0.16.8",
     "markdown-it": "^13.0.1",
     "markdown-it-texmath": "^1.0.0",
@@ -93,7 +96,7 @@
     "vite": "^5.0.2",
     "vite-plugin-css-injected-by-js": "^3.3.0",
     "vite-plugin-dts": "^3.6.3",
-    "vitest": "^0.34.6"
+    "vitest": "^2.1.8"
   },
   "peerDependencies": {
     "react": ">=18.2.0",

package/dist/admin/formComponents/RenderSortable.d.ts

@@ -1,2 +0,0 @@
-export default RenderSortable;
-declare function RenderSortable(parent: any, card: any, i: any, moveCard: any): import("react/jsx-runtime").JSX.Element | null;

package/dist/vite.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>