🤖 Merge PR DefinitelyTyped#71752 feat(swagger-react-ui): Support ESM and update package version by @davulrich

Author: davulrich

types/swagger-ui-react/index.d.mts

@@ -0,0 +1,5 @@
+import * as React from "react";
+import { SwaggerUIProps } from "./swagger-ui-react.js";
+
+declare const SwaggerUI: React.FunctionComponent<SwaggerUIProps>;
+export default SwaggerUI;

types/swagger-ui-react/index.d.ts

@@ -1,48 +1,5 @@
 import * as React from "react";
-
-interface Request {
-    [k: string]: any;
-}
-interface Response {
-    [k: string]: any;
-}
-type System = any;
-
-type PluginGenerator = (system: System) => object;
-
-type Plugin = object | PluginGenerator;
-
-type Preset = () => unknown;
-
-export interface SwaggerUIProps {
-    spec?: object | string;
-    url?: string;
-    layout?: string;
-    onComplete?: (system: System) => void;
-    requestInterceptor?: (req: Request) => Request | Promise<Request>;
-    responseInterceptor?: (res: Response) => Response | Promise<Response>;
-    docExpansion?: "list" | "full" | "none";
-    defaultModelExpandDepth?: number;
-    defaultModelsExpandDepth?: number;
-    defaultModelRendering?: "example" | "model";
-    queryConfigEnabled?: boolean;
-    plugins?: Plugin[];
-    supportedSubmitMethods?: Array<"get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace">;
-    deepLinking?: boolean;
-    showMutatedRequest?: boolean;
-    showExtensions?: boolean;
-    showCommonExtensions?: boolean;
-    presets?: Preset[];
-    filter?: string | boolean;
-    requestSnippetsEnabled?: boolean;
-    requestSnippets?: object;
-    displayOperationId?: boolean;
-    tryItOutEnabled?: boolean;
-    displayRequestDuration?: boolean;
-    persistAuthorization?: boolean;
-    withCredentials?: boolean;
-    oauth2RedirectUrl?: string;
-}
+import { SwaggerUIProps } from "./swagger-ui-react";
 
 declare const SwaggerUI: React.FunctionComponent<SwaggerUIProps>;
-export default SwaggerUI;
+export = SwaggerUI;

types/swagger-ui-react/package.json

@@ -1,10 +1,16 @@
 {
     "private": true,
     "name": "@types/swagger-ui-react",
-    "version": "4.19.9999",
+    "version": "5.18.9999",
     "projects": [
         "https://github.com/swagger-api/swagger-ui#readme"
     ],
+    "exports": {
+        ".": {
+            "import": "./index.d.mts",
+            "require": "./index.d.ts"
+        }
+    },
     "dependencies": {
         "@types/react": "*"
     },

types/swagger-ui-react/swagger-ui-react-tests.tsx

@@ -1,4 +1,4 @@
-import * as React from "react";
+import React from "react";
 import SwaggerUI from "swagger-ui-react";
 
 <div>

types/swagger-ui-react/swagger-ui-react.d.ts

@@ -0,0 +1,45 @@
+interface Request {
+    [k: string]: any;
+}
+interface Response {
+    [k: string]: any;
+}
+type System = any;
+
+type PluginGenerator = (system: System) => object;
+
+type Plugin = object | PluginGenerator;
+
+type Preset = () => unknown;
+
+export interface SwaggerUIProps {
+    spec?: object | string;
+    url?: string;
+    layout?: string;
+    onComplete?: (system: System) => void;
+    requestInterceptor?: (req: Request) => Request | Promise<Request>;
+    responseInterceptor?: (res: Response) => Response | Promise<Response>;
+    docExpansion?: "list" | "full" | "none";
+    defaultModelExpandDepth?: number;
+    defaultModelsExpandDepth?: number;
+    defaultModelRendering?: "example" | "model";
+    queryConfigEnabled?: boolean;
+    plugins?: Plugin[];
+    supportedSubmitMethods?: Array<"get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace">;
+    deepLinking?: boolean;
+    showMutatedRequest?: boolean;
+    showExtensions?: boolean;
+    showCommonExtensions?: boolean;
+    presets?: Preset[];
+    filter?: string | boolean;
+    requestSnippetsEnabled?: boolean;
+    requestSnippets?: object;
+    displayOperationId?: boolean;
+    tryItOutEnabled?: boolean;
+    displayRequestDuration?: boolean;
+    persistAuthorization?: boolean;
+    withCredentials?: boolean;
+    oauth2RedirectUrl?: string;
+}
+
+export default SwaggerUIProps;

types/swagger-ui-react/tsconfig.json

@@ -16,6 +16,8 @@
     },
     "files": [
         "index.d.ts",
+        "index.d.mts",
+        "swagger-ui-react.d.ts",
         "swagger-ui-react-tests.tsx"
     ]
 }