nitropack/dist/presets/firebase/types.d.ts

Build and Deploy Universal JavaScript Servers

import type { RuntimeOptions, region } from "firebase-functions";
import type { HttpsOptions } from "firebase-functions/v2/https";
export type FirebaseOptions = FirebaseFunctionsOptions | AppHostingOptions;
export type FirebaseFunctionsOptions = FirebaseOptionsGen1 | FirebaseOptionsGen2;
export interface FirebaseOptionsBase {
    gen: 1 | 2;
    /**
     * Firebase functions node runtime version.
     * @see https://cloud.google.com/functions/docs/runtime-support
     * @see https://cloud.google.com/functions/docs/concepts/nodejs-runtime
     */
    nodeVersion?: "22" | "20" | "18" | "16";
    /**
     * When deploying multiple apps within the same Firebase project
     * you must give your server a unique name in order to avoid overwriting your functions.
     *
     * @default "server"
     */
    serverFunctionName?: string;
}
export interface FirebaseOptionsGen1 extends FirebaseOptionsBase {
    gen: 1;
    /**
     * Firebase functions 1st generation region passed to `functions.region()`.
     */
    region?: Parameters<typeof region>[0];
    /**
     * Firebase functions 1st generation runtime options passed to `functions.runWith()`.
     */
    runtimeOptions?: RuntimeOptions;
}
export interface FirebaseOptionsGen2 extends FirebaseOptionsBase {
    gen: 2;
    /**
     * Firebase functions 2nd generation https options passed to `onRequest`.
     * @see https://firebase.google.com/docs/reference/functions/2nd-gen/node/firebase-functions.https.httpsoptions
     */
    httpsOptions?: HttpsOptions;
}
export interface AppHostingOptions {
    appHosting: Partial<AppHostingOutputBundleConfig["runConfig"]>;
}
export interface AppHostingOutputBundleConfig {
    version: "v1";
    runConfig: {
        /** Command to start the server (e.g. "node dist/index.js"). Assume this command is run from the root dir of the workspace. */
        runCommand: string;
        /** Environment variables set when the app is run. */
        environmentVariables?: Array<{
            /** Name of the variable. */
            variable: string;
            /** Value associated with the variable. */
            value: string;
            /** Where the variable will be available, for now only RUNTIME is supported. */
            availability: "RUNTIME"[];
        }>;
        /** The maximum number of concurrent requests that each server instance can receive. */
        concurrency?: number;
        /** The number of CPUs used in a single server instance. */
        cpu?: number;
        /** The amount of memory available for a server instance. */
        memoryMiB?: number;
        /** The limit on the minimum number of function instances that may coexist at a given time. */
        minInstances?: number;
        /** The limit on the maximum number of function instances that may coexist at a given time. */
        maxInstances?: number;
    };
    metadata: {
        adapterPackageName: string;
        adapterVersion: string;
        framework: string;
        frameworkVersion?: string;
    };
    outputFiles?: {
        /** serverApp holds a list of directories + files relative to the app root dir that frameworks need to deploy to the App Hosting server. */
        serverApp: {
            include: string[];
        };
    };
}