@blackglory/estore-js 0.5.1 → 0.5.3

package/lib/utils/rpc-client.browser.d.ts

@@ -1,8 +1,6 @@
 import { IAPI } from "../contract.js";
-import { ClientProxy, BatchClient, BatchClientProxy } from 'delight-rpc';
+import { ClientProxy } from 'delight-rpc';
 export declare function createRPCClient(url: string, retryIntervalForReconnection?: number): Promise<{
     client: ClientProxy<IAPI>;
-    batchClient: BatchClient<IAPI>;
-    proxy: BatchClientProxy<IAPI, unknown>;
     close: () => Promise<void>;
 }>;

package/lib/utils/rpc-client.browser.js

@@ -1,21 +1,15 @@
 import { expectedVersion } from "../contract.js";
-import { createBatchProxy } from 'delight-rpc';
-import { createClient, createBatchClient } from '@delight-rpc/extra-native-websocket';
+import { createClient } from '@delight-rpc/extra-native-websocket';
 import { ExtraNativeWebSocket, autoReconnect } from 'extra-native-websocket';
 export async function createRPCClient(url, retryIntervalForReconnection) {
     const ws = new ExtraNativeWebSocket(() => new WebSocket(url));
     const cancelAutoReconnect = autoReconnect(ws, retryIntervalForReconnection);
     await ws.connect();
     const [client, closeClient] = createClient(ws, { expectedVersion });
-    const [batchClient, closeBatchClient] = createBatchClient(ws, { expectedVersion });
-    const proxy = createBatchProxy();
     return {
         client,
-        batchClient,
-        proxy,
         close: async () => {
             closeClient();
-            closeBatchClient();
             cancelAutoReconnect();
             await ws.close();
         }

package/lib/utils/rpc-client.browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"rpc-client.browser.js","sourceRoot":"","sources":["../../src/utils/rpc-client.browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,eAAe,EAAE,uBAAwB;AACxD,OAAO,EAA8C,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC1F,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AACrF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAE5E,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,GAAW,EACX,4BAAqC;IAOrC,MAAM,EAAE,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7D,MAAM,mBAAmB,GAAG,aAAa,CAAC,EAAE,EAAE,4BAA4B,CAAC,CAAA;IAC3E,MAAM,EAAE,CAAC,OAAO,EAAE,CAAA;IAElB,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,YAAY,CAAO,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC,CAAA;IACzE,MAAM,CAAC,WAAW,EAAE,gBAAgB,CAAC,GAAG,iBAAiB,CAAC,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC,CAAA;IAClF,MAAM,KAAK,GAAG,gBAAgB,EAAQ,CAAA;IAEtC,OAAO;QACL,MAAM;QACN,WAAW;QACX,KAAK;QACL,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,WAAW,EAAE,CAAA;YACb,gBAAgB,EAAE,CAAA;YAClB,mBAAmB,EAAE,CAAA;YACrB,MAAM,EAAE,CAAC,KAAK,EAAE,CAAA;QAClB,CAAC;KACF,CAAA;AACH,CAAC"}
+{"version":3,"file":"rpc-client.browser.js","sourceRoot":"","sources":["../../src/utils/rpc-client.browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,eAAe,EAAE,uBAAwB;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAA;AAClE,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAE5E,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,GAAW,EACX,4BAAqC;IAKrC,MAAM,EAAE,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7D,MAAM,mBAAmB,GAAG,aAAa,CAAC,EAAE,EAAE,4BAA4B,CAAC,CAAA;IAC3E,MAAM,EAAE,CAAC,OAAO,EAAE,CAAA;IAElB,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,YAAY,CAAO,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC,CAAA;IAEzE,OAAO;QACL,MAAM;QACN,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,WAAW,EAAE,CAAA;YACb,mBAAmB,EAAE,CAAA;YACrB,MAAM,EAAE,CAAC,KAAK,EAAE,CAAA;QAClB,CAAC;KACF,CAAA;AACH,CAAC"}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@blackglory/estore-js",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "",
   "keywords": [],
   "files": [
-    "lib"
+    "lib",
+    "src"
   ],
   "type": "module",
   "main": "lib/index.js",

package/src/contract.ts

@@ -0,0 +1,45 @@
+import { CustomError } from '@blackglory/errors'
+import { JSONValue } from 'justypes'
+
+export const expectedVersion = '^0.4.0'
+
+export interface INamespaceStats {
+  items: number
+}
+
+export interface IAPI {
+  getAllNamespaces(): string[]
+  getAllItemIds(namespace: string): string[]
+  getAllEvents(namespace: string, itemId: string): JSONValue[]
+
+  getNamespaceStats(namespace: string): INamespaceStats
+
+  clearItemsByNamespace(namespace: string): null
+
+  removeItem(namespace: string, itemId: string): null
+
+  /**
+   * 获得指定项目内包含的事件数量, 该值等同于下一个事件插入时的索引号.
+   * 对于不存在的项目, 它会返回0.
+   */
+  getItemSize(namespace: string, itemId: string): number
+
+  /**
+   * @param nextEventIndex 如果指定, 则会在eventIndex不等于下一个index时抛出EventIndexConflict错误.
+   * @throws {EventIndexConflict}
+   */
+  appendEvent(
+    namespace: string
+  , itemId: string
+  , event: JSONValue
+  , nextEventIndex?: number
+  ): null
+
+  getEvent(
+    namespace: string
+  , itemId: string
+  , eventIndex: number
+  ): JSONValue | null
+}
+
+export class EventIndexConflict extends CustomError {}

package/src/estore-client.ts

@@ -0,0 +1,143 @@
+import { createRPCClient } from '@utils/rpc-client.js'
+import { ClientProxy } from 'delight-rpc'
+import { IAPI, INamespaceStats } from './contract.js'
+import { timeoutSignal, withAbortSignal } from 'extra-abort'
+import { isUndefined, JSONValue } from '@blackglory/prelude'
+export { INamespaceStats } from './contract.js'
+export { EventIndexConflict } from './contract.js'
+
+export interface IEStoreClientOptions {
+  server: string
+  timeout?: number
+  retryIntervalForReconnection?: number
+}
+
+export class EStoreClient {
+  static async create(options: IEStoreClientOptions): Promise<EStoreClient> {
+    const { client, close } = await createRPCClient(
+      options.server
+    , options.retryIntervalForReconnection
+    )
+    return new EStoreClient(client, close, options.timeout)
+  }
+
+  private constructor(
+    private client: ClientProxy<IAPI>
+  , private closeClients: () => Promise<void>
+  , private timeout?: number
+  ) {}
+
+  async close(): Promise<void> {
+    await this.closeClients()
+  }
+
+  async getNamespaceStats(
+    namespace: string
+  , timeout?: number
+  ): Promise<INamespaceStats> {
+    return await this.withTimeout(
+      () => this.client.getNamespaceStats(namespace)
+    , timeout ?? this.timeout
+    )
+  }
+
+  async getAllNamespaces(timeout?: number): Promise<string[]> {
+    return await this.withTimeout(
+      () => this.client.getAllNamespaces()
+    , timeout ?? this.timeout
+    )
+  }
+
+  async getAllItemIds(namespace: string, timeout?: number): Promise<string[]> {
+    return await this.withTimeout(
+      () => this.client.getAllItemIds(namespace)
+    , timeout ?? this.timeout
+    )
+  }
+
+  async getAllEvents(
+    namespace: string
+  , itemId: string
+  , timeout?: number
+  ): Promise<JSONValue[]> {
+    return await this.withTimeout(
+      () => this.client.getAllEvents(namespace, itemId)
+    , timeout ?? this.timeout
+    )
+  }
+
+  async clearItemsByNamespace(namespace: string, timeout?: number): Promise<void> {
+    await this.withTimeout(
+      () => this.client.clearItemsByNamespace(namespace)
+    , timeout ?? this.timeout
+    )
+  }
+
+  async removeItem(
+    namespace: string
+  , itemId: string
+  , timeout?: number
+  ): Promise<void> {
+    await this.withTimeout(
+      () => this.client.removeItem(namespace, itemId)
+    , timeout ?? this.timeout
+    )
+  }
+
+  async getItemSize(
+    namespace: string
+  , itemId: string
+  , timeout?: number
+  ): Promise<number> {
+    return await this.withTimeout(
+      () => this.client.getItemSize(namespace, itemId)
+    , timeout ?? this.timeout
+    )
+  }
+
+  /**
+   * @param nextEventIndex 如果指定, 则会在eventIndex不等于下一个index时抛出EventIndexConflict错误.
+   * @throws {EventIndexConflict}
+   */
+  async appendEvent(
+    namespace: string
+  , itemId: string
+  , event: JSONValue
+  , nextEventIndex?: number
+  , timeout?: number
+  ): Promise<void> {
+    await this.withTimeout(
+      () => {
+        if (isUndefined(nextEventIndex)) {
+          return this.client.appendEvent(namespace, itemId, event)
+        } else {
+          return this.client.appendEvent(namespace, itemId, event, nextEventIndex)
+        }
+      }
+    , timeout ?? this.timeout
+    )
+  }
+
+  async getEvent(
+    namespace: string
+  , itemId: string
+  , index: number
+  , timeout?: number
+  ): Promise<JSONValue | null> {
+    return await this.withTimeout(
+      () => this.client.getEvent(namespace, itemId, index)
+    , timeout ?? this.timeout
+    )
+  }
+
+  private async withTimeout<T>(
+    fn: () => PromiseLike<T>
+  , timeout: number | undefined = this.timeout
+  ): Promise<T> {
+    if (timeout) {
+      return await withAbortSignal(timeoutSignal(timeout), fn)
+    } else {
+      return await fn()
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './estore-client.js'

package/src/utils/rpc-client.browser.ts

@@ -0,0 +1,27 @@
+import { IAPI, expectedVersion } from '@src/contract.js'
+import { ClientProxy } from 'delight-rpc'
+import { createClient } from '@delight-rpc/extra-native-websocket'
+import { ExtraNativeWebSocket, autoReconnect } from 'extra-native-websocket'
+
+export async function createRPCClient(
+  url: string
+, retryIntervalForReconnection?: number
+): Promise<{
+  client: ClientProxy<IAPI>
+  close: () => Promise<void>
+}> {
+  const ws = new ExtraNativeWebSocket(() => new WebSocket(url))
+  const cancelAutoReconnect = autoReconnect(ws, retryIntervalForReconnection)
+  await ws.connect()
+
+  const [client, closeClient] = createClient<IAPI>(ws, { expectedVersion })
+
+  return {
+    client
+  , close: async () => {
+      closeClient()
+      cancelAutoReconnect()
+      await ws.close()
+    }
+  }
+}

package/src/utils/rpc-client.ts

@@ -0,0 +1,28 @@
+import { IAPI, expectedVersion } from '@src/contract.js'
+import { ClientProxy } from 'delight-rpc'
+import { createClient } from '@delight-rpc/extra-websocket'
+import { WebSocket } from 'ws'
+import { ExtraWebSocket, autoReconnect } from 'extra-websocket'
+
+export async function createRPCClient(
+  url: string
+, retryIntervalForReconnection?: number
+): Promise<{
+  client: ClientProxy<IAPI>
+  close: () => Promise<void>
+}> {
+  const ws = new ExtraWebSocket(() => new WebSocket(url))
+  const cancelAutoReconnect = autoReconnect(ws, retryIntervalForReconnection)
+  await ws.connect()
+
+  const [client, closeClient] = createClient<IAPI>(ws, { expectedVersion })
+
+  return {
+    client
+  , close: async () => {
+      closeClient()
+      cancelAutoReconnect()
+      await ws.close()
+    }
+  }
+}