feat!: new utils-{chat,stream} package (#36)

* refactor!: new `utils-{chat,stream}` package

* fix: lint code

* feat(utils-stream): add smoothStream

* refactor(utils-stream/smooth-stream): handle zero delay

* feat(utils-stream): add simulateReadableStream

* chore!: relicense to apache-2.0

* chore(utils): remove private field

* fix(license): update copyright

* Revert "fix(license): update copyright"

This reverts commit 7a85cd6.

* Revert "chore!: relicense to apache-2.0"

This reverts commit 826b420.

* chore(utils-stream): add license header

* chore(utils-stream): update license header

packages/shared-chat/src/utils/index.ts

@@ -1,2 +1 @@
 export { chat } from './chat'
-export * as message from './message'

packages/utils-chat/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@xsai/utils-chat",
+  "type": "module",
+  "version": "0.0.29",
+  "description": "extra-small AI SDK for Browser, Node.js, Deno, Bun or Edge Runtime.",
+  "author": "Moeru AI",
+  "license": "MIT",
+  "homepage": "https://xsai.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moeru-ai/xsai.git",
+    "directory": "packages/utils-chat"
+  },
+  "bugs": "https://github.com/moeru-ai/xsai/issues",
+  "keywords": ["xsai", "openai", "ai"],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pkgroll",
+    "build:watch": "pkgroll --watch"
+  },
+  "dependencies": {
+    "@xsai/shared-chat": "workspace:"
+  }
+}

packages/utils-chat/src/index.ts

@@ -0,0 +1 @@
+export * as message from './message'

packages/shared-chat/src/utils/message.ts → packages/utils-chat/src/message.ts

@@ -1,5 +1,4 @@
-import type { AssistantMessage, AssistantMessagePart, Message, SystemMessage, SystemMessagePart, ToolCall, ToolMessage, ToolMessagePart, UserMessage, UserMessagePart } from '../types/message'
-import type { ImagePart, TextPart } from '../types/message-part'
+import type { AssistantMessage, AssistantMessagePart, ImagePart, Message, SystemMessage, SystemMessagePart, TextPart, ToolCall, ToolMessage, ToolMessagePart, UserMessage, UserMessagePart } from '@xsai/shared-chat'
 
 export const messages = (...messages: Message[]): Message[] => messages
 

packages/utils-chat/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@importantimport/tsconfig/app.json",
+  "include": ["src"]
+}

packages/utils-stream/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@xsai/utils-stream",
+  "type": "module",
+  "version": "0.0.29",
+  "description": "extra-small AI SDK for Browser, Node.js, Deno, Bun or Edge Runtime.",
+  "author": "Moeru AI",
+  "license": "MIT",
+  "homepage": "https://xsai.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moeru-ai/xsai.git",
+    "directory": "packages/utils-stream"
+  },
+  "bugs": "https://github.com/moeru-ai/xsai/issues",
+  "keywords": ["xsai", "openai", "ai"],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pkgroll",
+    "build:watch": "pkgroll --watch"
+  }
+}

packages/utils-stream/src/_sleep.ts

@@ -0,0 +1,4 @@
+export const sleep = async (delay: number) => delay === 0
+  ? Promise.resolve()
+  // eslint-disable-next-line @masknet/no-timer, @masknet/prefer-timer-id
+  : new Promise(resolve => setTimeout(resolve, delay))

packages/utils-stream/src/index.ts

@@ -0,0 +1,3 @@
+export { simulateReadableStream } from './simulate-readable-stream'
+export { smoothStream } from './smooth-stream'
+export { toAsyncIterator } from './to-async-iterator'

packages/utils-stream/src/simulate-readable-stream.ts

@@ -0,0 +1,24 @@
+// License for this File only:
+//
+// Copyright Vercel, Inc. (https://vercel.com)
+// Copyright Moeru AI (https://github.com/moeru-ai)
+// SPDX-License-Identifier: Apache-2.0
+
+import { sleep } from './_sleep'
+
+export interface SimulateReadableStreamOptions<T> {
+  chunkDelay: number
+  chunks: T[]
+  initialDelay: number
+}
+
+/** @experimental */
+export const simulateReadableStream = <T>({ chunkDelay, chunks, initialDelay }: SimulateReadableStreamOptions<T>) => new ReadableStream({
+  pull: async (controller) => {
+    for (const [index, chunk] of chunks.entries()) {
+      await sleep(index === 0 ? initialDelay : chunkDelay)
+      controller.enqueue(chunk)
+    }
+    controller.close()
+  },
+})

packages/utils-stream/src/smooth-stream.ts

@@ -0,0 +1,47 @@
+// License for this File only:
+//
+// Copyright Vercel, Inc. (https://vercel.com)
+// Copyright Moeru AI (https://github.com/moeru-ai)
+// SPDX-License-Identifier: Apache-2.0
+
+import { sleep } from './_sleep'
+
+export interface SmoothStreamOptions {
+  chunking?: 'line' | 'word' | RegExp
+  delay?: number
+}
+
+const CHUNKING_REGEXPS = {
+  // eslint-disable-next-line sonarjs/slow-regex
+  line: /[^\n]*\n/,
+  // eslint-disable-next-line sonarjs/slow-regex
+  word: /\s*\S+\s+/,
+}
+
+/**
+ * @experimental
+ * Smooths text streaming output.
+ */
+export const smoothStream = ({ chunking = 'word', delay = 10 }: SmoothStreamOptions = {}): TransformStream<string, string> => {
+  const chunkingRegexp
+    = typeof chunking === 'string' ? CHUNKING_REGEXPS[chunking] : chunking
+
+  let buffer = ''
+
+  return new TransformStream<string, string>({
+    transform: async (chunk, controller) => {
+      buffer += chunk
+
+      let match = chunkingRegexp.exec(buffer)
+      while (match !== null) {
+        const result = match[0]
+        controller.enqueue(result)
+        buffer = buffer.slice(result.length)
+
+        match = chunkingRegexp.exec(buffer)
+
+        await sleep(delay)
+      }
+    },
+  })
+}

packages/utils-stream/src/to-async-iterator.ts

@@ -0,0 +1,18 @@
+export async function* toAsyncIterator<T>(
+  stream: ReadableStream<T>,
+): AsyncGenerator<T, void, unknown> {
+  const reader = stream.getReader()
+  try {
+    while (true) {
+      const { done, value } = await reader.read()
+
+      if (done)
+        return
+
+      yield value
+    }
+  }
+  finally {
+    reader.releaseLock()
+  }
+}

packages/utils-stream/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@importantimport/tsconfig/app.json",
+  "include": ["src"]
+}

tsconfig.json

@@ -12,6 +12,7 @@
     { "path": "./packages/stream-object/tsconfig.json" },
     { "path": "./packages/stream-text/tsconfig.json" },
     { "path": "./packages/tool/tsconfig.json" },
+    { "path": "./packages/utils-stream/tsconfig.json" },
     { "path": "./packages/xsai/tsconfig.json" },
     { "path": "./tsconfig.node.json" }
   ],