codebase-models 3.0.9 → 3.1.1

package/README.md

@@ -0,0 +1,324 @@
+# codebase-models
+
+Common Mongoose models and utilities for the Conversion.IO codebase.
+
+## Installation
+
+```bash
+npm install codebase-models
+```
+
+## Quick Start
+
+```typescript
+import { connect, Client, User, Provider, ProviderType } from "codebase-models";
+
+// Connect to MongoDB
+await connect(process.env.MONGODB_URI);
+
+// Use models
+const client = await Client.findOne({ name: "Example Client" });
+const user = await User.findOne({ email: "user@example.com" });
+```
+
+## Features
+
+- **50+ Mongoose Models**: Pre-defined schemas for clients, users, tests, reports, and more
+- **Database Connection Helper**: Automatic connection management with role seeding
+- **TypeScript Support**: Full TypeScript definitions for all models
+- **Provider Integration**: Built-in support for third-party integrations (Shopify, BigQuery, Google services, etc.)
+- **Utility Functions**: Helper functions for ID generation and constants
+
+## Available Models
+
+### Core Models
+
+- `Client` - Client/organization management
+- `User` - User accounts and authentication
+- `Organization` - Organization structure
+- `Role` - User roles and permissions
+- `UserPermission` - User-specific permissions
+- `UserOrganization` - User-organization relationships
+- `Package` - Feature packages and subscriptions
+- `Tier` - Client tiers
+
+### Testing & Experiments
+
+- `Test` - A/B tests and experiments
+- `TestSequentialValue` - Sequential testing configuration
+- `TestTimeline` - Test event timeline
+- `Hypothesis` - Test hypotheses
+- `HypothesisSheet` - Hypothesis evaluation sheets
+- `Page` - Landing pages
+- `PageElement` - Page elements/components
+- `PageTestType` - Page test type configurations
+- `Trigger` - Test triggers
+- `Audience` - Test audiences
+
+### Reporting & Analytics
+
+- `Report` - General reports
+- `CVRReport` - Conversion rate reports
+- `ClientReportsTemp` - Temporary client reports
+- `BqPreCompiledData` - BigQuery pre-compiled data
+- `PrecalculationFilters` - Data precalculation filters
+
+### Client Management
+
+- `ClientRetention` - Client retention data
+- `ClientStrategy` - Client strategies
+- `ClientLearning` - Client learnings
+- `ClientLinks` - Client links and documents
+- `ClientNote` - Client notes
+- `ClientNextStep` - Client next steps
+- `ClientAdditionalRevenue` - Additional revenue tracking
+- `ClientScript` - Client scripts
+- `ClientSurvey` - Client surveys
+
+### Content & Communication
+
+- `Thread` - Communication threads
+- `ThreadMessage` - Thread messages
+- `Notification` - System notifications
+- `ReadNotification` - Notification read status
+- `Announcement` - System announcements
+- `Invitation` - User invitations
+- `Feedback` - User feedback
+- `Faq` - Frequently asked questions
+
+### Integrations & Providers
+
+- `Provider` - Third-party provider configurations (Shopify, BigQuery, Google services, etc.)
+- `ApiLog` - API call logging
+
+### Other Models
+
+- `Goal` - Goals and objectives
+- `NewIdeas` - New ideas tracking
+- `SavedSegment` - Saved user segments
+- `Snippet` - Code snippets
+- `Tag` - Tagging system
+- `Portfolio` - Portfolio management
+- `LandingPages` - Landing page management
+- `StageInCustomerJourney` - Customer journey stages
+- `Environment` - Environment configurations
+- `CustomQuery` - Custom database queries
+- `CronData` - Cron job data
+- `CronConfig` - Cron job configurations
+- `AppEvent` - Application events
+- `Temp` - Temporary data storage
+
+## Database Connection
+
+The package provides a `connect` function that handles MongoDB connection and automatically seeds roles:
+
+```typescript
+import { connect } from "codebase-models";
+
+// Basic connection
+await connect(process.env.MONGODB_URI);
+
+// With options
+await connect(process.env.MONGODB_URI, {
+  maxPoolSize: 10,
+  serverSelectionTimeoutMS: 5000,
+});
+```
+
+The connection function:
+
+- Automatically checks if already connected
+- Seeds default roles on first connection
+- Returns the mongoose instance
+
+## Provider Model
+
+The `Provider` model is designed to store API keys, secrets, and configurations for third-party integrations.
+
+### Supported Provider Types
+
+```typescript
+import { Provider, ProviderType } from "codebase-models";
+
+// Available provider types
+ProviderType.SHOPIFY;
+ProviderType.BIGQUERY;
+ProviderType.GOOGLE_ANALYTICS;
+ProviderType.GOOGLE_TAG_MANAGER;
+ProviderType.GOOGLE_ADS;
+ProviderType.GOOGLE_SEARCH_CONSOLE;
+ProviderType.GOOGLE_SHEETS;
+ProviderType.GOOGLE_DOCS;
+ProviderType.GOOGLE_DRIVE;
+ProviderType.GOOGLE_MAIL;
+ProviderType.GOOGLE_CALENDAR;
+```
+
+### Example: Shopify Provider
+
+```typescript
+import { Provider, ProviderType, IShopifyMetadata } from "codebase-models";
+
+const shopifyProvider = new Provider({
+  name: "My Shopify Store",
+  providerType: ProviderType.SHOPIFY,
+  client: clientId,
+  user: userId,
+  organizationId: orgId,
+  metadata: {
+    apiKey: "your-api-key",
+    apiSecretKey: "your-secret-key",
+    hostName: "your-store.myshopify.com",
+    apiVersion: "2026-01",
+  } as IShopifyMetadata,
+  active: true,
+});
+
+await shopifyProvider.save();
+```
+
+### Example: BigQuery Provider
+
+```typescript
+import { Provider, ProviderType, IBigQueryMetadata } from "codebase-models";
+
+const bigQueryProvider = new Provider({
+  name: "Analytics BigQuery",
+  providerType: ProviderType.BIGQUERY,
+  client: clientId,
+  user: userId,
+  organizationId: orgId,
+  metadata: {
+    projectId: "your-project-id",
+    credentials: {
+      type: "service_account",
+      project_id: "your-project-id",
+      private_key_id: "key-id",
+      private_key:
+        "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
+      client_email: "service-account@project.iam.gserviceaccount.com",
+      client_id: "client-id",
+      auth_uri: "https://accounts.google.com/o/oauth2/auth",
+      token_uri: "https://oauth2.googleapis.com/token",
+      auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs",
+      client_x509_cert_url:
+        "https://www.googleapis.com/robot/v1/metadata/x509/...",
+    },
+    datasetId: "your-dataset",
+    location: "US",
+  } as IBigQueryMetadata,
+  active: true,
+});
+
+await bigQueryProvider.save();
+```
+
+### Querying Providers
+
+```typescript
+// Find all active Shopify providers for a client
+const shopifyProviders = await Provider.find({
+  providerType: ProviderType.SHOPIFY,
+  client: clientId,
+  active: true,
+});
+
+// Find provider by IID
+const provider = await Provider.findOne({ iid: "ABC123XYZ456" });
+```
+
+## Utility Functions
+
+### Generate Random IID
+
+```typescript
+import { generateRandomIID } from "codebase-models";
+
+const uniqueId = generateRandomIID(); // Returns 12-character uppercase string
+```
+
+### Constants
+
+```typescript
+import {
+  RolesConstants,
+  PermissionsConstants,
+  PackageFeaturesConstants,
+  HypothesisSheetConstants,
+} from "codebase-models";
+
+// Available roles
+RolesConstants; // ['USER', 'ADMIN', 'CLIENT', 'EXTERNAL', 'QA', 'OPTIMIZER']
+
+// Permissions
+PermissionsConstants.dashboard;
+PermissionsConstants.reporting;
+PermissionsConstants.insights;
+// ... etc
+```
+
+## Model Patterns
+
+All models follow consistent patterns:
+
+1. **Model Name Check**: Models check `mongoose.models.modelname` before creation to prevent overwrite errors
+2. **Lowercase Model Names**: All model names are lowercase (e.g., `"client"`, `"user"`, `"provider"`)
+3. **Timestamps**: Most models include `createdAt` and `updatedAt` timestamps
+4. **IID Support**: Many models use `iid` (internal ID) generated via `generateRandomIID()`
+5. **Indexes**: Models include appropriate indexes for common query patterns
+
+## TypeScript Support
+
+All models export TypeScript interfaces:
+
+```typescript
+import { Client, IClient } from "codebase-models";
+import { Provider, IProvider, ProviderType } from "codebase-models";
+import { User, IUser } from "codebase-models";
+```
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+This will:
+
+1. Clean the `dist` directory
+2. Compile TypeScript with declaration files
+
+### Publishing
+
+```bash
+npm publish
+```
+
+The `prepublish` script automatically builds before publishing.
+
+## Requirements
+
+- Node.js 20+
+- MongoDB
+- TypeScript 5.4+
+
+## Dependencies
+
+- `mongoose` ^8.2.3 - MongoDB ODM
+- `mongoose-slug-updater` ^3.3.0 - Slug generation
+- `uuid` ^11.1.0 - Unique ID generation
+
+## License
+
+ISC
+
+## Repository
+
+- **GitHub**: [Conversion-IO/codebase-models](https://github.com/Conversion-IO/codebase-models)
+- **Issues**: [GitHub Issues](https://github.com/Conversion-IO/codebase-models/issues)
+
+## Author
+
+Vaibhav Anchal <vaibhav@conversion.io>

package/dist/index.d.ts

@@ -73,12 +73,13 @@ import { generateRandomIID, RolesConstants } from "./src/constant";
 import TestTimeline from "./src/models/TestTimeline";
 import CronData from "./src/models/CronData";
 import CronConfig from "./src/models/CronConfig";
-import UserIdentity from "./src/models/UserIdentity";
 import UserOrganization from "./src/models/UserOrganization";
 import Package from "./src/models/Package";
 import Invitation from "./src/models/Invitation";
 import Thread from "./src/models/Thread";
 import ThreadMessage from "./src/models/ThreadMessage";
 import Provider from "./src/models/Provider";
+import ApiLog from "./src/models/ApiLog";
+import { ProviderType } from "./src/models/Provider";
 export declare function connect(uri: string, options?: mongoose.ConnectOptions | undefined): Promise<typeof mongoose>;
-export { generateRandomIID, RolesConstants, Client, ClientReportsTemp, Report, Provider, 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, Snippet, StageInCustomerJourney, Tag, Temp, Tier, Trigger, ClientScript, Audience, Environment, Organization, PrecalculationFilters, BqPreCompiledData, CronData, CronConfig, UserPermission, UserIdentity, UserOrganization, Package, Invitation, Thread, ThreadMessage, };
+export { generateRandomIID, RolesConstants, Client, ClientReportsTemp, Report, Provider, 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, Snippet, StageInCustomerJourney, Tag, Temp, Tier, Trigger, ClientScript, Audience, Environment, Organization, PrecalculationFilters, BqPreCompiledData, CronData, CronConfig, UserPermission, UserOrganization, Package, Invitation, Thread, ThreadMessage, ApiLog, ProviderType, };

package/dist/index.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BqPreCompiledData = exports.PrecalculationFilters = exports.Organization = exports.Environment = exports.Audience = exports.ClientScript = exports.Trigger = exports.Tier = exports.Temp = exports.Tag = exports.StageInCustomerJourney = exports.Snippet = 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.Provider = exports.Report = exports.ClientReportsTemp = exports.Client = exports.RolesConstants = exports.generateRandomIID = exports.connect = void 0;
-exports.ThreadMessage = exports.Thread = exports.Invitation = exports.Package = exports.UserOrganization = exports.UserIdentity = exports.UserPermission = exports.CronConfig = exports.CronData = void 0;
+exports.ProviderType = exports.ApiLog = exports.ThreadMessage = exports.Thread = exports.Invitation = exports.Package = exports.UserOrganization = exports.UserPermission = exports.CronConfig = exports.CronData = void 0;
 const mongoose_1 = __importDefault(require("mongoose"));
 const Client_1 = __importDefault(require("./src/models/Client"));
 exports.Client = Client_1.default;
@@ -116,8 +116,6 @@ const CronData_1 = __importDefault(require("./src/models/CronData"));
 exports.CronData = CronData_1.default;
 const CronConfig_1 = __importDefault(require("./src/models/CronConfig"));
 exports.CronConfig = CronConfig_1.default;
-const UserIdentity_1 = __importDefault(require("./src/models/UserIdentity"));
-exports.UserIdentity = UserIdentity_1.default;
 const UserOrganization_1 = __importDefault(require("./src/models/UserOrganization"));
 exports.UserOrganization = UserOrganization_1.default;
 const Package_1 = __importDefault(require("./src/models/Package"));
@@ -130,6 +128,10 @@ const ThreadMessage_1 = __importDefault(require("./src/models/ThreadMessage"));
 exports.ThreadMessage = ThreadMessage_1.default;
 const Provider_1 = __importDefault(require("./src/models/Provider"));
 exports.Provider = Provider_1.default;
+const ApiLog_1 = __importDefault(require("./src/models/ApiLog"));
+exports.ApiLog = ApiLog_1.default;
+const Provider_2 = require("./src/models/Provider");
+Object.defineProperty(exports, "ProviderType", { enumerable: true, get: function () { return Provider_2.ProviderType; } });
 function seedRoles() {
     return __awaiter(this, void 0, void 0, function* () {
         const checkRoles = yield Role_1.default.countDocuments();

package/dist/src/models/{UserIdentity.d.ts → ApiLog.d.ts}

@@ -23,13 +23,16 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 import mongoose, { Document } from "mongoose";
-export interface IUserIdentity extends Document {
+export interface IApiLog extends Document {
     iid: string;
+    apiName: string;
+    organizationId?: mongoose.Schema.Types.ObjectId;
+    client: mongoose.Schema.Types.ObjectId;
     user: mongoose.Schema.Types.ObjectId;
-    provider: "google" | "microsoft" | "github" | "facebook" | "apple";
-    providerUserId: string;
-    email: string;
-    metadata?: any;
+    endpoint: string;
+    createdAt: Date;
+    updatedAt: Date;
+    metadata: mongoose.Schema.Types.Mixed;
 }
-declare const UserIdentity: mongoose.Model<any, {}, {}, {}, any, any>;
-export default UserIdentity;
+declare const ApiLog: mongoose.Model<any, {}, {}, {}, any, any>;
+export default ApiLog;

package/dist/src/models/{UserIdentity.js → ApiLog.js}

@@ -25,13 +25,50 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const mongoose_1 = __importStar(require("mongoose"));
 const constant_1 = require("../constant");
-const UserIdentitySchema = new mongoose_1.Schema({
-    iid: { type: String, unique: true, default: () => (0, constant_1.generateRandomIID)() },
-    user: { type: mongoose_1.default.Schema.Types.ObjectId, ref: "user", required: true },
-    email: { type: String, unique: true, required: true },
-    providerUserId: { type: String, required: true },
-    provider: { type: String, enum: ["google", "microsoft", "github", "facebook", "apple"], required: true },
-    metadata: { type: mongoose_1.default.Schema.Types.Mixed, default: {} },
-}, { timestamps: true });
-const UserIdentity = mongoose_1.default.models.useridentity || (0, mongoose_1.model)("useridentity", UserIdentitySchema);
-exports.default = UserIdentity;
+const Provider_1 = require("./Provider");
+const ApiLogSchema = new mongoose_1.Schema({
+    iid: {
+        type: String,
+        trim: true,
+        unique: true,
+        default: () => (0, constant_1.generateRandomIID)(),
+    },
+    apiName: {
+        type: String,
+        required: true,
+        enum: Object.values(Provider_1.ProviderType),
+        trim: true,
+    },
+    organizationId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "organization",
+        default: null,
+        required: true,
+    },
+    client: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "client",
+        default: null,
+        required: true,
+    },
+    user: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "user",
+        default: null,
+        required: true,
+    },
+    endpoint: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    metadata: {
+        type: mongoose_1.default.Schema.Types.Mixed,
+        default: null,
+        trim: true,
+    },
+}, {
+    timestamps: true
+});
+const ApiLog = mongoose_1.default.models.apiLog || (0, mongoose_1.model)("apiLog", ApiLogSchema);
+exports.default = ApiLog;

package/index.ts

@@ -50,13 +50,14 @@ import { generateRandomIID, RolesConstants } from "./src/constant";
 import TestTimeline from "./src/models/TestTimeline";
 import CronData from "./src/models/CronData";
 import CronConfig from "./src/models/CronConfig";
-import UserIdentity from "./src/models/UserIdentity";
 import UserOrganization from "./src/models/UserOrganization";
 import Package from "./src/models/Package";
 import Invitation from "./src/models/Invitation";
 import Thread from "./src/models/Thread";
 import ThreadMessage from "./src/models/ThreadMessage";
 import Provider from "./src/models/Provider";
+import ApiLog from "./src/models/ApiLog";
+import { ProviderType } from "./src/models/Provider";
 async function seedRoles() {
   const checkRoles = await Role.countDocuments();
   if (checkRoles < RolesConstants.length) {
@@ -157,10 +158,11 @@ export {
   CronData,
   CronConfig,
   UserPermission,
-  UserIdentity,
   UserOrganization,
   Package,
   Invitation,
   Thread,
   ThreadMessage,
+  ApiLog,
+  ProviderType,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codebase-models",
-  "version": "3.0.9",
+  "version": "3.1.1",
   "description": "Common models for codebase",
   "main": "dist/index.js",
   "scripts": {
@@ -24,10 +24,10 @@
   "types": "./dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AcceleratedAgency/codebase-models.git"
+    "url": "git+https://github.com/Conversion-IO/codebase-models.git"
   },
   "bugs": {
-    "url": "https://github.com/AcceleratedAgency/codebase-models/issues"
+    "url": "https://github.com/Conversion-IO/codebase-models/issues"
   },
-  "homepage": "https://github.com/AcceleratedAgency/codebase-models#readme"
+  "homepage": "https://github.com/Conversion-IO/codebase-models#readme"
 }

package/src/constant.ts

@@ -127,5 +127,7 @@ const PackageFeaturesConstants = [
   },
 ];
 
+
+
 export { generateRandomIID, RolesConstants, PermissionsConstants, PackageFeaturesConstants };
 export default HypothesisSheetConstants;

package/src/models/ApiLog.ts

@@ -0,0 +1,67 @@
+import mongoose, { Document, Schema, model } from "mongoose";
+import { generateRandomIID } from "../constant";
+import { ProviderType } from "./Provider";
+
+export interface IApiLog extends Document {
+ iid: string;
+ apiName: string;
+ organizationId?: mongoose.Schema.Types.ObjectId;
+ client: mongoose.Schema.Types.ObjectId;
+ user: mongoose.Schema.Types.ObjectId;
+ endpoint: string;
+ createdAt: Date;
+ updatedAt: Date;
+ metadata: mongoose.Schema.Types.Mixed;
+}
+
+const ApiLogSchema = new Schema<IApiLog>(
+  {
+    iid: {
+      type: String,
+      trim: true,
+      unique: true,
+      default: () => generateRandomIID(),
+    },
+    apiName: {
+      type: String,
+      required: true,
+      enum: Object.values(ProviderType) as [string],
+      trim: true,
+    },
+    organizationId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "organization",
+      default: null,
+      required: true,
+    },
+    client: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "client",
+      default: null,
+      required: true,
+    },
+    user: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "user",
+      default: null,
+      required: true,
+    },
+    endpoint: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    metadata: {
+      type: mongoose.Schema.Types.Mixed,
+      default: null,
+      trim: true,
+    },
+  },
+  {
+    timestamps: true
+  }
+);
+
+const ApiLog = mongoose.models.apiLog || model<IApiLog>("apiLog", ApiLogSchema);
+
+export default ApiLog;

package/src/models/UserIdentity.ts

@@ -1,26 +0,0 @@
-import mongoose, { Document, Schema, model } from "mongoose";
-import { generateRandomIID } from "../constant";
-
-export interface IUserIdentity extends Document {
-    iid: string;
-    user: mongoose.Schema.Types.ObjectId;
-    provider: "google" | "microsoft" | "github" | "facebook" | "apple";
-    providerUserId: string; 
-    email: string;
-    metadata?: any;
-}
-
-const UserIdentitySchema = new Schema<IUserIdentity>(
-  {
-    iid: { type: String, unique: true, default: () => generateRandomIID() },
-    user: { type: mongoose.Schema.Types.ObjectId, ref: "user", required: true },
-    email: { type: String, unique: true, required: true },
-    providerUserId: { type: String, required: true },
-    provider: { type: String, enum: ["google", "microsoft", "github", "facebook", "apple"], required: true },
-    metadata: { type: mongoose.Schema.Types.Mixed, default: {} },
-  },
-  { timestamps: true }
-);
-
-const UserIdentity = mongoose.models.useridentity || model<IUserIdentity>("useridentity", UserIdentitySchema);
-export default UserIdentity;