prostgles-server 4.2.105 → 4.2.106

package/dist/DboBuilder.d.ts

@@ -1,324 +0,0 @@
-import { QueryStreamer } from "./DboBuilder/QueryStreamer";
-import * as pgPromise from 'pg-promise';
-import { AnyObject, ColumnInfo, DbJoinMaker, EXISTS_KEY, PG_COLUMN_UDT_DATA_TYPE, ProstglesError, RawJoinPath, SQLHandler, SQLOptions, TableInfo as TInfo, TS_PG_Types } from "prostgles-types";
-import pg = require('pg-promise/typescript/pg-subset');
-export type SortItem = {
-    asc: boolean;
-    nulls?: "first" | "last";
-    nullEmpty?: boolean;
-    key: string;
-    nested?: {
-        table: string;
-        selectItemAlias: string;
-        isNumeric: boolean;
-        wrapperQuerySortItem: string;
-        joinAlias: string;
-    };
-} & ({
-    type: "query";
-    fieldQuery: string;
-} | {
-    type: "position";
-    fieldPosition: number;
-});
-export type Media = {
-    id?: string;
-    title?: string;
-    extension?: string;
-    content_type?: string;
-    content_length?: number;
-    url?: string;
-    added?: Date;
-    signed_url?: string;
-    signed_url_expires?: number;
-    name?: string;
-    original_name?: string;
-    etag?: string;
-    deleted?: string | null;
-    deleted_from_storage?: string | null;
-};
-export type ParsedMedia = Required<Pick<Media, "extension" | "content_type">>;
-export type TxCB<TH = DbTxTableHandlers> = {
-    (t: TH & Pick<DBHandlerServer, "sql">, _t: pgPromise.ITask<{}>): (any | void);
-};
-export type TX<TH = TableHandlers> = {
-    (t: TxCB<TH>): Promise<(any | void)>;
-};
-export type TableHandlers = {
-    [key: string]: Partial<TableHandler> | TableHandler;
-};
-export type DbTxTableHandlers = {
-    [key: string]: Omit<Partial<TableHandler>, "dbTx"> | Omit<TableHandler, "dbTx">;
-};
-export type DBHandlerServer<TH = TableHandlers> = TH & Partial<DbJoinMaker> & {
-    sql?: SQLHandler;
-} & {
-    tx?: TX<TH>;
-};
-import { FieldSpec } from "./DboBuilder/QueryBuilder/Functions";
-import { JoinPaths, ViewHandler } from "./DboBuilder/ViewHandler/ViewHandler";
-import { DB, Join, Prostgles } from "./Prostgles";
-import { BasicCallback, PubSubManager } from "./PubSubManager/PubSubManager";
-import { PublishAllOrNothing, PublishParser } from "./PublishParser/PublishParser";
-type PGP = pgPromise.IMain<{}, pg.IClient>;
-export declare const pgp: PGP;
-export type TableInfo = TInfo & {
-    schema: string;
-    name: string;
-    oid: number;
-    comment: string;
-    columns: ColumnInfo[];
-};
-export type ViewInfo = TableInfo & {
-    parent_tables: string[];
-};
-export type TableOrViewInfo = TableInfo & ViewInfo & {
-    is_view: boolean;
-};
-export type PRGLIOSocket = {
-    readonly id: string;
-    readonly handshake: {
-        query?: Record<string, string | string[] | undefined>;
-        /**
-         * IP Address
-         */
-        address: string;
-        headers?: AnyObject & {
-            cookie?: string;
-        };
-        auth?: Record<string, any>;
-    };
-    readonly on: (channel: string, params: any, cb?: (err: any, res?: any) => void) => any;
-    readonly emit: (channel: string, message?: any, cb?: BasicCallback) => any;
-    readonly once: (channel: string, cb: (_data: any, cb: BasicCallback) => void) => void;
-    readonly removeAllListeners: (channel: string) => void;
-    readonly disconnect: () => void;
-    readonly request: {
-        url?: string;
-        connection: {
-            remoteAddress?: string;
-        };
-    };
-    /** Used for session caching */
-    __prglCache?: {
-        session: BasicSession;
-        user: UserLike;
-        clientUser: AnyObject;
-    };
-    _user?: AnyObject;
-    /** Used for publish error caching */
-    prostgles?: AnyObject;
-};
-export type LocalParams = {
-    httpReq?: ExpressReq;
-    socket?: PRGLIOSocket;
-    func?: () => any;
-    isRemoteRequest?: {
-        user?: UserLike | undefined;
-    };
-    testRule?: boolean;
-    tableAlias?: string;
-    tx?: {
-        dbTX: TableHandlers;
-        t: pgPromise.ITask<{}>;
-    };
-    returnQuery?: boolean | "noRLS" | "where-condition";
-    returnNewQuery?: boolean;
-    /** Used for count/size queries */
-    bypassLimit?: boolean;
-    nestedInsert?: {
-        depth: number;
-        previousData: AnyObject;
-        previousTable: string;
-        referencingColumn?: string;
-    };
-};
-export declare function escapeTSNames(str: string, capitalize?: boolean): string;
-export type Aggregation = {
-    field: string;
-    query: string;
-    alias: string;
-    getQuery: (alias: string) => string;
-};
-export type Filter = AnyObject | {
-    $and: Filter[];
-} | {
-    $or: Filter[];
-};
-export type JoinInfo = {
-    /**
-     * If true then all joins involve unique columns and the result is a 1 to 1 join
-     */
-    expectOne?: boolean;
-    paths: {
-        /**
-         * The table that JOIN ON columns refer to.
-         * columns in index = 1 refer to this table. index = 0 columns refer to previous JoinInfo.table
-         */
-        table: string;
-        /**
-         * Source and target JOIN ON column groups for each existing constraint
-         * Each inner array group will be combined with AND and outer arrays with OR to allow multiple references to the same table
-         * e.g.:    [[source_table_column: string, table_column: string]]
-         */
-        on: [string, string][][];
-        /**
-         * Source table name
-         */
-        source: string;
-        /**
-         * Target table name
-         */
-        target: string;
-    }[];
-};
-import { Graph } from "./shortestPath";
-export type CommonTableRules = {
-    /**
-     * True by default. Allows clients to get column information on any columns that are allowed in (select, insert, update) field rules.
-     */
-    getColumns?: PublishAllOrNothing;
-    /**
-     * True by default. Allows clients to get table information (oid, comment, label, has_media).
-     */
-    getInfo?: PublishAllOrNothing;
-};
-export type ValidatedTableRules = CommonTableRules & {
-    allColumns: FieldSpec[];
-    select: {
-        fields: string[];
-        orderByFields: string[];
-        filterFields: string[];
-        forcedFilter: any;
-        maxLimit: number | null;
-    };
-    update: {
-        fields: string[];
-        returningFields: string[];
-        filterFields: string[];
-        forcedFilter: any;
-        forcedData: any;
-    };
-    insert: {
-        fields: string[];
-        returningFields: string[];
-        forcedData: any;
-    };
-    delete: {
-        filterFields: string[];
-        forcedFilter: any;
-        returningFields: string[];
-    };
-};
-export declare function makeErrorFromPGError(err: any, localParams?: LocalParams, view?: ViewHandler, allowedKeys?: string[]): Promise<never>;
-/**
- * Ensure the error is a serializable Object
- */
-export declare function parseError(e: any, caller: string): ProstglesError;
-export type ExistsFilterConfig = {
-    existType: EXISTS_KEY;
-    /**
-     * Target table filter. target table is the last table from tables
-     */
-    targetTableFilter: Filter;
-} & ({
-    isJoined: true;
-    /**
-     * list of join tables in their order
-     * If table path starts with "**" then get shortest join to first table
-     * e.g.: "**.users" means finding the shortest join from root table to users table
-     */
-    path: RawJoinPath;
-    parsedPath: ParsedJoinPath[];
-} | {
-    isJoined: false;
-    targetTable: string;
-});
-type OidInfo = {
-    /**
-     * Oid
-     */
-    relid: number;
-    relname: string;
-    schemaname: string;
-};
-type TableOidInfo = OidInfo & {
-    pkey_columns: string[] | null;
-};
-type TableOidColumnInfo = OidInfo & {
-    column_name: string;
-    udt_name: string;
-    ordinal_position: number;
-};
-import { BasicSession, ExpressReq, UserLike } from "./AuthHandler";
-import { TableHandler } from "./DboBuilder/TableHandler/TableHandler";
-import { ParsedJoinPath } from "./DboBuilder/ViewHandler/parseJoinPath";
-import { TableSchema } from "./DboBuilder/DboBuilderTypes";
-export declare class DboBuilder {
-    tablesOrViews?: TableSchema[];
-    /**
-     * Used in obtaining column names for error messages
-     */
-    constraints?: PGConstraint[];
-    db: DB;
-    dbo: DBHandlerServer;
-    _pubSubManager?: PubSubManager;
-    /**
-     * Used for db.sql field type details
-     */
-    DATA_TYPES: {
-        oid: string;
-        typname: PG_COLUMN_UDT_DATA_TYPE;
-    }[] | undefined;
-    USER_TABLES: TableOidInfo[] | undefined;
-    USER_TABLE_COLUMNS: TableOidColumnInfo[] | undefined;
-    queryStreamer: QueryStreamer;
-    getPubSubManager: () => Promise<PubSubManager>;
-    tsTypesDefinition?: string;
-    joinGraph?: Graph;
-    private shortestJoinPaths;
-    prostgles: Prostgles;
-    publishParser?: PublishParser;
-    onSchemaChange?: (event: {
-        command: string;
-        query: string;
-    }) => void;
-    private constructor();
-    private init;
-    static create: (prostgles: Prostgles) => Promise<DboBuilder>;
-    destroy(): void;
-    _joins?: Join[];
-    get joins(): Join[];
-    set joins(j: Join[]);
-    getAllJoinPaths(): JoinPaths;
-    prepareShortestJoinPaths: () => Promise<void>;
-    runSQL: (query: string, params: any, options: SQLOptions | undefined, localParams?: LocalParams) => Promise<any>;
-    build(): Promise<DBHandlerServer>;
-    getShortestJoinPath: (viewHandler: ViewHandler, target: string) => JoinPaths[number] | undefined;
-    getTX: (cb: TxCB) => Promise<any>;
-}
-type PGConstraint = {
-    /**
-     * Constraint type
-     */
-    contype: "u" | "p" | "c";
-    /**
-     * Column ordinal positions
-     */
-    conkey: number[];
-    /**
-     * Constraint name
-     */
-    conname: string;
-    /**
-     * Table name
-     */
-    relname: string;
-};
-export declare function isPlainObject(o: any): o is Record<string, any>;
-export declare function postgresToTsType(udt_data_type: PG_COLUMN_UDT_DATA_TYPE): keyof typeof TS_PG_Types;
-export declare const prepareOrderByQuery: (items: SortItem[], tableAlias?: string) => string[];
-export declare const canEXECUTE: (db: DB) => Promise<boolean>;
-export declare const withUserRLS: (localParams: LocalParams | undefined, query: string) => string;
-export {};
-//# sourceMappingURL=DboBuilder.d.ts.map

package/dist/DboBuilder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DboBuilder.d.ts","sourceRoot":"","sources":["../lib/DboBuilder.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,KAAK,SAAS,MAAM,YAAY,CAAC;AACxC,OAAO,EACL,SAAS,EACT,UAAU,EACV,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,cAAc,EACd,WAAW,EACX,UAAU,EACV,UAAU,EACV,SAAS,IAAI,KAAK,EAClB,WAAW,EAIZ,MAAM,iBAAiB,CAAC;AAIzB,OAAO,EAAE,GAAG,QAAQ,iCAAiC,CAAC,CAAC;AAEvD,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,EAAE,OAAO,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,eAAe,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,OAAO,CAAC;QACnB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,GAAG,CAAC;IACH,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG;IACF,IAAI,EAAE,UAAU,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC;AAGH,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,GAAG,cAAc,CAAC,CAAC,CAAC;AAE9E,MAAM,MAAM,IAAI,CAAC,EAAE,GAAG,iBAAiB,IAAI;IACzC,CAAC,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;CAC/E,CAAA;AACD,MAAM,MAAM,EAAE,CAAC,EAAE,GAAG,aAAa,IAAI;IACnC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC;CACtC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;CACrD,CAAA;AACD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;CACjF,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,EAAE,GAAG,aAAa,IAC5C,EAAE,GACF,OAAO,CAAC,WAAW,CAAC,GAAG;IACrB,GAAG,CAAC,EAAE,UAAU,CAAA;CACjB,GAAG;IACF,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;CACZ,CAAA;AAGH,OAAO,EAAE,SAAS,EAAG,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EACL,EAAE,EACF,IAAI,EAAE,SAAS,EAEhB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,aAAa,EAAY,MAAM,+BAA+B,CAAC;AACvF,OAAO,EACL,mBAAmB,EACnB,aAAa,EACd,MAAM,+BAA+B,CAAC;AAIvC,KAAK,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;AAC3C,eAAO,MAAM,GAAG,EAAE,GAGhB,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG;IACjC,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,QAAQ,GAAG;IACnD,OAAO,EAAE,OAAO,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,SAAS,EAAE;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;QACtD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,SAAS,GAAG;YAAE,MAAM,CAAC,EAAE,MAAM,CAAC;SAAE,CAAC;QAC3C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC5B,CAAA;IAED,QAAQ,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,KAAK,GAAG,CAAC;IAEvF,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,aAAa,KAAK,GAAG,CAAC;IAE3E,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,aAAa,KAAK,IAAI,KAAK,IAAI,CAAC;IAEtF,QAAQ,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAEvD,QAAQ,CAAC,UAAU,EAAE,MAAM,IAAI,CAAC;IAEhC,QAAQ,CAAC,OAAO,EAAE;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,UAAU,EAAE;YAAE,aAAa,CAAC,EAAE,MAAM,CAAC;SAAE,CAAA;KACxC,CAAA;IAED,+BAA+B;IAC/B,WAAW,CAAC,EAAE;QACZ,OAAO,EAAE,YAAY,CAAC;QACtB,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,EAAE,SAAS,CAAC;KACvB,CAAA;IAED,KAAK,CAAC,EAAE,SAAS,CAAA;IAEjB,qCAAqC;IACrC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC;IACjB,eAAe,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IAGpB,EAAE,CAAC,EAAE;QACH,IAAI,EAAE,aAAa,CAAC;QACpB,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACxB,CAAA;IAID,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,iBAAiB,CAAC;IACpD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,YAAY,CAAC,EAAE;QACb,KAAK,EAAE,MAAM,CAAC;QACd,YAAY,EAAE,SAAS,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAA;CACF,CAAA;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,UAAQ,GAAG,MAAM,CAKrE;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAExE,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE;QAEL;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAA;KACf,EAAE,CAAA;CACJ,CAAA;AAED,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC,MAAM,MAAM,gBAAgB,GAAG;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,mBAAmB,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG;IAGnD,UAAU,EAAE,SAAS,EAAE,CAAC;IAExB,MAAM,EAAE;QAEN,MAAM,EAAE,MAAM,EAAE,CAAC;QAGjB,aAAa,EAAE,MAAM,EAAE,CAAC;QAGxB,YAAY,EAAE,MAAM,EAAE,CAAC;QAGvB,YAAY,EAAE,GAAG,CAAC;QAGlB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB,CAAC;IACF,MAAM,EAAE;QAEN,MAAM,EAAE,MAAM,EAAE,CAAC;QAGjB,eAAe,EAAE,MAAM,EAAE,CAAC;QAG1B,YAAY,EAAE,MAAM,EAAE,CAAC;QAGvB,YAAY,EAAE,GAAG,CAAC;QAGlB,UAAU,EAAE,GAAG,CAAC;KACjB,CAAC;IACF,MAAM,EAAE;QAEN,MAAM,EAAE,MAAM,EAAE,CAAC;QAGjB,eAAe,EAAE,MAAM,EAAE,CAAC;QAG1B,UAAU,EAAE,GAAG,CAAC;KACjB,CAAC;IACF,MAAM,EAAE;QAEN,YAAY,EAAE,MAAM,EAAE,CAAC;QAGvB,YAAY,EAAE,GAAG,CAAC;QAGlB,eAAe,EAAE,MAAM,EAAE,CAAC;KAC3B,CAAA;CACF,CAAA;AAGD,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,kBA0BnH;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,CAejE;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAE3B,GAAG,CAAC;IACH,QAAQ,EAAE,IAAI,CAAC;IACf;;;;OAIG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB,UAAU,EAAE,cAAc,EAAE,CAAA;CAC7B,GAAG;IACF,QAAQ,EAAE,KAAK,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAAC;AAEH,KAAK,OAAO,GAAG;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,YAAY,GAAG,OAAO,GAAG;IAC5B,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF,KAAK,kBAAkB,GAAG,OAAO,GAAG;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGnE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAiB,MAAM,wCAAwC,CAAC;AAEvF,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,qBAAa,UAAU;IACrB,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,EAAE,CAAC;IAE7B,EAAE,EAAE,EAAE,CAAC;IAEP,GAAG,EAAE,eAAe,CAAC;IACrB,cAAc,CAAC,EAAE,aAAa,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,uBAAuB,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;IAC5E,WAAW,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;IACxC,kBAAkB,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAC;IAErD,aAAa,EAAE,aAAa,CAAC;IAE7B,gBAAgB,QAAa,QAAQ,aAAa,CAAC,CA4BlD;IAED,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,KAAK,CAAC;IAClB,OAAO,CAAC,iBAAiB,CAAiB;IAE1C,SAAS,EAAE,SAAS,CAAC;IACrB,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAErE,OAAO;IASP,OAAO,CAAC,IAAI,CAcX;IAED,OAAc,MAAM,cAAqB,SAAS,KAAG,QAAQ,UAAU,CAAC,CAGvE;IAGD,OAAO;IAIP,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC;IAChB,IAAI,KAAK,IAAI,IAAI,EAAE,CAElB;IAED,IAAI,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,EAElB;IAED,eAAe;IAIf,wBAAwB,sBAKvB;IAED,MAAM,UAAiB,MAAM,UAAU,GAAG,WAAW,UAAU,GAAG,SAAS,gBAAgB,WAAW,kBAErG;IACK,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAsEvC,mBAAmB,gBAAiB,WAAW,UAAU,MAAM,KAAG,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,CAoB9F;IAED,KAAK,OAAQ,IAAI,kBAahB;CACF;AAED,KAAK,YAAY,GAAG;IAElB;;OAEG;IACH,OAAO,EACL,GAAG,GACH,GAAG,GACH,GAAG,CAAA;IAEL;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAgBF,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAE9D;AAED,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,uBAAuB,GAAG,MAAM,OAAO,WAAW,CAKjG;AAED,eAAO,MAAM,mBAAmB,UAAW,QAAQ,EAAE,eAAe,MAAM,KAAG,MAAM,EAWlF,CAAA;AAED,eAAO,MAAM,UAAU,8BAUtB,CAAA;AAED,eAAO,MAAM,WAAW,gBAAiB,WAAW,GAAG,SAAS,SAAS,MAAM,WAU9E,CAAA"}

package/dist/DboBuilder.js

@@ -1,345 +0,0 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Stefan L. All rights reserved.
- *  Licensed under the MIT License. See LICENSE in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withUserRLS = exports.canEXECUTE = exports.prepareOrderByQuery = exports.postgresToTsType = exports.isPlainObject = exports.DboBuilder = exports.parseError = exports.makeErrorFromPGError = exports.escapeTSNames = exports.pgp = void 0;
-const Bluebird = require("bluebird");
-const QueryStreamer_1 = require("./DboBuilder/QueryStreamer");
-const pgPromise = require("pg-promise");
-const prostgles_types_1 = require("prostgles-types");
-const getTablesForSchemaPostgresSQL_1 = require("./DboBuilder/getTablesForSchemaPostgresSQL");
-const runSQL_1 = require("./DboBuilder/runSQL");
-const sqlErrCodeToMsg_1 = require("./DboBuilder/sqlErrCodeToMsg");
-const ViewHandler_1 = require("./DboBuilder/ViewHandler/ViewHandler");
-const PubSubManager_1 = require("./PubSubManager/PubSubManager");
-const utils_1 = require("./utils");
-exports.pgp = pgPromise({
-    promiseLib: Bluebird
-    // ,query: function (e) { console.log({psql: e.query, params: e.params}); }
-});
-function escapeTSNames(str, capitalize = false) {
-    let res = str;
-    res = (capitalize ? str[0]?.toUpperCase() : str[0]) + str.slice(1);
-    if (canBeUsedAsIsInTypescript(res))
-        return res;
-    return JSON.stringify(res);
-}
-exports.escapeTSNames = escapeTSNames;
-/* DEBUG CLIENT ERRORS HERE */
-function makeErrorFromPGError(err, localParams, view, allowedKeys) {
-    if (process.env.PRGL_DEBUG) {
-        console.trace(err);
-    }
-    const errObject = {
-        ...((!localParams || !localParams.socket) ? err : {}),
-        ...(0, PubSubManager_1.pickKeys)(err, ["column", "code", "table", "constraint", "hint"]),
-        ...(err && err.toString ? { txt: err.toString() } : {}),
-        code_info: (0, sqlErrCodeToMsg_1.sqlErrCodeToMsg)(err.code)
-    };
-    if (view?.dboBuilder?.constraints && errObject.constraint && !errObject.column) {
-        const constraint = view.dboBuilder.constraints
-            .find(c => c.conname === errObject.constraint && c.relname === view.name);
-        if (constraint) {
-            const cols = view.columns.filter(c => (!allowedKeys || allowedKeys.includes(c.name)) &&
-                constraint.conkey.includes(c.ordinal_position));
-            const [firstCol] = cols;
-            if (firstCol) {
-                errObject.column = firstCol.name;
-                errObject.columns = cols.map(c => c.name);
-            }
-        }
-    }
-    return Promise.reject(errObject);
-}
-exports.makeErrorFromPGError = makeErrorFromPGError;
-/**
- * Ensure the error is a serializable Object
- */
-function parseError(e, caller) {
-    const errorObject = (0, prostgles_types_1.isObject)(e) ? e : undefined;
-    const message = typeof e === "string" ? e : e instanceof Error ? e.message :
-        (0, prostgles_types_1.isObject)(errorObject) ? (errorObject.message ?? errorObject.txt ?? JSON.stringify(errorObject) ?? "") : "";
-    const stack = [
-        ...(errorObject && Array.isArray(errorObject.stack) ? errorObject.stack : []),
-        caller
-    ];
-    const result = {
-        ...errorObject,
-        message,
-        stack,
-    };
-    return result;
-}
-exports.parseError = parseError;
-const DBSchemaBuilder_1 = require("./DBSchemaBuilder");
-const QueryBuilder_1 = require("./DboBuilder/QueryBuilder/QueryBuilder");
-const TableHandler_1 = require("./DboBuilder/TableHandler/TableHandler");
-const parseJoinPath_1 = require("./DboBuilder/ViewHandler/parseJoinPath");
-const prepareShortestJoinPaths_1 = require("./DboBuilder/prepareShortestJoinPaths");
-class DboBuilder {
-    tablesOrViews;
-    /**
-     * Used in obtaining column names for error messages
-     */
-    constraints;
-    db;
-    dbo;
-    _pubSubManager;
-    /**
-     * Used for db.sql field type details
-     */
-    DATA_TYPES;
-    USER_TABLES;
-    USER_TABLE_COLUMNS;
-    queryStreamer;
-    getPubSubManager = async () => {
-        if (!this._pubSubManager) {
-            let onSchemaChange;
-            const { isSuperUs } = await PubSubManager_1.PubSubManager.canCreate(this.db);
-            if (!exports.canEXECUTE)
-                throw "PubSubManager based subscriptions not possible: Cannot run EXECUTE statements on this connection";
-            if (this.prostgles.opts.watchSchema && this.prostgles.opts.watchSchemaType === "DDL_trigger") {
-                if (!isSuperUs) {
-                    console.warn(`watchSchemaType "${this.prostgles.opts.watchSchemaType}" cannot be used because db user is not a superuser. Will fallback to watchSchemaType "prostgles_queries" `);
-                }
-                else {
-                    onSchemaChange = (event) => {
-                        this.prostgles.onSchemaChange(event);
-                    };
-                }
-            }
-            this._pubSubManager = await PubSubManager_1.PubSubManager.create({
-                dboBuilder: this,
-                onSchemaChange
-            });
-        }
-        if (!this._pubSubManager) {
-            console.trace("Could not create this._pubSubManager");
-            throw "Could not create this._pubSubManager";
-        }
-        return this._pubSubManager;
-    };
-    tsTypesDefinition;
-    joinGraph;
-    shortestJoinPaths = [];
-    prostgles;
-    publishParser;
-    onSchemaChange;
-    constructor(prostgles) {
-        this.prostgles = prostgles;
-        if (!this.prostgles.db)
-            throw "db missing";
-        this.db = this.prostgles.db;
-        this.dbo = {};
-        this.queryStreamer = new QueryStreamer_1.QueryStreamer(this.db);
-        this.queryStreamer.startQuery({ id: "1", socketId: "1", query: "", onData: console.log });
-    }
-    init = async () => {
-        /* If watchSchema then PubSubManager must be created (if possible) */
-        await this.build();
-        if (this.prostgles.opts.watchSchema &&
-            (this.prostgles.opts.watchSchemaType === "DDL_trigger" || !this.prostgles.opts.watchSchemaType) &&
-            this.prostgles.isSuperUser) {
-            await this.getPubSubManager();
-        }
-        return this;
-    };
-    static create = async (prostgles) => {
-        const res = new DboBuilder(prostgles);
-        return await res.init();
-    };
-    destroy() {
-        this._pubSubManager?.destroy();
-    }
-    _joins;
-    get joins() {
-        return (0, utils_1.clone)(this._joins ?? []).filter(j => j.tables[0] !== j.tables[1]);
-    }
-    set joins(j) {
-        this._joins = (0, utils_1.clone)(j);
-    }
-    getAllJoinPaths() {
-        return this.shortestJoinPaths;
-    }
-    prepareShortestJoinPaths = async () => {
-        const { joins, shortestJoinPaths, joinGraph } = await (0, prepareShortestJoinPaths_1.prepareShortestJoinPaths)(this);
-        this.joinGraph = joinGraph;
-        this.joins = joins;
-        this.shortestJoinPaths = shortestJoinPaths;
-    };
-    runSQL = async (query, params, options, localParams) => {
-        return runSQL_1.runSQL.bind(this)(query, params, options, localParams);
-    };
-    async build() {
-        const start = Date.now();
-        const tablesOrViewsReq = await (0, getTablesForSchemaPostgresSQL_1.getTablesForSchemaPostgresSQL)(this, this.prostgles.opts.schema);
-        await this.prostgles.opts.onLog?.({
-            type: "debug",
-            command: "DboBuilder.getTablesForSchemaPostgresSQL",
-            data: tablesOrViewsReq.durations,
-            duration: Date.now() - start,
-        });
-        this.tablesOrViews = tablesOrViewsReq.result;
-        this.constraints = await getConstraints(this.db, this.prostgles.opts.schema);
-        await this.prepareShortestJoinPaths();
-        this.dbo = {};
-        this.tablesOrViews.map(tov => {
-            const columnsForTypes = tov.columns.slice(0).sort((a, b) => a.name.localeCompare(b.name));
-            const filterKeywords = Object.values(this.prostgles.keywords);
-            const $filterCol = columnsForTypes.find(c => filterKeywords.includes(c.name));
-            if ($filterCol) {
-                throw `DboBuilder init error: \n\nTable ${JSON.stringify(tov.name)} column ${JSON.stringify($filterCol.name)} is colliding with Prostgles filtering functionality ($filter keyword)
-                Please provide a replacement keyword name using the $filter_keyName init option. 
-                Alternatively you can rename the table column\n`;
-            }
-            this.dbo[tov.escaped_identifier] = new (tov.is_view ? ViewHandler_1.ViewHandler : TableHandler_1.TableHandler)(this.db, tov, this, undefined, this.shortestJoinPaths);
-            if (this.shortestJoinPaths && this.shortestJoinPaths.find(jp => [jp.t1, jp.t2].includes(tov.name))) {
-                const table = tov.name;
-                this.dbo.innerJoin ??= {};
-                this.dbo.leftJoin ??= {};
-                this.dbo.innerJoinOne ??= {};
-                this.dbo.leftJoinOne ??= {};
-                const joinHandlers = (0, prostgles_types_1.getJoinHandlers)(table);
-                this.dbo.leftJoin[table] = joinHandlers.leftJoin;
-                this.dbo.innerJoin[table] = joinHandlers.innerJoin;
-                this.dbo.leftJoinOne[table] = joinHandlers.leftJoinOne;
-                this.dbo.innerJoinOne[table] = joinHandlers.innerJoinOne;
-            }
-        });
-        if (this.prostgles.opts.transactions) {
-            let txKey = "tx";
-            if (typeof this.prostgles.opts.transactions === "string")
-                txKey = this.prostgles.opts.transactions;
-            this.dbo[txKey] = (cb) => this.getTX(cb);
-        }
-        if (!this.dbo.sql) {
-            this.dbo.sql = this.runSQL;
-        }
-        else {
-            console.warn(`Could not create dbo.sql handler because there is already a table named "sql"`);
-        }
-        this.tsTypesDefinition = [
-            `/* SCHEMA DEFINITON. Table names have been altered to work with Typescript */`,
-            `/* DBO Definition */`,
-            (0, DBSchemaBuilder_1.getDBSchema)(this)
-        ].join("\n");
-        return this.dbo;
-    }
-    getShortestJoinPath = (viewHandler, target) => {
-        const source = viewHandler.name;
-        if (source === target) {
-            const joinPath = (0, parseJoinPath_1.parseJoinPath)({
-                rawPath: target,
-                rootTable: source,
-                viewHandler
-            });
-            if (!joinPath)
-                return undefined;
-            return {
-                t1: source,
-                t2: target,
-                path: [source]
-            };
-        }
-        const jp = this.shortestJoinPaths.find(jp => jp.t1 === source && jp.t2 === target);
-        return jp;
-    };
-    getTX = (cb) => {
-        return this.db.tx(t => {
-            const dbTX = {};
-            this.tablesOrViews?.map(tov => {
-                dbTX[tov.name] = new (tov.is_view ? ViewHandler_1.ViewHandler : TableHandler_1.TableHandler)(this.db, tov, this, { t, dbTX }, this.shortestJoinPaths);
-            });
-            // ???? getKeys(dbTX).map(k => {
-            //   dbTX[k]!.dbTX = dbTX;
-            // });
-            dbTX.sql = (q, args, opts, localP) => this.runSQL(q, args, opts, { tx: { dbTX, t }, ...(localP ?? {}) });
-            return cb(dbTX, t);
-        });
-    };
-}
-exports.DboBuilder = DboBuilder;
-async function getConstraints(db, schema) {
-    const { sql, schemaNames } = (0, getTablesForSchemaPostgresSQL_1.getSchemaFilter)(schema);
-    return db.any(`
-    SELECT rel.relname, con.conkey, con.conname, con.contype
-    FROM pg_catalog.pg_constraint con
-        INNER JOIN pg_catalog.pg_class rel
-            ON rel.oid = con.conrelid
-        INNER JOIN pg_catalog.pg_namespace nsp
-            ON nsp.oid = connamespace
-    WHERE nsp.nspname ${sql}
-  `, { schemaNames });
-}
-function isPlainObject(o) {
-    return Object(o) === o && Object.getPrototypeOf(o) === Object.prototype;
-}
-exports.isPlainObject = isPlainObject;
-function postgresToTsType(udt_data_type) {
-    return (0, prostgles_types_1.getKeys)(prostgles_types_1.TS_PG_Types).find(k => {
-        // @ts-ignore
-        return prostgles_types_1.TS_PG_Types[k].includes(udt_data_type);
-    }) ?? "any";
-}
-exports.postgresToTsType = postgresToTsType;
-const prepareOrderByQuery = (items, tableAlias) => {
-    if (!items.length)
-        return [];
-    return ["ORDER BY " + items.map(d => {
-            const orderType = d.asc ? " ASC " : " DESC ";
-            const nullOrder = d.nulls ? ` NULLS ${d.nulls === "first" ? " FIRST " : " LAST "}` : "";
-            if (d.type === "query" && d.nested) {
-                return d.fieldQuery;
-            }
-            return `${(0, QueryBuilder_1.asNameAlias)(d.key, tableAlias)} ${orderType} ${nullOrder}`;
-        }).join(", ")];
-};
-exports.prepareOrderByQuery = prepareOrderByQuery;
-const canEXECUTE = async (db) => {
-    try {
-        await db.any(`DO $$ BEGIN  EXECUTE 'select 1'; END $$;`);
-        return true;
-    }
-    catch (error) {
-        console.warn(error);
-    }
-    return false;
-};
-exports.canEXECUTE = canEXECUTE;
-const withUserRLS = (localParams, query) => {
-    const user = localParams?.isRemoteRequest?.user;
-    const queryPrefix = `SET SESSION "prostgles.user" \nTO`;
-    let firstQuery = `${queryPrefix} '';`;
-    if (user) {
-        firstQuery = exports.pgp.as.format(`${queryPrefix} \${user};`, { user });
-    }
-    return [firstQuery, query].join("\n");
-};
-exports.withUserRLS = withUserRLS;
-function canBeUsedAsIsInTypescript(str) {
-    if (!str)
-        return false;
-    const isAlphaNumericOrUnderline = str.match(/^[a-z0-9_]+$/i);
-    const startsWithCharOrUnderscore = str[0]?.match(/^[a-z_]+$/i);
-    return Boolean(isAlphaNumericOrUnderline && startsWithCharOrUnderscore);
-}
-function snakify(str, capitalize = false) {
-    return str.split("").map((c, i) => {
-        if (!i) {
-            if (capitalize)
-                c = c.toUpperCase();
-            if (c.match(/[^a-z_A-Z]/)) {
-                return ((capitalize) ? "D_" : "_") + c.charCodeAt(0);
-            }
-        }
-        else {
-            if (c.match(/[^a-zA-Z_0-9]/)) {
-                return "_" + c.charCodeAt(0);
-            }
-        }
-        return c;
-    }).join("");
-}
-//# sourceMappingURL=DboBuilder.js.map