@emmanuel-nike/ark-notify-js 0.1.1 → 0.1.2

package/dist/utils-Zj1Ees3H.d.ts

@@ -1,409 +0,0 @@
-declare const DEFAULT_BASE_URL = "https://ark-notify-933303906015.europe-north1.run.app";
-interface ArkNotifyGlobalConfig {
-    baseUrl?: string;
-}
-/** Set the default base URL once at application startup. */
-declare function configureArkNotify(config: ArkNotifyGlobalConfig): void;
-declare function resolveBaseUrl(baseUrl?: string): string;
-
-type UserRole = 'SYSTEM_ADMIN' | 'ACCOUNT_ADMIN' | 'ACCOUNT_USER';
-interface User {
-    id: string;
-    email: string;
-    firstName: string;
-    lastName: string;
-    role: UserRole;
-    createdAt: string;
-}
-interface ApiError {
-    error: string;
-    message: string;
-    reason?: string;
-    retryAfterSec?: number;
-}
-interface ConnectionCapabilities {
-    subscribe: boolean;
-    publish: boolean;
-    presence: boolean;
-}
-interface Application {
-    id: string;
-    name: string;
-    appKey: string;
-    tenantId: string;
-    authWebhookUrl: string | null;
-    requireClientAuth: boolean;
-    serverAuthUrl: string | null;
-    messageHistorySize: number;
-    createdAt: string;
-    updatedAt: string;
-    secret?: string;
-}
-interface CreateApplicationInput {
-    name: string;
-    authWebhookUrl?: string | null;
-    requireClientAuth?: boolean;
-    serverAuthUrl?: string | null;
-    messageHistorySize?: number;
-}
-interface UpdateApplicationInput {
-    name?: string;
-    authWebhookUrl?: string | null;
-    requireClientAuth?: boolean;
-    serverAuthUrl?: string | null;
-    messageHistorySize?: number;
-}
-interface LoginInput {
-    email: string;
-    password: string;
-}
-interface AuthResponse {
-    user: User;
-    token: string;
-}
-interface PublishEventInput {
-    channel: string;
-    event: string;
-    data?: unknown;
-}
-interface PublishEventResponse {
-    published: boolean;
-    channel: string;
-    event: string;
-}
-interface ChannelAuthInput {
-    socket_id?: string;
-    connection_id?: string;
-    channel_name: string;
-    user_data?: Record<string, unknown>;
-}
-interface ChannelAuthResponse {
-    auth: string;
-}
-interface ConnectionTokenInput {
-    client_id?: string;
-    clientId?: string;
-    user_data?: Record<string, unknown>;
-    userData?: Record<string, unknown>;
-    serverAuthUrl?: string | null;
-    server_auth_url?: string | null;
-    ttl?: number;
-    capabilities?: Partial<ConnectionCapabilities>;
-}
-interface ConnectionTokenResponse {
-    token: string;
-    client_id: string;
-    expires_at: number;
-    capabilities: ConnectionCapabilities;
-}
-interface PresenceMember {
-    connectionId: string;
-    clientId: string;
-    data: Record<string, unknown>;
-    updatedAt: number;
-}
-interface AdminConnection {
-    connectionId: string;
-    clientId: string;
-    transport: 'websocket' | 'sse';
-    authenticated: boolean;
-    connectedAt: number;
-}
-interface AdminChannel {
-    tenantId: string;
-    channel: string;
-    applicationId: string;
-    applicationName: string;
-    appKey: string;
-    subscriberCount: number;
-    presenceMemberCount: number;
-    presenceMembers: PresenceMember[];
-    connections: AdminConnection[];
-    analytics: {
-        eventsByType: Record<string, number>;
-        totalEvents: number;
-        lastEventAt: string | null;
-    };
-}
-interface AdminChannelsResponse {
-    generatedAt: string;
-    summary: {
-        totalApplications: number;
-        totalChannels: number;
-        totalConnections: number;
-        totalPresenceMembers: number;
-        totalSubscribers: number;
-        totalAnalyticsEvents: number;
-    };
-    channels: AdminChannel[];
-    connections: AdminConnection[];
-    analytics: {
-        eventsByType: Array<{
-            eventType: string;
-            eventCount: number;
-        }>;
-        recentEvents: unknown[];
-    };
-}
-type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'reconnecting' | 'failed';
-interface ConnectedMessage {
-    type: 'connected';
-    connection_id: string;
-    client_id: string;
-    app_key: string;
-    authenticated: boolean;
-    channels?: string[];
-}
-interface EventMessage {
-    type: 'event';
-    channel: string;
-    event: string;
-    data: unknown;
-    clientId: string | null;
-    timestamp: number;
-}
-interface PresenceMemberInfo {
-    connectionId: string;
-    clientId: string;
-    data: Record<string, unknown>;
-    updatedAt: number;
-}
-type PresenceAction = 'enter' | 'leave' | 'update' | 'sync';
-interface PresenceMessage {
-    type: 'presence';
-    channel: string;
-    action: PresenceAction;
-    member: PresenceMemberInfo | null;
-    members: PresenceMemberInfo[] | null;
-    timestamp: number;
-}
-interface SubscribedMessage {
-    type: 'subscribed';
-    channel: string;
-}
-interface UnsubscribedMessage {
-    type: 'unsubscribed';
-    channel: string;
-}
-interface PublishedMessage {
-    type: 'published';
-    channel: string;
-    event: string;
-}
-interface PongMessage {
-    type: 'pong';
-    timestamp: number;
-}
-interface PingMessage {
-    type: 'ping';
-}
-interface ServerErrorMessage {
-    type: 'error';
-    code: string;
-    message: string;
-}
-interface PresenceUpdatedMessage {
-    type: 'presence_updated';
-    channel: string;
-    data: Record<string, unknown>;
-}
-interface PresenceLeftMessage {
-    type: 'presence_left';
-    channel: string;
-}
-type ServerMessage = ConnectedMessage | EventMessage | PresenceMessage | SubscribedMessage | UnsubscribedMessage | PublishedMessage | PongMessage | PingMessage | ServerErrorMessage | PresenceUpdatedMessage | PresenceLeftMessage;
-interface ArkNotifyClientConfig {
-    baseUrl?: string;
-    token?: string | (() => string | null | undefined);
-    fetch?: typeof fetch;
-}
-interface AppCredentials {
-    appKey: string;
-    secret: string;
-}
-type PrivateChannelAuthHandler = (channel: string, connectionId: string) => Promise<string>;
-interface ArkNotifyConnectionConfig {
-    baseUrl?: string;
-    appKey: string;
-    clientId?: string;
-    /** Signed connection token, or a resolver. Omit to auto-fetch when `clientId` is set. */
-    token?: string | (() => string | null | undefined);
-    /** App credentials for auto-fetching a connection token (backend-only when no serverAuthUrl). */
-    credentials?: AppCredentials;
-    /** Override server auth URL when auto-fetching a token; uses the application default when omitted. */
-    serverAuthUrl?: string | null;
-    /** Forwarded to the connection-token endpoint when auto-fetching a token. */
-    user_data?: Record<string, unknown>;
-    autoReconnect?: boolean;
-    reconnectDelayMs?: number;
-    maxReconnectDelayMs?: number;
-    onPrivateChannelAuth?: PrivateChannelAuthHandler;
-    fetch?: typeof fetch;
-    WebSocket?: typeof WebSocket;
-}
-interface SubscribeOptions {
-    history?: boolean;
-    presence?: boolean;
-    presence_data?: Record<string, unknown>;
-    auth?: string;
-}
-interface ArkNotifySSEConfig {
-    baseUrl?: string;
-    appKey: string;
-    channels: string[];
-    clientId?: string;
-    token?: string | (() => string | null | undefined);
-    auth?: Record<string, string>;
-    user_data?: Record<string, unknown>;
-    history?: boolean;
-    onPrivateChannelAuth?: PrivateChannelAuthHandler;
-    EventSource?: typeof EventSource;
-}
-interface ChannelEventHandler<T = unknown> {
-    (data: T, message: EventMessage): void;
-}
-interface ChannelHandlers {
-    [eventName: string]: ChannelEventHandler;
-}
-interface HealthResponse {
-    status: string;
-    uptime: number;
-}
-
-declare class ArkNotifyClient {
-    private readonly baseUrl;
-    private readonly fetchFn;
-    private token?;
-    constructor(config: ArkNotifyClientConfig);
-    setToken(token: string | null): void;
-    private getAuthHeader;
-    private request;
-    health(): Promise<HealthResponse>;
-    login(input: LoginInput): Promise<AuthResponse>;
-    me(): Promise<{
-        user: User;
-    }>;
-    listApplications(): Promise<{
-        apps: Application[];
-    }>;
-    createApplication(input: CreateApplicationInput): Promise<{
-        app: Application;
-    }>;
-    getApplication(id: string): Promise<{
-        app: Application;
-    }>;
-    updateApplication(id: string, input: UpdateApplicationInput): Promise<{
-        app: Application;
-    }>;
-    deleteApplication(id: string): Promise<{
-        deleted: boolean;
-        id: string;
-    }>;
-    regenerateSecret(id: string): Promise<{
-        app: Application;
-    }>;
-    adminChannels(): Promise<AdminChannelsResponse>;
-    publishEvent(appKey: string, credentials: AppCredentials, input: PublishEventInput): Promise<PublishEventResponse>;
-    authorizeChannel(appKey: string, credentials: AppCredentials, input: ChannelAuthInput): Promise<ChannelAuthResponse>;
-    issueConnectionToken(appKey: string, input: ConnectionTokenInput, credentials?: AppCredentials): Promise<ConnectionTokenResponse>;
-}
-
-type EventMap = {
-    state: (state: ConnectionState) => void;
-    connected: (message: ConnectedMessage) => void;
-    event: (message: EventMessage) => void;
-    presence: (message: PresenceMessage) => void;
-    message: (message: ServerMessage) => void;
-    error: (error: {
-        code: string;
-        message: string;
-    }) => void;
-    close: (event: {
-        code: number;
-        reason: string;
-    }) => void;
-};
-type EventName = keyof EventMap;
-declare class ArkNotifyConnection {
-    private readonly config;
-    private ws;
-    private state;
-    private connectionId;
-    private clientId;
-    private authenticated;
-    private subscribedChannels;
-    private pendingSubscriptions;
-    private listeners;
-    private reconnectAttempt;
-    private reconnectTimer;
-    private intentionalClose;
-    private connectPromise;
-    private readonly WebSocketCtor;
-    constructor(config: ArkNotifyConnectionConfig);
-    getConnectionState(): ConnectionState;
-    getConnectionId(): string | null;
-    getClientId(): string | null;
-    isAuthenticated(): boolean;
-    getSubscribedChannels(): string[];
-    on<E extends EventName>(event: E, handler: EventMap[E]): () => void;
-    off<E extends EventName>(event: E, handler: EventMap[E]): void;
-    private emit;
-    private setState;
-    connect(): Promise<void>;
-    private doConnect;
-    disconnect(): void;
-    private scheduleReconnect;
-    private clearReconnectTimer;
-    private send;
-    private handleMessage;
-    private resubscribeAll;
-    subscribe(channel: string, options?: SubscribeOptions): Promise<void>;
-    unsubscribe(channel: string): void;
-    publish(channel: string, event: string, data?: unknown): void;
-    presenceEnter(channel: string, data: Record<string, unknown>): void;
-    presenceUpdate(channel: string, data: Record<string, unknown>): void;
-    presenceLeave(channel: string): void;
-    presenceSync(channel: string): void;
-    ping(): void;
-    bind(channel: string, event: string, handler: ChannelEventHandler): () => void;
-    bindAll(channel: string, handler: ChannelEventHandler): () => void;
-}
-
-type SSEEventMap = {
-    connected: (message: ConnectedMessage) => void;
-    event: (message: EventMessage) => void;
-    presence: (message: PresenceMessage) => void;
-    message: (message: ServerMessage) => void;
-    error: (error: Error) => void;
-    close: () => void;
-};
-type SSEEventName = keyof SSEEventMap;
-declare class ArkNotifySSE {
-    private readonly config;
-    private es;
-    private connectionId;
-    private listeners;
-    private readonly EventSourceCtor;
-    constructor(config: ArkNotifySSEConfig);
-    getConnectionId(): string | null;
-    on<E extends SSEEventName>(event: E, handler: SSEEventMap[E]): () => void;
-    off<E extends SSEEventName>(event: E, handler: SSEEventMap[E]): void;
-    private emit;
-    connect(): Promise<void>;
-    disconnect(): void;
-    bind(channel: string, event: string, handler: (data: unknown, message: EventMessage) => void): () => void;
-    bindAll(channel: string, handler: (data: unknown, message: EventMessage) => void): () => void;
-}
-
-declare class ArkNotifyError extends Error {
-    readonly status: number;
-    readonly code: string;
-    readonly retryAfterSec?: number;
-    readonly reason?: string;
-    constructor(status: number, body: ApiError);
-}
-declare function toWebSocketUrl(baseUrl: string, path: string): string;
-declare function resolveValue<T>(value: T | (() => T)): T;
-declare function isPrivateChannel(channel: string): boolean;
-
-export { toWebSocketUrl as $, type AppCredentials as A, type PresenceMember as B, type ConnectionTokenInput as C, DEFAULT_BASE_URL as D, type EventMessage as E, type PresenceMemberInfo as F, type PresenceMessage as G, type HealthResponse as H, type PresenceUpdatedMessage as I, type PrivateChannelAuthHandler as J, type PublishEventInput as K, type LoginInput as L, type PublishEventResponse as M, type PublishedMessage as N, type ServerMessage as O, type PingMessage as P, type SubscribeOptions as Q, type SubscribedMessage as R, type ServerErrorMessage as S, type UpdateApplicationInput as T, type UnsubscribedMessage as U, type User as V, type UserRole as W, configureArkNotify as X, isPrivateChannel as Y, resolveBaseUrl as Z, resolveValue as _, type ConnectionTokenResponse as a, type AdminChannel as b, type AdminChannelsResponse as c, type AdminConnection as d, type ApiError as e, type Application as f, ArkNotifyClient as g, type ArkNotifyClientConfig as h, ArkNotifyConnection as i, type ArkNotifyConnectionConfig as j, ArkNotifyError as k, type ArkNotifyGlobalConfig as l, ArkNotifySSE as m, type ArkNotifySSEConfig as n, type AuthResponse as o, type ChannelAuthInput as p, type ChannelAuthResponse as q, type ChannelEventHandler as r, type ChannelHandlers as s, type ConnectedMessage as t, type ConnectionCapabilities as u, type ConnectionState as v, type CreateApplicationInput as w, type PongMessage as x, type PresenceAction as y, type PresenceLeftMessage as z };