firebase-admin/lib/firestore/error.js

Firebase admin SDK for Node.js

/*! firebase-admin v14.0.0 */
"use strict";
/*!
 * Copyright 2026 Google LLC
 *
 * 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.FirebaseFirestoreError = exports.FirestoreErrorCode = void 0;
const error_1 = require("../utils/error");
/**
 * The constant mapping for valid Firestore client error codes.
 */
exports.FirestoreErrorCode = {
    FAILED_PRECONDITION: 'failed-precondition',
    INVALID_ARGUMENT: 'invalid-argument',
    INVALID_CREDENTIAL: 'invalid-credential',
    MISSING_DEPENDENCIES: 'missing-dependencies',
};
/**
 * Firebase Firestore error code structure. This extends `FirebaseError`.
 */
class FirebaseFirestoreError extends error_1.FirebaseError {
    /**
     * @param info - The error code info.
     * @param message - The error message. This will override the default
     *     message if provided.
     */
    constructor(info, message) {
        // Override default message if custom message provided.
        super({
            code: `firestore/${info.code}`,
            message: message || info.message,
            httpResponse: info.httpResponse,
            cause: info.cause,
        });
        /** @internal */
        this.codePrefix = 'firestore';
    }
}
exports.FirebaseFirestoreError = FirebaseFirestoreError;