V3 Roadmap

Proposal

https://github.com/thaitype/nammatham/issues/129

Design Goal

• Support both Bun and Node.js, Bun is first-class citizen
• Support Azure Custom Handler
  • https://github.com/mildronize/azure-functions-with-bun-hono?tab=readme-ov-file
  • Note: Functions is not a standard reverse proxy. Some features such as response streaming, HTTP/2, and WebSockets are not available
• Nammatham should run outside Azure Functions Runtime.
• Support any Web Framework, e.g. Hono, Express.
• Auto create host.json , https://github.com/mildronize/azure-functions-with-bun-hono/blob/main/host.json (#125)
• Use func start will read settings from host.json
• Support auto generate function.json like nammatham v1 (#135)
• Support Dev Mode auto reload server https://github.com/mildronize/azure-functions-with-bun-hono/blob/main/host.json
  • Already proof of concept
• Move deployable files into .nmt for generated function.json, host.json, built the bundle files
• Can bundle with bundler and support monorepo (#110)
  • In v2, depends on Azure functions Official Framework that cannot make bundle, using custom handler will solve the problem
• nammatham command supports to any custom handler using JavaScript/TypeScript both Bun and Node.js runtime.
  • However, nammatham also publish as the package framework for creating Azure Functions App easily.

Progress

• Use Azure Custom Handler
• Support Node.js and Bun.js on Hono Framework.
  • E2E Test for Node.js with Github Actions
    • Build on Linux and deploy to Azure
    • Build on Windows and deploy to Azure
    • Build on Mac only
  • E2E Test for Bun with Github Actions
    • Build on Linux and deploy to Azure
    • Build on Windows and deploy to Azure
    • Build on Mac only
• Support bundle and monorepo code

Github Actions E2E Results

• https://github.com/thaitype/nammatham/actions/runs/9042196321

Documentation

• Add doc site: https://nammatham.thaitype.dev/

Candidate Features

• Support Node.js Runtime (from Official Azure Functions) when it can bundle and use with monorepo
• Run outside func start process, without changing the code, may using flag deployment=standalone