Merge pull request #27965 from kevspl/fixtypedrouter

fix: typed router export

.changeset/rich-suns-drive.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-openapi-utils': minor
+---
+
+Fixed a Typescript error when trying to use the new OpenAPI server-side generated code.

packages/backend-openapi-utils/report.api.md

@@ -530,7 +530,6 @@ declare namespace internal {
     DocEndpointTemplate,
     TemplateToDocEndpoint,
     EndpointMapRequestMatcher,
-    TypedRouter,
   };
 }
 export { internal };
@@ -902,7 +901,8 @@ type TuplifyUnion<
 > = true extends N ? [] : Push<TuplifyUnion<Exclude<T, L>>, L>;
 
 // @public (undocumented)
-interface TypedRouter<GeneratedEndpointMap extends EndpointMap> extends Router {
+export interface TypedRouter<GeneratedEndpointMap extends EndpointMap>
+  extends Router {
   // (undocumented)
   delete: EndpointMapRequestMatcher<GeneratedEndpointMap, this, '_delete'>;
   // (undocumented)

packages/backend-openapi-utils/src/index.ts

@@ -30,7 +30,7 @@ export type {
   CookieParameters,
   PathParameters,
 } from './utility';
-export type { ApiRouter } from './router';
+export type { ApiRouter, TypedRouter } from './router';
 export type { PathTemplate } from './types/common';
 export { wrapInOpenApiTestServer, wrapServer } from './testUtils';
 export {

packages/backend-openapi-utils/src/router.ts

@@ -14,7 +14,12 @@
  * limitations under the License.
  */
 import { Router } from 'express';
-import { DocRequestMatcher, RequiredDoc } from './types';
+import {
+  DocRequestMatcher,
+  EndpointMap,
+  EndpointMapRequestMatcher,
+  RequiredDoc,
+} from './types';
 
 /**
  * Typed Express router based on an OpenAPI 3.1 spec.
@@ -37,3 +42,14 @@ export interface ApiRouter<Doc extends RequiredDoc> extends Router {
 
   head: DocRequestMatcher<Doc, this, 'head'>;
 }
+
+/**
+ * @public
+ */
+export interface TypedRouter<GeneratedEndpointMap extends EndpointMap>
+  extends Router {
+  get: EndpointMapRequestMatcher<GeneratedEndpointMap, this, 'get'>;
+  post: EndpointMapRequestMatcher<GeneratedEndpointMap, this, 'post'>;
+  put: EndpointMapRequestMatcher<GeneratedEndpointMap, this, 'put'>;
+  delete: EndpointMapRequestMatcher<GeneratedEndpointMap, this, '_delete'>;
+}

packages/backend-openapi-utils/src/stub.ts

@@ -15,8 +15,8 @@
  */
 
 import PromiseRouter from 'express-promise-router';
-import { ApiRouter } from './router';
-import { EndpointMap, RequiredDoc, TypedRouter } from './types';
+import { ApiRouter, TypedRouter } from './router';
+import { EndpointMap, RequiredDoc } from './types';
 import {
   ErrorRequestHandler,
   RequestHandler,

packages/backend-openapi-utils/src/types/generated.ts

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Router } from 'express';
 import type core from 'express-serve-static-core';
 import { PathTemplate, ValueOf } from './common';
 
@@ -209,14 +208,3 @@ export interface EndpointMapRequestMatcher<
     >
   ): T;
 }
-
-/**
- * @public
- */
-export interface TypedRouter<GeneratedEndpointMap extends EndpointMap>
-  extends Router {
-  get: EndpointMapRequestMatcher<GeneratedEndpointMap, this, 'get'>;
-  post: EndpointMapRequestMatcher<GeneratedEndpointMap, this, 'post'>;
-  put: EndpointMapRequestMatcher<GeneratedEndpointMap, this, 'put'>;
-  delete: EndpointMapRequestMatcher<GeneratedEndpointMap, this, '_delete'>;
-}