agrs-sequelize-sdk 1.4.19 → 1.4.21

package/.worktrees/ad-review-status/models/AdHistory.js

@@ -0,0 +1,30 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdHistory = sequelize.define(
+    "AdHistory",
+    {
+      HistoryID: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      AdID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      DataSnapshot: {
+        type: DataTypes.JSONB, // Store the full Ad row as a JSON object
+        allowNull: false,
+      },
+      timestamp: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+    },
+    {
+      tableName: "AdHistory",
+      timestamps: false, // Disable Sequelize timestamps
+    }
+  );
+
+  return AdHistory;
+};

package/.worktrees/ad-review-status/models/AdPerformance.js

@@ -0,0 +1,100 @@
+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,
+      },
+      ViewContent: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Search: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Purchase: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Lead: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      originalSpend: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      PurchasesConversionValue: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+
+      originRevenue: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      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/.worktrees/ad-review-status/models/AdPerformanceHourly.js

@@ -0,0 +1,71 @@
+// 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,
+      },
+      ViewContent: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Search: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Purchase: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Lead: {
+        // New field
+        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/.worktrees/ad-review-status/models/AdSet.js

@@ -0,0 +1,295 @@
+// module.exports = (sequelize, DataTypes) => {
+//   const AdSet = sequelize.define(
+//     "AdSet",
+//     {
+//       AdSetID: {
+//         type: DataTypes.STRING,
+//         primaryKey: true,
+//       },
+//       AdSetName: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       Status: {
+//         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
+//       },
+//       Draft: {
+//         type: DataTypes.BOOLEAN,
+//         allowNull: true,
+//         defaultValue: false,
+//       },
+//       UserCreated: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       publish: {
+//         type: DataTypes.BOOLEAN,
+//         allowNull: true,
+//         defaultValue: true,
+//       },
+//       CampaignID: {
+//         type: DataTypes.STRING,
+//         allowNull: false,
+//         references: {
+//           model: "Campaign",
+//           key: "CampaignID",
+//         },
+//       },
+//       effectiveStatus: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       // add issues_info field
+//       issuesInfo: {
+//         type: DataTypes.JSONB,
+//         allowNull: true,
+//       },
+//       bid_strategy: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       // bid amount
+//       bid_amount: {
+//         type: DataTypes.INTEGER,
+//         allowNull: true,
+//       },
+//       waiting: {
+//         type: DataTypes.BOOLEAN,
+//         defaultValue: false,
+//       },
+//     },
+//     {
+//       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" });
+//   };
+
+//   AdSet.addHook("beforeUpdate", async (adSet, options) => {
+//     if (adSet.changed("publish")) {
+//       if (adSet.previous("publish") === true && adSet.publish === false) {
+//         // Save current state to AdSetHistory
+//         await sequelize.models.AdSetHistory.create({
+//           AdSetID: adSet.AdSetID,
+//           DataSnapshot: adSet._previousDataValues, // Save the full AdSet data as JSON
+//         });
+//       } else if (
+//         adSet.previous("publish") === false &&
+//         adSet.publish === true
+//       ) {
+//         // Delete the latest history entry
+//         const latestHistory = await sequelize.models.AdSetHistory.findOne({
+//           where: { AdSetID: adSet.AdSetID },
+//           order: [["timestamp", "DESC"]], // Get the latest history entry
+//         });
+
+//         if (latestHistory) {
+//           await latestHistory.destroy();
+//         }
+//       }
+//     }
+//   });
+
+//   AdSet.addHook("afterCreate", async (adSet, options) => {
+//     if (adSet.publish === false) {
+//       // If publish is false on creation, save a snapshot to AdSetHistory
+//       await sequelize.models.AdSetHistory.create({
+//         AdSetID: adSet.AdSetID,
+//         DataSnapshot: adSet.toJSON(), // Save the full AdSet data as JSON
+//       });
+//     }
+//   });
+
+//   return AdSet;
+// };
+
+module.exports = (sequelize, DataTypes) => {
+  const AdSet = sequelize.define(
+    "AdSet",
+    {
+      AdSetID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AdSetName: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+      },
+      Status: {
+        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,
+        allowNull: true,
+      },
+      BillingEvent: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "impressions",
+      },
+      OptimizationGoal: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "offsite_conversions",
+      },
+      Draft: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: false,
+      },
+      UserCreated: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      publish: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: true,
+      },
+      CampaignID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        references: {
+          model: "Campaign",
+          key: "CampaignID",
+        },
+      },
+      effectiveStatus: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      issuesInfo: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      bid_strategy: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      bid_amount: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      target_roas: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+        comment: "Target ROAS as decimal (0.9 = 90%)",
+      },
+      waiting: {
+        type: DataTypes.BOOLEAN,
+        defaultValue: false,
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      tableName: "AdSet",
+      indexes: [
+        {
+          fields: ["CampaignID"],
+        },
+      ],
+    }
+  );
+
+  AdSet.associate = (models) => {
+    AdSet.belongsTo(models.Campaign, { foreignKey: "CampaignID" });
+    AdSet.hasMany(models.Ad, { foreignKey: "AdSetID" });
+    // Add this line to define the relationship with AdSetPerformance
+    AdSet.hasMany(models.AdSetPerformance, { foreignKey: "AdSetID" });
+  };
+
+  AdSet.addHook("beforeUpdate", async (adSet, options) => {
+    if (adSet.changed("publish")) {
+      if (adSet.previous("publish") === true && adSet.publish === false) {
+        await sequelize.models.AdSetHistory.create({
+          AdSetID: adSet.AdSetID,
+          DataSnapshot: adSet._previousDataValues,
+        });
+      } else if (
+        adSet.previous("publish") === false &&
+        adSet.publish === true
+      ) {
+        const latestHistory = await sequelize.models.AdSetHistory.findOne({
+          where: { AdSetID: adSet.AdSetID },
+          order: [["timestamp", "DESC"]],
+        });
+
+        if (latestHistory) {
+          await latestHistory.destroy();
+        }
+      }
+    }
+  });
+
+  AdSet.addHook("afterCreate", async (adSet, options) => {
+    if (adSet.publish === false) {
+      await sequelize.models.AdSetHistory.create({
+        AdSetID: adSet.AdSetID,
+        DataSnapshot: adSet.toJSON(),
+      });
+    }
+  });
+
+  return AdSet;
+};

package/.worktrees/ad-review-status/models/AdSetHistory.js

@@ -0,0 +1,30 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdSetHistory = sequelize.define(
+    "AdSetHistory",
+    {
+      HistoryID: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      AdSetID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      DataSnapshot: {
+        type: DataTypes.JSONB, // Store the full AdSet row as a JSON object
+        allowNull: false,
+      },
+      timestamp: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+    },
+    {
+      tableName: "AdSetHistory",
+      timestamps: false,
+    }
+  );
+
+  return AdSetHistory;
+};

package/.worktrees/ad-review-status/models/AdsetPerformance.js

@@ -0,0 +1,132 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdSetPerformance = sequelize.define(
+    "AdSetPerformance",
+    {
+      AdSetID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        primaryKey: true,
+        // Part of the composite primary key identifying the AdSet
+      },
+      Date: {
+        type: DataTypes.DATEONLY,
+        allowNull: false,
+        primaryKey: true,
+        // Part of the composite primary key representing the performance date
+      },
+      ChannelID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        // Optional identifier for the channel, extracted from AdSet name if available
+      },
+      StyleID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        // Optional identifier for the style, extracted from AdSet name if available
+      },
+      Spend: {
+        type: DataTypes.FLOAT,
+        defaultValue: 0,
+        // Total spend on the AdSet from the source platform (e.g., Facebook)
+      },
+      Impressions: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of impressions recorded by the source platform
+      },
+      LinkClicks: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of link clicks recorded by the source platform
+      },
+      ViewContent: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of view content events recorded by the source platform
+      },
+      Search: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of search events recorded by the source platform
+      },
+      Purchase: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of purchase events recorded by the source platform
+      },
+      Lead: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of lead events recorded by the source platform
+      },
+      ExternalRevenue: {
+        type: DataTypes.FLOAT,
+        defaultValue: 0,
+        // Revenue data from an external source (e.g., analytics or monetization platforms)
+      },
+      ExternalImpressions: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of impressions recorded by an external source
+      },
+      ExternalClicks: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of clicks recorded by an external source
+      },
+      Sessions: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of website sessions/visits generated from this AdSet
+      },
+      ExternalRequests: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of requests recorded by an external source
+      },
+      ROI: {
+        type: DataTypes.FLOAT,
+        defaultValue: 0,
+        // Calculated Return on Investment (ExternalRevenue / Spend)
+      },
+      agrscid: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        // Optional identifier for the AdSet, extracted from AdSet url if available
+      },
+      originalRevenue: {
+        type: DataTypes.FLOAT,
+        defaultValue: 0,
+        // Original revenue value before any modifications or calculations
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      }
+    },
+    {
+      tableName: "AdSetPerformance",
+      timestamps: false, // No need for createdAt/updatedAt timestamps
+      indexes: [
+        {
+          unique: true,
+          fields: ["AdSetID", "Date"],
+          // Composite unique index to ensure one record per AdSet per date
+        },
+      ],
+    }
+  );
+
+  // Define associations with other models
+  AdSetPerformance.associate = (models) => {
+    AdSetPerformance.belongsTo(models.AdSet, {
+      foreignKey: "AdSetID",
+      targetKey: "AdSetID",
+      // Links to the AdSet model for additional AdSet details
+    });
+  };
+
+  return AdSetPerformance;
+};