feat: dtsPath options

Author: rayriffy

.changeset/fast-nights-sit.md

@@ -0,0 +1,5 @@
+---
+"elysia-remote-dts": patch
+---
+
+add option to change path to get server types

README.md

@@ -36,14 +36,20 @@ const app = new Elysia().use(dts('./src/index.ts')).listen(3000)
 export type App = typeof app;
 ```
 
-Types will then be available at `/server.d.ts`.
+Types will then be available at `/server.d.ts` by default, or at the path specified in the `dtsPath` option.
 
 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 before using it with Eden:
 
 ```
 curl -o server.ts https://<remote-url>/server.d.ts
 ```
 
+If you've customized the path:
+
+```
+curl -o server.ts https://<remote-url>/your-custom-path
+```
+
 Then use it in your frontend code:
 
 ```ts
@@ -70,6 +76,7 @@ dts(entryPoint, options)
 | `compilerOptions` | `object` | `{}` | The `compilerOptions` for the TypeScript compiler. See [TypeScript compiler options](https://www.typescriptlang.org/docs/handbook/compiler-options.html). |
 | `resolve` | `boolean \| (string \| RegExp)[]` | `false` | Resolve external types used in `.d.ts` files from `node_modules`. Can be a boolean or an array of strings/RegExp patterns. |
 | `resolvePaths` | `boolean` | `false` | When `true`, the plugin will resolve `paths` in `tsconfig.json`. This option is enabled automatically when `paths` is set in `compilerOptions`. |
+| `dtsPath` | `string` | `"/server.d.ts"` | The path where the type definitions will be served. |
 
 ### Example with Options
 
@@ -82,7 +89,8 @@ const app = new Elysia().use(
     tsconfig: './tsconfig.json',
     compilerOptions: {
       strict: true
-    }
+    },
+    dtsPath: '/types.d.ts'
   })
 ).listen(3000)
 

src/index.ts

@@ -4,12 +4,13 @@ import type { Options } from './types'
 
 export const dts = (filePath: string, options?: Options) => {
   let dts = ''
+  const dtsPath = options?.dtsPath || '/server.d.ts'
 
   return new Elysia()
     .onStart(async () => {
       dts = await generateDts(filePath, options)
     })
-    .get('/server.d.ts', ({ set }) => {
+    .get(dtsPath, ({ set }) => {
       // use same Content-Type as Deno
       // https://github.com/denoland/deno/blob/f42cb0816ef3be41213c0b2151b1d1c28495d4ce/cli/lsp/documents.rs#L1712
       set.headers['Content-Type'] = 'application/typescript'

src/types.ts

@@ -39,6 +39,13 @@ export interface Options {
    * This option is enabled when `paths` is set in `compilerOptions`.
    */
   resolvePaths?: boolean
+
+  /**
+   * The path where the type definitions will be served.
+   * 
+   * @default `/server.d.ts`
+   */
+  dtsPath?: string
 }
 
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U