🤖 Merge PR DefinitelyTyped#72526 feat(swagger-ui): type support for internal presets and subpath mods by @tasshi-me

Author: tasshi-me

types/swagger-ui/dist/oauth2-redirect.html.d.ts

@@ -0,0 +1,3 @@
+declare var html: any;
+
+export = html;

types/swagger-ui/dist/swagger-ui-standalone-preset.d.ts

@@ -0,0 +1,5 @@
+import { SwaggerUIPreset } from "../index";
+
+declare var StandalonePreset: SwaggerUIPreset;
+
+export = StandalonePreset;

types/swagger-ui/dist/swagger-ui.css.d.ts

@@ -0,0 +1,3 @@
+declare var css: any;
+
+export = css;

types/swagger-ui/index.d.ts

@@ -57,7 +57,7 @@ declare namespace SwaggerUI {
          * An array of presets to use in Swagger UI.
          * Usually, you'll want to include ApisPreset if you use this option.
          */
-        presets?: SwaggerUIPlugin[] | undefined;
+        presets?: SwaggerUIPlugin[] | SwaggerUIPreset[] | undefined;
 
         // Display
 
@@ -303,9 +303,24 @@ declare namespace SwaggerUI {
         };
     }
 
+    /**
+     * Presets are arrays of plugins
+     * See https://swagger.io/docs/open-source-tools/swagger-ui/customization/overview/#presets
+     */
+    type SwaggerUIPreset = SwaggerUIPlugin[];
+
     interface Indexable {
         [index: string]: any;
     }
+
+    /**
+     * Internal presets
+     * See https://swagger.io/docs/open-source-tools/swagger-ui/customization/overview/#presets
+     */
+    var presets: {
+        base: SwaggerUIPreset;
+        apis: SwaggerUIPreset;
+    };
 }
 
 interface SwaggerUI {

types/swagger-ui/package.json

@@ -1,10 +1,24 @@
 {
     "private": true,
     "name": "@types/swagger-ui",
-    "version": "3.52.9999",
+    "version": "5.21.9999",
     "projects": [
         "https://github.com/swagger-api/swagger-ui"
     ],
+    "exports": {
+        ".": {
+            "types": "./index.d.ts"
+        },
+        "./dist/oauth2-redirect.html": {
+            "types": "./dist/oauth2-redirect.html.d.ts"
+        },
+        "./dist/swagger-ui.css": {
+            "types": "./dist/swagger-ui.css.d.ts"
+        },
+        "./dist/swagger-ui-standalone-preset": {
+            "types": "./dist/swagger-ui-standalone-preset.d.ts"
+        }
+    },
     "devDependencies": {
         "@types/swagger-ui": "workspace:."
     },

types/swagger-ui/swagger-ui-tests.ts

@@ -84,6 +84,23 @@ const swaggerUI = SwaggerUI({
     syntaxHighlight: false,
 });
 
+// $ExpectType SwaggerUIPreset
+const _basePreset = SwaggerUI.presets.base;
+// $ExpectType SwaggerUIPreset
+const _apisPreset = SwaggerUI.presets.apis;
+
 swaggerUI.initOAuth({});
 swaggerUI.preauthorizeApiKey("abc", "dec");
 swaggerUI.preauthorizeBasic("key", "user", "password");
+
+import SwaggerUIStandalonePreset from "swagger-ui/dist/swagger-ui-standalone-preset";
+// $ExpectType SwaggerUIPreset
+const _standAlonePreset = SwaggerUIStandalonePreset;
+
+import SwaggerUICSS from "swagger-ui/dist/swagger-ui.css";
+// $ExpectType any
+const _css = SwaggerUICSS;
+
+import OAuth2RedirectHTML from "swagger-ui/dist/oauth2-redirect.html";
+// $ExpectType any
+const _html = OAuth2RedirectHTML;