prostgles-server 2.0.178 → 2.0.179

package/lib/PubSubManager.d.ts

@@ -0,0 +1,157 @@
+/// <reference types="node" />
+import { PostgresNotifListenManager } from "./PostgresNotifListenManager";
+import { TableOrViewInfo, TableInfo, DBHandlerServer, DboBuilder, PRGLIOSocket } from "./DboBuilder";
+import { DB } from "./Prostgles";
+import { SelectParams, FieldFilter, WAL, AnyObject } from "prostgles-types";
+import { ClientExpressData } from "./SyncReplication";
+import { TableRule } from "./PublishParser";
+export declare const asValue: (v: any) => string;
+export declare const DEFAULT_SYNC_BATCH_SIZE = 50;
+export declare const log: (...args: any[]) => void;
+export declare type BasicCallback = (err?: any, res?: any) => void;
+export declare type SyncParams = {
+    socket_id: string;
+    channel_name: string;
+    table_name: string;
+    table_rules?: TableRule;
+    synced_field: string;
+    allow_delete: boolean;
+    id_fields: string[];
+    batch_size: number;
+    filter: object;
+    params: {
+        select: FieldFilter;
+    };
+    condition: string;
+    wal?: WAL;
+    throttle?: number;
+    lr?: AnyObject;
+    last_synced: number;
+    is_syncing: boolean;
+};
+declare type AddSyncParams = {
+    socket: any;
+    table_info: TableInfo;
+    table_rules: TableRule;
+    synced_field: string;
+    allow_delete?: boolean;
+    id_fields: string[];
+    filter: object;
+    params: {
+        select: FieldFilter;
+    };
+    condition: string;
+    throttle?: number;
+};
+declare type SubscriptionParams = {
+    socket_id?: string;
+    channel_name: string;
+    table_name: string;
+    socket: PRGLIOSocket | undefined;
+    table_info: TableOrViewInfo;
+    table_rules?: TableRule;
+    filter: object;
+    params: SelectParams;
+    func?: (data: any) => any;
+    throttle?: number;
+    last_throttled: number;
+    is_throttling?: any;
+    is_ready?: boolean;
+};
+declare type AddSubscriptionParams = SubscriptionParams & {
+    condition: string;
+};
+export declare type PubSubManagerOptions = {
+    dboBuilder: DboBuilder;
+    db: DB;
+    dbo: DBHandlerServer;
+    wsChannelNamePrefix?: string;
+    pgChannelName?: string;
+    onSchemaChange?: (event: {
+        command: string;
+        query: string;
+    }) => void;
+};
+export declare class PubSubManager {
+    static DELIMITER: string;
+    dboBuilder: DboBuilder;
+    db: DB;
+    dbo: DBHandlerServer;
+    _triggers?: Record<string, string[]>;
+    sockets: any;
+    subs: {
+        [ke: string]: {
+            [ke: string]: {
+                subs: SubscriptionParams[];
+            };
+        };
+    };
+    syncs: SyncParams[];
+    socketChannelPreffix: string;
+    onSchemaChange?: ((event: {
+        command: string;
+        query: string;
+    }) => void);
+    postgresNotifListenManager?: PostgresNotifListenManager;
+    private constructor();
+    NOTIF_TYPE: {
+        data: string;
+        schema: string;
+    };
+    NOTIF_CHANNEL: {
+        preffix: string;
+        getFull: (appID?: string) => string;
+    };
+    private appID?;
+    appCheckFrequencyMS: number;
+    appCheck?: ReturnType<typeof setInterval>;
+    static create: (options: PubSubManagerOptions) => Promise<PubSubManager>;
+    destroyed: boolean;
+    destroy: () => void;
+    canContinue: () => boolean;
+    appChecking: boolean;
+    init: () => Promise<PubSubManager | undefined>;
+    DB_OBJ_NAMES: {
+        trigger_add_remove_func: string;
+        data_watch_func: string;
+        schema_watch_func: string;
+        schema_watch_trigger: string;
+    };
+    static EXCLUDE_QUERY_FROM_SCHEMA_WATCH_ID: string;
+    prepareTriggers: () => Promise<boolean>;
+    isReady(): any;
+    getSubs(table_name: string, condition: string): SubscriptionParams[];
+    getSyncs(table_name: string, condition: string): SyncParams[];
+    notifListener: (data: {
+        payload: string;
+    }) => Promise<void>;
+    pushSubData(sub: SubscriptionParams, err?: any): true | Promise<unknown>;
+    upsertSocket(socket: any, channel_name: string): void;
+    syncTimeout?: ReturnType<typeof setTimeout>;
+    syncData(sync: SyncParams, clientData: ClientExpressData | undefined, source: "trigger" | "client"): Promise<void>;
+    /**
+     * Returns a sync channel
+     * A sync channel is unique per socket for each filter
+     */
+    addSync(syncParams: AddSyncParams): Promise<string>;
+    parseCondition: (condition: string) => string;
+    addSub(subscriptionParams: Omit<AddSubscriptionParams, "channel_name">): Promise<string>;
+    removeLocalSub(table_name: string, condition: string, func: (items: object[]) => any): void;
+    getActiveListeners: () => {
+        table_name: string;
+        condition: string;
+    }[];
+    onSocketDisconnected(socket?: PRGLIOSocket, channel_name?: string): string;
+    checkIfTimescaleBug: (table_name: string) => Promise<boolean>;
+    getMyTriggerQuery: () => Promise<string>;
+    addingTrigger: any;
+    addTriggerPool?: Record<string, string[]>;
+    addTrigger(params: {
+        table_name: string;
+        condition: string;
+    }): Promise<boolean>;
+}
+export declare function omitKeys<T extends AnyObject, Exclude extends keyof T>(obj: T, exclude: Exclude[]): Omit<T, Exclude>;
+export declare function pickKeys<T extends AnyObject, Include extends keyof T>(obj: T, include?: Include[]): Pick<T, Include>;
+export {};
+//# sourceMappingURL=PubSubManager.d.ts.map

package/lib/PubSubManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PubSubManager.d.ts","sourceRoot":"","sources":["PubSubManager.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,eAAe,EAAgB,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACnH,OAAO,EAAE,EAAE,EAAe,MAAM,aAAa,CAAC;AAM9C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAU,GAAG,EAAW,SAAS,EAAW,MAAM,iBAAiB,CAAC;AAEtG,OAAO,EAAE,iBAAiB,EAAY,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAM5C,eAAO,MAAM,OAAO,MAAO,GAAG,WAA6B,CAAC;AAC5D,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,eAAO,MAAM,GAAG,YAAa,GAAG,EAAE,SAIjC,CAAA;AAED,oBAAY,aAAa,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,CAAA;AAE1D,oBAAY,UAAU,GAAG;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE;QACN,MAAM,EAAE,WAAW,CAAA;KACpB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,SAAS,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACrB,CAAA;AAED,aAAK,aAAa,GAAG;IACnB,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,SAAS,CAAC;IACtB,WAAW,EAAE,SAAS,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE;QACN,MAAM,EAAE,WAAW,CAAA;KACpB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,aAAK,kBAAkB,GAAG;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;IACjC,UAAU,EAAE,eAAe,CAAC;IAC5B,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CAEpB,CAAA;AACD,aAAK,qBAAqB,GAAG,kBAAkB,GAAG;IAChD,SAAS,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,oBAAY,oBAAoB,GAAG;IACjC,UAAU,EAAE,UAAU,CAAC;IACvB,EAAE,EAAE,EAAE,CAAC;IACP,GAAG,EAAE,eAAe,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CACtE,CAAA;AAED,qBAAa,aAAa;IACxB,MAAM,CAAC,SAAS,SAAiB;IAEjC,UAAU,EAAE,UAAU,CAAC;IACvB,EAAE,EAAE,EAAE,CAAC;IACP,GAAG,EAAE,eAAe,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACrC,OAAO,EAAE,GAAG,CAAC;IACb,IAAI,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG;gBAAE,IAAI,EAAE,kBAAkB,EAAE,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAC;IACzE,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC,CAAa;IAEnF,0BAA0B,CAAC,EAAE,0BAA0B,CAAC;IAExD,OAAO;IAkBP,UAAU;;;MAGT;IACD,aAAa;;0BAEO,MAAM;MAIzB;IAED,OAAO,CAAC,KAAK,CAAC,CAAS;IAEvB,mBAAmB,SAAa;IAChC,QAAQ,CAAC,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;IAoB1C,OAAc,MAAM,YAAmB,oBAAoB,4BAG1D;IAED,SAAS,UAAS;IAClB,OAAO,aAWN;IAED,WAAW,gBAMV;IAED,WAAW,UAAS;IACpB,IAAI,QAAa,QAAQ,aAAa,GAAG,SAAS,CAAC,CAgoBlD;IAED,YAAY;;;;;MAKX;IAED,MAAM,CAAC,kCAAkC,SAA2D;IACpG,eAAe,yBAwHd;IAED,OAAO;IAKP,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,kBAAkB,EAAE;IAIpE,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAM9C,aAAa,SAAgB;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,mBAoH/C;IAGD,WAAW,CAAC,GAAG,EAAE,kBAAkB,EAAE,GAAG,CAAC,EAAE,GAAG;IA8C9C,YAAY,CAAC,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM;IAO9C,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,iBAAiB,GAAG,SAAS,EAAE,MAAM,EAAE,SAAS,GAAG,QAAQ;IAIxG;;;OAGG;IACG,OAAO,CAAC,UAAU,EAAE,aAAa;IAiHvC,cAAc,cAAe,MAAM,KAAG,MAAM,CAAsE;IAI5G,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,EAAE,cAAc,CAAC;IA6H5E,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG;IAepF,kBAAkB,QAAO;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EAAE,CAmBnE;IAED,oBAAoB,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,EAAE,MAAM;IAwDjE,mBAAmB,eAAsB,MAAM,sBAgB9C;IAQD,iBAAiB,wBAQhB;IAGD,aAAa,EAAE,GAAG,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAa;IAChD,UAAU,CAAC,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;KAAE;CA4DpE;AAED,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAEnH;AAED,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,GAAE,OAAO,EAAO,GAAG,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAcxH"}