@gravlabs/appwrite-hono-adapter-node

v0.9.0

Published

7 months ago

This adapter allows you to run your Hono application on Appwrite's `node-21.0` runtime. **Caution:** this library is in active development and the API is subject to change.

0High
0Medium
0Low

verydanny

Appwrite Hono Adapter

This adapter allows you to run your Hono application on Appwrite's node-21.0 runtime. Caution: this library is in active development and the API is subject to change.

[!NOTE] Please carefully read the Requirements. Certain versions of this library will work with select Appwrite node-21.0+ runtimes.

Installation

You can install it from the npm registry:

npm:

npm install hono @gravlabs/appwrite-hono-adapter-node

yarn:

yarn add hono @gravlabs/appwrite-hono-adapter-node

pnpm:

pnpm add hono @gravlabs/appwrite-hono-adapter-node

Usage

Import serve from @gravlabs/appwrite-hono-adapter-node and write your Hono code like usual. It supports most Hono middleware as well:

import { Hono } from "hono"
import { serve } from "@gravlabs/appwrite-hono-adapter-node"
import { serveStatic } from "@gravlabs/appwrite-hono-adapter-node/serveStatic"

const app = new Hono()

app.get("/static/*", serveStatic({
    root: './',
}))

app.get("/", (context) =>
    context.html(`
        <html>
            <h1>Hello world</h1>
        </html>
    `),
)

export default serve(app)

Options

overrideGlobalObjects

default: true

Allows override of default Response and Request object. This is where the magic happens and allows this adapter to work faster than default Response and Request objects.

Middleware

Middleware that works for Hono will work with this middleware.

Static Middleware

Use the packaged serveStatic middleware to serve static files. It's best illustrated with an example. If your folder structure looks like so:

.
├── src
│   └── main.js // Appwrite function entry
├── static
│   ├── 1.jpg
│   └── 2.html

Your serveStatic middleware would look like so:

import { serveStatic } from "@gravlabs/appwrite-hono-adapter-node/serveStatic"

app.use('/static/*', serveStatic({ root: './' }))

And with your folder structure looking like so:

.
└─ src
   ├─ main.js // Appwrite function entry
   └─ static
     ├─ 1.jpg
     └─ 2.html

Your serveStatic middleware would look like so:

import { serveStatic } from "@gravlabs/appwrite-hono-adapter-node/serveStatic"

app.use('/static/*', serveStatic({ root: './src' }))

Astro Middleware Example

It's really convenient to create an Astro static site with just Appwrite functions:

1. Set up the Adapter

Add the adapter to your astro.config.mjs file.

import { defineConfig } from "astro/config"
import honoAstro from "hono-astro-adapter"

// https://astro.build/config
export default defineConfig({
	output: "server", // or hybrid if you want to use SSR and SSG
	adapter: honoAstro(),
})

2. Build your project

Build your project using the astro build command.

3. Import and set up your Appwrite hook

import { Hono } from "hono";
import { serve } from "@gravlabs/appwrite-hono-adapter-node"
import { serveStatic } from "@gravlabs/appwrite-hono-adapter-node/serveStatic"
import { handler as ssrHandler } from "./dist/server/entry.mjs"

const app = new Hono()

app.use("/*", serveStatic({ root: "./dist/client/" }))
app.use(ssrHandler)

export default serve(app)

Typings

You can use the log and error functions from the runtime, as well as have access to the original req and res by accessing the context.env in Hono. You can access the types from

import type { AppwriteBindings } from '@gravlabs/appwrite-hono-adapter-node/types'

Requirements

Pleae check out which context methods you can use and then install the appropriate version.

Supported Appwrite Function API

| Version | Supports | Doesn't Support | | --- | --- | --- | | < 1.0.0 | res.send() res.json() res.empty() res.redirect() | res.binary() res.start() res.writeText() res.writeJson() res.writeBinary() res.end() | >=1.0.0 \|\| < 2.0.0 | res.send() res.text() res.json() res.empty() res.redirect() res.binary() | res.start() res.writeText() res.writeJson() res.writeBinary() res.end() | >=2.0.0 | res.send() res.text() res.json() res.empty() res.redirect() res.binary() res.start() res.writeText() res.writeJson() res.writeBinary() res.end() |

License

MIT