@pstdio/ui 0.39.0 → 0.41.0

package/dist/index-D3UJyWWh.d.ts

@@ -0,0 +1,501 @@
+import { f as ResourceContextAction, i as WorkspaceBadgeProps } from "./host-storage-DP0RLj4i.js";
+import { ComponentProps, ComponentType, DragEventHandler, ReactNode } from "react";
+import { ViewFilterCondition, ViewFilterGroup, ViewFilterGroup as ViewFilterGroup$1, ViewFilterRule, ViewFilterRule as ViewFilterRule$1, ViewSort, ViewSort as ViewSort$1, ViewSortDirection } from "@pstdio/sdk/extensions";
+//#region src/components/collection-view/collection-view-types.d.ts
+declare const EMPTY_VIEW_FILTER: ViewFilterGroup;
+/** What a saved view stores. Search, selection, and collapsed groups are screen state and never saved. */
+interface CollectionSavedView<TSettings> {
+  id: string;
+  title: string;
+  settings: TSettings;
+  filter: ViewFilterGroup;
+  sorts: ViewSort[];
+  /** @deprecated Use defaultActiveViewId instead. */
+  isDefault?: boolean;
+}
+interface CollectionViewState<TSettings> {
+  settings: TSettings;
+  filter: ViewFilterGroup;
+  sorts: ViewSort[];
+}
+interface CollectionViewsSource<TSettings> {
+  views: (CollectionSavedView<TSettings> & {
+    builtIn: boolean;
+  })[];
+  defaultViewId: string;
+  onCreateView: (input: CollectionViewState<TSettings> & {
+    title: string;
+    copyFrom?: string;
+  }) => Promise<CollectionSavedView<TSettings>>;
+  onUpdateView: (id: string, input: Partial<CollectionViewState<TSettings>> & {
+    title?: string;
+  }) => Promise<void>;
+  onDeleteView: (id: string) => Promise<void>;
+  onSetDefaultView: (id: string | null) => Promise<void>;
+}
+//#endregion
+//#region src/components/kanban-renderer/types.d.ts
+type ViewMode = "board" | "list";
+declare const NO_GROUPING = "none";
+interface EnumOption {
+  value: string;
+  label: string;
+  color?: string;
+  icon?: string | null;
+}
+/**
+ * Reactive options source for enum / enum-multi attributes. Mirrors React's
+ * useSyncExternalStore contract so a contribution can hand its options off as
+ * a live collection (e.g. a project-scoped resource) instead of a frozen
+ * array, and the renderer subscribes to it the same way it subscribes to rows.
+ */
+interface EnumOptionsSource {
+  subscribe: (listener: () => void) => () => void;
+  getSnapshot: () => EnumOption[];
+}
+type EnumOptions = EnumOption[] | EnumOptionsSource;
+type AttributeType = {
+  kind: "enum";
+  options: EnumOptions;
+} | {
+  kind: "enum-multi";
+  options: EnumOptions;
+} | {
+  kind: "boolean";
+  legacyValues?: Record<string, boolean>;
+} | {
+  kind: "string";
+} | {
+  kind: "date";
+} | {
+  kind: "number";
+} | {
+  kind: "user";
+};
+declare const isEnumOptionsSource: (options: EnumOptions) => options is EnumOptionsSource;
+type AttributeKind = AttributeType["kind"];
+type AttributeDisplayDescriptor = {
+  kind: "badge-list";
+  itemsAttributeId: string;
+};
+type CollectionBadgeJsonValue = string | number | boolean | null | CollectionBadgeJsonValue[] | CollectionBadgeJsonObject;
+interface CollectionBadgeJsonObject {
+  [key: string]: CollectionBadgeJsonValue;
+}
+interface CollectionBadgeResource {
+  type: string;
+  id: string;
+  projectId?: string;
+  label?: string;
+  extensionId?: string;
+  metadata?: CollectionBadgeJsonObject;
+}
+interface CollectionBadgeItem {
+  id: string;
+  label: string;
+  icon?: string;
+  resource?: CollectionBadgeResource;
+}
+interface AttributeDescriptor {
+  id: string;
+  label: string;
+  type: AttributeType;
+  filterable?: boolean;
+  groupable?: boolean;
+  sortable?: boolean;
+  displayable?: boolean;
+  editable?: boolean;
+  display?: AttributeDisplayDescriptor;
+  render?: (value: unknown, row: KanbanRendererRow) => ReactNode;
+  compare?: (a: unknown, b: unknown) => number;
+}
+/**
+ * Reactive source for an entire attribute schema. Mirrors React's
+ * useSyncExternalStore contract so consumers (e.g. the workbench's
+ * kanban-renderer bridge) can subscribe and re-resolve when the schema changes
+ * — letting a contribution add/remove/edit attributes at runtime without
+ * re-registering.
+ */
+interface AttributesSource {
+  subscribe: (listener: () => void) => () => void;
+  getSnapshot: () => AttributeDescriptor[];
+}
+declare const isAttributesSource: (attributes: AttributeDescriptor[] | AttributesSource) => attributes is AttributesSource;
+interface KanbanRendererRow {
+  id: string;
+  title: string;
+  /**
+   * Optional navigation handle. When set, the renderer's default click handler
+   * routes through the contribution's onRowClick (which typically opens the
+   * resource via the workbench).
+   */
+  resource?: unknown;
+  attributes: Record<string, unknown>;
+}
+/** Board display settings. Order lives in the view's sorts. */
+interface KanbanRendererSettings {
+  viewMode: ViewMode;
+  columnGrouping: string | typeof NO_GROUPING;
+  rowGrouping: string | typeof NO_GROUPING;
+  displayProperties: string[];
+}
+type KanbanRendererSavedView = CollectionSavedView<KanbanRendererSettings>;
+type KanbanRendererCreateFieldType = "text" | "longtext" | "markdown" | "number" | "boolean" | "select" | "multi-select" | "files";
+interface KanbanRendererCreateField {
+  id: string;
+  label: string;
+  description?: string;
+  placeholder?: string;
+  type: KanbanRendererCreateFieldType;
+  required?: boolean;
+  defaultValue?: unknown;
+  options?: EnumOption[];
+  /** `files` fields only. */
+  multiple?: boolean;
+  accept?: string;
+}
+/** Chrome copy is supplied by the caller so the dialog ships no strings of its own. */
+interface KanbanRendererCreateLabels {
+  cancel: string;
+  properties: string;
+  submitError: string;
+  removeFile: string;
+}
+interface KanbanRendererCreateRowConfig {
+  title: string;
+  submitLabel: string;
+  fields: KanbanRendererCreateField[];
+  labels: KanbanRendererCreateLabels;
+}
+interface KanbanRendererCreateSubmission {
+  columnId: string;
+  columnAttributeId?: string;
+  /** Declared field values, excluding `files` fields — those arrive as `files`. */
+  values: Record<string, unknown>;
+  /** Every editable attribute the user set, keyed by attribute id. */
+  attributeValues: Record<string, unknown>;
+  files: File[];
+}
+declare const DEFAULT_KANBAN_RENDERER_SETTINGS: KanbanRendererSettings;
+/**
+ * Look up an attribute by id from a contribution-provided descriptor list.
+ * Returns undefined for the "none" grouping or unknown ids.
+ */
+declare const findAttribute: (attributes: AttributeDescriptor[], id: string | undefined) => AttributeDescriptor | undefined;
+type KanbanRendererViewsSource = CollectionViewsSource<KanbanRendererSettings>;
+//#endregion
+//#region src/components/collection-view/collection-view-fields.d.ts
+/**
+ * Read a typed attribute value out of a row. enum-multi normalizes to an array;
+ * single-valued kinds normalize to undefined when missing.
+ */
+declare const getAttributeValue: (row: KanbanRendererRow, descriptor: AttributeDescriptor) => unknown;
+declare const getAttributeStringValues: (row: KanbanRendererRow, descriptor: AttributeDescriptor) => string[];
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-badge-helpers.d.ts
+interface AttributeBadge {
+  attributeId: string;
+  attributeLabel?: string;
+  label: string;
+  color?: string;
+  icon?: string | null;
+  value?: string | string[];
+  options?: EnumOption[];
+  isEditable?: boolean;
+}
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-enum-helpers.d.ts
+/**
+ * Normalize an enum / enum-multi attribute's `options` to a plain option list.
+ * Sources resolve via `getSnapshot()` on every call, so callers naturally see
+ * the latest values.
+ */
+declare const getEnumOptions: (type: AttributeType) => EnumOption[];
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-helpers.d.ts
+declare const renderBadgeListDisplay: (descriptor: AttributeDescriptor, value: unknown, row: KanbanRendererRow, openResource?: (resource: NonNullable<CollectionBadgeItem["resource"]>) => void) => ReactNode;
+/**
+ * Per-type default cell summary used by the card / list end-content. Returns
+ * null when the attribute has no displayable value.
+ */
+declare const renderAttributeBadge: (descriptor: AttributeDescriptor, row: KanbanRendererRow) => AttributeBadge | null;
+declare const collectDisplayBadges: (row: KanbanRendererRow, attributes: AttributeDescriptor[], displayProperties: string[]) => AttributeBadge[];
+interface FilterCategoryView {
+  id: string;
+  label: string;
+  selectionMode: "multiple";
+  options: {
+    value: string;
+    label: string;
+    color?: string;
+    icon?: string | null;
+  }[];
+}
+/**
+ * Build the filter menu's category list from the declared attributes. Enum
+ * descriptors expose their declared options first; auto-derived values from
+ * the data fill in the gaps for string / date / number / user attributes (so
+ * filter chips for free-form fields don't require declaring every option).
+ */
+declare const buildFilterCategories: (attributes: AttributeDescriptor[], rows: KanbanRendererRow[]) => FilterCategoryView[];
+interface MenuOption {
+  value: string;
+  label: string;
+}
+declare const buildGroupingOptions: (attributes: AttributeDescriptor[]) => MenuOption[];
+declare const buildDisplayPropertyOptions: (attributes: AttributeDescriptor[]) => MenuOption[];
+//#endregion
+//#region src/components/kanban-renderer/display-menu.d.ts
+interface DisplayMenuProps {
+  settings: KanbanRendererSettings;
+  sortControl?: ReactNode;
+  groupingOptions: MenuOption[];
+  displayPropertyOptions: MenuOption[];
+  onViewModeChange: (value: KanbanRendererSettings["viewMode"]) => void;
+  onColumnGroupingChange: (value: string) => void;
+  onRowGroupingChange: (value: string) => void;
+  onDisplayPropertyToggle: (property: string) => void;
+}
+declare const DisplayMenu: (props: DisplayMenuProps) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-action.d.ts
+type KanbanActionErrorHandler = (error: unknown, action: string) => void;
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-card.d.ts
+interface KanbanRendererCardProps$1 {
+  eyebrow?: string;
+  title: string;
+  /** Search text to mark in the title and eyebrow. */
+  highlight?: string;
+  badges?: AttributeBadge[];
+  customSlots?: ReactNode[];
+  workspaceBadge?: WorkspaceBadgeProps;
+  isSelected?: boolean;
+  draggable?: boolean;
+  onBadgeChange?: (attributeId: string, value: unknown) => void;
+  onDragStart?: DragEventHandler<HTMLDivElement>;
+  onDragEnd?: DragEventHandler<HTMLDivElement>;
+  onClick?: () => void;
+}
+declare const KanbanRendererCard: (props: KanbanRendererCardProps$1) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-board.d.ts
+type KanbanRendererCardProps = ComponentProps<typeof KanbanRendererCard>;
+interface KanbanRendererBoardItem {
+  id: string;
+  cardProps: Omit<KanbanRendererCardProps, "draggable" | "onDragStart" | "onDragEnd" | "isSelected">;
+  contextMenuActions?: ResourceContextAction[];
+}
+interface KanbanRendererBoardColumnAction {
+  id: string;
+  label: string;
+  icon: ComponentType<{
+    size?: number | string;
+  }>;
+}
+interface KanbanRendererBoardGroup {
+  key: string;
+  label: string;
+  items: KanbanRendererBoardItem[];
+}
+interface KanbanRendererBoardColumn {
+  id: string;
+  label: string;
+  createLabel?: string;
+  color?: string;
+  icon?: string | null;
+  items: KanbanRendererBoardItem[];
+  groups?: KanbanRendererBoardGroup[];
+  /** Cards in the column before search narrowed it. Set only while a search is active. */
+  totalCount?: number;
+  canDragIn: boolean;
+  canDragOut: boolean;
+  canCreate: boolean;
+  actions: KanbanRendererBoardColumnAction[];
+}
+interface KanbanRendererBoardProps {
+  columns: KanbanRendererBoardColumn[];
+  selectedItemId?: string | null;
+  onMoveItem?: (itemId: string, targetColumnId: string, context?: {
+    beforeItemId?: string;
+    targetGroupKey?: string;
+  }) => Promise<void> | void;
+  onMoveToGroup?: (itemId: string, targetGroupKey: string, context?: {
+    beforeItemId?: string;
+  }) => Promise<void> | void;
+  onCreateStart?: (columnId: string) => void;
+  onColumnAction?: (columnId: string, actionId: string) => Promise<void> | void;
+}
+declare const KanbanRendererBoard: (props: KanbanRendererBoardProps) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer.d.ts
+/** Board-column behavior and menu configuration for a resolved column group. */
+interface BoardColumnConfig {
+  /** Chakra color palette used for the column header and group badges. */
+  color?: string;
+  canDragIn?: boolean;
+  canDragOut?: boolean;
+  canCreate?: boolean;
+  actions?: KanbanRendererBoardColumnAction[];
+}
+/** Switchable list/board renderer for rows with typed attributes, filtering, grouping, and ordering. */
+interface KanbanRendererProps<TRow extends KanbanRendererRow = KanbanRendererRow> {
+  /** Stable rows to render. Each row must have an id, title, and attributes map. */
+  rows: TRow[];
+  /** Persistent key used by the renderer store for view, filter, grouping, ordering, and list expansion settings. */
+  storageKey: string;
+  itemLabel?: string;
+  /** Attribute descriptors that define display, filtering, grouping, ordering, and board columns. */
+  attributes: AttributeDescriptor[];
+  selectedRowId?: string | null;
+  emptyState?: ReactNode;
+  emptyTitle?: string;
+  emptyDescription?: string;
+  /** Replaces the data area while a query is unavailable, keeping its controls mounted. */
+  contentPlaceholder?: ReactNode;
+  defaultSettings?: Partial<KanbanRendererSettings>;
+  defaultFilter?: ViewFilterGroup;
+  defaultSorts?: ViewSort[];
+  viewsSource?: KanbanRendererViewsSource;
+  defaultViews?: KanbanRendererSavedView[];
+  defaultActiveViewId?: string;
+  hideToolbar?: boolean;
+  toolbarActions?: ReactNode;
+  toolbarLeading?: ReactNode;
+  onRowClick?: (row: TRow) => void;
+  /** Reports a failed badge edit or complete move once and consumes its rejection. */
+  onActionError?: KanbanActionErrorHandler;
+  /** Called when a row attribute changes through drag/drop, board movement, or inline controls. */
+  onAttributeChange?: (rowId: string, attributeId: string, value: unknown) => Promise<void> | void;
+  /** Called for manual row ordering when a dragged row is dropped before another row. Only used while the view has no sorts. */
+  onReorder?: (rowId: string, beforeRowId?: string) => Promise<void> | void;
+  createRow?: KanbanRendererCreateRowConfig;
+  onCreateRow?: (submission: KanbanRendererCreateSubmission) => Promise<void> | void;
+  onColumnAction?: (columnId: string, actionId: string) => Promise<void> | void;
+  getBoardColumnConfig?: (groupKey: string) => BoardColumnConfig;
+  getRowContextMenuActions?: (row: TRow) => ResourceContextAction[];
+}
+declare const KanbanRenderer: <TRow extends KanbanRendererRow>(props: KanbanRendererProps<TRow>) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-create-dialog.d.ts
+interface KanbanRendererCreateDialogProps {
+  open: boolean;
+  columnId: string;
+  columnAttributeId?: string;
+  attributes: AttributeDescriptor[];
+  config: KanbanRendererCreateRowConfig;
+  onClose: () => void;
+  onSubmit: (submission: KanbanRendererCreateSubmission) => Promise<void> | void;
+}
+declare const KanbanRendererCreateDialog: (props: KanbanRendererCreateDialogProps) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-list.d.ts
+interface KanbanRendererListItem {
+  id: string;
+  eyebrow?: string;
+  title: string;
+  /** Search text to mark in the title and eyebrow. */
+  highlight?: string;
+  isGroup?: boolean;
+  countBadge?: number;
+  countColorPalette?: string;
+  statusIcon?: ComponentType<{
+    size?: number | string;
+  }>;
+  statusColor?: string;
+  statusColorPalette?: string;
+  badges?: AttributeBadge[];
+  customSlots?: ReactNode[];
+  children?: KanbanRendererListItem[];
+  onClick?: () => void;
+  onBadgeChange?: (attributeId: string, value: unknown) => void;
+  contextMenuActions?: ResourceContextAction[];
+  draggable?: boolean;
+  onDropRow?: (rowId: string) => void;
+}
+type KanbanRendererListExpandedState = Record<string, boolean>;
+interface KanbanRendererListProps {
+  items: KanbanRendererListItem[];
+  selectedItemId?: string | null;
+  expandedGroups?: KanbanRendererListExpandedState;
+  onItemClick?: (item: KanbanRendererListItem) => void;
+  onExpandedGroupChange?: (rowId: string, isExpanded: boolean) => void;
+}
+declare const KanbanRendererList: (props: KanbanRendererListProps) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/components/kanban-renderer/kanban-renderer-toolbar.d.ts
+interface KanbanRendererToolbarProps<TRow extends KanbanRendererRow = KanbanRendererRow> {
+  rows: TRow[];
+  storageKey: string;
+  itemLabel?: string;
+  attributes: AttributeDescriptor[];
+  defaultSettings?: Partial<KanbanRendererSettings>;
+  defaultFilter?: ViewFilterGroup;
+  defaultSorts?: ViewSort[];
+  viewsSource?: KanbanRendererViewsSource;
+  defaultViews?: KanbanRendererSavedView[];
+  defaultActiveViewId?: string;
+  search: string;
+  onSearchChange: (value: string) => void;
+  searchResultLabel?: string;
+  leading?: ReactNode;
+  actions?: ReactNode;
+}
+declare const KanbanRendererToolbar: <TRow extends KanbanRendererRow>(props: KanbanRendererToolbarProps<TRow>) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/components/collection-view/use-collection-view-store.d.ts
+/** The unsaved state of one renderer: the active view and the edits made on top of it. */
+interface CollectionViewSnapshot<TSettings> {
+  settings: TSettings;
+  filter: ViewFilterGroup;
+  sorts: ViewSort[];
+  expandedGroups: Record<string, boolean>;
+  activeViewId: string;
+}
+type CollectionViewMenu = "filter";
+interface CollectionViewStoreState<TSettings> extends CollectionViewSnapshot<TSettings> {
+  /** The view bar menu that is open. Screen state: never persisted. */
+  openMenu: CollectionViewMenu | null;
+  /** The root rule whose pill editor is open. Screen state: never persisted. */
+  openRuleIndex: number | null;
+  setOpenMenu: (menu: CollectionViewMenu | null) => void;
+  setOpenRuleIndex: (index: number | null) => void;
+  /** Adds a rule for the field and opens its pill editor. */
+  startRule: (field: AttributeDescriptor) => void;
+  /** Commits picker values; scalar values transfer editing to their bubble. */
+  selectRule: (rule: ViewFilterRule) => void;
+  setSettings: (settings: Partial<TSettings>) => void;
+  setFilter: (filter: ViewFilterGroup) => void;
+  setSorts: (sorts: ViewSort[]) => void;
+  setExpandedGroup: (groupId: string, isExpanded: boolean) => void;
+  activateView: (view: CollectionSavedView<TSettings>) => void;
+  reset: () => void;
+}
+//#endregion
+//#region src/components/kanban-renderer/use-kanban-renderer-store.d.ts
+type KanbanRendererState = CollectionViewStoreState<KanbanRendererSettings>;
+interface KanbanRendererStoreInitialState {
+  settings?: Partial<KanbanRendererSettings>;
+  filter?: ViewFilterGroup;
+  sorts?: ViewSort[];
+}
+/** The unsaved view state of one board. Hosts read it to send the view to their query. */
+declare const useKanbanRendererStore: <T>(storageKey: string, selector: (state: KanbanRendererState) => T, initialState?: KanbanRendererStoreInitialState) => T;
+//#endregion
+//#region src/components/kanban-renderer/use-resolved-attributes.d.ts
+/**
+ * Returns the same descriptors with every source-backed enum's options
+ * replaced by a fresh `getSnapshot()` array. Pure — call from anywhere that
+ * needs a normalized view of the schema.
+ */
+declare const resolveAttributeOptions: (attributes: AttributeDescriptor[]) => AttributeDescriptor[];
+/**
+ * Subscribes to every source-backed enum in `attributes` and returns the
+ * resolved descriptors (options materialized to plain arrays). When any
+ * source's listener fires the component rerenders, so downstream renders see
+ * the new snapshot automatically.
+ */
+declare const useResolvedAttributes: (attributes: AttributeDescriptor[]) => AttributeDescriptor[];
+//#endregion
+export { isEnumOptionsSource as $, getAttributeStringValues as A, EnumOptionsSource as B, buildFilterCategories as C, renderBadgeListDisplay as D, renderAttributeBadge as E, AttributeType as F, KanbanRendererRow as G, KanbanRendererCreateFieldType as H, AttributesSource as I, KanbanRendererViewsSource as J, KanbanRendererSavedView as K, DEFAULT_KANBAN_RENDERER_SETTINGS as L, AttributeDescriptor as M, AttributeDisplayDescriptor as N, getEnumOptions as O, AttributeKind as P, isAttributesSource as Q, EnumOption as R, buildDisplayPropertyOptions as S, collectDisplayBadges as T, KanbanRendererCreateRowConfig as U, KanbanRendererCreateField as V, KanbanRendererCreateSubmission as W, ViewMode as X, NO_GROUPING as Y, findAttribute as Z, KanbanRendererCard as _, KanbanRendererToolbar as a, ViewFilterRule$1 as at, FilterCategoryView as b, KanbanRendererListItem as c, KanbanRenderer as d, CollectionSavedView as et, KanbanRendererProps as f, KanbanRendererBoardItem as g, KanbanRendererBoardColumnAction as h, CollectionViewStoreState as i, ViewFilterGroup$1 as it, getAttributeValue as j, AttributeBadge as k, KanbanRendererCreateDialog as l, KanbanRendererBoardColumn as m, useResolvedAttributes as n, EMPTY_VIEW_FILTER as nt, KanbanRendererToolbarProps as o, ViewSort$1 as ot, KanbanRendererBoard as p, KanbanRendererSettings as q, useKanbanRendererStore as r, ViewFilterCondition as rt, KanbanRendererList as s, ViewSortDirection as st, resolveAttributeOptions as t, CollectionViewsSource as tt, BoardColumnConfig as u, KanbanRendererCardProps$1 as v, buildGroupingOptions as w, MenuOption as x, DisplayMenu as y, EnumOptions as z };
+export {};