@caldik/client 0.1.4 → 0.1.5

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.

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;
@@ -393,7 +412,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 +578,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, ProductMetadata, ProductResponse, ProductTag, ProductVariant, ProductsResponse, Review, ReviewsResponse, Store, StoreResponse, StoreSocials, StoreWebhookEvent, StoreWebhookEventName, StorefrontMetadata, StorefrontOrder, SubscriptionPaymentProviderId, SubscriptionResponse, checkoutPaymentProviderIds, paymentProviderIds, storeWebhookEventNames, subscriptionPaymentProviderIds };

package/dist/index.mjs

@@ -173,8 +173,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.5",
   "type": "module",
   "main": "./dist/index.mjs",
   "types": "./dist/index.d.mts",