move FetchResponse types to public_types

Author: kjelko

packages/remote-config/src/client/caching_client.ts

@@ -16,8 +16,8 @@
  */
 
 import { StorageCache } from '../storage/storage_cache';
+import { FetchResponse } from '../public_types';
 import {
-  FetchResponse,
   RemoteConfigFetchClient,
   FetchRequest
 } from './remote_config_fetch_client';
@@ -37,7 +37,7 @@ export class CachingClient implements RemoteConfigFetchClient {
     private readonly storage: Storage,
     private readonly storageCache: StorageCache,
     private readonly logger: Logger
-  ) {}
+  ) { }
 
   /**
    * Returns true if the age of the cached fetched configs is less than or equal to
@@ -65,9 +65,9 @@ export class CachingClient implements RemoteConfigFetchClient {
 
     this.logger.debug(
       'Config fetch cache check.' +
-        ` Cache age millis: ${cacheAgeMillis}.` +
-        ` Cache max age millis (minimumFetchIntervalMillis setting): ${cacheMaxAgeMillis}.` +
-        ` Is cache hit: ${isCachedDataFresh}.`
+      ` Cache age millis: ${cacheAgeMillis}.` +
+      ` Cache max age millis (minimumFetchIntervalMillis setting): ${cacheMaxAgeMillis}.` +
+      ` Is cache hit: ${isCachedDataFresh}.`
     );
 
     return isCachedDataFresh;

packages/remote-config/src/client/remote_config_fetch_client.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { CustomSignals } from '../public_types';
+import { CustomSignals, FetchResponse } from '../public_types';
 
 /**
  * Defines a client, as in https://en.wikipedia.org/wiki/Client%E2%80%93server_model, for the
@@ -36,13 +36,6 @@ export interface RemoteConfigFetchClient {
   fetch(request: FetchRequest): Promise<FetchResponse>;
 }
 
-/**
- * Defines a self-descriptive reference for config key-value pairs.
- */
-export interface FirebaseRemoteConfigObject {
-  [key: string]: string;
-}
-
 /**
  * Shims a minimal AbortSignal.
  *
@@ -109,39 +102,3 @@ export interface FetchRequest {
   customSignals?: CustomSignals;
 }
 
-/**
- * Defines a successful response (200 or 304).
- *
- * <p>Modeled after the native {@link Response} interface, but simplified for Remote Config's
- * use case.
- */
-export interface FetchResponse {
-  /**
-   * The HTTP status, which is useful for differentiating success responses with data from
-   * those without.
-   *
-   * <p>{@link RemoteConfigClient} is modeled after the native {@link GlobalFetch} interface, so
-   * HTTP status is first-class.
-   *
-   * <p>Disambiguation: the fetch response returns a legacy "state" value that is redundant with the
-   * HTTP status code. The former is normalized into the latter.
-   */
-  status: number;
-
-  /**
-   * Defines the ETag response header value.
-   *
-   * <p>Only defined for 200 and 304 responses.
-   */
-  eTag?: string;
-
-  /**
-   * Defines the map of parameters returned as "entries" in the fetch response body.
-   *
-   * <p>Only defined for 200 responses.
-   */
-  config?: FirebaseRemoteConfigObject;
-
-  // Note: we're not extracting experiment metadata until
-  // ABT and Analytics have Web SDKs.
-}

packages/remote-config/src/client/rest_client.ts

@@ -15,11 +15,9 @@
  * limitations under the License.
  */
 
-import { CustomSignals } from '../public_types';
+import { CustomSignals, FetchResponse, FirebaseRemoteConfigObject } from '../public_types';
 import {
-  FetchResponse,
   RemoteConfigFetchClient,
-  FirebaseRemoteConfigObject,
   FetchRequest
 } from './remote_config_fetch_client';
 import { ERROR_FACTORY, ErrorCode } from '../errors';
@@ -57,7 +55,7 @@ export class RestClient implements RemoteConfigFetchClient {
     private readonly projectId: string,
     private readonly apiKey: string,
     private readonly appId: string
-  ) {}
+  ) { }
 
   /**
    * Fetches from the Remote Config REST API.

packages/remote-config/src/client/retrying_client.ts

@@ -15,10 +15,10 @@
  * limitations under the License.
  */
 
+import { FetchResponse } from '../public_types';
 import {
   RemoteConfigAbortSignal,
   RemoteConfigFetchClient,
-  FetchResponse,
   FetchRequest
 } from './remote_config_fetch_client';
 import { ThrottleMetadata, Storage } from '../storage/storage';
@@ -91,7 +91,7 @@ export class RetryingClient implements RemoteConfigFetchClient {
   constructor(
     private readonly client: RemoteConfigFetchClient,
     private readonly storage: Storage
-  ) {}
+  ) { }
 
   async fetch(request: FetchRequest): Promise<FetchResponse> {
     const throttleMetadata = (await this.storage.getThrottleMetadata()) || {

packages/remote-config/src/public_types.ts

@@ -16,29 +16,6 @@
  */
 
 import { FirebaseApp } from '@firebase/app';
-import { FetchResponse } from './client/remote_config_fetch_client';
-
-export {
-  FetchResponse,
-  FirebaseRemoteConfigObject
-} from './client/remote_config_fetch_client';
-
-/**
- * Options for Remote Config initialization.
- *
- * @public
- */
-export interface RemoteConfigOptions {
-  /**
-   * The ID of the template to use. If not provided, defaults to "firebase".
-   */
-  templateId?: string;
-
-  /**
-   * Hydrates the state with an initial fetch response.
-   */
-  initialFetchResponse?: FetchResponse;
-}
 
 /**
  * The Firebase Remote Config service interface.
@@ -73,6 +50,67 @@ export interface RemoteConfig {
   lastFetchStatus: FetchStatus;
 }
 
+/**
+ * Defines a self-descriptive reference for config key-value pairs.
+ */
+export interface FirebaseRemoteConfigObject {
+  [key: string]: string;
+}
+
+/**
+ * Defines a successful response (200 or 304).
+ *
+ * <p>Modeled after the native {@link Response} interface, but simplified for Remote Config's
+ * use case.
+ */
+export interface FetchResponse {
+  /**
+   * The HTTP status, which is useful for differentiating success responses with data from
+   * those without.
+   *
+   * <p>{@link RemoteConfigClient} is modeled after the native {@link GlobalFetch} interface, so
+   * HTTP status is first-class.
+   *
+   * <p>Disambiguation: the fetch response returns a legacy "state" value that is redundant with the
+   * HTTP status code. The former is normalized into the latter.
+   */
+  status: number;
+
+  /**
+   * Defines the ETag response header value.
+   *
+   * <p>Only defined for 200 and 304 responses.
+   */
+  eTag?: string;
+
+  /**
+   * Defines the map of parameters returned as "entries" in the fetch response body.
+   *
+   * <p>Only defined for 200 responses.
+   */
+  config?: FirebaseRemoteConfigObject;
+
+  // Note: we're not extracting experiment metadata until
+  // ABT and Analytics have Web SDKs.
+}
+
+/**
+ * Options for Remote Config initialization.
+ *
+ * @public
+ */
+export interface RemoteConfigOptions {
+  /**
+   * The ID of the template to use. If not provided, defaults to "firebase".
+   */
+  templateId?: string;
+
+  /**
+   * Hydrates the state with an initial fetch response.
+   */
+  initialFetchResponse?: FetchResponse;
+}
+
 /**
  * Indicates the source of a value.
  *

packages/remote-config/src/storage/storage.ts

@@ -16,10 +16,7 @@
  */
 
 import { FetchStatus, CustomSignals } from '@firebase/remote-config-types';
-import {
-  FetchResponse,
-  FirebaseRemoteConfigObject
-} from '../client/remote_config_fetch_client';
+import { FetchResponse, FirebaseRemoteConfigObject } from '../public_types';
 import { ERROR_FACTORY, ErrorCode } from '../errors';
 import { RC_CUSTOM_SIGNAL_MAX_ALLOWED_SIGNALS } from '../constants';
 import { FirebaseError } from '@firebase/util';

packages/remote-config/src/storage/storage_cache.ts

@@ -16,14 +16,14 @@
  */
 
 import { FetchStatus, CustomSignals } from '@firebase/remote-config-types';
-import { FirebaseRemoteConfigObject } from '../client/remote_config_fetch_client';
+import { FirebaseRemoteConfigObject } from '../public_types';
 import { Storage } from './storage';
 
 /**
  * A memory cache layer over storage to support the SDK's synchronous read requirements.
  */
 export class StorageCache {
-  constructor(private readonly storage: Storage) {}
+  constructor(private readonly storage: Storage) { }
 
   /**
    * Memory caches.

packages/remote-config/test/api.test.ts

@@ -19,9 +19,10 @@ import { expect } from 'chai';
 import {
   ensureInitialized,
   fetchAndActivate,
+  FetchResponse,
   getRemoteConfig,
   getString
-} from '../src/index';
+} from '../src';
 import '../test/setup';
 import {
   deleteApp,
@@ -30,7 +31,6 @@ import {
   _addOrOverwriteComponent
 } from '@firebase/app';
 import * as sinon from 'sinon';
-import { FetchResponse } from '../src/client/remote_config_fetch_client';
 import { Component, ComponentType } from '@firebase/component';
 import { FirebaseInstallations } from '@firebase/installations-types';
 import { openDatabase, APP_NAMESPACE_STORE } from '../src/storage/storage';

packages/remote-config/test/client/caching_client.test.ts

@@ -17,9 +17,9 @@
 
 import '../setup';
 import { expect } from 'chai';
+import { FetchResponse } from '../../src';
 import {
   RemoteConfigFetchClient,
-  FetchResponse,
   FetchRequest,
   RemoteConfigAbortSignal
 } from '../../src/client/remote_config_fetch_client';

packages/remote-config/test/client/retrying_client.test.ts

@@ -18,10 +18,10 @@
 import { expect } from 'chai';
 import * as sinon from 'sinon';
 import { Storage, ThrottleMetadata } from '../../src/storage/storage';
+import { FetchResponse } from '../../src';
 import {
   RemoteConfigFetchClient,
   FetchRequest,
-  FetchResponse,
   RemoteConfigAbortSignal
 } from '../../src/client/remote_config_fetch_client';
 import {