@caldik/client 0.0.9 → 0.1.1

package/README.md

@@ -42,6 +42,8 @@ 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",
 })
@@ -50,3 +52,30 @@ const result = await caldik.cart.checkout({
 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()
+```

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,6 +147,7 @@ type CommerceItem = ManualCommerceItem | ProductCommerceItem;
 interface CreateOrderInput {
   customerId?: string;
   email?: string;
+  termsAccepted?: boolean;
   paymentMethod: CheckoutPaymentProviderId;
   items: CommerceItem[];
   discountCode?: string;
@@ -222,6 +224,7 @@ interface StoreWebhookEvent<TObject extends Record<string, unknown> = Record<str
 interface CustomerLoginResponse {
   success: boolean;
   message: string;
+  loginId: string;
 }
 interface CustomerLoginVerifyResponse {
   success: boolean;
@@ -229,10 +232,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 {
@@ -272,7 +308,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
@@ -292,6 +328,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>;
@@ -300,9 +342,18 @@ declare class CheckoutApi {
 //#region src/customer.d.ts
 declare class CustomerApi {
   private client;
+  readonly settings: {
+    get: () => Promise<CustomerLoginSettingsResponse>;
+  };
+  readonly login: {
+    (email: string): Promise<CustomerLoginResponse>;
+    (input: CustomerPasswordInput): Promise<CustomerLoginVerifyResponse>;
+  } & {
+    /** Pass loginId to resume a code request after reloading the page. */verify: (code: string, loginId?: string | undefined) => Promise<CustomerLoginVerifyResponse>;
+  };
   constructor(client: CaldikHttpClient);
-  requestLogin(email: string): Promise<CustomerLoginResponse>;
-  verifyLogin(code: string): Promise<CustomerLoginVerifyResponse>;
+  /** Set or reset credentials after signing in with an email code. Requires a customer session. */
+  setPassword(input: CustomerPasswordInput): Promise<CustomerLoginVerifyResponse>;
 }
 //#endregion
 //#region src/subscriptions.d.ts
@@ -395,4 +446,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, CheckoutPaymentProviderId, CommerceItem, CreateOrderInput, CreateSubscriptionInput, CustomerLoginResponse, CustomerLoginVerifyResponse, 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, 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

@@ -127,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
@@ -157,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" });
@@ -171,14 +175,34 @@ var CheckoutApi = class {
 //#region src/customer.ts
 var CustomerApi = class {
 	client;
+	settings;
+	login;
 	constructor(client) {
 		this.client = client;
-	}
-	requestLogin(email) {
-		return this.client.post("/customers/login", { email }, { access: "public" });
-	}
-	verifyLogin(code) {
-		return this.client.post("/customers/login/verify", { code }, { access: "public" });
+		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;
+			return response;
+		}
+		this.login = Object.assign(login, { 
+		/** Pass loginId to resume a code request after reloading the page. */
+verify: async (code, loginId = pendingLoginId) => {
+			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");
+			const response = await client.post("/customers/login/verify", {
+				code,
+				loginId
+			}, { access: "public" });
+			if (pendingLoginId === loginId) pendingLoginId = void 0;
+			return response;
+		} });
+	}
+	/** 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" });
 	}
 };
 //#endregion

package/package.json

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