@snorreks/firestack 0.0.1

package/lib/types/deploy.d.ts

@@ -0,0 +1,166 @@
+import type { ExecutorBaseBuildOptions } from './core.js';
+import type { DeployFunction, FunctionBuilder } from './function-types.js';
+import type { FunctionOptions, NodeVersion } from './helper-options.js';
+export type PackageManager = 'npm' | 'yarn' | 'pnpm' | 'global';
+interface SharedDeployExecutorBaseOptions extends ExecutorBaseBuildOptions {
+    /** The project flavor */
+    flavor?: string;
+    /** The default region is us-central1 */
+    region?: string;
+    /** Only build the function, don't deploy it */
+    dryRun?: boolean;
+    /** Force deploy all functions, even if no files changed */
+    force?: boolean;
+    /**
+     * The package manager to use when running firebase-tools.
+     *
+     * Set `global` to use the globally installed firebase-tools (`npm i -g
+     * firebase-tools`).
+     *
+     * @default 'pnpm'
+     */
+    packageManager: PackageManager;
+    /**
+     * Relative path to the directory where the functions will be deployed.
+     *
+     * @default 'src/controllers'
+     */
+    functionsDirectory?: string;
+    /**
+     * The name of the file in the root project that will be used to fetch and
+     * update the cloud cache.
+     *
+     * @default 'functions-cache.ts'
+     */
+    cloudCacheFileName: string;
+    ignoreMissingEnvironmentKey?: boolean;
+    pnpmFix?: boolean;
+    useLogger?: boolean;
+}
+export interface DeployExecutorOptions extends SharedDeployExecutorBaseOptions {
+    /**
+     * The output directory of the build
+     *
+     * @default `dist/<relative-path-to-project>`
+     */
+    outputDirectory?: string;
+    /** If true, will set the flavor as production */
+    production?: boolean;
+    /** If true, will set the flavor as development */
+    development?: boolean;
+    /** Don't log anything */
+    silent?: boolean;
+    /** Get verbose logs */
+    verbose?: boolean;
+    minify?: boolean;
+    /**
+     * The amount of functions to deploy in parallel
+     *
+     * @default 5
+     */
+    concurrency?: number;
+    /**
+     * The amount of functions to deploy in parallel when retrying
+     *
+     * @default 1
+     */
+    retryConcurrency?: number;
+    /**
+     * Stringify version of the environment. If this is set, .env files will be
+     * ignored.
+     *
+     * This is useful when you want to deploy using CI/CD and don't want to
+     * store the environment variables in a file.
+     *
+     * @default undefined
+     */
+    envString?: string;
+    debug?: boolean;
+    /** Only deploy the given function names, separated by a comma */
+    only?: string;
+    flavor?: string;
+    flavors: Record<string, string>;
+    envFiles?: Record<string, string>;
+    deploySentry?: boolean;
+    retryAmount?: number;
+}
+export type Environment = {
+    [key: string]: string | undefined;
+};
+export interface SentryLiteData {
+    /** The name of the project in sentry. */
+    project: string;
+    /** The organization name in sentry. */
+    organization: string;
+    /**
+     * The sentry auth token.
+     *
+     * @see {@link https://docs.sentry.io/product/cli/configuration/#auth-token}
+     */
+    token: string;
+}
+export interface SentryData extends SentryLiteData {
+    /** The name of the release. */
+    release: string;
+}
+export interface BaseDeployOptions extends SharedDeployExecutorBaseOptions {
+    firebaseProjectId: string;
+    projectRoot: string;
+    workspaceRoot: string;
+    outputDirectory: string;
+    defaultRegion: string;
+    temporaryDirectory: string;
+    flavor: string;
+    /** Stringified code of the environments */
+    environment?: Environment;
+    /**
+     * Relative path to the directory where the functions will be deployed from
+     * the project root.
+     */
+    functionsDirectory: string;
+    only?: string[];
+    currentTime: number;
+    /** If this is defined, upload the sourcemaps to sentry. */
+    sentry?: SentryLiteData;
+    pnpmFix?: boolean;
+    minify?: boolean;
+}
+export interface BuildFunctionLiteData<T extends FunctionBuilder = FunctionBuilder> extends BaseDeployOptions {
+    /**
+     * The type of the function.
+     *
+     * @see {@link DeployFunction}
+     */
+    deployFunction: DeployFunction;
+    rootFunctionBuilder: T;
+    /** The absolute path of the deploy file */
+    absolutePath: string;
+    relativeDeployFilePath: string;
+}
+export type BuildFunctionData<T extends FunctionBuilder = FunctionBuilder> = Omit<BuildFunctionLiteData<T>, 'sentry'> & FunctionOptions[T] & {
+    /**
+     * If the type is `onCreate`, `onUpdate`, or `onDelete`, this is
+     * required
+     */
+    path: T extends 'firestore' | 'database' ? string : undefined;
+    /** The name of the function. */
+    functionName: string;
+    outputRoot: string;
+    /**
+     * The region to deploy the function to. If not provided it will be
+     * the region set in project.json. If that is not provided it will
+     * be 'us-central1'
+     *
+     * @see https://firebase.google.com/docs/functions/locations
+     */
+    region: string | string[];
+    startTime: number;
+    hasLoggerFile?: boolean;
+    checksum?: string;
+    sentry?: SentryData;
+    flavor: string;
+    nodeVersion: NodeVersion;
+};
+export type DeployFunctionData<T extends FunctionBuilder = FunctionBuilder> = BuildFunctionData<T>;
+export {};
+//# sourceMappingURL=deploy.d.ts.map

package/lib/types/deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../src/lib/types/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAExE,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEhE,UAAU,+BAAgC,SAAQ,wBAAwB;IACxE,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2DAA2D;IAC3D,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;;OAOG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,qBAAsB,SAAQ,+BAA+B;IAC5E;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kDAAkD;IAClD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,yBAAyB;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,uBAAuB;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAElC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEhE,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAW,SAAQ,cAAc;IAChD,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAkB,SAAQ,+BAA+B;IACxE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,CAChF,SAAQ,iBAAiB;IACzB;;;;OAIG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B,mBAAmB,EAAE,CAAC,CAAC;IACvB,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAC;IAErB,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,IAAI,IAAI,CAC/E,qBAAqB,CAAC,CAAC,CAAC,EACxB,QAAQ,CACT,GACC,eAAe,CAAC,CAAC,CAAC,GAAG;IACnB;;;OAGG;IACH,IAAI,EAAE,CAAC,SAAS,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;IAE9D,gCAAgC;IAChC,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE1B,SAAS,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEJ,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC"}

package/lib/types/firebase-auth-v2.d.ts

@@ -0,0 +1,30 @@
+import type { AuthUserRecord } from 'firebase-functions/v2/identity';
+export interface AuthEventContext {
+    eventId: string;
+    eventType: string;
+    resource: string;
+    timestamp: string;
+    params: {
+        [key: string]: string;
+    };
+    auth: {
+        token: object;
+        uid: string;
+    };
+    data: AuthUserRecord;
+}
+export interface BeforeCreateResponse {
+    customClaims?: object;
+    disabled?: boolean;
+    displayName?: string;
+    email?: string;
+    emailVerified?: boolean;
+    password?: string;
+    phoneNumber?: string;
+    photoURL?: string;
+}
+export interface BeforeSignInResponse {
+    customClaims?: object;
+    sessionClaims?: object;
+}
+//# sourceMappingURL=firebase-auth-v2.d.ts.map

package/lib/types/firebase-auth-v2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"firebase-auth-v2.d.ts","sourceRoot":"","sources":["../../../src/lib/types/firebase-auth-v2.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAErE,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAClC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/lib/types/function-types.d.ts

@@ -0,0 +1,11 @@
+import type { databaseFunctions, deployDirectories, firestoreFunctions, functionBuilders, functions, httpsFunctions, schedulerFunctions, storageFunctions } from '../constants/index.js';
+export type DatabaseFunction = (typeof databaseFunctions)[number];
+export type FirestoreFunction = (typeof firestoreFunctions)[number];
+export type StorageFunction = (typeof storageFunctions)[number];
+export type SchedulerFunction = (typeof schedulerFunctions)[number];
+export type Function = (typeof functions)[number];
+export type HttpsFunction = (typeof httpsFunctions)[number];
+export type DeployFunction = (typeof functions)[number];
+export type FunctionBuilder = (typeof functionBuilders)[number];
+export type DeployDirectory = (typeof deployDirectories)[number];
+//# sourceMappingURL=function-types.d.ts.map

package/lib/types/function-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-types.d.ts","sourceRoot":"","sources":["../../../src/lib/types/function-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAElD,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/lib/types/functions-cache.d.ts

@@ -0,0 +1,31 @@
+export interface FunctionsCache {
+    [functionName: string]: string;
+}
+/**
+ * Having a cloud-cache.ts file in the root of the project allows you to fetch
+ * and update the cloud cache.
+ *
+ * The name of the function has to be `fetch` and the return type has to be
+ * `FunctionsCache | undefined`.
+ *
+ * @example export const fetch: FunctionsCacheFetch = async () => {
+ *
+ * const doc = await db.doc('cloudCache').get();
+ *
+ * return doc.data() as FunctionsCache; };
+ */
+export type FunctionsCacheFetch = (options: {
+    flavor: string;
+}) => Promise<FunctionsCache | undefined>;
+/**
+ * Having a cloud-cache.ts file in the root of the project allows you to fetch
+ * and update the cloud cache.
+ *
+ * The name of the function has to be `update` and the parameter type has to be
+ * `FunctionsCache`.
+ */
+export type FunctionsCacheUpdate = (options: {
+    newFunctionsCache: FunctionsCache;
+    flavor: string;
+}) => Promise<void>;
+//# sourceMappingURL=functions-cache.d.ts.map

package/lib/types/functions-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions-cache.d.ts","sourceRoot":"","sources":["../../../src/lib/types/functions-cache.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE;IAC1C,MAAM,EAAE,MAAM,CAAC;CAChB,KAAK,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE;IAC3C,iBAAiB,EAAE,cAAc,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/lib/types/helper-generics.d.ts

@@ -0,0 +1,20 @@
+export type CallableFunctions = {
+    [key: string]: [unknown, unknown];
+};
+export type RequestFunctions = {
+    [key: string]: [
+        {
+            [key: string]: unknown;
+        },
+        unknown
+    ];
+};
+export interface CoreData {
+    /**
+     * The document's ID
+     *
+     * @see https://firebase.google.com/docs/reference/node/firebase.firestore.DocumentSnapshot#id
+     */
+    id: string;
+}
+//# sourceMappingURL=helper-generics.d.ts.map

package/lib/types/helper-generics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper-generics.d.ts","sourceRoot":"","sources":["../../../src/lib/types/helper-generics.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb;YACE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB;QACD,OAAO;KACR,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ"}

package/lib/types/helper-options.d.ts

@@ -0,0 +1,81 @@
+import type { ReferenceOptions as FBReferenceOptions } from 'firebase-functions/v2/database';
+import type { DocumentOptions as FBDocumentOptions } from 'firebase-functions/v2/firestore';
+import type { HttpsOptions as FirebaseHttpsOptions } from 'firebase-functions/v2/https';
+import type { GlobalOptions } from 'firebase-functions/v2/options';
+import type { ScheduleOptions as FBScheduleOptions } from 'firebase-functions/v2/scheduler';
+import type { StorageOptions } from 'firebase-functions/v2/storage';
+export type NodeVersion = '14' | '16' | '18' | '20' | '22';
+export interface BaseFunctionOptions<T extends string = string> extends GlobalOptions {
+    /**
+     * The name of the function. If not provided, the name of the function is
+     * the path from the root of the {@link DeployDirectory} directory to the
+     * file. Replacing all `/` and `-` with `_`.
+     *
+     * example // api/stripe/webhook.ts => stripe_webhook
+     *
+     * example // callable/auth/check-email.ts => auth_check_email
+     */
+    functionName?: T;
+    /**
+     * Some packages needs to be installed as external dependencies.
+     *
+     * @example external: ['sharp'] // will npm i sharp in dist
+     */
+    external?: string[];
+    /**
+     * Documentation: https://esbuild.github.io/api/#keep-names
+     *
+     * @default true
+     */
+    keepNames?: boolean;
+    /**
+     * Path to the assets from the project root directory.
+     *
+     * NB this will be placed in the same directory as the function.
+     */
+    assets?: string[];
+    nodeVersion?: NodeVersion;
+}
+export interface HttpsOptions<T extends string | number | symbol = string> extends Omit<BaseFunctionOptions<Extract<T, string>>, 'region'>, FirebaseHttpsOptions {
+}
+export interface DocumentOptions extends Omit<BaseFunctionOptions, 'enforceAppCheck'>, Omit<FBDocumentOptions, 'document'> {
+    /**
+     * The document path where the function will listen for changed in firestore
+     *
+     * If not provided, the document path is the path from the root of the
+     * {@link DeployDirectory} to the file. Replacing all `/` and `-` with `_`.
+     * And replacing all `[]` with `{}`
+     *
+     * example // database/users/[uid]/created.ts => 'users/{uid}'
+     *
+     * example // database/users/[uid]/notifications/[notificationId] =>
+     * 'users/{uid}/notifications/{notificationId}'
+     */
+    document?: string;
+}
+export interface ReferenceOptions extends Omit<BaseFunctionOptions, 'enforceAppCheck'>, FBReferenceOptions {
+    ref: string;
+}
+export interface ScheduleOptions extends BaseFunctionOptions, FBScheduleOptions {
+    /**
+     * When to execute the function. If the function is a scheduled function,
+     * this property is required.
+     *
+     * @see https://firebase.google.com/docs/functions/schedule-functions
+     */
+    schedule: string;
+    /** The timezone to use when determining the function's execution time. */
+    timeZone?: string;
+}
+export interface ObjectTriggerOptions extends Omit<BaseFunctionOptions, 'region'>, StorageOptions {
+}
+export type AuthTriggerOptions = Omit<BaseFunctionOptions, 'region'>;
+export type FunctionOptions = {
+    https: HttpsOptions;
+    firestore: DocumentOptions;
+    scheduler: ScheduleOptions;
+    storage: ObjectTriggerOptions;
+    database: ReferenceOptions;
+    auth: AuthTriggerOptions;
+};
+//# sourceMappingURL=helper-options.d.ts.map

package/lib/types/helper-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper-options.d.ts","sourceRoot":"","sources":["../../../src/lib/types/helper-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC7F,OAAO,KAAK,EAAE,eAAe,IAAI,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,KAAK,EAAE,YAAY,IAAI,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAExF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,IAAI,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACpE,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAE3D,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,aAAa;IACnF;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CACvE,SAAQ,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAC7D,oBAAoB;CAAG;AAE3B,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,EAClD,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC;IACrC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,EAClD,kBAAkB;IACpB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,eAAgB,SAAQ,mBAAmB,EAAE,iBAAiB;IAC7E;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,EAAE,cAAc;CAAG;AAEpG,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;AAErE,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,YAAY,CAAC;IACpB,SAAS,EAAE,eAAe,CAAC;IAC3B,SAAS,EAAE,eAAe,CAAC;IAC3B,OAAO,EAAE,oBAAoB,CAAC;IAC9B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC"}

package/lib/types/index.d.ts

@@ -0,0 +1,10 @@
+export * from './build.js';
+export * from './core.js';
+export * from './deploy.js';
+export * from './firebase-auth-v2.js';
+export * from './function-types.js';
+export * from './functions-cache.js';
+export * from './helper-generics.js';
+export * from './helper-options.js';
+export * from './script.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC"}

package/lib/types/script.d.ts

@@ -0,0 +1,6 @@
+export interface ScriptContext {
+    projectId: string;
+    flavor: string;
+}
+export type ScriptFunction = (context: ScriptContext) => Promise<unknown>;
+//# sourceMappingURL=script.d.ts.map

package/lib/types/script.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../../../src/lib/types/script.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC"}