@caldik/client 0.0.8 → 0.1.0

package/README.md

@@ -22,3 +22,60 @@ const caldik = new CaldikClient({
   apiKey: process.env.CALDIK_PRIVATE_API_KEY,
 })
 ```
+
+## Cart and discounts
+
+
+```ts
+const cart = caldik.cart.add({
+  productId: "PRODUCT_...",
+  productVariantId: "PRODUCT_VARIANT_...",
+  quantity: 1,
+})
+
+caldik.cart.updateQuantity(cart.items[0].id, 3)
+caldik.cart.remove(cart.items[0].id)
+```
+
+```ts
+await caldik.cart.applyDiscount("SAVE10")
+
+const result = await caldik.cart.checkout({
+  paymentMethod: "stripe",
+  items: [{ productId, productVariantId, quantity: 1 }],
+  termsAccepted: acceptedTermsCheckbox,
+  successUrl: "https://shop.example/success",
+  cancelUrl: "https://shop.example/cart",
+})
+```
+
+Use `caldik.discounts.check({ code, items })` when a cart should be managed by
+the application instead of the SDK.
+
+
+## Customer Logins
+
+Magic Code
+```ts
+await caldik.customer.requestLogin("customer@example.com")
+await caldik.customer.verifyLogin(code)
+```
+
+Username / Email Password ( if password login is enabled )
+```ts
+await caldik.customer.login({ username: "customer", password })
+```
+
+if you are logged in using magic code you can just do 
+ - this to enroll the customers account into username / email password login ( password login needs to be enabled in the dashboard )
+```ts
+await caldik.customer.setPassword({ username: "customer", password })
+```
+
+## Payment methods and Settings
+
+```ts
+const { settings: loginSettings } = await caldik.customer.settings.get()
+const { settings: checkoutSettings } = await caldik.checkout.settings.get()
+const { paymentMethods } = await caldik.checkout.paymentmethods.list()
+```

package/dist/index.d.mts

@@ -99,6 +99,7 @@ interface Product {
 interface ProductVariant {
   id: string;
   name: string;
+  position: number;
   price: string;
   compareAtPrice: string | null;
 }
@@ -146,8 +147,10 @@ type CommerceItem = ManualCommerceItem | ProductCommerceItem;
 interface CreateOrderInput {
   customerId?: string;
   email?: string;
+  termsAccepted?: boolean;
   paymentMethod: CheckoutPaymentProviderId;
   items: CommerceItem[];
+  discountCode?: string;
   successUrl?: string;
   cancelUrl?: string;
 }
@@ -158,7 +161,13 @@ interface StorefrontOrder {
   customerId: string | null;
   paymentStatus: string;
   fulfillmentStatus: string;
+  subtotal: string;
   amount: string;
+  discount: {
+    code: string;
+    percentage: string;
+    amount: string;
+  } | null;
   currency: string;
 }
 interface CheckoutPayment {
@@ -202,18 +211,6 @@ interface SubscriptionResponse {
     checkoutSessionId: string;
   };
 }
-interface StoreWebhookEventDefinition {
-  name: StoreWebhookEventName;
-  resource: string;
-  action: string;
-  description: string;
-}
-interface StoreWebhookEventsResponse {
-  success: boolean;
-  apiVersion: "v1";
-  catalogVersion: string;
-  events: StoreWebhookEventDefinition[];
-}
 interface StoreWebhookEvent<TObject extends Record<string, unknown> = Record<string, unknown>> {
   id: string;
   type: StoreWebhookEventName;
@@ -234,10 +231,43 @@ interface CustomerLoginVerifyResponse {
     id: string;
     shortId: string;
     displayId: string;
-    email: string;
+    email: string | null;
     status: string;
   };
 }
+interface CustomerPasswordInput {
+  username: string;
+  password: string;
+}
+interface CustomerLoginSettings {
+  passwordEnabled: boolean;
+}
+interface CustomerLoginSettingsResponse {
+  success: boolean;
+  settings: CustomerLoginSettings;
+}
+interface CheckoutSettings {
+  requireEmail: boolean;
+  requireTermsAcceptance: boolean;
+}
+interface CheckoutSettingsResponse {
+  success: boolean;
+  settings: CheckoutSettings;
+}
+interface CheckoutPaymentMethod {
+  id: CheckoutPaymentProviderId;
+  label: string;
+  description: string;
+  checkout: {
+    kind: "internal" | "redirect";
+    requiresCustomerEmail: boolean;
+  };
+  requiresCustomerLogin: boolean;
+}
+interface CheckoutPaymentMethodsResponse {
+  success: boolean;
+  paymentMethods: CheckoutPaymentMethod[];
+}
 //#endregion
 //#region src/internal/types.d.ts
 interface RequestOptions {
@@ -257,6 +287,7 @@ declare class CaldikHttpClient {
   private readonly apiUrl;
   private readonly storeId?;
   constructor(options?: HttpClientOptions);
+  storeContextId(): string | null;
   private baseUrl;
   private request;
   get<T>(path: string, params?: Record<string, string | number>, options?: RequestOptions): Promise<T>;
@@ -276,7 +307,7 @@ declare class ProductsApi {
   private client;
   constructor(client: CaldikHttpClient);
   list(): Promise<ProductsResponse>;
-  get(productId: string): Promise<ProductResponse>;
+  get(productIdOrSlug: string): Promise<ProductResponse>;
 }
 //#endregion
 //#region src/reviews.d.ts
@@ -296,6 +327,12 @@ declare class StoreApi {
 //#region src/checkout.d.ts
 declare class CheckoutApi {
   private client;
+  readonly paymentmethods: {
+    list: () => Promise<CheckoutPaymentMethodsResponse>;
+  };
+  readonly settings: {
+    get: () => Promise<CheckoutSettingsResponse>;
+  };
   constructor(client: CaldikHttpClient);
   create(input: CreateOrderInput): Promise<OrderResponse>;
   payWithBalance(orderId: string): Promise<OrderResponse>;
@@ -304,7 +341,13 @@ declare class CheckoutApi {
 //#region src/customer.d.ts
 declare class CustomerApi {
   private client;
+  readonly settings: {
+    get: () => Promise<CustomerLoginSettingsResponse>;
+  };
   constructor(client: CaldikHttpClient);
+  login(input: CustomerPasswordInput): Promise<CustomerLoginVerifyResponse>;
+  /** Set or reset credentials after signing in with an email code. Requires a customer session. */
+  setPassword(input: CustomerPasswordInput): Promise<CustomerLoginVerifyResponse>;
   requestLogin(email: string): Promise<CustomerLoginResponse>;
   verifyLogin(code: string): Promise<CustomerLoginVerifyResponse>;
 }
@@ -316,12 +359,66 @@ declare class SubscriptionsApi {
   create(input: CreateSubscriptionInput): Promise<SubscriptionResponse>;
 }
 //#endregion
-//#region src/webhooks.d.ts
-declare class WebhooksApi {
+//#region src/discounts.d.ts
+interface CheckDiscountInput {
+  code: string;
+  items: CommerceItem[];
+}
+interface AppliedDiscount {
+  code: string;
+  percentage: string;
+}
+interface DiscountQuoteResponse {
+  success: boolean;
+  discount: AppliedDiscount;
+  subtotal: string;
+  discountAmount: string;
+  total: string;
+  currency: string;
+}
+declare class DiscountsApi {
+  private client;
+  constructor(client: CaldikHttpClient);
+  check(input: CheckDiscountInput): Promise<DiscountQuoteResponse>;
+}
+//#endregion
+//#region src/cart.d.ts
+interface CartItem {
+  id: string;
+  productId: string;
+  productVariantId?: string;
+  quantity: number;
+}
+interface CartDiscount {
+  code: string;
+  percentage: string;
+  subtotal: string;
+  discountAmount: string;
+  total: string;
+  currency: string;
+}
+interface CartSnapshot {
+  items: CartItem[];
+  discount: CartDiscount | null;
+}
+type CartCheckoutInput = Omit<CreateOrderInput, "items" | "discountCode">;
+declare class CartApi {
   private client;
+  private memory;
   constructor(client: CaldikHttpClient);
-  /** Lists the canonical events accepted by store webhook subscriptions. */
-  events(): Promise<StoreWebhookEventsResponse>;
+  private storageKey;
+  private read;
+  private write;
+  get(): CartSnapshot;
+  add(item: ProductCommerceItem): CartSnapshot;
+  updateQuantity(itemId: string, nextQuantity: number): CartSnapshot;
+  remove(itemId: string): CartSnapshot;
+  clear(): CartSnapshot;
+  private commerceItems;
+  checkDiscount(code: string): Promise<DiscountQuoteResponse>;
+  applyDiscount(code: string): Promise<CartSnapshot>;
+  removeDiscount(): CartSnapshot;
+  checkout(input: CartCheckoutInput): Promise<OrderResponse>;
 }
 //#endregion
 //#region src/index.d.ts
@@ -340,8 +437,9 @@ declare class CaldikClient {
   readonly checkout: CheckoutApi;
   readonly customer: CustomerApi;
   readonly subscriptions: SubscriptionsApi;
-  readonly webhooks: WebhooksApi;
+  readonly discounts: DiscountsApi;
+  readonly cart: CartApi;
   constructor(options?: CaldikClientOptions);
 }
 //#endregion
-export { CaldikClient, CaldikClientOptions, CategoriesResponse, Category, CategoryDetails, CategoryMetadata, CategoryProduct, CategoryResponse, CheckoutPayment, CheckoutPaymentProviderId, CommerceItem, CreateOrderInput, CreateSubscriptionInput, CustomerLoginResponse, CustomerLoginVerifyResponse, ManualCommerceItem, OrderResponse, PaymentProviderId, Product, ProductCommerceItem, ProductCustomField, ProductCustomFieldInputType, ProductCustomFieldOption, ProductMetadata, ProductResponse, ProductTag, ProductVariant, ProductsResponse, Review, ReviewsResponse, Store, StoreResponse, StoreWebhookEvent, StoreWebhookEventDefinition, StoreWebhookEventName, StoreWebhookEventsResponse, StorefrontMetadata, StorefrontOrder, SubscriptionPaymentProviderId, SubscriptionResponse, checkoutPaymentProviderIds, paymentProviderIds, storeWebhookEventNames, subscriptionPaymentProviderIds };
+export { AppliedDiscount, CaldikClient, CaldikClientOptions, CartApi, CartCheckoutInput, CartDiscount, CartItem, CartSnapshot, CategoriesResponse, Category, CategoryDetails, CategoryMetadata, CategoryProduct, CategoryResponse, CheckDiscountInput, CheckoutPayment, CheckoutPaymentMethod, CheckoutPaymentMethodsResponse, CheckoutPaymentProviderId, CheckoutSettings, CheckoutSettingsResponse, CommerceItem, CreateOrderInput, CreateSubscriptionInput, CustomerLoginResponse, CustomerLoginSettings, CustomerLoginSettingsResponse, CustomerLoginVerifyResponse, CustomerPasswordInput, DiscountQuoteResponse, DiscountsApi, ManualCommerceItem, OrderResponse, PaymentProviderId, Product, ProductCommerceItem, ProductCustomField, ProductCustomFieldInputType, ProductCustomFieldOption, ProductMetadata, ProductResponse, ProductTag, ProductVariant, ProductsResponse, Review, ReviewsResponse, Store, StoreResponse, StoreWebhookEvent, StoreWebhookEventName, StorefrontMetadata, StorefrontOrder, SubscriptionPaymentProviderId, SubscriptionResponse, checkoutPaymentProviderIds, paymentProviderIds, storeWebhookEventNames, subscriptionPaymentProviderIds };

package/dist/index.mjs

@@ -8,7 +8,6 @@ function firstValue(...values) {
 function importMetaEnvironment() {
 	return import.meta.env;
 }
-/** Public context exposed by Next/Vinext, Vite, or Astro during `caldik dev`. */
 function browserBuildStoreId() {
 	const environment = importMetaEnvironment();
 	return firstValue(typeof process === "undefined" ? void 0 : process.env.NEXT_PUBLIC_CALDIK_STORE_ID, environment?.VITE_CALDIK_STORE_ID, environment?.PUBLIC_CALDIK_STORE_ID);
@@ -58,6 +57,9 @@ var CaldikHttpClient = class {
 		if (isBrowserRuntime() && this.apiKey) throw new Error("Caldik private API keys cannot be used in browser code");
 		this.storeId = configuredStoreId || (isBrowserRuntime() ? browserRuntimeStoreId() || void 0 : void 0);
 	}
+	storeContextId() {
+		return this.storeId || boundRuntimeStoreId();
+	}
 	baseUrl() {
 		if (isBrowserRuntime()) {
 			const storeId = this.storeId;
@@ -125,8 +127,8 @@ var ProductsApi = class {
 	list() {
 		return this.client.get("/products", void 0, { access: "public" });
 	}
-	get(productId) {
-		return this.client.get(`/products/${productId}`, void 0, { access: "public" });
+	get(productIdOrSlug) {
+		return this.client.get(`/products/${encodeURIComponent(productIdOrSlug)}`, void 0, { access: "public" });
 	}
 };
 //#endregion
@@ -155,8 +157,12 @@ var StoreApi = class {
 //#region src/checkout.ts
 var CheckoutApi = class {
 	client;
+	paymentmethods;
+	settings;
 	constructor(client) {
 		this.client = client;
+		this.paymentmethods = { list: () => this.client.get("/checkouts/payment-methods", void 0, { access: "public" }) };
+		this.settings = { get: () => this.client.get("/checkouts/settings", void 0, { access: "public" }) };
 	}
 	create(input) {
 		return this.client.post("/checkouts", input, { access: "public" });
@@ -169,8 +175,17 @@ var CheckoutApi = class {
 //#region src/customer.ts
 var CustomerApi = class {
 	client;
+	settings;
 	constructor(client) {
 		this.client = client;
+		this.settings = { get: () => this.client.get("/customers/settings", void 0, { access: "public" }) };
+	}
+	login(input) {
+		return this.client.post("/customers/login/password", input, { access: "public" });
+	}
+	/** Set or reset credentials after signing in with an email code. Requires a customer session. */
+	setPassword(input) {
+		return this.client.post("/customers/password", input, { access: "public" });
 	}
 	requestLogin(email) {
 		return this.client.post("/customers/login", { email }, { access: "public" });
@@ -191,15 +206,176 @@ var SubscriptionsApi = class {
 	}
 };
 //#endregion
-//#region src/webhooks.ts
-var WebhooksApi = class {
+//#region src/discounts.ts
+var DiscountsApi = class {
+	client;
+	constructor(client) {
+		this.client = client;
+	}
+	check(input) {
+		return this.client.post("/discounts/check", input, { access: "public" });
+	}
+};
+//#endregion
+//#region src/cart.ts
+const CART_VERSION = 1;
+const MAX_QUANTITY = 999999;
+function cartItemId(item) {
+	return item.productVariantId ? `${item.productId}:${item.productVariantId}` : item.productId;
+}
+function quantity(value, allowZero = false) {
+	const normalized = value ?? 1;
+	const minimum = allowZero ? 0 : 1;
+	if (!Number.isInteger(normalized) || normalized < minimum || normalized > MAX_QUANTITY) throw new Error(`Cart quantity must be an integer between ${minimum} and ${MAX_QUANTITY}`);
+	return normalized;
+}
+function cloneSnapshot(state) {
+	return {
+		items: state.items.map((item) => ({ ...item })),
+		discount: state.discount ? { ...state.discount } : null
+	};
+}
+function isCartItem(value) {
+	if (!value || typeof value !== "object") return false;
+	const item = value;
+	return typeof item.id === "string" && typeof item.productId === "string" && (item.productVariantId === void 0 || typeof item.productVariantId === "string") && typeof item.quantity === "number" && Number.isInteger(item.quantity) && item.quantity > 0 && item.quantity <= MAX_QUANTITY;
+}
+function isCartDiscount(value) {
+	if (!value || typeof value !== "object") return false;
+	const discount = value;
+	return typeof discount.code === "string" && typeof discount.percentage === "string" && typeof discount.subtotal === "string" && typeof discount.discountAmount === "string" && typeof discount.total === "string" && typeof discount.currency === "string";
+}
+var CartApi = class {
 	client;
+	memory = {
+		version: CART_VERSION,
+		items: [],
+		discount: null
+	};
 	constructor(client) {
 		this.client = client;
 	}
-	/** Lists the canonical events accepted by store webhook subscriptions. */
-	events() {
-		return this.client.get("/webhooks/events");
+	storageKey() {
+		const storeId = this.client.storeContextId();
+		return storeId ? `caldik:cart:${storeId}` : null;
+	}
+	read() {
+		const key = this.storageKey();
+		if (key && typeof localStorage !== "undefined") try {
+			const value = localStorage.getItem(key);
+			if (value) {
+				const parsed = JSON.parse(value);
+				if (parsed.version === CART_VERSION && Array.isArray(parsed.items) && parsed.items.every(isCartItem)) this.memory = {
+					version: CART_VERSION,
+					items: parsed.items,
+					discount: isCartDiscount(parsed.discount) ? parsed.discount : null
+				};
+			}
+		} catch {}
+		return this.memory;
+	}
+	write(state) {
+		this.memory = {
+			version: CART_VERSION,
+			...cloneSnapshot(state)
+		};
+		const key = this.storageKey();
+		if (key && typeof localStorage !== "undefined") try {
+			localStorage.setItem(key, JSON.stringify(this.memory));
+		} catch {}
+		return this.get();
+	}
+	get() {
+		return cloneSnapshot(this.read());
+	}
+	add(item) {
+		const productId = item.productId.trim();
+		const productVariantId = item.productVariantId?.trim() || "";
+		if (!productId) throw new Error("Cart productId is required");
+		const state = this.get();
+		const id = cartItemId({
+			productId,
+			productVariantId
+		});
+		const existing = state.items.find((entry) => entry.id === id);
+		const addedQuantity = quantity(item.quantity);
+		if (existing) existing.quantity = quantity(existing.quantity + addedQuantity);
+		else state.items.push({
+			id,
+			productId,
+			...productVariantId ? { productVariantId } : {},
+			quantity: addedQuantity
+		});
+		state.discount = null;
+		return this.write(state);
+	}
+	updateQuantity(itemId, nextQuantity) {
+		const state = this.get();
+		const normalized = quantity(nextQuantity, true);
+		const index = state.items.findIndex((item) => item.id === itemId);
+		if (index === -1) throw new Error("Cart item not found");
+		if (normalized === 0) state.items.splice(index, 1);
+		else state.items[index].quantity = normalized;
+		state.discount = null;
+		return this.write(state);
+	}
+	remove(itemId) {
+		const state = this.get();
+		const items = state.items.filter((item) => item.id !== itemId);
+		if (items.length === state.items.length) throw new Error("Cart item not found");
+		return this.write({
+			items,
+			discount: null
+		});
+	}
+	clear() {
+		return this.write({
+			items: [],
+			discount: null
+		});
+	}
+	commerceItems() {
+		return this.get().items.map(({ productId, productVariantId, quantity }) => ({
+			productId,
+			...productVariantId ? { productVariantId } : {},
+			quantity
+		}));
+	}
+	async checkDiscount(code) {
+		const items = this.commerceItems();
+		if (items.length === 0) throw new Error("Cannot check a discount on an empty cart");
+		return this.client.post("/discounts/check", {
+			code,
+			items
+		}, { access: "public" });
+	}
+	async applyDiscount(code) {
+		const quote = await this.checkDiscount(code);
+		const state = this.get();
+		state.discount = {
+			...quote.discount,
+			subtotal: quote.subtotal,
+			discountAmount: quote.discountAmount,
+			total: quote.total,
+			currency: quote.currency
+		};
+		return this.write(state);
+	}
+	removeDiscount() {
+		const state = this.get();
+		state.discount = null;
+		return this.write(state);
+	}
+	async checkout(input) {
+		const state = this.get();
+		if (state.items.length === 0) throw new Error("Cannot checkout an empty cart");
+		const response = await this.client.post("/checkouts", {
+			...input,
+			items: this.commerceItems(),
+			...state.discount ? { discountCode: state.discount.code } : {}
+		}, { access: "public" });
+		this.clear();
+		return response;
 	}
 };
 //#endregion
@@ -254,7 +430,8 @@ var CaldikClient = class {
 	checkout;
 	customer;
 	subscriptions;
-	webhooks;
+	discounts;
+	cart;
 	constructor(options = {}) {
 		const client = new CaldikHttpClient({
 			apiKey: options.apiKey,
@@ -268,8 +445,9 @@ var CaldikClient = class {
 		this.checkout = new CheckoutApi(client);
 		this.customer = new CustomerApi(client);
 		this.subscriptions = new SubscriptionsApi(client);
-		this.webhooks = new WebhooksApi(client);
+		this.discounts = new DiscountsApi(client);
+		this.cart = new CartApi(client);
 	}
 };
 //#endregion
-export { CaldikClient, checkoutPaymentProviderIds, paymentProviderIds, storeWebhookEventNames, subscriptionPaymentProviderIds };
+export { CaldikClient, CartApi, DiscountsApi, checkoutPaymentProviderIds, paymentProviderIds, storeWebhookEventNames, subscriptionPaymentProviderIds };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caldik/client",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "type": "module",
   "main": "./dist/index.mjs",
   "types": "./dist/index.d.mts",