chore: refine IClassicCom types (jupyter-widgets#3722)

* chore: refine comm types
Alacamaic-technologies · Mar 21, 2023 · c1829d3 · c1829d3
1 parent 785d159
commit c1829d3
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 28 deletions.
diff --git a/packages/base/src/services-shim.ts b/packages/base/src/services-shim.ts
@@ -8,6 +8,7 @@
  */
 
 import { Kernel, KernelMessage } from '@jupyterlab/services';
+import type { JSONValue, JSONObject } from '@lumino/coreutils';
 
 /**
  * Callbacks for services shim comms.
@@ -40,9 +41,9 @@ export interface IClassicComm {
    * @return msg id
    */
   open(
-    data: any,
-    callbacks: any,
-    metadata?: any,
+    data: JSONValue,
+    callbacks?: ICallbacks,
+    metadata?: JSONObject,
     buffers?: ArrayBuffer[] | ArrayBufferView[]
   ): string;
 
@@ -55,9 +56,9 @@ export interface IClassicComm {
    * @return message id
    */
   send(
-    data: any,
-    callbacks: any,
-    metadata?: any,
+    data: JSONValue,
+    callbacks?: ICallbacks,
+    metadata?: JSONObject,
     buffers?: ArrayBuffer[] | ArrayBufferView[]
   ): string;
 
@@ -70,9 +71,9 @@ export interface IClassicComm {
    * @return msg id
    */
   close(
-    data?: any,
-    callbacks?: any,
-    metadata?: any,
+    data?: JSONValue,
+    callbacks?: ICallbacks,
+    metadata?: JSONObject,
     buffers?: ArrayBuffer[] | ArrayBufferView[]
   ): string;
 
@@ -218,9 +219,9 @@ export namespace shims {
        * @return msg id
        */
       open(
-        data: any,
-        callbacks: any,
-        metadata?: any,
+        data: JSONValue,
+        callbacks?: ICallbacks,
+        metadata?: JSONObject,
         buffers?: ArrayBuffer[] | ArrayBufferView[]
       ): string {
         const future = this.jsServicesComm.open(data, metadata, buffers);
@@ -237,9 +238,9 @@ export namespace shims {
        * @return message id
        */
       send(
-        data: any,
-        callbacks: any,
-        metadata?: any,
+        data: JSONValue,
+        callbacks?: ICallbacks,
+        metadata?: JSONObject,
         buffers?: ArrayBuffer[] | ArrayBufferView[]
       ): string {
         const future = this.jsServicesComm.send(data, metadata, buffers);
@@ -255,9 +256,9 @@ export namespace shims {
        * @return msg id
        */
       close(
-        data?: any,
-        callbacks?: any,
-        metadata?: any,
+        data?: JSONValue,
+        callbacks?: ICallbacks,
+        metadata?: JSONObject,
         buffers?: ArrayBuffer[] | ArrayBufferView[]
       ): string {
         const future = this.jsServicesComm.close(data, metadata, buffers);
@@ -288,7 +289,7 @@ export namespace shims {
        */
       _hookupCallbacks(
         future: Kernel.IShellFuture,
-        callbacks: ICallbacks
+        callbacks?: ICallbacks
       ): void {
         if (callbacks) {
           future.onReply = function (msg): void {

diff --git a/packages/base/src/widget.ts b/packages/base/src/widget.ts
@@ -9,7 +9,7 @@ import $ from 'jquery';
 
 import { NativeView } from './nativeview';
 
-import { JSONObject } from '@lumino/coreutils';
+import { JSONObject, JSONValue } from '@lumino/coreutils';
 
 import { Message, MessageLoop } from '@lumino/messaging';
 
@@ -164,8 +164,8 @@ export class WidgetModel extends Backbone.Model {
    * Send a custom msg over the comm.
    */
   send(
-    content: {},
-    callbacks: {},
+    content: JSONValue,
+    callbacks?: ICallbacks,
     buffers?: ArrayBuffer[] | ArrayBufferView[]
   ): void {
     if (this.comm !== undefined) {

diff --git a/packages/controls/test/src/utils.ts b/packages/controls/test/src/utils.ts
@@ -5,6 +5,8 @@ import * as widgets from '@jupyter-widgets/base';
 import * as services from '@jupyterlab/services';
 import { DummyManager } from './dummy-manager';
 
+import type { JSONValue, JSONObject } from '@lumino/coreutils';
+
 let numComms = 0;
 
 export class MockComm implements widgets.IClassicComm {
@@ -30,8 +32,9 @@ export class MockComm implements widgets.IClassicComm {
   }
 
   open(
-    data?: any,
-    metadata?: any,
+    data: JSONValue,
+    callbacks?: widgets.ICallbacks,
+    metadata?: JSONObject,
     buffers?: ArrayBuffer[] | ArrayBufferView[]
   ): string {
     if (this._on_open) {
@@ -41,8 +44,9 @@ export class MockComm implements widgets.IClassicComm {
   }
 
   close(
-    data?: any,
-    metadata?: any,
+    data?: JSONValue,
+    callbacks?: widgets.ICallbacks,
+    metadata?: JSONObject,
     buffers?: ArrayBuffer[] | ArrayBufferView[]
   ): string {
     if (this._on_close) {
@@ -52,8 +56,9 @@ export class MockComm implements widgets.IClassicComm {
   }
 
   send(
-    data?: any,
-    metadata?: any,
+    data: JSONValue,
+    callbacks?: widgets.ICallbacks,
+    metadata?: JSONObject,
     buffers?: ArrayBuffer[] | ArrayBufferView[]
   ): string {
     return '';