@betterstore/sdk 0.6.1 → 0.6.3

package/dist/index.d.mts

@@ -127,11 +127,17 @@ declare class Client {
     }): Promise<LookupAddressResult>;
 }
 
+type FormatResponseForSDK<T extends object> = keyof T extends [
+    string,
+    string,
+    ...string[]
+] ? T : T[keyof T];
+
 declare class Collections {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListCollectionsParams>(params?: T): Promise<ListCollectionsResponse<T>>;
-    retrieve<T extends RetrieveCollectionParams>(params: T): Promise<RetrieveCollectionResponse<T> | null>;
+    list<T extends ListCollectionsParams>(params?: T): Promise<FormatResponseForSDK<ListCollectionsResponse<T>>>;
+    retrieve<T extends RetrieveCollectionParams>(params: T): Promise<FormatResponseForSDK<RetrieveCollectionResponse<T>> | null>;
 }
 
 declare class Customer {
@@ -162,17 +168,30 @@ declare class Customer {
 declare class Discounts {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListDiscountsParams>(params?: T): Promise<ListDiscountsResponse>;
-    retrieve<T extends RetrieveDiscountParams>(params: T): Promise<RetrieveDiscountResponse | null>;
+    list<T extends ListDiscountsParams>(params?: T): Promise<FormatResponseForSDK<ListDiscountsResponse>>;
+    retrieve<T extends RetrieveDiscountParams>(params: T): Promise<FormatResponseForSDK<RetrieveDiscountResponse> | null>;
 }
 
 declare class Products {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListProductsParams>(params?: T): Promise<ListProductsResponse<T>>;
-    retrieve<T extends RetrieveProductParams>(params: T): Promise<RetrieveProductResponse<T> | null>;
+    list<T extends ListProductsParams>(params?: T): Promise<FormatResponseForSDK<ListProductsResponse<T>>>;
+    retrieve<T extends RetrieveProductParams>(params: T): Promise<FormatResponseForSDK<RetrieveProductResponse<T>> | null>;
 }
 
+type Discount = NonNullable<RetrieveDiscountResponse["discount"]>;
+declare function findAutomaticProductDiscount({ productId, priceInCents, discounts, }: {
+    productId: string;
+    priceInCents: number;
+    discounts: Discount[];
+}): {
+    finalPrice: number;
+    discountAmount: number | undefined;
+    originalPrice: number;
+    isFree: boolean;
+    isDiscounted: boolean;
+};
+
 declare function createBetterStore(config: {
     apiKey: string;
     proxy?: string;
@@ -188,4 +207,4 @@ declare function createStoreClient(config?: {
     proxy?: string;
 }): Client;
 
-export { createStoreClient, createBetterStore as default };
+export { type Discount, createStoreClient, createBetterStore as default, findAutomaticProductDiscount };

package/dist/index.d.ts

@@ -127,11 +127,17 @@ declare class Client {
     }): Promise<LookupAddressResult>;
 }
 
+type FormatResponseForSDK<T extends object> = keyof T extends [
+    string,
+    string,
+    ...string[]
+] ? T : T[keyof T];
+
 declare class Collections {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListCollectionsParams>(params?: T): Promise<ListCollectionsResponse<T>>;
-    retrieve<T extends RetrieveCollectionParams>(params: T): Promise<RetrieveCollectionResponse<T> | null>;
+    list<T extends ListCollectionsParams>(params?: T): Promise<FormatResponseForSDK<ListCollectionsResponse<T>>>;
+    retrieve<T extends RetrieveCollectionParams>(params: T): Promise<FormatResponseForSDK<RetrieveCollectionResponse<T>> | null>;
 }
 
 declare class Customer {
@@ -162,17 +168,30 @@ declare class Customer {
 declare class Discounts {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListDiscountsParams>(params?: T): Promise<ListDiscountsResponse>;
-    retrieve<T extends RetrieveDiscountParams>(params: T): Promise<RetrieveDiscountResponse | null>;
+    list<T extends ListDiscountsParams>(params?: T): Promise<FormatResponseForSDK<ListDiscountsResponse>>;
+    retrieve<T extends RetrieveDiscountParams>(params: T): Promise<FormatResponseForSDK<RetrieveDiscountResponse> | null>;
 }
 
 declare class Products {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListProductsParams>(params?: T): Promise<ListProductsResponse<T>>;
-    retrieve<T extends RetrieveProductParams>(params: T): Promise<RetrieveProductResponse<T> | null>;
+    list<T extends ListProductsParams>(params?: T): Promise<FormatResponseForSDK<ListProductsResponse<T>>>;
+    retrieve<T extends RetrieveProductParams>(params: T): Promise<FormatResponseForSDK<RetrieveProductResponse<T>> | null>;
 }
 
+type Discount = NonNullable<RetrieveDiscountResponse["discount"]>;
+declare function findAutomaticProductDiscount({ productId, priceInCents, discounts, }: {
+    productId: string;
+    priceInCents: number;
+    discounts: Discount[];
+}): {
+    finalPrice: number;
+    discountAmount: number | undefined;
+    originalPrice: number;
+    isFree: boolean;
+    isDiscounted: boolean;
+};
+
 declare function createBetterStore(config: {
     apiKey: string;
     proxy?: string;
@@ -188,4 +207,4 @@ declare function createStoreClient(config?: {
     proxy?: string;
 }): Client;
 
-export { createStoreClient, createBetterStore as default };
+export { type Discount, createStoreClient, createBetterStore as default, findAutomaticProductDiscount };

package/dist/index.js

@@ -32,12 +32,13 @@ var index_exports = {};
 __export(index_exports, {
   createStoreClient: () => createStoreClient,
   default: () => createBetterStore,
+  findAutomaticProductDiscount: () => findAutomaticProductDiscount,
   formatCurrency: () => import_bridge.formatCurrency,
   formatPrice: () => import_bridge.formatPrice
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/utils/axios.ts
+// src/_utils/axios.ts
 var import_axios = __toESM(require("axios"));
 var API_BASE_URL = "https://v1.betterstore.io";
 var createApiClient = (apiKey, proxy) => {
@@ -440,11 +441,9 @@ var Collections = class {
   async list(params) {
     const data = await this.apiClient.post(`/collections`, params);
     if (!data || !Array.isArray(data) || "isError" in data && data.isError || !("collections" in data)) {
-      return {
-        collections: []
-      };
+      return [];
     }
-    return data;
+    return data.collections;
   }
   async retrieve(params) {
     const data = await this.apiClient.post(`/collections/retrieve`, params);
@@ -452,7 +451,7 @@ var Collections = class {
       console.error(`Collection not found`);
       return null;
     }
-    return data;
+    return data.collection;
   }
 };
 var collections_default = Collections;
@@ -537,11 +536,9 @@ var Discounts = class {
       params
     );
     if (!data || !Array.isArray(data) || "isError" in data && data.isError || !("discounts" in data)) {
-      return {
-        discounts: []
-      };
+      return [];
     }
-    return data;
+    return data.discounts;
   }
   async retrieve(params) {
     const data = await this.apiClient.post(
@@ -552,7 +549,7 @@ var Discounts = class {
       console.error(`Discount not found`);
       return null;
     }
-    return data;
+    return data.discount;
   }
 };
 var discounts_default = Discounts;
@@ -569,11 +566,9 @@ var Products = class {
       params
     );
     if (!data || !Array.isArray(data) || "isError" in data && data.isError || !("products" in data)) {
-      return {
-        products: []
-      };
+      return [];
     }
-    return data;
+    return data.products;
   }
   async retrieve(params) {
     const data = await this.apiClient.post("/products/retrieve", params);
@@ -581,14 +576,58 @@ var Products = class {
       console.error(`Product not found`);
       return null;
     }
-    return data;
+    return data.product;
   }
 };
 var products_default = Products;
 
-// src/types.ts
+// src/types-and-methods.ts
 var import_bridge = require("@betterstore/bridge");
 
+// src/methods/cart-discounts.ts
+function getHighestDiscount(productId, priceInCents, discounts) {
+  const applicableDiscounts = discounts.filter(
+    (discount) => discount.allowedProductIDs.includes(productId)
+  );
+  const bestDiscount = applicableDiscounts.length > 1 ? applicableDiscounts.reduce((bestSoFar, currentDiscount) => {
+    let currentDiscountValueInCents = currentDiscount.value;
+    if (currentDiscount.valueType === "PERCENTAGE") {
+      currentDiscountValueInCents = currentDiscount.value / 100 * priceInCents;
+    } else if (currentDiscount.valueType === "FREE") {
+      currentDiscountValueInCents = priceInCents;
+    }
+    return (bestSoFar?.value ?? 0) > currentDiscountValueInCents ? bestSoFar : currentDiscount;
+  }, applicableDiscounts[0]) : applicableDiscounts[0];
+  return bestDiscount;
+}
+function calculateDiscountAmount(originalPrice, discount) {
+  let discountValueInCents = discount?.value;
+  const isFreeDiscount = discount?.valueType === "FREE";
+  if (discount?.valueType === "PERCENTAGE") {
+    discountValueInCents = discount.value / 100 * originalPrice;
+  } else if (discount?.valueType === "FREE") {
+    discountValueInCents = originalPrice;
+  }
+  const finalPrice = discountValueInCents ? Math.max(originalPrice - discountValueInCents, 0) : originalPrice;
+  const isDiscounted = discountValueInCents === 0;
+  return {
+    finalPrice,
+    discountAmount: discountValueInCents,
+    originalPrice,
+    isFree: isFreeDiscount,
+    isDiscounted
+  };
+}
+function findAutomaticProductDiscount({
+  productId,
+  priceInCents,
+  discounts
+}) {
+  const discount = getHighestDiscount(productId, priceInCents, discounts);
+  const result = calculateDiscountAmount(priceInCents, discount);
+  return result;
+}
+
 // src/index.ts
 function createBetterStore(config) {
   if (!config.apiKey) {
@@ -609,6 +648,7 @@ function createStoreClient(config) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createStoreClient,
+  findAutomaticProductDiscount,
   formatCurrency,
   formatPrice
 });

package/dist/index.mjs

@@ -1,4 +1,4 @@
-// src/utils/axios.ts
+// src/_utils/axios.ts
 import axios from "axios";
 var API_BASE_URL = "https://v1.betterstore.io";
 var createApiClient = (apiKey, proxy) => {
@@ -401,11 +401,9 @@ var Collections = class {
   async list(params) {
     const data = await this.apiClient.post(`/collections`, params);
     if (!data || !Array.isArray(data) || "isError" in data && data.isError || !("collections" in data)) {
-      return {
-        collections: []
-      };
+      return [];
     }
-    return data;
+    return data.collections;
   }
   async retrieve(params) {
     const data = await this.apiClient.post(`/collections/retrieve`, params);
@@ -413,7 +411,7 @@ var Collections = class {
       console.error(`Collection not found`);
       return null;
     }
-    return data;
+    return data.collection;
   }
 };
 var collections_default = Collections;
@@ -498,11 +496,9 @@ var Discounts = class {
       params
     );
     if (!data || !Array.isArray(data) || "isError" in data && data.isError || !("discounts" in data)) {
-      return {
-        discounts: []
-      };
+      return [];
     }
-    return data;
+    return data.discounts;
   }
   async retrieve(params) {
     const data = await this.apiClient.post(
@@ -513,7 +509,7 @@ var Discounts = class {
       console.error(`Discount not found`);
       return null;
     }
-    return data;
+    return data.discount;
   }
 };
 var discounts_default = Discounts;
@@ -530,11 +526,9 @@ var Products = class {
       params
     );
     if (!data || !Array.isArray(data) || "isError" in data && data.isError || !("products" in data)) {
-      return {
-        products: []
-      };
+      return [];
     }
-    return data;
+    return data.products;
   }
   async retrieve(params) {
     const data = await this.apiClient.post("/products/retrieve", params);
@@ -542,14 +536,58 @@ var Products = class {
       console.error(`Product not found`);
       return null;
     }
-    return data;
+    return data.product;
   }
 };
 var products_default = Products;
 
-// src/types.ts
+// src/types-and-methods.ts
 import { formatCurrency, formatPrice } from "@betterstore/bridge";
 
+// src/methods/cart-discounts.ts
+function getHighestDiscount(productId, priceInCents, discounts) {
+  const applicableDiscounts = discounts.filter(
+    (discount) => discount.allowedProductIDs.includes(productId)
+  );
+  const bestDiscount = applicableDiscounts.length > 1 ? applicableDiscounts.reduce((bestSoFar, currentDiscount) => {
+    let currentDiscountValueInCents = currentDiscount.value;
+    if (currentDiscount.valueType === "PERCENTAGE") {
+      currentDiscountValueInCents = currentDiscount.value / 100 * priceInCents;
+    } else if (currentDiscount.valueType === "FREE") {
+      currentDiscountValueInCents = priceInCents;
+    }
+    return (bestSoFar?.value ?? 0) > currentDiscountValueInCents ? bestSoFar : currentDiscount;
+  }, applicableDiscounts[0]) : applicableDiscounts[0];
+  return bestDiscount;
+}
+function calculateDiscountAmount(originalPrice, discount) {
+  let discountValueInCents = discount?.value;
+  const isFreeDiscount = discount?.valueType === "FREE";
+  if (discount?.valueType === "PERCENTAGE") {
+    discountValueInCents = discount.value / 100 * originalPrice;
+  } else if (discount?.valueType === "FREE") {
+    discountValueInCents = originalPrice;
+  }
+  const finalPrice = discountValueInCents ? Math.max(originalPrice - discountValueInCents, 0) : originalPrice;
+  const isDiscounted = discountValueInCents === 0;
+  return {
+    finalPrice,
+    discountAmount: discountValueInCents,
+    originalPrice,
+    isFree: isFreeDiscount,
+    isDiscounted
+  };
+}
+function findAutomaticProductDiscount({
+  productId,
+  priceInCents,
+  discounts
+}) {
+  const discount = getHighestDiscount(productId, priceInCents, discounts);
+  const result = calculateDiscountAmount(priceInCents, discount);
+  return result;
+}
+
 // src/index.ts
 function createBetterStore(config) {
   if (!config.apiKey) {
@@ -570,6 +608,7 @@ function createStoreClient(config) {
 export {
   createStoreClient,
   createBetterStore as default,
+  findAutomaticProductDiscount,
   formatCurrency,
   formatPrice
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@betterstore/sdk",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "private": false,
   "main": "dist/index.js",
   "module": "dist/index.mjs",