@overvis/hmi-workspace-ui 0.0.0-stage → 0.1.1

package/dist/src/workspace/setup/report/table-editor.d.ts

@@ -0,0 +1,9 @@
+import type { ReportParameterShellForm, TableSetup } from "@overvis/hmi-shared/report";
+export declare function TableRepresentationCard({ representationKey, setup, snapshots, defaultOpen, onChange, onRemove, }: {
+    representationKey: string;
+    setup: TableSetup;
+    snapshots: readonly ReportParameterShellForm[];
+    defaultOpen?: boolean;
+    onChange: (next: TableSetup) => void;
+    onRemove: () => void;
+}): import("react").JSX.Element;

package/dist/src/workspace/setup/report/time-buckets-editor.d.ts

@@ -0,0 +1,9 @@
+import type { ReportParameterShellForm, TimeBucketsSetup } from "@overvis/hmi-shared/report";
+export declare function TimeBucketsRepresentationCard({ representationKey, setup, snapshots, defaultOpen, onChange, onRemove, }: {
+    representationKey: string;
+    setup: TimeBucketsSetup;
+    snapshots: readonly ReportParameterShellForm[];
+    defaultOpen?: boolean;
+    onChange: (next: TimeBucketsSetup) => void;
+    onRemove: () => void;
+}): import("react").JSX.Element;

package/dist/src/workspace/setup/route/dialog.d.ts

@@ -0,0 +1,33 @@
+import type { ReactNode } from "react";
+/** Outer page wrapper in dialog presentation (fills sticky dialog body slot). */
+export declare function SetupRouteDialogPage({ className, ...props }: React.ComponentProps<"div">): import("react").JSX.Element;
+/**
+ * Scrollable form fields + sticky action footer for `SetupRouteDialog` with `stickyChrome`.
+ * Place inside `form.FormRoot` (footer buttons must stay in the `<form>`).
+ */
+export declare function SetupRouteDialogFormChrome({ bodyClassName, children, footer, notice, }: {
+    bodyClassName?: string;
+    children: ReactNode;
+    footer: ReactNode;
+    /** Shown above the form error, next to the actions (e.g. `SetupConflictNotice`). */
+    notice?: ReactNode;
+}): import("react").JSX.Element;
+/**
+ * Route-driven Setup dialog: open while the child route is mounted; close navigates away via onClose.
+ * Overlay is scoped to the host content region (header and assistant stay live).
+ *
+ * `stickyChrome`: fixed header; child supplies scroll body + sticky footer via
+ * `SetupRouteDialogFormChrome`.
+ */
+export declare function SetupRouteDialog({ onClose, title, description, entityId, contentClassName, stickyChrome, open, backdropBlur, children, }: {
+    onClose: () => void;
+    title?: string;
+    description?: string;
+    /** Existing entity uuid; omit on create. Shown under the title, copyable. */
+    entityId?: string;
+    contentClassName?: string;
+    stickyChrome?: boolean;
+    open?: boolean;
+    backdropBlur?: boolean;
+    children: ReactNode;
+}): import("react").JSX.Element;

package/dist/src/workspace/setup/route/dialogs.d.ts

@@ -0,0 +1,41 @@
+import type { RecordedAddress } from "../endpoints/status-recorded.js";
+export declare function SetupParameterFormDialog({ workspaceId, parameterId, initialBranchId, recorded, onClose: onCloseProp, }: {
+    workspaceId: string;
+    parameterId?: string;
+    initialBranchId?: string;
+    /** A new parameter for an address the device recorded readings of. */
+    recorded?: RecordedAddress;
+    /** Defaults to navigating back to the Setup → Parameters list. */
+    onClose?: () => void;
+}): import("react").JSX.Element;
+export declare function SetupEndpointCreateDialog({ workspaceId }: {
+    workspaceId: string;
+}): import("react").JSX.Element;
+export declare function SetupEndpointEditDialog({ workspaceId, endpointId, onClose: onCloseProp, }: {
+    workspaceId: string;
+    endpointId: string;
+    /** Defaults to navigating back to the Setup → Endpoints list. */
+    onClose?: () => void;
+}): import("react").JSX.Element;
+export declare function SetupDashboardCreateDialog({ workspaceId }: {
+    workspaceId: string;
+}): import("react").JSX.Element;
+export declare function SetupDashboardCreateFromReportDialog({ workspaceId }: {
+    workspaceId: string;
+}): import("react").JSX.Element;
+export declare function SetupDashboardSettingsDialog({ workspaceId, dashboardId, onClose: onCloseProp, }: {
+    workspaceId: string;
+    dashboardId: string;
+    /** Defaults to navigating back to the Setup → Dashboards list. */
+    onClose?: () => void;
+}): import("react").JSX.Element;
+export declare function SetupReportFormDialog({ workspaceId, presetId, promoteTemporary, onClose: onCloseProp, backdropBlur, }: {
+    workspaceId: string;
+    presetId?: string;
+    /** Opens the editor to promote a temporary preset via `report.preset.saveTemporary`. */
+    promoteTemporary?: boolean;
+    /** Defaults to navigating back to the Setup → Reports list. */
+    onClose?: () => void;
+    /** Off when opened over live report canvases (backdrop-filter is costly). */
+    backdropBlur?: boolean;
+}): import("react").JSX.Element;

package/dist/src/workspace/setup/sections.d.ts

@@ -0,0 +1,17 @@
+import { type LucideIcon } from "lucide-react";
+export type SetupSectionId = "dashboards" | "endpoints" | "parameters" | "reports" | "automations" | "audit" | "files" | "storage";
+export type SetupSectionRoute = "/workspace/$workspaceId/setup/dashboards" | "/workspace/$workspaceId/setup/endpoints" | "/workspace/$workspaceId/setup/parameters" | "/workspace/$workspaceId/setup/reports" | "/workspace/$workspaceId/setup/automations" | "/workspace/$workspaceId/audit" | "/workspace/$workspaceId/setup/files" | "/workspace/$workspaceId/setup/storage";
+export interface SetupSection {
+    id: SetupSectionId;
+    to: SetupSectionRoute;
+    icon: LucideIcon;
+    label: () => string;
+}
+/**
+ * Setup sections in menu order. One source for the sidebar, the dropdown, and breadcrumbs. Setup
+ * is for editors, admins and owners only; `WorkspaceShell` keeps viewers and operators out.
+ */
+export declare const setupSections: readonly SetupSection[];
+export declare function setupSection(id: SetupSectionId): SetupSection;
+/** Section that owns `pathname`, or `undefined` outside Setup (dashboards, reports runtime, index). */
+export declare function activeSetupSection(pathname: string): SetupSectionId | undefined;

package/dist/src/workspace/setup/starters/starter-fields.d.ts

@@ -0,0 +1,45 @@
+import { type LocalizedString } from "@overvis/hmi-shared";
+import { type AutomationMembersOutput } from "@overvis/hmi-shared/automation";
+import { type StarterPlaceholder, type StarterProblem, type StarterScalarPlaceholder } from "@overvis/hmi-shared/starter";
+import { type StarterFormValues } from "./starter-form.js";
+export interface StarterOption {
+    id: string;
+    name: string;
+}
+/** What the placeholder fields choose from; each kind of starter fills in what its kinds need. */
+export interface StarterFieldData {
+    /** Parameters that fit a placeholder, listed first in its picker. */
+    parameterFits: (placeholder: Extract<StarterScalarPlaceholder, {
+        kind: "parameter";
+    }>, parameterId: string) => boolean;
+    /** Why a chosen parameter cannot serve a placeholder, shown as soon as it is chosen. */
+    parameterProblem?: (placeholder: Extract<StarterScalarPlaceholder, {
+        kind: "parameter";
+    }>, parameterId: string) => StarterProblem | null;
+    endpoints: readonly StarterOption[];
+    alarmRules: readonly StarterOption[];
+    branches: readonly StarterOption[];
+    members: AutomationMembersOutput["members"];
+}
+/** The catalog's starters to choose from, each opening its form. */
+export declare function StarterChoices({ starters, onPick, }: {
+    starters: readonly {
+        id: string;
+        name: LocalizedString;
+        description: LocalizedString;
+    }[];
+    onPick: (starterId: string) => void;
+}): import("react").JSX.Element;
+/**
+ * A starter's placeholders as form fields, in order, with the problems the last Continue found.
+ * `onChange` gets the path of what changed, whose problems are out of date.
+ */
+export declare function StarterFieldGroup({ workspaceId, placeholders, values, onChange, problems, data, newKey, }: {
+    workspaceId: string;
+    placeholders: readonly StarterPlaceholder[];
+    values: StarterFormValues;
+    onChange: (values: StarterFormValues, edited: string) => void;
+    problems: readonly StarterProblem[];
+    data: StarterFieldData;
+    newKey: () => string;
+}): import("react").JSX.Element;

package/dist/src/workspace/setup/starters/starter-form.d.ts

@@ -0,0 +1,50 @@
+import type { AutomationRecipients } from "@overvis/hmi-shared/automation";
+import { type StarterPlaceholder, type StarterProblem, type StarterScalarPlaceholder, type StarterValues } from "@overvis/hmi-shared/starter";
+export type StarterRole = Extract<AutomationRecipients, {
+    kind: "roles";
+}>["roles"][number];
+/** Who a recipients field notifies; `none` leaves the value out. */
+export interface StarterRecipientsValue {
+    kind: "none" | "roles" | "members";
+    roles: StarterRole[];
+    memberIds: string[];
+}
+/**
+ * What the form holds for one scalar placeholder: text for typed-in and chosen values (empty
+ * when nothing is given), a switch, weekdays, or recipients.
+ */
+export type StarterFieldValue = string | boolean | number[] | StarterRecipientsValue;
+export interface StarterFormRow {
+    /** Stable across edits, for React keys. */
+    key: string;
+    fields: Record<string, StarterFieldValue>;
+}
+export type StarterFormValue = StarterFieldValue | StarterFormRow[];
+export type StarterFormValues = Record<string, StarterFormValue>;
+/** A duration in the placeholder's unit, as the form shows it. */
+export declare function durationInUnit(placeholder: StarterScalarPlaceholder & {
+    kind: "duration";
+}, ms: number): string;
+/** The form value of a scalar placeholder before anything is filled in: its default, or empty. */
+export declare function initialStarterField(placeholder: StarterScalarPlaceholder): StarterFieldValue;
+export declare function newStarterRow(fields: readonly StarterScalarPlaceholder[], key: string): StarterFormRow;
+/** Form values of a starter before anything is filled in; lists start with their fewest rows. */
+export declare function newStarterFormValues(placeholders: readonly StarterPlaceholder[]): StarterFormValues;
+export type StarterFormConversion = {
+    ok: true;
+    values: StarterValues;
+} | {
+    ok: false;
+    problems: StarterProblem[];
+};
+/**
+ * The values a starter's `instantiate` takes. Empty fields are left out, for the starter
+ * to fill with its defaults or to report as required; numbers that do not parse are problems.
+ */
+export declare function starterFormToValues(placeholders: readonly StarterPlaceholder[], form: StarterFormValues): StarterFormConversion;
+/** A scalar's form value; a list's rows are not one. */
+export declare function asField(value: StarterFormValue | undefined): StarterFieldValue | undefined;
+/** A list's rows; a scalar's form value is none. */
+export declare function asRows(value: StarterFormValue | undefined): StarterFormRow[];
+/** Problems by the path of the field they belong to; a list's own problems sit on the list. */
+export declare function starterProblemsByPath(problems: readonly StarterProblem[]): Map<string, StarterProblem[]>;

package/dist/src/workspace/setup/storage/dialogs.d.ts

@@ -0,0 +1,77 @@
+import { type LocalizedString } from "@overvis/hmi-shared";
+import { type StorageRetentionSettings, type StorageRetentionOverride } from "@overvis/hmi-shared/workspace";
+interface ParameterTree {
+    readonly branches: readonly {
+        id: string;
+        parentId: string | null;
+        name: LocalizedString;
+    }[];
+    readonly parameters: readonly {
+        id: string;
+        branchId: string;
+        name: LocalizedString;
+    }[];
+}
+/** The days a retention of `kind` keeps at least, and its field of the retention settings. */
+declare const retentionKinds: {
+    readonly readings: {
+        readonly min: 1;
+        readonly field: "readingsKeepDays";
+    };
+    readonly audit: {
+        readonly min: 30;
+        readonly field: "auditKeepDays";
+    };
+    readonly alarm_log: {
+        readonly min: 30;
+        readonly field: "alarmLogKeepDays";
+    };
+};
+export type RetentionKind = keyof typeof retentionKinds;
+/** Sets the default readings retention, the activity history or the alarm log retention. */
+export declare function RetentionDefaultForm({ workspaceId, kind, retention, onCancel, onDone, }: {
+    workspaceId: string;
+    kind: RetentionKind;
+    retention: StorageRetentionSettings;
+    onCancel: () => void;
+    onDone: () => void;
+}): import("react").JSX.Element;
+/** Creates a retention rule, or edits `override`. */
+export declare function RetentionOverrideForm({ workspaceId, retention, override, tree, onCancel, onDone, }: {
+    workspaceId: string;
+    retention: StorageRetentionSettings;
+    override: StorageRetentionOverride | null;
+    tree: ParameterTree;
+    onCancel: () => void;
+    onDone: () => void;
+}): import("react").JSX.Element;
+/** Deletes a retention rule; its targets follow the default again. */
+export declare function DeleteRetentionOverrideForm({ workspaceId, override, onCancel, onDone, }: {
+    workspaceId: string;
+    override: StorageRetentionOverride;
+    onCancel: () => void;
+    onDone: () => void;
+}): import("react").JSX.Element;
+/** Which readings a deletion dialog removes: every parameter's, or the listed parameters'. */
+export type DeleteReadingsScope = {
+    readonly kind: "workspace";
+} | {
+    readonly kind: "parameters";
+    readonly parameterIds: readonly string[];
+    readonly label: string;
+};
+/** Deletes readings of a scope: all of them, those before a date, or those in a range. */
+export declare function DeleteReadingsForm({ workspaceId, scope, onCancel, onStarted, }: {
+    workspaceId: string;
+    scope: DeleteReadingsScope;
+    onCancel: () => void;
+    onStarted: (jobId: string) => void;
+}): import("react").JSX.Element;
+/** Deletes activity history or alarm log events before a date at least 30 days ago. */
+export declare function DeleteHistoryForm({ workspaceId, kind, onCancel, onStarted, }: {
+    workspaceId: string;
+    kind: "audit" | "alarm_log";
+    onCancel: () => void;
+    onStarted: (jobId: string) => void;
+}): import("react").JSX.Element;
+export {};

package/dist/src/workspace/setup/storage/format.d.ts

@@ -0,0 +1,6 @@
+/** A count of records with the locale's digit grouping. */
+export declare function formatRecords(records: number, locale: string): string;
+/** A size in bytes, in the largest unit that keeps it at least 1. */
+export declare function formatBytes(bytes: number, locale: string): string;
+/** How long a retention keeps data: "Keep everything" or "Keep 365 days". */
+export declare function keepLabel(keepDays: number | null): string;

package/dist/src/workspace/setup/storage/page.d.ts

@@ -0,0 +1,3 @@
+export declare function SetupStoragePage({ workspaceId }: {
+    workspaceId: string;
+}): import("react").JSX.Element;

package/dist/src/workspace/setup/storage/retention-note.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The readings retention that applies to a parameter or to a branch's parameters, read-only:
+ * retention is set on the Stored data page, which the note links to.
+ */
+export declare function AppliedRetentionNote({ workspaceId, target, }: {
+    workspaceId: string;
+    target: {
+        kind: "parameter" | "branch";
+        id: string;
+    };
+}): import("react").JSX.Element | null;

package/dist/src/workspace/setup/storage/retention.d.ts

@@ -0,0 +1,21 @@
+import { type AppliedRetention, type RetentionResolver, type StorageRetentionSettings } from "@overvis/hmi-shared/workspace";
+interface TreeData {
+    readonly branches: readonly {
+        id: string;
+        parentId: string | null;
+    }[];
+    readonly parameters: readonly {
+        id: string;
+        branchId: string;
+    }[];
+}
+export declare function retentionResolver(retention: StorageRetentionSettings, tree: TreeData): RetentionResolver;
+/** The workspace's retention resolved against its parameter tree; null while either loads. */
+export declare function useRetentionResolver(workspaceId: string): {
+    retention: StorageRetentionSettings;
+    resolver: RetentionResolver;
+    branchName: (id: string) => string;
+} | null;
+/** Where an applied retention comes from, in a sentence. */
+export declare function appliedRetentionText(applied: AppliedRetention, branchName: (id: string) => string): string;
+export {};

package/dist/src/workspace/shell.d.ts

@@ -0,0 +1,21 @@
+import { type ReactNode } from "react";
+import { type WorkspaceGetOutput } from "@overvis/hmi-shared/workspace";
+/**
+ * Operator shell: the page is the dashboard; the sidebar is only a list of dashboards to switch
+ * between, drawn on the page background without its own frame. For editors, admins and owners
+ * Setup is a quiet control at the bottom, out of the way. In a workspace that raises alarms, the
+ * Alarms link with the count of alarms waiting sits above it, or in its place for viewers and
+ * operators.
+ * While this browser plays the alarm sound, a bar above the page says why and silences it.
+ *
+ * Inside Setup the same sidebar switches to the section list (`SetupNav`) so the mode and the
+ * current section are visible.
+ *
+ * Setup belongs to editors, admins and owners. Viewers and operators get no way in, and a Setup URL
+ * (typed, bookmarked, or open when their access drops) takes them back to the dashboards.
+ */
+export declare function WorkspaceShell({ workspaceId, access, children, }: {
+    workspaceId: string;
+    access: WorkspaceGetOutput["access"];
+    children: ReactNode;
+}): import("react").JSX.Element;

package/dist/src/workspace/sidebar-nav-link.d.ts

@@ -0,0 +1,13 @@
+import type { ComponentProps, ReactNode } from "react";
+declare function SidebarNavAnchor({ active, collapsed, icon, label, badge, onNavigate, onClick, className: linkClassName, children: _children, ...anchorProps }: ComponentProps<"a"> & {
+    active: boolean;
+    collapsed: boolean;
+    icon: ReactNode;
+    label: string;
+    /** A count beside the label; a dot on the icon while collapsed. */
+    badge?: ReactNode;
+    onNavigate?: () => void;
+}): import("react").JSX.Element;
+/** One row in the workspace sidebar. Collapsed mode shows the icon only and names the row in a tooltip. */
+export declare const SidebarNavLink: import("@tanstack/react-router").LinkComponent<typeof SidebarNavAnchor, string>;
+export {};

package/dist/src/workspace/suspended.d.ts

@@ -0,0 +1,8 @@
+import type { WorkspaceGetOutput } from "@overvis/hmi-shared/workspace";
+/**
+ * Shown instead of every page of a suspended workspace, with one explanation per active reason.
+ * A workspace suspended for balance also shows what the host offers to fund it again.
+ */
+export declare function WorkspaceSuspendedPage({ workspace }: {
+    workspace: WorkspaceGetOutput;
+}): import("react").JSX.Element;