@cyoda/workflow-react 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,271 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { WorkflowEditorDocument, 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';
+
+declare const defaultMessages: {
+    toolbar: {
+        undo: string;
+        redo: string;
+        validate: string;
+        errors: string;
+        warnings: string;
+        infos: string;
+        save: string;
+        addWorkflow: string;
+    };
+    inspector: {
+        empty: string;
+        properties: string;
+        json: string;
+        name: string;
+        description: string;
+        version: string;
+        active: string;
+        initialState: string;
+        manual: string;
+        disabled: string;
+        processors: string;
+        criterion: string;
+        executionMode: string;
+        addProcessor: string;
+        removeProcessor: string;
+        moveUp: string;
+        moveDown: string;
+        issues: string;
+        sourceAnchor: string;
+        targetAnchor: string;
+        anchorDefault: string;
+        anchorTop: string;
+        anchorRight: string;
+        anchorBottom: string;
+        anchorLeft: string;
+    };
+    confirmDelete: {
+        title: string;
+        message: string;
+        transitionsAffected: string;
+        confirm: string;
+        cancel: string;
+    };
+    dragConnect: {
+        title: string;
+        transitionName: string;
+        create: string;
+        cancel: string;
+        invalidName: string;
+        duplicateName: string;
+    };
+    tabs: {
+        closeTab: string;
+        untitled: string;
+    };
+    saveConfirm: {
+        title: string;
+        modeLabel: string;
+        ackReplace: string;
+        ackActivate: string;
+        ackWarnings: string;
+        confirm: string;
+        cancel: string;
+    };
+    conflict: {
+        message: string;
+        reload: string;
+        forceOverwrite: string;
+    };
+};
+type Messages = typeof defaultMessages;
+
+declare const I18nContext: react.Context<{
+    toolbar: {
+        undo: string;
+        redo: string;
+        validate: string;
+        errors: string;
+        warnings: string;
+        infos: string;
+        save: string;
+        addWorkflow: string;
+    };
+    inspector: {
+        empty: string;
+        properties: string;
+        json: string;
+        name: string;
+        description: string;
+        version: string;
+        active: string;
+        initialState: string;
+        manual: string;
+        disabled: string;
+        processors: string;
+        criterion: string;
+        executionMode: string;
+        addProcessor: string;
+        removeProcessor: string;
+        moveUp: string;
+        moveDown: string;
+        issues: string;
+        sourceAnchor: string;
+        targetAnchor: string;
+        anchorDefault: string;
+        anchorTop: string;
+        anchorRight: string;
+        anchorBottom: string;
+        anchorLeft: string;
+    };
+    confirmDelete: {
+        title: string;
+        message: string;
+        transitionsAffected: string;
+        confirm: string;
+        cancel: string;
+    };
+    dragConnect: {
+        title: string;
+        transitionName: string;
+        create: string;
+        cancel: string;
+        invalidName: string;
+        duplicateName: string;
+    };
+    tabs: {
+        closeTab: string;
+        untitled: string;
+    };
+    saveConfirm: {
+        title: string;
+        modeLabel: string;
+        ackReplace: string;
+        ackActivate: string;
+        ackWarnings: string;
+        confirm: string;
+        cancel: string;
+    };
+    conflict: {
+        message: string;
+        reload: string;
+        forceOverwrite: string;
+    };
+}>;
+declare function useMessages(): Messages;
+type PartialMessages = {
+    [K in keyof Messages]?: Partial<Messages[K]>;
+};
+declare function mergeMessages(overrides?: PartialMessages): Messages;
+
+type EditorMode = "viewer" | "playground" | "editor";
+/** What the user currently has selected on the canvas or inspector. */
+type Selection = null | {
+    kind: "workflow";
+    workflow: string;
+} | {
+    kind: "state";
+    workflow: string;
+    stateCode: string;
+    nodeId: string;
+} | {
+    kind: "transition";
+    transitionUuid: string;
+} | {
+    kind: "processor";
+    processorUuid: string;
+} | {
+    kind: "criterion";
+    hostKind: "workflow" | "transition";
+    hostId: string;
+    path: string[];
+};
+
+interface WorkflowEditorProps {
+    document: WorkflowEditorDocument;
+    mode?: EditorMode;
+    messages?: PartialMessages;
+    layoutOptions?: LayoutOptions;
+    onChange?: (doc: WorkflowEditorDocument) => void;
+    onSave?: (doc: WorkflowEditorDocument) => void;
+}
+/** 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;
+
+interface UseSaveFlowArgs {
+    api: WorkflowApi;
+    document: WorkflowEditorDocument;
+    /**
+     * Concurrency token from the last successful `exportWorkflows` / `importWorkflows`.
+     * `null` means we have no server context (first-save scenario).
+     */
+    concurrencyToken: ConcurrencyToken | null;
+    /** Called after a successful save to refresh the session and token. */
+    onSaved: (nextToken: ConcurrencyToken | null) => void;
+    /** Called when the user chooses "Reload" from the conflict banner. */
+    onReload?: () => void;
+}
+interface SaveFlow {
+    status: SaveStatus;
+    /** Show the confirmation modal — REPLACE / ACTIVATE require explicit confirm (§17.3). */
+    requestSave: () => void;
+    /** Called from the modal after the user confirms. */
+    confirmSave: () => Promise<void>;
+    /** Dismiss the confirmation modal without dispatching. */
+    cancel: () => void;
+    /** Force-overwrite branch of the 409 banner (§17.4). */
+    forceOverwrite: () => Promise<void>;
+    /** Reload branch of the 409 banner — delegates to `onReload`. */
+    reload: () => void;
+    /** Reset status back to idle after viewing a success/error toast. */
+    clear: () => void;
+}
+/**
+ * Save-flow hook per spec §17.3. Owns the modal/banner state machine so
+ * the shell only needs to render the current `status` and call `requestSave`
+ * from the toolbar's Save button.
+ */
+declare function useSaveFlow(args: UseSaveFlowArgs): SaveFlow;
+
+interface SaveConfirmModalProps {
+    mode: ImportMode;
+    requiresExplicitConfirm: boolean;
+    warningCount: number;
+    document: WorkflowEditorDocument;
+    /** Summary of changes vs. server state — rendered verbatim above the
+     *  confirm button. Callers who have not fetched server state pass null. */
+    diffSummary?: string | null;
+    onConfirm: () => void;
+    onCancel: () => void;
+}
+/**
+ * Save confirmation modal per spec §17.3 + §18.5.
+ *
+ *  - REPLACE / ACTIVATE require a tick on "I understand this replaces /
+ *    activates server state" before the confirm button enables.
+ *  - When warnings are present, a separate tick is required acknowledging
+ *    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;
+
+interface ConflictBannerProps {
+    onReload: () => void;
+    onForceOverwrite: () => void;
+}
+/**
+ * 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;
+
+/**
+ * Produce a short human-readable diff summary between the last-known server
+ * document and the current editor document (spec §17.3). Counts workflows /
+ * states / transitions added, removed, or changed; returns null when no
+ * server document is available (first-save scenario).
+ *
+ * The summary is intentionally coarse — detailed diffs belong in a dedicated
+ * compare view, not a modal.
+ */
+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 };

package/dist/index.d.ts

@@ -0,0 +1,271 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { WorkflowEditorDocument, 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';
+
+declare const defaultMessages: {
+    toolbar: {
+        undo: string;
+        redo: string;
+        validate: string;
+        errors: string;
+        warnings: string;
+        infos: string;
+        save: string;
+        addWorkflow: string;
+    };
+    inspector: {
+        empty: string;
+        properties: string;
+        json: string;
+        name: string;
+        description: string;
+        version: string;
+        active: string;
+        initialState: string;
+        manual: string;
+        disabled: string;
+        processors: string;
+        criterion: string;
+        executionMode: string;
+        addProcessor: string;
+        removeProcessor: string;
+        moveUp: string;
+        moveDown: string;
+        issues: string;
+        sourceAnchor: string;
+        targetAnchor: string;
+        anchorDefault: string;
+        anchorTop: string;
+        anchorRight: string;
+        anchorBottom: string;
+        anchorLeft: string;
+    };
+    confirmDelete: {
+        title: string;
+        message: string;
+        transitionsAffected: string;
+        confirm: string;
+        cancel: string;
+    };
+    dragConnect: {
+        title: string;
+        transitionName: string;
+        create: string;
+        cancel: string;
+        invalidName: string;
+        duplicateName: string;
+    };
+    tabs: {
+        closeTab: string;
+        untitled: string;
+    };
+    saveConfirm: {
+        title: string;
+        modeLabel: string;
+        ackReplace: string;
+        ackActivate: string;
+        ackWarnings: string;
+        confirm: string;
+        cancel: string;
+    };
+    conflict: {
+        message: string;
+        reload: string;
+        forceOverwrite: string;
+    };
+};
+type Messages = typeof defaultMessages;
+
+declare const I18nContext: react.Context<{
+    toolbar: {
+        undo: string;
+        redo: string;
+        validate: string;
+        errors: string;
+        warnings: string;
+        infos: string;
+        save: string;
+        addWorkflow: string;
+    };
+    inspector: {
+        empty: string;
+        properties: string;
+        json: string;
+        name: string;
+        description: string;
+        version: string;
+        active: string;
+        initialState: string;
+        manual: string;
+        disabled: string;
+        processors: string;
+        criterion: string;
+        executionMode: string;
+        addProcessor: string;
+        removeProcessor: string;
+        moveUp: string;
+        moveDown: string;
+        issues: string;
+        sourceAnchor: string;
+        targetAnchor: string;
+        anchorDefault: string;
+        anchorTop: string;
+        anchorRight: string;
+        anchorBottom: string;
+        anchorLeft: string;
+    };
+    confirmDelete: {
+        title: string;
+        message: string;
+        transitionsAffected: string;
+        confirm: string;
+        cancel: string;
+    };
+    dragConnect: {
+        title: string;
+        transitionName: string;
+        create: string;
+        cancel: string;
+        invalidName: string;
+        duplicateName: string;
+    };
+    tabs: {
+        closeTab: string;
+        untitled: string;
+    };
+    saveConfirm: {
+        title: string;
+        modeLabel: string;
+        ackReplace: string;
+        ackActivate: string;
+        ackWarnings: string;
+        confirm: string;
+        cancel: string;
+    };
+    conflict: {
+        message: string;
+        reload: string;
+        forceOverwrite: string;
+    };
+}>;
+declare function useMessages(): Messages;
+type PartialMessages = {
+    [K in keyof Messages]?: Partial<Messages[K]>;
+};
+declare function mergeMessages(overrides?: PartialMessages): Messages;
+
+type EditorMode = "viewer" | "playground" | "editor";
+/** What the user currently has selected on the canvas or inspector. */
+type Selection = null | {
+    kind: "workflow";
+    workflow: string;
+} | {
+    kind: "state";
+    workflow: string;
+    stateCode: string;
+    nodeId: string;
+} | {
+    kind: "transition";
+    transitionUuid: string;
+} | {
+    kind: "processor";
+    processorUuid: string;
+} | {
+    kind: "criterion";
+    hostKind: "workflow" | "transition";
+    hostId: string;
+    path: string[];
+};
+
+interface WorkflowEditorProps {
+    document: WorkflowEditorDocument;
+    mode?: EditorMode;
+    messages?: PartialMessages;
+    layoutOptions?: LayoutOptions;
+    onChange?: (doc: WorkflowEditorDocument) => void;
+    onSave?: (doc: WorkflowEditorDocument) => void;
+}
+/** 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;
+
+interface UseSaveFlowArgs {
+    api: WorkflowApi;
+    document: WorkflowEditorDocument;
+    /**
+     * Concurrency token from the last successful `exportWorkflows` / `importWorkflows`.
+     * `null` means we have no server context (first-save scenario).
+     */
+    concurrencyToken: ConcurrencyToken | null;
+    /** Called after a successful save to refresh the session and token. */
+    onSaved: (nextToken: ConcurrencyToken | null) => void;
+    /** Called when the user chooses "Reload" from the conflict banner. */
+    onReload?: () => void;
+}
+interface SaveFlow {
+    status: SaveStatus;
+    /** Show the confirmation modal — REPLACE / ACTIVATE require explicit confirm (§17.3). */
+    requestSave: () => void;
+    /** Called from the modal after the user confirms. */
+    confirmSave: () => Promise<void>;
+    /** Dismiss the confirmation modal without dispatching. */
+    cancel: () => void;
+    /** Force-overwrite branch of the 409 banner (§17.4). */
+    forceOverwrite: () => Promise<void>;
+    /** Reload branch of the 409 banner — delegates to `onReload`. */
+    reload: () => void;
+    /** Reset status back to idle after viewing a success/error toast. */
+    clear: () => void;
+}
+/**
+ * Save-flow hook per spec §17.3. Owns the modal/banner state machine so
+ * the shell only needs to render the current `status` and call `requestSave`
+ * from the toolbar's Save button.
+ */
+declare function useSaveFlow(args: UseSaveFlowArgs): SaveFlow;
+
+interface SaveConfirmModalProps {
+    mode: ImportMode;
+    requiresExplicitConfirm: boolean;
+    warningCount: number;
+    document: WorkflowEditorDocument;
+    /** Summary of changes vs. server state — rendered verbatim above the
+     *  confirm button. Callers who have not fetched server state pass null. */
+    diffSummary?: string | null;
+    onConfirm: () => void;
+    onCancel: () => void;
+}
+/**
+ * Save confirmation modal per spec §17.3 + §18.5.
+ *
+ *  - REPLACE / ACTIVATE require a tick on "I understand this replaces /
+ *    activates server state" before the confirm button enables.
+ *  - When warnings are present, a separate tick is required acknowledging
+ *    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;
+
+interface ConflictBannerProps {
+    onReload: () => void;
+    onForceOverwrite: () => void;
+}
+/**
+ * 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;
+
+/**
+ * Produce a short human-readable diff summary between the last-known server
+ * document and the current editor document (spec §17.3). Counts workflows /
+ * states / transitions added, removed, or changed; returns null when no
+ * server document is available (first-save scenario).
+ *
+ * The summary is intentionally coarse — detailed diffs belong in a dedicated
+ * compare view, not a modal.
+ */
+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 };