@zeniai/client-epic-state 5.0.81-betaML5 → 5.0.81-betaRR0

package/lib/entity/aiCfo/aiCfoState.d.ts

@@ -9,9 +9,13 @@ export interface AiCfoAnswerParagraph {
     }>;
 }
 export declare const ALL_AI_CFO_CHARTS_TYPES: readonly ["bar_chart", "pie_chart", "line_chart"];
-export declare const ALL_AI_CFO_VISUALIZATION_TYPES: readonly ["bar_chart", "pie_chart", "line_chart", "table"];
-export declare const toAiCfoVisualizationType: (v: string) => "bar_chart" | "pie_chart" | "line_chart" | "table";
-export declare const toAiCfoVisualizationTypeStrict: (v: string) => "bar_chart" | "pie_chart" | "line_chart" | "table" | undefined;
+export declare const ALL_AI_CFO_VISUALIZATION_TYPES: readonly ["bar_chart", "pie_chart", "line_chart", "table", "interactive_form"];
+export declare const ALL_INTERACTIVE_FORM_TYPES: readonly ["cards_creation", "card_policy"];
+export declare const toInteractiveFormType: (v: string) => "cards_creation" | "card_policy";
+export declare const toInteractiveFormTypeStrict: (v: string) => "cards_creation" | "card_policy" | undefined;
+export type InteractiveFormType = ReturnType<typeof toInteractiveFormType>;
+export declare const toAiCfoVisualizationType: (v: string) => "bar_chart" | "pie_chart" | "line_chart" | "table" | "interactive_form";
+export declare const toAiCfoVisualizationTypeStrict: (v: string) => "bar_chart" | "pie_chart" | "line_chart" | "table" | "interactive_form" | undefined;
 export type AiCfoVisualizationType = ReturnType<typeof toAiCfoVisualizationType>;
 export declare const toAiCfoChartType: (v: string) => "bar_chart" | "pie_chart" | "line_chart";
 export declare const toAiCfoChartTypeStrict: (v: string) => "bar_chart" | "pie_chart" | "line_chart" | undefined;
@@ -53,8 +57,163 @@ export interface ChartVisualization {
     lines?: string[];
     yFormat?: YFormat;
 }
+export interface CardsCardOption {
+    id: string;
+    label: string;
+    description?: string;
+}
+/**
+ * Card kind for AI Card Creation rows. `vendor` = vendor-bound card,
+ * `class` = department-scoped card. The wire format ships `department`;
+ * the reducer maps it to `class` (the FE-side term for accounting class /
+ * department) so it lines up with the rest of the codebase.
+ */
+export type CardsCardKind = 'vendor' | 'class';
+/**
+ * Single entry in the unified vendor + department dropdown universe shipped
+ * by the AI controller for the `review` flow. Powers both the
+ * step-2 Card cell dropdown (filtered to entries with matching `kind`) and
+ * the step-1 "Add something else" search (no kind filter — user can add
+ * either).
+ */
+export interface CardNameOption {
+    id: string;
+    kind: CardsCardKind;
+    label: string;
+}
+/**
+ * Initial data for the AI Card Creation interactive form. Discriminated on
+ * `mode`:
+ *
+ * - `review` (default): AI suggests rows (mix of vendors +
+ *   departments); user reviews them in step 1, then configures one card per
+ *   row in step 2. `cardNameOptions` is the full universe (suggested +
+ *   not-suggested) used to populate the dropdown / search.
+ * - `create` (1-step): AI has already chosen cards; user lands directly
+ *   on the editable card table for confirmation.
+ */
+export type CardsCreationInitialData = {
+    cardNameOptions: CardNameOption[];
+    cardOptions: CardsCardOption[];
+    mode: 'review';
+    /**
+     * Map of `teamRow.id` -> suggested owner `userId`. Resolved against
+     * `allUsers` (sourced from the tenant) at render time.
+     */
+    suggestedOwnerUserIdByTeamId: Record<string, ID | undefined>;
+    teamRows: Array<{
+        avgMonthlySpend: string;
+        cardKind: CardsCardKind;
+        id: string;
+        label: string;
+        recommendedLimit: string;
+        recommendedLimitCadence?: string;
+    }>;
+} | {
+    cardOptions: CardsCardOption[];
+    cardRows: Array<{
+        cardOptionId: string;
+        id: string;
+        /**
+         * Optional team-derived display label rendered in the card cell
+         * trigger (e.g. "Engineering"). Drives the row's first-letter avatar
+         * in step 2.
+         */
+        label?: string;
+        recommendedLimit?: number;
+        suggestedOwnerUserId?: ID;
+    }>;
+    mode: 'create';
+};
+/**
+ * Per-policy allow / block bucket. CamelCase mirror of
+ * `DraftPolicyEntityPayload`.
+ */
+export interface CardPolicyDraftPolicyEntity {
+    categoryCodes: string[];
+    merchantNames: string[];
+}
+/**
+ * Spend-limit bucket per policy. `transaction` is the only cadence the
+ * BE ships today.
+ */
+export interface CardPolicySpendLimits {
+    transaction: number;
+}
+/**
+ * Single draft policy in FE state. Identity is positional — the reducer
+ * synthesizes a stable `id` (`draft-0`, `draft-1`, ...) at decode time
+ * since the BE doesn't ship one today.
+ */
+export interface CardPolicyDraftPolicy {
+    allowedEntity: CardPolicyDraftPolicyEntity;
+    applyToCards: string[];
+    blockedEntity: CardPolicyDraftPolicyEntity;
+    description: string;
+    id: string;
+    /** Enforcement mode (e.g. `"strict"`). Carried for guided submit;
+     * ignored by auto / upload submit. */
+    mode: string;
+    name: string;
+    requiredReceiptThreshold: number;
+    spendLimits: CardPolicySpendLimits;
+}
+export interface CardPolicyStep5Review {
+    draftPolicies: CardPolicyDraftPolicy[];
+    groupingSource: string;
+    prompt: string;
+}
+export interface CardPolicyWizardPlan {
+    step5Review: CardPolicyStep5Review;
+}
+/**
+ * Upload-mode metadata returned by the
+ * `policy-recommendation-from-upload` API alongside the wizard plan.
+ */
+export interface CardPolicyUploadSource {
+    confidenceScore: number;
+    fileName: string;
+    lowConfidenceFields: string[];
+}
+/**
+ * Initial data for the AI Card Policy interactive form. Discriminated on
+ * `policyKind`. All three modes consume the same `wizardPlan.step5Review`
+ * envelope; the wizard renders different surfaces per mode.
+ *
+ * - `auto` (1-step review): chip groups built directly from each draft
+ *   policy. Submit omits `mode` + `spend_limits` + `required_receipt_threshold`.
+ * - `guided` (5-step wizard): Steps 1–4 seeded from `draftPolicies[0]`,
+ *   Step 5 lists every draft. Submit includes all keys.
+ * - `upload` (3-step): upload → cards → review. `wizardPlan` is
+ *   `undefined` until the upload-recommendation API succeeds, then
+ *   populated alongside `source` metadata. Submit includes
+ *   `spend_limits` + `required_receipt_threshold`; omits `mode`.
+ */
+export type CardPolicyInitialData = {
+    policyKind: 'auto';
+    wizardPlan: CardPolicyWizardPlan;
+} | {
+    policyKind: 'guided';
+    wizardPlan: CardPolicyWizardPlan;
+} | {
+    policyKind: 'upload';
+    source?: CardPolicyUploadSource;
+    wizardPlan?: CardPolicyWizardPlan;
+};
+/**
+ * Visualization variant rendered as an interactive RHF form (in lieu of a
+ * chart or table). Discriminated on `formType`; each branch carries its own
+ * payload shape.
+ */
+export type InteractiveFormVisualization = {
+    formType: 'cards_creation';
+    payload: CardsCreationInitialData;
+} | {
+    formType: 'card_policy';
+    payload: CardPolicyInitialData;
+};
 export interface AiCfoVisualization {
-    data: TableVisualization | ChartVisualization;
+    data: TableVisualization | ChartVisualization | InteractiveFormVisualization;
     type: AiCfoVisualizationType;
 }
 export declare const toMessageSender: (v: string) => "user" | "agent";
@@ -112,7 +271,30 @@ export interface ChatSessionWithMessages {
     chatSession: ChatSession;
     questionAnswers: AiCfoQuestionWithAnswer[];
 }
+/**
+ * Discriminator for client-synthesized AI CFO answer bubbles. These are not
+ * Q/A pairs streamed from the backend — they are pushed locally by the AI
+ * CFO flow when it kicks off a cards or policy create from an interactive
+ * form, so the drawer can render a "Creating…" placeholder and later a
+ * "Created" success bubble while the corresponding mutation epic runs.
+ */
+export declare const ALL_SYNTHETIC_AI_CFO_ANSWER_KINDS: readonly ["creating_cards", "creating_policy", "created_cards", "created_policy"];
+export type SyntheticAiCfoAnswerKind = (typeof ALL_SYNTHETIC_AI_CFO_ANSWER_KINDS)[number];
+/**
+ * A locally-synthesized answer bubble (e.g. "Creating cards…", or "2 policies
+ * are created and saved" with preview tiles). Lives parallel to the streamed
+ * `questionAnswers` to keep the conversation shape pristine; the AI CFO
+ * renderer appends these at the bottom of the conversation in order of
+ * `createdAt`.
+ */
+export interface SyntheticAiCfoAnswer {
+    createdAt: ZeniDate;
+    entityIds: ID[];
+    id: ID;
+    kind: SyntheticAiCfoAnswerKind;
+}
 export interface AiCfoState {
     aiCfoByChatSessionId: Record<ID, ChatSessionWithMessages>;
     partialQuestionAnswers: Record<ID, AiCfoQuestionWithAnswer | undefined>;
+    syntheticAnswersByChatSessionId: Record<ID, SyntheticAiCfoAnswer[]>;
 }

package/lib/entity/aiCfo/aiCfoState.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toMessageTypeStrict = exports.toMessageSenderStrict = exports.toMessageType = exports.toMessageSender = exports.toAiCfoAnswerResponseTypeStrict = exports.toAiCfoAnswerStateTypeStrict = exports.toAiCfoAnswerResponseType = exports.toAiCfoAnswerStateType = exports.toYFormatScaleStrict = exports.toYFormatUnitStrict = exports.toYFormatTypeStrict = exports.toYFormatScale = exports.toYFormatUnit = exports.toYFormatType = exports.ALL_Y_FORMAT_SCALES = exports.ALL_Y_FORMAT_NON_CURRENCY_UNITS = exports.ALL_Y_FORMAT_TYPES = exports.ALL_AI_CFO_ANSWER_RESPONSE_TYPES = exports.ALL_AI_CFO_ANSWER_STATE_TYPES = exports.toAiCfoChartTypeStrict = exports.toAiCfoChartType = exports.toAiCfoVisualizationTypeStrict = exports.toAiCfoVisualizationType = exports.ALL_AI_CFO_VISUALIZATION_TYPES = exports.ALL_AI_CFO_CHARTS_TYPES = void 0;
+exports.ALL_SYNTHETIC_AI_CFO_ANSWER_KINDS = exports.toMessageTypeStrict = exports.toMessageSenderStrict = exports.toMessageType = exports.toMessageSender = exports.toAiCfoAnswerResponseTypeStrict = exports.toAiCfoAnswerStateTypeStrict = exports.toAiCfoAnswerResponseType = exports.toAiCfoAnswerStateType = exports.toYFormatScaleStrict = exports.toYFormatUnitStrict = exports.toYFormatTypeStrict = exports.toYFormatScale = exports.toYFormatUnit = exports.toYFormatType = exports.ALL_Y_FORMAT_SCALES = exports.ALL_Y_FORMAT_NON_CURRENCY_UNITS = exports.ALL_Y_FORMAT_TYPES = exports.ALL_AI_CFO_ANSWER_RESPONSE_TYPES = exports.ALL_AI_CFO_ANSWER_STATE_TYPES = exports.toAiCfoChartTypeStrict = exports.toAiCfoChartType = exports.toAiCfoVisualizationTypeStrict = exports.toAiCfoVisualizationType = exports.toInteractiveFormTypeStrict = exports.toInteractiveFormType = exports.ALL_INTERACTIVE_FORM_TYPES = exports.ALL_AI_CFO_VISUALIZATION_TYPES = exports.ALL_AI_CFO_CHARTS_TYPES = void 0;
 const stringToUnion_1 = require("../../commonStateTypes/stringToUnion");
 exports.ALL_AI_CFO_CHARTS_TYPES = [
     'bar_chart',
@@ -10,7 +10,16 @@ exports.ALL_AI_CFO_CHARTS_TYPES = [
 exports.ALL_AI_CFO_VISUALIZATION_TYPES = [
     ...exports.ALL_AI_CFO_CHARTS_TYPES,
     'table',
+    'interactive_form',
 ];
+exports.ALL_INTERACTIVE_FORM_TYPES = [
+    'cards_creation',
+    'card_policy',
+];
+const toInteractiveFormType = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.ALL_INTERACTIVE_FORM_TYPES);
+exports.toInteractiveFormType = toInteractiveFormType;
+const toInteractiveFormTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, exports.ALL_INTERACTIVE_FORM_TYPES);
+exports.toInteractiveFormTypeStrict = toInteractiveFormTypeStrict;
 const toAiCfoVisualizationType = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.ALL_AI_CFO_VISUALIZATION_TYPES);
 exports.toAiCfoVisualizationType = toAiCfoVisualizationType;
 const toAiCfoVisualizationTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, exports.ALL_AI_CFO_VISUALIZATION_TYPES);
@@ -79,3 +88,16 @@ const toMessageSenderStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v,
 exports.toMessageSenderStrict = toMessageSenderStrict;
 const toMessageTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, ALL_MESSAGE_TYPES);
 exports.toMessageTypeStrict = toMessageTypeStrict;
+/**
+ * Discriminator for client-synthesized AI CFO answer bubbles. These are not
+ * Q/A pairs streamed from the backend — they are pushed locally by the AI
+ * CFO flow when it kicks off a cards or policy create from an interactive
+ * form, so the drawer can render a "Creating…" placeholder and later a
+ * "Created" success bubble while the corresponding mutation epic runs.
+ */
+exports.ALL_SYNTHETIC_AI_CFO_ANSWER_KINDS = [
+    'creating_cards',
+    'creating_policy',
+    'created_cards',
+    'created_policy',
+];

package/lib/entity/cardPolicy/cardPolicyPayload.d.ts

@@ -0,0 +1,277 @@
+import { ID } from '../../commonStateTypes/common';
+import { ZeniAPIResponse } from '../../responsePayload';
+import { CardPolicyStats, CardPolicyTemplate, CardPolicyTemplateEntityList, CardPolicyTemplateMode, CardPolicyTemplateSpendLimits, ExtractedCardPolicyRules, MccCategory } from './cardPolicyState';
+export interface MccCategoryPayload {
+    count: number;
+    mcc_codes: string[];
+    name: string;
+}
+/**
+ * Wire shape for `GET /cards/1.0/cards/mcc-codes`. Beyond the universe of
+ * MCC categories used to populate the category search dropdown, the
+ * endpoint also ships **suggested** allow / block merchants and categories
+ * that the chip-pickers seed into their cloud body before the user starts
+ * editing.
+ *
+ * Field spellings (`*_catagories`) preserve the BE wire format verbatim;
+ * the camelCase mapper below corrects to `Categories`.
+ */
+export interface CardPolicyMccCategoriesPayload {
+    categories: MccCategoryPayload[];
+    suggested_allow_catagories?: MccCategoryPayload[];
+    suggested_allow_merchants?: string[];
+    suggested_block_catagories?: MccCategoryPayload[];
+    suggested_block_merchants?: string[];
+}
+export type CardPolicyMccCategoriesResponse = ZeniAPIResponse<CardPolicyMccCategoriesPayload>;
+export declare const toMccCategory: (payload: MccCategoryPayload) => MccCategory;
+/**
+ * Vendor row returned by `/accounting/1.0/vendors`. The card-policy
+ * vendor search dropdown only needs `vendor_id` + `vendor_name`; we
+ * deliberately ignore the rest of the payload to keep this slice
+ * independent of the heavy `vendor` entity store.
+ */
+export interface CardPolicyVendorSearchVendorPayload {
+    vendor_id: string;
+    vendor_name: string;
+}
+export interface CardPolicyVendorSearchData {
+    vendors: CardPolicyVendorSearchVendorPayload[];
+}
+export type CardPolicyVendorSearchResponse = ZeniAPIResponse<CardPolicyVendorSearchData>;
+export interface CardPolicyVendorSearchOption {
+    name: string;
+    vendorId: string;
+}
+export declare const toCardPolicyVendorSearchOption: (payload: CardPolicyVendorSearchVendorPayload) => CardPolicyVendorSearchOption;
+interface CardPolicyTemplateEntityListPayload {
+    category_codes: string[];
+    merchant_names: string[];
+}
+interface CardPolicyTemplateSpendLimitsPayload {
+    transaction: number | null;
+}
+/**
+ * Per-template request shape. `POST /cards/1.0/policy-templates` now
+ * accepts a bulk wrapper (`CreateCardPolicyTemplatesRequest`); this
+ * interface describes a single entry inside the `templates` array.
+ *
+ * `PUT /cards/1.0/policy-templates/{id}` (update) still consumes this
+ * shape directly — see `UpdateCardPolicyTemplateRequest` below.
+ */
+export interface CreateCardPolicyTemplateRequest {
+    allowedEntity: CardPolicyTemplateEntityList;
+    applyToCards: ID[];
+    blockedEntity: CardPolicyTemplateEntityList;
+    description: string;
+    mode: CardPolicyTemplateMode;
+    name: string;
+    /**
+     * `null` indicates the require-receipt toggle is off (no threshold
+     * configured). The BE accepts `null` and treats it as "no requirement";
+     * `0` means the user explicitly entered zero with the toggle on.
+     */
+    requiredReceiptThreshold: number | null;
+    spendLimits: CardPolicyTemplateSpendLimits;
+}
+export interface CreateCardPolicyTemplateRequestBody {
+    allowed_entity: CardPolicyTemplateEntityListPayload;
+    apply_to_cards: ID[];
+    blocked_entity: CardPolicyTemplateEntityListPayload;
+    description: string;
+    mode: string;
+    name: string;
+    required_receipt_threshold: number | null;
+    spend_limits: CardPolicyTemplateSpendLimitsPayload;
+}
+/**
+ * Bulk request for `POST /cards/1.0/policy-templates`. The single-policy
+ * create flow wraps its one request in a length-1 `templates` array;
+ * future multi-policy submit (AI CFO review step) sends N entries in a
+ * single round-trip.
+ *
+ * `sourceChatSessionId` ties the submit back to an AI CFO chat session so
+ * the BE can attribute the created templates to it. Manual create-page
+ * callers omit it.
+ */
+export interface CreateCardPolicyTemplatesRequest {
+    templates: CreateCardPolicyTemplateRequest[];
+    sourceChatSessionId?: string;
+}
+export interface CreateCardPolicyTemplatesRequestBody {
+    templates: CreateCardPolicyTemplateRequestBody[];
+    source_chat_session_id?: string;
+}
+export interface CardPolicyTemplatePayload {
+    allowed_entity: CardPolicyTemplateEntityListPayload;
+    applied_cards: ID[];
+    blocked_entity: CardPolicyTemplateEntityListPayload;
+    cards_count: number;
+    category_restrictions: unknown[];
+    created_at: string;
+    created_by: ID;
+    description: string;
+    mode: string;
+    name: string;
+    required_receipt_threshold: number | null;
+    spend_limits: CardPolicyTemplateSpendLimitsPayload;
+    status: string;
+    template_id: ID;
+    tenant_id: ID;
+    updated_at: string;
+}
+/**
+ * Per-template response envelope. Still returned by `PUT /policy-templates/{id}`,
+ * `GET /policy-templates/{id}`, and (as the row payload) the list endpoint.
+ * Also nested inside `CreateCardPolicyTemplatesResponseData.templates_created`.
+ */
+export interface CreateCardPolicyTemplateResponseData {
+    cards_applied: number;
+    template: CardPolicyTemplatePayload;
+}
+export type CreateCardPolicyTemplateResponse = ZeniAPIResponse<CreateCardPolicyTemplateResponseData>;
+/**
+ * Per-item error returned by the bulk POST when one or more templates in
+ * the request fail validation / persistence. The exact field shape is
+ * **TBD** with the BE — `message` is the only guaranteed field today; the
+ * rest are best-effort placeholders that callers should not assume to be
+ * present.
+ *
+ * TODO: lock down the shape (`index`, `name`, `code`) once the BE
+ * documents it. See plan §"Open question to resolve with BE".
+ */
+export interface BulkCreateCardPolicyTemplateErrorPayload {
+    message: string;
+    code?: string;
+    index?: number;
+    name?: string;
+}
+/**
+ * Wire shape returned by the bulk `POST /cards/1.0/policy-templates`.
+ * Partial success is allowed — `templates_created` holds the successfully
+ * created rows (each in the same envelope as the single endpoint), and
+ * `errors` holds per-item failures for the rest. `status.message` follows
+ * the "N of M templates created" convention.
+ */
+export interface CreateCardPolicyTemplatesResponseData {
+    errors: BulkCreateCardPolicyTemplateErrorPayload[];
+    templates_created: CreateCardPolicyTemplateResponseData[];
+}
+export type CreateCardPolicyTemplatesResponse = ZeniAPIResponse<CreateCardPolicyTemplatesResponseData>;
+/**
+ * Camel-cased mirror of `BulkCreateCardPolicyTemplateErrorPayload` stored
+ * on the create-card-policy view slice so the UI can render a partial-success
+ * banner without re-touching the wire types.
+ */
+export interface BulkCreateCardPolicyTemplateError {
+    message: string;
+    code?: string;
+    index?: number;
+    name?: string;
+}
+export type UpdateCardPolicyTemplateRequest = CreateCardPolicyTemplateRequest;
+export type UpdateCardPolicyTemplateRequestBody = CreateCardPolicyTemplateRequestBody;
+export type UpdateCardPolicyTemplateResponseData = CreateCardPolicyTemplateResponseData;
+export type UpdateCardPolicyTemplateResponse = CreateCardPolicyTemplateResponse;
+export type CardPolicyDetailResponseData = CreateCardPolicyTemplateResponseData;
+export type CardPolicyDetailResponse = CreateCardPolicyTemplateResponse;
+/**
+ * Aggregate counters returned alongside the templates list. Stored on
+ * the entity slice (alongside `cardPolicyTemplateById`) so any list
+ * surface can read it without re-fetching.
+ */
+export interface CardPolicyStatsPayload {
+    active_policies: number;
+    total_cards: number;
+    total_templates: number;
+}
+/**
+ * Each list row is wrapped in the same `{cards_applied, template}`
+ * envelope the create endpoint returns. Only the `template` portion is
+ * stored on the entity slice; `cards_applied` is a one-shot summary
+ * carried over from create and not surfaced in the list state today.
+ */
+export interface CardPolicyListRowPayload {
+    data: CreateCardPolicyTemplateResponseData;
+}
+export interface ListCardPolicyTemplatesResponseData {
+    stats: CardPolicyStatsPayload;
+    templates: CardPolicyListRowPayload[];
+}
+export type ListCardPolicyTemplatesResponse = ZeniAPIResponse<ListCardPolicyTemplatesResponseData>;
+export declare const toCardPolicyStats: (payload: CardPolicyStatsPayload) => CardPolicyStats;
+export declare const toCardPolicyTemplateList: (data: ListCardPolicyTemplatesResponseData) => CardPolicyTemplate[];
+export declare const toCardPolicyTemplate: (payload: CardPolicyTemplatePayload) => CardPolicyTemplate;
+/**
+ * Re-shape a single camelCase create request into the snake_case wire
+ * body. Used by the bulk-create mapper to build each entry of the
+ * `templates` array, and directly by the update epic (PUT) since the
+ * update endpoint still consumes a single object.
+ */
+export declare const toCreateCardPolicyTemplateRequestBody: (request: CreateCardPolicyTemplateRequest) => CreateCardPolicyTemplateRequestBody;
+/**
+ * Re-shape a bulk create request into the snake_case wire body for
+ * `POST /cards/1.0/policy-templates`. Maps each entry through
+ * `toCreateCardPolicyTemplateRequestBody` and only emits
+ * `source_chat_session_id` when the camelCase counterpart is defined,
+ * so manual-create callers don't ship a stray `undefined` over the wire.
+ */
+export declare const toCreateCardPolicyTemplatesRequestBody: (request: CreateCardPolicyTemplatesRequest) => CreateCardPolicyTemplatesRequestBody;
+/**
+ * Map a single bulk-response error payload to its camelCased view shape.
+ * Defensive against missing optional fields (see `BulkCreateCardPolicyTemplateErrorPayload`
+ * docstring — the BE contract isn't fully locked yet).
+ */
+export declare const toBulkCreateCardPolicyTemplateError: (payload: BulkCreateCardPolicyTemplateErrorPayload) => BulkCreateCardPolicyTemplateError;
+export declare const toUpdateCardPolicyTemplateRequestBody: (request: CreateCardPolicyTemplateRequest) => CreateCardPolicyTemplateRequestBody;
+/**
+ * Seed an edit-form draft (`CreateCardPolicyTemplateRequest`) from an
+ * existing camelCased `CardPolicyTemplate`. Used by the detail-fetch
+ * epic so the edit page can render with the saved values pre-populated.
+ */
+export declare const toCardPolicyEditFormDraft: (template: CardPolicyTemplate) => CreateCardPolicyTemplateRequest;
+/**
+ * Wire shape returned by `POST /cards/1.0/policy-documents/extract`.
+ * The backend OCRs / parses an uploaded policy document (PDF, image, etc.)
+ * and returns a best-effort set of policy rules + a confidence score.
+ *
+ * Consumers (manual `CardPolicyCreatePage` + AI CFO `CardPolicyInteractiveForm`)
+ * use `toExtractedCardPolicyRules` to map this onto the camelCase FE shape
+ * and then feed the result through `applyExtractedPolicyRulesToFormValues`
+ * (`@zeniai/web-components`) to seed the RHF form.
+ */
+export interface ExtractedCardPolicyRulesPayload {
+    allowed_entity: CardPolicyTemplateEntityListPayload;
+    blocked_entity: CardPolicyTemplateEntityListPayload;
+    confidence_score: number;
+    policy_name: string;
+    required_receipt_threshold: number;
+    transaction_limit: number;
+}
+export interface PolicyDocumentExtractResponseData {
+    extracted_rules: ExtractedCardPolicyRulesPayload;
+    message: string;
+}
+export type PolicyDocumentExtractResponse = ZeniAPIResponse<PolicyDocumentExtractResponseData>;
+export declare const toExtractedCardPolicyRules: (payload: ExtractedCardPolicyRulesPayload) => ExtractedCardPolicyRules;
+/**
+ * Wire shape returned by `POST /cards/1.0/ai-cfo/policy-recommendation-from-upload`.
+ * Chained after `extractPolicyDocument` succeeds in the AI CFO `upload`
+ * flow: the FE forwards the just-returned `extracted_rules` and the BE
+ * synthesizes a wizard plan + upload source metadata.
+ *
+ * The response mirrors the same `mode`-discriminated envelope the
+ * controller API ships for `auto` / `guided`, but always with `mode:
+ * "upload"` and a populated `wizard_plan.step_5_review`. The FE merges
+ * the returned `wizard_plan` + `source` into the in-flight AI CFO
+ * answer's `CardPolicyInitialData` via
+ * `updateAiCfoAnswerCardPolicyWizardPlan`.
+ */
+export interface CardPolicyRecommendationFromUploadResponseData {
+    mode: 'upload';
+    source: import('../aiCfo/aiCfoPayload').CardPolicyUploadSourcePayload;
+    tenant_id: string;
+    wizard_plan: import('../aiCfo/aiCfoPayload').CardPolicyWizardPlanPayload;
+}
+export type CardPolicyRecommendationFromUploadResponse = ZeniAPIResponse<CardPolicyRecommendationFromUploadResponseData>;
+export {};

package/lib/entity/cardPolicy/cardPolicyPayload.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toExtractedCardPolicyRules = exports.toCardPolicyEditFormDraft = exports.toUpdateCardPolicyTemplateRequestBody = exports.toBulkCreateCardPolicyTemplateError = exports.toCreateCardPolicyTemplatesRequestBody = exports.toCreateCardPolicyTemplateRequestBody = exports.toCardPolicyTemplate = exports.toCardPolicyTemplateList = exports.toCardPolicyStats = exports.toCardPolicyVendorSearchOption = exports.toMccCategory = void 0;
+const zeniDayJS_1 = require("../../zeniDayJS");
+const cardPolicyState_1 = require("./cardPolicyState");
+const toMccCategory = (payload) => ({
+    count: payload.count,
+    mccCodes: payload.mcc_codes ?? [],
+    name: payload.name,
+});
+exports.toMccCategory = toMccCategory;
+const toCardPolicyVendorSearchOption = (payload) => ({
+    vendorId: payload.vendor_id,
+    name: payload.vendor_name,
+});
+exports.toCardPolicyVendorSearchOption = toCardPolicyVendorSearchOption;
+const toCardPolicyStats = (payload) => ({
+    activePolicies: payload.active_policies,
+    totalCards: payload.total_cards,
+    totalTemplates: payload.total_templates,
+});
+exports.toCardPolicyStats = toCardPolicyStats;
+const toCardPolicyTemplateList = (data) => (data.templates ?? []).map((row) => (0, exports.toCardPolicyTemplate)(row.data.template));
+exports.toCardPolicyTemplateList = toCardPolicyTemplateList;
+const toCardPolicyTemplateEntityList = (payload) => ({
+    categoryCodes: payload.category_codes ?? [],
+    merchantNames: payload.merchant_names ?? [],
+});
+const toCardPolicyTemplate = (payload) => ({
+    allowedEntity: toCardPolicyTemplateEntityList(payload.allowed_entity),
+    appliedCards: payload.applied_cards ?? [],
+    blockedEntity: toCardPolicyTemplateEntityList(payload.blocked_entity),
+    cardsCount: payload.cards_count,
+    categoryRestrictions: payload.category_restrictions ?? [],
+    createdAt: (0, zeniDayJS_1.date)(payload.created_at),
+    createdBy: payload.created_by,
+    description: payload.description,
+    mode: (0, cardPolicyState_1.toCardPolicyTemplateMode)(payload.mode),
+    name: payload.name,
+    requiredReceiptThreshold: payload.required_receipt_threshold,
+    spendLimits: {
+        transaction: payload.spend_limits.transaction,
+    },
+    status: (0, cardPolicyState_1.toCardPolicyTemplateStatus)(payload.status),
+    templateId: payload.template_id,
+    tenantId: payload.tenant_id,
+    updatedAt: (0, zeniDayJS_1.date)(payload.updated_at),
+});
+exports.toCardPolicyTemplate = toCardPolicyTemplate;
+/**
+ * Re-shape a single camelCase create request into the snake_case wire
+ * body. Used by the bulk-create mapper to build each entry of the
+ * `templates` array, and directly by the update epic (PUT) since the
+ * update endpoint still consumes a single object.
+ */
+const toCreateCardPolicyTemplateRequestBody = (request) => ({
+    allowed_entity: {
+        category_codes: request.allowedEntity.categoryCodes,
+        merchant_names: request.allowedEntity.merchantNames,
+    },
+    apply_to_cards: request.applyToCards,
+    blocked_entity: {
+        category_codes: request.blockedEntity.categoryCodes,
+        merchant_names: request.blockedEntity.merchantNames,
+    },
+    description: request.description,
+    mode: request.mode ?? 'strict',
+    name: request.name,
+    required_receipt_threshold: request.requiredReceiptThreshold,
+    spend_limits: {
+        transaction: request.spendLimits.transaction,
+    },
+});
+exports.toCreateCardPolicyTemplateRequestBody = toCreateCardPolicyTemplateRequestBody;
+/**
+ * Re-shape a bulk create request into the snake_case wire body for
+ * `POST /cards/1.0/policy-templates`. Maps each entry through
+ * `toCreateCardPolicyTemplateRequestBody` and only emits
+ * `source_chat_session_id` when the camelCase counterpart is defined,
+ * so manual-create callers don't ship a stray `undefined` over the wire.
+ */
+const toCreateCardPolicyTemplatesRequestBody = (request) => {
+    const body = {
+        templates: request.templates.map(exports.toCreateCardPolicyTemplateRequestBody),
+    };
+    if (request.sourceChatSessionId != null) {
+        body.source_chat_session_id = request.sourceChatSessionId;
+    }
+    return body;
+};
+exports.toCreateCardPolicyTemplatesRequestBody = toCreateCardPolicyTemplatesRequestBody;
+/**
+ * Map a single bulk-response error payload to its camelCased view shape.
+ * Defensive against missing optional fields (see `BulkCreateCardPolicyTemplateErrorPayload`
+ * docstring — the BE contract isn't fully locked yet).
+ */
+const toBulkCreateCardPolicyTemplateError = (payload) => ({
+    message: payload.message,
+    code: payload.code,
+    index: payload.index,
+    name: payload.name,
+});
+exports.toBulkCreateCardPolicyTemplateError = toBulkCreateCardPolicyTemplateError;
+// Update body uses the exact same wire shape as create — the PUT
+// endpoint is a full replace and was not affected by the bulk migration.
+exports.toUpdateCardPolicyTemplateRequestBody = exports.toCreateCardPolicyTemplateRequestBody;
+/**
+ * Seed an edit-form draft (`CreateCardPolicyTemplateRequest`) from an
+ * existing camelCased `CardPolicyTemplate`. Used by the detail-fetch
+ * epic so the edit page can render with the saved values pre-populated.
+ */
+const toCardPolicyEditFormDraft = (template) => ({
+    allowedEntity: {
+        categoryCodes: [...template.allowedEntity.categoryCodes],
+        merchantNames: [...template.allowedEntity.merchantNames],
+    },
+    applyToCards: [...template.appliedCards],
+    blockedEntity: {
+        categoryCodes: [...template.blockedEntity.categoryCodes],
+        merchantNames: [...template.blockedEntity.merchantNames],
+    },
+    description: template.description,
+    mode: template.mode,
+    name: template.name,
+    requiredReceiptThreshold: template.requiredReceiptThreshold,
+    spendLimits: { transaction: template.spendLimits.transaction },
+});
+exports.toCardPolicyEditFormDraft = toCardPolicyEditFormDraft;
+const toExtractedCardPolicyRules = (payload) => ({
+    allowedEntity: {
+        categoryCodes: payload.allowed_entity?.category_codes ?? [],
+        merchantNames: payload.allowed_entity?.merchant_names ?? [],
+    },
+    blockedEntity: {
+        categoryCodes: payload.blocked_entity?.category_codes ?? [],
+        merchantNames: payload.blocked_entity?.merchant_names ?? [],
+    },
+    confidenceScore: payload.confidence_score,
+    policyName: payload.policy_name,
+    requiredReceiptThreshold: payload.required_receipt_threshold,
+    transactionLimit: payload.transaction_limit,
+});
+exports.toExtractedCardPolicyRules = toExtractedCardPolicyRules;