agrs-sequelize-sdk 1.1.91 → 1.1.94

package/agrs-sequelize/models/Article.js

@@ -0,0 +1,156 @@
+module.exports = (sequelize, DataTypes) => {
+  const Article = sequelize.define(
+    "Article",
+    {
+      providerId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        unique: true,
+      },
+      category: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      AGRSAID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        unique: true,
+      },
+      articleUrl: {
+        type: DataTypes.STRING(1024),
+        allowNull: true,
+      },
+      feed: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      feedName: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      vertical: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      language: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "en",
+      },
+      headline: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      topics: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: true,
+      },
+      mainKeyword: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      keywords: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: true,
+      },
+      date: {
+        type: DataTypes.DATE,
+        allowNull: true,
+        defaultValue: DataTypes.NOW,
+      },
+      nativeKeyword: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      suggestedKeywords: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      articleExcerpt: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+      },
+      articleContent: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+      },
+      fbPixelId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      status: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "pending",
+        validate: {
+          isIn: [
+            [
+              "pending",
+              "approved",
+              "rejected",
+              "disapproved",
+              "duplicated",
+              "keyword_already_exists",
+              "invalid_vertical",
+              "invalid_language",
+              "in_review",
+              "error",
+            ],
+          ],
+        },
+      },
+      originalStatus: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "Original status from Predicto before any mapping",
+      },
+      creationType: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "slug",
+        validate: {
+          isIn: [["search", "slug"]],
+        },
+      },
+      createdAt: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+      updatedAt: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+      buyer: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      country: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      name: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "articles",
+      timestamps: true,
+    }
+  );
+
+  Article.associate = (models) => {
+    Article.hasMany(models.RSOCFeedCampaign, {
+      foreignKey: "AGRSAID",
+      sourceKey: "AGRSAID",
+      as: "RSOCFeedCampaigns",
+      constraints: false,
+    });
+  };
+
+  Article.prototype.isAvailableForCampaign = function () {
+    return ["approved", "keyword_already_exists"].includes(this.status);
+  };
+
+  return Article;
+};

package/agrs-sequelize/models/Buyers.js

@@ -0,0 +1,26 @@
+module.exports = (sequelize, DataTypes) => {
+    const Buyers = sequelize.define(
+      "Buyers",
+      {
+        id: {
+          type: DataTypes.UUID,
+          defaultValue: DataTypes.UUIDV4,
+          primaryKey: true,
+        },
+        name: {
+          type: DataTypes.STRING,
+          allowNull: false,
+        },
+        code: {
+            type: DataTypes.STRING,
+            allowNull: false,
+            unique: true, 
+        },
+      },
+      {
+        tableName: "Buyers",
+      }
+    );
+  
+    return Buyers;
+  };

package/agrs-sequelize/models/Campaign.js

@@ -0,0 +1,136 @@
+module.exports = (sequelize, DataTypes) => {
+  const Campaign = sequelize.define(
+    "Campaign",
+    {
+      CampaignID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      CampaignName: {
+        type: DataTypes.STRING,
+        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,
+      },
+    },
+    {
+      tableName: "Campaign",
+      indexes: [
+        {
+          fields: ["AdAccountID"], // Index on AdAccountID for faster joins
+        },
+      ],
+    }
+  );
+
+  // 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/agrs-sequelize/models/CampaignCreationLog.js

@@ -0,0 +1,86 @@
+// 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"),
+        allowNull: false,
+        defaultValue: "STARTED",
+      },
+      country: {
+        type: DataTypes.STRING,
+        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",
+      },
+    },
+    {
+      tableName: "CampaignCreationLogs",
+      timestamps: true,
+      indexes: [
+        {
+          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,
+      });
+    }
+  };
+
+  return CampaignCreationLog;
+};

package/agrs-sequelize/models/CampaignHistory.js

@@ -0,0 +1,33 @@
+module.exports = (sequelize, DataTypes) => {
+  const CampaignHistory = sequelize.define(
+    "CampaignHistory",
+    {
+      HistoryID: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      CampaignID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      TableName: {
+        type: DataTypes.STRING, // Useful for multi-table history tracking
+        defaultValue: "Campaign",
+      },
+      DataSnapshot: {
+        type: DataTypes.JSONB, // Store the entire row as JSON
+        allowNull: false,
+      },
+      timestamp: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+    },
+    {
+      tableName: "CampaignHistory",
+    }
+  );
+
+  return CampaignHistory;
+};

package/agrs-sequelize/models/Channel.js

@@ -0,0 +1,55 @@
+module.exports = (sequelize, DataTypes) => {
+  const Channel = sequelize.define(
+    "Channel",
+    {
+      channelId: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        // Not setting as primary key or unique since duplicates are allowed
+      },
+      styleId: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      status: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "free",
+        validate: {
+          isIn: [["free", "used", "archived"]],
+        },
+      },
+      connectedCampaigns: {
+        type: DataTypes.JSONB, // Use JSONB for better querying capabilities
+        allowNull: false,
+        defaultValue: [],
+      },
+    },
+    {
+      tableName: "channels",
+      timestamps: true,
+      indexes: [
+        // Add a composite unique index on channelId and styleId if needed
+        {
+          unique: true,
+          fields: ["channelId", "styleId"],
+          name: "unique_channel_style",
+        },
+      ],
+    }
+  );
+
+  // Define associations without enforcing constraints
+  Channel.associate = (models) => {
+    if (models.RSOCFeedCampaign) {
+      Channel.hasMany(models.RSOCFeedCampaign, {
+        foreignKey: "channelId",
+        sourceKey: "channelId",
+        as: "RSOCFeedCampaigns",
+        constraints: false, // Disable FK constraint
+      });
+    }
+  };
+
+  return Channel;
+};

package/agrs-sequelize/models/CodefuelCampaign.js

@@ -0,0 +1,159 @@
+const { DataTypes } = require("sequelize");
+module.exports = (sequelize, DataTypes) => {
+  const CodefuelCampaign = sequelize.define("CodefuelCampaign", {
+    AGRSCID: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      unique: true,
+      primaryKey: true,
+    },
+    Assignee: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    Status: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    Country: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    Vertical: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    FreeText: {
+      type: DataTypes.TEXT,
+      allowNull: true,
+    },
+    CampaignName: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    CampaignID: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    KW: {
+      type: DataTypes.ARRAY(DataTypes.STRING),
+      allowNull: true,
+    },
+    FinalLink: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    RedirectLink: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    PixelID: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    Token: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    AccountID: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    FeedName: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    AdTitle: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Domain: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    feedProvider: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      defaultValue: "CodeFuel",
+    },
+    lastUpdateKw: {
+      type: DataTypes.DATE,
+      allowNull: true,
+    },
+    createdCampaignAt: {
+      type: DataTypes.DATE,
+      allowNull: true, // Ensure this is allowed to be null if necessary
+      defaultValue: DataTypes.NOW,
+    },
+    Draft: {
+      type: DataTypes.BOOLEAN,
+      allowNull: true,
+      defaultValue: false,
+    },
+  });
+  CodefuelCampaign.associate = (models) => {
+    CodefuelCampaign.hasMany(models.Ad, {
+      foreignKey: "AGRS_CID",
+      sourceKey: "AGRSCID",
+      as: "Ads",
+      constraints: false,
+    });
+  };
+
+  CodefuelCampaign.beforeCreate(async (campaign, options) => {
+    // Ensure RedirectLink is set when AGRSCID is defined during creation
+    const AGRSCID = campaign.getDataValue("AGRSCID");
+    if (AGRSCID) {
+      const redirectLink = `https://ktwrjqdfv.com/${AGRSCID}?campaign_name={{campaign.name}}&adset_name={{adset.name}}&ad_name={{ad.name}}&campaign_id={{campaign.id}}&adset_id={{adset.id}}&ad_id={{ad.id}}_${AGRSCID}&placement={{placement}}&site_source={{site_source}}&fbclid={{fbclid}}`;
+      campaign.setDataValue("RedirectLink", redirectLink);
+    }
+  });
+
+  CodefuelCampaign.beforeUpdate(async (campaign, options) => {
+    if (campaign.changed("KW")) {
+      const previousKW = campaign.previous("KW");
+      const currentHistory =
+        await sequelize.models.CodefuelCampaignKWHistory.findAll({
+          where: { campaignId: campaign.AGRSCID },
+          order: [["version", "DESC"]],
+        });
+      const nextVersion = currentHistory.length
+        ? currentHistory[0].version + 1
+        : 1;
+      await sequelize.models.CodefuelCampaignKWHistory.create({
+        campaignId: campaign.AGRSCID,
+        kw: previousKW,
+        version: nextVersion,
+      });
+    }
+
+    // Update RedirectLink when AGRSCID is changed
+    if (campaign.changed("AGRSCID")) {
+      const AGRSCID = campaign.getDataValue("AGRSCID");
+      if (AGRSCID) {
+        const redirectLink = `https://ktwrjqdfv.com/${AGRSCID}?campaign_name={{campaign.name}}&adset_name={{adset.name}}&ad_name={{ad.name}}&campaign_id={{campaign.id}}&adset_id={{adset.id}}&ad_id={{ad.id}}_${AGRSCID}&placement={{placement}}&site_source_name={{site_source}}&fbclid={{fbclid}}`;
+        campaign.setDataValue("RedirectLink", redirectLink);
+      }
+    }
+  });
+
+  CodefuelCampaign.beforeSave(async (campaign, options) => {
+    // Catch-all logic to set RedirectLink if AGRSCID is set during save
+    console.log("beforeSave", campaign);
+    const AGRSCID = campaign.getDataValue("AGRSCID");
+    if (AGRSCID && !campaign.getDataValue("RedirectLink")) {
+      const redirectLink = `https://ktwrjqdfv.com/${AGRSCID}?campaign_name={{campaign.name}}&adset_name={{adset.name}}&ad_name={{ad.name}}&campaign_id={{campaign.id}}&adset_id={{adset.id}}&ad_id={{ad.id}}_${AGRSCID}&placement={{placement}}&site_source_name={{site_source}}&fbclid={{fbclid}}`;
+      campaign.setDataValue("RedirectLink", redirectLink);
+    }
+  });
+
+  CodefuelCampaign.afterUpdate(async (campaign, options) => {
+    console.log("afterUpdate", campaign);
+  });
+
+  CodefuelCampaign.afterCreate(async (campaign, options) => {
+    console.log("afterCreate", campaign);
+  });
+
+  return CodefuelCampaign;
+};

package/agrs-sequelize/models/CodefuelCampaignKWHistory.js

@@ -0,0 +1,41 @@
+const { DataTypes } = require("sequelize");
+
+module.exports = (sequelize, DataTypes) => {
+  const CodefuelCampaignKWHistory = sequelize.define(
+    "CodefuelCampaignKWHistory",
+    {
+      id: {
+        type: DataTypes.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+      },
+      campaignId: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      kw: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: false,
+      },
+      version: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+      },
+      createdAt: {
+        type: DataTypes.DATE,
+        allowNull: false,
+        defaultValue: DataTypes.NOW,
+      },
+    }
+  );
+
+  CodefuelCampaignKWHistory.associate = (models) => {
+    CodefuelCampaignKWHistory.belongsTo(models.CodefuelCampaign, {
+      foreignKey: "campaignId",
+      targetKey: "AGRSCID",
+      onDelete: "CASCADE",
+    });
+  };
+
+  return CodefuelCampaignKWHistory;
+};