agrs-sequelize-sdk 1.4.16 → 1.4.18

package/models/AdsetPerformance.js

@@ -1,126 +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
-      }
-    },
-    {
-      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;
-};
+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;
+};

package/models/AiArticleRetryQueue.js

@@ -1,150 +1,157 @@
-module.exports = (sequelize, DataTypes) => {
-  const AiArticleRetryQueue = sequelize.define(
-    "AiArticleRetryQueue",
-    {
-      id: {
-        type: DataTypes.INTEGER,
-        primaryKey: true,
-        autoIncrement: true,
-      },
-      agrs_cid: {
-        type: DataTypes.STRING(255),
-        allowNull: false,
-        field: "agrs_cid",
-        comment: "AGRS Campaign ID (links to the campaign combo)",
-      },
-      process_id: {
-        type: DataTypes.STRING(255),
-        allowNull: true,
-        field: "process_id",
-        comment: "Root process_id from createAICampaign",
-      },
-      controller_process_id: {
-        type: DataTypes.UUID,
-        allowNull: true,
-        field: "controller_process_id",
-        comment: "Per-campaign process_id (for CampaignCreationLog)",
-      },
-      feed_provider: {
-        type: DataTypes.STRING(100),
-        allowNull: false,
-        field: "feed_provider",
-        comment: "Normalized feed name: Mine - RSOC, Predicto - RSOC, etc.",
-      },
-      article_creation_payload: {
-        type: DataTypes.JSONB,
-        allowNull: false,
-        field: "article_creation_payload",
-        comment: "Exact params to pass to createMineArticle/createPredictoArticle/etc.",
-      },
-      original_payload: {
-        type: DataTypes.JSONB,
-        allowNull: true,
-        field: "original_payload",
-        comment: "Full original_payload from createAICampaign (preset, feed config, AI settings, combo values)",
-      },
-      generated_assets: {
-        type: DataTypes.JSONB,
-        allowNull: true,
-        field: "generated_assets",
-        comment: "Already-generated assets: { headlines, primaryTexts, bannerFiles, keywords }",
-      },
-      campaign_context: {
-        type: DataTypes.JSONB,
-        allowNull: true,
-        field: "campaign_context",
-        comment: "Additional context needed to resume campaign flow after article succeeds",
-      },
-      status: {
-        type: DataTypes.STRING(50),
-        allowNull: false,
-        defaultValue: "pending",
-        validate: {
-          isIn: [["pending", "processing", "completed", "failed", "abandoned"]],
-        },
-      },
-      retry_count: {
-        type: DataTypes.INTEGER,
-        allowNull: false,
-        defaultValue: 0,
-        field: "retry_count",
-      },
-      max_retries: {
-        type: DataTypes.INTEGER,
-        allowNull: false,
-        defaultValue: 10,
-        field: "max_retries",
-      },
-      next_retry_at: {
-        type: DataTypes.DATE,
-        allowNull: false,
-        field: "next_retry_at",
-        comment: "When the next retry should be attempted",
-      },
-      last_error: {
-        type: DataTypes.TEXT,
-        allowNull: true,
-        field: "last_error",
-      },
-      last_attempt_at: {
-        type: DataTypes.DATE,
-        allowNull: true,
-        field: "last_attempt_at",
-      },
-      created_at: {
-        type: DataTypes.DATE,
-        allowNull: false,
-        defaultValue: DataTypes.NOW,
-        field: "created_at",
-      },
-      completed_at: {
-        type: DataTypes.DATE,
-        allowNull: true,
-        field: "completed_at",
-      },
-      article_id: {
-        type: DataTypes.STRING(255),
-        allowNull: true,
-        field: "article_id",
-        comment: "AGRSAID of created article (populated on success)",
-      },
-      article_url: {
-        type: DataTypes.TEXT,
-        allowNull: true,
-        field: "article_url",
-        comment: "URL of created article (populated on success)",
-      },
-    },
-    {
-      tableName: "ai_article_retry_queue",
-      timestamps: false,
-      indexes: [
-        {
-          fields: ["status", "next_retry_at"],
-          name: "idx_article_retry_status_next",
-        },
-        {
-          fields: ["agrs_cid"],
-        },
-        {
-          fields: ["feed_provider"],
-        },
-        {
-          fields: ["process_id"],
-        },
-        {
-          fields: ["controller_process_id"],
-        },
-        {
-          fields: ["created_at"],
-        },
-      ],
-    }
-  );
-
-  AiArticleRetryQueue.associate = (models) => {
-    // No associations needed for now
-  };
-
-  return AiArticleRetryQueue;
-};
+module.exports = (sequelize, DataTypes) => {
+  const AiArticleRetryQueue = sequelize.define(
+    "AiArticleRetryQueue",
+    {
+      id: {
+        type: DataTypes.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      agrs_cid: {
+        type: DataTypes.STRING(255),
+        allowNull: false,
+        field: "agrs_cid",
+        comment: "AGRS Campaign ID (links to the campaign combo)",
+      },
+      process_id: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+        field: "process_id",
+        comment: "Root process_id from createAICampaign",
+      },
+      controller_process_id: {
+        type: DataTypes.UUID,
+        allowNull: true,
+        field: "controller_process_id",
+        comment: "Per-campaign process_id (for CampaignCreationLog)",
+      },
+      feed_provider: {
+        type: DataTypes.STRING(100),
+        allowNull: false,
+        field: "feed_provider",
+        comment: "Normalized feed name: Mine - RSOC, Predicto - RSOC, etc.",
+      },
+      article_creation_payload: {
+        type: DataTypes.JSONB,
+        allowNull: false,
+        field: "article_creation_payload",
+        comment: "Exact params to pass to createMineArticle/createPredictoArticle/etc.",
+      },
+      original_payload: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+        field: "original_payload",
+        comment: "Full original_payload from createAICampaign (preset, feed config, AI settings, combo values)",
+      },
+      generated_assets: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+        field: "generated_assets",
+        comment: "Already-generated assets: { headlines, primaryTexts, bannerFiles, keywords }",
+      },
+      campaign_context: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+        field: "campaign_context",
+        comment: "Additional context needed to resume campaign flow after article succeeds",
+      },
+      status: {
+        type: DataTypes.STRING(50),
+        allowNull: false,
+        defaultValue: "pending",
+        validate: {
+          isIn: [["pending", "processing", "completed", "failed", "abandoned"]],
+        },
+      },
+      retry_count: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+        defaultValue: 0,
+        field: "retry_count",
+      },
+      max_retries: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+        defaultValue: 10,
+        field: "max_retries",
+      },
+      next_retry_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+        field: "next_retry_at",
+        comment: "When the next retry should be attempted",
+      },
+      last_error: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        field: "last_error",
+      },
+      last_attempt_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+        field: "last_attempt_at",
+      },
+      created_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+        defaultValue: DataTypes.NOW,
+        field: "created_at",
+      },
+      completed_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+        field: "completed_at",
+      },
+      article_id: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+        field: "article_id",
+        comment: "AGRSAID of created article (populated on success)",
+      },
+      article_url: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        field: "article_url",
+        comment: "URL of created article (populated on success)",
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        field: "platform",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      tableName: "ai_article_retry_queue",
+      timestamps: false,
+      indexes: [
+        {
+          fields: ["status", "next_retry_at"],
+          name: "idx_article_retry_status_next",
+        },
+        {
+          fields: ["agrs_cid"],
+        },
+        {
+          fields: ["feed_provider"],
+        },
+        {
+          fields: ["process_id"],
+        },
+        {
+          fields: ["controller_process_id"],
+        },
+        {
+          fields: ["created_at"],
+        },
+      ],
+    }
+  );
+
+  AiArticleRetryQueue.associate = (models) => {
+    // No associations needed for now
+  };
+
+  return AiArticleRetryQueue;
+};