@parallelworks/ui 0.51.0 → 0.52.0

package/dist/components/Popover.js

@@ -1,7 +1,7 @@
 import { cx } from "../cx.js";
 import { panelClassName, positionerClassName, tipClassName, toPositionerAnchor } from "./floating.js";
 import { jsx, jsxs } from "react/jsx-runtime";
-import { createContext, use, useRef } from "react";
+import { createContext, use, useCallback, useRef } from "react";
 import { Popover } from "@base-ui/react/popover";
 //#region src/components/Popover.tsx
 /** A button that closes the popover it sits in. */
@@ -20,6 +20,7 @@ function Popover$1({ trigger, at, title, open, defaultOpen, onOpenChange, side =
 	const tip = variant === "tip";
 	const popup = useRef(null);
 	const actions = useRef(null);
+	const close = useCallback(() => actions.current?.close(), []);
 	return /* @__PURE__ */ jsxs(Popover.Root, {
 		actionsRef: actions,
 		...open === void 0 ? {} : { open },
@@ -51,7 +52,7 @@ function Popover$1({ trigger, at, title, open, defaultOpen, onOpenChange, side =
 						children: title
 					}),
 					/* @__PURE__ */ jsx(CloseContext, {
-						value: () => actions.current?.close(),
+						value: close,
 						children
 					})
 				]

package/dist/components/Provider.d.ts

@@ -75,6 +75,10 @@ export interface UIStrings {
         remove: string;
         sort: string;
         userAvatar: string;
+        /** A person's presence beside their avatar, read with their name. */
+        presence: Record<'online' | 'offline' | 'busy' | 'away', string>;
+        /** An avatar's name with the person's presence, such as "Ada Lovelace, online". */
+        withPresence: (name: string, presence: string) => string;
         moreInfo: string;
         /** The name of a menu of actions on a page or row. */
         actions: string;
@@ -84,10 +88,16 @@ export interface UIStrings {
         clearSearch: string;
         filterPlaceholder: string;
         breadcrumb: string;
+        /** Names the menu of the breadcrumbs a narrow trail folds away. */
+        showFullPath: string;
         yes: string;
         no: string;
         /** Read after a link that opens a new tab. */
         opensInNewTab: string;
+        /** Names a code editor that has no label of its own. */
+        codeEditor: string;
+        /** Shown when someone types in a read-only code editor. */
+        readOnlyText: string;
         /** Names the handle that resizes a panel. */
         resizePanel: string;
         /** A resizable panel's width, read aloud. */
@@ -105,6 +115,8 @@ export interface UIStrings {
         add: (text: string) => string;
         /** In place of the placeholder once a field holds as many values as it takes. */
         limitReached: (max: number) => string;
+        /** Names the button on a chosen value's chip that takes it out. */
+        removeValue: (label: string) => string;
     };
     datePicker: {
         /** The button's text while no date is chosen. */
@@ -193,6 +205,8 @@ export interface UIStrings {
         endInFuture: string;
         follow: string;
         following: string;
+        /** A line number's name: it selects the line for copying. */
+        selectLine: (line: number) => string;
     };
     dag: {
         workflow: string;
@@ -226,6 +240,13 @@ export interface UIStrings {
             warning: string;
             notice: string;
         };
+        /** Names the annotations' toggle for a screen reader, in place of its count badges, such as
+         *  "Annotations: 2 errors, 1 warning". It starts with `annotations`, the toggle's visible text. */
+        annotationsLabel: (counts: {
+            error: number;
+            warning: number;
+            notice: number;
+        }) => 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. */
@@ -251,9 +272,10 @@ export interface UIStrings {
             previewTab: string;
             preview: string;
             openFullPreview: string;
-            /** Names the choice between a quick look and the full window. */
+            /** Names the choice between a compact preview and the full window. */
             previewLayout: string;
-            quickLook: string;
+            /** The preview in a panel over the page, beside `fullWindow`. */
+            compact: string;
             fullWindow: string;
             streamed: string;
             streamedTooltip: string;
@@ -360,6 +382,10 @@ export interface UIStrings {
             corsAdded: string;
             corsPropagating: string;
             previewUnsupported: string;
+            /** A folder's listing failed; `name` is the folder. */
+            loadFailed: (name: string, message: string) => string;
+            /** A failure that came with no message of its own. */
+            unknownError: string;
         };
         chrome: {
             explorer: string;
@@ -382,6 +408,14 @@ export interface UIStrings {
             details: string;
             selectFiles: string;
             selectFolder: string;
+            /** Names the table of a folder's contents. */
+            files: string;
+            /** Names the folder tree. */
+            folders: string;
+            /** Names the trail from the storage down to the open folder. */
+            location: string;
+            /** Explains a share link, beside Share. */
+            shareHelp: string;
         };
         confirmUpload: {
             title: string;
@@ -468,8 +502,6 @@ export interface UIStrings {
         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;
@@ -494,6 +526,12 @@ export interface UIStrings {
         labelId: string;
         labelUrl: string;
         couldNotLoad: (noun: string) => string;
+        /** What `ListError` names when the host gives no noun. */
+        data: string;
+        /** A list's size, as `ListCount` shows it; `count` is formatted and `noun` agrees with it. */
+        count: (count: string, noun: string) => string;
+        /** How many rows a filter left, of how many. */
+        matchCount: (matches: string, total: string, nounPlural: string) => string;
         displayOptions: string;
         grouping: string;
         ordering: string;
@@ -503,6 +541,8 @@ export interface UIStrings {
         descending: string;
         columnHeaders: string;
         showColumnHeaders: string;
+        /** The header checkbox that ticks every row, or clears them all. */
+        selectAll: string;
         showActions: string;
         showRowActions: string;
         alwaysShowActions: string;
@@ -521,6 +561,12 @@ export interface UIStrings {
         removeSearchTerm: (term: string) => string;
     };
 }
+/** What a host passes to translate the strings: any group, any string in it, at any depth.
+ *  A string it leaves out stays in English. */
+export type UIStringOverrides = Overrides<UIStrings>;
+type Overrides<T> = {
+    [K in keyof T]?: T[K] extends (...args: never[]) => unknown ? T[K] : T[K] extends readonly unknown[] ? T[K] : T[K] extends object ? Overrides<T[K]> : T[K];
+};
 export interface UINavigation {
     goTo: (to: string) => void;
     /** Opens the source of a step that runs another workflow, named by its `uses`;
@@ -574,11 +620,14 @@ export interface UIData {
     usePersistedState: PersistedStateHook;
 }
 import type { FieldComponent } from '../form/fieldRegistry.js';
-import type { PageHeaderCrumb } from './PageHeader.js';
-/** Renders internal navigation; hosts bind their router's Link. Accessibility
- * and tooltip data attributes pass through so header links keep their labels. */
-/** An internal navigation link. It passes every other prop, ref included, to
- *  its anchor, so menus and tooltips can attach to it. */
+import type { Breadcrumb } from './pageHeaderStore.js';
+/** An internal navigation link, which hosts bind to their router's Link. Its
+ *  `href` is a full in-app URL that may carry a search and a hash, such as
+ *  `/runs/42?tab=logs#step-3`, and the host routes all of it client-side on a
+ *  plain click, leaving modified and middle clicks to the browser. It passes
+ *  every other prop, ref included, to its anchor, so menus and tooltips can
+ *  attach to it. Components render it through `AppLink`, which sanitizes the
+ *  href and keeps full page loads and other origins off the router. */
 export type UILinkComponent = React.ComponentType<React.ComponentPropsWithRef<'a'> & {
     href: string;
 }>;
@@ -632,7 +681,7 @@ export interface UISlots {
     }) => ReactNode;
     /** Pin affordance rendered after the page header's crumb trail; absent hides it. */
     breadcrumbPin?: (args: {
-        crumbs: readonly PageHeaderCrumb[];
+        crumbs: readonly Breadcrumb[];
     }) => ReactNode;
     /** Control rendered at the start of the page header row, before the crumb
      * trail — the host's app-nav toggle. Absent hides it. */
@@ -661,13 +710,22 @@ 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({ strings, navigation, data, slots, engine, children, }: {
-    strings?: {
-        [G in keyof UIStrings]?: UIStrings[G] extends object ? Partial<UIStrings[G]> : UIStrings[G];
-    };
-    navigation?: Partial<UINavigation>;
-    data?: Partial<UIData>;
-    slots?: UISlots;
-    engine?: WorkflowEngineSource;
+export interface UIProviderProps {
+    /** Translations over the English defaults, at any depth. Define them outside a component, or
+     *  memoize them: the provider compares them by value, but a function made each render differs. */
+    strings?: UIStringOverrides | undefined;
+    /** How the package navigates; read at the moment it navigates, so a new one never re-renders. */
+    navigation?: Partial<UINavigation> | undefined;
+    /** The host's data hooks and resolvers. `useRunFile` and `usePersistedState` are called as
+     *  hooks, so each must stay the same function for the life of the app. */
+    data?: Partial<UIData> | undefined;
+    /** Components the host renders inside the package's; a component made each render would
+     *  remount everything it renders. */
+    slots?: UISlots | undefined;
+    /** The engine, or a loader that resolves to it. A loader is called once, the first one
+     *  passed, so it may be written inline. */
+    engine?: WorkflowEngineSource | undefined;
     children: React.ReactNode;
-}): import("react").JSX.Element;
+}
+export declare function UIProvider({ strings, navigation, data, slots, engine: engineProp, children, }: UIProviderProps): import("react").JSX.Element;
+export {};