firebase-admin 9.12.0

package/lib/utils/validator.js

@@ -0,0 +1,271 @@
+/*! firebase-admin v9.12.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTopic = exports.isURL = exports.isUTCDateString = exports.isISODateString = exports.isPhoneNumber = exports.isEmail = exports.isPassword = exports.isUid = exports.isNonNullObject = exports.isObject = exports.isNonEmptyString = exports.isBase64String = exports.isString = exports.isNumber = exports.isBoolean = exports.isNonEmptyArray = exports.isArray = exports.isBuffer = void 0;
+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.
+ */
+function isBuffer(value) {
+    return value instanceof Buffer;
+}
+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.
+ */
+function isArray(value) {
+    return Array.isArray(value);
+}
+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.
+ */
+function isNonEmptyArray(value) {
+    return isArray(value) && value.length !== 0;
+}
+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.
+ */
+function isBoolean(value) {
+    return typeof value === 'boolean';
+}
+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.
+ */
+function isNumber(value) {
+    return typeof value === 'number' && !isNaN(value);
+}
+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.
+ */
+function isString(value) {
+    return typeof value === 'string';
+}
+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.
+ */
+function isBase64String(value) {
+    if (!isString(value)) {
+        return false;
+    }
+    return /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(value);
+}
+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.
+ */
+function isNonEmptyString(value) {
+    return isString(value) && value !== '';
+}
+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.
+ */
+function isObject(value) {
+    return typeof value === 'object' && !isArray(value);
+}
+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.
+ */
+function isNonNullObject(value) {
+    return isObject(value) && value !== null;
+}
+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.
+ */
+function isUid(uid) {
+    return typeof uid === 'string' && uid.length > 0 && uid.length <= 128;
+}
+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.
+ */
+function isPassword(password) {
+    // A password must be a string of at least 6 characters.
+    return typeof password === 'string' && password.length >= 6;
+}
+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.
+ */
+function isEmail(email) {
+    if (typeof email !== 'string') {
+        return false;
+    }
+    // There must at least one character before the @ symbol and another after.
+    var re = /^[^@]+@[^@]+$/;
+    return re.test(email);
+}
+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.
+ */
+function isPhoneNumber(phoneNumber) {
+    if (typeof phoneNumber !== 'string') {
+        return false;
+    }
+    // Phone number validation is very lax here. Backend will enforce E.164
+    // spec compliance and will normalize accordingly.
+    // The phone number string must be non-empty and starts with a plus sign.
+    var re1 = /^\+/;
+    // The phone number string must contain at least one alphanumeric character.
+    var re2 = /[\da-zA-Z]+/;
+    return re1.test(phoneNumber) && re2.test(phoneNumber);
+}
+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.
+ */
+function isISODateString(dateString) {
+    try {
+        return isNonEmptyString(dateString) &&
+            (new Date(dateString).toISOString() === dateString);
+    }
+    catch (e) {
+        return false;
+    }
+}
+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.
+ */
+function isUTCDateString(dateString) {
+    try {
+        return isNonEmptyString(dateString) &&
+            (new Date(dateString).toUTCString() === dateString);
+    }
+    catch (e) {
+        return false;
+    }
+}
+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.
+ */
+function isURL(urlStr) {
+    if (typeof urlStr !== 'string') {
+        return false;
+    }
+    // Lookup illegal characters.
+    var re = /[^a-z0-9:/?#[\]@!$&'()*+,;=.\-_~%]/i;
+    if (re.test(urlStr)) {
+        return false;
+    }
+    try {
+        var uri = url.parse(urlStr);
+        var scheme = uri.protocol;
+        var slashes = uri.slashes;
+        var hostname = uri.hostname;
+        var pathname = uri.pathname;
+        if ((scheme !== 'http:' && scheme !== 'https:') || !slashes) {
+            return false;
+        }
+        // Validate hostname: Can contain letters, numbers, underscore and dashes separated by a dot.
+        // Each zone must not start with a hyphen or underscore.
+        if (!hostname || !/^[a-zA-Z0-9]+[\w-]*([.]?[a-zA-Z0-9]+[\w-]*)*$/.test(hostname)) {
+            return false;
+        }
+        // Allow for pathnames: (/chars+)*/?
+        // Where chars can be a combination of: a-z A-Z 0-9 - _ . ~ ! $ & ' ( ) * + , ; = : @ %
+        var pathnameRe = /^(\/[\w\-.~!$'()*+,;=:@%]+)*\/?$/;
+        // Validate pathname.
+        if (pathname &&
+            pathname !== '/' &&
+            !pathnameRe.test(pathname)) {
+            return false;
+        }
+        // Allow any query string and hash as long as no invalid character is used.
+    }
+    catch (e) {
+        return false;
+    }
+    return true;
+}
+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.
+ */
+function isTopic(topic) {
+    if (typeof topic !== 'string') {
+        return false;
+    }
+    var VALID_TOPIC_REGEX = /^(\/topics\/)?(private\/)?[a-zA-Z0-9-_.~%]+$/;
+    return VALID_TOPIC_REGEX.test(topic);
+}
+exports.isTopic = isTopic;

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "firebase-admin",
+  "version": "9.12.0",
+  "description": "Firebase admin SDK for Node.js",
+  "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
+  "license": "Apache-2.0",
+  "homepage": "https://firebase.google.com/",
+  "engines": {
+    "node": ">=10.13.0"
+  },
+  "scripts": {
+    "build": "gulp build",
+    "build:tests": "gulp compile_test",
+    "prepare": "npm run build",
+    "lint": "run-p lint:src lint:test",
+    "test": "run-s lint test:unit",
+    "integration": "run-s build test:integration",
+    "test:unit": "mocha test/unit/*.spec.ts --require ts-node/register",
+    "test:integration": "mocha test/integration/*.ts --slow 5000 --timeout 20000 --require ts-node/register",
+    "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",
+    "api-extractor": "api-extractor run",
+    "api-extractor:local": "api-extractor run --local"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ],
+    "include": [
+      "src"
+    ],
+    "exclude": [
+      "**/*.d.ts"
+    ],
+    "all": true
+  },
+  "keywords": [
+    "admin",
+    "database",
+    "Firebase",
+    "realtime",
+    "authentication"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/firebase/firebase-admin-node"
+  },
+  "main": "lib/index.js",
+  "files": [
+    "lib/",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
+  "types": "./lib/index.d.ts",
+  "dependencies": {
+    "@firebase/database-compat": "^0.1.1",
+    "@firebase/database-types": "^0.7.2",
+    "@types/node": ">=12.12.47",
+    "dicer": "^0.3.0",
+    "jsonwebtoken": "^8.5.1",
+    "jwks-rsa": "^2.0.2",
+    "node-forge": "^0.10.0"
+  },
+  "optionalDependencies": {
+    "@google-cloud/firestore": "^4.5.0",
+    "@google-cloud/storage": "^5.3.0"
+  },
+  "devDependencies": {
+    "@firebase/app-compat": "^0.1.2",
+    "@firebase/auth-compat": "^0.1.3",
+    "@firebase/auth-types": "^0.10.3",
+    "@microsoft/api-extractor": "^7.11.2",
+    "@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.1",
+    "@types/lodash": "^4.14.104",
+    "@types/minimist": "^1.2.0",
+    "@types/mocha": "^8.2.2",
+    "@types/nock": "^11.1.0",
+    "@types/request": "^2.47.0",
+    "@types/request-promise": "^4.1.41",
+    "@types/sinon": "^10.0.2",
+    "@types/sinon-chai": "^3.0.0",
+    "@typescript-eslint/eslint-plugin": "^2.20.0",
+    "@typescript-eslint/parser": "^2.20.0",
+    "bcrypt": "^5.0.0",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.0.0",
+    "chalk": "^4.1.1",
+    "child-process-promise": "^2.2.1",
+    "del": "^6.0.0",
+    "eslint": "^6.8.0",
+    "firebase-token-generator": "^2.0.0",
+    "gulp": "^4.0.2",
+    "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",
+    "mz": "^2.7.0",
+    "nock": "^13.0.0",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^15.1.0",
+    "request": "^2.75.0",
+    "request-promise": "^4.1.1",
+    "run-sequence": "^2.2.1",
+    "sinon": "^9.0.0",
+    "sinon-chai": "^3.0.0",
+    "ts-node": "^10.2.0",
+    "typedoc": "^0.19.2",
+    "typescript": "^3.7.3",
+    "yargs": "^17.0.1"
+  }
+}