firebase-admin/lib/app-check/error.d.ts

Firebase admin SDK for Node.js

/*! firebase-admin v14.0.0 */
/*!
 * 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.
 */
import { FirebaseError, ErrorInfo } from '../utils/error';
/** @const {Record<string, AppCheckErrorCode>} App Check server to client error code mapping. */
export declare const APP_CHECK_ERROR_CODE_MAPPING: Record<string, AppCheckErrorCode>;
/**
 * The constant mapping for valid App Check client error codes.
 */
export declare const AppCheckErrorCode: {
    readonly ABORTED: "aborted";
    readonly INVALID_ARGUMENT: "invalid-argument";
    readonly INVALID_CREDENTIAL: "invalid-credential";
    readonly INTERNAL: "internal-error";
    readonly PERMISSION_DENIED: "permission-denied";
    readonly UNAUTHENTICATED: "unauthenticated";
    readonly NOT_FOUND: "not-found";
    readonly APP_CHECK_TOKEN_EXPIRED: "app-check-token-expired";
    readonly UNKNOWN: "unknown-error";
};
/**
 * The type definition for valid App Check client error codes.
 */
export type AppCheckErrorCode = typeof AppCheckErrorCode[keyof typeof AppCheckErrorCode];
/**
 * Firebase App Check error code structure. This extends `FirebaseError`.
 */
export declare class FirebaseAppCheckError extends FirebaseError {
    /**
     * @param info - The error code info.
     * @param message - The error message. If provided, this will override the default message.
     */
    constructor(info: ErrorInfo, message?: string);
}