@perspective-dev/client 5.3.1 → 5.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,6 @@
1
+ import type { ViewOnRemoveResp } from "./ViewOnRemoveResp.js";
2
+ /**
3
+ * Removed index values and port ID corresponding to a remove batch, provided
4
+ * to the callback argument to [`View::on_remove`].
5
+ */
6
+ export type OnRemoveData = ViewOnRemoveResp;
@@ -0,0 +1,6 @@
1
+ import type { ViewOnUpdateResp } from "./ViewOnUpdateResp.js";
2
+ /**
3
+ * Rows updated and port ID corresponding to an update batch, provided to the
4
+ * callback argument to [`View::on_update`] with the "rows" mode.
5
+ */
6
+ export type OnUpdateData = ViewOnUpdateResp;
@@ -0,0 +1,4 @@
1
+ export type ViewOnRemoveResp = {
2
+ indices: Uint8Array;
3
+ port_id: number;
4
+ };
@@ -1,4 +1,4 @@
1
1
  export type ViewOnUpdateResp = {
2
- delta: Array<number>;
2
+ delta: Uint8Array | undefined;
3
3
  port_id: number;
4
4
  };
@@ -5,7 +5,7 @@ import type * as psp from "../../../dist/wasm/perspective-js.d.ts";
5
5
  * @param module
6
6
  * @returns
7
7
  */
8
- export declare function worker(module: Promise<typeof psp>, server_wasm: Promise<WebAssembly.Module> | undefined, perspective_wasm_worker: Promise<SharedWorker | ServiceWorker | Worker | MessagePort>): Promise<psp.Client>;
8
+ export declare function worker(module: Promise<typeof psp>, server_wasm: Promise<WebAssembly.Module> | undefined, perspective_wasm_worker: Promise<SharedWorker | Worker | MessagePort>): Promise<psp.Client>;
9
9
  /**
10
10
  * Create a new client connected via WebSocket to a server implemnting the
11
11
  * Perspective Protocol.
@@ -91,6 +91,9 @@ export type * from "../../src/ts/ts-rs/ColumnWindow.d.ts";
91
91
  export type * from "../../src/ts/ts-rs/TableInitOptions.d.ts";
92
92
  export type * from "../../src/ts/ts-rs/ViewConfigUpdate.d.ts";
93
93
  export type * from "../../src/ts/ts-rs/ViewOnUpdateResp.d.ts";
94
+ export type * from "../../src/ts/ts-rs/ViewOnRemoveResp.d.ts";
95
+ export type * from "../../src/ts/ts-rs/OnRemoveData.d.ts";
96
+ export type * from "../../src/ts/ts-rs/OnUpdateData.d.ts";
94
97
  export type * from "../../src/ts/ts-rs/OnUpdateOptions.d.ts";
95
98
  export type * from "../../src/ts/ts-rs/UpdateOptions.d.ts";
96
99
  export type * from "../../src/ts/ts-rs/DeleteOptions.d.ts";
@@ -115,6 +118,8 @@ import type {JoinOptions} from "../../src/ts/ts-rs/JoinOptions.ts";
115
118
  import type {JoinType} from "../../src/ts/ts-rs/JoinType.ts";
116
119
  import type {ViewConfigUpdate} from "../../src/ts/ts-rs/ViewConfigUpdate.d.ts";
117
120
  import type * as on_update_args from "../../src/ts/ts-rs/ViewOnUpdateResp.d.ts";
121
+ import type {OnRemoveData} from "../../src/ts/ts-rs/OnRemoveData.d.ts";
122
+ import type {OnUpdateData} from "../../src/ts/ts-rs/OnUpdateData.d.ts";
118
123
  import type {OnUpdateOptions} from "../../src/ts/ts-rs/OnUpdateOptions.d.ts";
119
124
  import type {UpdateOptions} from "../../src/ts/ts-rs/UpdateOptions.d.ts";
120
125
  import type {DeleteOptions} from "../../src/ts/ts-rs/DeleteOptions.d.ts";
@@ -737,12 +742,31 @@ export class View {
737
742
  * deleted, this callback will be invoked.
738
743
  */
739
744
  on_delete(on_delete: Function): Promise<any>;
745
+ /**
746
+ * Register a callback which is invoked whenever rows are removed from
747
+ * this [`View`]'s [`Table`] by [`Table::remove`], with an object
748
+ * containing `port_id` and `indices`, the removed `index` column
749
+ * values as an Arrow of one column named after the index.
750
+ *
751
+ * [`Table::replace`] reports the keys it does not re-supply and
752
+ * [`Table::clear`] reports every key. `on_remove` never fires for a
753
+ * [`Table`] without an `index`.
754
+ *
755
+ * # JavaScript Examples
756
+ *
757
+ * ```javascript
758
+ * const id = await view.on_remove(({ indices, port_id }) => {
759
+ * replica.remove(indices);
760
+ * });
761
+ * ```
762
+ */
763
+ on_remove(on_remove_js: (data: OnRemoveData) => void): Promise<any>;
740
764
  /**
741
765
  * Register a callback with this [`View`]. Whenever the view's underlying
742
766
  * table emits an update, this callback will be invoked with an object
743
767
  * containing `port_id`, indicating which port the update fired on, and
744
768
  * optionally `delta`, which is the new data that was updated for each
745
- * cell or each row.
769
+ * cell or each row (as an Arrow).
746
770
  *
747
771
  * # Arguments
748
772
  *
@@ -750,27 +774,33 @@ export class View {
750
774
  * object with two keys: `port_id`, indicating which port the update was
751
775
  * triggered on, and `delta`, whose value is dependent on the mode
752
776
  * parameter.
753
- * - `options` - If this is provided as `OnUpdateOptions { mode:
754
- * Some(OnUpdateMode::Row) }`, then `delta` is an Arrow of the updated
755
- * rows. Otherwise `delta` will be [`Option::None`].
777
+ * - `options` - If this is provided as `{mode: "row"}`, then `delta` is an
778
+ * Arrow of the updated rows. Otherwise `delta` will be `null`.
756
779
  *
757
780
  * # JavaScript Examples
758
781
  *
759
782
  * ```javascript
760
- * // Attach an `on_update` callback
761
783
  * view.on_update((updated) => console.log(updated.port_id));
762
784
  * ```
763
785
  *
764
786
  * ```javascript
765
- * // `on_update` with row deltas
766
787
  * view.on_update((updated) => console.log(updated.delta), { mode: "row" });
767
788
  * ```
768
789
  */
769
- on_update(on_update_js: Function, options?: OnUpdateOptions | null): Promise<any>;
790
+ on_update(on_update_js: (data: OnUpdateData) => void, options?: OnUpdateOptions | null): Promise<any>;
770
791
  /**
771
792
  * Unregister a previously registered [`View::on_delete`] callback.
772
793
  */
773
794
  remove_delete(callback_id: number): Promise<any>;
795
+ /**
796
+ * Unregister a previously registered [`View::on_remove`] callback.
797
+ *
798
+ * # Arguments
799
+ *
800
+ * - `id` - A callback `id` as returned by a reciprocal call to
801
+ * [`View::on_remove`].
802
+ */
803
+ remove_remove(callback_id: number): Promise<void>;
774
804
  /**
775
805
  * Unregister a previously registered update callback with this [`View`].
776
806
  *
@@ -941,8 +971,10 @@ export interface InitOutput {
941
971
  readonly view_num_columns: (a: number) => number;
942
972
  readonly view_num_rows: (a: number) => number;
943
973
  readonly view_on_delete: (a: number, b: number) => number;
974
+ readonly view_on_remove: (a: number, b: number) => number;
944
975
  readonly view_on_update: (a: number, b: number, c: number) => number;
945
976
  readonly view_remove_delete: (a: number, b: number) => number;
977
+ readonly view_remove_remove: (a: number, b: number) => number;
946
978
  readonly view_remove_update: (a: number, b: number) => number;
947
979
  readonly view_schema: (a: number) => number;
948
980
  readonly view_set_depth: (a: number, b: number) => number;
@@ -964,12 +996,12 @@ export interface InitOutput {
964
996
  readonly virtualdataslice_setStringCol: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
965
997
  readonly virtualserver_handleRequest: (a: number, b: number, c: number) => number;
966
998
  readonly virtualserver_new: (a: number, b: number) => void;
967
- readonly __wasm_bindgen_func_elem_1178: (a: number, b: number) => void;
968
- readonly __wasm_bindgen_func_elem_4323: (a: number, b: number) => void;
969
- readonly __wasm_bindgen_func_elem_12505: (a: number, b: number, c: number, d: number) => void;
970
- readonly __wasm_bindgen_func_elem_4340: (a: number, b: number, c: number) => void;
971
- readonly __wasm_bindgen_func_elem_1927: (a: number, b: number) => number;
972
- readonly __wasm_bindgen_func_elem_1928: (a: number, b: number) => void;
999
+ readonly __wasm_bindgen_func_elem_1222: (a: number, b: number) => void;
1000
+ readonly __wasm_bindgen_func_elem_4376: (a: number, b: number) => void;
1001
+ readonly __wasm_bindgen_func_elem_12577: (a: number, b: number, c: number, d: number) => void;
1002
+ readonly __wasm_bindgen_func_elem_4393: (a: number, b: number, c: number) => void;
1003
+ readonly __wasm_bindgen_func_elem_1955: (a: number, b: number) => number;
1004
+ readonly __wasm_bindgen_func_elem_1956: (a: number, b: number) => void;
973
1005
  readonly __wbindgen_export: (a: number, b: number) => number;
974
1006
  readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
975
1007
  readonly __wbindgen_export3: (a: number) => void;
@@ -1277,12 +1277,36 @@ export class View {
1277
1277
  const ret = wasm.view_on_delete(this.__wbg_ptr, addHeapObject(on_delete));
1278
1278
  return takeObject(ret);
1279
1279
  }
1280
+ /**
1281
+ * Register a callback which is invoked whenever rows are removed from
1282
+ * this [`View`]'s [`Table`] by [`Table::remove`], with an object
1283
+ * containing `port_id` and `indices`, the removed `index` column
1284
+ * values as an Arrow of one column named after the index.
1285
+ *
1286
+ * [`Table::replace`] reports the keys it does not re-supply and
1287
+ * [`Table::clear`] reports every key. `on_remove` never fires for a
1288
+ * [`Table`] without an `index`.
1289
+ *
1290
+ * # JavaScript Examples
1291
+ *
1292
+ * ```javascript
1293
+ * const id = await view.on_remove(({ indices, port_id }) => {
1294
+ * replica.remove(indices);
1295
+ * });
1296
+ * ```
1297
+ * @param {(data: OnRemoveData) => void} on_remove_js
1298
+ * @returns {Promise<any>}
1299
+ */
1300
+ on_remove(on_remove_js) {
1301
+ const ret = wasm.view_on_remove(this.__wbg_ptr, addHeapObject(on_remove_js));
1302
+ return takeObject(ret);
1303
+ }
1280
1304
  /**
1281
1305
  * Register a callback with this [`View`]. Whenever the view's underlying
1282
1306
  * table emits an update, this callback will be invoked with an object
1283
1307
  * containing `port_id`, indicating which port the update fired on, and
1284
1308
  * optionally `delta`, which is the new data that was updated for each
1285
- * cell or each row.
1309
+ * cell or each row (as an Arrow).
1286
1310
  *
1287
1311
  * # Arguments
1288
1312
  *
@@ -1290,22 +1314,19 @@ export class View {
1290
1314
  * object with two keys: `port_id`, indicating which port the update was
1291
1315
  * triggered on, and `delta`, whose value is dependent on the mode
1292
1316
  * parameter.
1293
- * - `options` - If this is provided as `OnUpdateOptions { mode:
1294
- * Some(OnUpdateMode::Row) }`, then `delta` is an Arrow of the updated
1295
- * rows. Otherwise `delta` will be [`Option::None`].
1317
+ * - `options` - If this is provided as `{mode: "row"}`, then `delta` is an
1318
+ * Arrow of the updated rows. Otherwise `delta` will be `null`.
1296
1319
  *
1297
1320
  * # JavaScript Examples
1298
1321
  *
1299
1322
  * ```javascript
1300
- * // Attach an `on_update` callback
1301
1323
  * view.on_update((updated) => console.log(updated.port_id));
1302
1324
  * ```
1303
1325
  *
1304
1326
  * ```javascript
1305
- * // `on_update` with row deltas
1306
1327
  * view.on_update((updated) => console.log(updated.delta), { mode: "row" });
1307
1328
  * ```
1308
- * @param {Function} on_update_js
1329
+ * @param {(data: OnUpdateData) => void} on_update_js
1309
1330
  * @param {OnUpdateOptions | null} [options]
1310
1331
  * @returns {Promise<any>}
1311
1332
  */
@@ -1322,6 +1343,20 @@ export class View {
1322
1343
  const ret = wasm.view_remove_delete(this.__wbg_ptr, callback_id);
1323
1344
  return takeObject(ret);
1324
1345
  }
1346
+ /**
1347
+ * Unregister a previously registered [`View::on_remove`] callback.
1348
+ *
1349
+ * # Arguments
1350
+ *
1351
+ * - `id` - A callback `id` as returned by a reciprocal call to
1352
+ * [`View::on_remove`].
1353
+ * @param {number} callback_id
1354
+ * @returns {Promise<void>}
1355
+ */
1356
+ remove_remove(callback_id) {
1357
+ const ret = wasm.view_remove_remove(this.__wbg_ptr, callback_id);
1358
+ return takeObject(ret);
1359
+ }
1325
1360
  /**
1326
1361
  * Unregister a previously registered update callback with this [`View`].
1327
1362
  *
@@ -2017,7 +2052,7 @@ function __wbg_get_imports() {
2017
2052
  const a = state0.a;
2018
2053
  state0.a = 0;
2019
2054
  try {
2020
- return __wasm_bindgen_func_elem_12505(a, state0.b, arg0, arg1);
2055
+ return __wasm_bindgen_func_elem_12577(a, state0.b, arg0, arg1);
2021
2056
  } finally {
2022
2057
  state0.a = a;
2023
2058
  }
@@ -2092,7 +2127,7 @@ function __wbg_get_imports() {
2092
2127
  const ret = Promise.resolve(getObject(arg0));
2093
2128
  return addHeapObject(ret);
2094
2129
  },
2095
- __wbg_run_eb9b330adc7bc53c: function() { return handleError(function (arg0, arg1) {
2130
+ __wbg_run_26ff8525c6787d9c: function() { return handleError(function (arg0, arg1) {
2096
2131
  const ret = getObject(arg0).run(getObject(arg1));
2097
2132
  return addHeapObject(ret);
2098
2133
  }, arguments); },
@@ -2180,17 +2215,17 @@ function __wbg_get_imports() {
2180
2215
  },
2181
2216
  __wbindgen_cast_0000000000000001: function(arg0, arg1) {
2182
2217
  // Cast intrinsic for `Closure(Closure { dtor_idx: 12, function: Function { arguments: [], shim_idx: 32, ret: NamedExternref("Promise<any>"), inner_ret: Some(NamedExternref("Promise<any>")) }, mutable: false }) -> Externref`.
2183
- const ret = makeClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_1178, __wasm_bindgen_func_elem_1927);
2218
+ const ret = makeClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_1222, __wasm_bindgen_func_elem_1955);
2184
2219
  return addHeapObject(ret);
2185
2220
  },
2186
2221
  __wbindgen_cast_0000000000000002: function(arg0, arg1) {
2187
2222
  // Cast intrinsic for `Closure(Closure { dtor_idx: 12, function: Function { arguments: [], shim_idx: 33, ret: Unit, inner_ret: Some(Unit) }, mutable: false }) -> Externref`.
2188
- const ret = makeClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_1178, __wasm_bindgen_func_elem_1928);
2223
+ const ret = makeClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_1222, __wasm_bindgen_func_elem_1956);
2189
2224
  return addHeapObject(ret);
2190
2225
  },
2191
2226
  __wbindgen_cast_0000000000000003: function(arg0, arg1) {
2192
- // Cast intrinsic for `Closure(Closure { dtor_idx: 591, function: Function { arguments: [Externref], shim_idx: 592, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
2193
- const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_4323, __wasm_bindgen_func_elem_4340);
2227
+ // Cast intrinsic for `Closure(Closure { dtor_idx: 609, function: Function { arguments: [Externref], shim_idx: 610, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
2228
+ const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_4376, __wasm_bindgen_func_elem_4393);
2194
2229
  return addHeapObject(ret);
2195
2230
  },
2196
2231
  __wbindgen_cast_0000000000000004: function(arg0) {
@@ -2267,21 +2302,21 @@ function __wbg_get_imports() {
2267
2302
  };
2268
2303
  }
2269
2304
 
2270
- function __wasm_bindgen_func_elem_1928(arg0, arg1) {
2271
- wasm.__wasm_bindgen_func_elem_1928(arg0, arg1);
2305
+ function __wasm_bindgen_func_elem_1956(arg0, arg1) {
2306
+ wasm.__wasm_bindgen_func_elem_1956(arg0, arg1);
2272
2307
  }
2273
2308
 
2274
- function __wasm_bindgen_func_elem_1927(arg0, arg1) {
2275
- const ret = wasm.__wasm_bindgen_func_elem_1927(arg0, arg1);
2309
+ function __wasm_bindgen_func_elem_1955(arg0, arg1) {
2310
+ const ret = wasm.__wasm_bindgen_func_elem_1955(arg0, arg1);
2276
2311
  return takeObject(ret);
2277
2312
  }
2278
2313
 
2279
- function __wasm_bindgen_func_elem_4340(arg0, arg1, arg2) {
2280
- wasm.__wasm_bindgen_func_elem_4340(arg0, arg1, addHeapObject(arg2));
2314
+ function __wasm_bindgen_func_elem_4393(arg0, arg1, arg2) {
2315
+ wasm.__wasm_bindgen_func_elem_4393(arg0, arg1, addHeapObject(arg2));
2281
2316
  }
2282
2317
 
2283
- function __wasm_bindgen_func_elem_12505(arg0, arg1, arg2, arg3) {
2284
- wasm.__wasm_bindgen_func_elem_12505(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
2318
+ function __wasm_bindgen_func_elem_12577(arg0, arg1, arg2, arg3) {
2319
+ wasm.__wasm_bindgen_func_elem_12577(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
2285
2320
  }
2286
2321
 
2287
2322
  const ClientFinalization = (typeof FinalizationRegistry === 'undefined')
Binary file
@@ -70,8 +70,10 @@ export const view_get_min_max: (a: number, b: number, c: number) => number;
70
70
  export const view_num_columns: (a: number) => number;
71
71
  export const view_num_rows: (a: number) => number;
72
72
  export const view_on_delete: (a: number, b: number) => number;
73
+ export const view_on_remove: (a: number, b: number) => number;
73
74
  export const view_on_update: (a: number, b: number, c: number) => number;
74
75
  export const view_remove_delete: (a: number, b: number) => number;
76
+ export const view_remove_remove: (a: number, b: number) => number;
75
77
  export const view_remove_update: (a: number, b: number) => number;
76
78
  export const view_schema: (a: number) => number;
77
79
  export const view_set_depth: (a: number, b: number) => number;
@@ -93,12 +95,12 @@ export const virtualdataslice_setIntegerCol: (a: number, b: number, c: number, d
93
95
  export const virtualdataslice_setStringCol: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
94
96
  export const virtualserver_handleRequest: (a: number, b: number, c: number) => number;
95
97
  export const virtualserver_new: (a: number, b: number) => void;
96
- export const __wasm_bindgen_func_elem_1178: (a: number, b: number) => void;
97
- export const __wasm_bindgen_func_elem_4323: (a: number, b: number) => void;
98
- export const __wasm_bindgen_func_elem_12505: (a: number, b: number, c: number, d: number) => void;
99
- export const __wasm_bindgen_func_elem_4340: (a: number, b: number, c: number) => void;
100
- export const __wasm_bindgen_func_elem_1927: (a: number, b: number) => number;
101
- export const __wasm_bindgen_func_elem_1928: (a: number, b: number) => void;
98
+ export const __wasm_bindgen_func_elem_1222: (a: number, b: number) => void;
99
+ export const __wasm_bindgen_func_elem_4376: (a: number, b: number) => void;
100
+ export const __wasm_bindgen_func_elem_12577: (a: number, b: number, c: number, d: number) => void;
101
+ export const __wasm_bindgen_func_elem_4393: (a: number, b: number, c: number) => void;
102
+ export const __wasm_bindgen_func_elem_1955: (a: number, b: number) => number;
103
+ export const __wasm_bindgen_func_elem_1956: (a: number, b: number) => void;
102
104
  export const __wbindgen_export: (a: number, b: number) => number;
103
105
  export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
104
106
  export const __wbindgen_export3: (a: number) => void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@perspective-dev/client",
3
- "version": "5.3.1",
3
+ "version": "5.5.0",
4
4
  "description": "Client for Perspective, a high-performance WASM engine with reactive Tables, Views, and joins.",
5
5
  "keywords": [
6
6
  "perspective",
@@ -63,15 +63,12 @@
63
63
  "access": "public"
64
64
  },
65
65
  "dependencies": {
66
- "@perspective-dev/server": "",
67
66
  "pro_self_extracting_wasm": "0.0.9",
68
67
  "stoppable": "=1.1.0",
69
- "ws": "^8.17.0"
68
+ "ws": "^8.17.0",
69
+ "@perspective-dev/server": "^5.5.0"
70
70
  },
71
71
  "devDependencies": {
72
- "@perspective-dev/esbuild-plugin": "",
73
- "@perspective-dev/metadata": "",
74
- "@perspective-dev/test": "",
75
72
  "@clickhouse/client-web": "^1.12.0",
76
73
  "@duckdb/duckdb-wasm": "1.33.1-dev18.0",
77
74
  "@playwright/experimental-ct-react": "=1.58.0",
@@ -86,7 +83,10 @@
86
83
  "typedoc": "^0.28.7",
87
84
  "typescript": ">=5 <6",
88
85
  "web-worker": "1.4.1",
89
- "zx": ">=8 <9"
86
+ "zx": ">=8 <9",
87
+ "@perspective-dev/esbuild-plugin": "^5.5.0",
88
+ "@perspective-dev/metadata": "^5.5.0",
89
+ "@perspective-dev/test": "^5.5.0"
90
90
  },
91
91
  "scripts": {
92
92
  "build": "node ./build.mjs",
package/src/rust/lib.rs CHANGED
@@ -53,6 +53,9 @@ export type * from "../../src/ts/ts-rs/ColumnWindow.d.ts";
53
53
  export type * from "../../src/ts/ts-rs/TableInitOptions.d.ts";
54
54
  export type * from "../../src/ts/ts-rs/ViewConfigUpdate.d.ts";
55
55
  export type * from "../../src/ts/ts-rs/ViewOnUpdateResp.d.ts";
56
+ export type * from "../../src/ts/ts-rs/ViewOnRemoveResp.d.ts";
57
+ export type * from "../../src/ts/ts-rs/OnRemoveData.d.ts";
58
+ export type * from "../../src/ts/ts-rs/OnUpdateData.d.ts";
56
59
  export type * from "../../src/ts/ts-rs/OnUpdateOptions.d.ts";
57
60
  export type * from "../../src/ts/ts-rs/UpdateOptions.d.ts";
58
61
  export type * from "../../src/ts/ts-rs/DeleteOptions.d.ts";
@@ -77,6 +80,8 @@ import type {JoinOptions} from "../../src/ts/ts-rs/JoinOptions.ts";
77
80
  import type {JoinType} from "../../src/ts/ts-rs/JoinType.ts";
78
81
  import type {ViewConfigUpdate} from "../../src/ts/ts-rs/ViewConfigUpdate.d.ts";
79
82
  import type * as on_update_args from "../../src/ts/ts-rs/ViewOnUpdateResp.d.ts";
83
+ import type {OnRemoveData} from "../../src/ts/ts-rs/OnRemoveData.d.ts";
84
+ import type {OnUpdateData} from "../../src/ts/ts-rs/OnUpdateData.d.ts";
80
85
  import type {OnUpdateOptions} from "../../src/ts/ts-rs/OnUpdateOptions.d.ts";
81
86
  import type {UpdateOptions} from "../../src/ts/ts-rs/UpdateOptions.d.ts";
82
87
  import type {DeleteOptions} from "../../src/ts/ts-rs/DeleteOptions.d.ts";
@@ -108,6 +108,14 @@ where
108
108
  pub fn new_throttled<U: Future<Output = ApiResult<T>> + 'static>(x: U) -> ApiFuture<()> {
109
109
  ApiFuture::<()>::new(async move { x.await.ignore_view_delete().map(|_| ()) })
110
110
  }
111
+
112
+ pub fn new_pure(t: T) -> ApiFuture<T> {
113
+ ApiFuture::<T>::new(async move { Ok(t) })
114
+ }
115
+
116
+ pub fn new_err<E: Into<ApiError> + 'static>(err: E) -> ApiFuture<T> {
117
+ ApiFuture::<T>::new(async move { Err(err.into()) })
118
+ }
111
119
  }
112
120
 
113
121
  impl<T> ApiFuture<T>
package/src/rust/view.rs CHANGED
@@ -12,7 +12,7 @@
12
12
 
13
13
  use js_sys::{Array, ArrayBuffer, Function, Object};
14
14
  use perspective_client::{
15
- ColumnWindow, OnUpdateData, OnUpdateOptions, ViewWindow, assert_view_api,
15
+ ColumnWindow, OnRemoveData, OnUpdateData, OnUpdateOptions, ViewWindow, assert_view_api,
16
16
  };
17
17
  use wasm_bindgen::prelude::*;
18
18
  use wasm_bindgen_futures::spawn_local;
@@ -289,7 +289,7 @@ impl View {
289
289
  /// table emits an update, this callback will be invoked with an object
290
290
  /// containing `port_id`, indicating which port the update fired on, and
291
291
  /// optionally `delta`, which is the new data that was updated for each
292
- /// cell or each row.
292
+ /// cell or each row (as an Arrow).
293
293
  ///
294
294
  /// # Arguments
295
295
  ///
@@ -297,24 +297,22 @@ impl View {
297
297
  /// object with two keys: `port_id`, indicating which port the update was
298
298
  /// triggered on, and `delta`, whose value is dependent on the mode
299
299
  /// parameter.
300
- /// - `options` - If this is provided as `OnUpdateOptions { mode:
301
- /// Some(OnUpdateMode::Row) }`, then `delta` is an Arrow of the updated
302
- /// rows. Otherwise `delta` will be [`Option::None`].
300
+ /// - `options` - If this is provided as `{mode: "row"}`, then `delta` is an
301
+ /// Arrow of the updated rows. Otherwise `delta` will be `null`.
303
302
  ///
304
303
  /// # JavaScript Examples
305
304
  ///
306
305
  /// ```javascript
307
- /// // Attach an `on_update` callback
308
306
  /// view.on_update((updated) => console.log(updated.port_id));
309
307
  /// ```
310
308
  ///
311
309
  /// ```javascript
312
- /// // `on_update` with row deltas
313
310
  /// view.on_update((updated) => console.log(updated.delta), { mode: "row" });
314
311
  /// ```
315
312
  #[wasm_bindgen]
316
313
  pub fn on_update(
317
314
  &self,
315
+ #[wasm_bindgen(unchecked_param_type = "(data: OnUpdateData) => void")]
318
316
  on_update_js: Function,
319
317
  options: Option<JsOnUpdateOptions>,
320
318
  ) -> ApiFuture<u32> {
@@ -346,6 +344,49 @@ impl View {
346
344
  Ok(self.0.remove_update(callback_id).await?)
347
345
  }
348
346
 
347
+ /// Register a callback which is invoked whenever rows are removed from
348
+ /// this [`View`]'s [`Table`] by [`Table::remove`], with an object
349
+ /// containing `port_id` and `indices`, the removed `index` column
350
+ /// values as an Arrow of one column named after the index.
351
+ ///
352
+ /// [`Table::replace`] reports the keys it does not re-supply and
353
+ /// [`Table::clear`] reports every key. `on_remove` never fires for a
354
+ /// [`Table`] without an `index`.
355
+ ///
356
+ /// # JavaScript Examples
357
+ ///
358
+ /// ```javascript
359
+ /// const id = await view.on_remove(({ indices, port_id }) => {
360
+ /// replica.remove(indices);
361
+ /// });
362
+ /// ```
363
+ #[wasm_bindgen]
364
+ pub fn on_remove(
365
+ &self,
366
+ #[wasm_bindgen(unchecked_param_type = "(data: OnRemoveData) => void")]
367
+ on_remove_js: Function,
368
+ ) -> ApiFuture<u32> {
369
+ let poll_loop = LocalPollLoop::new(move |args: OnRemoveData| {
370
+ let js_obj = JsValue::from_serde_ext(&*args)?;
371
+ on_remove_js.call1(&JsValue::UNDEFINED, &js_obj)
372
+ });
373
+
374
+ let on_remove = Box::new(move |msg| poll_loop.poll(msg));
375
+ let view = self.0.clone();
376
+ ApiFuture::new(async move { Ok(view.on_remove(on_remove).await?) })
377
+ }
378
+
379
+ /// Unregister a previously registered [`View::on_remove`] callback.
380
+ ///
381
+ /// # Arguments
382
+ ///
383
+ /// - `id` - A callback `id` as returned by a reciprocal call to
384
+ /// [`View::on_remove`].
385
+ #[wasm_bindgen]
386
+ pub async fn remove_remove(&self, callback_id: u32) -> ApiResult<()> {
387
+ Ok(self.0.remove_remove(callback_id).await?)
388
+ }
389
+
349
390
  /// Register a callback with this [`View`]. Whenever the [`View`] is
350
391
  /// deleted, this callback will be invoked.
351
392
  #[wasm_bindgen]
@@ -56,6 +56,16 @@ function bindPortSharedWorker(msg: MessageEvent) {
56
56
  port.start();
57
57
  }
58
58
 
59
+ /**
60
+ * Provided by `@perspective-dev/esbuild-plugin/worker`, which replaces this
61
+ * module with a stub when it is imported (rather than built as an entry
62
+ * point). Constructs a `Worker` from the bundled source, or falls back to
63
+ * running it on the main thread and returns a `MessagePort` to it.
64
+ */
65
+ export declare function initialize(
66
+ opts?: WorkerOptions,
67
+ ): Promise<Worker | MessagePort>;
68
+
59
69
  // @ts-expect-error wrong scope
60
70
  self.addEventListener("connect", bindPortSharedWorker);
61
71
  self.addEventListener(
@@ -235,10 +235,6 @@ async function compilerize(
235
235
  disable_stage_0: boolean = false,
236
236
  ) {
237
237
  const wasm_buff = disable_stage_0 ? wasm : await load_wasm_stage_0(wasm);
238
- // Compile to a `WebAssembly.Module` once so it can be both instantiated
239
- // locally and forwarded to other workers via `getCompiledClientWasm()`.
240
- // `WebAssembly.Module` is structured-cloneable across workers, so the
241
- // recipient can instantiate without re-fetching or re-compiling.
242
238
  const compiled = await compile_module(wasm_buff);
243
239
  GLOBAL_CLIENT_MODULE = Promise.resolve(compiled);
244
240
  await wasm_module.default({ module_or_path: compiled });
@@ -342,24 +338,10 @@ function get_server() {
342
338
  let GLOBAL_WORKER: undefined | (() => Promise<Worker>) = undefined;
343
339
 
344
340
  // `WorkerPlugin` resolves this import to a stub that exports
345
- // `getPerspectiveWorkerURL(): Promise<string>`. The URL is either a
346
- // Blob URL (inline mode — production builds) or a real file path
347
- // resolved against `import.meta.url` (file mode — debug builds).
348
- // Constructing the `Worker` lives here in the consumer rather than
349
- // inside the plugin so the same module text can also be loaded
350
- // in-process via dynamic `import(url)` when a future caller wants
351
- // it; the plugin no longer owns Worker lifecycle.
352
- //
353
- // `initialize()` constructs `new Worker(blobUrl)` and falls back to
354
- // running the worker source on the main thread via `new Function(...)`
355
- // when Worker construction is unavailable (e.g. `file://` origins where
356
- // module-Worker support is gated). The shim it returns is
357
- // MessagePort-shaped so downstream code can treat it like a real
358
- // Worker.
359
- // @ts-ignore — resolved at build time by `@perspective-dev/esbuild-plugin/worker`
341
+ // `getPerspectiveWorkerURL(): Promise<string>`.
360
342
  import { initialize as initializePerspectiveWorker } from "../../src/ts/perspective-server.worker.js";
361
343
 
362
- async function get_worker(): Promise<Worker> {
344
+ async function get_worker(): Promise<Worker | MessagePort> {
363
345
  if (GLOBAL_WORKER === undefined) {
364
346
  return await initializePerspectiveWorker({
365
347
  type: "module",
@@ -375,7 +357,7 @@ export async function websocket(url: string | URL) {
375
357
  }
376
358
 
377
359
  export async function worker(
378
- worker?: Promise<SharedWorker | ServiceWorker | Worker | MessagePort>,
360
+ worker?: Promise<SharedWorker | Worker | MessagePort>,
379
361
  ) {
380
362
  if (typeof worker === "undefined") {
381
363
  worker = get_worker();
@@ -0,0 +1,8 @@
1
+ // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
2
+ import type { ViewOnRemoveResp } from "./ViewOnRemoveResp.js";
3
+
4
+ /**
5
+ * Removed index values and port ID corresponding to a remove batch, provided
6
+ * to the callback argument to [`View::on_remove`].
7
+ */
8
+ export type OnRemoveData = ViewOnRemoveResp;
@@ -0,0 +1,3 @@
1
+ // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
2
+
3
+ export type ViewOnRemoveResp = { indices: Uint8Array, port_id: number, };
@@ -1,3 +1,3 @@
1
1
  // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
2
2
 
3
- export type ViewOnUpdateResp = { delta: Array<number>, port_id: number, };
3
+ export type ViewOnUpdateResp = { delta: Uint8Array | undefined, port_id: number, };