firebase-tools 11.29.1 → 12.0.0

package/lib/extensions/extensionsApi.js

@@ -1,20 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExtension = exports.deleteExtension = exports.unpublishExtension = exports.publishExtensionVersion = exports.undeprecateExtensionVersion = exports.deprecateExtensionVersion = exports.registerPublisherProfile = exports.getPublisherProfile = exports.listExtensionVersions = exports.listExtensions = exports.getExtensionVersion = exports.getSource = exports.createSource = exports.updateInstanceFromRegistry = exports.updateInstance = exports.configureInstance = exports.listInstances = exports.getInstance = exports.deleteInstance = exports.createInstance = void 0;
+exports.refNotFoundError = exports.getExtension = exports.listExtensionVersions = exports.listExtensions = exports.getExtensionVersion = exports.getSource = exports.createSource = exports.populateSpec = exports.updateInstanceFromRegistry = exports.updateInstance = exports.configureInstance = exports.listInstances = exports.getInstance = exports.deleteInstance = exports.createInstance = void 0;
 const yaml = require("js-yaml");
 const clc = require("colorette");
-const marked_1 = require("marked");
 const apiv2_1 = require("../apiv2");
 const api_1 = require("../api");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
 const operationPoller = require("../operation-poller");
 const refs = require("./refs");
-const VERSION = "v1beta";
+const EXTENSIONS_API_VERSION = "v1beta";
 const PAGE_SIZE_MAX = 100;
-const apiClient = new apiv2_1.Client({ urlPrefix: api_1.extensionsOrigin, apiVersion: VERSION });
+const extensionsApiClient = new apiv2_1.Client({
+    urlPrefix: api_1.extensionsOrigin,
+    apiVersion: EXTENSIONS_API_VERSION,
+});
 async function createInstanceHelper(projectId, instanceId, config, validateOnly = false) {
-    const createRes = await apiClient.post(`/projects/${projectId}/instances/`, {
+    const createRes = await extensionsApiClient.post(`/projects/${projectId}/instances/`, {
         name: `projects/${projectId}/instances/${instanceId}`,
         config,
     }, {
@@ -27,7 +29,7 @@ async function createInstanceHelper(projectId, instanceId, config, validateOnly
     }
     const pollRes = await operationPoller.pollOperation({
         apiOrigin: api_1.extensionsOrigin,
-        apiVersion: VERSION,
+        apiVersion: EXTENSIONS_API_VERSION,
         operationResourceName: createRes.body.name,
         masterTimeout: 600000,
     });
@@ -65,10 +67,10 @@ async function createInstance(args) {
 }
 exports.createInstance = createInstance;
 async function deleteInstance(projectId, instanceId) {
-    const deleteRes = await apiClient.delete(`/projects/${projectId}/instances/${instanceId}`);
+    const deleteRes = await extensionsApiClient.delete(`/projects/${projectId}/instances/${instanceId}`);
     const pollRes = await operationPoller.pollOperation({
         apiOrigin: api_1.extensionsOrigin,
-        apiVersion: VERSION,
+        apiVersion: EXTENSIONS_API_VERSION,
         operationResourceName: deleteRes.body.name,
         masterTimeout: 600000,
     });
@@ -77,7 +79,7 @@ async function deleteInstance(projectId, instanceId) {
 exports.deleteInstance = deleteInstance;
 async function getInstance(projectId, instanceId) {
     try {
-        const res = await apiClient.get(`/projects/${projectId}/instances/${instanceId}`);
+        const res = await extensionsApiClient.get(`/projects/${projectId}/instances/${instanceId}`);
         return res.body;
     }
     catch (err) {
@@ -91,7 +93,7 @@ exports.getInstance = getInstance;
 async function listInstances(projectId) {
     const instances = [];
     const getNextPage = async (pageToken = "") => {
-        const res = await apiClient.get(`/projects/${projectId}/instances`, {
+        const res = await extensionsApiClient.get(`/projects/${projectId}/instances`, {
             queryParams: {
                 pageSize: PAGE_SIZE_MAX,
                 pageToken,
@@ -205,7 +207,7 @@ async function updateInstanceFromRegistry(args) {
 }
 exports.updateInstanceFromRegistry = updateInstanceFromRegistry;
 async function patchInstance(args) {
-    const updateRes = await apiClient.patch(`/projects/${args.projectId}/instances/${args.instanceId}`, args.data, {
+    const updateRes = await extensionsApiClient.patch(`/projects/${args.projectId}/instances/${args.instanceId}`, args.data, {
         queryParams: {
             updateMask: args.updateMask,
             validateOnly: args.validateOnly ? "true" : "false",
@@ -216,7 +218,7 @@ async function patchInstance(args) {
     }
     const pollRes = await operationPoller.pollOperation({
         apiOrigin: api_1.extensionsOrigin,
-        apiVersion: VERSION,
+        apiVersion: EXTENSIONS_API_VERSION,
         operationResourceName: updateRes.body.name,
         masterTimeout: 600000,
     });
@@ -239,14 +241,15 @@ function populateSpec(spec) {
         spec.systemParams = (_b = spec.systemParams) !== null && _b !== void 0 ? _b : [];
     }
 }
+exports.populateSpec = populateSpec;
 async function createSource(projectId, packageUri, extensionRoot) {
-    const createRes = await apiClient.post(`/projects/${projectId}/sources/`, {
+    const createRes = await extensionsApiClient.post(`/projects/${projectId}/sources/`, {
         packageUri,
         extensionRoot,
     });
     const pollRes = await operationPoller.pollOperation({
         apiOrigin: api_1.extensionsOrigin,
-        apiVersion: VERSION,
+        apiVersion: EXTENSIONS_API_VERSION,
         operationResourceName: createRes.body.name,
         masterTimeout: 600000,
     });
@@ -257,7 +260,7 @@ async function createSource(projectId, packageUri, extensionRoot) {
 }
 exports.createSource = createSource;
 async function getSource(sourceName) {
-    const res = await apiClient.get(`/${sourceName}`);
+    const res = await extensionsApiClient.get(`/${sourceName}`);
     if (res.body.spec) {
         populateSpec(res.body.spec);
     }
@@ -270,7 +273,7 @@ async function getExtensionVersion(extensionVersionRef) {
         throw new error_1.FirebaseError(`ExtensionVersion ref "${extensionVersionRef}" must supply a version.`);
     }
     try {
-        const res = await apiClient.get(`/${refs.toExtensionVersionName(ref)}`);
+        const res = await extensionsApiClient.get(`/${refs.toExtensionVersionName(ref)}`);
         if (res.body.spec) {
             populateSpec(res.body.spec);
         }
@@ -290,7 +293,7 @@ exports.getExtensionVersion = getExtensionVersion;
 async function listExtensions(publisherId) {
     const extensions = [];
     const getNextPage = async (pageToken = "") => {
-        const res = await apiClient.get(`/publishers/${publisherId}/extensions`, {
+        const res = await extensionsApiClient.get(`/publishers/${publisherId}/extensions`, {
             queryParams: {
                 pageSize: PAGE_SIZE_MAX,
                 pageToken,
@@ -311,7 +314,7 @@ async function listExtensionVersions(ref, filter = "", showPrereleases = false)
     const { publisherId, extensionId } = refs.parse(ref);
     const extensionVersions = [];
     const getNextPage = async (pageToken = "") => {
-        const res = await apiClient.get(`/publishers/${publisherId}/extensions/${extensionId}/versions`, {
+        const res = await extensionsApiClient.get(`/publishers/${publisherId}/extensions/${extensionId}/versions`, {
             queryParams: {
                 filter,
                 showPrereleases: String(showPrereleases),
@@ -330,141 +333,10 @@ async function listExtensionVersions(ref, filter = "", showPrereleases = false)
     return extensionVersions;
 }
 exports.listExtensionVersions = listExtensionVersions;
-async function getPublisherProfile(projectId, publisherId) {
-    const res = await apiClient.get(`/projects/${projectId}/publisherProfile`, {
-        queryParams: publisherId === undefined
-            ? undefined
-            : {
-                publisherId,
-            },
-    });
-    return res.body;
-}
-exports.getPublisherProfile = getPublisherProfile;
-async function registerPublisherProfile(projectId, publisherId) {
-    const res = await apiClient.post(`/projects/${projectId}/publisherProfile:register`, {
-        publisherId,
-    });
-    return res.body;
-}
-exports.registerPublisherProfile = registerPublisherProfile;
-async function deprecateExtensionVersion(extensionRef, deprecationMessage) {
-    const ref = refs.parse(extensionRef);
-    try {
-        const res = await apiClient.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 apiClient.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 publishExtensionVersion(args) {
-    var _a, _b, _c, _d;
-    const ref = refs.parse(args.extensionVersionRef);
-    if (!ref.version) {
-        throw new error_1.FirebaseError(`ExtensionVersion ref "${args.extensionVersionRef}" must supply a version.`);
-    }
-    const publishRes = await apiClient.post(`/${refs.toExtensionName(ref)}/versions:publish`, {
-        versionId: ref.version,
-        packageUri: (_a = args.packageUri) !== null && _a !== void 0 ? _a : "",
-        extensionRoot: (_b = args.extensionRoot) !== null && _b !== void 0 ? _b : "/",
-        repoUri: (_c = args.repoUri) !== null && _c !== void 0 ? _c : "",
-        sourceRef: (_d = args.sourceRef) !== null && _d !== void 0 ? _d : "",
-    });
-    const pollRes = await operationPoller.pollOperation({
-        apiOrigin: api_1.extensionsOrigin,
-        apiVersion: VERSION,
-        operationResourceName: publishRes.body.name,
-        masterTimeout: 600000,
-    });
-    return pollRes;
-}
-exports.publishExtensionVersion = publishExtensionVersion;
-async function unpublishExtension(extensionRef) {
-    const ref = refs.parse(extensionRef);
-    if (ref.version) {
-        throw new error_1.FirebaseError(`Extension reference "${extensionRef}" must not contain a version.`);
-    }
-    try {
-        await apiClient.post(`/${refs.toExtensionName(ref)}:unpublish`);
-    }
-    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 unpublish this extension.`, { status: err.status });
-        }
-        else if (err instanceof error_1.FirebaseError) {
-            throw err;
-        }
-        throw new error_1.FirebaseError(`Error occurred unpublishing extension '${extensionRef}': ${err}`, {
-            status: err.status,
-        });
-    }
-}
-exports.unpublishExtension = unpublishExtension;
-async function deleteExtension(extensionRef) {
-    const ref = refs.parse(extensionRef);
-    if (ref.version) {
-        throw new error_1.FirebaseError(`Extension reference "${extensionRef}" must not contain a version.`);
-    }
-    try {
-        await apiClient.delete(`/${refs.toExtensionName(ref)}`);
-    }
-    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 delete this extension.`, { status: err.status });
-        }
-        else if (err.status === 404) {
-            throw new error_1.FirebaseError(`Extension ${clc.bold(extensionRef)} was not found.`);
-        }
-        else if (err instanceof error_1.FirebaseError) {
-            throw err;
-        }
-        throw new error_1.FirebaseError(`Error occurred delete extension '${extensionRef}': ${err}`, {
-            status: err.status,
-        });
-    }
-}
-exports.deleteExtension = deleteExtension;
 async function getExtension(extensionRef) {
     const ref = refs.parse(extensionRef);
     try {
-        const res = await apiClient.get(`/${refs.toExtensionName(ref)}`);
+        const res = await extensionsApiClient.get(`/${refs.toExtensionName(ref)}`);
         return res.body;
     }
     catch (err) {
@@ -484,5 +356,6 @@ function refNotFoundError(ref) {
     return new error_1.FirebaseError(`The extension reference '${clc.bold(ref.version ? refs.toExtensionVersionRef(ref) : refs.toExtensionRef(ref))}' doesn't exist. This could happen for two reasons:\n` +
         `  -The publisher ID '${clc.bold(ref.publisherId)}' doesn't exist or could be misspelled\n` +
         `  -The name of the ${ref.version ? "extension version" : "extension"} '${clc.bold(ref.version ? `${ref.extensionId}@${ref.version}` : ref.extensionId)}' doesn't exist or could be misspelled\n\n` +
-        `Please correct the extension reference and try again. If you meant to install an extension from a local source, please provide a relative path prefixed with '${clc.bold("./")}', '${clc.bold("../")}', or '${clc.bold("~/")}'. Learn more about local extension installation at ${(0, marked_1.marked)("[https://firebase.google.com/docs/extensions/alpha/install-extensions_community#install](https://firebase.google.com/docs/extensions/alpha/install-extensions_community#install).")}`, { status: 404 });
+        `Please correct the extension reference and try again. If you meant to install an extension from a local source, please provide a relative path prefixed with '${clc.bold("./")}', '${clc.bold("../")}', or '${clc.bold("~/")}'.}`, { status: 404 });
 }
+exports.refNotFoundError = refNotFoundError;