@shopi-lk/storefront-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,397 @@
+interface ShopiConfig {
+    /** Your Storefront API key (must start with shopi_pk_) */
+    apiKey: string;
+    /** Override the API base URL (default: https://apicall.shopi.lk/v1) */
+    baseUrl?: string;
+    /** Request timeout in milliseconds (default: 10000) */
+    timeoutMs?: number;
+}
+interface Shop {
+    id: string;
+    shop_name: string;
+    subdomain: string;
+    custom_domain: string | null;
+    primary_domain: string | null;
+    business_type: string | null;
+    is_active: boolean;
+    active_theme: number | null;
+}
+interface Product {
+    id: string;
+    shop_id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    price: number;
+    compare_at_price: number | null;
+    category: string | null;
+    images: string[];
+    is_visible: boolean;
+    stock_quantity: number | null;
+    track_inventory: boolean;
+    sku: string | null;
+    weight: number | null;
+    variants: ProductVariant[] | null;
+    created_at: string;
+    updated_at: string;
+}
+interface ProductVariant {
+    name: string;
+    options: string[];
+    prices?: Record<string, number>;
+}
+interface ProductListParams {
+    category?: string;
+    search?: string;
+    limit?: number;
+    offset?: number;
+    sort_by?: "created_at" | "name" | "price" | "sales" | "updated_at";
+    sort_order?: "asc" | "desc";
+}
+interface ProductListResponse {
+    products: Product[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+interface Category {
+    id: string;
+    name: string;
+    image_url: string | null;
+}
+interface Listing {
+    id: string;
+    shop_id?: string;
+    name: string;
+    slug: string | null;
+    description: string | null;
+    price: number | null;
+    price_label: string | null;
+    currency: string | null;
+    category: string | null;
+    condition: string | null;
+    location: string | null;
+    images: string[] | null;
+    video: string | null;
+    features: string[] | null;
+    specifications: Record<string, any> | null;
+    contact_info: Record<string, any> | null;
+    availability_status: string | null;
+    is_featured: boolean | null;
+    views_count: number | null;
+    inquiries_count: number | null;
+    sort_order: number | null;
+    created_at: string;
+    updated_at: string;
+}
+interface ListingListParams {
+    category?: string;
+    search?: string;
+    limit?: number;
+    offset?: number;
+    sort_by?: "created_at" | "name" | "price" | "views_count" | "updated_at" | "sort_order";
+    sort_order?: "asc" | "desc";
+}
+interface ListingListResponse {
+    listings: Listing[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+interface RentalItem {
+    id: string;
+    shop_id?: string;
+    name: string;
+    slug: string | null;
+    description: string | null;
+    category: string | null;
+    condition: string | null;
+    location: string | null;
+    images: string[] | null;
+    video: string | null;
+    specifications: Record<string, any> | null;
+    currency: string | null;
+    hourly_rate: number | null;
+    daily_rate: number | null;
+    weekly_rate: number | null;
+    monthly_rate: number | null;
+    deposit_required: boolean | null;
+    deposit_amount: number | null;
+    min_rental_duration_hours: number | null;
+    max_rental_duration_days: number | null;
+    total_quantity: number | null;
+    available_quantity: number | null;
+    pickup_available: boolean | null;
+    delivery_available: boolean | null;
+    delivery_fee: number | null;
+    is_featured: boolean | null;
+    sort_order: number | null;
+    created_at: string;
+    updated_at: string;
+}
+interface RentalItemListParams {
+    category?: string;
+    search?: string;
+    limit?: number;
+    offset?: number;
+    sort_by?: "created_at" | "name" | "daily_rate" | "updated_at" | "sort_order";
+    sort_order?: "asc" | "desc";
+}
+interface RentalItemListResponse {
+    rental_items: RentalItem[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+interface Service {
+    id: string;
+    shop_id?: string;
+    name: string;
+    slug: string | null;
+    description: string | null;
+    price: number;
+    currency: string | null;
+    category: string | null;
+    duration_minutes: number;
+    images: string[] | null;
+    deposit_required: boolean | null;
+    deposit_amount: number | null;
+    max_bookings_per_slot: number | null;
+    buffer_before_minutes: number | null;
+    buffer_after_minutes: number | null;
+    sort_order: number | null;
+    created_at: string;
+    updated_at: string;
+}
+interface ServiceListParams {
+    category?: string;
+    search?: string;
+    limit?: number;
+    offset?: number;
+    sort_by?: "created_at" | "name" | "price" | "sort_order" | "updated_at";
+    sort_order?: "asc" | "desc";
+}
+interface ServiceListResponse {
+    services: Service[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+interface StoreSettings {
+    shop_name: string;
+    tagline: string | null;
+    logo_url: string | null;
+    phone_number: string | null;
+    email: string | null;
+    address: string | null;
+    footer_text: string | null;
+    meta_title: string | null;
+    meta_description: string | null;
+    keywords: string | null;
+    business_category: string | null;
+    business_hours: any;
+    location_city: string | null;
+    location_country: string | null;
+    social_links: Record<string, string> | null;
+    shipping_regions: any;
+    is_free_shipping: boolean | null;
+    free_shipping_enabled: boolean | null;
+    free_shipping_threshold: number | null;
+    shipping_currency: string | null;
+    shipping_config: any;
+    international_shipping: any;
+}
+interface PaymentMethod {
+    method_id: string;
+    method_name: string;
+    enabled: boolean;
+}
+interface BankDetail {
+    bank_name: string;
+    branch_name: string | null;
+    account_number: string;
+    account_holder_name: string;
+}
+interface Page {
+    id: string;
+    title: string;
+    slug: string;
+    content: string | null;
+    is_visible: boolean;
+    sort_order: number | null;
+    meta_title: string | null;
+    meta_description: string | null;
+    rendered_html: string | null;
+    rendered_css: string | null;
+}
+interface BlogPost {
+    id: string;
+    title: string;
+    slug: string;
+    content?: string;
+    excerpt: string | null;
+    featured_image: string | null;
+    author_name: string | null;
+    published_at: string | null;
+    tags: string[] | null;
+    meta_title: string | null;
+    meta_description: string | null;
+    rendered_html?: string | null;
+    rendered_css?: string | null;
+}
+interface BlogListParams {
+    limit?: number;
+    offset?: number;
+}
+interface Review {
+    id: string;
+    product_id: string;
+    rating: number;
+    review_text: string | null;
+    image_url: string | null;
+    is_verified_purchase: boolean;
+    created_at: string;
+}
+interface Discount {
+    id: string;
+    name: string;
+    discount_percentage: number;
+    applies_to: string;
+    product_id: string | null;
+    start_date: string;
+    end_date: string;
+}
+interface ThemeSettings {
+    theme_id: number;
+    settings: Record<string, any>;
+    is_published: boolean;
+}
+interface CartItem {
+    product_id: string;
+    name: string;
+    price: number;
+    quantity: number;
+    image?: string;
+    variant?: string;
+}
+interface CreateOrderParams {
+    customer_name: string;
+    customer_email: string;
+    customer_phone?: string;
+    items: CartItem[];
+    shipping_address?: Record<string, any>;
+    shipping_method?: string;
+    payment_method?: string;
+    notes?: string;
+    promo_code_id?: string;
+    discount_amount?: number;
+}
+interface Order {
+    id: string;
+    order_number: string;
+    total: number;
+    status: string;
+    created_at: string;
+}
+interface PromoValidateParams {
+    code: string;
+    cart_items?: CartItem[];
+    subtotal?: number;
+}
+interface PromoValidateResult {
+    valid: boolean;
+    error?: string;
+    promo_code?: {
+        id: string;
+        code: string;
+        discount_type: string;
+        discount_value: number;
+        applies_to: string;
+    };
+    discount_amount?: number;
+    message?: string;
+}
+interface SubmitReviewParams {
+    product_id: string;
+    rating: number;
+    review_text?: string;
+    customer_name?: string;
+    customer_email?: string;
+    image_url?: string;
+}
+
+interface RateLimitState {
+    /** Maximum requests allowed per window */
+    limit: number;
+    /** Requests remaining in the current window */
+    remaining: number;
+    /** Unix timestamp (seconds) when the window resets */
+    reset: number;
+}
+declare class Shopi {
+    private apiKey;
+    private baseUrl;
+    private timeoutMs;
+    /** Populated after every request — reflects the current rate-limit window. */
+    rateLimit: RateLimitState | null;
+    constructor(config: ShopiConfig);
+    private request;
+    getShop(): Promise<Shop>;
+    products: {
+        list: (params?: ProductListParams) => Promise<ProductListResponse>;
+        getBySlug: (slug: string) => Promise<Product>;
+    };
+    categories: {
+        list: () => Promise<Category[]>;
+    };
+    listings: {
+        list: (params?: ListingListParams) => Promise<ListingListResponse>;
+        getBySlug: (slug: string) => Promise<Listing>;
+    };
+    rentalItems: {
+        list: (params?: RentalItemListParams) => Promise<RentalItemListResponse>;
+        getBySlug: (slug: string) => Promise<RentalItem>;
+    };
+    services: {
+        list: (params?: ServiceListParams) => Promise<ServiceListResponse>;
+        getBySlug: (slug: string) => Promise<Service>;
+    };
+    getStoreSettings(): Promise<StoreSettings>;
+    getPaymentMethods(): Promise<{
+        payment_methods: PaymentMethod[];
+        bank_details: BankDetail[];
+    }>;
+    pages: {
+        list: () => Promise<Page[]>;
+        getBySlug: (slug: string) => Promise<Page>;
+    };
+    blog: {
+        list: (params?: BlogListParams) => Promise<{
+            posts: BlogPost[];
+            total: number;
+        }>;
+        getBySlug: (slug: string) => Promise<BlogPost>;
+    };
+    reviews: {
+        list: (productId: string, limit?: number) => Promise<Review[]>;
+        submit: (params: SubmitReviewParams) => Promise<{
+            id: string;
+        }>;
+    };
+    getDiscounts(): Promise<{
+        shop_wide: Discount[];
+        product_specific: Discount[];
+    }>;
+    getThemeSettings(): Promise<ThemeSettings | null>;
+    checkout: {
+        createOrder: (params: CreateOrderParams) => Promise<Order>;
+        validatePromo: (params: PromoValidateParams) => Promise<PromoValidateResult>;
+    };
+}
+declare class ShopiError extends Error {
+    status: number;
+    data: unknown;
+    constructor(message: string, status: number, data?: unknown);
+}
+
+export { type BankDetail, type BlogListParams, type BlogPost, type CartItem, type Category, type CreateOrderParams, type Discount, type Listing, type ListingListParams, type ListingListResponse, type Order, type Page, type PaymentMethod, type Product, type ProductListParams, type ProductListResponse, type ProductVariant, type PromoValidateParams, type PromoValidateResult, type RateLimitState, type RentalItem, type RentalItemListParams, type RentalItemListResponse, type Review, type Service, type ServiceListParams, type ServiceListResponse, type Shop, Shopi, type ShopiConfig, ShopiError, type StoreSettings, type SubmitReviewParams, type ThemeSettings };

package/dist/index.js

@@ -0,0 +1,293 @@
+"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);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Shopi: () => Shopi,
+  ShopiError: () => ShopiError
+});
+module.exports = __toCommonJS(index_exports);
+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;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Shopi,
+  ShopiError
+});