@b2y/ecommerce-common 1.4.2 → 1.4.4

package/constants/AuditConstants.js

@@ -0,0 +1,16 @@
+const AuditConstants = {
+  EVENT_TYPE: {
+    CREATE: 'CREATE',
+    UPDATE: 'UPDATE',
+    DELETE: 'DELETE',
+  },
+  ENTITY_NAME: {
+    TENANT: 'Tenant',
+    TENANT_SETTINGS: 'TenantSettings',
+    TENANT_SUBSCRIPTION: 'TenantSubscription',
+    MULTI_TENANT_USER: 'MultiTenantUser',
+    SUBSCRIPTION_PLAN: 'SubscriptionPlan',
+  },
+};
+
+module.exports = AuditConstants;

package/index.js

@@ -7,6 +7,7 @@ const TenantSettingsAbstractController = require('./controller/TenantSettingsAbs
 const LocationController = require('./controller/LocationController');
 const CommonAppConstants = require('./constants/AppConstants');
 const CommonStatusMessage = require('./constants/StatusMessageConstants');
+const AuditConstants = require('./constants/AuditConstants');
 const QueryBuilder = require('./scripts/QueryBuilder');
 const enums = {};
 const enumDir = path.join(__dirname, 'enum');
@@ -25,4 +26,4 @@ fs.readdirSync(utilDir).forEach((file) => {
   }
 })
 
-module.exports = {initializeModels, enums, utils, CommonAppConstants, CommonStatusMessage, SubscriptionAbstractController, TenantAbstractController, TenantSettingsAbstractController, LocationController, QueryBuilder};
+module.exports = {initializeModels, enums, utils, CommonAppConstants, CommonStatusMessage, AuditConstants, SubscriptionAbstractController, TenantAbstractController, TenantSettingsAbstractController, LocationController, QueryBuilder};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@b2y/ecommerce-common",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "description": "E-commerce common library",
   "main": "index.js",
   "scripts": {

package/utility/ThemeColourUtil.js

@@ -0,0 +1,26 @@
+// Brand colour used for {{themeColour}} in transactional email templates
+// (the header band / accent colour) whenever a tenant hasn't set their own
+// TenantSettings.ThemeColour yet.
+const DEFAULT_THEME_COLOUR = '#FFFFFF';
+
+/**
+ * Resolve the brand colour to use for a tenant's transactional emails.
+ *
+ * TenantSettings is passed in (not required here) because each service owns
+ * its own Sequelize connection/model instance - same dependency-injection
+ * convention as TenantSettingsAbstractController.
+ *
+ * @param {object} TenantSettings   the caller's own TenantSettings Sequelize model
+ * @param {string} [tenantId]       tenant to look up (omit for a platform/admin-only send - resolves straight to the default)
+ * @param {string} [override]       explicit colour that skips the TenantSettings lookup entirely
+ * @returns {Promise<string>}       override, else the tenant's TenantSettings.ThemeColour, else DEFAULT_THEME_COLOUR
+ */
+const resolveThemeColour = async (TenantSettings, tenantId, override) => {
+  if (override) return override;
+  if (!tenantId) return DEFAULT_THEME_COLOUR;
+
+  const settings = await TenantSettings.findOne({ where: { TenantID: tenantId } }).catch(() => null);
+  return settings?.ThemeColour || DEFAULT_THEME_COLOUR;
+};
+
+module.exports = { DEFAULT_THEME_COLOUR, resolveThemeColour };