From da75250a5a9379ba077f4bd569c6adcc56bffba5 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Thu, 31 Oct 2024 09:22:08 +0000 Subject: [PATCH] refactor(@angular/ssr): add route configs to public API These interfaces needs to be exported to be included in adev. --- goldens/public-api/angular/ssr/index.api.md | 34 +++++++++++++++ .../angular/ssr/index_transitive.api.md | 43 ------------------- packages/angular/ssr/BUILD.bazel | 12 +----- packages/angular/ssr/public_api.ts | 6 +++ packages/angular/ssr/public_api_transitive.ts | 20 --------- 5 files changed, 41 insertions(+), 74 deletions(-) delete mode 100644 goldens/public-api/angular/ssr/index_transitive.api.md delete mode 100644 packages/angular/ssr/public_api_transitive.ts diff --git a/goldens/public-api/angular/ssr/index.api.md b/goldens/public-api/angular/ssr/index.api.md index 840e3c987b3f..d62bf7cf2d1c 100644 --- a/goldens/public-api/angular/ssr/index.api.md +++ b/goldens/public-api/angular/ssr/index.api.md @@ -37,6 +37,40 @@ export enum RenderMode { // @public export type ServerRoute = ServerRouteAppShell | ServerRouteClient | ServerRoutePrerender | ServerRoutePrerenderWithParams | ServerRouteServer; +// @public +export interface ServerRouteAppShell extends Omit { + renderMode: RenderMode.AppShell; +} + +// @public +export interface ServerRouteClient extends ServerRouteCommon { + renderMode: RenderMode.Client; +} + +// @public +export interface ServerRouteCommon { + headers?: Record; + path: string; + status?: number; +} + +// @public +export interface ServerRoutePrerender extends Omit { + fallback?: never; + renderMode: RenderMode.Prerender; +} + +// @public +export interface ServerRoutePrerenderWithParams extends Omit { + fallback?: PrerenderFallback; + getPrerenderParams: () => Promise[]>; +} + +// @public +export interface ServerRouteServer extends ServerRouteCommon { + renderMode: RenderMode.Server; +} + // (No @packageDocumentation comment for this package) ``` diff --git a/goldens/public-api/angular/ssr/index_transitive.api.md b/goldens/public-api/angular/ssr/index_transitive.api.md deleted file mode 100644 index f51756a2d9cb..000000000000 --- a/goldens/public-api/angular/ssr/index_transitive.api.md +++ /dev/null @@ -1,43 +0,0 @@ -## API Report File for "@angular/devkit-repo" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -// @public -export interface ServerRouteAppShell extends Omit { - renderMode: RenderMode.AppShell; -} - -// @public -export interface ServerRouteClient extends ServerRouteCommon { - renderMode: RenderMode.Client; -} - -// @public -export interface ServerRouteCommon { - headers?: Record; - path: string; - status?: number; -} - -// @public -export interface ServerRoutePrerender extends Omit { - fallback?: never; - renderMode: RenderMode.Prerender; -} - -// @public -export interface ServerRoutePrerenderWithParams extends Omit { - fallback?: PrerenderFallback; - getPrerenderParams: () => Promise[]>; -} - -// @public -export interface ServerRouteServer extends ServerRouteCommon { - renderMode: RenderMode.Server; -} - -// (No @packageDocumentation comment for this package) - -``` diff --git a/packages/angular/ssr/BUILD.bazel b/packages/angular/ssr/BUILD.bazel index e2d4ba7bd238..872962542c1d 100644 --- a/packages/angular/ssr/BUILD.bazel +++ b/packages/angular/ssr/BUILD.bazel @@ -1,4 +1,4 @@ -load("@npm//@angular/build-tooling/bazel/api-golden:index.bzl", "api_golden_test", "api_golden_test_npm_package") +load("@npm//@angular/build-tooling/bazel/api-golden:index.bzl", "api_golden_test_npm_package") load("@rules_pkg//:pkg.bzl", "pkg_tar") load("//tools:defaults.bzl", "ng_package", "ts_library") @@ -71,13 +71,3 @@ api_golden_test_npm_package( golden_dir = "angular_cli/goldens/public-api/angular/ssr", npm_package = "angular_cli/packages/angular/ssr/npm_package", ) - -api_golden_test( - name = "ssr_transitive_api", - data = [ - ":ssr", - "//goldens:public-api", - ], - entry_point = "angular_cli/packages/angular/ssr/public_api_transitive.d.ts", - golden = "angular_cli/goldens/public-api/angular/ssr/index_transitive.api.md", -) diff --git a/packages/angular/ssr/public_api.ts b/packages/angular/ssr/public_api.ts index 256a0169c89b..bf751f07a374 100644 --- a/packages/angular/ssr/public_api.ts +++ b/packages/angular/ssr/public_api.ts @@ -16,4 +16,10 @@ export { type ServerRoute, provideServerRoutesConfig, RenderMode, + type ServerRouteAppShell, + type ServerRouteClient, + type ServerRoutePrerender, + type ServerRoutePrerenderWithParams, + type ServerRouteServer, + type ServerRouteCommon, } from './src/routes/route-config'; diff --git a/packages/angular/ssr/public_api_transitive.ts b/packages/angular/ssr/public_api_transitive.ts deleted file mode 100644 index 0acba4c214c4..000000000000 --- a/packages/angular/ssr/public_api_transitive.ts +++ /dev/null @@ -1,20 +0,0 @@ -/** - * @license - * Copyright Google LLC All Rights Reserved. - * - * Use of this source code is governed by an MIT-style license that can be - * found in the LICENSE file at https://angular.dev/license - */ - -// This file exports symbols that are not part of the public API but are -// dependencies of public API symbols. Including them here ensures they -// are tracked in the API golden file, preventing accidental breaking changes. - -export type { - ServerRouteAppShell, - ServerRouteClient, - ServerRoutePrerender, - ServerRoutePrerenderWithParams, - ServerRouteServer, - ServerRouteCommon, -} from './src/routes/route-config';