@vouchfor/sdk 1.1.33 → 1.1.35

package/.claude/settings.local.json

@@ -0,0 +1,10 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(grep -l \"Router\\\\\\(\\\\\\)\" /home/david/dev/vouch-new/amplify/backend/function/restapi/lib/controllers/*.ts | xargs grep -L \"@openapi\")",
+      "Bash(for f:*)",
+      "Bash(cd /home/david/dev/vouch-new/amplify/backend/function/restapi/openapi && node -e \"const s = require\\('./components/schemas'\\); console.log\\(Object.keys\\(s\\).join\\(', '\\)\\)\" 2>&1)",
+      "Bash(cd /home/david/dev/vouch-new/amplify/backend/function/restapi/openapi && node -e \"const r = require\\('./components/responses'\\); console.log\\(Object.keys\\(r\\).join\\(', '\\)\\)\" 2>&1)"
+    ]
+  }
+}

package/lib/services/baseService.js

@@ -1,4 +1,5 @@
 const utils = require('../shared/utils');
+const tasks = require('../shared/tasks');
 
 // set up env for local development
 // set env SDK_LOCAL_DEV to use default local development endpoints
@@ -25,6 +26,7 @@ class BaseService {
     this._client = client;
     this._apiKey = config.apiKey || '';
     this._integrationKey = config.integrationKey || '';
+    this._callbackUrl = config.callbackUrl || '';
     this._baseUrl = `${config.baseUrl}${basePath}`;
     this._logger = logger;
     this._utils = utils;
@@ -49,13 +51,87 @@ class BaseService {
       apiHeaders['x-integration-key'] = integrationKey;
     }
 
-    return this._utils.request({
-      body,
-      headers: apiHeaders,
-      method,
-      url,
-      logger: this._logger
-    });
+    const elapsedTimeInSeconds = (start) => {
+      return ((Date.now() - start) / 1000).toFixed(3) + 's';
+    }
+
+    const logAsyncSuccess = ({ id, status, json, start }) => {
+      const elapsed = elapsedTimeInSeconds(start);
+      const response = JSON.stringify(json);
+      this._logger.info(
+          `async success for task: ${task.id} ++ ${elapsed}\n`
+        + `========================================\n`
+        + `Content-Type: application/json\n`
+        + `Content-Length: ${response.length}\n`
+        + '\n' + response + '\n'
+        + `========================================`);
+    }
+
+    const logAsyncFailure = ({ id, status, json, start }) => {
+      const elapsed = elapsedTimeInSeconds(start);
+      const response = JSON.stringify(json);
+      this._logger.info(
+          `async failure for task: ${task.id} ++ ${elapsed}\n`
+        + `========================================\n`
+        + `Content-Type: application/json\n`
+        + `Content-Length: ${response.length}\n`
+        + '\n' + response + '\n'
+        + `========================================`);
+    }
+
+    const registerAsyncResponse = () => {
+      if (this._callbackUrl) {
+        const start = Date.now();
+        const task = tasks.create();
+        apiHeaders['x-callback-url'] = this._callbackUrl + utils.queryString({ id: task.id });
+        const promise = task.promise
+          .then(({ status, json }) => {
+            logAsyncSuccess({ id: task.id, status, json, start });
+            return { json };
+          })
+          .catch(({ status, json }) => {
+            logAsyncFailure({ id: task.id, status, json, start });
+            throw json.error;
+          });
+        promise.catch(() => {});
+        return { id: task.id, promise };
+      }
+      return {};
+    }
+
+    const task = registerAsyncResponse();
+
+    let [res, cb]= await Promise.all([
+      this._utils.request({
+        body,
+        headers: apiHeaders,
+        method,
+        url,
+        logger: this._logger
+      }).then((res) => {
+        if (task.id && res.task !== task.id) {
+          tasks.cancel(task.id); // our callback url was ignored
+        }
+        return res;
+      }).catch((err) => {
+        return { error: err }
+      }),
+      task.promise || {}
+    ]);
+
+    if (task.id) {
+      if (res.task === task.id) {
+        res = cb.json; // we got the async response we expected
+      } else if (res.error && cb.json) {
+        res = cb.json; // api gateway failed, use async response
+      }
+    }
+
+    if (res.error) {
+      throw res.error;
+    }
+
+    return res;
   }
 }
 

package/lib/services/callbackService.js

@@ -0,0 +1,17 @@
+const tasks = require('../shared/tasks');
+
+class CallbackService {
+  response(id, body) {
+    const { status, json } = body || {};
+    if (!(id && status)) {
+      // invalid - do nothing
+    } else if (status < 400) {
+      tasks.respond(id, body);
+    } else {
+      tasks.fail(id, body);
+    }
+  }
+}
+
+module.exports = CallbackService;
+

package/lib/services/index.js

@@ -11,9 +11,10 @@ module.exports = Object.freeze({
   compositions: require('./rest/compositionService'),
   files: require('./rest/fileService'),
   images: require('./rest/imageService'),
-  audios: require('./rest/audioService'),
+  audio: require('./rest/audioService'),
   documents: require('./rest/documentService'),
   links: require('./rest/linkService'),
   advocacy: require('./rest/advocacyService'),
   utilities: require('./rest/utilityService'),
+  callback: require('./callbackService'),
 });

package/lib/services/rest/base.js

@@ -6,6 +6,7 @@ class BaseRestService extends BaseService {
     super(client, {
       apiKey: config.apiKey,
       integrationKey: config.integrationKey,
+      callbackUrl: config.callbackUrl,
       baseUrl: process.env.SDK_LOCAL_REST || `https://api${utils.getApiSuffix(config.env)}.vouchfor.com/v1`,
       basePath,
       env: config.env,

package/lib/shared/tasks.js

@@ -0,0 +1,72 @@
+const crypto = require('node:crypto')
+
+function generateId() {
+  const id = crypto.randomBytes(40)
+    .toString('base64url')
+    .replace(/[^a-zA-Z0-9]/g, '')
+    .slice(0, 10);
+  return id;
+}
+
+class TaskBroker {
+  constructor() {
+    this.pending = new Map();
+  }
+
+  create(timeoutMs = 120000) {
+    const id = generateId();
+
+    let resolveFn;
+    let rejectFn;
+
+    const promise = new Promise((resolve, reject) => {
+      resolveFn = resolve;
+      rejectFn = reject;
+    })
+
+    const timeout = setTimeout(() => {
+      if (!this.pending.has(id)) return;
+      this.pending.delete(id);
+      rejectFn({ status: 0, json: { error: 'TimedOut' } });
+    }, timeoutMs);
+
+    this.pending.set(id, {
+      resolve: value => {
+        clearTimeout(timeout);
+        this.pending.delete(id);
+        resolveFn(value);
+      },
+      reject: err => {
+        clearTimeout(timeout);
+        this.pending.delete(id);
+        rejectFn(err);
+      }
+    })
+
+    return { id, promise };
+  }
+
+  cancel(id) {
+    const entry = this.pending.get(id);
+    if (!entry) return false;
+    entry.resolve({ status: 0, json: { error: 'Cancelled' } });
+    return true;
+  }
+
+  respond(id, value) {
+    const entry = this.pending.get(id);
+    if (!entry) return false;
+    entry.resolve(value);
+    return true;
+  }
+
+  fail(id, value) {
+    const entry = this.pending.get(id);
+    if (!entry) return false;
+    entry.reject(value);
+    return true;
+  }
+}
+
+const broker = new TaskBroker()
+module.exports = broker

package/lib/shared/utils.js

@@ -108,7 +108,7 @@ module.exports = {
 
                 const errors = [
                   502, // bad gateway, the BE is deploying
-                  504, // gatewat timeout, the BE will scale
+                  //504 gateway timeout, do not retry!!
                 ];
                 const maxAttempts = 8;
                 const interval = 1000;

package/lib/vouch.js

@@ -3,6 +3,7 @@ class Vouch {
     this.config = Object.freeze({
       apiKey: config.apiKey,
       integrationKey: config.integrationKey,
+      callbackUrl: config.callbackUrl,
       env: config.env || 'prod',
     });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/sdk",
-  "version": "1.1.33",
+  "version": "1.1.35",
   "description": "Vouch API SDK",
   "main": "lib/index.js",
   "repository": {

package/test-callback.js

@@ -0,0 +1,21 @@
+const Vouch = require("./lib/vouch");
+
+const vouchClient = new Vouch({
+  env: 'dev',
+  integrationKey: 'b0883f06-84af-4108-8543-31874c335c36-kkr3Wy4CLY8C2g65UT79sgUfOIR2ZzkA9uQam3bTs4ZNdlSs7M',
+  callbackUrl: 'https://extrajudicial-melanie-unadministratively.ngrok-free.dev/callback'
+}, console);
+
+console.log(vouchClient);
+
+const apiKey = 'kTYGShoaeg-QvraTZk9LmHNsxP4dWcye82uJB6Rf0XtIsgq7UaEcYpVhMDl3z';
+
+(async () => {
+  const params = {
+    query: 'why',
+    limit: 2
+  };
+  const data = await vouchClient.campaigns.search(params, apiKey).catch(() => undefined);
+  console.log(data);
+})();
+