Merge pull request #5 from appwrite/feat-url-shortener

feat: URL Shortener function

node/url-shortener/.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/url-shortener/.prettierrc.json

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

node/url-shortener/README.md

@@ -0,0 +1,116 @@
+# 🔗 Node.js URL Shortener Function
+
+Generate URL with short ID and redirect to the original URL when visited.
+
+## 🧰 Usage
+
+### `GET /:shortId`
+
+Redirects to shortId's original URL.
+
+**Parameters**
+
+| Name    | Description                      | Location | Type   | Sample Value |
+| ------- | -------------------------------- | -------- | ------ | ------------ |
+| shortId | Short ID to lookup original URL. | Path     | String | `discord`    |
+
+**Response**
+
+Sample `302` Response:
+
+Redirects to the original URL.
+
+```text
+Location: https://discord.com/invite/GSeTUeA
+```
+
+Sample `404` Response:
+
+When no URL is found for the short ID.
+
+```text
+Invalid link.
+```
+
+### `POST /`
+
+Create a new short ID for a URL.
+
+**Parameters**
+
+| Name         | Description         | Location | Type               | Sample Value                                                   |
+| ------------ | ------------------- | -------- | ------------------ | -------------------------------------------------------------- |
+| Content-Type | Content type        | Header   | `application/json` |
+| url          | Long URL to shorten | Body     | String             | `https://mywebapp.com/pages/hugelongurl?with=query&params=123` |
+
+**Response**
+
+Sample `200` Response:
+
+Returns the short URL and the original URL. The short URL is constructed from the base URL (`host` header) and the short ID.
+
+```json
+{
+  "url": "https://mywebapp.com/discord"
+}
+```
+
+Sample `400` Response:
+
+When the URL parameter is missing.
+
+```json
+{
+  "ok": false,
+  "error": "Missing url parameter."
+}
+```
+
+## ⚙️ Configuration
+
+| Setting           | Value                          |
+| ----------------- | ------------------------------ |
+| Runtime           | Node (18.0)                    |
+| Entrypoint        | `src/main.js`                  |
+| Build Commands    | `npm install && npm run setup` |
+| Permissions       | `any`                          |
+| Timeout (Seconds) | 15                             |
+
+## 🔒 Environment Variables
+
+### APPWRITE_API_KEY
+
+The API Key to talk to Appwrite backend APIs.
+
+| Question      | Answer                                                                                             |
+| ------------- | -------------------------------------------------------------------------------------------------- |
+| Required      | Yes                                                                                                |
+| Sample Value  | `d1efb...aec35`                                                                                    |
+| Documentation | [Appwrite: Getting Started for Server](https://appwrite.io/docs/getting-started-for-server#apiKey) |
+
+### APPWRITE_ENDPOINT
+
+The URL endpoint of the Appwrite server. 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 short URLs.
+
+| Question     | Answer                        |
+| ------------ | ----------------------------- |
+| Required     | Yes                           |
+| Sample Value | `urlShortener`                 |
+
+### APPWRITE_COLLECTION_ID
+
+The ID of the collection to store the short URLs.
+
+| Question     | Answer                        |
+| ------------ | ----------------------------- |
+| Required     | Yes                           |
+| Sample Value | `urls`                        |

node/url-shortener/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;
+      APPWRITE_DATABASE_ID: string;
+      APPWRITE_COLLECTION_ID: string;
+    }
+  }
+}
+
+export {};