@budibase/server 1.2.37 → 1.2.39-alpha.1

package/dist/db/utils.js

@@ -1,13 +1,13 @@
 "use strict";
 const newid = require("./newid");
-const { DocumentTypes: CoreDocTypes, getRoleParams, generateRoleID, APP_DEV_PREFIX, APP_PREFIX, SEPARATOR, StaticDatabases, isDevAppID, isProdAppID, getDevelopmentAppID, generateAppID, getQueryIndex, ViewNames, } = require("@budibase/backend-core/db");
+const { DocumentType: CoreDocTypes, getRoleParams, generateRoleID, APP_DEV_PREFIX, APP_PREFIX, SEPARATOR, StaticDatabases, isDevAppID, isProdAppID, getDevelopmentAppID, generateAppID, getQueryIndex, ViewName, } = require("@budibase/backend-core/db");
 const UNICODE_MAX = "\ufff0";
 const AppStatus = {
     DEV: "development",
     ALL: "all",
     DEPLOYED: "published",
 };
-const DocumentTypes = Object.assign(Object.assign({}, CoreDocTypes), { TABLE: "ta", ROW: "ro", USER: "us", AUTOMATION: "au", LINK: "li", WEBHOOK: "wh", INSTANCE: "inst", LAYOUT: "layout", SCREEN: "screen", DATASOURCE: "datasource", DATASOURCE_PLUS: "datasource_plus", QUERY: "query", DEPLOYMENTS: "deployments", METADATA: "metadata", MEM_VIEW: "view", USER_FLAG: "flag", AUTOMATION_METADATA: "meta_au" });
+const DocumentType = Object.assign(Object.assign({}, CoreDocTypes), { TABLE: "ta", ROW: "ro", USER: "us", AUTOMATION: "au", LINK: "li", WEBHOOK: "wh", INSTANCE: "inst", LAYOUT: "layout", SCREEN: "screen", DATASOURCE: "datasource", DATASOURCE_PLUS: "datasource_plus", QUERY: "query", DEPLOYMENTS: "deployments", METADATA: "metadata", MEM_VIEW: "view", USER_FLAG: "flag", AUTOMATION_METADATA: "meta_au" });
 const InternalTables = {
     USER_METADATA: "ta_users",
 };
@@ -26,12 +26,12 @@ exports.APP_PREFIX = APP_PREFIX;
 exports.APP_DEV_PREFIX = APP_DEV_PREFIX;
 exports.isDevAppID = isDevAppID;
 exports.isProdAppID = isProdAppID;
-exports.USER_METDATA_PREFIX = `${DocumentTypes.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`;
-exports.LINK_USER_METADATA_PREFIX = `${DocumentTypes.LINK}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`;
-exports.TABLE_ROW_PREFIX = `${DocumentTypes.ROW}${SEPARATOR}${DocumentTypes.TABLE}`;
-exports.ViewNames = ViewNames;
+exports.USER_METDATA_PREFIX = `${DocumentType.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`;
+exports.LINK_USER_METADATA_PREFIX = `${DocumentType.LINK}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`;
+exports.TABLE_ROW_PREFIX = `${DocumentType.ROW}${SEPARATOR}${DocumentType.TABLE}`;
+exports.ViewName = ViewName;
 exports.InternalTables = InternalTables;
-exports.DocumentTypes = DocumentTypes;
+exports.DocumentType = DocumentType;
 exports.SEPARATOR = SEPARATOR;
 exports.UNICODE_MAX = UNICODE_MAX;
 exports.SearchIndexes = SearchIndexes;
@@ -65,14 +65,14 @@ exports.getDocParams = getDocParams;
  * Gets parameters for retrieving tables, this is a utility function for the getDocParams function.
  */
 exports.getTableParams = (tableId = null, otherProps = {}) => {
-    return getDocParams(DocumentTypes.TABLE, tableId, otherProps);
+    return getDocParams(DocumentType.TABLE, tableId, otherProps);
 };
 /**
  * Generates a new table ID.
  * @returns {string} The new table ID which the table doc can be stored under.
  */
 exports.generateTableID = () => {
-    return `${DocumentTypes.TABLE}${SEPARATOR}${newid()}`;
+    return `${DocumentType.TABLE}${SEPARATOR}${newid()}`;
 };
 /**
  * Gets the DB allDocs/query params for retrieving a row.
@@ -84,10 +84,10 @@ exports.generateTableID = () => {
  */
 exports.getRowParams = (tableId = null, rowId = null, otherProps = {}) => {
     if (tableId == null) {
-        return getDocParams(DocumentTypes.ROW, null, otherProps);
+        return getDocParams(DocumentType.ROW, null, otherProps);
     }
     const endOfKey = rowId == null ? `${tableId}${SEPARATOR}` : rowId;
-    return getDocParams(DocumentTypes.ROW, endOfKey, otherProps);
+    return getDocParams(DocumentType.ROW, endOfKey, otherProps);
 };
 /**
  * Given a row ID this will find the table ID within it (only works for internal tables).
@@ -96,9 +96,9 @@ exports.getRowParams = (tableId = null, rowId = null, otherProps = {}) => {
  */
 exports.getTableIDFromRowID = rowId => {
     const components = rowId
-        .split(DocumentTypes.TABLE + SEPARATOR)[1]
+        .split(DocumentType.TABLE + SEPARATOR)[1]
         .split(SEPARATOR);
-    return `${DocumentTypes.TABLE}${SEPARATOR}${components[0]}`;
+    return `${DocumentType.TABLE}${SEPARATOR}${components[0]}`;
 };
 /**
  * Gets a new row ID for the specified table.
@@ -108,7 +108,7 @@ exports.getTableIDFromRowID = rowId => {
  */
 exports.generateRowID = (tableId, id = null) => {
     id = id || newid();
-    return `${DocumentTypes.ROW}${SEPARATOR}${tableId}${SEPARATOR}${id}`;
+    return `${DocumentType.ROW}${SEPARATOR}${tableId}${SEPARATOR}${id}`;
 };
 /**
  * Gets parameters for retrieving users, this is a utility function for the getDocParams function.
@@ -128,7 +128,7 @@ exports.generateUserMetadataID = globalId => {
  * Breaks up the ID to get the global ID.
  */
 exports.getGlobalIDFromUserMetadataID = id => {
-    const prefix = `${DocumentTypes.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`;
+    const prefix = `${DocumentType.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`;
     if (!id || !id.includes(prefix)) {
         return id;
     }
@@ -138,14 +138,14 @@ exports.getGlobalIDFromUserMetadataID = id => {
  * Gets parameters for retrieving automations, this is a utility function for the getDocParams function.
  */
 exports.getAutomationParams = (automationId = null, otherProps = {}) => {
-    return getDocParams(DocumentTypes.AUTOMATION, automationId, otherProps);
+    return getDocParams(DocumentType.AUTOMATION, automationId, otherProps);
 };
 /**
  * Generates a new automation ID.
  * @returns {string} The new automation ID which the automation doc can be stored under.
  */
 exports.generateAutomationID = () => {
-    return `${DocumentTypes.AUTOMATION}${SEPARATOR}${newid()}`;
+    return `${DocumentType.AUTOMATION}${SEPARATOR}${newid()}`;
 };
 /**
  * Generates a new link doc ID. This is currently not usable with the alldocs call,
@@ -162,117 +162,117 @@ exports.generateLinkID = (tableId1, tableId2, rowId1, rowId2, fieldName1, fieldN
     const tables = `${SEPARATOR}${tableId1}${SEPARATOR}${tableId2}`;
     const rows = `${SEPARATOR}${rowId1}${SEPARATOR}${rowId2}`;
     const fields = `${SEPARATOR}${fieldName1}${SEPARATOR}${fieldName2}`;
-    return `${DocumentTypes.LINK}${tables}${rows}${fields}`;
+    return `${DocumentType.LINK}${tables}${rows}${fields}`;
 };
 /**
  * Gets parameters for retrieving link docs, this is a utility function for the getDocParams function.
  */
 exports.getLinkParams = (otherProps = {}) => {
-    return getDocParams(DocumentTypes.LINK, null, otherProps);
+    return getDocParams(DocumentType.LINK, null, otherProps);
 };
 /**
  * Generates a new layout ID.
  * @returns {string} The new layout ID which the layout doc can be stored under.
  */
 exports.generateLayoutID = id => {
-    return `${DocumentTypes.LAYOUT}${SEPARATOR}${id || newid()}`;
+    return `${DocumentType.LAYOUT}${SEPARATOR}${id || newid()}`;
 };
 /**
  * Gets parameters for retrieving layout, this is a utility function for the getDocParams function.
  */
 exports.getLayoutParams = (layoutId = null, otherProps = {}) => {
-    return getDocParams(DocumentTypes.LAYOUT, layoutId, otherProps);
+    return getDocParams(DocumentType.LAYOUT, layoutId, otherProps);
 };
 /**
  * Generates a new screen ID.
  * @returns {string} The new screen ID which the screen doc can be stored under.
  */
 exports.generateScreenID = () => {
-    return `${DocumentTypes.SCREEN}${SEPARATOR}${newid()}`;
+    return `${DocumentType.SCREEN}${SEPARATOR}${newid()}`;
 };
 /**
  * Gets parameters for retrieving screens, this is a utility function for the getDocParams function.
  */
 exports.getScreenParams = (screenId = null, otherProps = {}) => {
-    return getDocParams(DocumentTypes.SCREEN, screenId, otherProps);
+    return getDocParams(DocumentType.SCREEN, screenId, otherProps);
 };
 /**
  * Generates a new webhook ID.
  * @returns {string} The new webhook ID which the webhook doc can be stored under.
  */
 exports.generateWebhookID = () => {
-    return `${DocumentTypes.WEBHOOK}${SEPARATOR}${newid()}`;
+    return `${DocumentType.WEBHOOK}${SEPARATOR}${newid()}`;
 };
 /**
  * Gets parameters for retrieving a webhook, this is a utility function for the getDocParams function.
  */
 exports.getWebhookParams = (webhookId = null, otherProps = {}) => {
-    return getDocParams(DocumentTypes.WEBHOOK, webhookId, otherProps);
+    return getDocParams(DocumentType.WEBHOOK, webhookId, otherProps);
 };
 /**
  * Generates a new datasource ID.
  * @returns {string} The new datasource ID which the webhook doc can be stored under.
  */
 exports.generateDatasourceID = ({ plus = false } = {}) => {
-    return `${plus ? DocumentTypes.DATASOURCE_PLUS : DocumentTypes.DATASOURCE}${SEPARATOR}${newid()}`;
+    return `${plus ? DocumentType.DATASOURCE_PLUS : DocumentType.DATASOURCE}${SEPARATOR}${newid()}`;
 };
 /**
  * Gets parameters for retrieving a datasource, this is a utility function for the getDocParams function.
  */
 exports.getDatasourceParams = (datasourceId = null, otherProps = {}) => {
-    return getDocParams(DocumentTypes.DATASOURCE, datasourceId, otherProps);
+    return getDocParams(DocumentType.DATASOURCE, datasourceId, otherProps);
 };
 /**
  * Generates a new query ID.
  * @returns {string} The new query ID which the query doc can be stored under.
  */
 exports.generateQueryID = datasourceId => {
-    return `${DocumentTypes.QUERY}${SEPARATOR}${datasourceId}${SEPARATOR}${newid()}`;
+    return `${DocumentType.QUERY}${SEPARATOR}${datasourceId}${SEPARATOR}${newid()}`;
 };
 /**
  * Generates a metadata ID for automations, used to track errors in recurring
  * automations etc.
  */
 exports.generateAutomationMetadataID = automationId => {
-    return `${DocumentTypes.AUTOMATION_METADATA}${SEPARATOR}${automationId}`;
+    return `${DocumentType.AUTOMATION_METADATA}${SEPARATOR}${automationId}`;
 };
 /**
  * Retrieve all automation metadata in an app database.
  */
 exports.getAutomationMetadataParams = (otherProps = {}) => {
-    return getDocParams(DocumentTypes.AUTOMATION_METADATA, null, otherProps);
+    return getDocParams(DocumentType.AUTOMATION_METADATA, null, otherProps);
 };
 /**
  * Gets parameters for retrieving a query, this is a utility function for the getDocParams function.
  */
 exports.getQueryParams = (datasourceId = null, otherProps = {}) => {
     if (datasourceId == null) {
-        return getDocParams(DocumentTypes.QUERY, null, otherProps);
+        return getDocParams(DocumentType.QUERY, null, otherProps);
     }
-    return getDocParams(DocumentTypes.QUERY, `${datasourceId}${SEPARATOR}`, otherProps);
+    return getDocParams(DocumentType.QUERY, `${datasourceId}${SEPARATOR}`, otherProps);
 };
 /**
  * Generates a new flag document ID.
  * @returns {string} The ID of the flag document that was generated.
  */
 exports.generateUserFlagID = userId => {
-    return `${DocumentTypes.USER_FLAG}${SEPARATOR}${userId}`;
+    return `${DocumentType.USER_FLAG}${SEPARATOR}${userId}`;
 };
 exports.generateMetadataID = (type, entityId) => {
-    return `${DocumentTypes.METADATA}${SEPARATOR}${type}${SEPARATOR}${entityId}`;
+    return `${DocumentType.METADATA}${SEPARATOR}${type}${SEPARATOR}${entityId}`;
 };
 exports.getMetadataParams = (type, entityId = null, otherProps = {}) => {
     let docId = `${type}${SEPARATOR}`;
     if (entityId != null) {
         docId += entityId;
     }
-    return getDocParams(DocumentTypes.METADATA, docId, otherProps);
+    return getDocParams(DocumentType.METADATA, docId, otherProps);
 };
 exports.generateMemoryViewID = viewName => {
-    return `${DocumentTypes.MEM_VIEW}${SEPARATOR}${viewName}`;
+    return `${DocumentType.MEM_VIEW}${SEPARATOR}${viewName}`;
 };
 exports.getMemoryViewParams = (otherProps = {}) => {
-    return getDocParams(DocumentTypes.MEM_VIEW, null, otherProps);
+    return getDocParams(DocumentType.MEM_VIEW, null, otherProps);
 };
 /**
  * This can be used with the db.allDocs to get a list of IDs

package/dist/db/views/staticViews.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 const { getAppDB } = require("@budibase/backend-core/context");
-const { DocumentTypes, SEPARATOR, ViewNames, SearchIndexes, } = require("../utils");
-const SCREEN_PREFIX = DocumentTypes.SCREEN + SEPARATOR;
+const { DocumentType, SEPARATOR, ViewName, SearchIndexes } = require("../utils");
+const SCREEN_PREFIX = DocumentType.SCREEN + SEPARATOR;
 /**************************************************
  *                  INFORMATION                   *
  * This file exists purely to keep views separate *
@@ -54,7 +54,7 @@ exports.createLinkView = () => __awaiter(void 0, void 0, void 0, function* () {
             }
         }.toString(),
     };
-    designDoc.views = Object.assign(Object.assign({}, designDoc.views), { [ViewNames.LINK]: view });
+    designDoc.views = Object.assign(Object.assign({}, designDoc.views), { [ViewName.LINK]: view });
     yield db.put(designDoc);
 });
 exports.createRoutingView = () => __awaiter(void 0, void 0, void 0, function* () {
@@ -71,7 +71,7 @@ exports.createRoutingView = () => __awaiter(void 0, void 0, void 0, function* ()
       }
     }`,
     };
-    designDoc.views = Object.assign(Object.assign({}, designDoc.views), { [ViewNames.ROUTING]: view });
+    designDoc.views = Object.assign(Object.assign({}, designDoc.views), { [ViewName.ROUTING]: view });
     yield db.put(designDoc);
 });
 function searchIndex(indexName, fnString) {

package/dist/definitions/automations.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoopStepTypes = void 0;
-var LoopStepTypes;
-(function (LoopStepTypes) {
-    LoopStepTypes["ARRAY"] = "Array";
-    LoopStepTypes["STRING"] = "String";
-})(LoopStepTypes = exports.LoopStepTypes || (exports.LoopStepTypes = {}));
+exports.LoopStepType = void 0;
+var LoopStepType;
+(function (LoopStepType) {
+    LoopStepType["ARRAY"] = "Array";
+    LoopStepType["STRING"] = "String";
+})(LoopStepType = exports.LoopStepType || (exports.LoopStepType = {}));

package/dist/definitions/datasource.js

@@ -1,75 +1,11 @@
 "use strict";
+/********************************************
+ * This file contains structures which are  *
+ * internal to the server and don't need to *
+ * be exposed for use by other services.    *
+ ********************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthType = exports.FilterTypes = exports.IncludeRelationships = exports.SourceNames = exports.DatasourceFieldTypes = exports.QueryTypes = exports.SortDirection = exports.Operation = void 0;
-var Operation;
-(function (Operation) {
-    Operation["CREATE"] = "CREATE";
-    Operation["READ"] = "READ";
-    Operation["UPDATE"] = "UPDATE";
-    Operation["DELETE"] = "DELETE";
-    Operation["BULK_CREATE"] = "BULK_CREATE";
-    Operation["CREATE_TABLE"] = "CREATE_TABLE";
-    Operation["UPDATE_TABLE"] = "UPDATE_TABLE";
-    Operation["DELETE_TABLE"] = "DELETE_TABLE";
-})(Operation = exports.Operation || (exports.Operation = {}));
-var SortDirection;
-(function (SortDirection) {
-    SortDirection["ASCENDING"] = "ASCENDING";
-    SortDirection["DESCENDING"] = "DESCENDING";
-})(SortDirection = exports.SortDirection || (exports.SortDirection = {}));
-var QueryTypes;
-(function (QueryTypes) {
-    QueryTypes["SQL"] = "sql";
-    QueryTypes["JSON"] = "json";
-    QueryTypes["FIELDS"] = "fields";
-})(QueryTypes = exports.QueryTypes || (exports.QueryTypes = {}));
-var DatasourceFieldTypes;
-(function (DatasourceFieldTypes) {
-    DatasourceFieldTypes["STRING"] = "string";
-    DatasourceFieldTypes["LONGFORM"] = "longForm";
-    DatasourceFieldTypes["BOOLEAN"] = "boolean";
-    DatasourceFieldTypes["NUMBER"] = "number";
-    DatasourceFieldTypes["PASSWORD"] = "password";
-    DatasourceFieldTypes["LIST"] = "list";
-    DatasourceFieldTypes["OBJECT"] = "object";
-    DatasourceFieldTypes["JSON"] = "json";
-    DatasourceFieldTypes["FILE"] = "file";
-})(DatasourceFieldTypes = exports.DatasourceFieldTypes || (exports.DatasourceFieldTypes = {}));
-var SourceNames;
-(function (SourceNames) {
-    SourceNames["POSTGRES"] = "POSTGRES";
-    SourceNames["DYNAMODB"] = "DYNAMODB";
-    SourceNames["MONGODB"] = "MONGODB";
-    SourceNames["ELASTICSEARCH"] = "ELASTICSEARCH";
-    SourceNames["COUCHDB"] = "COUCHDB";
-    SourceNames["SQL_SERVER"] = "SQL_SERVER";
-    SourceNames["S3"] = "S3";
-    SourceNames["AIRTABLE"] = "AIRTABLE";
-    SourceNames["MYSQL"] = "MYSQL";
-    SourceNames["ARANGODB"] = "ARANGODB";
-    SourceNames["REST"] = "REST";
-    SourceNames["ORACLE"] = "ORACLE";
-    SourceNames["GOOGLE_SHEETS"] = "GOOGLE_SHEETS";
-    SourceNames["FIRESTORE"] = "FIRESTORE";
-    SourceNames["REDIS"] = "REDIS";
-    SourceNames["SNOWFLAKE"] = "SNOWFLAKE";
-})(SourceNames = exports.SourceNames || (exports.SourceNames = {}));
-var IncludeRelationships;
-(function (IncludeRelationships) {
-    IncludeRelationships[IncludeRelationships["INCLUDE"] = 1] = "INCLUDE";
-    IncludeRelationships[IncludeRelationships["EXCLUDE"] = 0] = "EXCLUDE";
-})(IncludeRelationships = exports.IncludeRelationships || (exports.IncludeRelationships = {}));
-var FilterTypes;
-(function (FilterTypes) {
-    FilterTypes["STRING"] = "string";
-    FilterTypes["FUZZY"] = "fuzzy";
-    FilterTypes["RANGE"] = "range";
-    FilterTypes["EQUAL"] = "equal";
-    FilterTypes["NOT_EQUAL"] = "notEqual";
-    FilterTypes["EMPTY"] = "empty";
-    FilterTypes["NOT_EMPTY"] = "notEmpty";
-    FilterTypes["ONE_OF"] = "oneOf";
-})(FilterTypes = exports.FilterTypes || (exports.FilterTypes = {}));
+exports.AuthType = void 0;
 var AuthType;
 (function (AuthType) {
     AuthType["BASIC"] = "basic";

package/dist/integrations/airtable.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const datasource_1 = require("../definitions/datasource");
+const types_1 = require("@budibase/types");
 var AirtableModule;
 (function (AirtableModule) {
     const Airtable = require("airtable");
@@ -20,61 +20,61 @@ var AirtableModule;
         type: "Spreadsheet",
         datasource: {
             apiKey: {
-                type: datasource_1.DatasourceFieldTypes.PASSWORD,
+                type: types_1.DatasourceFieldType.PASSWORD,
                 default: "enter api key",
                 required: true,
             },
             base: {
-                type: datasource_1.DatasourceFieldTypes.STRING,
+                type: types_1.DatasourceFieldType.STRING,
                 default: "mybase",
                 required: true,
             },
         },
         query: {
             create: {
-                type: datasource_1.QueryTypes.FIELDS,
+                type: types_1.QueryType.FIELDS,
                 customisable: true,
                 fields: {
                     table: {
-                        type: datasource_1.DatasourceFieldTypes.STRING,
+                        type: types_1.DatasourceFieldType.STRING,
                         required: true,
                     },
                 },
             },
             read: {
-                type: datasource_1.QueryTypes.FIELDS,
+                type: types_1.QueryType.FIELDS,
                 fields: {
                     table: {
-                        type: datasource_1.DatasourceFieldTypes.STRING,
+                        type: types_1.DatasourceFieldType.STRING,
                         required: true,
                     },
                     view: {
-                        type: datasource_1.DatasourceFieldTypes.STRING,
+                        type: types_1.DatasourceFieldType.STRING,
                         required: true,
                     },
                     numRecords: {
-                        type: datasource_1.DatasourceFieldTypes.NUMBER,
+                        type: types_1.DatasourceFieldType.NUMBER,
                         default: 10,
                     },
                 },
             },
             update: {
-                type: datasource_1.QueryTypes.FIELDS,
+                type: types_1.QueryType.FIELDS,
                 customisable: true,
                 fields: {
                     id: {
                         display: "Record ID",
-                        type: datasource_1.DatasourceFieldTypes.STRING,
+                        type: types_1.DatasourceFieldType.STRING,
                         required: true,
                     },
                     table: {
-                        type: datasource_1.DatasourceFieldTypes.STRING,
+                        type: types_1.DatasourceFieldType.STRING,
                         required: true,
                     },
                 },
             },
             delete: {
-                type: datasource_1.QueryTypes.JSON,
+                type: types_1.QueryType.JSON,
             },
         },
     };

package/dist/integrations/arangodb.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const datasource_1 = require("../definitions/datasource");
+const types_1 = require("@budibase/types");
 var ArangoModule;
 (function (ArangoModule) {
     const { Database, aql } = require("arangojs");
@@ -20,35 +20,35 @@ var ArangoModule;
         description: "ArangoDB is a scalable open-source multi-model database natively supporting graph, document and search. All supported data models & access patterns can be combined in queries allowing for maximal flexibility. ",
         datasource: {
             url: {
-                type: datasource_1.DatasourceFieldTypes.STRING,
+                type: types_1.DatasourceFieldType.STRING,
                 default: "http://localhost:8529",
                 required: true,
             },
             username: {
-                type: datasource_1.DatasourceFieldTypes.STRING,
+                type: types_1.DatasourceFieldType.STRING,
                 default: "root",
                 required: true,
             },
             password: {
-                type: datasource_1.DatasourceFieldTypes.PASSWORD,
+                type: types_1.DatasourceFieldType.PASSWORD,
                 required: true,
             },
             databaseName: {
-                type: datasource_1.DatasourceFieldTypes.STRING,
+                type: types_1.DatasourceFieldType.STRING,
                 default: "_system",
                 required: true,
             },
             collection: {
-                type: datasource_1.DatasourceFieldTypes.STRING,
+                type: types_1.DatasourceFieldType.STRING,
                 required: true,
             },
         },
         query: {
             read: {
-                type: datasource_1.QueryTypes.SQL,
+                type: types_1.QueryType.SQL,
             },
             create: {
-                type: datasource_1.QueryTypes.JSON,
+                type: types_1.QueryType.JSON,
             },
         },
     };

package/dist/integrations/base/query.js

@@ -0,0 +1,27 @@
+"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.makeExternalQuery = void 0;
+const { integrations } = require("../index");
+function makeExternalQuery(datasource, json) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const Integration = integrations[datasource.source];
+        // query is the opinionated function
+        if (Integration.prototype.query) {
+            const integration = new Integration(datasource.config);
+            return integration.query(json);
+        }
+        else {
+            throw "Datasource does not support query.";
+        }
+    });
+}
+exports.makeExternalQuery = makeExternalQuery;