Release 1.0.1

xmindltd · Sep 5, 2020 · 4510daf · 4510daf
1 parent 17f6296
commit 4510daf
Show file tree

Hide file tree

Showing 93 changed files with 398 additions and 399 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,16 @@ XMind Viewer is an official project, made by XMind team, and written in TypeScri
 
 ## Usage and Getting Started
 
+### Usage in Node.js
+
+```shell
+$ npm i --save xmind-viewer
+```
+
+```js
+const { loadFromXMind, SnowbrushRenderer } = require('xmind-viewer')
+```
+
 ### Simple Usage
 
 ```ts

diff --git a/example/index.html b/example/index.html
@@ -38,7 +38,7 @@
   </header>
   <div id="page-content"></div>
 
-  <script src="./index.ts"></script>
+  <script src="./index.js"></script>
 </body>
 
 </html>
diff --git a/example/index.ts → example/index.js b/example/index.ts → example/index.js
@@ -1,12 +1,11 @@
 import contentData from './content.json'
 import JSZip from 'jszip'
-import { SheetData } from 'model/sheet'
 import { loadFromXMind, SnowbrushRenderer } from '../src/index'
 
 load(contentData)
 
 document.getElementById('input-dialog').addEventListener('input', function() {
-  const inputEle = this as HTMLInputElement
+  const inputEle = this
   if (inputEle.files.length === 0) { 
     return 
   }
@@ -19,7 +18,7 @@ document.getElementById('input-dialog').addEventListener('input', function() {
     return Promise.all([
       Promise.resolve(fileName),
       jszip.loadAsync(e.target.result).then(zip => {
-        loadFromXMind(zip).then((result: any) => {
+        loadFromXMind(zip).then(result => {
           load(result.sheets)
         })
       })
@@ -34,7 +33,7 @@ document.getElementById('open-file').addEventListener('click', function(){
   input.click()
 })
 
-function load(data: SheetData[]) {
+function load(data) {
   const container = document.getElementById('page-content')
   if (container.children.length > 0) {
     container.innerHTML = ''

diff --git a/package.json b/package.json
@@ -1,10 +1,11 @@
 {
   "name": "xmind-viewer",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rm -rf ./dist && node_modules/.bin/tsc"
   },
   "author": {
     "name": "XMind Ltd.",
@@ -20,12 +21,7 @@
     "@types/jszip": "^3.1.6",
     "jszip": "^3.2.2"
   },
-  "alias": {
-    "common": "./src/common",
-    "model": "./src/model",
-    "utils": "./src/utils",
-    "view": "./src/view",
-    "viewController": "./src/viewController",
-    "structure": "./src/structure"
-  }
+  "files": [
+    "dist"
+  ]
 }
diff --git a/src/model/model.ts b/src/model/model.ts
@@ -1,5 +1,5 @@
 import Sheet from './sheet'
-import { StyleKey } from 'common/constants/styles'
+import { StyleKey } from '../common/constants/styles'
 
 export interface ModelData {
   id: string

diff --git a/src/model/sheet.ts b/src/model/sheet.ts
@@ -1,7 +1,7 @@
 import Topic, { TopicData, parseTopic } from './topic'
 import Model, { ModelData } from './model'
 import Theme, { ThemeData } from './theme'
-import { StyleKey } from 'common/constants/styles'
+import { StyleKey } from '../common/constants/styles'
 import { StyleData } from './style'
 
 export interface SheetData extends ModelData {

diff --git a/src/model/style.ts b/src/model/style.ts
@@ -1,5 +1,5 @@
 import Model, { ModelData } from './model'
-import { StyleKey } from 'common/constants/styles'
+import { StyleKey } from '../common/constants/styles'
 
 export interface StyleData extends ModelData {
   properties: any

diff --git a/src/model/theme.ts b/src/model/theme.ts
@@ -1,6 +1,6 @@
 import Model, { ModelData } from './model'
 import Style, { StyleData } from './style'
-import { ClassType } from 'common/constants/styles'
+import { ClassType } from '../common/constants/styles'
 
 export interface ThemeData extends ModelData {
 

diff --git a/src/model/topic.ts b/src/model/topic.ts
@@ -1,8 +1,8 @@
 import Model, { ModelData }  from './model'
-import { TopicType } from 'common/constants/models'
-import { ExtensionProvider, ExtensionContentName } from 'common/constants/extensions'
+import { TopicType } from '../common/constants/models'
+import { ExtensionProvider, ExtensionContentName } from '../common/constants/extensions'
 import { StyleData } from './style'
-import { StyleKey } from 'common/constants/styles'
+import { StyleKey } from '../common/constants/styles'
 import Sheet from './sheet'
 
 export interface TopicData extends ModelData {

diff --git a/src/snowbrushRenderer.ts b/src/snowbrushRenderer.ts
@@ -1,7 +1,7 @@
-import { SheetData } from 'model/sheet'
-import SheetViewController from 'viewController/sheetViewController'
+import { SheetData } from './model/sheet'
+import SheetViewController from './viewController/sheetViewController'
 import { Svg } from '@svgdotjs/svg.js'
-import { Workbook } from 'model/workbook'
+import { Workbook } from './model/workbook'
 
 export interface RenderOptions {
   sheetIndex?: number

diff --git a/src/structure/abstractStructure.ts b/src/structure/abstractStructure.ts
@@ -1,10 +1,10 @@
-import BranchViewController from 'viewController/branchViewController'
-import Bounds, { mergeArray, move } from 'utils/bounds'
-import StructureClass, { EXPOSED_ATTACHED_STRUCTURES } from 'common/constants/structures'
-import { TopicType } from 'common/constants/models'
-import { ConnectionInfo, getConnectionInfo } from 'view/lineRender/topicLineStyle'
-import { BranchConnection } from 'common/constants/styles'
-import { isOrgChartStructure } from 'structure/helper/structureUtils'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds, { mergeArray, move } from '../utils/bounds'
+import StructureClass, { EXPOSED_ATTACHED_STRUCTURES } from '../common/constants/structures'
+import { TopicType } from '../common/constants/models'
+import { ConnectionInfo, getConnectionInfo } from '../view/lineRender/topicLineStyle'
+import { BranchConnection } from '../common/constants/styles'
+import { isOrgChartStructure } from './helper/structureUtils'
 
 export default abstract class AbstractStructure {
 

diff --git a/src/structure/baseMap.ts b/src/structure/baseMap.ts
@@ -1,11 +1,11 @@
-import AbstractStructure from 'structure/abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import { TopicType, Direction } from 'common/constants/models'
-import { EXPOSED_ATTACHED_RIGHT_STRUCTURES, EXPOSED_ATTACHED_LEFT_STRUCTURES } from 'common/constants/structures'
-import Bounds from 'utils/bounds'
+import AbstractStructure from './abstractStructure'
+import BranchViewController from '../viewController/branchViewController'
+import { TopicType, Direction } from '../common/constants/models'
+import { EXPOSED_ATTACHED_RIGHT_STRUCTURES, EXPOSED_ATTACHED_LEFT_STRUCTURES } from '../common/constants/structures'
+import Bounds from '../utils/bounds'
 import { mergeBounds } from './helper/structureUtils'
-import { getBranchIndex, getParentBranch } from 'utils/branchUtils'
-import { PADDING } from 'common/constants/layoutSettings'
+import { getBranchIndex, getParentBranch } from '../utils/branchUtils'
+import { PADDING } from '../common/constants/layoutSettings'
 
 const MIN_TOP_BOTTOM_SPACING = 80
 const MAX_TOP_BOTTOM_SPACING = 180

diff --git a/src/structure/fishboneLeftHeaded.ts b/src/structure/fishboneLeftHeaded.ts
@@ -1,12 +1,12 @@
 import AbstractStructure from './abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds from 'utils/bounds'
-import StructureClass from 'common/constants/structures'
-import { TopicType, Direction } from 'common/constants/models'
-import { PADDING, ROTATED_COS, ROTATED_SIN } from 'common/constants/layoutSettings'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds from '../utils/bounds'
+import StructureClass from '../common/constants/structures'
+import { TopicType, Direction } from '../common/constants/models'
+import { PADDING, ROTATED_COS, ROTATED_SIN } from '../common/constants/layoutSettings'
 import { getUpSideBranches, isUpSideBranch } from './helper/structureUtils'
-import { BranchConnection } from 'common/constants/styles'
-import { getConnectionInfo } from 'view/lineRender/topicLineStyle'
+import { BranchConnection } from '../common/constants/styles'
+import { getConnectionInfo } from '../view/lineRender/topicLineStyle'
 
 export default class FishboneLeftHeaded extends AbstractStructure {
 

diff --git a/src/structure/fishboneNENormal.ts b/src/structure/fishboneNENormal.ts
@@ -1,11 +1,11 @@
 import AbstractStructure from './abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds, { merge } from 'utils/bounds'
-import StructureClass from 'common/constants/structures'
-import { TopicType } from 'common/constants/models'
-import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from 'common/constants/layoutSettings'
-import { BranchConnection } from 'common/constants/styles'
-import { getConnectionInfo } from 'view/lineRender/topicLineStyle'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds, { merge } from '../utils/bounds'
+import StructureClass from '../common/constants/structures'
+import { TopicType } from '../common/constants/models'
+import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from '../common/constants/layoutSettings'
+import { BranchConnection } from '../common/constants/styles'
+import { getConnectionInfo } from '../view/lineRender/topicLineStyle'
 
 export default class FishboneNENormal extends AbstractStructure {
 

diff --git a/src/structure/fishboneNWNormal.ts b/src/structure/fishboneNWNormal.ts
@@ -1,11 +1,11 @@
 import AbstractStructure from './abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds, { merge } from 'utils/bounds'
-import { TopicType } from 'common/constants/models'
-import StructureClass from 'common/constants/structures'
-import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from 'common/constants/layoutSettings'
-import { getConnectionInfo } from 'view/lineRender/topicLineStyle'
-import { BranchConnection } from 'common/constants/styles'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds, { merge } from '../utils/bounds'
+import { TopicType } from '../common/constants/models'
+import StructureClass from '../common/constants/structures'
+import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from '../common/constants/layoutSettings'
+import { getConnectionInfo } from '../view/lineRender/topicLineStyle'
+import { BranchConnection } from '../common/constants/styles'
 
 export default class FishboneNWNormal extends AbstractStructure {
 

diff --git a/src/structure/fishboneRightHeaded.ts b/src/structure/fishboneRightHeaded.ts
@@ -1,12 +1,12 @@
 import AbstractStructure from './abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds from 'utils/bounds'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds from '../utils/bounds'
 import { isUpSideBranch, getUpSideBranches } from './helper/structureUtils'
-import StructureClass from 'common/constants/structures'
-import { TopicType, Direction } from 'common/constants/models'
-import { PADDING, ROTATED_COS, ROTATED_SIN } from 'common/constants/layoutSettings'
-import { getConnectionInfo } from 'view/lineRender/topicLineStyle'
-import { BranchConnection } from 'common/constants/styles'
+import StructureClass from '../common/constants/structures'
+import { TopicType, Direction } from '../common/constants/models'
+import { PADDING, ROTATED_COS, ROTATED_SIN } from '../common/constants/layoutSettings'
+import { getConnectionInfo } from '../view/lineRender/topicLineStyle'
+import { BranchConnection } from '../common/constants/styles'
 
 export default class FishboneRightHeaded extends AbstractStructure {
 

diff --git a/src/structure/fishboneSENormal.ts b/src/structure/fishboneSENormal.ts
@@ -1,11 +1,11 @@
 import AbstractStructure from './abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds, { merge } from 'utils/bounds'
-import StructureClass from 'common/constants/structures'
-import { TopicType } from 'common/constants/models'
-import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from 'common/constants/layoutSettings'
-import { getConnectionInfo } from 'view/lineRender/topicLineStyle'
-import { BranchConnection } from 'common/constants/styles'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds, { merge } from '../utils/bounds'
+import StructureClass from '../common/constants/structures'
+import { TopicType } from '../common/constants/models'
+import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from '../common/constants/layoutSettings'
+import { getConnectionInfo } from '../view/lineRender/topicLineStyle'
+import { BranchConnection } from '../common/constants/styles'
 
 export default class FishboneSENormal extends AbstractStructure {
 

diff --git a/src/structure/fishboneSWNormal.ts b/src/structure/fishboneSWNormal.ts
@@ -1,11 +1,11 @@
 import AbstractStructure from './abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds, { merge } from 'utils/bounds'
-import { TopicType } from 'common/constants/models'
-import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from 'common/constants/layoutSettings'
-import StructureClass from 'common/constants/structures'
-import { getConnectionInfo } from 'view/lineRender/topicLineStyle'
-import { BranchConnection } from 'common/constants/styles'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds, { merge } from '../utils/bounds'
+import { TopicType } from '../common/constants/models'
+import { COLLAPSE_GAP, PADDING, ROTATED_TAN } from '../common/constants/layoutSettings'
+import StructureClass from '../common/constants/structures'
+import { getConnectionInfo } from '../view/lineRender/topicLineStyle'
+import { BranchConnection } from '../common/constants/styles'
 
 export default class FishboneSWNormal extends AbstractStructure {
 

diff --git a/src/structure/helper/allStructures.ts b/src/structure/helper/allStructures.ts
@@ -1,23 +1,23 @@
-import StructureClass from 'common/constants/structures'
-import MapUnbalanced from 'structure/mapUnbalanced'
-import AbstractStructure from 'structure/abstractStructure'
-import LogicRight from 'structure/logicRight'
-import LogicLeft from 'structure/logicLeft'
-import OrgChartDown from 'structure/orgChartDown'
-import OrgChartUp from 'structure/orgChartUp'
-import TreeRight from 'structure/treeRight'
-import TreeLeft from 'structure/treeLeft'
-import TimelineVertical from 'structure/timelineVertical'
-import FishboneLeftHeaded from 'structure/fishboneLeftHeaded'
-import FishboneNENormal from 'structure/fishboneNENormal'
-import FishboneSENormal from 'structure/fishboneSENormal'
-import FishboneRightHeaded from 'structure/fishboneRightHeaded'
-import FishboneNWNormal from 'structure/fishboneNWNormal'
-import FishboneSWNormal from 'structure/fishboneSWNormal'
-import TimelineHorizontal from 'structure/timelineHorizontal'
-import TimelineHorizontalUp from 'structure/timelineHorizontalUp'
-import TimelineHorizontalDown from 'structure/timelineHorizontalDown'
-import MapClockWise from 'structure/mapClockWise'
+import StructureClass from '../../common/constants/structures'
+import MapUnbalanced from '../mapUnbalanced'
+import AbstractStructure from '../abstractStructure'
+import LogicRight from '../logicRight'
+import LogicLeft from '../logicLeft'
+import OrgChartDown from '../orgChartDown'
+import OrgChartUp from '../orgChartUp'
+import TreeRight from '../treeRight'
+import TreeLeft from '../treeLeft'
+import TimelineVertical from '../timelineVertical'
+import FishboneLeftHeaded from '../fishboneLeftHeaded'
+import FishboneNENormal from '../fishboneNENormal'
+import FishboneSENormal from '../fishboneSENormal'
+import FishboneRightHeaded from '../fishboneRightHeaded'
+import FishboneNWNormal from '../fishboneNWNormal'
+import FishboneSWNormal from '../fishboneSWNormal'
+import TimelineHorizontal from '../timelineHorizontal'
+import TimelineHorizontalUp from '../timelineHorizontalUp'
+import TimelineHorizontalDown from '../timelineHorizontalDown'
+import MapClockWise from '../mapClockWise'
 
 export default function getStructure(key: string): AbstractStructure {
   if (key === StructureClass.MAP_UNBALANCED) {

diff --git a/src/structure/helper/structureUtils.ts b/src/structure/helper/structureUtils.ts
@@ -1,11 +1,11 @@
-import BranchViewController from 'viewController/branchViewController'
-import Bounds from 'utils/bounds'
-import BaseMap from 'structure/baseMap'
-import { TopicType, Direction } from 'common/constants/models'
-import StructureClass from 'common/constants/structures'
-import LeftAndRight from 'structure/leftAndRight'
-import TreeLeftAndRight from 'structure/treeLeftAndRight'
-import OrgChart from 'structure/orgChart'
+import BranchViewController from '../../viewController/branchViewController'
+import Bounds from '../../utils/bounds'
+import BaseMap from '../baseMap'
+import { TopicType, Direction } from '../../common/constants/models'
+import StructureClass from '../../common/constants/structures'
+import LeftAndRight from '../leftAndRight'
+import TreeLeftAndRight from '../treeLeftAndRight'
+import OrgChart from '../orgChart'
 
 export function isMapStructure(branch: BranchViewController) {
   return branch?.getStructureObject() instanceof BaseMap

diff --git a/src/structure/leftAndRight.ts b/src/structure/leftAndRight.ts
@@ -1,9 +1,9 @@
 import AbstractStructure from './abstractStructure'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds from 'utils/bounds'
-import { TopicType } from 'common/constants/models'
-import Size from 'utils/size'
-import { BranchConnection } from 'common/constants/styles'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds from '../utils/bounds'
+import { TopicType } from '../common/constants/models'
+import Size from '../utils/size'
+import { BranchConnection } from '../common/constants/styles'
 
 export default abstract class LeftAndRight extends AbstractStructure {
 

diff --git a/src/structure/logicLeft.ts b/src/structure/logicLeft.ts
@@ -1,7 +1,7 @@
 import LeftAndRight from './leftAndRight'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds from 'utils/bounds'
-import StructureClass from 'common/constants/structures'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds from '../utils/bounds'
+import StructureClass from '../common/constants/structures'
 
 export default class LogicLeft extends LeftAndRight {
 

diff --git a/src/structure/logicRight.ts b/src/structure/logicRight.ts
@@ -1,7 +1,7 @@
 import LeftAndRight from './leftAndRight'
-import BranchViewController from 'viewController/branchViewController'
-import Bounds from 'utils/bounds'
-import StructureClass from 'common/constants/structures'
+import BranchViewController from '../viewController/branchViewController'
+import Bounds from '../utils/bounds'
+import StructureClass from '../common/constants/structures'
 
 export default class LogicRight extends LeftAndRight {