firebase-admin 9.100.0-alpha.0 → 10.0.2

package/lib/utils/validator.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -19,126 +19,126 @@
 /**
  * Validates that a value is a byte buffer.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is byte buffer or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is byte buffer or not.
  */
 export declare function isBuffer(value: any): value is Buffer;
 /**
  * Validates that a value is an array.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is an array or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is an array or not.
  */
 export declare function isArray<T>(value: any): value is T[];
 /**
  * Validates that a value is a non-empty array.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a non-empty array or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a non-empty array or not.
  */
 export declare function isNonEmptyArray<T>(value: any): value is T[];
 /**
  * Validates that a value is a boolean.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a boolean or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a boolean or not.
  */
 export declare function isBoolean(value: any): boolean;
 /**
  * Validates that a value is a number.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a number or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a number or not.
  */
 export declare function isNumber(value: any): boolean;
 /**
  * Validates that a value is a string.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a string or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a string or not.
  */
 export declare function isString(value: any): value is string;
 /**
  * Validates that a value is a base64 string.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a base64 string or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a base64 string or not.
  */
 export declare function isBase64String(value: any): boolean;
 /**
  * Validates that a value is a non-empty string.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a non-empty string or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a non-empty string or not.
  */
 export declare function isNonEmptyString(value: any): value is string;
 /**
  * Validates that a value is a nullable object.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is an object or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is an object or not.
  */
 export declare function isObject(value: any): boolean;
 /**
  * Validates that a value is a non-null object.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a non-null object or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a non-null object or not.
  */
 export declare function isNonNullObject<T>(value: T | null | undefined): value is T;
 /**
  * Validates that a string is a valid Firebase Auth uid.
  *
- * @param {any} uid The string to validate.
- * @return {boolean} Whether the string is a valid Firebase Auth uid.
+ * @param uid - The string to validate.
+ * @returns Whether the string is a valid Firebase Auth uid.
  */
 export declare function isUid(uid: any): boolean;
 /**
  * Validates that a string is a valid Firebase Auth password.
  *
- * @param {any} password The password string to validate.
- * @return {boolean} Whether the string is a valid Firebase Auth password.
+ * @param password - The password string to validate.
+ * @returns Whether the string is a valid Firebase Auth password.
  */
 export declare function isPassword(password: any): boolean;
 /**
  * Validates that a string is a valid email.
  *
- * @param {any} email The string to validate.
- * @return {boolean} Whether the string is valid email or not.
+ * @param email - The string to validate.
+ * @returns Whether the string is valid email or not.
  */
 export declare function isEmail(email: any): boolean;
 /**
  * Validates that a string is a valid phone number.
  *
- * @param {any} phoneNumber The string to validate.
- * @return {boolean} Whether the string is a valid phone number or not.
+ * @param phoneNumber - The string to validate.
+ * @returns Whether the string is a valid phone number or not.
  */
 export declare function isPhoneNumber(phoneNumber: any): boolean;
 /**
  * Validates that a string is a valid ISO date string.
  *
- * @param dateString The string to validate.
- * @return Whether the string is a valid ISO date string.
+ * @param dateString - The string to validate.
+ * @returns Whether the string is a valid ISO date string.
  */
 export declare function isISODateString(dateString: any): boolean;
 /**
  * Validates that a string is a valid UTC date string.
  *
- * @param dateString The string to validate.
- * @return Whether the string is a valid UTC date string.
+ * @param dateString - The string to validate.
+ * @returns Whether the string is a valid UTC date string.
  */
 export declare function isUTCDateString(dateString: any): boolean;
 /**
  * Validates that a string is a valid web URL.
  *
- * @param {any} urlStr The string to validate.
- * @return {boolean} Whether the string is valid web URL or not.
+ * @param urlStr - The string to validate.
+ * @returns Whether the string is valid web URL or not.
  */
 export declare function isURL(urlStr: any): boolean;
 /**
  * Validates that the provided topic is a valid FCM topic name.
  *
- * @param {any} topic The topic to validate.
- * @return {boolean} Whether the provided topic is a valid FCM topic name.
+ * @param topic - The topic to validate.
+ * @returns Whether the provided topic is a valid FCM topic name.
  */
 export declare function isTopic(topic: any): boolean;

package/lib/utils/validator.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -22,8 +22,8 @@ var url = require("url");
 /**
  * Validates that a value is a byte buffer.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is byte buffer or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is byte buffer or not.
  */
 function isBuffer(value) {
     return value instanceof Buffer;
@@ -32,8 +32,8 @@ exports.isBuffer = isBuffer;
 /**
  * Validates that a value is an array.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is an array or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is an array or not.
  */
 function isArray(value) {
     return Array.isArray(value);
@@ -42,8 +42,8 @@ exports.isArray = isArray;
 /**
  * Validates that a value is a non-empty array.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a non-empty array or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a non-empty array or not.
  */
 function isNonEmptyArray(value) {
     return isArray(value) && value.length !== 0;
@@ -52,8 +52,8 @@ exports.isNonEmptyArray = isNonEmptyArray;
 /**
  * Validates that a value is a boolean.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a boolean or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a boolean or not.
  */
 function isBoolean(value) {
     return typeof value === 'boolean';
@@ -62,8 +62,8 @@ exports.isBoolean = isBoolean;
 /**
  * Validates that a value is a number.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a number or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a number or not.
  */
 function isNumber(value) {
     return typeof value === 'number' && !isNaN(value);
@@ -72,8 +72,8 @@ exports.isNumber = isNumber;
 /**
  * Validates that a value is a string.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a string or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a string or not.
  */
 function isString(value) {
     return typeof value === 'string';
@@ -82,8 +82,8 @@ exports.isString = isString;
 /**
  * Validates that a value is a base64 string.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a base64 string or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a base64 string or not.
  */
 function isBase64String(value) {
     if (!isString(value)) {
@@ -95,8 +95,8 @@ exports.isBase64String = isBase64String;
 /**
  * Validates that a value is a non-empty string.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a non-empty string or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a non-empty string or not.
  */
 function isNonEmptyString(value) {
     return isString(value) && value !== '';
@@ -105,8 +105,8 @@ exports.isNonEmptyString = isNonEmptyString;
 /**
  * Validates that a value is a nullable object.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is an object or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is an object or not.
  */
 function isObject(value) {
     return typeof value === 'object' && !isArray(value);
@@ -115,8 +115,8 @@ exports.isObject = isObject;
 /**
  * Validates that a value is a non-null object.
  *
- * @param {any} value The value to validate.
- * @return {boolean} Whether the value is a non-null object or not.
+ * @param value - The value to validate.
+ * @returns Whether the value is a non-null object or not.
  */
 function isNonNullObject(value) {
     return isObject(value) && value !== null;
@@ -125,8 +125,8 @@ exports.isNonNullObject = isNonNullObject;
 /**
  * Validates that a string is a valid Firebase Auth uid.
  *
- * @param {any} uid The string to validate.
- * @return {boolean} Whether the string is a valid Firebase Auth uid.
+ * @param uid - The string to validate.
+ * @returns Whether the string is a valid Firebase Auth uid.
  */
 function isUid(uid) {
     return typeof uid === 'string' && uid.length > 0 && uid.length <= 128;
@@ -135,8 +135,8 @@ exports.isUid = isUid;
 /**
  * Validates that a string is a valid Firebase Auth password.
  *
- * @param {any} password The password string to validate.
- * @return {boolean} Whether the string is a valid Firebase Auth password.
+ * @param password - The password string to validate.
+ * @returns Whether the string is a valid Firebase Auth password.
  */
 function isPassword(password) {
     // A password must be a string of at least 6 characters.
@@ -146,8 +146,8 @@ exports.isPassword = isPassword;
 /**
  * Validates that a string is a valid email.
  *
- * @param {any} email The string to validate.
- * @return {boolean} Whether the string is valid email or not.
+ * @param email - The string to validate.
+ * @returns Whether the string is valid email or not.
  */
 function isEmail(email) {
     if (typeof email !== 'string') {
@@ -161,8 +161,8 @@ exports.isEmail = isEmail;
 /**
  * Validates that a string is a valid phone number.
  *
- * @param {any} phoneNumber The string to validate.
- * @return {boolean} Whether the string is a valid phone number or not.
+ * @param phoneNumber - The string to validate.
+ * @returns Whether the string is a valid phone number or not.
  */
 function isPhoneNumber(phoneNumber) {
     if (typeof phoneNumber !== 'string') {
@@ -180,8 +180,8 @@ exports.isPhoneNumber = isPhoneNumber;
 /**
  * Validates that a string is a valid ISO date string.
  *
- * @param dateString The string to validate.
- * @return Whether the string is a valid ISO date string.
+ * @param dateString - The string to validate.
+ * @returns Whether the string is a valid ISO date string.
  */
 function isISODateString(dateString) {
     try {
@@ -196,8 +196,8 @@ exports.isISODateString = isISODateString;
 /**
  * Validates that a string is a valid UTC date string.
  *
- * @param dateString The string to validate.
- * @return Whether the string is a valid UTC date string.
+ * @param dateString - The string to validate.
+ * @returns Whether the string is a valid UTC date string.
  */
 function isUTCDateString(dateString) {
     try {
@@ -212,8 +212,8 @@ exports.isUTCDateString = isUTCDateString;
 /**
  * Validates that a string is a valid web URL.
  *
- * @param {any} urlStr The string to validate.
- * @return {boolean} Whether the string is valid web URL or not.
+ * @param urlStr - The string to validate.
+ * @returns Whether the string is valid web URL or not.
  */
 function isURL(urlStr) {
     if (typeof urlStr !== 'string') {
@@ -258,8 +258,8 @@ exports.isURL = isURL;
 /**
  * Validates that the provided topic is a valid FCM topic name.
  *
- * @param {any} topic The topic to validate.
- * @return {boolean} Whether the provided topic is a valid FCM topic name.
+ * @param topic - The topic to validate.
+ * @returns Whether the provided topic is a valid FCM topic name.
  */
 function isTopic(topic) {
     if (typeof topic !== 'string') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-admin",
-  "version": "9.100.0-alpha.0",
+  "version": "10.0.2",
   "description": "Firebase admin SDK for Node.js",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "license": "Apache-2.0",
@@ -11,7 +11,7 @@
   "scripts": {
     "build": "gulp build",
     "build:tests": "gulp compile_test",
-    "prepare": "npm run build",
+    "prepare": "npm run build && npm run esm-wrap",
     "lint": "run-p lint:src lint:test",
     "test": "run-s lint test:unit",
     "integration": "run-s build test:integration",
@@ -20,9 +20,14 @@
     "test:coverage": "nyc npm run test:unit",
     "lint:src": "eslint src/ --ext .ts",
     "lint:test": "eslint test/ --ext .ts",
-    "apidocs": "node docgen/generate-docs.js --api node",
+    "apidocs": "run-s api-extractor:local api-documenter",
     "api-extractor": "node generate-reports.js",
-    "api-extractor:local": "npm run build && node generate-reports.js --local"
+    "api-extractor:local": "npm run build && node generate-reports.js --local",
+    "esm-wrap": "node generate-esm-wrapper.js",
+    "api-documenter": "run-s api-documenter:markdown api-documenter:toc api-documenter:post",
+    "api-documenter:markdown": "api-documenter-fire markdown --input temp --output docgen/markdown -s",
+    "api-documenter:toc": "api-documenter-fire toc --input temp --output docgen/markdown -p /docs/reference/admin/node -s",
+    "api-documenter:post": "node docgen/post-process.js"
   },
   "nyc": {
     "extension": [
@@ -57,95 +62,163 @@
   "types": "./lib/index.d.ts",
   "typesVersions": {
     "*": {
-      "app": ["lib/app"],
-      "auth": ["lib/auth"],
-      "database": ["lib/database"],
-      "firestore": ["lib/firestore"],
-      "instance-id": ["lib/instance-id"],
-      "machine-learning": ["lib/machine-learning"],
-      "messaging": ["lib/messaging"],
-      "project-management": ["lib/project-management"],
-      "remote-config": ["lib/remote-config"],
-      "security-rules": ["lib/security-rules"],
-      "storage": ["lib/storage"]
+      "app": [
+        "lib/app"
+      ],
+      "app-check": [
+        "lib/app-check"
+      ],
+      "auth": [
+        "lib/auth"
+      ],
+      "database": [
+        "lib/database"
+      ],
+      "firestore": [
+        "lib/firestore"
+      ],
+      "installations": [
+        "lib/installations"
+      ],
+      "instance-id": [
+        "lib/instance-id"
+      ],
+      "machine-learning": [
+        "lib/machine-learning"
+      ],
+      "messaging": [
+        "lib/messaging"
+      ],
+      "project-management": [
+        "lib/project-management"
+      ],
+      "remote-config": [
+        "lib/remote-config"
+      ],
+      "security-rules": [
+        "lib/security-rules"
+      ],
+      "storage": [
+        "lib/storage"
+      ]
     }
   },
   "exports": {
     ".": "./lib/index.js",
-    "./app": "./lib/app/index.js",
-    "./auth": "./lib/auth/index.js",
-    "./database": "./lib/database/index.js",
-    "./firestore": "./lib/firestore/index.js",
-    "./instance-id": "./lib/instance-id/index.js",
-    "./machine-learning": "./lib/machine-learning/index.js",
-    "./messaging": "./lib/messaging/index.js",
-    "./project-management": "./lib/project-management/index.js",
-    "./remote-config": "./lib/remote-config/index.js",
-    "./security-rules": "./lib/security-rules/index.js",
-    "./storage": "./lib/storage/index.js"
+    "./app": {
+      "require": "./lib/app/index.js",
+      "import": "./lib/esm/app/index.js"
+    },
+    "./app-check": {
+      "require": "./lib/app-check/index.js",
+      "import": "./lib/esm/app-check/index.js"
+    },
+    "./auth": {
+      "require": "./lib/auth/index.js",
+      "import": "./lib/esm/auth/index.js"
+    },
+    "./database": {
+      "require": "./lib/database/index.js",
+      "import": "./lib/esm/database/index.js"
+    },
+    "./firestore": {
+      "require": "./lib/firestore/index.js",
+      "import": "./lib/esm/firestore/index.js"
+    },
+    "./installations": {
+      "require": "./lib/installations/index.js",
+      "import": "./lib/esm/installations/index.js"
+    },
+    "./instance-id": {
+      "require": "./lib/instance-id/index.js",
+      "import": "./lib/esm/instance-id/index.js"
+    },
+    "./machine-learning": {
+      "require": "./lib/machine-learning/index.js",
+      "import": "./lib/esm/machine-learning/index.js"
+    },
+    "./messaging": {
+      "require": "./lib/messaging/index.js",
+      "import": "./lib/esm/messaging/index.js"
+    },
+    "./project-management": {
+      "require": "./lib/project-management/index.js",
+      "import": "./lib/esm/project-management/index.js"
+    },
+    "./remote-config": {
+      "require": "./lib/remote-config/index.js",
+      "import": "./lib/esm/remote-config/index.js"
+    },
+    "./security-rules": {
+      "require": "./lib/security-rules/index.js",
+      "import": "./lib/esm/security-rules/index.js"
+    },
+    "./storage": {
+      "require": "./lib/storage/index.js",
+      "import": "./lib/esm/storage/index.js"
+    }
   },
   "dependencies": {
-    "@firebase/database": "^0.8.1",
-    "@firebase/database-types": "^0.6.1",
-    "@types/node": "^10.10.0",
+    "@firebase/database-compat": "^0.1.1",
+    "@firebase/database-types": "^0.9.3",
+    "@types/node": ">=12.12.47",
     "dicer": "^0.3.0",
     "jsonwebtoken": "^8.5.1",
-    "node-forge": "^0.10.0"
+    "jwks-rsa": "^2.0.2",
+    "node-forge": "^1.0.0"
   },
   "optionalDependencies": {
     "@google-cloud/firestore": "^4.5.0",
     "@google-cloud/storage": "^5.3.0"
   },
   "devDependencies": {
-    "@firebase/app": "^0.6.13",
-    "@firebase/auth": "^0.15.2",
-    "@firebase/auth-types": "^0.10.1",
+    "@firebase/api-documenter": "^0.1.2",
+    "@firebase/app-compat": "^0.1.2",
+    "@firebase/auth-compat": "^0.2.5",
+    "@firebase/auth-types": "^0.11.0",
     "@microsoft/api-extractor": "^7.11.2",
-    "@types/bcrypt": "^2.0.0",
+    "@types/bcrypt": "^5.0.0",
     "@types/chai": "^4.0.0",
     "@types/chai-as-promised": "^7.1.0",
     "@types/firebase-token-generator": "^2.0.28",
-    "@types/jsonwebtoken": "^8.5.0",
+    "@types/jsonwebtoken": "8.5.1",
     "@types/lodash": "^4.14.104",
     "@types/minimist": "^1.2.0",
-    "@types/mocha": "^2.2.48",
-    "@types/nock": "^9.1.0",
+    "@types/mocha": "^9.0.0",
+    "@types/nock": "^11.1.0",
     "@types/request": "^2.47.0",
     "@types/request-promise": "^4.1.41",
-    "@types/sinon": "^9.0.0",
+    "@types/sinon": "^10.0.2",
     "@types/sinon-chai": "^3.0.0",
-    "@typescript-eslint/eslint-plugin": "^2.20.0",
-    "@typescript-eslint/parser": "^2.20.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "bcrypt": "^5.0.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.0.0",
-    "chalk": "^1.1.3",
+    "chalk": "^4.1.1",
     "child-process-promise": "^2.2.1",
-    "del": "^2.2.1",
-    "eslint": "^6.8.0",
+    "del": "^6.0.0",
+    "eslint": "^7.1.0",
     "firebase-token-generator": "^2.0.0",
     "gulp": "^4.0.2",
-    "gulp-filter": "^6.0.0",
-    "gulp-header": "^1.8.8",
-    "gulp-replace": "^0.5.4",
+    "gulp-filter": "^7.0.0",
+    "gulp-header": "^2.0.9",
     "gulp-typescript": "^5.0.1",
     "http-message-parser": "^0.0.34",
-    "jsdom": "^15.0.0",
     "lodash": "^4.17.15",
     "minimist": "^1.2.0",
-    "mocha": "^8.0.0",
+    "mocha": "^9.1.2",
     "mz": "^2.7.0",
     "nock": "^13.0.0",
     "npm-run-all": "^4.1.5",
-    "nyc": "^14.1.0",
+    "nyc": "^15.1.0",
     "request": "^2.75.0",
     "request-promise": "^4.1.1",
-    "run-sequence": "^1.1.5",
+    "run-sequence": "^2.2.1",
     "sinon": "^9.0.0",
     "sinon-chai": "^3.0.0",
-    "ts-node": "^9.0.0",
-    "typedoc": "^0.19.2",
+    "ts-node": "^10.2.0",
     "typescript": "^3.7.3",
-    "yargs": "^16.0.0"
+    "yargs": "^17.0.1"
   }
 }