agrs-sequelize-sdk 1.4.18 → 1.4.21

package/.worktrees/creation-logs-platform-code/models/Campaign.js

@@ -0,0 +1,163 @@
+module.exports = (sequelize, DataTypes) => {
+  const Campaign = sequelize.define(
+    "Campaign",
+    {
+      CampaignID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      CampaignName: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+      },
+      pixelId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      customEventType: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "PURCHASE",
+      },
+      objective: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "OUTCOME_SALES",
+      },
+      status: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      AdAccountID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        references: {
+          model: "AdAccount",
+          key: "AdAccountID",
+        },
+      },
+      CreatedTime: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+      CampaignDelivery: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      DailyBudget: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Draft: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: false,
+      },
+      publish: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: true,
+      },
+      UserCreated: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      special_ad_categories: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: true,
+      },
+      effectiveStatus: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      issuesInfo: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      waiting: {
+        type: DataTypes.BOOLEAN,
+        defaultValue: false,
+      },
+      policy_status: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "Facebook policy status: APPROVED, DENIED, PENDING, etc.",
+      },
+      policy_rejection_reason: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        comment: "Detailed reason for policy rejection",
+      },
+      first_spend_date: {
+        type: DataTypes.DATEONLY,
+        allowNull: true,
+        comment:
+          "First date when campaign had spend > 0 (for accurate days_running calculation)",
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      tableName: "Campaign",
+      indexes: [
+        {
+          fields: ["AdAccountID"], // Index on AdAccountID for faster joins
+        },
+        {
+          fields: ["first_spend_date"], // Index for days_running calculations
+        },
+        {
+          fields: ["CampaignID", "first_spend_date"], // Composite index for performance queries
+        },
+      ],
+    }
+  );
+
+  // Define associations
+  Campaign.associate = (models) => {
+    Campaign.belongsTo(models.AdAccount, { foreignKey: "AdAccountID" });
+    Campaign.hasMany(models.AdSet, { foreignKey: "CampaignID" });
+  };
+
+  // Combined beforeUpdate hook
+  Campaign.addHook("beforeUpdate", async (campaign, options) => {
+    if (campaign.changed("publish")) {
+      if (campaign.previous("publish") === true && campaign.publish === false) {
+        // Save current state to CampaignHistory
+        await sequelize.models.CampaignHistory.create({
+          CampaignID: campaign.CampaignID,
+          DataSnapshot: campaign._previousDataValues, // Store current state as JSON
+        });
+      } else if (
+        campaign.previous("publish") === false &&
+        campaign.publish === true
+      ) {
+        // Delete the latest history entry
+        const latestHistory = await sequelize.models.CampaignHistory.findOne({
+          where: { CampaignID: campaign.CampaignID },
+          order: [["timestamp", "DESC"]], // Get the latest history entry
+        });
+
+        if (latestHistory) {
+          await latestHistory.destroy(); // Delete the latest history entry
+        }
+      }
+    }
+  });
+
+  Campaign.addHook("afterCreate", async (campaign, options) => {
+    if (campaign.publish === false) {
+      // If publish is false on creation, save a snapshot to CampaignHistory
+      await sequelize.models.CampaignHistory.create({
+        CampaignID: campaign.CampaignID,
+        DataSnapshot: campaign.toJSON(), // Save current state
+      });
+    }
+  });
+
+  return Campaign;
+};

package/.worktrees/creation-logs-platform-code/models/CampaignActionHistory.js

@@ -0,0 +1,86 @@
+module.exports = (sequelize, DataTypes) => {
+  const CampaignActionHistory = sequelize.define(
+    "CampaignActionHistory",
+    {
+      id: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      objectId: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        comment:
+          "ID of the object being tracked (campaignId, AGRSCID, adsetId, etc.)",
+        index: true,
+      },
+      objectType: {
+        type: DataTypes.ENUM("campaign", "agrscid", "adset", "ad"),
+        allowNull: false,
+        comment: "Type of object to know what objectId represents",
+        index: true,
+      },
+      actionType: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        comment:
+          "Type of action: budget_update, bid_update, keyword_update, duplicated, etc.",
+        index: true,
+      },
+      previousValue: {
+        type: DataTypes.JSON,
+        allowNull: true,
+        comment: "Previous value before the action",
+      },
+      newValue: {
+        type: DataTypes.JSON,
+        allowNull: true,
+        comment: "New value after the action",
+      },
+      details: {
+        type: DataTypes.JSON,
+        allowNull: true,
+        comment: "Additional context and metadata about the action",
+      },
+      userId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "ID of the user who performed the action",
+      },
+      createdAt: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+        allowNull: false,
+        index: true,
+      },
+      updatedAt: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+    },
+    {
+      tableName: "CampaignActionHistories",
+      timestamps: true,
+      indexes: [
+        {
+          fields: ["objectId", "objectType"],
+          name: "idx_object_id_type",
+        },
+        {
+          fields: ["actionType"],
+          name: "idx_action_type",
+        },
+        {
+          fields: ["createdAt"],
+          name: "idx_created_at",
+        },
+        {
+          fields: ["objectId", "actionType"],
+          name: "idx_object_action",
+        },
+      ],
+    }
+  );
+
+  return CampaignActionHistory;
+};

package/.worktrees/creation-logs-platform-code/models/CampaignCreationLog.js

@@ -0,0 +1,321 @@
+// models/CampaignCreationLog.js
+module.exports = (sequelize, DataTypes) => {
+  const CampaignCreationLog = sequelize.define(
+    "CampaignCreationLog",
+    {
+      id: {
+        type: DataTypes.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      process_id: {
+        type: DataTypes.UUID,
+        allowNull: false,
+        comment: "Unique ID for the creation batch process",
+      },
+      status: {
+        type: DataTypes.ENUM(
+          "STARTED",
+          "IN_PROGRESS",
+          "COMPLETED",
+          "FAILED",
+          "PARTIALLY_COMPLETED"
+        ),
+        allowNull: false,
+        defaultValue: "STARTED",
+      },
+      country: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        comment: "Country being processed",
+      },
+      feed_campaign_id: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "AGRS_CID of the created feed campaign",
+      },
+      facebook_campaign_id: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "Facebook campaign ID if created",
+      },
+      details: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+        comment: "Additional details about the process or results",
+      },
+      error_message: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        comment: "Error message if process failed",
+      },
+      vertical: {
+        type: DataTypes.STRING(100),
+        allowNull: true,
+        comment: "Campaign vertical (e.g., babydiapers, veteranbenefits)",
+      },
+      feed_provider: {
+        type: DataTypes.STRING(100),
+        allowNull: true,
+        comment: "Feed provider (e.g., predicto.ai, compado)",
+      },
+      media_buyer: {
+        type: DataTypes.STRING(100),
+        allowNull: true,
+        comment: "Media buyer/assignee (e.g., dug, ida)",
+      },
+      account_id: {
+        type: DataTypes.STRING(100),
+        allowNull: true,
+        comment: "Facebook account ID",
+      },
+      campaign_name: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+        comment: "Campaign name",
+      },
+      assignee: {
+        type: DataTypes.STRING(100),
+        allowNull: true,
+        comment: "Alternative assignee field",
+      },
+      facebook_campaign_name: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+        comment: "Facebook campaign name",
+      },
+      notes: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        comment: "Campaign notes/freeText",
+      },
+      free_text: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        comment: "Free text content",
+      },
+      ad_title: {
+        type: DataTypes.STRING(500),
+        allowNull: true,
+        comment: "Ad title",
+      },
+      keywords: {
+        type: DataTypes.ARRAY(DataTypes.TEXT),
+        allowNull: true,
+        comment: "Campaign keywords array",
+      },
+      countries: {
+        type: DataTypes.ARRAY(DataTypes.TEXT),
+        allowNull: true,
+        comment: "Target countries array",
+      },
+      platform: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "Platform (e.g., Facebook)",
+      },
+      platform_code: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment:
+          "Canonical ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+      bid_strategy: {
+        type: DataTypes.STRING(100),
+        allowNull: true,
+        comment: "Bid strategy",
+      },
+      daily_budget: {
+        type: DataTypes.DECIMAL(10, 2),
+        allowNull: true,
+        comment: "Daily budget amount",
+      },
+      bid_amount: {
+        type: DataTypes.DECIMAL(10, 2),
+        allowNull: true,
+        comment: "Bid amount",
+      },
+      language: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "Campaign language",
+      },
+      domain: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+        comment: "Campaign domain",
+      },
+      page_id: {
+        type: DataTypes.UUID,
+        allowNull: true,
+        comment: "Facebook Page ID (UUID from Pages table)",
+      },
+      page_code: {
+        type: DataTypes.STRING(100),
+        allowNull: true,
+        comment: "Page code (unique identifier from Pages table)",
+      },
+    },
+    {
+      tableName: "CampaignCreationLogs",
+      timestamps: true,
+      indexes: [
+        // CRITICAL: Main performance index for your DISTINCT ON query
+        {
+          name: "idx_campaign_logs_process_created_desc",
+          fields: ["process_id", { name: "createdAt", order: "DESC" }],
+        },
+        // JSON search optimization for account ID filtering
+        {
+          name: "idx_campaign_logs_details_gin",
+          fields: ["details"],
+          using: "gin",
+        },
+        {
+          name: "idx_campaign_logs_vertical",
+          fields: ["vertical"],
+        },
+        {
+          name: "idx_campaign_logs_feed_provider",
+          fields: ["feed_provider"],
+        },
+        {
+          name: "idx_campaign_logs_media_buyer",
+          fields: ["media_buyer"],
+        },
+        {
+          name: "idx_campaign_logs_account_id",
+          fields: ["account_id"],
+        },
+        {
+          name: "idx_campaign_logs_campaign_name",
+          fields: ["campaign_name"],
+        },
+        {
+          name: "idx_campaign_logs_assignee",
+          fields: ["assignee"],
+        },
+        {
+          name: "idx_campaign_logs_keywords",
+          fields: ["keywords"],
+          using: "gin",
+        },
+        {
+          name: "idx_campaign_logs_countries",
+          fields: ["countries"],
+          using: "gin",
+        },
+        // Composite index for status + country filters
+        {
+          name: "idx_campaign_logs_status_country",
+          fields: ["status", "country"],
+        },
+        {
+          name: "idx_campaign_logs_vertical_status",
+          fields: ["vertical", "status"],
+        },
+        {
+          name: "idx_campaign_logs_feed_provider_status",
+          fields: ["feed_provider", "status"],
+        },
+        {
+          name: "idx_campaign_logs_media_buyer_status",
+          fields: ["media_buyer", "status"],
+        },
+        {
+          name: "idx_campaign_logs_account_id_status",
+          fields: ["account_id", "status"],
+        },
+        {
+          name: "idx_campaign_logs_vertical_feed_provider",
+          fields: ["vertical", "feed_provider"],
+        },
+        {
+          name: "idx_campaign_logs_media_buyer_vertical",
+          fields: ["media_buyer", "vertical"],
+        },
+        {
+          name: "idx_campaign_logs_process_status_created",
+          fields: ["process_id", "status", "createdAt"],
+        },
+        {
+          name: "idx_campaign_logs_created_at_desc",
+          fields: [{ name: "createdAt", order: "DESC" }],
+          comment: "Critical for last day filtering and sorting by date",
+        },
+        {
+          name: "idx_campaign_logs_status_created_at",
+          fields: ["status", { name: "createdAt", order: "DESC" }],
+          comment: "Optimized for filtering by status within date ranges",
+        },
+        {
+          name: "idx_campaign_logs_process_created_at_desc",
+          fields: ["process_id", { name: "createdAt", order: "DESC" }],
+          comment: "Optimized for DISTINCT ON queries with date ordering",
+        },
+        {
+          name: "idx_campaign_logs_account_process",
+          fields: ["account_id", "process_id"],
+          comment: "For process-level account filtering v2",
+        },
+        {
+          name: "idx_campaign_logs_page_id",
+          fields: ["page_id"],
+          comment: "For page filtering",
+        },
+        {
+          name: "idx_campaign_logs_page_code",
+          fields: ["page_code"],
+          comment: "For page code filtering",
+        },
+        {
+          name: "idx_campaign_logs_platform_code",
+          fields: ["platform_code"],
+          comment: "For canonical platform filtering",
+        },
+        {
+          fields: ["process_id"],
+        },
+        {
+          fields: ["status"],
+        },
+        {
+          fields: ["country"],
+        },
+        {
+          fields: ["feed_campaign_id"],
+        },
+        {
+          fields: ["facebook_campaign_id"],
+        },
+        {
+          fields: ["createdAt"],
+        },
+      ],
+    }
+  );
+
+  CampaignCreationLog.associate = (models) => {
+    // Add associations if needed
+    if (models.CodefuelCampaign) {
+      CampaignCreationLog.belongsTo(models.CodefuelCampaign, {
+        foreignKey: "feed_campaign_id",
+        targetKey: "AGRSCID",
+        as: "FeedCampaign",
+        constraints: false,
+      });
+    }
+
+    if (models.Pages) {
+      CampaignCreationLog.belongsTo(models.Pages, {
+        foreignKey: "page_code",
+        targetKey: "code",
+        as: "Page",
+        constraints: false,
+      });
+    }
+  };
+
+  return CampaignCreationLog;
+};