iii-browser-sdk 0.10.0

package/dist/stream-CCorhlLO.d.mts

@@ -0,0 +1,145 @@
+//#region src/stream.d.ts
+/** Input for stream authentication. */
+interface StreamAuthInput {
+  /** Request headers. */
+  headers: Record<string, string>;
+  /** Request path. */
+  path: string;
+  /** Query parameters. */
+  query_params: Record<string, string[]>;
+  /** Client address. */
+  addr: string;
+}
+/** Result of stream authentication. */
+interface StreamAuthResult {
+  /** Arbitrary context passed to stream handlers after authentication. */
+  context?: any;
+}
+/** Context type extracted from {@link StreamAuthResult}. */
+type StreamContext = StreamAuthResult['context'];
+/** Event payload for stream join/leave events. */
+interface StreamJoinLeaveEvent {
+  /** Unique subscription identifier. */
+  subscription_id: string;
+  /** Name of the stream. */
+  stream_name: string;
+  /** Group identifier. */
+  group_id: string;
+  /** Item identifier (if applicable). */
+  id?: string;
+  /** Auth context from {@link StreamAuthResult}. */
+  context?: StreamContext;
+}
+/** Result of a stream join request. */
+interface StreamJoinResult {
+  /** Whether the join was unauthorized. */
+  unauthorized: boolean;
+}
+/** Input for retrieving a single stream item. */
+type StreamGetInput = {
+  /** Name of the stream. */stream_name: string; /** Group identifier. */
+  group_id: string; /** Item identifier. */
+  item_id: string;
+};
+/** Input for setting a stream item. */
+type StreamSetInput = {
+  /** Name of the stream. */stream_name: string; /** Group identifier. */
+  group_id: string; /** Item identifier. */
+  item_id: string; /** Data to store. */
+  data: any;
+};
+/** Input for deleting a stream item. */
+type StreamDeleteInput = {
+  /** Name of the stream. */stream_name: string; /** Group identifier. */
+  group_id: string; /** Item identifier. */
+  item_id: string;
+};
+/** Input for listing all items in a stream group. */
+type StreamListInput = {
+  /** Name of the stream. */stream_name: string; /** Group identifier. */
+  group_id: string;
+};
+/** Input for listing all groups in a stream. */
+type StreamListGroupsInput = {
+  /** Name of the stream. */stream_name: string;
+};
+/** Result of a stream set operation. */
+type StreamSetResult<TData> = {
+  /** Previous value (if it existed). */old_value?: TData; /** New value that was stored. */
+  new_value: TData;
+};
+/** Result of a stream update operation. */
+type StreamUpdateResult<TData> = {
+  /** Previous value (if it existed). */old_value?: TData; /** New value after the update. */
+  new_value: TData;
+};
+/** Set a field at the given path to a value. */
+type UpdateSet = {
+  type: 'set'; /** Dot-separated field path (e.g. `user.name`). */
+  path: string; /** Value to set. */
+  value: any;
+};
+/** Increment a numeric field by a given amount. */
+type UpdateIncrement = {
+  type: 'increment'; /** Dot-separated field path. */
+  path: string; /** Amount to increment by. */
+  by: number;
+};
+/** Decrement a numeric field by a given amount. */
+type UpdateDecrement = {
+  type: 'decrement'; /** Dot-separated field path. */
+  path: string; /** Amount to decrement by. */
+  by: number;
+};
+/** Remove a field at the given path. */
+type UpdateRemove = {
+  type: 'remove'; /** Dot-separated field path. */
+  path: string;
+};
+/** Deep-merge an object into the field at the given path. */
+type UpdateMerge = {
+  type: 'merge'; /** Dot-separated field path. */
+  path: string; /** Object to merge. */
+  value: any;
+};
+/** Result of a stream delete operation. */
+type DeleteResult = {
+  /** Previous value (if it existed). */old_value?: any;
+};
+/**
+ * Union of all atomic update operations supported by streams.
+ *
+ * @see {@link UpdateSet}, {@link UpdateIncrement}, {@link UpdateDecrement},
+ *      {@link UpdateRemove}, {@link UpdateMerge}
+ */
+type UpdateOp = UpdateSet | UpdateIncrement | UpdateDecrement | UpdateRemove | UpdateMerge;
+/** Input for atomically updating a stream item. */
+type StreamUpdateInput = {
+  /** Name of the stream. */stream_name: string; /** Group identifier. */
+  group_id: string; /** Item identifier. */
+  item_id: string; /** Ordered list of update operations to apply atomically. */
+  ops: UpdateOp[];
+};
+/**
+ * Interface for custom stream implementations. Passed to `ISdk.createStream`
+ * to override the engine's built-in stream storage.
+ *
+ * @typeParam TData - Type of the data stored in the stream.
+ */
+interface IStream<TData> {
+  /** Retrieve a single item by group and item ID. */
+  get(input: StreamGetInput): Promise<TData | null>;
+  /** Set (create or overwrite) a stream item. */
+  set(input: StreamSetInput): Promise<StreamSetResult<TData> | null>;
+  /** Delete a stream item. */
+  delete(input: StreamDeleteInput): Promise<DeleteResult>;
+  /** List all items in a group. */
+  list(input: StreamListInput): Promise<TData[]>;
+  /** List all group IDs in a stream. */
+  listGroups(input: StreamListGroupsInput): Promise<string[]>;
+  /** Apply atomic update operations to a stream item. */
+  update(input: StreamUpdateInput): Promise<StreamUpdateResult<TData> | null>;
+}
+//#endregion
+export { UpdateIncrement as _, StreamContext as a, UpdateRemove as b, StreamJoinLeaveEvent as c, StreamListInput as d, StreamSetInput as f, UpdateDecrement as g, StreamUpdateResult as h, StreamAuthResult as i, StreamJoinResult as l, StreamUpdateInput as m, IStream as n, StreamDeleteInput as o, StreamSetResult as p, StreamAuthInput as r, StreamGetInput as s, DeleteResult as t, StreamListGroupsInput as u, UpdateMerge as v, UpdateSet as x, UpdateOp as y };
+//# sourceMappingURL=stream-CCorhlLO.d.mts.map

package/dist/stream-CCorhlLO.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-CCorhlLO.d.mts","names":[],"sources":["../src/stream.ts"],"mappings":";;UACiB,eAAA;EAAe;EAE9B,OAAA,EAAS,MAAA;EAIW;EAFpB,IAAA;EAFS;EAIT,YAAA,EAAc,MAAA;EAAd;EAEA,IAAA;AAAA;;UAIe,gBAAA;EAAA;EAGf,OAAA;AAAA;;KAIU,aAAA,GAAgB,gBAAA;AAA5B;AAAA,UAGiB,oBAAA;;EAEf,eAAA;EAL0C;EAO1C,WAAA;EAJmC;EAMnC,QAAA;EAIuB;EAFvB,EAAA;EAJA;EAMA,OAAA,GAAU,aAAA;AAAA;;UAIK,gBAAA;EAJQ;EAMvB,YAAA;AAAA;;KAIU,cAAA;EAJV,0BAMA,WAAA,UAFU;EAIV,QAAA;EAEA,OAAA;AAAA;;KAIU,cAAA;EAJH,0BAMP,WAAA,UAFU;EAIV,QAAA;EAEA,OAAA,UAJA;EAOA,IAAA;AAAA;;KAIU,iBAAA;EAJN,0BAMJ,WAAA,UAF2B;EAI3B,QAAA,UAJ2B;EAM3B,OAAA;AAAA;;KAIU,eAAA;EAJH,0BAMP,WAAA,UAFyB;EAIzB,QAAA;AAAA;;KAIU,qBAAA;EAAqB,0BAE/B,WAAA;AAAA;;KAIU,eAAA;EAAe,sCAEzB,SAAA,GAAY,KAAA,EAEI;EAAhB,SAAA,EAAW,KAAA;AAAA;;KAID,kBAAA;EAJC,sCAMX,SAAA,GAAY,KAAA,EANI;EAQhB,SAAA,EAAW,KAAA;AAAA;;KAID,SAAA;EACV,IAAA,SAPA;EASA,IAAA,UAPA;EAUA,KAAA;AAAA;;KAIU,eAAA;EACV,IAAA;EAEA,IAAA,UAZA;EAcA,EAAA;AAAA;;KAIU,eAAA;EACV,IAAA,eAVyB;EAYzB,IAAA,UAZyB;EAczB,EAAA;AAAA;;KAIU,YAAA;EACV,IAAA,YAVU;EAYV,IAAA;AAAA;;KAIU,WAAA;EACV,IAAA,WAZA;EAcA,IAAA,UAdE;EAiBF,KAAA;AAAA;;KAIU,YAAA;EAdN,sCAiBJ,SAAA;AAAA;;;;;;;KASU,QAAA,GAAW,SAAA,GAAY,eAAA,GAAkB,eAAA,GAAkB,YAAA,GAAe,WAAA;AAZtF;AAAA,KAeY,iBAAA;4BAEV,WAAA,UAdS;EAgBT,QAAA,UAPkB;EASlB,OAAA,UATqB;EAWrB,GAAA,EAAK,QAAA;AAAA;;;;;;;UASU,OAAA;EApBsD;EAsBrE,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,KAAA;EAtB2D;EAwB/F,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,eAAA,CAAgB,KAAA;EArB1C;EAuBV,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,YAAA;;EAE1C,IAAA,CAAK,KAAA,EAAO,eAAA,GAAkB,OAAA,CAAQ,KAAA;EAvBtC;EAyBA,UAAA,CAAW,KAAA,EAAO,qBAAA,GAAwB,OAAA;EArB1C;EAuBA,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;AAAA"}

package/dist/stream.d.cts

@@ -0,0 +1,2 @@
+import { _ as UpdateIncrement, a as StreamContext, b as UpdateRemove, c as StreamJoinLeaveEvent, d as StreamListInput, f as StreamSetInput, g as UpdateDecrement, h as StreamUpdateResult, i as StreamAuthResult, l as StreamJoinResult, m as StreamUpdateInput, n as IStream, o as StreamDeleteInput, p as StreamSetResult, r as StreamAuthInput, s as StreamGetInput, t as DeleteResult, u as StreamListGroupsInput, v as UpdateMerge, x as UpdateSet, y as UpdateOp } from "./stream-B4Etd7Hp.cjs";
+export { DeleteResult, IStream, StreamAuthInput, StreamAuthResult, StreamContext, StreamDeleteInput, StreamGetInput, StreamJoinLeaveEvent, StreamJoinResult, StreamListGroupsInput, StreamListInput, StreamSetInput, StreamSetResult, StreamUpdateInput, StreamUpdateResult, UpdateDecrement, UpdateIncrement, UpdateMerge, UpdateOp, UpdateRemove, UpdateSet };

package/dist/stream.d.mts

@@ -0,0 +1,2 @@
+import { _ as UpdateIncrement, a as StreamContext, b as UpdateRemove, c as StreamJoinLeaveEvent, d as StreamListInput, f as StreamSetInput, g as UpdateDecrement, h as StreamUpdateResult, i as StreamAuthResult, l as StreamJoinResult, m as StreamUpdateInput, n as IStream, o as StreamDeleteInput, p as StreamSetResult, r as StreamAuthInput, s as StreamGetInput, t as DeleteResult, u as StreamListGroupsInput, v as UpdateMerge, x as UpdateSet, y as UpdateOp } from "./stream-CCorhlLO.mjs";
+export { DeleteResult, IStream, StreamAuthInput, StreamAuthResult, StreamContext, StreamDeleteInput, StreamGetInput, StreamJoinLeaveEvent, StreamJoinResult, StreamListGroupsInput, StreamListInput, StreamSetInput, StreamSetResult, StreamUpdateInput, StreamUpdateResult, UpdateDecrement, UpdateIncrement, UpdateMerge, UpdateOp, UpdateRemove, UpdateSet };

package/dist/stream.mjs

@@ -0,0 +1 @@
+export {  };

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "iii-browser-sdk",
+  "version": "0.10.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "index.js",
+  "author": "III",
+  "license": "Apache-2.0",
+  "type": "module",
+  "description": "III SDK for the browser — no OpenTelemetry, no Node.js dependencies",
+  "keywords": [
+    "iii",
+    "sdk",
+    "browser",
+    "websocket"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./stream": {
+      "types": "./dist/stream.d.ts",
+      "import": "./dist/stream.mjs",
+      "require": "./dist/stream.cjs"
+    },
+    "./state": {
+      "types": "./dist/state.d.ts",
+      "import": "./dist/state.mjs",
+      "require": "./dist/state.cjs"
+    }
+  },
+  "devDependencies": {
+    "@types/ws": "^8.18.1",
+    "happy-dom": "^17.4.4",
+    "tsdown": "^0.21.4",
+    "typedoc": "^0.28.17",
+    "typescript": "^5.9.3",
+    "vitest": "^2.1.0",
+    "ws": "^8.18.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "docs:json": "typedoc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:integration": "vitest run --config vitest.integration.config.ts"
+  }
+}

package/typedoc.json

@@ -0,0 +1,8 @@
+{
+  "entryPoints": ["src/index.ts", "src/stream.ts", "src/state.ts"],
+  "json": "api-docs.json",
+  "tsconfig": "tsconfig.json",
+  "excludePrivate": true,
+  "excludeInternal": true,
+  "excludeExternals": true
+}

package/vitest.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'happy-dom',
+    testTimeout: 30000,
+    hookTimeout: 30000,
+    setupFiles: ['./tests/setup.ts'],
+    exclude: ['tests/integration/**'],
+  },
+})

package/vitest.integration.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    globals: true,
+    testTimeout: 30000,
+    hookTimeout: 30000,
+    setupFiles: ['./tests/integration/setup.ts'],
+    include: ['tests/integration/**/*.test.ts'],
+  },
+})