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.
Files changed (188) hide show
  1. package/README.md +7 -3
  2. package/lib/app/core.d.ts +15 -22
  3. package/lib/app/core.js +1 -1
  4. package/lib/app/credential-factory.d.ts +17 -33
  5. package/lib/app/credential-factory.js +17 -33
  6. package/lib/app/credential-internal.d.ts +10 -9
  7. package/lib/app/credential-internal.js +15 -13
  8. package/lib/app/credential.d.ts +3 -9
  9. package/lib/app/credential.js +1 -1
  10. package/lib/app/firebase-app.d.ts +6 -30
  11. package/lib/app/firebase-app.js +72 -216
  12. package/lib/app/firebase-namespace.d.ts +28 -34
  13. package/lib/app/firebase-namespace.js +119 -99
  14. package/lib/app/index.d.ts +6 -1
  15. package/lib/app/index.js +1 -1
  16. package/lib/app/lifecycle.d.ts +24 -3
  17. package/lib/app/lifecycle.js +119 -25
  18. package/lib/app-check/app-check-api-client-internal.d.ts +32 -0
  19. package/lib/app-check/app-check-api-client-internal.js +197 -0
  20. package/lib/app-check/app-check-api.d.ts +95 -0
  21. package/lib/app-check/app-check-api.js +19 -0
  22. package/lib/app-check/app-check-namespace.d.ts +65 -0
  23. package/lib/app-check/app-check-namespace.js +18 -0
  24. package/lib/app-check/app-check.d.ts +49 -0
  25. package/lib/app-check/app-check.js +82 -0
  26. package/lib/app-check/index.d.ts +53 -0
  27. package/lib/app-check/index.js +63 -0
  28. package/lib/app-check/token-generator.d.ts +25 -0
  29. package/lib/app-check/token-generator.js +159 -0
  30. package/lib/app-check/token-verifier.d.ts +17 -0
  31. package/lib/app-check/token-verifier.js +151 -0
  32. package/lib/auth/action-code-settings-builder.d.ts +1 -1
  33. package/lib/auth/action-code-settings-builder.js +2 -2
  34. package/lib/auth/auth-api-request.d.ts +28 -32
  35. package/lib/auth/auth-api-request.js +167 -125
  36. package/lib/auth/auth-config.d.ts +123 -21
  37. package/lib/auth/auth-config.js +85 -34
  38. package/lib/auth/auth-namespace.d.ts +157 -4
  39. package/lib/auth/auth-namespace.js +1 -1
  40. package/lib/auth/auth.d.ts +5 -3
  41. package/lib/auth/auth.js +6 -4
  42. package/lib/auth/base-auth.d.ts +134 -116
  43. package/lib/auth/base-auth.js +213 -143
  44. package/lib/auth/identifier.d.ts +5 -5
  45. package/lib/auth/identifier.js +1 -1
  46. package/lib/auth/index.d.ts +10 -5
  47. package/lib/auth/index.js +9 -4
  48. package/lib/auth/tenant-manager.d.ts +19 -19
  49. package/lib/auth/tenant-manager.js +21 -25
  50. package/lib/auth/tenant.d.ts +14 -5
  51. package/lib/auth/tenant.js +19 -11
  52. package/lib/auth/token-generator.d.ts +7 -108
  53. package/lib/auth/token-generator.js +52 -145
  54. package/lib/auth/token-verifier.d.ts +3 -4
  55. package/lib/auth/token-verifier.js +96 -145
  56. package/lib/auth/user-import-builder.d.ts +11 -11
  57. package/lib/auth/user-import-builder.js +9 -9
  58. package/lib/auth/user-record.d.ts +23 -15
  59. package/lib/auth/user-record.js +30 -20
  60. package/lib/credential/index.d.ts +18 -35
  61. package/lib/credential/index.js +17 -33
  62. package/lib/database/database-namespace.d.ts +39 -10
  63. package/lib/database/database-namespace.js +1 -1
  64. package/lib/database/database.d.ts +16 -6
  65. package/lib/database/database.js +61 -6
  66. package/lib/database/index.d.ts +19 -18
  67. package/lib/database/index.js +21 -23
  68. package/lib/default-namespace.d.ts +7 -1
  69. package/lib/default-namespace.js +4 -4
  70. package/lib/esm/app/index.js +10 -0
  71. package/lib/esm/app-check/index.js +4 -0
  72. package/lib/esm/auth/index.js +14 -0
  73. package/lib/esm/database/index.js +6 -0
  74. package/lib/esm/firestore/index.js +24 -0
  75. package/lib/esm/installations/index.js +4 -0
  76. package/lib/esm/instance-id/index.js +4 -0
  77. package/lib/esm/machine-learning/index.js +5 -0
  78. package/lib/esm/messaging/index.js +4 -0
  79. package/lib/esm/package.json +1 -0
  80. package/lib/esm/project-management/index.js +8 -0
  81. package/lib/esm/remote-config/index.js +4 -0
  82. package/lib/esm/security-rules/index.js +6 -0
  83. package/lib/esm/storage/index.js +4 -0
  84. package/lib/firebase-namespace-api.d.ts +12 -6
  85. package/lib/firebase-namespace-api.js +5 -1
  86. package/lib/firestore/firestore-internal.d.ts +2 -2
  87. package/lib/firestore/firestore-internal.js +2 -2
  88. package/lib/firestore/firestore-namespace.d.ts +6 -1
  89. package/lib/firestore/firestore-namespace.js +2 -1
  90. package/lib/firestore/index.d.ts +36 -4
  91. package/lib/firestore/index.js +29 -1
  92. package/lib/index.d.ts +1 -1
  93. package/lib/index.js +1 -1
  94. package/lib/installations/index.d.ts +52 -0
  95. package/lib/installations/index.js +62 -0
  96. package/lib/installations/installations-namespace.d.ts +55 -0
  97. package/lib/installations/installations-namespace.js +18 -0
  98. package/lib/{instance-id/instance-id-request-internal.d.ts → installations/installations-request-handler.d.ts} +8 -8
  99. package/lib/{instance-id/instance-id-request-internal.js → installations/installations-request-handler.js} +23 -23
  100. package/lib/installations/installations.d.ts +38 -0
  101. package/lib/installations/installations.js +63 -0
  102. package/lib/instance-id/index.d.ts +20 -9
  103. package/lib/instance-id/index.js +20 -9
  104. package/lib/instance-id/instance-id-namespace.d.ts +9 -8
  105. package/lib/instance-id/instance-id-namespace.js +1 -1
  106. package/lib/instance-id/instance-id.d.ts +8 -6
  107. package/lib/instance-id/instance-id.js +20 -11
  108. package/lib/machine-learning/index.d.ts +29 -27
  109. package/lib/machine-learning/index.js +29 -27
  110. package/lib/machine-learning/machine-learning-api-client.d.ts +1 -1
  111. package/lib/machine-learning/machine-learning-api-client.js +4 -4
  112. package/lib/machine-learning/machine-learning-namespace.d.ts +33 -8
  113. package/lib/machine-learning/machine-learning-namespace.js +1 -1
  114. package/lib/machine-learning/machine-learning-utils.d.ts +1 -1
  115. package/lib/machine-learning/machine-learning-utils.js +1 -1
  116. package/lib/machine-learning/machine-learning.d.ts +19 -19
  117. package/lib/machine-learning/machine-learning.js +20 -20
  118. package/lib/messaging/batch-request-internal.d.ts +3 -3
  119. package/lib/messaging/batch-request-internal.js +9 -9
  120. package/lib/messaging/index.d.ts +11 -9
  121. package/lib/messaging/index.js +11 -9
  122. package/lib/messaging/messaging-api-request-internal.d.ts +8 -8
  123. package/lib/messaging/messaging-api-request-internal.js +8 -8
  124. package/lib/messaging/messaging-api.d.ts +79 -75
  125. package/lib/messaging/messaging-api.js +1 -1
  126. package/lib/messaging/messaging-errors-internal.d.ts +5 -5
  127. package/lib/messaging/messaging-errors-internal.js +7 -7
  128. package/lib/messaging/messaging-internal.d.ts +1 -1
  129. package/lib/messaging/messaging-internal.js +6 -31
  130. package/lib/messaging/messaging-namespace.d.ts +105 -8
  131. package/lib/messaging/messaging-namespace.js +1 -1
  132. package/lib/messaging/messaging.d.ts +70 -86
  133. package/lib/messaging/messaging.js +76 -89
  134. package/lib/project-management/android-app.d.ts +11 -12
  135. package/lib/project-management/android-app.js +13 -14
  136. package/lib/project-management/app-metadata.d.ts +1 -1
  137. package/lib/project-management/app-metadata.js +1 -1
  138. package/lib/project-management/index.d.ts +11 -9
  139. package/lib/project-management/index.js +11 -9
  140. package/lib/project-management/ios-app.d.ts +6 -7
  141. package/lib/project-management/ios-app.js +6 -7
  142. package/lib/project-management/project-management-api-request-internal.d.ts +1 -80
  143. package/lib/project-management/project-management-api-request-internal.js +14 -14
  144. package/lib/project-management/project-management-namespace.d.ts +31 -9
  145. package/lib/project-management/project-management-namespace.js +1 -1
  146. package/lib/project-management/project-management.d.ts +18 -21
  147. package/lib/project-management/project-management.js +19 -22
  148. package/lib/remote-config/index.d.ts +12 -10
  149. package/lib/remote-config/index.js +11 -9
  150. package/lib/remote-config/remote-config-api-client-internal.d.ts +1 -1
  151. package/lib/remote-config/remote-config-api-client-internal.js +2 -2
  152. package/lib/remote-config/remote-config-api.d.ts +12 -2
  153. package/lib/remote-config/remote-config-api.js +1 -1
  154. package/lib/remote-config/remote-config-namespace.d.ts +50 -9
  155. package/lib/remote-config/remote-config-namespace.js +1 -1
  156. package/lib/remote-config/remote-config.d.ts +19 -21
  157. package/lib/remote-config/remote-config.js +25 -25
  158. package/lib/security-rules/index.d.ts +12 -10
  159. package/lib/security-rules/index.js +12 -10
  160. package/lib/security-rules/security-rules-api-client-internal.d.ts +1 -1
  161. package/lib/security-rules/security-rules-api-client-internal.js +1 -1
  162. package/lib/security-rules/security-rules-internal.d.ts +1 -1
  163. package/lib/security-rules/security-rules-internal.js +1 -1
  164. package/lib/security-rules/security-rules-namespace.d.ts +43 -28
  165. package/lib/security-rules/security-rules-namespace.js +1 -1
  166. package/lib/security-rules/security-rules.d.ts +39 -42
  167. package/lib/security-rules/security-rules.js +38 -39
  168. package/lib/storage/index.d.ts +9 -7
  169. package/lib/storage/index.js +9 -7
  170. package/lib/storage/storage-namespace.d.ts +7 -6
  171. package/lib/storage/storage-namespace.js +1 -1
  172. package/lib/storage/storage.d.ts +3 -3
  173. package/lib/storage/storage.js +14 -4
  174. package/lib/utils/api-request.d.ts +24 -24
  175. package/lib/utils/api-request.js +25 -25
  176. package/lib/utils/crypto-signer.d.ts +128 -0
  177. package/lib/utils/crypto-signer.js +237 -0
  178. package/lib/utils/deep-copy.d.ts +6 -6
  179. package/lib/utils/deep-copy.js +6 -6
  180. package/lib/utils/error.d.ts +69 -36
  181. package/lib/utils/error.js +98 -43
  182. package/lib/utils/index.d.ts +30 -19
  183. package/lib/utils/index.js +47 -20
  184. package/lib/utils/jwt.d.ts +131 -0
  185. package/lib/utils/jwt.js +355 -0
  186. package/lib/utils/validator.d.ts +37 -37
  187. package/lib/utils/validator.js +37 -37
  188. package/package.json +126 -53
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  /*!
3
3
  * Copyright 2018 Google Inc.
4
4
  *
@@ -33,8 +33,7 @@ export interface IosAppMetadata extends AppMetadata {
33
33
  /**
34
34
  * A reference to a Firebase iOS app.
35
35
  *
36
- * Do not call this constructor directly. Instead, use
37
- * [`projectManagement.iosApp()`](projectManagement.ProjectManagement#iosApp).
36
+ * Do not call this constructor directly. Instead, use {@link ProjectManagement.iosApp}.
38
37
  */
39
38
  export declare class IosApp {
40
39
  readonly appId: string;
@@ -43,23 +42,23 @@ export declare class IosApp {
43
42
  /**
44
43
  * Retrieves metadata about this iOS app.
45
44
  *
46
- * @return A promise that
45
+ * @returns A promise that
47
46
  * resolves to the retrieved metadata about this iOS app.
48
47
  */
49
48
  getMetadata(): Promise<IosAppMetadata>;
50
49
  /**
51
50
  * Sets the optional user-assigned display name of the app.
52
51
  *
53
- * @param newDisplayName The new display name to set.
52
+ * @param newDisplayName - The new display name to set.
54
53
  *
55
- * @return A promise that resolves when the display name has
54
+ * @returns A promise that resolves when the display name has
56
55
  * been set.
57
56
  */
58
57
  setDisplayName(newDisplayName: string): Promise<void>;
59
58
  /**
60
59
  * Gets the configuration artifact associated with this app.
61
60
  *
62
- * @return A promise that resolves to the iOS app's Firebase
61
+ * @returns A promise that resolves to the iOS app's Firebase
63
62
  * config file, in UTF-8 string format. This string is typically intended to
64
63
  * be written to a plist file that gets shipped with your iOS app.
65
64
  */
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  "use strict";
3
3
  /*!
4
4
  * Copyright 2018 Google Inc.
@@ -24,8 +24,7 @@ var app_metadata_1 = require("./app-metadata");
24
24
  /**
25
25
  * A reference to a Firebase iOS app.
26
26
  *
27
- * Do not call this constructor directly. Instead, use
28
- * [`projectManagement.iosApp()`](projectManagement.ProjectManagement#iosApp).
27
+ * Do not call this constructor directly. Instead, use {@link ProjectManagement.iosApp}.
29
28
  */
30
29
  var IosApp = /** @class */ (function () {
31
30
  /**
@@ -42,7 +41,7 @@ var IosApp = /** @class */ (function () {
42
41
  /**
43
42
  * Retrieves metadata about this iOS app.
44
43
  *
45
- * @return A promise that
44
+ * @returns A promise that
46
45
  * resolves to the retrieved metadata about this iOS app.
47
46
  */
48
47
  IosApp.prototype.getMetadata = function () {
@@ -67,9 +66,9 @@ var IosApp = /** @class */ (function () {
67
66
  /**
68
67
  * Sets the optional user-assigned display name of the app.
69
68
  *
70
- * @param newDisplayName The new display name to set.
69
+ * @param newDisplayName - The new display name to set.
71
70
  *
72
- * @return A promise that resolves when the display name has
71
+ * @returns A promise that resolves when the display name has
73
72
  * been set.
74
73
  */
75
74
  IosApp.prototype.setDisplayName = function (newDisplayName) {
@@ -78,7 +77,7 @@ var IosApp = /** @class */ (function () {
78
77
  /**
79
78
  * Gets the configuration artifact associated with this app.
80
79
  *
81
- * @return A promise that resolves to the iOS app's Firebase
80
+ * @returns A promise that resolves to the iOS app's Firebase
82
81
  * config file, in UTF-8 string format. This string is typically intended to
83
82
  * be written to a plist file that gets shipped with your iOS app.
84
83
  */
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  /*!
3
3
  * Copyright 2018 Google Inc.
4
4
  *
@@ -14,83 +14,4 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
- import { App } from '../app';
18
- import { ShaCertificate } from './android-app';
19
17
  export declare function assertServerResponse(condition: boolean, responseData: object, message: string): void;
20
- /**
21
- * Class that provides mechanism to send requests to the Firebase project management backend
22
- * endpoints.
23
- *
24
- * @private
25
- */
26
- export declare class ProjectManagementRequestHandler {
27
- private readonly baseUrl;
28
- private readonly baseBetaUrl;
29
- private readonly httpClient;
30
- private static wrapAndRethrowHttpError;
31
- /**
32
- * @param app The app used to fetch access tokens to sign API requests.
33
- * @constructor
34
- */
35
- constructor(app: App);
36
- /**
37
- * @param {string} parentResourceName Fully-qualified resource name of the project whose Android
38
- * apps you want to list.
39
- */
40
- listAndroidApps(parentResourceName: string): Promise<object>;
41
- /**
42
- * @param {string} parentResourceName Fully-qualified resource name of the project whose iOS apps
43
- * you want to list.
44
- */
45
- listIosApps(parentResourceName: string): Promise<object>;
46
- /**
47
- * @param {string} parentResourceName Fully-qualified resource name of the project whose iOS apps
48
- * you want to list.
49
- */
50
- listAppMetadata(parentResourceName: string): Promise<object>;
51
- /**
52
- * @param {string} parentResourceName Fully-qualified resource name of the project that you want
53
- * to create the Android app within.
54
- */
55
- createAndroidApp(parentResourceName: string, packageName: string, displayName?: string): Promise<object>;
56
- /**
57
- * @param {string} parentResourceName Fully-qualified resource name of the project that you want
58
- * to create the iOS app within.
59
- */
60
- createIosApp(parentResourceName: string, bundleId: string, displayName?: string): Promise<object>;
61
- /**
62
- * @param {string} resourceName Fully-qualified resource name of the entity whose display name you
63
- * want to set.
64
- */
65
- setDisplayName(resourceName: string, newDisplayName: string): Promise<void>;
66
- /**
67
- * @param {string} parentResourceName Fully-qualified resource name of the Android app whose SHA
68
- * certificates you want to get.
69
- */
70
- getAndroidShaCertificates(parentResourceName: string): Promise<object>;
71
- /**
72
- * @param {string} parentResourceName Fully-qualified resource name of the Android app that you
73
- * want to add the given SHA certificate to.
74
- */
75
- addAndroidShaCertificate(parentResourceName: string, certificate: ShaCertificate): Promise<void>;
76
- /**
77
- * @param {string} parentResourceName Fully-qualified resource name of the app whose config you
78
- * want to get.
79
- */
80
- getConfig(parentResourceName: string): Promise<object>;
81
- /**
82
- * @param {string} parentResourceName Fully-qualified resource name of the entity that you want to
83
- * get.
84
- */
85
- getResource(parentResourceName: string): Promise<object>;
86
- /**
87
- * @param {string} resourceName Fully-qualified resource name of the entity that you want to
88
- * delete.
89
- */
90
- deleteResource(resourceName: string): Promise<void>;
91
- private pollRemoteOperationWithExponentialBackoff;
92
- /**
93
- * Invokes the request handler with the provided request data.
94
- */
95
- private invokeRequestHandler;
96
- }
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  "use strict";
3
3
  /*!
4
4
  * Copyright 2018 Google Inc.
@@ -48,11 +48,11 @@ exports.assertServerResponse = assertServerResponse;
48
48
  * Class that provides mechanism to send requests to the Firebase project management backend
49
49
  * endpoints.
50
50
  *
51
- * @private
51
+ * @internal
52
52
  */
53
53
  var ProjectManagementRequestHandler = /** @class */ (function () {
54
54
  /**
55
- * @param app The app used to fetch access tokens to sign API requests.
55
+ * @param app - The app used to fetch access tokens to sign API requests.
56
56
  * @constructor
57
57
  */
58
58
  function ProjectManagementRequestHandler(app) {
@@ -102,7 +102,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
102
102
  throw new error_1.FirebaseProjectManagementError(errorCode, errorMessage + " Status code: " + errStatusCode + ". Raw server response: \"" + errText + "\".");
103
103
  };
104
104
  /**
105
- * @param {string} parentResourceName Fully-qualified resource name of the project whose Android
105
+ * @param parentResourceName - Fully-qualified resource name of the project whose Android
106
106
  * apps you want to list.
107
107
  */
108
108
  ProjectManagementRequestHandler.prototype.listAndroidApps = function (parentResourceName) {
@@ -110,7 +110,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
110
110
  /* requestData */ null, 'v1beta1');
111
111
  };
112
112
  /**
113
- * @param {string} parentResourceName Fully-qualified resource name of the project whose iOS apps
113
+ * @param parentResourceName - Fully-qualified resource name of the project whose iOS apps
114
114
  * you want to list.
115
115
  */
116
116
  ProjectManagementRequestHandler.prototype.listIosApps = function (parentResourceName) {
@@ -118,7 +118,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
118
118
  /* requestData */ null, 'v1beta1');
119
119
  };
120
120
  /**
121
- * @param {string} parentResourceName Fully-qualified resource name of the project whose iOS apps
121
+ * @param parentResourceName - Fully-qualified resource name of the project whose iOS apps
122
122
  * you want to list.
123
123
  */
124
124
  ProjectManagementRequestHandler.prototype.listAppMetadata = function (parentResourceName) {
@@ -126,7 +126,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
126
126
  /* requestData */ null, 'v1beta1');
127
127
  };
128
128
  /**
129
- * @param {string} parentResourceName Fully-qualified resource name of the project that you want
129
+ * @param parentResourceName - Fully-qualified resource name of the project that you want
130
130
  * to create the Android app within.
131
131
  */
132
132
  ProjectManagementRequestHandler.prototype.createAndroidApp = function (parentResourceName, packageName, displayName) {
@@ -146,7 +146,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
146
146
  });
147
147
  };
148
148
  /**
149
- * @param {string} parentResourceName Fully-qualified resource name of the project that you want
149
+ * @param parentResourceName - Fully-qualified resource name of the project that you want
150
150
  * to create the iOS app within.
151
151
  */
152
152
  ProjectManagementRequestHandler.prototype.createIosApp = function (parentResourceName, bundleId, displayName) {
@@ -166,7 +166,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
166
166
  });
167
167
  };
168
168
  /**
169
- * @param {string} resourceName Fully-qualified resource name of the entity whose display name you
169
+ * @param resourceName - Fully-qualified resource name of the entity whose display name you
170
170
  * want to set.
171
171
  */
172
172
  ProjectManagementRequestHandler.prototype.setDisplayName = function (resourceName, newDisplayName) {
@@ -178,14 +178,14 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
178
178
  .then(function () { return undefined; });
179
179
  };
180
180
  /**
181
- * @param {string} parentResourceName Fully-qualified resource name of the Android app whose SHA
181
+ * @param parentResourceName - Fully-qualified resource name of the Android app whose SHA
182
182
  * certificates you want to get.
183
183
  */
184
184
  ProjectManagementRequestHandler.prototype.getAndroidShaCertificates = function (parentResourceName) {
185
185
  return this.invokeRequestHandler('GET', parentResourceName + "/sha", /* requestData */ null, 'v1beta1');
186
186
  };
187
187
  /**
188
- * @param {string} parentResourceName Fully-qualified resource name of the Android app that you
188
+ * @param parentResourceName - Fully-qualified resource name of the Android app that you
189
189
  * want to add the given SHA certificate to.
190
190
  */
191
191
  ProjectManagementRequestHandler.prototype.addAndroidShaCertificate = function (parentResourceName, certificate) {
@@ -198,21 +198,21 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
198
198
  .then(function () { return undefined; });
199
199
  };
200
200
  /**
201
- * @param {string} parentResourceName Fully-qualified resource name of the app whose config you
201
+ * @param parentResourceName - Fully-qualified resource name of the app whose config you
202
202
  * want to get.
203
203
  */
204
204
  ProjectManagementRequestHandler.prototype.getConfig = function (parentResourceName) {
205
205
  return this.invokeRequestHandler('GET', parentResourceName + "/config", /* requestData */ null, 'v1beta1');
206
206
  };
207
207
  /**
208
- * @param {string} parentResourceName Fully-qualified resource name of the entity that you want to
208
+ * @param parentResourceName - Fully-qualified resource name of the entity that you want to
209
209
  * get.
210
210
  */
211
211
  ProjectManagementRequestHandler.prototype.getResource = function (parentResourceName) {
212
212
  return this.invokeRequestHandler('GET', parentResourceName, /* requestData */ null, 'v1beta1');
213
213
  };
214
214
  /**
215
- * @param {string} resourceName Fully-qualified resource name of the entity that you want to
215
+ * @param resourceName - Fully-qualified resource name of the entity that you want to
216
216
  * delete.
217
217
  */
218
218
  ProjectManagementRequestHandler.prototype.deleteResource = function (resourceName) {
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  /*!
3
3
  * Copyright 2021 Google Inc.
4
4
  *
@@ -20,14 +20,12 @@ import { ProjectManagement as TProjectManagement } from './project-management';
20
20
  import { AndroidApp as TAndroidApp, AndroidAppMetadata as TAndroidAppMetadata, ShaCertificate as TShaCertificate } from './android-app';
21
21
  import { IosApp as TIosApp, IosAppMetadata as TIosAppMetadata } from './ios-app';
22
22
  /**
23
- * Gets the {@link projectManagement.ProjectManagement
24
- * `ProjectManagement`} service for the default app or a given app.
23
+ * Gets the {@link firebase-admin.project-management#ProjectManagement} service for the
24
+ * default app or a given app.
25
25
  *
26
26
  * `admin.projectManagement()` can be called with no arguments to access the
27
- * default app's {@link projectManagement.ProjectManagement
28
- * `ProjectManagement`} service, or as `admin.projectManagement(app)` to access
29
- * the {@link projectManagement.ProjectManagement `ProjectManagement`}
30
- * service associated with a specific app.
27
+ * default app's `ProjectManagement` service, or as `admin.projectManagement(app)` to access
28
+ * the `ProjectManagement` service associated with a specific app.
31
29
  *
32
30
  * @example
33
31
  * ```javascript
@@ -41,20 +39,44 @@ import { IosApp as TIosApp, IosAppMetadata as TIosAppMetadata } from './ios-app'
41
39
  * var otherProjectManagement = admin.projectManagement(otherApp);
42
40
  * ```
43
41
  *
44
- * @param app Optional app whose `ProjectManagement` service
42
+ * @param app - Optional app whose `ProjectManagement` service
45
43
  * to return. If not provided, the default `ProjectManagement` service will
46
44
  * be returned. *
47
- * @return The default `ProjectManagement` service if no app is provided or the
45
+ * @returns The default `ProjectManagement` service if no app is provided or the
48
46
  * `ProjectManagement` service associated with the provided app.
49
47
  */
50
48
  export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
51
49
  export declare namespace projectManagement {
50
+ /**
51
+ * Type alias to {@link firebase-admin.project-management#AppMetadata}.
52
+ */
52
53
  type AppMetadata = TAppMetadata;
54
+ /**
55
+ * Type alias to {@link firebase-admin.project-management#AppPlatform}.
56
+ */
53
57
  type AppPlatform = TAppPlatform;
58
+ /**
59
+ * Type alias to {@link firebase-admin.project-management#ProjectManagement}.
60
+ */
54
61
  type ProjectManagement = TProjectManagement;
62
+ /**
63
+ * Type alias to {@link firebase-admin.project-management#IosApp}.
64
+ */
55
65
  type IosApp = TIosApp;
66
+ /**
67
+ * Type alias to {@link firebase-admin.project-management#IosAppMetadata}.
68
+ */
56
69
  type IosAppMetadata = TIosAppMetadata;
70
+ /**
71
+ * Type alias to {@link firebase-admin.project-management#AndroidApp}.
72
+ */
57
73
  type AndroidApp = TAndroidApp;
74
+ /**
75
+ * Type alias to {@link firebase-admin.project-management#AndroidAppMetadata}.
76
+ */
58
77
  type AndroidAppMetadata = TAndroidAppMetadata;
78
+ /**
79
+ * Type alias to {@link firebase-admin.project-management#ShaCertificate}.
80
+ */
59
81
  type ShaCertificate = TShaCertificate;
60
82
  }
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  "use strict";
3
3
  /*!
4
4
  * Copyright 2021 Google Inc.
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  /*!
3
3
  * Copyright 2018 Google Inc.
4
4
  *
@@ -20,9 +20,6 @@ import { IosApp } from './ios-app';
20
20
  import { AppMetadata } from './app-metadata';
21
21
  /**
22
22
  * The Firebase ProjectManagement service interface.
23
- *
24
- * Do not call this constructor directly. Instead, use
25
- * [`admin.projectManagement()`](projectManagement#projectManagement).
26
23
  */
27
24
  export declare class ProjectManagement {
28
25
  readonly app: App;
@@ -31,13 +28,13 @@ export declare class ProjectManagement {
31
28
  /**
32
29
  * Lists up to 100 Firebase Android apps associated with this Firebase project.
33
30
  *
34
- * @return The list of Android apps.
31
+ * @returns The list of Android apps.
35
32
  */
36
33
  listAndroidApps(): Promise<AndroidApp[]>;
37
34
  /**
38
35
  * Lists up to 100 Firebase iOS apps associated with this Firebase project.
39
36
  *
40
- * @return The list of iOS apps.
37
+ * @returns The list of iOS apps.
41
38
  */
42
39
  listIosApps(): Promise<IosApp[]>;
43
40
  /**
@@ -46,9 +43,9 @@ export declare class ProjectManagement {
46
43
  *
47
44
  * This method does not perform an RPC.
48
45
  *
49
- * @param appId The `appId` of the Android app to reference.
46
+ * @param appId - The `appId` of the Android app to reference.
50
47
  *
51
- * @return An `AndroidApp` object that references the specified Firebase Android app.
48
+ * @returns An `AndroidApp` object that references the specified Firebase Android app.
52
49
  */
53
50
  androidApp(appId: string): AndroidApp;
54
51
  /**
@@ -57,9 +54,9 @@ export declare class ProjectManagement {
57
54
  *
58
55
  * This method does not perform an RPC.
59
56
  *
60
- * @param appId The `appId` of the iOS app to reference.
57
+ * @param appId - The `appId` of the iOS app to reference.
61
58
  *
62
- * @return An `iOSApp` object that references the specified Firebase iOS app.
59
+ * @returns An `iOSApp` object that references the specified Firebase iOS app.
63
60
  */
64
61
  iosApp(appId: string): IosApp;
65
62
  /**
@@ -67,44 +64,44 @@ export declare class ProjectManagement {
67
64
  *
68
65
  * This method does not perform an RPC.
69
66
  *
70
- * @param shaHash The SHA-1 or SHA-256 hash for this certificate.
67
+ * @param shaHash - The SHA-1 or SHA-256 hash for this certificate.
71
68
  *
72
- * @return A `ShaCertificate` object contains the specified SHA hash.
69
+ * @returns A `ShaCertificate` object contains the specified SHA hash.
73
70
  */
74
71
  shaCertificate(shaHash: string): ShaCertificate;
75
72
  /**
76
73
  * Creates a new Firebase Android app associated with this Firebase project.
77
74
  *
78
- * @param packageName The canonical package name of the Android App,
75
+ * @param packageName - The canonical package name of the Android App,
79
76
  * as would appear in the Google Play Developer Console.
80
- * @param displayName An optional user-assigned display name for this
77
+ * @param displayName - An optional user-assigned display name for this
81
78
  * new app.
82
79
  *
83
- * @return A promise that resolves to the newly created Android app.
80
+ * @returns A promise that resolves to the newly created Android app.
84
81
  */
85
82
  createAndroidApp(packageName: string, displayName?: string): Promise<AndroidApp>;
86
83
  /**
87
84
  * Creates a new Firebase iOS app associated with this Firebase project.
88
85
  *
89
- * @param bundleId The iOS app bundle ID to use for this new app.
90
- * @param displayName An optional user-assigned display name for this
86
+ * @param bundleId - The iOS app bundle ID to use for this new app.
87
+ * @param displayName - An optional user-assigned display name for this
91
88
  * new app.
92
89
  *
93
- * @return A promise that resolves to the newly created iOS app.
90
+ * @returns A promise that resolves to the newly created iOS app.
94
91
  */
95
92
  createIosApp(bundleId: string, displayName?: string): Promise<IosApp>;
96
93
  /**
97
94
  * Lists up to 100 Firebase apps associated with this Firebase project.
98
95
  *
99
- * @return A promise that resolves to the metadata list of the apps.
96
+ * @returns A promise that resolves to the metadata list of the apps.
100
97
  */
101
98
  listAppMetadata(): Promise<AppMetadata[]>;
102
99
  /**
103
100
  * Update the display name of this Firebase project.
104
101
  *
105
- * @param newDisplayName The new display name to be updated.
102
+ * @param newDisplayName - The new display name to be updated.
106
103
  *
107
- * @return A promise that resolves when the project display name has been updated.
104
+ * @returns A promise that resolves when the project display name has been updated.
108
105
  */
109
106
  setDisplayName(newDisplayName: string): Promise<void>;
110
107
  private transformResponseToAppMetadata;
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  "use strict";
3
3
  /*!
4
4
  * Copyright 2018 Google Inc.
@@ -26,13 +26,10 @@ var project_management_api_request_internal_1 = require("./project-management-ap
26
26
  var app_metadata_1 = require("./app-metadata");
27
27
  /**
28
28
  * The Firebase ProjectManagement service interface.
29
- *
30
- * Do not call this constructor directly. Instead, use
31
- * [`admin.projectManagement()`](projectManagement#projectManagement).
32
29
  */
33
30
  var ProjectManagement = /** @class */ (function () {
34
31
  /**
35
- * @param app The app for this ProjectManagement service.
32
+ * @param app - The app for this ProjectManagement service.
36
33
  * @constructor
37
34
  * @internal
38
35
  */
@@ -47,7 +44,7 @@ var ProjectManagement = /** @class */ (function () {
47
44
  /**
48
45
  * Lists up to 100 Firebase Android apps associated with this Firebase project.
49
46
  *
50
- * @return The list of Android apps.
47
+ * @returns The list of Android apps.
51
48
  */
52
49
  ProjectManagement.prototype.listAndroidApps = function () {
53
50
  return this.listPlatformApps('android', 'listAndroidApps()');
@@ -55,7 +52,7 @@ var ProjectManagement = /** @class */ (function () {
55
52
  /**
56
53
  * Lists up to 100 Firebase iOS apps associated with this Firebase project.
57
54
  *
58
- * @return The list of iOS apps.
55
+ * @returns The list of iOS apps.
59
56
  */
60
57
  ProjectManagement.prototype.listIosApps = function () {
61
58
  return this.listPlatformApps('ios', 'listIosApps()');
@@ -66,9 +63,9 @@ var ProjectManagement = /** @class */ (function () {
66
63
  *
67
64
  * This method does not perform an RPC.
68
65
  *
69
- * @param appId The `appId` of the Android app to reference.
66
+ * @param appId - The `appId` of the Android app to reference.
70
67
  *
71
- * @return An `AndroidApp` object that references the specified Firebase Android app.
68
+ * @returns An `AndroidApp` object that references the specified Firebase Android app.
72
69
  */
73
70
  ProjectManagement.prototype.androidApp = function (appId) {
74
71
  return new android_app_1.AndroidApp(appId, this.requestHandler);
@@ -79,9 +76,9 @@ var ProjectManagement = /** @class */ (function () {
79
76
  *
80
77
  * This method does not perform an RPC.
81
78
  *
82
- * @param appId The `appId` of the iOS app to reference.
79
+ * @param appId - The `appId` of the iOS app to reference.
83
80
  *
84
- * @return An `iOSApp` object that references the specified Firebase iOS app.
81
+ * @returns An `iOSApp` object that references the specified Firebase iOS app.
85
82
  */
86
83
  ProjectManagement.prototype.iosApp = function (appId) {
87
84
  return new ios_app_1.IosApp(appId, this.requestHandler);
@@ -91,9 +88,9 @@ var ProjectManagement = /** @class */ (function () {
91
88
  *
92
89
  * This method does not perform an RPC.
93
90
  *
94
- * @param shaHash The SHA-1 or SHA-256 hash for this certificate.
91
+ * @param shaHash - The SHA-1 or SHA-256 hash for this certificate.
95
92
  *
96
- * @return A `ShaCertificate` object contains the specified SHA hash.
93
+ * @returns A `ShaCertificate` object contains the specified SHA hash.
97
94
  */
98
95
  ProjectManagement.prototype.shaCertificate = function (shaHash) {
99
96
  return new android_app_1.ShaCertificate(shaHash);
@@ -101,12 +98,12 @@ var ProjectManagement = /** @class */ (function () {
101
98
  /**
102
99
  * Creates a new Firebase Android app associated with this Firebase project.
103
100
  *
104
- * @param packageName The canonical package name of the Android App,
101
+ * @param packageName - The canonical package name of the Android App,
105
102
  * as would appear in the Google Play Developer Console.
106
- * @param displayName An optional user-assigned display name for this
103
+ * @param displayName - An optional user-assigned display name for this
107
104
  * new app.
108
105
  *
109
- * @return A promise that resolves to the newly created Android app.
106
+ * @returns A promise that resolves to the newly created Android app.
110
107
  */
111
108
  ProjectManagement.prototype.createAndroidApp = function (packageName, displayName) {
112
109
  var _this = this;
@@ -123,11 +120,11 @@ var ProjectManagement = /** @class */ (function () {
123
120
  /**
124
121
  * Creates a new Firebase iOS app associated with this Firebase project.
125
122
  *
126
- * @param bundleId The iOS app bundle ID to use for this new app.
127
- * @param displayName An optional user-assigned display name for this
123
+ * @param bundleId - The iOS app bundle ID to use for this new app.
124
+ * @param displayName - An optional user-assigned display name for this
128
125
  * new app.
129
126
  *
130
- * @return A promise that resolves to the newly created iOS app.
127
+ * @returns A promise that resolves to the newly created iOS app.
131
128
  */
132
129
  ProjectManagement.prototype.createIosApp = function (bundleId, displayName) {
133
130
  var _this = this;
@@ -144,7 +141,7 @@ var ProjectManagement = /** @class */ (function () {
144
141
  /**
145
142
  * Lists up to 100 Firebase apps associated with this Firebase project.
146
143
  *
147
- * @return A promise that resolves to the metadata list of the apps.
144
+ * @returns A promise that resolves to the metadata list of the apps.
148
145
  */
149
146
  ProjectManagement.prototype.listAppMetadata = function () {
150
147
  var _this = this;
@@ -162,9 +159,9 @@ var ProjectManagement = /** @class */ (function () {
162
159
  /**
163
160
  * Update the display name of this Firebase project.
164
161
  *
165
- * @param newDisplayName The new display name to be updated.
162
+ * @param newDisplayName - The new display name to be updated.
166
163
  *
167
- * @return A promise that resolves when the project display name has been updated.
164
+ * @returns A promise that resolves when the project display name has been updated.
168
165
  */
169
166
  ProjectManagement.prototype.setDisplayName = function (newDisplayName) {
170
167
  var _this = this;
@@ -1,4 +1,4 @@
1
- /*! firebase-admin v9.100.0-alpha.0 */
1
+ /*! firebase-admin v10.0.2 */
2
2
  /*!
3
3
  * Copyright 2020 Google Inc.
4
4
  *
@@ -14,19 +14,21 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
+ /**
18
+ * Firebase Remote Config.
19
+ *
20
+ * @packageDocumentation
21
+ */
17
22
  import { App } from '../app';
18
23
  import { RemoteConfig } from './remote-config';
19
- export { ExplicitParameterValue, InAppDefaultValue, ListVersionsOptions, ListVersionsResult, RemoteConfigCondition, RemoteConfigParameter, RemoteConfigParameterGroup, RemoteConfigParameterValue, RemoteConfigTemplate, RemoteConfigUser, TagColor, Version, } from './remote-config-api';
24
+ export { ExplicitParameterValue, InAppDefaultValue, ListVersionsOptions, ListVersionsResult, ParameterValueType, RemoteConfigCondition, RemoteConfigParameter, RemoteConfigParameterGroup, RemoteConfigParameterValue, RemoteConfigTemplate, RemoteConfigUser, TagColor, Version, } from './remote-config-api';
20
25
  export { RemoteConfig } from './remote-config';
21
26
  /**
22
- * Gets the {@link remoteConfig.RemoteConfig `RemoteConfig`} service for the
23
- * default app or a given app.
27
+ * Gets the {@link RemoteConfig} service for the default app or a given app.
24
28
  *
25
29
  * `getRemoteConfig()` can be called with no arguments to access the default
26
- * app's {@link remoteConfig.RemoteConfig `RemoteConfig`} service or as
27
- * `getRemoteConfig(app)` to access the
28
- * {@link remoteConfig.RemoteConfig `RemoteConfig`} service associated with a
29
- * specific app.
30
+ * app's `RemoteConfig` service or as `getRemoteConfig(app)` to access the
31
+ * `RemoteConfig` service associated with a specific app.
30
32
  *
31
33
  * @example
32
34
  * ```javascript
@@ -40,10 +42,10 @@ export { RemoteConfig } from './remote-config';
40
42
  * const otherRemoteConfig = getRemoteConfig(otherApp);
41
43
  * ```
42
44
  *
43
- * @param app Optional app for which to return the `RemoteConfig` service.
45
+ * @param app - Optional app for which to return the `RemoteConfig` service.
44
46
  * If not provided, the default `RemoteConfig` service is returned.
45
47
  *
46
- * @return The default `RemoteConfig` service if no
48
+ * @returns The default `RemoteConfig` service if no
47
49
  * app is provided, or the `RemoteConfig` service associated with the provided
48
50
  * app.
49
51
  */