add support for custom sync parameter formatting using syncParamFormat

bin/oih-gen.js

@@ -63,6 +63,7 @@ async function oihGen() {
     outputDir: options.output,
     snapshot: options.snapshot,
     rateLimit: options.rateLimit,
+    syncParamFormat: options.syncParamFormat,
     paginationConfig: {
       pageTokenOption: {
         fieldName: options.paginationTokenFieldName,

lib/do-generate.js

@@ -17,9 +17,10 @@ const generate = require("./generate");
  * @param {object} paginationConfig.pageTokenOption
  * @param {string} paginationConfig.pageTokenOption.fieldName
  * @param {number} rateLimit
+ * @param {string} syncParamFormat
  * @returns {Promise<*>}
  */
-module.exports = async function doGenerate({ swaggerUrl, outputDir, connectorName, snapshot, paginationConfig, rateLimit }) {
+module.exports = async function doGenerate({ swaggerUrl, outputDir, connectorName, snapshot, paginationConfig, rateLimit, syncParamFormat }) {
   const downloadedSpecFile = path.join(outputDir, "openapi-original.json");
   const validatedSpecFile = path.join(outputDir, "openapi-validated.json");
   const generatePath = path.join(outputDir, connectorName);
@@ -47,7 +48,8 @@ module.exports = async function doGenerate({ swaggerUrl, outputDir, connectorNam
     swaggerUrl: swaggerUrl,
     snapshot: snapshot || "",
     paginationConfig,
-    rateLimit: rateLimit || -1
+    rateLimit: rateLimit || -1,
+    syncParamFormat: syncParamFormat
   });
 
   console.log("\x1b[32m", "Successfully generated. Connector has been saved in output directory:", generatePath);

lib/generate.js

@@ -33,6 +33,7 @@ module.exports = async function generate({
   paginationConfig,
   suffixServiceNameToTitle = false,
   rateLimit = -1,
+  syncParamFormat,
 }) {
   let api = await SwaggerParser.parse(inputFile);
   if (!api.components) {
@@ -52,7 +53,7 @@ module.exports = async function generate({
     fse.removeSync(libDir);
   }
 
-  let componentJson = await getComponentJson(apiTitle, api, swaggerUrl, rateLimit, this);
+  let componentJson = await getComponentJson(apiTitle, api, swaggerUrl, rateLimit, syncParamFormat, this);
   let existingNames = {};
 
   // generate actions

lib/utils/functions.js

@@ -80,7 +80,7 @@ async function output(filename, text, data, outputDir) {
   //console.log('Writing file %s', filename);
   return await fse.outputFile(path.join(outputDir, filename), text);
 }
-async function getComponentJson(apiTitle, api, swaggerUrl, rateLimit) {
+async function getComponentJson(apiTitle, api, swaggerUrl, rateLimit, syncParamFormat) {
   const textDescription = toText(api.info.description);
 
   const componentJson = Object.assign(JSON.parse(templates.componentTemplate), {
@@ -89,6 +89,7 @@ async function getComponentJson(apiTitle, api, swaggerUrl, rateLimit) {
     docsUrl: (api.externalDocs && api.externalDocs.url) || "",
     url: swaggerUrl,
     rateLimit: parseInt(rateLimit),
+    syncParamFormat: syncParamFormat,
   });
 
   await addCredentials(componentJson, api);

templates/lib/triggers/trigger.js

@@ -21,14 +21,15 @@ const {
 } = require("../utils/helpers");
 const { createPaginator } = require("../utils/paginator");
 const componentJson = require("../../component.json");
+const dayjs = require("dayjs");
 
 async function processTrigger(msg, cfg, snapshot, incomingMessageHeaders, tokenData) {
   let logger = this.logger;
   let continueOnError = false;
   if (cfg && cfg.nodeSettings && cfg.nodeSettings.continueOnError) continueOnError = true;
 
   try {
-    const { snapshotKey, arraySplittingKey, syncParam, skipSnapshot, logLevel } = cfg.nodeSettings;
+    const { snapshotKey, arraySplittingKey, syncParam, skipSnapshot, logLevel, syncParamFormat } = cfg.nodeSettings;
 
     if (["fatal", "error", "warn", "info", "debug", "trace"].includes(logLevel)) {
       logger = this.logger.child({});
@@ -96,15 +97,21 @@ async function processTrigger(msg, cfg, snapshot, incomingMessageHeaders, tokenD
     }
 
     if (syncParam && snapshot.lastUpdated) {
+      let formattedTimestamp = snapshot.lastUpdated;
+      if (syncParamFormat) {
+        formattedTimestamp = dayjs(snapshot.lastUpdated).utc().format(syncParamFormat);
+      }
+      logger.info("SyncParam: %s", formattedTimestamp);
       if (syncParam === "$FILTER") {
         if (!snapshotKey) {
           throw new Error("snapshotKey params should be specified!");
         }
-        parameters[syncParam] = `${snapshotKey} gt datetime'${snapshot.lastUpdated}'`;
+        parameters[syncParam] = `${snapshotKey} gt datetime'${formattedTimestamp}'`;
       } else {
-        parameters[syncParam] = snapshot.lastUpdated;
+        parameters[syncParam] = formattedTimestamp;
       }
     }
+
     logger.debug("Parameters were populated from configuration: %j", parameters);
 
     $SECURITIES;