ci: move public-api goldens to goldens directory (angular#35768)

Moves the public api .d.ts files from tools/public_api_guard to
goldens/public-api.

Additionally, provides a README in the goldens directory and a script
assist in testing the current state of the repo against the goldens as
well as a command for accepting all changes to the goldens in a single
command.

PR Close angular#35768

.pullapprove.yml

@@ -939,6 +939,7 @@ groups:
           'docs/SAVED_REPLIES.md',
           'docs/TOOLS.md',
           'docs/TRIAGE_AND_LABELS.md',
+          'goldens/*',
           'modules/e2e_util/e2e_util.ts',
           'modules/e2e_util/perf_util.ts',
           'modules/*',
@@ -958,8 +959,6 @@ groups:
           'tools/ngcontainer/**',
           'tools/npm/**',
           'tools/npm_integration_test/**',
-          'tools/public_api_guard/BUILD.bazel',
-          'tools/public_api_guard/public_api_guard.bzl',
           'tools/pullapprove/**',
           'tools/rxjs/**',
           'tools/saucelabs/**',
@@ -994,7 +993,7 @@ groups:
     conditions:
       - >
         contains_any_globs(files, [
-          'tools/public_api_guard/**',
+          'goldens/public-api/**',
           'docs/NAMING.md',
           'aio/content/guide/glossary.md',
           'aio/content/guide/styleguide.md',

goldens/BUILD.bazel

@@ -0,0 +1,8 @@
+package(default_visibility = ["//visibility:public"])
+
+filegroup(
+    name = "public-api",
+    srcs = glob([
+        "public-api/**/*.d.ts",
+    ]),
+)

goldens/README.md

@@ -0,0 +1,11 @@
+### *`public-api/`*
+
+This directory contains all of the public api goldens for our npm packages we publish
+to NPM.  These are tested on all PRs and commits as part of the our bazel tests.
+
+To check or update the public api goldens, run one of the following commands:
+
+```bash
+yarn public-api:check
+yarn public-api:update
+```

tools/public_api_guard/animations/animations.d.ts → goldens/public-api/animations/animations.d.ts

@@ -14,16 +14,16 @@ export declare type AnimateTimings = {
 
 export declare function animation(steps: AnimationMetadata | AnimationMetadata[], options?: AnimationOptions | null): AnimationReferenceMetadata;
 
-export interface AnimationAnimateChildMetadata extends AnimationMetadata {
+export declare interface AnimationAnimateChildMetadata extends AnimationMetadata {
     options: AnimationOptions | null;
 }
 
-export interface AnimationAnimateMetadata extends AnimationMetadata {
+export declare interface AnimationAnimateMetadata extends AnimationMetadata {
     styles: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null;
     timings: string | number | AnimateTimings;
 }
 
-export interface AnimationAnimateRefMetadata extends AnimationMetadata {
+export declare interface AnimationAnimateRefMetadata extends AnimationMetadata {
     animation: AnimationReferenceMetadata;
     options: AnimationOptions | null;
 }
@@ -32,7 +32,7 @@ export declare abstract class AnimationBuilder {
     abstract build(animation: AnimationMetadata | AnimationMetadata[]): AnimationFactory;
 }
 
-export interface AnimationEvent {
+export declare interface AnimationEvent {
     disabled: boolean;
     element: any;
     fromState: string;
@@ -46,16 +46,16 @@ export declare abstract class AnimationFactory {
     abstract create(element: any, options?: AnimationOptions): AnimationPlayer;
 }
 
-export interface AnimationGroupMetadata extends AnimationMetadata {
+export declare interface AnimationGroupMetadata extends AnimationMetadata {
     options: AnimationOptions | null;
     steps: AnimationMetadata[];
 }
 
-export interface AnimationKeyframesSequenceMetadata extends AnimationMetadata {
+export declare interface AnimationKeyframesSequenceMetadata extends AnimationMetadata {
     steps: AnimationStyleMetadata[];
 }
 
-export interface AnimationMetadata {
+export declare interface AnimationMetadata {
     type: AnimationMetadataType;
 }
 
@@ -82,7 +82,7 @@ export declare interface AnimationOptions {
     };
 }
 
-export interface AnimationPlayer {
+export declare interface AnimationPlayer {
     beforeDestroy?: () => any;
     parentPlayer: AnimationPlayer | null;
     readonly totalTime: number;
@@ -101,7 +101,7 @@ export interface AnimationPlayer {
     setPosition(position: any /** TODO #9100 */): void;
 }
 
-export interface AnimationQueryMetadata extends AnimationMetadata {
+export declare interface AnimationQueryMetadata extends AnimationMetadata {
     animation: AnimationMetadata | AnimationMetadata[];
     options: AnimationQueryOptions | null;
     selector: string;
@@ -112,22 +112,22 @@ export declare interface AnimationQueryOptions extends AnimationOptions {
     optional?: boolean;
 }
 
-export interface AnimationReferenceMetadata extends AnimationMetadata {
+export declare interface AnimationReferenceMetadata extends AnimationMetadata {
     animation: AnimationMetadata | AnimationMetadata[];
     options: AnimationOptions | null;
 }
 
-export interface AnimationSequenceMetadata extends AnimationMetadata {
+export declare interface AnimationSequenceMetadata extends AnimationMetadata {
     options: AnimationOptions | null;
     steps: AnimationMetadata[];
 }
 
-export interface AnimationStaggerMetadata extends AnimationMetadata {
+export declare interface AnimationStaggerMetadata extends AnimationMetadata {
     animation: AnimationMetadata | AnimationMetadata[];
     timings: string | number;
 }
 
-export interface AnimationStateMetadata extends AnimationMetadata {
+export declare interface AnimationStateMetadata extends AnimationMetadata {
     name: string;
     options?: {
         params: {
@@ -137,7 +137,7 @@ export interface AnimationStateMetadata extends AnimationMetadata {
     styles: AnimationStyleMetadata;
 }
 
-export interface AnimationStyleMetadata extends AnimationMetadata {
+export declare interface AnimationStyleMetadata extends AnimationMetadata {
     offset: number | null;
     styles: '*' | {
         [key: string]: string | number;
@@ -146,15 +146,15 @@ export interface AnimationStyleMetadata extends AnimationMetadata {
     } | '*'>;
 }
 
-export interface AnimationTransitionMetadata extends AnimationMetadata {
+export declare interface AnimationTransitionMetadata extends AnimationMetadata {
     animation: AnimationMetadata | AnimationMetadata[];
     expr: string | ((fromState: string, toState: string, element?: any, params?: {
         [key: string]: any;
     }) => boolean);
     options: AnimationOptions | null;
 }
 
-export interface AnimationTriggerMetadata extends AnimationMetadata {
+export declare interface AnimationTriggerMetadata extends AnimationMetadata {
     definitions: AnimationMetadata[];
     name: string;
     options: {

tools/public_api_guard/common/common.d.ts → goldens/public-api/common/common.d.ts

@@ -128,7 +128,7 @@ export declare class JsonPipe implements PipeTransform {
     transform(value: any): string;
 }
 
-export interface KeyValue<K, V> {
+export declare interface KeyValue<K, V> {
     key: K;
     value: V;
 }
@@ -165,12 +165,12 @@ export declare class Location {
 
 export declare const LOCATION_INITIALIZED: InjectionToken<Promise<any>>;
 
-export interface LocationChangeEvent {
+export declare interface LocationChangeEvent {
     state: any;
     type: string;
 }
 
-export interface LocationChangeListener {
+export declare interface LocationChangeListener {
     (event: LocationChangeEvent): any;
 }
 
@@ -362,7 +362,7 @@ export declare enum Plural {
     Other = 5
 }
 
-export interface PopStateEvent {
+export declare interface PopStateEvent {
     pop?: boolean;
     state?: any;
     type?: string;

tools/public_api_guard/common/http.d.ts → goldens/public-api/common/http/http.d.ts

@@ -1489,7 +1489,7 @@ export declare class HttpClientXsrfModule {
     }): ModuleWithProviders<HttpClientXsrfModule>;
 }
 
-export interface HttpDownloadProgressEvent extends HttpProgressEvent {
+export declare interface HttpDownloadProgressEvent extends HttpProgressEvent {
     partialText?: string;
     type: HttpEventType.DownloadProgress;
 }
@@ -1552,11 +1552,11 @@ export declare class HttpHeaders {
     set(name: string, value: string | string[]): HttpHeaders;
 }
 
-export interface HttpInterceptor {
+export declare interface HttpInterceptor {
     intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
 }
 
-export interface HttpParameterCodec {
+export declare interface HttpParameterCodec {
     decodeKey(key: string): string;
     decodeValue(value: string): string;
     encodeKey(key: string): string;
@@ -1575,7 +1575,7 @@ export declare class HttpParams {
     toString(): string;
 }
 
-export interface HttpProgressEvent {
+export declare interface HttpProgressEvent {
     loaded: number;
     total?: number;
     type: HttpEventType.DownloadProgress | HttpEventType.UploadProgress;
@@ -1690,11 +1690,11 @@ export declare abstract class HttpResponseBase {
     }, defaultStatus?: number, defaultStatusText?: string);
 }
 
-export interface HttpSentEvent {
+export declare interface HttpSentEvent {
     type: HttpEventType.Sent;
 }
 
-export interface HttpUploadProgressEvent extends HttpProgressEvent {
+export declare interface HttpUploadProgressEvent extends HttpProgressEvent {
     type: HttpEventType.UploadProgress;
 }
 
@@ -1705,7 +1705,7 @@ export declare class HttpUrlEncodingCodec implements HttpParameterCodec {
     encodeValue(value: string): string;
 }
 
-export interface HttpUserEvent<T> {
+export declare interface HttpUserEvent<T> {
     type: HttpEventType.User;
 }
 
@@ -1719,7 +1719,7 @@ export declare abstract class HttpXsrfTokenExtractor {
 }
 
 export declare class JsonpClientBackend implements HttpBackend {
-    constructor(callbackMap: JsonpCallbackContext, document: any);
+    constructor(callbackMap: ɵangular_packages_common_http_http_b, document: any);
     handle(req: HttpRequest<never>): Observable<HttpEvent<any>>;
 }
 

tools/public_api_guard/common/http/testing.d.ts → goldens/public-api/common/http/testing/testing.d.ts

@@ -16,7 +16,7 @@ export declare abstract class HttpTestingController {
     }): void;
 }
 
-export interface RequestMatch {
+export declare interface RequestMatch {
     method?: string;
     url?: string;
 }

tools/public_api_guard/common/testing.d.ts → goldens/public-api/common/testing/testing.d.ts

@@ -39,7 +39,7 @@ export declare class MockPlatformLocation implements PlatformLocation {
     replaceState(state: any, title: string, newUrl: string): void;
 }
 
-export interface MockPlatformLocationConfig {
+export declare interface MockPlatformLocationConfig {
     appBaseHref?: string;
     startUrl?: string;
 }

tools/public_api_guard/common/upgrade.d.ts → goldens/public-api/common/upgrade/upgrade.d.ts

@@ -64,7 +64,7 @@ export declare class AngularJSUrlCodec implements UrlCodec {
 
 export declare const LOCATION_UPGRADE_CONFIGURATION: InjectionToken<LocationUpgradeConfig>;
 
-export interface LocationUpgradeConfig {
+export declare interface LocationUpgradeConfig {
     appBaseHref?: string;
     hashPrefix?: string;
     serverBaseHref?: string;