@malawistore/store-sdk 0.1.2 → 0.1.3

package/dist/index.d.cts

@@ -32,7 +32,7 @@ interface StatusResponse {
 interface PageParams {
     /** 1-based page. Wins over `offset` when both are sent. */
     page?: number;
-    /** Page size. The API defaults to 20 and caps at 100. */
+    /** Page size. Storefront/shopper lists default to 12; admin user lists default to 20. Capped at 100. */
     limit?: number;
     /** Number of rows to skip. */
     offset?: number;
@@ -290,6 +290,22 @@ interface AddCartItemInput {
     variant_id?: string;
     qty: number;
 }
+type CartSort = "oldest" | "newest" | "name_asc" | "name_desc" | "price_asc" | "price_desc" | "qty_asc" | "qty_desc";
+interface ListCartParams extends PageParams {
+    /** Case-insensitive substring over line name and SKU. */
+    q?: string;
+    product_id?: string;
+    variant_id?: string;
+    sort?: CartSort;
+}
+/**
+ * Raw paged cart envelope returned by `getPage`. `data.subtotal_cents`
+ * always covers the whole cart; `meta` counts cart lines.
+ */
+interface CartResponse {
+    data: Cart;
+    meta: PaginationMeta;
+}
 
 interface Stock {
     product_id: string;
@@ -340,6 +356,20 @@ interface Order {
     /** ISO-8601 timestamp. */
     created_at: string;
 }
+type OrderSort = "newest" | "oldest" | "total_asc" | "total_desc";
+interface ListOrdersParams extends PageParams {
+    status?: OrderStatus;
+    currency?: string;
+    /** RFC3339 or YYYY-MM-DD. */
+    created_after?: string;
+    /** RFC3339 or YYYY-MM-DD; a date-only value includes the whole day. */
+    created_before?: string;
+    min_total_cents?: number;
+    max_total_cents?: number;
+    sort?: OrderSort;
+}
+/** Raw paged orders envelope returned by `listPage`. */
+type OrderListResponse = Paginated<Order>;
 
 type PaymentStatus = "pending" | "succeeded" | "failed" | "cancelled";
 /**
@@ -383,6 +413,15 @@ interface WishlistItem {
     /** ISO-8601 timestamp. */
     added_at: string;
 }
+type WishlistSort = "newest" | "oldest" | "name_asc" | "name_desc" | "price_asc" | "price_desc";
+interface ListWishlistParams extends PageParams {
+    /** Case-insensitive substring over product name and slug. */
+    q?: string;
+    category_id?: string;
+    sort?: WishlistSort;
+}
+/** Raw paged wishlist envelope returned by `listPage`. */
+type WishlistListResponse = Paginated<WishlistItem>;
 
 interface Review {
     id: string;
@@ -400,6 +439,16 @@ interface ReviewSummary {
     average: number;
     count: number;
     reviews: Review[];
+    /** Counters for the filtered review page (average/count are unfiltered). */
+    meta: PaginationMeta;
+}
+type ReviewSort = "newest" | "oldest" | "highest" | "lowest";
+interface ListReviewsParams extends PageParams {
+    /** Case-insensitive substring over title, body and author. */
+    q?: string;
+    /** Only this rating (1-5). */
+    rating?: number;
+    sort?: ReviewSort;
 }
 interface CreateReviewInput {
     /** 1–5. */
@@ -539,8 +588,10 @@ declare class AuthResource {
 declare class CartResource {
     private readonly http;
     constructor(http: HttpClient);
-    /** Active cart, created empty on first use. */
-    get(): Promise<Cart>;
+    /** Active cart, created empty on first use (paging meta is dropped). */
+    get(params?: ListCartParams): Promise<Cart>;
+    /** Same as `get`, plus the `meta` paging counters. */
+    getPage(params?: ListCartParams): Promise<CartResponse>;
     /** Validates against the catalog and snapshots the current price. */
     addItem(input: AddCartItemInput): Promise<Cart>;
     /** `qty: 0` removes the line. */
@@ -610,8 +661,10 @@ declare class OrdersResource {
      * the cart.
      */
     checkout(): Promise<Order>;
-    /** Newest first. */
-    list(): Promise<Order[]>;
+    /** Newest first (paging meta is dropped). */
+    list(params?: ListOrdersParams): Promise<Order[]>;
+    /** Same filters as `list`, plus the `meta` paging counters. */
+    listPage(params?: ListOrdersParams): Promise<OrderListResponse>;
     get(id: string): Promise<Order>;
     /** Pending orders only; releases the stock hold. */
     cancel(id: string): Promise<Order>;
@@ -656,8 +709,8 @@ declare class ProductsResource {
 declare class ReviewsResource {
     private readonly http;
     constructor(http: HttpClient);
-    /** Public aggregate plus the newest reviews for a product. */
-    summary(productId: string): Promise<ReviewSummary>;
+    /** Public aggregate plus one filtered review page (`summary.meta`). */
+    summary(productId: string, params?: ListReviewsParams): Promise<ReviewSummary>;
     /** One review per user per product. */
     create(productId: string, input: CreateReviewInput): Promise<Review>;
     /** Edits the caller's own review. */
@@ -698,8 +751,10 @@ declare class VariantsResource {
 declare class WishlistResource {
     private readonly http;
     constructor(http: HttpClient);
-    /** Newest first. */
-    list(): Promise<WishlistItem[]>;
+    /** Newest first (paging meta is dropped). */
+    list(params?: ListWishlistParams): Promise<WishlistItem[]>;
+    /** Same filters as `list`, plus the `meta` paging counters. */
+    listPage(params?: ListWishlistParams): Promise<WishlistListResponse>;
     /** Idempotent: re-hearting succeeds silently. */
     add(productId: string): Promise<WishlistItem>;
     /** `productId`, not the wishlist row ID. */
@@ -819,4 +874,4 @@ declare function verifyStripeSignature(options: VerifyStripeSignatureOptions): P
  */
 declare function constructStripeEvent<T = Record<string, unknown>>(options: VerifyStripeSignatureOptions): Promise<StripeEvent<T>>;
 
-export { type AddCartItemInput, type ApiEnvelope, type ApiErrorCode, type ApiErrorEnvelope, type AuthStatusResponse, type Cart, type CartLine, type Category, type CategoryListResponse, type CategorySort, type CheckoutSession, type ClientErrorCode, type CreateCategoryInput, type CreateProductInput, type CreateReviewInput, type CreateVariantInput, type ErrorCode, type FetchLike, type GetStockParams, type HealthResponse, type ListCategoriesParams, type ListProductsParams, type ListUsersParams, type LoginInput, MalawiStore, MalawiStoreError, type MalawiStoreErrorInit, type MalawiStoreOptions, type Order, type OrderLine, type OrderStatus, type PageParams, type Paginated, type PaginationMeta, type PasswordResetInput, type Payment, type PaymentStatus, type Product, type ProductDetail, type ProductListResponse, type ProductSort, type ProductVariantView, type QueryParams, type QueryScalar, type QueryValue, type RegisterInput, type RequestOptions, type ReserveLineInput, type ReserveStockInput, type RetryOptions, type Review, type ReviewSummary, type Role, type SetRoleInput, type SetStockInput, type StatusResponse, type Stock, type StripeEvent, type TokenPair, type TokenState, type UpdateCategoryInput, type UpdateProductInput, type UpdateReviewInput, type UpdateVariantInput, type UploadData, type UploadFile, type User, type UserListResponse, type UserSort, type Variant, type VerifyEmailInput, type VerifyStripeSignatureOptions, type WishlistItem, type WishlistProduct, buildQuery, constructStripeEvent, createUploadForm, isMalawiStoreError, verifyStripeSignature };
+export { type AddCartItemInput, type ApiEnvelope, type ApiErrorCode, type ApiErrorEnvelope, type AuthStatusResponse, type Cart, type CartLine, type CartResponse, type CartSort, type Category, type CategoryListResponse, type CategorySort, type CheckoutSession, type ClientErrorCode, type CreateCategoryInput, type CreateProductInput, type CreateReviewInput, type CreateVariantInput, type ErrorCode, type FetchLike, type GetStockParams, type HealthResponse, type ListCartParams, type ListCategoriesParams, type ListOrdersParams, type ListProductsParams, type ListReviewsParams, type ListUsersParams, type ListWishlistParams, type LoginInput, MalawiStore, MalawiStoreError, type MalawiStoreErrorInit, type MalawiStoreOptions, type Order, type OrderLine, type OrderListResponse, type OrderSort, type OrderStatus, type PageParams, type Paginated, type PaginationMeta, type PasswordResetInput, type Payment, type PaymentStatus, type Product, type ProductDetail, type ProductListResponse, type ProductSort, type ProductVariantView, type QueryParams, type QueryScalar, type QueryValue, type RegisterInput, type RequestOptions, type ReserveLineInput, type ReserveStockInput, type RetryOptions, type Review, type ReviewSort, type ReviewSummary, type Role, type SetRoleInput, type SetStockInput, type StatusResponse, type Stock, type StripeEvent, type TokenPair, type TokenState, type UpdateCategoryInput, type UpdateProductInput, type UpdateReviewInput, type UpdateVariantInput, type UploadData, type UploadFile, type User, type UserListResponse, type UserSort, type Variant, type VerifyEmailInput, type VerifyStripeSignatureOptions, type WishlistItem, type WishlistListResponse, type WishlistProduct, type WishlistSort, buildQuery, constructStripeEvent, createUploadForm, isMalawiStoreError, verifyStripeSignature };

package/dist/index.d.ts

@@ -32,7 +32,7 @@ interface StatusResponse {
 interface PageParams {
     /** 1-based page. Wins over `offset` when both are sent. */
     page?: number;
-    /** Page size. The API defaults to 20 and caps at 100. */
+    /** Page size. Storefront/shopper lists default to 12; admin user lists default to 20. Capped at 100. */
     limit?: number;
     /** Number of rows to skip. */
     offset?: number;
@@ -290,6 +290,22 @@ interface AddCartItemInput {
     variant_id?: string;
     qty: number;
 }
+type CartSort = "oldest" | "newest" | "name_asc" | "name_desc" | "price_asc" | "price_desc" | "qty_asc" | "qty_desc";
+interface ListCartParams extends PageParams {
+    /** Case-insensitive substring over line name and SKU. */
+    q?: string;
+    product_id?: string;
+    variant_id?: string;
+    sort?: CartSort;
+}
+/**
+ * Raw paged cart envelope returned by `getPage`. `data.subtotal_cents`
+ * always covers the whole cart; `meta` counts cart lines.
+ */
+interface CartResponse {
+    data: Cart;
+    meta: PaginationMeta;
+}
 
 interface Stock {
     product_id: string;
@@ -340,6 +356,20 @@ interface Order {
     /** ISO-8601 timestamp. */
     created_at: string;
 }
+type OrderSort = "newest" | "oldest" | "total_asc" | "total_desc";
+interface ListOrdersParams extends PageParams {
+    status?: OrderStatus;
+    currency?: string;
+    /** RFC3339 or YYYY-MM-DD. */
+    created_after?: string;
+    /** RFC3339 or YYYY-MM-DD; a date-only value includes the whole day. */
+    created_before?: string;
+    min_total_cents?: number;
+    max_total_cents?: number;
+    sort?: OrderSort;
+}
+/** Raw paged orders envelope returned by `listPage`. */
+type OrderListResponse = Paginated<Order>;
 
 type PaymentStatus = "pending" | "succeeded" | "failed" | "cancelled";
 /**
@@ -383,6 +413,15 @@ interface WishlistItem {
     /** ISO-8601 timestamp. */
     added_at: string;
 }
+type WishlistSort = "newest" | "oldest" | "name_asc" | "name_desc" | "price_asc" | "price_desc";
+interface ListWishlistParams extends PageParams {
+    /** Case-insensitive substring over product name and slug. */
+    q?: string;
+    category_id?: string;
+    sort?: WishlistSort;
+}
+/** Raw paged wishlist envelope returned by `listPage`. */
+type WishlistListResponse = Paginated<WishlistItem>;
 
 interface Review {
     id: string;
@@ -400,6 +439,16 @@ interface ReviewSummary {
     average: number;
     count: number;
     reviews: Review[];
+    /** Counters for the filtered review page (average/count are unfiltered). */
+    meta: PaginationMeta;
+}
+type ReviewSort = "newest" | "oldest" | "highest" | "lowest";
+interface ListReviewsParams extends PageParams {
+    /** Case-insensitive substring over title, body and author. */
+    q?: string;
+    /** Only this rating (1-5). */
+    rating?: number;
+    sort?: ReviewSort;
 }
 interface CreateReviewInput {
     /** 1–5. */
@@ -539,8 +588,10 @@ declare class AuthResource {
 declare class CartResource {
     private readonly http;
     constructor(http: HttpClient);
-    /** Active cart, created empty on first use. */
-    get(): Promise<Cart>;
+    /** Active cart, created empty on first use (paging meta is dropped). */
+    get(params?: ListCartParams): Promise<Cart>;
+    /** Same as `get`, plus the `meta` paging counters. */
+    getPage(params?: ListCartParams): Promise<CartResponse>;
     /** Validates against the catalog and snapshots the current price. */
     addItem(input: AddCartItemInput): Promise<Cart>;
     /** `qty: 0` removes the line. */
@@ -610,8 +661,10 @@ declare class OrdersResource {
      * the cart.
      */
     checkout(): Promise<Order>;
-    /** Newest first. */
-    list(): Promise<Order[]>;
+    /** Newest first (paging meta is dropped). */
+    list(params?: ListOrdersParams): Promise<Order[]>;
+    /** Same filters as `list`, plus the `meta` paging counters. */
+    listPage(params?: ListOrdersParams): Promise<OrderListResponse>;
     get(id: string): Promise<Order>;
     /** Pending orders only; releases the stock hold. */
     cancel(id: string): Promise<Order>;
@@ -656,8 +709,8 @@ declare class ProductsResource {
 declare class ReviewsResource {
     private readonly http;
     constructor(http: HttpClient);
-    /** Public aggregate plus the newest reviews for a product. */
-    summary(productId: string): Promise<ReviewSummary>;
+    /** Public aggregate plus one filtered review page (`summary.meta`). */
+    summary(productId: string, params?: ListReviewsParams): Promise<ReviewSummary>;
     /** One review per user per product. */
     create(productId: string, input: CreateReviewInput): Promise<Review>;
     /** Edits the caller's own review. */
@@ -698,8 +751,10 @@ declare class VariantsResource {
 declare class WishlistResource {
     private readonly http;
     constructor(http: HttpClient);
-    /** Newest first. */
-    list(): Promise<WishlistItem[]>;
+    /** Newest first (paging meta is dropped). */
+    list(params?: ListWishlistParams): Promise<WishlistItem[]>;
+    /** Same filters as `list`, plus the `meta` paging counters. */
+    listPage(params?: ListWishlistParams): Promise<WishlistListResponse>;
     /** Idempotent: re-hearting succeeds silently. */
     add(productId: string): Promise<WishlistItem>;
     /** `productId`, not the wishlist row ID. */
@@ -819,4 +874,4 @@ declare function verifyStripeSignature(options: VerifyStripeSignatureOptions): P
  */
 declare function constructStripeEvent<T = Record<string, unknown>>(options: VerifyStripeSignatureOptions): Promise<StripeEvent<T>>;
 
-export { type AddCartItemInput, type ApiEnvelope, type ApiErrorCode, type ApiErrorEnvelope, type AuthStatusResponse, type Cart, type CartLine, type Category, type CategoryListResponse, type CategorySort, type CheckoutSession, type ClientErrorCode, type CreateCategoryInput, type CreateProductInput, type CreateReviewInput, type CreateVariantInput, type ErrorCode, type FetchLike, type GetStockParams, type HealthResponse, type ListCategoriesParams, type ListProductsParams, type ListUsersParams, type LoginInput, MalawiStore, MalawiStoreError, type MalawiStoreErrorInit, type MalawiStoreOptions, type Order, type OrderLine, type OrderStatus, type PageParams, type Paginated, type PaginationMeta, type PasswordResetInput, type Payment, type PaymentStatus, type Product, type ProductDetail, type ProductListResponse, type ProductSort, type ProductVariantView, type QueryParams, type QueryScalar, type QueryValue, type RegisterInput, type RequestOptions, type ReserveLineInput, type ReserveStockInput, type RetryOptions, type Review, type ReviewSummary, type Role, type SetRoleInput, type SetStockInput, type StatusResponse, type Stock, type StripeEvent, type TokenPair, type TokenState, type UpdateCategoryInput, type UpdateProductInput, type UpdateReviewInput, type UpdateVariantInput, type UploadData, type UploadFile, type User, type UserListResponse, type UserSort, type Variant, type VerifyEmailInput, type VerifyStripeSignatureOptions, type WishlistItem, type WishlistProduct, buildQuery, constructStripeEvent, createUploadForm, isMalawiStoreError, verifyStripeSignature };
+export { type AddCartItemInput, type ApiEnvelope, type ApiErrorCode, type ApiErrorEnvelope, type AuthStatusResponse, type Cart, type CartLine, type CartResponse, type CartSort, type Category, type CategoryListResponse, type CategorySort, type CheckoutSession, type ClientErrorCode, type CreateCategoryInput, type CreateProductInput, type CreateReviewInput, type CreateVariantInput, type ErrorCode, type FetchLike, type GetStockParams, type HealthResponse, type ListCartParams, type ListCategoriesParams, type ListOrdersParams, type ListProductsParams, type ListReviewsParams, type ListUsersParams, type ListWishlistParams, type LoginInput, MalawiStore, MalawiStoreError, type MalawiStoreErrorInit, type MalawiStoreOptions, type Order, type OrderLine, type OrderListResponse, type OrderSort, type OrderStatus, type PageParams, type Paginated, type PaginationMeta, type PasswordResetInput, type Payment, type PaymentStatus, type Product, type ProductDetail, type ProductListResponse, type ProductSort, type ProductVariantView, type QueryParams, type QueryScalar, type QueryValue, type RegisterInput, type RequestOptions, type ReserveLineInput, type ReserveStockInput, type RetryOptions, type Review, type ReviewSort, type ReviewSummary, type Role, type SetRoleInput, type SetStockInput, type StatusResponse, type Stock, type StripeEvent, type TokenPair, type TokenState, type UpdateCategoryInput, type UpdateProductInput, type UpdateReviewInput, type UpdateVariantInput, type UploadData, type UploadFile, type User, type UserListResponse, type UserSort, type Variant, type VerifyEmailInput, type VerifyStripeSignatureOptions, type WishlistItem, type WishlistListResponse, type WishlistProduct, type WishlistSort, buildQuery, constructStripeEvent, createUploadForm, isMalawiStoreError, verifyStripeSignature };

package/dist/index.js

@@ -442,9 +442,34 @@ var CartResource = class {
     this.http = http;
   }
   http;
-  /** Active cart, created empty on first use. */
-  get() {
-    return this.http.request("GET", "/cart");
+  /** Active cart, created empty on first use (paging meta is dropped). */
+  get(params = {}) {
+    return this.http.request("GET", "/cart", {
+      query: {
+        q: params.q,
+        product_id: params.product_id,
+        variant_id: params.variant_id,
+        sort: params.sort,
+        page: params.page,
+        limit: params.limit,
+        offset: params.offset
+      }
+    });
+  }
+  /** Same as `get`, plus the `meta` paging counters. */
+  getPage(params = {}) {
+    return this.http.request("GET", "/cart", {
+      query: {
+        q: params.q,
+        product_id: params.product_id,
+        variant_id: params.variant_id,
+        sort: params.sort,
+        page: params.page,
+        limit: params.limit,
+        offset: params.offset
+      },
+      unwrap: false
+    });
   }
   /** Validates against the catalog and snapshots the current price. */
   addItem(input) {
@@ -643,9 +668,40 @@ var OrdersResource = class {
       retry: false
     });
   }
-  /** Newest first. */
-  list() {
-    return this.http.request("GET", "/orders");
+  /** Newest first (paging meta is dropped). */
+  list(params = {}) {
+    return this.http.request("GET", "/orders", {
+      query: {
+        status: params.status,
+        currency: params.currency,
+        created_after: params.created_after,
+        created_before: params.created_before,
+        min_total_cents: params.min_total_cents,
+        max_total_cents: params.max_total_cents,
+        sort: params.sort,
+        page: params.page,
+        limit: params.limit,
+        offset: params.offset
+      }
+    });
+  }
+  /** Same filters as `list`, plus the `meta` paging counters. */
+  listPage(params = {}) {
+    return this.http.request("GET", "/orders", {
+      query: {
+        status: params.status,
+        currency: params.currency,
+        created_after: params.created_after,
+        created_before: params.created_before,
+        min_total_cents: params.min_total_cents,
+        max_total_cents: params.max_total_cents,
+        sort: params.sort,
+        page: params.page,
+        limit: params.limit,
+        offset: params.offset
+      },
+      unwrap: false
+    });
   }
   get(id) {
     return this.http.request("GET", `/orders/${segment(id)}`);
@@ -795,12 +851,22 @@ var ReviewsResource = class {
     this.http = http;
   }
   http;
-  /** Public aggregate plus the newest reviews for a product. */
-  summary(productId) {
+  /** Public aggregate plus one filtered review page (`summary.meta`). */
+  summary(productId, params = {}) {
     return this.http.request(
       "GET",
       `/products/${segment(productId)}/reviews`,
-      { skipAuth: true }
+      {
+        query: {
+          q: params.q,
+          rating: params.rating,
+          sort: params.sort,
+          page: params.page,
+          limit: params.limit,
+          offset: params.offset
+        },
+        skipAuth: true
+      }
     );
   }
   /** One review per user per product. */
@@ -936,9 +1002,32 @@ var WishlistResource = class {
     this.http = http;
   }
   http;
-  /** Newest first. */
-  list() {
-    return this.http.request("GET", "/wishlist");
+  /** Newest first (paging meta is dropped). */
+  list(params = {}) {
+    return this.http.request("GET", "/wishlist", {
+      query: {
+        q: params.q,
+        category_id: params.category_id,
+        sort: params.sort,
+        page: params.page,
+        limit: params.limit,
+        offset: params.offset
+      }
+    });
+  }
+  /** Same filters as `list`, plus the `meta` paging counters. */
+  listPage(params = {}) {
+    return this.http.request("GET", "/wishlist", {
+      query: {
+        q: params.q,
+        category_id: params.category_id,
+        sort: params.sort,
+        page: params.page,
+        limit: params.limit,
+        offset: params.offset
+      },
+      unwrap: false
+    });
   }
   /** Idempotent: re-hearting succeeds silently. */
   add(productId) {