Merge pull request #186 from nfroidure/feat/openapi_upgrade

feat(openapi): move OpenAPI support to 3.1
nfroidure · Jul 15, 2024 · e4da5e0 · e4da5e0
2 parents 7a13fc7 + 87fe576
commit e4da5e0
Show file tree

Hide file tree

Showing 56 changed files with 792 additions and 771 deletions.
diff --git a/packages/whook-aws-lambda/src/commands/testHTTPLambda.ts b/packages/whook-aws-lambda/src/commands/testHTTPLambda.ts
@@ -17,7 +17,7 @@ import type {
 } from '@whook/whook';
 import type { AppEnvVars } from 'application-services';
 import type { LogService, TimeService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { WhookAPIOperationAWSLambdaConfig } from '../index.js';
 import type { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
 
@@ -69,7 +69,7 @@ async function initTestHTTPLambdaCommand({
   APP_ENV: string;
   PROJECT_DIR: string;
   COMPILER_OPTIONS?: WhookCompilerOptions;
-  API: OpenAPIV3.Document;
+  API: OpenAPIV3_1.Document;
   time: TimeService;
   log: LogService;
   args: WhookCommandArgs;

diff --git a/packages/whook-aws-lambda/src/index.ts b/packages/whook-aws-lambda/src/index.ts
@@ -28,7 +28,7 @@ import type {
   WhookCompilerOptions,
   WhookCompilerService,
 } from '@whook/whook';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { LogService } from 'common-services';
 import type { CprOptions } from 'cpr';
 
@@ -171,7 +171,7 @@ export async function runBuild(
         compiler: WhookCompilerService;
         log: LogService;
         $autoload: Autoloader<Initializer<Dependencies, Service>>;
-        API: OpenAPIV3.Document;
+        API: OpenAPIV3_1.Document;
         buildInitializer: BuildInitializer;
       } = await $.run([
       'APP_ENV',

diff --git a/packages/whook-aws-lambda/src/services/_autoload.ts b/packages/whook-aws-lambda/src/services/_autoload.ts
@@ -32,7 +32,7 @@ import type {
   ServiceInitializerWrapper,
 } from 'knifecycle';
 import type { LogService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type {
   WhookAPIOperationAWSLambdaConfig,
   WhookAWSLambdaConfiguration,
@@ -99,12 +99,12 @@ const initializerWrapper: ServiceInitializerWrapper<
     path: string;
   }>
 > => {
-  let API: OpenAPIV3.Document;
+  let API: OpenAPIV3_1.Document;
   let OPERATION_APIS: WhookRawOperation<WhookAPIOperationAWSLambdaConfig>[];
   const getAPIOperation: (
     serviceName: string,
   ) => Promise<
-    [WhookAWSLambdaConfiguration['type'], string, OpenAPIV3.Document]
+    [WhookAWSLambdaConfiguration['type'], string, OpenAPIV3_1.Document]
   > = (() => {
     return async (serviceName) => {
       const cleanedName = serviceName.split('_').pop();
@@ -131,11 +131,11 @@ const initializerWrapper: ServiceInitializerWrapper<
       }
 
       // eslint-disable-next-line
-      const OPERATION_API: OpenAPIV3.Document = cleanupOpenAPI({
+      const OPERATION_API: OpenAPIV3_1.Document = cleanupOpenAPI({
         ...API,
         paths: {
           [OPERATION.path]: {
-            [OPERATION.method]: API.paths[OPERATION.path]?.[OPERATION.method],
+            [OPERATION.method]: API.paths?.[OPERATION.path]?.[OPERATION.method],
           },
         },
       });
@@ -152,7 +152,9 @@ const initializerWrapper: ServiceInitializerWrapper<
                   {
                     path: OPERATION.path,
                     method: OPERATION.method,
-                    ...OPERATION_API.paths[OPERATION.path]?.[OPERATION.method],
+                    ...OPERATION_API.paths?.[OPERATION.path]?.[
+                      OPERATION.method
+                    ],
                     parameters: OPERATION.parameters,
                   },
                 ])

diff --git a/packages/whook-aws-lambda/src/wrappers/awsConsumerLambda.ts b/packages/whook-aws-lambda/src/wrappers/awsConsumerLambda.ts
@@ -11,7 +11,7 @@ import type {
   WhookWrapper,
 } from '@whook/whook';
 import type { TimeService, LogService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type {
   KinesisStreamEvent,
   SQSEvent,
@@ -47,7 +47,7 @@ export type LambdaConsumerOutput = WhookResponse<number, WhookHeaders, void>;
 
 export type WhookWrapConsumerLambdaDependencies = {
   ENV: AppEnvVars;
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   apm: WhookAPMService;
   time?: TimeService;
   log?: LogService;
@@ -111,12 +111,12 @@ async function handleForAWSConsumerLambda(
   context: Context,
   callback: (err: Error) => void,
 ) {
-  const path = Object.keys(OPERATION_API.paths)[0];
-  const method = Object.keys(OPERATION_API.paths[path] || {})[0];
+  const path = Object.keys(OPERATION_API.paths || {})?.[0];
+  const method = Object.keys(OPERATION_API.paths?.[path] || {})[0];
   const OPERATION: WhookOperation = {
     path,
     method,
-    ...OPERATION_API.paths[path]?.[method],
+    ...OPERATION_API.paths?.[path]?.[method],
   };
   const startTime = time();
   const parameters: LambdaConsumerInput = {

diff --git a/packages/whook-aws-lambda/src/wrappers/awsCronLambda.ts b/packages/whook-aws-lambda/src/wrappers/awsCronLambda.ts
@@ -11,7 +11,7 @@ import type {
   WhookWrapper,
 } from '@whook/whook';
 import type { LogService, TimeService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { ScheduledEvent, Context } from 'aws-lambda';
 import type { JsonObject } from 'type-fest';
 import type { AppEnvVars } from 'application-services';
@@ -24,7 +24,7 @@ export type LambdaCronOutput = WhookResponse<number, WhookHeaders, void>;
 
 export type WhookWrapCronLambdaDependencies = {
   ENV: AppEnvVars;
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   apm: WhookAPMService;
   time?: TimeService;
   log?: LogService;
@@ -83,12 +83,12 @@ async function handleForAWSCronLambda<T extends JsonObject = JsonObject>(
   context: Context,
   callback: (err: Error) => void,
 ) {
-  const path = Object.keys(OPERATION_API.paths)[0];
-  const method = Object.keys(OPERATION_API.paths[path] || {})[0];
+  const path = Object.keys(OPERATION_API.paths || {})[0];
+  const method = Object.keys(OPERATION_API.paths?.[path] || {})[0];
   const OPERATION: WhookOperation = {
     path,
     method,
-    ...OPERATION_API.paths[path]?.[method],
+    ...OPERATION_API.paths?.[path]?.[method],
   };
   const startTime = time();
   const parameters: LambdaCronInput<T> = {

diff --git a/packages/whook-aws-lambda/src/wrappers/awsHTTPLambda.ts b/packages/whook-aws-lambda/src/wrappers/awsHTTPLambda.ts
@@ -43,10 +43,10 @@ import type {
   WhookWrapper,
 } from '@whook/whook';
 import type { TimeService, LogService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { Readable } from 'stream';
 import {
-  DereferencedParameterObject,
+  type DereferencedParameterObject,
   pickAllHeaderValues,
 } from '@whook/http-transaction';
 import type {
@@ -65,7 +65,7 @@ const uuidPattern =
   '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$';
 
 export type WhookWrapConsumerLambdaDependencies = {
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   ENV: AppEnvVars;
   DEBUG_NODE_ENVS?: string[];
   DECODERS?: typeof DEFAULT_DECODERS;
@@ -135,8 +135,8 @@ async function initWrapHandlerForConsumerLambda<S extends WhookHandler>({
 }: WhookWrapConsumerLambdaDependencies): Promise<WhookWrapper<S>> {
   log('debug', '📥 - Initializing the AWS LAmbda consumer wrapper.');
 
-  const path = Object.keys(OPERATION_API.paths)[0];
-  const pathObject = OPERATION_API.paths[path];
+  const path = Object.keys(OPERATION_API.paths || {})[0];
+  const pathObject = OPERATION_API.paths?.[path];
 
   if (typeof pathObject === 'undefined' || '$ref' in pathObject) {
     throw new YError('E_BAD_OPERATION', 'pathObject', pathObject);
@@ -175,7 +175,7 @@ async function initWrapHandlerForConsumerLambda<S extends WhookHandler>({
   const validators = prepareParametersValidators(
     ajv,
     operation.operationId,
-    ((operation.parameters || []) as OpenAPIV3.ParameterObject[]).concat(
+    ((operation.parameters || []) as DereferencedParameterObject[]).concat(
       ammendedParameters,
     ),
   );
@@ -371,13 +371,13 @@ async function handleForAWSHTTPLambda(
     // specified and it is not a binary one
     const responseObject =
       operation.responses &&
-      (operation.responses[response.status] as OpenAPIV3.ResponseObject);
+      (operation.responses[response.status] as OpenAPIV3_1.ResponseObject);
     const responseSchema =
       responseObject &&
       responseObject.content &&
       responseObject.content[response.headers['content-type']] &&
       (responseObject.content[response.headers['content-type']]
-        .schema as OpenAPIV3.SchemaObject);
+        .schema as OpenAPIV3_1.SchemaObject);
     const responseHasSchema =
       responseSchema &&
       (responseSchema.type !== 'string' || responseSchema.format !== 'binary');

diff --git a/packages/whook-aws-lambda/src/wrappers/awsKafkaConsumerLambda.ts b/packages/whook-aws-lambda/src/wrappers/awsKafkaConsumerLambda.ts
@@ -11,7 +11,7 @@ import type {
   WhookWrapper,
 } from '@whook/whook';
 import type { TimeService, LogService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { MSKEvent, Context } from 'aws-lambda';
 import type { AppEnvVars } from 'application-services';
 
@@ -24,7 +24,7 @@ export type LambdaKafkaConsumerOutput = WhookResponse<
 
 export type WhookWrapKafkaLambdaDependencies = {
   ENV: AppEnvVars;
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   apm: WhookAPMService;
   time?: TimeService;
   log?: LogService;
@@ -83,12 +83,12 @@ async function handleForAWSKafkaConsumerLambda(
   context: Context,
   callback: (err: Error) => void,
 ) {
-  const path = Object.keys(OPERATION_API.paths)[0];
-  const method = Object.keys(OPERATION_API.paths[path] || {})[0];
+  const path = Object.keys(OPERATION_API.paths || {})[0];
+  const method = Object.keys(OPERATION_API.paths?.[path] || {})[0];
   const OPERATION: WhookOperation = {
     path,
     method,
-    ...OPERATION_API.paths[path]?.[method],
+    ...OPERATION_API.paths?.[path]?.[method],
   };
   const startTime = time();
   const parameters: LambdaKafkaConsumerInput = {

diff --git a/packages/whook-aws-lambda/src/wrappers/awsLogSubscriberLambda.ts b/packages/whook-aws-lambda/src/wrappers/awsLogSubscriberLambda.ts
@@ -12,7 +12,7 @@ import type {
   WhookWrapper,
 } from '@whook/whook';
 import type { TimeService, LogService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { JsonValue } from 'type-fest';
 import type {
   CloudWatchLogsEvent,
@@ -33,7 +33,7 @@ export type LambdaLogSubscriberOutput = WhookResponse<
 
 export type WhookWrapLogSubscriberLambdaDependencies = {
   ENV: AppEnvVars;
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   apm: WhookAPMService;
   time?: TimeService;
   log?: LogService;
@@ -97,12 +97,12 @@ async function handleForAWSLogSubscriberLambda<
   context: Context,
   callback: (err: Error) => void,
 ) {
-  const path = Object.keys(OPERATION_API.paths)[0];
-  const method = Object.keys(OPERATION_API.paths[path] || {})[0];
+  const path = Object.keys(OPERATION_API.paths || {})[0];
+  const method = Object.keys(OPERATION_API.paths?.[path] || {})[0];
   const OPERATION: WhookOperation = {
     path,
     method,
-    ...OPERATION_API.paths[path]?.[method],
+    ...OPERATION_API.paths?.[path]?.[method],
   };
   const startTime = time();
   const parameters = {

diff --git a/packages/whook-aws-lambda/src/wrappers/awsS3Lambda.ts b/packages/whook-aws-lambda/src/wrappers/awsS3Lambda.ts
@@ -11,7 +11,7 @@ import type {
   WhookWrapper,
 } from '@whook/whook';
 import type { LogService, TimeService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { S3Event, Context } from 'aws-lambda';
 import type { AppEnvVars } from 'application-services';
 
@@ -20,7 +20,7 @@ export type LambdaS3Output = WhookResponse<number, WhookHeaders, void>;
 
 export type WhookWrapS3LambdaDependencies = {
   ENV: AppEnvVars;
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   apm: WhookAPMService;
   time?: TimeService;
   log?: LogService;
@@ -79,12 +79,12 @@ async function handleForAWSS3Lambda(
   context: Context,
   callback: (err: Error) => void,
 ) {
-  const path = Object.keys(OPERATION_API.paths)[0];
-  const method = Object.keys(OPERATION_API.paths[path] || {})[0];
+  const path = Object.keys(OPERATION_API.paths || {})[0];
+  const method = Object.keys(OPERATION_API.paths?.[path] || {})[0];
   const OPERATION: WhookOperation = {
     path,
     method,
-    ...OPERATION_API.paths[path]?.[method],
+    ...OPERATION_API.paths?.[path]?.[method],
   };
   const startTime = time();
   const parameters = {

diff --git a/packages/whook-aws-lambda/src/wrappers/awsTransformerLambda.ts b/packages/whook-aws-lambda/src/wrappers/awsTransformerLambda.ts
@@ -11,7 +11,7 @@ import type {
   WhookWrapper,
 } from '@whook/whook';
 import type { TimeService, LogService } from 'common-services';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type {
   FirehoseTransformationEvent,
   FirehoseTransformationEventRecord,
@@ -23,7 +23,7 @@ import type { AppEnvVars } from 'application-services';
 
 type TransformerWrapperDependencies = {
   ENV: AppEnvVars;
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   apm: WhookAPMService;
   time?: TimeService;
   log?: LogService;
@@ -57,7 +57,7 @@ export type LambdaTransformerOutput = WhookResponse<
 
 export type WhookWrapConsumerLambdaDependencies = {
   ENV: AppEnvVars;
-  OPERATION_API: OpenAPIV3.Document;
+  OPERATION_API: OpenAPIV3_1.Document;
   apm: WhookAPMService;
   time?: TimeService;
   log?: LogService;
@@ -119,12 +119,12 @@ async function handleForAWSTransformerLambda(
   context: Context,
   callback: (err: Error | null, result?: FirehoseTransformationResult) => void,
 ) {
-  const path = Object.keys(OPERATION_API.paths)[0];
-  const method = Object.keys(OPERATION_API.paths[path] || {})[0];
+  const path = Object.keys(OPERATION_API.paths || {})[0];
+  const method = Object.keys(OPERATION_API.paths?.[path] || {})[0];
   const OPERATION: WhookOperation = {
     path,
     method,
-    ...OPERATION_API.paths[path]?.[method],
+    ...OPERATION_API.paths?.[path]?.[method],
   };
   const startTime = time();
   const parameters = {

diff --git a/packages/whook-cors/src/__snapshots__/index.test.ts.snap b/packages/whook-cors/src/__snapshots__/index.test.ts.snap
@@ -47,7 +47,7 @@ exports[`augmentAPIWithCORS() should work 1`] = `
     "title": "Sample OpenAPI",
     "version": "1.0.0",
   },
-  "openapi": "3.0.2",
+  "openapi": "3.1.0",
   "paths": {
     "/crons/tokens": {
       "post": {

diff --git a/packages/whook-cors/src/index.test.ts b/packages/whook-cors/src/index.test.ts
@@ -8,7 +8,7 @@ import {
 import { handler } from 'knifecycle';
 import { YHTTPError } from 'yhttperror';
 import type { CORSConfig } from './index.js';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { WhookOperation } from '@whook/whook';
 import type { LogService } from 'common-services';
 
@@ -216,7 +216,7 @@ describe('augmentAPIWithCORS()', () => {
   it('should work', async () => {
     expect(
       await augmentAPIWithCORS({
-        openapi: '3.0.2',
+        openapi: '3.1.0',
         info: {
           version: '1.0.0',
           title: 'Sample OpenAPI',
@@ -354,8 +354,8 @@ describe('augmentAPIWithCORS()', () => {
                   description: 'Pong',
                 },
               },
-            } as OpenAPIV3.OperationObject,
-          },
+            },
+          } as OpenAPIV3_1.PathItemObject,
         },
       }),
     ).toMatchSnapshot();