@danxbot/ui 3.12.2 → 3.13.0

package/dist/types/components/provenance/ProvenanceDetail.d.ts

@@ -0,0 +1,62 @@
+import { type ReactNode } from "react";
+import type { ProvenanceRecord } from "./types";
+/** The level the field name renders at. See "NO DIALOG ASSUMPTIONS" above. */
+export type ProvenanceDetailTitleAs = "h2" | "h3" | "h4" | "h5" | "h6";
+export interface ProvenanceDetailProps {
+    record: ProvenanceRecord;
+    /**
+     * Rendered at the foot — sign-off, correction, the cited pages themselves.
+     *
+     * A slot rather than props, because the actions a consumer offers over an
+     * extracted value are theirs: this library has no idea who is allowed to sign
+     * one, or what correcting it should do. It is also where a consumer puts the
+     * evidence it had to go and FETCH — the cited pages, their thumbnails, the
+     * audit trail — none of which this library can name.
+     */
+    actions?: ReactNode;
+    /** Shown in place of the value when there is none and it did not fail. */
+    emptyLabel?: string;
+    /** Shown in place of the value when the viewer may not see it. */
+    redactedLabel?: string;
+    /**
+     * Draw the VALUE yourself — an editor, most usefully.
+     *
+     * This replaces the one paragraph that prints the value, and nothing else:
+     * the field name above it, the state badge beside it, the confidence meter
+     * under it, and every row below the separator are still the component's.
+     *
+     * IT MAY BE INTERACTIVE. An `InlineEdit`, a select, a confirm/cancel pair are
+     * all legitimate — correcting a value in the surface somebody opened to judge
+     * it is the whole point of opening it, and the observed alternative is a
+     * consumer putting its editor in `actions`, which reads as "here is the
+     * value, and separately, down here, a form about some value".
+     *
+     * IT OVERRIDES THE ABSENCES TOO — redacted, empty and failed alike. A slot
+     * that disappeared whenever the value was missing would vanish in exactly the
+     * case a value editor is most wanted: a field that was never extracted is the
+     * one somebody actually has to type.
+     *
+     * The redaction gate cannot police a node you built yourself, so a consumer
+     * rendering this against a redactable record owns that one decision —
+     * `record.redacted` is right there to branch on.
+     *
+     * Passing `null` or `undefined` falls back to the built-in paragraph, so
+     * gating editability is `canEdit ? <Editor … /> : null` rather than two
+     * spellings of the whole component.
+     */
+    valueContent?: ReactNode;
+    /**
+     * Put a known id on the field-name heading, so something WRAPPING this can be
+     * labelled by it.
+     *
+     * `ProvenanceDisclosure` passes one: its popup takes `role="dialog"`, and an
+     * unlabelled dialog announces itself as nothing. An inline render normally
+     * has nothing to label and can leave this alone — a generated id is used, so
+     * the heading always has one.
+     */
+    titleId?: string;
+    /** @default "h2" */
+    titleAs?: ProvenanceDetailTitleAs;
+    className?: string;
+}
+export declare function ProvenanceDetail({ record, actions, emptyLabel, redactedLabel, valueContent, titleId, titleAs: Title, className, }: ProvenanceDetailProps): import("react").JSX.Element;

package/dist/types/components/provenance/ProvenanceDisclosure.d.ts

@@ -4,13 +4,7 @@ import type { ProvenanceRecord } from "./types";
 export type ProvenanceTriggerBadge = "icon" | "word" | "none";
 export interface ProvenanceDisclosureProps {
     record: ProvenanceRecord;
-    /**
-     * Rendered at the foot of the panel — sign-off, correction, "open the source".
-     *
-     * A slot rather than props, because the actions a consumer offers over an
-     * extracted value are theirs: this library has no idea who is allowed to sign
-     * one, or what correcting it should do.
-     */
+    /** Rendered at the foot of the panel. {@link ProvenanceDetailProps.actions} */
     actions?: ReactNode;
     /** Shown in place of the value when there is none and it did not fail. */
     emptyLabel?: string;
@@ -61,50 +55,12 @@ export interface ProvenanceDisclosureProps {
     triggerContent?: ReactNode;
     /**
      * Draw the PANEL HEADER'S VALUE yourself — an editor, most usefully.
+     * {@link ProvenanceDetailProps.valueContent}
      *
-     * This replaces the one paragraph that prints the value inside the open
-     * panel, and nothing else: the field name above it, the state badge beside
-     * it, the confidence meter under it, and every row below the separator are
-     * still the component's. It does not touch the trigger — the value on the
-     * page is still drawn from `record`, still truncated or wrapped per
-     * `valueWrap`, still announced as part of the trigger's own name. The
-     * closed page does not change because a consumer supplied this.
-     *
-     * UNLIKE `triggerContent`, THIS MAY BE INTERACTIVE, and that is the entire
-     * reason it exists. `triggerContent` sits inside the disclosure's `<button>`,
-     * so a control there would nest a control inside a control — invalid and
-     * unfocusable. This sits in the panel body, which Base UI gives
-     * `role="dialog"` and full focus management: an `InlineEdit`, a select, a
-     * confirm/cancel pair are all legitimate here.
-     *
-     * WHY A SLOT AND NOT AN `onCorrect` PROP. The same reason `actions` is a
-     * slot: this library has no idea who is allowed to correct an extracted
-     * value, what the permitted values are, or what writing one costs. What it
-     * does know is WHERE the correction belongs — against the value, in the
-     * surface someone opened to judge it — and the observed alternative is a
-     * consumer putting its editor in `actions`, which reads as "here is the
-     * value, and separately, down here, a form about some value".
-     *
-     * IT OVERRIDES THE ABSENCES TOO — redacted, empty and failed alike — and
-     * that is a deliberate choice rather than an oversight. A slot that
-     * disappeared whenever the value was missing would vanish in exactly the
-     * case a value editor is most wanted: a field that was never extracted is
-     * the one somebody actually has to type. It would also make the header's
-     * shape depend on a state the consumer did not ask about, so an editor would
-     * silently become a read-only word for reasons invisible at the call site.
-     * The absence vocabulary is not lost — the struck-through eye, the dash and
-     * the triangle still do their whole job on the trigger, which is the surface
-     * the density argument was ever about.
-     *
-     * The redaction gate is unchanged and still worth knowing about: the panel
-     * keeps withholding the quote, the reasoning and the sign-off note from a
-     * record marked `redacted`. It cannot police a node you built yourself, so
-     * a consumer rendering this against a redactable record owns that one
-     * decision — `record.redacted` is right there to branch on.
-     *
-     * Passing `null` or `undefined` falls back to the built-in paragraph, so
-     * gating editability is `canEdit ? <Editor … /> : null` rather than two
-     * spellings of the whole component.
+     * It does not touch the trigger — the value on the page is still drawn from
+     * `record`, still truncated or wrapped per `valueWrap`, still announced as
+     * part of the trigger's own name. The closed page does not change because a
+     * consumer supplied this.
      */
     valueContent?: ReactNode;
     /**

package/dist/types/components/provenance/absence.d.ts

@@ -0,0 +1,36 @@
+import type { ReactNode } from "react";
+import { type IconName } from "../Icon";
+import type { ProvenanceRecord } from "./types";
+declare const ABSENCE: Record<"redacted" | "empty" | "failed", {
+    icon: IconName;
+    className: string;
+}>;
+export declare function Absence({ kind, children }: {
+    kind: keyof typeof ABSENCE;
+    children: ReactNode;
+}): import("react").JSX.Element;
+/** Whether the record is withheld from this viewer. The first gate, everywhere. */
+export declare function isRedacted(record: ProvenanceRecord): boolean;
+/**
+ * Whether the record's own check disproved it.
+ *
+ * Precedence matters and is asserted: a record that is BOTH withheld and failed
+ * reads as withheld, because that is the fact about this viewer. The failure is
+ * still true, but it is not theirs to act on — and showing them a failure reason
+ * drawn from a value they may not see is the leak the panel is supposed to
+ * close.
+ */
+export declare function isFailed(record: ProvenanceRecord): boolean;
+/**
+ * What a reader is shown IN PLACE OF the value — or the value itself.
+ *
+ * Each of the three absences says which one it is: withheld from you, never
+ * extracted, or extracted and disproved. Rendering all three as an empty cell
+ * would make them indistinguishable, and they call for completely different
+ * next actions.
+ */
+export declare function shownValue(record: ProvenanceRecord, { emptyLabel, redactedLabel }: {
+    emptyLabel: string;
+    redactedLabel: string;
+}): ReactNode;
+export {};

package/dist/types/components/provenance/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./types";
 export * from "./ConfidenceMeter";
 export * from "./ProvenanceBadge";
+export * from "./ProvenanceDetail";
 export * from "./ProvenanceDisclosure";

package/dist/types/index.d.ts

@@ -109,7 +109,7 @@ export { AmbiguousTimeError, addDays, addDuration, addMonths, atMidnight, atTime
 export { allDayBandSegment, dayKey, daySlots, isAllDay, packBand, packLanes, snapFractionToInstant, timeSegments, timedBandSegment, type AllDayEvent, type BandInput, type BandOptions, type BandPlacement, type BandResult, type BandSegment, type CalendarEvent, type CalendarEventId, type CalendarView, type DaySlot, type DragKind, type EventDraft, type EventPalette, type LaneInput, type LaneOptions, type LanePlacement, type PaletteEntry, type TimeSegment, type TimedEvent, type VisibleRange, } from "./lib/calendar";
 export { RBACProvider, useRBAC, AccountMenu, DevToolsPopover, RolePermissionMatrix, ProfilePage, RolesPermissionsPage, type RBACProviderProps, type RBACHookResult, type AccountMenuProps, type DevToolsPopoverProps, type RolePermissionMatrixProps, type Permission, type Role, type User, type Team, type TeamMembership, } from "./components/rbac";
 export { UseCaseCard, RoadmapItemCard, RoadmapSwimlaneBoard, UseCaseLedgerPage, RoadmapPage, PhaseManager, TrackManager, deriveRoadmapItemStatus, isFullyBuilt, isUnbuilt, trackIds, trackProgress, toneForIndex, CATEGORY_TONES, type Domain, type Phase, type Track, type RoadmapItem, type RoadmapItemStatus, type UseCase, type UseCaseStatus, type UseCaseDecision, type UseCaseCardProps, type RoadmapItemCardProps, type RoadmapSwimlaneBoardProps, type UseCaseLedgerPageProps, type RoadmapPageProps, type PhaseManagerProps, type TrackManagerProps, } from "./components/roadmap";
-export { ProvenanceDisclosure, ProvenanceBadge, ConfidenceMeter, provenanceStateLabel, confidenceBand, type ProvenanceRecord, type ProvenanceState, type ProvenanceSource, type ProvenanceCheck, type ProvenanceCall, type ProvenanceSignoff, type ConfidenceBand, type ProvenanceDisclosureProps, type ProvenanceTriggerBadge, type ProvenanceBadgeProps, type ProvenanceBadgeAppearance, type ConfidenceMeterProps, } from "./components/provenance";
+export { ProvenanceDisclosure, ProvenanceDetail, ProvenanceBadge, ConfidenceMeter, provenanceStateLabel, confidenceBand, type ProvenanceRecord, type ProvenanceState, type ProvenanceSource, type ProvenanceCheck, type ProvenanceCall, type ProvenanceSignoff, type ConfidenceBand, type ProvenanceDisclosureProps, type ProvenanceDetailProps, type ProvenanceDetailTitleAs, type ProvenanceTriggerBadge, type ProvenanceBadgeProps, type ProvenanceBadgeAppearance, type ConfidenceMeterProps, } from "./components/provenance";
 export { createSimStore, resetSimStores, useSimSettings, setSimSettings, getNetworkSpeed, getDataSource, simulateLatency, SimNetworkError, type SimStore, type SimStoreOptions, type SimSettings, type NetworkSpeed, type DataSource, type SimNamespace, } from "./lib/sim";
 export { NodeCanvas, LAYOUT_DEFAULTS, layoutTree, pathToNode, type NodeCanvasProps, type CanvasEdge, type CanvasLayout, type CanvasNode, type CanvasOrientation, type LayoutOptions, type NodeRenderContext, type NodeRenderer, type PlacedNode, } from "./components/node-canvas";
 export { defineRecordType, resetRecordTypes, useRecord, useRecords, useStaleness, write, writeAll, peekRecord, readState, readStaleness, subscribeToKey, subscribeToStaleness, retainKeys, sweepRecords, setRecordStoreTenant, getRecordStoreTenant, flushRecordNotifications, resetRecordStore, recordStoreStats, UNKNOWN_STATE, normalizeTypeName, normalizeTimestamp, recordKey, isRecordRef, type RecordRef, type ReadOptions, type RecordPayload, type RecordState, type RecordTypeOptions, type RecordTypeToken, type StalenessEntry, type WriteAllResult, type WriteOptions, type WriteResult, type WriteSource, type WriteVerdict, } from "./lib/records";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danxbot/ui",
-  "version": "3.12.2",
+  "version": "3.13.0",
   "type": "module",
   "description": "Danxbot — a domain-agnostic React design system with motion as a first-class primitive.",
   "license": "MIT",