@unito/integration-sdk 0.1.8 → 0.1.10

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, AckknowledgeWebhooksContext } from './resources/context.js';
+import { GetItemContext, GetCollectionContext, CreateItemContext, UpdateItemContext, DeleteItemContext, GetCredentialAccountContext, ParseWebhooksContext, UpdateWebhookSubscriptionsContext, AcknowledgeWebhooksContext } from './resources/context.js';
 /**
  * Handler called to get an individual item.
  */
@@ -36,25 +36,25 @@ export type UpdateWebhookSubscriptionsHandler = (context: UpdateWebhookSubscript
 /**
  * Handler called to acknowledge the reception of a webhook.
  */
-export type AckknowledgeWebhooksHandler = (context: AckknowledgeWebhooksContext<any, any, any>) => Promise<API.WebhookAcknowledgeResponsePayload>;
-type ItemHandlers = {
+export type AcknowledgeWebhooksHandler = (context: AcknowledgeWebhooksContext<any, any, any>) => Promise<API.WebhookAcknowledgeResponsePayload>;
+export type ItemHandlers = {
     getItem?: GetItemHandler;
     getCollection?: GetCollectionHandler;
     createItem?: CreateItemHandler;
     updateItem?: UpdateItemHandler;
     deleteItem?: DeleteItemHandler;
 };
-type CredentialAccountHandlers = {
+export type CredentialAccountHandlers = {
     getCredentialAccount: GetCredentialAccountHandler;
 };
-type ParseWebhookHandlers = {
+export type ParseWebhookHandlers = {
     parseWebhooks: ParseWebhooksHandler;
 };
-type WebhookSubscriptionHandlers = {
+export type WebhookSubscriptionHandlers = {
     updateWebhookSubscriptions: UpdateWebhookSubscriptionsHandler;
 };
-type AcknowledgeWebhookHandlers = {
-    acknowledgeWebhooks: AckknowledgeWebhooksHandler;
+export type AcknowledgeWebhookHandlers = {
+    acknowledgeWebhooks: AcknowledgeWebhooksHandler;
 };
 export type HandlersInput = ItemHandlers | CredentialAccountHandlers | ParseWebhookHandlers | WebhookSubscriptionHandlers | AcknowledgeWebhookHandlers;
 export declare class Handler {
@@ -64,4 +64,3 @@ export declare class Handler {
     constructor(inputPath: string, handlers: HandlersInput);
     generate(): Router;
 }
-export {};

package/dist/src/handler.js

@@ -90,6 +90,7 @@ export class Handler {
                 }
                 const collection = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     selects: res.locals.selects,
                     filters: res.locals.filters,
                     logger: res.locals.logger,
@@ -109,6 +110,7 @@ export class Handler {
                 assertCreateItemRequestPayload(req.body);
                 const createItemSummary = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     body: req.body,
                     logger: res.locals.logger,
                     params: req.params,
@@ -126,6 +128,7 @@ export class Handler {
                 }
                 const item = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -143,6 +146,7 @@ export class Handler {
                 assertUpdateItemRequestPayload(req.body);
                 const item = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     body: req.body,
                     logger: res.locals.logger,
                     params: req.params,
@@ -160,6 +164,7 @@ export class Handler {
                 }
                 await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -176,6 +181,7 @@ export class Handler {
                 }
                 const credentialAccount = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -189,6 +195,7 @@ export class Handler {
             router.post(this.pathWithIdentifier, async (req, res) => {
                 assertWebhookParseRequestPayload(req.body);
                 const response = await handler({
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -203,6 +210,7 @@ export class Handler {
             router.post(this.pathWithIdentifier, async (req, res) => {
                 assertWebhookParseRequestPayload(req.body);
                 const response = await handler({
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -220,6 +228,7 @@ export class Handler {
                 }
                 assertWebhookSubscriptionRequestPayload(req.body);
                 const response = await handler({
+                    secrets: res.locals.secrets,
                     credentials: res.locals.credentials,
                     body: req.body,
                     logger: res.locals.logger,

package/dist/src/index.cjs

@@ -480,6 +480,7 @@ class Handler {
                 }
                 const collection = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     selects: res.locals.selects,
                     filters: res.locals.filters,
                     logger: res.locals.logger,
@@ -499,6 +500,7 @@ class Handler {
                 assertCreateItemRequestPayload(req.body);
                 const createItemSummary = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     body: req.body,
                     logger: res.locals.logger,
                     params: req.params,
@@ -516,6 +518,7 @@ class Handler {
                 }
                 const item = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -533,6 +536,7 @@ class Handler {
                 assertUpdateItemRequestPayload(req.body);
                 const item = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     body: req.body,
                     logger: res.locals.logger,
                     params: req.params,
@@ -550,6 +554,7 @@ class Handler {
                 }
                 await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -566,6 +571,7 @@ class Handler {
                 }
                 const credentialAccount = await handler({
                     credentials: res.locals.credentials,
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -579,6 +585,7 @@ class Handler {
             router.post(this.pathWithIdentifier, async (req, res) => {
                 assertWebhookParseRequestPayload(req.body);
                 const response = await handler({
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -593,6 +600,7 @@ class Handler {
             router.post(this.pathWithIdentifier, async (req, res) => {
                 assertWebhookParseRequestPayload(req.body);
                 const response = await handler({
+                    secrets: res.locals.secrets,
                     logger: res.locals.logger,
                     params: req.params,
                     query: req.query,
@@ -610,6 +618,7 @@ class Handler {
                 }
                 assertWebhookSubscriptionRequestPayload(req.body);
                 const response = await handler({
+                    secrets: res.locals.secrets,
                     credentials: res.locals.credentials,
                     body: req.body,
                     logger: res.locals.logger,
@@ -626,7 +635,7 @@ class Handler {
 
 function printErrorMessage(message) {
     console.error();
-    console.error(`\x1b[31m Oups! Something went wrong! \x1b[0m`);
+    console.error(`\x1b[31m Oops! Something went wrong! \x1b[0m`);
     console.error(message);
 }
 class Integration {

package/dist/src/integration.js

@@ -11,7 +11,7 @@ import { shutdownCaches } from './resources/cache.js';
 import { Handler } from './handler.js';
 function printErrorMessage(message) {
     console.error();
-    console.error(`\x1b[31m Oups! Something went wrong! \x1b[0m`);
+    console.error(`\x1b[31m Oops! Something went wrong! \x1b[0m`);
     console.error(message);
 }
 export default class Integration {

package/dist/src/middlewares/secrets.d.ts

@@ -0,0 +1,13 @@
+import { Request, Response, NextFunction } from 'express';
+declare global {
+    namespace Express {
+        interface Locals {
+            secrets: Secrets;
+        }
+    }
+}
+export type Secrets = {
+    [keys: string]: unknown;
+};
+declare const middleware: (req: Request, res: Response, next: NextFunction) => void;
+export default middleware;

package/dist/src/middlewares/secrets.js

@@ -0,0 +1,17 @@
+import { BadRequestError } from '../httpErrors.js';
+const SECRETS_HEADER = 'X-Unito-Secrets';
+const middleware = (req, res, next) => {
+    const secretsHeader = req.header(SECRETS_HEADER);
+    if (secretsHeader) {
+        let secrets;
+        try {
+            secrets = JSON.parse(Buffer.from(secretsHeader, 'base64').toString('utf8'));
+        }
+        catch {
+            throw new BadRequestError(`Malformed HTTP header ${SECRETS_HEADER}`);
+        }
+        res.locals.secrets = secrets;
+    }
+    next();
+};
+export default middleware;

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

@@ -1,14 +1,21 @@
 import * as API from '@unito/integration-api';
 import Logger from './logger.js';
 import { Credentials } from '../middlewares/credentials.js';
+import { Secrets } from 'src/middlewares/secrets.js';
 import { Filter } from '../middlewares/filters.js';
-type Context<P extends Record<string, string>, Q extends ParsedQueryString> = {
+export type Context<P extends Record<string, string>, Q extends ParsedQueryString> = {
     /**
      * The parsed credentials associated with the request through the X-Unito-Credentials header.
      *
      * Will contain the keys for the variables defined in the corresponding configuration's authorization.
      */
     credentials: Credentials;
+    /**
+     * The parsed secrets associated with the request through the X-Unito-Secrets header.
+     *
+     * Will contain the keys for the secrets defined in the corresponding configuration's secrets.
+     */
+    secrets: Secrets;
     /**
      * The logger pre decorated with the correlation ID and the additionnal metadata provided through the request headers.
      */
@@ -69,7 +76,7 @@ export type ParseWebhooksContext<P extends Record<string, string> = Record<strin
 export type UpdateWebhookSubscriptionsContext<P extends Record<string, string> = Record<string, never>, Q extends Record<string, string> = Record<string, never>, B extends API.WebhookSubscriptionRequestPayload = API.WebhookSubscriptionRequestPayload> = Context<P, Q> & {
     body: B;
 };
-export type AckknowledgeWebhooksContext<P extends Record<string, string> = Record<string, never>, Q extends Record<string, string> = Record<string, never>, B extends API.WebhookParseRequestPayload = API.WebhookParseRequestPayload> = Omit<Context<P, Q>, 'credentials'> & {
+export type AcknowledgeWebhooksContext<P extends Record<string, string> = Record<string, never>, Q extends Record<string, string> = Record<string, never>, B extends API.WebhookParseRequestPayload = API.WebhookParseRequestPayload> = Omit<Context<P, Q>, 'credentials'> & {
     body: B;
 };
 interface ParsedQueryString {

package/dist/test/middlewares/secrets.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/middlewares/secrets.test.js

@@ -0,0 +1,28 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import middleware from '../../src/middlewares/secrets.js';
+import { BadRequestError } from '../../src/httpErrors.js';
+describe('secrets middleware', () => {
+    it('uses header', () => {
+        const secrets = Buffer.from(JSON.stringify({
+            chut: 'abc',
+        })).toString('base64');
+        const request = { header: (_key) => secrets };
+        const response = { locals: {} };
+        middleware(request, response, () => { });
+        assert.deepEqual(response.locals, {
+            secrets: {
+                chut: 'abc',
+            },
+        });
+    });
+    it('malformed header', async () => {
+        const request = { header: (_key) => 'nope' };
+        const response = { locals: {} };
+        assert.throws(() => middleware(request, response, () => { }), BadRequestError);
+    });
+    it('undefined', () => {
+        const response = { locals: {} };
+        assert.deepEqual(response.locals, {});
+    });
+});

package/package.json

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

package/src/handler.ts

@@ -11,7 +11,7 @@ import {
   GetCredentialAccountContext,
   ParseWebhooksContext,
   UpdateWebhookSubscriptionsContext,
-  AckknowledgeWebhooksContext,
+  AcknowledgeWebhooksContext,
 } from './resources/context.js';
 
 /**
@@ -63,11 +63,11 @@ export type UpdateWebhookSubscriptionsHandler = (
 /**
  * Handler called to acknowledge the reception of a webhook.
  */
-export type AckknowledgeWebhooksHandler = (
-  context: AckknowledgeWebhooksContext<any, any, any>,
+export type AcknowledgeWebhooksHandler = (
+  context: AcknowledgeWebhooksContext<any, any, any>,
 ) => Promise<API.WebhookAcknowledgeResponsePayload>;
 
-type ItemHandlers = {
+export type ItemHandlers = {
   getItem?: GetItemHandler;
   getCollection?: GetCollectionHandler;
   createItem?: CreateItemHandler;
@@ -75,20 +75,20 @@ type ItemHandlers = {
   deleteItem?: DeleteItemHandler;
 };
 
-type CredentialAccountHandlers = {
+export type CredentialAccountHandlers = {
   getCredentialAccount: GetCredentialAccountHandler;
 };
 
-type ParseWebhookHandlers = {
+export type ParseWebhookHandlers = {
   parseWebhooks: ParseWebhooksHandler;
 };
 
-type WebhookSubscriptionHandlers = {
+export type WebhookSubscriptionHandlers = {
   updateWebhookSubscriptions: UpdateWebhookSubscriptionsHandler;
 };
 
-type AcknowledgeWebhookHandlers = {
-  acknowledgeWebhooks: AckknowledgeWebhooksHandler;
+export type AcknowledgeWebhookHandlers = {
+  acknowledgeWebhooks: AcknowledgeWebhooksHandler;
 };
 
 export type HandlersInput =
@@ -230,6 +230,7 @@ export class Handler {
 
         const collection = await handler({
           credentials: res.locals.credentials,
+          secrets: res.locals.secrets,
           selects: res.locals.selects,
           filters: res.locals.filters,
           logger: res.locals.logger,
@@ -255,6 +256,7 @@ export class Handler {
 
         const createItemSummary = await handler({
           credentials: res.locals.credentials,
+          secrets: res.locals.secrets,
           body: req.body,
           logger: res.locals.logger,
           params: req.params,
@@ -277,6 +279,7 @@ export class Handler {
 
         const item = await handler({
           credentials: res.locals.credentials,
+          secrets: res.locals.secrets,
           logger: res.locals.logger,
           params: req.params,
           query: req.query,
@@ -300,6 +303,7 @@ export class Handler {
 
         const item = await handler({
           credentials: res.locals.credentials,
+          secrets: res.locals.secrets,
           body: req.body,
           logger: res.locals.logger,
           params: req.params,
@@ -322,6 +326,7 @@ export class Handler {
 
         await handler({
           credentials: res.locals.credentials,
+          secrets: res.locals.secrets,
           logger: res.locals.logger,
           params: req.params,
           query: req.query,
@@ -343,6 +348,7 @@ export class Handler {
 
         const credentialAccount = await handler({
           credentials: res.locals.credentials,
+          secrets: res.locals.secrets,
           logger: res.locals.logger,
           params: req.params,
           query: req.query,
@@ -361,6 +367,7 @@ export class Handler {
         assertWebhookParseRequestPayload(req.body);
 
         const response = await handler({
+          secrets: res.locals.secrets,
           logger: res.locals.logger,
           params: req.params,
           query: req.query,
@@ -380,6 +387,7 @@ export class Handler {
         assertWebhookParseRequestPayload(req.body);
 
         const response = await handler({
+          secrets: res.locals.secrets,
           logger: res.locals.logger,
           params: req.params,
           query: req.query,
@@ -403,6 +411,7 @@ export class Handler {
         assertWebhookSubscriptionRequestPayload(req.body);
 
         const response = await handler({
+          secrets: res.locals.secrets,
           credentials: res.locals.credentials,
           body: req.body,
           logger: res.locals.logger,

package/src/integration.ts

@@ -14,7 +14,7 @@ import { HandlersInput, Handler } from './handler.js';
 
 function printErrorMessage(message: string) {
   console.error();
-  console.error(`\x1b[31m Oups! Something went wrong! \x1b[0m`);
+  console.error(`\x1b[31m Oops! Something went wrong! \x1b[0m`);
   console.error(message);
 }
 

package/src/middlewares/secrets.ts

@@ -0,0 +1,35 @@
+import { Request, Response, NextFunction } from 'express';
+import { BadRequestError } from '../httpErrors.js';
+
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace Express {
+    interface Locals {
+      secrets: Secrets;
+    }
+  }
+}
+
+export type Secrets = { [keys: string]: unknown };
+
+const SECRETS_HEADER = 'X-Unito-Secrets';
+
+const middleware = (req: Request, res: Response, next: NextFunction) => {
+  const secretsHeader = req.header(SECRETS_HEADER);
+
+  if (secretsHeader) {
+    let secrets: Secrets;
+
+    try {
+      secrets = JSON.parse(Buffer.from(secretsHeader, 'base64').toString('utf8'));
+    } catch {
+      throw new BadRequestError(`Malformed HTTP header ${SECRETS_HEADER}`);
+    }
+
+    res.locals.secrets = secrets;
+  }
+
+  next();
+};
+
+export default middleware;

package/src/resources/context.ts

@@ -3,15 +3,22 @@ import * as API from '@unito/integration-api';
 
 import Logger from './logger.js';
 import { Credentials } from '../middlewares/credentials.js';
+import { Secrets } from 'src/middlewares/secrets.js';
 import { Filter } from '../middlewares/filters.js';
 
-type Context<P extends Record<string, string>, Q extends ParsedQueryString> = {
+export type Context<P extends Record<string, string>, Q extends ParsedQueryString> = {
   /**
    * The parsed credentials associated with the request through the X-Unito-Credentials header.
    *
    * Will contain the keys for the variables defined in the corresponding configuration's authorization.
    */
   credentials: Credentials;
+  /**
+   * The parsed secrets associated with the request through the X-Unito-Secrets header.
+   *
+   * Will contain the keys for the secrets defined in the corresponding configuration's secrets.
+   */
+  secrets: Secrets;
   /**
    * The logger pre decorated with the correlation ID and the additionnal metadata provided through the request headers.
    */
@@ -101,7 +108,7 @@ export type UpdateWebhookSubscriptionsContext<
   B extends API.WebhookSubscriptionRequestPayload = API.WebhookSubscriptionRequestPayload,
 > = Context<P, Q> & { body: B };
 
-export type AckknowledgeWebhooksContext<
+export type AcknowledgeWebhooksContext<
   P extends Record<string, string> = Record<string, never>,
   Q extends Record<string, string> = Record<string, never>,
   B extends API.WebhookParseRequestPayload = API.WebhookParseRequestPayload,

package/test/middlewares/secrets.test.ts

@@ -0,0 +1,39 @@
+import express from 'express';
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import middleware from '../../src/middlewares/secrets.js';
+import { BadRequestError } from '../../src/httpErrors.js';
+
+describe('secrets middleware', () => {
+  it('uses header', () => {
+    const secrets = Buffer.from(
+      JSON.stringify({
+        chut: 'abc',
+      }),
+    ).toString('base64');
+
+    const request = { header: (_key: string) => secrets } as express.Request;
+    const response = { locals: {} } as express.Response;
+
+    middleware(request, response, () => {});
+
+    assert.deepEqual(response.locals, {
+      secrets: {
+        chut: 'abc',
+      },
+    });
+  });
+
+  it('malformed header', async () => {
+    const request = { header: (_key: string) => 'nope' } as express.Request;
+    const response = { locals: {} } as express.Response;
+
+    assert.throws(() => middleware(request, response, () => {}), BadRequestError);
+  });
+
+  it('undefined', () => {
+    const response = { locals: {} } as express.Response;
+
+    assert.deepEqual(response.locals, {});
+  });
+});