joye-backend-utility 7.2.13 → 7.3.1

package/dist/config/notificationBucket.d.ts

@@ -0,0 +1,6 @@
+/** Inner hash range per platform segment (each segment has 1000 slots). */
+export declare const BUCKET_SEGMENT_SPAN = 1000;
+/** Deterministic value in `0 .. modulus-1` (default segment span 1000). */
+export declare function stableBucketFromEmployeeId(employeeId: string, modulus?: number): number;
+/** Stored bucket = segment base + inner hash in `[0, BUCKET_SEGMENT_SPAN)`. */
+export declare function notificationBucketFromSegmentBase(employeeId: string, segmentBase: number): number;

package/dist/config/notificationBucket.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notificationBucketFromSegmentBase = exports.stableBucketFromEmployeeId = exports.BUCKET_SEGMENT_SPAN = void 0;
+const crypto_1 = require("crypto");
+/** Inner hash range per platform segment (each segment has 1000 slots). */
+exports.BUCKET_SEGMENT_SPAN = 1000;
+/** Deterministic value in `0 .. modulus-1` (default segment span 1000). */
+function stableBucketFromEmployeeId(employeeId, modulus = exports.BUCKET_SEGMENT_SPAN) {
+    const m = Math.max(2, Math.floor(modulus));
+    const h = crypto_1.default.createHash('sha256').update(employeeId, 'utf8').digest();
+    return h.readUInt32BE(0) % m;
+}
+exports.stableBucketFromEmployeeId = stableBucketFromEmployeeId;
+/** Stored bucket = segment base + inner hash in `[0, BUCKET_SEGMENT_SPAN)`. */
+function notificationBucketFromSegmentBase(employeeId, segmentBase) {
+    return segmentBase + stableBucketFromEmployeeId(employeeId, exports.BUCKET_SEGMENT_SPAN);
+}
+exports.notificationBucketFromSegmentBase = notificationBucketFromSegmentBase;

package/dist/config/notificationBucketSegmentRules.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Platform → segment base (added before `hash(employeeId) % 1000` for stored `User.bucket`).
+ *
+ * Only platforms listed in **`DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM`** get a `bucket`.
+ * Keys are matched **case-insensitively** to `Organization.platformKey`. Anything else → no bucket.
+ */
+/** Edit this object only — add one entry per platform that should participate in notification sharding. */
+export declare const DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM: Record<string, number>;
+export declare function getBucketSegmentMapping(): Record<string, number>;
+export declare function segmentBaseForPlatformKey(orgPlatformKey: string, mapping: Record<string, number>): number | null;
+/** Segment base if `platformKey` is in the map; otherwise `null` (do not set `User.bucket`). */
+export declare function resolveBucketSegmentBase(orgPlatformKey: string): number | null;

package/dist/config/notificationBucketSegmentRules.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * Platform → segment base (added before `hash(employeeId) % 1000` for stored `User.bucket`).
+ *
+ * Only platforms listed in **`DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM`** get a `bucket`.
+ * Keys are matched **case-insensitively** to `Organization.platformKey`. Anything else → no bucket.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveBucketSegmentBase = exports.segmentBaseForPlatformKey = exports.getBucketSegmentMapping = exports.DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM = void 0;
+/** Edit this object only — add one entry per platform that should participate in notification sharding. */
+exports.DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM = {
+    teams: 0,
+    visit: 1000,
+    medibuddy: 3000,
+};
+function lowercaseKeys(map) {
+    const out = {};
+    for (const [k, v] of Object.entries(map)) {
+        if (typeof v === 'number' && Number.isFinite(v) && v >= 0) {
+            out[k.toLowerCase()] = v;
+        }
+    }
+    return out;
+}
+const BUCKET_SEGMENT_MAPPING = lowercaseKeys(Object.assign({}, exports.DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM));
+function getBucketSegmentMapping() {
+    return BUCKET_SEGMENT_MAPPING;
+}
+exports.getBucketSegmentMapping = getBucketSegmentMapping;
+function segmentBaseForPlatformKey(orgPlatformKey, mapping) {
+    const k = String(orgPlatformKey || '')
+        .trim()
+        .toLowerCase();
+    if (!k)
+        return null;
+    if (Object.prototype.hasOwnProperty.call(mapping, k))
+        return mapping[k];
+    return null;
+}
+exports.segmentBaseForPlatformKey = segmentBaseForPlatformKey;
+/** Segment base if `platformKey` is in the map; otherwise `null` (do not set `User.bucket`). */
+function resolveBucketSegmentBase(orgPlatformKey) {
+    return segmentBaseForPlatformKey(orgPlatformKey, getBucketSegmentMapping());
+}
+exports.resolveBucketSegmentBase = resolveBucketSegmentBase;

package/dist/index.d.ts

@@ -4,3 +4,5 @@ export { createHashPassword, createUuid } from './util';
 export { createToken, jwtVerify } from './jwt';
 export { getPreviousWorkday, get2ndLastPreviousWorkday, addDays, addMinutes, addYears, getCurrentDateTime, getCurrentUtcTime, newDate, getDatesBetweenRange, getMoment, getCurrentEpoch, } from './dateTime';
 export { RedisClient } from './redisClient';
+export { DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM, getBucketSegmentMapping, segmentBaseForPlatformKey, resolveBucketSegmentBase, } from './config/notificationBucketSegmentRules';
+export { BUCKET_SEGMENT_SPAN, stableBucketFromEmployeeId, notificationBucketFromSegmentBase } from './config/notificationBucket';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisClient = exports.getCurrentEpoch = exports.getMoment = exports.getDatesBetweenRange = exports.newDate = exports.getCurrentUtcTime = exports.getCurrentDateTime = exports.addYears = exports.addMinutes = exports.addDays = exports.get2ndLastPreviousWorkday = exports.getPreviousWorkday = exports.jwtVerify = exports.createToken = exports.createUuid = exports.createHashPassword = void 0;
+exports.notificationBucketFromSegmentBase = exports.stableBucketFromEmployeeId = exports.BUCKET_SEGMENT_SPAN = exports.resolveBucketSegmentBase = exports.segmentBaseForPlatformKey = exports.getBucketSegmentMapping = exports.DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM = exports.RedisClient = exports.getCurrentEpoch = exports.getMoment = exports.getDatesBetweenRange = exports.newDate = exports.getCurrentUtcTime = exports.getCurrentDateTime = exports.addYears = exports.addMinutes = exports.addDays = exports.get2ndLastPreviousWorkday = exports.getPreviousWorkday = exports.jwtVerify = exports.createToken = exports.createUuid = exports.createHashPassword = void 0;
 const database_1 = require("./database");
 exports.default = database_1.default;
 var util_1 = require("./util");
@@ -24,3 +24,12 @@ Object.defineProperty(exports, "getMoment", { enumerable: true, get: function ()
 Object.defineProperty(exports, "getCurrentEpoch", { enumerable: true, get: function () { return dateTime_1.getCurrentEpoch; } });
 var redisClient_1 = require("./redisClient");
 Object.defineProperty(exports, "RedisClient", { enumerable: true, get: function () { return redisClient_1.RedisClient; } });
+var notificationBucketSegmentRules_1 = require("./config/notificationBucketSegmentRules");
+Object.defineProperty(exports, "DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM", { enumerable: true, get: function () { return notificationBucketSegmentRules_1.DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM; } });
+Object.defineProperty(exports, "getBucketSegmentMapping", { enumerable: true, get: function () { return notificationBucketSegmentRules_1.getBucketSegmentMapping; } });
+Object.defineProperty(exports, "segmentBaseForPlatformKey", { enumerable: true, get: function () { return notificationBucketSegmentRules_1.segmentBaseForPlatformKey; } });
+Object.defineProperty(exports, "resolveBucketSegmentBase", { enumerable: true, get: function () { return notificationBucketSegmentRules_1.resolveBucketSegmentBase; } });
+var notificationBucket_1 = require("./config/notificationBucket");
+Object.defineProperty(exports, "BUCKET_SEGMENT_SPAN", { enumerable: true, get: function () { return notificationBucket_1.BUCKET_SEGMENT_SPAN; } });
+Object.defineProperty(exports, "stableBucketFromEmployeeId", { enumerable: true, get: function () { return notificationBucket_1.stableBucketFromEmployeeId; } });
+Object.defineProperty(exports, "notificationBucketFromSegmentBase", { enumerable: true, get: function () { return notificationBucket_1.notificationBucketFromSegmentBase; } });

package/dist/schema/masterTraining.js

@@ -79,5 +79,20 @@ const MasterTraining = new mongoose_1.Schema({
         default: '',
         index: true,
     },
+    dailyWelcome: {
+        type: String,
+        required: false,
+        default: '',
+    },
+    weeklyWelcome: {
+        type: String,
+        required: false,
+        default: '',
+    },
+    monthlyWelcome: {
+        type: String,
+        required: false,
+        default: '',
+    },
 });
 exports.MasterTrainingSchema = MasterTraining;

package/dist/schema/masterTrainingDays.js

@@ -26,6 +26,11 @@ const MasterTrainingDays = new mongoose_1.Schema({
         type: String,
         required: false,
     },
+    welcomeMessage: {
+        type: String,
+        required: false,
+        default: '',
+    },
 });
 MasterTrainingDays.index({ trainingKey: 1, day: 1 });
 exports.MasterTrainingDaysSchema = MasterTrainingDays;

package/dist/schema/user.js

@@ -205,6 +205,16 @@ const User = new mongoose_1.Schema({
         type: Array,
         required: false,
     },
+    /**
+     * Stable shard index: segment base from `DEFAULT_BUCKET_SEGMENT_BASE_BY_PLATFORM` + hash(employeeId)%1000; see BUCKET_SHARDING.md.
+     * Schedulers filter `bucket` in [BUCKET_MIN, BUCKET_MAX]; omit field for platforms without notification sharding.
+     */
+    bucket: {
+        type: Number,
+        required: false,
+        min: 0,
+        index: true,
+    },
 });
 User.index({ employeeId: 1 }, {
     unique: true,
@@ -218,4 +228,7 @@ User.index({ organizationId: 1, botDetails: -1 }, {
 User.index({ botDetails: 1, organizationId: -1, preferredTimezone: -1 }, {
     unique: false,
 });
+User.index({ bucket: 1, botDetails: 1 }, {
+    unique: false,
+});
 exports.UserSchema = User;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joye-backend-utility",
-  "version": "7.2.13",
+  "version": "7.3.1",
   "description": "Joye backend utility for db functions and common functions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",