types(Graph, Cell, Element, Link): add JSON and BaseJSON types

clientIO · Jan 10, 2025 · 3ab568a · 3ab568a
1 parent 12b0c32
commit 3ab568a
Showing 1 changed file with 34 additions and 8 deletions.
diff --git a/packages/joint-core/types/joint.d.ts b/packages/joint-core/types/joint.d.ts
@@ -174,6 +174,16 @@ export namespace dia {
             strict?: boolean;
         }
 
+        type BaseJSON = {
+            cells: Array<Element.BaseJSON | Link.BaseJSON>;
+            [key: string]: any;
+        }
+
+        type JSON = {
+            cells: Array<Element.JSON | Link.JSON>;
+            [key: string]: any;
+        }
+
         type SearchByKey = 'bbox' | PositionName;
 
         interface FindUnderElementOptions extends FindInAreaOptions, FindAtPointOptions {
@@ -256,9 +266,9 @@ export namespace dia {
 
         getCommonAncestor(...cells: Cell[]): Element | undefined;
 
-        toJSON(opt?: { cellAttributes?: dia.Cell.ExportOptions }): any;
+        toJSON(opt?: { cellAttributes?: dia.Cell.ExportOptions }): Graph.JSON;
 
-        fromJSON(json: any, opt?: S): this;
+        fromJSON(json: Graph.BaseJSON, opt?: S): this;
 
         clear(opt?: { [key: string]: any }): this;
 
@@ -343,13 +353,16 @@ export namespace dia {
         interface Attributes extends GenericAttributes<Selectors> {
         }
 
-        type JSON<K extends Selectors = Selectors, T extends GenericAttributes<K> = GenericAttributes<K>> = T & {
+        type BaseJSON<K extends Selectors = Selectors, T extends GenericAttributes<K> = GenericAttributes<K>> = T & {
             [attribute in keyof T]: T[attribute];
         } & {
-            id: ID;
             type: string;
         };
 
+        type JSON<K extends Selectors = Selectors, T extends GenericAttributes<K> = GenericAttributes<K>> = BaseJSON<K, T> & {
+            id: ID;
+        };
+
         interface Constructor<T extends mvc.Model> {
             new(opt?: { id?: ID, [key: string]: any }): T;
             define(type: string, defaults?: any, protoProps?: any, staticProps?: any): dia.Cell.Constructor<T>;
@@ -560,6 +573,10 @@ export namespace dia {
         interface Attributes extends GenericAttributes<Cell.Selectors> {
         }
 
+        type BaseJSON<K extends Cell.Selectors = Cell.Selectors, T extends GenericAttributes<K> = GenericAttributes<K>> = Cell.BaseJSON<K, T>;
+
+        type JSON<K extends Cell.Selectors = Cell.Selectors, T extends GenericAttributes<K> = GenericAttributes<K>> = Cell.JSON<K, T>;
+
         type PortPositionCallback = (ports: Port[], bbox: g.Rect) => dia.Point[];
 
         interface PortPositionJSON {
@@ -692,12 +709,17 @@ export namespace dia {
             priority?: boolean;
         }
 
-        interface EndJSON extends EndCellArgs {
-            id?: Cell.ID;
-            x?: number;
-            y?: number;
+        interface EndCellJSON extends EndCellArgs {
+            id: Cell.ID;
+        }
+
+        interface EndPointJSON extends EndCellArgs {
+            x: number;
+            y: number;
         }
 
+        type EndJSON = EndCellJSON | EndPointJSON;
+
         interface GenericAttributes<T> extends Cell.GenericAttributes<T> {
             source?: EndJSON;
             target?: EndJSON;
@@ -721,6 +743,10 @@ export namespace dia {
         interface Attributes extends Cell.GenericAttributes<LinkSelectors> {
         }
 
+        type BaseJSON<K extends LinkSelectors = LinkSelectors, T extends GenericAttributes<K> = GenericAttributes<K>> = Cell.BaseJSON<K, T>;
+
+        type JSON<K extends LinkSelectors = LinkSelectors, T extends GenericAttributes<K> = GenericAttributes<K>> = Cell.JSON<K, T>;
+
         interface LabelPosition {
             distance?: number; // optional for default labels
             offset?: number | { x: number, y: number };