@caldik/client 0.1.4 → 0.1.6

package/README.md

@@ -59,14 +59,59 @@ const { products } = await caldik.products.list(20)
 
 ### Get Product
 
-Retrieve a specific product by its ID.
+Retrieve a visible product by its ID or slug. Product IDs are unambiguous. The
+same slug can be used in different categories, but must be unique within a
+category. Uncategorized products have their own shared slug namespace.
 
 **Basic usage**
 
 ```ts
-const { product } = await caldik.products.get("product_123")
+const { product } = await caldik.products.get("PRODUCT_...")
 ```
 
+**Get a product by category and slug**
+
+Pass a category ID or slug when the product slug is shared across categories.
+
+```ts
+const { product: rustProduct } = await caldik.products.get("stealth", {
+  category: "test2",
+})
+
+const { product: testProduct } = await caldik.products.get("stealth", {
+  category: "test",
+})
+```
+
+**Get a product by a unique slug**
+
+```ts
+const { product } = await caldik.products.get("unique-product")
+```
+
+### Get Store
+
+**Get the store profile and statistics**
+
+```ts
+const { store } = await caldik.store.get()
+
+console.log(store.name)
+console.log(store.averageRating) // e.g. 4.9; null when there are no reviews
+console.log(store.orders) // integer count of all store order records
+console.log(store.customers) // integer count of all customer records, including guests
+```
+
+**Read the store's social links**
+
+```ts
+const { store } = await caldik.store.get()
+
+const { instagram, tiktok, x, youtube, discord, telegram } = store.socials
+```
+
+Socials are included in the same response. Each unconfigured link is `null`.
+
 ### Get Category
 
 Retrieve a specific category by its ID.
@@ -218,6 +263,10 @@ a storefront API proxy). Cookies set only on a separate API hostname are not
 included in requests to the storefront server. A private store key does not
 replace a shopper's customer session.
 
+Customer and cart cookies are scoped to the storefront origin. When you pass
+`request`, the SDK forwards its `Origin` header, or the request URL's origin when
+that header is absent, so server calls use the same session as the storefront.
+
 ### Checkout with Explicit Items
 
 Use `caldik.checkout.create()` to create an order from explicitly provided items.

package/dist/index.d.mts

@@ -70,6 +70,25 @@ interface CategoryResponse {
 interface Store {
   name: string;
   description: string;
+  /** Average of all store reviews, rounded to one decimal; null without reviews. */
+  averageRating: number | null;
+  /** All store order records, including unpaid, failed and refunded orders. */
+  orders: number;
+  /** All store customer records, including guest customers. */
+  customers: number;
+  socials: StoreSocials;
+}
+interface StoreSocials {
+  instagram: string | null;
+  tiktok: string | null;
+  x: string | null;
+  youtube: string | null;
+  discord: string | null;
+  telegram: string | null;
+}
+interface ProductGetOptions {
+  /** Category ID or slug. Required for a slug used in multiple categories. */
+  category?: string;
 }
 interface StoreResponse {
   success: boolean;
@@ -99,6 +118,7 @@ interface Product {
   deliveryType: string;
   minimumQuantity: number | null;
   maximumQuantity: number | null;
+  images: ProductImage[];
   variants: ProductVariant[];
   tags: ProductTag[];
   customFields: ProductCustomField[];
@@ -110,6 +130,13 @@ interface ProductVariant {
   position: number;
   price: string;
   compareAtPrice: string | null;
+  images: ProductImage[];
+}
+interface ProductImage {
+  id: string;
+  url: string;
+  alt: string | null;
+  position: number;
 }
 interface ProductTag {
   label: string;
@@ -367,6 +394,7 @@ declare class CaldikHttpClient {
   private readonly storeId?;
   private readonly cookies;
   private readonly onSetCookie?;
+  private readonly storefrontOrigin?;
   private readonly authenticationListeners;
   constructor(options?: HttpClientOptions);
   storeContextId(): string | null;
@@ -393,7 +421,7 @@ declare class ProductsApi {
   private client;
   constructor(client: CaldikHttpClient);
   list(): Promise<ProductsResponse>;
-  get(productIdOrSlug: string): Promise<ProductResponse>;
+  get(productIdOrSlug: string, options?: ProductGetOptions): Promise<ProductResponse>;
 }
 //#endregion
 //#region src/reviews.d.ts
@@ -559,4 +587,4 @@ declare class CaldikClient {
   constructor(options?: CaldikClientOptions);
 }
 //#endregion
-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 };
+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, ProductGetOptions, ProductImage, ProductMetadata, ProductResponse, ProductTag, ProductVariant, ProductsResponse, Review, ReviewsResponse, Store, StoreResponse, StoreSocials, StoreWebhookEvent, StoreWebhookEventName, StorefrontMetadata, StorefrontOrder, SubscriptionPaymentProviderId, SubscriptionResponse, checkoutPaymentProviderIds, paymentProviderIds, storeWebhookEventNames, subscriptionPaymentProviderIds };

package/dist/index.mjs

@@ -47,22 +47,19 @@ function browserRuntimeStoreId() {
 	const buildStoreId = browserBuildStoreId();
 	return buildStoreId && STORE_ID_PATTERN.test(buildStoreId) ? buildStoreId : null;
 }
-function isLocalBrowserRuntime() {
-	if (!isBrowserRuntime() || typeof location === "undefined") return false;
-	const hostname = location.hostname.toLowerCase();
-	return hostname === "localhost" || hostname === "127.0.0.1" || hostname === "::1" || hostname === "[::1]";
-}
 var CaldikHttpClient = class {
 	apiKey;
 	apiUrl;
 	storeId;
 	cookies = /* @__PURE__ */ new Map();
 	onSetCookie;
+	storefrontOrigin;
 	authenticationListeners = /* @__PURE__ */ new Set();
 	constructor(options = {}) {
 		this.apiKey = options.apiKey?.trim() || void 0;
 		this.apiUrl = options.apiUrl || defaultApiUrl(isBrowserRuntime());
 		this.onSetCookie = options.onSetCookie;
+		if (options.request && !isBrowserRuntime()) this.storefrontOrigin = options.request.headers.get("Origin") || new URL(options.request.url).origin;
 		if (!isBrowserRuntime()) for (const part of (options.request?.headers.get("Cookie") || "").split(";")) {
 			const separator = part.indexOf("=");
 			if (separator > 0) this.cookies.set(part.slice(0, separator).trim(), part.slice(separator + 1).trim());
@@ -77,7 +74,8 @@ var CaldikHttpClient = class {
 		return this.storeId || boundRuntimeStoreId();
 	}
 	hasCartSession() {
-		return this.cookies.has(`caldik_cart_session_${this.storeContextId()}`);
+		const prefix = `caldik_cart_session_${this.storeContextId()}`;
+		return [...this.cookies.keys()].some((name) => name === prefix || name.startsWith(`${prefix}_`));
 	}
 	onCustomerAuthentication(listener) {
 		this.authenticationListeners.add(listener);
@@ -118,10 +116,11 @@ var CaldikHttpClient = class {
 		const url = new URL(`${this.baseUrl()}${path}`);
 		if (params) for (const [key, value] of Object.entries(params)) url.searchParams.set(key, String(value));
 		const headers = { ...options?.headers };
+		if (!isBrowserRuntime() && this.storefrontOrigin) headers.Origin = this.storefrontOrigin;
 		if (!isBrowserRuntime()) headers["User-Agent"] = "CaldikClient/0.0.2";
 		if (!isBrowserRuntime() && options?.access === "public" && this.cookies.size) headers.Cookie = [...this.cookies].map(([name, value]) => `${name}=${value}`).join("; ");
 		if (this.apiKey) headers.Authorization = `Bearer ${this.apiKey}`;
-		else if (options?.access === "public" && (!isBrowserRuntime() || isLocalBrowserRuntime())) headers["X-Caldik-Public-Request"] = "1";
+		else if (options?.access === "public") headers["X-Caldik-Public-Request"] = "1";
 		if (input !== void 0) headers["Content-Type"] = "application/json";
 		if (options?.edgeCache) headers["X-Cache-Policy"] = "public";
 		const response = await fetch(url, {
@@ -173,8 +172,8 @@ var ProductsApi = class {
 	list() {
 		return this.client.get("/products", void 0, { access: "public" });
 	}
-	get(productIdOrSlug) {
-		return this.client.get(`/products/${encodeURIComponent(productIdOrSlug)}`, void 0, { access: "public" });
+	get(productIdOrSlug, options) {
+		return this.client.get(`/products/${encodeURIComponent(productIdOrSlug)}`, options?.category === void 0 ? void 0 : { category: options.category }, { access: "public" });
 	}
 };
 //#endregion

package/package.json

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