@firebase/app-check/dist/esm/src/types.d.ts

The App Check component of the Firebase JS SDK

/**
 * @license
 * Copyright 2021 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 { FirebaseApp } from '@firebase/app';
import { PartialObserver } from '@firebase/util';
import { AppCheckToken, AppCheckTokenListener } from './public-types';
export interface FirebaseAppCheckInternal {
    getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
    getLimitedUseToken(): Promise<AppCheckTokenResult>;
    addTokenListener(listener: AppCheckTokenListener): void;
    removeTokenListener(listener: AppCheckTokenListener): void;
}
export interface AppCheckTokenObserver extends PartialObserver<AppCheckTokenResult> {
    next: AppCheckTokenListener;
    type: ListenerType;
}
export declare const enum ListenerType {
    'INTERNAL' = "INTERNAL",
    'EXTERNAL' = "EXTERNAL"
}
export interface AppCheckTokenResult {
    readonly token: string;
    readonly error?: Error;
    readonly internalError?: Error;
}
export interface AppCheckTokenInternal extends AppCheckToken {
    issuedAtTimeMillis: number;
}
export interface AppCheckProvider {
    /**
     * Returns an App Check token.
     * @internal
     */
    getToken: () => Promise<AppCheckTokenInternal>;
    /**
     * @internal
     */
    initialize(app: FirebaseApp): void;
}
/**
 * @internal
 */
export type _AppCheckInternalComponentName = 'app-check-internal';
export interface ThrottleData {
    allowRequestsAfter: number;
    backoffCount: number;
    httpStatus: number;
}
declare module '@firebase/component' {
    interface NameServiceMapping {
        'app-check-internal': FirebaseAppCheckInternal;
    }
}