@vyckr/tachyon 0.1.0

package/.env.example

@@ -0,0 +1,24 @@
+# Tachyon environment variables
+PORT=8000
+ALLOW_HEADERS=*
+ALLOW_ORGINS=*
+ALLOW_CREDENTIALS=true|false
+ALLOW_EXPOSE_HEADERS=*
+ALLOW_MAX_AGE=3600
+ALLOW_METHODS=GET,POST,PUT,DELETE,PATCH
+PRODUCTION=true|false
+SAVE_LOGS=true|false
+SAVE_STATS=true|false
+SAVE_REQUESTS=true|false
+SAVE_ERRORS=true|false
+
+# BYOS environment variables
+DB_DIR=/path/to/disk/database
+SCHEMA=LOOSE|STRICT
+LOGGING=true|false
+SCHEMA_PATH=/path/to/schema/directory
+MEM_DR=/path/to/memory/database
+S3_REGION=region
+S3_INDEX_BUCKET=bucket
+S3_DATA_BUCKET=bucket
+S3_ENDPOINT=https//example.com

package/Dockerfile

@@ -0,0 +1,43 @@
+FROM oven/bun:latest AS build
+
+RUN apt-get update && apt-get install -y unzip git
+
+WORKDIR /app
+
+RUN git clone https://github.com/oven-sh/bun.git
+
+WORKDIR /app/bun/packages/bun-lambda
+
+RUN bun install
+
+RUN bun run build-layer
+
+RUN unzip bun-lambda-layer.zip -d /tmp
+
+WORKDIR /tmp
+
+COPY ./src/Tach.ts .
+
+COPY package.json .
+
+RUN bun install
+
+RUN bun build --target=bun Tach.ts --outfile lambda
+
+FROM public.ecr.aws/lambda/provided:al2
+
+COPY --from=build /tmp/lambda ${LAMBDA_TASK_ROOT}
+
+COPY --from=build /tmp/bootstrap ${LAMBDA_RUNTIME_DIR}
+
+COPY --from=build /tmp/bun /opt
+
+COPY ./src/runtime.ts /opt
+
+RUN chmod 777 /opt/bun
+
+RUN chmod 777 ${LAMBDA_TASK_ROOT}/lambda
+
+RUN chmod 777 ${LAMBDA_RUNTIME_DIR}/bootstrap
+
+CMD ["lambda.fetch"]

package/README.md

@@ -0,0 +1,124 @@
+# Tachyon
+
+Tachyon is a simple to use API framework built with TypeScript (Bun), which was inspired by Fastly  and FastAPI (Python). Tachyon aim to provide a simple and intuitive API framework for building serverless applications and abstracts away the complexity of configuations, letting you focus on building your application.
+
+## Features
+
+- Has BYOS [(Bring Your Own Storage)](https://github.com/Chidelma/BYOS) integration
+- Use of decorators for routes
+- Customizable methods for routes
+- AWS Lambda support [(Docker)](https://hub.docker.com/repository/docker/iyormobi/tachyon/general)
+- Use of file-system based routing
+- Hot reloading of routes in development mode
+- Supports dynamic routes
+- Supports Async Iterators (Streaming)
+
+## Installation
+
+```bash
+bun add @vyckr/tachyon
+```
+
+## Configuration
+
+The .env file should be in the root directory of your project. The following environment variables:
+```
+# Tachyon environment variables
+PORT=8000 (optional)
+ALLOW_HEADERS=* (optional)
+ALLOW_ORGINS=* (optional)
+ALLOW_CREDENTIALS=true|false (optional)
+ALLOW_EXPOSE_HEADERS=* (optional)
+ALLOW_MAX_AGE=3600 (optional)
+ALLOW_METHODS=GET,POST,PUT,DELETE,PATCH (optional)
+PRODUCTION=true|false (optional)
+SAVE_LOGS=true|false (optional)
+SAVE_STATS=true|false (optional)
+SAVE_REQUESTS=true|false (optional)
+SAVE_ERRORS=true|false (optional)
+
+# BYOS environment variables
+DB_DIR=/path/to/disk/database (required)
+SCHEMA=LOOSE|STRICT (optional)
+LOGGING=true|false (optional)
+SCHEMA_PATH=/path/to/schema/directory (required if SCHEMA is set to STRICT)
+MEM_DR=/path/to/memory/database (optional)
+S3_REGION=region (optional)
+S3_INDEX_BUCKET=bucket (required)
+S3_DATA_BUCKET=bucket (required)
+S3_ENDPOINT=https//example.com (optional)
+```
+
+## Usage/Example
+
+Make sure you have set the 'SCHEMA_PATH' if 'SCHEMA' is set to 'STRICT'. The schema path should be a directory containing the declaration files. for example:
+
+```
+/path/to/schema/directory
+    /users.d.ts
+```
+### Requirements
+- Make sure to have a 'routes' directory in the root of your project
+- Dynamic routes should be enclosed in square brackets
+- The first parameter should NOT be a dynamic route (e.g. /[version]/doc.ts)
+- All dynamic routes should be within odd indexes (e.g. /v1/[path]/login/[id]/name.ts)
+- The last parameter in the route should not be a dynamic route (e.g. /v1/[path]/login/[id]/name.ts)
+
+```typescript
+// routes/v1/[collection]/doc.ts
+import Silo from "@vyckr/byos"
+imoprt { VALIDATE } from "../utils/decorators"
+
+export default class Users {
+
+    static collection = "[collection]"
+
+    @VALIDATE
+    async GET({ slugs }) {
+        return await Silo.findDocs(slugs.get(this.collection), { $limit: 10 })
+    }
+
+    @VALIDATE
+    async POST(user: _user, { slugs }) {
+        return await Silo.putData(slugs.get(this.collection), { name: user.name, age: user.age })
+    }
+
+    @VALIDATE
+    async PATCH(user: _user, { slugs }) {
+        return await Silo.patchDoc(slugs.get(this.collection), { $set: { name: user.name, age: user.age } })
+    }
+
+    @VALIDATE
+    async DELETE(id: string, { slugs }) {
+        await Silo.delDoc(slugs.get(this.collection), id)
+    }   
+}
+```
+
+To run the application, you can use the following command:
+
+```bash 
+bun tach
+```
+
+To invoke the API endpoints, you can use the following commands:
+
+```bash
+curl -X GET http://localhost:8000/v1/users/doc
+```
+
+```bash
+curl -X POST http://localhost:8000/v1/users/doc -d '{"name": "John Doe", "age": 30}'
+```
+
+```bash
+curl -X PATCH http://localhost:8000/v1/users/doc -d '{"name": "Jane Doe", "age": 31}'
+```
+
+```bash
+curl -X DELETE http://localhost:8000/v1/users/doc/5e8b0a9c-c0d1-4d3b-a0b1-e2d8e0e9a1c0
+```
+
+# License
+
+Tachyon is licensed under the MIT License.

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@vyckr/tachyon",
+  "version": "0.1.0",
+  "devDependencies": {
+    "@types/node": "^20.4.2",
+    "bun-types": "^1.1.21"
+  },
+  "dependencies": {
+    "@vyckr/byos": "^0.1.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts"
+    }
+  },
+  "bin": {
+    "tach": "./src/Yon.ts"
+  },
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Chidelma/Tachyon.git"
+  },
+  "keywords": [
+    "tachyon",
+    "api",
+    "framework",
+    "typescript",
+    "bun"
+  ],
+  "author": "Chidelma",
+  "bugs": {
+    "url": "https://github.com/Chidelma/Tachyon/issues"
+  }
+}

package/routes/_utils/validation.ts

@@ -0,0 +1,36 @@
+export const VALIDATE = (input: any[]) => (cls: Object, funcName: string, propDesc: PropertyDescriptor) => {
+
+    const originalFunc: Function = propDesc.value
+            
+    propDesc.value = async function(...args: any[]) {
+
+        const params = [...input]
+
+        if(params.length !== args.length) {
+
+            do {
+
+                const idx = params.findLastIndex(x => x.default !== undefined)
+
+                if(idx === -1) break
+
+                const [ param ] = params.splice(idx, 1)
+
+                args.unshift(param.default)
+
+            } while(true)
+
+            if(input.length !== args.length) throw new Error(`Invalid number of arguments for ${funcName}`)
+        }
+
+        for(let i = 0; i < input.length; i++) {
+
+            if(typeof args[i] !== input[i].type) {
+
+                throw new Error(`Invalid argument type for ${funcName}`)
+            }
+        }
+
+        return originalFunc.apply(this, args)
+    }
+}

package/routes/byos/[primary]/doc.ts

@@ -0,0 +1,28 @@
+import { VALIDATE } from "../../_utils/validation.js";
+
+export default class Doc {
+
+    @VALIDATE([{ type: "object" }])
+    static async GET({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    @VALIDATE([{ type: "object" }, { type: "object" }])
+    static async POST({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    @VALIDATE([{ type: "object" }, { type: "object" }])
+    static async PATCH({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    @VALIDATE([{ type: "string" }, { type: "object" }])
+    static async DELETE({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+}

package/routes/byos/[primary]/docs.ts

@@ -0,0 +1,28 @@
+import { VALIDATE } from "../../_utils/validation.js";
+
+export default class Docs {
+
+    @VALIDATE([{ type: "object" }])
+    static async GET({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    @VALIDATE([{ type: "object" }])
+    static async POST({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    @VALIDATE([{ type: "object" }])
+    static async PATCH({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    @VALIDATE([{ type: "object" }])
+    static async DELETE({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+}

package/routes/byos/[primary]/join/[secondary]/docs.ts

@@ -0,0 +1,10 @@
+import { VALIDATE } from "../../../../_utils/validation.js";
+
+export default class Docs {
+
+    @VALIDATE([{ type: "object" }])
+    static async GET({ slugs }: _HTTPContext) {
+
+        console.info(slugs)
+    }
+}

package/routes/byos/[primary]/schema.ts

@@ -0,0 +1,17 @@
+export default class Schema {
+
+    static async POST({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    static async PATCH({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+
+    static DELETE({ request }: _HTTPContext) {
+
+        console.log(request.url)
+    }
+}

package/routes/byos/[primary]/stream/doc.ts

@@ -0,0 +1,28 @@
+import { VALIDATE } from "../../../_utils/validation.js";
+
+export default class {
+
+    @VALIDATE([{ type: "object" }])
+    static GET({ request }: _HTTPContext) {
+
+        return {
+
+            async *[Symbol.asyncIterator]() {
+
+                yield request.url
+            }
+        }
+    }
+
+    @VALIDATE([{ type: "object" }])
+    static DELETE({ request }: _HTTPContext) {
+
+        return {
+
+            async *[Symbol.asyncIterator]() {
+
+                yield request.url
+            }
+        }
+    }
+}

package/routes/byos/[primary]/stream/docs.ts

@@ -0,0 +1,28 @@
+import { VALIDATE } from "../../../_utils/validation.js";
+
+export default class {
+
+    @VALIDATE([{ type: "object" }])
+    static GET({ request }: _HTTPContext) {
+
+        return {
+
+            async *[Symbol.asyncIterator]() {
+
+                yield request.url
+            }
+        }
+    }
+
+    @VALIDATE([{ type: "object", default: {} }, { type: "object" }])
+    static DELETE({ request }: _HTTPContext) {
+
+        return {
+
+            async *[Symbol.asyncIterator]() {
+
+                yield request.url
+            }
+        }
+    }
+}