firebase-admin 9.100.0-alpha.0 → 10.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -3
- package/lib/app/core.d.ts +15 -22
- package/lib/app/core.js +1 -1
- package/lib/app/credential-factory.d.ts +17 -33
- package/lib/app/credential-factory.js +17 -33
- package/lib/app/credential-internal.d.ts +10 -9
- package/lib/app/credential-internal.js +15 -13
- package/lib/app/credential.d.ts +3 -9
- package/lib/app/credential.js +1 -1
- package/lib/app/firebase-app.d.ts +6 -30
- package/lib/app/firebase-app.js +72 -216
- package/lib/app/firebase-namespace.d.ts +28 -34
- package/lib/app/firebase-namespace.js +119 -99
- package/lib/app/index.d.ts +6 -1
- package/lib/app/index.js +1 -1
- package/lib/app/lifecycle.d.ts +24 -3
- package/lib/app/lifecycle.js +119 -25
- package/lib/app-check/app-check-api-client-internal.d.ts +32 -0
- package/lib/app-check/app-check-api-client-internal.js +197 -0
- package/lib/app-check/app-check-api.d.ts +95 -0
- package/lib/app-check/app-check-api.js +19 -0
- package/lib/app-check/app-check-namespace.d.ts +65 -0
- package/lib/app-check/app-check-namespace.js +18 -0
- package/lib/app-check/app-check.d.ts +49 -0
- package/lib/app-check/app-check.js +82 -0
- package/lib/app-check/index.d.ts +53 -0
- package/lib/app-check/index.js +63 -0
- package/lib/app-check/token-generator.d.ts +25 -0
- package/lib/app-check/token-generator.js +159 -0
- package/lib/app-check/token-verifier.d.ts +17 -0
- package/lib/app-check/token-verifier.js +151 -0
- package/lib/auth/action-code-settings-builder.d.ts +1 -1
- package/lib/auth/action-code-settings-builder.js +2 -2
- package/lib/auth/auth-api-request.d.ts +28 -32
- package/lib/auth/auth-api-request.js +167 -125
- package/lib/auth/auth-config.d.ts +123 -21
- package/lib/auth/auth-config.js +85 -34
- package/lib/auth/auth-namespace.d.ts +157 -4
- package/lib/auth/auth-namespace.js +1 -1
- package/lib/auth/auth.d.ts +5 -3
- package/lib/auth/auth.js +6 -4
- package/lib/auth/base-auth.d.ts +134 -116
- package/lib/auth/base-auth.js +213 -143
- package/lib/auth/identifier.d.ts +5 -5
- package/lib/auth/identifier.js +1 -1
- package/lib/auth/index.d.ts +10 -5
- package/lib/auth/index.js +9 -4
- package/lib/auth/tenant-manager.d.ts +19 -19
- package/lib/auth/tenant-manager.js +21 -25
- package/lib/auth/tenant.d.ts +14 -5
- package/lib/auth/tenant.js +19 -11
- package/lib/auth/token-generator.d.ts +7 -108
- package/lib/auth/token-generator.js +52 -145
- package/lib/auth/token-verifier.d.ts +3 -4
- package/lib/auth/token-verifier.js +96 -145
- package/lib/auth/user-import-builder.d.ts +11 -11
- package/lib/auth/user-import-builder.js +9 -9
- package/lib/auth/user-record.d.ts +23 -15
- package/lib/auth/user-record.js +30 -20
- package/lib/credential/index.d.ts +18 -35
- package/lib/credential/index.js +17 -33
- package/lib/database/database-namespace.d.ts +39 -10
- package/lib/database/database-namespace.js +1 -1
- package/lib/database/database.d.ts +16 -6
- package/lib/database/database.js +61 -6
- package/lib/database/index.d.ts +19 -18
- package/lib/database/index.js +21 -23
- package/lib/default-namespace.d.ts +7 -1
- package/lib/default-namespace.js +4 -4
- package/lib/esm/app/index.js +10 -0
- package/lib/esm/app-check/index.js +4 -0
- package/lib/esm/auth/index.js +14 -0
- package/lib/esm/database/index.js +6 -0
- package/lib/esm/firestore/index.js +24 -0
- package/lib/esm/installations/index.js +4 -0
- package/lib/esm/instance-id/index.js +4 -0
- package/lib/esm/machine-learning/index.js +5 -0
- package/lib/esm/messaging/index.js +4 -0
- package/lib/esm/package.json +1 -0
- package/lib/esm/project-management/index.js +8 -0
- package/lib/esm/remote-config/index.js +4 -0
- package/lib/esm/security-rules/index.js +6 -0
- package/lib/esm/storage/index.js +4 -0
- package/lib/firebase-namespace-api.d.ts +12 -6
- package/lib/firebase-namespace-api.js +5 -1
- package/lib/firestore/firestore-internal.d.ts +2 -2
- package/lib/firestore/firestore-internal.js +2 -2
- package/lib/firestore/firestore-namespace.d.ts +6 -1
- package/lib/firestore/firestore-namespace.js +2 -1
- package/lib/firestore/index.d.ts +36 -4
- package/lib/firestore/index.js +29 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +1 -1
- package/lib/installations/index.d.ts +52 -0
- package/lib/installations/index.js +62 -0
- package/lib/installations/installations-namespace.d.ts +55 -0
- package/lib/installations/installations-namespace.js +18 -0
- package/lib/{instance-id/instance-id-request-internal.d.ts → installations/installations-request-handler.d.ts} +8 -8
- package/lib/{instance-id/instance-id-request-internal.js → installations/installations-request-handler.js} +23 -23
- package/lib/installations/installations.d.ts +38 -0
- package/lib/installations/installations.js +63 -0
- package/lib/instance-id/index.d.ts +20 -9
- package/lib/instance-id/index.js +20 -9
- package/lib/instance-id/instance-id-namespace.d.ts +9 -8
- package/lib/instance-id/instance-id-namespace.js +1 -1
- package/lib/instance-id/instance-id.d.ts +8 -6
- package/lib/instance-id/instance-id.js +20 -11
- package/lib/machine-learning/index.d.ts +29 -27
- package/lib/machine-learning/index.js +29 -27
- package/lib/machine-learning/machine-learning-api-client.d.ts +1 -1
- package/lib/machine-learning/machine-learning-api-client.js +4 -4
- package/lib/machine-learning/machine-learning-namespace.d.ts +33 -8
- package/lib/machine-learning/machine-learning-namespace.js +1 -1
- package/lib/machine-learning/machine-learning-utils.d.ts +1 -1
- package/lib/machine-learning/machine-learning-utils.js +1 -1
- package/lib/machine-learning/machine-learning.d.ts +19 -19
- package/lib/machine-learning/machine-learning.js +20 -20
- package/lib/messaging/batch-request-internal.d.ts +3 -3
- package/lib/messaging/batch-request-internal.js +9 -9
- package/lib/messaging/index.d.ts +11 -9
- package/lib/messaging/index.js +11 -9
- package/lib/messaging/messaging-api-request-internal.d.ts +8 -8
- package/lib/messaging/messaging-api-request-internal.js +8 -8
- package/lib/messaging/messaging-api.d.ts +79 -75
- package/lib/messaging/messaging-api.js +1 -1
- package/lib/messaging/messaging-errors-internal.d.ts +5 -5
- package/lib/messaging/messaging-errors-internal.js +7 -7
- package/lib/messaging/messaging-internal.d.ts +1 -1
- package/lib/messaging/messaging-internal.js +6 -31
- package/lib/messaging/messaging-namespace.d.ts +105 -8
- package/lib/messaging/messaging-namespace.js +1 -1
- package/lib/messaging/messaging.d.ts +70 -86
- package/lib/messaging/messaging.js +76 -89
- package/lib/project-management/android-app.d.ts +11 -12
- package/lib/project-management/android-app.js +13 -14
- package/lib/project-management/app-metadata.d.ts +1 -1
- package/lib/project-management/app-metadata.js +1 -1
- package/lib/project-management/index.d.ts +11 -9
- package/lib/project-management/index.js +11 -9
- package/lib/project-management/ios-app.d.ts +6 -7
- package/lib/project-management/ios-app.js +6 -7
- package/lib/project-management/project-management-api-request-internal.d.ts +1 -80
- package/lib/project-management/project-management-api-request-internal.js +14 -14
- package/lib/project-management/project-management-namespace.d.ts +31 -9
- package/lib/project-management/project-management-namespace.js +1 -1
- package/lib/project-management/project-management.d.ts +18 -21
- package/lib/project-management/project-management.js +19 -22
- package/lib/remote-config/index.d.ts +12 -10
- package/lib/remote-config/index.js +11 -9
- package/lib/remote-config/remote-config-api-client-internal.d.ts +1 -1
- package/lib/remote-config/remote-config-api-client-internal.js +2 -2
- package/lib/remote-config/remote-config-api.d.ts +12 -2
- package/lib/remote-config/remote-config-api.js +1 -1
- package/lib/remote-config/remote-config-namespace.d.ts +50 -9
- package/lib/remote-config/remote-config-namespace.js +1 -1
- package/lib/remote-config/remote-config.d.ts +19 -21
- package/lib/remote-config/remote-config.js +25 -25
- package/lib/security-rules/index.d.ts +12 -10
- package/lib/security-rules/index.js +12 -10
- package/lib/security-rules/security-rules-api-client-internal.d.ts +1 -1
- package/lib/security-rules/security-rules-api-client-internal.js +1 -1
- package/lib/security-rules/security-rules-internal.d.ts +1 -1
- package/lib/security-rules/security-rules-internal.js +1 -1
- package/lib/security-rules/security-rules-namespace.d.ts +43 -28
- package/lib/security-rules/security-rules-namespace.js +1 -1
- package/lib/security-rules/security-rules.d.ts +39 -42
- package/lib/security-rules/security-rules.js +38 -39
- package/lib/storage/index.d.ts +9 -7
- package/lib/storage/index.js +9 -7
- package/lib/storage/storage-namespace.d.ts +7 -6
- package/lib/storage/storage-namespace.js +1 -1
- package/lib/storage/storage.d.ts +3 -3
- package/lib/storage/storage.js +14 -4
- package/lib/utils/api-request.d.ts +24 -24
- package/lib/utils/api-request.js +25 -25
- package/lib/utils/crypto-signer.d.ts +128 -0
- package/lib/utils/crypto-signer.js +237 -0
- package/lib/utils/deep-copy.d.ts +6 -6
- package/lib/utils/deep-copy.js +6 -6
- package/lib/utils/error.d.ts +69 -36
- package/lib/utils/error.js +98 -43
- package/lib/utils/index.d.ts +30 -19
- package/lib/utils/index.js +47 -20
- package/lib/utils/jwt.d.ts +131 -0
- package/lib/utils/jwt.js +355 -0
- package/lib/utils/validator.d.ts +37 -37
- package/lib/utils/validator.js +37 -37
- package/package.json +126 -53
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
"use strict";
|
|
3
3
|
/*!
|
|
4
4
|
* Copyright 2020 Google Inc.
|
|
@@ -17,19 +17,21 @@
|
|
|
17
17
|
*/
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
19
|
exports.getRemoteConfig = void 0;
|
|
20
|
+
/**
|
|
21
|
+
* Firebase Remote Config.
|
|
22
|
+
*
|
|
23
|
+
* @packageDocumentation
|
|
24
|
+
*/
|
|
20
25
|
var app_1 = require("../app");
|
|
21
26
|
var remote_config_1 = require("./remote-config");
|
|
22
27
|
var remote_config_2 = require("./remote-config");
|
|
23
28
|
Object.defineProperty(exports, "RemoteConfig", { enumerable: true, get: function () { return remote_config_2.RemoteConfig; } });
|
|
24
29
|
/**
|
|
25
|
-
* Gets the {@link
|
|
26
|
-
* default app or a given app.
|
|
30
|
+
* Gets the {@link RemoteConfig} service for the default app or a given app.
|
|
27
31
|
*
|
|
28
32
|
* `getRemoteConfig()` can be called with no arguments to access the default
|
|
29
|
-
* app's
|
|
30
|
-
* `
|
|
31
|
-
* {@link remoteConfig.RemoteConfig `RemoteConfig`} service associated with a
|
|
32
|
-
* specific app.
|
|
33
|
+
* app's `RemoteConfig` service or as `getRemoteConfig(app)` to access the
|
|
34
|
+
* `RemoteConfig` service associated with a specific app.
|
|
33
35
|
*
|
|
34
36
|
* @example
|
|
35
37
|
* ```javascript
|
|
@@ -43,10 +45,10 @@ Object.defineProperty(exports, "RemoteConfig", { enumerable: true, get: function
|
|
|
43
45
|
* const otherRemoteConfig = getRemoteConfig(otherApp);
|
|
44
46
|
* ```
|
|
45
47
|
*
|
|
46
|
-
* @param app Optional app for which to return the `RemoteConfig` service.
|
|
48
|
+
* @param app - Optional app for which to return the `RemoteConfig` service.
|
|
47
49
|
* If not provided, the default `RemoteConfig` service is returned.
|
|
48
50
|
*
|
|
49
|
-
* @
|
|
51
|
+
* @returns The default `RemoteConfig` service if no
|
|
50
52
|
* app is provided, or the `RemoteConfig` service associated with the provided
|
|
51
53
|
* app.
|
|
52
54
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
"use strict";
|
|
3
3
|
/*!
|
|
4
4
|
* Copyright 2020 Google Inc.
|
|
@@ -322,7 +322,7 @@ var RemoteConfigApiClient = /** @class */ (function () {
|
|
|
322
322
|
*
|
|
323
323
|
* @param {ListVersionsOptions} options An options object to be validated.
|
|
324
324
|
*
|
|
325
|
-
* @
|
|
325
|
+
* @returns {ListVersionsOptions} A copy of the provided options object with timestamps converted
|
|
326
326
|
* to UTC Zulu format.
|
|
327
327
|
*/
|
|
328
328
|
RemoteConfigApiClient.prototype.validateListVersionsOptions = function (options) {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
/*!
|
|
3
3
|
* Copyright 2021 Google Inc.
|
|
4
4
|
*
|
|
@@ -18,6 +18,11 @@
|
|
|
18
18
|
* Colors that are associated with conditions for display purposes.
|
|
19
19
|
*/
|
|
20
20
|
export declare type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';
|
|
21
|
+
/**
|
|
22
|
+
* Type representing a Remote Config parameter value data type.
|
|
23
|
+
* Defaults to `STRING` if unspecified.
|
|
24
|
+
*/
|
|
25
|
+
export declare type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';
|
|
21
26
|
/**
|
|
22
27
|
* Interface representing a Remote Config condition.
|
|
23
28
|
* A condition targets a specific group of users. A list of these conditions make up
|
|
@@ -31,7 +36,7 @@ export interface RemoteConfigCondition {
|
|
|
31
36
|
/**
|
|
32
37
|
* The logic of this condition.
|
|
33
38
|
* See the documentation on
|
|
34
|
-
* {@link https://firebase.google.com/docs/remote-config/condition-reference condition expressions}
|
|
39
|
+
* {@link https://firebase.google.com/docs/remote-config/condition-reference | condition expressions}
|
|
35
40
|
* for the expected syntax of this field.
|
|
36
41
|
*/
|
|
37
42
|
expression: string;
|
|
@@ -89,6 +94,11 @@ export interface RemoteConfigParameter {
|
|
|
89
94
|
* Unicode characters.
|
|
90
95
|
*/
|
|
91
96
|
description?: string;
|
|
97
|
+
/**
|
|
98
|
+
* The data type for all values of this parameter in the current version of the template.
|
|
99
|
+
* Defaults to `ParameterValueType.STRING` if unspecified.
|
|
100
|
+
*/
|
|
101
|
+
valueType?: ParameterValueType;
|
|
92
102
|
}
|
|
93
103
|
/**
|
|
94
104
|
* Interface representing a Remote Config parameter group.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
/*!
|
|
3
3
|
* Copyright 2021 Google Inc.
|
|
4
4
|
*
|
|
@@ -15,17 +15,15 @@
|
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
17
|
import { App } from '../app';
|
|
18
|
-
import { ExplicitParameterValue as TExplicitParameterValue, InAppDefaultValue as TInAppDefaultValue, ListVersionsOptions as TListVersionsOptions, ListVersionsResult as TListVersionsResult, RemoteConfigCondition as TRemoteConfigCondition, RemoteConfigParameter as TRemoteConfigParameter, RemoteConfigParameterGroup as TRemoteConfigParameterGroup, RemoteConfigParameterValue as TRemoteConfigParameterValue, RemoteConfigTemplate as TRemoteConfigTemplate, RemoteConfigUser as TRemoteConfigUser, TagColor as TTagColor, Version as TVersion } from './remote-config-api';
|
|
18
|
+
import { ExplicitParameterValue as TExplicitParameterValue, InAppDefaultValue as TInAppDefaultValue, ListVersionsOptions as TListVersionsOptions, ListVersionsResult as TListVersionsResult, ParameterValueType as TParameterValueType, RemoteConfigCondition as TRemoteConfigCondition, RemoteConfigParameter as TRemoteConfigParameter, RemoteConfigParameterGroup as TRemoteConfigParameterGroup, RemoteConfigParameterValue as TRemoteConfigParameterValue, RemoteConfigTemplate as TRemoteConfigTemplate, RemoteConfigUser as TRemoteConfigUser, TagColor as TTagColor, Version as TVersion } from './remote-config-api';
|
|
19
19
|
import { RemoteConfig as TRemoteConfig } from './remote-config';
|
|
20
20
|
/**
|
|
21
|
-
* Gets the {@link
|
|
21
|
+
* Gets the {@link firebase-admin.remote-config#RemoteConfig} service for the
|
|
22
22
|
* default app or a given app.
|
|
23
23
|
*
|
|
24
24
|
* `admin.remoteConfig()` can be called with no arguments to access the default
|
|
25
|
-
* app's
|
|
26
|
-
* `
|
|
27
|
-
* {@link remoteConfig.RemoteConfig `RemoteConfig`} service associated with a
|
|
28
|
-
* specific app.
|
|
25
|
+
* app's `RemoteConfig` service or as `admin.remoteConfig(app)` to access the
|
|
26
|
+
* `RemoteConfig` service associated with a specific app.
|
|
29
27
|
*
|
|
30
28
|
* @example
|
|
31
29
|
* ```javascript
|
|
@@ -39,26 +37,69 @@ import { RemoteConfig as TRemoteConfig } from './remote-config';
|
|
|
39
37
|
* var otherRemoteConfig = admin.remoteConfig(otherApp);
|
|
40
38
|
* ```
|
|
41
39
|
*
|
|
42
|
-
* @param app Optional app for which to return the `RemoteConfig` service.
|
|
40
|
+
* @param app - Optional app for which to return the `RemoteConfig` service.
|
|
43
41
|
* If not provided, the default `RemoteConfig` service is returned.
|
|
44
42
|
*
|
|
45
|
-
* @
|
|
43
|
+
* @returns The default `RemoteConfig` service if no
|
|
46
44
|
* app is provided, or the `RemoteConfig` service associated with the provided
|
|
47
45
|
* app.
|
|
48
46
|
*/
|
|
49
47
|
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
|
|
50
48
|
export declare namespace remoteConfig {
|
|
49
|
+
/**
|
|
50
|
+
* Type alias to {@link firebase-admin.remote-config#ExplicitParameterValue}.
|
|
51
|
+
*/
|
|
51
52
|
type ExplicitParameterValue = TExplicitParameterValue;
|
|
53
|
+
/**
|
|
54
|
+
* Type alias to {@link firebase-admin.remote-config#InAppDefaultValue}.
|
|
55
|
+
*/
|
|
52
56
|
type InAppDefaultValue = TInAppDefaultValue;
|
|
57
|
+
/**
|
|
58
|
+
* Type alias to {@link firebase-admin.remote-config#ListVersionsOptions}.
|
|
59
|
+
*/
|
|
53
60
|
type ListVersionsOptions = TListVersionsOptions;
|
|
61
|
+
/**
|
|
62
|
+
* Type alias to {@link firebase-admin.remote-config#ListVersionsResult}.
|
|
63
|
+
*/
|
|
54
64
|
type ListVersionsResult = TListVersionsResult;
|
|
65
|
+
/**
|
|
66
|
+
* Type alias to {@link firebase-admin.remote-config#ParameterValueType}.
|
|
67
|
+
*/
|
|
68
|
+
type ParameterValueType = TParameterValueType;
|
|
69
|
+
/**
|
|
70
|
+
* Type alias to {@link firebase-admin.remote-config#RemoteConfig}.
|
|
71
|
+
*/
|
|
55
72
|
type RemoteConfig = TRemoteConfig;
|
|
73
|
+
/**
|
|
74
|
+
* Type alias to {@link firebase-admin.remote-config#RemoteConfigCondition}.
|
|
75
|
+
*/
|
|
56
76
|
type RemoteConfigCondition = TRemoteConfigCondition;
|
|
77
|
+
/**
|
|
78
|
+
* Type alias to {@link firebase-admin.remote-config#RemoteConfigParameter}.
|
|
79
|
+
*/
|
|
57
80
|
type RemoteConfigParameter = TRemoteConfigParameter;
|
|
81
|
+
/**
|
|
82
|
+
* Type alias to {@link firebase-admin.remote-config#RemoteConfigParameterGroup}.
|
|
83
|
+
*/
|
|
58
84
|
type RemoteConfigParameterGroup = TRemoteConfigParameterGroup;
|
|
85
|
+
/**
|
|
86
|
+
* Type alias to {@link firebase-admin.remote-config#RemoteConfigParameterValue}.
|
|
87
|
+
*/
|
|
59
88
|
type RemoteConfigParameterValue = TRemoteConfigParameterValue;
|
|
89
|
+
/**
|
|
90
|
+
* Type alias to {@link firebase-admin.remote-config#RemoteConfigTemplate}.
|
|
91
|
+
*/
|
|
60
92
|
type RemoteConfigTemplate = TRemoteConfigTemplate;
|
|
93
|
+
/**
|
|
94
|
+
* Type alias to {@link firebase-admin.remote-config#RemoteConfigUser}.
|
|
95
|
+
*/
|
|
61
96
|
type RemoteConfigUser = TRemoteConfigUser;
|
|
97
|
+
/**
|
|
98
|
+
* Type alias to {@link firebase-admin.remote-config#TagColor}.
|
|
99
|
+
*/
|
|
62
100
|
type TagColor = TTagColor;
|
|
101
|
+
/**
|
|
102
|
+
* Type alias to {@link firebase-admin.remote-config#Version}.
|
|
103
|
+
*/
|
|
63
104
|
type Version = TVersion;
|
|
64
105
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
/*!
|
|
3
3
|
* Copyright 2020 Google Inc.
|
|
4
4
|
*
|
|
@@ -23,41 +23,39 @@ export declare class RemoteConfig {
|
|
|
23
23
|
readonly app: App;
|
|
24
24
|
private readonly client;
|
|
25
25
|
/**
|
|
26
|
-
* Gets the current active version of the {@link
|
|
27
|
-
* `RemoteConfigTemplate`} of the project.
|
|
26
|
+
* Gets the current active version of the {@link RemoteConfigTemplate} of the project.
|
|
28
27
|
*
|
|
29
|
-
* @
|
|
28
|
+
* @returns A promise that fulfills with a `RemoteConfigTemplate`.
|
|
30
29
|
*/
|
|
31
30
|
getTemplate(): Promise<RemoteConfigTemplate>;
|
|
32
31
|
/**
|
|
33
|
-
* Gets the requested version of the {@link
|
|
34
|
-
* `RemoteConfigTemplate`} of the project.
|
|
32
|
+
* Gets the requested version of the {@link RemoteConfigTemplate} of the project.
|
|
35
33
|
*
|
|
36
|
-
* @param versionNumber Version number of the Remote Config template to look up.
|
|
34
|
+
* @param versionNumber - Version number of the Remote Config template to look up.
|
|
37
35
|
*
|
|
38
|
-
* @
|
|
36
|
+
* @returns A promise that fulfills with a `RemoteConfigTemplate`.
|
|
39
37
|
*/
|
|
40
38
|
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
|
|
41
39
|
/**
|
|
42
|
-
* Validates a {@link
|
|
40
|
+
* Validates a {@link RemoteConfigTemplate}.
|
|
43
41
|
*
|
|
44
|
-
* @param template The Remote Config template to be validated.
|
|
42
|
+
* @param template - The Remote Config template to be validated.
|
|
45
43
|
* @returns A promise that fulfills with the validated `RemoteConfigTemplate`.
|
|
46
44
|
*/
|
|
47
45
|
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
|
|
48
46
|
/**
|
|
49
47
|
* Publishes a Remote Config template.
|
|
50
48
|
*
|
|
51
|
-
* @param template The Remote Config template to be published.
|
|
52
|
-
* @param options Optional options object when publishing a Remote Config template:
|
|
53
|
-
* -
|
|
49
|
+
* @param template - The Remote Config template to be published.
|
|
50
|
+
* @param options - Optional options object when publishing a Remote Config template:
|
|
51
|
+
* - `force`: Setting this to `true` forces the Remote Config template to
|
|
54
52
|
* be updated and circumvent the ETag. This approach is not recommended
|
|
55
53
|
* because it risks causing the loss of updates to your Remote Config
|
|
56
54
|
* template if multiple clients are updating the Remote Config template.
|
|
57
|
-
* See {@link https://firebase.google.com/docs/remote-config/use-config-rest#etag_usage_and_forced_updates
|
|
55
|
+
* See {@link https://firebase.google.com/docs/remote-config/use-config-rest#etag_usage_and_forced_updates |
|
|
58
56
|
* ETag usage and forced updates}.
|
|
59
57
|
*
|
|
60
|
-
* @
|
|
58
|
+
* @returns A Promise that fulfills with the published `RemoteConfigTemplate`.
|
|
61
59
|
*/
|
|
62
60
|
publishTemplate(template: RemoteConfigTemplate, options?: {
|
|
63
61
|
force: boolean;
|
|
@@ -67,12 +65,12 @@ export declare class RemoteConfig {
|
|
|
67
65
|
* A rollback is equivalent to getting a previously published Remote Config
|
|
68
66
|
* template and re-publishing it using a force update.
|
|
69
67
|
*
|
|
70
|
-
* @param versionNumber The version number of the Remote Config template to roll back to.
|
|
68
|
+
* @param versionNumber - The version number of the Remote Config template to roll back to.
|
|
71
69
|
* The specified version number must be lower than the current version number, and not have
|
|
72
70
|
* been deleted due to staleness. Only the last 300 versions are stored.
|
|
73
71
|
* All versions that correspond to non-active Remote Config templates (that is, all except the
|
|
74
72
|
* template that is being fetched by clients) are also deleted if they are more than 90 days old.
|
|
75
|
-
* @
|
|
73
|
+
* @returns A promise that fulfills with the published `RemoteConfigTemplate`.
|
|
76
74
|
*/
|
|
77
75
|
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
|
|
78
76
|
/**
|
|
@@ -81,16 +79,16 @@ export declare class RemoteConfig {
|
|
|
81
79
|
* All versions that correspond to non-active Remote Config templates (i.e., all except the
|
|
82
80
|
* template that is being fetched by clients) are also deleted if they are older than 90 days.
|
|
83
81
|
*
|
|
84
|
-
* @param options Optional options object for getting a list of versions.
|
|
85
|
-
* @
|
|
82
|
+
* @param options - Optional options object for getting a list of versions.
|
|
83
|
+
* @returns A promise that fulfills with a `ListVersionsResult`.
|
|
86
84
|
*/
|
|
87
85
|
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
|
|
88
86
|
/**
|
|
89
87
|
* Creates and returns a new Remote Config template from a JSON string.
|
|
90
88
|
*
|
|
91
|
-
* @param json The JSON string to populate a Remote Config template.
|
|
89
|
+
* @param json - The JSON string to populate a Remote Config template.
|
|
92
90
|
*
|
|
93
|
-
* @
|
|
91
|
+
* @returns A new template instance.
|
|
94
92
|
*/
|
|
95
93
|
createTemplateFromJSON(json: string): RemoteConfigTemplate;
|
|
96
94
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
"use strict";
|
|
3
3
|
/*!
|
|
4
4
|
* Copyright 2020 Google Inc.
|
|
@@ -24,7 +24,7 @@ var remote_config_api_client_internal_1 = require("./remote-config-api-client-in
|
|
|
24
24
|
*/
|
|
25
25
|
var RemoteConfig = /** @class */ (function () {
|
|
26
26
|
/**
|
|
27
|
-
* @param app The app for this RemoteConfig service.
|
|
27
|
+
* @param app - The app for this RemoteConfig service.
|
|
28
28
|
* @constructor
|
|
29
29
|
* @internal
|
|
30
30
|
*/
|
|
@@ -33,10 +33,9 @@ var RemoteConfig = /** @class */ (function () {
|
|
|
33
33
|
this.client = new remote_config_api_client_internal_1.RemoteConfigApiClient(app);
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
* Gets the current active version of the {@link
|
|
37
|
-
* `RemoteConfigTemplate`} of the project.
|
|
36
|
+
* Gets the current active version of the {@link RemoteConfigTemplate} of the project.
|
|
38
37
|
*
|
|
39
|
-
* @
|
|
38
|
+
* @returns A promise that fulfills with a `RemoteConfigTemplate`.
|
|
40
39
|
*/
|
|
41
40
|
RemoteConfig.prototype.getTemplate = function () {
|
|
42
41
|
return this.client.getTemplate()
|
|
@@ -45,12 +44,11 @@ var RemoteConfig = /** @class */ (function () {
|
|
|
45
44
|
});
|
|
46
45
|
};
|
|
47
46
|
/**
|
|
48
|
-
* Gets the requested version of the {@link
|
|
49
|
-
* `RemoteConfigTemplate`} of the project.
|
|
47
|
+
* Gets the requested version of the {@link RemoteConfigTemplate} of the project.
|
|
50
48
|
*
|
|
51
|
-
* @param versionNumber Version number of the Remote Config template to look up.
|
|
49
|
+
* @param versionNumber - Version number of the Remote Config template to look up.
|
|
52
50
|
*
|
|
53
|
-
* @
|
|
51
|
+
* @returns A promise that fulfills with a `RemoteConfigTemplate`.
|
|
54
52
|
*/
|
|
55
53
|
RemoteConfig.prototype.getTemplateAtVersion = function (versionNumber) {
|
|
56
54
|
return this.client.getTemplateAtVersion(versionNumber)
|
|
@@ -59,9 +57,9 @@ var RemoteConfig = /** @class */ (function () {
|
|
|
59
57
|
});
|
|
60
58
|
};
|
|
61
59
|
/**
|
|
62
|
-
* Validates a {@link
|
|
60
|
+
* Validates a {@link RemoteConfigTemplate}.
|
|
63
61
|
*
|
|
64
|
-
* @param template The Remote Config template to be validated.
|
|
62
|
+
* @param template - The Remote Config template to be validated.
|
|
65
63
|
* @returns A promise that fulfills with the validated `RemoteConfigTemplate`.
|
|
66
64
|
*/
|
|
67
65
|
RemoteConfig.prototype.validateTemplate = function (template) {
|
|
@@ -73,16 +71,16 @@ var RemoteConfig = /** @class */ (function () {
|
|
|
73
71
|
/**
|
|
74
72
|
* Publishes a Remote Config template.
|
|
75
73
|
*
|
|
76
|
-
* @param template The Remote Config template to be published.
|
|
77
|
-
* @param options Optional options object when publishing a Remote Config template:
|
|
78
|
-
* -
|
|
74
|
+
* @param template - The Remote Config template to be published.
|
|
75
|
+
* @param options - Optional options object when publishing a Remote Config template:
|
|
76
|
+
* - `force`: Setting this to `true` forces the Remote Config template to
|
|
79
77
|
* be updated and circumvent the ETag. This approach is not recommended
|
|
80
78
|
* because it risks causing the loss of updates to your Remote Config
|
|
81
79
|
* template if multiple clients are updating the Remote Config template.
|
|
82
|
-
* See {@link https://firebase.google.com/docs/remote-config/use-config-rest#etag_usage_and_forced_updates
|
|
80
|
+
* See {@link https://firebase.google.com/docs/remote-config/use-config-rest#etag_usage_and_forced_updates |
|
|
83
81
|
* ETag usage and forced updates}.
|
|
84
82
|
*
|
|
85
|
-
* @
|
|
83
|
+
* @returns A Promise that fulfills with the published `RemoteConfigTemplate`.
|
|
86
84
|
*/
|
|
87
85
|
RemoteConfig.prototype.publishTemplate = function (template, options) {
|
|
88
86
|
return this.client.publishTemplate(template, options)
|
|
@@ -95,12 +93,12 @@ var RemoteConfig = /** @class */ (function () {
|
|
|
95
93
|
* A rollback is equivalent to getting a previously published Remote Config
|
|
96
94
|
* template and re-publishing it using a force update.
|
|
97
95
|
*
|
|
98
|
-
* @param versionNumber The version number of the Remote Config template to roll back to.
|
|
96
|
+
* @param versionNumber - The version number of the Remote Config template to roll back to.
|
|
99
97
|
* The specified version number must be lower than the current version number, and not have
|
|
100
98
|
* been deleted due to staleness. Only the last 300 versions are stored.
|
|
101
99
|
* All versions that correspond to non-active Remote Config templates (that is, all except the
|
|
102
100
|
* template that is being fetched by clients) are also deleted if they are more than 90 days old.
|
|
103
|
-
* @
|
|
101
|
+
* @returns A promise that fulfills with the published `RemoteConfigTemplate`.
|
|
104
102
|
*/
|
|
105
103
|
RemoteConfig.prototype.rollback = function (versionNumber) {
|
|
106
104
|
return this.client.rollback(versionNumber)
|
|
@@ -114,8 +112,8 @@ var RemoteConfig = /** @class */ (function () {
|
|
|
114
112
|
* All versions that correspond to non-active Remote Config templates (i.e., all except the
|
|
115
113
|
* template that is being fetched by clients) are also deleted if they are older than 90 days.
|
|
116
114
|
*
|
|
117
|
-
* @param options Optional options object for getting a list of versions.
|
|
118
|
-
* @
|
|
115
|
+
* @param options - Optional options object for getting a list of versions.
|
|
116
|
+
* @returns A promise that fulfills with a `ListVersionsResult`.
|
|
119
117
|
*/
|
|
120
118
|
RemoteConfig.prototype.listVersions = function (options) {
|
|
121
119
|
return this.client.listVersions(options)
|
|
@@ -130,9 +128,9 @@ var RemoteConfig = /** @class */ (function () {
|
|
|
130
128
|
/**
|
|
131
129
|
* Creates and returns a new Remote Config template from a JSON string.
|
|
132
130
|
*
|
|
133
|
-
* @param json The JSON string to populate a Remote Config template.
|
|
131
|
+
* @param json - The JSON string to populate a Remote Config template.
|
|
134
132
|
*
|
|
135
|
-
* @
|
|
133
|
+
* @returns A new template instance.
|
|
136
134
|
*/
|
|
137
135
|
RemoteConfig.prototype.createTemplateFromJSON = function (json) {
|
|
138
136
|
if (!validator.isNonEmptyString(json)) {
|
|
@@ -195,7 +193,7 @@ var RemoteConfigTemplateImpl = /** @class */ (function () {
|
|
|
195
193
|
/**
|
|
196
194
|
* Gets the ETag of the template.
|
|
197
195
|
*
|
|
198
|
-
* @
|
|
196
|
+
* @returns The ETag of the Remote Config template.
|
|
199
197
|
*/
|
|
200
198
|
get: function () {
|
|
201
199
|
return this.etagInternal;
|
|
@@ -204,7 +202,9 @@ var RemoteConfigTemplateImpl = /** @class */ (function () {
|
|
|
204
202
|
configurable: true
|
|
205
203
|
});
|
|
206
204
|
/**
|
|
207
|
-
*
|
|
205
|
+
* Returns a JSON-serializable representation of this object.
|
|
206
|
+
*
|
|
207
|
+
* @returns A JSON-serializable representation of this object.
|
|
208
208
|
*/
|
|
209
209
|
RemoteConfigTemplateImpl.prototype.toJSON = function () {
|
|
210
210
|
return {
|
|
@@ -282,7 +282,7 @@ var VersionImpl = /** @class */ (function () {
|
|
|
282
282
|
}
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
|
-
* @
|
|
285
|
+
* @returns A JSON-serializable representation of this object.
|
|
286
286
|
*/
|
|
287
287
|
VersionImpl.prototype.toJSON = function () {
|
|
288
288
|
return {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
/*!
|
|
3
3
|
* Copyright 2020 Google Inc.
|
|
4
4
|
*
|
|
@@ -14,18 +14,20 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
+
/**
|
|
18
|
+
* Security Rules for Cloud Firestore and Cloud Storage.
|
|
19
|
+
*
|
|
20
|
+
* @packageDocumentation
|
|
21
|
+
*/
|
|
17
22
|
import { App } from '../app';
|
|
18
23
|
import { SecurityRules } from './security-rules';
|
|
19
24
|
export { RulesFile, Ruleset, RulesetMetadata, RulesetMetadataList, SecurityRules, } from './security-rules';
|
|
20
25
|
/**
|
|
21
|
-
* Gets the {@link
|
|
22
|
-
* `SecurityRules`} service for the default app or a given app.
|
|
26
|
+
* Gets the {@link SecurityRules} service for the default app or a given app.
|
|
23
27
|
*
|
|
24
28
|
* `admin.securityRules()` can be called with no arguments to access the
|
|
25
|
-
* default app's
|
|
26
|
-
* `SecurityRules`
|
|
27
|
-
* the {@link securityRules.SecurityRules `SecurityRules`}
|
|
28
|
-
* service associated with a specific app.
|
|
29
|
+
* default app's `SecurityRules` service, or as `admin.securityRules(app)` to access
|
|
30
|
+
* the `SecurityRules` service associated with a specific app.
|
|
29
31
|
*
|
|
30
32
|
* @example
|
|
31
33
|
* ```javascript
|
|
@@ -34,15 +36,15 @@ export { RulesFile, Ruleset, RulesetMetadata, RulesetMetadataList, SecurityRules
|
|
|
34
36
|
* ```
|
|
35
37
|
*
|
|
36
38
|
* @example
|
|
37
|
-
*
|
|
39
|
+
* ```javascript
|
|
38
40
|
* // Get the SecurityRules service for a given app
|
|
39
41
|
* const otherSecurityRules = getSecurityRules(otherApp);
|
|
40
42
|
* ```
|
|
41
43
|
*
|
|
42
|
-
* @param app Optional app to return the `SecurityRules` service
|
|
44
|
+
* @param app - Optional app to return the `SecurityRules` service
|
|
43
45
|
* for. If not provided, the default `SecurityRules` service
|
|
44
46
|
* is returned.
|
|
45
|
-
* @
|
|
47
|
+
* @returns The default `SecurityRules` service if no app is provided, or the
|
|
46
48
|
* `SecurityRules` service associated with the provided app.
|
|
47
49
|
*/
|
|
48
50
|
export declare function getSecurityRules(app?: App): SecurityRules;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin
|
|
1
|
+
/*! firebase-admin v10.0.2 */
|
|
2
2
|
"use strict";
|
|
3
3
|
/*!
|
|
4
4
|
* Copyright 2020 Google Inc.
|
|
@@ -17,6 +17,11 @@
|
|
|
17
17
|
*/
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
19
|
exports.getSecurityRules = void 0;
|
|
20
|
+
/**
|
|
21
|
+
* Security Rules for Cloud Firestore and Cloud Storage.
|
|
22
|
+
*
|
|
23
|
+
* @packageDocumentation
|
|
24
|
+
*/
|
|
20
25
|
var app_1 = require("../app");
|
|
21
26
|
var security_rules_1 = require("./security-rules");
|
|
22
27
|
var security_rules_2 = require("./security-rules");
|
|
@@ -24,14 +29,11 @@ Object.defineProperty(exports, "Ruleset", { enumerable: true, get: function () {
|
|
|
24
29
|
Object.defineProperty(exports, "RulesetMetadataList", { enumerable: true, get: function () { return security_rules_2.RulesetMetadataList; } });
|
|
25
30
|
Object.defineProperty(exports, "SecurityRules", { enumerable: true, get: function () { return security_rules_2.SecurityRules; } });
|
|
26
31
|
/**
|
|
27
|
-
* Gets the {@link
|
|
28
|
-
* `SecurityRules`} service for the default app or a given app.
|
|
32
|
+
* Gets the {@link SecurityRules} service for the default app or a given app.
|
|
29
33
|
*
|
|
30
34
|
* `admin.securityRules()` can be called with no arguments to access the
|
|
31
|
-
* default app's
|
|
32
|
-
* `SecurityRules`
|
|
33
|
-
* the {@link securityRules.SecurityRules `SecurityRules`}
|
|
34
|
-
* service associated with a specific app.
|
|
35
|
+
* default app's `SecurityRules` service, or as `admin.securityRules(app)` to access
|
|
36
|
+
* the `SecurityRules` service associated with a specific app.
|
|
35
37
|
*
|
|
36
38
|
* @example
|
|
37
39
|
* ```javascript
|
|
@@ -40,15 +42,15 @@ Object.defineProperty(exports, "SecurityRules", { enumerable: true, get: functio
|
|
|
40
42
|
* ```
|
|
41
43
|
*
|
|
42
44
|
* @example
|
|
43
|
-
*
|
|
45
|
+
* ```javascript
|
|
44
46
|
* // Get the SecurityRules service for a given app
|
|
45
47
|
* const otherSecurityRules = getSecurityRules(otherApp);
|
|
46
48
|
* ```
|
|
47
49
|
*
|
|
48
|
-
* @param app Optional app to return the `SecurityRules` service
|
|
50
|
+
* @param app - Optional app to return the `SecurityRules` service
|
|
49
51
|
* for. If not provided, the default `SecurityRules` service
|
|
50
52
|
* is returned.
|
|
51
|
-
* @
|
|
53
|
+
* @returns The default `SecurityRules` service if no app is provided, or the
|
|
52
54
|
* `SecurityRules` service associated with the provided app.
|
|
53
55
|
*/
|
|
54
56
|
function getSecurityRules(app) {
|