backend-{plugin,app}-api: added addAuthPolicy to HttpRouterService + implementation

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Carl-Erik Bergström <cbergstrom@spotify.com>
Co-authored-by: blam <ben@blam.sh>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/backend-plugin-api/api-report.md

@@ -299,10 +299,20 @@ export interface HttpAuthService {
 
 // @public (undocumented)
 export interface HttpRouterService {
+  // (undocumented)
+  addAuthPolicy(policy: HttpRouterServiceAuthPolicy): void;
   // (undocumented)
   use(handler: Handler): void;
 }
 
+// @public (undocumented)
+export interface HttpRouterServiceAuthPolicy {
+  // (undocumented)
+  allow: 'unauthenticated' | 'user-cookie';
+  // (undocumented)
+  path: string;
+}
+
 // @public (undocumented)
 export interface IdentityService extends IdentityApi {}
 

packages/backend-plugin-api/src/services/definitions/HttpRouterService.ts

@@ -16,9 +16,17 @@
 
 import { Handler } from 'express';
 
+/** @public */
+export interface HttpRouterServiceAuthPolicy {
+  path: string;
+  allow: 'unauthenticated' | 'user-cookie';
+}
+
 /**
  * @public
  */
 export interface HttpRouterService {
   use(handler: Handler): void;
+
+  addAuthPolicy(policy: HttpRouterServiceAuthPolicy): void;
 }

packages/backend-plugin-api/src/services/definitions/index.ts

@@ -29,7 +29,10 @@ export type {
 export type { RootConfigService } from './RootConfigService';
 export type { DatabaseService } from './DatabaseService';
 export type { DiscoveryService } from './DiscoveryService';
-export type { HttpRouterService } from './HttpRouterService';
+export type {
+  HttpRouterService,
+  HttpRouterServiceAuthPolicy,
+} from './HttpRouterService';
 export type {
   HttpAuthService,
   BackstageCredentialTypes,