npm support

Author: nakasyou

.github/workflows/publish.yml

@@ -12,5 +12,16 @@ jobs:
       id-token: write
     steps:
       - uses: actions/checkout@v4
-      - name: Publish package
-        run: npx jsr publish
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+      - uses: denoland/setup-deno@v2
+
+      - name: Update npm
+        run: npm install -g npm@latest
+
+      - run: deno task build
+
+      - run: npm publish
+      - run: npx jsr publish

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

README.md

@@ -7,10 +7,23 @@
 - **Type-safe streaming**: Share the same generic type between server and client thanks to `TypedResponse` support.
 - **Simple API surface**: Call `typedStream` on the server and `receiveTypedStream` on the client—no manual plumbing required.
 - **Built for Hono**: Leverages `streamText`, works smoothly with `testClient`, and fits naturally into existing Hono apps.
-- **Batteries included**: Ships `TextLineSplitterStream` and `JSONParserStream` to handle newline-delimited JSON payloads.
 
 ## Installation
 
+### npm
+
+https://www.npmjs.com/packages/hono-typedstream
+
+```
+npm install hono-typedstream # npm
+yarn add hono-typedstream # yarn
+pnpm add hono-typedstream # pnpm
+bun add hono-typedstream # bun
+deno add npm:hono-typedstream # deno
+```
+
+### jsr
+
 The package is published to [jsr.io/@ns/hono-typedstream](https://jsr.io/@ns/hono-typedstream).
 
 ```
@@ -22,8 +35,8 @@ deno add jsr:@ns/hono-typedstream # deno
 ```
 
 ```ts
-import { typedStream } from '@ns/hono-typedstream'
-import { receiveTypedStream } from '@ns/hono-typedstream/client'
+import { typedStream } from 'hono-typedstream'
+import { receiveTypedStream } from 'hono-typedstream/client'
 ```
 
 ## Usage
@@ -34,7 +47,7 @@ import { receiveTypedStream } from '@ns/hono-typedstream/client'
 
 ```ts
 import { Hono } from 'hono'
-import { typedStream } from 'jsr:@ns/hono-typedstream'
+import { typedStream } from 'hono-typedstream'
 
 const app = new Hono()
 
@@ -63,7 +76,7 @@ export type AppType = typeof app
 
 ```ts
 import { hc } from 'hono/client'
-import { receiveTypedStream } from 'jsr:@ns/hono-typedstream/client'
+import { receiveTypedStream } from 'hono-typedstream/client'
 import type { AppType } from './server.ts'
 
 const client = hc<AppType>('/')

client.ts

@@ -9,6 +9,7 @@ import type { TYPED_STREAM_KEY } from './shared.ts'
 /**
  * Splits a text stream into individual lines using newline delimiters.
  * @example
+ * ```ts
  * const readable = new ReadableStream({
  *   start(controller) {
  *     const encoder = new TextEncoder()
@@ -22,6 +23,7 @@ import type { TYPED_STREAM_KEY } from './shared.ts'
  * for await (const line of lines) {
  *   console.log(line) // "one", then "two"
  * }
+ * ```
  */
 export class TextLineSplitterStream extends TransformStream<string, string> {
   constructor() {
@@ -49,6 +51,7 @@ export class TextLineSplitterStream extends TransformStream<string, string> {
 /**
  * Parses newline-delimited JSON chunks into strongly typed objects.
  * @example
+ * ```ts
  * const readable = new ReadableStream({
  *   start(controller) {
  *     controller.enqueue(JSON.stringify({ ok: true }))
@@ -60,6 +63,7 @@ export class TextLineSplitterStream extends TransformStream<string, string> {
  * for await (const result of objects) {
  *   console.log(result.ok) // true
  * }
+ * ```
  */
 export class JSONParserStream<T> extends TransformStream<string, T> {
   constructor() {
@@ -81,11 +85,13 @@ export class JSONParserStream<T> extends TransformStream<string, T> {
  * @param res Response returned by the Hono client request.
  * @returns Readable stream of typed JSON objects.
  * @example
+ * ```ts
  * const res = await client.api.events.$get()
  * const dataStream = receiveTypedStream(res)
  * for await (const payload of dataStream) {
  *   console.log(payload.type)
  * }
+ * ```
  */
 export const receiveTypedStream = <T>(
   res: ClientResponse<T, StatusCode, TYPED_STREAM_KEY>

deno.json

@@ -1,17 +1,21 @@
 {
-    "name": "@ns/hono-typedstream",
-    "version": "0.1.0",
-    "exports": {
-        ".": "./server.ts",
-        "./client": "./client.ts"
-    },
-    "imports": {
-        "@std/assert": "jsr:@std/assert@^1.0.15",
-        "hono": "npm:hono@^4.10.4"
-    },
-    "fmt": {
-        "semiColons": false,
-        "singleQuote": true
-    },
-    "license": "MIT"
-}
+  "name": "@ns/hono-typedstream",
+  "version": "0.1.1",
+  "exports": {
+    ".": "./server.ts",
+    "./client": "./client.ts"
+  },
+  "imports": {
+    "@std/assert": "jsr:@std/assert@^1.0.15",
+    "hono": "npm:hono@^4.10.4"
+  },
+  "fmt": {
+    "semiColons": false,
+    "singleQuote": true
+  },
+  "license": "MIT",
+  "tasks": {
+    "build": "deno run -A npm:tsup server.ts client.ts --dts && deno task copy:version",
+    "copy:version": "jq --slurp '.[1].version as $v | .[0] | .version = $v' package.json deno.json > tmp.json && mv tmp.json package.json"
+  }
+}