@cyoda/workflow-react 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1,8 +1,10 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { WorkflowEditorDocument, SaveStatus, WorkflowApi, ConcurrencyToken, ImportMode } from '@cyoda/workflow-core';
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { WorkflowEditorDocument, WorkflowUiMeta, SaveStatus, WorkflowApi, ConcurrencyToken, ImportMode } from '@cyoda/workflow-core';
 import { LayoutOptions } from '@cyoda/workflow-layout';
 export { LayoutOptions, LayoutPreset, PinnedNode } from '@cyoda/workflow-layout';
-import * as react from 'react';
+import { LiftResult, WorkflowJsonMonacoRuntime } from '@cyoda/workflow-monaco';
+export { WorkflowJsonEditorInstance, WorkflowJsonModelLike, WorkflowJsonMonacoRuntime } from '@cyoda/workflow-monaco';
 
 declare const defaultMessages: {
     toolbar: {
@@ -14,6 +16,59 @@ declare const defaultMessages: {
         infos: string;
         save: string;
         addWorkflow: string;
+        autoLayout: string;
+        resetLayout: string;
+        addState: string;
+        addNote: string;
+        addStateButton: string;
+        help: string;
+    };
+    help: {
+        title: string;
+        statesTitle: string;
+        stateInitial: string;
+        stateDefault: string;
+        stateProcessing: string;
+        stateManualReview: string;
+        stateTerminal: string;
+        stateError: string;
+        stateWarning: string;
+        transitionsTitle: string;
+        transitionAutomated: string;
+        transitionManual: string;
+        transitionConditional: string;
+        transitionProcessing: string;
+        transitionTerminal: string;
+        transitionLoop: string;
+        transitionDisabled: string;
+        controlsTitle: string;
+        shortcutAddState: string;
+        shortcutAutoLayout: string;
+        shortcutUndo: string;
+        shortcutRedo: string;
+        shortcutSave: string;
+        shortcutDelete: string;
+        shortcutEscape: string;
+        tipsTitle: string;
+        tipDoubleClick: string;
+        tipConnect: string;
+        tipSelect: string;
+        tipMove: string;
+        close: string;
+    };
+    issues: {
+        title: string;
+        none: string;
+        errors: string;
+        warnings: string;
+        infos: string;
+        jumpTo: string;
+        relatedState: string;
+        relatedTransition: string;
+        close: string;
+        openErrors: string;
+        openWarnings: string;
+        openInfos: string;
     };
     inspector: {
         empty: string;
@@ -24,23 +79,36 @@ declare const defaultMessages: {
         version: string;
         active: string;
         initialState: string;
+        transitionType: string;
+        automated: string;
         manual: string;
         disabled: string;
         processors: string;
+        processes: string;
         criterion: string;
+        criteria: string;
         executionMode: string;
         addProcessor: string;
         removeProcessor: string;
         moveUp: string;
         moveDown: string;
+        transitionOrderHelp: string;
         issues: string;
         sourceAnchor: string;
         targetAnchor: string;
         anchorDefault: string;
+        anchorTopLeft: string;
         anchorTop: string;
+        anchorTopRight: string;
+        anchorRightTop: string;
         anchorRight: string;
+        anchorRightBottom: string;
+        anchorBottomLeft: string;
         anchorBottom: string;
+        anchorBottomRight: string;
+        anchorLeftTop: string;
         anchorLeft: string;
+        anchorLeftBottom: string;
     };
     confirmDelete: {
         title: string;
@@ -61,6 +129,14 @@ declare const defaultMessages: {
         closeTab: string;
         untitled: string;
     };
+    editorView: {
+        graph: string;
+        json: string;
+        unavailable: string;
+        invalidJson: string;
+        invalidSchema: string;
+        semanticErrors: string;
+    };
     saveConfirm: {
         title: string;
         modeLabel: string;
@@ -75,6 +151,19 @@ declare const defaultMessages: {
         reload: string;
         forceOverwrite: string;
     };
+    criterion: {
+        heading: string;
+        addTitle: string;
+        editTitle: string;
+        add: string;
+        edit: string;
+        remove: string;
+        noneManual: string;
+        noneAutomated: string;
+        noneAutomatedWarning: string;
+        cancel: string;
+        applyModal: string;
+    };
 };
 type Messages = typeof defaultMessages;
 
@@ -88,6 +177,59 @@ declare const I18nContext: react.Context<{
         infos: string;
         save: string;
         addWorkflow: string;
+        autoLayout: string;
+        resetLayout: string;
+        addState: string;
+        addNote: string;
+        addStateButton: string;
+        help: string;
+    };
+    help: {
+        title: string;
+        statesTitle: string;
+        stateInitial: string;
+        stateDefault: string;
+        stateProcessing: string;
+        stateManualReview: string;
+        stateTerminal: string;
+        stateError: string;
+        stateWarning: string;
+        transitionsTitle: string;
+        transitionAutomated: string;
+        transitionManual: string;
+        transitionConditional: string;
+        transitionProcessing: string;
+        transitionTerminal: string;
+        transitionLoop: string;
+        transitionDisabled: string;
+        controlsTitle: string;
+        shortcutAddState: string;
+        shortcutAutoLayout: string;
+        shortcutUndo: string;
+        shortcutRedo: string;
+        shortcutSave: string;
+        shortcutDelete: string;
+        shortcutEscape: string;
+        tipsTitle: string;
+        tipDoubleClick: string;
+        tipConnect: string;
+        tipSelect: string;
+        tipMove: string;
+        close: string;
+    };
+    issues: {
+        title: string;
+        none: string;
+        errors: string;
+        warnings: string;
+        infos: string;
+        jumpTo: string;
+        relatedState: string;
+        relatedTransition: string;
+        close: string;
+        openErrors: string;
+        openWarnings: string;
+        openInfos: string;
     };
     inspector: {
         empty: string;
@@ -98,23 +240,36 @@ declare const I18nContext: react.Context<{
         version: string;
         active: string;
         initialState: string;
+        transitionType: string;
+        automated: string;
         manual: string;
         disabled: string;
         processors: string;
+        processes: string;
         criterion: string;
+        criteria: string;
         executionMode: string;
         addProcessor: string;
         removeProcessor: string;
         moveUp: string;
         moveDown: string;
+        transitionOrderHelp: string;
         issues: string;
         sourceAnchor: string;
         targetAnchor: string;
         anchorDefault: string;
+        anchorTopLeft: string;
         anchorTop: string;
+        anchorTopRight: string;
+        anchorRightTop: string;
         anchorRight: string;
+        anchorRightBottom: string;
+        anchorBottomLeft: string;
         anchorBottom: string;
+        anchorBottomRight: string;
+        anchorLeftTop: string;
         anchorLeft: string;
+        anchorLeftBottom: string;
     };
     confirmDelete: {
         title: string;
@@ -135,6 +290,14 @@ declare const I18nContext: react.Context<{
         closeTab: string;
         untitled: string;
     };
+    editorView: {
+        graph: string;
+        json: string;
+        unavailable: string;
+        invalidJson: string;
+        invalidSchema: string;
+        semanticErrors: string;
+    };
     saveConfirm: {
         title: string;
         modeLabel: string;
@@ -149,6 +312,19 @@ declare const I18nContext: react.Context<{
         reload: string;
         forceOverwrite: string;
     };
+    criterion: {
+        heading: string;
+        addTitle: string;
+        editTitle: string;
+        add: string;
+        edit: string;
+        remove: string;
+        noneManual: string;
+        noneAutomated: string;
+        noneAutomatedWarning: string;
+        cancel: string;
+        applyModal: string;
+    };
 }>;
 declare function useMessages(): Messages;
 type PartialMessages = {
@@ -179,16 +355,78 @@ type Selection = null | {
     path: string[];
 };
 
+type JsonEditStatus = LiftResult | {
+    status: "idle";
+};
+interface WorkflowJsonEditorConfig {
+    monaco: WorkflowJsonMonacoRuntime;
+    modelUri?: string;
+    editorOptions?: Record<string, unknown>;
+    debounceMs?: number;
+}
+
+/** Controls which chrome elements the editor shell renders. All fields default to `true`. */
+interface ChromeOptions {
+    /** Top toolbar (undo/redo/validation pills/save). Default: true. */
+    toolbar?: boolean;
+    /** Workflow tabs bar. Default: true (also gated by existing single-workflow-viewer rule). */
+    tabs?: boolean;
+    /** Right-side inspector panel. Default: true. */
+    inspector?: boolean;
+    /** Canvas minimap. Default: true. */
+    minimap?: boolean;
+    /** Canvas zoom/pan controls. Default: true. */
+    controls?: boolean;
+}
 interface WorkflowEditorProps {
     document: WorkflowEditorDocument;
     mode?: EditorMode;
+    surface?: WorkflowEditorSurface;
+    layout?: WorkflowEditorLayout;
     messages?: PartialMessages;
     layoutOptions?: LayoutOptions;
+    /** Selectively suppress editor chrome for compact embed scenarios. */
+    chrome?: ChromeOptions;
     onChange?: (doc: WorkflowEditorDocument) => void;
     onSave?: (doc: WorkflowEditorDocument) => void;
+    showSaveButton?: boolean;
+    toolbarStart?: ReactNode;
+    toolbarCenter?: ReactNode;
+    toolbarEnd?: ReactNode;
+    /**
+     * Host-controlled layout/UI metadata. When provided it takes precedence over
+     * the editor's internal localStorage persistence.
+     */
+    layoutMetadata?: WorkflowUiMeta;
+    /** Called whenever layout positions or other editor-only metadata change. */
+    onLayoutMetadataChange?: (meta: WorkflowUiMeta) => void;
+    /** Called with the full per-workflow UI map whenever any layout changes — use this for file-based persistence. */
+    onWorkflowUiChange?: (workflowUi: Record<string, WorkflowUiMeta>) => void;
+    /**
+     * localStorage key prefix for layout persistence. Defaults to
+     * "cyoda-editor-layout". Pass `null` to disable localStorage persistence.
+     */
+    localStorageKey?: string | null;
+    /** Enables the canonical JSON editing surface inside the editor shell. */
+    enableJsonEditor?: boolean;
+    /** Controls whether JSON appears as a tab or alongside the graph. */
+    jsonEditorPlacement?: "tab" | "split";
+    /** Optional host-supplied Monaco runtime/configuration. */
+    jsonEditor?: WorkflowJsonEditorConfig | null;
+    /** Reports JSON parse/schema/apply status for host UX. */
+    onJsonStatusChange?: (status: JsonEditStatus) => void;
+    /**
+     * Show developer-oriented affordances (raw JSON tab in the inspector and
+     * other diagnostics). Defaults to `false` so SMEs/BAs see a clean view.
+     * Existing demo and admin surfaces that previously relied on the JSON tab
+     * should opt in explicitly with `developerMode={true}`.
+     */
+    developerMode?: boolean;
 }
+type WorkflowEditorSurface = "dev-console";
+type WorkflowEditorLayout = "embedded" | "fullWidth";
 /** Top-level editor shell — spec §14. Provides viewer/playground/editor modes. */
-declare function WorkflowEditor({ document: initialDocument, mode, messages, layoutOptions, onChange, onSave, }: WorkflowEditorProps): react_jsx_runtime.JSX.Element;
+declare function WorkflowEditor({ document: initialDocument, mode, surface, layout, messages, layoutOptions, chrome, onChange, onSave, showSaveButton, toolbarStart, toolbarCenter, toolbarEnd, layoutMetadata: externalLayoutMeta, onLayoutMetadataChange, onWorkflowUiChange, localStorageKey, enableJsonEditor, jsonEditorPlacement, jsonEditor, onJsonStatusChange, developerMode, }: WorkflowEditorProps): react.JSX.Element;
 
 interface UseSaveFlowArgs {
     api: WorkflowApi;
@@ -245,7 +483,7 @@ interface SaveConfirmModalProps {
  *    the warning count.
  *  - The diff summary (if provided) is shown above the tick-boxes.
  */
-declare function SaveConfirmModal({ mode, requiresExplicitConfirm, warningCount, diffSummary, onConfirm, onCancel, }: SaveConfirmModalProps): react_jsx_runtime.JSX.Element;
+declare function SaveConfirmModal({ mode, requiresExplicitConfirm, warningCount, diffSummary, onConfirm, onCancel, }: SaveConfirmModalProps): react.JSX.Element;
 
 interface ConflictBannerProps {
     onReload: () => void;
@@ -255,7 +493,7 @@ interface ConflictBannerProps {
  * 409-conflict banner per spec §17.4. Non-dismissable; the user must pick
  * Reload (discard local) or Force overwrite (resend without the token).
  */
-declare function ConflictBanner({ onReload, onForceOverwrite }: ConflictBannerProps): react_jsx_runtime.JSX.Element;
+declare function ConflictBanner({ onReload, onForceOverwrite }: ConflictBannerProps): react.JSX.Element;
 
 /**
  * Produce a short human-readable diff summary between the last-known server
@@ -268,4 +506,4 @@ declare function ConflictBanner({ onReload, onForceOverwrite }: ConflictBannerPr
  */
 declare function diffSummary(server: WorkflowEditorDocument | null, local: WorkflowEditorDocument): string | null;
 
-export { ConflictBanner, type ConflictBannerProps, type EditorMode, I18nContext, type Messages, type PartialMessages, SaveConfirmModal, type SaveConfirmModalProps, type SaveFlow, type Selection, type UseSaveFlowArgs, WorkflowEditor, type WorkflowEditorProps, defaultMessages, diffSummary, mergeMessages, useMessages, useSaveFlow };
+export { type ChromeOptions, ConflictBanner, type ConflictBannerProps, type EditorMode, I18nContext, type JsonEditStatus, type Messages, type PartialMessages, SaveConfirmModal, type SaveConfirmModalProps, type SaveFlow, type Selection, type UseSaveFlowArgs, WorkflowEditor, type WorkflowEditorLayout, type WorkflowEditorProps, type WorkflowEditorSurface, type WorkflowJsonEditorConfig, defaultMessages, diffSummary, mergeMessages, useMessages, useSaveFlow };