@backstage/backend-openapi-utils 0.4.1 → 0.5.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/backend-openapi-utils
 
+## 0.5.0-next.1
+
+### Minor Changes
+
+- 700d32b: **BREAKING**: The `wrapInOpenApiTestServer` and `wrapServer` functions are now exported via `/testUtils` subpath. If you were importing these functions directly from the root of the package, you will need to update your imports to use the `/testUtils` subpath:
+
+  ```diff
+  - import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils';
+  + import { wrapInOpenApiTestServer } from '@backstage/backend-openapi-utils/testUtils';
+  ```
+
+  or
+
+  ```diff
+  - import { wrapServer } from '@backstage/backend-openapi-utils';
+  + import { wrapServer } from '@backstage/backend-openapi-utils/testUtils';
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.2.0-next.0
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+
+## 0.4.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.2.0-next.0
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+
 ## 0.4.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1,14 +1,11 @@
 'use strict';
 
 var index = require('./types/index.cjs.js');
-var testUtils = require('./testUtils.cjs.js');
 var stub = require('./stub.cjs.js');
 
 
 
 exports.internal = index;
-exports.wrapInOpenApiTestServer = testUtils.wrapInOpenApiTestServer;
-exports.wrapServer = testUtils.wrapServer;
 exports.createValidatedOpenApiRouter = stub.createValidatedOpenApiRouter;
 exports.createValidatedOpenApiRouterFromGeneratedEndpointMap = stub.createValidatedOpenApiRouterFromGeneratedEndpointMap;
 exports.getOpenApiSpecRoute = stub.getOpenApiSpecRoute;

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,9 +1,7 @@
-/// <reference types="node" />
 import { JSONSchema, FromSchema } from 'json-schema-to-ts';
 import { ReferenceObject, OpenAPIObject, ContentObject, RequestBodyObject, ResponseObject, ParameterObject, SchemaObject } from 'openapi3-ts';
 import core from 'express-serve-static-core';
-import { Router, Express, RequestHandler } from 'express';
-import { Server } from 'http';
+import { Router, RequestHandler } from 'express';
 import { middleware } from 'express-openapi-validator';
 
 /**
@@ -611,25 +609,6 @@ interface TypedRouter<GeneratedEndpointMap extends EndpointMap> extends Router {
     delete: EndpointMapRequestMatcher<GeneratedEndpointMap, this, '_delete'>;
 }
 
-/**
- * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!
- * Setup a server with a custom OpenAPI proxy. This proxy will capture all requests and responses and make sure they
- *  conform to the spec.
- * @param app - express server, needed to ensure we have the correct ports for the proxy.
- * @returns - a configured HTTP server that should be used with supertest.
- * @public
- */
-declare function wrapServer(app: Express): Promise<Server>;
-/**
- * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!
- * Running against supertest, we need some way to hit the optic proxy. This ensures that
- *  that happens at runtime when in the context of a `yarn optic capture` command.
- * @param app - Express router that would be passed to supertest's `request`.
- * @returns A wrapper around the express router (or the router untouched) that still works with supertest.
- * @public
- */
-declare const wrapInOpenApiTestServer: (app: Express) => Server | Express;
-
 /**
  * Given a base url for a plugin, find the given OpenAPI spec for that plugin.
  * @param baseUrl - Plugin base url.
@@ -660,4 +639,4 @@ declare function createValidatedOpenApiRouterFromGeneratedEndpointMap<T extends
     middleware?: RequestHandler[];
 }): TypedRouter<T>;
 
-export { type ApiRouter, type CookieParameters, type HeaderParameters, type PathParameters, type PathTemplate, type QueryParameters, type Request, type Response, type TypedRouter, createValidatedOpenApiRouter, createValidatedOpenApiRouterFromGeneratedEndpointMap, getOpenApiSpecRoute, index_d as internal, wrapInOpenApiTestServer, wrapServer };
+export { type ApiRouter, type CookieParameters, type HeaderParameters, type PathParameters, type PathTemplate, type QueryParameters, type Request, type Response, type TypedRouter, createValidatedOpenApiRouter, createValidatedOpenApiRouterFromGeneratedEndpointMap, getOpenApiSpecRoute, index_d as internal };

package/dist/testUtils.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import { Express } from 'express';
+import { Server } from 'http';
+
+/**
+ * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!
+ * Setup a server with a custom OpenAPI proxy. This proxy will capture all requests and responses and make sure they
+ *  conform to the spec.
+ * @param app - express server, needed to ensure we have the correct ports for the proxy.
+ * @returns - a configured HTTP server that should be used with supertest.
+ * @public
+ */
+declare function wrapServer(app: Express): Promise<Server>;
+/**
+ * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!
+ * Running against supertest, we need some way to hit the optic proxy. This ensures that
+ *  that happens at runtime when in the context of a `yarn optic capture` command.
+ * @param app - Express router that would be passed to supertest's `request`.
+ * @returns A wrapper around the express router (or the router untouched) that still works with supertest.
+ * @public
+ */
+declare const wrapInOpenApiTestServer: (app: Express) => Server | Express;
+
+export { wrapInOpenApiTestServer, wrapServer };

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "@backstage/backend-openapi-utils",
-  "version": "0.4.1",
+  "version": "0.5.0-next.1",
   "description": "OpenAPI typescript support.",
   "backstage": {
     "role": "node-library"
   },
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "module": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
   },
   "homepage": "https://backstage.io",
   "repository": {
@@ -18,8 +15,31 @@
     "directory": "packages/backend-openapi-utils"
   },
   "license": "Apache-2.0",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./testUtils": {
+      "require": "./dist/testUtils.cjs.js",
+      "types": "./dist/testUtils.d.ts",
+      "default": "./dist/testUtils.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ],
+      "testUtils": [
+        "dist/testUtils.d.ts"
+      ]
+    }
+  },
   "files": [
     "dist"
   ],
@@ -34,9 +54,9 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@backstage/backend-plugin-api": "^1.1.1",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/types": "^1.2.1",
+    "@backstage/backend-plugin-api": "1.2.0-next.0",
+    "@backstage/errors": "1.2.7",
+    "@backstage/types": "1.2.1",
     "@types/express": "^4.17.6",
     "@types/express-serve-static-core": "^4.17.5",
     "ajv": "^8.16.0",
@@ -51,17 +71,9 @@
     "openapi3-ts": "^3.1.2"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.29.5",
-    "@backstage/test-utils": "^1.7.4",
+    "@backstage/cli": "0.30.0-next.1",
+    "@backstage/test-utils": "1.7.5-next.0",
     "msw": "^1.0.0",
     "supertest": "^7.0.0"
-  },
-  "typesVersions": {
-    "*": {
-      "index": [
-        "dist/index.d.ts"
-      ]
-    }
-  },
-  "module": "dist/index.esm.js"
+  }
 }