@bacano/sdk 1.2.2 → 1.2.3

package/flows.d.ts

@@ -0,0 +1,109 @@
+import type { AccessTokenProvider, WebsiteFormDefinition, WebsiteFormResponseValue } from "./types";
+export interface FlowCaseSummary {
+    id: string;
+    title: string;
+    reference: string;
+    status: "open" | "completed" | "rejected";
+    flowName: string;
+}
+export interface ParticipantFlowStep {
+    id: string;
+    kind: "content" | "form" | "task" | "review";
+    title: string;
+    required: boolean;
+    completed: boolean;
+    available: boolean;
+    canComplete: boolean;
+    internal: boolean;
+    canReadResponse: boolean;
+    completion?: "reference" | "continue" | "confirmation";
+    confirmationText?: string;
+    instructions?: string;
+}
+export interface ParticipantJourney extends FlowCaseSummary {
+    revision: number;
+    flowRevision: number;
+    stageId: string;
+    dueDate: string | null;
+    stages: Array<{
+        id: string;
+        name: string;
+        current: boolean;
+        /** Presentation only; availability and completion remain server-authoritative. */
+        presentation?: "step_by_step" | "single_view";
+        steps: ParticipantFlowStep[];
+    }>;
+    messages: Array<{
+        createdAt: string;
+        message: string;
+    }>;
+}
+export interface FlowPublishedForm {
+    name: string;
+    version: number;
+    definitionHash: string;
+    definition: WebsiteFormDefinition;
+    /** Own previous answers, scoped and filtered by the backend for a correction. */
+    initialValues?: Record<string, WebsiteFormResponseValue>;
+    correction?: {
+        attempt: number;
+        formChanged: boolean;
+    };
+}
+export interface FlowContentResource {
+    id: string;
+    name: string;
+    content: Record<string, unknown>;
+}
+export interface FlowResponse {
+    snapshot: Array<{
+        key: string;
+        label: string;
+        displayValue: unknown;
+    }>;
+    attempt: number;
+    submittedAt: string;
+}
+export interface FlowParticipantCommand {
+    stepId: string;
+    revision: number;
+    flowRevision: number;
+    idempotencyKey: string;
+    operation: "complete_content" | "complete_task" | "submit_form";
+    confirmed?: boolean;
+    submission?: {
+        formVersion: number;
+        definitionHash: string;
+        values: Record<string, WebsiteFormResponseValue>;
+    };
+}
+export interface FlowsClientConfig {
+    apiUrl: string;
+    getAccessToken?: AccessTokenProvider;
+    websiteSlug?: string;
+}
+export interface FlowDemoSession {
+    token: string;
+    name: string;
+    expiresAt: string;
+}
+/** Gateway only. Tokens are supplied per request; this client stores no credentials. */
+export declare function createFlowsClient(config: FlowsClientConfig): {
+    /** Only the explicitly enabled local demo gateway accepts these credentials. */
+    localDemoLogin: (email: string, password: string) => Promise<FlowDemoSession>;
+    logout: () => Promise<{
+        success: boolean;
+    }>;
+    listCases: () => Promise<FlowCaseSummary[]>;
+    getJourney: (caseId: string) => Promise<ParticipantJourney>;
+    getContent: (caseId: string, stepId: string) => Promise<FlowContentResource[]>;
+    getForm: (caseId: string, stepId: string) => Promise<FlowPublishedForm>;
+    getResponse: (caseId: string, stepId: string) => Promise<FlowResponse>;
+    getFile: (caseId: string, stepId: string, fileId: string) => Promise<Blob>;
+    act: (caseId: string, command: FlowParticipantCommand) => Promise<{
+        caseId: string;
+        revision: number;
+        responseId: string | null;
+    }>;
+};
+export type FlowsClient = ReturnType<typeof createFlowsClient>;

package/form-conditions.d.ts

@@ -0,0 +1,6 @@
+import type { WebsiteFormDefinition, WebsiteFormField } from "./types";
+export declare function formRootFields(definition: WebsiteFormDefinition): WebsiteFormField[];
+/** Unselected branches do not participate in validation or submissions. */
+export declare function visibleFormFields(fields: WebsiteFormField[], values: Record<string, unknown>): WebsiteFormField[];
+export declare function allFormFields(fields: WebsiteFormField[]): WebsiteFormField[];
+export declare function activeFormValues<T>(definition: WebsiteFormDefinition, values: Record<string, T>): Record<string, T>;

package/index.cjs

@@ -30,6 +30,7 @@ __export(index_exports, {
   RateLimitError: () => RateLimitError,
   WEBSITE_MARKETING_CONTACT_PLACEMENTS: () => WEBSITE_MARKETING_CONTACT_PLACEMENTS,
   WebsiteError: () => WebsiteError,
+  activeFormValues: () => activeFormValues,
   buildStorageContentMediaUrls: () => buildStorageContentMediaUrls,
   buildStorageFileUrl: () => buildStorageFileUrl,
   buildStorageMediaUrls: () => buildStorageMediaUrls,
@@ -37,7 +38,9 @@ __export(index_exports, {
   buildStorageTransformedFileUrl: () => buildStorageTransformedFileUrl,
   captureWebsiteMarketingAttribution: () => captureWebsiteMarketingAttribution,
   createBacanoClient: () => createBacanoClient,
+  createFlowsClient: () => createFlowsClient,
   createWebsiteMarketingRuntime: () => createWebsiteMarketingRuntime,
+  formRootFields: () => formRootFields,
   formatMediaSrcSet: () => formatMediaSrcSet,
   getAllowedMarketingParameters: () => getAllowedMarketingParameters,
   getContentEntryLocatorAttributes: () => getContentEntryLocatorAttributes,
@@ -51,7 +54,8 @@ __export(index_exports, {
   getWebsiteMarketingAttribution: () => getWebsiteMarketingAttribution,
   getWebsitePublicConfig: () => getWebsitePublicConfig,
   resolveProductPricing: () => resolveProductPricing,
-  sanitizeMarketingUrl: () => sanitizeMarketingUrl
+  sanitizeMarketingUrl: () => sanitizeMarketingUrl,
+  visibleFormFields: () => visibleFormFields
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -110,6 +114,52 @@ var GraphQLRequestError = class extends WebsiteError {
   }
 };
 
+// libs/sdk/src/flows.ts
+function createFlowsClient(config) {
+  const base = config.apiUrl.replace(/\/+$/, "") + "/api/v1/website/flows";
+  async function request(path, body, binary = false) {
+    const token = await config.getAccessToken?.();
+    const response = await fetch(base + path, {
+      method: body === void 0 ? "GET" : "POST",
+      cache: "no-store",
+      headers: {
+        ...token ? { Authorization: `Bearer ${token}` } : {},
+        ...body !== void 0 ? { "Content-Type": "application/json" } : {},
+        ...config.websiteSlug ? { "x-bacano-website-slug": config.websiteSlug } : {}
+      },
+      ...body !== void 0 ? { body: JSON.stringify(body) } : {}
+    });
+    if (!response.ok) {
+      const result = await response.json().catch(() => ({ error: "FLOW_REQUEST_FAILED" }));
+      throw new WebsiteError(
+        result.error ?? "FLOW_REQUEST_FAILED",
+        result.error ?? "FLOW_REQUEST_FAILED"
+      );
+    }
+    return binary ? await response.blob() : await response.json();
+  }
+  const stepPath = (caseId, stepId) => `/cases/${encodeURIComponent(caseId)}/steps/${encodeURIComponent(stepId)}`;
+  return {
+    /** Only the explicitly enabled local demo gateway accepts these credentials. */
+    localDemoLogin: (email, password) => request("/local-session", { email, password }),
+    logout: () => request("/logout", {}),
+    listCases: () => request("/cases"),
+    getJourney: (caseId) => request(`/cases/${encodeURIComponent(caseId)}`),
+    getContent: (caseId, stepId) => request(stepPath(caseId, stepId) + "/content"),
+    getForm: (caseId, stepId) => request(stepPath(caseId, stepId) + "/form"),
+    getResponse: (caseId, stepId) => request(stepPath(caseId, stepId) + "/response"),
+    getFile: (caseId, stepId, fileId) => request(
+      stepPath(caseId, stepId) + `/files/${encodeURIComponent(fileId)}`,
+      void 0,
+      true
+    ),
+    act: (caseId, command) => request(
+      `/cases/${encodeURIComponent(caseId)}/actions`,
+      command
+    )
+  };
+}
+
 // libs/sdk/src/media.ts
 var DEFAULT_RESPONSIVE_WIDTHS = [240, 384, 640, 960, 1400];
 var CONTENT_HERO_WIDTHS = [640, 960, 1400, 1920, 2560];
@@ -2240,7 +2290,7 @@ var RECONCILE_PAYMENT_SESSION = (
     $orderId: uuid!
     $publicOrderToken: String!
     $paymentSessionId: uuid!
-    $gatewayTransactionId: String!
+    $gatewayTransactionId: String
   ) {
     websiteReconcilePaymentSession(
       order_id: $orderId
@@ -7064,6 +7114,7 @@ function createBacanoClient(config) {
       await initialization;
     },
     getContext,
+    flows: createFlowsClient(config),
     auth: {
       async getAccessToken() {
         return config.getAccessToken ? await config.getAccessToken() : null;
@@ -7163,3 +7214,34 @@ function getContentEntryLocatorAttributes(entry) {
     "data-bacano-entry-name": entry.name.trim() || key
   };
 }
+
+// libs/sdk/src/form-conditions.ts
+function formRootFields(definition) {
+  return [
+    ...definition.fields,
+    ...definition.sections.flatMap((section) => section.fields),
+    ...definition.steps.flatMap((step) => [
+      ...step.fields,
+      ...step.sections.flatMap((section) => section.fields)
+    ])
+  ];
+}
+function visibleFormFields(fields, values) {
+  return fields.flatMap((field) => [
+    field,
+    ...visibleFormFields(
+      field.branches?.find((branch) => branch.value === values[field.key])?.fields ?? [],
+      values
+    )
+  ]);
+}
+function activeFormValues(definition, values) {
+  const keys = new Set(
+    visibleFormFields(formRootFields(definition), values).map(
+      (field) => field.key
+    )
+  );
+  return Object.fromEntries(
+    Object.entries(values).filter(([key]) => keys.has(key))
+  );
+}

package/index.d.ts

@@ -3,6 +3,9 @@ export { createBacanoClient } from "./client";
 export type { ContentEntryLocatorAttributes, ContentEntryLocatorSource, } from "./content-entry-locator";
 export { CONTENT_ENTRY_LOCATOR_SELECTOR, CONTENT_ENTRY_LOCATOR_VERSION, getContentEntryLocatorAttributes, } from "./content-entry-locator";
 export { AuthError, CheckoutError, GraphQLRequestError, NotInitializedError, RateLimitError, WebsiteError, } from "./errors";
+export type { FlowCaseSummary, FlowContentResource, FlowDemoSession, FlowParticipantCommand, FlowPublishedForm, FlowResponse, FlowsClient, FlowsClientConfig, ParticipantFlowStep, ParticipantJourney, } from "./flows";
+export { createFlowsClient } from "./flows";
+export { activeFormValues, formRootFields, visibleFormFields, } from "./form-conditions";
 export type { WebsiteAdvertisingConsent, WebsiteMarketingAttribution, WebsiteMarketingBrowserEvent, WebsiteMarketingBrowserEventName, WebsiteMarketingContactPlacement, WebsiteMarketingDiagnostic, WebsiteMarketingItem, WebsiteMarketingRuntime, WebsiteMarketingRuntimeOptions, WebsiteMarketingScriptLoadStrategy, WebsiteMarketingTouchpoint, } from "./marketing";
 export { captureWebsiteMarketingAttribution, createWebsiteMarketingRuntime, getAllowedMarketingParameters, getWebsiteMarketingAttribution, MARKETING_SCHEMA_VERSION, sanitizeMarketingUrl, WEBSITE_MARKETING_CONTACT_PLACEMENTS, } from "./marketing";
 export type { MediaResponsiveSource, MediaResponsiveSourceOptions, MediaTransformFormat, MediaTransformOptions, MediaUrlVariant, } from "./media";

package/index.js

@@ -53,6 +53,52 @@ var GraphQLRequestError = class extends WebsiteError {
   }
 };
 
+// libs/sdk/src/flows.ts
+function createFlowsClient(config) {
+  const base = config.apiUrl.replace(/\/+$/, "") + "/api/v1/website/flows";
+  async function request(path, body, binary = false) {
+    const token = await config.getAccessToken?.();
+    const response = await fetch(base + path, {
+      method: body === void 0 ? "GET" : "POST",
+      cache: "no-store",
+      headers: {
+        ...token ? { Authorization: `Bearer ${token}` } : {},
+        ...body !== void 0 ? { "Content-Type": "application/json" } : {},
+        ...config.websiteSlug ? { "x-bacano-website-slug": config.websiteSlug } : {}
+      },
+      ...body !== void 0 ? { body: JSON.stringify(body) } : {}
+    });
+    if (!response.ok) {
+      const result = await response.json().catch(() => ({ error: "FLOW_REQUEST_FAILED" }));
+      throw new WebsiteError(
+        result.error ?? "FLOW_REQUEST_FAILED",
+        result.error ?? "FLOW_REQUEST_FAILED"
+      );
+    }
+    return binary ? await response.blob() : await response.json();
+  }
+  const stepPath = (caseId, stepId) => `/cases/${encodeURIComponent(caseId)}/steps/${encodeURIComponent(stepId)}`;
+  return {
+    /** Only the explicitly enabled local demo gateway accepts these credentials. */
+    localDemoLogin: (email, password) => request("/local-session", { email, password }),
+    logout: () => request("/logout", {}),
+    listCases: () => request("/cases"),
+    getJourney: (caseId) => request(`/cases/${encodeURIComponent(caseId)}`),
+    getContent: (caseId, stepId) => request(stepPath(caseId, stepId) + "/content"),
+    getForm: (caseId, stepId) => request(stepPath(caseId, stepId) + "/form"),
+    getResponse: (caseId, stepId) => request(stepPath(caseId, stepId) + "/response"),
+    getFile: (caseId, stepId, fileId) => request(
+      stepPath(caseId, stepId) + `/files/${encodeURIComponent(fileId)}`,
+      void 0,
+      true
+    ),
+    act: (caseId, command) => request(
+      `/cases/${encodeURIComponent(caseId)}/actions`,
+      command
+    )
+  };
+}
+
 // libs/sdk/src/media.ts
 var DEFAULT_RESPONSIVE_WIDTHS = [240, 384, 640, 960, 1400];
 var CONTENT_HERO_WIDTHS = [640, 960, 1400, 1920, 2560];
@@ -2183,7 +2229,7 @@ var RECONCILE_PAYMENT_SESSION = (
     $orderId: uuid!
     $publicOrderToken: String!
     $paymentSessionId: uuid!
-    $gatewayTransactionId: String!
+    $gatewayTransactionId: String
   ) {
     websiteReconcilePaymentSession(
       order_id: $orderId
@@ -7007,6 +7053,7 @@ function createBacanoClient(config) {
       await initialization;
     },
     getContext,
+    flows: createFlowsClient(config),
     auth: {
       async getAccessToken() {
         return config.getAccessToken ? await config.getAccessToken() : null;
@@ -7106,6 +7153,37 @@ function getContentEntryLocatorAttributes(entry) {
     "data-bacano-entry-name": entry.name.trim() || key
   };
 }
+
+// libs/sdk/src/form-conditions.ts
+function formRootFields(definition) {
+  return [
+    ...definition.fields,
+    ...definition.sections.flatMap((section) => section.fields),
+    ...definition.steps.flatMap((step) => [
+      ...step.fields,
+      ...step.sections.flatMap((section) => section.fields)
+    ])
+  ];
+}
+function visibleFormFields(fields, values) {
+  return fields.flatMap((field) => [
+    field,
+    ...visibleFormFields(
+      field.branches?.find((branch) => branch.value === values[field.key])?.fields ?? [],
+      values
+    )
+  ]);
+}
+function activeFormValues(definition, values) {
+  const keys = new Set(
+    visibleFormFields(formRootFields(definition), values).map(
+      (field) => field.key
+    )
+  );
+  return Object.fromEntries(
+    Object.entries(values).filter(([key]) => keys.has(key))
+  );
+}
 export {
   AuthError,
   CONTENT_ENTRY_LOCATOR_SELECTOR,
@@ -7117,6 +7195,7 @@ export {
   RateLimitError,
   WEBSITE_MARKETING_CONTACT_PLACEMENTS,
   WebsiteError,
+  activeFormValues,
   buildStorageContentMediaUrls,
   buildStorageFileUrl,
   buildStorageMediaUrls,
@@ -7124,7 +7203,9 @@ export {
   buildStorageTransformedFileUrl,
   captureWebsiteMarketingAttribution,
   createBacanoClient,
+  createFlowsClient,
   createWebsiteMarketingRuntime,
+  formRootFields,
   formatMediaSrcSet,
   getAllowedMarketingParameters,
   getContentEntryLocatorAttributes,
@@ -7138,5 +7219,6 @@ export {
   getWebsiteMarketingAttribution,
   getWebsitePublicConfig,
   resolveProductPricing,
-  sanitizeMarketingUrl
+  sanitizeMarketingUrl,
+  visibleFormFields
 };

package/modules/checkout.d.ts

@@ -36,7 +36,7 @@ export interface CheckoutModule {
         orderId: string;
         publicOrderToken: string;
         paymentSessionId: string;
-        gatewayTransactionId: string;
+        gatewayTransactionId?: string;
     }): Promise<WebsitePaymentSessionResult>;
 }
 export declare function createCheckoutModule(graphqlUrl: string, getHeaders: RequestHeadersProvider, getContext: () => BacanoClientContext, cartSessionStorage: CartSessionStorage): CheckoutModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bacano/sdk",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "TypeScript SDK for building websites on the Bacano ERP",
   "main": "./index.cjs",
   "module": "./index.js",

package/react/flow-form.d.ts

@@ -0,0 +1,9 @@
+import type { FlowPublishedForm } from "../flows";
+import type { BacanoFormClassNames, BacanoFormValues } from "./forms";
+/** Reuses the Forms controls but never calls a website form-entry endpoint. */
+export declare function BacanoFlowForm({ form, onSubmit, onRefresh, classNames, }: {
+    form: FlowPublishedForm;
+    onSubmit(values: BacanoFormValues, form: FlowPublishedForm): Promise<void>;
+    onRefresh(): Promise<void>;
+    classNames?: BacanoFormClassNames;
+}): import("react").JSX.Element;

package/react/form-scale-control.d.ts

@@ -0,0 +1,9 @@
+import type { WebsiteFormField } from "../types";
+/** Discrete radios preserve keyboard support, required validation and an empty initial answer. */
+export declare function FormScaleControl({ field, id, value, onChange, className, }: {
+    field: WebsiteFormField;
+    id: string;
+    value: string | string[] | boolean;
+    onChange(value: string): void;
+    className?: string;
+}): import("react").JSX.Element | null;