react-formule 1.5.0 → 1.7.0

package/dist/store/schemaWizard.d.ts

@@ -24,7 +24,7 @@ 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">, addFile: import('@reduxjs/toolkit').ActionCreatorWithPayload<{
+}, "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<{

package/dist/types/index.d.ts

@@ -18,6 +18,73 @@ export type CustomFunctions = {
         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;
@@ -31,4 +98,11 @@ export type FormuleContextProps = {
     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.5.0",
+  "version": "1.7.0",
   "author": "CERN",
   "license": "MIT",
   "repository": {
@@ -32,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",
@@ -43,10 +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.26.0",
     "axios": "^1.4.0",
     "codemirror": "^6.0.1",
     "codemirror-json-schema": "0.7.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/widgets/SliderWidget.d.ts

@@ -1,14 +0,0 @@
-import { default as PropTypes } from 'prop-types';
-export default SliderWidget;
-declare function SliderWidget({ schema, onChange, value }: {
-    schema: any;
-    onChange: any;
-    value: any;
-}): import("react/jsx-runtime").JSX.Element;
-declare namespace SliderWidget {
-    namespace propTypes {
-        let schema: PropTypes.Requireable<object>;
-        let onChange: PropTypes.Requireable<(...args: any[]) => any>;
-        let value: PropTypes.Requireable<number>;
-    }
-}

package/dist/admin/formComponents/widgets/index.d.ts

@@ -1,5 +0,0 @@
-import { default as SliderWidget } from './SliderWidget';
-export default widgets;
-declare namespace widgets {
-    export { SliderWidget as slider };
-}