@tiquo/dom-package 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,323 @@
+/**
+ * @tiquo/dom-package
+ *
+ * Customer authentication SDK for third-party websites using Tiquo.
+ * Enables email OTP authentication without passwords.
+ *
+ * @example
+ * ```typescript
+ * import { TiquoAuth } from '@tiquo/dom-package';
+ *
+ * const auth = new TiquoAuth({
+ *   publicKey: 'pk_dom_xxxxx'
+ * });
+ *
+ * // Send OTP
+ * await auth.sendOTP('user@example.com');
+ *
+ * // Verify OTP
+ * const result = await auth.verifyOTP('user@example.com', '123456');
+ *
+ * // Get current user
+ * const user = await auth.getUser();
+ *
+ * // Logout
+ * await auth.logout();
+ * ```
+ */
+interface TiquoAuthConfig {
+    /** Public key from your Tiquo Auth DOM settings */
+    publicKey: string;
+    /** API endpoint (defaults to production) */
+    apiEndpoint?: string;
+    /** Storage key prefix for session data */
+    storagePrefix?: string;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Enable multi-tab session sync via BroadcastChannel (default: true) */
+    enableTabSync?: boolean;
+}
+interface TiquoUser {
+    id: string;
+    email: string;
+}
+interface TiquoCustomer {
+    id: string;
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    customerNumber: string;
+    email?: string;
+    phone?: string;
+}
+interface TiquoSession {
+    user: TiquoUser;
+    customer: TiquoCustomer | null;
+    expiresAt: number;
+}
+interface SendOTPResult {
+    success: boolean;
+    message: string;
+}
+interface VerifyOTPResult {
+    success: boolean;
+    sessionToken: string;
+    expiresAt: number;
+    isNewUser: boolean;
+    hasCustomer: boolean;
+}
+interface IframeTokenResult {
+    token: string;
+    expiresAt: number;
+}
+interface ProfileUpdateData {
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    phone?: string;
+    profilePhoto?: string;
+}
+interface ProfileUpdateResult {
+    success: boolean;
+    customer: TiquoCustomer & {
+        profilePhoto?: string;
+    };
+}
+interface TiquoOrderItem {
+    id: string;
+    name: string;
+    quantity: number;
+    unitPrice: number;
+    total: number;
+    type: 'product' | 'booking' | 'custom';
+}
+interface TiquoOrder {
+    id: string;
+    orderNumber: string;
+    status: 'draft' | 'pending' | 'confirmed' | 'processing' | 'completed' | 'cancelled' | 'refunded' | 'open_tab';
+    paymentStatus: 'pending' | 'paid' | 'partial' | 'refunded' | 'failed' | 'cancelled';
+    total: number;
+    subtotal: number;
+    taxTotal: number;
+    discountTotal: number;
+    items: TiquoOrderItem[];
+    createdAt: number;
+    completedAt?: number;
+    customerRole: 'primary' | 'attendee' | 'recipient' | 'billing' | 'guest' | 'other';
+}
+interface GetOrdersOptions {
+    limit?: number;
+    cursor?: string;
+    status?: TiquoOrder['status'];
+}
+interface GetOrdersResult {
+    orders: TiquoOrder[];
+    hasMore: boolean;
+    nextCursor?: string;
+}
+interface TiquoBooking {
+    id: string;
+    bookingNumber: string;
+    confirmationCode: string;
+    status: 'draft' | 'scheduled' | 'confirmed' | 'reminder_sent' | 'waiting_room' | 'waiting_list' | 'checked_in' | 'active' | 'in_progress' | 'completed' | 'cancelled' | 'no_show' | 'rescheduled';
+    date: number;
+    startTime: string;
+    endTime: string;
+    duration: number;
+    timezone: string;
+    attendeeCount: number;
+    serviceName: string;
+    serviceId: string;
+    sublocationId: string;
+    customerNotes?: string;
+    createdAt: number;
+    checkedInAt?: number;
+    completedAt?: number;
+    cancelledAt?: number;
+}
+interface GetBookingsOptions {
+    limit?: number;
+    cursor?: string;
+    status?: TiquoBooking['status'];
+    upcoming?: boolean;
+}
+interface GetBookingsResult {
+    bookings: TiquoBooking[];
+    hasMore: boolean;
+    nextCursor?: string;
+}
+interface TiquoEnquiry {
+    id: string;
+    enquiryNumber: string;
+    type: string;
+    subject: string;
+    message: string;
+    category: string;
+    status: 'new' | 'in_progress' | 'waiting_customer' | 'waiting_internal' | 'won' | 'lost' | 'closed' | 'resolved' | 'archived';
+    priority: 'low' | 'medium' | 'high' | 'urgent';
+    source: 'online' | 'website' | 'phone' | 'email' | 'walk_in' | 'social' | 'referral' | 'pos' | 'admin';
+    responseCount: number;
+    createdAt: string;
+    updatedAt: string;
+    firstResponseAt?: string;
+    resolvedAt?: string;
+    customerRole: 'primary' | 'interested' | 'decision_maker' | 'influencer' | 'referrer' | 'other';
+}
+interface GetEnquiriesOptions {
+    limit?: number;
+    cursor?: string;
+    status?: TiquoEnquiry['status'];
+}
+interface GetEnquiriesResult {
+    enquiries: TiquoEnquiry[];
+    hasMore: boolean;
+    nextCursor?: string;
+}
+type AuthStateChangeCallback = (session: TiquoSession | null) => void;
+declare class TiquoAuthError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined);
+}
+declare class TiquoAuth {
+    private config;
+    private sessionToken;
+    private session;
+    private listeners;
+    private refreshTimer;
+    private broadcastChannel;
+    private tabId;
+    private isProcessingTabSync;
+    constructor(config: TiquoAuthConfig);
+    /**
+     * Send an OTP verification code to the user's email
+     */
+    sendOTP(email: string): Promise<SendOTPResult>;
+    /**
+     * Verify an OTP code and authenticate the user
+     */
+    verifyOTP(email: string, otp: string): Promise<VerifyOTPResult>;
+    /**
+     * Get the current authenticated user and customer data
+     */
+    getUser(): Promise<TiquoSession | null>;
+    /**
+     * Check if user is currently authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Update the authenticated customer's profile
+     * Only allows updating the logged-in customer's own data
+     */
+    updateProfile(updates: ProfileUpdateData): Promise<ProfileUpdateResult>;
+    /**
+     * Log out the current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Subscribe to authentication state changes
+     */
+    onAuthStateChange(callback: AuthStateChangeCallback): () => void;
+    /**
+     * Get the authenticated customer's order history
+     * Only returns orders for the logged-in customer
+     */
+    getOrders(options?: GetOrdersOptions): Promise<GetOrdersResult>;
+    /**
+     * Get the authenticated customer's booking history
+     * Only returns bookings for the logged-in customer
+     */
+    getBookings(options?: GetBookingsOptions): Promise<GetBookingsResult>;
+    /**
+     * Get the authenticated customer's enquiry history
+     * Only returns enquiries for the logged-in customer
+     */
+    getEnquiries(options?: GetEnquiriesOptions): Promise<GetEnquiriesResult>;
+    /**
+     * Generate a short-lived token for customer flow iframe authentication
+     */
+    getIframeToken(customerFlowId?: string): Promise<IframeTokenResult>;
+    /**
+     * Embed a customer flow with automatic authentication
+     *
+     * @param flowUrl - The URL of the customer flow (book.tiquo.app/...)
+     * @param container - Container element or selector
+     * @param options - Optional iframe configuration
+     */
+    embedCustomerFlow(flowUrl: string, container: HTMLElement | string, options?: {
+        width?: string;
+        height?: string;
+        onLoad?: () => void;
+        onError?: (error: Error) => void;
+    }): Promise<HTMLIFrameElement>;
+    /**
+     * Get the current session token (for advanced use cases)
+     */
+    getSessionToken(): string | null;
+    private request;
+    private refreshSession;
+    private saveSession;
+    private restoreSession;
+    private clearSession;
+    private notifyListeners;
+    private scheduleRefresh;
+    private log;
+    private generateTabId;
+    private initTabSync;
+    private broadcastTabSync;
+    private handleTabSyncMessage;
+    /**
+     * Clean up resources (call when destroying the auth instance)
+     */
+    destroy(): void;
+}
+/**
+ * React hook for using TiquoAuth
+ * Note: Requires a TiquoAuth instance to be passed in
+ *
+ * @example
+ * ```tsx
+ * const auth = new TiquoAuth({ publicKey: 'pk_dom_xxx' });
+ *
+ * function App() {
+ *   const { user, isLoading, isAuthenticated, logout } = useTiquoAuth(auth);
+ *
+ *   if (isLoading) return <div>Loading...</div>;
+ *
+ *   if (!isAuthenticated) {
+ *     return <LoginForm auth={auth} />;
+ *   }
+ *
+ *   return (
+ *     <div>
+ *       Welcome, {user?.email}
+ *       <button onClick={logout}>Logout</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useTiquoAuth(auth: TiquoAuth): {
+    readonly user: TiquoUser | null;
+    readonly customer: TiquoCustomer | null;
+    readonly session: TiquoSession | null;
+    readonly isLoading: boolean;
+    readonly isAuthenticated: boolean;
+    sendOTP: (email: string) => Promise<SendOTPResult>;
+    verifyOTP: (email: string, otp: string) => Promise<VerifyOTPResult>;
+    logout: () => Promise<void>;
+    updateProfile: (updates: ProfileUpdateData) => Promise<ProfileUpdateResult>;
+    getOrders: (options?: GetOrdersOptions) => Promise<GetOrdersResult>;
+    getBookings: (options?: GetBookingsOptions) => Promise<GetBookingsResult>;
+    getEnquiries: (options?: GetEnquiriesOptions) => Promise<GetEnquiriesResult>;
+    getIframeToken: (flowId?: string) => Promise<IframeTokenResult>;
+    embedCustomerFlow: (flowUrl: string, container: HTMLElement | string, options?: {
+        width?: string;
+        height?: string;
+        onLoad?: () => void;
+        onError?: (error: Error) => void;
+    }) => Promise<HTMLIFrameElement>;
+    onAuthStateChange: (cb: AuthStateChangeCallback) => () => void;
+};
+
+export { type AuthStateChangeCallback, type GetBookingsOptions, type GetBookingsResult, type GetEnquiriesOptions, type GetEnquiriesResult, type GetOrdersOptions, type GetOrdersResult, type IframeTokenResult, type ProfileUpdateData, type ProfileUpdateResult, type SendOTPResult, TiquoAuth, type TiquoAuthConfig, TiquoAuthError, type TiquoBooking, type TiquoCustomer, type TiquoEnquiry, type TiquoOrder, type TiquoOrderItem, type TiquoSession, type TiquoUser, type VerifyOTPResult, TiquoAuth as default, useTiquoAuth };

package/dist/index.d.ts

@@ -0,0 +1,323 @@
+/**
+ * @tiquo/dom-package
+ *
+ * Customer authentication SDK for third-party websites using Tiquo.
+ * Enables email OTP authentication without passwords.
+ *
+ * @example
+ * ```typescript
+ * import { TiquoAuth } from '@tiquo/dom-package';
+ *
+ * const auth = new TiquoAuth({
+ *   publicKey: 'pk_dom_xxxxx'
+ * });
+ *
+ * // Send OTP
+ * await auth.sendOTP('user@example.com');
+ *
+ * // Verify OTP
+ * const result = await auth.verifyOTP('user@example.com', '123456');
+ *
+ * // Get current user
+ * const user = await auth.getUser();
+ *
+ * // Logout
+ * await auth.logout();
+ * ```
+ */
+interface TiquoAuthConfig {
+    /** Public key from your Tiquo Auth DOM settings */
+    publicKey: string;
+    /** API endpoint (defaults to production) */
+    apiEndpoint?: string;
+    /** Storage key prefix for session data */
+    storagePrefix?: string;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Enable multi-tab session sync via BroadcastChannel (default: true) */
+    enableTabSync?: boolean;
+}
+interface TiquoUser {
+    id: string;
+    email: string;
+}
+interface TiquoCustomer {
+    id: string;
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    customerNumber: string;
+    email?: string;
+    phone?: string;
+}
+interface TiquoSession {
+    user: TiquoUser;
+    customer: TiquoCustomer | null;
+    expiresAt: number;
+}
+interface SendOTPResult {
+    success: boolean;
+    message: string;
+}
+interface VerifyOTPResult {
+    success: boolean;
+    sessionToken: string;
+    expiresAt: number;
+    isNewUser: boolean;
+    hasCustomer: boolean;
+}
+interface IframeTokenResult {
+    token: string;
+    expiresAt: number;
+}
+interface ProfileUpdateData {
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    phone?: string;
+    profilePhoto?: string;
+}
+interface ProfileUpdateResult {
+    success: boolean;
+    customer: TiquoCustomer & {
+        profilePhoto?: string;
+    };
+}
+interface TiquoOrderItem {
+    id: string;
+    name: string;
+    quantity: number;
+    unitPrice: number;
+    total: number;
+    type: 'product' | 'booking' | 'custom';
+}
+interface TiquoOrder {
+    id: string;
+    orderNumber: string;
+    status: 'draft' | 'pending' | 'confirmed' | 'processing' | 'completed' | 'cancelled' | 'refunded' | 'open_tab';
+    paymentStatus: 'pending' | 'paid' | 'partial' | 'refunded' | 'failed' | 'cancelled';
+    total: number;
+    subtotal: number;
+    taxTotal: number;
+    discountTotal: number;
+    items: TiquoOrderItem[];
+    createdAt: number;
+    completedAt?: number;
+    customerRole: 'primary' | 'attendee' | 'recipient' | 'billing' | 'guest' | 'other';
+}
+interface GetOrdersOptions {
+    limit?: number;
+    cursor?: string;
+    status?: TiquoOrder['status'];
+}
+interface GetOrdersResult {
+    orders: TiquoOrder[];
+    hasMore: boolean;
+    nextCursor?: string;
+}
+interface TiquoBooking {
+    id: string;
+    bookingNumber: string;
+    confirmationCode: string;
+    status: 'draft' | 'scheduled' | 'confirmed' | 'reminder_sent' | 'waiting_room' | 'waiting_list' | 'checked_in' | 'active' | 'in_progress' | 'completed' | 'cancelled' | 'no_show' | 'rescheduled';
+    date: number;
+    startTime: string;
+    endTime: string;
+    duration: number;
+    timezone: string;
+    attendeeCount: number;
+    serviceName: string;
+    serviceId: string;
+    sublocationId: string;
+    customerNotes?: string;
+    createdAt: number;
+    checkedInAt?: number;
+    completedAt?: number;
+    cancelledAt?: number;
+}
+interface GetBookingsOptions {
+    limit?: number;
+    cursor?: string;
+    status?: TiquoBooking['status'];
+    upcoming?: boolean;
+}
+interface GetBookingsResult {
+    bookings: TiquoBooking[];
+    hasMore: boolean;
+    nextCursor?: string;
+}
+interface TiquoEnquiry {
+    id: string;
+    enquiryNumber: string;
+    type: string;
+    subject: string;
+    message: string;
+    category: string;
+    status: 'new' | 'in_progress' | 'waiting_customer' | 'waiting_internal' | 'won' | 'lost' | 'closed' | 'resolved' | 'archived';
+    priority: 'low' | 'medium' | 'high' | 'urgent';
+    source: 'online' | 'website' | 'phone' | 'email' | 'walk_in' | 'social' | 'referral' | 'pos' | 'admin';
+    responseCount: number;
+    createdAt: string;
+    updatedAt: string;
+    firstResponseAt?: string;
+    resolvedAt?: string;
+    customerRole: 'primary' | 'interested' | 'decision_maker' | 'influencer' | 'referrer' | 'other';
+}
+interface GetEnquiriesOptions {
+    limit?: number;
+    cursor?: string;
+    status?: TiquoEnquiry['status'];
+}
+interface GetEnquiriesResult {
+    enquiries: TiquoEnquiry[];
+    hasMore: boolean;
+    nextCursor?: string;
+}
+type AuthStateChangeCallback = (session: TiquoSession | null) => void;
+declare class TiquoAuthError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined);
+}
+declare class TiquoAuth {
+    private config;
+    private sessionToken;
+    private session;
+    private listeners;
+    private refreshTimer;
+    private broadcastChannel;
+    private tabId;
+    private isProcessingTabSync;
+    constructor(config: TiquoAuthConfig);
+    /**
+     * Send an OTP verification code to the user's email
+     */
+    sendOTP(email: string): Promise<SendOTPResult>;
+    /**
+     * Verify an OTP code and authenticate the user
+     */
+    verifyOTP(email: string, otp: string): Promise<VerifyOTPResult>;
+    /**
+     * Get the current authenticated user and customer data
+     */
+    getUser(): Promise<TiquoSession | null>;
+    /**
+     * Check if user is currently authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Update the authenticated customer's profile
+     * Only allows updating the logged-in customer's own data
+     */
+    updateProfile(updates: ProfileUpdateData): Promise<ProfileUpdateResult>;
+    /**
+     * Log out the current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Subscribe to authentication state changes
+     */
+    onAuthStateChange(callback: AuthStateChangeCallback): () => void;
+    /**
+     * Get the authenticated customer's order history
+     * Only returns orders for the logged-in customer
+     */
+    getOrders(options?: GetOrdersOptions): Promise<GetOrdersResult>;
+    /**
+     * Get the authenticated customer's booking history
+     * Only returns bookings for the logged-in customer
+     */
+    getBookings(options?: GetBookingsOptions): Promise<GetBookingsResult>;
+    /**
+     * Get the authenticated customer's enquiry history
+     * Only returns enquiries for the logged-in customer
+     */
+    getEnquiries(options?: GetEnquiriesOptions): Promise<GetEnquiriesResult>;
+    /**
+     * Generate a short-lived token for customer flow iframe authentication
+     */
+    getIframeToken(customerFlowId?: string): Promise<IframeTokenResult>;
+    /**
+     * Embed a customer flow with automatic authentication
+     *
+     * @param flowUrl - The URL of the customer flow (book.tiquo.app/...)
+     * @param container - Container element or selector
+     * @param options - Optional iframe configuration
+     */
+    embedCustomerFlow(flowUrl: string, container: HTMLElement | string, options?: {
+        width?: string;
+        height?: string;
+        onLoad?: () => void;
+        onError?: (error: Error) => void;
+    }): Promise<HTMLIFrameElement>;
+    /**
+     * Get the current session token (for advanced use cases)
+     */
+    getSessionToken(): string | null;
+    private request;
+    private refreshSession;
+    private saveSession;
+    private restoreSession;
+    private clearSession;
+    private notifyListeners;
+    private scheduleRefresh;
+    private log;
+    private generateTabId;
+    private initTabSync;
+    private broadcastTabSync;
+    private handleTabSyncMessage;
+    /**
+     * Clean up resources (call when destroying the auth instance)
+     */
+    destroy(): void;
+}
+/**
+ * React hook for using TiquoAuth
+ * Note: Requires a TiquoAuth instance to be passed in
+ *
+ * @example
+ * ```tsx
+ * const auth = new TiquoAuth({ publicKey: 'pk_dom_xxx' });
+ *
+ * function App() {
+ *   const { user, isLoading, isAuthenticated, logout } = useTiquoAuth(auth);
+ *
+ *   if (isLoading) return <div>Loading...</div>;
+ *
+ *   if (!isAuthenticated) {
+ *     return <LoginForm auth={auth} />;
+ *   }
+ *
+ *   return (
+ *     <div>
+ *       Welcome, {user?.email}
+ *       <button onClick={logout}>Logout</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useTiquoAuth(auth: TiquoAuth): {
+    readonly user: TiquoUser | null;
+    readonly customer: TiquoCustomer | null;
+    readonly session: TiquoSession | null;
+    readonly isLoading: boolean;
+    readonly isAuthenticated: boolean;
+    sendOTP: (email: string) => Promise<SendOTPResult>;
+    verifyOTP: (email: string, otp: string) => Promise<VerifyOTPResult>;
+    logout: () => Promise<void>;
+    updateProfile: (updates: ProfileUpdateData) => Promise<ProfileUpdateResult>;
+    getOrders: (options?: GetOrdersOptions) => Promise<GetOrdersResult>;
+    getBookings: (options?: GetBookingsOptions) => Promise<GetBookingsResult>;
+    getEnquiries: (options?: GetEnquiriesOptions) => Promise<GetEnquiriesResult>;
+    getIframeToken: (flowId?: string) => Promise<IframeTokenResult>;
+    embedCustomerFlow: (flowUrl: string, container: HTMLElement | string, options?: {
+        width?: string;
+        height?: string;
+        onLoad?: () => void;
+        onError?: (error: Error) => void;
+    }) => Promise<HTMLIFrameElement>;
+    onAuthStateChange: (cb: AuthStateChangeCallback) => () => void;
+};
+
+export { type AuthStateChangeCallback, type GetBookingsOptions, type GetBookingsResult, type GetEnquiriesOptions, type GetEnquiriesResult, type GetOrdersOptions, type GetOrdersResult, type IframeTokenResult, type ProfileUpdateData, type ProfileUpdateResult, type SendOTPResult, TiquoAuth, type TiquoAuthConfig, TiquoAuthError, type TiquoBooking, type TiquoCustomer, type TiquoEnquiry, type TiquoOrder, type TiquoOrderItem, type TiquoSession, type TiquoUser, type VerifyOTPResult, TiquoAuth as default, useTiquoAuth };