@bacano/sdk 1.2.6 → 1.2.8

package/catalog-draft-types.d.ts

@@ -0,0 +1,145 @@
+export interface CatalogDraftReference {
+    id: string | null;
+    source_label: string;
+}
+export interface CatalogDraftAttribute {
+    attribute: CatalogDraftReference;
+    values: CatalogDraftReference[];
+    text_value?: string | null;
+}
+export interface CatalogDraftSource {
+    namespace: string;
+    key: string;
+    kind: "excel" | "wordpress" | "shopify" | "other";
+    url?: string;
+    row_numbers?: number[];
+}
+export interface CatalogDraftContent {
+    name: string;
+    description: string | null;
+    long_description: unknown;
+    seo_title: string | null;
+    seo_description: string | null;
+}
+export interface CatalogDraftImage {
+    source_key: string;
+    source_url?: string;
+    storage_file_id: string | null;
+    file_name: string;
+    alt_text: string;
+    position: number;
+    variant_source_keys: string[];
+}
+export interface CatalogCreateProposal {
+    contract_version: 1;
+    operation: "create";
+    source: CatalogDraftSource;
+    product: CatalogDraftContent & {
+        structure_type: "SIMPLE" | "VARIABLE";
+        category_code: string | null;
+        category_source_label: string;
+        subcategory: CatalogDraftReference;
+        measurement_unit: string | null;
+        sales_tax_profile_code: string | null;
+        price_tax_basis: "included" | "excluded" | null;
+        currency: string | null;
+        attributes: CatalogDraftAttribute[];
+        variant_attributes: CatalogDraftReference[];
+    };
+    destinations: Array<{
+        chain_id: string;
+        initial_status: "draft" | "active";
+    }>;
+    websites: Array<{
+        website_id: string;
+        show: boolean;
+    }>;
+    variants: Array<{
+        source_key: string;
+        excluded: boolean;
+        sku: string | null;
+        barcode: string | null;
+        attributes: CatalogDraftAttribute[];
+        prices: Array<{
+            chain_id: string;
+            price_type: "CLIENT" | "WHOLESALE" | "WHOLESALE_2" | "SALE";
+            amount: number | null;
+        }>;
+        initial_inventory: Array<{
+            chain_id: string;
+            warehouse_id: string | null;
+            source_label: string;
+            quantity: number | null;
+        }>;
+    }>;
+    images: CatalogDraftImage[];
+}
+export interface CatalogContentProposal {
+    contract_version: 1;
+    operation: "edit_content";
+    source: CatalogDraftSource;
+    product_id: string;
+    base_updated_at: string;
+    base_content: CatalogDraftContent;
+    changes: Partial<CatalogDraftContent>;
+}
+export type CatalogDraftProposal = CatalogCreateProposal | CatalogContentProposal;
+export interface CatalogDraftWrite {
+    expected_revision: number;
+    request_id: string;
+    proposal: CatalogDraftProposal;
+}
+export interface CatalogDraftRecord {
+    item_id: string;
+    batch_id: string;
+    revision: number;
+    request_id: string;
+    draft: CatalogDraftProposal;
+    human_changes: Record<string, unknown>;
+    conflicts: unknown[];
+    closed: boolean;
+}
+export interface CatalogDraftIssue {
+    path: string;
+    code: string;
+}
+export interface CatalogDraftResult {
+    item: CatalogDraftRecord;
+    issues: CatalogDraftIssue[];
+}
+export interface CatalogDraftWriteResult extends CatalogDraftResult {
+    current_revision: number;
+    replayed: boolean;
+}
+export interface CatalogDraftBatch {
+    id: string;
+    name: string;
+    status: string;
+}
+export interface CatalogDraftBatchPage {
+    batch: CatalogDraftBatch;
+    items: CatalogDraftResult[];
+    next_cursor: string | null;
+}
+export interface CatalogDraftChunkResult {
+    results: Array<{
+        request_id: string;
+        success: true;
+        data: CatalogDraftWriteResult;
+    } | {
+        request_id: string;
+        success: false;
+        error: {
+            code: string;
+            message: string;
+            details?: unknown;
+        };
+    }>;
+}
+export interface CatalogDraftImageResult extends CatalogDraftWriteResult {
+    image: {
+        source_key: string;
+        storage_file_id: string;
+        reused: boolean;
+    };
+}

package/catalog-management-types.d.ts

@@ -0,0 +1,143 @@
+export interface CatalogCapabilities {
+    references: true;
+    drafts: boolean;
+    images: boolean;
+    content: boolean;
+}
+export interface CatalogManagementContext {
+    companyId: string;
+    grantId: string;
+    capabilities: CatalogCapabilities;
+    allProducts: boolean;
+    productIds: string[];
+    branchIds: string[];
+    expiresAt: string;
+    /** Only draft writes; never confirmation or direct product edits. */
+    writesAvailable: boolean;
+}
+export interface CatalogReferences {
+    contractVersion: 1;
+    company: {
+        id: string;
+        name: string;
+        country_code: string;
+        is_vat_responsible: boolean;
+        sales_prices_include_tax_default: boolean;
+    };
+    priceTypes: Array<{
+        price_type: string;
+        is_enabled: boolean;
+        is_enabled_for_sales: boolean;
+        sort_order: number;
+    }>;
+    taxProfiles: Array<{
+        code: string;
+        name: string;
+        category: string;
+        rate: number;
+    }>;
+    branches: Array<{
+        id: string;
+        name: string;
+        chains_warehouses: Array<{
+            warehouse: {
+                id: string;
+                name: string;
+            };
+        }>;
+    }>;
+    websites: Array<{
+        id: string;
+        name: string;
+        chain_id: string | null;
+        is_active: boolean;
+    }>;
+    categories: Array<{
+        name: string;
+        product_subcategories: Array<{
+            id: string;
+            name: string;
+        }>;
+    }>;
+    measurementUnits: Array<{
+        name: string;
+    }>;
+    rules: {
+        saleMustBeLowerThanClient: true;
+        existingProductsContentOnly: true;
+        humanConfirmationRequired: true;
+        inventoryRequiresExistingWarehouse: true;
+        taxonomyEndpoint: string;
+    };
+}
+export interface CatalogAttributeRule {
+    attribute_id: string;
+    sort_order: number;
+    usage_scope: string;
+    is_required: boolean;
+    is_filterable: boolean;
+}
+export interface CatalogTaxonomy {
+    attribute_categories: Array<CatalogAttributeRule & {
+        category: string;
+    }>;
+    attribute_subcategories: Array<CatalogAttributeRule & {
+        subcategory_id: string;
+    }>;
+    attribute_subcategory_exclusions: Array<{
+        subcategory_id: string;
+        attribute_id: string;
+        reason: string | null;
+    }>;
+    attributes: Array<{
+        id: string;
+        name: string;
+        is_multiple: boolean;
+        tooltip: string | null;
+        values: unknown;
+        attribute_values: Array<{
+            id: string;
+            code: string;
+            sort_order: number;
+            metadata: unknown;
+        }>;
+        attribute_value_sets: Array<{
+            id: string;
+            code: string;
+            category: string;
+            attribute_id: string;
+            product_subcategory_attribute_value_sets: Array<{
+                subcategory_id: string;
+                position: number;
+            }>;
+            attribute_value_set_values: Array<{
+                position: number;
+                attribute_value: {
+                    id: string;
+                    code: string;
+                    metadata: unknown;
+                };
+            }>;
+        }>;
+    }>;
+}
+export interface CatalogProductContent {
+    id: string;
+    name: string;
+    sku: string | null;
+    description: string | null;
+    long_description: unknown;
+    seo_title: string | null;
+    seo_description: string | null;
+    updated_at: string | null;
+}
+export interface CatalogProductPage {
+    items: CatalogProductContent[];
+    hasMore: boolean;
+    nextOffset: number | null;
+}
+export interface CatalogManagementConfig {
+    apiUrl: string;
+    accessToken: string | (() => string | Promise<string>);
+    fetch?: typeof fetch;
+}

package/catalog-management.cjs

@@ -0,0 +1,125 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// libs/sdk/src/catalog-management.ts
+var catalog_management_exports = {};
+__export(catalog_management_exports, {
+  CatalogManagementError: () => CatalogManagementError,
+  createCatalogManagementClient: () => createCatalogManagementClient
+});
+module.exports = __toCommonJS(catalog_management_exports);
+var CatalogManagementError = class extends Error {
+  constructor(code, status, message, details) {
+    super(message);
+    this.code = code;
+    this.status = status;
+    this.details = details;
+    this.name = "CatalogManagementError";
+  }
+  code;
+  status;
+  details;
+};
+function createCatalogManagementClient(config) {
+  const base = config.apiUrl.trim().replace(/\/+$/, "");
+  const url = new URL(base);
+  if (url.username || url.password || url.search || url.hash || !(url.protocol === "https:" || url.protocol === "http:" && ["localhost", "127.0.0.1", "[::1]"].includes(url.hostname))) {
+    throw new CatalogManagementError(
+      "CATALOG_CONFIG_INVALID",
+      0,
+      "Usa HTTPS o localhost para el acceso temporal."
+    );
+  }
+  const fetcher = config.fetch ?? globalThis.fetch;
+  async function request(path, input) {
+    const token = typeof config.accessToken === "function" ? await config.accessToken() : config.accessToken;
+    if (!token.trim())
+      throw new CatalogManagementError(
+        "CATALOG_ACCESS_INVALID",
+        401,
+        "Falta el acceso temporal."
+      );
+    const response = await fetcher(`${base}/api/v1/catalog-management${path}`, {
+      method: input ? "POST" : "GET",
+      headers: {
+        Authorization: `Bearer ${token.trim()}`,
+        Accept: "application/json",
+        ...input ? {
+          "Content-Type": input.bytes ? "application/octet-stream" : "application/json"
+        } : {}
+      },
+      ...input ? { body: input.bytes ?? JSON.stringify(input.json) } : {},
+      cache: "no-store",
+      redirect: "error",
+      credentials: "omit"
+    });
+    const payload = await response.json().catch(() => ({}));
+    if (!response.ok || payload.success !== true || payload.data === void 0) {
+      throw new CatalogManagementError(
+        payload.error?.code ?? "CATALOG_REQUEST_FAILED",
+        response.status,
+        payload.error?.message ?? payload.message ?? "No fue posible consultar el cat\xE1logo.",
+        payload.error?.details
+      );
+    }
+    return payload.data;
+  }
+  return {
+    createBatch: (input) => request("/batches", { json: input }),
+    getBatch: (batchId, input = {}) => {
+      const query = new URLSearchParams();
+      if (input.limit !== void 0) query.set("limit", String(input.limit));
+      if (input.after !== void 0) query.set("after", input.after);
+      return request(
+        `/batches/${encodeURIComponent(batchId)}${query.size ? `?${query}` : ""}`
+      );
+    },
+    getDraft: (batchId, itemId) => request(
+      `/batches/${encodeURIComponent(batchId)}/items/${encodeURIComponent(itemId)}`
+    ),
+    sendProposals: (batchId, items) => request(
+      `/batches/${encodeURIComponent(batchId)}/items`,
+      { json: { items } }
+    ),
+    uploadImage: (input) => {
+      const query = new URLSearchParams({
+        source_key: input.source_key,
+        expected_revision: String(input.expected_revision),
+        request_id: input.request_id
+      });
+      return request(
+        `/batches/${encodeURIComponent(input.batchId)}/items/${encodeURIComponent(input.itemId)}/images?${query}`,
+        { bytes: input.bytes }
+      );
+    },
+    getContext: () => request("/context"),
+    getReferences: () => request("/references"),
+    getTaxonomy: (category) => request(
+      `/references/taxonomy?category=${encodeURIComponent(category)}`
+    ),
+    listProducts: (input = {}) => {
+      const query = new URLSearchParams();
+      if (input.limit !== void 0) query.set("limit", String(input.limit));
+      if (input.offset !== void 0) query.set("offset", String(input.offset));
+      return request(
+        `/products${query.size ? `?${query}` : ""}`
+      );
+    }
+  };
+}

package/catalog-management.d.ts

@@ -0,0 +1,37 @@
+import type { CatalogManagementConfig, CatalogManagementContext, CatalogProductPage, CatalogReferences, CatalogTaxonomy } from "./catalog-management-types";
+export * from "./catalog-draft-types";
+export * from "./catalog-management-types";
+import type { CatalogDraftBatch, CatalogDraftBatchPage, CatalogDraftChunkResult, CatalogDraftImageResult, CatalogDraftResult, CatalogDraftWrite } from "./catalog-draft-types";
+export declare class CatalogManagementError extends Error {
+    readonly code: string;
+    readonly status: number;
+    readonly details?: unknown | undefined;
+    constructor(code: string, status: number, message: string, details?: unknown | undefined);
+}
+export declare function createCatalogManagementClient(config: CatalogManagementConfig): {
+    createBatch: (input: {
+        request_id: string;
+        name: string;
+    }) => Promise<CatalogDraftBatch>;
+    getBatch: (batchId: string, input?: {
+        limit?: number;
+        after?: string;
+    }) => Promise<CatalogDraftBatchPage>;
+    getDraft: (batchId: string, itemId: string) => Promise<CatalogDraftResult>;
+    sendProposals: (batchId: string, items: CatalogDraftWrite[]) => Promise<CatalogDraftChunkResult>;
+    uploadImage: (input: {
+        batchId: string;
+        itemId: string;
+        source_key: string;
+        expected_revision: number;
+        request_id: string;
+        bytes: Blob;
+    }) => Promise<CatalogDraftImageResult>;
+    getContext: () => Promise<CatalogManagementContext>;
+    getReferences: () => Promise<CatalogReferences>;
+    getTaxonomy: (category: string) => Promise<CatalogTaxonomy>;
+    listProducts: (input?: {
+        limit?: number;
+        offset?: number;
+    }) => Promise<CatalogProductPage>;
+};

package/catalog-management.js

@@ -0,0 +1,104 @@
+// libs/sdk/src/catalog-management.ts
+var CatalogManagementError = class extends Error {
+  constructor(code, status, message, details) {
+    super(message);
+    this.code = code;
+    this.status = status;
+    this.details = details;
+    this.name = "CatalogManagementError";
+  }
+  code;
+  status;
+  details;
+};
+function createCatalogManagementClient(config) {
+  const base = config.apiUrl.trim().replace(/\/+$/, "");
+  const url = new URL(base);
+  if (url.username || url.password || url.search || url.hash || !(url.protocol === "https:" || url.protocol === "http:" && ["localhost", "127.0.0.1", "[::1]"].includes(url.hostname))) {
+    throw new CatalogManagementError(
+      "CATALOG_CONFIG_INVALID",
+      0,
+      "Usa HTTPS o localhost para el acceso temporal."
+    );
+  }
+  const fetcher = config.fetch ?? globalThis.fetch;
+  async function request(path, input) {
+    const token = typeof config.accessToken === "function" ? await config.accessToken() : config.accessToken;
+    if (!token.trim())
+      throw new CatalogManagementError(
+        "CATALOG_ACCESS_INVALID",
+        401,
+        "Falta el acceso temporal."
+      );
+    const response = await fetcher(`${base}/api/v1/catalog-management${path}`, {
+      method: input ? "POST" : "GET",
+      headers: {
+        Authorization: `Bearer ${token.trim()}`,
+        Accept: "application/json",
+        ...input ? {
+          "Content-Type": input.bytes ? "application/octet-stream" : "application/json"
+        } : {}
+      },
+      ...input ? { body: input.bytes ?? JSON.stringify(input.json) } : {},
+      cache: "no-store",
+      redirect: "error",
+      credentials: "omit"
+    });
+    const payload = await response.json().catch(() => ({}));
+    if (!response.ok || payload.success !== true || payload.data === void 0) {
+      throw new CatalogManagementError(
+        payload.error?.code ?? "CATALOG_REQUEST_FAILED",
+        response.status,
+        payload.error?.message ?? payload.message ?? "No fue posible consultar el cat\xE1logo.",
+        payload.error?.details
+      );
+    }
+    return payload.data;
+  }
+  return {
+    createBatch: (input) => request("/batches", { json: input }),
+    getBatch: (batchId, input = {}) => {
+      const query = new URLSearchParams();
+      if (input.limit !== void 0) query.set("limit", String(input.limit));
+      if (input.after !== void 0) query.set("after", input.after);
+      return request(
+        `/batches/${encodeURIComponent(batchId)}${query.size ? `?${query}` : ""}`
+      );
+    },
+    getDraft: (batchId, itemId) => request(
+      `/batches/${encodeURIComponent(batchId)}/items/${encodeURIComponent(itemId)}`
+    ),
+    sendProposals: (batchId, items) => request(
+      `/batches/${encodeURIComponent(batchId)}/items`,
+      { json: { items } }
+    ),
+    uploadImage: (input) => {
+      const query = new URLSearchParams({
+        source_key: input.source_key,
+        expected_revision: String(input.expected_revision),
+        request_id: input.request_id
+      });
+      return request(
+        `/batches/${encodeURIComponent(input.batchId)}/items/${encodeURIComponent(input.itemId)}/images?${query}`,
+        { bytes: input.bytes }
+      );
+    },
+    getContext: () => request("/context"),
+    getReferences: () => request("/references"),
+    getTaxonomy: (category) => request(
+      `/references/taxonomy?category=${encodeURIComponent(category)}`
+    ),
+    listProducts: (input = {}) => {
+      const query = new URLSearchParams();
+      if (input.limit !== void 0) query.set("limit", String(input.limit));
+      if (input.offset !== void 0) query.set("offset", String(input.offset));
+      return request(
+        `/products${query.size ? `?${query}` : ""}`
+      );
+    }
+  };
+}
+export {
+  CatalogManagementError,
+  createCatalogManagementClient
+};

package/content-management-types.d.ts

@@ -3,7 +3,7 @@ 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" | "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 type ContentManagementFieldType = "icon" | "boolean" | "component" | "date" | "link" | "measure" | "media" | "number" | "reference" | "repeater" | "rich_text" | "rich_text_full" | "select" | "slug" | "text" | "textarea";
 export interface ContentManagementChildFieldInput {
     id?: string | null;
     key: string;
@@ -182,6 +182,14 @@ export interface ContentManagementImageUploadResult extends ContentManagementMed
     reused: boolean;
 }
 export interface ContentManagementReferences {
+    icons: Array<{
+        id: string;
+        concept: string;
+        label: string;
+        category: string;
+        keywords: string[];
+        provenance: "original-bacano" | "official-brand";
+    }>;
     categories: Array<{
         code: string;
         name: string;