@betterstore/sdk 0.6.2 → 0.6.4

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { OTPSignupParams, OTPSignupResponse, OTPLoginParams, OTPLoginResponse, OTPVerifyParams, OTPVerifyResponse, CustomerSession, CheckoutCreateParams, CheckoutSession, CheckoutUpdateParams, GetShippingRatesResponse, CustomerCreateParams, CustomerResponse, CustomerUpdateParams, AutosuggestAddressResult, LookupAddressResult, ListCollectionsParams, ListCollectionsResponse, RetrieveCollectionParams, RetrieveCollectionResponse, CustomerSubscriptionUpdateParams, CustomerSubscription, ListDiscountsParams, ListDiscountsResponse, RetrieveDiscountParams, RetrieveDiscountResponse, ListProductsParams, ListProductsResponse, RetrieveProductParams, RetrieveProductResponse } from '@betterstore/bridge';
 export { Address, AutosuggestAddressResult, CheckoutCreateParams, CheckoutSession, CheckoutUpdateParams, CustomShippingVendorRate, CustomerCreateParams, CustomerResponse, CustomerSession, CustomerSubscription, CustomerSubscriptionUpdateParams, CustomerUpdateParams, GetShippingRatesResponse, ListCollectionsParams, ListCollectionsResponse, ListDiscountsParams, ListDiscountsResponse, ListProductsParams, ListProductsResponse, LookupAddressResult, OTPLoginParams, OTPLoginResponse, OTPSignupParams, OTPSignupResponse, OTPVerifyParams, OTPVerifyResponse, ProductVariant, RetrieveCollectionParams, RetrieveCollectionResponse, RetrieveDiscountParams, RetrieveDiscountResponse, RetrieveProductParams, RetrieveProductResponse, formatCurrency, formatPrice } from '@betterstore/bridge';
 import axios from 'axios';
+import * as _betterstore_bridge_generated_prisma_client from '@betterstore/bridge/generated/prisma/client';
 
 declare const createApiClient: (apiKey: string, proxy?: string) => axios.AxiosInstance;
 
@@ -132,12 +133,13 @@ type FormatResponseForSDK<T extends object> = keyof T extends [
     string,
     ...string[]
 ] ? T : T[keyof T];
+type FormatParamsForSDK<GenericType, ConstraintType> = GenericType & Record<Exclude<keyof GenericType, keyof ConstraintType>, never>;
 
 declare class Collections {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListCollectionsParams>(params?: T): Promise<FormatResponseForSDK<ListCollectionsResponse<T>>>;
-    retrieve<T extends RetrieveCollectionParams>(params: T): Promise<FormatResponseForSDK<RetrieveCollectionResponse<T>> | null>;
+    list<T extends ListCollectionsParams>(params?: FormatParamsForSDK<T, ListCollectionsParams>): Promise<FormatResponseForSDK<ListCollectionsResponse<T>>>;
+    retrieve<T extends RetrieveCollectionParams>(params: FormatParamsForSDK<T, RetrieveCollectionParams>): Promise<FormatResponseForSDK<RetrieveCollectionResponse<T>> | null>;
 }
 
 declare class Customer {
@@ -168,17 +170,61 @@ declare class Customer {
 declare class Discounts {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListDiscountsParams>(params?: T): Promise<FormatResponseForSDK<ListDiscountsResponse>>;
-    retrieve<T extends RetrieveDiscountParams>(params: T): Promise<FormatResponseForSDK<RetrieveDiscountResponse> | null>;
+    list<T extends ListDiscountsParams>(params?: FormatParamsForSDK<T, ListDiscountsParams>): Promise<FormatResponseForSDK<ListDiscountsResponse>>;
+    retrieve<T extends RetrieveDiscountParams>(params: FormatParamsForSDK<T, RetrieveDiscountParams>): Promise<FormatResponseForSDK<RetrieveDiscountResponse> | null>;
 }
 
 declare class Products {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListProductsParams>(params?: T): Promise<FormatResponseForSDK<ListProductsResponse<T>>>;
-    retrieve<T extends RetrieveProductParams>(params: T): Promise<FormatResponseForSDK<RetrieveProductResponse<T>> | null>;
+    list<T extends ListProductsParams>(params?: FormatParamsForSDK<T, ListProductsParams>): Promise<FormatResponseForSDK<ListProductsResponse<T>>>;
+    retrieve<T extends RetrieveProductParams>(params: FormatParamsForSDK<T, RetrieveProductParams>): Promise<FormatResponseForSDK<RetrieveProductResponse<T>> | null>;
 }
 
+type Discount = NonNullable<RetrieveDiscountResponse["discount"]>;
+declare function findAutomaticProductDiscount({ productId, priceInCents, discounts, }: {
+    productId: string;
+    priceInCents: number;
+    discounts: Discount[];
+}): {
+    discount: {
+        method: _betterstore_bridge_generated_prisma_client.$Enums.DiscountMethod;
+        testmode: boolean;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        expiresAt: Date | null;
+        status: _betterstore_bridge_generated_prisma_client.$Enums.DiscountStatus;
+        code: string | null;
+        title: string | null;
+        type: _betterstore_bridge_generated_prisma_client.$Enums.DiscountType;
+        value: number;
+        valueType: _betterstore_bridge_generated_prisma_client.$Enums.DiscountValueType;
+        discountScope: _betterstore_bridge_generated_prisma_client.$Enums.ProductDiscountScope;
+        allowedProductIDs: string[];
+        allowedCollectionIDs: string[];
+        allowedCombinations: _betterstore_bridge_generated_prisma_client.$Enums.DiscountScope[];
+        minimumRequirementsType: _betterstore_bridge_generated_prisma_client.$Enums.MinimumRequirementsType;
+        minimumRequirementsValue: number | null;
+        requiredProductIDs: string[];
+        requiredCollectionIDs: string[];
+        minimumRequirementsScope: _betterstore_bridge_generated_prisma_client.$Enums.ProductDiscountScope;
+        maxUses: number | null;
+        maxUsesPerCustomer: number | null;
+        maxAllowedProductQuantity: number | null;
+        uses: number;
+        subscriptionDiscountDurationType: _betterstore_bridge_generated_prisma_client.$Enums.SubscriptionDiscountDurationType;
+        subscriptionDiscountDurationValue: number;
+        stripeDiscountId: string | null;
+        startsAt: Date;
+    } | undefined;
+    finalPrice: number;
+    discountAmount: number;
+    originalPrice: number;
+    isFree: boolean;
+    isDiscounted: boolean;
+};
+
 declare function createBetterStore(config: {
     apiKey: string;
     proxy?: string;
@@ -194,4 +240,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

@@ -1,6 +1,7 @@
 import { OTPSignupParams, OTPSignupResponse, OTPLoginParams, OTPLoginResponse, OTPVerifyParams, OTPVerifyResponse, CustomerSession, CheckoutCreateParams, CheckoutSession, CheckoutUpdateParams, GetShippingRatesResponse, CustomerCreateParams, CustomerResponse, CustomerUpdateParams, AutosuggestAddressResult, LookupAddressResult, ListCollectionsParams, ListCollectionsResponse, RetrieveCollectionParams, RetrieveCollectionResponse, CustomerSubscriptionUpdateParams, CustomerSubscription, ListDiscountsParams, ListDiscountsResponse, RetrieveDiscountParams, RetrieveDiscountResponse, ListProductsParams, ListProductsResponse, RetrieveProductParams, RetrieveProductResponse } from '@betterstore/bridge';
 export { Address, AutosuggestAddressResult, CheckoutCreateParams, CheckoutSession, CheckoutUpdateParams, CustomShippingVendorRate, CustomerCreateParams, CustomerResponse, CustomerSession, CustomerSubscription, CustomerSubscriptionUpdateParams, CustomerUpdateParams, GetShippingRatesResponse, ListCollectionsParams, ListCollectionsResponse, ListDiscountsParams, ListDiscountsResponse, ListProductsParams, ListProductsResponse, LookupAddressResult, OTPLoginParams, OTPLoginResponse, OTPSignupParams, OTPSignupResponse, OTPVerifyParams, OTPVerifyResponse, ProductVariant, RetrieveCollectionParams, RetrieveCollectionResponse, RetrieveDiscountParams, RetrieveDiscountResponse, RetrieveProductParams, RetrieveProductResponse, formatCurrency, formatPrice } from '@betterstore/bridge';
 import axios from 'axios';
+import * as _betterstore_bridge_generated_prisma_client from '@betterstore/bridge/generated/prisma/client';
 
 declare const createApiClient: (apiKey: string, proxy?: string) => axios.AxiosInstance;
 
@@ -132,12 +133,13 @@ type FormatResponseForSDK<T extends object> = keyof T extends [
     string,
     ...string[]
 ] ? T : T[keyof T];
+type FormatParamsForSDK<GenericType, ConstraintType> = GenericType & Record<Exclude<keyof GenericType, keyof ConstraintType>, never>;
 
 declare class Collections {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListCollectionsParams>(params?: T): Promise<FormatResponseForSDK<ListCollectionsResponse<T>>>;
-    retrieve<T extends RetrieveCollectionParams>(params: T): Promise<FormatResponseForSDK<RetrieveCollectionResponse<T>> | null>;
+    list<T extends ListCollectionsParams>(params?: FormatParamsForSDK<T, ListCollectionsParams>): Promise<FormatResponseForSDK<ListCollectionsResponse<T>>>;
+    retrieve<T extends RetrieveCollectionParams>(params: FormatParamsForSDK<T, RetrieveCollectionParams>): Promise<FormatResponseForSDK<RetrieveCollectionResponse<T>> | null>;
 }
 
 declare class Customer {
@@ -168,17 +170,61 @@ declare class Customer {
 declare class Discounts {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListDiscountsParams>(params?: T): Promise<FormatResponseForSDK<ListDiscountsResponse>>;
-    retrieve<T extends RetrieveDiscountParams>(params: T): Promise<FormatResponseForSDK<RetrieveDiscountResponse> | null>;
+    list<T extends ListDiscountsParams>(params?: FormatParamsForSDK<T, ListDiscountsParams>): Promise<FormatResponseForSDK<ListDiscountsResponse>>;
+    retrieve<T extends RetrieveDiscountParams>(params: FormatParamsForSDK<T, RetrieveDiscountParams>): Promise<FormatResponseForSDK<RetrieveDiscountResponse> | null>;
 }
 
 declare class Products {
     private apiClient;
     constructor(apiKey: string, proxy?: string);
-    list<T extends ListProductsParams>(params?: T): Promise<FormatResponseForSDK<ListProductsResponse<T>>>;
-    retrieve<T extends RetrieveProductParams>(params: T): Promise<FormatResponseForSDK<RetrieveProductResponse<T>> | null>;
+    list<T extends ListProductsParams>(params?: FormatParamsForSDK<T, ListProductsParams>): Promise<FormatResponseForSDK<ListProductsResponse<T>>>;
+    retrieve<T extends RetrieveProductParams>(params: FormatParamsForSDK<T, RetrieveProductParams>): Promise<FormatResponseForSDK<RetrieveProductResponse<T>> | null>;
 }
 
+type Discount = NonNullable<RetrieveDiscountResponse["discount"]>;
+declare function findAutomaticProductDiscount({ productId, priceInCents, discounts, }: {
+    productId: string;
+    priceInCents: number;
+    discounts: Discount[];
+}): {
+    discount: {
+        method: _betterstore_bridge_generated_prisma_client.$Enums.DiscountMethod;
+        testmode: boolean;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        expiresAt: Date | null;
+        status: _betterstore_bridge_generated_prisma_client.$Enums.DiscountStatus;
+        code: string | null;
+        title: string | null;
+        type: _betterstore_bridge_generated_prisma_client.$Enums.DiscountType;
+        value: number;
+        valueType: _betterstore_bridge_generated_prisma_client.$Enums.DiscountValueType;
+        discountScope: _betterstore_bridge_generated_prisma_client.$Enums.ProductDiscountScope;
+        allowedProductIDs: string[];
+        allowedCollectionIDs: string[];
+        allowedCombinations: _betterstore_bridge_generated_prisma_client.$Enums.DiscountScope[];
+        minimumRequirementsType: _betterstore_bridge_generated_prisma_client.$Enums.MinimumRequirementsType;
+        minimumRequirementsValue: number | null;
+        requiredProductIDs: string[];
+        requiredCollectionIDs: string[];
+        minimumRequirementsScope: _betterstore_bridge_generated_prisma_client.$Enums.ProductDiscountScope;
+        maxUses: number | null;
+        maxUsesPerCustomer: number | null;
+        maxAllowedProductQuantity: number | null;
+        uses: number;
+        subscriptionDiscountDurationType: _betterstore_bridge_generated_prisma_client.$Enums.SubscriptionDiscountDurationType;
+        subscriptionDiscountDurationValue: number;
+        stripeDiscountId: string | null;
+        startsAt: Date;
+    } | undefined;
+    finalPrice: number;
+    discountAmount: number;
+    originalPrice: number;
+    isFree: boolean;
+    isDiscounted: boolean;
+};
+
 declare function createBetterStore(config: {
     apiKey: string;
     proxy?: string;
@@ -194,4 +240,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) => {
@@ -580,9 +581,53 @@ var Products = class {
 };
 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 ?? 0,
+    originalPrice,
+    isFree: isFreeDiscount,
+    isDiscounted
+  };
+}
+function findAutomaticProductDiscount({
+  productId,
+  priceInCents,
+  discounts
+}) {
+  const discount = getHighestDiscount(productId, priceInCents, discounts);
+  const result = calculateDiscountAmount(priceInCents, discount);
+  return { ...result, discount };
+}
+
 // src/index.ts
 function createBetterStore(config) {
   if (!config.apiKey) {
@@ -603,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) => {
@@ -541,9 +541,53 @@ var Products = class {
 };
 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 ?? 0,
+    originalPrice,
+    isFree: isFreeDiscount,
+    isDiscounted
+  };
+}
+function findAutomaticProductDiscount({
+  productId,
+  priceInCents,
+  discounts
+}) {
+  const discount = getHighestDiscount(productId, priceInCents, discounts);
+  const result = calculateDiscountAmount(priceInCents, discount);
+  return { ...result, discount };
+}
+
 // src/index.ts
 function createBetterStore(config) {
   if (!config.apiKey) {
@@ -564,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.2",
+  "version": "0.6.4",
   "private": false,
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -18,7 +18,7 @@
     "@betterstore/typescript-config": "0.0.0"
   },
   "dependencies": {
-    "@betterstore/bridge": "^0.0.23",
+    "@betterstore/bridge": "^0.0.24",
     "axios": "^1.8.2",
     "zod": "^3.24.2"
   },