Merge pull request #2 from appwrite/feat-subscriptions-with-stripe

node/payments-with-stripe/.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.*

node/payments-with-stripe/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
+}

node/payments-with-stripe/README.md

@@ -0,0 +1,129 @@
+# 💳 Node.js Stripe Payments Function
+
+Receive card payments and store paid orders.
+
+## 🧰 Usage
+
+### `POST /checkout`
+
+This endpoint initiates a Stripe checkout session. The user ID is fetched from the headers of the request. If the user ID is not found or a Stripe checkout session could not be created, the request will be redirected to a cancel URL.
+
+**Parameters**
+
+| Name               | Description                                               | Location | Type               | Sample Value                |
+| ------------------ | --------------------------------------------------------- | -------- | ------------------ | --------------------------- |
+| x-appwrite-user-id | User ID from Appwrite.                                    | Header   | String             | 642...7cd                   |
+| Content-Type       | The content type of the request body                      | Header   | `application/json` | N/A                         |
+| successUrl         | The URL to redirect to after a successful payment.        | Body     | String             | https://example.com/success |
+| failureUrl         | The URL to redirect to after a cancelled payment attempt. | Body     | String             | https://example.com/failure |
+
+**Response**
+
+Sample `303` Response:
+
+The response is a redirect to the Stripe checkout session URL or to the cancel URL if an error occurs
+
+```text
+Location: https://checkout.stripe.com/pay/cs_test_...#fidkdWxOYHwnP
+```
+
+```text
+Location: https://mywebapp.com/cancel
+```
+
+### `POST /webhook`
+
+This endpoint is a webhook that handles Stripe event `checkout.session.completed`. It validates the incoming request using the Stripe's validateWebhook method. If the validation fails, a `401` response is sent.
+
+**Parameters**
+
+| Name | Description                  | Location | Type   | Sample Value                                                          |
+| ---- | ---------------------------- | -------- | ------ | --------------------------------------------------------------------- |
+| None | Webhook payload from Stripe. | Body     | Object | [See Stripe documentation](https://stripe.com/docs/api/events/object) |
+
+**Response**
+
+Sample `200` Response:
+
+In case of `checkout.session.completed` event, document for the order is created in Appwrite Database.
+
+```json
+{ "success": true }
+```
+
+Sample `401` Response:
+
+```json
+{ "success": false }
+```
+
+## ⚙️ Configuration
+
+| Setting           | Value                          |
+| ----------------- | ------------------------------ |
+| Runtime           | Node (18.0)                    |
+| Entrypoint        | `src/main.js`                  |
+| Build Commands    | `npm install && npm run setup` |
+| Permissions       | `any`                          |
+| Timeout (Seconds) | 15                             |
+
+> If using a demo web app to create order, make sure to add your function domain as a web platform to your Appwrite project. Doing this fixes CORS errors and allows proper functionality.
+
+## 🔒 Environment Variables
+
+### APPWRITE_API_KEY
+
+Your Appwrite project's API key.
+
+| Question      | Answer                                                                                                                                    |
+| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| Required      | Yes                                                                                                                                       |
+| Sample Value  | `083d341ee48...`                                                                                                                          |
+| Documentation | [Appwrite: Create an API key](https://appwrite.io/docs/keys#:~:text=To%20create%20a%20new%20API,scope%20to%20grant%20your%20application.) |
+
+### APPWRITE_ENDPOINT
+
+The endpoint where your Appwrite server is located. If not provided, it defaults to the Appwrite Cloud server: `https://cloud.appwrite.io/v1`.
+
+| Question     | Answer                         |
+| ------------ | ------------------------------ |
+| Required     | No                             |
+| Sample Value | `https://cloud.appwrite.io/v1` |
+
+### APPWRITE_DATABASE_ID
+
+The ID of the database to store the orders.
+
+| Question     | Answer |
+| ------------ | ------ |
+| Required     | No     |
+| Sample Value | `main` |
+
+### APPWRITE_COLLECTION_ID
+
+The ID of the collection to store the orders.
+
+| Question     | Answer   |
+| ------------ | -------- |
+| Required     | No       |
+| Sample Value | `orders` |
+
+### STRIPE_SECRET_KEY
+
+Secret for sending requests to the Stripe API.
+
+| Question      | Answer                                           |
+| ------------- | ------------------------------------------------ |
+| Required      | Yes                                              |
+| Sample Value  | `sk_test_51J...`                                 |
+| Documentation | [Stripe: API Keys](https://stripe.com/docs/keys) |
+
+### STRIPE_WEBHOOK_SECRET
+
+Secret used to validate the Stripe Webhook signature.
+
+| Question      | Answer                                               |
+| ------------- | ---------------------------------------------------- |
+| Required      | Yes                                                  |
+| Sample Value  | `whsec_...`                                          |
+| Documentation | [Stripe: Webhooks](https://stripe.com/docs/webhooks) |

node/payments-with-stripe/env.d.ts

@@ -0,0 +1,13 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      APPWRITE_ENDPOINT?: string;
+      APPWRITE_FUNCTION_PROJECT_ID: string;
+      APPWRITE_API_KEY: string;
+      STRIPE_SECRET_KEY: string;
+      STRIPE_WEBHOOK_SECRET: string;
+    }
+  }
+}
+
+export {};