@adoptai/genui-components 0.1.56 → 0.1.58

package/dist/schemas/index.js

@@ -3453,6 +3453,286 @@ var workflowStepperTool = {
     required: ["type", "title", "steps"]
   }
 };
+var bbox = z.tuple([z.number(), z.number(), z.number(), z.number()]);
+var fieldSchema = z.object({
+  field_key: z.string(),
+  label: z.string(),
+  value: z.string(),
+  page: z.number(),
+  // 0-indexed, matches PageDimension.page
+  bbox: bbox.nullable().optional(),
+  confidence: z.number().optional(),
+  confidence_tier: z.enum(["green", "amber", "red"]).optional(),
+  badge: z.enum(["SC", "CN", "AB", "SW"]).optional(),
+  state: z.enum(["ok", "corrected", "missing", "warn"]).optional(),
+  entity_type: z.string().optional(),
+  is_primary: z.boolean().optional(),
+  // Set after a human correction (extractor output, or an optimistic in-card
+  // edit) so the editable field card can show old → new and who changed it.
+  previous_value: z.string().nullable().optional(),
+  corrected_by: z.string().nullable().optional()
+});
+var pageSchema = z.object({
+  page: z.number(),
+  // 0-indexed
+  imageUrl: z.string().optional(),
+  // host-resolved from the durable image_ref
+  width_pt: z.number(),
+  height_pt: z.number()
+});
+var summaryStatSchema = z.object({
+  field_key: z.string(),
+  label: z.string(),
+  value: z.string(),
+  caption: z.string().nullable().optional()
+});
+var summaryFactSchema = z.object({
+  field_key: z.string(),
+  label: z.string(),
+  value: z.string(),
+  badge: z.string().nullable().optional()
+});
+var summarySchema = z.object({
+  display_name: z.string().nullable().optional(),
+  short_name: z.string().nullable().optional(),
+  organization: z.string().nullable().optional(),
+  domain: z.string().nullable().optional(),
+  domain_group: z.string().nullable().optional(),
+  tax_year: z.union([z.string(), z.number()]).nullable().optional(),
+  crumbs: z.array(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  stats: z.array(summaryStatSchema).optional(),
+  facts: z.array(summaryFactSchema).optional()
+});
+var documentFieldExtractionSchema = z.object({
+  type: z.literal("document-field-extraction"),
+  doc_type: z.string().optional(),
+  // Original uploaded filename (e.g. "2024_gl.pdf"); preferred over doc_type for
+  // the card title since doc_type is often the "generic_fallback" schema name.
+  file_name: z.string().optional(),
+  // Server-side token; resolved by the host into pages/fields before render.
+  payload_ref: z.string().optional(),
+  // Present for persisted workstream docs; absent for pre-existing cards.
+  store_id: z.string().optional(),
+  doc_id: z.string().optional(),
+  pages: z.array(pageSchema).max(100).optional(),
+  fields: z.array(fieldSchema).max(1e3).optional(),
+  // Page-count metadata for the Details tab ("N of M pages extracted").
+  page_count: z.number().optional(),
+  pages_processed: z.number().optional(),
+  // Deterministic document summary for the Details tab.
+  summary: summarySchema.nullable().optional()
+});
+var documentFieldExtractionTool = {
+  name: "render_document_field_extraction",
+  description: "Render extracted document fields as an interactive overlay on the page image(s) \u2014 colored bounding boxes per field plus a synced field-card list. Use after the extract_document tool returns; pass the returned payload_ref (the host expands it). For invoices, statements, tax forms, receipts, KYC/loan docs, POs where the user wants to SEE where each value sits on the page.",
+  input_schema: {
+    type: "object",
+    properties: {
+      type: { type: "string", enum: ["document-field-extraction"] },
+      doc_type: { type: "string" },
+      file_name: {
+        type: "string",
+        description: "Original uploaded filename; shown as the card title."
+      },
+      payload_ref: {
+        type: "string",
+        description: "Durable store key returned by extract_document; the GenUI host expands it into pages/fields at render time. Pass this verbatim \u2014 do NOT hand-build pages/fields."
+      },
+      store_id: {
+        type: "string",
+        description: "Docstore store id; present for persisted workstream docs. The host uses this to open the editable viewer."
+      },
+      doc_id: {
+        type: "string",
+        description: "Docstore document id; present for persisted workstream docs. Required for the editable viewer."
+      },
+      pages: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            page: { type: "number", description: "0-indexed page number" },
+            imageUrl: { type: "string" },
+            width_pt: { type: "number" },
+            height_pt: { type: "number" }
+          },
+          required: ["page", "width_pt", "height_pt"]
+        }
+      },
+      fields: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            field_key: { type: "string" },
+            label: { type: "string" },
+            value: { type: "string" },
+            page: { type: "number", description: "0-indexed page number" },
+            bbox: {
+              type: "array",
+              items: { type: "number" },
+              description: "[x0,y0,x1,y1] PDF points, origin bottom-left; null if unlocated"
+            },
+            confidence: { type: "number" },
+            confidence_tier: { type: "string", enum: ["green", "amber", "red"] },
+            badge: { type: "string", enum: ["SC", "CN", "AB", "SW"] },
+            state: { type: "string", enum: ["ok", "corrected", "missing", "warn"] },
+            entity_type: { type: "string" },
+            is_primary: { type: "boolean" }
+          },
+          required: ["field_key", "label", "value", "page"]
+        }
+      },
+      page_count: { type: "number" },
+      pages_processed: { type: "number" },
+      summary: {
+        type: "object",
+        description: "Deterministic document summary for the Details tab (display_name, organization, domain, stats, facts, tags). Produced by the extractor \u2014 pass through verbatim.",
+        properties: {
+          display_name: { type: "string" },
+          short_name: { type: "string" },
+          organization: { type: "string" },
+          domain: { type: "string" },
+          domain_group: { type: "string" },
+          tax_year: { type: "string" },
+          crumbs: { type: "array", items: { type: "string" } },
+          tags: { type: "array", items: { type: "string" } },
+          stats: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                field_key: { type: "string" },
+                label: { type: "string" },
+                value: { type: "string" },
+                caption: { type: "string" }
+              },
+              required: ["field_key", "label", "value"]
+            }
+          },
+          facts: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                field_key: { type: "string" },
+                label: { type: "string" },
+                value: { type: "string" },
+                badge: { type: "string" }
+              },
+              required: ["field_key", "label", "value"]
+            }
+          }
+        }
+      }
+    },
+    required: ["type"]
+  }
+};
+var decisionCardSchema = z.object({
+  type: z.literal("decision-card"),
+  id: z.string().optional(),
+  decision_type: z.string().optional(),
+  title: z.string(),
+  question: z.string(),
+  amount: z.number().optional(),
+  currency: z.string().optional(),
+  amount_label: z.string().optional(),
+  severity: z.enum(["low", "medium", "high"]).optional(),
+  flags: z.array(
+    z.object({
+      field: z.string().optional(),
+      issue: z.string(),
+      severity: z.enum(["low", "medium", "high"]).optional()
+    })
+  ).max(6).optional(),
+  options: z.array(
+    z.object({
+      id: z.string().optional(),
+      label: z.string(),
+      recommended: z.boolean().optional()
+    })
+  ).min(1).max(5),
+  source: z.object({
+    label: z.string().optional(),
+    url: z.string().optional()
+  }).optional(),
+  resolved: z.object({
+    option: z.string()
+  }).optional()
+});
+var decisionCardTool = {
+  name: "render_decision_card",
+  description: "Render an inline human-in-the-loop (HITL) decision card \u2014 a single judgment the agent needs from the user, resolved in-thread. Shows a titled question with an optional dollar amount at stake, optional data-quality flags, and 2-5 mutually-exclusive resolution options (the first or `recommended` one renders as the primary action), plus an optional 'view source' link. Use for inline approve/choose decisions the user resolves directly in the conversation. NOT for handing off to an external review portal (use escalation-card) and NOT for collecting multiple typed fields (use render_builder).",
+  input_schema: {
+    type: "object",
+    properties: {
+      type: { type: "string", enum: ["decision-card"] },
+      id: { type: "string", description: "Stable id for update-in-place rendering" },
+      decision_type: {
+        type: "string",
+        description: "Short category shown in the eyebrow, e.g. 'Cross-check', 'Allocation', 'Reserve'"
+      },
+      title: { type: "string", description: "The decision headline, e.g. 'AR reserve adequacy'" },
+      question: { type: "string", description: "The full question / context the user must judge" },
+      amount: { type: "number", description: "Dollar value at stake, e.g. 27100" },
+      currency: { type: "string", description: "ISO currency code; defaults to USD" },
+      amount_label: { type: "string", description: "Caption above the amount, e.g. 'At stake'" },
+      severity: {
+        type: "string",
+        enum: ["low", "medium", "high"],
+        description: "Severity of the decision; tints the accent rail"
+      },
+      flags: {
+        type: "array",
+        maxItems: 6,
+        description: "Optional data-quality flags surfaced on the card",
+        items: {
+          type: "object",
+          properties: {
+            field: { type: "string" },
+            issue: { type: "string" },
+            severity: { type: "string", enum: ["low", "medium", "high"] }
+          },
+          required: ["issue"]
+        }
+      },
+      options: {
+        type: "array",
+        minItems: 1,
+        maxItems: 5,
+        description: "Mutually-exclusive resolution choices; mark one `recommended` to make it primary",
+        items: {
+          type: "object",
+          properties: {
+            id: { type: "string" },
+            label: { type: "string" },
+            recommended: { type: "boolean" }
+          },
+          required: ["label"]
+        }
+      },
+      source: {
+        type: "object",
+        description: "Optional provenance link for the figure",
+        properties: {
+          label: { type: "string" },
+          url: { type: "string" }
+        }
+      },
+      resolved: {
+        type: "object",
+        description: "Pre-resolved state for transcript replay",
+        properties: {
+          option: { type: "string" }
+        },
+        required: ["option"]
+      }
+    },
+    required: ["type", "title", "question", "options"]
+  }
+};
 
 // src/schemas/buildRenderUITool.ts
 function buildRenderUITool(selectedSchemas) {
@@ -3571,7 +3851,9 @@ var schemaRegistry = {
   "connect-integration": { schema: connectIntegrationSchema, tool: connectIntegrationTool },
   "integrations-list": { schema: integrationsListSchema, tool: integrationsListTool },
   "pipeline-preview": { schema: pipelinePreviewSchema, tool: pipelinePreviewTool },
-  "workflow-stepper": { schema: workflowStepperSchema, tool: workflowStepperTool }
+  "workflow-stepper": { schema: workflowStepperSchema, tool: workflowStepperTool },
+  "document-field-extraction": { schema: documentFieldExtractionSchema, tool: documentFieldExtractionTool },
+  "decision-card": { schema: decisionCardSchema, tool: decisionCardTool }
 };
 
 export { buildRenderUITool, schemaRegistry, validatePayload };