feat: onboard topsort destination

src/v0/destinations/topsort/config.js

@@ -0,0 +1,31 @@
+const { getMappingConfig } = require('../../util');
+
+const BASE_URL = 'https://api.topsort.com/v2/events';
+
+const ConfigCategory = {
+  TRACK: {
+    type: 'track',
+    name: 'TopsortTrackConfig',
+  },
+  PLACEMENT: { name: 'TopsortPlacementConfig' },
+  ITEM: { name: 'TopsortItemConfig' },
+  PURCHASE_ITEM: { name: 'TopSortPurchaseProductConfig' },
+};
+
+const ECOMM_EVENTS_WITH_PRODUCT_ARRAY = [
+  'Cart Viewed',
+  'Checkout Started',
+  'Order Updated',
+  'Order Completed',
+  'Order Refunded',
+  'Order Cancelled',
+];
+
+const mappingConfig = getMappingConfig(ConfigCategory, __dirname);
+
+module.exports = {
+  mappingConfig,
+  ConfigCategory,
+  BASE_URL,
+  ECOMM_EVENTS_WITH_PRODUCT_ARRAY,
+};

src/v0/destinations/topsort/data/TopSortPurchaseProductConfig.json

@@ -0,0 +1,21 @@
+[
+  {
+    "destKey": "productId",
+    "sourceKeys": ["product_id", "properties.product_id"]
+  },
+  {
+    "destKey": "unitPrice",
+    "sourceKeys": ["price", "properties.price"],
+    "metadata": {
+      "type": "toNumber"
+    }
+  },
+  {
+    "destKey": "quantity",
+    "sourceKeys": ["quantity", "properties.quantity"]
+  },
+  {
+    "destKey": "vendorId",
+    "sourceKeys": "properties.vendorId"
+  }
+]

src/v0/destinations/topsort/data/TopsortItemConfig.json

@@ -0,0 +1,12 @@
+[
+  {
+    "destKey": "position",
+    "sourceKeys": ["properties.position", "position"],
+    "required": false
+  },
+  {
+    "destKey": "productId",
+    "sourceKeys": ["properties.product_id", "product_id"],
+    "required": false
+  }
+]

src/v0/destinations/topsort/data/TopsortPlacementConfig.json

@@ -0,0 +1,30 @@
+[
+  {
+    "destKey": "path",
+    "sourceKeys": "context.page.path",
+    "required": true
+  },
+  {
+    "destKey": "searchQuery",
+    "sourceKeys": "properties.query",
+    "required": false
+  },
+  {
+    "destKey": "page",
+    "sourceKeys": "properties.pageNumber",
+    "required": false
+  },
+  {
+    "destKey": "pageSize",
+    "sourceKeys": "properties.pageSize",
+    "required": false
+  },
+  {
+    "destKey": "categoryIds",
+    "sourceKeys": "properties.category_id",
+    "required": false,
+    "metadata": {
+      "toArray": true
+    }
+  }
+]

src/v0/destinations/topsort/data/TopsortTrackConfig.json

@@ -0,0 +1,30 @@
+[
+  {
+    "destKey": "occurredAt",
+    "sourceKeys": ["originalTimestamp", "timestamp"],
+    "metadata": {
+      "type": "timestamp"
+    },
+    "required": true
+  },
+  {
+    "destKey": "opaqueUserId",
+    "sourceKeys": "anonymousId",
+    "required": true
+  },
+  {
+    "destKey": "resolvedBidId",
+    "sourceKeys": "properties.resolvedBidId",
+    "required": false
+  },
+  {
+    "destKey": "entity",
+    "sourceKeys": "properties.entity",
+    "required": false
+  },
+  {
+    "destKey": "additionalAttribution",
+    "sourceKeys": "properties.additionalAttribution",
+    "required": false
+  }
+]

src/v0/destinations/topsort/transform.js

@@ -0,0 +1,103 @@
+const {
+  InstrumentationError,
+  ConfigurationError,
+  getHashFromArray,
+} = require('@rudderstack/integrations-lib');
+const { mappingConfig, ECOMM_EVENTS_WITH_PRODUCT_ARRAY, ConfigCategory } = require('./config');
+const { constructPayload, simpleProcessRouterDest } = require('../../util');
+const {
+  isProductArrayValid,
+  getMappedEventName,
+  processImpressionsAndClicksUtility,
+  processPurchaseEventUtility,
+} = require('./utils');
+
+const responseBuilder = (message, { Config }) => {
+  const { topsortEvents } = Config;
+  const { event, properties } = message;
+  const { products } = properties;
+
+  // Parse Topsort event mappings
+  const mappedEventName = getMappedEventName(getHashFromArray(topsortEvents), event);
+
+  if (!mappedEventName) {
+    throw new InstrumentationError("Event not mapped in 'topsortEvents'. Dropping the event.");
+  }
+
+  const topsortEventName = mappedEventName;
+
+  // Construct base and placement payloads
+  const basePayload = constructPayload(message, mappingConfig[ConfigCategory.TRACK.name]);
+
+  const finalPayloads = {
+    impressions: [],
+    clicks: [],
+    purchases: [],
+  };
+
+  const commonArgs = {
+    basePayload,
+    topsortEventName,
+    finalPayloads,
+    products,
+    message,
+    isProductArrayAvailable:
+      ECOMM_EVENTS_WITH_PRODUCT_ARRAY.includes(event) && isProductArrayValid(event, properties),
+  };
+
+  // Process events based on type and construct payload within each logic block
+  if (topsortEventName === 'impressions' || topsortEventName === 'clicks') {
+    const placementPayload = constructPayload(
+      message,
+      mappingConfig[ConfigCategory.PLACEMENT.name],
+    );
+    processImpressionsAndClicksUtility.processImpressionsAndClicks({
+      ...commonArgs,
+      placementPayload, // Only pass placementPayload for impressions and clicks
+    });
+  } else if (topsortEventName === 'purchases') {
+    const purchasePayload = constructPayload(
+      message,
+      mappingConfig[ConfigCategory.PURCHASE_ITEM.name],
+    );
+    processPurchaseEventUtility.processPurchaseEvent({
+      ...commonArgs,
+      purchasePayload, // Only pass purchasePayload for purchase events
+    });
+  } else {
+    throw new InstrumentationError(`Unknown event type: ${topsortEventName}`);
+  }
+
+  return finalPayloads;
+};
+
+const processEvent = (message, destination) => {
+  // Check for missing API Key or missing Advertiser ID
+  if (!destination.Config.apiKey) {
+    throw new ConfigurationError('API Key is missing. Aborting message.', 400);
+  }
+  if (!message.type) {
+    throw new InstrumentationError('Message Type is missing. Aborting message.', 400);
+  }
+
+  const messageType = message.type.toLowerCase();
+
+  // Handle 'track' event type
+  if (messageType !== 'track') {
+    throw new InstrumentationError('Only "track" events are supported. Dropping event.', 400);
+  }
+
+  return responseBuilder(message, destination);
+};
+
+// Process function that is called per event
+const process = (event) => processEvent(event.message, event.destination);
+
+// Router destination handler to process a batch of events
+const processRouterDest = async (inputs, reqMetadata) => {
+  // Process all events through the simpleProcessRouterDest utility
+  const respList = await simpleProcessRouterDest(inputs, process, reqMetadata);
+  return respList;
+};
+
+module.exports = { process, processRouterDest };