@cloudpss/message-stream 0.5.36 → 0.5.39

package/README.md

@@ -1,3 +1,25 @@
 # @cloudpss/message-stream
 
-Message stream type definitions for cloudpss APIs.
+Message stream type definitions for cloudpss APIs. And plugin for `@cloudpss/http-client`, provides cloudpss message stream APIs.
+
+## Example
+
+```ts
+import { HttpClient } from '@cloudpss/http-client';
+import { MessageStreamPlugin } from '@cloudpss/message-stream/plugin';
+import { interval } from 'rxjs';
+import { map, take } from 'rxjs/operators';
+
+const http = new HttpClient({
+  /* config */
+}).use(MessageStreamPlugin());
+const stream = await http.stream.create({ type: 'object', comment: 'test', durability: 0 });
+await http.stream.write(
+  stream.token,
+  stream.type,
+  interval(100)
+    .pipe(take(10))
+    .pipe(map((i) => ({ i }))),
+);
+await http.stream.freeze(stream.token);
+```

package/dist/index.d.ts

@@ -1,10 +1,5 @@
 import type { Tagged, Simplify } from 'type-fest';
-/** UUID */
-type UUID = `${string}-${string}-${string}-${string}-${string}`;
-/** 空 UUID */
-type NIL_UUID = typeof NIL_UUID;
-/** 空 UUID */
-declare const NIL_UUID: "00000000-0000-0000-0000-000000000000";
+import { type UUID, NIL_UUID } from '@cloudpss/id';
 /**
  * 标识流的读权限
  */

package/dist/index.js

@@ -1,6 +1,4 @@
-/** 空 UUID */
-// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-const NIL_UUID = '00000000-0000-0000-0000-000000000000';
+import { NIL_UUID } from '@cloudpss/id';
 /** 表示一个空白的流 ID，读取此 ID 对应的流会得到不包含消息的且已冻结的空白流 */
 export const EMPTY_STREAM_ID = NIL_UUID;
 /** 表示一个空白的流 Token，写入此 Token 的消息会被直接丢弃，不会产生错误 */

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,aAAa;AACb,4EAA4E;AAC5E,MAAM,QAAQ,GAAG,sCAA+C,CAAC;AAKjE,+CAA+C;AAC/C,MAAM,CAAC,MAAM,eAAe,GAAG,QAAwC,CAAC;AAMxE,gDAAgD;AAChD,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAA2C,CAAC;AAC9E,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,QAAQ,EAAE,MAAM,cAAc,CAAC;AAMnD,+CAA+C;AAC/C,MAAM,CAAC,MAAM,eAAe,GAAG,QAAwC,CAAC;AAMxE,gDAAgD;AAChD,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAA2C,CAAC;AAC9E,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,47 @@
+import { Observable, type ObservableInput } from 'rxjs';
+import type { HttpClient, HttpClientPlugin } from '@cloudpss/http-client';
+import type { Message, RawMessage, Stream, StreamArgs, StreamId, StreamInfo, StreamToken, StreamType } from './index.js';
+export type { Message, RawMessage, Stream, StreamArgs, StreamId, StreamInfo, StreamToken, StreamType };
+/** 消息流客户端 */
+declare class MessageStreamClient {
+    readonly client: HttpClient;
+    constructor(client: HttpClient);
+    /** 创建流 */
+    create<T extends StreamType>(args: StreamArgs & {
+        readonly type: T;
+    }): Promise<Stream & {
+        readonly type: T;
+    }>;
+    /** 批量创建流 */
+    create<T extends StreamType>(args: ReadonlyArray<StreamArgs & {
+        readonly type: T;
+    }>): Promise<Array<Stream & {
+        readonly type: T;
+    }>>;
+    /** 冻结流 */
+    freeze(token: StreamToken): Promise<boolean>;
+    /** 删除流 */
+    delete(token: StreamToken): Promise<void>;
+    /** 获取流信息 */
+    info(id: StreamId): Promise<StreamInfo>;
+    /** 获取流信息 */
+    get(token: StreamToken): Promise<Stream>;
+    /** 读取消息 */
+    read<T extends StreamType>(stream: {
+        readonly id: StreamId;
+        readonly type: T;
+    }, options?: {
+        from?: Date;
+    }): Observable<Message<T>>;
+    /** 写入消息 */
+    write<T extends StreamType>(stream: {
+        readonly token: StreamToken;
+        readonly type: T;
+    }, data: ObservableInput<Message<T>['data']>): Promise<void>;
+}
+/**
+ * 添加消息流插件，使得可以通过 `client.stream` 访问消息流相关接口
+ */
+export declare function MessageStreamPlugin(): HttpClientPlugin<{
+    readonly stream: MessageStreamClient;
+}>;

package/dist/plugin.js

@@ -0,0 +1,184 @@
+import { Observable, from } from 'rxjs';
+import { connected, disconnected } from '@cloudpss/fetch';
+import { decode, decodeMany, encodeMany } from '@cloudpss/ubjson';
+/** 解析响应 */
+function parseStreamInfo(data) {
+    data.createdAt = new Date(data.createdAt);
+    data.lastReadAt = data.lastReadAt != null ? new Date(data.lastReadAt) : undefined;
+    data.lastWrittenAt = data.lastWrittenAt != null ? new Date(data.lastWrittenAt) : undefined;
+    return data;
+}
+/** 解析响应 */
+function parseMessage(type, data) {
+    const message = decode(data);
+    message.timestamp = new Date(message.timestamp);
+    if (type === 'object') {
+        message.data = [...decodeMany(message.data)];
+    }
+    else {
+        // reallocate the buffer to make it non-shared
+        // (message as Omit<RawMessage, 'data'> as Writable<Message<'binary'>>).data = Uint8Array.from(message.data);
+    }
+    return message;
+}
+/** 消息流客户端 */
+class MessageStreamClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /** 创建流 */
+    async create(args) {
+        if (Array.isArray(args)) {
+            const list = args;
+            if (list.length === 0)
+                return [];
+            const result = await this.client.restful('/streams/bulk', args);
+            return result.data.map(parseStreamInfo);
+        }
+        const result = await this.client.restful('/streams', args);
+        return parseStreamInfo(result.data);
+    }
+    /** 冻结流 */
+    async freeze(token) {
+        const result = await this.client.restful(`/streams/token/${token}/freeze`, undefined, { method: 'PUT' });
+        if (result.response.status === 204)
+            return false;
+        return true;
+    }
+    /** 删除流 */
+    async delete(token) {
+        await this.client.restful(`/streams/token/${token}`, undefined, { method: 'DELETE' });
+    }
+    /** 获取流信息 */
+    async info(id) {
+        const result = await this.client.restful(`/streams/id/${id}/info`);
+        return parseStreamInfo(result.data);
+    }
+    /** 获取流信息 */
+    async get(token) {
+        const result = await this.client.restful(`/streams/token/${token}/info`);
+        return parseStreamInfo(result.data);
+    }
+    /** 读取消息 */
+    read(stream, options) {
+        const { id, type } = stream;
+        const from = options?.from && Number(options.from) ? `?from=${options.from.toISOString()}` : '';
+        return new Observable((subscriber) => {
+            const ws = this.client.ws(`/streams/id/${id}${from}`);
+            ws.binaryType = 'arraybuffer';
+            ws.addEventListener('message', (event) => {
+                if (typeof event.data === 'string' || !event.data)
+                    return;
+                subscriber.next(parseMessage(type, event.data));
+            });
+            ws.addEventListener('close', (ev) => {
+                if (ev.code !== 1000) {
+                    subscriber.error(new Error(`WebSocket closed with code ${ev.code}: ${ev.reason}`));
+                }
+                else if (ev.reason) {
+                    subscriber.error(new Error(ev.reason));
+                }
+                else {
+                    subscriber.complete();
+                }
+            });
+            ws.addEventListener('error', (ev) => {
+                setTimeout(() => {
+                    if (!subscriber.closed) {
+                        // make sure the error event is not dispatched before the close event
+                        const error = ev.error ?? new Error(`WebSocket error`);
+                        subscriber.error(error);
+                    }
+                }, 1);
+            });
+            return () => {
+                if (ws.readyState === ws.OPEN)
+                    ws.close(1000);
+            };
+        });
+    }
+    /** 写入消息 */
+    async write(stream, data) {
+        const { token, type } = stream;
+        return new Promise((resolve, reject) => {
+            const ws = this.client.ws(`/streams/token/${token}`);
+            let queue = connected(ws).catch((error) => {
+                sub.unsubscribe();
+                throw error;
+            });
+            const sub = from(data).subscribe({
+                next: (data) => {
+                    if (data === undefined)
+                        return;
+                    queue = queue.then(() => {
+                        try {
+                            if (ws.readyState !== ws.OPEN) {
+                                throw new Error(`WebSocket is already in CLOSING or CLOSED state.`);
+                            }
+                            if (type === 'object') {
+                                if (!Array.isArray(data)) {
+                                    throw new TypeError(`Invalid data type, object stream only accepts array.`);
+                                }
+                                if (data.length)
+                                    ws.send(encodeMany(data));
+                                return;
+                            }
+                            else {
+                                if (!ArrayBuffer.isView(data)) {
+                                    throw new TypeError(`Invalid data type, binary stream only accepts Uint8Array.`);
+                                }
+                                ws.send(data);
+                            }
+                        }
+                        catch (ex) {
+                            sub.unsubscribe();
+                            throw ex;
+                        }
+                    });
+                },
+                error: (error) => {
+                    // error from source observable
+                    queue = queue.then(() => {
+                        throw error;
+                    });
+                },
+            });
+            sub.add(() => {
+                void (async () => {
+                    let err;
+                    try {
+                        await queue;
+                    }
+                    catch (e) {
+                        err = e;
+                    }
+                    ws.close(1000);
+                    try {
+                        await disconnected(ws);
+                    }
+                    catch (e) {
+                        err ??= e;
+                    }
+                    if (err === undefined) {
+                        resolve();
+                    }
+                    else {
+                        reject(err);
+                    }
+                })();
+            });
+        });
+    }
+}
+/**
+ * 添加消息流插件，使得可以通过 `client.stream` 访问消息流相关接口
+ */
+export function MessageStreamPlugin() {
+    return (client) => {
+        const stream = new MessageStreamClient(client);
+        Object.defineProperty(client, 'stream', { value: stream, configurable: true });
+        return client;
+    };
+}
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAwB,IAAI,EAAE,MAAM,MAAM,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAclE,WAAW;AACX,SAAS,eAAe,CAAgC,IAAO;IAC1D,IAAoB,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3F,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,WAAW;AACX,SAAS,YAAY,CAAuB,IAAO,EAAE,IAAiB;IAClE,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAe,CAAC;IAC1C,OAA6B,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvE,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACnB,OAAmE,CAAC,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9G,CAAC;SAAM,CAAC;QACJ,8CAA8C;QAC9C,6GAA6G;IACjH,CAAC;IACD,OAAO,OAAqB,CAAC;AACjC,CAAC;AAED,aAAa;AACb,MAAM,mBAAmB;IACA;IAArB,YAAqB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAQ3C,UAAU;IACV,KAAK,CAAC,MAAM,CAAC,IAAwC;QACjD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,IAA6B,CAAC;YAC3C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YACjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,eAAe,EAAE,IAAI,CAAC,CAAC;YAC1E,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAS,UAAU,EAAE,IAAI,CAAC,CAAC;QACnE,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,UAAU;IACV,KAAK,CAAC,MAAM,CAAC,KAAkB;QAC3B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,KAAK,SAAS,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACzG,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,KAAK,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,UAAU;IACV,KAAK,CAAC,MAAM,CAAC,KAAkB;QAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,YAAY;IACZ,KAAK,CAAC,IAAI,CAAC,EAAY;QACnB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAa,eAAe,EAAE,OAAO,CAAC,CAAC;QAC/E,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,YAAY;IACZ,KAAK,CAAC,GAAG,CAAC,KAAkB;QACxB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAS,kBAAkB,KAAK,OAAO,CAAC,CAAC;QACjF,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,WAAW;IACX,IAAI,CACA,MAGC,EACD,OAAyB;QAEzB,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5B,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChG,OAAO,IAAI,UAAU,CAAa,CAAC,UAAU,EAAE,EAAE;YAC7C,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;YACtD,EAAE,CAAC,UAAU,GAAG,aAAa,CAAC;YAC9B,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;gBACrC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI;oBAAE,OAAO;gBAC1D,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,IAAmB,CAAC,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE;gBAChC,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACnB,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,8BAA8B,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBACvF,CAAC;qBAAM,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;oBACnB,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC3C,CAAC;qBAAM,CAAC;oBACJ,UAAU,CAAC,QAAQ,EAAE,CAAC;gBAC1B,CAAC;YACL,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE;gBAChC,UAAU,CAAC,GAAG,EAAE;oBACZ,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;wBACrB,qEAAqE;wBACrE,MAAM,KAAK,GAAK,EAAiB,CAAC,KAAe,IAAI,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;wBAClF,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBAC5B,CAAC;gBACL,CAAC,EAAE,CAAC,CAAC,CAAC;YACV,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,EAAE;gBACR,IAAI,EAAE,CAAC,UAAU,KAAK,EAAE,CAAC,IAAI;oBAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,WAAW;IACX,KAAK,CAAC,KAAK,CACP,MAGC,EACD,IAAyC;QAEzC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAC;YACrD,IAAI,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACtC,GAAG,CAAC,WAAW,EAAE,CAAC;gBAClB,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC;gBAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;oBACX,IAAI,IAAI,KAAK,SAAS;wBAAE,OAAO;oBAC/B,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;wBACpB,IAAI,CAAC;4BACD,IAAI,EAAE,CAAC,UAAU,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;gCAC5B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;4BACxE,CAAC;4BACD,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gCACpB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oCACvB,MAAM,IAAI,SAAS,CAAC,sDAAsD,CAAC,CAAC;gCAChF,CAAC;gCACD,IAAI,IAAI,CAAC,MAAM;oCAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;gCAC3C,OAAO;4BACX,CAAC;iCAAM,CAAC;gCACJ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;oCAC5B,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;gCACrF,CAAC;gCACD,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BAClB,CAAC;wBACL,CAAC;wBAAC,OAAO,EAAE,EAAE,CAAC;4BACV,GAAG,CAAC,WAAW,EAAE,CAAC;4BAClB,MAAM,EAAE,CAAC;wBACb,CAAC;oBACL,CAAC,CAAC,CAAC;gBACP,CAAC;gBACD,KAAK,EAAE,CAAC,KAAY,EAAE,EAAE;oBACpB,+BAA+B;oBAC/B,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;wBACpB,MAAM,KAAK,CAAC;oBAChB,CAAC,CAAC,CAAC;gBACP,CAAC;aACJ,CAAC,CAAC;YACH,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE;gBACT,KAAK,CAAC,KAAK,IAAI,EAAE;oBACb,IAAI,GAAY,CAAC;oBACjB,IAAI,CAAC;wBACD,MAAM,KAAK,CAAC;oBAChB,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACT,GAAG,GAAG,CAAC,CAAC;oBACZ,CAAC;oBACD,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACf,IAAI,CAAC;wBACD,MAAM,YAAY,CAAC,EAAE,CAAC,CAAC;oBAC3B,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACT,GAAG,KAAK,CAAC,CAAC;oBACd,CAAC;oBACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;wBACpB,OAAO,EAAE,CAAC;oBACd,CAAC;yBAAM,CAAC;wBACJ,MAAM,CAAC,GAAY,CAAC,CAAC;oBACzB,CAAC;gBACL,CAAC,CAAC,EAAE,CAAC;YACT,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB;IAC/B,OAAO,CAAC,MAAM,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/E,OAAO,MAA+D,CAAC;IAC3E,CAAC,CAAC;AACN,CAAC"}

package/jest.config.js

@@ -0,0 +1,3 @@
+import { config } from '../../jest.config.js';
+
+export default { ...config };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudpss/message-stream",
-  "version": "0.5.36",
+  "version": "0.5.39",
   "author": "CloudPSS",
   "license": "MIT",
   "type": "module",
@@ -8,16 +8,31 @@
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
-    "types": "./dist/index.d.ts",
-    "default": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./plugin": "./dist/plugin.js"
   },
   "dependencies": {
-    "type-fest": "^4.23.0"
+    "rxjs": "^7.8.1",
+    "type-fest": "^4.26.0",
+    "@cloudpss/fetch": "~0.5.39",
+    "@cloudpss/id": "~0.5.39",
+    "@cloudpss/ubjson": "~0.5.39"
+  },
+  "peerDependencies": {
+    "@cloudpss/http-client": "~0.5.39"
+  },
+  "peerDependenciesMeta": {
+    "@cloudpss/http-client": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@cloudpss/http-client": "~0.5.39"
   },
   "scripts": {
     "start": "pnpm clean && tsc --watch",
     "build": "pnpm clean && tsc",
     "clean": "rimraf dist",
-    "test": "echo 'no test'"
+    "test": "NODE_OPTIONS=\"${NODE_OPTIONS:-} --experimental-vm-modules\" echo no tests"
   }
 }

package/src/index.ts

@@ -1,13 +1,6 @@
 import type { Tagged, Simplify } from 'type-fest';
+import { type UUID, NIL_UUID } from '@cloudpss/id';
 
-/** UUID */
-type UUID = `${string}-${string}-${string}-${string}-${string}`;
-
-/** 空 UUID */
-type NIL_UUID = typeof NIL_UUID;
-/** 空 UUID */
-// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-const NIL_UUID = '00000000-0000-0000-0000-000000000000' as const;
 /**
  * 标识流的读权限
  */

package/src/plugin.ts

@@ -0,0 +1,209 @@
+import type { Writable } from 'type-fest';
+import { Observable, type ObservableInput, from } from 'rxjs';
+import type { HttpClient, HttpClientPlugin } from '@cloudpss/http-client';
+import { connected, disconnected } from '@cloudpss/fetch';
+import { decode, decodeMany, encodeMany } from '@cloudpss/ubjson';
+import type {
+    Message,
+    RawMessage,
+    Stream,
+    StreamArgs,
+    StreamId,
+    StreamInfo,
+    StreamToken,
+    StreamType,
+} from './index.js';
+
+export type { Message, RawMessage, Stream, StreamArgs, StreamId, StreamInfo, StreamToken, StreamType };
+
+/** 解析响应 */
+function parseStreamInfo<T extends Stream | StreamInfo>(data: T): T {
+    (data as Writable<T>).createdAt = new Date(data.createdAt);
+    data.lastReadAt = data.lastReadAt != null ? new Date(data.lastReadAt) : undefined;
+    data.lastWrittenAt = data.lastWrittenAt != null ? new Date(data.lastWrittenAt) : undefined;
+    return data;
+}
+
+/** 解析响应 */
+function parseMessage<T extends StreamType>(type: T, data: ArrayBuffer): Message<T> {
+    const message = decode(data) as RawMessage;
+    (message as Writable<Message>).timestamp = new Date(message.timestamp);
+    if (type === 'object') {
+        (message as Omit<RawMessage, 'data'> as Writable<Message<'object'>>).data = [...decodeMany(message.data)];
+    } else {
+        // reallocate the buffer to make it non-shared
+        // (message as Omit<RawMessage, 'data'> as Writable<Message<'binary'>>).data = Uint8Array.from(message.data);
+    }
+    return message as Message<T>;
+}
+
+/** 消息流客户端 */
+class MessageStreamClient {
+    constructor(readonly client: HttpClient) {}
+
+    /** 创建流 */
+    async create<T extends StreamType>(args: StreamArgs & { readonly type: T }): Promise<Stream & { readonly type: T }>;
+    /** 批量创建流 */
+    async create<T extends StreamType>(
+        args: ReadonlyArray<StreamArgs & { readonly type: T }>,
+    ): Promise<Array<Stream & { readonly type: T }>>;
+    /** 创建流 */
+    async create(args: StreamArgs | readonly StreamArgs[]): Promise<Stream | Stream[]> {
+        if (Array.isArray(args)) {
+            const list = args as readonly StreamArgs[];
+            if (list.length === 0) return [];
+            const result = await this.client.restful<Stream[]>('/streams/bulk', args);
+            return result.data.map(parseStreamInfo);
+        }
+        const result = await this.client.restful<Stream>('/streams', args);
+        return parseStreamInfo(result.data);
+    }
+
+    /** 冻结流 */
+    async freeze(token: StreamToken): Promise<boolean> {
+        const result = await this.client.restful(`/streams/token/${token}/freeze`, undefined, { method: 'PUT' });
+        if (result.response.status === 204) return false;
+        return true;
+    }
+
+    /** 删除流 */
+    async delete(token: StreamToken): Promise<void> {
+        await this.client.restful(`/streams/token/${token}`, undefined, { method: 'DELETE' });
+    }
+
+    /** 获取流信息 */
+    async info(id: StreamId): Promise<StreamInfo> {
+        const result = await this.client.restful<StreamInfo>(`/streams/id/${id}/info`);
+        return parseStreamInfo(result.data);
+    }
+
+    /** 获取流信息 */
+    async get(token: StreamToken): Promise<Stream> {
+        const result = await this.client.restful<Stream>(`/streams/token/${token}/info`);
+        return parseStreamInfo(result.data);
+    }
+
+    /** 读取消息 */
+    read<T extends StreamType>(
+        stream: {
+            readonly id: StreamId;
+            readonly type: T;
+        },
+        options?: { from?: Date },
+    ): Observable<Message<T>> {
+        const { id, type } = stream;
+        const from = options?.from && Number(options.from) ? `?from=${options.from.toISOString()}` : '';
+        return new Observable<Message<T>>((subscriber) => {
+            const ws = this.client.ws(`/streams/id/${id}${from}`);
+            ws.binaryType = 'arraybuffer';
+            ws.addEventListener('message', (event) => {
+                if (typeof event.data === 'string' || !event.data) return;
+                subscriber.next(parseMessage(type, event.data as ArrayBuffer));
+            });
+            ws.addEventListener('close', (ev) => {
+                if (ev.code !== 1000) {
+                    subscriber.error(new Error(`WebSocket closed with code ${ev.code}: ${ev.reason}`));
+                } else if (ev.reason) {
+                    subscriber.error(new Error(ev.reason));
+                } else {
+                    subscriber.complete();
+                }
+            });
+            ws.addEventListener('error', (ev) => {
+                setTimeout(() => {
+                    if (!subscriber.closed) {
+                        // make sure the error event is not dispatched before the close event
+                        const error = ((ev as ErrorEvent).error as Error) ?? new Error(`WebSocket error`);
+                        subscriber.error(error);
+                    }
+                }, 1);
+            });
+            return () => {
+                if (ws.readyState === ws.OPEN) ws.close(1000);
+            };
+        });
+    }
+
+    /** 写入消息 */
+    async write<T extends StreamType>(
+        stream: {
+            readonly token: StreamToken;
+            readonly type: T;
+        },
+        data: ObservableInput<Message<T>['data']>,
+    ): Promise<void> {
+        const { token, type } = stream;
+        return new Promise((resolve, reject) => {
+            const ws = this.client.ws(`/streams/token/${token}`);
+            let queue = connected(ws).catch((error) => {
+                sub.unsubscribe();
+                throw error;
+            });
+            const sub = from(data).subscribe({
+                next: (data) => {
+                    if (data === undefined) return;
+                    queue = queue.then(() => {
+                        try {
+                            if (ws.readyState !== ws.OPEN) {
+                                throw new Error(`WebSocket is already in CLOSING or CLOSED state.`);
+                            }
+                            if (type === 'object') {
+                                if (!Array.isArray(data)) {
+                                    throw new TypeError(`Invalid data type, object stream only accepts array.`);
+                                }
+                                if (data.length) ws.send(encodeMany(data));
+                                return;
+                            } else {
+                                if (!ArrayBuffer.isView(data)) {
+                                    throw new TypeError(`Invalid data type, binary stream only accepts Uint8Array.`);
+                                }
+                                ws.send(data);
+                            }
+                        } catch (ex) {
+                            sub.unsubscribe();
+                            throw ex;
+                        }
+                    });
+                },
+                error: (error: Error) => {
+                    // error from source observable
+                    queue = queue.then(() => {
+                        throw error;
+                    });
+                },
+            });
+            sub.add(() => {
+                void (async () => {
+                    let err: unknown;
+                    try {
+                        await queue;
+                    } catch (e) {
+                        err = e;
+                    }
+                    ws.close(1000);
+                    try {
+                        await disconnected(ws);
+                    } catch (e) {
+                        err ??= e;
+                    }
+                    if (err === undefined) {
+                        resolve();
+                    } else {
+                        reject(err as Error);
+                    }
+                })();
+            });
+        });
+    }
+}
+
+/**
+ * 添加消息流插件，使得可以通过 `client.stream` 访问消息流相关接口
+ */
+export function MessageStreamPlugin(): HttpClientPlugin<{ readonly stream: MessageStreamClient }> {
+    return (client) => {
+        const stream = new MessageStreamClient(client);
+        Object.defineProperty(client, 'stream', { value: stream, configurable: true });
+        return client as HttpClient & { readonly stream: MessageStreamClient };
+    };
+}

package/tests/e2e.js

@@ -0,0 +1,33 @@
+/* eslint-disable no-console */
+import { setTimeout } from 'node:timers/promises';
+import { HttpClient } from '@cloudpss/http-client';
+import { MessageStreamPlugin } from '@cloudpss/message-stream/plugin';
+import { Subject } from 'rxjs';
+
+const http = new HttpClient({
+    apiUrl: 'http://dev.local.ddns.cloudpss.net/api/',
+}).use(MessageStreamPlugin());
+console.log(http);
+const stream = await http.stream.create({ type: 'binary', comment: 'test', durability: 0 });
+console.log(stream);
+const source = new Subject();
+
+const w = http.stream.write(stream, source);
+for (const i of Array.from({ length: 5 }).keys()) source.next(new Uint8Array([i]));
+source.next(10);
+for (const i of Array.from({ length: 5 }).keys()) source.next(new Uint8Array([i + 5]));
+source.error('xxs');
+source.complete();
+try {
+    await w;
+    console.log('write ok');
+} catch (ex) {
+    console.log('write error', ex);
+}
+await http.stream.freeze(stream.token);
+console.log(stream);
+http.stream.read(stream).subscribe((x) => {
+    console.log(x.data);
+});
+await setTimeout(10);
+await http.stream.delete(stream.token);