@unito/integration-sdk 1.0.2 → 1.0.4

package/dist/src/handler.d.ts

@@ -1,6 +1,6 @@
 import { Router } from 'express';
 import * as API from '@unito/integration-api';
-import { GetItemContext, GetCollectionContext, CreateItemContext, UpdateItemContext, DeleteItemContext, GetCredentialAccountContext, ParseWebhooksContext, UpdateWebhookSubscriptionsContext, AcknowledgeWebhooksContext } from './resources/context.js';
+import { GetBlobContext, GetItemContext, GetCollectionContext, CreateItemContext, UpdateItemContext, DeleteItemContext, GetCredentialAccountContext, ParseWebhooksContext, UpdateWebhookSubscriptionsContext, AcknowledgeWebhooksContext } from './resources/context.js';
 /**
  * Handler called to get an individual item.
  *
@@ -35,6 +35,13 @@ export type UpdateItemHandler = (context: UpdateItemContext<any, any, any>) => P
  * @param context {@link DeleteItemContext}
  */
 export type DeleteItemHandler = (context: DeleteItemContext<any, any>) => Promise<void>;
+/**
+ * Handler called to get a Binary Large Object.
+ *
+ * @param context {@link BlobItemContext}
+ * @returns A {@link ReadableStream} of the Blob.
+ */
+export type GetBlobHandler = (context: GetBlobContext<any, any>) => Promise<ReadableStream<Uint8Array>>;
 /**
  * Handler called to retrieve the account details associated with the credentials.
  *
@@ -83,6 +90,9 @@ export type ItemHandlers = {
     updateItem?: UpdateItemHandler;
     deleteItem?: DeleteItemHandler;
 };
+export type BlobHandlers = {
+    getBlob: GetBlobHandler;
+};
 export type CredentialAccountHandlers = {
     getCredentialAccount: GetCredentialAccountHandler;
 };
@@ -95,7 +105,7 @@ export type WebhookSubscriptionHandlers = {
 export type AcknowledgeWebhookHandlers = {
     acknowledgeWebhooks: AcknowledgeWebhooksHandler;
 };
-export type HandlersInput = ItemHandlers | CredentialAccountHandlers | ParseWebhookHandlers | WebhookSubscriptionHandlers | AcknowledgeWebhookHandlers;
+export type HandlersInput = ItemHandlers | BlobHandlers | CredentialAccountHandlers | ParseWebhookHandlers | WebhookSubscriptionHandlers | AcknowledgeWebhookHandlers;
 export declare class Handler {
     private path;
     private pathWithIdentifier;

package/dist/src/handler.js

@@ -177,6 +177,41 @@ export class Handler {
                 res.status(204).send(null);
             });
         }
+        if (this.handlers.getBlob) {
+            console.debug(`  Enabling getBlob at GET ${this.pathWithIdentifier}`);
+            const handler = this.handlers.getBlob;
+            router.get(this.pathWithIdentifier, async (req, res) => {
+                if (!res.locals.credentials) {
+                    throw new UnauthorizedError();
+                }
+                const blob = await handler({
+                    credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
+                    logger: res.locals.logger,
+                    signal: res.locals.signal,
+                    params: req.params,
+                    query: req.query,
+                });
+                res.writeHead(200, {
+                    'Content-Type': 'application/octet-stream',
+                });
+                const reader = blob.getReader();
+                let isDone = false;
+                try {
+                    while (!isDone) {
+                        const chunk = await reader.read();
+                        isDone = chunk.done;
+                        if (chunk.value) {
+                            res.write(chunk.value);
+                        }
+                    }
+                }
+                finally {
+                    reader.releaseLock();
+                }
+                res.end();
+            });
+        }
         if (this.handlers.getCredentialAccount) {
             const handler = this.handlers.getCredentialAccount;
             console.debug(`  Enabling getCredentialAccount at GET ${this.pathWithIdentifier}`);

package/dist/src/index.cjs

@@ -212,7 +212,7 @@ class Cache {
      * @returns A cache instance.
      */
     static create(redisUrl) {
-        const cacheInstance = redisUrl ? new cachette.WriteThroughCache(redisUrl) : new cachette.LocalCache();
+        const cacheInstance = redisUrl ? new cachette.RedisCache(redisUrl) : new cachette.LocalCache();
         // Intended: the correlation id will be the same for all logs of Cachette.
         const correlationId = uuid__namespace.v4();
         const logger = new Logger({ correlation_id: correlationId });
@@ -692,6 +692,41 @@ class Handler {
                 res.status(204).send(null);
             });
         }
+        if (this.handlers.getBlob) {
+            console.debug(`  Enabling getBlob at GET ${this.pathWithIdentifier}`);
+            const handler = this.handlers.getBlob;
+            router.get(this.pathWithIdentifier, async (req, res) => {
+                if (!res.locals.credentials) {
+                    throw new UnauthorizedError();
+                }
+                const blob = await handler({
+                    credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
+                    logger: res.locals.logger,
+                    signal: res.locals.signal,
+                    params: req.params,
+                    query: req.query,
+                });
+                res.writeHead(200, {
+                    'Content-Type': 'application/octet-stream',
+                });
+                const reader = blob.getReader();
+                let isDone = false;
+                try {
+                    while (!isDone) {
+                        const chunk = await reader.read();
+                        isDone = chunk.done;
+                        if (chunk.value) {
+                            res.write(chunk.value);
+                        }
+                    }
+                }
+                finally {
+                    reader.releaseLock();
+                }
+                res.end();
+            });
+        }
         if (this.handlers.getCredentialAccount) {
             const handler = this.handlers.getCredentialAccount;
             console.debug(`  Enabling getCredentialAccount at GET ${this.pathWithIdentifier}`);

package/dist/src/resources/cache.js

@@ -1,4 +1,4 @@
-import { WriteThroughCache, LocalCache } from 'cachette';
+import { LocalCache, RedisCache } from 'cachette';
 import * as uuid from 'uuid';
 import Logger from './logger.js';
 /**
@@ -78,7 +78,7 @@ export class Cache {
      * @returns A cache instance.
      */
     static create(redisUrl) {
-        const cacheInstance = redisUrl ? new WriteThroughCache(redisUrl) : new LocalCache();
+        const cacheInstance = redisUrl ? new RedisCache(redisUrl) : new LocalCache();
         // Intended: the correlation id will be the same for all logs of Cachette.
         const correlationId = uuid.v4();
         const logger = new Logger({ correlation_id: correlationId });

package/dist/src/resources/context.d.ts

@@ -61,6 +61,12 @@ export type Context<P extends Maybe<Params> = Params, Q extends Maybe<Query> = Q
  * @see {@link Context}
  */
 export type GetItemContext<P extends Maybe<Params> = Empty, Q extends Query = Empty> = Context<P, Q>;
+/**
+ * Context received by the `GetBlobHandler`, same as `GetItemContext`.
+ *
+ * @see {@link Context}
+ */
+export type GetBlobContext<P extends Maybe<Params> = Empty, Q extends Query = Empty> = Context<P, Q>;
 /**
  * Context received by the `GetCollectionHandler`.
  *

package/dist/test/resources/cache.test.js

@@ -10,7 +10,7 @@ describe('Cache', () => {
             assert.ok(cache['cacheInstance'] instanceof LocalCache);
             await cache['cacheInstance'].quit();
         });
-        it('redis url returns (tries) WriteThroughCache', () => {
+        it('redis url tries to return a RedisCache', () => {
             assert.throws(() => Cache.create('fakeredis'), Error, 'Invalid redis url fakereis.');
         });
     });

package/dist/test/resources/provider.test.js

@@ -3,6 +3,11 @@ import { describe, it } from 'node:test';
 import { Provider } from '../../src/resources/provider.js';
 import * as HttpErrors from '../../src/httpErrors.js';
 import Logger from '../../src/resources/logger.js';
+// There is currently an issue with node 20.12 and fetch mocking. A quick fix is to first call fetch so it's getter
+// get properly instantiated, which allow it to be mocked properly.
+// Issue: https://github.com/nodejs/node/issues/52015
+// PR fix: https://github.com/nodejs/node/pull/52275
+globalThis.fetch = fetch;
 describe('Provider', () => {
     const provider = new Provider({
         prepareRequest: requestOptions => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-sdk",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Integration SDK",
   "type": "module",
   "types": "dist/src/index.d.ts",

package/src/handler.ts

@@ -3,6 +3,7 @@ import * as API from '@unito/integration-api';
 import { InvalidHandler } from './errors.js';
 import { UnauthorizedError, BadRequestError } from './httpErrors.js';
 import {
+  GetBlobContext,
   GetItemContext,
   GetCollectionContext,
   CreateItemContext,
@@ -53,6 +54,14 @@ export type UpdateItemHandler = (context: UpdateItemContext<any, any, any>) => P
  */
 export type DeleteItemHandler = (context: DeleteItemContext<any, any>) => Promise<void>;
 
+/**
+ * Handler called to get a Binary Large Object.
+ *
+ * @param context {@link BlobItemContext}
+ * @returns A {@link ReadableStream} of the Blob.
+ */
+export type GetBlobHandler = (context: GetBlobContext<any, any>) => Promise<ReadableStream<Uint8Array>>;
+
 /**
  * Handler called to retrieve the account details associated with the credentials.
  *
@@ -114,6 +123,10 @@ export type ItemHandlers = {
   deleteItem?: DeleteItemHandler;
 };
 
+export type BlobHandlers = {
+  getBlob: GetBlobHandler;
+};
+
 export type CredentialAccountHandlers = {
   getCredentialAccount: GetCredentialAccountHandler;
 };
@@ -132,6 +145,7 @@ export type AcknowledgeWebhookHandlers = {
 
 export type HandlersInput =
   | ItemHandlers
+  | BlobHandlers
   | CredentialAccountHandlers
   | ParseWebhookHandlers
   | WebhookSubscriptionHandlers
@@ -139,6 +153,7 @@ export type HandlersInput =
 
 type Handlers = Partial<
   ItemHandlers &
+    BlobHandlers &
     CredentialAccountHandlers &
     ParseWebhookHandlers &
     WebhookSubscriptionHandlers &
@@ -380,6 +395,50 @@ export class Handler {
       });
     }
 
+    if (this.handlers.getBlob) {
+      console.debug(`  Enabling getBlob at GET ${this.pathWithIdentifier}`);
+
+      const handler = this.handlers.getBlob;
+
+      router.get(this.pathWithIdentifier, async (req, res) => {
+        if (!res.locals.credentials) {
+          throw new UnauthorizedError();
+        }
+
+        const blob = await handler({
+          credentials: res.locals.credentials,
+          secrets: res.locals.secrets,
+          logger: res.locals.logger,
+          signal: res.locals.signal,
+          params: req.params,
+          query: req.query,
+        });
+
+        res.writeHead(200, {
+          'Content-Type': 'application/octet-stream',
+        });
+
+        const reader = blob.getReader();
+
+        let isDone = false;
+
+        try {
+          while (!isDone) {
+            const chunk = await reader.read();
+            isDone = chunk.done;
+
+            if (chunk.value) {
+              res.write(chunk.value);
+            }
+          }
+        } finally {
+          reader.releaseLock();
+        }
+
+        res.end();
+      });
+    }
+
     if (this.handlers.getCredentialAccount) {
       const handler = this.handlers.getCredentialAccount;
 

package/src/resources/cache.ts

@@ -1,4 +1,4 @@
-import { WriteThroughCache, LocalCache, CacheInstance, FetchingFunction, CachableValue } from 'cachette';
+import { LocalCache, CacheInstance, FetchingFunction, CachableValue, RedisCache } from 'cachette';
 import * as uuid from 'uuid';
 import Logger from './logger.js';
 
@@ -92,7 +92,7 @@ export class Cache {
    * @returns A cache instance.
    */
   public static create(redisUrl?: string): Cache {
-    const cacheInstance: CacheInstance = redisUrl ? new WriteThroughCache(redisUrl) : new LocalCache();
+    const cacheInstance: CacheInstance = redisUrl ? new RedisCache(redisUrl) : new LocalCache();
 
     // Intended: the correlation id will be the same for all logs of Cachette.
     const correlationId = uuid.v4();

package/src/resources/context.ts

@@ -67,6 +67,13 @@ export type Context<P extends Maybe<Params> = Params, Q extends Maybe<Query> = Q
  */
 export type GetItemContext<P extends Maybe<Params> = Empty, Q extends Query = Empty> = Context<P, Q>;
 
+/**
+ * Context received by the `GetBlobHandler`, same as `GetItemContext`.
+ *
+ * @see {@link Context}
+ */
+export type GetBlobContext<P extends Maybe<Params> = Empty, Q extends Query = Empty> = Context<P, Q>;
+
 /**
  * Context received by the `GetCollectionHandler`.
  *

package/test/resources/cache.test.ts

@@ -14,7 +14,7 @@ describe('Cache', () => {
       await cache['cacheInstance'].quit();
     });
 
-    it('redis url returns (tries) WriteThroughCache', () => {
+    it('redis url tries to return a RedisCache', () => {
       assert.throws(() => Cache.create('fakeredis'), Error, 'Invalid redis url fakereis.');
     });
   });

package/test/resources/provider.test.ts

@@ -5,6 +5,12 @@ import { Provider } from '../../src/resources/provider.js';
 import * as HttpErrors from '../../src/httpErrors.js';
 import Logger from '../../src/resources/logger.js';
 
+// There is currently an issue with node 20.12 and fetch mocking. A quick fix is to first call fetch so it's getter
+// get properly instantiated, which allow it to be mocked properly.
+// Issue: https://github.com/nodejs/node/issues/52015
+// PR fix: https://github.com/nodejs/node/pull/52275
+globalThis.fetch = fetch;
+
 describe('Provider', () => {
   const provider = new Provider({
     prepareRequest: requestOptions => {