diff --git a/etc/firebase-admin.remote-config.api.md b/etc/firebase-admin.remote-config.api.md index dc48662e8c..fcd99cb8ed 100644 --- a/etc/firebase-admin.remote-config.api.md +++ b/etc/firebase-admin.remote-config.api.md @@ -81,7 +81,7 @@ export interface ExplicitParameterValue { value: string; } -// @public +// @public @deprecated export interface FetchResponseData { config?: { [key: string]: string; @@ -236,10 +236,11 @@ export const RemoteConfigErrorCode: { // @public export type RemoteConfigErrorCode = typeof RemoteConfigErrorCode[keyof typeof RemoteConfigErrorCode]; -// @public +// @public @deprecated export class RemoteConfigFetchResponse { + // @deprecated constructor(app: App, serverConfig: ServerConfig, requestEtag?: string); - // (undocumented) + // @deprecated toJSON(): FetchResponseData; } diff --git a/src/remote-config/remote-config-api.ts b/src/remote-config/remote-config-api.ts index 0f2648d797..588bad7523 100644 --- a/src/remote-config/remote-config-api.ts +++ b/src/remote-config/remote-config-api.ts @@ -879,6 +879,10 @@ export interface ServerConfig { /** * JSON-serializable representation of evaluated config values. This can be consumed by * Remote Config web client SDKs. + * + * @deprecated Remote Config server-side rendering (SSR) hydration of the + * client SDK is no longer supported. This type will be removed in the + * next major release. */ export interface FetchResponseData { /** diff --git a/src/remote-config/remote-config.ts b/src/remote-config/remote-config.ts index 7e74fc9381..a78ae5956f 100644 --- a/src/remote-config/remote-config.ts +++ b/src/remote-config/remote-config.ts @@ -706,6 +706,10 @@ const HTTP_OK = 200; /** * Represents a fetch response that can be used to interact with RC's client SDK. + * + * @deprecated Remote Config server-side rendering (SSR) hydration of the + * client SDK is no longer supported. This class will be removed in the + * next major release. */ export class RemoteConfigFetchResponse { private response: FetchResponseData; @@ -714,6 +718,10 @@ export class RemoteConfigFetchResponse { * @param app - The app for this RemoteConfig service. * @param serverConfig - The server config for which to generate a fetch response. * @param requestEtag - A request eTag with which to compare the current response. + * + * @deprecated Remote Config server-side rendering (SSR) hydration of the + * client SDK is no longer supported. This class will be removed in the + * next major release. */ constructor(app: App, serverConfig: ServerConfig, requestEtag?: string) { const config: { [key: string]: string } = {}; @@ -737,9 +745,13 @@ export class RemoteConfigFetchResponse { } } - /** - * @returns JSON representation of the fetch response that can be consumed - * by the RC client SDK. + /** + * Returns the JSON representation of this fetch response, which can be + * consumed by the RC client SDK. + * + * @deprecated Remote Config server-side rendering (SSR) hydration of the + * client SDK is no longer supported. This method will be removed in the + * next major release. */ public toJSON(): FetchResponseData { return this.response;