@bacano/sdk 1.2.2 → 1.2.4

package/content-management-types.d.ts

@@ -2,7 +2,7 @@ import type { FormManagementClient } from "./form-management-types";
 export type ContentManagementTypeKind = "entry" | "component";
 export type ContentManagementTypeStatus = "draft" | "active" | "archived";
 export type ContentManagementTypeUsage = "website_content" | "product_additional" | "product_specification";
-export type ContentManagementScope = "content_types:manage" | "content_entries:manage" | "content_media:upload" | "content_entries:publish" | "forms:manage" | "forms:publish";
+export type ContentManagementScope = "content_types:manage" | "content_entries:manage" | "content_media:upload" | "content_entries:publish" | "forms:manage" | "forms:publish" | "product_content:manage";
 export type ContentManagementFieldType = "boolean" | "component" | "date" | "link" | "measure" | "media" | "number" | "reference" | "repeater" | "rich_text" | "rich_text_full" | "select" | "slug" | "text" | "textarea";
 export interface ContentManagementChildFieldInput {
     id?: string | null;
@@ -68,8 +68,46 @@ export interface ContentManagementContext {
     /** @deprecated Use scopes to inspect the complete grant. */
     scope: ContentManagementScope;
     scopes: ContentManagementScope[];
+    productIds: string[];
     expiresAt: string;
 }
+export interface ContentManagementProductBlock {
+    id: string;
+    productId: string;
+    contentType: {
+        id: string;
+        key: string;
+        name: string;
+    };
+    locale: string;
+    content: Record<string, unknown>;
+    sortOrder: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ContentManagementProductBlockListInput {
+    contentType?: string;
+    locale?: string;
+}
+export interface ContentManagementProductBlockCreateInput {
+    contentType: string;
+    locale?: string;
+    content: Record<string, unknown>;
+    sortOrder: number;
+}
+export interface ContentManagementProductBlockUpdateInput {
+    content: Record<string, unknown>;
+    sortOrder: number;
+    expectedUpdatedAt: string;
+}
+export interface ContentManagementProductBlockReorderInput {
+    locale: string;
+    /** Complete ordered list for this product and locale. */
+    items: Array<{
+        id: string;
+        expectedUpdatedAt: string;
+    }>;
+}
 export type ContentManagementEntryStatus = "draft" | "published" | "archived";
 export interface ContentManagementEntryInput {
     contentType: string;
@@ -262,6 +300,11 @@ export interface ContentManagementClientConfig {
 }
 export interface ContentManagementClient extends FormManagementClient {
     getContext(): Promise<ContentManagementContext>;
+    listProductBlocks(productId: string, input?: ContentManagementProductBlockListInput): Promise<ContentManagementProductBlock[]>;
+    createProductBlock(productId: string, input: ContentManagementProductBlockCreateInput): Promise<ContentManagementProductBlock>;
+    updateProductBlock(productId: string, blockId: string, input: ContentManagementProductBlockUpdateInput): Promise<ContentManagementProductBlock>;
+    reorderProductBlocks(productId: string, input: ContentManagementProductBlockReorderInput): Promise<ContentManagementProductBlock[]>;
+    retireProductBlock(productId: string, blockId: string, expectedUpdatedAt: string): Promise<ContentManagementProductBlock>;
     getReferences(): Promise<ContentManagementReferences>;
     listTypes(): Promise<ContentManagementType[]>;
     getType(identifier: string): Promise<ContentManagementType>;

package/content-management.cjs

@@ -112,6 +112,13 @@ function mediaListPath(input = {}) {
   const query = search.toString();
   return query ? `/media?${query}` : "/media";
 }
+function productBlocksPath(productId, input = {}) {
+  const path = `/products/${encodeIdentifier(productId)}/blocks`;
+  const search = new URLSearchParams();
+  if (input.contentType) search.set("contentType", input.contentType);
+  if (input.locale) search.set("locale", input.locale);
+  return search.size ? `${path}?${search}` : path;
+}
 function uploadBody(file) {
   if ("arrayBuffer" in file) return file;
   if (file instanceof ArrayBuffer) return file;
@@ -183,6 +190,25 @@ function createContentManagementClient(config) {
   return {
     ...createFormManagementMethods(request),
     getContext: () => request("/context"),
+    listProductBlocks: (productId, input) => request(
+      productBlocksPath(productId, input)
+    ),
+    createProductBlock: (productId, input) => request(productBlocksPath(productId), {
+      method: "POST",
+      body: JSON.stringify(input)
+    }),
+    updateProductBlock: (productId, blockId, input) => request(
+      `${productBlocksPath(productId)}/${encodeIdentifier(blockId)}`,
+      { method: "PUT", body: JSON.stringify(input) }
+    ),
+    reorderProductBlocks: (productId, input) => request(
+      `${productBlocksPath(productId)}/order`,
+      { method: "PUT", body: JSON.stringify(input) }
+    ),
+    retireProductBlock: (productId, blockId, expectedUpdatedAt) => request(
+      `${productBlocksPath(productId)}/${encodeIdentifier(blockId)}`,
+      { method: "DELETE", body: JSON.stringify({ expectedUpdatedAt }) }
+    ),
     getReferences: () => request("/references"),
     listTypes: () => request("/types"),
     getType: (identifier) => request(`/types/${encodeIdentifier(identifier)}`),

package/content-management.js

@@ -85,6 +85,13 @@ function mediaListPath(input = {}) {
   const query = search.toString();
   return query ? `/media?${query}` : "/media";
 }
+function productBlocksPath(productId, input = {}) {
+  const path = `/products/${encodeIdentifier(productId)}/blocks`;
+  const search = new URLSearchParams();
+  if (input.contentType) search.set("contentType", input.contentType);
+  if (input.locale) search.set("locale", input.locale);
+  return search.size ? `${path}?${search}` : path;
+}
 function uploadBody(file) {
   if ("arrayBuffer" in file) return file;
   if (file instanceof ArrayBuffer) return file;
@@ -156,6 +163,25 @@ function createContentManagementClient(config) {
   return {
     ...createFormManagementMethods(request),
     getContext: () => request("/context"),
+    listProductBlocks: (productId, input) => request(
+      productBlocksPath(productId, input)
+    ),
+    createProductBlock: (productId, input) => request(productBlocksPath(productId), {
+      method: "POST",
+      body: JSON.stringify(input)
+    }),
+    updateProductBlock: (productId, blockId, input) => request(
+      `${productBlocksPath(productId)}/${encodeIdentifier(blockId)}`,
+      { method: "PUT", body: JSON.stringify(input) }
+    ),
+    reorderProductBlocks: (productId, input) => request(
+      `${productBlocksPath(productId)}/order`,
+      { method: "PUT", body: JSON.stringify(input) }
+    ),
+    retireProductBlock: (productId, blockId, expectedUpdatedAt) => request(
+      `${productBlocksPath(productId)}/${encodeIdentifier(blockId)}`,
+      { method: "DELETE", body: JSON.stringify({ expectedUpdatedAt }) }
+    ),
     getReferences: () => request("/references"),
     listTypes: () => request("/types"),
     getType: (identifier) => request(`/types/${encodeIdentifier(identifier)}`),

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];
@@ -1364,6 +1414,35 @@ var WEBSITE_GET_PRODUCT_CONTENT = (
   }
 `
 );
+var WEBSITE_GET_PRODUCT_CONTENT_BATCH = (
+  /* GraphQL */
+  `
+  mutation WebsiteGetProductContentBatch(
+    $websiteId: uuid!
+    $productIds: [uuid!]!
+    $locale: String
+  ) {
+    result: websiteGetProductContentBatch(
+      website_id: $websiteId
+      product_ids: $productIds
+      locale: $locale
+    ) {
+      success
+      errors
+      blocks {
+        id
+        product_id
+        locale
+        content_json
+        resolved_fields
+        sort_order
+        updated_at
+        content_type { id key name kind }
+      }
+    }
+  }
+`
+);
 var CHECK_AVAILABILITY = (
   /* GraphQL */
   `
@@ -2240,7 +2319,7 @@ var RECONCILE_PAYMENT_SESSION = (
     $orderId: uuid!
     $publicOrderToken: String!
     $paymentSessionId: uuid!
-    $gatewayTransactionId: String!
+    $gatewayTransactionId: String
   ) {
     websiteReconcilePaymentSession(
       order_id: $orderId
@@ -5732,6 +5811,33 @@ function createContentModule(graphqlUrl, getHeaders, getContext, storageUrl) {
       return (data.result.blocks ?? []).map(
         (block) => mapProductContentBlock(block, storageUrl)
       );
+    },
+    async getForProducts(productIds, opts) {
+      const uniqueIds = [...new Set(productIds.map((id) => id.toLowerCase()))];
+      const blocksByProduct = Object.fromEntries(uniqueIds.map((id) => [id, []]));
+      if (uniqueIds.length === 0) return blocksByProduct;
+      const ctx = getContext();
+      for (let start = 0; start < uniqueIds.length; start += 50) {
+        const batch = uniqueIds.slice(start, start + 50);
+        const data = await executeGraphQL(
+          graphqlUrl,
+          WEBSITE_GET_PRODUCT_CONTENT_BATCH,
+          {
+            websiteId: ctx.websiteId,
+            productIds: batch,
+            locale: opts?.locale ?? DEFAULT_LOCALE
+          },
+          getHeaders
+        );
+        if (!data.result?.success) continue;
+        for (const block of data.result.blocks ?? []) {
+          const id = block.product_id.toLowerCase();
+          if (Object.prototype.hasOwnProperty.call(blocksByProduct, id)) {
+            blocksByProduct[id].push(mapProductContentBlock(block, storageUrl));
+          }
+        }
+      }
+      return blocksByProduct;
     }
   };
 }
@@ -7064,6 +7170,7 @@ function createBacanoClient(config) {
       await initialization;
     },
     getContext,
+    flows: createFlowsClient(config),
     auth: {
       async getAccessToken() {
         return config.getAccessToken ? await config.getAccessToken() : null;
@@ -7096,7 +7203,8 @@ function createBacanoClient(config) {
       getByKey: contentModule.getByKey.bind(contentModule),
       getByCategory: contentModule.getByCategory.bind(contentModule),
       getByTag: contentModule.getByTag.bind(contentModule),
-      getForProduct: contentModule.getForProduct.bind(contentModule)
+      getForProduct: contentModule.getForProduct.bind(contentModule),
+      getForProducts: contentModule.getForProducts.bind(contentModule)
     },
     forms: {
       getDefinition: formsModule.getDefinition.bind(formsModule),
@@ -7163,3 +7271,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";