@caldik/client 0.1.1 → 0.1.3

package/README.md

@@ -1,81 +1,339 @@
-# Caldik SDK
-
-## Caldik-hosted storefront
-
-No credentials or store configuration are required:
-
-```ts
-import { CaldikClient } from "@caldik/client"
-
-const caldik = new CaldikClient()
-const { products } = await caldik.products.list()
-```
-
-## External server
-
-External integrations explicitly provide the store ID and a private `sk_` API
-key:
-
-```ts
-const caldik = new CaldikClient({
-  storeId: "STORE_...",
-  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.login("customer@example.com")
-await caldik.customer.login.verify(code) // Six-digit code sent by email.
-```
-
-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()
-```
+# Caldik SDK
+
+The official Caldik SDK for interacting with Caldik storefronts, products, carts, checkouts, and customer accounts.
+
+## Installation
+
+```bash
+npm install @caldik/client
+```
+
+## Getting Started
+
+### Caldik-hosted Storefront
+
+No credentials or store configuration are required when running inside a Caldik-hosted storefront.
+
+```ts
+import { CaldikClient } from "@caldik/client"
+
+const caldik = new CaldikClient()
+
+const { products } = await caldik.products.list()
+```
+
+### External Server
+
+External integrations must explicitly provide a store ID and a private `sk_` API key.
+
+```ts
+import { CaldikClient } from "@caldik/client"
+
+const caldik = new CaldikClient({
+  storeId: "STORE_...",
+  apiKey: process.env.CALDIK_PRIVATE_API_KEY,
+})
+```
+
+> **Security:** Private API keys must only be used in trusted server-side environments. Never expose `sk_` keys in client-side code.
+
+## Orders and Items
+
+### Categories
+
+Retrieve categories associated with the current store.
+
+**Basic usage**
+
+```ts
+const { categories } = await caldik.categories.list()
+```
+
+**Limit results**
+
+Pass a number to limit the number of categories returned.
+
+```ts
+const { categories } = await caldik.categories.list(20)
+```
+
+**Advanced usage**
+
+Use an options object to configure the limit and request additional fields.
+
+```ts
+const { categories } = await caldik.categories.list({
+  limit: 20,
+  include: ["productCount", "startingPrice"],
+})
+```
+
+The following fields are omitted by default unless explicitly requested using `include`:
+
+| Field | Description |
+|---|---|
+| `productCount` | Number of products associated with the category. |
+| `startingPrice` | Lowest available product price in the category, in cents. |
+
+## Cart and Discounts
+
+### Cart Management
+
+Add products to the cart, update quantities, or remove items.
+
+**Add an item**
+
+```ts
+const cart = caldik.cart.add({
+  productId: "PRODUCT_...",
+  productVariantId: "PRODUCT_VARIANT_...",
+  quantity: 1,
+})
+```
+
+**Update item quantity**
+
+```ts
+caldik.cart.updateQuantity(cart.items[0].id, 3)
+```
+
+**Remove an item**
+
+```ts
+caldik.cart.remove(cart.items[0].id)
+```
+
+### Apply Discounts
+
+Apply a discount code to the current cart.
+
+```ts
+await caldik.cart.applyDiscount("SAVE10")
+```
+
+### Checkout
+
+Create a checkout session using the current cart or explicitly provided items.
+
+```ts
+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",
+})
+```
+
+### Validate Discounts
+
+If your application manages its own cart instead of using the SDK's built-in cart management, validate discount codes directly.
+
+```ts
+const result = await caldik.discounts.check({
+  code,
+  items,
+})
+```
+
+## Customer Authentication
+
+Caldik supports email-based magic code authentication and optional password authentication.
+
+Username authentication is available through the **Customer Usernames** plugin.
+
+### Magic Code Login
+
+Customers can log in using a six-digit verification code sent to their email address.
+
+**Send a verification code**
+
+```ts
+await caldik.customer.login("customer@example.com")
+```
+
+Alternatively, use an options object to configure the session.
+
+```ts
+await caldik.customer.login({
+  email: "customer@example.com",
+  rememberMe: true, // Optional, defaults to false
+})
+```
+
+**Verify the code**
+
+```ts
+await caldik.customer.login.verify(code)
+```
+
+### Email and Password Login
+
+Email and password authentication requires password login to be enabled in the store dashboard.
+
+```ts
+await caldik.customer.login({
+  email: "customer@example.com",
+  password,
+  rememberMe: true, // Optional, defaults to false
+})
+```
+
+### Username and Password Login
+
+Username authentication requires the **Customer Usernames** plugin to be installed and enabled.
+
+Once installed, customers can authenticate using their username instead of their email address.
+
+```ts
+await caldik.customer.login({
+  username: "customer",
+  password,
+  rememberMe: true, // Optional, defaults to false
+})
+```
+
+> **Note:** Username authentication requires both the Customer Usernames plugin and password authentication to be enabled.
+
+### Session Duration
+
+All customer authentication methods support the optional `rememberMe` parameter.
+
+| `rememberMe` | Session Duration |
+|---|---|
+| `false` (default) | 24 hours |
+| `true` | 30 days |
+
+Omit `rememberMe` to use the default session duration.
+
+### Session Check
+
+Retrieve the current customer's authentication status, account details, and session expiration.
+
+```ts
+const {
+  authenticated,
+  customer,
+  expiresAt,
+} = await caldik.customer.session()
+```
+
+### Password Reset
+
+Customers can reset their passwords using a verification code sent to their email address.
+
+**Request a password reset**
+
+```ts
+const { challengeId } =
+  await caldik.customer.password.requestReset(email)
+```
+
+Password reset codes expire after **10 minutes**.
+
+**Reset the password**
+
+```ts
+await caldik.customer.password.reset({
+  challengeId,
+  code,
+  password: newPassword,
+})
+```
+
+## Customer Registration
+
+Customers can register using their email address, with optional password and username support.
+
+All registrations require email verification before the account is activated.
+
+Password registration must be enabled in the store dashboard.
+
+### Email Registration
+
+Register a customer using their email address and password.
+
+**Register a customer**
+
+```ts
+await caldik.customer.register({
+  email: "customer@example.com",
+  password,
+})
+```
+
+**Verify the email address**
+
+```ts
+await caldik.customer.register.verify(code)
+```
+
+### Email and Username Registration
+
+To register customers with a username, install and enable the **Customer Usernames** plugin.
+
+Once installed, the registration endpoint accepts an additional `username` field.
+
+**Register a customer with a username**
+
+```ts
+await caldik.customer.register({
+  email: "customer@example.com",
+  password,
+  username: "customer",
+})
+```
+
+**Verify the email address**
+
+```ts
+await caldik.customer.register.verify(code)
+```
+
+> **Note:** The `username` field is provided by the Customer Usernames plugin. Omit this field when the plugin is not installed.
+
+## Payment Methods and Settings
+
+Retrieve customer authentication settings, checkout configuration, and available payment methods.
+
+### Customer Settings
+
+Retrieve the store's customer authentication settings.
+
+```ts
+const { settings: loginSettings } = await caldik.customer.settings.get()
+```
+
+### Checkout Settings
+
+Retrieve the store's checkout configuration.
+
+```ts
+const { settings: checkoutSettings } = await caldik.checkout.settings.get()
+```
+
+### Available Payment Methods
+
+Retrieve the payment methods available for checkout.
+
+```ts
+const { paymentMethods } = await caldik.checkout.paymentmethods.list()
+```
+
+### Combined Example
+
+Retrieve customer settings, checkout settings, and available payment methods together.
+
+```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

@@ -24,7 +24,10 @@ interface Category {
   name: string;
   slug: string;
   description: string;
-  price: string;
+  /** Present when startingPrice is included. Prefer startingPrice. */
+  price?: string;
+  productCount?: number;
+  startingPrice?: string | null;
   logo: string | null;
   banner: string | null;
   metadata: CategoryMetadata[];
@@ -33,6 +36,11 @@ interface CategoriesResponse {
   success: boolean;
   categories: Category[];
 }
+type CategoryInclude = "productCount" | "startingPrice" | "product count" | "starting price";
+interface CategoryListOptions {
+  limit?: number;
+  include?: readonly CategoryInclude[];
+}
 interface CategoryProduct {
   id: string;
   name: string;
@@ -139,16 +147,19 @@ interface ManualCommerceItem {
   unitAmount: string | number;
 }
 interface ProductCommerceItem {
+  customFields?: Record<string, string | number | boolean>;
   productId: string;
   productVariantId?: string;
   quantity?: number;
 }
 type CommerceItem = ManualCommerceItem | ProductCommerceItem;
 interface CreateOrderInput {
+  uiMode?: "hosted" | "elements";
+  returnUrl?: string;
   customerId?: string;
   email?: string;
   termsAccepted?: boolean;
-  paymentMethod: CheckoutPaymentProviderId;
+  paymentMethod?: CheckoutPaymentProviderId;
   items: CommerceItem[];
   discountCode?: string;
   successUrl?: string;
@@ -157,10 +168,8 @@ interface CreateOrderInput {
 interface StorefrontOrder {
   id: string;
   shortId: string;
-  displayId: string;
   customerId: string | null;
   paymentStatus: string;
-  fulfillmentStatus: string;
   subtotal: string;
   amount: string;
   discount: {
@@ -171,6 +180,8 @@ interface StorefrontOrder {
   currency: string;
 }
 interface CheckoutPayment {
+  clientSecret?: string;
+  publishableKey?: string;
   type: CheckoutPaymentProviderId;
   checkoutUrl?: string | null;
   checkoutSessionId?: string | null;
@@ -223,23 +234,83 @@ interface StoreWebhookEvent<TObject extends Record<string, unknown> = Record<str
 }
 interface CustomerLoginResponse {
   success: boolean;
-  message: string;
-  loginId: string;
+  challengeId: string;
 }
 interface CustomerLoginVerifyResponse {
+  session?: {
+    token: string;
+    expiresAt: number;
+  };
   success: boolean;
+}
+interface CustomerPasswordResponse extends CustomerLoginVerifyResponse {
   customer: {
     id: string;
     shortId: string;
     displayId: string;
     email: string | null;
     status: string;
+    extensions?: Record<string, Record<string, string | number | boolean>>;
   };
 }
-interface CustomerPasswordInput {
+type CustomerPasswordInput = ({
   username: string;
+  email?: never;
+} | {
+  email: string;
+  username?: never;
+}) & {
+  password: string;
+  rememberMe?: boolean;
+};
+interface CustomerEmailLoginInput {
+  email: string;
+  rememberMe?: boolean;
+}
+interface CustomerSessionResponse {
+  success: boolean;
+  authenticated: boolean;
+  customer: {
+    id: string;
+    email: string | null;
+  } | null;
+  expiresAt: number | null;
+}
+interface CustomerPasswordResetResponse extends CustomerLoginResponse {
+  expiresAt: number;
+  message: string;
+}
+interface CustomerPasswordResetInput {
+  challengeId?: string;
+  code: string;
   password: string;
 }
+interface CustomerPasswordResetVerifyResponse {
+  success: boolean;
+  message: string;
+}
+interface CustomerRegistrationInput {
+  email: string;
+  password?: string;
+  /** Available when the store installs Customer Usernames. */
+  username?: string;
+  [pluginField: string]: string | number | boolean | undefined;
+}
+interface CustomerRegistrationResponse extends CustomerLoginResponse {
+  expiresAt: number;
+}
+interface CustomerProfileResponse {
+  success: boolean;
+  customer: {
+    id: string;
+    email: string | null;
+    extensions?: Record<string, Record<string, string | number | boolean>>;
+  };
+  balances: Array<{
+    currency: string;
+    amount: string;
+  }>;
+}
 interface CustomerLoginSettings {
   passwordEnabled: boolean;
 }
@@ -248,6 +319,9 @@ interface CustomerLoginSettingsResponse {
   settings: CustomerLoginSettings;
 }
 interface CheckoutSettings {
+  termsUrl?: string | null;
+  refundPolicyUrl?: string | null;
+  embedStripeMode: "elements" | "hosted" | "popup";
   requireEmail: boolean;
   requireTermsAcceptance: boolean;
 }
@@ -299,7 +373,7 @@ declare class CaldikHttpClient {
 declare class CategoriesApi {
   private client;
   constructor(client: CaldikHttpClient);
-  list(limit?: number): Promise<CategoriesResponse>;
+  list(options?: number | CategoryListOptions): Promise<CategoriesResponse>;
   get(categoryId: string): Promise<CategoryResponse>;
 }
 //#endregion
@@ -346,14 +420,29 @@ declare class CustomerApi {
     get: () => Promise<CustomerLoginSettingsResponse>;
   };
   readonly login: {
-    (email: string): Promise<CustomerLoginResponse>;
-    (input: CustomerPasswordInput): Promise<CustomerLoginVerifyResponse>;
+    (email: string, options?: {
+      rememberMe?: boolean;
+    }): Promise<CustomerLoginResponse>;
+    (input: CustomerEmailLoginInput): Promise<CustomerLoginResponse>;
+    (input: CustomerPasswordInput): Promise<CustomerPasswordResponse>;
+  } & {
+    /** Pass challengeId to resume a code request after reloading the page. */verify: (code: string, challengeId?: string | undefined) => Promise<CustomerLoginVerifyResponse>;
+  };
+  readonly register: {
+    (email: string): Promise<CustomerRegistrationResponse>;
+    (input: CustomerRegistrationInput): Promise<CustomerRegistrationResponse>;
   } & {
-    /** Pass loginId to resume a code request after reloading the page. */verify: (code: string, loginId?: string | undefined) => Promise<CustomerLoginVerifyResponse>;
+    /** Verify the email and atomically activate the account. Supports resuming after a reload. */verify: (code: string, challengeId?: string | undefined) => Promise<CustomerPasswordResponse>;
+  };
+  readonly password: {
+    requestReset: (email: string) => Promise<CustomerPasswordResetResponse>;
+    reset: (input: CustomerPasswordResetInput) => Promise<CustomerPasswordResetVerifyResponse>;
   };
   constructor(client: CaldikHttpClient);
-  /** Set or reset credentials after signing in with an email code. Requires a customer session. */
-  setPassword(input: CustomerPasswordInput): Promise<CustomerLoginVerifyResponse>;
+  /** Check a store-scoped session without raising an error for signed-out customers. */
+  session(): Promise<CustomerSessionResponse>;
+  /** Read the signed-in customer and their balances. */
+  me(): Promise<CustomerProfileResponse>;
 }
 //#endregion
 //#region src/subscriptions.d.ts
@@ -446,4 +535,4 @@ declare class CaldikClient {
   constructor(options?: CaldikClientOptions);
 }
 //#endregion
-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 };
+export { AppliedDiscount, CaldikClient, CaldikClientOptions, CartApi, CartCheckoutInput, CartDiscount, CartItem, CartSnapshot, CategoriesResponse, Category, CategoryDetails, CategoryInclude, CategoryListOptions, CategoryMetadata, CategoryProduct, CategoryResponse, CheckDiscountInput, CheckoutPayment, CheckoutPaymentMethod, CheckoutPaymentMethodsResponse, CheckoutPaymentProviderId, CheckoutSettings, CheckoutSettingsResponse, CommerceItem, CreateOrderInput, CreateSubscriptionInput, CustomerEmailLoginInput, CustomerLoginResponse, CustomerLoginSettings, CustomerLoginSettingsResponse, CustomerLoginVerifyResponse, CustomerPasswordInput, CustomerPasswordResetInput, CustomerPasswordResetResponse, CustomerPasswordResetVerifyResponse, CustomerPasswordResponse, CustomerProfileResponse, CustomerRegistrationInput, CustomerRegistrationResponse, CustomerSessionResponse, 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

@@ -110,8 +110,12 @@ var CategoriesApi = class {
 	constructor(client) {
 		this.client = client;
 	}
-	list(limit) {
-		return this.client.get("/categories", limit ? { limit } : void 0, { access: "public" });
+	list(options) {
+		const { limit, include } = typeof options === "number" ? { limit: options } : options ?? {};
+		return this.client.get("/categories", {
+			...limit !== void 0 ? { limit } : {},
+			...include?.length ? { include: include.join(",") } : {}
+		}, { access: "public" });
 	}
 	get(categoryId) {
 		return this.client.get(`/categories/${categoryId}`, void 0, { access: "public" });
@@ -177,32 +181,78 @@ var CustomerApi = class {
 	client;
 	settings;
 	login;
+	register;
+	password;
 	constructor(client) {
 		this.client = client;
 		this.settings = { get: () => this.client.get("/customers/settings", void 0, { access: "public" }) };
-		let pendingLoginId;
-		async function login(input) {
-			if (typeof input !== "string") return client.post("/customers/login/password", input, { access: "public" });
-			const response = await client.post("/customers/login", { email: input }, { access: "public" });
-			pendingLoginId = response.loginId;
+		let pendingResetId;
+		this.password = {
+			requestReset: async (email) => {
+				const response = await client.post("/customers/password/reset", { email }, { access: "public" });
+				pendingResetId = response.challengeId;
+				return response;
+			},
+			reset: async (input) => {
+				const challengeId = input.challengeId ?? pendingResetId;
+				if (!challengeId) throw new Error("Request a password reset first or provide its challengeId");
+				if (!/^\d{6}$/.test(input.code)) throw new Error("A six-digit reset code is required");
+				const response = await client.post("/customers/password/reset/verify", {
+					...input,
+					challengeId
+				}, { access: "public" });
+				if (pendingResetId === challengeId) pendingResetId = void 0;
+				return response;
+			}
+		};
+		let pendingChallengeId;
+		async function login(input, options) {
+			if (typeof input !== "string" && "password" in input) return client.post("/customers/login/password", input, { access: "public" });
+			const response = await client.post("/customers/login", typeof input === "string" ? {
+				email: input,
+				...options
+			} : input, { access: "public" });
+			pendingChallengeId = response.challengeId;
 			return response;
 		}
 		this.login = Object.assign(login, { 
-		/** Pass loginId to resume a code request after reloading the page. */
-verify: async (code, loginId = pendingLoginId) => {
+		/** Pass challengeId to resume a code request after reloading the page. */
+verify: async (code, challengeId = pendingChallengeId) => {
 			if (!/^\d{6}$/.test(code)) throw new Error("A six-digit login code is required");
-			if (!loginId) throw new Error("Request a login code first or provide its loginId");
+			if (!challengeId) throw new Error("Request a login code first or provide its challengeId");
 			const response = await client.post("/customers/login/verify", {
 				code,
-				loginId
+				challengeId
 			}, { access: "public" });
-			if (pendingLoginId === loginId) pendingLoginId = void 0;
+			if (pendingChallengeId === challengeId) pendingChallengeId = void 0;
 			return response;
 		} });
+		let pendingRegistrationId;
+		async function register(input) {
+			const response = await client.post("/customers/register", typeof input === "string" ? { email: input } : input, { access: "public" });
+			pendingRegistrationId = response.challengeId;
+			return response;
+		}
+		this.register = Object.assign(register, { 
+		/** Verify the email and atomically activate the account. Supports resuming after a reload. */
+verify: async (code, challengeId = pendingRegistrationId) => {
+			if (!/^\d{6}$/.test(code)) throw new Error("A six-digit registration code is required");
+			if (!challengeId) throw new Error("Request a registration code first or provide its challengeId");
+			const response = await client.post("/customers/register/verify", {
+				code,
+				challengeId
+			}, { access: "public" });
+			if (pendingRegistrationId === challengeId) pendingRegistrationId = void 0;
+			return response;
+		} });
+	}
+	/** Check a store-scoped session without raising an error for signed-out customers. */
+	session() {
+		return this.client.get("/customers/session", void 0, { 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" });
+	/** Read the signed-in customer and their balances. */
+	me() {
+		return this.client.get("/customers/me", void 0, { access: "public" });
 	}
 };
 //#endregion

package/package.json

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