@whatalo/plugin-sdk 1.0.0

package/dist/types-DZ659i6f.d.ts

@@ -0,0 +1,68 @@
+import { O as Order, a as Product, d as Customer } from './types-M1eLMz6w.js';
+
+/** All supported webhook event types */
+type WebhookEvent = "order.created" | "order.updated" | "order.status_changed" | "order.cancelled" | "product.created" | "product.updated" | "product.deleted" | "customer.created" | "customer.updated" | "inventory.low" | "inventory.adjusted" | "app.installed" | "app.uninstalled";
+/** Map of webhook events to their payload data shapes */
+interface WebhookEventData {
+    "order.created": {
+        order: Order;
+    };
+    "order.updated": {
+        order: Order;
+        changes: string[];
+    };
+    "order.status_changed": {
+        orderId: string;
+        previousStatus: string;
+        newStatus: string;
+    };
+    "order.cancelled": {
+        orderId: string;
+        reason?: string;
+    };
+    "product.created": {
+        product: Product;
+    };
+    "product.updated": {
+        product: Product;
+        changes: string[];
+    };
+    "product.deleted": {
+        productId: string;
+    };
+    "customer.created": {
+        customer: Customer;
+    };
+    "customer.updated": {
+        customer: Customer;
+        changes: string[];
+    };
+    "inventory.low": {
+        productId: string;
+        currentQuantity: number;
+        threshold: number;
+    };
+    "inventory.adjusted": {
+        productId: string;
+        previousQuantity: number;
+        newQuantity: number;
+        reason: string;
+    };
+    "app.installed": {
+        storeId: string;
+        installedAt: string;
+    };
+    "app.uninstalled": {
+        storeId: string;
+        uninstalledAt: string;
+    };
+}
+/** Typed webhook payload delivered to subscriber endpoints */
+interface WebhookPayload<E extends WebhookEvent = WebhookEvent> {
+    event: E;
+    timestamp: string;
+    storeId: string;
+    data: WebhookEventData[E];
+}
+
+export type { WebhookEvent as W, WebhookPayload as a, WebhookEventData as b };

package/dist/types-Db_BeRCj.d.cts

@@ -0,0 +1,19 @@
+import { W as WebhookEvent, a as WebhookPayload } from './types-DdqKKyqX.cjs';
+
+/** Handler function for a specific webhook event */
+type WebhookEventHandler<E extends WebhookEvent> = (payload: WebhookPayload<E>) => Promise<void> | void;
+/** Map of event names to handler functions */
+type WebhookHandlers = {
+    [E in WebhookEvent]?: WebhookEventHandler<E>;
+};
+/** Options for creating a webhook handler */
+interface WebhookHandlerOptions {
+    /** The webhook signing secret */
+    secret: string;
+    /** Event handler map */
+    handlers: WebhookHandlers;
+    /** Called when an event has no registered handler */
+    onUnhandledEvent?: (event: string, payload: WebhookPayload) => Promise<void> | void;
+}
+
+export type { WebhookHandlerOptions as W };

package/dist/types-DdqKKyqX.d.cts

@@ -0,0 +1,68 @@
+import { O as Order, a as Product, d as Customer } from './types-M1eLMz6w.cjs';
+
+/** All supported webhook event types */
+type WebhookEvent = "order.created" | "order.updated" | "order.status_changed" | "order.cancelled" | "product.created" | "product.updated" | "product.deleted" | "customer.created" | "customer.updated" | "inventory.low" | "inventory.adjusted" | "app.installed" | "app.uninstalled";
+/** Map of webhook events to their payload data shapes */
+interface WebhookEventData {
+    "order.created": {
+        order: Order;
+    };
+    "order.updated": {
+        order: Order;
+        changes: string[];
+    };
+    "order.status_changed": {
+        orderId: string;
+        previousStatus: string;
+        newStatus: string;
+    };
+    "order.cancelled": {
+        orderId: string;
+        reason?: string;
+    };
+    "product.created": {
+        product: Product;
+    };
+    "product.updated": {
+        product: Product;
+        changes: string[];
+    };
+    "product.deleted": {
+        productId: string;
+    };
+    "customer.created": {
+        customer: Customer;
+    };
+    "customer.updated": {
+        customer: Customer;
+        changes: string[];
+    };
+    "inventory.low": {
+        productId: string;
+        currentQuantity: number;
+        threshold: number;
+    };
+    "inventory.adjusted": {
+        productId: string;
+        previousQuantity: number;
+        newQuantity: number;
+        reason: string;
+    };
+    "app.installed": {
+        storeId: string;
+        installedAt: string;
+    };
+    "app.uninstalled": {
+        storeId: string;
+        uninstalledAt: string;
+    };
+}
+/** Typed webhook payload delivered to subscriber endpoints */
+interface WebhookPayload<E extends WebhookEvent = WebhookEvent> {
+    event: E;
+    timestamp: string;
+    storeId: string;
+    data: WebhookEventData[E];
+}
+
+export type { WebhookEvent as W, WebhookPayload as a, WebhookEventData as b };

package/dist/types-M1eLMz6w.d.cts

@@ -0,0 +1,279 @@
+/** Options for initializing the WhataloClient */
+interface WhataloClientOptions {
+    /** Store-scoped API key (wk_live_* or wk_test_*) */
+    apiKey: string;
+    /** API base URL. Defaults to https://api.whatalo.com/v1 */
+    baseUrl?: string;
+    /** Request timeout in milliseconds. Defaults to 30000 */
+    timeout?: number;
+    /** Number of automatic retries on 5xx errors. Defaults to 0 */
+    retries?: number;
+    /** Custom fetch implementation for testing or custom environments */
+    fetch?: typeof globalThis.fetch;
+    /** Hook fired before each request attempt */
+    onRequest?: (url: string, init: RequestInit) => void;
+    /** Hook fired after each received response */
+    onResponse?: (response: Response, durationMs: number) => void;
+}
+/** Rate limit info from the latest API response */
+interface RateLimitInfo {
+    limit: number;
+    remaining: number;
+    reset: number;
+}
+/** Standard paginated response from list endpoints */
+interface PaginatedResponse<T> {
+    data: T[];
+    pagination: {
+        page: number;
+        per_page: number;
+        total: number;
+        total_pages: number;
+    };
+}
+/** Single resource response */
+interface SingleResponse<T> {
+    data: T;
+}
+/** Product resource from the API */
+interface Product {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    price: number;
+    compare_price: number | null;
+    main_image: string | null;
+    gallery: string[];
+    is_active: boolean;
+    is_featured: boolean;
+    sku: string | null;
+    track_inventory: boolean;
+    stock_quantity: number;
+    condition: string;
+    is_purchasable: boolean;
+    has_discount: boolean;
+    discount_percentage: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Order resource from the API */
+interface Order {
+    id: string;
+    status: string;
+    total: number;
+    currency: string;
+    customer_name: string;
+    customer_phone: string;
+    items_count: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Customer resource from the API */
+interface Customer {
+    id: string;
+    name: string;
+    phone: string;
+    email: string | null;
+    orders_count: number;
+    total_spent: number;
+    created_at: string;
+}
+/** Category resource from the API */
+interface Category {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    image: string | null;
+    products_count: number;
+    is_active: boolean;
+    position: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Discount resource from the API */
+interface Discount {
+    id: string;
+    name: string;
+    code: string;
+    type: "percentage" | "fixed";
+    value: number;
+    min_order_amount: number | null;
+    max_uses: number | null;
+    used_count: number;
+    starts_at: string | null;
+    ends_at: string | null;
+    is_active: boolean;
+    created_at: string;
+}
+/** Store resource from the API */
+interface Store {
+    id: string;
+    name: string;
+    slug: string;
+    domain: string | null;
+    logo: string | null;
+    description: string | null;
+    currency: string;
+    country: string;
+    timezone: string;
+    is_active: boolean;
+    created_at: string;
+}
+/** Inventory details for a product */
+interface InventoryItem {
+    product_id: string;
+    sku: string | null;
+    stock_quantity: number;
+    track_inventory: boolean;
+    low_stock_threshold: number | null;
+}
+/** Webhook resource from the API */
+interface Webhook {
+    id: string;
+    url: string;
+    events: string[];
+    is_active: boolean;
+    created_at: string;
+}
+/** Params for listing products */
+interface ListProductsParams {
+    page?: number;
+    per_page?: number;
+    sort?: "name" | "price" | "created_at" | "updated_at";
+    order?: "asc" | "desc";
+    search?: string;
+    status?: "active" | "inactive" | "all";
+    category_id?: string;
+    is_featured?: boolean;
+}
+/** Params for creating a product */
+interface CreateProductParams {
+    name: string;
+    slug?: string;
+    description?: string;
+    price: number;
+    compare_price?: number | null;
+    category_id?: string;
+    main_image?: string;
+    gallery?: string[];
+    is_active?: boolean;
+    is_featured?: boolean;
+    sku?: string;
+    track_inventory?: boolean;
+    stock_quantity?: number;
+    condition?: "new" | "original" | "used_like_new";
+}
+/** Params for updating a product */
+interface UpdateProductParams {
+    name?: string;
+    slug?: string;
+    description?: string;
+    price?: number;
+    compare_price?: number | null;
+    main_image?: string | null;
+    gallery?: string[];
+    is_active?: boolean;
+    is_featured?: boolean;
+    sku?: string | null;
+    track_inventory?: boolean;
+    stock_quantity?: number;
+    condition?: "new" | "original" | "used_like_new";
+}
+/** Params for listing orders */
+interface ListOrdersParams {
+    page?: number;
+    per_page?: number;
+    sort?: string;
+    order?: "asc" | "desc";
+    status?: string;
+    date_from?: string;
+    date_to?: string;
+    customer_id?: string;
+}
+/** Params for listing customers */
+interface ListCustomersParams {
+    page?: number;
+    per_page?: number;
+    search?: string;
+}
+/** Params for listing categories */
+interface ListCategoriesParams {
+    page?: number;
+    per_page?: number;
+    sort?: "name" | "position" | "created_at" | "updated_at";
+    order?: "asc" | "desc";
+    search?: string;
+    status?: "active" | "inactive" | "all";
+}
+/** Params for creating a category */
+interface CreateCategoryParams {
+    name: string;
+    slug?: string;
+    description?: string;
+    image?: string;
+    is_active?: boolean;
+    position?: number;
+}
+/** Params for updating a category */
+interface UpdateCategoryParams {
+    name?: string;
+    slug?: string;
+    description?: string | null;
+    image?: string | null;
+    is_active?: boolean;
+    position?: number;
+}
+/** Params for listing discounts */
+interface ListDiscountsParams {
+    page?: number;
+    per_page?: number;
+    sort?: "name" | "code" | "created_at" | "starts_at" | "ends_at";
+    order?: "asc" | "desc";
+    search?: string;
+    status?: "active" | "inactive" | "all";
+    type?: "percentage" | "fixed";
+}
+/** Params for creating a discount */
+interface CreateDiscountParams {
+    name: string;
+    code: string;
+    type: "percentage" | "fixed";
+    value: number;
+    min_order_amount?: number | null;
+    max_uses?: number | null;
+    starts_at?: string | null;
+    ends_at?: string | null;
+    is_active?: boolean;
+}
+/** Params for updating a discount */
+interface UpdateDiscountParams {
+    name?: string;
+    code?: string;
+    type?: "percentage" | "fixed";
+    value?: number;
+    min_order_amount?: number | null;
+    max_uses?: number | null;
+    starts_at?: string | null;
+    ends_at?: string | null;
+    is_active?: boolean;
+}
+/** Params for creating/updating webhooks */
+interface UpsertWebhookParams {
+    url: string;
+    events: string[];
+    secret?: string;
+}
+/** Params for updating an existing webhook */
+interface UpdateWebhookParams {
+    url?: string;
+    events?: string[];
+}
+/** Params for adjusting product inventory */
+interface AdjustInventoryParams {
+    quantity: number;
+    reason: string;
+}
+
+export type { AdjustInventoryParams as A, CreateProductParams as C, Discount as D, InventoryItem as I, ListProductsParams as L, Order as O, PaginatedResponse as P, RateLimitInfo as R, SingleResponse as S, UpdateProductParams as U, Webhook as W, Product as a, ListOrdersParams as b, ListCustomersParams as c, Customer as d, ListCategoriesParams as e, Category as f, CreateCategoryParams as g, UpdateCategoryParams as h, ListDiscountsParams as i, CreateDiscountParams as j, UpdateDiscountParams as k, Store as l, UpsertWebhookParams as m, UpdateWebhookParams as n, WhataloClientOptions as o };

package/dist/types-M1eLMz6w.d.ts

@@ -0,0 +1,279 @@
+/** Options for initializing the WhataloClient */
+interface WhataloClientOptions {
+    /** Store-scoped API key (wk_live_* or wk_test_*) */
+    apiKey: string;
+    /** API base URL. Defaults to https://api.whatalo.com/v1 */
+    baseUrl?: string;
+    /** Request timeout in milliseconds. Defaults to 30000 */
+    timeout?: number;
+    /** Number of automatic retries on 5xx errors. Defaults to 0 */
+    retries?: number;
+    /** Custom fetch implementation for testing or custom environments */
+    fetch?: typeof globalThis.fetch;
+    /** Hook fired before each request attempt */
+    onRequest?: (url: string, init: RequestInit) => void;
+    /** Hook fired after each received response */
+    onResponse?: (response: Response, durationMs: number) => void;
+}
+/** Rate limit info from the latest API response */
+interface RateLimitInfo {
+    limit: number;
+    remaining: number;
+    reset: number;
+}
+/** Standard paginated response from list endpoints */
+interface PaginatedResponse<T> {
+    data: T[];
+    pagination: {
+        page: number;
+        per_page: number;
+        total: number;
+        total_pages: number;
+    };
+}
+/** Single resource response */
+interface SingleResponse<T> {
+    data: T;
+}
+/** Product resource from the API */
+interface Product {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    price: number;
+    compare_price: number | null;
+    main_image: string | null;
+    gallery: string[];
+    is_active: boolean;
+    is_featured: boolean;
+    sku: string | null;
+    track_inventory: boolean;
+    stock_quantity: number;
+    condition: string;
+    is_purchasable: boolean;
+    has_discount: boolean;
+    discount_percentage: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Order resource from the API */
+interface Order {
+    id: string;
+    status: string;
+    total: number;
+    currency: string;
+    customer_name: string;
+    customer_phone: string;
+    items_count: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Customer resource from the API */
+interface Customer {
+    id: string;
+    name: string;
+    phone: string;
+    email: string | null;
+    orders_count: number;
+    total_spent: number;
+    created_at: string;
+}
+/** Category resource from the API */
+interface Category {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    image: string | null;
+    products_count: number;
+    is_active: boolean;
+    position: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Discount resource from the API */
+interface Discount {
+    id: string;
+    name: string;
+    code: string;
+    type: "percentage" | "fixed";
+    value: number;
+    min_order_amount: number | null;
+    max_uses: number | null;
+    used_count: number;
+    starts_at: string | null;
+    ends_at: string | null;
+    is_active: boolean;
+    created_at: string;
+}
+/** Store resource from the API */
+interface Store {
+    id: string;
+    name: string;
+    slug: string;
+    domain: string | null;
+    logo: string | null;
+    description: string | null;
+    currency: string;
+    country: string;
+    timezone: string;
+    is_active: boolean;
+    created_at: string;
+}
+/** Inventory details for a product */
+interface InventoryItem {
+    product_id: string;
+    sku: string | null;
+    stock_quantity: number;
+    track_inventory: boolean;
+    low_stock_threshold: number | null;
+}
+/** Webhook resource from the API */
+interface Webhook {
+    id: string;
+    url: string;
+    events: string[];
+    is_active: boolean;
+    created_at: string;
+}
+/** Params for listing products */
+interface ListProductsParams {
+    page?: number;
+    per_page?: number;
+    sort?: "name" | "price" | "created_at" | "updated_at";
+    order?: "asc" | "desc";
+    search?: string;
+    status?: "active" | "inactive" | "all";
+    category_id?: string;
+    is_featured?: boolean;
+}
+/** Params for creating a product */
+interface CreateProductParams {
+    name: string;
+    slug?: string;
+    description?: string;
+    price: number;
+    compare_price?: number | null;
+    category_id?: string;
+    main_image?: string;
+    gallery?: string[];
+    is_active?: boolean;
+    is_featured?: boolean;
+    sku?: string;
+    track_inventory?: boolean;
+    stock_quantity?: number;
+    condition?: "new" | "original" | "used_like_new";
+}
+/** Params for updating a product */
+interface UpdateProductParams {
+    name?: string;
+    slug?: string;
+    description?: string;
+    price?: number;
+    compare_price?: number | null;
+    main_image?: string | null;
+    gallery?: string[];
+    is_active?: boolean;
+    is_featured?: boolean;
+    sku?: string | null;
+    track_inventory?: boolean;
+    stock_quantity?: number;
+    condition?: "new" | "original" | "used_like_new";
+}
+/** Params for listing orders */
+interface ListOrdersParams {
+    page?: number;
+    per_page?: number;
+    sort?: string;
+    order?: "asc" | "desc";
+    status?: string;
+    date_from?: string;
+    date_to?: string;
+    customer_id?: string;
+}
+/** Params for listing customers */
+interface ListCustomersParams {
+    page?: number;
+    per_page?: number;
+    search?: string;
+}
+/** Params for listing categories */
+interface ListCategoriesParams {
+    page?: number;
+    per_page?: number;
+    sort?: "name" | "position" | "created_at" | "updated_at";
+    order?: "asc" | "desc";
+    search?: string;
+    status?: "active" | "inactive" | "all";
+}
+/** Params for creating a category */
+interface CreateCategoryParams {
+    name: string;
+    slug?: string;
+    description?: string;
+    image?: string;
+    is_active?: boolean;
+    position?: number;
+}
+/** Params for updating a category */
+interface UpdateCategoryParams {
+    name?: string;
+    slug?: string;
+    description?: string | null;
+    image?: string | null;
+    is_active?: boolean;
+    position?: number;
+}
+/** Params for listing discounts */
+interface ListDiscountsParams {
+    page?: number;
+    per_page?: number;
+    sort?: "name" | "code" | "created_at" | "starts_at" | "ends_at";
+    order?: "asc" | "desc";
+    search?: string;
+    status?: "active" | "inactive" | "all";
+    type?: "percentage" | "fixed";
+}
+/** Params for creating a discount */
+interface CreateDiscountParams {
+    name: string;
+    code: string;
+    type: "percentage" | "fixed";
+    value: number;
+    min_order_amount?: number | null;
+    max_uses?: number | null;
+    starts_at?: string | null;
+    ends_at?: string | null;
+    is_active?: boolean;
+}
+/** Params for updating a discount */
+interface UpdateDiscountParams {
+    name?: string;
+    code?: string;
+    type?: "percentage" | "fixed";
+    value?: number;
+    min_order_amount?: number | null;
+    max_uses?: number | null;
+    starts_at?: string | null;
+    ends_at?: string | null;
+    is_active?: boolean;
+}
+/** Params for creating/updating webhooks */
+interface UpsertWebhookParams {
+    url: string;
+    events: string[];
+    secret?: string;
+}
+/** Params for updating an existing webhook */
+interface UpdateWebhookParams {
+    url?: string;
+    events?: string[];
+}
+/** Params for adjusting product inventory */
+interface AdjustInventoryParams {
+    quantity: number;
+    reason: string;
+}
+
+export type { AdjustInventoryParams as A, CreateProductParams as C, Discount as D, InventoryItem as I, ListProductsParams as L, Order as O, PaginatedResponse as P, RateLimitInfo as R, SingleResponse as S, UpdateProductParams as U, Webhook as W, Product as a, ListOrdersParams as b, ListCustomersParams as c, Customer as d, ListCategoriesParams as e, Category as f, CreateCategoryParams as g, UpdateCategoryParams as h, ListDiscountsParams as i, CreateDiscountParams as j, UpdateDiscountParams as k, Store as l, UpsertWebhookParams as m, UpdateWebhookParams as n, WhataloClientOptions as o };