Merge pull request #1728 from inversify/feat/add-swagger-ui-provider

Add 3.2 Swagger UI provider

Author: notaphplover

.changeset/eager-adults-fail.md

@@ -0,0 +1,5 @@
+---
+"@inversifyjs/http-open-api": patch
+---
+
+- Updated `mergeOpenApiTypeSchema` to properly handle property schema metadata edge case

.changeset/metal-worms-know.md

@@ -0,0 +1,5 @@
+---
+"@inversifyjs/http-open-api": minor
+---
+
+- Added 3.2 `SwaggerUiProvider`

packages/framework/http/libraries/open-api/src/common/models/FilteredByValueType.spec-d.ts

@@ -0,0 +1,60 @@
+import { describe, expectTypeOf, it } from 'vitest';
+
+import {
+  type OpenApi3Dot2OperationObject,
+  type OpenApi3Dot2PathItemObject,
+} from '@inversifyjs/open-api-types/v3Dot2';
+
+import { type FilteredByValueType } from './FilteredByValueType.js';
+
+// eslint-disable-next-line vitest/prefer-describe-function-title
+describe('FilteredByValueType', () => {
+  describe('having an object with optional properties of mixed types', () => {
+    interface TestObject {
+      bar?: number;
+      baz?: string;
+      foo?: string;
+      record?: Record<string, string>;
+    }
+
+    describe('when used with string as value type', () => {
+      it('should only include keys with matching value type', () => {
+        expectTypeOf<
+          keyof FilteredByValueType<TestObject, string>
+        >().toEqualTypeOf<'baz' | 'foo'>();
+      });
+    });
+  });
+
+  describe('having OpenApi3Dot2PathItemObject', () => {
+    describe('when used with OpenApi3Dot2OperationObject as value type', () => {
+      it('should only include HTTP method keys', () => {
+        expectTypeOf<
+          keyof FilteredByValueType<
+            OpenApi3Dot2PathItemObject,
+            OpenApi3Dot2OperationObject
+          >
+        >().toEqualTypeOf<
+          | 'delete'
+          | 'get'
+          | 'head'
+          | 'options'
+          | 'patch'
+          | 'post'
+          | 'put'
+          | 'query'
+          | 'trace'
+        >();
+      });
+
+      it('should not include additionalOperations', () => {
+        expectTypeOf<
+          FilteredByValueType<
+            OpenApi3Dot2PathItemObject,
+            OpenApi3Dot2OperationObject
+          >
+        >().not.toHaveProperty('additionalOperations');
+      });
+    });
+  });
+});

packages/framework/http/libraries/open-api/src/common/models/FilteredByValueType.ts

@@ -1,5 +1,9 @@
 export type FilteredByValueType<TObject, TType> = {
-  [TKey in keyof TObject as TObject[TKey] extends TType | undefined
-    ? TKey
-    : never]: TObject[TKey] extends TType | undefined ? TObject[TKey] : never;
+  [TKey in keyof TObject as NonNullable<TObject[TKey]> extends TType
+    ? string extends keyof NonNullable<TObject[TKey]>
+      ? string extends keyof TType
+        ? TKey
+        : never
+      : TKey
+    : never]: TObject[TKey];
 };