@firebase/remote-config 0.3.0 → 0.3.1-canary.2322b6023

package/dist/esm/src/storage/storage.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FetchStatus } from '@firebase/remote-config-types';
+import { FetchResponse, FirebaseRemoteConfigObject } from '../client/remote_config_fetch_client';
+/**
+ * A general-purpose store keyed by app + namespace + {@link
+ * ProjectNamespaceKeyFieldValue}.
+ *
+ * <p>The Remote Config SDK can be used with multiple app installations, and each app can interact
+ * with multiple namespaces, so this store uses app (ID + name) and namespace as common parent keys
+ * for a set of key-value pairs. See {@link Storage#createCompositeKey}.
+ *
+ * <p>Visible for testing.
+ */
+export declare const APP_NAMESPACE_STORE = "app_namespace_store";
+/**
+ * Encapsulates metadata concerning throttled fetch requests.
+ */
+export interface ThrottleMetadata {
+    backoffCount: number;
+    throttleEndTimeMillis: number;
+}
+/**
+ * Provides type-safety for the "key" field used by {@link APP_NAMESPACE_STORE}.
+ *
+ * <p>This seems like a small price to avoid potentially subtle bugs caused by a typo.
+ */
+declare type ProjectNamespaceKeyFieldValue = 'active_config' | 'active_config_etag' | 'last_fetch_status' | 'last_successful_fetch_timestamp_millis' | 'last_successful_fetch_response' | 'settings' | 'throttle_metadata';
+export declare function openDatabase(): Promise<IDBDatabase>;
+/**
+ * Abstracts data persistence.
+ */
+export declare class Storage {
+    private readonly appId;
+    private readonly appName;
+    private readonly namespace;
+    private readonly openDbPromise;
+    /**
+     * @param appId enables storage segmentation by app (ID + name).
+     * @param appName enables storage segmentation by app (ID + name).
+     * @param namespace enables storage segmentation by namespace.
+     */
+    constructor(appId: string, appName: string, namespace: string, openDbPromise?: Promise<IDBDatabase>);
+    getLastFetchStatus(): Promise<FetchStatus | undefined>;
+    setLastFetchStatus(status: FetchStatus): Promise<void>;
+    getLastSuccessfulFetchTimestampMillis(): Promise<number | undefined>;
+    setLastSuccessfulFetchTimestampMillis(timestamp: number): Promise<void>;
+    getLastSuccessfulFetchResponse(): Promise<FetchResponse | undefined>;
+    setLastSuccessfulFetchResponse(response: FetchResponse): Promise<void>;
+    getActiveConfig(): Promise<FirebaseRemoteConfigObject | undefined>;
+    setActiveConfig(config: FirebaseRemoteConfigObject): Promise<void>;
+    getActiveConfigEtag(): Promise<string | undefined>;
+    setActiveConfigEtag(etag: string): Promise<void>;
+    getThrottleMetadata(): Promise<ThrottleMetadata | undefined>;
+    setThrottleMetadata(metadata: ThrottleMetadata): Promise<void>;
+    deleteThrottleMetadata(): Promise<void>;
+    get<T>(key: ProjectNamespaceKeyFieldValue): Promise<T | undefined>;
+    set<T>(key: ProjectNamespaceKeyFieldValue, value: T): Promise<void>;
+    delete(key: ProjectNamespaceKeyFieldValue): Promise<void>;
+    createCompositeKey(key: ProjectNamespaceKeyFieldValue): string;
+}
+export {};

package/dist/esm/src/storage/storage_cache.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FetchStatus } from '@firebase/remote-config-types';
+import { FirebaseRemoteConfigObject } from '../client/remote_config_fetch_client';
+import { Storage } from './storage';
+/**
+ * A memory cache layer over storage to support the SDK's synchronous read requirements.
+ */
+export declare class StorageCache {
+    private readonly storage;
+    constructor(storage: Storage);
+    /**
+     * Memory caches.
+     */
+    private lastFetchStatus?;
+    private lastSuccessfulFetchTimestampMillis?;
+    private activeConfig?;
+    /**
+     * Memory-only getters
+     */
+    getLastFetchStatus(): FetchStatus | undefined;
+    getLastSuccessfulFetchTimestampMillis(): number | undefined;
+    getActiveConfig(): FirebaseRemoteConfigObject | undefined;
+    /**
+     * Read-ahead getter
+     */
+    loadFromStorage(): Promise<void>;
+    /**
+     * Write-through setters
+     */
+    setLastFetchStatus(status: FetchStatus): Promise<void>;
+    setLastSuccessfulFetchTimestampMillis(timestampMillis: number): Promise<void>;
+    setActiveConfig(activeConfig: FirebaseRemoteConfigObject): Promise<void>;
+}

package/dist/esm/src/value.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Value as ValueType, ValueSource } from '@firebase/remote-config-types';
+export declare class Value implements ValueType {
+    private readonly _source;
+    private readonly _value;
+    constructor(_source: ValueSource, _value?: string);
+    asString(): string;
+    asBoolean(): boolean;
+    asNumber(): number;
+    getSource(): ValueSource;
+}

package/dist/esm/test/client/caching_client.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import '../setup';

package/dist/esm/test/client/rest_client.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import '../setup';

package/dist/esm/test/client/retrying_client.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import '../setup';

package/dist/esm/test/errors.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import './setup';

package/dist/esm/test/language.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import './setup';

package/dist/esm/test/remote_config.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import './setup';

package/dist/esm/test/setup.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/esm/test/storage/storage.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import '../setup';

package/dist/esm/test/storage/storage_cache.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import '../setup';

package/dist/esm/test/value.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import './setup';

package/dist/index.cjs.js

@@ -10,7 +10,7 @@ var tslib = require('tslib');
 require('@firebase/installations');
 
 var name = "@firebase/remote-config";
-var version = "0.3.0";
+var version = "0.3.1-canary.2322b6023";
 
 /**
  * @license
@@ -1210,7 +1210,8 @@ var StorageCache = /** @class */ (function () {
                     case 2:
                         lastSuccessfulFetchTimestampMillis = _a.sent();
                         if (lastSuccessfulFetchTimestampMillis) {
-                            this.lastSuccessfulFetchTimestampMillis = lastSuccessfulFetchTimestampMillis;
+                            this.lastSuccessfulFetchTimestampMillis =
+                                lastSuccessfulFetchTimestampMillis;
                         }
                         return [4 /*yield*/, activeConfigPromise];
                     case 3:
@@ -1260,6 +1261,8 @@ var StorageCache = /** @class */ (function () {
 function registerRemoteConfig() {
     app._registerComponent(new component.Component(RC_COMPONENT_NAME, remoteConfigFactory, "PUBLIC" /* PUBLIC */).setMultipleInstances(true));
     app.registerVersion(name, version);
+    // BUILD_TARGET will be replaced by values like esm5, esm2017, cjs5, etc during the compilation
+    app.registerVersion(name, version, 'cjs5');
     function remoteConfigFactory(container, _a) {
         var namespace = _a.instanceIdentifier;
         /* Dependencies */