extension.yaml

# Learn detailed information about the fields of an extension.yaml file in the docs:
# https://firebase.google.com/docs/extensions/reference/extension-yaml

# Identifier for your extension
# TODO: Replace this with an descriptive name for your extension.
name: firebase-auth-outbox
version: 0.0.1  # Follow semver versioning
specVersion: v1beta  # Version of the Firebase Extensions specification

# Friendly display name for your extension (~3-5 words)
displayName: Firebase Auth Outbox Extension

# Brief description of the task your extension performs (~1 sentence)
description: >-
  Publishes events from firebase authentication to a broker

license: Apache-2.0  # https://spdx.org/licenses/

# Public URL for the source code of your extension.
# TODO:  Replace this with your GitHub repo.
sourceUrl: https://github.com/teaglebuilt/firebase-auth-outbox-extension

# Specify whether a paid-tier billing plan is required to use your extension.
# Learn more in the docs: https://firebase.google.com/docs/extensions/reference/extension-yaml#billing-required-field
billingRequired: false

author:
  authorName: Dillan Teagle
  email: dillan.teagle.va@gmail.com
  url: https://github.com/teaglebuilt
contributors:
  - authorName: Dillan Teagle

# In an `apis` field, list any Google APIs (like Cloud Translation, BigQuery, etc.)
# required for your extension to operate.
# Learn more in the docs:
# https://firebase.google.com/docs/extensions/reference/extension-yaml#apis-field

# In a `roles` field, list any IAM access roles required for your extension to operate.
# Learn more in the docs:
# https://firebase.google.com/docs/extensions/reference/extension-yaml#roles-field

# In the `resources` field, list each of your extension's functions, including the trigger for each function.
# Learn more in the docs:
# https://firebase.google.com/docs/extensions/reference/extension-yaml#resources-field
resources:
  - name: producerUserCreatedEvent
    type: firebaseextensions.v1beta.function
    description: >-
      Publish user created events to kafka
    properties:
      location: ${LOCATION}
      eventTrigger:
        eventType: providers/firebase.auth/eventTypes/user.create
        resource: projects/${PROJECT_ID}
      runtime: "nodejs16"

  - name: producerUserDeletedEvent
    type: firebaseextensions.v1beta.function
    description: >-
      Publish user deleted events to kafka
    properties:
      location: ${LOCATION}
      eventTrigger:
        eventType: providers/firebase.auth/eventTypes/user.delete
        resource: projects/${PROJECT_ID}
      runtime: "nodejs16"

  - name: producerSignInEvent
    type: firebaseextensions.v1beta.function
    description: >-
      Publish user deleted events to kafka
    properties:
      location: ${LOCATION}
      eventTrigger:
        eventType: providers/firebase.auth/eventTypes/user.delete
        resource: projects/${PROJECT_ID}
      runtime: "nodejs16"

# In the `params` field, set up your extension's user-configured parameters.
# Learn more in the docs:
# https://firebase.google.com/docs/extensions/reference/extension-yaml#params-field
params:
  - param: BROKER
    label: Broker URL
    description: "url of broker example: https://kafka.domain-name.com:9092"
    type: string
  - param: TOPIC
    label: Name of Topic
    description: Name of the topic you will be publishing messages to
    type: string
  - param: FIELDS_TO_INCLUDED
    label: Fields to include
    description: >-
      Select the fields from the user record that you want to include in the
      event. If you select a field that does not exist in the user
      record, it will be ignored.
    type: multiSelect
    options:
      - label: uid
        value: uid
      - label: email
        value: email
      - label: emailVerified
        value: emailVerified
      - label: displayName
        value: displayName
      - label: photoURL
        value: photoURL
      - label: phoneNumber
        value: phoneNumber
      - label: disabled
        value: disabled
      - label: creationTime
        value: creationTime
  - param: LOCATION
    label: Cloud Functions location
    description: >-
      Where do you want to deploy the functions created for this extension?
      For help selecting a location, refer to the [location selection
      guide](https://firebase.google.com/docs/functions/locations).
    type: select
    options:
      - label: Iowa (us-central1)
        value: us-central1
      - label: South Carolina (us-east1)
        value: us-east1
      - label: Northern Virginia (us-east4)
        value: us-east4
      - label: Los Angeles (us-west2)
        value: us-west2
      - label: Salt Lake City (us-west3)
        value: us-west3
      - label: Las Vegas (us-west4)
        value: us-west4
      - label: Warsaw (europe-central2)
        value: europe-central2
      - label: Belgium (europe-west1)
        value: europe-west1
      - label: London (europe-west2)
        value: europe-west2
      - label: Frankfurt (europe-west3)
        value: europe-west3
      - label: Zurich (europe-west6)
        value: europe-west6
      - label: Hong Kong (asia-east2)
        value: asia-east2
      - label: Tokyo (asia-northeast1)
        value: asia-northeast1
      - label: Osaka (asia-northeast2)
        value: asia-northeast2
      - label: Seoul (asia-northeast3)
        value: asia-northeast3
      - label: Mumbai (asia-south1)
        value: asia-south1
      - label: Jakarta (asia-southeast2)
        value: asia-southeast2
      - label: Montreal (northamerica-northeast1)
        value: northamerica-northeast1
      - label: Sao Paulo (southamerica-east1)
        value: southamerica-east1
      - label: Sydney (australia-southeast1)
        value: australia-southeast1
    required: true
    immutable: true