@budibase/server 2.6.19-alpha.2 → 2.6.19-alpha.20

package/dist/db/linkedRows/index.js

@@ -1,206 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.squashLinksToPrimaryDisplay = exports.attachFullLinkedDocs = exports.updateLinks = exports.EventType = exports.createLinkView = exports.getLinkDocuments = exports.IncludeDocs = void 0;
-const LinkController_1 = __importDefault(require("./LinkController"));
-const linkUtils_1 = require("./linkUtils");
-const lodash_1 = require("lodash");
-const constants_1 = require("../../constants");
-const utils_1 = require("../utils");
-const lodash_2 = require("lodash");
-const global_1 = require("../../utilities/global");
-const rowProcessor_1 = require("../../utilities/rowProcessor");
-const backend_core_1 = require("@budibase/backend-core");
-var linkUtils_2 = require("./linkUtils");
-Object.defineProperty(exports, "IncludeDocs", { enumerable: true, get: function () { return linkUtils_2.IncludeDocs; } });
-Object.defineProperty(exports, "getLinkDocuments", { enumerable: true, get: function () { return linkUtils_2.getLinkDocuments; } });
-Object.defineProperty(exports, "createLinkView", { enumerable: true, get: function () { return linkUtils_2.createLinkView; } });
-/**
- * This functionality makes sure that when rows with links are created, updated or deleted they are processed
- * correctly - making sure that no stale links are left around and that all links have been made successfully.
- */
-exports.EventType = {
-    ROW_SAVE: "row:save",
-    ROW_UPDATE: "row:update",
-    ROW_DELETE: "row:delete",
-    TABLE_SAVE: "table:save",
-    TABLE_UPDATED: "table:updated",
-    TABLE_DELETE: "table:delete",
-};
-function clearRelationshipFields(table, rows) {
-    for (let [key, field] of Object.entries(table.schema)) {
-        if (field.type === constants_1.FieldTypes.LINK) {
-            rows = rows.map(row => {
-                delete row[key];
-                return row;
-            });
-        }
-    }
-    return rows;
-}
-function getLinksForRows(rows) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const tableIds = [...new Set(rows.map(el => el.tableId))];
-        // start by getting all the link values for performance reasons
-        const promises = tableIds.map(tableId => (0, linkUtils_1.getLinkDocuments)({
-            tableId: tableId,
-            includeDocs: linkUtils_1.IncludeDocs.EXCLUDE,
-        }));
-        const responses = (0, lodash_1.flatten)((yield Promise.all(promises)));
-        // have to get unique as the previous table query can
-        // return duplicates, could be querying for both tables in a relation
-        return (0, linkUtils_1.getUniqueByProp)(responses
-            .filter(el => el != null)
-            // create a unique ID which we can use for getting only unique ones
-            .map(el => (Object.assign(Object.assign({}, el), { unique: el.id + el.thisId + el.fieldName }))), "unique");
-    });
-}
-function getFullLinkedDocs(links) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // create DBs
-        const db = backend_core_1.context.getAppDB();
-        const linkedRowIds = links.map(link => link.id);
-        const uniqueRowIds = [...new Set(linkedRowIds)];
-        let dbRows = (yield db.allDocs((0, utils_1.getMultiIDParams)(uniqueRowIds))).rows.map(row => row.doc);
-        // convert the unique db rows back to a full list of linked rows
-        const linked = linkedRowIds
-            .map(id => dbRows.find(row => row && row._id === id))
-            .filter(row => row != null);
-        // need to handle users as specific cases
-        let [users, other] = (0, lodash_2.partition)(linked, linkRow => linkRow._id.startsWith(utils_1.USER_METDATA_PREFIX));
-        users = yield (0, global_1.getGlobalUsersFromMetadata)(users);
-        return [...other, ...users];
-    });
-}
-/**
- * Update link documents for a row or table - this is to be called by the API controller when a change is occurring.
- * @param {string} args.eventType states what type of change which is occurring, means this can be expanded upon in the
- * future quite easily (all updates go through one function).
- * @param {string} args.tableId The ID of the of the table which is being changed.
- * @param {object|undefined} args.row The row which is changing, e.g. created, updated or deleted.
- * @param {object|undefined} args.table If the table has already been retrieved this can be used to reduce database gets.
- * @param {object|undefined} args.oldTable If the table is being updated then the old table can be provided for differencing.
- * @returns {Promise<object>} When the update is complete this will respond successfully. Returns the row for
- * row operations and the table for table operations.
- */
-function updateLinks(args) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { eventType, row, tableId, table, oldTable } = args;
-        const baseReturnObj = row == null ? table : row;
-        // make sure table ID is set
-        if (tableId == null && table != null) {
-            args.tableId = table._id;
-        }
-        let linkController = new LinkController_1.default(args);
-        try {
-            if (!(yield linkController.doesTableHaveLinkedFields(table)) &&
-                (oldTable == null ||
-                    !(yield linkController.doesTableHaveLinkedFields(oldTable)))) {
-                return baseReturnObj;
-            }
-        }
-        catch (err) {
-            return baseReturnObj;
-        }
-        switch (eventType) {
-            case exports.EventType.ROW_SAVE:
-            case exports.EventType.ROW_UPDATE:
-                return yield linkController.rowSaved();
-            case exports.EventType.ROW_DELETE:
-                return yield linkController.rowDeleted();
-            case exports.EventType.TABLE_SAVE:
-                return yield linkController.tableSaved();
-            case exports.EventType.TABLE_UPDATED:
-                return yield linkController.tableUpdated();
-            case exports.EventType.TABLE_DELETE:
-                return yield linkController.tableDeleted();
-            default:
-                throw "Type of event is not known, linked row handler requires update.";
-        }
-    });
-}
-exports.updateLinks = updateLinks;
-/**
- * Given a table and a list of rows this will retrieve all of the attached docs and enrich them into the row.
- * This is required for formula fields, this may only be utilised internally (for now).
- * @param {object} table The table from which the rows originated.
- * @param {array<object>} rows The rows which are to be enriched.
- * @return {Promise<*>} returns the rows with all of the enriched relationships on it.
- */
-function attachFullLinkedDocs(table, rows) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const linkedTableIds = (0, linkUtils_1.getLinkedTableIDs)(table);
-        if (linkedTableIds.length === 0) {
-            return rows;
-        }
-        // get all the links
-        const links = (yield getLinksForRows(rows)).filter(link => rows.some(row => row._id === link.thisId));
-        // clear any existing links that could be dupe'd
-        rows = clearRelationshipFields(table, rows);
-        // now get the docs and combine into the rows
-        let linked = yield getFullLinkedDocs(links);
-        const linkedTables = [];
-        for (let row of rows) {
-            for (let link of links.filter(link => link.thisId === row._id)) {
-                if (row[link.fieldName] == null) {
-                    row[link.fieldName] = [];
-                }
-                const linkedRow = linked.find(row => row._id === link.id);
-                if (linkedRow) {
-                    const linkedTableId = linkedRow.tableId || (0, linkUtils_1.getRelatedTableForField)(table, link.fieldName);
-                    const linkedTable = yield (0, linkUtils_1.getLinkedTable)(linkedTableId, linkedTables);
-                    if (linkedTable) {
-                        row[link.fieldName].push((0, rowProcessor_1.processFormulas)(linkedTable, linkedRow));
-                    }
-                }
-            }
-        }
-        return rows;
-    });
-}
-exports.attachFullLinkedDocs = attachFullLinkedDocs;
-/**
- * This function will take the given enriched rows and squash the links to only contain the primary display field.
- * @param {object} table The table from which the rows originated.
- * @param {array<object>} enriched The pre-enriched rows (full docs) which are to be squashed.
- * @returns {Promise<Array>} The rows after having their links squashed to only contain the ID and primary display.
- */
-function squashLinksToPrimaryDisplay(table, enriched) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // will populate this as we find them
-        const linkedTables = [table];
-        for (let row of enriched) {
-            // this only fetches the table if its not already in array
-            const rowTable = yield (0, linkUtils_1.getLinkedTable)(row.tableId, linkedTables);
-            for (let [column, schema] of Object.entries((rowTable === null || rowTable === void 0 ? void 0 : rowTable.schema) || {})) {
-                if (schema.type !== constants_1.FieldTypes.LINK || !Array.isArray(row[column])) {
-                    continue;
-                }
-                const newLinks = [];
-                for (let link of row[column]) {
-                    const linkTblId = link.tableId || (0, linkUtils_1.getRelatedTableForField)(table, column);
-                    const linkedTable = yield (0, linkUtils_1.getLinkedTable)(linkTblId, linkedTables);
-                    const obj = { _id: link._id };
-                    if ((linkedTable === null || linkedTable === void 0 ? void 0 : linkedTable.primaryDisplay) && link[linkedTable.primaryDisplay]) {
-                        obj.primaryDisplay = link[linkedTable.primaryDisplay];
-                    }
-                    newLinks.push(obj);
-                }
-                row[column] = newLinks;
-            }
-        }
-        return enriched;
-    });
-}
-exports.squashLinksToPrimaryDisplay = squashLinksToPrimaryDisplay;

package/dist/db/linkedRows/linkUtils.js

@@ -1,131 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRelatedTableForField = exports.getLinkedTable = exports.getLinkedTableIDs = exports.getUniqueByProp = exports.getLinkDocuments = exports.IncludeDocs = exports.createLinkView = void 0;
-const utils_1 = require("../utils");
-const constants_1 = require("../../constants");
-const staticViews_1 = require("../views/staticViews");
-const backend_core_1 = require("@budibase/backend-core");
-var staticViews_2 = require("../views/staticViews");
-Object.defineProperty(exports, "createLinkView", { enumerable: true, get: function () { return staticViews_2.createLinkView; } });
-/**
- * Only needed so that boolean parameters are being used for includeDocs
- * @type {{EXCLUDE: boolean, INCLUDE: boolean}}
- */
-exports.IncludeDocs = {
-    INCLUDE: true,
-    EXCLUDE: false,
-};
-/**
- * Gets the linking documents, not the linked documents themselves.
- * @param {string} args.tableId The table which we are searching for linked rows against.
- * @param {string|null} args.fieldName The name of column/field which is being altered, only looking for
- * linking documents that are related to it. If this is not specified then the table level will be assumed.
- * @param {string|null} args.rowId The ID of the row which we want to find linking documents for -
- * if this is not specified then it will assume table or field level depending on whether the
- * field name has been specified.
- * @param {boolean|null} args.includeDocs whether to include docs in the response call, this is considerably slower so only
- * use this if actually interested in the docs themselves.
- * @returns {Promise<object[]>} This will return an array of the linking documents that were found
- * (if any).
- */
-function getLinkDocuments(args) {
-    return __awaiter(this, arguments, void 0, function* () {
-        const { tableId, rowId, includeDocs } = args;
-        const db = backend_core_1.context.getAppDB();
-        let params;
-        if (rowId != null) {
-            params = { key: [tableId, rowId] };
-        }
-        // only table is known
-        else {
-            params = { startKey: [tableId], endKey: [tableId, {}] };
-        }
-        params.include_docs = !!includeDocs;
-        try {
-            let linkRows = (yield db.query((0, utils_1.getQueryIndex)(utils_1.ViewName.LINK), params)).rows;
-            // filter to get unique entries
-            const foundIds = [];
-            linkRows = linkRows.filter(link => {
-                // make sure anything unique is the correct key
-                if ((tableId && link.key[0] !== tableId) ||
-                    (rowId && link.key[1] !== rowId)) {
-                    return false;
-                }
-                const unique = foundIds.indexOf(link.id) === -1;
-                if (unique) {
-                    foundIds.push(link.id);
-                }
-                return unique;
-            });
-            if (includeDocs) {
-                return linkRows.map(row => row.doc);
-            }
-            else {
-                return linkRows.map(row => row.value);
-            }
-        }
-        catch (err) {
-            // check if the view doesn't exist, it should for all new instances
-            if (err != null && err.name === "not_found") {
-                yield (0, staticViews_1.createLinkView)();
-                return getLinkDocuments(arguments[0]);
-            }
-            else {
-                /* istanbul ignore next */
-                backend_core_1.logging.logAlert("Failed to get link documents", err);
-                throw err;
-            }
-        }
-    });
-}
-exports.getLinkDocuments = getLinkDocuments;
-function getUniqueByProp(array, prop) {
-    return array.filter((obj, pos, arr) => {
-        return arr.map(mapObj => mapObj[prop]).indexOf(obj[prop]) === pos;
-    });
-}
-exports.getUniqueByProp = getUniqueByProp;
-function getLinkedTableIDs(table) {
-    return Object.values(table.schema)
-        .filter((column) => column.type === constants_1.FieldTypes.LINK)
-        .map(column => column.tableId);
-}
-exports.getLinkedTableIDs = getLinkedTableIDs;
-function getLinkedTable(id, tables) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const db = backend_core_1.context.getAppDB();
-        let linkedTable = tables.find(table => table._id === id);
-        if (linkedTable) {
-            return linkedTable;
-        }
-        linkedTable = yield db.get(id);
-        if (linkedTable) {
-            tables.push(linkedTable);
-        }
-        return linkedTable;
-    });
-}
-exports.getLinkedTable = getLinkedTable;
-function getRelatedTableForField(table, fieldName) {
-    // look to see if its on the table, straight in the schema
-    const field = table.schema[fieldName];
-    if (field != null) {
-        return field.tableId;
-    }
-    for (let column of Object.values(table.schema)) {
-        if (column.type === constants_1.FieldTypes.LINK && column.fieldName === fieldName) {
-            return column.tableId;
-        }
-    }
-    return null;
-}
-exports.getRelatedTableForField = getRelatedTableForField;

package/dist/db/newid.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const { v4 } = require("uuid");
-function default_1() {
-    return v4().replace(/-/g, "");
-}
-exports.default = default_1;

package/dist/db/utils.js

@@ -1,248 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateMemoryViewID = exports.getMetadataParams = exports.generateMetadataID = exports.generateUserFlagID = exports.getQueryParams = exports.getAutomationMetadataParams = exports.generateAutomationMetadataID = exports.generateQueryID = exports.getDatasourceParams = exports.generateDatasourceID = exports.getWebhookParams = exports.generateWebhookID = exports.getScreenParams = exports.generateScreenID = exports.getLayoutParams = exports.generateLayoutID = exports.getLinkParams = exports.generateLinkID = exports.generateAutomationID = exports.getAutomationParams = exports.getTableIDFromRowID = exports.generateTableID = exports.getTableParams = exports.getGlobalIDFromUserMetadataID = exports.generateUserMetadataID = exports.getUserMetadataParams = exports.generateRowID = exports.getRowParams = exports.getDocParams = exports.getQueryIndex = exports.getRoleParams = exports.generateRoleID = exports.generateDevAppID = exports.generateAppID = exports.UNICODE_MAX = exports.InternalTables = exports.ViewName = exports.AUTOMATION_LOG_PREFIX = exports.TABLE_ROW_PREFIX = exports.LINK_USER_METADATA_PREFIX = exports.USER_METDATA_PREFIX = exports.isProdAppID = exports.isDevAppID = exports.APP_DEV_PREFIX = exports.APP_PREFIX = exports.DocumentType = exports.StaticDatabases = exports.SEPARATOR = exports.BudibaseInternalDB = exports.AppStatus = void 0;
-exports.getMultiIDParams = exports.generatePluginID = exports.getMemoryViewParams = void 0;
-const newid_1 = __importDefault(require("./newid"));
-const backend_core_1 = require("@budibase/backend-core");
-exports.AppStatus = {
-    DEV: "development",
-    ALL: "all",
-    DEPLOYED: "published",
-};
-exports.BudibaseInternalDB = {
-    _id: "bb_internal",
-    type: backend_core_1.db.BUDIBASE_DATASOURCE_TYPE,
-    name: "Budibase DB",
-    source: "BUDIBASE",
-    config: {},
-};
-exports.SEPARATOR = backend_core_1.db.SEPARATOR;
-exports.StaticDatabases = backend_core_1.db.StaticDatabases;
-exports.DocumentType = backend_core_1.db.DocumentType;
-exports.APP_PREFIX = backend_core_1.db.APP_PREFIX;
-exports.APP_DEV_PREFIX = backend_core_1.db.APP_DEV_PREFIX;
-exports.isDevAppID = backend_core_1.db.isDevAppID;
-exports.isProdAppID = backend_core_1.db.isProdAppID;
-exports.USER_METDATA_PREFIX = `${exports.DocumentType.ROW}${exports.SEPARATOR}${backend_core_1.db.InternalTable.USER_METADATA}${exports.SEPARATOR}`;
-exports.LINK_USER_METADATA_PREFIX = `${exports.DocumentType.LINK}${exports.SEPARATOR}${backend_core_1.db.InternalTable.USER_METADATA}${exports.SEPARATOR}`;
-exports.TABLE_ROW_PREFIX = `${exports.DocumentType.ROW}${exports.SEPARATOR}${exports.DocumentType.TABLE}`;
-exports.AUTOMATION_LOG_PREFIX = `${exports.DocumentType.AUTOMATION_LOG}${exports.SEPARATOR}`;
-exports.ViewName = backend_core_1.db.ViewName;
-exports.InternalTables = backend_core_1.db.InternalTable;
-exports.UNICODE_MAX = backend_core_1.db.UNICODE_MAX;
-exports.generateAppID = backend_core_1.db.generateAppID;
-exports.generateDevAppID = backend_core_1.db.getDevelopmentAppID;
-exports.generateRoleID = backend_core_1.db.generateRoleID;
-exports.getRoleParams = backend_core_1.db.getRoleParams;
-exports.getQueryIndex = backend_core_1.db.getQueryIndex;
-exports.getDocParams = backend_core_1.db.getDocParams;
-exports.getRowParams = backend_core_1.db.getRowParams;
-exports.generateRowID = backend_core_1.db.generateRowID;
-exports.getUserMetadataParams = backend_core_1.db.getUserMetadataParams;
-exports.generateUserMetadataID = backend_core_1.db.generateUserMetadataID;
-exports.getGlobalIDFromUserMetadataID = backend_core_1.db.getGlobalIDFromUserMetadataID;
-/**
- * Gets parameters for retrieving tables, this is a utility function for the getDocParams function.
- */
-function getTableParams(tableId, otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.TABLE, tableId, otherProps);
-}
-exports.getTableParams = getTableParams;
-/**
- * Generates a new table ID.
- * @returns {string} The new table ID which the table doc can be stored under.
- */
-function generateTableID() {
-    return `${exports.DocumentType.TABLE}${exports.SEPARATOR}${(0, newid_1.default)()}`;
-}
-exports.generateTableID = generateTableID;
-/**
- * Given a row ID this will find the table ID within it (only works for internal tables).
- * @param {string} rowId The ID of the row.
- * @returns {string} The table ID.
- */
-function getTableIDFromRowID(rowId) {
-    const components = rowId
-        .split(exports.DocumentType.TABLE + exports.SEPARATOR)[1]
-        .split(exports.SEPARATOR);
-    return `${exports.DocumentType.TABLE}${exports.SEPARATOR}${components[0]}`;
-}
-exports.getTableIDFromRowID = getTableIDFromRowID;
-/**
- * Gets parameters for retrieving automations, this is a utility function for the getDocParams function.
- */
-function getAutomationParams(automationId, otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.AUTOMATION, automationId, otherProps);
-}
-exports.getAutomationParams = getAutomationParams;
-/**
- * Generates a new automation ID.
- * @returns {string} The new automation ID which the automation doc can be stored under.
- */
-function generateAutomationID() {
-    return `${exports.DocumentType.AUTOMATION}${exports.SEPARATOR}${(0, newid_1.default)()}`;
-}
-exports.generateAutomationID = generateAutomationID;
-/**
- * Generates a new link doc ID. This is currently not usable with the alldocs call,
- * instead a view is built to make walking to tree easier.
- * @param {string} tableId1 The ID of the linker table.
- * @param {string} tableId2 The ID of the linked table.
- * @param {string} rowId1 The ID of the linker row.
- * @param {string} rowId2 The ID of the linked row.
- * @param {string} fieldName1 The name of the field in the linker row.
- * @param {string} fieldName2 the name of the field in the linked row.
- * @returns {string} The new link doc ID which the automation doc can be stored under.
- */
-function generateLinkID(tableId1, tableId2, rowId1, rowId2, fieldName1, fieldName2) {
-    const tables = `${exports.SEPARATOR}${tableId1}${exports.SEPARATOR}${tableId2}`;
-    const rows = `${exports.SEPARATOR}${rowId1}${exports.SEPARATOR}${rowId2}`;
-    const fields = `${exports.SEPARATOR}${fieldName1}${exports.SEPARATOR}${fieldName2}`;
-    return `${exports.DocumentType.LINK}${tables}${rows}${fields}`;
-}
-exports.generateLinkID = generateLinkID;
-/**
- * Gets parameters for retrieving link docs, this is a utility function for the getDocParams function.
- */
-function getLinkParams(otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.LINK, null, otherProps);
-}
-exports.getLinkParams = getLinkParams;
-/**
- * Generates a new layout ID.
- * @returns {string} The new layout ID which the layout doc can be stored under.
- */
-function generateLayoutID(id) {
-    return `${exports.DocumentType.LAYOUT}${exports.SEPARATOR}${id || (0, newid_1.default)()}`;
-}
-exports.generateLayoutID = generateLayoutID;
-/**
- * Gets parameters for retrieving layout, this is a utility function for the getDocParams function.
- */
-function getLayoutParams(layoutId, otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.LAYOUT, layoutId, otherProps);
-}
-exports.getLayoutParams = getLayoutParams;
-/**
- * Generates a new screen ID.
- * @returns {string} The new screen ID which the screen doc can be stored under.
- */
-function generateScreenID() {
-    return `${exports.DocumentType.SCREEN}${exports.SEPARATOR}${(0, newid_1.default)()}`;
-}
-exports.generateScreenID = generateScreenID;
-/**
- * Gets parameters for retrieving screens, this is a utility function for the getDocParams function.
- */
-function getScreenParams(screenId, otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.SCREEN, screenId, otherProps);
-}
-exports.getScreenParams = getScreenParams;
-/**
- * Generates a new webhook ID.
- * @returns {string} The new webhook ID which the webhook doc can be stored under.
- */
-function generateWebhookID() {
-    return `${exports.DocumentType.WEBHOOK}${exports.SEPARATOR}${(0, newid_1.default)()}`;
-}
-exports.generateWebhookID = generateWebhookID;
-/**
- * Gets parameters for retrieving a webhook, this is a utility function for the getDocParams function.
- */
-function getWebhookParams(webhookId, otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.WEBHOOK, webhookId, otherProps);
-}
-exports.getWebhookParams = getWebhookParams;
-/**
- * Generates a new datasource ID.
- * @returns {string} The new datasource ID which the webhook doc can be stored under.
- */
-function generateDatasourceID({ plus = false } = {}) {
-    return `${plus ? exports.DocumentType.DATASOURCE_PLUS : exports.DocumentType.DATASOURCE}${exports.SEPARATOR}${(0, newid_1.default)()}`;
-}
-exports.generateDatasourceID = generateDatasourceID;
-/**
- * Gets parameters for retrieving a datasource, this is a utility function for the getDocParams function.
- */
-function getDatasourceParams(datasourceId, otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.DATASOURCE, datasourceId, otherProps);
-}
-exports.getDatasourceParams = getDatasourceParams;
-/**
- * Generates a new query ID.
- * @returns {string} The new query ID which the query doc can be stored under.
- */
-function generateQueryID(datasourceId) {
-    return `${exports.DocumentType.QUERY}${exports.SEPARATOR}${datasourceId}${exports.SEPARATOR}${(0, newid_1.default)()}`;
-}
-exports.generateQueryID = generateQueryID;
-/**
- * Generates a metadata ID for automations, used to track errors in recurring
- * automations etc.
- */
-function generateAutomationMetadataID(automationId) {
-    return `${exports.DocumentType.AUTOMATION_METADATA}${exports.SEPARATOR}${automationId}`;
-}
-exports.generateAutomationMetadataID = generateAutomationMetadataID;
-/**
- * Retrieve all automation metadata in an app database.
- */
-function getAutomationMetadataParams(otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.AUTOMATION_METADATA, null, otherProps);
-}
-exports.getAutomationMetadataParams = getAutomationMetadataParams;
-/**
- * Gets parameters for retrieving a query, this is a utility function for the getDocParams function.
- */
-function getQueryParams(datasourceId, otherProps = {}) {
-    if (datasourceId == null) {
-        return (0, exports.getDocParams)(exports.DocumentType.QUERY, null, otherProps);
-    }
-    return (0, exports.getDocParams)(exports.DocumentType.QUERY, `${datasourceId}${exports.SEPARATOR}`, otherProps);
-}
-exports.getQueryParams = getQueryParams;
-/**
- * Generates a new flag document ID.
- * @returns {string} The ID of the flag document that was generated.
- */
-function generateUserFlagID(userId) {
-    return `${exports.DocumentType.USER_FLAG}${exports.SEPARATOR}${userId}`;
-}
-exports.generateUserFlagID = generateUserFlagID;
-function generateMetadataID(type, entityId) {
-    return `${exports.DocumentType.METADATA}${exports.SEPARATOR}${type}${exports.SEPARATOR}${entityId}`;
-}
-exports.generateMetadataID = generateMetadataID;
-function getMetadataParams(type, entityId, otherProps = {}) {
-    let docId = `${type}${exports.SEPARATOR}`;
-    if (entityId != null) {
-        docId += entityId;
-    }
-    return (0, exports.getDocParams)(exports.DocumentType.METADATA, docId, otherProps);
-}
-exports.getMetadataParams = getMetadataParams;
-function generateMemoryViewID(viewName) {
-    return `${exports.DocumentType.MEM_VIEW}${exports.SEPARATOR}${viewName}`;
-}
-exports.generateMemoryViewID = generateMemoryViewID;
-function getMemoryViewParams(otherProps = {}) {
-    return (0, exports.getDocParams)(exports.DocumentType.MEM_VIEW, null, otherProps);
-}
-exports.getMemoryViewParams = getMemoryViewParams;
-function generatePluginID(name) {
-    return `${exports.DocumentType.PLUGIN}${exports.SEPARATOR}${name}`;
-}
-exports.generatePluginID = generatePluginID;
-/**
- * This can be used with the db.allDocs to get a list of IDs
- */
-function getMultiIDParams(ids) {
-    return {
-        keys: ids,
-        include_docs: true,
-    };
-}
-exports.getMultiIDParams = getMultiIDParams;