https://github.com/teaglebuilt/firebase-auth-outbox-extension
Publish events from firebase auth to a broker
https://github.com/teaglebuilt/firebase-auth-outbox-extension
firebase firebase-auth firebase-extensions
Last synced: about 1 month ago
JSON representation
Publish events from firebase auth to a broker
- Host: GitHub
- URL: https://github.com/teaglebuilt/firebase-auth-outbox-extension
- Owner: teaglebuilt
- Created: 2023-09-09T16:53:31.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-09T20:47:42.000Z (almost 3 years ago)
- Last Synced: 2025-03-04T00:44:03.356Z (over 1 year ago)
- Topics: firebase, firebase-auth, firebase-extensions
- Language: TypeScript
- Homepage:
- Size: 134 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Firebase Auth Outbox Extension
[](https://github.com/teaglebuilt/firebase-auth-outbox-extension/actions/workflows/main.yaml)
Publishes events raised from firebase authentication to a broker of choosing. The extension refers to outbox since this data is persisted, however some events in this extension can be captured that occur before a persisted action occurs.
#### Events Captured
Currently, here are the events available to produce. Events are labeled as 1st or 2nd class citizens under the scope of firebase. Therefore, these events
* _2nd Class_ `User Created`
* _2nd Class_ `User Deleted`
* _1st Class_ `On User Sign In`
#### Broker Clients Available
Two parameters are required.
- `Broker` - `https://broker.com:9092`
- `Topic` - `my-topic-to-publish-events-to`
1. **Kafka** - Uses [KafkaJS](https://kafka.js.org/docs/getting-started) and is currently the only supported client.
2. **NATS** - Next supported client on the list
### Installation
Visit extension in firebase extensions store [here](https://console.firebase.google.com/project/teaglebuilt-6226f/publisher/extensions/firebase-auth-outbox/v/0.0.1-beta.0).
You can also click [this link](https://console.firebase.google.com/project/teaglebuilt-6226f/publisher/extensions/firebase-auth-outbox/v/0.0.1-beta.0) to directly install the extension, assuming you already have firebase and authentication setup.