Feat/infobip lookup variable

.gitignore

@@ -1 +1,6 @@
-server-gtm-sandboxed-apis.d.ts
+server-gtm-sandboxed-apis.d.ts
+**/.DS_Store
+node_modules
+jsconfig.json
+package-lock.json
+package.json

.prettierrc

@@ -2,5 +2,5 @@
   "singleQuote": true,
   "trailingComma": "none",
   "tabWidth": 2,
-  "printWidth": 200
-}
+  "printWidth": 100
+}

README.md

@@ -1,7 +1,38 @@
-# Infobip Lookup Variable for Google Tag Manager Server Container
+# Infobip CDP Lookup Variable for GTM Server-Side
 
-This Google Tag Manager Server-Side variable allows you to retrieve contact information using the Infobip API.
+This Google Tag Manager Server-Side variable allows you to retrieve a single contact profile information given an identifier from Infobip People CDP using the Infobip People CDP API.
+
+## Features
+
+- **Multiple Identifiers**: Lookup profiles by ID, External ID, Email, Phone, Facebook, Telegram, and many others.
+- **Built-in Caching**: Stores API responses in Template Storage to reduce API calls and latency (configurable expiration).
+- **Flexible Output**: Extract specific keys or return the full object. Supports flattening nested JSON responses.
+- **BigQuery Logging**: Native support for logging request and response data to BigQuery.
+
+## Configuration
+
+### 1. API Configuration
+
+- **Base URL**: Your Infobip Base URL (e.g., `xxxxx.api.infobip.com`) found in the [Developer Tools > API Keys](https://portal.infobip.com/dev/api-keys) page Do not include `https://`.
+- **API Key**: Your Infobip API Key found in the [Developer Tools > API Keys](https://portal.infobip.com/dev/api-keys) page.
+  - **Scopes**: at least one of the following scopes `people:manage` and `people:read`
+
+### 2. Lookup Parameters
+
+- **Identifier Type**: Select the type of identifier to use for the lookup (e.g., Email, Phone, External ID, etc.).
+- **Identifier Value**: The actual value to search for.
+- **Sender**: The Sender or Application ID. Required for specific types (not required for ID, External ID, Phone, or Email).
+
+### 3. Cache Settings
+
+- **Store response in cache**: If enabled, saves the API response to Template Storage.
+- **Cache Expiration Time**: Time in hours before the cache invalidates (default: 12).
+
+### 4. Output Settings
+
+- **Extract keys**: Option to limit the returned object to specific keys (supports dot notation).
+- **Output object structure**: Choose between creating a **Flat object** (underscore separated) or a **Nested object**.
 
 ## Open Source
 
-The **Infobip Lookup Variable by Stape** is developed and maintained by the [Stape Team](https://stape.io/) under the Apache 2.0 license.
+The **Infobip CDP Lookup Variable by Stape** is developed and maintained by the [Stape Team](https://stape.io/) under the Apache 2.0 license.

metadata.yaml

@@ -1,5 +1,5 @@
 homepage: 'https://stape.io/'
 documentation: 'https://github.com/stape-io/infobip-lookup-variable'
 versions:
-  - sha: <SHA-INITIAL_RELEASE>
+  - sha: 729f25c30bb53886fd5f822873c2a62ce78439d0
     changeNotes: Initial Release.

template.js

@@ -0,0 +1,302 @@
+const BigQuery = require('BigQuery');
+const encodeUriComponent = require('encodeUriComponent');
+const getAllEventData = require('getAllEventData');
+const getContainerVersion = require('getContainerVersion');
+const getRequestHeader = require('getRequestHeader');
+const getTimestampMillis = require('getTimestampMillis');
+const getType = require('getType');
+const JSON = require('JSON');
+const logToConsole = require('logToConsole');
+const makeInteger = require('makeInteger');
+const makeString = require('makeString');
+const Promise = require('Promise');
+const sendHttpRequest = require('sendHttpRequest');
+const sha256Sync = require('sha256Sync');
+const templateDataStorage = require('templateDataStorage');
+
+/*==============================================================================
+==============================================================================*/
+
+const eventData = getAllEventData();
+
+if (shouldExitEarly(eventData)) return;
+
+return sendRequest();
+
+/*==============================================================================
+ VENDOR RELATED FUNCTIONS
+==============================================================================*/
+
+function sendRequest() {
+  const chosenApi = 'PersonLookup';
+  const requestConfig = handleRequestConfig(data, chosenApi);
+  const cacheKey = sha256Sync('infobip' + chosenApi + requestConfig.url + data.apiKey);
+  const cacheKeyTimestamp = cacheKey + '_timestamp';
+  const cacheExpirationTimeMillis = makeInteger(data.expirationTime || 12) * 60 * 60 * 1000;
+  const now = getTimestampMillis();
+
+  if (data.storeResponse) {
+    const cachedValues = templateDataStorage.getItemCopy(cacheKey);
+    const cachedValueTimestamp = templateDataStorage.getItemCopy(cacheKeyTimestamp);
+
+    if (
+      cachedValueTimestamp &&
+      now - makeInteger(cachedValueTimestamp) >= cacheExpirationTimeMillis
+    ) {
+      templateDataStorage.removeItem(cacheKey);
+      templateDataStorage.removeItem(cacheKeyTimestamp);
+    } else if (cachedValues) {
+      return Promise.create((resolve) => resolve(createReturningObject(cachedValues)));
+    }
+  }
+
+  log({
+    Name: 'InfobipLookup',
+    Type: 'Request',
+    EventName: chosenApi,
+    RequestMethod: requestConfig.options.method,
+    RequestUrl: requestConfig.url
+  });
+
+  return sendHttpRequest(requestConfig.url, requestConfig.options)
+    .then((result) => {
+      log({
+        Name: 'InfobipLookup',
+        Type: 'Response',
+        EventName: chosenApi,
+        ResponseStatusCode: result.statusCode,
+        ResponseHeaders: result.headers,
+        ResponseBody: result.body
+      });
+
+      if (result.statusCode === 200) {
+        const parsedBody = JSON.parse(result.body || '{}');
+        if (data.storeResponse) {
+          templateDataStorage.setItemCopy(cacheKey, parsedBody);
+          templateDataStorage.setItemCopy(cacheKeyTimestamp, now);
+        }
+        return createReturningObject(parsedBody);
+      } else {
+        return;
+      }
+    })
+    .catch((result) => {
+      log({
+        Name: 'InfobipLookup',
+        Type: 'Message',
+        EventName: chosenApi,
+        Message: 'Request failed or timed out.',
+        Reason: JSON.stringify(result)
+      });
+      return;
+    });
+}
+
+function createReturningObject(sourceObject) {
+  let returnObject = {};
+
+  const keysToReturn = data.outputKeys
+    ? data.outputKeysList.split(',').map((s) => s.trim())
+    : undefined;
+  if (!keysToReturn) {
+    return sourceObject;
+  } else if (getType(keysToReturn) === 'array') {
+    if (keysToReturn.length === 1) {
+      return extractKeyFromObject(keysToReturn[0], sourceObject);
+    } else if (keysToReturn.length > 1) {
+      returnObject = createNestedObject(sourceObject, keysToReturn);
+      return data.objectOutput === 'createFlatObject' ? flattenObject(returnObject) : returnObject;
+    }
+  }
+}
+
+function handleRequestConfig(data, chosenApi) {
+  const apiMethodsMapping = {
+    PersonLookup: personLookupHandler
+  };
+  const apiPath = apiMethodsMapping[chosenApi]('path');
+  const apiQueries = apiMethodsMapping[chosenApi]('queries');
+  const apiBaseUrl = 'https://' + data.baseUrl.replace('https://', '').replace('http://', '');
+  const requestConfig = {
+    url: apiBaseUrl + apiPath + apiQueries,
+    options: {
+      headers: {
+        Accept: 'application/json',
+        Authorization: 'App ' + data.apiKey
+      },
+      method: apiMethodsMapping[chosenApi]('requestMethod')
+    }
+  };
+  return requestConfig;
+}
+
+function personLookupHandler(method) {
+  if (method === 'requestMethod') return 'GET';
+  if (method === 'path') return '/people/2/persons';
+  if (method === 'queries') {
+    const queriesUrl = [];
+    const queries = {
+      type: data.type,
+      identifier: data.identifier,
+      sender: data.sender
+    };
+    for (const key in queries) {
+      if (queries[key]) queriesUrl.push(enc(key) + '=' + enc(queries[key]));
+    }
+    return '?' + queriesUrl.join('&');
+  }
+}
+
+/*==============================================================================
+  Helpers
+==============================================================================*/
+
+function shouldExitEarly(eventData) {
+  const url = eventData.page_location || getRequestHeader('referer');
+  if (url && url.lastIndexOf('https://gtm-msr.appspot.com/', 0) === 0) return true;
+}
+
+function enc(data) {
+  if (['null', 'undefined'].indexOf(getType(data)) !== -1) data = '';
+  return encodeUriComponent(makeString(data));
+}
+
+function flattenObject(ob) {
+  const toReturn = {};
+  for (let i in ob) {
+    if (!ob.hasOwnProperty(i)) continue;
+    if (['object', 'array'].indexOf(getType(ob[i])) !== -1) {
+      const flatObject = flattenObject(ob[i]);
+      for (let x in flatObject) {
+        if (!flatObject.hasOwnProperty(x)) continue;
+        toReturn[i + '_' + x] = flatObject[x];
+      }
+    } else {
+      toReturn[i] = ob[i];
+    }
+  }
+
+  return toReturn;
+}
+
+function createNestedObject(source, paths) {
+  const result = {};
+  paths.forEach((path) => {
+    const keys = path.trim().split('.');
+    let srcPtr = source;
+    let resPtr = result;
+
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+
+      if (!srcPtr || !srcPtr[key]) return;
+
+      const isLastKey = i === keys.length - 1;
+      if (isLastKey) {
+        resPtr[key] = srcPtr[key];
+      } else {
+        if (getType(resPtr[key]) === 'undefined') {
+          resPtr[key] = getType(srcPtr[key]) === 'array' ? [] : {};
+        }
+        srcPtr = srcPtr[key];
+        resPtr = resPtr[key];
+      }
+    }
+  });
+  return result;
+}
+
+function extractKeyFromObject(keyPath, sourceObject) {
+  const keys = keyPath.split('.');
+  return keys.reduce((object, key) => {
+    if (sourceObject === undefined) return undefined;
+    if (object.hasOwnProperty(key)) return object[key];
+    return undefined;
+  }, sourceObject);
+}
+
+function log(rawDataToLog) {
+  const logDestinationsHandlers = {};
+  if (determinateIsLoggingEnabled()) logDestinationsHandlers.console = logConsole;
+  if (determinateIsLoggingEnabledForBigQuery()) logDestinationsHandlers.bigQuery = logToBigQuery;
+
+  rawDataToLog.TraceId = getRequestHeader('trace-id');
+
+  const keyMappings = {
+    // No transformation for Console is needed.
+    bigQuery: {
+      Name: 'tag_name',
+      Type: 'type',
+      TraceId: 'trace_id',
+      EventName: 'event_name',
+      RequestMethod: 'request_method',
+      RequestUrl: 'request_url',
+      RequestBody: 'request_body',
+      ResponseStatusCode: 'response_status_code',
+      ResponseHeaders: 'response_headers',
+      ResponseBody: 'response_body'
+    }
+  };
+
+  for (const logDestination in logDestinationsHandlers) {
+    const handler = logDestinationsHandlers[logDestination];
+    if (!handler) continue;
+
+    const mapping = keyMappings[logDestination];
+    const dataToLog = mapping ? {} : rawDataToLog;
+
+    if (mapping) {
+      for (const key in rawDataToLog) {
+        const mappedKey = mapping[key] || key;
+        dataToLog[mappedKey] = rawDataToLog[key];
+      }
+    }
+
+    handler(dataToLog);
+  }
+}
+
+function logConsole(dataToLog) {
+  logToConsole(JSON.stringify(dataToLog));
+}
+
+function logToBigQuery(dataToLog) {
+  const connectionInfo = {
+    projectId: data.logBigQueryProjectId,
+    datasetId: data.logBigQueryDatasetId,
+    tableId: data.logBigQueryTableId
+  };
+  dataToLog.timestamp = getTimestampMillis();
+
+  ['request_body', 'response_headers', 'response_body'].forEach((p) => {
+    dataToLog[p] = JSON.stringify(dataToLog[p]);
+  });
+  BigQuery.insert(connectionInfo, [dataToLog], { ignoreUnknownValues: true });
+}
+
+function determinateIsLoggingEnabled() {
+  const containerVersion = getContainerVersion();
+  const isDebug = !!(
+    containerVersion &&
+    (containerVersion.debugMode || containerVersion.previewMode)
+  );
+
+  if (!data.logType) {
+    return isDebug;
+  }
+
+  if (data.logType === 'no') {
+    return false;
+  }
+
+  if (data.logType === 'debug') {
+    return isDebug;
+  }
+
+  return data.logType === 'always';
+}
+
+function determinateIsLoggingEnabledForBigQuery() {
+  if (data.bigQueryLogType === 'no') return false;
+  return data.bigQueryLogType === 'always';
+}