firebase-tools 11.30.0 → 12.0.1

package/lib/extensions/publisherApi.js

@@ -0,0 +1,215 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExtension = exports.listExtensionVersions = exports.listExtensions = exports.getExtensionVersion = exports.createExtensionVersionFromGitHubSource = exports.createExtensionVersionFromLocalSource = exports.undeprecateExtensionVersion = exports.deprecateExtensionVersion = exports.registerPublisherProfile = exports.getPublisherProfile = void 0;
+const clc = require("colorette");
+const operationPoller = require("../operation-poller");
+const refs = require("./refs");
+const api_1 = require("../api");
+const apiv2_1 = require("../apiv2");
+const error_1 = require("../error");
+const extensionsApi_1 = require("./extensionsApi");
+const PUBLISHER_API_VERSION = "v1beta";
+const PAGE_SIZE_MAX = 100;
+const extensionsPublisherApiClient = new apiv2_1.Client({
+    urlPrefix: api_1.extensionsPublisherOrigin,
+    apiVersion: PUBLISHER_API_VERSION,
+});
+async function getPublisherProfile(projectId, publisherId) {
+    const res = await extensionsPublisherApiClient.get(`/projects/${projectId}/publisherProfile`, {
+        queryParams: publisherId === undefined
+            ? undefined
+            : {
+                publisherId,
+            },
+    });
+    return res.body;
+}
+exports.getPublisherProfile = getPublisherProfile;
+async function registerPublisherProfile(projectId, publisherId) {
+    const res = await extensionsPublisherApiClient.patch(`/projects/${projectId}/publisherProfile`, {
+        publisherId,
+        displayName: publisherId,
+    }, {
+        queryParams: {
+            updateMask: "publisher_id,display_name",
+        },
+    });
+    return res.body;
+}
+exports.registerPublisherProfile = registerPublisherProfile;
+async function deprecateExtensionVersion(extensionRef, deprecationMessage) {
+    const ref = refs.parse(extensionRef);
+    try {
+        const res = await extensionsPublisherApiClient.post(`/${refs.toExtensionVersionName(ref)}:deprecate`, {
+            deprecationMessage,
+        });
+        return res.body;
+    }
+    catch (err) {
+        if (err.status === 403) {
+            throw new error_1.FirebaseError(`You are not the owner of extension '${clc.bold(extensionRef)}' and don’t have the correct permissions to deprecate this extension version.` + err, { status: err.status });
+        }
+        else if (err.status === 404) {
+            throw new error_1.FirebaseError(`Extension version ${clc.bold(extensionRef)} was not found.`);
+        }
+        else if (err instanceof error_1.FirebaseError) {
+            throw err;
+        }
+        throw new error_1.FirebaseError(`Error occurred deprecating extension version '${extensionRef}': ${err}`, {
+            status: err.status,
+        });
+    }
+}
+exports.deprecateExtensionVersion = deprecateExtensionVersion;
+async function undeprecateExtensionVersion(extensionRef) {
+    const ref = refs.parse(extensionRef);
+    try {
+        const res = await extensionsPublisherApiClient.post(`/${refs.toExtensionVersionName(ref)}:undeprecate`);
+        return res.body;
+    }
+    catch (err) {
+        if (err.status === 403) {
+            throw new error_1.FirebaseError(`You are not the owner of extension '${clc.bold(extensionRef)}' and don’t have the correct permissions to undeprecate this extension version.`, { status: err.status });
+        }
+        else if (err.status === 404) {
+            throw new error_1.FirebaseError(`Extension version ${clc.bold(extensionRef)} was not found.`);
+        }
+        else if (err instanceof error_1.FirebaseError) {
+            throw err;
+        }
+        throw new error_1.FirebaseError(`Error occurred undeprecating extension version '${extensionRef}': ${err}`, {
+            status: err.status,
+        });
+    }
+}
+exports.undeprecateExtensionVersion = undeprecateExtensionVersion;
+async function createExtensionVersionFromLocalSource(args) {
+    var _a;
+    const ref = refs.parse(args.extensionVersionRef);
+    if (!ref.version) {
+        throw new error_1.FirebaseError(`Extension version ref "${args.extensionVersionRef}" must supply a version.`);
+    }
+    const uploadRes = await extensionsPublisherApiClient.post(`/${refs.toExtensionName(ref)}/versions:createFromSource`, {
+        versionId: ref.version,
+        extensionRoot: (_a = args.extensionRoot) !== null && _a !== void 0 ? _a : "/",
+        remoteArchiveSource: {
+            packageUri: args.packageUri,
+        },
+    });
+    const pollRes = await operationPoller.pollOperation({
+        apiOrigin: api_1.extensionsPublisherOrigin,
+        apiVersion: PUBLISHER_API_VERSION,
+        operationResourceName: uploadRes.body.name,
+        masterTimeout: 600000,
+    });
+    return pollRes;
+}
+exports.createExtensionVersionFromLocalSource = createExtensionVersionFromLocalSource;
+async function createExtensionVersionFromGitHubSource(args) {
+    var _a;
+    const ref = refs.parse(args.extensionVersionRef);
+    if (!ref.version) {
+        throw new error_1.FirebaseError(`Extension version ref "${args.extensionVersionRef}" must supply a version.`);
+    }
+    const uploadRes = await extensionsPublisherApiClient.post(`/${refs.toExtensionName(ref)}/versions:createFromSource`, {
+        versionId: ref.version,
+        extensionRoot: (_a = args.extensionRoot) !== null && _a !== void 0 ? _a : "/",
+        githubRepositorySource: {
+            uri: args.repoUri,
+            sourceRef: args.sourceRef,
+        },
+    });
+    const pollRes = await operationPoller.pollOperation({
+        apiOrigin: api_1.extensionsPublisherOrigin,
+        apiVersion: PUBLISHER_API_VERSION,
+        operationResourceName: uploadRes.body.name,
+        masterTimeout: 600000,
+    });
+    return pollRes;
+}
+exports.createExtensionVersionFromGitHubSource = createExtensionVersionFromGitHubSource;
+async function getExtensionVersion(extensionVersionRef) {
+    const ref = refs.parse(extensionVersionRef);
+    if (!ref.version) {
+        throw new error_1.FirebaseError(`ExtensionVersion ref "${extensionVersionRef}" must supply a version.`);
+    }
+    try {
+        const res = await extensionsPublisherApiClient.get(`/${refs.toExtensionVersionName(ref)}`);
+        if (res.body.spec) {
+            (0, extensionsApi_1.populateSpec)(res.body.spec);
+        }
+        return res.body;
+    }
+    catch (err) {
+        if (err.status === 404) {
+            throw (0, extensionsApi_1.refNotFoundError)(ref);
+        }
+        else if (err instanceof error_1.FirebaseError) {
+            throw err;
+        }
+        throw new error_1.FirebaseError(`Failed to query the extension version '${clc.bold(extensionVersionRef)}': ${err}`);
+    }
+}
+exports.getExtensionVersion = getExtensionVersion;
+async function listExtensions(publisherId) {
+    const extensions = [];
+    const getNextPage = async (pageToken = "") => {
+        const res = await extensionsPublisherApiClient.get(`/publishers/${publisherId}/extensions`, {
+            queryParams: {
+                pageSize: PAGE_SIZE_MAX,
+                pageToken,
+            },
+        });
+        if (Array.isArray(res.body.extensions)) {
+            extensions.push(...res.body.extensions);
+        }
+        if (res.body.nextPageToken) {
+            await getNextPage(res.body.nextPageToken);
+        }
+    };
+    await getNextPage();
+    return extensions;
+}
+exports.listExtensions = listExtensions;
+async function listExtensionVersions(ref, filter = "", showPrereleases = false) {
+    const { publisherId, extensionId } = refs.parse(ref);
+    const extensionVersions = [];
+    const getNextPage = async (pageToken = "") => {
+        const res = await extensionsPublisherApiClient.get(`/publishers/${publisherId}/extensions/${extensionId}/versions`, {
+            queryParams: {
+                filter,
+                showPrereleases: String(showPrereleases),
+                pageSize: PAGE_SIZE_MAX,
+                pageToken,
+            },
+        });
+        if (Array.isArray(res.body.extensionVersions)) {
+            extensionVersions.push(...res.body.extensionVersions);
+        }
+        if (res.body.nextPageToken) {
+            await getNextPage(res.body.nextPageToken);
+        }
+    };
+    await getNextPage();
+    return extensionVersions;
+}
+exports.listExtensionVersions = listExtensionVersions;
+async function getExtension(extensionRef) {
+    const ref = refs.parse(extensionRef);
+    try {
+        const res = await extensionsPublisherApiClient.get(`/${refs.toExtensionName(ref)}`);
+        return res.body;
+    }
+    catch (err) {
+        if (err.status === 404) {
+            throw (0, extensionsApi_1.refNotFoundError)(ref);
+        }
+        else if (err instanceof error_1.FirebaseError) {
+            throw err;
+        }
+        throw new error_1.FirebaseError(`Failed to query the extension '${clc.bold(extensionRef)}': ${err}`, {
+            status: err.status,
+        });
+    }
+}
+exports.getExtension = getExtension;

package/lib/extensions/refs.js

@@ -12,7 +12,7 @@ function parse(refOrName) {
     if (ret.version &&
         !semver.valid(ret.version) &&
         !semver.validRange(ret.version) &&
-        ret.version !== "latest") {
+        !["latest", "latest-approved"].includes(ret.version)) {
         throw new error_1.FirebaseError(`Extension reference ${ret} contains an invalid version ${ret.version}.`);
     }
     return ret;

package/lib/extensions/resolveSource.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTrustedPublishers = exports.getExtensionRegistry = void 0;
-const logger_1 = require("../logger");
+exports.getExtensionRegistry = void 0;
 const apiv2_1 = require("../apiv2");
 const api_1 = require("../api");
 const EXTENSIONS_REGISTRY_ENDPOINT = "/extensions.json";
@@ -23,19 +22,3 @@ async function getExtensionRegistry(onlyFeatured = false) {
     return extensions;
 }
 exports.getExtensionRegistry = getExtensionRegistry;
-async function getTrustedPublishers() {
-    let registry;
-    try {
-        registry = await getExtensionRegistry();
-    }
-    catch (err) {
-        logger_1.logger.debug("Couldn't get extensions registry, assuming no trusted publishers except Firebase.");
-        return ["firebase"];
-    }
-    const publisherIds = new Set();
-    for (const entry in registry) {
-        publisherIds.add(registry[entry].publisher);
-    }
-    return Array.from(publisherIds);
-}
-exports.getTrustedPublishers = getTrustedPublishers;

package/lib/extensions/tos.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayDeveloperTOSWarning = exports.acceptLatestAppDeveloperTOS = exports.acceptLatestPublisherTOS = exports.acceptPublisherTOS = exports.getPublisherTOSStatus = exports.acceptAppDeveloperTOS = exports.getAppDeveloperTOSStatus = void 0;
+const apiv2_1 = require("../apiv2");
+const api_1 = require("../api");
+const logger_1 = require("../logger");
+const prompt_1 = require("../prompt");
+const error_1 = require("../error");
+const extensionsHelper_1 = require("./extensionsHelper");
+const utils = require("../utils");
+const VERSION = "v1";
+const extensionsTosUrl = (tos) => `https://firebase.google.com/terms/extensions/${tos}`;
+const apiClient = new apiv2_1.Client({ urlPrefix: api_1.extensionsTOSOrigin, apiVersion: VERSION });
+async function getAppDeveloperTOSStatus(projectId) {
+    const res = await apiClient.get(`/projects/${projectId}/appdevtos`);
+    return res.body;
+}
+exports.getAppDeveloperTOSStatus = getAppDeveloperTOSStatus;
+async function acceptAppDeveloperTOS(projectId, tosVersion, instanceId = "") {
+    const res = await apiClient.post(`/projects/${projectId}/appdevtos:accept`, {
+        name: `project/${projectId}/appdevtos`,
+        instanceId,
+        version: tosVersion,
+    });
+    return res.body;
+}
+exports.acceptAppDeveloperTOS = acceptAppDeveloperTOS;
+async function getPublisherTOSStatus(projectId) {
+    const res = await apiClient.get(`/projects/${projectId}/publishertos`);
+    return res.body;
+}
+exports.getPublisherTOSStatus = getPublisherTOSStatus;
+async function acceptPublisherTOS(projectId, tosVersion) {
+    const res = await apiClient.post(`/projects/${projectId}/publishertos:accept`, {
+        name: `project/${projectId}/publishertos`,
+        version: tosVersion,
+    });
+    return res.body;
+}
+exports.acceptPublisherTOS = acceptPublisherTOS;
+async function acceptLatestPublisherTOS(options, projectId) {
+    logger_1.logger.debug(`Checking if latest publisher TOS has been accepted by ${projectId}...`);
+    const currentAcceptance = await getPublisherTOSStatus(projectId);
+    if (currentAcceptance.lastAcceptedVersion) {
+        logger_1.logger.debug(`Already accepted version ${currentAcceptance.lastAcceptedVersion} of Extensions publisher TOS.`);
+        return currentAcceptance;
+    }
+    else {
+        const tosLink = extensionsTosUrl("publisher");
+        logger_1.logger.info(`To continue, you must accept the Firebase Extensions Publisher Terms of Service: ${tosLink}`);
+        if (await (0, prompt_1.confirm)(Object.assign(Object.assign({}, options), { message: "Do you accept the Firebase Extensions Publisher Terms of Service?" }))) {
+            return acceptPublisherTOS(projectId, currentAcceptance.latestTosVersion);
+        }
+        throw new error_1.FirebaseError("You must accept the terms of service to continue.");
+    }
+}
+exports.acceptLatestPublisherTOS = acceptLatestPublisherTOS;
+async function acceptLatestAppDeveloperTOS(options, projectId, instanceIds) {
+    logger_1.logger.debug(`Checking if latest AppDeveloper TOS has been accepted by ${projectId}...`);
+    displayDeveloperTOSWarning();
+    const currentAcceptance = await getAppDeveloperTOSStatus(projectId);
+    if (currentAcceptance.lastAcceptedVersion) {
+        logger_1.logger.debug(`User Terms of Service aready accepted on project ${projectId}.`);
+    }
+    else if (!(await (0, prompt_1.confirm)(Object.assign(Object.assign({}, options), { message: "Do you accept the Firebase Extensions User Terms of Service?" })))) {
+        throw new error_1.FirebaseError("You must accept the terms of service to continue.");
+    }
+    const tosPromises = instanceIds.map((instanceId) => {
+        return acceptAppDeveloperTOS(projectId, currentAcceptance.latestTosVersion, instanceId);
+    });
+    return Promise.all(tosPromises);
+}
+exports.acceptLatestAppDeveloperTOS = acceptLatestAppDeveloperTOS;
+function displayDeveloperTOSWarning() {
+    const tosLink = extensionsTosUrl("user");
+    utils.logLabeledBullet(extensionsHelper_1.logPrefix, `By installing an extension instance onto a Firebase project, you accept the Firebase Extensions User Terms of Service: ${tosLink}`);
+}
+exports.displayDeveloperTOSWarning = displayDeveloperTOSWarning;

package/lib/extensions/warnings.js

@@ -1,59 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.outOfBandChangesWarning = exports.displayWarningsForDeploy = exports.displayWarningPrompts = void 0;
-const marked_1 = require("marked");
+exports.outOfBandChangesWarning = exports.displayWarningsForDeploy = void 0;
 const clc = require("colorette");
-const displayExtensionInfo_1 = require("./displayExtensionInfo");
+const TerminalRenderer = require("marked-terminal");
+const marked_1 = require("marked");
+marked_1.marked.setOptions({
+    renderer: new TerminalRenderer(),
+});
 const extensionsHelper_1 = require("./extensionsHelper");
-const resolveSource_1 = require("./resolveSource");
 const deploymentSummary_1 = require("../deploy/extensions/deploymentSummary");
 const planner_1 = require("../deploy/extensions/planner");
-const utils = require("../utils");
 const logger_1 = require("../logger");
-function displayEAPWarning({ publisherId, sourceDownloadUri, githubLink, }) {
-    const publisherNameLink = githubLink ? `[${publisherId}](${githubLink})` : publisherId;
-    const warningMsg = `This extension is in preview and is built by a developer in the [Extensions Publisher Early Access Program](http://bit.ly/firex-provider). Its functionality might change in backward-incompatible ways. Since this extension isn't built by Firebase, reach out to ${publisherNameLink} with questions about this extension.`;
-    const legalMsg = "\n\nIt is provided “AS IS”, without any warranty, express or implied, from Google. Google disclaims all liability for any damages, direct or indirect, resulting from the use of the extension, and its functionality might change in backward - incompatible ways.";
-    utils.logLabeledBullet(extensionsHelper_1.logPrefix, (0, marked_1.marked)(warningMsg + legalMsg));
-    (0, displayExtensionInfo_1.printSourceDownloadLink)(sourceDownloadUri);
-}
-async function displayWarningPrompts(publisherId, extensionVersion) {
-    const trustedPublishers = await (0, resolveSource_1.getTrustedPublishers)();
-    if (!trustedPublishers.includes(publisherId)) {
-        displayEAPWarning({
-            publisherId,
-            sourceDownloadUri: extensionVersion.sourceDownloadUri,
-            githubLink: extensionVersion.spec.sourceUrl,
-        });
-    }
-    else {
-        return;
-    }
-}
-exports.displayWarningPrompts = displayWarningPrompts;
+const utils = require("../utils");
 const toListEntry = (i) => {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f;
     const idAndRef = (0, deploymentSummary_1.humanReadable)(i);
-    const sourceCodeLink = `\n\t[Source Code](${(_a = i.extensionVersion) === null || _a === void 0 ? void 0 : _a.sourceDownloadUri})`;
-    const githubLink = ((_c = (_b = i.extensionVersion) === null || _b === void 0 ? void 0 : _b.spec) === null || _c === void 0 ? void 0 : _c.sourceUrl)
-        ? `\n\t[Publisher Contact](${(_d = i.extensionVersion) === null || _d === void 0 ? void 0 : _d.spec.sourceUrl})`
+    const sourceCodeLink = `\n\t[Source Code](${(_b = (_a = i.extensionVersion) === null || _a === void 0 ? void 0 : _a.buildSourceUri) !== null && _b !== void 0 ? _b : (_c = i.extensionVersion) === null || _c === void 0 ? void 0 : _c.sourceDownloadUri})`;
+    const githubLink = ((_e = (_d = i.extensionVersion) === null || _d === void 0 ? void 0 : _d.spec) === null || _e === void 0 ? void 0 : _e.sourceUrl)
+        ? `\n\t[Publisher Contact](${(_f = i.extensionVersion) === null || _f === void 0 ? void 0 : _f.spec.sourceUrl})`
         : "";
     return `${idAndRef}${sourceCodeLink}${githubLink}`;
 };
 async function displayWarningsForDeploy(instancesToCreate) {
-    const trustedPublishers = await (0, resolveSource_1.getTrustedPublishers)();
-    const publishedExtensionInstances = instancesToCreate.filter((i) => i.ref);
-    for (const i of publishedExtensionInstances) {
-        await (0, planner_1.getExtension)(i);
+    const uploadedExtensionInstances = instancesToCreate.filter((i) => i.ref);
+    for (const i of uploadedExtensionInstances) {
+        await (0, planner_1.getExtensionVersion)(i);
     }
-    const eapExtensions = publishedExtensionInstances.filter((i) => { var _a, _b; return !trustedPublishers.includes((_b = (_a = i.ref) === null || _a === void 0 ? void 0 : _a.publisherId) !== null && _b !== void 0 ? _b : ""); });
-    if (eapExtensions.length) {
-        const humanReadableList = eapExtensions.map(toListEntry).join("\n");
-        utils.logLabeledBullet(extensionsHelper_1.logPrefix, (0, marked_1.marked)(`These extensions are in preview and are built by a developer in the Extensions Publisher Early Access Program (http://bit.ly/firex-provider). Their functionality might change in backwards-incompatible ways. Since these extensions aren't built by Firebase, reach out to their publisher with questions about them.` +
-            ` They are provided “AS IS”, without any warranty, express or implied, from Google.` +
-            ` Google disclaims all liability for any damages, direct or indirect, resulting from the use of these extensions\n${humanReadableList}`, { gfm: false }));
+    const unpublishedExtensions = uploadedExtensionInstances.filter((i) => { var _a, _b; return ((_b = (_a = i.extensionVersion) === null || _a === void 0 ? void 0 : _a.listing) === null || _b === void 0 ? void 0 : _b.state) !== "APPROVED"; });
+    if (unpublishedExtensions.length) {
+        const humanReadableList = unpublishedExtensions.map(toListEntry).join("\n");
+        utils.logLabeledBullet(extensionsHelper_1.logPrefix, (0, marked_1.marked)(`The following extension versions have not been published to the Firebase Extensions Hub:\n${humanReadableList}\n.` +
+            "Unpublished extensions have not been reviewed by " +
+            "Firebase. Please make sure you trust the extension publisher before installing this extension.", { gfm: false }));
     }
-    return eapExtensions.length > 0;
+    return unpublishedExtensions.length > 0;
 }
 exports.displayWarningsForDeploy = displayWarningsForDeploy;
 function outOfBandChangesWarning(instanceIds) {