Get rid of the UMD bundle: not pratical, not minimified so not ready for
production, nor for reuse.
This lets remove the webpack build which was not used anymore.
- core build: everything is done with tsc and simplify pack
- remove webpack configuration
- Move typedoc in the package where it is used (make it easier to detect
usage)
- remove unused dependencies:
- better-docs (use typedoc instead)
- webpack loaders (css, file, style, url)
- babel
- circular-dependency-plugin (webpack plugin)
- webpack
- cross-env
- core build: tsc only
BREAKING CHANGE: the UMD bundle is no more provided in the npm package
Keep the former mxGraph documentation to allow a later documentation
migration.
Remove both the former mxGraph and the new maxGraph API docs as they can
be generated.
Remove the former mxGraph examples home page as it has been replaced by
Storybook.
Update the configuration to generate the maxGraph API docs
- remove jsdoc resources as it is not used anymore
- configure the core package to generate the API docs in the docs
package
- add a GitHub workflow to ensure we can generate the API docs without
errors
Added `eslint` to project and configured it. The fixes will be applied later.
```
Found 1855 problems (709 errors, 1146 warnings) 🙈
628 errors and 291 warnings potentially fixable with the `--fix` option.
```
When running `generate-types` script in core package
there is typescript error TS2345 in src/util/Dictionary.ts,
added changes to fix it.
- Moved types IdentityObject and IdentityFunction to types.ts
- Renamed const FIELD_NAME to IDENTITY_FIELD_NAME and
moved it to util/Constants.ts
- Set Cell and CellOverlay to implement IdentityObject
Root and all package.json files
- Fix license, version and authors
- Remove the non-relevant .npmignore file at the project. It was designed for mxgraph, the whole directory structure
changed, and we don't plan to publish the root package
`core` package
- Generate type definition and javascript files for ESM output
- dedicated folder for `esm` and `types` in the `dist` folder to clearly separate concerns
- exported in the package.json
- Add npm script for `npm pack` configuration
- Drop the `postinstall` npm script that built the `core` bundle. It would have been run when the package is installed
in dependent projects at dependencies install. And it would have failed as it tries to build the project from TypeScript
sources that are not available in the npm package.
fix: ConstraintHandler now loads image as everywhere else in the code using `Client.imageBasePath`
Using import doesn't work as the image is not available in the npm package. It generated error like this in ViteJS
project:
Failed to resolve import "../../../images/point.gif" from "../core/dist/esm/view/handler/ConstraintHandler.js". Does the file exist?
This gif import had been introduced to make `Anchors.stories.js` retrieve the gif file. Configuring `imageBasePath` as
already done in other stories fixes the issue.
Don't export EditorCodec and StylesheetCodec as they generate errors.
This is a temporary solution to avoid error in dependent project (at least, with ViteJS projects).
This ensures we don't have type errors in the code.
Update tsconfig to only include source TS files.
Previous configuration prevented to run the type generation twice.
The generated d.ts files were considered as source files, so we got file override errors.
Add a dedicated npm script to generate scripts.
We cannot directly call the tsc or lerna commands on the macOS GH actions runner, so introduce the script.
Remove the extra NODE_OPTIONS in storybook server start script that generated an
error.
Remove cross-env devDependency which is then not used anymore.
Fix storybook deprecation warning (static dirs)
Fix imports that are not respecting the case of the filenames.
The build often has errors and they are only detected after a developer pull the `development` branch on their local machine.
To early catch build failures, add a GitHub workflow that runs a build command.
* reorganised directories; removed mx prefix
* reduced directory hierarchies; removed mx prefix; type fixes
* convert remaining javascript to ts
* fix/add types
* add type defs
* type updates; moved codecs to where they're used
* reorganise constants into enums+type additions
* removed "Function:" and "Variable:" prefixes from comments, as they aren't needed in JSDoc
* removed "Function:", "Variable:" and "Class:" prefixes from comments, as they aren't needed in JSDoc
* removed "Function:" prefixes from comments, as they aren't needed in JSDoc
* minor changes
* convert code example blocks to markdown
* module casing updates
* converted parameter function documentation to JSDoc
* documentation+type updates
* removed react subdir (for now)
* reorganised various `utils` functions into different files
* type updates/bugfixes/workarounds
* rename Rubberband and CellEditor to be *Handler to match the other plugins
* move codec classes to where they're used to reduce cyclic dependencies
* move codec classes to where they're used to reduce cyclic dependencies
* type updates/reorganize layout file structure
* renamed various files for consistency
* import fixes
* renamed GraphHandler SelectionHander and various fixes
* convert EventObject parameters to objects
* add basic better-docs config
* update better-docs config
* bugfix for shared variables in Graph persisting across instances
* fixed accessing handlers in examples; renamed Model to GraphModel
* fixed accessing handlers in examples; renamed Model to GraphModel
* restored selection model
* bugfix
* renamed getModel to getDataModel
* changed to use graph.batchUpdate() to reduce lines of code
* changed to use graph.batchUpdate() to reduce lines of code
* finished annotations+added TypeDoc
* convert remaining Cell[] instances to CellArray
* convert NaturalDocs links to JSDoc
Thomas Bouffard
Anatoliy Mayorov
Dave Morrissey
Junsik Shim
Jon Gadsden
davidjgraph
David Benson [draw.io]
alderg
Gaudenz Alder
David Benson
David Benson
mehyaa