@budibase/backend-core 3.2.41 → 3.2.43

package/dist/src/errors/errors.js

@@ -0,0 +1,97 @@
+"use strict";
+// BASE
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailUnavailableError = exports.InvalidAPIKeyError = exports.FeatureDisabledError = exports.UsageLimitError = exports.BadRequestError = exports.NotFoundError = exports.HTTPError = exports.getPublicError = exports.ErrorCode = exports.BudibaseError = void 0;
+class BudibaseError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+    }
+}
+exports.BudibaseError = BudibaseError;
+// ERROR HANDLING
+var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode["USAGE_LIMIT_EXCEEDED"] = "usage_limit_exceeded";
+    ErrorCode["FEATURE_DISABLED"] = "feature_disabled";
+    ErrorCode["INVALID_API_KEY"] = "invalid_api_key";
+    ErrorCode["HTTP"] = "http";
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
+/**
+ * For the given error, build the public representation that is safe
+ * to be exposed over an api.
+ */
+const getPublicError = (err) => {
+    let error;
+    if (err.code) {
+        // add generic error information
+        error = {
+            code: err.code,
+        };
+        if (err.getPublicError) {
+            error = Object.assign(Object.assign({}, error), err.getPublicError());
+        }
+    }
+    return error;
+};
+exports.getPublicError = getPublicError;
+// HTTP
+class HTTPError extends BudibaseError {
+    constructor(message, httpStatus, code = ErrorCode.HTTP) {
+        super(message, code);
+        this.status = httpStatus;
+    }
+}
+exports.HTTPError = HTTPError;
+class NotFoundError extends HTTPError {
+    constructor(message) {
+        super(message, 404);
+    }
+}
+exports.NotFoundError = NotFoundError;
+class BadRequestError extends HTTPError {
+    constructor(message) {
+        super(message, 400);
+    }
+}
+exports.BadRequestError = BadRequestError;
+// LICENSING
+class UsageLimitError extends HTTPError {
+    constructor(message, limitName) {
+        super(message, 400, ErrorCode.USAGE_LIMIT_EXCEEDED);
+        this.limitName = limitName;
+    }
+    getPublicError() {
+        return {
+            limitName: this.limitName,
+        };
+    }
+}
+exports.UsageLimitError = UsageLimitError;
+class FeatureDisabledError extends HTTPError {
+    constructor(message, featureName) {
+        super(message, 400, ErrorCode.FEATURE_DISABLED);
+        this.featureName = featureName;
+    }
+    getPublicError() {
+        return {
+            featureName: this.featureName,
+        };
+    }
+}
+exports.FeatureDisabledError = FeatureDisabledError;
+// AUTH
+class InvalidAPIKeyError extends BudibaseError {
+    constructor() {
+        super("Invalid API key - may need re-generated, or user doesn't exist", ErrorCode.INVALID_API_KEY);
+    }
+}
+exports.InvalidAPIKeyError = InvalidAPIKeyError;
+// USERS
+class EmailUnavailableError extends Error {
+    constructor(email) {
+        super(`Email already in use: '${email}'`);
+    }
+}
+exports.EmailUnavailableError = EmailUnavailableError;
+//# sourceMappingURL=errors.js.map

package/dist/src/errors/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/errors/errors.ts"],"names":[],"mappings":";AAAA,OAAO;;;AAEP,MAAsB,aAAc,SAAQ,KAAK;IAG/C,YAAY,OAAe,EAAE,IAAe;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CAGF;AATD,sCASC;AAED,iBAAiB;AAEjB,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,0DAA6C,CAAA;IAC7C,kDAAqC,CAAA;IACrC,gDAAmC,CAAA;IACnC,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAED;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAE,EAAE;IACzC,IAAI,KAAK,CAAA;IACT,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QACb,gCAAgC;QAChC,KAAK,GAAG;YACN,IAAI,EAAE,GAAG,CAAC,IAAI;SACf,CAAA;QAED,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;YACvB,KAAK,mCACA,KAAK,GAEL,GAAG,CAAC,cAAc,EAAE,CACxB,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAlBY,QAAA,cAAc,kBAkB1B;AAED,OAAO;AAEP,MAAa,SAAU,SAAQ,aAAa;IAG1C,YAAY,OAAe,EAAE,UAAkB,EAAE,IAAI,GAAG,SAAS,CAAC,IAAI;QACpE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;IAC1B,CAAC;CACF;AAPD,8BAOC;AAED,MAAa,aAAc,SAAQ,SAAS;IAC1C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;IACrB,CAAC;CACF;AAJD,sCAIC;AAED,MAAa,eAAgB,SAAQ,SAAS;IAC5C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;IACrB,CAAC;CACF;AAJD,0CAIC;AAED,YAAY;AAEZ,MAAa,eAAgB,SAAQ,SAAS;IAG5C,YAAY,OAAe,EAAE,SAAiB;QAC5C,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAA;QACnD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED,cAAc;QACZ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAA;IACH,CAAC;CACF;AAbD,0CAaC;AAED,MAAa,oBAAqB,SAAQ,SAAS;IAGjD,YAAY,OAAe,EAAE,WAAmB;QAC9C,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED,cAAc;QACZ,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAA;IACH,CAAC;CACF;AAbD,oDAaC;AAED,OAAO;AAEP,MAAa,kBAAmB,SAAQ,aAAa;IACnD;QACE,KAAK,CACH,gEAAgE,EAChE,SAAS,CAAC,eAAe,CAC1B,CAAA;IACH,CAAC;CACF;AAPD,gDAOC;AAED,QAAQ;AAER,MAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,KAAa;QACvB,KAAK,CAAC,0BAA0B,KAAK,GAAG,CAAC,CAAA;IAC3C,CAAC;CACF;AAJD,sDAIC"}

package/dist/src/errors/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB"}

package/dist/src/events/analytics.js

@@ -0,0 +1,52 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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.enabled = void 0;
+const configs = __importStar(require("../configs"));
+// wrapper utility function
+const enabled = () => __awaiter(void 0, void 0, void 0, function* () {
+    return configs.analyticsEnabled();
+});
+exports.enabled = enabled;
+//# sourceMappingURL=analytics.js.map

package/dist/src/events/analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/events/analytics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAErC,2BAA2B;AACpB,MAAM,OAAO,GAAG,GAAS,EAAE;IAChC,OAAO,OAAO,CAAC,gBAAgB,EAAE,CAAA;AACnC,CAAC,CAAA,CAAA;AAFY,QAAA,OAAO,WAEnB"}

package/dist/src/events/asyncEvents/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./queue"), exports);
+__exportStar(require("./publisher"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/events/asyncEvents/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/events/asyncEvents/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,8CAA2B"}

package/dist/src/events/asyncEvents/publisher.js

@@ -0,0 +1,26 @@
+"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.publishAsyncEvent = publishAsyncEvent;
+const types_1 = require("@budibase/types");
+const queue_1 = require("./queue");
+function publishAsyncEvent(payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!queue_1.asyncEventQueue) {
+            (0, queue_1.init)();
+        }
+        const { event, identity } = payload;
+        if (types_1.AsyncEvents.indexOf(event) !== -1 && identity.tenantId) {
+            yield queue_1.asyncEventQueue.add(payload);
+        }
+    });
+}
+//# sourceMappingURL=publisher.js.map

package/dist/src/events/asyncEvents/publisher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publisher.js","sourceRoot":"","sources":["../../../../src/events/asyncEvents/publisher.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,8CAQC;AAXD,2CAA6C;AAC7C,mCAA6D;AAE7D,SAAsB,iBAAiB,CAAC,OAAqB;;QAC3D,IAAI,CAAC,uBAAe,EAAE,CAAC;YACrB,IAAA,YAAI,GAAE,CAAA;QACR,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAA;QACnC,IAAI,mBAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC3D,MAAM,uBAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;CAAA"}

package/dist/src/events/asyncEvents/queue.js

@@ -0,0 +1,26 @@
+"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.asyncEventQueue = void 0;
+exports.init = init;
+exports.shutdown = shutdown;
+const queue_1 = require("../../queue");
+function init() {
+    exports.asyncEventQueue = (0, queue_1.createQueue)(queue_1.JobQueue.SYSTEM_EVENT_QUEUE);
+}
+function shutdown() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (exports.asyncEventQueue) {
+            yield exports.asyncEventQueue.close();
+        }
+    });
+}
+//# sourceMappingURL=queue.js.map

package/dist/src/events/asyncEvents/queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.js","sourceRoot":"","sources":["../../../../src/events/asyncEvents/queue.ts"],"names":[],"mappings":";;;;;;;;;;;;AAaA,oBAEC;AAED,4BAIC;AApBD,uCAAmD;AAYnD,SAAgB,IAAI;IAClB,uBAAe,GAAG,IAAA,mBAAW,EAAe,gBAAQ,CAAC,kBAAkB,CAAC,CAAA;AAC1E,CAAC;AAED,SAAsB,QAAQ;;QAC5B,IAAI,uBAAe,EAAE,CAAC;YACpB,MAAM,uBAAe,CAAC,KAAK,EAAE,CAAA;QAC/B,CAAC;IACH,CAAC;CAAA"}

package/dist/src/events/backfill.js

@@ -0,0 +1,189 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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.isAlreadySent = exports.isBackfillingEvent = exports.end = exports.recordEvent = exports.start = void 0;
+const types_1 = require("@budibase/types");
+const context = __importStar(require("../context"));
+const generic_1 = require("../cache/generic");
+const cache = __importStar(require("../cache/generic"));
+// LIFECYCLE
+const start = (events) => __awaiter(void 0, void 0, void 0, function* () {
+    const metadata = {
+        eventWhitelist: events,
+    };
+    return saveBackfillMetadata(metadata);
+});
+exports.start = start;
+const recordEvent = (event, properties) => __awaiter(void 0, void 0, void 0, function* () {
+    const eventKey = getEventKey(event, properties);
+    // don't use a ttl - cleaned up by migration
+    // don't use tenancy - already in the key
+    yield cache.store(eventKey, properties, undefined, { useTenancy: false });
+});
+exports.recordEvent = recordEvent;
+const end = () => __awaiter(void 0, void 0, void 0, function* () {
+    yield deleteBackfillMetadata();
+    yield clearEvents();
+});
+exports.end = end;
+// CRUD
+const getBackfillMetadata = () => __awaiter(void 0, void 0, void 0, function* () {
+    return cache.get(generic_1.CacheKey.BACKFILL_METADATA);
+});
+const saveBackfillMetadata = (backfill) => __awaiter(void 0, void 0, void 0, function* () {
+    // no TTL - deleted by backfill
+    return cache.store(generic_1.CacheKey.BACKFILL_METADATA, backfill);
+});
+const deleteBackfillMetadata = () => __awaiter(void 0, void 0, void 0, function* () {
+    yield cache.destroy(generic_1.CacheKey.BACKFILL_METADATA);
+});
+const clearEvents = () => __awaiter(void 0, void 0, void 0, function* () {
+    // wildcard
+    const pattern = getEventKey();
+    const keys = yield cache.keys(pattern);
+    for (const key of keys) {
+        // delete each key
+        // don't  use tenancy, already in the key
+        yield cache.destroy(key, { useTenancy: false });
+    }
+});
+// HELPERS
+const isBackfillingEvent = (event) => __awaiter(void 0, void 0, void 0, function* () {
+    const backfill = yield getBackfillMetadata();
+    const events = backfill === null || backfill === void 0 ? void 0 : backfill.eventWhitelist;
+    if (events && events.includes(event)) {
+        return true;
+    }
+    else {
+        return false;
+    }
+});
+exports.isBackfillingEvent = isBackfillingEvent;
+const isAlreadySent = (event, properties) => __awaiter(void 0, void 0, void 0, function* () {
+    const eventKey = getEventKey(event, properties);
+    const cachedEvent = yield cache.get(eventKey, {
+        useTenancy: false,
+    });
+    return !!cachedEvent;
+});
+exports.isAlreadySent = isAlreadySent;
+const CUSTOM_PROPERTY_SUFFIX = {
+    // APP EVENTS
+    [types_1.Event.AUTOMATION_CREATED]: (properties) => {
+        return properties.automationId;
+    },
+    [types_1.Event.AUTOMATION_STEP_CREATED]: (properties) => {
+        return properties.stepId;
+    },
+    [types_1.Event.DATASOURCE_CREATED]: (properties) => {
+        return properties.datasourceId;
+    },
+    [types_1.Event.LAYOUT_CREATED]: (properties) => {
+        return properties.layoutId;
+    },
+    [types_1.Event.QUERY_CREATED]: (properties) => {
+        return properties.queryId;
+    },
+    [types_1.Event.ROLE_CREATED]: (properties) => {
+        return properties.roleId;
+    },
+    [types_1.Event.SCREEN_CREATED]: (properties) => {
+        return properties.screenId;
+    },
+    [types_1.Event.TABLE_CREATED]: (properties) => {
+        return properties.tableId;
+    },
+    [types_1.Event.VIEW_CREATED]: (properties) => {
+        return properties.tableId; // best uniqueness
+    },
+    [types_1.Event.VIEW_CALCULATION_CREATED]: (properties) => {
+        return properties.tableId; // best uniqueness
+    },
+    [types_1.Event.VIEW_FILTER_CREATED]: (properties) => {
+        return properties.tableId; // best uniqueness
+    },
+    [types_1.Event.APP_CREATED]: (properties) => {
+        return properties.appId; // best uniqueness
+    },
+    [types_1.Event.APP_PUBLISHED]: (properties) => {
+        return properties.appId; // best uniqueness
+    },
+    // GLOBAL EVENTS
+    [types_1.Event.AUTH_SSO_CREATED]: (properties) => {
+        return properties.type;
+    },
+    [types_1.Event.AUTH_SSO_ACTIVATED]: (properties) => {
+        return properties.type;
+    },
+    [types_1.Event.USER_CREATED]: (properties) => {
+        return properties.userId;
+    },
+    [types_1.Event.USER_PERMISSION_ADMIN_ASSIGNED]: (properties) => {
+        return properties.userId;
+    },
+    [types_1.Event.USER_PERMISSION_BUILDER_ASSIGNED]: (properties) => {
+        return properties.userId;
+    },
+    [types_1.Event.ROLE_ASSIGNED]: (properties) => {
+        return `${properties.roleId}-${properties.userId}`;
+    },
+};
+const getEventKey = (event, properties) => {
+    let eventKey;
+    const tenantId = context.getTenantId();
+    if (event) {
+        eventKey = `${generic_1.CacheKey.EVENTS}:${tenantId}:${event}`;
+        // use some properties to make the key more unique
+        const custom = CUSTOM_PROPERTY_SUFFIX[event];
+        const suffix = custom ? custom(properties) : undefined;
+        if (suffix) {
+            eventKey = `${eventKey}:${suffix}`;
+        }
+    }
+    else {
+        eventKey = `${generic_1.CacheKey.EVENTS}:${tenantId}:*`;
+    }
+    return eventKey;
+};
+//# sourceMappingURL=backfill.js.map

package/dist/src/events/backfill.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backfill.js","sourceRoot":"","sources":["../../../src/events/backfill.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAqBwB;AACxB,oDAAqC;AACrC,8CAA2C;AAC3C,wDAAyC;AAEzC,YAAY;AAEL,MAAM,KAAK,GAAG,CAAO,MAAe,EAAE,EAAE;IAC7C,MAAM,QAAQ,GAAqB;QACjC,cAAc,EAAE,MAAM;KACvB,CAAA;IACD,OAAO,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AACvC,CAAC,CAAA,CAAA;AALY,QAAA,KAAK,SAKjB;AAEM,MAAM,WAAW,GAAG,CAAO,KAAY,EAAE,UAAe,EAAE,EAAE;IACjE,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IAC/C,4CAA4C;IAC5C,yCAAyC;IACzC,MAAM,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;AAC3E,CAAC,CAAA,CAAA;AALY,QAAA,WAAW,eAKvB;AAEM,MAAM,GAAG,GAAG,GAAS,EAAE;IAC5B,MAAM,sBAAsB,EAAE,CAAA;IAC9B,MAAM,WAAW,EAAE,CAAA;AACrB,CAAC,CAAA,CAAA;AAHY,QAAA,GAAG,OAGf;AAED,OAAO;AAEP,MAAM,mBAAmB,GAAG,GAA2C,EAAE;IACvE,OAAO,KAAK,CAAC,GAAG,CAAC,kBAAQ,CAAC,iBAAiB,CAAC,CAAA;AAC9C,CAAC,CAAA,CAAA;AAED,MAAM,oBAAoB,GAAG,CAC3B,QAA0B,EACX,EAAE;IACjB,+BAA+B;IAC/B,OAAO,KAAK,CAAC,KAAK,CAAC,kBAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;AAC1D,CAAC,CAAA,CAAA;AAED,MAAM,sBAAsB,GAAG,GAAwB,EAAE;IACvD,MAAM,KAAK,CAAC,OAAO,CAAC,kBAAQ,CAAC,iBAAiB,CAAC,CAAA;AACjD,CAAC,CAAA,CAAA;AAED,MAAM,WAAW,GAAG,GAAS,EAAE;IAC7B,WAAW;IACX,MAAM,OAAO,GAAG,WAAW,EAAE,CAAA;IAC7B,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAEtC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,kBAAkB;QAClB,yCAAyC;QACzC,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;IACjD,CAAC;AACH,CAAC,CAAA,CAAA;AAED,UAAU;AAEH,MAAM,kBAAkB,GAAG,CAAO,KAAY,EAAE,EAAE;IACvD,MAAM,QAAQ,GAAG,MAAM,mBAAmB,EAAE,CAAA;IAC5C,MAAM,MAAM,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc,CAAA;IACvC,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA,CAAA;AARY,QAAA,kBAAkB,sBAQ9B;AAEM,MAAM,aAAa,GAAG,CAAO,KAAY,EAAE,UAAe,EAAE,EAAE;IACnE,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IAC/C,MAAM,WAAW,GAAgB,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;QACzD,UAAU,EAAE,KAAK;KAClB,CAAC,CAAA;IACF,OAAO,CAAC,CAAC,WAAW,CAAA;AACtB,CAAC,CAAA,CAAA;AANY,QAAA,aAAa,iBAMzB;AAED,MAAM,sBAAsB,GAAQ;IAClC,aAAa;IACb,CAAC,aAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,UAAkC,EAAE,EAAE;QACjE,OAAO,UAAU,CAAC,YAAY,CAAA;IAChC,CAAC;IACD,CAAC,aAAK,CAAC,uBAAuB,CAAC,EAAE,CAAC,UAAsC,EAAE,EAAE;QAC1E,OAAO,UAAU,CAAC,MAAM,CAAA;IAC1B,CAAC;IACD,CAAC,aAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,UAAkC,EAAE,EAAE;QACjE,OAAO,UAAU,CAAC,YAAY,CAAA;IAChC,CAAC;IACD,CAAC,aAAK,CAAC,cAAc,CAAC,EAAE,CAAC,UAA8B,EAAE,EAAE;QACzD,OAAO,UAAU,CAAC,QAAQ,CAAA;IAC5B,CAAC;IACD,CAAC,aAAK,CAAC,aAAa,CAAC,EAAE,CAAC,UAA6B,EAAE,EAAE;QACvD,OAAO,UAAU,CAAC,OAAO,CAAA;IAC3B,CAAC;IACD,CAAC,aAAK,CAAC,YAAY,CAAC,EAAE,CAAC,UAA4B,EAAE,EAAE;QACrD,OAAO,UAAU,CAAC,MAAM,CAAA;IAC1B,CAAC;IACD,CAAC,aAAK,CAAC,cAAc,CAAC,EAAE,CAAC,UAA8B,EAAE,EAAE;QACzD,OAAO,UAAU,CAAC,QAAQ,CAAA;IAC5B,CAAC;IACD,CAAC,aAAK,CAAC,aAAa,CAAC,EAAE,CAAC,UAA6B,EAAE,EAAE;QACvD,OAAO,UAAU,CAAC,OAAO,CAAA;IAC3B,CAAC;IACD,CAAC,aAAK,CAAC,YAAY,CAAC,EAAE,CAAC,UAA4B,EAAE,EAAE;QACrD,OAAO,UAAU,CAAC,OAAO,CAAA,CAAC,kBAAkB;IAC9C,CAAC;IACD,CAAC,aAAK,CAAC,wBAAwB,CAAC,EAAE,CAChC,UAAuC,EACvC,EAAE;QACF,OAAO,UAAU,CAAC,OAAO,CAAA,CAAC,kBAAkB;IAC9C,CAAC;IACD,CAAC,aAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC,UAAkC,EAAE,EAAE;QAClE,OAAO,UAAU,CAAC,OAAO,CAAA,CAAC,kBAAkB;IAC9C,CAAC;IACD,CAAC,aAAK,CAAC,WAAW,CAAC,EAAE,CAAC,UAA2B,EAAE,EAAE;QACnD,OAAO,UAAU,CAAC,KAAK,CAAA,CAAC,kBAAkB;IAC5C,CAAC;IACD,CAAC,aAAK,CAAC,aAAa,CAAC,EAAE,CAAC,UAA6B,EAAE,EAAE;QACvD,OAAO,UAAU,CAAC,KAAK,CAAA,CAAC,kBAAkB;IAC5C,CAAC;IACD,gBAAgB;IAChB,CAAC,aAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,UAA2B,EAAE,EAAE;QACxD,OAAO,UAAU,CAAC,IAAI,CAAA;IACxB,CAAC;IACD,CAAC,aAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,UAA2B,EAAE,EAAE;QAC1D,OAAO,UAAU,CAAC,IAAI,CAAA;IACxB,CAAC;IACD,CAAC,aAAK,CAAC,YAAY,CAAC,EAAE,CAAC,UAA4B,EAAE,EAAE;QACrD,OAAO,UAAU,CAAC,MAAM,CAAA;IAC1B,CAAC;IACD,CAAC,aAAK,CAAC,8BAA8B,CAAC,EAAE,CACtC,UAAuC,EACvC,EAAE;QACF,OAAO,UAAU,CAAC,MAAM,CAAA;IAC1B,CAAC;IACD,CAAC,aAAK,CAAC,gCAAgC,CAAC,EAAE,CACxC,UAAuC,EACvC,EAAE;QACF,OAAO,UAAU,CAAC,MAAM,CAAA;IAC1B,CAAC;IACD,CAAC,aAAK,CAAC,aAAa,CAAC,EAAE,CAAC,UAA6B,EAAE,EAAE;QACvD,OAAO,GAAG,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE,CAAA;IACpD,CAAC;CACF,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,UAAgB,EAAE,EAAE;IACtD,IAAI,QAAgB,CAAA;IAEpB,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAA;IACtC,IAAI,KAAK,EAAE,CAAC;QACV,QAAQ,GAAG,GAAG,kBAAQ,CAAC,MAAM,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAA;QAEpD,kDAAkD;QAClD,MAAM,MAAM,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAA;QAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACtD,IAAI,MAAM,EAAE,CAAC;YACX,QAAQ,GAAG,GAAG,QAAQ,IAAI,MAAM,EAAE,CAAA;QACpC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,GAAG,kBAAQ,CAAC,MAAM,IAAI,QAAQ,IAAI,CAAA;IAC/C,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA"}

package/dist/src/events/events.js

@@ -0,0 +1,87 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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.publishEvent = void 0;
+const processors_1 = require("./processors");
+const identification_1 = __importDefault(require("./identification"));
+const backfill = __importStar(require("./backfill"));
+const asyncEvents_1 = require("./asyncEvents");
+const publishEvent = (event, properties, timestamp, identityOverride) => __awaiter(void 0, void 0, void 0, function* () {
+    // in future this should use async events via a distributed queue.
+    const identity = identityOverride || (yield identification_1.default.getCurrentIdentity());
+    // Backfilling is get from the user cache, but when we override the identity cache is not available. Overrides are
+    // normally performed in automatic actions or operations in async flows (BPM) where the user session is not available.
+    const backfilling = identityOverride
+        ? false
+        : yield backfill.isBackfillingEvent(event);
+    // no backfill - send the event and exit
+    if (!backfilling) {
+        // send off async events if required
+        yield (0, asyncEvents_1.publishAsyncEvent)({
+            event,
+            identity,
+            properties,
+            timestamp,
+        });
+        // now handle the main sync event processing pipeline
+        yield processors_1.processors.processEvent(event, identity, properties, timestamp);
+        return;
+    }
+    // backfill active - check if the event has been sent already
+    const alreadySent = yield backfill.isAlreadySent(event, properties);
+    if (alreadySent) {
+        // do nothing
+        return;
+    }
+    else {
+        // send and record the event
+        yield processors_1.processors.processEvent(event, identity, properties, timestamp);
+        yield backfill.recordEvent(event, properties);
+    }
+});
+exports.publishEvent = publishEvent;
+//# sourceMappingURL=events.js.map

package/dist/src/events/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/events/events.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAAyC;AACzC,sEAA6C;AAC7C,qDAAsC;AACtC,+CAAiD;AAE1C,MAAM,YAAY,GAAG,CAC1B,KAAY,EACZ,UAAe,EACf,SAA2B,EAC3B,gBAA2B,EAC3B,EAAE;IACF,kEAAkE;IAClE,MAAM,QAAQ,GACZ,gBAAgB,IAAI,CAAC,MAAM,wBAAc,CAAC,kBAAkB,EAAE,CAAC,CAAA;IAEjE,kHAAkH;IAClH,sHAAsH;IACtH,MAAM,WAAW,GAAG,gBAAgB;QAClC,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,MAAM,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAE5C,wCAAwC;IACxC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,oCAAoC;QACpC,MAAM,IAAA,+BAAiB,EAAC;YACtB,KAAK;YACL,QAAQ;YACR,UAAU;YACV,SAAS;SACV,CAAC,CAAA;QACF,qDAAqD;QACrD,MAAM,uBAAU,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QACrE,OAAM;IACR,CAAC;IAED,6DAA6D;IAC7D,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IACnE,IAAI,WAAW,EAAE,CAAC;QAChB,aAAa;QACb,OAAM;IACR,CAAC;SAAM,CAAC;QACN,4BAA4B;QAC5B,MAAM,uBAAU,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QACrE,MAAM,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IAC/C,CAAC;AACH,CAAC,CAAA,CAAA;AAxCY,QAAA,YAAY,gBAwCxB"}