@parallelworks/ui 0.44.0 → 0.46.0

package/dist/components/Provider.d.ts

@@ -1,42 +1,10 @@
 import type { Dispatch, ReactNode, SetStateAction } from 'react';
 import type { WorkflowAction, WorkflowEditing } from '../editing.js';
 import type { WorkflowEngine } from '../engine.js';
-import type { GraphEditorStrings, InputsEditorStrings } from '../graph/editorStrings.js';
+import type { GraphEditorText, InputsEditorText } from '../graph/editorStrings.js';
 import type { RunLink } from '../graph/types.js';
-export type UIToastId = string | number;
-export interface UIToastOptions {
-    toastId?: UIToastId;
-    /** false hides the default icon. */
-    icon?: false;
-    closeButton?: boolean;
-    autoClose?: number | false;
-}
-export interface UIToastUpdate {
-    render?: ReactNode;
-    type?: 'info' | 'success' | 'warning' | 'error';
-    /** false or null hides the icon. */
-    icon?: false | null;
-    isLoading?: boolean;
-    closeButton?: boolean | null;
-    autoClose?: number | false | null;
-}
-export interface UINotify {
-    info: (message: string) => void;
-    success: (message: string) => void;
-    warning: (message: string) => void;
-    error: (message: string) => void;
-    /** Persistent spinner toast; drive it with update/dismiss via the returned id. */
-    loading: (content: ReactNode, options?: UIToastOptions) => UIToastId;
-    update: (id: UIToastId, update: UIToastUpdate) => void;
-    /** Without an id, dismisses every open toast. */
-    dismiss: (id?: UIToastId) => void;
-}
 export interface UIStrings {
-    loading: string;
     modal: {
-        cancel: string;
-        close: string;
-        create: string;
         creating: string;
         addDescription: string;
         advanced: string;
@@ -44,12 +12,57 @@ export interface UIStrings {
         favorited: string;
         favoriteHintOn: string;
         favoriteHintOff: string;
-        filter: string;
     };
     common: {
-        copy: string;
+        cancel: string;
+        close: string;
+        save: string;
+        clear: string;
+        delete: string;
+        download: string;
+        retry: string;
+        reset: string;
+        apply: string;
+        dismiss: string;
+        /** Names the region toasts appear in. */
+        notifications: string;
+        rename: string;
+        share: string;
+        send: string;
+        filter: string;
+        loading: string;
+        loadMore: string;
+        showMore: string;
+        showLess: string;
+        previous: string;
+        next: string;
+        zoomIn: string;
+        zoomOut: string;
+        expandAll: string;
+        collapseAll: string;
+        moveUp: string;
+        moveDown: string;
+        undo: string;
+        redo: string;
+        duplicate: string;
         copied: string;
+        copyToClipboard: string;
+        /** The toast after a copy that names nothing. */
+        copiedToClipboard: string;
         copyFailed: string;
+        /** `label` names what is copied, such as "email address". */
+        copyThing: (label: string) => string;
+        copiedThing: (label: string) => string;
+        copyThingFailed: (label: string) => string;
+        /** A name field's rule: the characters a key or identifier allows. */
+        invalidName: string;
+        invalidNumber: string;
+        copy: string;
+        /** A masked value's eye toggle, for a password or a secret. */
+        showValue: string;
+        hideValue: string;
+        expand: string;
+        collapse: string;
         showHiddenFields: string;
         showHiddenFieldsHint: string;
         jsonHasErrors: string;
@@ -59,11 +72,88 @@ export interface UIStrings {
         sort: string;
         userAvatar: string;
         moreInfo: string;
+        /** The name of a menu of actions on a page or row. */
+        actions: string;
+        edit: string;
+        submit: string;
+        search: string;
+        clearSearch: string;
+        filterPlaceholder: string;
+        breadcrumb: string;
+        yes: string;
+        no: string;
+        /** Read after a link that opens a new tab. */
+        opensInNewTab: string;
+        /** Names the handle that resizes a panel. */
+        resizePanel: string;
+        /** A resizable panel's width, read aloud. */
+        panelWidth: (px: number) => string;
+        refresh: string;
+        refreshing: string;
+        /** A refresh button's label once it knows when the data was fetched. */
+        updated: (ago: string) => string;
     };
     dropdown: {
         select: (type: string) => string;
         noOptionsFound: string;
         showOptions: string;
+        /** The row that adds typed text as a new value. */
+        add: (text: string) => string;
+        /** In place of the placeholder once a field holds as many values as it takes. */
+        limitReached: (max: number) => string;
+    };
+    datePicker: {
+        /** The button's text while no date is chosen. */
+        pickDate: string;
+        /** Names the time beside the date. */
+        time: string;
+        previousMonth: string;
+        nextMonth: string;
+    };
+    theme: {
+        /** Names the light, dark or system choice. */
+        appearance: string;
+        light: string;
+        dark: string;
+        system: string;
+        /** Names the choice of which mode's colors the controls edit. */
+        editing: string;
+        presets: string;
+        /** The background a theme is generated from. */
+        base: string;
+        accent: string;
+        contrast: string;
+        /** Under the contrast slider. */
+        contrastHelp: string;
+        /** The switch that gives the sidebar its own colors. */
+        customSidebar: string;
+        sidebarBase: string;
+        sidebarAccent: string;
+        code: string;
+        codeStyle: (style: 'balanced' | 'vivid' | 'muted' | 'mono') => string;
+        /** Names a color input's picker, beside its hex field. */
+        pick: (name: string) => string;
+        invalidColor: string;
+        copy: string;
+        /** The thing a copy toast names. */
+        copied: string;
+        import: string;
+        importLabel: string;
+        importPlaceholder: string;
+        apply: string;
+        reset: string;
+        /** Why a pasted theme was refused. */
+        importError: (code: 'json' | 'version' | 'shape' | 'color' | 'range', path: string) => string;
+        preview: string;
+        previewNav: readonly string[];
+        previewHeading: string;
+        previewBody: string;
+        previewMuted: string;
+        previewLink: string;
+        previewButton: string;
+        previewSearch: string;
+        previewPassed: string;
+        previewFailed: string;
     };
     logviewer: {
         error: string;
@@ -76,7 +166,6 @@ export interface UIStrings {
         hideDebug: string;
         showDebug: string;
         filterLogs: string;
-        download: string;
         beginningOfLog: string;
         loadingOlderEntries: string;
         loadOlderEntries: string;
@@ -87,12 +176,12 @@ export interface UIStrings {
         timeRangeHelp: string;
         timeRangeFrom: string;
         timeRangeTo: string;
-        apply: string;
-        clear: string;
         invalidStartTime: string;
         invalidEndTime: string;
         endBeforeStart: string;
         endInFuture: string;
+        follow: string;
+        following: string;
     };
     dag: {
         workflow: string;
@@ -100,10 +189,6 @@ export interface UIStrings {
         status: string;
         runtime: string;
         submitted: string;
-        expandAll: string;
-        collapseAll: string;
-        zoomIn: string;
-        zoomOut: string;
         resetView: string;
         previousGraph: string;
         nextGraph: string;
@@ -114,6 +199,26 @@ export interface UIStrings {
         logLoadFailed: string;
         statusLabel: (status: string) => string;
         statusReason: (reason: string | undefined | null) => string | undefined;
+        /** A run's general log, beside its summary. */
+        generalLog: string;
+        previousStep: string;
+        nextStep: string;
+        /** The view toggle: the graph, and the list of jobs and steps. */
+        graphView: string;
+        treeView: string;
+        summary: string;
+        dependsOn: string;
+        subworkflow: string;
+        annotations: string;
+        annotationType: {
+            error: string;
+            warning: string;
+            notice: string;
+        };
+        /** Where an annotation came from, under its message. */
+        annotationSource: (job: string, step: string) => string;
+        /** A step without a name, numbered from 0 as the run reports it. */
+        stepNumber: (index: number) => string;
     };
     jobActions: {
         openSubworkflowLogs: string;
@@ -121,8 +226,8 @@ export interface UIStrings {
         openInNewGraph: string;
     };
     /** The visual editor's text a host translates; the editor fills in the rest in English. */
-    graphEditor: Partial<GraphEditorStrings>;
-    inputsEditor: Partial<InputsEditorStrings>;
+    graphEditor: Partial<GraphEditorText>;
+    inputsEditor: Partial<InputsEditorText>;
     fileExplorer: {
         preview: {
             shareFile: string;
@@ -131,11 +236,12 @@ export interface UIStrings {
             select: (name: string) => string;
             viewDetails: string;
             openFolder: string;
-            delete: string;
             detailsTab: string;
             previewTab: string;
             preview: string;
             openFullPreview: string;
+            /** Names the choice between a quick look and the full window. */
+            previewLayout: string;
             quickLook: string;
             fullWindow: string;
             streamed: string;
@@ -153,10 +259,6 @@ export interface UIStrings {
             unsupportedMessage: string;
             notebookParseError: string;
             copyUri: string;
-            download: string;
-            close: string;
-            zoomIn: string;
-            zoomOut: string;
             previousFile: string;
             nextFile: string;
             csvRows: (count: number, columns: number) => string;
@@ -176,7 +278,6 @@ export interface UIStrings {
             success: (name: string) => string;
             error: (message: string) => string;
             invalidTarget: string;
-            noWriteAccess: string;
             unsupported: string;
             validation: {
                 reserved: string;
@@ -185,6 +286,9 @@ export interface UIStrings {
             };
         };
         readOnly: string;
+        /** Names what a copy took, in its toast. */
+        fileLink: string;
+        uri: string;
         cors: {
             explanation: {
                 title: string;
@@ -193,7 +297,6 @@ export interface UIStrings {
                 note: string;
             };
             actions: {
-                retry: string;
                 addRules: string;
             };
             propagating: {
@@ -211,13 +314,10 @@ export interface UIStrings {
         };
         selectedCount: (count: number) => string;
         loadingMore: string;
-        loadMore: string;
-        retry: string;
         partialCount: (count: number) => string;
         notFound: {
             title: (name: string) => string;
             description: string;
-            retry: string;
         };
         treeMoreCount: (count: number) => string;
         treeMoreCountPartial: (count: number) => string;
@@ -227,10 +327,7 @@ export interface UIStrings {
             noFilesForDownload: string;
             downloadLinkFailed: string;
             fileLinkFailed: string;
-            fileLinkCopied: string;
             noUri: string;
-            uriCopied: string;
-            uriCopyFailed: string;
             storageUnavailable: string;
             waitForCurrentUpload: string;
             waitForUpload: string;
@@ -251,24 +348,29 @@ export interface UIStrings {
             corsNoStorage: string;
             corsAdded: string;
             corsPropagating: string;
+            previewUnsupported: string;
         };
         chrome: {
             explorer: string;
-            refresh: string;
-            collapse: string;
             upload: string;
-            download: string;
             downloadFromBrowser: string;
             access: string;
             manageAccess: string;
-            delete: string;
-            copyToClipboard: string;
             selectAll: string;
             name: string;
             size: string;
             created: string;
             hash: string;
             storageIconAlt: string;
+            type: string;
+            storages: string;
+            modified: string;
+            lastModified: string;
+            contentType: string;
+            storageClass: string;
+            details: string;
+            selectFiles: string;
+            selectFolder: string;
         };
         confirmUpload: {
             title: string;
@@ -277,7 +379,6 @@ export interface UIStrings {
             noPath: string;
             confirm: string;
             target: string;
-            totalSize: string;
             sizeLimitTitle: string;
             sizeLimitBody: (total: string, max: string) => string;
             sizeLimitHint: string;
@@ -285,7 +386,6 @@ export interface UIStrings {
         confirmDelete: {
             title: string;
             text: string;
-            action: string;
         };
         empty: {
             nothingSelected: string;
@@ -294,7 +394,6 @@ export interface UIStrings {
             dropHint: string;
             readOnlyHint: string;
             connectionIssue: string;
-            tryAgain: string;
             shareThisFile: string;
         };
         upload: {
@@ -304,32 +403,43 @@ export interface UIStrings {
             eta: string;
             uploading: string;
             completeTitle: string;
-            completeShort: string;
             failedTitle: string;
-            failedShort: string;
             unknownTitle: string;
             unknownShort: string;
-            cancelled: string;
+            canceled: string;
             completed: string;
             failed: string;
             totalSize: string;
             size: string;
             calculating: string;
+            /** In place of the time left once only a few seconds remain. */
+            almostDone: string;
             expandDetails: string;
             minimizeDetails: string;
             sessionNotQueued: (id: string, status: string) => string;
-            allCancelled: (count: number) => string;
+            allCanceled: (count: number) => string;
             someUploaded: (count: number) => string;
-            someCancelled: (count: number) => string;
+            someCanceled: (count: number) => string;
             allUploaded: string;
             failedSummary: (failed: number, total: number) => string;
             failReasonGeneric: string;
             refreshFailed: (name: string, message: string) => string;
             unknownError: string;
             overallProgress: string;
+            cancelFile: (name: string) => string;
+            confirmCancelFile: string;
+            confirmCancelAll: string;
+            filesDone: (done: number, total: number) => string;
+            progress: (uploading: number, done: number, total: number) => string;
+            fileCount: (count: number) => string;
+            keepPageOpen: string;
         };
     };
     form: {
+        /** Under a field the form needs a value in. */
+        required: string;
+        /** Under a field the server rejected without saying why. */
+        checkValue: string;
         invalidDuration: string;
         durationOutOfRange: (min: string, max: string) => string;
         durationBelowMin: (min: string) => string;
@@ -337,8 +447,24 @@ export interface UIStrings {
         copyTitle: (title: string, number: number) => string;
         addCopy: (title: string) => string;
         removeCopy: (title: string) => string;
-        /** A wizard's row of step dots. */
+        /** A wizard's steps: what its list of them is called. */
         steps: string;
+        /** Where a wizard is, numbered from 1. */
+        stepOf: (number: number, total: number) => string;
+        /** The button that opens the list of a wizard's steps. */
+        allSteps: string;
+        /** A step before the current one. */
+        stepDone: string;
+        /** A step with a value to fix. */
+        stepNeedsAttention: string;
+        previousStep: string;
+        nextStep: string;
+        /** A wizard's last button, unless its config names its own. */
+        runWizard: string;
+        fixErrorsToContinue: string;
+        stepFailed: string;
+        /** A step's name in the list of steps, numbered from 1. */
+        stepLabel: (number: number, title: string) => string;
     };
     time: {
         now: string;
@@ -348,10 +474,6 @@ export interface UIStrings {
         years: (n: number) => string;
     };
     list: {
-        copyMenu: string;
-        copy: (label: string) => string;
-        copied: (label: string) => string;
-        couldntCopy: (label: string) => string;
         moreActions: string;
         /** A toolbar toggle's name in the overflow menu, where a row can't be pressed. */
         labelName: string;
@@ -377,18 +499,15 @@ export interface UIStrings {
         displayProperties: string;
         pinnedActions: string;
         pinnedActionsHelp: string;
-        reset: string;
         none: string;
-        filter: string;
-        clear: string;
         searchOptions: string;
         /** `atLeast`: `total` is a floor, because the count was capped and more rows follow. */
         pager: (start: number, end: number, total: number, atLeast: boolean) => string;
         perPage: string;
         paginationPrevious: string;
         paginationNext: string;
-        paginationShowing: (name: string, start: number | string, end: number | string) => ReactNode;
-        paginationShowingTimeRange: (name: string, startTime: string, endTime: string) => ReactNode;
+        pagination: string;
+        removeSearchTerm: (term: string) => string;
     };
 }
 export interface UINavigation {
@@ -510,7 +629,6 @@ export interface UISlots {
 }
 /** An engine, or a loader so the host can keep the engine out of its first-load bundle. */
 export type WorkflowEngineSource = WorkflowEngine | (() => Promise<WorkflowEngine>);
-export declare function useNotify(): UINotify;
 export declare function useStrings(): UIStrings;
 export declare function useNavigation(): UINavigation;
 export declare function useWorkflowJsonResolver(): UIData['resolveWorkflowJson'];
@@ -532,8 +650,7 @@ export declare function useRunFile(slug: string, path: string | null, options?:
     refreshInterval?: number;
 }): RunFileResult;
 export declare function usePersistedState<T>(key: string, defaultValue: T): [T, Dispatch<SetStateAction<T>>];
-export declare function UIProvider({ notify, strings, navigation, data, slots, engine, children, }: {
-    notify?: Partial<UINotify>;
+export declare function UIProvider({ strings, navigation, data, slots, engine, children, }: {
     strings?: {
         [G in keyof UIStrings]?: UIStrings[G] extends object ? Partial<UIStrings[G]> : UIStrings[G];
     };