firebase-admin 10.1.0 → 11.0.0

package/lib/machine-learning/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -16,14 +16,14 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMachineLearning = void 0;
+exports.getMachineLearning = exports.Model = exports.MachineLearning = void 0;
 /**
  * Firebase Machine Learning.
  *
  * @packageDocumentation
  */
-var app_1 = require("../app");
-var machine_learning_1 = require("./machine-learning");
+const app_1 = require("../app");
+const machine_learning_1 = require("./machine-learning");
 var machine_learning_2 = require("./machine-learning");
 Object.defineProperty(exports, "MachineLearning", { enumerable: true, get: function () { return machine_learning_2.MachineLearning; } });
 Object.defineProperty(exports, "Model", { enumerable: true, get: function () { return machine_learning_2.Model; } });
@@ -55,9 +55,9 @@ Object.defineProperty(exports, "Model", { enumerable: true, get: function () { r
  */
 function getMachineLearning(app) {
     if (typeof app === 'undefined') {
-        app = app_1.getApp();
+        app = (0, app_1.getApp)();
     }
-    var firebaseApp = app;
-    return firebaseApp.getOrInitService('machineLearning', function (app) { return new machine_learning_1.MachineLearning(app); });
+    const firebaseApp = app;
+    return firebaseApp.getOrInitService('machineLearning', (app) => new machine_learning_1.MachineLearning(app));
 }
 exports.getMachineLearning = getMachineLearning;

package/lib/machine-learning/machine-learning-api-client.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/machine-learning-api-client.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -17,22 +17,21 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MachineLearningApiClient = exports.isGcsTfliteModelOptions = void 0;
-var api_request_1 = require("../utils/api-request");
-var error_1 = require("../utils/error");
-var utils = require("../utils/index");
-var validator = require("../utils/validator");
-var machine_learning_utils_1 = require("./machine-learning-utils");
-var ML_V1BETA2_API = 'https://firebaseml.googleapis.com/v1beta2';
-var FIREBASE_VERSION_HEADER = {
-    'X-Firebase-Client': "fire-admin-node/" + utils.getSdkVersion(),
+const api_request_1 = require("../utils/api-request");
+const error_1 = require("../utils/error");
+const utils = require("../utils/index");
+const validator = require("../utils/validator");
+const machine_learning_utils_1 = require("./machine-learning-utils");
+const ML_V1BETA2_API = 'https://firebaseml.googleapis.com/v1beta2';
+const FIREBASE_VERSION_HEADER = {
+    'X-Firebase-Client': `fire-admin-node/${utils.getSdkVersion()}`,
 };
 // Operation polling defaults
-var POLL_DEFAULT_MAX_TIME_MILLISECONDS = 120000; // Maximum overall 2 minutes
-var POLL_BASE_WAIT_TIME_MILLISECONDS = 3000; // Start with 3 second delay
-var POLL_MAX_WAIT_TIME_MILLISECONDS = 30000; // Maximum 30 second delay
+const POLL_DEFAULT_MAX_TIME_MILLISECONDS = 120000; // Maximum overall 2 minutes
+const POLL_BASE_WAIT_TIME_MILLISECONDS = 3000; // Start with 3 second delay
+const POLL_MAX_WAIT_TIME_MILLISECONDS = 30000; // Maximum 30 second delay
 function isGcsTfliteModelOptions(options) {
-    var _a, _b;
-    var gcsUri = (_b = (_a = options) === null || _a === void 0 ? void 0 : _a.tfliteModel) === null || _b === void 0 ? void 0 : _b.gcsTfliteUri;
+    const gcsUri = options?.tfliteModel?.gcsTfliteUri;
     return typeof gcsUri !== 'undefined';
 }
 exports.isGcsTfliteModelOptions = isGcsTfliteModelOptions;
@@ -41,8 +40,8 @@ exports.isGcsTfliteModelOptions = isGcsTfliteModelOptions;
  *
  * @internal
  */
-var MachineLearningApiClient = /** @class */ (function () {
-    function MachineLearningApiClient(app) {
+class MachineLearningApiClient {
+    constructor(app) {
         this.app = app;
         if (!validator.isNonNullObject(app) || !('options' in app)) {
             throw new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'First argument passed to admin.machineLearning() must be a valid '
@@ -50,156 +49,147 @@ var MachineLearningApiClient = /** @class */ (function () {
         }
         this.httpClient = new api_request_1.AuthorizedHttpClient(app);
     }
-    MachineLearningApiClient.prototype.createModel = function (model) {
-        var _this = this;
+    createModel(model) {
         if (!validator.isNonNullObject(model) ||
             !validator.isNonEmptyString(model.displayName)) {
-            var err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid model content.');
+            const err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid model content.');
             return Promise.reject(err);
         }
         return this.getProjectUrl()
-            .then(function (url) {
-            var request = {
+            .then((url) => {
+            const request = {
                 method: 'POST',
-                url: url + "/models",
+                url: `${url}/models`,
                 data: model,
             };
-            return _this.sendRequest(request);
+            return this.sendRequest(request);
         });
-    };
-    MachineLearningApiClient.prototype.updateModel = function (modelId, model, updateMask) {
-        var _this = this;
+    }
+    updateModel(modelId, model, updateMask) {
         if (!validator.isNonEmptyString(modelId) ||
             !validator.isNonNullObject(model) ||
             !validator.isNonEmptyArray(updateMask)) {
-            var err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid model or mask content.');
+            const err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid model or mask content.');
             return Promise.reject(err);
         }
         return this.getProjectUrl()
-            .then(function (url) {
-            var request = {
+            .then((url) => {
+            const request = {
                 method: 'PATCH',
-                url: url + "/models/" + modelId + "?updateMask=" + updateMask.join(),
+                url: `${url}/models/${modelId}?updateMask=${updateMask.join()}`,
                 data: model,
             };
-            return _this.sendRequest(request);
+            return this.sendRequest(request);
         });
-    };
-    MachineLearningApiClient.prototype.getModel = function (modelId) {
-        var _this = this;
+    }
+    getModel(modelId) {
         return Promise.resolve()
-            .then(function () {
-            return _this.getModelName(modelId);
+            .then(() => {
+            return this.getModelName(modelId);
         })
-            .then(function (modelName) {
-            return _this.getResourceWithShortName(modelName);
+            .then((modelName) => {
+            return this.getResourceWithShortName(modelName);
         });
-    };
-    MachineLearningApiClient.prototype.getOperation = function (operationName) {
-        var _this = this;
+    }
+    getOperation(operationName) {
         return Promise.resolve()
-            .then(function () {
-            return _this.getResourceWithFullName(operationName);
+            .then(() => {
+            return this.getResourceWithFullName(operationName);
         });
-    };
-    MachineLearningApiClient.prototype.listModels = function (options) {
-        var _this = this;
-        if (options === void 0) { options = {}; }
+    }
+    listModels(options = {}) {
         if (!validator.isNonNullObject(options)) {
-            var err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid ListModelsOptions');
+            const err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid ListModelsOptions');
             return Promise.reject(err);
         }
         if (typeof options.filter !== 'undefined' && !validator.isNonEmptyString(options.filter)) {
-            var err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid list filter.');
+            const err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid list filter.');
             return Promise.reject(err);
         }
         if (typeof options.pageSize !== 'undefined') {
             if (!validator.isNumber(options.pageSize)) {
-                var err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid page size.');
+                const err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Invalid page size.');
                 return Promise.reject(err);
             }
             if (options.pageSize < 1 || options.pageSize > 100) {
-                var err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Page size must be between 1 and 100.');
+                const err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Page size must be between 1 and 100.');
                 return Promise.reject(err);
             }
         }
         if (typeof options.pageToken !== 'undefined' && !validator.isNonEmptyString(options.pageToken)) {
-            var err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Next page token must be a non-empty string.');
+            const err = new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Next page token must be a non-empty string.');
             return Promise.reject(err);
         }
         return this.getProjectUrl()
-            .then(function (url) {
-            var request = {
+            .then((url) => {
+            const request = {
                 method: 'GET',
-                url: url + "/models",
+                url: `${url}/models`,
                 data: options,
             };
-            return _this.sendRequest(request);
+            return this.sendRequest(request);
         });
-    };
-    MachineLearningApiClient.prototype.deleteModel = function (modelId) {
-        var _this = this;
+    }
+    deleteModel(modelId) {
         return this.getProjectUrl()
-            .then(function (url) {
-            var modelName = _this.getModelName(modelId);
-            var request = {
+            .then((url) => {
+            const modelName = this.getModelName(modelId);
+            const request = {
                 method: 'DELETE',
-                url: url + "/" + modelName,
+                url: `${url}/${modelName}`,
             };
-            return _this.sendRequest(request);
+            return this.sendRequest(request);
         });
-    };
+    }
     /**
      * Handles a Long Running Operation coming back from the server.
      *
      * @param op - The operation to handle
      * @param options - The options for polling
      */
-    MachineLearningApiClient.prototype.handleOperation = function (op, options) {
+    handleOperation(op, options) {
         if (op.done) {
             if (op.response) {
                 return Promise.resolve(op.response);
             }
             else if (op.error) {
-                var err = machine_learning_utils_1.FirebaseMachineLearningError.fromOperationError(op.error.code, op.error.message);
+                const err = machine_learning_utils_1.FirebaseMachineLearningError.fromOperationError(op.error.code, op.error.message);
                 return Promise.reject(err);
             }
             // Done operations must have either a response or an error.
             throw new machine_learning_utils_1.FirebaseMachineLearningError('invalid-server-response', 'Invalid operation response.');
         }
         // Operation is not done
-        if (options === null || options === void 0 ? void 0 : options.wait) {
+        if (options?.wait) {
             return this.pollOperationWithExponentialBackoff(op.name, options);
         }
-        var metadata = op.metadata || {};
-        var metadataType = metadata['@type'] || '';
+        const metadata = op.metadata || {};
+        const metadataType = metadata['@type'] || '';
         if (!metadataType.includes('ModelOperationMetadata')) {
-            throw new machine_learning_utils_1.FirebaseMachineLearningError('invalid-server-response', "Unknown Metadata type: " + JSON.stringify(metadata));
+            throw new machine_learning_utils_1.FirebaseMachineLearningError('invalid-server-response', `Unknown Metadata type: ${JSON.stringify(metadata)}`);
         }
         return this.getModel(extractModelId(metadata.name));
-    };
+    }
     // baseWaitMillis and maxWaitMillis should only ever be modified by unit tests to run faster.
-    MachineLearningApiClient.prototype.pollOperationWithExponentialBackoff = function (opName, options) {
-        var _this = this;
-        var _a, _b, _c;
-        var maxTimeMilliseconds = (_a = options === null || options === void 0 ? void 0 : options.maxTimeMillis) !== null && _a !== void 0 ? _a : POLL_DEFAULT_MAX_TIME_MILLISECONDS;
-        var baseWaitMillis = (_b = options === null || options === void 0 ? void 0 : options.baseWaitMillis) !== null && _b !== void 0 ? _b : POLL_BASE_WAIT_TIME_MILLISECONDS;
-        var maxWaitMillis = (_c = options === null || options === void 0 ? void 0 : options.maxWaitMillis) !== null && _c !== void 0 ? _c : POLL_MAX_WAIT_TIME_MILLISECONDS;
-        var poller = new api_request_1.ExponentialBackoffPoller(baseWaitMillis, maxWaitMillis, maxTimeMilliseconds);
-        return poller.poll(function () {
-            return _this.getOperation(opName)
-                .then(function (responseData) {
+    pollOperationWithExponentialBackoff(opName, options) {
+        const maxTimeMilliseconds = options?.maxTimeMillis ?? POLL_DEFAULT_MAX_TIME_MILLISECONDS;
+        const baseWaitMillis = options?.baseWaitMillis ?? POLL_BASE_WAIT_TIME_MILLISECONDS;
+        const maxWaitMillis = options?.maxWaitMillis ?? POLL_MAX_WAIT_TIME_MILLISECONDS;
+        const poller = new api_request_1.ExponentialBackoffPoller(baseWaitMillis, maxWaitMillis, maxTimeMilliseconds);
+        return poller.poll(() => {
+            return this.getOperation(opName)
+                .then((responseData) => {
                 if (!responseData.done) {
                     return null;
                 }
                 if (responseData.error) {
-                    var err = machine_learning_utils_1.FirebaseMachineLearningError.fromOperationError(responseData.error.code, responseData.error.message);
+                    const err = machine_learning_utils_1.FirebaseMachineLearningError.fromOperationError(responseData.error.code, responseData.error.message);
                     throw err;
                 }
                 return responseData.response;
             });
         });
-    };
+    }
     /**
      * Gets the specified resource from the ML API. Resource names must be the short names without project
      * ID prefix (e.g. `models/123456789`).
@@ -207,92 +197,88 @@ var MachineLearningApiClient = /** @class */ (function () {
      * @param {string} name Short name of the resource to get. e.g. 'models/12345'
      * @returns {Promise<T>} A promise that fulfills with the resource.
      */
-    MachineLearningApiClient.prototype.getResourceWithShortName = function (name) {
-        var _this = this;
+    getResourceWithShortName(name) {
         return this.getProjectUrl()
-            .then(function (url) {
-            var request = {
+            .then((url) => {
+            const request = {
                 method: 'GET',
-                url: url + "/" + name,
+                url: `${url}/${name}`,
             };
-            return _this.sendRequest(request);
+            return this.sendRequest(request);
         });
-    };
+    }
     /**
      * Gets the specified resource from the ML API. Resource names must be the full names including project
      * number prefix.
      * @param fullName - Full resource name of the resource to get. e.g. projects/123465/operations/987654
      * @returns {Promise<T>} A promise that fulfulls with the resource.
      */
-    MachineLearningApiClient.prototype.getResourceWithFullName = function (fullName) {
-        var request = {
+    getResourceWithFullName(fullName) {
+        const request = {
             method: 'GET',
-            url: ML_V1BETA2_API + "/" + fullName
+            url: `${ML_V1BETA2_API}/${fullName}`
         };
         return this.sendRequest(request);
-    };
-    MachineLearningApiClient.prototype.sendRequest = function (request) {
-        var _this = this;
+    }
+    sendRequest(request) {
         request.headers = FIREBASE_VERSION_HEADER;
         return this.httpClient.send(request)
-            .then(function (resp) {
+            .then((resp) => {
             return resp.data;
         })
-            .catch(function (err) {
-            throw _this.toFirebaseError(err);
+            .catch((err) => {
+            throw this.toFirebaseError(err);
         });
-    };
-    MachineLearningApiClient.prototype.toFirebaseError = function (err) {
+    }
+    toFirebaseError(err) {
         if (err instanceof error_1.PrefixedFirebaseError) {
             return err;
         }
-        var response = err.response;
+        const response = err.response;
         if (!response.isJson()) {
-            return new machine_learning_utils_1.FirebaseMachineLearningError('unknown-error', "Unexpected response with status: " + response.status + " and body: " + response.text);
+            return new machine_learning_utils_1.FirebaseMachineLearningError('unknown-error', `Unexpected response with status: ${response.status} and body: ${response.text}`);
         }
-        var error = response.data.error || {};
-        var code = 'unknown-error';
+        const error = response.data.error || {};
+        let code = 'unknown-error';
         if (error.status && error.status in ERROR_CODE_MAPPING) {
             code = ERROR_CODE_MAPPING[error.status];
         }
-        var message = error.message || "Unknown server error: " + response.text;
+        const message = error.message || `Unknown server error: ${response.text}`;
         return new machine_learning_utils_1.FirebaseMachineLearningError(code, message);
-    };
-    MachineLearningApiClient.prototype.getProjectUrl = function () {
+    }
+    getProjectUrl() {
         return this.getProjectIdPrefix()
-            .then(function (projectIdPrefix) {
-            return ML_V1BETA2_API + "/" + projectIdPrefix;
+            .then((projectIdPrefix) => {
+            return `${ML_V1BETA2_API}/${projectIdPrefix}`;
         });
-    };
-    MachineLearningApiClient.prototype.getProjectIdPrefix = function () {
-        var _this = this;
+    }
+    getProjectIdPrefix() {
         if (this.projectIdPrefix) {
             return Promise.resolve(this.projectIdPrefix);
         }
         return utils.findProjectId(this.app)
-            .then(function (projectId) {
+            .then((projectId) => {
             if (!validator.isNonEmptyString(projectId)) {
                 throw new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Failed to determine project ID. Initialize the SDK with service account credentials, or '
                     + 'set project ID as an app option. Alternatively, set the GOOGLE_CLOUD_PROJECT '
                     + 'environment variable.');
             }
-            _this.projectIdPrefix = "projects/" + projectId;
-            return _this.projectIdPrefix;
+            this.projectIdPrefix = `projects/${projectId}`;
+            return this.projectIdPrefix;
         });
-    };
-    MachineLearningApiClient.prototype.getModelName = function (modelId) {
+    }
+    getModelName(modelId) {
         if (!validator.isNonEmptyString(modelId)) {
             throw new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Model ID must be a non-empty string.');
         }
         if (modelId.indexOf('/') !== -1) {
             throw new machine_learning_utils_1.FirebaseMachineLearningError('invalid-argument', 'Model ID must not contain any "/" characters.');
         }
-        return "models/" + modelId;
-    };
-    return MachineLearningApiClient;
-}());
+        return `models/${modelId}`;
+    }
+}
 exports.MachineLearningApiClient = MachineLearningApiClient;
-var ERROR_CODE_MAPPING = {
+const ERROR_CODE_MAPPING = {
     INVALID_ARGUMENT: 'invalid-argument',
     NOT_FOUND: 'not-found',
     RESOURCE_EXHAUSTED: 'resource-exhausted',

package/lib/machine-learning/machine-learning-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/machine-learning/machine-learning-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/machine-learning/machine-learning-utils.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/machine-learning-utils.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -15,28 +15,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FirebaseMachineLearningError = void 0;
-var error_1 = require("../utils/error");
-var FirebaseMachineLearningError = /** @class */ (function (_super) {
-    __extends(FirebaseMachineLearningError, _super);
-    function FirebaseMachineLearningError(code, message) {
-        return _super.call(this, 'machine-learning', code, message) || this;
-    }
-    FirebaseMachineLearningError.fromOperationError = function (code, message) {
+const error_1 = require("../utils/error");
+class FirebaseMachineLearningError extends error_1.PrefixedFirebaseError {
+    static fromOperationError(code, message) {
         switch (code) {
             case 1: return new FirebaseMachineLearningError('cancelled', message);
             case 2: return new FirebaseMachineLearningError('unknown-error', message);
@@ -56,7 +39,9 @@ var FirebaseMachineLearningError = /** @class */ (function (_super) {
             default:
                 return new FirebaseMachineLearningError('unknown-error', message);
         }
-    };
-    return FirebaseMachineLearningError;
-}(error_1.PrefixedFirebaseError));
+    }
+    constructor(code, message) {
+        super('machine-learning', code, message);
+    }
+}
 exports.FirebaseMachineLearningError = FirebaseMachineLearningError;

package/lib/machine-learning/machine-learning.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v11.0.0 */
 /*!
  * Copyright 2020 Google Inc.
  *