@depup/firebase__ai 2.9.0-depup.0

package/dist/src/types/imagen/internal.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @license
+ * Copyright 2025 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 { ImagenGenerationConfig, ImagenSafetySettings } from './requests';
+/**
+ * A response from the REST API is expected to look like this in the success case:
+ * {
+ *   "predictions": [
+ *     {
+ *       "mimeType": "image/png",
+ *       "bytesBase64Encoded": "iVBORw0KG..."
+ *     },
+ *     {
+ *       "mimeType": "image/png",
+ *       "bytesBase64Encoded": "i4BOtw0KG..."
+ *     }
+ *   ]
+ * }
+ *
+ * And like this in the failure case:
+ * {
+ *   "predictions": [
+ *     {
+ *       "raiFilteredReason": "..."
+ *     }
+ *   ]
+ * }
+ *
+ * @internal
+ */
+export interface ImagenResponseInternal {
+    predictions?: Array<{
+        /**
+         * The MIME type of the generated image.
+         */
+        mimeType?: string;
+        /**
+         * The image data encoded as a base64 string.
+         */
+        bytesBase64Encoded?: string;
+        /**
+         * The GCS URI where the image was stored.
+         */
+        gcsUri?: string;
+        /**
+         * The reason why the image was filtered.
+         */
+        raiFilteredReason?: string;
+        /**
+         * The safety attributes.
+         *
+         * This type is currently unused in the SDK. It is sent back because our requests set
+         * `includeSafetyAttributes`. This property is currently only used to avoid throwing an error
+         * when encountering this unsupported prediction type.
+         */
+        safetyAttributes?: unknown;
+    }>;
+}
+/**
+ * The parameters to be sent in the request body of the HTTP call
+ * to the Vertex AI backend.
+ *
+ * We need a separate internal-only interface for this because the REST
+ * API expects different parameter names than what we show to our users.
+ *
+ * Sample request body JSON:
+ * {
+ *   "instances": [
+ *     {
+ *       "prompt": "Portrait of a golden retriever on a beach."
+ *     }
+ *   ],
+ *   "parameters": {
+ *     "mimeType": "image/png",
+ *     "safetyFilterLevel": "block_low_and_above",
+ *     "personGeneration": "allow_all",
+ *     "sampleCount": 2,
+ *     "includeRaiReason": true,
+ *     "includeSafetyAttributes": true,
+ *     "aspectRatio": "9:16"
+ *   }
+ * }
+ *
+ * See the Google Cloud docs: https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#-drest
+ *
+ * @internal
+ */
+export interface PredictRequestBody {
+    instances: [
+        {
+            prompt: string;
+        }
+    ];
+    parameters: {
+        sampleCount: number;
+        aspectRatio?: string;
+        outputOptions?: {
+            mimeType: string;
+            compressionQuality?: number;
+        };
+        negativePrompt?: string;
+        storageUri?: string;
+        addWatermark?: boolean;
+        safetyFilterLevel?: string;
+        personGeneration?: string;
+        includeRaiReason: boolean;
+        includeSafetyAttributes: boolean;
+    };
+}
+/**
+ * Contains all possible REST API paramaters that are provided by the caller.
+ *
+ * @internal
+ */
+export type ImagenGenerationParams = {
+    /**
+     * The Cloud Storage for Firebase bucket URI where the images should be stored
+     * (for GCS requests only).
+     */
+    gcsURI?: string;
+} & ImagenGenerationConfig & ImagenSafetySettings;

package/dist/src/types/imagen/requests.d.ts

@@ -0,0 +1,245 @@
+/**
+ * @license
+ * Copyright 2025 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 { ImagenImageFormat } from '../../requests/imagen-image-format';
+/**
+ * Parameters for configuring an {@link ImagenModel}.
+ *
+ * @public
+ */
+export interface ImagenModelParams {
+    /**
+     * The Imagen model to use for generating images.
+     * For example: `imagen-3.0-generate-002`.
+     *
+     * Only Imagen 3 models (named `imagen-3.0-*`) are supported.
+     *
+     * See {@link https://firebase.google.com/docs/vertex-ai/models | model versions}
+     * for a full list of supported Imagen 3 models.
+     */
+    model: string;
+    /**
+     * Configuration options for generating images with Imagen.
+     */
+    generationConfig?: ImagenGenerationConfig;
+    /**
+     * Safety settings for filtering potentially inappropriate content.
+     */
+    safetySettings?: ImagenSafetySettings;
+}
+/**
+ * Configuration options for generating images with Imagen.
+ *
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images-imagen | documentation} for
+ * more details.
+ *
+ * @public
+ */
+export interface ImagenGenerationConfig {
+    /**
+     * A description of what should be omitted from the generated images.
+     *
+     * Support for negative prompts depends on the Imagen model.
+     *
+     * See the {@link http://firebase.google.com/docs/vertex-ai/model-parameters#imagen | documentation} for more details.
+     *
+     * This is no longer supported in the Gemini Developer API ({@link GoogleAIBackend}) in versions
+     * greater than `imagen-3.0-generate-002`.
+     */
+    negativePrompt?: string;
+    /**
+     * The number of images to generate. The default value is 1.
+     *
+     * The number of sample images that may be generated in each request depends on the model
+     * (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">sampleCount</a>
+     * documentation for more details.
+     */
+    numberOfImages?: number;
+    /**
+     * The aspect ratio of the generated images. The default value is square 1:1.
+     * Supported aspect ratios depend on the Imagen model, see {@link (ImagenAspectRatio:type)}
+     * for more details.
+     */
+    aspectRatio?: ImagenAspectRatio;
+    /**
+     * The image format of the generated images. The default is PNG.
+     *
+     * See {@link ImagenImageFormat} for more details.
+     */
+    imageFormat?: ImagenImageFormat;
+    /**
+     * Whether to add an invisible watermark to generated images.
+     *
+     * If set to `true`, an invisible SynthID watermark is embedded in generated images to indicate
+     * that they are AI generated. If set to `false`, watermarking will be disabled.
+     *
+     * For Imagen 3 models, the default value is `true`; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">addWatermark</a>
+     * documentation for more details.
+     *
+     * When using the Gemini Developer API ({@link GoogleAIBackend}), this will default to true,
+     * and cannot be turned off.
+     */
+    addWatermark?: boolean;
+}
+/**
+ * A filter level controlling how aggressively to filter sensitive content.
+ *
+ * Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI
+ * are assessed against a list of safety filters, which include 'harmful categories' (for example,
+ * `violence`, `sexual`, `derogatory`, and `toxic`). This filter level controls how aggressively to
+ * filter out potentially harmful content from responses. See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
+ * for more details.
+ *
+ * @public
+ */
+export declare const ImagenSafetyFilterLevel: {
+    /**
+     * The most aggressive filtering level; most strict blocking.
+     */
+    readonly BLOCK_LOW_AND_ABOVE: "block_low_and_above";
+    /**
+     * Blocks some sensitive prompts and responses.
+     */
+    readonly BLOCK_MEDIUM_AND_ABOVE: "block_medium_and_above";
+    /**
+     * Blocks few sensitive prompts and responses.
+     */
+    readonly BLOCK_ONLY_HIGH: "block_only_high";
+    /**
+     * The least aggressive filtering level; blocks very few sensitive prompts and responses.
+     *
+     * Access to this feature is restricted and may require your case to be reviewed and approved by
+     * Cloud support.
+     */
+    readonly BLOCK_NONE: "block_none";
+};
+/**
+ * A filter level controlling how aggressively to filter sensitive content.
+ *
+ * Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI
+ * are assessed against a list of safety filters, which include 'harmful categories' (for example,
+ * `violence`, `sexual`, `derogatory`, and `toxic`). This filter level controls how aggressively to
+ * filter out potentially harmful content from responses. See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
+ * for more details.
+ *
+ * @public
+ */
+export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typeof ImagenSafetyFilterLevel];
+/**
+ * A filter level controlling whether generation of images containing people or faces is allowed.
+ *
+ * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
+ * documentation for more details.
+ *
+ * @public
+ */
+export declare const ImagenPersonFilterLevel: {
+    /**
+     * Disallow generation of images containing people or faces; images of people are filtered out.
+     */
+    readonly BLOCK_ALL: "dont_allow";
+    /**
+     * Allow generation of images containing adults only; images of children are filtered out.
+     *
+     * Generation of images containing people or faces may require your use case to be
+     * reviewed and approved by Cloud support; see the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen | Responsible AI and usage guidelines}
+     * for more details.
+     */
+    readonly ALLOW_ADULT: "allow_adult";
+    /**
+     * Allow generation of images containing adults only; images of children are filtered out.
+     *
+     * Generation of images containing people or faces may require your use case to be
+     * reviewed and approved by Cloud support; see the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen | Responsible AI and usage guidelines}
+     * for more details.
+     */
+    readonly ALLOW_ALL: "allow_all";
+};
+/**
+ * A filter level controlling whether generation of images containing people or faces is allowed.
+ *
+ * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
+ * documentation for more details.
+ *
+ * @public
+ */
+export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typeof ImagenPersonFilterLevel];
+/**
+ * Settings for controlling the aggressiveness of filtering out sensitive content.
+ *
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * for more details.
+ *
+ * @public
+ */
+export interface ImagenSafetySettings {
+    /**
+     * A filter level controlling how aggressive to filter out sensitive content from generated
+     * images.
+     */
+    safetyFilterLevel?: ImagenSafetyFilterLevel;
+    /**
+     * A filter level controlling whether generation of images containing people or faces is allowed.
+     */
+    personFilterLevel?: ImagenPersonFilterLevel;
+}
+/**
+ * Aspect ratios for Imagen images.
+ *
+ * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
+ * {@link ImagenGenerationConfig}.
+ *
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * for more details and examples of the supported aspect ratios.
+ *
+ * @public
+ */
+export declare const ImagenAspectRatio: {
+    /**
+     * Square (1:1) aspect ratio.
+     */
+    readonly SQUARE: "1:1";
+    /**
+     * Landscape (3:4) aspect ratio.
+     */
+    readonly LANDSCAPE_3x4: "3:4";
+    /**
+     * Portrait (4:3) aspect ratio.
+     */
+    readonly PORTRAIT_4x3: "4:3";
+    /**
+     * Landscape (16:9) aspect ratio.
+     */
+    readonly LANDSCAPE_16x9: "16:9";
+    /**
+     * Portrait (9:16) aspect ratio.
+     */
+    readonly PORTRAIT_9x16: "9:16";
+};
+/**
+ * Aspect ratios for Imagen images.
+ *
+ * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
+ * {@link ImagenGenerationConfig}.
+ *
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * for more details and examples of the supported aspect ratios.
+ *
+ * @public
+ */
+export type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];

package/dist/src/types/imagen/responses.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @license
+ * Copyright 2025 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.
+ */
+/**
+ * An image generated by Imagen, represented as inline data.
+ *
+ * @public
+ */
+export interface ImagenInlineImage {
+    /**
+     * The MIME type of the image; either `"image/png"` or `"image/jpeg"`.
+     *
+     * To request a different format, set the `imageFormat` property in your {@link ImagenGenerationConfig}.
+     */
+    mimeType: string;
+    /**
+     * The base64-encoded image data.
+     */
+    bytesBase64Encoded: string;
+}
+/**
+ * An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
+ *
+ * This feature is not available yet.
+ * @public
+ */
+export interface ImagenGCSImage {
+    /**
+     * The MIME type of the image; either `"image/png"` or `"image/jpeg"`.
+     *
+     * To request a different format, set the `imageFormat` property in your {@link ImagenGenerationConfig}.
+     */
+    mimeType: string;
+    /**
+     * The URI of the file stored in a Cloud Storage for Firebase bucket.
+     *
+     * @example `"gs://bucket-name/path/sample_0.jpg"`.
+     */
+    gcsURI: string;
+}
+/**
+ * The response from a request to generate images with Imagen.
+ *
+ * @public
+ */
+export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGCSImage> {
+    /**
+     * The images generated by Imagen.
+     *
+     * The number of images generated may be fewer than the number requested if one or more were
+     * filtered out; see `filteredReason`.
+     */
+    images: T[];
+    /**
+     * The reason that images were filtered out. This property will only be defined if one
+     * or more images were filtered.
+     *
+     * Images may be filtered out due to the {@link (ImagenSafetyFilterLevel:type)},
+     * {@link (ImagenPersonFilterLevel:type)}, or filtering included in the model.
+     * The filter levels may be adjusted in your {@link ImagenSafetySettings}.
+     *
+     * See the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen | Responsible AI and usage guidelines for Imagen}
+     * for more details.
+     */
+    filteredReason?: string;
+}

package/dist/src/types/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+export * from './content';
+export * from './enums';
+export * from './requests';
+export * from './responses';
+export * from './error';
+export * from './schema';
+export * from './imagen';
+export * from './googleai';
+export { LanguageModelCreateOptions, LanguageModelCreateCoreOptions, LanguageModelExpected, LanguageModelMessage, LanguageModelMessageContent, LanguageModelMessageContentValue, LanguageModelMessageRole, LanguageModelMessageType, LanguageModelPromptOptions } from './language-model';
+export * from './chrome-adapter';

package/dist/src/types/internal.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2024 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 { AppCheckTokenResult } from '@firebase/app-check-interop-types';
+import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
+import { Backend } from '../backend';
+import { InferenceMode } from './enums';
+export * from './imagen/internal';
+export interface ApiSettings {
+    apiKey: string;
+    project: string;
+    appId: string;
+    automaticDataCollectionEnabled?: boolean;
+    /**
+     * @deprecated Use `backend.location` instead.
+     */
+    location: string;
+    backend: Backend;
+    getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
+    getAppCheckToken?: () => Promise<AppCheckTokenResult>;
+    inferenceMode?: InferenceMode;
+}

package/dist/src/types/language-model.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @license
+ * Copyright 2025 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.
+ */
+/**
+ * The subset of the Prompt API
+ * (see {@link https://github.com/webmachinelearning/prompt-api#full-api-surface-in-web-idl }
+ * required for hybrid functionality.
+ *
+ * @internal
+ */
+export interface LanguageModel extends EventTarget {
+    create(options?: LanguageModelCreateOptions): Promise<LanguageModel>;
+    availability(options?: LanguageModelCreateCoreOptions): Promise<Availability>;
+    prompt(input: LanguageModelPrompt, options?: LanguageModelPromptOptions): Promise<string>;
+    promptStreaming(input: LanguageModelPrompt, options?: LanguageModelPromptOptions): ReadableStream;
+    measureInputUsage(input: LanguageModelPrompt, options?: LanguageModelPromptOptions): Promise<number>;
+    destroy(): undefined;
+}
+/**
+ * @internal
+ */
+export declare enum Availability {
+    'UNAVAILABLE' = "unavailable",
+    'DOWNLOADABLE' = "downloadable",
+    'DOWNLOADING' = "downloading",
+    'AVAILABLE' = "available"
+}
+/**
+ * Configures the creation of an on-device language model session.
+ * @beta
+ */
+export interface LanguageModelCreateCoreOptions {
+    topK?: number;
+    temperature?: number;
+    expectedInputs?: LanguageModelExpected[];
+}
+/**
+ * Configures the creation of an on-device language model session.
+ * @beta
+ */
+export interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
+    signal?: AbortSignal;
+    initialPrompts?: LanguageModelMessage[];
+}
+/**
+ * Options for an on-device language model prompt.
+ * @beta
+ */
+export interface LanguageModelPromptOptions {
+    responseConstraint?: object;
+}
+/**
+ * Options for the expected inputs for an on-device language model.
+ * @beta
+ */ export interface LanguageModelExpected {
+    type: LanguageModelMessageType;
+    languages?: string[];
+}
+/**
+ * An on-device language model prompt.
+ * @beta
+ */
+export type LanguageModelPrompt = LanguageModelMessage[];
+/**
+ * An on-device language model message.
+ * @beta
+ */
+export interface LanguageModelMessage {
+    role: LanguageModelMessageRole;
+    content: LanguageModelMessageContent[];
+}
+/**
+ * An on-device language model content object.
+ * @beta
+ */
+export interface LanguageModelMessageContent {
+    type: LanguageModelMessageType;
+    value: LanguageModelMessageContentValue;
+}
+/**
+ * Allowable roles for on-device language model usage.
+ * @beta
+ */
+export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
+/**
+ * Allowable types for on-device language model messages.
+ * @beta
+ */
+export type LanguageModelMessageType = 'text' | 'image' | 'audio';
+/**
+ * Content formats that can be provided as on-device message content.
+ * @beta
+ */
+export type LanguageModelMessageContentValue = ImageBitmapSource | AudioBuffer | BufferSource | string;