Implementation (#1)

* feat: implementation

* fix: bundling

* chore: staged changes

* chore: staged changes

* chore: metadata

* docs: guide to use with frontend

* chore: staged changes

* feat: changeset

* docs: readme

Author: rayriffy

.changeset/chubby-poets-walk.md

@@ -0,0 +1,5 @@
+---
+"elysia-remote-dts": major
+---
+
+Initial release

.github/workflows/pr.yml

@@ -0,0 +1,24 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - name: install
+        run: bun i
+      - name: build
+        run: bun run build
+      - name: publish
+        run: bunx pkg-pr-new publish

README.md

@@ -1,18 +1,60 @@
-# quick-npm
+# Elysia remote DTS
 
-Quick start template to rapidly develop NPM packages with speed, and automations.
+A plugin that provide `.d.ts` types remotely for Eden Treaty to consume.
+
+[![NPM Version](https://img.shields.io/npm/v/elysia-remote-dts)](https://www.npmjs.com/package/elysia-remote-dts)
+[![NPM Downloads](https://img.shields.io/npm/dw/elysia-remote-dts)](https://www.npmjs.com/package/elysia-remote-dts)
+[![NPM License](https://img.shields.io/npm/l/elysia-remote-dts)](https://www.npmjs.com/package/elysia-remote-dts)
+
+Imagine in this scenario, you deploy an Elysia server remotely somewhere. And you also want to provide the benefit of end-to-end type safety by using [Eden Treaty](https://elysiajs.com/eden/overview#eden-treaty-recommended). But external developer may not have a direct access to source code to pull `typeof app` types out from your server maybe because.
+
+- Your server is closed-source.
+- Frontend locate somewhere else that make types inaccessible.
+
+This plugin will attempt to expose types remotely, and provide remote type to Eden Treaty to consume somehow.
+
+> [!NOTE]  
+> Part of the code that responsible for runtime type-generation is copied from project [rolldown-plugin-dts](https://github.com/sxzz/rolldown-plugin-dts), what difference is this `generateDts` utility is completely dependent, and decoupled from rolldown lifecycle. Full credit should go to them, I just port some functionality that hoped to be cool stuff on Elysia ecosystem.
 
 ## Install
 
-```bash
-bun add @rayriffy/quick-npm
+```
+bun add elysia-remote-dts
+```
+
+## Usage
+
+```ts
+import { Elysia } from 'elysia'
+import { dts } from 'elysia-remote-dts'
+
+const app = new Elysia().use(dts('./src/index.ts')).listen(3000)
+
+// Be sure to export type for plugin to consume as well.
+export type App = typeof app;
+```
+
+Then types should be available at `/server.d.ts`.
+
+Due to limitations with [Triple-Slash Directives](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html), types cannot be directly consumed from a remote URL ([tracking issue](https://github.com/microsoft/TypeScript/issues/28985)). For frontend projects, you'll need to first download the type declaration file from this path before using it with Eden.
+
+```
+curl -o server.ts https://<remote-url>/server.d.ts
+```
+
+```ts
+import { treaty } from '@elysiajs/eden'
+import type { App } from './server'
+
+// frontend project should already have both elysia, and @elysiajs/eden installed
+export const app = treaty<App>('https://<remote-url>')
 ```
 
-## Setting up
+## Configuration
 
-1. Allow GitHub Actions to create pull request
-2. Generate NPM authotization token into `NPM_TOKEN` secret
+To be documented
 
-## Publishing
+## Known Limitations
 
-This repository has been configured to automatically publish NPM packages by [Changesets](https://github.com/changesets/changesets). Run `bun changeset` command to publishing your changes before commit.
+1. Sometimes emitting types can be `null`, this happens only in some runtime environment (So far, Distroless). I would recommended `oven/bun`, or `oven/bun:alpine` as base image.
+2. Be sure that `typescript` package is available when running. It's no longer `devDependencies`.

bun.lock

@@ -0,0 +1,42 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
+
+**/*.trace
+**/*.zip
+**/*.tar.gz
+**/*.tgz
+**/*.log
+package-lock.json
+**/*.bun

example/.gitignore

@@ -0,0 +1,16 @@
+FROM oven/bun:alpine
+
+WORKDIR /app
+
+COPY package.json .
+COPY bun.lock .
+
+RUN bun install
+
+COPY src src
+COPY tsconfig.json .
+
+ENV NODE_ENV production
+CMD ["bun", "src/index.ts"]
+
+EXPOSE 3000

example/Dockerfile

@@ -0,0 +1,15 @@
+# Elysia with Bun runtime
+
+## Getting Started
+To get started with this template, simply paste this command into your terminal:
+```bash
+bun create elysia ./elysia-example
+```
+
+## Development
+To start the development server run:
+```bash
+bun run dev
+```
+
+Open http://localhost:3000/ with your browser to see the result.

example/README.md

@@ -0,0 +1,17 @@
+{
+  "name": "example",
+  "version": "1.0.50",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "bun run --watch src/index.ts"
+  },
+  "dependencies": {
+    "elysia": "latest",
+    "elysia-remote-dts": "https://pkg.pr.new/rayriffy/elysia-remote-dts@ff9f948",
+    "typescript": "^5.8.3"
+  },
+  "devDependencies": {
+    "bun-types": "latest"
+  },
+  "module": "src/index.js"
+}

example/bun.lock

@@ -0,0 +1,20 @@
+import { Elysia, t } from 'elysia'
+import { dts } from 'elysia-remote-dts'
+
+const app = new Elysia()
+  .use(dts('./src/index.ts'))
+  .get('/', () => 'Hello Elysia')
+  .post('/cow', ({ body }) => {
+    return body.message
+  }, {
+    body: t.Object({
+      message: t.String()
+    })
+  })
+  .listen(3000)
+
+export type App = typeof app
+
+console.log(
+  `🦊 Elysia is running at http://${app.server?.hostname}:${app.server?.port}`
+)