json-canvas-viewer 3.2.0 → 3.2.2

package/dist/types/baseModule.d.ts

@@ -1,12 +1,11 @@
 import type { Container } from '@needle-di/core';
-import type { DefaultOptions, Empty, GeneralFunction, GeneralObject, Utilities } from './declarations';
-export type BaseArgs = [Container, GeneralObject, Utilities];
+import type { DefaultOptions, Empty, GeneralFunction, GeneralObject } from './declarations';
+export type BaseArgs = [Container, GeneralObject];
 export type GeneralModuleCtor = typeof BaseModule<GeneralObject>;
 export type GeneralModule = InstanceType<GeneralModuleCtor>;
 export declare class BaseModule<O extends GeneralObject = Empty> {
     protected container: Container;
-    protected utilities: Utilities;
-    constructor(container: Container, options: GeneralObject, utilities: Utilities);
+    constructor(container: Container, options: GeneralObject);
     options: DefaultOptions & O;
     dispose?: GeneralFunction;
 }

package/dist/types/canvasViewer.d.ts

@@ -12,11 +12,14 @@ type InternalModules = [
     typeof InteractionHandler,
     typeof Renderer
 ];
-export declare class JSONCanvasViewer<M extends ModuleInput = []> {
+export default class JSONCanvasViewer<M extends ModuleInput = []> {
     private options;
     private allModules;
+    private IO;
     container: Container;
     constructor(options: Options<[...InternalModules, ...M]>, modules?: M);
+    private load;
+    private onVisibilityCheck;
     dispose: () => void;
 }
 export {};

package/dist/types/controller.d.ts

@@ -6,6 +6,7 @@ export default class Controller extends BaseModule<Options> {
     private animationId;
     private resizeAnimationId;
     private DM;
+    private resizeObserver;
     private perFrame;
     private lastResizeCenter;
     hooks: {
@@ -27,7 +28,6 @@ export default class Controller extends BaseModule<Options> {
     private draw;
     private refresh;
     private onResize;
-    private resizeObserver;
     dispose: () => void;
 }
 export {};

package/dist/types/controls/index.d.ts

@@ -20,7 +20,7 @@ export default class Controls extends BaseModule<Options> {
     private get zoomInBtn();
     private get resetViewBtn();
     constructor(...args: BaseArgs);
-    toggleCollapse: () => boolean;
+    toggleCollapse: () => void;
     private zoomIn;
     private zoomOut;
     private slide;

package/dist/types/dataManager.d.ts

@@ -1,5 +1,5 @@
-import type { Coordinates, NodeBounds } from './declarations';
 import { BaseModule } from './baseModule';
+import type { Coordinates, NodeBounds } from './declarations';
 export default class DataManager extends BaseModule {
     private spatialGrid;
     hooks: {
@@ -17,7 +17,7 @@ export default class DataManager extends BaseModule {
         };
     };
     data: {
-        canvasData: JSONCanvas;
+        canvasData: Required<JSONCanvas>;
         nodeMap: Record<string, JSONCanvasNode>;
         canvasBaseDir: string;
         nodeBounds: NodeBounds;
@@ -27,7 +27,6 @@ export default class DataManager extends BaseModule {
         container: HTMLDivElement;
     };
     loadCanvas: () => Promise<void>;
-    private resolvePath;
     findNodeAt: (screenCoords: Coordinates) => JSONCanvasNode | null;
     private judgeInteract;
     private calculateNodeBounds;

package/dist/types/declarations.d.ts

@@ -1,23 +1,40 @@
-import type { GeneralModuleCtor } from './baseModule';
-import type utilities from './utilities';
+import type { BaseModule, GeneralModule, GeneralModuleCtor } from './baseModule';
+import type Controller from './controller';
+import type DataManager from './dataManager';
+import type InteractionHandler from './interactionHandler';
+import type OverlayManager from './overlayManager';
+import type Renderer from './renderer';
 declare global {
-    interface JSONCanvasNode {
+    interface JSONCanvasGenericNode {
         id: string;
         type: 'group' | 'file' | 'text' | 'link';
         x: number;
         y: number;
         width: number;
         height: number;
+        styleAttributes?: Record<string, string>;
+        color?: string;
+    }
+    interface JSONCanvasGroupNode extends JSONCanvasGenericNode {
+        type: 'group';
         label?: string;
         background?: string;
         backgroundStyle?: 'cover' | 'ratio' | 'repeat';
-        styleAttributes?: Record<string, string>;
-        color?: string;
-        text?: string;
-        file?: string;
+    }
+    interface JSONCanvasFileNode extends JSONCanvasGenericNode {
+        type: 'file';
+        file: string;
         subpath?: string;
-        url?: string;
     }
+    interface JSONCanvasTextNode extends JSONCanvasGenericNode {
+        type: 'text';
+        text: string;
+    }
+    interface JSONCanvasLinkNode extends JSONCanvasGenericNode {
+        type: 'link';
+        url: string;
+    }
+    type JSONCanvasNode = JSONCanvasGroupNode | JSONCanvasFileNode | JSONCanvasTextNode | JSONCanvasLinkNode;
     interface JSONCanvasEdge {
         id: string;
         fromNode: string;
@@ -30,12 +47,12 @@ declare global {
         color?: string;
     }
     interface JSONCanvas {
-        nodes: Array<JSONCanvasNode>;
-        edges: Array<JSONCanvasEdge>;
-        metadata: {
-            version: string;
-            frontmatter: Record<string, string>;
-        };
+        nodes?: Array<JSONCanvasNode>;
+        edges?: Array<JSONCanvasEdge>;
+    }
+    module '*.scss?inline' {
+        const content: string;
+        export default content;
     }
 }
 export type Coordinates = {
@@ -72,8 +89,12 @@ type AllModuleInstances<T extends ModuleInput> = InstanceType<T[number]>;
 export type DefaultOptions = {
     container: HTMLElement;
     canvasPath: string;
+    lazyLoad?: boolean;
 };
-export type Utilities = typeof utilities;
 export type ModuleInput = Array<GeneralModuleCtor>;
-export type Options<T extends ModuleInput> = Omit<UnionToIntersection<AllModuleInstances<T>['options']>, keyof DefaultOptions> & DefaultOptions;
+export type Options<T extends ModuleInput = []> = Omit<UnionToIntersection<AllModuleInstances<T>['options']>, keyof DefaultOptions> & DefaultOptions;
+type Ctors<T extends Array<BaseModule> | BaseModule> = T extends Array<BaseModule> ? {
+    [K in keyof T]: new (...args: GeneralArguments) => T[K];
+} : [new (...args: GeneralArguments) => T];
+export type UserOptions<T extends Array<GeneralModule> = []> = Options<Ctors<[Controller, InteractionHandler, DataManager, OverlayManager, Renderer, ...T]>>;
 export {};

package/dist/types/index.d.ts

@@ -1,9 +1,12 @@
 export { type BaseArgs, BaseModule } from './baseModule';
-export { JSONCanvasViewer } from './canvasViewer';
+export { default as JSONCanvasViewer } from './canvasViewer';
 export { default as Controls } from './controls';
 export { default as DebugPanel } from './debugPanel';
+export type { UserOptions as Options } from './declarations';
 export { default as Minimap } from './minimap';
 export { default as MistouchPreventer } from './mistouchPreventer';
+export { default as renderToString } from './renderToString';
+export { default as canvasUtils } from './utilities';
 import Controller from './controller';
 import DataManager from './dataManager';
 import InteractionHandler from './interactionHandler';

package/dist/types/interactionHandler.d.ts

@@ -1,16 +1,11 @@
-import { Pointeract } from 'pointeract';
+import { Click, type Ctors, Drag, MultitouchPanZoom, Pointeract, type Options as PointeractOptions, PreventDefault, WheelPanZoom } from 'pointeract';
 import { type BaseArgs, BaseModule } from './baseModule';
 type Options = {
-    interactions?: {
-        proControlSchema?: boolean;
-        zoomFactor?: number;
-        lockControlSchema?: boolean;
-    };
+    pointeract?: PointeractOptions<Ctors<[Click, Drag, WheelPanZoom, PreventDefault, MultitouchPanZoom]>>;
 };
 export default class InteractionHandler extends BaseModule<Options> {
     private pointeract;
     private DM;
-    private OM;
     onClick: {
         (args_0: string | null): void;
         subs: Set<(args_0: string | null) => unknown>;

package/dist/types/overlayManager.d.ts

@@ -1,12 +1,16 @@
+import { micromark } from 'micromark';
 import { type BaseArgs, BaseModule } from './baseModule';
-export default class OverlayManager extends BaseModule {
+type Options = {
+    micromark?: Parameters<typeof micromark>[1];
+};
+export default class OverlayManager extends BaseModule<Options> {
     private _overlaysLayer;
     private overlays;
     private selectedId;
     private eventListeners;
     private DM;
     private IH;
-    private parser;
+    private parse;
     private get overlaysLayer();
     hooks: {
         onInteractionStart: {
@@ -27,7 +31,8 @@ export default class OverlayManager extends BaseModule {
     private select;
     private loadMarkdownForNode;
     private updateOverlays;
-    private updateOrCreateOverlay;
+    private updateOverlay;
     private constructOverlay;
     dispose: () => void;
 }
+export {};

package/dist/types/renderToString.d.ts

@@ -0,0 +1,2 @@
+import { micromark } from 'micromark';
+export default function (path: string, micromarkOptions?: Parameters<typeof micromark>[1]): Promise<string>;

package/dist/types/utilities.d.ts

@@ -1,3 +1,4 @@
+import type { GeneralArguments } from './declarations';
 declare const _default: {
     round: typeof round;
     resizeCanvasForDPR: typeof resizeCanvasForDPR;
@@ -5,8 +6,11 @@ declare const _default: {
     drawRoundRect: typeof drawRoundRect;
     getAnchorCoord: typeof getAnchorCoord;
     getColor: typeof getColor;
+    resolvePath: typeof resolvePath;
+    makeHook: typeof makeHook;
 };
 export default _default;
+export declare const destroyError: Error;
 declare function applyStyles(container: HTMLElement | ShadowRoot, styleString: string): void;
 declare function drawRoundRect(ctx: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, radius: number): void;
 declare function getAnchorCoord(node: JSONCanvasNode, side: 'top' | 'bottom' | 'left' | 'right'): number[];
@@ -17,3 +21,10 @@ declare function getColor(colorIndex?: string): {
 };
 declare function resizeCanvasForDPR(canvas: HTMLCanvasElement, width: number, height: number): void;
 declare function round(roundedNum: number, digits: number): number;
+declare function resolvePath(path: string): string;
+declare function makeHook<Args extends GeneralArguments = []>(): {
+    (...args: Args): void;
+    subs: Set<(...args: Args) => unknown>;
+    subscribe(callback: (...args: Args) => unknown): void;
+    unsubscribe(callback: (...args: Args) => unknown): void;
+};

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "json-canvas-viewer",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "An extensible TypeScript-based viewer for JSON Canvas, easy to embed into websites.",
   "type": "module",
-  "types": "dist/types/src/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "repository": {
@@ -25,6 +25,7 @@
     "name": "Hēsperus",
     "email": "hesprs@outlook.com"
   },
+  "sideEffects": false,
   "publishConfig": {
     "provenance": true,
     "access": "public"
@@ -33,6 +34,7 @@
   "devDependencies": {
     "@biomejs/biome": "^2.3.10",
     "@types/node": "^25.0.3",
+    "micromark-extension-gfm": "^3.0.0",
     "sass": "^1.97.1",
     "tsc-alias": "^1.8.16",
     "typescript": "^5.9.3",
@@ -43,9 +45,7 @@
   ],
   "dependencies": {
     "@needle-di/core": "^1.1.0",
-    "dompurify": "^3.3.1",
     "micromark": "^4.0.2",
-    "micromark-extension-gfm": "^3.0.0",
     "pointeract": "^1.0.1"
   },
   "scripts": {

package/dist/types/shared.d.ts

@@ -1,13 +0,0 @@
-import type { GeneralArguments } from './declarations';
-export declare const unexpectedError: Error;
-export declare const destroyError: Error;
-export interface RuntimeJSONCanvasNode extends JSONCanvasNode {
-    mdContent?: string;
-    mdFrontmatter?: Record<string, string>;
-}
-export declare function makeHook<Args extends GeneralArguments = []>(): {
-    (...args: Args): void;
-    subs: Set<(...args: Args) => unknown>;
-    subscribe(callback: (...args: Args) => unknown): void;
-    unsubscribe(callback: (...args: Args) => unknown): void;
-};