@budibase/backend-core 2.11.37 → 2.11.39

package/dist/src/cache/user.d.ts

@@ -3,9 +3,9 @@ import { User } from "@budibase/types";
  * Get the requested user by id.
  * Use redis cache to first read the user.
  * If not present fallback to loading the user directly and re-caching.
- * @param {*} userId the id of the user to get
- * @param {*} tenantId the tenant of the user to get
- * @param {*} populateUser function to provide the user for re-caching. default to couch db
+ * @param userId the id of the user to get
+ * @param tenantId the tenant of the user to get
+ * @param populateUser function to provide the user for re-caching. default to couch db
  * @returns
  */
 export declare function getUser(userId: string, tenantId?: string, populateUser?: any): Promise<any>;
@@ -13,8 +13,8 @@ export declare function getUser(userId: string, tenantId?: string, populateUser?
  * Get the requested users by id.
  * Use redis cache to first read the users.
  * If not present fallback to loading the users directly and re-caching.
- * @param {*} userIds the ids of the user to get
- * @param {*} tenantId the tenant of the users to get
+ * @param userIds the ids of the user to get
+ * @param tenantId the tenant of the users to get
  * @returns
  */
 export declare function getUsers(userIds: string[]): Promise<{

package/dist/src/cache/user.js

@@ -89,9 +89,9 @@ function populateUsersFromDB(userIds) {
  * Get the requested user by id.
  * Use redis cache to first read the user.
  * If not present fallback to loading the user directly and re-caching.
- * @param {*} userId the id of the user to get
- * @param {*} tenantId the tenant of the user to get
- * @param {*} populateUser function to provide the user for re-caching. default to couch db
+ * @param userId the id of the user to get
+ * @param tenantId the tenant of the user to get
+ * @param populateUser function to provide the user for re-caching. default to couch db
  * @returns
  */
 function getUser(userId, tenantId, populateUser) {
@@ -139,8 +139,8 @@ exports.getUser = getUser;
  * Get the requested users by id.
  * Use redis cache to first read the users.
  * If not present fallback to loading the users directly and re-caching.
- * @param {*} userIds the ids of the user to get
- * @param {*} tenantId the tenant of the users to get
+ * @param userIds the ids of the user to get
+ * @param tenantId the tenant of the users to get
  * @returns
  */
 function getUsers(userIds) {

package/dist/src/cache/writethrough.d.ts

@@ -3,7 +3,7 @@ export declare class Writethrough {
     db: Database;
     writeRateMs: number;
     constructor(db: Database, writeRateMs?: number);
-    put(doc: any): Promise<{
+    put(doc: any, writeRateMs?: number): Promise<{
         ok: boolean;
         id: string | undefined;
         rev: string | undefined;

package/dist/src/cache/writethrough.js

@@ -139,9 +139,9 @@ class Writethrough {
         this.db = db;
         this.writeRateMs = writeRateMs;
     }
-    put(doc) {
+    put(doc, writeRateMs = this.writeRateMs) {
         return __awaiter(this, void 0, void 0, function* () {
-            return put(this.db, doc, this.writeRateMs);
+            return put(this.db, doc, writeRateMs);
         });
     }
     get(id) {

package/dist/src/cache/writethrough.js.map

@@ -1 +1 @@
-{"version":3,"file":"writethrough.js","sourceRoot":"","sources":["../../../src/cache/writethrough.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA8B;AAC9B,wCAAqD;AACrD,wCAAoC;AACpC,2CAAwE;AACxE,4DAA6C;AAE7C,MAAM,qBAAqB,GAAG,KAAK,CAAA;AACnC,IAAI,KAAK,GAAqB,IAAI,CAAA;AAOlC,SAAe,QAAQ;;QACrB,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,MAAM,GAAG,MAAM,IAAA,4BAAqB,GAAE,CAAA;YAC5C,KAAK,GAAG,IAAI,cAAS,CAAC,MAAM,CAAC,CAAA;SAC9B;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CAAA;AAED,SAAS,YAAY,CAAC,EAAY,EAAE,GAAW;IAC7C,OAAO,EAAE,CAAC,IAAI,GAAG,GAAG,CAAA;AACtB,CAAC;AAED,SAAS,aAAa,CAAC,GAAQ,EAAE,YAA2B,IAAI;IAC9D,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;AACpD,CAAC;AAED,SAAe,GAAG,CAChB,EAAY,EACZ,GAAa,EACb,cAAsB,qBAAqB;;QAE3C,MAAM,KAAK,GAAG,MAAM,QAAQ,EAAE,CAAA;QAC9B,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAA;QACnB,IAAI,SAAgC,CAAA;QACpC,IAAI,GAAG,EAAE;YACP,SAAS,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA;SACnD;QACD,MAAM,QAAQ,GAAG,CAAC,SAAS,IAAI,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAA;QAC7E,IAAI,MAAM,GAAG,GAAG,CAAA;QAChB,IAAI,QAAQ,EAAE;YACZ,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CACzC;gBACE,IAAI,EAAE,gBAAQ,CAAC,QAAQ;gBACvB,IAAI,EAAE,gBAAQ,CAAC,oBAAoB;gBACnC,QAAQ,EAAE,GAAG;gBACb,GAAG,EAAE,KAAK;aACX,EACD,GAAS,EAAE;gBACT,MAAM,OAAO,GAAG,CAAO,OAAY,EAAE,EAAE;oBACrC,sCAAsC;oBACtC,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;oBACvD,MAAM,mCACD,GAAG,KACN,GAAG,EAAE,QAAQ,CAAC,EAAE,EAChB,IAAI,EAAE,QAAQ,CAAC,GAAG,GACnB,CAAA;gBACH,CAAC,CAAA,CAAA;gBACD,IAAI;oBACF,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;iBACnB;gBAAC,OAAO,GAAQ,EAAE;oBACjB,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;wBACtB,MAAM,GAAG,CAAA;qBACV;yBAAM;wBACL,4BAA4B;wBAC5B,IAAA,iBAAO,EAAC,0CAA0C,CAAC,CAAA;qBACpD;iBACF;YACH,CAAC,CAAA,CACF,CAAA;YAED,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;gBAC1B,IAAA,iBAAO,EAAC,kDAAkD,CAAC,CAAA;aAC5D;SACF;QACD,kEAAkE;QAClE,SAAS,GAAG,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAS,CAAC,CAAA;QACzE,IAAI,MAAM,CAAC,GAAG,EAAE;YACd,MAAM,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAA;SAC3D;QACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,CAAA;IACvD,CAAC;CAAA;AAED,SAAe,GAAG,CAAC,EAAY,EAAE,EAAU;;QACzC,MAAM,KAAK,GAAG,MAAM,QAAQ,EAAE,CAAA;QAC9B,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QACrC,IAAI,SAAS,GAAc,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACpD,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAC5B,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;YAC9B,MAAM,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;SACvC;QACD,OAAO,SAAS,CAAC,GAAG,CAAA;IACtB,CAAC;CAAA;AAED,SAAe,MAAM,CAAC,EAAY,EAAE,OAAY,EAAE,GAAS;;QACzD,MAAM,KAAK,GAAG,MAAM,QAAQ,EAAE,CAAA;QAC9B,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;SACvC;QACD,MAAM,EAAE,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAA;QAC9D,GAAG,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;QACtD,IAAI;YACF,MAAM,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;SACzC;gBAAS;YACR,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;SACzB;IACH,CAAC;CAAA;AAED,MAAa,YAAY;IAIvB,YAAY,EAAY,EAAE,cAAsB,qBAAqB;QACnE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAEK,GAAG,CAAC,GAAQ;;YAChB,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;QAC5C,CAAC;KAAA;IAEK,GAAG,CAAC,EAAU;;YAClB,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QACzB,CAAC;KAAA;IAEK,MAAM,CAAC,OAAY,EAAE,GAAS;;YAClC,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;QACtC,CAAC;KAAA;CACF;AApBD,oCAoBC"}
+{"version":3,"file":"writethrough.js","sourceRoot":"","sources":["../../../src/cache/writethrough.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA8B;AAC9B,wCAAqD;AACrD,wCAAoC;AACpC,2CAAwE;AACxE,4DAA6C;AAE7C,MAAM,qBAAqB,GAAG,KAAK,CAAA;AACnC,IAAI,KAAK,GAAqB,IAAI,CAAA;AAOlC,SAAe,QAAQ;;QACrB,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,MAAM,GAAG,MAAM,IAAA,4BAAqB,GAAE,CAAA;YAC5C,KAAK,GAAG,IAAI,cAAS,CAAC,MAAM,CAAC,CAAA;SAC9B;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CAAA;AAED,SAAS,YAAY,CAAC,EAAY,EAAE,GAAW;IAC7C,OAAO,EAAE,CAAC,IAAI,GAAG,GAAG,CAAA;AACtB,CAAC;AAED,SAAS,aAAa,CAAC,GAAQ,EAAE,YAA2B,IAAI;IAC9D,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;AACpD,CAAC;AAED,SAAe,GAAG,CAChB,EAAY,EACZ,GAAa,EACb,cAAsB,qBAAqB;;QAE3C,MAAM,KAAK,GAAG,MAAM,QAAQ,EAAE,CAAA;QAC9B,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAA;QACnB,IAAI,SAAgC,CAAA;QACpC,IAAI,GAAG,EAAE;YACP,SAAS,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA;SACnD;QACD,MAAM,QAAQ,GAAG,CAAC,SAAS,IAAI,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAA;QAC7E,IAAI,MAAM,GAAG,GAAG,CAAA;QAChB,IAAI,QAAQ,EAAE;YACZ,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CACzC;gBACE,IAAI,EAAE,gBAAQ,CAAC,QAAQ;gBACvB,IAAI,EAAE,gBAAQ,CAAC,oBAAoB;gBACnC,QAAQ,EAAE,GAAG;gBACb,GAAG,EAAE,KAAK;aACX,EACD,GAAS,EAAE;gBACT,MAAM,OAAO,GAAG,CAAO,OAAY,EAAE,EAAE;oBACrC,sCAAsC;oBACtC,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;oBACvD,MAAM,mCACD,GAAG,KACN,GAAG,EAAE,QAAQ,CAAC,EAAE,EAChB,IAAI,EAAE,QAAQ,CAAC,GAAG,GACnB,CAAA;gBACH,CAAC,CAAA,CAAA;gBACD,IAAI;oBACF,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;iBACnB;gBAAC,OAAO,GAAQ,EAAE;oBACjB,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;wBACtB,MAAM,GAAG,CAAA;qBACV;yBAAM;wBACL,4BAA4B;wBAC5B,IAAA,iBAAO,EAAC,0CAA0C,CAAC,CAAA;qBACpD;iBACF;YACH,CAAC,CAAA,CACF,CAAA;YAED,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;gBAC1B,IAAA,iBAAO,EAAC,kDAAkD,CAAC,CAAA;aAC5D;SACF;QACD,kEAAkE;QAClE,SAAS,GAAG,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAS,CAAC,CAAA;QACzE,IAAI,MAAM,CAAC,GAAG,EAAE;YACd,MAAM,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAA;SAC3D;QACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,CAAA;IACvD,CAAC;CAAA;AAED,SAAe,GAAG,CAAC,EAAY,EAAE,EAAU;;QACzC,MAAM,KAAK,GAAG,MAAM,QAAQ,EAAE,CAAA;QAC9B,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QACrC,IAAI,SAAS,GAAc,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACpD,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAC5B,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;YAC9B,MAAM,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;SACvC;QACD,OAAO,SAAS,CAAC,GAAG,CAAA;IACtB,CAAC;CAAA;AAED,SAAe,MAAM,CAAC,EAAY,EAAE,OAAY,EAAE,GAAS;;QACzD,MAAM,KAAK,GAAG,MAAM,QAAQ,EAAE,CAAA;QAC9B,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;SACvC;QACD,MAAM,EAAE,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAA;QAC9D,GAAG,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;QACtD,IAAI;YACF,MAAM,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;SACzC;gBAAS;YACR,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;SACzB;IACH,CAAC;CAAA;AAED,MAAa,YAAY;IAIvB,YAAY,EAAY,EAAE,cAAsB,qBAAqB;QACnE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAEK,GAAG,CAAC,GAAQ,EAAE,cAAsB,IAAI,CAAC,WAAW;;YACxD,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,CAAA;QACvC,CAAC;KAAA;IAEK,GAAG,CAAC,EAAU;;YAClB,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QACzB,CAAC;KAAA;IAEK,MAAM,CAAC,OAAY,EAAE,GAAS;;YAClC,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;QACtC,CAAC;KAAA;CACF;AApBD,oCAoBC"}

package/dist/src/configs/configs.d.ts

@@ -1,7 +1,7 @@
 import { Config, ConfigType, GoogleInnerConfig, OIDCInnerConfig, OIDCLogosConfig, SCIMInnerConfig, SettingsConfig, SettingsInnerConfig, SMTPConfig, SMTPInnerConfig } from "@budibase/types";
 /**
  * Generates a new configuration ID.
- * @returns {string} The new configuration ID which the config doc can be stored under.
+ * @returns The new configuration ID which the config doc can be stored under.
  */
 export declare function generateConfigID(type: ConfigType): string;
 export declare function getConfig<T extends Config>(type: ConfigType): Promise<T | undefined>;

package/dist/src/configs/configs.js

@@ -45,7 +45,7 @@ const environment_2 = __importDefault(require("../environment"));
 // UTILS
 /**
  * Generates a new configuration ID.
- * @returns {string} The new configuration ID which the config doc can be stored under.
+ * @returns The new configuration ID which the config doc can be stored under.
  */
 function generateConfigID(type) {
     return `${constants_1.DocumentType.CONFIG}${constants_1.SEPARATOR}${type}`;

package/dist/src/context/mainContext.d.ts

@@ -8,7 +8,7 @@ export declare function isTenantIdSet(): boolean;
 export declare function isTenancyEnabled(): string | undefined;
 /**
  * Given an app ID this will attempt to retrieve the tenant ID from it.
- * @return {null|string} The tenant ID found within the app ID.
+ * @return The tenant ID found within the app ID.
  */
 export declare function getTenantIDFromAppID(appId: string): string | undefined;
 export declare function doInAutomationContext(params: {

package/dist/src/context/mainContext.js

@@ -93,7 +93,7 @@ function isTenancyEnabled() {
 exports.isTenancyEnabled = isTenancyEnabled;
 /**
  * Given an app ID this will attempt to retrieve the tenant ID from it.
- * @return {null|string} The tenant ID found within the app ID.
+ * @return The tenant ID found within the app ID.
  */
 function getTenantIDFromAppID(appId) {
     if (!appId) {

package/dist/src/db/Replication.d.ts

@@ -4,20 +4,20 @@ declare class Replication {
     replication: any;
     /**
      *
-     * @param {String} source - the DB you want to replicate or rollback to
-     * @param {String} target - the DB you want to replicate to, or rollback from
+     * @param source - the DB you want to replicate or rollback to
+     * @param target - the DB you want to replicate to, or rollback from
      */
     constructor({ source, target }: any);
     close(): Promise<[void, void]>;
     promisify(operation: any, opts?: {}): Promise<unknown>;
     /**
      * Two way replication operation, intended to be promise based.
-     * @param {Object} opts - PouchDB replication options
+     * @param opts - PouchDB replication options
      */
     sync(opts?: {}): any;
     /**
      * One way replication operation, intended to be promise based.
-     * @param {Object} opts - PouchDB replication options
+     * @param opts - PouchDB replication options
      */
     replicate(opts?: {}): any;
     appReplicateOpts(): {

package/dist/src/db/Replication.js

@@ -14,8 +14,8 @@ const constants_1 = require("../constants");
 class Replication {
     /**
      *
-     * @param {String} source - the DB you want to replicate or rollback to
-     * @param {String} target - the DB you want to replicate to, or rollback from
+     * @param source - the DB you want to replicate or rollback to
+     * @param target - the DB you want to replicate to, or rollback from
      */
     constructor({ source, target }) {
         this.source = (0, couch_1.getPouchDB)(source);
@@ -41,7 +41,7 @@ class Replication {
     }
     /**
      * Two way replication operation, intended to be promise based.
-     * @param {Object} opts - PouchDB replication options
+     * @param opts - PouchDB replication options
      */
     sync(opts = {}) {
         this.replication = this.promisify(this.source.sync, opts);
@@ -49,7 +49,7 @@ class Replication {
     }
     /**
      * One way replication operation, intended to be promise based.
-     * @param {Object} opts - PouchDB replication options
+     * @param opts - PouchDB replication options
      */
     replicate(opts = {}) {
         this.replication = this.promisify(this.source.replicate.to, opts);

package/dist/src/db/lucene.d.ts

@@ -69,10 +69,10 @@ export declare class QueryBuilder<T> {
  * Performs a paginated search. A bookmark will be returned to allow the next
  * page to be fetched. There is a max limit off 200 results per page in a
  * paginated search.
- * @param dbName {string} Which database to run a lucene query on
- * @param index {string} Which search index to utilise
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
+ * @param dbName Which database to run a lucene query on
+ * @param index Which search index to utilise
+ * @param query The JSON query structure
+ * @param params The search params including:
  *   tableId {string} The table ID to search
  *   sort {string} The sort column
  *   sortOrder {string} The sort order ("ascending" or "descending")
@@ -93,10 +93,10 @@ export declare function paginatedSearch<T>(dbName: string, index: string, query:
  * desired amount of results. There is a limit of 1000 results to avoid
  * heavy performance hits, and to avoid client components breaking from
  * handling too much data.
- * @param dbName {string} Which database to run a lucene query on
- * @param index {string} Which search index to utilise
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
+ * @param dbName Which database to run a lucene query on
+ * @param index Which search index to utilise
+ * @param query The JSON query structure
+ * @param params The search params including:
  *   tableId {string} The table ID to search
  *   sort {string} The sort column
  *   sortOrder {string} The sort order ("ascending" or "descending")

package/dist/src/db/lucene.js

@@ -534,10 +534,10 @@ function runQuery(url, body, cookie) {
  * Gets round the fixed limit of 200 results from a query by fetching as many
  * pages as required and concatenating the results. This recursively operates
  * until enough results have been found.
- * @param dbName {string} Which database to run a lucene query on
- * @param index {string} Which search index to utilise
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
+ * @param dbName Which database to run a lucene query on
+ * @param index Which search index to utilise
+ * @param query The JSON query structure
+ * @param params The search params including:
  *   tableId {string} The table ID to search
  *   sort {string} The sort column
  *   sortOrder {string} The sort order ("ascending" or "descending")
@@ -582,10 +582,10 @@ function recursiveSearch(dbName, index, query, params) {
  * Performs a paginated search. A bookmark will be returned to allow the next
  * page to be fetched. There is a max limit off 200 results per page in a
  * paginated search.
- * @param dbName {string} Which database to run a lucene query on
- * @param index {string} Which search index to utilise
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
+ * @param dbName Which database to run a lucene query on
+ * @param index Which search index to utilise
+ * @param query The JSON query structure
+ * @param params The search params including:
  *   tableId {string} The table ID to search
  *   sort {string} The sort column
  *   sortOrder {string} The sort order ("ascending" or "descending")
@@ -641,10 +641,10 @@ exports.paginatedSearch = paginatedSearch;
  * desired amount of results. There is a limit of 1000 results to avoid
  * heavy performance hits, and to avoid client components breaking from
  * handling too much data.
- * @param dbName {string} Which database to run a lucene query on
- * @param index {string} Which search index to utilise
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
+ * @param dbName Which database to run a lucene query on
+ * @param index Which search index to utilise
+ * @param query The JSON query structure
+ * @param params The search params including:
  *   tableId {string} The table ID to search
  *   sort {string} The sort column
  *   sortOrder {string} The sort order ("ascending" or "descending")

package/dist/src/db/utils.d.ts

@@ -13,7 +13,7 @@ export declare function getAllDbs(opts?: {
  * Lots of different points in the system need to find the full list of apps, this will
  * enumerate the entire CouchDB cluster and get the list of databases (every app).
  *
- * @return {Promise<object[]>} returns the app information document stored in each app database.
+ * @return returns the app information document stored in each app database.
  */
 export declare function getAllApps({ dev, all, idsOnly, efficient, }?: any): Promise<App[] | string[]>;
 export declare function getAppsByIDs(appIds: string[]): Promise<App[]>;

package/dist/src/db/utils.js

@@ -76,7 +76,7 @@ exports.getAllDbs = getAllDbs;
  * Lots of different points in the system need to find the full list of apps, this will
  * enumerate the entire CouchDB cluster and get the list of databases (every app).
  *
- * @return {Promise<object[]>} returns the app information document stored in each app database.
+ * @return returns the app information document stored in each app database.
  */
 function getAllApps({ dev, all, idsOnly, efficient, } = {}) {
     return __awaiter(this, void 0, void 0, function* () {

package/dist/src/docIds/conversions.d.ts

@@ -4,7 +4,7 @@ export declare function isProdAppID(appId?: string): boolean;
 export declare function isDevApp(app: App): boolean;
 /**
  * Generates a development app ID from a real app ID.
- * @returns {string} the dev app ID which can be used for dev database.
+ * @returns the dev app ID which can be used for dev database.
  */
 export declare function getDevelopmentAppID(appId: string): string;
 export declare const getDevAppID: typeof getDevelopmentAppID;

package/dist/src/docIds/conversions.js

@@ -26,7 +26,7 @@ function isDevApp(app) {
 exports.isDevApp = isDevApp;
 /**
  * Generates a development app ID from a real app ID.
- * @returns {string} the dev app ID which can be used for dev database.
+ * @returns the dev app ID which can be used for dev database.
  */
 function getDevelopmentAppID(appId) {
     if (!appId || appId.startsWith(constants_1.APP_DEV_PREFIX)) {

package/dist/src/docIds/ids.d.ts

@@ -1,30 +1,30 @@
 /**
  * Generates a new app ID.
- * @returns {string} The new app ID which the app doc can be stored under.
+ * @returns The new app ID which the app doc can be stored under.
  */
 export declare const generateAppID: (tenantId?: string | null) => string;
 /**
  * Gets a new row ID for the specified table.
- * @param {string} tableId The table which the row is being created for.
- * @param {string|null} id If an ID is to be used then the UUID can be substituted for this.
- * @returns {string} The new ID which a row doc can be stored under.
+ * @param tableId The table which the row is being created for.
+ * @param id If an ID is to be used then the UUID can be substituted for this.
+ * @returns The new ID which a row doc can be stored under.
  */
 export declare function generateRowID(tableId: string, id?: string): string;
 /**
  * Generates a new workspace ID.
- * @returns {string} The new workspace ID which the workspace doc can be stored under.
+ * @returns The new workspace ID which the workspace doc can be stored under.
  */
 export declare function generateWorkspaceID(): string;
 /**
  * Generates a new global user ID.
- * @returns {string} The new user ID which the user doc can be stored under.
+ * @returns The new user ID which the user doc can be stored under.
  */
 export declare function generateGlobalUserID(id?: any): string;
 export declare function isGlobalUserID(id: string): boolean;
 /**
  * Generates a new user ID based on the passed in global ID.
- * @param {string} globalId The ID of the global user.
- * @returns {string} The new user ID which the user doc can be stored under.
+ * @param globalId The ID of the global user.
+ * @returns The new user ID which the user doc can be stored under.
  */
 export declare function generateUserMetadataID(globalId: string): string;
 /**
@@ -39,7 +39,7 @@ export declare function generateTemplateID(ownerId: any): string;
 export declare function generateAppUserID(prodAppId: string, userId: string): string;
 /**
  * Generates a new role ID.
- * @returns {string} The new role ID which the role doc can be stored under.
+ * @returns The new role ID which the role doc can be stored under.
  */
 export declare function generateRoleID(name: string): string;
 /**
@@ -48,11 +48,11 @@ export declare function generateRoleID(name: string): string;
 export declare function prefixRoleID(name: string): string;
 /**
  * Generates a new dev info document ID - this is scoped to a user.
- * @returns {string} The new dev info ID which info for dev (like api key) can be stored under.
+ * @returns The new dev info ID which info for dev (like api key) can be stored under.
  */
 export declare const generateDevInfoID: (userId: any) => string;
 /**
  * Generates a new plugin ID - to be used in the global DB.
- * @returns {string} The new plugin ID which a plugin metadata document can be stored under.
+ * @returns The new plugin ID which a plugin metadata document can be stored under.
  */
 export declare const generatePluginID: (name: string) => string;

package/dist/src/docIds/ids.js

@@ -5,7 +5,7 @@ const constants_1 = require("../constants");
 const newid_1 = require("./newid");
 /**
  * Generates a new app ID.
- * @returns {string} The new app ID which the app doc can be stored under.
+ * @returns The new app ID which the app doc can be stored under.
  */
 const generateAppID = (tenantId) => {
     let id = constants_1.APP_PREFIX;
@@ -17,9 +17,9 @@ const generateAppID = (tenantId) => {
 exports.generateAppID = generateAppID;
 /**
  * Gets a new row ID for the specified table.
- * @param {string} tableId The table which the row is being created for.
- * @param {string|null} id If an ID is to be used then the UUID can be substituted for this.
- * @returns {string} The new ID which a row doc can be stored under.
+ * @param tableId The table which the row is being created for.
+ * @param id If an ID is to be used then the UUID can be substituted for this.
+ * @returns The new ID which a row doc can be stored under.
  */
 function generateRowID(tableId, id) {
     id = id || (0, newid_1.newid)();
@@ -28,7 +28,7 @@ function generateRowID(tableId, id) {
 exports.generateRowID = generateRowID;
 /**
  * Generates a new workspace ID.
- * @returns {string} The new workspace ID which the workspace doc can be stored under.
+ * @returns The new workspace ID which the workspace doc can be stored under.
  */
 function generateWorkspaceID() {
     return `${constants_1.DocumentType.WORKSPACE}${constants_1.SEPARATOR}${(0, newid_1.newid)()}`;
@@ -36,7 +36,7 @@ function generateWorkspaceID() {
 exports.generateWorkspaceID = generateWorkspaceID;
 /**
  * Generates a new global user ID.
- * @returns {string} The new user ID which the user doc can be stored under.
+ * @returns The new user ID which the user doc can be stored under.
  */
 function generateGlobalUserID(id) {
     return `${constants_1.DocumentType.USER}${constants_1.SEPARATOR}${id || (0, newid_1.newid)()}`;
@@ -49,8 +49,8 @@ function isGlobalUserID(id) {
 exports.isGlobalUserID = isGlobalUserID;
 /**
  * Generates a new user ID based on the passed in global ID.
- * @param {string} globalId The ID of the global user.
- * @returns {string} The new user ID which the user doc can be stored under.
+ * @param globalId The ID of the global user.
+ * @returns The new user ID which the user doc can be stored under.
  */
 function generateUserMetadataID(globalId) {
     return generateRowID(constants_1.InternalTable.USER_METADATA, globalId);
@@ -81,7 +81,7 @@ function generateAppUserID(prodAppId, userId) {
 exports.generateAppUserID = generateAppUserID;
 /**
  * Generates a new role ID.
- * @returns {string} The new role ID which the role doc can be stored under.
+ * @returns The new role ID which the role doc can be stored under.
  */
 function generateRoleID(name) {
     const prefix = `${constants_1.DocumentType.ROLE}${constants_1.SEPARATOR}`;
@@ -100,7 +100,7 @@ function prefixRoleID(name) {
 exports.prefixRoleID = prefixRoleID;
 /**
  * Generates a new dev info document ID - this is scoped to a user.
- * @returns {string} The new dev info ID which info for dev (like api key) can be stored under.
+ * @returns The new dev info ID which info for dev (like api key) can be stored under.
  */
 const generateDevInfoID = (userId) => {
     return `${constants_1.DocumentType.DEV_INFO}${constants_1.SEPARATOR}${userId}`;
@@ -108,7 +108,7 @@ const generateDevInfoID = (userId) => {
 exports.generateDevInfoID = generateDevInfoID;
 /**
  * Generates a new plugin ID - to be used in the global DB.
- * @returns {string} The new plugin ID which a plugin metadata document can be stored under.
+ * @returns The new plugin ID which a plugin metadata document can be stored under.
  */
 const generatePluginID = (name) => {
     return `${constants_1.DocumentType.PLUGIN}${constants_1.SEPARATOR}${name}`;

package/dist/src/docIds/params.d.ts

@@ -4,21 +4,21 @@ import { ViewName } from "../constants";
  * is usually the case as most of our docs are top level e.g. tables, automations, users and so on.
  * More complex cases such as link docs and rows which have multiple levels of IDs that their
  * ID consists of need their own functions to build the allDocs parameters.
- * @param {string} docType The type of document which input params are being built for, e.g. user,
+ * @param docType The type of document which input params are being built for, e.g. user,
  * link, app, table and so on.
- * @param {string|null} docId The ID of the document minus its type - this is only needed if looking
+ * @param docId The ID of the document minus its type - this is only needed if looking
  * for a singular document.
- * @param {object} otherProps Add any other properties onto the request, e.g. include_docs.
- * @returns {object} Parameters which can then be used with an allDocs request.
+ * @param otherProps Add any other properties onto the request, e.g. include_docs.
+ * @returns Parameters which can then be used with an allDocs request.
  */
 export declare function getDocParams(docType: string, docId?: string | null, otherProps?: any): any;
 /**
  * Gets the DB allDocs/query params for retrieving a row.
- * @param {string|null} tableId The table in which the rows have been stored.
- * @param {string|null} rowId The ID of the row which is being specifically queried for. This can be
+ * @param tableId The table in which the rows have been stored.
+ * @param rowId The ID of the row which is being specifically queried for. This can be
  * left null to get all the rows in the table.
- * @param {object} otherProps Any other properties to add to the request.
- * @returns {object} Parameters which can then be used with an allDocs request.
+ * @param otherProps Any other properties to add to the request.
+ * @returns Parameters which can then be used with an allDocs request.
  */
 export declare function getRowParams(tableId?: string | null, rowId?: string | null, otherProps?: {}): any;
 /**

package/dist/src/docIds/params.js

@@ -8,12 +8,12 @@ const conversions_1 = require("./conversions");
  * is usually the case as most of our docs are top level e.g. tables, automations, users and so on.
  * More complex cases such as link docs and rows which have multiple levels of IDs that their
  * ID consists of need their own functions to build the allDocs parameters.
- * @param {string} docType The type of document which input params are being built for, e.g. user,
+ * @param docType The type of document which input params are being built for, e.g. user,
  * link, app, table and so on.
- * @param {string|null} docId The ID of the document minus its type - this is only needed if looking
+ * @param docId The ID of the document minus its type - this is only needed if looking
  * for a singular document.
- * @param {object} otherProps Add any other properties onto the request, e.g. include_docs.
- * @returns {object} Parameters which can then be used with an allDocs request.
+ * @param otherProps Add any other properties onto the request, e.g. include_docs.
+ * @returns Parameters which can then be used with an allDocs request.
  */
 function getDocParams(docType, docId, otherProps = {}) {
     if (docId == null) {
@@ -24,11 +24,11 @@ function getDocParams(docType, docId, otherProps = {}) {
 exports.getDocParams = getDocParams;
 /**
  * Gets the DB allDocs/query params for retrieving a row.
- * @param {string|null} tableId The table in which the rows have been stored.
- * @param {string|null} rowId The ID of the row which is being specifically queried for. This can be
+ * @param tableId The table in which the rows have been stored.
+ * @param rowId The ID of the row which is being specifically queried for. This can be
  * left null to get all the rows in the table.
- * @param {object} otherProps Any other properties to add to the request.
- * @returns {object} Parameters which can then be used with an allDocs request.
+ * @param otherProps Any other properties to add to the request.
+ * @returns Parameters which can then be used with an allDocs request.
  */
 function getRowParams(tableId, rowId, otherProps = {}) {
     if (tableId == null) {

package/dist/src/helpers.d.ts

@@ -1,7 +1,7 @@
 /**
  * Makes sure that a URL has the correct number of slashes, while maintaining the
  * http(s):// double slashes.
- * @param {string} url The URL to test and remove any extra double slashes.
- * @return {string} The updated url.
+ * @param url The URL to test and remove any extra double slashes.
+ * @return The updated url.
  */
 export declare function checkSlashesInUrl(url: string): string;

package/dist/src/helpers.js

@@ -4,8 +4,8 @@ exports.checkSlashesInUrl = void 0;
 /**
  * Makes sure that a URL has the correct number of slashes, while maintaining the
  * http(s):// double slashes.
- * @param {string} url The URL to test and remove any extra double slashes.
- * @return {string} The updated url.
+ * @param url The URL to test and remove any extra double slashes.
+ * @return The updated url.
  */
 function checkSlashesInUrl(url) {
     return url.replace(/(https?:\/\/)|(\/)+/g, "$1$2");

package/dist/src/middleware/passport/local.d.ts

@@ -4,10 +4,10 @@ export declare const options: {
 };
 /**
  * Passport Local Authentication Middleware.
- * @param {*} ctx the request structure
- * @param {*} email username to login with
- * @param {*} password plain text password to log in with
- * @param {*} done callback from passport to return user information and errors
+ * @param ctx the request structure
+ * @param email username to login with
+ * @param password plain text password to log in with
+ * @param done callback from passport to return user information and errors
  * @returns The authenticated user, or errors if they occur
  */
 export declare function authenticate(ctx: BBContext, email: string, password: string, done: Function): Promise<any>;

package/dist/src/middleware/passport/local.js

@@ -44,10 +44,10 @@ exports.options = {
 };
 /**
  * Passport Local Authentication Middleware.
- * @param {*} ctx the request structure
- * @param {*} email username to login with
- * @param {*} password plain text password to log in with
- * @param {*} done callback from passport to return user information and errors
+ * @param ctx the request structure
+ * @param email username to login with
+ * @param password plain text password to log in with
+ * @param done callback from passport to return user information and errors
  * @returns The authenticated user, or errors if they occur
  */
 function authenticate(ctx, email, password, done) {

package/dist/src/middleware/passport/sso/oidc.js

@@ -44,15 +44,15 @@ const types_1 = require("@budibase/types");
 const OIDCStrategy = require("@techpass/passport-openidconnect").Strategy;
 function buildVerifyFn(saveUserFn) {
     /**
-     * @param {*} issuer The identity provider base URL
-     * @param {*} sub The user ID
-     * @param {*} profile The user profile information. Created by passport from the /userinfo response
-     * @param {*} jwtClaims The parsed id_token claims
-     * @param {*} accessToken The access_token for contacting the identity provider - may or may not be a JWT
-     * @param {*} refreshToken The refresh_token for obtaining a new access_token - usually not a JWT
-     * @param {*} idToken The id_token - always a JWT
-     * @param {*} params The response body from requesting an access_token
-     * @param {*} done The passport callback: err, user, info
+     * @param issuer The identity provider base URL
+     * @param sub The user ID
+     * @param profile The user profile information. Created by passport from the /userinfo response
+     * @param jwtClaims The parsed id_token claims
+     * @param accessToken The access_token for contacting the identity provider - may or may not be a JWT
+     * @param refreshToken The refresh_token for obtaining a new access_token - usually not a JWT
+     * @param idToken The id_token - always a JWT
+     * @param params The response body from requesting an access_token
+     * @param done The passport callback: err, user, info
      */
     return (issuer, sub, profile, jwtClaims, accessToken, refreshToken, idToken, params, done) => __awaiter(this, void 0, void 0, function* () {
         const details = {
@@ -73,8 +73,8 @@ function buildVerifyFn(saveUserFn) {
 }
 exports.buildVerifyFn = buildVerifyFn;
 /**
- * @param {*} profile The structured profile created by passport using the user info endpoint
- * @param {*} jwtClaims The claims returned in the id token
+ * @param profile The structured profile created by passport using the user info endpoint
+ * @param jwtClaims The claims returned in the id token
  */
 function getEmail(profile, jwtClaims) {
     // profile not guaranteed to contain email e.g. github connected azure ad account

package/dist/src/middleware/passport/utils.d.ts

@@ -2,9 +2,9 @@ import { ConfigType, GoogleInnerConfig } from "@budibase/types";
 /**
  * Utility to handle authentication errors.
  *
- * @param {*} done The passport callback.
- * @param {*} message Message that will be returned in the response body
- * @param {*} err (Optional) error that will be logged
+ * @param done The passport callback.
+ * @param message Message that will be returned in the response body
+ * @param err (Optional) error that will be logged
  */
 export declare function authError(done: Function, message: string, err?: any): any;
 export declare function ssoCallbackUrl(type: ConfigType, config?: GoogleInnerConfig): Promise<string>;

package/dist/src/middleware/passport/utils.js

@@ -38,9 +38,9 @@ const configs = __importStar(require("../../configs"));
 /**
  * Utility to handle authentication errors.
  *
- * @param {*} done The passport callback.
- * @param {*} message Message that will be returned in the response body
- * @param {*} err (Optional) error that will be logged
+ * @param done The passport callback.
+ * @param message Message that will be returned in the response body
+ * @param err (Optional) error that will be logged
  */
 function authError(done, message, err) {
     return done(err, null, // never return a user