prostgles-server 2.0.178 → 2.0.179

package/lib/PublishParser.d.ts

@@ -0,0 +1,262 @@
+import { AnyObject, TableSchemaForClient, DBSchemaTable, FullFilter } from "prostgles-types";
+import { ClientInfo } from "./AuthHandler";
+import { CommonTableRules, LocalParams, PRGLIOSocket } from "./DboBuilder";
+import { Prostgles, DBHandlerServer, DB } from "./Prostgles";
+import type { DBOFullyTyped, PublishFullyTyped } from "./DBSchemaBuilder";
+export declare type Method = (...args: any) => (any | Promise<any>);
+export declare type PublishMethods<S = void> = (params: PublishParams<S>) => {
+    [key: string]: Method;
+} | Promise<{
+    [key: string]: Method;
+}>;
+export declare type Awaitable<T> = T | Promise<T>;
+declare type Request = {
+    socket?: any;
+    httpReq?: any;
+};
+declare type DboTable = Request & {
+    tableName: string;
+    localParams: LocalParams;
+};
+declare type DboTableCommand = Request & DboTable & {
+    command: string;
+    localParams: LocalParams;
+};
+import { FieldFilter, SelectParams } from "prostgles-types";
+export declare type InsertRequestData = {
+    data: object | object[];
+    returning: FieldFilter;
+};
+export declare type SelectRequestData = {
+    filter: object;
+    params: SelectParams;
+};
+export declare type DeleteRequestData = {
+    filter: object;
+    returning: FieldFilter;
+};
+export declare type UpdateRequestDataOne<R> = {
+    filter: FullFilter<R>;
+    data: Partial<R>;
+    returning: FieldFilter<R>;
+};
+export declare type UpdateReq<R> = {
+    filter: FullFilter<R>;
+    data: Partial<R>;
+};
+export declare type UpdateRequestDataBatch<R> = {
+    data: UpdateReq<R>[];
+};
+export declare type UpdateRequestData<R extends AnyObject = AnyObject> = UpdateRequestDataOne<R> | UpdateRequestDataBatch<R>;
+export declare type ValidateRow<R extends AnyObject = AnyObject> = (row: R) => R | Promise<R>;
+export declare type ValidateUpdateRow<R extends AnyObject = AnyObject> = (args: {
+    update: Partial<R>;
+    filter: FullFilter<R>;
+}) => R | Promise<R>;
+export declare type SelectRule<Cols extends AnyObject = AnyObject> = {
+    /**
+     * Fields allowed to be selected.   Tip: Use false to exclude field
+     */
+    fields: FieldFilter<Cols>;
+    /**
+     * The maximum number of rows a user can get in a select query. null by default. Unless a null or higher limit is specified 100 rows will be returned by the default
+     */
+    maxLimit?: number | null;
+    /**
+     * Filter added to every query (e.g. user_id) to restrict access
+     */
+    forcedFilter?: FullFilter<Cols>;
+    /**
+     * Fields user can filter by
+     * */
+    filterFields?: FieldFilter<Cols>;
+    /**
+     * Validation logic to check/update data for each request
+     */
+    validate?(args: SelectRequestData): SelectRequestData | Promise<SelectRequestData>;
+};
+export declare type InsertRule<Cols extends AnyObject = AnyObject> = {
+    /**
+     * Fields allowed to be inserted.   Tip: Use false to exclude field
+     */
+    fields: SelectRule<Cols>["fields"];
+    /**
+     * Data to include/overwrite on each insert
+     */
+    forcedData?: Partial<Cols>;
+    /**
+     * Fields user can view after inserting
+     */
+    returningFields?: SelectRule<Cols>["fields"];
+    /**
+     * Validation logic to check/update data for each request. Happens before publish rule checks (for fields, forcedData/forcedFilter)
+     */
+    preValidate?: ValidateRow<Cols>;
+    /**
+     * Validation logic to check/update data for each request. Happens after publish rule checks (for fields, forcedData/forcedFilter)
+     */
+    validate?: InsertRule<Cols>["preValidate"];
+};
+export declare type UpdateRule<Cols extends AnyObject = AnyObject> = {
+    /**
+     * Fields allowed to be updated.   Tip: Use false/0 to exclude field
+     */
+    fields: SelectRule<Cols>["fields"];
+    /**
+     * Row level FGAC
+     * Used when the editable fields change based on the updated row
+     * If specified then the fields from the first matching filter table.count({ ...filter, ...updateFilter }) > 0 will be used
+     * If none matching then the "fields" will be used
+     * Specify in decreasing order of specificity otherwise a more general filter will match first
+     */
+    dynamicFields?: {
+        filter: SelectRule<Cols>["forcedFilter"];
+        fields: SelectRule<Cols>["fields"];
+    }[];
+    /**
+     * Filter added to every query (e.g. user_id) to restrict access
+     * This filter cannot be updated
+     */
+    forcedFilter?: SelectRule<Cols>["forcedFilter"];
+    /**
+     * Data to include/overwrite on each updatDBe
+     */
+    forcedData?: InsertRule<Cols>["forcedData"];
+    /**
+     * Fields user can use to find the updates
+     */
+    filterFields?: SelectRule<Cols>["fields"];
+    /**
+     * Fields user can view after updating
+     */
+    returningFields?: SelectRule<Cols>["fields"];
+    /**
+     * Validation logic to check/update data for each request
+     */
+    validate?: ValidateUpdateRow<Cols>;
+};
+export declare type DeleteRule<Cols extends AnyObject = AnyObject> = {
+    /**
+     * Filter added to every query (e.g. user_id) to restrict access
+     */
+    forcedFilter?: SelectRule<Cols>["forcedFilter"];
+    /**
+     * Fields user can filter by
+     */
+    filterFields?: SelectRule<Cols>["filterFields"];
+    /**
+     * Fields user can view after deleting
+     */
+    returningFields?: SelectRule<Cols>["filterFields"];
+    /**
+     * Validation logic to check/update data for each request
+     */
+    validate?(...args: any[]): UpdateRequestData<Cols>;
+};
+export declare type SyncRule<Cols extends AnyObject = AnyObject> = {
+    /**
+     * Primary keys used in updating data
+     */
+    id_fields: (keyof Cols)[];
+    /**
+     * Numerical incrementing fieldname (last updated timestamp) used to sync items
+     */
+    synced_field: keyof Cols;
+    /**
+     * EXPERIMENTAL. Disabled by default. If true then server will attempt to delete any records missing from client.
+     */
+    allow_delete?: boolean;
+    /**
+     * Throttle replication transmission in milliseconds. Defaults to 100
+     */
+    throttle?: number;
+    /**
+     * Number of rows to send per trip. Defaults to 50
+     */
+    batch_size?: number;
+};
+export declare type SubscribeRule = {
+    throttle?: number;
+};
+export declare type ViewRule<S = AnyObject> = CommonTableRules & {
+    /**
+     * What can be read from the table
+     */
+    select?: SelectRule<S>;
+};
+export declare type TableRule<S = AnyObject> = ViewRule<S> & {
+    insert?: InsertRule<S>;
+    update?: UpdateRule<S>;
+    delete?: DeleteRule<S>;
+    sync?: SyncRule<S>;
+    subscribe?: SubscribeRule;
+};
+export declare type PublishViewRule<S extends AnyObject = AnyObject> = {
+    select?: SelectRule<S> | PublishAllOrNothing;
+    getColumns?: PublishAllOrNothing;
+    getInfo?: PublishAllOrNothing;
+};
+export declare type PublishTableRule<S extends AnyObject = AnyObject> = PublishViewRule<S> & {
+    insert?: InsertRule<S> | PublishAllOrNothing;
+    update?: UpdateRule<S> | PublishAllOrNothing;
+    delete?: DeleteRule<S> | PublishAllOrNothing;
+    sync?: SyncRule<S>;
+    subscribe?: SubscribeRule | PublishAllOrNothing;
+};
+export declare type ParsedPublishTable = {
+    select?: SelectRule;
+    getColumns?: true;
+    getInfo?: true;
+    insert?: InsertRule;
+    update?: UpdateRule;
+    delete?: DeleteRule;
+    sync?: SyncRule;
+    subscribe?: SubscribeRule;
+    subscribeOne?: SubscribeRule;
+};
+export declare type PublishParams<S = void> = {
+    sid?: string;
+    dbo: DBOFullyTyped<S>;
+    db?: DB;
+    user?: AnyObject;
+    socket: PRGLIOSocket;
+};
+export declare type RequestParams = {
+    dbo?: DBHandlerServer;
+    socket?: any;
+};
+export declare type PublishAllOrNothing = true | "*" | false | null;
+declare type PublishObject = {
+    [table_name: string]: (PublishTableRule | PublishViewRule | PublishAllOrNothing);
+};
+export declare type ParsedPublishTables = {
+    [table_name: string]: ParsedPublishTable;
+};
+export declare type PublishedResult<Schema = void> = PublishAllOrNothing | PublishFullyTyped<Schema>;
+export declare type Publish<Schema = void> = PublishedResult<Schema> | ((params: PublishParams<Schema>) => Awaitable<PublishedResult<Schema>>);
+export declare class PublishParser {
+    publish: any;
+    publishMethods?: any;
+    publishRawSQL?: any;
+    dbo: DBHandlerServer;
+    db: DB;
+    prostgles: Prostgles;
+    constructor(publish: any, publishMethods: any, publishRawSQL: any, dbo: DBHandlerServer, db: DB, prostgles: Prostgles);
+    getPublishParams(localParams: LocalParams, clientInfo?: ClientInfo): Promise<PublishParams<any>>;
+    getMethods(socket: any): Promise<{}>;
+    /**
+     * Parses the first level of publish. (If false then nothing if * then all tables and views)
+     * @param socket
+     * @param user
+     */
+    getPublish(localParams: LocalParams, clientInfo?: ClientInfo): Promise<PublishObject>;
+    getValidatedRequestRuleWusr({ tableName, command, localParams }: DboTableCommand): Promise<TableRule>;
+    getValidatedRequestRule({ tableName, command, localParams }: DboTableCommand, clientInfo?: ClientInfo): Promise<TableRule>;
+    getTableRules({ tableName, localParams }: DboTable, clientInfo?: ClientInfo): Promise<ParsedPublishTable | undefined>;
+    getSchemaFromPublish(socket: any): Promise<{
+        schema: TableSchemaForClient;
+        tables: DBSchemaTable[];
+    }>;
+}
+export {};
+//# sourceMappingURL=PublishParser.d.ts.map

package/lib/PublishParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublishParser.d.ts","sourceRoot":"","sources":["PublishParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,SAAS,EAAO,oBAAoB,EAAE,aAAa,EAAwB,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC/I,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAyB,WAAW,EAAE,YAAY,EAA6B,MAAM,cAAc,CAAC;AAC7H,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAiB,MAAM,aAAa,CAAC;AAC5E,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,oBAAY,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAE,CAAC;AAC9D,oBAAY,cAAc,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK;IAAE,CAAC,GAAG,EAAC,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC;IAAE,CAAC,GAAG,EAAC,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC,CAAC;AAElI,oBAAY,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE1C,aAAK,OAAO,GAAG;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,OAAO,CAAC,EAAE,GAAG,CAAC;CACf,CAAA;AAED,aAAK,QAAQ,GAAG,OAAO,GAAG;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAA;AACD,aAAK,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAA;AA6ED,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAG5D,oBAAY,iBAAiB,GAAG;IAC5B,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,SAAS,EAAE,WAAW,CAAC;CAC1B,CAAA;AACD,oBAAY,iBAAiB,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;CACxB,CAAA;AACD,oBAAY,iBAAiB,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,WAAW,CAAC;CAC1B,CAAA;AACD,oBAAY,oBAAoB,CAAC,CAAC,IAAI;IACpC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IACrB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACjB,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC3B,CAAA;AACD,oBAAY,SAAS,CAAC,CAAC,IAAI;IACzB,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IACrB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CAClB,CAAA;AACD,oBAAY,sBAAsB,CAAC,CAAC,IAAI;IACpC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;CACxB,CAAA;AACD,oBAAY,iBAAiB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,oBAAoB,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;AAErH,oBAAY,WAAW,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AACtF,oBAAY,iBAAiB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,CAAC,IAAI,EAAE;IAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAAE,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAGzI,oBAAY,UAAU,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,IAAI;IAEzD;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAEhC;;SAEK;IACL,YAAY,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAEtF,CAAA;AACD,oBAAY,UAAU,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,IAAI;IAEzD;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,CAAA;CAC7C,CAAA;AACD,oBAAY,UAAU,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,IAAI;IAEzD;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;IAElC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE;QACd,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAA;QACxC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;KACnC,EAAE,CAAC;IAEJ;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAA;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAA;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;CAEtC,CAAC;AAEF,oBAAY,UAAU,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,IAAI;IAEzD;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAA;IAE/C;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAA;IAE/C;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAA;IAElD;;OAEG;IACH,QAAQ,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;CACtD,CAAA;AACD,oBAAY,QAAQ,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,IAAI;IAEvD;;OAEG;IACH,SAAS,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,EAAE,MAAM,IAAI,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAA;AACD,oBAAY,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,oBAAY,QAAQ,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,GAAG;IACvD;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AACF,oBAAY,SAAS,CAAC,CAAC,GAAG,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG;IACnD,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACvB,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IACnB,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B,CAAC;AACF,oBAAY,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IAC7D,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAA;IAC5C,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B,CAAC;AACF,oBAAY,gBAAgB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG;IACnF,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAA;IAC5C,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAA;IAC5C,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAA;IAC5C,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IACnB,SAAS,CAAC,EAAE,aAAa,GAAG,mBAAmB,CAAC;CACjD,CAAC;AAGF,oBAAY,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,YAAY,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAA;AAKD,oBAAY,aAAa,CAAC,CAAC,GAAG,IAAI,IAAI;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACtB,EAAE,CAAC,EAAE,EAAE,CAAC;IACR,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,YAAY,CAAA;CACrB,CAAA;AACD,oBAAY,aAAa,GAAG;IAAE,GAAG,CAAC,EAAE,eAAe,CAAC;IAAC,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC;AACpE,oBAAY,mBAAmB,GAAG,IAAI,GAAG,GAAG,GAAG,KAAK,GAAG,IAAI,CAAC;AAC5D,aAAK,aAAa,GAAG;IACnB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,gBAAgB,GAAG,eAAe,GAAG,mBAAmB,CAAE,CAAA;CAClF,CAAC;AACF,oBAAY,mBAAmB,GAAG;IAChC,CAAC,UAAU,EAAE,MAAM,GAAG,kBAAkB,CAAA;CACzC,CAAC;AACF,oBAAY,eAAe,CAAC,MAAM,GAAG,IAAI,IAAI,mBAAmB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAE;AAC9F,oBAAY,OAAO,CAAC,MAAM,GAAG,IAAI,IAAI,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEvI,qBAAa,aAAa;IACxB,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,GAAG,EAAE,eAAe,CAAC;IACrB,EAAE,EAAE,EAAE,CAAA;IACN,SAAS,EAAE,SAAS,CAAC;gBAET,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,SAAS;IAW/G,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAUhG,UAAU,CAAC,MAAM,EAAE,GAAG;IAoB5B;;;;OAIG;IACG,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAcrF,2BAA2B,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC;IAKrG,uBAAuB,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAyC1H,aAAa,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAqJrH,oBAAoB,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC;QAAC,MAAM,EAAE,oBAAoB,CAAC;QAAC,MAAM,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;CAoG3G"}

package/lib/PublishParser.js

@@ -0,0 +1,390 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublishParser = void 0;
+const prostgles_types_1 = require("prostgles-types");
+const DboBuilder_1 = require("./DboBuilder");
+const Prostgles_1 = require("./Prostgles");
+const RULE_TO_METHODS = [
+    {
+        rule: "getColumns",
+        sqlRule: "select",
+        methods: prostgles_types_1.RULE_METHODS.getColumns,
+        no_limits: true,
+        allowed_params: [],
+        table_only: false,
+        hint: ` expecting false | true | undefined`
+    },
+    {
+        rule: "getInfo",
+        sqlRule: "select",
+        methods: prostgles_types_1.RULE_METHODS.getInfo,
+        no_limits: true,
+        allowed_params: [],
+        table_only: false,
+        hint: ` expecting false | true | undefined`
+    },
+    {
+        rule: "insert",
+        sqlRule: "insert",
+        methods: prostgles_types_1.RULE_METHODS.insert,
+        no_limits: { fields: "*" },
+        table_only: true,
+        allowed_params: ["fields", "forcedData", "returningFields", "validate", "preValidate"],
+        hint: ` expecting "*" | true | { fields: string | string[] | {}  }`
+    },
+    {
+        rule: "update",
+        sqlRule: "update",
+        methods: prostgles_types_1.RULE_METHODS.update,
+        no_limits: { fields: "*", filterFields: "*", returningFields: "*" },
+        table_only: true,
+        allowed_params: ["fields", "filterFields", "forcedFilter", "forcedData", "returningFields", "validate", "dynamicFields"],
+        hint: ` expecting "*" | true | { fields: string | string[] | {}  }`
+    },
+    {
+        rule: "select",
+        sqlRule: "select",
+        methods: prostgles_types_1.RULE_METHODS.select,
+        no_limits: { fields: "*", filterFields: "*" },
+        table_only: false,
+        allowed_params: ["fields", "filterFields", "forcedFilter", "validate", "maxLimit"],
+        hint: ` expecting "*" | true | { fields: ( string | string[] | {} )  }`
+    },
+    {
+        rule: "delete",
+        sqlRule: "delete",
+        methods: prostgles_types_1.RULE_METHODS.delete,
+        no_limits: { filterFields: "*" },
+        table_only: true,
+        allowed_params: ["filterFields", "forcedFilter", "returningFields", "validate"],
+        hint: ` expecting "*" | true | { filterFields: ( string | string[] | {} ) } \n Will use "select", "update", "delete" and "insert" rules`
+    },
+    {
+        rule: "sync",
+        sqlRule: "select",
+        methods: prostgles_types_1.RULE_METHODS.sync,
+        no_limits: null,
+        table_only: true,
+        allowed_params: ["id_fields", "synced_field", "sync_type", "allow_delete", "throttle", "batch_size"],
+        hint: ` expecting "*" | true | { id_fields: string[], synced_field: string }`
+    },
+    {
+        rule: "subscribe",
+        sqlRule: "select",
+        methods: prostgles_types_1.RULE_METHODS.subscribe,
+        no_limits: { throttle: 0 },
+        table_only: true,
+        allowed_params: ["throttle"],
+        hint: ` expecting "*" | true | { throttle: number } \n Will use "select" rules`
+    }
+];
+const PubSubManager_1 = require("./PubSubManager");
+class PublishParser {
+    constructor(publish, publishMethods, publishRawSQL, dbo, db, prostgles) {
+        this.publish = publish;
+        this.publishMethods = publishMethods;
+        this.publishRawSQL = publishRawSQL;
+        this.dbo = dbo;
+        this.db = db;
+        this.prostgles = prostgles;
+        if (!this.dbo || !this.publish)
+            throw "INTERNAL ERROR: dbo and/or publish missing";
+    }
+    async getPublishParams(localParams, clientInfo) {
+        if (!this.dbo)
+            throw "dbo missing";
+        return {
+            ...(clientInfo || await this.prostgles.authHandler?.getClientInfo(localParams)),
+            dbo: this.dbo,
+            db: this.db,
+            socket: localParams.socket
+        };
+    }
+    async getMethods(socket) {
+        let methods = {};
+        const publishParams = await this.getPublishParams({ socket });
+        const _methods = await applyParamsIfFunc(this.publishMethods, publishParams);
+        if (_methods && Object.keys(_methods).length) {
+            (0, prostgles_types_1.getKeys)(_methods).map(key => {
+                if (_methods[key] && (typeof _methods[key] === "function" || typeof _methods[key].then === "function")) {
+                    //@ts-ignore
+                    methods[key] = _methods[key];
+                }
+                else {
+                    throw `invalid publishMethods item -> ${key} \n Expecting a function or promise`;
+                }
+            });
+        }
+        return methods;
+    }
+    /**
+     * Parses the first level of publish. (If false then nothing if * then all tables and views)
+     * @param socket
+     * @param user
+     */
+    async getPublish(localParams, clientInfo) {
+        const publishParams = await this.getPublishParams(localParams, clientInfo);
+        let _publish = await applyParamsIfFunc(this.publish, publishParams);
+        if (_publish === "*") {
+            let publish = {};
+            this.prostgles.dboBuilder.tablesOrViews?.map(tov => {
+                publish[tov.name] = "*";
+            });
+            return publish;
+        }
+        return _publish;
+    }
+    async getValidatedRequestRuleWusr({ tableName, command, localParams }) {
+        const clientInfo = await this.prostgles.authHandler.getClientInfo(localParams);
+        return await this.getValidatedRequestRule({ tableName, command, localParams }, clientInfo);
+    }
+    async getValidatedRequestRule({ tableName, command, localParams }, clientInfo) {
+        if (!this.dbo)
+            throw "INTERNAL ERROR: dbo is missing";
+        if (!command || !tableName)
+            throw "command OR tableName are missing";
+        let rtm = RULE_TO_METHODS.find(rtms => rtms.methods.includes(command));
+        if (!rtm) {
+            throw "Invalid command: " + command;
+        }
+        /* Must be local request -> allow everything */
+        if (!localParams || (!localParams.socket && !localParams.httpReq)) {
+            return RULE_TO_METHODS.reduce((a, v) => ({
+                ...a,
+                [v.rule]: v.no_limits
+            }), {});
+        }
+        /* Must be from socket. Must have a publish */
+        if (!this.publish)
+            throw "publish is missing";
+        /* Get any publish errors for socket */
+        const schm = localParams?.socket?.prostgles?.schema?.[tableName]?.[command];
+        if (schm && schm.err)
+            throw schm.err;
+        let table_rule = await this.getTableRules({ tableName, localParams }, clientInfo);
+        if (!table_rule)
+            throw "Invalid or disallowed table: " + tableName;
+        if (command === "upsert") {
+            if (!table_rule.update || !table_rule.insert) {
+                throw `Invalid or disallowed command: upsert`;
+            }
+        }
+        if (rtm && table_rule && table_rule[rtm.rule]) {
+            return table_rule;
+        }
+        else
+            throw `Invalid or disallowed command: ${tableName}.${command}`;
+    }
+    async getTableRules({ tableName, localParams }, clientInfo) {
+        try {
+            if (!localParams || !tableName)
+                throw "publish OR socket OR dbo OR tableName are missing";
+            let _publish = await this.getPublish(localParams, clientInfo);
+            const raw_table_rules = _publish[tableName]; // applyParamsIfFunc(_publish[tableName],  localParams, this.dbo, this.db, user);
+            if (!raw_table_rules)
+                return undefined;
+            let parsed_table = {};
+            /* Get view or table specific rules */
+            const tHandler = this.dbo[tableName];
+            if (!tHandler)
+                throw `${tableName} could not be found in dbo`;
+            const is_view = tHandler.is_view;
+            const MY_RULES = RULE_TO_METHODS.filter(r => {
+                /** Check PG User privileges */
+                const pgUserIsAllowedThis = tHandler.tableOrViewInfo.privileges[r.sqlRule];
+                const result = (!is_view || !r.table_only) && pgUserIsAllowedThis;
+                if (!pgUserIsAllowedThis && (0, DboBuilder_1.isPlainObject)(raw_table_rules) && raw_table_rules[r.sqlRule]) {
+                    throw `Your postgres user is not allowed ${r.sqlRule} on table ${tableName}`;
+                }
+                return result;
+            });
+            /* All methods allowed. Add no limits for table rules */
+            if ([true, "*"].includes(raw_table_rules)) {
+                parsed_table = {};
+                MY_RULES.map(r => {
+                    parsed_table[r.rule] = { ...r.no_limits };
+                });
+                /** Specific rules allowed */
+            }
+            else if ((0, DboBuilder_1.isPlainObject)(raw_table_rules) && (0, prostgles_types_1.getKeys)(raw_table_rules).length) {
+                const allRuleKeys = (0, prostgles_types_1.getKeys)(raw_table_rules);
+                const dissallowedRuleKeys = allRuleKeys.filter(m => !raw_table_rules[m]);
+                MY_RULES.map(r => {
+                    /** Unless specifically disabled these are allowed */
+                    if (["getInfo", "getColumns"].includes(r.rule) && !dissallowedRuleKeys.includes(r.rule)) {
+                        parsed_table[r.rule] = r.no_limits;
+                        return;
+                    }
+                    /** Add no_limit values for implied/ fully allowed methods */
+                    if ([true, "*"].includes(raw_table_rules[r.rule]) && r.no_limits) {
+                        parsed_table[r.rule] = Object.assign({}, r.no_limits);
+                        /** Carry over detailed config */
+                    }
+                    else if ((0, DboBuilder_1.isPlainObject)(raw_table_rules[r.rule])) {
+                        parsed_table[r.rule] = raw_table_rules[r.rule];
+                    }
+                });
+                allRuleKeys.filter(m => parsed_table[m])
+                    .find((method) => {
+                    let rm = MY_RULES.find(r => r.rule === method || r.methods.includes(method));
+                    if (!rm) {
+                        let extraInfo = "";
+                        if (is_view && RULE_TO_METHODS.find(r => !is_view && r.rule === method || r.methods.includes(method))) {
+                            extraInfo = "You've specified table rules to a view\n";
+                        }
+                        throw `Invalid rule in publish.${tableName} -> ${method} \n${extraInfo}Expecting any of: ${MY_RULES.flatMap(r => [r.rule, ...r.methods]).join(", ")}`;
+                    }
+                    /* Check RULES for invalid params */
+                    /* Methods do not have params -> They use them from rules */
+                    if (method === rm.rule) {
+                        let method_params = (0, prostgles_types_1.getKeys)(parsed_table[method]);
+                        let iparam = method_params.find(p => !rm?.allowed_params.includes(p));
+                        if (iparam) {
+                            throw `Invalid setting in publish.${tableName}.${method} -> ${iparam}. \n Expecting any of: ${rm.allowed_params.join(", ")}`;
+                        }
+                    }
+                    /* Add default params (if missing) */
+                    if (method === "sync") {
+                        if ([true, "*"].includes(parsed_table[method])) {
+                            throw "Invalid sync rule. Expecting { id_fields: string[], synced_field: string } ";
+                        }
+                        if (typeof parsed_table[method]?.throttle !== "number") {
+                            parsed_table[method].throttle = 100;
+                        }
+                        if (typeof parsed_table[method]?.batch_size !== "number") {
+                            parsed_table[method].batch_size = PubSubManager_1.DEFAULT_SYNC_BATCH_SIZE;
+                        }
+                    }
+                    /* Enable subscribe if not explicitly disabled */
+                    const subKey = "subscribe";
+                    if (method === "select" && !dissallowedRuleKeys.includes(subKey)) {
+                        const sr = MY_RULES.find(r => r.rule === subKey);
+                        if (sr) {
+                            parsed_table[subKey] = { ...sr.no_limits };
+                            parsed_table.subscribeOne = { ...sr.no_limits };
+                        }
+                    }
+                });
+            }
+            else {
+                throw "Unexpected publish";
+            }
+            const getImpliedMethods = (tableRules) => {
+                let res = { ...tableRules };
+                /* Add implied methods if not specifically dissallowed */
+                MY_RULES.map(r => {
+                    /** THIS IS A MESS -> some methods cannot be dissallowed (unsync, unsubscribe...) */
+                    r.methods.forEach(method => {
+                        var _a;
+                        const isAllowed = tableRules[r.rule] && tableRules[method] === undefined;
+                        if (isAllowed) {
+                            if (method === "updateBatch" && !tableRules.update) {
+                            }
+                            else if (method === "upsert" && (!tableRules.update || !tableRules.insert)) {
+                            }
+                            else {
+                                (_a = res)[method] ?? (_a[method] = true);
+                            }
+                        }
+                    });
+                });
+                return res;
+            };
+            parsed_table = getImpliedMethods(parsed_table);
+            return parsed_table;
+        }
+        catch (e) {
+            throw e;
+        }
+    }
+    /* Prepares schema for client. Only allowed views and commands will be present */
+    async getSchemaFromPublish(socket) {
+        let schema = {};
+        let tables = [];
+        try {
+            /* Publish tables and views based on socket */
+            const clientInfo = await this.prostgles.authHandler?.getClientInfo({ socket });
+            let _publish = await this.getPublish(socket, clientInfo);
+            if (_publish && Object.keys(_publish).length) {
+                let txKey = "tx";
+                if (!this.prostgles.opts.transactions)
+                    txKey = "";
+                if (typeof this.prostgles.opts.transactions === "string")
+                    txKey = this.prostgles.opts.transactions;
+                const tableNames = Object.keys(_publish).filter(k => !txKey || txKey !== k);
+                await Promise.all(tableNames
+                    .map(async (tableName) => {
+                    if (!this.dbo[tableName]) {
+                        throw `Table ${tableName} does not exist
+                          Expecting one of: ${this.prostgles.dboBuilder.tablesOrViews?.map(tov => tov.name).join(", ")}
+                          DBO tables: ${Object.keys(this.dbo).filter(k => this.dbo[k].find).join(", ")}
+                          `;
+                    }
+                    const table_rules = await this.getTableRules({ localParams: { socket }, tableName }, clientInfo);
+                    if (table_rules && Object.keys(table_rules).length) {
+                        schema[tableName] = {};
+                        let methods = [];
+                        let tableInfo;
+                        let tableColumns;
+                        if (typeof table_rules === "object") {
+                            methods = (0, prostgles_types_1.getKeys)(table_rules);
+                        }
+                        await Promise.all(methods.filter(m => m !== "select").map(async (method) => {
+                            if (method === "sync" && table_rules[method]) {
+                                /* Pass sync info */
+                                schema[tableName][method] = table_rules[method];
+                            }
+                            else if (table_rules[method]) {
+                                schema[tableName][method] = {};
+                                /* Test for issues with the common table CRUD methods () */
+                                if (Prostgles_1.TABLE_METHODS.includes(method)) {
+                                    let err = null;
+                                    try {
+                                        let valid_table_command_rules = await this.getValidatedRequestRule({ tableName, command: method, localParams: { socket } }, clientInfo);
+                                        await this.dbo[tableName][method]({}, {}, {}, valid_table_command_rules, { socket, has_rules: true, testRule: true });
+                                    }
+                                    catch (e) {
+                                        err = "INTERNAL PUBLISH ERROR";
+                                        schema[tableName][method] = { err };
+                                        throw `publish.${tableName}.${method}: \n   -> ${e}`;
+                                    }
+                                }
+                                if (method === "getInfo" || method === "getColumns") {
+                                    let tableRules = await this.getValidatedRequestRule({ tableName, command: method, localParams: { socket } }, clientInfo);
+                                    const res = await this.dbo[tableName][method](undefined, undefined, undefined, tableRules, { socket, has_rules: true });
+                                    if (method === "getInfo") {
+                                        tableInfo = res;
+                                    }
+                                    else if (method === "getColumns") {
+                                        tableColumns = res;
+                                    }
+                                }
+                            }
+                        }));
+                        if (tableInfo && tableColumns) {
+                            tables.push({
+                                name: tableName,
+                                info: tableInfo,
+                                columns: tableColumns
+                            });
+                        }
+                    }
+                    return true;
+                }));
+            }
+        }
+        catch (e) {
+            console.error("Prostgles \nERRORS IN PUBLISH: ", JSON.stringify(e));
+            throw e;
+        }
+        return { schema, tables };
+    }
+}
+exports.PublishParser = PublishParser;
+function applyParamsIfFunc(maybeFunc, ...params) {
+    if ((maybeFunc !== null && maybeFunc !== undefined) &&
+        (typeof maybeFunc === "function" || typeof maybeFunc.then === "function")) {
+        return maybeFunc(...params);
+    }
+    return maybeFunc;
+}