agrs-sequelize-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Agressive Scale LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# agrs-sequelize

package/config/config.json

@@ -0,0 +1,24 @@
+{
+  "development": {
+    "username": "postgres",
+    "password": "1234",
+    "database": "dev-db",
+    "host": "localhost",
+    "port": 5432,
+    "dialect": "postgres"
+  },
+  "test": {
+    "username": "root",
+    "password": "1234",
+    "database": "test-db",
+    "host": "127:0.0.1",
+    "dialect": "postgres"
+  },
+  "production": {
+    "username": "root",
+    "password": "1234",
+    "database": "prod-db",
+    "host": "127:0.0.1",
+    "dialect": "postgres"
+  }
+}

package/index.js

@@ -0,0 +1,69 @@
+const Sequelize = require("sequelize");
+const path = require("path");
+const fs = require("fs");
+
+// const env = process.env.NODE_ENV || "development";
+class DBModels {
+  constructor(config) {
+    this.config = config;
+    this.db = {};
+
+    // Initialize Sequelize
+    const sequelize = new Sequelize(
+      this.config .database,
+      this.config .username,
+      this.config .password,
+      {
+        host: this.config .host,
+        dialect: this.config .dialect,
+        port: this.config .port,
+        logging: false,
+        pool: {
+          max: 100,
+          min: 0,
+          acquire: 30000,
+          idle: 10000,
+        },
+      }
+    );
+    
+    // // Initialize PaperTrail
+    // const PaperTrail = require("sequelize-paper-trail").init(sequelize, {
+    //   userModel: false, // Optional: set this to true if you have a user model to track who made the changes
+    //   enableRevisionChangeModel: true, // Optional: set this to true if you want to store the changes made to each revision
+    // });
+    // PaperTrail.defineModels(); // Define the Revision and RevisionChange models
+    
+    // Load all models
+    fs.readdirSync(path.join(__dirname, "models"))
+      .filter((file) => {
+        return file.indexOf(".") !== 0 && file.slice(-3) === ".js";
+      })
+      .forEach((file) => {
+        const model = require(path.join(__dirname, "models", file))(
+          sequelize,
+          Sequelize.DataTypes
+        );
+        this.db[model.name] = model;
+      });
+    
+    // Apply PaperTrail to CodefuelCampaign model
+    // const CodefuelCampaign = db["CodefuelCampaign"];
+    // if (CodefuelCampaign) {
+    //   CodefuelCampaign.Revisions = CodefuelCampaign.hasPaperTrail();
+    // }
+    
+    // Set up associations
+    Object.keys(this.db).forEach((modelName) => {
+      if (this.db[modelName].associate) {
+        this.db[modelName].associate(this.db);
+      }
+    });
+    
+    // Export the db object with Sequelize and models
+    this.db.sequelize = sequelize;
+    this.db.Sequelize = Sequelize;
+  }
+}
+
+module.exports = DBModels;

package/models/ActivityHistory.js

@@ -0,0 +1,73 @@
+// models/ActivityHistory.js
+module.exports = (sequelize, DataTypes) => {
+  const ActivityHistory = sequelize.define(
+    "ActivityHistory",
+    {
+      ActivityHistoryID: {
+        type: DataTypes.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      AssociatedModelType: {
+        type: DataTypes.STRING,
+        allowNull: false, // Could be 'Ad', 'AdSet', 'Campaign', etc.
+      },
+      AssociatedModelID: {
+        type: DataTypes.STRING,
+        allowNull: false, // ID of the associated model
+      },
+      ActorID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ActorName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ApplicationName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      DateTimeInTimeZone: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      EventType: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ObjectName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ObjectType: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      TranslatedEventType: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ObjectID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ExtraData: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "ActivityHistory",
+      indexes: [
+        {
+          unique: true,
+          name: "unique_index_on_date_object_event", // Custom name
+          fields: ["DateTimeInTimeZone", "ObjectID", "EventType"],
+        },
+      ],
+    }
+  );
+
+  return ActivityHistory;
+};

package/models/Ad.js

@@ -0,0 +1,140 @@
+module.exports = (sequelize, DataTypes) => {
+  const Ad = sequelize.define(
+    "Ad",
+    {
+      AdID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AdName: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      AdSetID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        references: {
+          model: "AdSet",
+          key: "AdSetID",
+        },
+      },
+      creativeId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        references: {
+          model: "AdCreative", // Assuming you have an AdCreative model
+          key: "id",
+        },
+      },
+      pixelId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      startTime: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      endTime: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      format: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "SINGLE",
+      },
+      imageHashes: {
+        type: DataTypes.ARRAY(DataTypes.STRING), // Array of image hashes
+        allowNull: true,
+      },
+      videoIds: {
+        type: DataTypes.ARRAY(DataTypes.STRING), // Array of video IDs
+        allowNull: true,
+      },
+      messages: {
+        type: DataTypes.ARRAY(DataTypes.STRING), // Array of primary text messages
+        allowNull: true,
+      },
+      headlines: {
+        type: DataTypes.ARRAY(DataTypes.STRING), // Array of headlines
+        allowNull: true,
+      },
+      websiteUrl: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      actionTypes: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "offsite_conversion",
+      },
+      Status: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+
+      createdTime: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      AGRS_CID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "Ad",
+      indexes: [
+        {
+          fields: ["AdSetID"], // Index on AdSetID for faster join
+        },
+      ],
+    }
+  );
+
+  Ad.associate = (models) => {
+    Ad.belongsTo(models.AdSet, { foreignKey: "AdSetID" });
+
+    // Association with CodefuelCampaign using AGRS_CID
+    Ad.belongsTo(models.CodefuelCampaign, {
+      foreignKey: "AGRS_CID",
+      targetKey: "AGRSCID",
+      as: "CodefuelCampaign",
+    });
+
+    Ad.hasMany(models.AdPerformance, {
+      foreignKey: "AdID",
+    });
+  };
+
+  // Method to dynamically fetch related campaign
+  Ad.prototype.getRelatedCampaign = async function () {
+    if (!this.AGRS_CID) return null;
+
+    const codefuelCampaign = await sequelize.models.CodefuelCampaign.findOne({
+      where: { AGRSCID: this.AGRS_CID },
+    });
+
+    if (codefuelCampaign) {
+      return {
+        type: "CodefuelCampaign",
+        data: codefuelCampaign,
+      };
+    }
+
+    const tonicCampaign = await sequelize.models.TonicCampaign.findOne({
+      where: { AGRSCID: this.AGRS_CID },
+    });
+
+    if (tonicCampaign) {
+      return {
+        type: "TonicCampaign",
+        data: tonicCampaign,
+      };
+    }
+
+    return null;
+  };
+
+  return Ad;
+};

package/models/AdAccount.js

@@ -0,0 +1,90 @@
+// module.exports = (sequelize, DataTypes) => {
+//   const AdAccount = sequelize.define(
+//     "AdAccount",
+//     {
+//       AdAccountID: {
+//         type: DataTypes.STRING,
+//         primaryKey: true,
+//       },
+//       AdAccountName: {
+//         type: DataTypes.STRING,
+//         allowNull: false,
+//       },
+//       AdAccountTimeZone: {
+//         type: DataTypes.STRING,
+//         allowNull: false,
+//       },
+//       Currency: {
+//         type: DataTypes.STRING,
+//         allowNull: false,
+//       },
+//       Rate: {
+//         type: DataTypes.FLOAT,
+//         allowNull: false,
+//       },
+//       UTCOffset: {
+//         type: DataTypes.INTEGER,
+//         allowNull: false,
+//       },
+//     },
+//     {
+//       tableName: "AdAccount",
+//     }
+//   );
+
+//   AdAccount.associate = (models) => {};
+
+//   return AdAccount;
+// };
+
+module.exports = (sequelize, DataTypes) => {
+  const AdAccount = sequelize.define(
+    "AdAccount",
+    {
+      AdAccountID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AdAccountName: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      AdAccountTimeZone: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      Currency: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      Rate: {
+        type: DataTypes.FLOAT,
+        allowNull: false,
+      },
+      UTCOffset: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+      },
+    },
+    {
+      tableName: "AdAccount",
+      indexes: [
+        {
+          fields: ["AdAccountName"],
+        },
+        {
+          fields: ["Currency"],
+        },
+      ],
+    }
+  );
+
+  AdAccount.associate = (models) => {
+    AdAccount.hasMany(models.Campaign, {
+      foreignKey: "AdAccountID",
+      as: "Campaigns",
+    });
+  };
+
+  return AdAccount;
+};

package/models/AdCreative.js

@@ -0,0 +1,57 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdCreative = sequelize.define("AdCreative", {
+    id: {
+      type: DataTypes.STRING,
+      primaryKey: true,
+    },
+    name: DataTypes.STRING,
+    adAccountId: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    pageId: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    imageHashes: {
+      type: DataTypes.ARRAY(DataTypes.STRING), // Array of image hash IDs (Foreign key to Files table)
+      allowNull: true,
+    },
+    videoIds: {
+      type: DataTypes.ARRAY(DataTypes.STRING), // Array of video file IDs (Foreign key to Files table)
+      allowNull: true,
+    },
+    messages: {
+      type: DataTypes.ARRAY(DataTypes.STRING), // Array of messages (primary text)
+      allowNull: true,
+    },
+    headlines: {
+      type: DataTypes.ARRAY(DataTypes.STRING), // Array of headlines
+      allowNull: true,
+    },
+    descriptions: {
+      type: DataTypes.ARRAY(DataTypes.STRING), // Array of descriptions
+      allowNull: true,
+    },
+    websiteUrl: {
+      type: DataTypes.STRING, // URL for the call to action
+      allowNull: false,
+    },
+    format: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      defaultValue: "FLEXIBLE",
+    },
+  });
+
+  // Define associations
+  AdCreative.associate = function (models) {
+    // Associate AdCreative with Ad (one-to-many)
+    AdCreative.hasMany(models.Ad, { foreignKey: "creativeId" });
+
+    // Associate AdCreative with Files (one-to-many)
+    AdCreative.hasMany(models.Files, { foreignKey: "id", sourceKey: "id" });
+  };
+
+  return AdCreative;
+};

package/models/AdPerformance.js

@@ -0,0 +1,65 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdPerformance = sequelize.define(
+    "AdPerformance",
+    {
+      Date: {
+        type: DataTypes.DATEONLY,
+        primaryKey: true,
+      },
+      AdID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        primaryKey: true,
+      },
+      AmountSpent: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      Impressions: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      LinkClicks: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Revenue: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      AdClicks: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Sessions: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      originalSpend: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "AdPerformance",
+      indexes: [
+        {
+          unique: true,
+          fields: ["AdID", "Date"], // Composite unique index
+        },
+        {
+          fields: ["Date"], // Index on Date for faster range queries
+        },
+        {
+          fields: ["AdID"], // Index on AdID for faster join
+        },
+      ],
+    }
+  );
+
+  AdPerformance.associate = (models) => {
+    AdPerformance.belongsTo(models.Ad, { foreignKey: "AdID" });
+  };
+
+  return AdPerformance;
+};

package/models/AdPerformanceHourly.js

@@ -0,0 +1,51 @@
+// models/AdPerformanceHourly.js
+module.exports = (sequelize, DataTypes) => {
+  const AdPerformanceHourly = sequelize.define(
+    "AdPerformanceHourly",
+    {
+      Date: {
+        type: DataTypes.DATEONLY,
+        primaryKey: true,
+      },
+      Hour: {
+        type: DataTypes.INTEGER,
+        primaryKey: true,
+      },
+      AdID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AmountSpent: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      Impressions: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      LinkClicks: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      originalSpend: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "AdPerformanceHourly",
+      indexes: [
+        {
+          unique: true,
+          fields: ["AdID", "Date", "Hour"],
+        },
+      ],
+    }
+  );
+
+  AdPerformanceHourly.associate = (models) => {
+    AdPerformanceHourly.belongsTo(models.Ad, { foreignKey: "AdID" });
+  };
+
+  return AdPerformanceHourly;
+};

package/models/AdSet.js

@@ -0,0 +1,69 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdSet = sequelize.define(
+    "AdSet",
+    {
+      AdSetID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AdSetName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      daily_budget: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      start_time: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      end_time: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      targeting: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      promotedObject: {
+        type: DataTypes.JSONB, // Storing promoted object as a JSON object
+        allowNull: true,
+      },
+      BillingEvent: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "impressions", // Default value for BillingEvent
+      },
+      OptimizationGoal: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "offsite_conversions", // Default value for OptimizationGoal
+      },
+
+      CampaignID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        references: {
+          model: "Campaign",
+          key: "CampaignID",
+        },
+      },
+    },
+    {
+      tableName: "AdSet",
+      indexes: [
+        {
+          fields: ["CampaignID"], // Index on CampaignID for faster join
+        },
+      ],
+    }
+  );
+
+  AdSet.associate = (models) => {
+    AdSet.belongsTo(models.Campaign, { foreignKey: "CampaignID" });
+    AdSet.hasMany(models.Ad, { foreignKey: "AdSetID" });
+  };
+
+  return AdSet;
+};