firebase-tools 10.9.1 → 11.0.1

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 (38) hide show
  1. package/README.md +15 -9
  2. package/lib/appdistribution/client.js +16 -25
  3. package/lib/commands/apps-sdkconfig.js +6 -2
  4. package/lib/commands/ext-configure.js +54 -119
  5. package/lib/commands/ext-dev-emulators-exec.js +11 -6
  6. package/lib/commands/ext-dev-emulators-start.js +10 -26
  7. package/lib/commands/ext-install.js +12 -197
  8. package/lib/commands/ext-uninstall.js +7 -91
  9. package/lib/commands/ext-update.js +65 -224
  10. package/lib/deploy/functions/runtimes/discovery/v1alpha1.js +8 -9
  11. package/lib/deploy/remoteconfig/functions.js +18 -14
  12. package/lib/emulator/commandUtils.js +1 -1
  13. package/lib/emulator/controller.js +2 -2
  14. package/lib/emulator/databaseEmulator.js +7 -5
  15. package/lib/emulator/downloadableEmulators.js +6 -6
  16. package/lib/emulator/extensionsEmulator.js +7 -3
  17. package/lib/emulator/firestoreEmulator.js +10 -12
  18. package/lib/emulator/functionsEmulator.js +39 -42
  19. package/lib/emulator/hubClient.js +11 -22
  20. package/lib/emulator/hubExport.js +26 -16
  21. package/lib/emulator/portUtils.js +2 -0
  22. package/lib/emulator/storage/crc.js +3 -0
  23. package/lib/emulator/storage/rules/runtime.js +1 -1
  24. package/lib/extensions/extensionsHelper.js +4 -5
  25. package/lib/extensions/manifest.js +5 -11
  26. package/lib/firebaseConfigValidate.js +1 -1
  27. package/lib/firestore/checkDatabaseType.js +4 -5
  28. package/lib/firestore/indexes.js +17 -34
  29. package/lib/gcp/storage.js +2 -4
  30. package/lib/hosting/cloudRunProxy.js +19 -15
  31. package/lib/init/features/database.js +3 -5
  32. package/lib/management/apps.js +47 -43
  33. package/lib/management/database.js +33 -31
  34. package/lib/management/projects.js +13 -7
  35. package/lib/rtdb.js +31 -29
  36. package/npm-shrinkwrap.json +982 -511
  37. package/package.json +16 -19
  38. package/standalone/package.json +1 -1
@@ -1,13 +1,14 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.deleteAppAndroidSha = exports.createAppAndroidSha = exports.listAppAndroidSha = exports.getAppConfig = exports.getAppConfigFile = exports.listFirebaseApps = exports.createWebApp = exports.createAndroidApp = exports.createIosApp = exports.getAppPlatform = exports.ShaCertificateType = exports.AppPlatform = void 0;
3
+ exports.deleteAppAndroidSha = exports.createAppAndroidSha = exports.listAppAndroidSha = exports.getAppConfig = exports.getAppConfigFile = exports.listFirebaseApps = exports.createWebApp = exports.createAndroidApp = exports.createIosApp = exports.getAppPlatform = exports.ShaCertificateType = exports.AppPlatform = exports.APP_LIST_PAGE_SIZE = void 0;
4
4
  const fs = require("fs");
5
- const api = require("../api");
5
+ const apiv2_1 = require("../apiv2");
6
+ const api_1 = require("../api");
6
7
  const error_1 = require("../error");
7
8
  const logger_1 = require("../logger");
8
9
  const operation_poller_1 = require("../operation-poller");
9
10
  const TIMEOUT_MILLIS = 30000;
10
- const APP_LIST_PAGE_SIZE = 100;
11
+ exports.APP_LIST_PAGE_SIZE = 100;
11
12
  const CREATE_APP_API_REQUEST_TIMEOUT_MILLIS = 15000;
12
13
  const WEB_CONFIG_FILE_NAME = "google-config.js";
13
14
  var AppPlatform;
@@ -39,17 +40,18 @@ function getAppPlatform(platform) {
39
40
  }
40
41
  }
41
42
  exports.getAppPlatform = getAppPlatform;
43
+ const apiClient = new apiv2_1.Client({ urlPrefix: api_1.firebaseApiOrigin, apiVersion: "v1beta1" });
42
44
  async function createIosApp(projectId, options) {
43
45
  try {
44
- const response = await api.request("POST", `/v1beta1/projects/${projectId}/iosApps`, {
45
- auth: true,
46
- origin: api.firebaseApiOrigin,
46
+ const response = await apiClient.request({
47
+ method: "POST",
48
+ path: `/projects/${projectId}/iosApps`,
47
49
  timeout: CREATE_APP_API_REQUEST_TIMEOUT_MILLIS,
48
- data: options,
50
+ body: options,
49
51
  });
50
52
  const appData = await (0, operation_poller_1.pollOperation)({
51
53
  pollerName: "Create iOS app Poller",
52
- apiOrigin: api.firebaseApiOrigin,
54
+ apiOrigin: api_1.firebaseApiOrigin,
53
55
  apiVersion: "v1beta1",
54
56
  operationResourceName: response.body.name,
55
57
  });
@@ -63,15 +65,15 @@ async function createIosApp(projectId, options) {
63
65
  exports.createIosApp = createIosApp;
64
66
  async function createAndroidApp(projectId, options) {
65
67
  try {
66
- const response = await api.request("POST", `/v1beta1/projects/${projectId}/androidApps`, {
67
- auth: true,
68
- origin: api.firebaseApiOrigin,
68
+ const response = await apiClient.request({
69
+ method: "POST",
70
+ path: `/projects/${projectId}/androidApps`,
69
71
  timeout: CREATE_APP_API_REQUEST_TIMEOUT_MILLIS,
70
- data: options,
72
+ body: options,
71
73
  });
72
74
  const appData = await (0, operation_poller_1.pollOperation)({
73
75
  pollerName: "Create Android app Poller",
74
- apiOrigin: api.firebaseApiOrigin,
76
+ apiOrigin: api_1.firebaseApiOrigin,
75
77
  apiVersion: "v1beta1",
76
78
  operationResourceName: response.body.name,
77
79
  });
@@ -88,15 +90,15 @@ async function createAndroidApp(projectId, options) {
88
90
  exports.createAndroidApp = createAndroidApp;
89
91
  async function createWebApp(projectId, options) {
90
92
  try {
91
- const response = await api.request("POST", `/v1beta1/projects/${projectId}/webApps`, {
92
- auth: true,
93
- origin: api.firebaseApiOrigin,
93
+ const response = await apiClient.request({
94
+ method: "POST",
95
+ path: `/projects/${projectId}/webApps`,
94
96
  timeout: CREATE_APP_API_REQUEST_TIMEOUT_MILLIS,
95
- data: options,
97
+ body: options,
96
98
  });
97
99
  const appData = await (0, operation_poller_1.pollOperation)({
98
100
  pollerName: "Create Web app Poller",
99
- apiOrigin: api.firebaseApiOrigin,
101
+ apiOrigin: api_1.firebaseApiOrigin,
100
102
  apiVersion: "v1beta1",
101
103
  operationResourceName: response.body.name,
102
104
  });
@@ -126,18 +128,21 @@ function getListAppsResourceString(projectId, platform) {
126
128
  default:
127
129
  throw new error_1.FirebaseError("Unexpected platform. Only support iOS, Android and Web apps");
128
130
  }
129
- return `/v1beta1/projects/${projectId}${resourceSuffix}`;
131
+ return `/projects/${projectId}${resourceSuffix}`;
130
132
  }
131
- async function listFirebaseApps(projectId, platform, pageSize = APP_LIST_PAGE_SIZE) {
133
+ async function listFirebaseApps(projectId, platform, pageSize = exports.APP_LIST_PAGE_SIZE) {
132
134
  const apps = [];
133
135
  try {
134
- let nextPageToken = "";
136
+ let nextPageToken;
135
137
  do {
136
- const pageTokenQueryString = nextPageToken ? `&pageToken=${nextPageToken}` : "";
137
- const response = await api.request("GET", getListAppsResourceString(projectId, platform) +
138
- `?pageSize=${pageSize}${pageTokenQueryString}`, {
139
- auth: true,
140
- origin: api.firebaseApiOrigin,
138
+ const queryParams = { pageSize };
139
+ if (nextPageToken) {
140
+ queryParams.pageToken = nextPageToken;
141
+ }
142
+ const response = await apiClient.request({
143
+ method: "GET",
144
+ path: getListAppsResourceString(projectId, platform),
145
+ queryParams,
141
146
  timeout: TIMEOUT_MILLIS,
142
147
  });
143
148
  if (response.body.apps) {
@@ -173,7 +178,7 @@ function getAppConfigResourceString(appId, platform) {
173
178
  default:
174
179
  throw new error_1.FirebaseError("Unexpected app platform");
175
180
  }
176
- return `/v1beta1/projects/-/${platformResource}/${appId}/config`;
181
+ return `/projects/-/${platformResource}/${appId}/config`;
177
182
  }
178
183
  function parseConfigFromResponse(responseBody, platform) {
179
184
  if (platform === AppPlatform.WEB) {
@@ -196,13 +201,13 @@ function getAppConfigFile(config, platform) {
196
201
  }
197
202
  exports.getAppConfigFile = getAppConfigFile;
198
203
  async function getAppConfig(appId, platform) {
199
- let response;
200
204
  try {
201
- response = await api.request("GET", getAppConfigResourceString(appId, platform), {
202
- auth: true,
203
- origin: api.firebaseApiOrigin,
205
+ const response = await apiClient.request({
206
+ method: "GET",
207
+ path: getAppConfigResourceString(appId, platform),
204
208
  timeout: TIMEOUT_MILLIS,
205
209
  });
210
+ return response.body;
206
211
  }
207
212
  catch (err) {
208
213
  logger_1.logger.debug(err.message);
@@ -211,15 +216,15 @@ async function getAppConfig(appId, platform) {
211
216
  original: err,
212
217
  });
213
218
  }
214
- return response.body;
215
219
  }
216
220
  exports.getAppConfig = getAppConfig;
217
221
  async function listAppAndroidSha(projectId, appId) {
218
222
  const shaCertificates = [];
219
223
  try {
220
- const response = await api.request("GET", `/v1beta1/projects/${projectId}/androidApps/${appId}/sha`, {
221
- auth: true,
222
- origin: api.firebaseApiOrigin,
224
+ const response = await apiClient.request({
225
+ method: "GET",
226
+ path: `/projects/${projectId}/androidApps/${appId}/sha`,
227
+ timeout: CREATE_APP_API_REQUEST_TIMEOUT_MILLIS,
223
228
  });
224
229
  if (response.body.certificates) {
225
230
  shaCertificates.push(...response.body.certificates);
@@ -238,11 +243,11 @@ async function listAppAndroidSha(projectId, appId) {
238
243
  exports.listAppAndroidSha = listAppAndroidSha;
239
244
  async function createAppAndroidSha(projectId, appId, options) {
240
245
  try {
241
- const response = await api.request("POST", `/v1beta1/projects/${projectId}/androidApps/${appId}/sha`, {
242
- auth: true,
243
- origin: api.firebaseApiOrigin,
246
+ const response = await apiClient.request({
247
+ method: "POST",
248
+ path: `/projects/${projectId}/androidApps/${appId}/sha`,
249
+ body: options,
244
250
  timeout: CREATE_APP_API_REQUEST_TIMEOUT_MILLIS,
245
- data: options,
246
251
  });
247
252
  const shaCertificate = response.body;
248
253
  return shaCertificate;
@@ -258,11 +263,10 @@ async function createAppAndroidSha(projectId, appId, options) {
258
263
  exports.createAppAndroidSha = createAppAndroidSha;
259
264
  async function deleteAppAndroidSha(projectId, appId, shaId) {
260
265
  try {
261
- await api.request("DELETE", `/v1beta1/projects/${projectId}/androidApps/${appId}/sha/${shaId}`, {
262
- auth: true,
263
- origin: api.firebaseApiOrigin,
266
+ await apiClient.request({
267
+ method: "DELETE",
268
+ path: `/projects/${projectId}/androidApps/${appId}/sha/${shaId}`,
264
269
  timeout: CREATE_APP_API_REQUEST_TIMEOUT_MILLIS,
265
- data: null,
266
270
  });
267
271
  }
268
272
  catch (err) {
@@ -1,14 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.listDatabaseInstances = exports.parseDatabaseLocation = exports.checkInstanceNameAvailable = exports.createInstance = exports.getDatabaseInstanceDetails = exports.populateInstanceDetails = exports.DatabaseLocation = exports.DatabaseInstanceState = exports.DatabaseInstanceType = void 0;
4
- const api = require("../api");
3
+ exports.listDatabaseInstances = exports.parseDatabaseLocation = exports.checkInstanceNameAvailable = exports.createInstance = exports.getDatabaseInstanceDetails = exports.populateInstanceDetails = exports.DatabaseLocation = exports.DatabaseInstanceState = exports.DatabaseInstanceType = exports.APP_LIST_PAGE_SIZE = exports.MGMT_API_VERSION = void 0;
4
+ const apiv2_1 = require("../apiv2");
5
+ const constants_1 = require("../emulator/constants");
6
+ const error_1 = require("../error");
5
7
  const logger_1 = require("../logger");
8
+ const api_1 = require("../api");
6
9
  const utils = require("../utils");
7
- const error_1 = require("../error");
8
- const constants_1 = require("../emulator/constants");
9
- const MGMT_API_VERSION = "v1beta";
10
+ exports.MGMT_API_VERSION = "v1beta";
11
+ exports.APP_LIST_PAGE_SIZE = 100;
10
12
  const TIMEOUT_MILLIS = 10000;
11
- const APP_LIST_PAGE_SIZE = 100;
12
13
  const INSTANCE_RESOURCE_NAME_REGEX = /projects\/([^/]+?)\/locations\/([^/]+?)\/instances\/([^/]*)/;
13
14
  var DatabaseInstanceType;
14
15
  (function (DatabaseInstanceType) {
@@ -30,6 +31,7 @@ var DatabaseLocation;
30
31
  DatabaseLocation["ASIA_SOUTHEAST1"] = "asia-southeast1";
31
32
  DatabaseLocation["ANY"] = "-";
32
33
  })(DatabaseLocation = exports.DatabaseLocation || (exports.DatabaseLocation = {}));
34
+ const apiClient = new apiv2_1.Client({ urlPrefix: api_1.rtdbManagementOrigin, apiVersion: exports.MGMT_API_VERSION });
33
35
  async function populateInstanceDetails(options) {
34
36
  options.instanceDetails = await getDatabaseInstanceDetails(options.project, options.instance);
35
37
  return Promise.resolve();
@@ -37,9 +39,9 @@ async function populateInstanceDetails(options) {
37
39
  exports.populateInstanceDetails = populateInstanceDetails;
38
40
  async function getDatabaseInstanceDetails(projectId, instanceName) {
39
41
  try {
40
- const response = await api.request("GET", `/${MGMT_API_VERSION}/projects/${projectId}/locations/-/instances/${instanceName}`, {
41
- auth: true,
42
- origin: api.rtdbManagementOrigin,
42
+ const response = await apiClient.request({
43
+ method: "GET",
44
+ path: `/projects/${projectId}/locations/-/instances/${instanceName}`,
43
45
  timeout: TIMEOUT_MILLIS,
44
46
  });
45
47
  return convertDatabaseInstance(response.body);
@@ -57,8 +59,8 @@ async function getDatabaseInstanceDetails(projectId, instanceName) {
57
59
  state: DatabaseInstanceState.ACTIVE,
58
60
  });
59
61
  }
60
- return utils.reject(`Failed to get instance details for instance: ${instanceName}. See firebase-debug.log for more details.`, {
61
- code: 2,
62
+ throw new error_1.FirebaseError(`Failed to get instance details for instance: ${instanceName}. See firebase-debug.log for more details.`, {
63
+ exit: 2,
62
64
  original: err,
63
65
  });
64
66
  }
@@ -66,13 +68,12 @@ async function getDatabaseInstanceDetails(projectId, instanceName) {
66
68
  exports.getDatabaseInstanceDetails = getDatabaseInstanceDetails;
67
69
  async function createInstance(projectId, instanceName, location, databaseType) {
68
70
  try {
69
- const response = await api.request("POST", `/${MGMT_API_VERSION}/projects/${projectId}/locations/${location}/instances?databaseId=${instanceName}`, {
70
- auth: true,
71
- origin: api.rtdbManagementOrigin,
71
+ const response = await apiClient.request({
72
+ method: "POST",
73
+ path: `/projects/${projectId}/locations/${location}/instances`,
74
+ queryParams: { databaseId: instanceName },
75
+ body: { type: databaseType },
72
76
  timeout: TIMEOUT_MILLIS,
73
- data: {
74
- type: databaseType,
75
- },
76
77
  });
77
78
  return convertDatabaseInstance(response.body);
78
79
  }
@@ -91,17 +92,14 @@ async function checkInstanceNameAvailable(projectId, instanceName, databaseType,
91
92
  location = DatabaseLocation.US_CENTRAL1;
92
93
  }
93
94
  try {
94
- await api.request("POST", `/${MGMT_API_VERSION}/projects/${projectId}/locations/${location}/instances?databaseId=${instanceName}&validateOnly=true`, {
95
- auth: true,
96
- origin: api.rtdbManagementOrigin,
95
+ await apiClient.request({
96
+ method: "POST",
97
+ path: `/projects/${projectId}/locations/${location}/instances`,
98
+ queryParams: { databaseId: instanceName, validateOnly: "true" },
99
+ body: { type: databaseType },
97
100
  timeout: TIMEOUT_MILLIS,
98
- data: {
99
- type: databaseType,
100
- },
101
101
  });
102
- return {
103
- available: true,
104
- };
102
+ return { available: true };
105
103
  }
106
104
  catch (err) {
107
105
  logger_1.logger.debug(`Invalid Realtime Database instance name: ${instanceName}.${err.message ? " " + err.message : ""}`);
@@ -136,15 +134,19 @@ function parseDatabaseLocation(location, defaultLocation) {
136
134
  }
137
135
  }
138
136
  exports.parseDatabaseLocation = parseDatabaseLocation;
139
- async function listDatabaseInstances(projectId, location, pageSize = APP_LIST_PAGE_SIZE) {
137
+ async function listDatabaseInstances(projectId, location, pageSize = exports.APP_LIST_PAGE_SIZE) {
140
138
  const instances = [];
141
139
  try {
142
140
  let nextPageToken = "";
143
141
  do {
144
- const pageTokenQueryString = nextPageToken ? `&pageToken=${nextPageToken}` : "";
145
- const response = await api.request("GET", `/${MGMT_API_VERSION}/projects/${projectId}/locations/${location}/instances?pageSize=${pageSize}${pageTokenQueryString}`, {
146
- auth: true,
147
- origin: api.rtdbManagementOrigin,
142
+ const queryParams = { pageSize };
143
+ if (nextPageToken) {
144
+ queryParams.pageToken = nextPageToken;
145
+ }
146
+ const response = await apiClient.request({
147
+ method: "GET",
148
+ path: `/projects/${projectId}/locations/${location}/instances`,
149
+ queryParams,
148
150
  timeout: TIMEOUT_MILLIS,
149
151
  });
150
152
  if (response.body.instances) {
@@ -172,11 +172,17 @@ async function promptAvailableProjectId() {
172
172
  exports.promptAvailableProjectId = promptAvailableProjectId;
173
173
  async function createCloudProject(projectId, options) {
174
174
  try {
175
- const response = await api.request("POST", "/v1/projects", {
176
- auth: true,
177
- origin: api.resourceManagerOrigin,
175
+ const client = new apiv2_1.Client({ urlPrefix: api.resourceManagerOrigin, apiVersion: "v1" });
176
+ const data = {
177
+ projectId,
178
+ name: options.displayName || projectId,
179
+ parent: options.parentResource,
180
+ };
181
+ const response = await client.request({
182
+ method: "POST",
183
+ path: "/projects",
184
+ body: data,
178
185
  timeout: CREATE_PROJECT_API_REQUEST_TIMEOUT_MILLIS,
179
- data: { projectId, name: options.displayName || projectId, parent: options.parentResource },
180
186
  });
181
187
  const projectInfo = await (0, operation_poller_1.pollOperation)({
182
188
  pollerName: "Project Creation Poller",
@@ -204,9 +210,9 @@ async function createCloudProject(projectId, options) {
204
210
  exports.createCloudProject = createCloudProject;
205
211
  async function addFirebaseToCloudProject(projectId) {
206
212
  try {
207
- const response = await api.request("POST", `/v1beta1/projects/${projectId}:addFirebase`, {
208
- auth: true,
209
- origin: api.firebaseApiOrigin,
213
+ const response = await firebaseAPIClient.request({
214
+ method: "POST",
215
+ path: `/projects/${projectId}:addFirebase`,
210
216
  timeout: CREATE_PROJECT_API_REQUEST_TIMEOUT_MILLIS,
211
217
  });
212
218
  const projectInfo = await (0, operation_poller_1.pollOperation)({
package/lib/rtdb.js CHANGED
@@ -1,33 +1,35 @@
1
1
  "use strict";
2
- var api = require("./api");
3
- var { FirebaseError } = require("./error");
4
- var utils = require("./utils");
5
- const { populateInstanceDetails } = require("./management/database");
6
- const { realtimeOriginOrCustomUrl } = require("./database/api");
7
- exports.updateRules = function (projectId, instance, src, options) {
8
- options = options || {};
9
- var path = ".settings/rules.json";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.updateRules = void 0;
4
+ const apiv2_1 = require("./apiv2");
5
+ const database_1 = require("./management/database");
6
+ const error_1 = require("./error");
7
+ const api_1 = require("./database/api");
8
+ const utils = require("./utils");
9
+ async function updateRules(projectId, instance, src, options = {}) {
10
+ const queryParams = {};
10
11
  if (options.dryRun) {
11
- path += "?dryRun=true";
12
+ queryParams.dryRun = "true";
12
13
  }
13
- var downstreamOptions = { instance: instance, project: projectId };
14
- return populateInstanceDetails(downstreamOptions)
15
- .then(function () {
16
- const origin = utils.getDatabaseUrl(realtimeOriginOrCustomUrl(downstreamOptions.instanceDetails.databaseUrl), instance, "");
17
- return api.request("PUT", path, {
18
- origin: origin,
19
- auth: true,
20
- data: src,
21
- json: false,
22
- resolveOnHTTPError: true,
23
- });
24
- })
25
- .then(function (response) {
26
- if (response.status === 400) {
27
- throw new FirebaseError("Syntax error in database rules:\n\n" + JSON.parse(response.body).error);
28
- }
29
- else if (response.status > 400) {
30
- throw new FirebaseError("Unexpected error while deploying database rules.", { exit: 2 });
31
- }
14
+ const downstreamOptions = { instance: instance, project: projectId };
15
+ await (0, database_1.populateInstanceDetails)(downstreamOptions);
16
+ if (!downstreamOptions.instanceDetails) {
17
+ throw new error_1.FirebaseError(`Could not get instance details`, { exit: 2 });
18
+ }
19
+ const origin = utils.getDatabaseUrl((0, api_1.realtimeOriginOrCustomUrl)(downstreamOptions.instanceDetails.databaseUrl), instance, "");
20
+ const client = new apiv2_1.Client({ urlPrefix: origin });
21
+ const response = await client.request({
22
+ method: "PUT",
23
+ path: ".settings/rules.json",
24
+ queryParams,
25
+ body: src,
26
+ resolveOnHTTPError: true,
32
27
  });
33
- };
28
+ if (response.status === 400) {
29
+ throw new error_1.FirebaseError(`Syntax error in database rules:\n\n${response.body.error}`);
30
+ }
31
+ else if (response.status > 400) {
32
+ throw new error_1.FirebaseError("Unexpected error while deploying database rules.", { exit: 2 });
33
+ }
34
+ }
35
+ exports.updateRules = updateRules;