@unito/integration-sdk 1.0.27 → 1.1.0

package/src/middlewares/credentials.ts

@@ -14,7 +14,7 @@ export type Credentials = { accessToken?: string; [keys: string]: unknown };
 
 const CREDENTIALS_HEADER = 'X-Unito-Credentials';
 
-const middleware = (req: Request, res: Response, next: NextFunction) => {
+function extractCredentials(req: Request, res: Response, next: NextFunction) {
   const credentialsHeader = req.header(CREDENTIALS_HEADER);
 
   if (credentialsHeader) {
@@ -30,6 +30,6 @@ const middleware = (req: Request, res: Response, next: NextFunction) => {
   }
 
   next();
-};
+}
 
-export default middleware;
+export default extractCredentials;

package/src/middlewares/errors.ts

@@ -12,7 +12,7 @@ declare global {
   }
 }
 
-const middleware = (err: Error, _req: Request, res: Response, next: NextFunction) => {
+function onError(err: Error, _req: Request, res: Response, next: NextFunction) {
   if (res.headersSent) {
     return next(err);
   }
@@ -50,6 +50,6 @@ const middleware = (err: Error, _req: Request, res: Response, next: NextFunction
   }
 
   res.status(Number(error.code)).json(error);
-};
+}
 
-export default middleware;
+export default onError;

package/src/middlewares/filters.ts

@@ -32,9 +32,9 @@ export type Filter = {
 // a subset of the symbol of another operator.
 //
 // For example, the symbol "=" (EQUAL) is a subset of the symbol "!=" (NOT_EQUAL).
-const ORDERED_OPERATORS = Object.values(OperatorType).sort((o1, o2) => o1.length - o2.length);
+const ORDERED_OPERATORS = Object.values(OperatorType).sort((o1, o2) => o2.length - o1.length);
 
-const middleware = (req: Request, res: Response, next: NextFunction) => {
+function extractFilters(req: Request, res: Response, next: NextFunction) {
   const rawFilters = req.query.filter;
 
   res.locals.filters = [];
@@ -55,6 +55,6 @@ const middleware = (req: Request, res: Response, next: NextFunction) => {
   }
 
   next();
-};
+}
 
-export default middleware;
+export default extractFilters;

package/src/middlewares/finish.ts

@@ -13,7 +13,7 @@ declare global {
   }
 }
 
-const middleware = (req: Request, res: Response, next: NextFunction) => {
+function onFinish(req: Request, res: Response, next: NextFunction) {
   if (req.originalUrl !== '/health') {
     res.on('finish', function () {
       const error = res.locals.error;
@@ -49,6 +49,6 @@ const middleware = (req: Request, res: Response, next: NextFunction) => {
   }
 
   next();
-};
+}
 
-export default middleware;
+export default onFinish;

package/src/middlewares/logger.ts

@@ -13,7 +13,7 @@ declare global {
 
 const ADDITIONAL_CONTEXT_HEADER = 'X-Unito-Additional-Logging-Context';
 
-const middleware = (req: Request, res: Response, next: NextFunction) => {
+function injectLogger(req: Request, res: Response, next: NextFunction) {
   const logger = new Logger({ correlation_id: res.locals.correlationId });
 
   res.locals.logger = logger;
@@ -31,6 +31,6 @@ const middleware = (req: Request, res: Response, next: NextFunction) => {
   }
 
   next();
-};
+}
 
-export default middleware;
+export default injectLogger;

package/src/middlewares/notFound.ts

@@ -1,13 +1,13 @@
 import { Request, Response, NextFunction } from 'express';
 import { Error as APIError } from '@unito/integration-api';
 
-const middleware = (req: Request, res: Response, _next: NextFunction) => {
+function notFound(req: Request, res: Response, _next: NextFunction) {
   const error: APIError = {
     code: '404',
     message: `Path ${req.path} not found.`,
   };
 
   res.status(404).json(error);
-};
+}
 
-export default middleware;
+export default notFound;

package/src/middlewares/secrets.ts

@@ -19,7 +19,7 @@ export type Secrets = { [keys: string]: unknown };
 
 const SECRETS_HEADER = 'X-Unito-Secrets';
 
-const middleware = (req: Request, res: Response, next: NextFunction) => {
+function extractSecrets(req: Request, res: Response, next: NextFunction) {
   const secretsHeader = req.header(SECRETS_HEADER);
 
   if (secretsHeader) {
@@ -35,6 +35,6 @@ const middleware = (req: Request, res: Response, next: NextFunction) => {
   }
 
   next();
-};
+}
 
-export default middleware;
+export default extractSecrets;

package/src/middlewares/selects.ts

@@ -16,7 +16,7 @@ declare global {
   }
 }
 
-const middleware = (req: Request, res: Response, next: NextFunction) => {
+function extractSelects(req: Request, res: Response, next: NextFunction) {
   const rawSelect = req.query.select;
 
   if (typeof rawSelect === 'string') {
@@ -26,6 +26,6 @@ const middleware = (req: Request, res: Response, next: NextFunction) => {
   }
 
   next();
-};
+}
 
-export default middleware;
+export default extractSelects;

package/src/middlewares/signal.ts

@@ -17,7 +17,7 @@ declare global {
 
 const OPERATION_DEADLINE_HEADER = 'X-Unito-Operation-Deadline';
 
-const middleware = (req: Request, res: Response, next: NextFunction) => {
+function extractOperationDeadline(req: Request, res: Response, next: NextFunction) {
   const operationDeadlineHeader = Number(req.header(OPERATION_DEADLINE_HEADER));
 
   if (operationDeadlineHeader) {
@@ -36,6 +36,6 @@ const middleware = (req: Request, res: Response, next: NextFunction) => {
   }
 
   next();
-};
+}
 
-export default middleware;
+export default extractOperationDeadline;

package/src/middlewares/{requestStartTime.ts → start.ts}

@@ -9,10 +9,10 @@ declare global {
   }
 }
 
-const middleware = (_: Request, res: Response, next: NextFunction) => {
+function start(_: Request, res: Response, next: NextFunction) {
   res.locals.requestStartTime = process.hrtime.bigint();
 
   next();
-};
+}
 
-export default middleware;
+export default start;

package/test/errors.test.ts

@@ -6,7 +6,7 @@ import * as httpErrors from '../src/httpErrors.js';
 describe('handleErrorResponse', () => {
   it('returns correct httpError given status code', () => {
     assert.ok(errors.buildHttpError(401, 'unauthorized') instanceof httpErrors.UnauthorizedError);
-    assert.ok(errors.buildHttpError(403, 'forbidden') instanceof httpErrors.UnauthorizedError);
+    assert.ok(errors.buildHttpError(403, 'forbidden') instanceof httpErrors.ForbiddenError);
     assert.ok(errors.buildHttpError(404, 'not found') instanceof httpErrors.NotFoundError);
     assert.ok(errors.buildHttpError(408, 'timeout') instanceof httpErrors.TimeoutError);
     assert.ok(errors.buildHttpError(410, 'resource gone') instanceof httpErrors.ResourceGoneError);

package/test/middlewares/correlationId.test.ts

@@ -1,14 +1,14 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/correlationId.js';
+import extractCorrelationId from '../../src/middlewares/correlationId.js';
 
 describe('correlationId middleware', () => {
   it('uses header', () => {
     const request = { header: (_key: string) => '123' } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractCorrelationId(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       correlationId: '123',
@@ -19,7 +19,7 @@ describe('correlationId middleware', () => {
     const request = { header: (_key: string) => undefined } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractCorrelationId(request, response, () => {});
 
     assert(response.locals.correlationId);
   });

package/test/middlewares/credentials.test.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/credentials.js';
+import extractCredentials from '../../src/middlewares/credentials.js';
 import { BadRequestError } from '../../src/httpErrors.js';
 
 describe('credentials middleware', () => {
@@ -15,7 +15,7 @@ describe('credentials middleware', () => {
     const request = { header: (_key: string) => credentials } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractCredentials(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       credentials: {
@@ -28,7 +28,7 @@ describe('credentials middleware', () => {
     const request = { header: (_key: string) => 'nope' } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    assert.throws(() => middleware(request, response, () => {}), BadRequestError);
+    assert.throws(() => extractCredentials(request, response, () => {}), BadRequestError);
   });
 
   it('variables', async () => {
@@ -41,7 +41,7 @@ describe('credentials middleware', () => {
     const request = { header: (_key: string) => credentials } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractCredentials(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       credentials: {

package/test/middlewares/errors.test.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/errors.js';
+import onError from '../../src/middlewares/errors.js';
 import { HttpError } from '../../src/httpErrors.js';
 
 describe('errors middleware', () => {
@@ -23,7 +23,7 @@ describe('errors middleware', () => {
       locals: { logger: { error: () => undefined } },
     } as unknown as express.Response;
 
-    middleware(new Error(), {} as express.Request, response, () => {});
+    onError(new Error(), {} as express.Request, response, () => {});
 
     assert.strictEqual(actualStatus, undefined);
     assert.strictEqual(actualJson, undefined);
@@ -46,7 +46,7 @@ describe('errors middleware', () => {
       },
       locals: { logger: { error: () => undefined } },
     } as unknown as express.Response;
-    middleware(new HttpError('httpError', 429), {} as express.Request, response, () => {});
+    onError(new HttpError('httpError', 429), {} as express.Request, response, () => {});
 
     assert.strictEqual(actualStatus, 429);
     assert.deepEqual(actualJson, { code: '429', message: 'httpError' });
@@ -69,7 +69,7 @@ describe('errors middleware', () => {
       },
       locals: { logger: { error: () => undefined } },
     } as unknown as express.Response;
-    middleware(new Error('error'), {} as express.Request, response, () => {});
+    onError(new Error('error'), {} as express.Request, response, () => {});
 
     assert.strictEqual(actualStatus, 500);
     assert.strictEqual(actualJson?.code, '500');

package/test/middlewares/filters.test.ts

@@ -2,32 +2,51 @@ import { OperatorType } from '@unito/integration-api';
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/filters.js';
+import extractFilters from '../../src/middlewares/filters.js';
 
 describe('filters middleware', () => {
-  it('data', () => {
-    const request = { query: { filter: 'status=active|pending,createdAt>2022-01-01,email!!' } } as express.Request<
+  it('properly parse operators', () => {
+    Object.values(OperatorType).forEach(operator => {
+      const request = {
+        query: { filter: `aKey${operator}value` },
+      } as express.Request<
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        any,
+        object,
+        object,
+        { filter: string }
+      >;
+
+      const response = { locals: {} } as express.Response;
+
+      extractFilters(request, response, () => {});
+
+      assert.deepEqual(response.locals, {
+        filters: [{ field: 'aKey', operator, values: ['value'] }],
+      });
+    });
+
+    const request = {
+      query: { filter: `aKey!!` },
+    } as express.Request<
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       any,
       object,
       object,
       { filter: string }
     >;
+
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractFilters(request, response, () => {});
 
     assert.deepEqual(response.locals, {
-      filters: [
-        { field: 'status', operator: OperatorType.EQUAL, values: ['active', 'pending'] },
-        { field: 'createdAt', operator: OperatorType.GREATER_THAN, values: ['2022-01-01'] },
-        { field: 'email', operator: OperatorType.IS_NOT_NULL, values: [] },
-      ],
+      filters: [{ field: 'aKey', operator: OperatorType.IS_NULL, values: [] }],
     });
   });
 
   it('decodes URI components', () => {
-    const request = { query: { filter: 'status=foo%2Cbar!!%2C%3Fbaz%3D!%3Equx' } } as express.Request<
+    const request = { query: { filter: 'status=foo%2Cbar%21%21%2C%3Fbaz%3D!%3Equx' } } as express.Request<
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       any,
       object,
@@ -36,7 +55,7 @@ describe('filters middleware', () => {
     >;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractFilters(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       filters: [{ field: 'status', operator: OperatorType.EQUAL, values: ['foo,bar!!,?baz=!>qux'] }],
@@ -47,7 +66,7 @@ describe('filters middleware', () => {
     const request = { query: {} } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractFilters(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       filters: [],

package/test/middlewares/finish.test.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/finish.js';
+import onFinish from '../../src/middlewares/finish.js';
 
 describe('finish middleware', () => {
   it('logs info', () => {
@@ -24,7 +24,7 @@ describe('finish middleware', () => {
       statusCode: 200,
     } as express.Response;
 
-    middleware(request, response, () => {});
+    onFinish(request, response, () => {});
     eventHandler();
 
     assert.equal(expected, 'works!');
@@ -50,7 +50,7 @@ describe('finish middleware', () => {
       statusCode: 500,
     } as express.Response;
 
-    middleware(request, response, () => {});
+    onFinish(request, response, () => {});
     eventHandler();
 
     assert.equal(expected, 'works!');
@@ -76,7 +76,7 @@ describe('finish middleware', () => {
       statusCode: 200,
     } as express.Response;
 
-    middleware(request, response, () => {});
+    onFinish(request, response, () => {});
     eventHandler();
 
     assert.equal(expected, '');

package/test/middlewares/logger.test.ts

@@ -1,14 +1,14 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/logger.js';
+import injectLogger from '../../src/middlewares/logger.js';
 
 describe('logger middleware', () => {
   it('initializes', () => {
     const request = { header: (_key: string) => undefined } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    injectLogger(request, response, () => {});
 
     assert.deepEqual(response.locals.logger.getMetadata(), {
       correlation_id: undefined,
@@ -19,7 +19,7 @@ describe('logger middleware', () => {
     const request = { header: (_key: string) => undefined } as express.Request;
     const response = { locals: { correlationId: '123' } } as express.Response;
 
-    middleware(request, response, () => {});
+    injectLogger(request, response, () => {});
 
     assert.deepEqual(response.locals.logger.getMetadata(), {
       correlation_id: '123',
@@ -34,7 +34,7 @@ describe('logger middleware', () => {
     const request = { header: (_key: string) => additional } as express.Request;
     const response = { locals: { correlationId: '123' } } as express.Response;
 
-    middleware(request, response, () => {});
+    injectLogger(request, response, () => {});
 
     assert.deepEqual(response.locals.logger.getMetadata(), {
       correlation_id: '123',
@@ -46,7 +46,7 @@ describe('logger middleware', () => {
     const request = { header: (_key: string) => 'nope' } as express.Request;
     const response = { locals: { correlationId: '123' } } as express.Response;
 
-    middleware(request, response, () => {});
+    injectLogger(request, response, () => {});
 
     assert.deepEqual(response.locals.logger.getMetadata(), {
       correlation_id: '123',

package/test/middlewares/notFound.test.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/notFound.js';
+import notFound from '../../src/middlewares/notFound.js';
 
 describe('notFound middleware', () => {
   it('respond with error without calling next', () => {
@@ -21,7 +21,7 @@ describe('notFound middleware', () => {
       },
       locals: { logger: { error: () => undefined } },
     } as unknown as express.Response;
-    middleware({ path: 'unknownPath' } as express.Request, response, () => {
+    notFound({ path: 'unknownPath' } as express.Request, response, () => {
       throw new Error('next should not be called');
     });
 

package/test/middlewares/secrets.test.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/secrets.js';
+import extractSecrets from '../../src/middlewares/secrets.js';
 import { BadRequestError } from '../../src/httpErrors.js';
 
 describe('secrets middleware', () => {
@@ -15,7 +15,7 @@ describe('secrets middleware', () => {
     const request = { header: (_key: string) => secrets } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractSecrets(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       secrets: {
@@ -28,7 +28,7 @@ describe('secrets middleware', () => {
     const request = { header: (_key: string) => 'nope' } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    assert.throws(() => middleware(request, response, () => {}), BadRequestError);
+    assert.throws(() => extractSecrets(request, response, () => {}), BadRequestError);
   });
 
   it('undefined', () => {

package/test/middlewares/selects.test.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/selects.js';
+import extractSelects from '../../src/middlewares/selects.js';
 
 describe('selects middleware', () => {
   it('data', () => {
@@ -14,7 +14,7 @@ describe('selects middleware', () => {
     >;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractSelects(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       selects: ['foo', 'bar.spam', 'baz'],
@@ -25,7 +25,7 @@ describe('selects middleware', () => {
     const request = { query: {} } as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractSelects(request, response, () => {});
 
     assert.deepEqual(response.locals, {
       selects: [],

package/test/middlewares/signal.test.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import middleware from '../../src/middlewares/signal.js';
+import extractOperationDeadline from '../../src/middlewares/signal.js';
 
 describe('signal middleware', () => {
   it('uses header', () => {
@@ -10,7 +10,7 @@ describe('signal middleware', () => {
     const request = { header: (_key: string) => deadline } as unknown as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractOperationDeadline(request, response, () => {});
 
     assert.ok(response.locals.signal instanceof AbortSignal);
     assert.equal(response.locals.signal.aborted, false);
@@ -20,7 +20,7 @@ describe('signal middleware', () => {
     const request = { header: (_key: string) => undefined } as unknown as express.Request;
     const response = { locals: {} } as express.Response;
 
-    middleware(request, response, () => {});
+    extractOperationDeadline(request, response, () => {});
 
     assert.ok(response.locals.signal instanceof AbortSignal);
     assert.equal(response.locals.signal.aborted, false);

package/test/middlewares/start.test.ts

@@ -0,0 +1,14 @@
+import express from 'express';
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import start from '../../src/middlewares/start.js';
+
+describe('start middleware', () => {
+  it('adds request start time to locals', () => {
+    const request = {} as express.Request;
+    const response = { locals: {} } as express.Response;
+
+    start(request, response, () => {});
+    assert.ok(response.locals.requestStartTime);
+  });
+});