@revenexx/sdk 0.0.2

package/types/services/realtime.d.ts

@@ -0,0 +1,134 @@
+import { Client } from '../client';
+import { Channel, ActionableChannel, ResolvedChannel } from '../channel';
+import { Query } from '../query';
+export type RealtimeSubscription = {
+    close: () => Promise<void>;
+};
+export type RealtimeCallback<T = any> = {
+    channels: Set<string>;
+    queries: string[];
+    callback: (event: RealtimeResponseEvent<T>) => void;
+};
+export type RealtimeResponse = {
+    type: string;
+    data?: any;
+};
+export type RealtimeResponseEvent<T = any> = {
+    events: string[];
+    channels: string[];
+    timestamp: string;
+    payload: T;
+    subscriptions: string[];
+};
+export type RealtimeResponseConnected = {
+    channels: string[];
+    user?: object;
+    subscriptions?: {
+        [slot: string]: string;
+    };
+};
+export type RealtimeRequest = {
+    type: 'authentication';
+    data: {
+        session: string;
+    };
+};
+export declare enum RealtimeCode {
+    NORMAL_CLOSURE = 1000,
+    POLICY_VIOLATION = 1008,
+    UNKNOWN_ERROR = -1
+}
+export declare class Realtime {
+    private readonly TYPE_ERROR;
+    private readonly TYPE_EVENT;
+    private readonly TYPE_PONG;
+    private readonly TYPE_CONNECTED;
+    private readonly DEBOUNCE_MS;
+    private readonly HEARTBEAT_INTERVAL;
+    private client;
+    private socket?;
+    private activeSubscriptions;
+    private slotToSubscriptionId;
+    private subscriptionIdToSlot;
+    private heartbeatTimer?;
+    private subCallDepth;
+    private reconnectAttempts;
+    private subscriptionsCounter;
+    private connectionId;
+    private reconnect;
+    private onErrorCallbacks;
+    private onCloseCallbacks;
+    private onOpenCallbacks;
+    constructor(client: Client);
+    /**
+     * Register a callback function to be called when an error occurs
+     *
+     * @param {Function} callback - Callback function to handle errors
+     * @returns {void}
+     */
+    onError(callback: (error?: Error, statusCode?: number) => void): void;
+    /**
+     * Register a callback function to be called when the connection closes
+     *
+     * @param {Function} callback - Callback function to handle connection close
+     * @returns {void}
+     */
+    onClose(callback: () => void): void;
+    /**
+     * Register a callback function to be called when the connection opens
+     *
+     * @param {Function} callback - Callback function to handle connection open
+     * @returns {void}
+     */
+    onOpen(callback: () => void): void;
+    private startHeartbeat;
+    private stopHeartbeat;
+    private createSocket;
+    private closeSocket;
+    private getTimeout;
+    private sleep;
+    /**
+     * Convert a channel value to a string
+     *
+     * @private
+     * @param {string | Channel<any> | ActionableChannel | ResolvedChannel} channel - Channel value (string or Channel builder instance)
+     * @returns {string} Channel string representation
+     */
+    private channelToString;
+    /**
+     * Subscribe to a single channel
+     *
+     * @param {string | Channel<any> | ActionableChannel | ResolvedChannel} channel - Channel name to subscribe to (string or Channel builder instance)
+     * @param {Function} callback - Callback function to handle events
+     * @returns {Promise<RealtimeSubscription>} Subscription object with close method
+     */
+    subscribe(channel: string | Channel<any> | ActionableChannel | ResolvedChannel, callback: (event: RealtimeResponseEvent<any>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
+    /**
+     * Subscribe to multiple channels
+     *
+     * @param {(string | Channel<any> | ActionableChannel | ResolvedChannel)[]} channels - Array of channel names to subscribe to (strings or Channel builder instances)
+     * @param {Function} callback - Callback function to handle events
+     * @returns {Promise<RealtimeSubscription>} Subscription object with close method
+     */
+    subscribe(channels: (string | Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (event: RealtimeResponseEvent<any>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
+    /**
+     * Subscribe to a single channel with typed payload
+     *
+     * @param {string | Channel<any> | ActionableChannel | ResolvedChannel} channel - Channel name to subscribe to (string or Channel builder instance)
+     * @param {Function} callback - Callback function to handle events with typed payload
+     * @returns {Promise<RealtimeSubscription>} Subscription object with close method
+     */
+    subscribe<T>(channel: string | Channel<any> | ActionableChannel | ResolvedChannel, callback: (event: RealtimeResponseEvent<T>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
+    /**
+     * Subscribe to multiple channels with typed payload
+     *
+     * @param {(string | Channel<any> | ActionableChannel | ResolvedChannel)[]} channels - Array of channel names to subscribe to (strings or Channel builder instances)
+     * @param {Function} callback - Callback function to handle events with typed payload
+     * @returns {Promise<RealtimeSubscription>} Subscription object with close method
+     */
+    subscribe<T>(channels: (string | Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (event: RealtimeResponseEvent<T>) => void, queries?: (string | Query)[]): Promise<RealtimeSubscription>;
+    private handleMessage;
+    private handleResponseConnected;
+    private handleResponseError;
+    private handleResponseEvent;
+}

package/types/services/search.d.ts

@@ -0,0 +1,131 @@
+import { Client } from '../client';
+import { Collection } from '../enums/collection';
+export declare class Search {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * The collections the tenant's installed apps have provisioned.
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    searchListCollections(): Promise<{}>;
+    /**
+     * Full-text search within one collection using Typesense query parameters as the query string.
+     *
+     * @param {Collection} params.collection - Collection key (one the tenant has installed).
+     * @param {string} params.q - Query text. Use `*` to match all.
+     * @param {string} params.queryBy - Comma-separated fields to search.
+     * @param {string} params.filterBy - Filter expression.
+     * @param {string} params.sortBy - Sort expression.
+     * @param {number} params.page - 1-based page.
+     * @param {number} params.perPage - Hits per page (max 250).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    searchSearchDocumentsGet(params: {
+        collection: Collection;
+        q?: string;
+        queryBy?: string;
+        filterBy?: string;
+        sortBy?: string;
+        page?: number;
+        perPage?: number;
+    }): Promise<{}>;
+    /**
+     * Full-text search within one collection using Typesense query parameters as the query string.
+     *
+     * @param {Collection} collection - Collection key (one the tenant has installed).
+     * @param {string} q - Query text. Use `*` to match all.
+     * @param {string} queryBy - Comma-separated fields to search.
+     * @param {string} filterBy - Filter expression.
+     * @param {string} sortBy - Sort expression.
+     * @param {number} page - 1-based page.
+     * @param {number} perPage - Hits per page (max 250).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    searchSearchDocumentsGet(collection: Collection, q?: string, queryBy?: string, filterBy?: string, sortBy?: string, page?: number, perPage?: number): Promise<{}>;
+    /**
+     * Full-text search within one collection. The body holds Typesense search parameters.
+     *
+     * @param {Collection} params.collection - Collection key (one the tenant has installed).
+     * @param {string} params.facetBy - Comma-separated fields to facet on.
+     * @param {string} params.filterBy - Filter expression, e.g. `in_stock:=true`.
+     * @param {number} params.page -
+     * @param {number} params.perPage -
+     * @param {string} params.q - Query text. Use `*` to match all.
+     * @param {string} params.queryBy - Comma-separated fields to search.
+     * @param {string} params.sortBy - Sort expression, e.g. `price:desc`.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    searchSearchDocuments(params: {
+        collection: Collection;
+        facetBy?: string;
+        filterBy?: string;
+        page?: number;
+        perPage?: number;
+        q?: string;
+        queryBy?: string;
+        sortBy?: string;
+    }): Promise<{}>;
+    /**
+     * Full-text search within one collection. The body holds Typesense search parameters.
+     *
+     * @param {Collection} collection - Collection key (one the tenant has installed).
+     * @param {string} facetBy - Comma-separated fields to facet on.
+     * @param {string} filterBy - Filter expression, e.g. `in_stock:=true`.
+     * @param {number} page -
+     * @param {number} perPage -
+     * @param {string} q - Query text. Use `*` to match all.
+     * @param {string} queryBy - Comma-separated fields to search.
+     * @param {string} sortBy - Sort expression, e.g. `price:desc`.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    searchSearchDocuments(collection: Collection, facetBy?: string, filterBy?: string, page?: number, perPage?: number, q?: string, queryBy?: string, sortBy?: string): Promise<{}>;
+    /**
+     * Fetch a single document by id from a collection the tenant has installed.
+     *
+     * @param {Collection} params.collection - Collection key (one the tenant has installed).
+     * @param {string} params.documentId - Document id within the collection.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    searchGetDocument(params: {
+        collection: Collection;
+        documentId: string;
+    }): Promise<{}>;
+    /**
+     * Fetch a single document by id from a collection the tenant has installed.
+     *
+     * @param {Collection} collection - Collection key (one the tenant has installed).
+     * @param {string} documentId - Document id within the collection.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    searchGetDocument(collection: Collection, documentId: string): Promise<{}>;
+    /**
+     * Run several searches in one request (the InstantSearch adapter uses this). Each entry names its collection.
+     *
+     * @param {object[]} params.searches -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    searchMultiSearch(params: {
+        searches: object[];
+    }): Promise<{}>;
+    /**
+     * Run several searches in one request (the InstantSearch adapter uses this). Each entry names its collection.
+     *
+     * @param {object[]} searches -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    searchMultiSearch(searches: object[]): Promise<{}>;
+}