@shopi-lk/storefront-sdk 1.0.0

package/dist/index.mjs

@@ -0,0 +1,267 @@
+// src/index.ts
+var DEFAULT_BASE_URL = "https://apicall.shopi.lk/v1";
+var DEFAULT_TIMEOUT_MS = 1e4;
+var MAX_RETRIES = 2;
+var RETRYABLE_STATUSES = /* @__PURE__ */ new Set([429, 500, 502, 503, 504]);
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+var Shopi = class {
+  constructor(config) {
+    /** Populated after every request — reflects the current rate-limit window. */
+    this.rateLimit = null;
+    // ── Products ───────────────────────────────────────────────────────────
+    this.products = {
+      list: async (params) => {
+        return this.request("products", {
+          params
+        });
+      },
+      getBySlug: async (slug) => {
+        const res = await this.request(
+          `products/${encodeURIComponent(slug)}`
+        );
+        return res.product;
+      }
+    };
+    // ── Categories ─────────────────────────────────────────────────────────
+    this.categories = {
+      list: async () => {
+        const res = await this.request("categories");
+        return res.categories;
+      }
+    };
+    // ── Listings ──────────────────────────────────────────────────────────
+    this.listings = {
+      list: async (params) => {
+        return this.request("listings", {
+          params
+        });
+      },
+      getBySlug: async (slug) => {
+        const res = await this.request(
+          `listings/${encodeURIComponent(slug)}`
+        );
+        return res.listing;
+      }
+    };
+    // ── Rental Items ──────────────────────────────────────────────────────
+    this.rentalItems = {
+      list: async (params) => {
+        return this.request("rental-items", {
+          params
+        });
+      },
+      getBySlug: async (slug) => {
+        const res = await this.request(
+          `rental-items/${encodeURIComponent(slug)}`
+        );
+        return res.rental_item;
+      }
+    };
+    // ── Services ──────────────────────────────────────────────────────────
+    this.services = {
+      list: async (params) => {
+        return this.request("services", {
+          params
+        });
+      },
+      getBySlug: async (slug) => {
+        const res = await this.request(
+          `services/${encodeURIComponent(slug)}`
+        );
+        return res.service;
+      }
+    };
+    // ── Pages ──────────────────────────────────────────────────────────────
+    this.pages = {
+      list: async () => {
+        const res = await this.request("pages");
+        return res.pages;
+      },
+      getBySlug: async (slug) => {
+        const res = await this.request(
+          `pages/${encodeURIComponent(slug)}`
+        );
+        return res.page;
+      }
+    };
+    // ── Blog ───────────────────────────────────────────────────────────────
+    this.blog = {
+      list: async (params) => {
+        return this.request("blogs", {
+          params
+        });
+      },
+      getBySlug: async (slug) => {
+        const res = await this.request(
+          `blogs/${encodeURIComponent(slug)}`
+        );
+        return res.post;
+      }
+    };
+    // ── Reviews ────────────────────────────────────────────────────────────
+    this.reviews = {
+      list: async (productId, limit) => {
+        const res = await this.request(
+          `reviews/${encodeURIComponent(productId)}`,
+          { params: limit ? { limit } : void 0 }
+        );
+        return res.reviews;
+      },
+      submit: async (params) => {
+        const res = await this.request("reviews", {
+          method: "POST",
+          body: params
+        });
+        return res.review;
+      }
+    };
+    // ── Checkout / Orders ──────────────────────────────────────────────────
+    this.checkout = {
+      createOrder: async (params) => {
+        const res = await this.request("orders", {
+          method: "POST",
+          body: params
+        });
+        return res.order;
+      },
+      validatePromo: async (params) => {
+        return this.request("promo/validate", {
+          method: "POST",
+          body: params
+        });
+      }
+    };
+    if (!config.apiKey || typeof config.apiKey !== "string") {
+      throw new Error("apiKey is required and must be a string");
+    }
+    const trimmed = config.apiKey.trim();
+    if (!trimmed.startsWith("shopi_pk_")) {
+      throw new Error('apiKey must start with "shopi_pk_"');
+    }
+    this.apiKey = trimmed;
+    this.baseUrl = (config.baseUrl || DEFAULT_BASE_URL).replace(/\/$/, "");
+    this.timeoutMs = config.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+  }
+  async request(path, options = {}) {
+    const { method = "GET", body, params, _retryCount = 0 } = options;
+    let url = `${this.baseUrl}/${path}`;
+    if (params) {
+      const search = new URLSearchParams();
+      for (const [k, v] of Object.entries(params)) {
+        if (v !== void 0 && v !== null) search.set(k, String(v));
+      }
+      const qs = search.toString();
+      if (qs) url += `?${qs}`;
+    }
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), this.timeoutMs);
+    let res;
+    try {
+      res = await fetch(url, {
+        method,
+        headers: {
+          "X-Shopi-Api-Key": this.apiKey,
+          ...body ? { "Content-Type": "application/json" } : {}
+        },
+        body: body ? JSON.stringify(body) : void 0,
+        signal: controller.signal
+      });
+    } catch (err) {
+      clearTimeout(timer);
+      if (err instanceof Error && err.name === "AbortError") {
+        throw new ShopiError(
+          `Request timed out after ${this.timeoutMs}ms`,
+          408
+        );
+      }
+      throw new ShopiError(
+        err instanceof Error ? err.message : "Network error",
+        0
+      );
+    } finally {
+      clearTimeout(timer);
+    }
+    if (RETRYABLE_STATUSES.has(res.status) && _retryCount < MAX_RETRIES) {
+      let delay = 2 ** _retryCount * 300;
+      if (res.status === 429) {
+        const retryAfter = res.headers.get("Retry-After");
+        if (retryAfter) delay = Math.min(parseInt(retryAfter, 10) * 1e3, 1e4);
+      }
+      await sleep(delay);
+      return this.request(path, { ...options, _retryCount: _retryCount + 1 });
+    }
+    const rlLimit = res.headers.get("X-RateLimit-Limit");
+    const rlRemaining = res.headers.get("X-RateLimit-Remaining");
+    const rlReset = res.headers.get("X-RateLimit-Reset");
+    if (rlLimit && rlRemaining && rlReset) {
+      this.rateLimit = {
+        limit: parseInt(rlLimit, 10),
+        remaining: parseInt(rlRemaining, 10),
+        reset: parseInt(rlReset, 10)
+      };
+    }
+    let data;
+    try {
+      data = await res.json();
+    } catch {
+      throw new ShopiError(
+        `Unexpected server response (status ${res.status})`,
+        res.status
+      );
+    }
+    if (!res.ok) {
+      const errData = data;
+      throw new ShopiError(
+        typeof errData?.error === "string" ? errData.error : "Request failed",
+        res.status,
+        data
+      );
+    }
+    return data;
+  }
+  // ── Shop ───────────────────────────────────────────────────────────────
+  async getShop() {
+    const res = await this.request("shop");
+    return res.shop;
+  }
+  // ── Store Settings ─────────────────────────────────────────────────────
+  async getStoreSettings() {
+    const res = await this.request(
+      "store-settings"
+    );
+    return res.settings;
+  }
+  // ── Payment Methods ────────────────────────────────────────────────────
+  async getPaymentMethods() {
+    return this.request("payment-methods");
+  }
+  // ── Discounts ──────────────────────────────────────────────────────────
+  async getDiscounts() {
+    const res = await this.request("discounts");
+    return {
+      shop_wide: res.shop_wide_discounts,
+      product_specific: res.product_discounts
+    };
+  }
+  // ── Theme Settings ─────────────────────────────────────────────────────
+  async getThemeSettings() {
+    const res = await this.request(
+      "theme-settings"
+    );
+    return res.theme;
+  }
+};
+var ShopiError = class extends Error {
+  constructor(message, status, data) {
+    super(message);
+    this.name = "ShopiError";
+    this.status = status;
+    this.data = data;
+  }
+};
+export {
+  Shopi,
+  ShopiError
+};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@shopi-lk/storefront-sdk",
+  "version": "1.0.0",
+  "description": "Official Shopi.lk Storefront SDK — access products, cart, checkout, and theme settings for custom storefronts",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+  ".": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.js"
+  }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
+  },
+  "keywords": ["shopi", "storefront", "ecommerce", "sdk", "headless-commerce"],
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  }
+}