@unito/integration-sdk 1.4.4 → 1.6.0

package/dist/src/handler.js

@@ -98,6 +98,7 @@ export class Handler {
                     signal: res.locals.signal,
                     params: req.params,
                     query: req.query,
+                    relations: res.locals.relations,
                 });
                 res.status(200).send(collection);
             });

package/dist/src/index.cjs

@@ -529,6 +529,7 @@ class Handler {
                     signal: res.locals.signal,
                     params: req.params,
                     query: req.query,
+                    relations: res.locals.relations,
                 });
                 res.status(200).send(collection);
             });
@@ -939,6 +940,12 @@ function extractSelects(req, res, next) {
     next();
 }
 
+function extractRelations(req, res, next) {
+    const rawRelations = req.query.relations;
+    res.locals.relations = typeof rawRelations === 'string' ? rawRelations.split(',') : [];
+    next();
+}
+
 const OPERATION_DEADLINE_HEADER = 'X-Unito-Operation-Deadline';
 function extractOperationDeadline(req, res, next) {
     const operationDeadlineHeader = Number(req.header(OPERATION_DEADLINE_HEADER));
@@ -1075,6 +1082,7 @@ class Integration {
         app.use(extractSecrets);
         app.use(extractFilters);
         app.use(extractSelects);
+        app.use(extractRelations);
         app.use(extractOperationDeadline);
         // Load handlers as needed.
         if (this.handlers.length) {
@@ -1344,7 +1352,8 @@ class Provider {
             if (headers['Content-Type'] === 'application/x-www-form-urlencoded') {
                 stringifiedBody = new URLSearchParams(body).toString();
             }
-            else if (headers['Content-Type'] === 'application/json') {
+            else if (headers['Content-Type'] === 'application/json' ||
+                headers['Content-Type'] === 'application/json-patch+json') {
                 stringifiedBody = JSON.stringify(body);
             }
         }

package/dist/src/integration.js

@@ -11,6 +11,7 @@ import loggerMiddleware from './middlewares/logger.js';
 import startMiddleware from './middlewares/start.js';
 import secretsMiddleware from './middlewares/secrets.js';
 import selectsMiddleware from './middlewares/selects.js';
+import relationsMiddleware from './middlewares/relations.js';
 import signalMiddleware from './middlewares/signal.js';
 function printErrorMessage(message) {
     console.error();
@@ -131,6 +132,7 @@ export default class Integration {
         app.use(secretsMiddleware);
         app.use(filtersMiddleware);
         app.use(selectsMiddleware);
+        app.use(relationsMiddleware);
         app.use(signalMiddleware);
         // Load handlers as needed.
         if (this.handlers.length) {

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

@@ -0,0 +1,10 @@
+import { Request, Response, NextFunction } from 'express';
+declare global {
+    namespace Express {
+        interface Locals {
+            relations: string[];
+        }
+    }
+}
+declare function extractRelations(req: Request, res: Response, next: NextFunction): void;
+export default extractRelations;

package/dist/src/middlewares/relations.js

@@ -0,0 +1,6 @@
+function extractRelations(req, res, next) {
+    const rawRelations = req.query.relations;
+    res.locals.relations = typeof rawRelations === 'string' ? rawRelations.split(',') : [];
+    next();
+}
+export default extractRelations;

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

@@ -100,6 +100,16 @@ export type GetCollectionContext<P extends Maybe<Params> = Empty, Q extends Quer
      *  ['name', 'department.name']
      */
     selects: string[];
+    /**
+     * Parsed relations query param yielding a list of relation for which the path should be returned.
+     *
+     *  Given a relations query param:
+     *  `relations=items,subitems`
+     *
+     *  Context.relations will be:
+     *  ['items', 'subitems']
+     */
+    relations: string[];
 };
 export type CreateItemContext<P extends Maybe<Params> = Empty, Q extends Maybe<Query> = Empty, B extends CreateItemBody = API.CreateItemRequestPayload> = Context<P, Q> & {
     body: B;

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

@@ -60,6 +60,7 @@ export type PreparedRequest = {
     url: string;
     headers: Record<string, string>;
 };
+export type RequestBody = Record<string, unknown> | RequestBody[];
 /**
  * The Provider class is a wrapper around the fetch function to call a provider's HTTP API.
  *
@@ -149,7 +150,7 @@ export declare class Provider {
      * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
      * @returns The {@link Response} extracted from the provider.
      */
-    post<T>(endpoint: string, body: Record<string, unknown>, options: RequestOptions): Promise<Response<T>>;
+    post<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>>;
     postForm<T>(endpoint: string, form: FormData, options: RequestOptions): Promise<Response<T>>;
     /**
      * Performs a PUT request to the provider.
@@ -163,7 +164,7 @@ export declare class Provider {
      * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
      * @returns The {@link Response} extracted from the provider.
      */
-    put<T>(endpoint: string, body: Record<string, unknown>, options: RequestOptions): Promise<Response<T>>;
+    put<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>>;
     /**
      * Performs a PATCH request to the provider.
      *
@@ -176,7 +177,7 @@ export declare class Provider {
      * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
      * @returns The {@link Response} extracted from the provider.
      */
-    patch<T>(endpoint: string, body: Record<string, unknown>, options: RequestOptions): Promise<Response<T>>;
+    patch<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>>;
     /**
      * Performs a DELETE request to the provider.
      *

package/dist/src/resources/provider.js

@@ -245,7 +245,8 @@ export class Provider {
             if (headers['Content-Type'] === 'application/x-www-form-urlencoded') {
                 stringifiedBody = new URLSearchParams(body).toString();
             }
-            else if (headers['Content-Type'] === 'application/json') {
+            else if (headers['Content-Type'] === 'application/json' ||
+                headers['Content-Type'] === 'application/json-patch+json') {
                 stringifiedBody = JSON.stringify(body);
             }
         }

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

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

package/dist/test/middlewares/relations.test.js

@@ -0,0 +1,21 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import extractRelations from '../../src/middlewares/relations.js';
+describe('relations middleware', () => {
+    it('data', () => {
+        const request = { query: { relations: 'foo,bar,baz' } };
+        const response = { locals: {} };
+        extractRelations(request, response, () => { });
+        assert.deepEqual(response.locals, {
+            relations: ['foo', 'bar', 'baz'],
+        });
+    });
+    it('no data', () => {
+        const request = { query: {} };
+        const response = { locals: {} };
+        extractRelations(request, response, () => { });
+        assert.deepEqual(response.locals, {
+            relations: [],
+        });
+    });
+});

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

@@ -157,6 +157,39 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
     });
+    it('accept an array as body for post request', async (context) => {
+        const response = new Response('{"data": "value"}', {
+            status: 201,
+            headers: { 'Content-Type': 'application/json' },
+        });
+        const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
+        const actualResponse = await provider.post('/endpoint', [
+            { data: '1', data2: '2' },
+            { data: '3', data2: '4' },
+        ], {
+            credentials: { apiKey: 'apikey#1111' },
+            logger: logger,
+            signal: new AbortController().signal,
+            additionnalheaders: { 'Content-Type': 'application/json-patch+json', 'X-Additional-Header': 'value1' },
+        });
+        assert.equal(fetchMock.mock.calls.length, 1);
+        assert.deepEqual(fetchMock.mock.calls[0]?.arguments, [
+            'www.myApi.com/endpoint',
+            {
+                method: 'POST',
+                body: '[{"data":"1","data2":"2"},{"data":"3","data2":"4"}]',
+                signal: new AbortController().signal,
+                headers: {
+                    'Content-Type': 'application/json-patch+json',
+                    Accept: 'application/json',
+                    'X-Custom-Provider-Header': 'value',
+                    'X-Provider-Credential-Header': 'apikey#1111',
+                    'X-Additional-Header': 'value1',
+                },
+            },
+        ]);
+        assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
+    });
     it('put with json body', async (context) => {
         const response = new Response('{"data": "value"}', {
             status: 201,

package/package.json

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

package/src/handler.ts

@@ -303,6 +303,7 @@ export class Handler {
           signal: res.locals.signal,
           params: req.params,
           query: req.query,
+          relations: res.locals.relations,
         });
 
         res.status(200).send(collection);

package/src/integration.ts

@@ -13,6 +13,7 @@ import loggerMiddleware from './middlewares/logger.js';
 import startMiddleware from './middlewares/start.js';
 import secretsMiddleware from './middlewares/secrets.js';
 import selectsMiddleware from './middlewares/selects.js';
+import relationsMiddleware from './middlewares/relations.js';
 import signalMiddleware from './middlewares/signal.js';
 
 function printErrorMessage(message: string) {
@@ -149,6 +150,7 @@ export default class Integration {
     app.use(secretsMiddleware);
     app.use(filtersMiddleware);
     app.use(selectsMiddleware);
+    app.use(relationsMiddleware);
     app.use(signalMiddleware);
 
     // Load handlers as needed.

package/src/middlewares/relations.ts

@@ -0,0 +1,27 @@
+import { Request, Response, NextFunction } from 'express';
+
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace Express {
+    interface Locals {
+      // When the query params contains...
+      //
+      //   relations=items,subitems
+      //
+      // ... it becomes available as follow in handlers:
+      //
+      //   ['items', 'subitems']
+      relations: string[];
+    }
+  }
+}
+
+function extractRelations(req: Request, res: Response, next: NextFunction) {
+  const rawRelations = req.query.relations;
+
+  res.locals.relations = typeof rawRelations === 'string' ? rawRelations.split(',') : [];
+
+  next();
+}
+
+export default extractRelations;

package/src/resources/context.ts

@@ -106,6 +106,16 @@ export type GetCollectionContext<P extends Maybe<Params> = Empty, Q extends Quer
    *  ['name', 'department.name']
    */
   selects: string[];
+  /**
+   * Parsed relations query param yielding a list of relation for which the path should be returned.
+   *
+   *  Given a relations query param:
+   *  `relations=items,subitems`
+   *
+   *  Context.relations will be:
+   *  ['items', 'subitems']
+   */
+  relations: string[];
 };
 
 export type CreateItemContext<

package/src/resources/provider.ts

@@ -64,6 +64,8 @@ export type PreparedRequest = {
   headers: Record<string, string>;
 };
 
+export type RequestBody = Record<string, unknown> | RequestBody[];
+
 /**
  * The Provider class is a wrapper around the fetch function to call a provider's HTTP API.
  *
@@ -184,7 +186,7 @@ export class Provider {
    * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
    * @returns The {@link Response} extracted from the provider.
    */
-  public async post<T>(endpoint: string, body: Record<string, unknown>, options: RequestOptions): Promise<Response<T>> {
+  public async post<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>> {
     return this.fetchWrapper<T>(endpoint, body, {
       ...options,
       method: 'POST',
@@ -261,7 +263,7 @@ export class Provider {
    * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
    * @returns The {@link Response} extracted from the provider.
    */
-  public async put<T>(endpoint: string, body: Record<string, unknown>, options: RequestOptions): Promise<Response<T>> {
+  public async put<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>> {
     return this.fetchWrapper<T>(endpoint, body, {
       ...options,
       method: 'PUT',
@@ -284,11 +286,7 @@ export class Provider {
    * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
    * @returns The {@link Response} extracted from the provider.
    */
-  public async patch<T>(
-    endpoint: string,
-    body: Record<string, unknown>,
-    options: RequestOptions,
-  ): Promise<Response<T>> {
+  public async patch<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>> {
     return this.fetchWrapper<T>(endpoint, body, {
       ...options,
       method: 'PATCH',
@@ -337,7 +335,7 @@ export class Provider {
 
   private async fetchWrapper<T>(
     endpoint: string,
-    body: Record<string, unknown> | null,
+    body: RequestBody | null,
     options: RequestOptions & { defaultHeaders: { 'Content-Type'?: string; Accept?: string }; method: string },
   ): Promise<Response<T>> {
     const { url: providerUrl, headers: providerHeaders } = await this.prepareRequest(options);
@@ -349,7 +347,10 @@ export class Provider {
     if (body) {
       if (headers['Content-Type'] === 'application/x-www-form-urlencoded') {
         stringifiedBody = new URLSearchParams(body as Record<string, string>).toString();
-      } else if (headers['Content-Type'] === 'application/json') {
+      } else if (
+        headers['Content-Type'] === 'application/json' ||
+        headers['Content-Type'] === 'application/json-patch+json'
+      ) {
         stringifiedBody = JSON.stringify(body);
       }
     }

package/test/middlewares/relations.test.ts

@@ -0,0 +1,35 @@
+import express from 'express';
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+
+import extractRelations from '../../src/middlewares/relations.js';
+
+describe('relations middleware', () => {
+  it('data', () => {
+    const request = { query: { relations: 'foo,bar,baz' } } as express.Request<
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      any,
+      object,
+      object,
+      { relations: string }
+    >;
+    const response = { locals: {} } as express.Response;
+
+    extractRelations(request, response, () => {});
+
+    assert.deepEqual(response.locals, {
+      relations: ['foo', 'bar', 'baz'],
+    });
+  });
+
+  it('no data', () => {
+    const request = { query: {} } as express.Request;
+    const response = { locals: {} } as express.Response;
+
+    extractRelations(request, response, () => {});
+
+    assert.deepEqual(response.locals, {
+      relations: [],
+    });
+  });
+});

package/test/resources/provider.test.ts

@@ -188,6 +188,47 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
   });
 
+  it('accept an array as body for post request', async context => {
+    const response = new Response('{"data": "value"}', {
+      status: 201,
+      headers: { 'Content-Type': 'application/json' },
+    });
+
+    const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
+
+    const actualResponse = await provider.post(
+      '/endpoint',
+      [
+        { data: '1', data2: '2' },
+        { data: '3', data2: '4' },
+      ],
+      {
+        credentials: { apiKey: 'apikey#1111' },
+        logger: logger,
+        signal: new AbortController().signal,
+        additionnalheaders: { 'Content-Type': 'application/json-patch+json', 'X-Additional-Header': 'value1' },
+      },
+    );
+
+    assert.equal(fetchMock.mock.calls.length, 1);
+    assert.deepEqual(fetchMock.mock.calls[0]?.arguments, [
+      'www.myApi.com/endpoint',
+      {
+        method: 'POST',
+        body: '[{"data":"1","data2":"2"},{"data":"3","data2":"4"}]',
+        signal: new AbortController().signal,
+        headers: {
+          'Content-Type': 'application/json-patch+json',
+          Accept: 'application/json',
+          'X-Custom-Provider-Header': 'value',
+          'X-Provider-Credential-Header': 'apikey#1111',
+          'X-Additional-Header': 'value1',
+        },
+      },
+    ]);
+    assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
+  });
+
   it('put with json body', async context => {
     const response = new Response('{"data": "value"}', {
       status: 201,