prostgles-server 2.0.178 → 2.0.181

package/lib/PublishParser.ts

@@ -1,10 +1,10 @@
-import { getKeys, RULE_METHODS, AnyObject, get, TableSchemaForClient, DBSchemaTable, MethodKey, TableInfo, FullFilter, DBSchemaColumns, DBSchema, DBTableSchema } from "prostgles-types";
+import { getKeys, RULE_METHODS, AnyObject, get, TableSchemaForClient, DBSchemaTable, MethodKey, TableInfo, FullFilter } from "prostgles-types";
 import { ClientInfo } from "./AuthHandler";
 import { CommonTableRules, Filter, isPlainObject, LocalParams, PRGLIOSocket, TableHandler, ViewHandler } from "./DboBuilder";
 import { Prostgles, DBHandlerServer, DB, TABLE_METHODS } from "./Prostgles";
 import type { DBOFullyTyped, PublishFullyTyped } from "./DBSchemaBuilder";
 export type Method = (...args: any) => ( any | Promise<any> );
-export type PublishMethods<S extends DBSchema | undefined = undefined> = (params: PublishParams<S>) => { [key:string]: Method } | Promise<{ [key:string]: Method }>;
+export type PublishMethods<S = void> = (params: PublishParams<S>) => { [key:string]: Method } | Promise<{ [key:string]: Method }>;
 
 export type Awaitable<T> = T | Promise<T>;
 
@@ -129,12 +129,13 @@ export type UpdateRequestData<R extends AnyObject = AnyObject> = UpdateRequestDa
 export type ValidateRow<R extends AnyObject = AnyObject> = (row: R) => R | Promise<R>;
 export type ValidateUpdateRow<R extends AnyObject = AnyObject> = (args: { update: Partial<R>, filter: FullFilter<R> }) => R | Promise<R>;
 
-export type SelectRule<S extends DBTableSchema | undefined = undefined> = {
+
+export type SelectRule<Cols extends AnyObject = AnyObject> = {
 
     /**
      * Fields allowed to be selected.   Tip: Use false to exclude field
      */
-    fields: FieldFilter<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    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
@@ -144,12 +145,12 @@ export type SelectRule<S extends DBTableSchema | undefined = undefined> = {
     /**
      * Filter added to every query (e.g. user_id) to restrict access
      */
-    forcedFilter?: FullFilter<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    forcedFilter?: FullFilter<Cols>;
 
     /**
      * Fields user can filter by 
      * */
-    filterFields?: FieldFilter<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    filterFields?: FieldFilter<Cols>;
 
     /**
      * Validation logic to check/update data for each request
@@ -157,39 +158,39 @@ export type SelectRule<S extends DBTableSchema | undefined = undefined> = {
     validate?(args: SelectRequestData): SelectRequestData | Promise<SelectRequestData>;
 
 }
-export type InsertRule<S extends DBTableSchema | undefined = undefined> = {
+export type InsertRule<Cols extends AnyObject = AnyObject> = {
 
     /**
      * Fields allowed to be inserted.   Tip: Use false to exclude field
      */
-    fields: SelectRule<S>["fields"]
+    fields: SelectRule<Cols>["fields"]
 
     /**
      * Data to include/overwrite on each insert
      */
-    forcedData?: Partial<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    forcedData?: Partial<Cols>;
 
     /**
      * Fields user can view after inserting
      */
-    returningFields?: SelectRule<S>["fields"]
+    returningFields?: SelectRule<Cols>["fields"]
 
     /**
      * Validation logic to check/update data for each request. Happens before publish rule checks (for fields, forcedData/forcedFilter)
      */
-    preValidate?: ValidateRow<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    preValidate?: ValidateRow<Cols>;
 
     /**
      * Validation logic to check/update data for each request. Happens after publish rule checks (for fields, forcedData/forcedFilter)
      */
-    validate?: InsertRule<S>["preValidate"]
+    validate?: InsertRule<Cols>["preValidate"]
 }
-export type UpdateRule<S extends DBTableSchema | undefined = undefined> = {
+export type UpdateRule<Cols extends AnyObject = AnyObject> = {
 
     /**
      * Fields allowed to be updated.   Tip: Use false/0 to exclude field
      */
-    fields: SelectRule<S>["fields"]
+    fields: SelectRule<Cols>["fields"]
     
     /**
      * Row level FGAC
@@ -199,71 +200,71 @@ export type UpdateRule<S extends DBTableSchema | undefined = undefined> = {
      * Specify in decreasing order of specificity otherwise a more general filter will match first
      */
     dynamicFields?: {
-      filter: SelectRule<S>["forcedFilter"]
-      fields: SelectRule<S>["fields"]
+      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<S>["forcedFilter"]
+    forcedFilter?: SelectRule<Cols>["forcedFilter"]
 
     /**
      * Data to include/overwrite on each updatDBe
      */
-    forcedData?: InsertRule<S>["forcedData"]
+    forcedData?: InsertRule<Cols>["forcedData"]
 
     /**
      * Fields user can use to find the updates
      */
-    filterFields?: SelectRule<S>["fields"]
+    filterFields?: SelectRule<Cols>["fields"]
 
     /**
      * Fields user can view after updating
      */
-    returningFields?: SelectRule<S>["fields"]
+    returningFields?: SelectRule<Cols>["fields"]
 
     /**
      * Validation logic to check/update data for each request
      */
-    validate?: ValidateUpdateRow<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    validate?: ValidateUpdateRow<Cols>;
 
 };
 
-export type DeleteRule<S extends DBTableSchema | undefined = undefined> = {
+export type DeleteRule<Cols extends AnyObject = AnyObject> = {
     
     /**
      * Filter added to every query (e.g. user_id) to restrict access
      */
-    forcedFilter?: FullFilter<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    forcedFilter?: SelectRule<Cols>["forcedFilter"]
 
     /**
      * Fields user can filter by
      */
-    filterFields?: FieldFilter<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    filterFields: FieldFilter<Cols>;
 
     /**
      * Fields user can view after deleting
      */
-    returningFields?: FieldFilter<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    returningFields?: SelectRule<Cols>["filterFields"]
 
     /**
      * Validation logic to check/update data for each request
      */
-    validate?(...args: any[]): UpdateRequestData<S extends DBTableSchema? DBSchemaColumns<S["columns"]> : AnyObject>;
+    validate?(...args: any[]): Awaitable<void>;// UpdateRequestData<Cols>;
 }
-export type SyncRule<S extends DBTableSchema | undefined = undefined> = {
+export type SyncRule<Cols extends AnyObject = AnyObject> = {
     
     /**
      * Primary keys used in updating data
      */
-    id_fields: S extends DBTableSchema? (keyof S["dataTypes"])[] : string[];
+    id_fields: (keyof Cols)[];
     
     /**
      * Numerical incrementing fieldname (last updated timestamp) used to sync items
      */
-    synced_field:  S extends DBTableSchema? (keyof S["dataTypes"]) : string;
+    synced_field: keyof Cols;
 
     /**
      * EXPERIMENTAL. Disabled by default. If true then server will attempt to delete any records missing from client.
@@ -284,25 +285,25 @@ export type SubscribeRule = {
   throttle?: number;
 }
 
-export type ViewRule<S extends DBTableSchema | undefined = undefined> = CommonTableRules & {
+export type ViewRule<S = AnyObject> = CommonTableRules & {
   /**
    * What can be read from the table
    */
   select?: SelectRule<S>;
 };
-export type TableRule<S extends DBTableSchema | undefined = undefined> = ViewRule<S> & {
+export type TableRule<S = AnyObject> = ViewRule<S> & {
   insert?: InsertRule<S>;
   update?: UpdateRule<S>;
   delete?: DeleteRule<S>;
   sync?: SyncRule<S>;
   subscribe?: SubscribeRule;
 };
-export type PublishViewRule<S extends DBTableSchema | undefined = undefined> = {
+export type PublishViewRule<S extends AnyObject = AnyObject> = {
   select?: SelectRule<S> | PublishAllOrNothing
   getColumns?: PublishAllOrNothing;
   getInfo?: PublishAllOrNothing;
 };
-export type PublishTableRule<S extends DBTableSchema | undefined = undefined> = PublishViewRule<S> & {
+export type PublishTableRule<S extends AnyObject = AnyObject> = PublishViewRule<S> & {
   insert?: InsertRule<S> | PublishAllOrNothing
   update?: UpdateRule<S> | PublishAllOrNothing
   delete?: DeleteRule<S> | PublishAllOrNothing
@@ -327,7 +328,7 @@ export type ParsedPublishTable = {
 // export type Publish = {
 //     tablesOrViews: {[key:string]: TableRule | ViewRule | "*" }
 // }
-export type PublishParams<S extends DBSchema | undefined = undefined> = {
+export type PublishParams<S = void> = {
   sid?: string;
   dbo: DBOFullyTyped<S>;
   db?: DB;
@@ -336,14 +337,14 @@ export type PublishParams<S extends DBSchema | undefined = undefined> = {
 }
 export type RequestParams = { dbo?: DBHandlerServer, socket?: any };
 export type PublishAllOrNothing = true | "*" | false | null;
-export type PublishObject<Schema extends DBSchema | undefined = undefined> = { 
-    [table_name: string]: (PublishTableRule | PublishViewRule | PublishAllOrNothing ) 
+type PublishObject = { 
+  [table_name: string]: (PublishTableRule | PublishViewRule | PublishAllOrNothing ) 
 };
 export type ParsedPublishTables = { 
   [table_name: string]: ParsedPublishTable
 };
-export type PublishedResult<Schema extends DBSchema | undefined = undefined> = PublishAllOrNothing | PublishFullyTyped<Schema> ;
-export type Publish<Schema extends DBSchema | undefined = undefined> = PublishedResult<Schema> | ((params: PublishParams<Schema>) => Awaitable<PublishedResult<Schema>>);
+export type PublishedResult<Schema = void> = PublishAllOrNothing | PublishFullyTyped<Schema> ;
+export type Publish<Schema = void> = PublishedResult<Schema> | ((params: PublishParams<Schema>) => Awaitable<PublishedResult<Schema>>);
 
 export class PublishParser {
   publish: any;

package/lib/QueryBuilder.d.ts

@@ -0,0 +1,124 @@
+import { Filter, LocalParams, TableHandler } from "./DboBuilder";
+import { TableRule } from "./PublishParser";
+import { SelectParams, ColumnInfo, PG_COLUMN_UDT_DATA_TYPE, Select } from "prostgles-types";
+export declare type SelectItem = {
+    type: "column" | "function" | "aggregation" | "joinedColumn" | "computed";
+    getFields: (args?: any[]) => string[] | "*";
+    getQuery: (tableAlias?: string) => string;
+    columnPGDataType?: string;
+    column_udt_type?: PG_COLUMN_UDT_DATA_TYPE;
+    alias: string;
+    selected: boolean;
+};
+export declare type NewQuery = {
+    allFields: string[];
+    /**
+     * Contains user selection and all the allowed columns. Allowed columns not selected are marked with  selected: false
+     */
+    select: SelectItem[];
+    table: string;
+    where: string;
+    orderBy: string[];
+    having: string;
+    limit: number;
+    offset: number;
+    isLeftJoin: boolean;
+    joins?: NewQuery[];
+    tableAlias?: string;
+    $path?: string[];
+};
+export declare const asNameAlias: (field: string, tableAlias?: string) => string;
+export declare const parseFunctionObject: (funcData: any) => {
+    funcName: string;
+    args: any[];
+};
+export declare const parseFunction: (funcData: {
+    func: string | FunctionSpec;
+    args: any[];
+    functions: FunctionSpec[];
+    allowedFields: string[];
+}) => FunctionSpec;
+declare type GetQueryArgs = {
+    allColumns: ColumnInfo[];
+    allowedFields: string[];
+    args: any[];
+    tableAlias?: string;
+    ctidField?: string;
+};
+export declare type FieldSpec = {
+    name: string;
+    type: "column" | "computed";
+    /**
+     * allowedFields passed for multicol functions (e.g.: $rowhash)
+     */
+    getQuery: (params: Omit<GetQueryArgs, "args">) => string;
+};
+export declare type FunctionSpec = {
+    name: string;
+    description?: string;
+    /**
+     * If true then it can be used in filters and is expected to return boolean
+     */
+    canBeUsedForFilter?: boolean;
+    /**
+     * If true then the first argument is expected to be a column name
+     */
+    singleColArg: boolean;
+    /**
+     * If true then this func can be used within where clause
+     */
+    /**
+     * Number of arguments expected
+     */
+    numArgs: number;
+    /**
+     * If provided then the number of column names provided to the function (from getFields()) must not be less than this
+     * By default every function is checked against numArgs
+     */
+    minCols?: number;
+    type: "function" | "aggregation" | "computed";
+    /**
+     * getFields: string[] -> used to validate user supplied field names. It will be fired before querying to validate against allowed columns
+     *      if not field names are used from arguments then return an empty array
+     */
+    getFields: (args: any[]) => "*" | string[];
+    /**
+     * allowedFields passed for multicol functions (e.g.: $rowhash)
+     */
+    getQuery: (params: GetQueryArgs) => string;
+    returnType?: PG_COLUMN_UDT_DATA_TYPE;
+};
+/**
+* Each function expects a column at the very least
+*/
+export declare const FUNCTIONS: FunctionSpec[];
+export declare const COMPUTED_FIELDS: FieldSpec[];
+export declare class SelectItemBuilder {
+    select: SelectItem[];
+    private allFields;
+    private allowedFields;
+    private computedFields;
+    private functions;
+    private allowedFieldsIncludingComputed;
+    private isView;
+    private columns;
+    constructor(params: {
+        allowedFields: string[];
+        computedFields: FieldSpec[];
+        functions: FunctionSpec[];
+        allFields: string[];
+        isView: boolean;
+        columns: ColumnInfo[];
+    });
+    private checkField;
+    private addItem;
+    private addFunction;
+    addColumn: (fieldName: string, selected: boolean) => void;
+    parseUserSelect: (userSelect: Select, joinParse?: (key: string, val: any, throwErr: (msg: string) => any) => any) => Promise<any[]>;
+}
+export declare function getNewQuery(_this: TableHandler, filter: Filter, selectParams: (SelectParams & {
+    alias?: string;
+}), param3_unused: any, tableRules: TableRule | undefined, localParams: LocalParams | undefined, columns: ColumnInfo[]): Promise<NewQuery>;
+export declare function makeQuery(_this: TableHandler, q: NewQuery, depth?: number, joinFields?: string[], selectParams?: SelectParams): string;
+export {};
+//# sourceMappingURL=QueryBuilder.d.ts.map

package/lib/QueryBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilder.d.ts","sourceRoot":"","sources":["QueryBuilder.ts"],"names":[],"mappings":"AAMA,OAAO,EAAO,MAAM,EAAE,WAAW,EAAiB,YAAY,EAAiC,MAAM,cAAc,CAAC;AACpH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAqE,UAAU,EAAE,uBAAuB,EAAY,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAIzK,oBAAY,UAAU,GAAG;IACvB,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,CAAC;IAC1E,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,GAAG,CAAC;IAC5C,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC1C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,uBAAuB,CAAC;IAE1C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,UAAU,EAAE,CAAC;IAErB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,WAAW,UAAW,MAAM,eAAe,MAAM,WAI7D,CAAA;AAED,eAAO,MAAM,mBAAmB,aAAc,GAAG;cAAe,MAAM;UAAQ,GAAG,EAAE;CAYlF,CAAA;AAED,eAAO,MAAM,aAAa,aAAc;IAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC;IAAC,IAAI,EAAE,GAAG,EAAE,CAAC;IAAE,SAAS,EAAE,YAAY,EAAE,CAAC;IAAC,aAAa,EAAE,MAAM,EAAE,CAAC;CAAE,KAAG,YA0C5I,CAAA;AAGD,aAAK,YAAY,GAAG;IAClB,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC;CAC1D,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IAGH;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,UAAU,GAAG,aAAa,GAAG,UAAU,CAAC;IAC9C;;;OAGG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,MAAM,EAAE,CAAC;IAC3C;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,MAAM,CAAC;IAE3C,UAAU,CAAC,EAAE,uBAAuB,CAAC;CACtC,CAAC;AA2OF;;EAEE;AACF,eAAO,MAAM,SAAS,EAAE,YAAY,EA2iBnC,CAAC;AAGF,eAAO,MAAM,eAAe,EAAE,SAAS,EA8BtC,CAAC;AAEF,qBAAa,iBAAiB;IAE5B,MAAM,EAAE,UAAU,EAAE,CAAM;IAC1B,OAAO,CAAC,SAAS,CAAW;IAE5B,OAAO,CAAC,aAAa,CAAW;IAChC,OAAO,CAAC,cAAc,CAAc;IACpC,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,8BAA8B,CAAW;IACjD,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,OAAO,CAAe;gBAElB,MAAM,EAAE;QAAE,aAAa,EAAE,MAAM,EAAE,CAAC;QAAC,cAAc,EAAE,SAAS,EAAE,CAAC;QAAC,SAAS,EAAE,YAAY,EAAE,CAAC;QAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,UAAU,EAAE,CAAC;KAAE;IAmBrK,OAAO,CAAC,UAAU,CAMjB;IAED,OAAO,CAAC,OAAO,CAQd;IAED,OAAO,CAAC,WAAW,CAkBlB;IAED,SAAS,cAAe,MAAM,YAAY,OAAO,UA6BhD;IAED,eAAe,eAAsB,MAAM,oBAAoB,MAAM,OAAO,GAAG,kBAAkB,MAAM,KAAK,GAAG,KAAK,GAAG,oBAiGtH;CAEF;AAED,wBAAsB,WAAW,CAC/B,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,CAAC,YAAY,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAO,EACvD,aAAa,KAAO,EACpB,UAAU,EAAE,SAAS,GAAG,SAAS,EACjC,WAAW,EAAE,WAAW,GAAG,SAAS,EACpC,OAAO,EAAE,UAAU,EAAE,GACpB,OAAO,CAAC,QAAQ,CAAC,CAqJnB;AAKD,wBAAgB,SAAS,CACvB,KAAK,EAAE,YAAY,EACnB,CAAC,EAAE,QAAQ,EACX,KAAK,GAAE,MAAU,EACjB,UAAU,GAAE,MAAM,EAAO,EACzB,YAAY,GAAE,YAAiB,GAC9B,MAAM,CAyQR"}