Merge pull request #17 from appwrite/feat-push-notifications-with-fcm

feat: Push Notifications with FCM function
appwrite · Aug 3, 2023 · 03afa49 · 03afa49
2 parents 0cf0833 + a6c5baa
commit 03afa49
Show file tree

Hide file tree

Showing 9 changed files with 2,501 additions and 3 deletions.
diff --git a/kotlin/starter/.gitignore b/kotlin/starter/.gitignore
@@ -52,9 +52,6 @@ captures/
 # External native build folder generated in Android Studio 2.2 and later
 .externalNativeBuild
 
-# Google Services (e.g. APIs or Firebase)
-google-services.json
-
 # Freeline
 freeline.py
 freeline/

diff --git a/node/push-notification-with-fcm/.gitignore b/node/push-notification-with-fcm/.gitignore
@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
diff --git a/node/push-notification-with-fcm/.prettierrc.json b/node/push-notification-with-fcm/.prettierrc.json
@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
+}
diff --git a/node/push-notification-with-fcm/README.md b/node/push-notification-with-fcm/README.md
@@ -0,0 +1,98 @@
+# 🔔 Node.js Push Notifications with FCM Function
+
+Send push notifications to your users using Firebase Cloud Messaging (FCM).
+
+## 🧰 Usage
+
+### `POST`
+
+Send a push notification to a user.
+
+**Parameters**
+
+| Name         | Description                          | Location | Type               | Sample Value   |
+| ------------ | ------------------------------------ | -------- | ------------------ | -------------- |
+| Content-Type | The content type of the request body | Header   | `application/json` | N/A            |
+| deviceToken  | FCM device identifier                | Body     | String             | `642...7cd`    |
+| message      | Message to send                      | Body     | String             | `Hello World!` |
+
+**Response**
+
+Sample `200` Response:
+
+```json
+{
+    "ok": true,
+    "messageId": "as4jg109cbe1"
+}
+```
+
+Sample `400` Response:
+
+```json
+{
+    "ok": false,
+    "error": "Device token and message are required."
+}
+```
+
+Sample `500` Response:
+
+```json
+{
+    "ok": false,
+    "error": "Failed to send the message."
+}
+```
+
+## ⚙️ Configuration
+
+| Setting           | Value         |
+| ----------------- | ------------- |
+| Runtime           | Node (18.0)   |
+| Entrypoint        | `src/main.js` |
+| Build Commands    | `npm install` |
+| Permissions       | `any`         |
+| Timeout (Seconds) | 15            |
+
+## 🔒 Environment Variables
+
+### FCM_PROJECT_ID
+
+A unique identifier for your FCM project.
+
+| Question      | Answer                                                                                             |
+| ------------- | -------------------------------------------------------------------------------------------------- |
+| Required      | Yes                                                                                                |
+| Sample Value  | `mywebapp-f6e57`                                                                                   |
+| Documentation | [FCM: Project ID](https://firebase.google.com/docs/projects/learn-more#project-id)                 |
+
+### FCM_CLIENT_EMAIL
+
+Your FCM service account email.
+
+| Question      | Answer                                                                                             |
+| ------------- | -------------------------------------------------------------------------------------------------- |
+| Required      | Yes                                                                                                |
+| Sample Value  | `[email protected]`                                            |
+| Documentation | [FCM: SDK Setup](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments) |
+
+### FCM_PRIVATE_KEY
+
+A unique private key used to authenticate with FCM.
+
+| Question      | Answer                                                                                             |
+| ------------- | -------------------------------------------------------------------------------------------------- |
+| Required      | Yes                                                                                                |
+| Sample Value | `0b6830cc66d92804e11af2153242d34211d675675`                                                         |
+| Documentation | [FCM: SDK Setup](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments) |
+
+### FCM_DATABASE_URL
+
+URL of your FCM database.
+
+| Question      | Answer                                                                                             |
+| ------------- | -------------------------------------------------------------------------------------------------- |
+| Required      | Yes                                                                                                |
+| Sample Value | `https://my-app-e398e.firebaseio.com`                                                               |
+| Documentation | [FCM: SDK Setup](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments) |
diff --git a/node/push-notification-with-fcm/env.d.ts b/node/push-notification-with-fcm/env.d.ts
@@ -0,0 +1,12 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      FCM_PROJECT_ID: string;
+      FCM_CLIENT_EMAIL: string;
+      FCM_PRIVATE_KEY: string;
+      FCM_DATABASE_URL: string;
+    }
+  }
+}
+
+export {};