@blocklet/payment-broker-client 1.20.17

package/lib/index.d.ts

@@ -0,0 +1,484 @@
+interface PollOptions$1 {
+    checkCondition: () => Promise<any>;
+    stepName?: string;
+    interval?: number;
+    maxAttempts?: number;
+    backoffStrategy?: 'linear' | 'exponential';
+    onProgress?: (attempt: number, maxAttempts: number) => void;
+}
+declare class PollingManager$1 {
+    private baseInterval;
+    private maxAttempts;
+    private backoffStrategy;
+    constructor(options?: {
+        baseInterval?: number;
+        maxAttempts?: number;
+        backoffStrategy?: 'linear' | 'exponential';
+    });
+    poll<T>(options: PollOptions$1): Promise<T>;
+    private calculateWaitTime;
+    pollWithTimeout<T>(options: PollOptions$1, timeoutMs: number): Promise<T>;
+    pollBatch<T>(items: T[], checkCondition: (item: T) => Promise<boolean>, options?: Omit<PollOptions$1, 'checkCondition'>): Promise<T[]>;
+}
+
+/**
+ * HTTP request interface - abstracts HTTP implementation for different environments
+ */
+interface HttpClient$1 {
+    get(url: string): Promise<any>;
+    post(url: string, data: any): Promise<any>;
+}
+/**
+ * Configuration provider interface - abstracts configuration retrieval for different environments
+ * Only responsible for getting raw blocklet information, unified processing logic is in SessionManager
+ */
+interface ConfigProvider$1 {
+    getBlockletInfo(): Promise<any>;
+}
+/**
+ * Unified manager dependencies
+ */
+interface ManagerDependencies$1 {
+    httpClient: HttpClient$1;
+    configProvider: ConfigProvider$1;
+    pollingManager: PollingManager$1;
+}
+
+type DeploymentStep$1 = 'creating_session' | 'waiting_payment' | 'installation_started' | 'installing' | 'starting_service' | 'getting_urls' | 'getting_vendors' | 'completed' | 'cancelled';
+interface BrokerConfig$1 {
+    baseUrl: string;
+    authToken?: string;
+    paymentLinkKey?: string;
+    api?: any;
+    timeout?: number;
+    polling?: {
+        interval?: number;
+        maxAttempts?: number;
+        backoffStrategy?: 'linear' | 'exponential';
+    };
+}
+declare const STEPS$1: {
+    readonly PAYMENT_PENDING: "payment_pending";
+    readonly PAYMENT_COMPLETED: "payment_completed";
+    readonly INSTALLATION_STARTING: "installation_starting";
+    readonly INSTALLATION_COMPLETED: "installation_completed";
+    readonly SERVICE_STARTING: "service_starting";
+    readonly SERVICE_READY: "service_ready";
+    readonly ACCESS_PREPARING: "access_preparing";
+    readonly ACCESS_READY: "access_ready";
+};
+interface DeploymentHooks$1 {
+    [STEPS$1.PAYMENT_PENDING]?: (data: {
+        sessionId?: string;
+        paymentUrl?: string;
+        linkId?: string;
+        isResuming?: boolean;
+    }) => void;
+    [STEPS$1.PAYMENT_COMPLETED]?: (data: {
+        sessionId: string;
+        vendors: VendorInfo$1[];
+    }) => void;
+    [STEPS$1.INSTALLATION_STARTING]?: (data: {
+        vendors: VendorInfo$1[];
+    }) => void;
+    [STEPS$1.INSTALLATION_COMPLETED]?: (data: {
+        vendors: VendorInfo$1[];
+        progress?: number;
+    }) => void;
+    [STEPS$1.SERVICE_STARTING]?: (data: {
+        vendors: VendorInfo$1[];
+    }) => void;
+    [STEPS$1.SERVICE_READY]?: (data: {
+        vendors: VendorInfo$1[];
+    }) => void;
+    [STEPS$1.ACCESS_PREPARING]?: (data: {
+        sessionId: string;
+    }) => void;
+    [STEPS$1.ACCESS_READY]?: (data: {
+        sessionId: string;
+        appUrl?: string;
+        dashboardUrl?: string;
+        subscriptionUrl?: string;
+        homeUrl?: string;
+    }) => void;
+}
+interface DeploymentOptions$1 {
+    cachedCheckoutId?: string;
+    cachedPaymentUrl?: string;
+    needShortUrl?: boolean;
+    page_info: {
+        success_message: {
+            en: string;
+            zh: string;
+        };
+    };
+    [key: string]: any;
+    hooks?: DeploymentHooks$1;
+    onError?: (error: DeploymentError$1, step?: DeploymentStep$1) => void;
+}
+interface PaymentSession$1 {
+    id: string;
+    paymentUrl: string;
+    status: 'pending' | 'paid' | 'expired' | 'cancelled';
+    linkId: string;
+    vendorDid: string;
+    amount?: number;
+    currency?: string;
+    createdAt: string;
+    updatedAt: string;
+    expiresAt: string;
+    paidAt?: string;
+    metadata?: Record<string, any>;
+}
+interface VendorInfo$1 {
+    id: string;
+    name: string;
+    status: 'pending' | 'installing' | 'starting' | 'running' | 'failed';
+    progress: number;
+    appUrl?: string;
+    dashboardUrl?: string;
+    homeUrl?: string;
+    token?: string;
+    subscriptionUrl?: string;
+    metadata?: Record<string, any>;
+    details?: Record<string, any>;
+}
+interface DeploymentResult$1 {
+    success: boolean;
+    sessionId: string;
+    status?: string;
+    vendors?: VendorInfo$1[];
+    appUrl?: string;
+    homeUrl?: string;
+    dashboardUrl?: string;
+    token?: string;
+    subscriptionUrl?: string;
+    duration?: number;
+    startTime?: string;
+    endTime?: string;
+    metadata?: Record<string, any>;
+    data?: any;
+    completedAt?: string;
+}
+interface DeploymentError$1 extends Error {
+    code: ErrorCode$1;
+    step?: DeploymentStep$1;
+    sessionId?: string;
+    paymentUrl?: string;
+    linkId?: string;
+    timestamp?: string;
+    details?: Record<string, any>;
+    recovery?: {
+        canRetry?: boolean;
+        retryAfter?: number;
+        suggestions?: string[];
+    };
+}
+type ErrorCode$1 = 'NETWORK_ERROR' | 'TIMEOUT_ERROR' | 'PAYMENT_ERROR' | 'VALIDATION_ERROR' | 'SESSION_ERROR' | 'DEPLOYMENT_ERROR' | 'VENDOR_ERROR' | 'INSTALLATION_ERROR' | 'SERVICE_ERROR' | 'ACCESS_ERROR' | 'CONFIG_ERROR' | 'UNKNOWN_ERROR';
+
+/**
+ * Unified BrokerClient class
+ * Uses dependency injection to support different environment implementations
+ */
+declare class BrokerClient {
+    private config;
+    private sessionManager;
+    private deploymentManager;
+    private isDeploying;
+    private currentDeployment;
+    constructor(config: Partial<BrokerConfig$1>, dependencies: ManagerDependencies$1);
+    deploy(options: DeploymentOptions$1): Promise<DeploymentResult$1>;
+    createSession(options?: Partial<DeploymentOptions$1>): Promise<PaymentSession$1>;
+    getSessionStatus(sessionId: string): Promise<any>;
+    cancelDeployment(): void;
+    getDeploymentStatus(): {
+        isDeploying: boolean;
+        result?: DeploymentResult$1 | null;
+        error?: DeploymentError$1 | null;
+        sessionId?: string;
+        duration?: number;
+    };
+    updateConfig(newConfig: Partial<BrokerConfig$1>): void;
+    getConfig(): BrokerConfig$1;
+    private validateConfig;
+}
+
+/**
+ * Creates a Node.js specific BrokerClient instance
+ * @param config - Partial configuration for the broker client
+ * @returns Configured BrokerClient instance with Node.js dependencies
+ */
+declare function createNodeBrokerClient(config: Partial<BrokerConfig$1>): BrokerClient;
+
+type DeploymentStatus = 'initializing' | 'creating_session' | 'payment_required' | 'payment_processing' | 'payment_completed' | 'installing' | 'starting_service' | 'getting_urls' | 'completed' | 'failed' | 'cancelled';
+type DeploymentStep = 'creating_session' | 'waiting_payment' | 'installation_started' | 'installing' | 'starting_service' | 'getting_urls' | 'getting_vendors' | 'completed' | 'cancelled';
+interface BrokerConfig {
+    baseUrl: string;
+    authToken?: string;
+    paymentLinkKey?: string;
+    api?: any;
+    timeout?: number;
+    polling?: {
+        interval?: number;
+        maxAttempts?: number;
+        backoffStrategy?: 'linear' | 'exponential';
+    };
+}
+declare const STEPS: {
+    readonly PAYMENT_PENDING: "payment_pending";
+    readonly PAYMENT_COMPLETED: "payment_completed";
+    readonly INSTALLATION_STARTING: "installation_starting";
+    readonly INSTALLATION_COMPLETED: "installation_completed";
+    readonly SERVICE_STARTING: "service_starting";
+    readonly SERVICE_READY: "service_ready";
+    readonly ACCESS_PREPARING: "access_preparing";
+    readonly ACCESS_READY: "access_ready";
+};
+interface DeploymentHooks {
+    [STEPS.PAYMENT_PENDING]?: (data: {
+        sessionId?: string;
+        paymentUrl?: string;
+        linkId?: string;
+        isResuming?: boolean;
+    }) => void;
+    [STEPS.PAYMENT_COMPLETED]?: (data: {
+        sessionId: string;
+        vendors: VendorInfo[];
+    }) => void;
+    [STEPS.INSTALLATION_STARTING]?: (data: {
+        vendors: VendorInfo[];
+    }) => void;
+    [STEPS.INSTALLATION_COMPLETED]?: (data: {
+        vendors: VendorInfo[];
+        progress?: number;
+    }) => void;
+    [STEPS.SERVICE_STARTING]?: (data: {
+        vendors: VendorInfo[];
+    }) => void;
+    [STEPS.SERVICE_READY]?: (data: {
+        vendors: VendorInfo[];
+    }) => void;
+    [STEPS.ACCESS_PREPARING]?: (data: {
+        sessionId: string;
+    }) => void;
+    [STEPS.ACCESS_READY]?: (data: {
+        sessionId: string;
+        appUrl?: string;
+        dashboardUrl?: string;
+        subscriptionUrl?: string;
+        homeUrl?: string;
+    }) => void;
+}
+interface DeploymentOptions {
+    cachedCheckoutId?: string;
+    cachedPaymentUrl?: string;
+    needShortUrl?: boolean;
+    page_info: {
+        success_message: {
+            en: string;
+            zh: string;
+        };
+    };
+    [key: string]: any;
+    hooks?: DeploymentHooks;
+    onError?: (error: DeploymentError, step?: DeploymentStep) => void;
+}
+interface PaymentSession {
+    id: string;
+    paymentUrl: string;
+    status: 'pending' | 'paid' | 'expired' | 'cancelled';
+    linkId: string;
+    vendorDid: string;
+    amount?: number;
+    currency?: string;
+    createdAt: string;
+    updatedAt: string;
+    expiresAt: string;
+    paidAt?: string;
+    metadata?: Record<string, any>;
+}
+interface VendorInfo {
+    id: string;
+    name: string;
+    status: 'pending' | 'installing' | 'starting' | 'running' | 'failed';
+    progress: number;
+    appUrl?: string;
+    dashboardUrl?: string;
+    homeUrl?: string;
+    token?: string;
+    subscriptionUrl?: string;
+    metadata?: Record<string, any>;
+    details?: Record<string, any>;
+}
+interface DeploymentResult {
+    success: boolean;
+    sessionId: string;
+    status?: string;
+    vendors?: VendorInfo[];
+    appUrl?: string;
+    homeUrl?: string;
+    dashboardUrl?: string;
+    token?: string;
+    subscriptionUrl?: string;
+    duration?: number;
+    startTime?: string;
+    endTime?: string;
+    metadata?: Record<string, any>;
+    data?: any;
+    completedAt?: string;
+}
+interface DeploymentError extends Error {
+    code: ErrorCode;
+    step?: DeploymentStep;
+    sessionId?: string;
+    paymentUrl?: string;
+    linkId?: string;
+    timestamp?: string;
+    details?: Record<string, any>;
+    recovery?: {
+        canRetry?: boolean;
+        retryAfter?: number;
+        suggestions?: string[];
+    };
+}
+type ErrorCode = 'NETWORK_ERROR' | 'TIMEOUT_ERROR' | 'PAYMENT_ERROR' | 'VALIDATION_ERROR' | 'SESSION_ERROR' | 'DEPLOYMENT_ERROR' | 'VENDOR_ERROR' | 'INSTALLATION_ERROR' | 'SERVICE_ERROR' | 'ACCESS_ERROR' | 'CONFIG_ERROR' | 'UNKNOWN_ERROR';
+interface DeploymentEvent {
+    type: string;
+    timestamp: string;
+    data?: any;
+}
+type DeploymentEventType = 'session.created' | 'payment.required' | 'payment.started' | 'payment.completed' | 'payment.failed' | 'installation.started' | 'installation.progress' | 'installation.completed' | 'service.started' | 'service.failed' | 'deployment.completed' | 'deployment.failed' | 'deployment.cancelled';
+type PartialExcept<T, K extends keyof T> = Partial<T> & Pick<T, K>;
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+declare const DEFAULT_CONFIG: {
+    timeout: number;
+    polling: {
+        interval: number;
+        maxAttempts: number;
+        backoffStrategy: "linear";
+    };
+};
+declare const API_ENDPOINTS: {
+    createCheckout: string;
+    paymentPage: string;
+    orderStatus: string;
+    orderDetail: string;
+    vendors: string;
+};
+declare const DEPLOYMENT_STEPS: {
+    readonly CREATING_SESSION: "creating_session";
+    readonly WAITING_PAYMENT: "waiting_payment";
+    readonly INSTALLING: "installing";
+    readonly STARTING_SERVICE: "starting_service";
+    readonly GETTING_URLS: "getting_urls";
+    readonly COMPLETED: "completed";
+};
+declare const ERROR_CODES: {
+    readonly NETWORK_ERROR: "NETWORK_ERROR";
+    readonly TIMEOUT_ERROR: "TIMEOUT_ERROR";
+    readonly PAYMENT_ERROR: "PAYMENT_ERROR";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    readonly SESSION_ERROR: "SESSION_ERROR";
+    readonly DEPLOYMENT_ERROR: "DEPLOYMENT_ERROR";
+    readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
+};
+
+declare function createDeploymentError(message: string, code: ErrorCode, options?: {
+    step?: DeploymentStep;
+    sessionId?: string;
+    paymentUrl?: string;
+    linkId?: string;
+    details?: Record<string, any>;
+    recovery?: {
+        canRetry?: boolean;
+        retryAfter?: number;
+        suggestions?: string[];
+    };
+}): DeploymentError;
+declare function isDeploymentError(error: any): error is DeploymentError;
+
+declare const httpUtils: {
+    request(url: string, options?: RequestInit): Promise<any>;
+    get(url: string, headers?: Record<string, string>): any;
+    post(url: string, data?: any, headers?: Record<string, string>): any;
+    put(url: string, data?: any, headers?: Record<string, string>): any;
+    delete(url: string, headers?: Record<string, string>): any;
+};
+declare const urlUtils: {
+    join(...parts: string[]): string;
+    addParams(url: string, params: Record<string, any>): string;
+    replaceParams(url: string, params: Record<string, string>): string;
+    isValidUrl(url: string): boolean;
+};
+declare const timeUtils: {
+    formatDuration(ms: number): string;
+    sleep(ms: number): Promise<void>;
+    timeout<T>(promise: Promise<T>, ms: number): Promise<T>;
+    now(): string;
+};
+declare const objectUtils: {
+    deepMerge<T extends Record<string, any>>(target: T, ...sources: Partial<T>[]): T;
+    isObject(item: any): item is Record<string, any>;
+    pick<T extends Record<string, any>, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+    omit<T extends Record<string, any>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+    deepClone<T>(obj: T): T;
+};
+
+interface PollOptions {
+    checkCondition: () => Promise<any>;
+    stepName?: string;
+    interval?: number;
+    maxAttempts?: number;
+    backoffStrategy?: 'linear' | 'exponential';
+    onProgress?: (attempt: number, maxAttempts: number) => void;
+}
+declare class PollingManager {
+    private baseInterval;
+    private maxAttempts;
+    private backoffStrategy;
+    constructor(options?: {
+        baseInterval?: number;
+        maxAttempts?: number;
+        backoffStrategy?: 'linear' | 'exponential';
+    });
+    poll<T>(options: PollOptions): Promise<T>;
+    private calculateWaitTime;
+    pollWithTimeout<T>(options: PollOptions, timeoutMs: number): Promise<T>;
+    pollBatch<T>(items: T[], checkCondition: (item: T) => Promise<boolean>, options?: Omit<PollOptions, 'checkCondition'>): Promise<T[]>;
+}
+
+declare const logger: {
+    debug: (message: string, data?: any) => void;
+    info: (message: string, data?: any) => void;
+    warn: (message: string, data?: any) => void;
+    error: (message: string, data?: any) => void;
+};
+//# sourceMappingURL=logger.d.ts.map
+
+/**
+ * HTTP request interface - abstracts HTTP implementation for different environments
+ */
+interface HttpClient {
+    get(url: string): Promise<any>;
+    post(url: string, data: any): Promise<any>;
+}
+/**
+ * Configuration provider interface - abstracts configuration retrieval for different environments
+ * Only responsible for getting raw blocklet information, unified processing logic is in SessionManager
+ */
+interface ConfigProvider {
+    getBlockletInfo(): Promise<any>;
+}
+/**
+ * Unified manager dependencies
+ */
+interface ManagerDependencies {
+    httpClient: HttpClient;
+    configProvider: ConfigProvider;
+    pollingManager: PollingManager;
+}
+
+export { API_ENDPOINTS, createNodeBrokerClient as BrokerClient, DEFAULT_CONFIG, DEPLOYMENT_STEPS, ERROR_CODES, PollingManager, STEPS, createDeploymentError, httpUtils, isDeploymentError, logger, objectUtils, timeUtils, urlUtils };
+export type { BrokerConfig, ConfigProvider, DeepPartial, DeploymentError, DeploymentEvent, DeploymentEventType, DeploymentHooks, DeploymentOptions, DeploymentResult, DeploymentStatus, DeploymentStep, ErrorCode, HttpClient, ManagerDependencies, PartialExcept, PaymentSession, PollOptions, VendorInfo };

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,cAAc,mBAAmB,CAAC"}