codebase-models 2.1.23 → 2.1.25

package/dist/index.d.ts

@@ -72,9 +72,9 @@ import Environment from "./src/models/Environment";
 import PrecalculationFilters from "./src/models/PrecalculationFilters";
 import BqPreCompiledData from "./src/models/BqPreCompiledData";
 import CustomQuery from "./src/models/CustomQuery";
-import { generateRandomIID } from "./src/constant";
+import { generateRandomIID, RolesConstants } from "./src/constant";
 import TestTimeline from "./src/models/TestTimeline";
 import CronData from "./src/models/CronData";
 import CronConfig from "./src/models/CronConfig";
 export declare function connect(uri: string, options?: mongoose.ConnectOptions | undefined): Promise<typeof mongoose>;
-export { generateRandomIID, Client, ClientReportsTemp, QueryLog, Report, Test, TestSequentialValue, User, AppEvent, Announcement, ClientAdditionalRevenue, ClientLearning, ClientLinks, ClientNextStep, ClientNote, ClientRetention, ClientStrategy, ClientSurvey, CVRReport, Faq, Feedback, Goal, Hypothesis, HypothesisSheet, LandingPages, NewIdeas, Notification, Page, PageElement, PageTestType, Portfolio, ReadNotification, Role, CustomQuery, SavedSegment, TestTimeline, Segment, SegmentCombination, Snippet, StageInCustomerJourney, Tag, Temp, Tier, Trigger, ClientScript, Audience, Environment, Organization, PrecalculationFilters, BqPreCompiledData, CronData, CronConfig, UserPermission };
+export { generateRandomIID, RolesConstants, Client, ClientReportsTemp, QueryLog, Report, Test, TestSequentialValue, User, AppEvent, Announcement, ClientAdditionalRevenue, ClientLearning, ClientLinks, ClientNextStep, ClientNote, ClientRetention, ClientStrategy, ClientSurvey, CVRReport, Faq, Feedback, Goal, Hypothesis, HypothesisSheet, LandingPages, NewIdeas, Notification, Page, PageElement, PageTestType, Portfolio, ReadNotification, Role, CustomQuery, SavedSegment, TestTimeline, Segment, SegmentCombination, Snippet, StageInCustomerJourney, Tag, Temp, Tier, Trigger, ClientScript, Audience, Environment, Organization, PrecalculationFilters, BqPreCompiledData, CronData, CronConfig, UserPermission, };

package/dist/index.js

@@ -12,8 +12,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrecalculationFilters = exports.Organization = exports.Environment = exports.Audience = exports.ClientScript = exports.Trigger = exports.Tier = exports.Temp = exports.Tag = exports.StageInCustomerJourney = exports.Snippet = exports.SegmentCombination = exports.Segment = exports.TestTimeline = exports.SavedSegment = exports.CustomQuery = exports.Role = exports.ReadNotification = exports.Portfolio = exports.PageTestType = exports.PageElement = exports.Page = exports.Notification = exports.NewIdeas = exports.LandingPages = exports.HypothesisSheet = exports.Hypothesis = exports.Goal = exports.Feedback = exports.Faq = exports.CVRReport = exports.ClientSurvey = exports.ClientStrategy = exports.ClientRetention = exports.ClientNote = exports.ClientNextStep = exports.ClientLinks = exports.ClientLearning = exports.ClientAdditionalRevenue = exports.Announcement = exports.AppEvent = exports.User = exports.TestSequentialValue = exports.Test = exports.Report = exports.QueryLog = exports.ClientReportsTemp = exports.Client = exports.generateRandomIID = exports.connect = void 0;
-exports.UserPermission = exports.CronConfig = exports.CronData = exports.BqPreCompiledData = void 0;
+exports.Organization = exports.Environment = exports.Audience = exports.ClientScript = exports.Trigger = exports.Tier = exports.Temp = exports.Tag = exports.StageInCustomerJourney = exports.Snippet = exports.SegmentCombination = exports.Segment = exports.TestTimeline = exports.SavedSegment = exports.CustomQuery = exports.Role = exports.ReadNotification = exports.Portfolio = exports.PageTestType = exports.PageElement = exports.Page = exports.Notification = exports.NewIdeas = exports.LandingPages = exports.HypothesisSheet = exports.Hypothesis = exports.Goal = exports.Feedback = exports.Faq = exports.CVRReport = exports.ClientSurvey = exports.ClientStrategy = exports.ClientRetention = exports.ClientNote = exports.ClientNextStep = exports.ClientLinks = exports.ClientLearning = exports.ClientAdditionalRevenue = exports.Announcement = exports.AppEvent = exports.User = exports.TestSequentialValue = exports.Test = exports.Report = exports.QueryLog = exports.ClientReportsTemp = exports.Client = exports.RolesConstants = exports.generateRandomIID = exports.connect = void 0;
+exports.UserPermission = exports.CronConfig = exports.CronData = exports.BqPreCompiledData = exports.PrecalculationFilters = void 0;
 const mongoose_1 = __importDefault(require("mongoose"));
 const Client_1 = __importDefault(require("./src/models/Client"));
 exports.Client = Client_1.default;
@@ -115,6 +115,7 @@ const CustomQuery_1 = __importDefault(require("./src/models/CustomQuery"));
 exports.CustomQuery = CustomQuery_1.default;
 const constant_1 = require("./src/constant");
 Object.defineProperty(exports, "generateRandomIID", { enumerable: true, get: function () { return constant_1.generateRandomIID; } });
+Object.defineProperty(exports, "RolesConstants", { enumerable: true, get: function () { return constant_1.RolesConstants; } });
 const TestTimeline_1 = __importDefault(require("./src/models/TestTimeline"));
 exports.TestTimeline = TestTimeline_1.default;
 const CronData_1 = __importDefault(require("./src/models/CronData"));
@@ -124,8 +125,8 @@ exports.CronConfig = CronConfig_1.default;
 function seedRoles() {
     return __awaiter(this, void 0, void 0, function* () {
         const checkRoles = yield Role_1.default.countDocuments();
-        if (checkRoles < 5) {
-            Promise.all(["USER", "ADMIN", "EDITOR", "OPTIMIZER", "CLIENT", "EXTERNAL"].map((name) => {
+        if (checkRoles < constant_1.RolesConstants.length) {
+            Promise.all(constant_1.RolesConstants.map((name) => {
                 Role_1.default.bulkWrite([
                     {
                         updateOne: {

package/dist/src/constant.d.ts

@@ -8,11 +8,12 @@ declare const HypothesisSheetConstants: {
     MEDIUM: number;
     GOOD: number;
 };
+declare const RolesConstants: string[];
 /**
  * Generates a random unique identifier
  * @returns A 12-character uppercase string (increased from 8 for better uniqueness)
  * @throws Error if UUID generation fails
  */
 declare const generateRandomIID: () => string;
-export { generateRandomIID };
+export { generateRandomIID, RolesConstants };
 export default HypothesisSheetConstants;

package/dist/src/constant.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateRandomIID = void 0;
+exports.RolesConstants = exports.generateRandomIID = void 0;
 const uuid_1 = require("uuid");
 const HypothesisSheetConstants = {
     NO: 0,
@@ -14,6 +14,17 @@ const HypothesisSheetConstants = {
     MEDIUM: 1,
     GOOD: 2,
 };
+const RolesConstants = [
+    "USER",
+    "ADMIN",
+    // "EDITOR",
+    // "COLLABORATOR",
+    "CLIENT",
+    "EXTERNAL",
+    "QA",
+    "OPTIMIZER",
+];
+exports.RolesConstants = RolesConstants;
 /**
  * Generates a random unique identifier
  * @returns A 12-character uppercase string (increased from 8 for better uniqueness)
@@ -22,10 +33,10 @@ const HypothesisSheetConstants = {
 const generateRandomIID = () => {
     try {
         // Take first 12 characters instead of 8 for better uniqueness
-        return (0, uuid_1.v4)().replace(/-/g, '').substring(0, 12).toUpperCase();
+        return (0, uuid_1.v4)().replace(/-/g, "").substring(0, 12).toUpperCase();
     }
     catch (error) {
-        throw new Error(`Failed to generate random IID: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        throw new Error(`Failed to generate random IID: ${error instanceof Error ? error.message : "Unknown error"}`);
     }
 };
 exports.generateRandomIID = generateRandomIID;

package/dist/src/models/ClientScript.d.ts

@@ -29,15 +29,12 @@ export interface IClientScript extends Document {
     client?: mongoose.Schema.Types.ObjectId;
     adhere_dnt: Boolean;
     allow_in_iframes: Boolean;
-    viewId?: string;
-    clientScriptURL: string;
     jquery_include: string;
     debug: Boolean;
     restrict_debug: Boolean;
     max_cookie_lifetime: Number;
     activation_mode: string;
     use_antiflicker: Boolean;
-    snippet_revision: Number;
     snippet_version: Number;
     rules: string;
     rules_tracking: string;
@@ -60,6 +57,7 @@ export interface IClientScript extends Document {
     goalsEnabled: Boolean;
     optedOut: Boolean;
     liveEventListenersSet: Boolean;
+    active: Boolean;
 }
 declare const ClientScript: mongoose.Model<any, {}, {}, {}, any, any>;
 export default ClientScript;

package/dist/src/models/ClientScript.js

@@ -48,13 +48,6 @@ const ClientScriptSchema = new mongoose_1.Schema({
         type: mongoose_1.default.Schema.Types.ObjectId,
         ref: "client",
     },
-    viewId: {
-        type: String,
-    },
-    clientScriptURL: {
-        type: String,
-        trim: true,
-    },
     jquery_include: {
         type: String,
         default: "false",
@@ -83,10 +76,6 @@ const ClientScriptSchema = new mongoose_1.Schema({
         type: Boolean,
         default: false,
     },
-    snippet_revision: {
-        type: Number,
-        default: 1,
-    },
     rules: {
         type: String,
         default: "return true;",
@@ -175,6 +164,10 @@ const ClientScriptSchema = new mongoose_1.Schema({
         type: Boolean,
         default: false,
     },
+    active: {
+        type: Boolean,
+        default: true,
+    },
 }, {
     timestamps: true,
 });
@@ -197,8 +190,5 @@ ClientScriptSchema.pre('save', function (next) {
 ClientScriptSchema.index({ iid: 1 }, { unique: true });
 // Compound indexes for common query patterns
 ClientScriptSchema.index({ client: 1 });
-// Sparse indexes for optional fields
-ClientScriptSchema.index({ organisationId: 1 }, { sparse: true });
-ClientScriptSchema.index({ asset_url: 1 }, { sparse: true });
 const ClientScript = mongoose_1.default.models.clientscript || (0, mongoose_1.model)("clientscript", ClientScriptSchema);
 exports.default = ClientScript;

package/dist/src/models/Role.js

@@ -29,7 +29,16 @@ const RoleSchema = new mongoose_1.Schema({
         type: String,
         unique: true,
         required: true,
-        enum: ["USER", "ADMIN", "EDITOR", "COLLABORATOR", "CLIENT", "EXTERNAL"],
+        enum: [
+            "USER",
+            "ADMIN",
+            "EDITOR",
+            "COLLABORATOR",
+            "CLIENT",
+            "EXTERNAL",
+            "QA",
+            "OPTIMIZER",
+        ],
         trim: true,
         uppercase: true,
     },
@@ -56,12 +65,12 @@ const RoleSchema = new mongoose_1.Schema({
         cvrReports: { type: Boolean, default: true },
         manageExperiments: { type: Boolean, default: true },
         dashboard: { type: Boolean, default: true },
-    }
+    },
 }, {
-    timestamps: true
+    timestamps: true,
 });
 // IF role is CLIENT then defaultPermissions should be false for all modules except reporting, insights, documentsAndLinks, cvrReports, dashboard
-RoleSchema.pre('save', function (next) {
+RoleSchema.pre("save", function (next) {
     const allTrue = {
         abTestingDefault: true,
         abTesting: true,
@@ -73,7 +82,7 @@ RoleSchema.pre('save', function (next) {
         cvrReports: true,
         dashboard: true,
     };
-    if (this.name === 'CLIENT') {
+    if (this.name === "CLIENT") {
         this.defaultPermissions = Object.assign(Object.assign({}, allTrue), { abTesting: false });
     }
     else {
@@ -86,8 +95,8 @@ RoleSchema.index({ name: 1, isActive: 1 });
 RoleSchema.index({ organizationId: 1, name: 1 });
 // Add text index for search
 RoleSchema.index({
-    name: 'text',
-    description: 'text'
+    name: "text",
+    description: "text",
 });
 const Role = mongoose_1.default.models.role || (0, mongoose_1.model)("role", RoleSchema);
 exports.default = Role;

package/index.ts

@@ -49,15 +49,15 @@ import Environment from "./src/models/Environment";
 import PrecalculationFilters from "./src/models/PrecalculationFilters";
 import BqPreCompiledData from "./src/models/BqPreCompiledData";
 import CustomQuery from "./src/models/CustomQuery";
-import { generateRandomIID } from "./src/constant";
+import { generateRandomIID, RolesConstants } from "./src/constant";
 import TestTimeline from "./src/models/TestTimeline";
 import CronData from "./src/models/CronData";
 import CronConfig from "./src/models/CronConfig";
 async function seedRoles() {
   const checkRoles = await Role.countDocuments();
-  if (checkRoles < 5) {
+  if (checkRoles < RolesConstants.length) {
     Promise.all(
-      ["USER", "ADMIN", "EDITOR", "OPTIMIZER", "CLIENT", "EXTERNAL"].map((name) => {
+      RolesConstants.map((name: string) => {
         Role.bulkWrite([
           {
             updateOne: {
@@ -102,6 +102,7 @@ export async function connect(
 
 export {
   generateRandomIID,
+  RolesConstants,
   Client,
   ClientReportsTemp,
   QueryLog,
@@ -153,5 +154,5 @@ export {
   BqPreCompiledData,
   CronData,
   CronConfig,
-  UserPermission
-};
+  UserPermission,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codebase-models",
-  "version": "2.1.23",
+  "version": "2.1.25",
   "description": "Common models for codebase",
   "main": "dist/index.js",
   "scripts": {

package/src/constant.ts

@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { v4 as uuidv4 } from "uuid";
 
 const HypothesisSheetConstants = {
   NO: 0,
@@ -13,6 +13,17 @@ const HypothesisSheetConstants = {
   GOOD: 2,
 };
 
+const RolesConstants = [
+  "USER",
+  "ADMIN",
+  // "EDITOR",
+  // "COLLABORATOR",
+  "CLIENT",
+  "EXTERNAL",
+  "QA",
+  "OPTIMIZER",
+];
+
 /**
  * Generates a random unique identifier
  * @returns A 12-character uppercase string (increased from 8 for better uniqueness)
@@ -21,11 +32,15 @@ const HypothesisSheetConstants = {
 const generateRandomIID = (): string => {
   try {
     // Take first 12 characters instead of 8 for better uniqueness
-    return uuidv4().replace(/-/g, '').substring(0, 12).toUpperCase();
+    return uuidv4().replace(/-/g, "").substring(0, 12).toUpperCase();
   } catch (error) {
-    throw new Error(`Failed to generate random IID: ${error instanceof Error ? error.message : 'Unknown error'}`);
+    throw new Error(
+      `Failed to generate random IID: ${
+        error instanceof Error ? error.message : "Unknown error"
+      }`
+    );
   }
 };
 
-export { generateRandomIID };
+export { generateRandomIID, RolesConstants };
 export default HypothesisSheetConstants;

package/src/models/ClientScript.ts

@@ -7,15 +7,12 @@ export interface IClientScript extends Document {
   client?: mongoose.Schema.Types.ObjectId;
   adhere_dnt: Boolean;
   allow_in_iframes: Boolean;
-  viewId?: string;
-  clientScriptURL: string;
   jquery_include: string;
   debug: Boolean;
   restrict_debug: Boolean;
   max_cookie_lifetime: Number;
   activation_mode: string;
   use_antiflicker: Boolean;
-  snippet_revision: Number;
   snippet_version: Number;
   rules: string;
   rules_tracking: string;
@@ -38,6 +35,7 @@ export interface IClientScript extends Document {
   goalsEnabled: Boolean;
   optedOut: Boolean;
   liveEventListenersSet: Boolean;
+  active: Boolean;
 }
 
 const ClientScriptSchema = new Schema<IClientScript>(
@@ -55,13 +53,6 @@ const ClientScriptSchema = new Schema<IClientScript>(
       type: mongoose.Schema.Types.ObjectId,
       ref: "client",
     },
-    viewId: {
-      type: String,
-    },
-    clientScriptURL: {
-      type: String,
-      trim: true,
-    },
     jquery_include: {
       type: String,
       default: "false",
@@ -90,10 +81,6 @@ const ClientScriptSchema = new Schema<IClientScript>(
       type: Boolean,
       default: false,
     },
-    snippet_revision: {
-      type: Number,
-      default: 1,
-    },
     rules: {
       type: String,
       default: "return true;",
@@ -182,6 +169,10 @@ const ClientScriptSchema = new Schema<IClientScript>(
       type: Boolean,
       default: false,
     },
+    active: {
+      type: Boolean,
+      default: true,
+    },
   },
   {
     timestamps: true,
@@ -206,9 +197,6 @@ ClientScriptSchema.pre('save', async function(next) {
 ClientScriptSchema.index({ iid: 1 }, { unique: true });
 // Compound indexes for common query patterns
 ClientScriptSchema.index({ client: 1 });
-// Sparse indexes for optional fields
-ClientScriptSchema.index({ organisationId: 1 }, { sparse: true });
-ClientScriptSchema.index({ asset_url: 1 }, { sparse: true });
 
 
 const ClientScript = mongoose.models.clientscript || model<IClientScript>("clientscript", ClientScriptSchema);

package/src/models/Role.ts

@@ -20,44 +20,56 @@ export interface IRole extends Document {
   };
 }
 
-const RoleSchema = new Schema<IRole>({
-  name: {
-    type: String,
-    unique: true,
-    required: true,
-    enum: ["USER", "ADMIN", "EDITOR", "COLLABORATOR", "CLIENT", "EXTERNAL"],
-    trim: true,
-    uppercase: true,
+const RoleSchema = new Schema<IRole>(
+  {
+    name: {
+      type: String,
+      unique: true,
+      required: true,
+      enum: [
+        "USER",
+        "ADMIN",
+        "EDITOR",
+        "COLLABORATOR",
+        "CLIENT",
+        "EXTERNAL",
+        "QA",
+        "OPTIMIZER",
+      ],
+      trim: true,
+      uppercase: true,
+    },
+    description: {
+      type: String,
+      trim: true,
+    },
+    organizationId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "organization",
+      default: null,
+    },
+    isActive: {
+      type: Boolean,
+      default: true,
+    },
+    defaultPermissions: {
+      abTestingDefault: { type: Boolean, default: true },
+      abTesting: { type: Boolean, default: false },
+      preCalculations: { type: Boolean, default: true },
+      reporting: { type: Boolean, default: true },
+      insights: { type: Boolean, default: true },
+      documentsAndLinks: { type: Boolean, default: true },
+      cvrReports: { type: Boolean, default: true },
+      manageExperiments: { type: Boolean, default: true },
+      dashboard: { type: Boolean, default: true },
+    },
   },
-  description: {
-    type: String,
-    trim: true,
-  },
-  organizationId: {
-    type: mongoose.Schema.Types.ObjectId,
-    ref: "organization",
-    default: null,
-  },
-  isActive: {
-    type: Boolean,
-    default: true,
-  },
-  defaultPermissions: {
-    abTestingDefault: { type: Boolean, default: true },
-    abTesting: { type: Boolean, default: false },
-    preCalculations: { type: Boolean, default: true },
-    reporting: { type: Boolean, default: true },
-    insights: { type: Boolean, default: true },
-    documentsAndLinks: { type: Boolean, default: true },
-    cvrReports: { type: Boolean, default: true },
-    manageExperiments: { type: Boolean, default: true },
-    dashboard: { type: Boolean, default: true },
+  {
+    timestamps: true,
   }
-}, {
-  timestamps: true
-});
+);
 // IF role is CLIENT then defaultPermissions should be false for all modules except reporting, insights, documentsAndLinks, cvrReports, dashboard
-RoleSchema.pre('save', function(next) {
+RoleSchema.pre("save", function (next) {
   const allTrue = {
     abTestingDefault: true,
     abTesting: true,
@@ -69,7 +81,7 @@ RoleSchema.pre('save', function(next) {
     cvrReports: true,
     dashboard: true,
   };
-  if (this.name === 'CLIENT') {
+  if (this.name === "CLIENT") {
     this.defaultPermissions = {
       ...allTrue,
       abTesting: false, // only this one is false
@@ -88,9 +100,9 @@ RoleSchema.index({ name: 1, isActive: 1 });
 RoleSchema.index({ organizationId: 1, name: 1 });
 
 // Add text index for search
-RoleSchema.index({ 
-  name: 'text',
-  description: 'text'
+RoleSchema.index({
+  name: "text",
+  description: "text",
 });
 
 const Role = mongoose.models.role || model<IRole>("role", RoleSchema);