obsidian - npm Package Compare versions

Comparing version 1.2.3 to 1.2.5

canvas.d.ts

@@ -1,15 +0,21 @@
-// A color used to encode color data for nodes and edges
-// can be a number (like "1") representing one of the (currently 6) supported colors.
-// or can be a custom color using the hex format "#FFFFFFF".
+
+/**
+ * A color used to encode color data for nodes and edges
+ * can be a number (like "1") representing one of the (currently 6) supported colors.
+ * or can be a custom color using the hex format "#FFFFFFF".
+ */
 export type CanvasColor = string;
 
-// The overall canvas file's JSON
+/** The overall canvas file's JSON */
 export interface CanvasData {
     nodes: AllCanvasNodeData[];
     edges: CanvasEdgeData[];
+
+    /** Support arbitrary keys for forward compatibility */
+    [key: string]: any;
 }
 
-// A node
+/** A node */
 export interface CanvasNodeData {
-    // The unique ID for this node
+    /** The unique ID for this node */
     id: string;
@@ -21,4 +27,7 @@ // The positional data
     height: number;
-    // The color of this node
+    /** The color of this node */
     color?: CanvasColor;
+
+    // Support arbitrary keys for forward compatibility
+    [key: string]: any;
 }
@@ -28,11 +37,11 @@
 
-// A node that is a file, where the file is located somewhere in the vault.
+/** A node that is a file, where the file is located somewhere in the vault. */
 export interface CanvasFileData extends CanvasNodeData {
     type: 'file';
     file: string;
-    // An optional subpath which links to a heading or a block. Always starts with a `#`.
+    /** An optional subpath which links to a heading or a block. Always starts with a `#`. */
     subpath?: string;
 }
 
-// A node that is plaintext.
+/** A node that is plaintext. */
 export interface CanvasTextData extends CanvasNodeData {
@@ -43,3 +52,3 @@ type: 'text';
 
-// A node that is an external resource.
+/** A node that is an external resource. */
 export interface CanvasLinkData extends CanvasNodeData {
@@ -50,40 +59,43 @@ type: 'link';
 
-// The background image rendering style
+/** The background image rendering style */
 export type BackgroundStyle = 'cover' | 'ratio' | 'repeat';
 
-// A node that represents a group.
+/** A node that represents a group. */
 export interface CanvasGroupData extends CanvasNodeData {
     type: 'group';
-    // Optional label to display on top of the group.
+    /** Optional label to display on top of the group. */
     label?: string;
-    // Optional background image, stores the path to the image file in the vault.
+    /** Optional background image, stores the path to the image file in the vault. */
     background?: string;
-    // Optional background image rendering style; defaults to 'cover'.
+    /** Optional background image rendering style; defaults to 'cover'. */
     backgroundStyle?: BackgroundStyle;
 }
 
-// The side of the node that a connection is connected to
+/** The side of the node that a connection is connected to */
 export type NodeSide = 'top' | 'right' | 'bottom' | 'left';
 
-// What to display at the end of an edge
+/** What to display at the end of an edge */
 export type EdgeEnd = 'none' | 'arrow';
 
-// An edge
+/** An edge */
 export interface CanvasEdgeData {
-    // The unique ID for this edge
+    /** The unique ID for this edge */
     id: string;
-    // The node ID and side where this edge starts
+    /** The node ID and side where this edge starts */
     fromNode: string;
     fromSide: NodeSide;
-    // The starting edge end; defaults to 'none'
+    /** The starting edge end; defaults to 'none' */
     fromEnd?: EdgeEnd;
-    // The node ID and side where this edge ends
+    /** The node ID and side where this edge ends */
     toNode: string;
     toSide: NodeSide;
-    // The ending edge end; defaults to 'arrow'
+    /** The ending edge end; defaults to 'arrow' */
     toEnd?: EdgeEnd;
-    // The color of this edge
+    /** The color of this edge */
     color?: CanvasColor;
-    // The text label of this edge, if available
+    /** The text label of this edge, if available */
     label?: string;
-}
+
+    // Support arbitrary keys for forward compatibility
+    [key: string]: any;
+}

package.json

 {
     "name": "obsidian",
-    "version": "1.2.3",
+    "version": "1.2.5",
     "description": "Type definitions for the latest Obsidian API (https://obsidian.md)",
@@ -5,0 +5,0 @@ "keywords": ["obsdmd"],

No alert changes

Improved metrics

Total package byte prevSize

141560

0.7%

Lines of code

4663

0.63%

No dependency changes