codebase-models 2.1.16 → 2.1.18

package/dist/index.d.ts

@@ -65,6 +65,7 @@ import Tag from "./src/models/Tag";
 import Temp from "./src/models/Temp";
 import Tier from "./src/models/Tier";
 import Trigger from "./src/models/Trigger";
+import UserPermission from "./src/models/UserPermission";
 import ClientScript from "./src/models/ClientScript";
 import Audience from "./src/models/Audience";
 import Environment from "./src/models/Environment";
@@ -75,4 +76,4 @@ import { generateRandomIID } from "./src/constant";
 import TestTimeline from "./src/models/TestTimeline";
 import CronData from "./src/models/CronData";
 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, };
+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, UserPermission, };

package/dist/index.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (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.CronData = exports.BqPreCompiledData = void 0;
+exports.UserPermission = exports.CronData = exports.BqPreCompiledData = void 0;
 const mongoose_1 = __importDefault(require("mongoose"));
 const Client_1 = __importDefault(require("./src/models/Client"));
 exports.Client = Client_1.default;
@@ -99,6 +99,8 @@ const Tier_1 = __importDefault(require("./src/models/Tier"));
 exports.Tier = Tier_1.default;
 const Trigger_1 = __importDefault(require("./src/models/Trigger"));
 exports.Trigger = Trigger_1.default;
+const UserPermission_1 = __importDefault(require("./src/models/UserPermission"));
+exports.UserPermission = UserPermission_1.default;
 const ClientScript_1 = __importDefault(require("./src/models/ClientScript"));
 exports.ClientScript = ClientScript_1.default;
 const Audience_1 = __importDefault(require("./src/models/Audience"));

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

@@ -30,6 +30,17 @@ export interface IRole extends Document {
     isActive?: boolean;
     createdAt?: Date;
     updatedAt?: Date;
+    defaultPermissions?: {
+        dashboard: boolean;
+        reporting: boolean;
+        insights: boolean;
+        documentsAndLinks: boolean;
+        cvrReports: boolean;
+        abTesting: boolean;
+        abTestingDefault: boolean;
+        manageExperiments: boolean;
+        preCalculations: boolean;
+    };
 }
 declare const Role: mongoose.Model<any, {}, {}, {}, any, any>;
 export default Role;

package/dist/src/models/Role.js

@@ -29,7 +29,7 @@ const RoleSchema = new mongoose_1.Schema({
         type: String,
         unique: true,
         required: true,
-        enum: ["USER", "ADMIN", "EDITOR", "COLLABORATOR", "CLIENT"],
+        enum: ["USER", "ADMIN", "EDITOR", "COLLABORATOR", "CLIENT", "EXTERNAL"],
         trim: true,
         uppercase: true,
     },
@@ -45,10 +45,42 @@ const RoleSchema = new mongoose_1.Schema({
     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
 });
+// IF role is CLIENT then defaultPermissions should be false for all modules except reporting, insights, documentsAndLinks, cvrReports, dashboard
+RoleSchema.pre('save', function (next) {
+    const allTrue = {
+        abTestingDefault: true,
+        abTesting: true,
+        manageExperiments: true,
+        preCalculations: true,
+        reporting: true,
+        insights: true,
+        documentsAndLinks: true,
+        cvrReports: true,
+        dashboard: true,
+    };
+    if (this.name === 'CLIENT') {
+        this.defaultPermissions = Object.assign(Object.assign({}, allTrue), { abTesting: false });
+    }
+    else {
+        this.defaultPermissions = Object.assign(Object.assign({}, allTrue), { abTestingDefault: false });
+    }
+    next();
+});
 // Compound indexes for common query patterns
 RoleSchema.index({ name: 1, isActive: 1 });
 RoleSchema.index({ organizationId: 1, name: 1 });

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

@@ -0,0 +1,44 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import mongoose, { Document } from "mongoose";
+export interface IUserPermission extends Document {
+    userId: mongoose.Schema.Types.ObjectId;
+    clientId: mongoose.Schema.Types.ObjectId;
+    permissions: {
+        dashboard: boolean;
+        reporting: boolean;
+        insights: boolean;
+        documentsAndLinks: boolean;
+        cvrReports: boolean;
+        abTesting: boolean;
+        abTestingDefault: boolean;
+        manageExperiments: boolean;
+        preCalculations: boolean;
+    };
+    createdAt: Date;
+    updatedAt: Date;
+}
+declare const UserPermission: mongoose.Model<any, {}, {}, {}, any, any>;
+export default UserPermission;

package/dist/src/models/UserPermission.js

@@ -0,0 +1,55 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongoose_1 = __importStar(require("mongoose"));
+const UserPermissionSchema = new mongoose_1.Schema({
+    userId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "user",
+        required: true,
+    },
+    clientId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "client",
+        required: true,
+    },
+    permissions: {
+        abTestingDefault: { type: Boolean, default: true },
+        abTesting: { type: Boolean, default: false },
+        preCalculations: { type: Boolean, default: false },
+        reporting: { type: Boolean, default: true },
+        insights: { type: Boolean, default: true },
+        documentsAndLinks: { type: Boolean, default: true },
+        cvrReports: { type: Boolean, default: true },
+        manageExperiments: { type: Boolean, default: false },
+        dashboard: { type: Boolean, default: true },
+    },
+}, {
+    timestamps: true,
+});
+// Add compound indexes for common query patterns
+UserPermissionSchema.index({ userId: 1, clientId: 1 }, { unique: true });
+const UserPermission = mongoose_1.default.models.userpermission || (0, mongoose_1.model)("userpermission", UserPermissionSchema);
+exports.default = UserPermission;

package/index.ts

@@ -42,6 +42,7 @@ import Tag from "./src/models/Tag";
 import Temp from "./src/models/Temp";
 import Tier from "./src/models/Tier";
 import Trigger from "./src/models/Trigger";
+import UserPermission from "./src/models/UserPermission";
 import ClientScript from "./src/models/ClientScript";
 import Audience from "./src/models/Audience";
 import Environment from "./src/models/Environment";
@@ -150,4 +151,5 @@ export {
   PrecalculationFilters,
   BqPreCompiledData,
   CronData,
+  UserPermission,
 };

package/package.json

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

package/src/models/Role.ts

@@ -7,6 +7,17 @@ export interface IRole extends Document {
   isActive?: boolean;
   createdAt?: Date;
   updatedAt?: Date;
+  defaultPermissions?: {
+    dashboard: boolean;
+    reporting: boolean;
+    insights: boolean;
+    documentsAndLinks: boolean;
+    cvrReports: boolean;
+    abTesting: boolean;
+    abTestingDefault: boolean;
+    manageExperiments: boolean;
+    preCalculations: boolean;
+  };
 }
 
 const RoleSchema = new Schema<IRole>({
@@ -14,7 +25,7 @@ const RoleSchema = new Schema<IRole>({
     type: String,
     unique: true,
     required: true,
-    enum: ["USER", "ADMIN", "EDITOR", "COLLABORATOR", "CLIENT"],
+    enum: ["USER", "ADMIN", "EDITOR", "COLLABORATOR", "CLIENT", "EXTERNAL"],
     trim: true,
     uppercase: true,
   },
@@ -30,11 +41,47 @@ const RoleSchema = new Schema<IRole>({
   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
 });
+// IF role is CLIENT then defaultPermissions should be false for all modules except reporting, insights, documentsAndLinks, cvrReports, dashboard
+RoleSchema.pre('save', function(next) {
+  const allTrue = {
+    abTestingDefault: true,
+    abTesting: true,
+    manageExperiments: true,
+    preCalculations: true,
+    reporting: true,
+    insights: true,
+    documentsAndLinks: true,
+    cvrReports: true,
+    dashboard: true,
+  };
+  if (this.name === 'CLIENT') {
+    this.defaultPermissions = {
+      ...allTrue,
+      abTesting: false, // only this one is false
+    };
+  } else {
+    this.defaultPermissions = {
+      ...allTrue,
+      abTestingDefault: false,
+    };
+  }
+  next();
+});
 
 // Compound indexes for common query patterns
 RoleSchema.index({ name: 1, isActive: 1 });

package/src/models/UserPermission.ts

@@ -0,0 +1,53 @@
+import mongoose, { Document, Schema, model } from "mongoose";
+
+export interface IUserPermission extends Document {
+  userId: mongoose.Schema.Types.ObjectId;
+  clientId: mongoose.Schema.Types.ObjectId;
+  permissions: {
+    dashboard: boolean;
+    reporting: boolean;
+    insights: boolean;
+    documentsAndLinks: boolean;
+    cvrReports: boolean;
+    abTesting: boolean;
+    abTestingDefault: boolean;
+    manageExperiments: boolean;
+    preCalculations: boolean;
+  }
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+const UserPermissionSchema = new Schema<IUserPermission>({
+  userId: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: "user",
+    required: true,
+  },
+  clientId: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: "client",
+    required: true,
+  },
+  permissions: {
+    abTestingDefault: { type: Boolean, default: true },
+    abTesting: { type: Boolean, default: false },
+    preCalculations: { type: Boolean, default: false },
+    reporting: { type: Boolean, default: true },
+    insights: { type: Boolean, default: true },
+    documentsAndLinks: { type: Boolean, default: true },
+    cvrReports: { type: Boolean, default: true },
+    manageExperiments: { type: Boolean, default: false },
+    dashboard: { type: Boolean, default: true },
+  },
+},
+  {
+    timestamps: true,
+  }
+);
+
+// Add compound indexes for common query patterns
+UserPermissionSchema.index({ userId: 1, clientId: 1 },{ unique: true });
+
+const UserPermission = mongoose.models.userpermission || model<IUserPermission>("userpermission", UserPermissionSchema);
+export default UserPermission;