uidex 0.3.0 → 0.4.0

package/dist/react/index.d.cts

@@ -35,11 +35,16 @@ interface Route {
     path: string;
     page: string;
 }
+interface FlowStep {
+    entityId: string;
+    action?: string;
+}
 interface Flow {
     kind: "flow";
     id: string;
     loc: Location;
     touches: string[];
+    steps: FlowStep[];
 }
 interface Page extends EntityWithMetaBase {
     kind: "page";
@@ -278,15 +283,16 @@ interface FeedbackResult {
     sequenceNumber: number;
     externalLink?: FeedbackExternalLink;
 }
-interface IngestConfigEpic {
+interface IngestConfigIssue {
+    id: string;
     key: string;
     summary: string;
-    status: string;
+    issueType: string;
 }
 interface IngestConfig {
     hasJira: boolean;
     integrationId?: string;
-    epics?: IngestConfigEpic[];
+    parentIssues?: IngestConfigIssue[];
 }
 /**
  * Generic so third-party adapters (e.g. `uidex-cloud`) can plug in their own
@@ -296,6 +302,12 @@ interface IngestConfig {
  */
 interface CloudAdapter<TPayload = FeedbackPayload, TResult = FeedbackResult, TIntegrations = {
     getConfig(): Promise<IngestConfig>;
+    /**
+     * Synchronous read of the eagerly-fetched config. Returns `null` until the
+     * initial fetch resolves; views that need a sync answer (e.g. detail
+     * actions deciding whether to surface a Jira button) read this.
+     */
+    getCachedConfig(): IngestConfig | null;
 }> {
     readonly feedback: {
         submit(payload: TPayload): Promise<TResult>;
@@ -327,6 +339,7 @@ interface OverlayShowOptions {
     borderStyle?: string;
     borderWidth?: number;
     fillOpacity?: number;
+    backdrop?: boolean;
 }
 
 type Corner = "top-left" | "top-right" | "bottom-left" | "bottom-right";
@@ -365,6 +378,8 @@ interface ListItem {
     leading?: () => Node;
     /** Raw data attribute tag appended to the row (for test/e2e hooks). */
     tag?: string;
+    /** Contextual actions surfaced in the footer popup when this row is highlighted. */
+    actions?: readonly ShellAction[];
 }
 interface DetailSurface {
     kind: "detail";
@@ -405,19 +420,21 @@ type DetailAction = (DetailActionBase & {
 }) | (DetailActionBase & {
     run: (ctx: DetailActionRunContext) => void | Promise<void>;
 });
-type DetailActionIcon = "copy" | "message-circle" | "chevron-down" | "target";
+type DetailActionIcon = "copy" | "camera" | "message-circle-warning" | "chevron-down" | "highlighter" | "ticket-plus" | "view";
 interface DetailActionRunContext {
     setLabel(next: string, durationMs?: number): void;
 }
+interface ResolvedFlowStep {
+    ordinal: number;
+    entity: Entity;
+    action?: string;
+}
 type DetailSection = {
     id: "description";
     text: string;
 } | {
     id: "acceptance";
     items: readonly string[];
-} | {
-    id: "scopes";
-    scopes: readonly string[];
 } | {
     id: "composes";
     label: string;
@@ -435,7 +452,10 @@ type DetailSection = {
 } | {
     id: "touches";
     entities: readonly Entity[];
-    unresolved: readonly string[];
+    filterable?: boolean;
+} | {
+    id: "steps";
+    steps: readonly ResolvedFlowStep[];
     filterable?: boolean;
 } | {
     id: "routes";
@@ -454,6 +474,11 @@ interface FormSurface {
      * routed to the matching `<FieldError>` and submission is skipped.
      */
     schema?: StandardSchemaV1<Record<string, unknown>>;
+    /**
+     * Promise resolving to a base64 screenshot data URL. When provided, the
+     * form renderer shows a thumbnail preview above the fields.
+     */
+    screenshotPreview?: Promise<string | null>;
 }
 /**
  * Minimal StandardSchemaV1 surface — kept inline so the SDK doesn't need a
@@ -550,6 +575,8 @@ interface ViewPalette {
 }
 interface ViewDirectory {
     list(): readonly View[];
+    recents(): readonly EntityRef[];
+    favorites(): readonly EntityRef[];
 }
 interface ViewPushTarget {
     id: string;
@@ -575,6 +602,10 @@ interface ViewContext {
     navigate: (ref: EntityRef) => void;
     /** Pin the overlay to `ref` until the user presses Esc. */
     pinHighlight: (ref: EntityRef) => void;
+    /** Toggle favorite status for an entity ref. */
+    toggleFavorite: (ref: EntityRef) => void;
+    /** Check if an entity ref is favorited. */
+    isFavorite: (ref: EntityRef) => boolean;
     /** Shell-owned search input. The shell dispatches its value into the active surface. */
     searchInput: HTMLInputElement;
     /** Drives the Surface's singleton overlay from inside a custom surface. */
@@ -605,6 +636,7 @@ interface ShellAction {
     id: string;
     label: string;
     shortcut?: string;
+    icon?: () => Node;
     perform: () => void | Promise<void>;
     intent?: ShellActionIntent;
 }
@@ -627,6 +659,15 @@ interface View {
     surface: (ctx: ViewContext) => ViewSurface;
 }
 
+interface PaletteShortcut {
+    /** The key value (e.g. "k", "j", ";"). Matched case-insensitively. */
+    key: string;
+    /** Require Cmd (Mac) / Ctrl (Win/Linux). Default: true. */
+    mod?: boolean;
+    /** Require Shift. Default: false. */
+    shift?: boolean;
+}
+
 interface ViewRegistrar {
     register(view: View): void;
     unregister(id: string): void;
@@ -634,6 +675,10 @@ interface ViewRegistrar {
     get(id: string): View | undefined;
     findMatch(ref: EntityRef): View | null;
     navigate(ref: EntityRef): void;
+    recents(): readonly EntityRef[];
+    favorites(): readonly EntityRef[];
+    toggleFavorite(ref: EntityRef): void;
+    isFavorite(ref: EntityRef): boolean;
 }
 
 interface CreateUidexOptions {
@@ -655,6 +700,8 @@ interface CreateUidexOptions {
      * an options object to override either channel.
      */
     ingest?: IngestOptions | null;
+    /** Keyboard shortcut for the command palette. Defaults to Cmd+K / Ctrl+K. */
+    shortcut?: PaletteShortcut;
 }
 interface Uidex {
     mount(target?: Element): void;

package/dist/react/index.d.ts

@@ -35,11 +35,16 @@ interface Route {
     path: string;
     page: string;
 }
+interface FlowStep {
+    entityId: string;
+    action?: string;
+}
 interface Flow {
     kind: "flow";
     id: string;
     loc: Location;
     touches: string[];
+    steps: FlowStep[];
 }
 interface Page extends EntityWithMetaBase {
     kind: "page";
@@ -278,15 +283,16 @@ interface FeedbackResult {
     sequenceNumber: number;
     externalLink?: FeedbackExternalLink;
 }
-interface IngestConfigEpic {
+interface IngestConfigIssue {
+    id: string;
     key: string;
     summary: string;
-    status: string;
+    issueType: string;
 }
 interface IngestConfig {
     hasJira: boolean;
     integrationId?: string;
-    epics?: IngestConfigEpic[];
+    parentIssues?: IngestConfigIssue[];
 }
 /**
  * Generic so third-party adapters (e.g. `uidex-cloud`) can plug in their own
@@ -296,6 +302,12 @@ interface IngestConfig {
  */
 interface CloudAdapter<TPayload = FeedbackPayload, TResult = FeedbackResult, TIntegrations = {
     getConfig(): Promise<IngestConfig>;
+    /**
+     * Synchronous read of the eagerly-fetched config. Returns `null` until the
+     * initial fetch resolves; views that need a sync answer (e.g. detail
+     * actions deciding whether to surface a Jira button) read this.
+     */
+    getCachedConfig(): IngestConfig | null;
 }> {
     readonly feedback: {
         submit(payload: TPayload): Promise<TResult>;
@@ -327,6 +339,7 @@ interface OverlayShowOptions {
     borderStyle?: string;
     borderWidth?: number;
     fillOpacity?: number;
+    backdrop?: boolean;
 }
 
 type Corner = "top-left" | "top-right" | "bottom-left" | "bottom-right";
@@ -365,6 +378,8 @@ interface ListItem {
     leading?: () => Node;
     /** Raw data attribute tag appended to the row (for test/e2e hooks). */
     tag?: string;
+    /** Contextual actions surfaced in the footer popup when this row is highlighted. */
+    actions?: readonly ShellAction[];
 }
 interface DetailSurface {
     kind: "detail";
@@ -405,19 +420,21 @@ type DetailAction = (DetailActionBase & {
 }) | (DetailActionBase & {
     run: (ctx: DetailActionRunContext) => void | Promise<void>;
 });
-type DetailActionIcon = "copy" | "message-circle" | "chevron-down" | "target";
+type DetailActionIcon = "copy" | "camera" | "message-circle-warning" | "chevron-down" | "highlighter" | "ticket-plus" | "view";
 interface DetailActionRunContext {
     setLabel(next: string, durationMs?: number): void;
 }
+interface ResolvedFlowStep {
+    ordinal: number;
+    entity: Entity;
+    action?: string;
+}
 type DetailSection = {
     id: "description";
     text: string;
 } | {
     id: "acceptance";
     items: readonly string[];
-} | {
-    id: "scopes";
-    scopes: readonly string[];
 } | {
     id: "composes";
     label: string;
@@ -435,7 +452,10 @@ type DetailSection = {
 } | {
     id: "touches";
     entities: readonly Entity[];
-    unresolved: readonly string[];
+    filterable?: boolean;
+} | {
+    id: "steps";
+    steps: readonly ResolvedFlowStep[];
     filterable?: boolean;
 } | {
     id: "routes";
@@ -454,6 +474,11 @@ interface FormSurface {
      * routed to the matching `<FieldError>` and submission is skipped.
      */
     schema?: StandardSchemaV1<Record<string, unknown>>;
+    /**
+     * Promise resolving to a base64 screenshot data URL. When provided, the
+     * form renderer shows a thumbnail preview above the fields.
+     */
+    screenshotPreview?: Promise<string | null>;
 }
 /**
  * Minimal StandardSchemaV1 surface — kept inline so the SDK doesn't need a
@@ -550,6 +575,8 @@ interface ViewPalette {
 }
 interface ViewDirectory {
     list(): readonly View[];
+    recents(): readonly EntityRef[];
+    favorites(): readonly EntityRef[];
 }
 interface ViewPushTarget {
     id: string;
@@ -575,6 +602,10 @@ interface ViewContext {
     navigate: (ref: EntityRef) => void;
     /** Pin the overlay to `ref` until the user presses Esc. */
     pinHighlight: (ref: EntityRef) => void;
+    /** Toggle favorite status for an entity ref. */
+    toggleFavorite: (ref: EntityRef) => void;
+    /** Check if an entity ref is favorited. */
+    isFavorite: (ref: EntityRef) => boolean;
     /** Shell-owned search input. The shell dispatches its value into the active surface. */
     searchInput: HTMLInputElement;
     /** Drives the Surface's singleton overlay from inside a custom surface. */
@@ -605,6 +636,7 @@ interface ShellAction {
     id: string;
     label: string;
     shortcut?: string;
+    icon?: () => Node;
     perform: () => void | Promise<void>;
     intent?: ShellActionIntent;
 }
@@ -627,6 +659,15 @@ interface View {
     surface: (ctx: ViewContext) => ViewSurface;
 }
 
+interface PaletteShortcut {
+    /** The key value (e.g. "k", "j", ";"). Matched case-insensitively. */
+    key: string;
+    /** Require Cmd (Mac) / Ctrl (Win/Linux). Default: true. */
+    mod?: boolean;
+    /** Require Shift. Default: false. */
+    shift?: boolean;
+}
+
 interface ViewRegistrar {
     register(view: View): void;
     unregister(id: string): void;
@@ -634,6 +675,10 @@ interface ViewRegistrar {
     get(id: string): View | undefined;
     findMatch(ref: EntityRef): View | null;
     navigate(ref: EntityRef): void;
+    recents(): readonly EntityRef[];
+    favorites(): readonly EntityRef[];
+    toggleFavorite(ref: EntityRef): void;
+    isFavorite(ref: EntityRef): boolean;
 }
 
 interface CreateUidexOptions {
@@ -655,6 +700,8 @@ interface CreateUidexOptions {
      * an options object to override either channel.
      */
     ingest?: IngestOptions | null;
+    /** Keyboard shortcut for the command palette. Defaults to Cmd+K / Ctrl+K. */
+    shortcut?: PaletteShortcut;
 }
 interface Uidex {
     mount(target?: Element): void;