doboxa-js 1.0.3 → 1.1.0

package/README.md

@@ -28,7 +28,7 @@ import Doboxa from "doboxa-js";
 
 // Initialize the client
 const doboxa = new Doboxa({
-  baseURL: "https://pl.doboxa.biz", // Optional: defaults to DOBOXA_API_URL env var or http://localhost
+  baseURL: "https://pl.doboxa.biz", // Optional: defaults to DOBOXA_API_URL env var or https://pl.doboxa.biz
 });
 ```
 
@@ -269,6 +269,54 @@ const me = await doboxa.users.me();
 console.log("Current user:", me.username);
 ```
 
+### Product catalog (BaseLinker connector)
+
+The product catalog is not part of API v2 - it is served by Doboxa's BaseLinker
+connector (shop integration file) on its own URL. The merchant finds both
+credentials in the Doboxa client panel: **Integracje → Edycja** on the BaseLinker
+integration. The modal shows the connector URL and the **Hasło** (password)
+field.
+
+```typescript
+const doboxa = new Doboxa({
+  baseURL: "https://pl.doboxa.biz",
+  catalog: {
+    url: "https://pl.doboxa.biz/api/base-linker/{clientToken}/{language}",
+    password: "YOUR_BL_PASS",
+  },
+});
+const catalog = doboxa.catalog!; // defined because `catalog` config was passed
+
+// Connector capabilities
+console.log(await catalog.fileVersion());
+console.log(await catalog.supportedMethods());
+
+// Categories: { "<id>": "Category / Path" }
+const categories = await catalog.categories();
+
+// One page of designs (100 per page)
+const { pages, items } = await catalog.list({ page: 1 });
+console.log(pages, items[0].id, items[0].name, items[0].price);
+
+// Full data (images, variants) for selected designs
+const data = await catalog.data({
+  products_id: [items[0].id],
+});
+```
+
+Notes:
+
+- The catalog uses only the connector password, so no `apiKey` is needed - the
+  client works with the catalog, with the API and with both.
+- `list()` returns one entry per design (the first variant); `data()` returns
+  the design with all of its variants.
+- Prices are strings in PLN (up to 3 decimals) and are most likely **net**
+  prices - the markup is set by the merchant in the panel ("Zarządzanie cenami").
+- The connector has no order methods, so orders are still created through
+  API v2 (`doboxa.orders`).
+- Connector errors are returned with HTTP 200 and are thrown as
+  `DoboxaConnectorError` (with `errorCode` and `errorText`).
+
 ## Environment Variables
 
 You can set the API base URL using an environment variable:
@@ -369,6 +417,13 @@ import type {
 - **Users**: `doboxa.users`
   - `me()` - Get current user
 
+- **Catalog**: `doboxa.catalog` (only when the `catalog` config is provided)
+  - `fileVersion()` - Get the connector platform and version
+  - `supportedMethods()` - Get the list of supported actions
+  - `categories()` - Get all product categories
+  - `list(params?)` - List one page of products (designs)
+  - `data(params)` - Get full product data (images, variants) for design ids
+
 ## License
 
 ISC

package/dist/{chunk-CGJD4ZO5.mjs → chunk-7RN7PBJH.mjs}

@@ -75,6 +75,15 @@ var DoboxaAuthenticationError = class _DoboxaAuthenticationError extends DoboxaE
     Object.setPrototypeOf(this, _DoboxaAuthenticationError.prototype);
   }
 };
+var DoboxaConnectorError = class _DoboxaConnectorError extends DoboxaError {
+  constructor(errorCode, errorText, message) {
+    super(message || errorText || `BaseLinker connector error: ${errorCode}`);
+    this.name = "DoboxaConnectorError";
+    this.errorCode = errorCode;
+    this.errorText = errorText;
+    Object.setPrototypeOf(this, _DoboxaConnectorError.prototype);
+  }
+};
 var DoboxaValidationError = class _DoboxaValidationError extends DoboxaAPIError {
   constructor(statusCode, message, body) {
     super(statusCode, message, body);
@@ -101,7 +110,8 @@ export {
   DoboxaError,
   DoboxaAPIError,
   DoboxaAuthenticationError,
+  DoboxaConnectorError,
   DoboxaValidationError,
   parseErrorResponse
 };
-//# sourceMappingURL=chunk-CGJD4ZO5.mjs.map
+//# sourceMappingURL=chunk-7RN7PBJH.mjs.map

package/dist/chunk-7RN7PBJH.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts"],"sourcesContent":["import type { InvalidRequestDataResponse, ServerErrorResponse } from './types/generated/src/models';\n\n/**\n * Base error class for all Doboxa errors\n */\nexport class DoboxaError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'DoboxaError';\n    Object.setPrototypeOf(this, DoboxaError.prototype);\n  }\n}\n\n/**\n * Error thrown when API returns an error response\n */\nexport class DoboxaAPIError extends DoboxaError {\n  public readonly statusCode: number;\n  public readonly code?: number;\n  public readonly errorMessage?: string;\n  public readonly invalidParameters?: Array<{ parameter: string; error_cause: string }>;\n\n  constructor(\n    statusCode: number,\n    message: string,\n    body?: InvalidRequestDataResponse | ServerErrorResponse\n  ) {\n    super(message);\n    this.name = 'DoboxaAPIError';\n    this.statusCode = statusCode;\n\n    if (body) {\n      if ('result_code' in body) {\n        this.code = body.result_code;\n      }\n      if ('error_message' in body) {\n        this.errorMessage = body.error_message || undefined;\n      }\n      if ('invalid_parameters' in body && body.invalid_parameters) {\n        this.invalidParameters = body.invalid_parameters.map((param) => ({\n          parameter: param.parameter,\n          error_cause: param.error_cause,\n        }));\n      }\n    }\n\n    Object.setPrototypeOf(this, DoboxaAPIError.prototype);\n  }\n}\n\n/**\n * Error thrown when authentication fails\n */\nexport class DoboxaAuthenticationError extends DoboxaError {\n  constructor(message: string = 'Authentication failed') {\n    super(message);\n    this.name = 'DoboxaAuthenticationError';\n    Object.setPrototypeOf(this, DoboxaAuthenticationError.prototype);\n  }\n}\n\n/**\n * Error thrown when the BaseLinker connector returns an error.\n * The connector always answers with HTTP 200, so the error is carried in the body.\n */\nexport class DoboxaConnectorError extends DoboxaError {\n  /**\n   * Machine readable error code, e.g. \"bad_password\", \"no_password\", \"unsupported_method\"\n   */\n  public readonly errorCode: string;\n  /**\n   * Human readable error text returned by the connector\n   */\n  public readonly errorText: string;\n\n  constructor(errorCode: string, errorText: string, message?: string) {\n    super(message || errorText || `BaseLinker connector error: ${errorCode}`);\n    this.name = 'DoboxaConnectorError';\n    this.errorCode = errorCode;\n    this.errorText = errorText;\n    Object.setPrototypeOf(this, DoboxaConnectorError.prototype);\n  }\n}\n\n/**\n * Error thrown when request validation fails\n */\nexport class DoboxaValidationError extends DoboxaAPIError {\n  constructor(statusCode: number, message: string, body?: InvalidRequestDataResponse) {\n    super(statusCode, message, body);\n    this.name = 'DoboxaValidationError';\n    Object.setPrototypeOf(this, DoboxaValidationError.prototype);\n  }\n}\n\n/**\n * Parse error response from API\n */\nexport function parseErrorResponse(\n  statusCode: number,\n  body: unknown\n): InvalidRequestDataResponse | ServerErrorResponse | undefined {\n  if (typeof body === 'object' && body !== null) {\n    if ('invalid_parameters' in body || 'error_message' in body) {\n      return body as InvalidRequestDataResponse;\n    }\n    if ('error_message' in body && 'result_code' in body) {\n      return body as ServerErrorResponse;\n    }\n  }\n  return undefined;\n}\n\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKO,IAAM,cAAN,MAAM,qBAAoB,MAAM;AAAA,EACrC,YAAY,SAAiB;AAC3B,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,WAAO,eAAe,MAAM,aAAY,SAAS;AAAA,EACnD;AACF;AAKO,IAAM,iBAAN,MAAM,wBAAuB,YAAY;AAAA,EAM9C,YACE,YACA,SACA,MACA;AACA,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,aAAa;AAElB,QAAI,MAAM;AACR,UAAI,iBAAiB,MAAM;AACzB,aAAK,OAAO,KAAK;AAAA,MACnB;AACA,UAAI,mBAAmB,MAAM;AAC3B,aAAK,eAAe,KAAK,iBAAiB;AAAA,MAC5C;AACA,UAAI,wBAAwB,QAAQ,KAAK,oBAAoB;AAC3D,aAAK,oBAAoB,KAAK,mBAAmB,IAAI,CAAC,WAAW;AAAA,UAC/D,WAAW,MAAM;AAAA,UACjB,aAAa,MAAM;AAAA,QACrB,EAAE;AAAA,MACJ;AAAA,IACF;AAEA,WAAO,eAAe,MAAM,gBAAe,SAAS;AAAA,EACtD;AACF;AAKO,IAAM,4BAAN,MAAM,mCAAkC,YAAY;AAAA,EACzD,YAAY,UAAkB,yBAAyB;AACrD,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,WAAO,eAAe,MAAM,2BAA0B,SAAS;AAAA,EACjE;AACF;AAMO,IAAM,uBAAN,MAAM,8BAA6B,YAAY;AAAA,EAUpD,YAAY,WAAmB,WAAmB,SAAkB;AAClE,UAAM,WAAW,aAAa,+BAA+B,SAAS,EAAE;AACxE,SAAK,OAAO;AACZ,SAAK,YAAY;AACjB,SAAK,YAAY;AACjB,WAAO,eAAe,MAAM,sBAAqB,SAAS;AAAA,EAC5D;AACF;AAKO,IAAM,wBAAN,MAAM,+BAA8B,eAAe;AAAA,EACxD,YAAY,YAAoB,SAAiB,MAAmC;AAClF,UAAM,YAAY,SAAS,IAAI;AAC/B,SAAK,OAAO;AACZ,WAAO,eAAe,MAAM,uBAAsB,SAAS;AAAA,EAC7D;AACF;AAKO,SAAS,mBACd,YACA,MAC8D;AAC9D,MAAI,OAAO,SAAS,YAAY,SAAS,MAAM;AAC7C,QAAI,wBAAwB,QAAQ,mBAAmB,MAAM;AAC3D,aAAO;AAAA,IACT;AACA,QAAI,mBAAmB,QAAQ,iBAAiB,MAAM;AACpD,aAAO;AAAA,IACT;AAAA,EACF;AACA,SAAO;AACT;","names":[]}

package/dist/{chunk-WGEOQ35B.mjs → chunk-RTI5YLAB.mjs}

@@ -1,11 +1,12 @@
 import {
   DoboxaAPIError,
   DoboxaAuthenticationError,
+  DoboxaConnectorError,
   __async,
   __spreadProps,
   __spreadValues,
   parseErrorResponse
-} from "./chunk-CGJD4ZO5.mjs";
+} from "./chunk-7RN7PBJH.mjs";
 
 // src/types/generated/src/runtime.ts
 var BASE_PATH = "http://localhost".replace(/\/+$/, "");
@@ -477,20 +478,6 @@ var AuthenticationResource = class {
   }
 };
 
-// src/types/generated/src/models/Bool.ts
-function BoolFromJSON(json) {
-  return json;
-}
-function BoolFromJSONTyped(json, ignoreDiscriminator) {
-  return json;
-}
-function BoolToJSON(value) {
-  return value;
-}
-function BoolToJSONTyped(value, ignoreDiscriminator = false) {
-  return value;
-}
-
 // src/types/generated/src/models/Attachment.ts
 function instanceOfAttachment(value) {
   if (!("type" in value) || value["type"] === void 0) return false;
@@ -1361,7 +1348,7 @@ function OrderCancellationResponseFromJSONTyped(json, ignoreDiscriminator) {
     return json;
   }
   return {
-    "cancelled": json["cancelled"] == null ? void 0 : BoolFromJSON(json["cancelled"]),
+    "cancelled": json["cancelled"] == null ? void 0 : json["cancelled"],
     "details": json["details"] == null ? void 0 : json["details"]
   };
 }
@@ -1373,7 +1360,7 @@ function OrderCancellationResponseToJSONTyped(value, ignoreDiscriminator = false
     return value;
   }
   return {
-    "cancelled": BoolToJSON(value["cancelled"]),
+    "cancelled": value["cancelled"],
     "details": value["details"]
   };
 }
@@ -2810,6 +2797,118 @@ var UsersResource = class {
   }
 };
 
+// src/resources/catalog.ts
+var CatalogResource = class {
+  constructor(config) {
+    this.config = config;
+  }
+  /**
+   * Call a connector action.
+   *
+   * @param action - Connector action, e.g. "ProductsList"
+   * @param params - Additional action parameters
+   * @throws DoboxaConnectorError on HTTP or connector errors
+   */
+  call(_0) {
+    return __async(this, arguments, function* (action, params = {}) {
+      const response = yield fetch(this.config.url, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded"
+        },
+        body: new URLSearchParams(__spreadValues({
+          bl_pass: this.config.password,
+          action
+        }, params))
+      });
+      if (!response.ok) {
+        throw new DoboxaConnectorError(
+          `http_${response.status}`,
+          response.statusText || "Unexpected HTTP status",
+          `BaseLinker connector request failed with HTTP ${response.status}`
+        );
+      }
+      let payload;
+      try {
+        payload = yield response.json();
+      } catch (e) {
+        throw new DoboxaConnectorError(
+          "invalid_response",
+          "Connector response is not valid JSON",
+          "BaseLinker connector returned a non-JSON response"
+        );
+      }
+      if (payload !== null && typeof payload === "object" && !Array.isArray(payload) && payload.error === true) {
+        const error = payload;
+        throw new DoboxaConnectorError(error.error_code, error.error_text);
+      }
+      return payload;
+    });
+  }
+  /**
+   * Get the connector platform and version.
+   */
+  fileVersion() {
+    return __async(this, null, function* () {
+      return this.call("FileVersion");
+    });
+  }
+  /**
+   * Get the list of actions the connector supports.
+   */
+  supportedMethods() {
+    return __async(this, null, function* () {
+      return this.call("SupportedMethods");
+    });
+  }
+  /**
+   * Get all product categories as a map of category id to category path.
+   */
+  categories() {
+    return __async(this, null, function* () {
+      return this.call("ProductsCategories");
+    });
+  }
+  /**
+   * List one page of products (designs).
+   *
+   * @param params - Page number and optional category filter
+   */
+  list() {
+    return __async(this, arguments, function* (params = {}) {
+      var _a;
+      const response = yield this.call("ProductsList", __spreadValues({
+        page: String((_a = params.page) != null ? _a : 1)
+      }, params.category_id !== void 0 ? { category_id: params.category_id } : {}));
+      const items = [];
+      for (const id of Object.keys(response)) {
+        if (id === "pages") {
+          continue;
+        }
+        const value = response[id];
+        if (typeof value !== "object" || value === null) {
+          continue;
+        }
+        items.push(__spreadValues({ id }, value));
+      }
+      return { pages: response.pages, items };
+    });
+  }
+  /**
+   * Get full product data (images, variants) for the given design ids.
+   *
+   * @param params - Design ids from the product list
+   */
+  data(params) {
+    return __async(this, null, function* () {
+      const response = yield this.call("ProductsData", {
+        products_id: params.products_id.join(",")
+      });
+      return Array.isArray(response) ? {} : response;
+    });
+  }
+};
+
 // src/client.ts
 var Doboxa = class {
   constructor(config = {}) {
@@ -2876,15 +2975,14 @@ var Doboxa = class {
       this.config
     );
     this.users = new UsersResource(this.httpClient, this.config);
+    if (config.catalog) {
+      this.catalog = new CatalogResource(config.catalog);
+    }
   }
 };
 
 export {
   AuthenticationResource,
-  BoolFromJSON,
-  BoolFromJSONTyped,
-  BoolToJSON,
-  BoolToJSONTyped,
   instanceOfAttachment,
   AttachmentFromJSON,
   AttachmentFromJSONTyped,
@@ -3092,6 +3190,7 @@ export {
   OrderCommentsResource,
   OrderStatusChangesResource,
   UsersResource,
+  CatalogResource,
   Doboxa
 };
-//# sourceMappingURL=chunk-WGEOQ35B.mjs.map
+//# sourceMappingURL=chunk-RTI5YLAB.mjs.map