# Copyright 2019 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

#

# https://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.

name: firestore-translate-text

version: 0.1.18

specVersion: v1beta

tags: [ai]

displayName: Translate Text in Firestore

description:

Translates strings written to a Cloud Firestore collection into multiple

languages (uses Cloud Translation API).

license: Apache-2.0

sourceUrl: https://github.com/firebase/extensions/tree/master/firestore-translate-text

releaseNotesUrl: https://github.com/firebase/extensions/blob/master/firestore-translate-text/CHANGELOG.md

author:

authorName: Firebase

url: https://firebase.google.com

contributors:

- authorName: Chris Bianca

email: chris@csfrequency.com

url: https://github.com/chrisbianca

- authorName: Invertase

email: oss@invertase.io

url: https://github.com/invertase

billingRequired: true

apis:

- apiName: translate.googleapis.com

reason:

To use Google Translate to translate strings into your specified target

languages.

roles:

- role: datastore.user

reason: Allows the extension to write translated strings to Cloud Firestore.

resources:

- name: fstranslate

type: firebaseextensions.v1beta.function

description:

Listens for writes of new strings to your specified Cloud Firestore

collection, translates the strings, then writes the translated strings

back to the same document.

properties:

runtime: nodejs18

eventTrigger:

eventType: providers/cloud.firestore/eventTypes/document.write

resource: projects/${param:PROJECT_ID}/databases/(default)/documents/${param:COLLECTION_PATH}/{messageId}

- name: fstranslatebackfill

type: firebaseextensions.v1beta.function

description:

Searches your specified Cloud Firestore collection for existing documents,

translates the strings into any missing languages, then writes the

translated strings back to the same document.

properties:

runtime: nodejs18

availableMemoryMb: 1024

timeout: 540s

taskQueueTrigger: {}

params:

- param: LANGUAGES

label: Target languages for translations, as a comma-separated list

description: >

Into which target languages do you want to translate new strings? The

languages are identified using ISO-639-1 codes in a comma-separated list,

for example: en,es,de,fr. For these codes, visit the [supported languages

list](https://cloud.google.com/translate/docs/languages).

example: en,es,de,fr

validationRegex: "^[a-zA-Z,-]*[a-zA-Z-]{2,}$"

validationErrorMessage:

Languages must be a comma-separated list of ISO-639-1 language codes.

default: en,es,de,fr

required: true

- param: COLLECTION_PATH

label: Collection path

description: >

What is the path to the collection that contains the strings that you want

to translate?

example: translations

validationRegex: "^[^/]+(/[^/]+/[^/]+)*$"

validationErrorMessage: Must be a valid Cloud Firestore Collection

default: translations

required: true

- param: INPUT_FIELD_NAME

label: Input field name

description: >

What is the name of the field that contains the string that you want to

translate?

example: input

default: input

required: true

- param: OUTPUT_FIELD_NAME

label: Translations output field name

description: >

What is the name of the field where you want to store your translations?

example: translated

default: translated

required: true

- param: LANGUAGES_FIELD_NAME

label: Languages field name

description: >

What is the name of the field that contains the languages that you want to

translate into? This field is optional. If you don't specify it, the

extension will use the languages specified in the LANGUAGES parameter.

example: languages

default: languages

required: false

# - param: DO_BACKFILL

# label: Translate existing documents?

# description: >

# Should existing documents in the Firestore collection be translated as

# well? If you've added new languages since a document was translated, this

# will fill those in as well.

# type: select

# required: true

# options:

# - label: Yes

# value: true

# - label: No

# value: false

events:

- type: firebase.extensions.firestore-translate-text.v1.onStart

description:

Occurs when a trigger has been called within the Extension, and will

include data such as the context of the trigger request.

- type: firebase.extensions.firestore-translate-text.v1.onSuccess

description:

Occurs when image resizing completes successfully. The event will contain

further details about specific formats and sizes.

- type: firebase.extensions.firestore-translate-text.v1.onError

description:

Occurs when an issue has been experienced in the Extension. This will

include any error data that has been included within the Error Exception.

- type: firebase.extensions.firestore-translate-text.v1.onCompletion

description:

Occurs when the function is settled. Provides no customized data other

than the context.

# lifecycleEvents:

# onInstall:

# function: fstranslatebackfill

# processingMessage: "Translating existing documents in ${COLLECTION_PATH}"

# onUpdate:

# function: fstranslatebackfill

# processingMessage: "Translating existing documents in ${COLLECTION_PATH}"

# onConfigure:

# function: fstranslatebackfill

# processingMessage: "Translating existing documents in ${COLLECTION_PATH}"