@managesales/storefront 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,316 @@
+/**
+ * ManageSales Storefront SDK
+ * --------------------------
+ * Resource-based client for building online storefronts.
+ * Works with any framework: Next.js, Remix, Nuxt, Astro, plain HTML.
+ *
+ * Usage:
+ *   import { createStorefrontClient } from "./managesales-storefront";
+ *   const client = createStorefrontClient({ workspaceId: "<workspace_id>" });
+ *   const products = await client.products.list();
+ */
+interface StorefrontConfig {
+    /** Your workspace ID (required) */
+    workspaceId: string;
+    /** API base URL — defaults to production */
+    apiUrl?: string;
+    /** Custom fetch implementation (for SSR / edge) */
+    customFetch?: typeof fetch;
+    /** Default locale for content */
+    locale?: string;
+}
+interface ListParams {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sort?: string;
+    order?: "asc" | "desc";
+    [key: string]: unknown;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+interface Product {
+    id: string;
+    name: string;
+    slug: string;
+    description: string;
+    status: string;
+    price: number;
+    compareAtPrice?: number;
+    currency: string;
+    images: ProductImage[];
+    variants: ProductVariant[];
+    category?: {
+        id: string;
+        name: string;
+    };
+    brand?: {
+        id: string;
+        name: string;
+    };
+    tags: string[];
+    metadata: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ProductImage {
+    id: string;
+    url: string;
+    alt: string;
+    position: number;
+}
+interface ProductVariant {
+    id: string;
+    name: string;
+    sku: string;
+    price: number;
+    compareAtPrice?: number;
+    inventory: number;
+    options: Record<string, string>;
+}
+interface Collection {
+    id: string;
+    name: string;
+    slug: string;
+    description: string;
+    image?: string;
+    productCount: number;
+}
+interface CheckoutLineItem {
+    productId: string;
+    variantId?: string;
+    quantity: number;
+}
+interface CheckoutSession {
+    id: string;
+    status: "open" | "completed" | "expired";
+    items: CheckoutLineItem[];
+    subtotal: number;
+    tax: number;
+    shipping: number;
+    discount: number;
+    total: number;
+    currency: string;
+    couponCode?: string;
+}
+interface Order {
+    id: string;
+    orderNumber: string;
+    status: string;
+    total: number;
+    currency: string;
+    items: OrderItem[];
+    createdAt: string;
+}
+interface OrderItem {
+    productId: string;
+    name: string;
+    quantity: number;
+    price: number;
+}
+interface Customer {
+    id: string;
+    email: string;
+    name: string;
+    phone?: string;
+    createdAt: string;
+}
+interface AuthSession {
+    customer: Customer;
+    accessToken: string;
+    refreshToken: string;
+}
+interface Address {
+    id: string;
+    label?: string;
+    line1: string;
+    line2?: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    country: string;
+    isDefault: boolean;
+}
+interface BlogPost {
+    id: string;
+    title: string;
+    slug: string;
+    excerpt: string;
+    content: string;
+    coverImage?: string;
+    tags: string[];
+    publishedAt: string;
+}
+interface BookableService {
+    id: string;
+    name: string;
+    duration: number;
+    price: number;
+    description: string;
+}
+interface TimeSlot {
+    start: string;
+    end: string;
+    available: boolean;
+}
+interface Booking {
+    id: string;
+    serviceId: string;
+    date: string;
+    startTime: string;
+    endTime: string;
+    status: string;
+    customer: {
+        name: string;
+        email: string;
+    };
+}
+interface FormDefinition {
+    id: string;
+    title: string;
+    description: string;
+    fields: FormField[];
+}
+interface FormField {
+    id: string;
+    type: string;
+    label: string;
+    required: boolean;
+    options?: string[];
+    placeholder?: string;
+}
+interface StoreConfig {
+    name: string;
+    slug: string;
+    logo?: string;
+    theme: Record<string, unknown>;
+    currency: string;
+    locale: string;
+}
+declare class StorefrontError extends Error {
+    status: number;
+    code: string;
+    details?: unknown;
+    constructor(status: number, code: string, message: string, details?: unknown);
+}
+declare function createStorefrontClient(config: StorefrontConfig): {
+    store: {
+        /** Resolve store config by workspace (returns theme, branding, currency) */
+        resolve(): Promise<StoreConfig>;
+    };
+    products: {
+        /** List published products with pagination and filters */
+        list(params?: ListParams): Promise<PaginatedResponse<Product>>;
+        /** Get a single product by ID or slug */
+        get(idOrSlug: string): Promise<Product>;
+        /** Search products (shorthand for list with search param) */
+        search(query: string, params?: ListParams): Promise<PaginatedResponse<Product>>;
+    };
+    collections: {
+        /** List published collections */
+        list(params?: ListParams): Promise<PaginatedResponse<Collection>>;
+        /** Get a collection with its products */
+        get(idOrSlug: string): Promise<Collection & {
+            products: Product[];
+        }>;
+    };
+    checkout: {
+        /** Create a checkout session from cart items */
+        create(items: CheckoutLineItem[]): Promise<CheckoutSession>;
+        /** Retrieve an existing checkout session */
+        get(checkoutId: string): Promise<CheckoutSession>;
+        /** Apply a coupon or discount code */
+        applyCoupon(checkoutId: string, couponCode: string): Promise<CheckoutSession>;
+        /** Complete checkout — process payment and create order */
+        complete(checkoutId: string, payment?: Record<string, unknown>): Promise<Order>;
+    };
+    auth: {
+        /** Register a new customer account */
+        register(data: {
+            email: string;
+            password: string;
+            name: string;
+            phone?: string;
+        }): Promise<AuthSession>;
+        /** Log in with email + password */
+        login(email: string, password: string): Promise<AuthSession>;
+        /** Log in with Google ID token */
+        loginWithGoogle(idToken: string): Promise<AuthSession>;
+        /** Log out and clear local session */
+        logout(): Promise<void>;
+        /** Refresh the access token */
+        refresh(): Promise<boolean>;
+        /** Check if client has a valid session */
+        isAuthenticated(): boolean;
+        /** Manually set tokens (e.g., from SSR or cookie restoration) */
+        setTokens(access: string, refresh: string): void;
+    };
+    customer: {
+        /** Get current customer profile */
+        me(): Promise<Customer>;
+        /** Get customer's order history */
+        orders(params?: ListParams): Promise<PaginatedResponse<Order>>;
+        /** Get customer's saved addresses */
+        addresses(): Promise<Address[]>;
+    };
+    blog: {
+        /** List published blog posts */
+        list(params?: ListParams & {
+            tags?: string;
+        }): Promise<PaginatedResponse<BlogPost>>;
+        /** Get a blog post by slug */
+        get(slug: string): Promise<BlogPost>;
+    };
+    bookings: {
+        /** List bookable services */
+        services(): Promise<BookableService[]>;
+        /** List bookable staff */
+        staff(): Promise<Array<{
+            id: string;
+            name: string;
+            avatar?: string;
+        }>>;
+        /** Check available time slots */
+        availability(params: {
+            serviceId: string;
+            date: string;
+            staffId?: string;
+        }): Promise<TimeSlot[]>;
+        /** Create a booking */
+        book(data: {
+            serviceId: string;
+            date: string;
+            startTime: string;
+            staffId?: string;
+            customer: {
+                name: string;
+                email: string;
+                phone?: string;
+            };
+        }): Promise<Booking>;
+    };
+    forms: {
+        /** Get a published form by ID or slug */
+        get(idOrSlug: string): Promise<FormDefinition>;
+        /** Submit form response */
+        submit(formId: string, data: Record<string, unknown>): Promise<{
+            id: string;
+        }>;
+        /** Upload file for a form file field */
+        uploadFile(formId: string, file: File): Promise<{
+            url: string;
+        }>;
+    };
+    cart: {
+        /** Recover an abandoned cart by recovery token */
+        recover(token: string): Promise<CheckoutSession>;
+    };
+};
+type StorefrontClient = ReturnType<typeof createStorefrontClient>;
+
+export { type Address, type AuthSession, type BlogPost, type BookableService, type Booking, type CheckoutLineItem, type CheckoutSession, type Collection, type Customer, type FormDefinition, type FormField, type ListParams, type Order, type OrderItem, type PaginatedResponse, type Product, type ProductImage, type ProductVariant, type StoreConfig, type StorefrontClient, type StorefrontConfig, StorefrontError, type TimeSlot, createStorefrontClient };

package/dist/index.d.ts

@@ -0,0 +1,316 @@
+/**
+ * ManageSales Storefront SDK
+ * --------------------------
+ * Resource-based client for building online storefronts.
+ * Works with any framework: Next.js, Remix, Nuxt, Astro, plain HTML.
+ *
+ * Usage:
+ *   import { createStorefrontClient } from "./managesales-storefront";
+ *   const client = createStorefrontClient({ workspaceId: "<workspace_id>" });
+ *   const products = await client.products.list();
+ */
+interface StorefrontConfig {
+    /** Your workspace ID (required) */
+    workspaceId: string;
+    /** API base URL — defaults to production */
+    apiUrl?: string;
+    /** Custom fetch implementation (for SSR / edge) */
+    customFetch?: typeof fetch;
+    /** Default locale for content */
+    locale?: string;
+}
+interface ListParams {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sort?: string;
+    order?: "asc" | "desc";
+    [key: string]: unknown;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+interface Product {
+    id: string;
+    name: string;
+    slug: string;
+    description: string;
+    status: string;
+    price: number;
+    compareAtPrice?: number;
+    currency: string;
+    images: ProductImage[];
+    variants: ProductVariant[];
+    category?: {
+        id: string;
+        name: string;
+    };
+    brand?: {
+        id: string;
+        name: string;
+    };
+    tags: string[];
+    metadata: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ProductImage {
+    id: string;
+    url: string;
+    alt: string;
+    position: number;
+}
+interface ProductVariant {
+    id: string;
+    name: string;
+    sku: string;
+    price: number;
+    compareAtPrice?: number;
+    inventory: number;
+    options: Record<string, string>;
+}
+interface Collection {
+    id: string;
+    name: string;
+    slug: string;
+    description: string;
+    image?: string;
+    productCount: number;
+}
+interface CheckoutLineItem {
+    productId: string;
+    variantId?: string;
+    quantity: number;
+}
+interface CheckoutSession {
+    id: string;
+    status: "open" | "completed" | "expired";
+    items: CheckoutLineItem[];
+    subtotal: number;
+    tax: number;
+    shipping: number;
+    discount: number;
+    total: number;
+    currency: string;
+    couponCode?: string;
+}
+interface Order {
+    id: string;
+    orderNumber: string;
+    status: string;
+    total: number;
+    currency: string;
+    items: OrderItem[];
+    createdAt: string;
+}
+interface OrderItem {
+    productId: string;
+    name: string;
+    quantity: number;
+    price: number;
+}
+interface Customer {
+    id: string;
+    email: string;
+    name: string;
+    phone?: string;
+    createdAt: string;
+}
+interface AuthSession {
+    customer: Customer;
+    accessToken: string;
+    refreshToken: string;
+}
+interface Address {
+    id: string;
+    label?: string;
+    line1: string;
+    line2?: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    country: string;
+    isDefault: boolean;
+}
+interface BlogPost {
+    id: string;
+    title: string;
+    slug: string;
+    excerpt: string;
+    content: string;
+    coverImage?: string;
+    tags: string[];
+    publishedAt: string;
+}
+interface BookableService {
+    id: string;
+    name: string;
+    duration: number;
+    price: number;
+    description: string;
+}
+interface TimeSlot {
+    start: string;
+    end: string;
+    available: boolean;
+}
+interface Booking {
+    id: string;
+    serviceId: string;
+    date: string;
+    startTime: string;
+    endTime: string;
+    status: string;
+    customer: {
+        name: string;
+        email: string;
+    };
+}
+interface FormDefinition {
+    id: string;
+    title: string;
+    description: string;
+    fields: FormField[];
+}
+interface FormField {
+    id: string;
+    type: string;
+    label: string;
+    required: boolean;
+    options?: string[];
+    placeholder?: string;
+}
+interface StoreConfig {
+    name: string;
+    slug: string;
+    logo?: string;
+    theme: Record<string, unknown>;
+    currency: string;
+    locale: string;
+}
+declare class StorefrontError extends Error {
+    status: number;
+    code: string;
+    details?: unknown;
+    constructor(status: number, code: string, message: string, details?: unknown);
+}
+declare function createStorefrontClient(config: StorefrontConfig): {
+    store: {
+        /** Resolve store config by workspace (returns theme, branding, currency) */
+        resolve(): Promise<StoreConfig>;
+    };
+    products: {
+        /** List published products with pagination and filters */
+        list(params?: ListParams): Promise<PaginatedResponse<Product>>;
+        /** Get a single product by ID or slug */
+        get(idOrSlug: string): Promise<Product>;
+        /** Search products (shorthand for list with search param) */
+        search(query: string, params?: ListParams): Promise<PaginatedResponse<Product>>;
+    };
+    collections: {
+        /** List published collections */
+        list(params?: ListParams): Promise<PaginatedResponse<Collection>>;
+        /** Get a collection with its products */
+        get(idOrSlug: string): Promise<Collection & {
+            products: Product[];
+        }>;
+    };
+    checkout: {
+        /** Create a checkout session from cart items */
+        create(items: CheckoutLineItem[]): Promise<CheckoutSession>;
+        /** Retrieve an existing checkout session */
+        get(checkoutId: string): Promise<CheckoutSession>;
+        /** Apply a coupon or discount code */
+        applyCoupon(checkoutId: string, couponCode: string): Promise<CheckoutSession>;
+        /** Complete checkout — process payment and create order */
+        complete(checkoutId: string, payment?: Record<string, unknown>): Promise<Order>;
+    };
+    auth: {
+        /** Register a new customer account */
+        register(data: {
+            email: string;
+            password: string;
+            name: string;
+            phone?: string;
+        }): Promise<AuthSession>;
+        /** Log in with email + password */
+        login(email: string, password: string): Promise<AuthSession>;
+        /** Log in with Google ID token */
+        loginWithGoogle(idToken: string): Promise<AuthSession>;
+        /** Log out and clear local session */
+        logout(): Promise<void>;
+        /** Refresh the access token */
+        refresh(): Promise<boolean>;
+        /** Check if client has a valid session */
+        isAuthenticated(): boolean;
+        /** Manually set tokens (e.g., from SSR or cookie restoration) */
+        setTokens(access: string, refresh: string): void;
+    };
+    customer: {
+        /** Get current customer profile */
+        me(): Promise<Customer>;
+        /** Get customer's order history */
+        orders(params?: ListParams): Promise<PaginatedResponse<Order>>;
+        /** Get customer's saved addresses */
+        addresses(): Promise<Address[]>;
+    };
+    blog: {
+        /** List published blog posts */
+        list(params?: ListParams & {
+            tags?: string;
+        }): Promise<PaginatedResponse<BlogPost>>;
+        /** Get a blog post by slug */
+        get(slug: string): Promise<BlogPost>;
+    };
+    bookings: {
+        /** List bookable services */
+        services(): Promise<BookableService[]>;
+        /** List bookable staff */
+        staff(): Promise<Array<{
+            id: string;
+            name: string;
+            avatar?: string;
+        }>>;
+        /** Check available time slots */
+        availability(params: {
+            serviceId: string;
+            date: string;
+            staffId?: string;
+        }): Promise<TimeSlot[]>;
+        /** Create a booking */
+        book(data: {
+            serviceId: string;
+            date: string;
+            startTime: string;
+            staffId?: string;
+            customer: {
+                name: string;
+                email: string;
+                phone?: string;
+            };
+        }): Promise<Booking>;
+    };
+    forms: {
+        /** Get a published form by ID or slug */
+        get(idOrSlug: string): Promise<FormDefinition>;
+        /** Submit form response */
+        submit(formId: string, data: Record<string, unknown>): Promise<{
+            id: string;
+        }>;
+        /** Upload file for a form file field */
+        uploadFile(formId: string, file: File): Promise<{
+            url: string;
+        }>;
+    };
+    cart: {
+        /** Recover an abandoned cart by recovery token */
+        recover(token: string): Promise<CheckoutSession>;
+    };
+};
+type StorefrontClient = ReturnType<typeof createStorefrontClient>;
+
+export { type Address, type AuthSession, type BlogPost, type BookableService, type Booking, type CheckoutLineItem, type CheckoutSession, type Collection, type Customer, type FormDefinition, type FormField, type ListParams, type Order, type OrderItem, type PaginatedResponse, type Product, type ProductImage, type ProductVariant, type StoreConfig, type StorefrontClient, type StorefrontConfig, StorefrontError, type TimeSlot, createStorefrontClient };