paper 0.13.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,90 @@
 # Change Log
 
+## `0.14.0`
+
+### Added
+
+- Add `options.handlers` to `PaperScript.execute()`, to export further global
+  handlers next to `onFrame`, `onResize` and the tool's, for hosts that call
+  them themselves, such as Scriptographer's `onStop`.
+- Add `Tool#eventInterval`, as Scriptographer had it, to fire `onMouseDrag` again
+  at an interval while the mouse button is held, also when the mouse doesn't
+  move.
+- Add `Project#scope`, `View#scope`, `Item#scope` and `Tool#scope`, to get from
+  each of them to its `PaperScope` (#1634).
+- Add `Group#isolated`, to draw a group or layer through a temporary canvas, so
+  that the blend modes of its children, such as `'destination-out'`, only apply
+  within it, like CSS's `isolation: isolate` (#474).
+- Add `View#dispatchMouseEvent()` and `View#dispatchKeyEvent()`, to feed mouse
+  and key events from hosts without a DOM, such as workers, through the same
+  handling as the DOM's events, for tools, items and views.
+- Add `settings.scaleStrokes`, to scale the stroke widths of paths and
+  compound paths along with their content when matrices are applied (#2098,
+  #1514).
+- Add the `paper-sourced.js` build, in which a project's items can be backed
+  by a host document through `Project#source`: items are created as light
+  shells from the host's records, and load their content and children from
+  the host on first access, so a script costs what it touches. Includes
+  `HostItem`, for the host's own kinds of nodes (#2203).
+- Add `Project#trackChanges` and `Project#takeChanges()`, to let hosts that
+  keep their own document update only the items that changed, and export
+  `ChangeFlag` (#2202).
+
+### Changed
+
+- `Path.RegularPolygon()` follows Illustrator: it stands on a flat bottom edge
+  for any number of sides, and its segments run counterclockwise from its top
+  vertex, or with an even number of sides, from the right end of its top edge.
+  This changes the segment order of all regular polygons, and turns those with
+  a multiple of 6 sides onto an edge (#1787).
+- Hit-test transparent fills, as in SVG: only items without a fill color are
+  not hit through their fill (#1157).
+- `paper.install()` keeps what the target scope has already, such as the
+  native `Event`, `MouseEvent` and `Symbol`, and PaperScript doesn't shadow
+  existing globals with Paper.js's classes of the same name either (#1832,
+  #1652).
+- `Item#importJSON()` into an existing item resets the fields that the JSON
+  leaves out, so the item ends up the same as a newly imported one, with its
+  place in the scene graph and its event handlers kept (#1425, #1324).
+- Canvases without `resize` get their CSS size from the view on every screen,
+  not only at pixel ratios other than 1, where the page's CSS won (#2088).
+- `#hitTestAll()` reports every segment and handle of a path within the
+  tolerance, closest first, followed by its stroke or fill hit, instead of only
+  the first hit per path (#1294).
+
+### Fixed
+
+- Create the tool in PaperScript for all of its global handlers, also for
+  scripts that only define `onActivate()` or `onDeactivate()`, and document
+  `Tool#onActivate` and `Tool#onDeactivate`.
+- Keep `Key.modifiers` in sync with the flags of mouse events, so modifier keys
+  pressed or released while the page didn't have the focus don't stay wrong
+  (#1140).
+- Keep Paper.js's own blend modes, which CSS doesn't have, such as
+  `'destination-out'`, through SVG export and import, in a
+  `data-paper-blend-mode` attribute (#1296).
+- Throw a clear error when creating an item without a project, instead of a
+  null access deep inside the constructor (#1889).
+- Free the pixels of temporary canvases when they're released, which their pool
+  kept allocated at their largest size for the life of the page.
+- Keep the size of rasters in JSON, so imported rasters have their size and
+  bounds before their image has loaded, or if it fails to load (#1598).
+- Fix the frame timer of workers and Node.js running forever after any script,
+  which kept hosts from seeing scripts end.
+- Fix touch scrolling over empty parts of a canvas whose items have mouse
+  handlers (#1930).
+- Fix mouse events reaching items and views through elements that cover the
+  canvas, such as menus. Drags still reach beyond them (#992).
+- Fix the points of `#hitTestAll()` results of items inside transformed
+  groups, which were in the items' own coordinates.
+- Support `strokeScaling: false` on text, exactly for uniform scaling (#1703).
+- Fix the view size of canvases inside elements with CSS transforms, which
+  only scale the canvas on screen.
+- Fix italic and oblique font weights in SVG export and import, which SVG
+  keeps in `font-style` (#937).
+- Fix `onFrame` in web workers, where views have no element (#2200).
+- Fix `PaperScope#execute()` in web workers (#2201).
+
 ## `0.13.0`
 
 ### Added

package/README.md

@@ -201,16 +201,14 @@ Paper.js uses [Gulp.js](https://gulpjs.com/) for building, and has a couple of
 dependencies as NPM modules. Read the chapter [Installing Node.js and
 NPM](#installing-nodejs-and-npm) if you still need to install these.
 
-Due to a conflict in Gulp 3 that could only be resolved using package
-resolution, we recently switched from NPM to `yarn` for development, which also
-needs to be installed now. See
-[Installing Yarn](https://classic.yarnpkg.com/en/docs/install/) for details.
+Development uses [pnpm](https://pnpm.io/), which needs to be installed too. See
+[Installing pnpm](https://pnpm.io/installation) for details.
 
 In order to be able to build Paper.js, after checking out the repository, paper
 has dependencies that need to be installed. Install them by issuing the
 following commands from the Paper.js directory:
 
-    yarn install
+    pnpm install
 
 ### Building the Library
 
@@ -218,7 +216,7 @@ The Paper.js sources are distributed across many separate files, organised in
 subfolders inside the `src` folder. To compile them all into distributable
 files, you can run the `build` task:
 
-    yarn build
+    pnpm build
 
 You will then find the built library files inside the `dist` folder, named
 `paper-full.js` and `paper-core.js`, along with their minified versions. Read
@@ -236,11 +234,11 @@ library.
 This means you can switch between loading from sources and loading a built
 library simply by running.
 
-    yarn load
+    pnpm load
 
 And to go back to a built library
 
-    yarn build
+    pnpm build
 
 Note that your PaperScripts examples do not need to change, they can keep
 loading `dist/paper-full.js`, which will always do the right thing. Note also
@@ -250,7 +248,7 @@ that `src/load.js` handles both browsers and Node.js, as supported by Prepro.js.
 
 Create a final zipped distribution file inside the `dist` folder:
 
-    yarn dist
+    pnpm dist
 
 ### Branch structure
 
@@ -261,7 +259,7 @@ only merged into [`main`](https://github.com/paperjs/paper.js/tree/main)
 when a new release occurs.
 
 As of version `0.9.26`, the `dist` folder is excluded on all branches, and the
-building is now part of the `yarn publish` process by way of the `prepublish`
+building is now part of the `pnpm publish` process by way of the `prepublish`
 script.
 
 We also offer prebuilt versions of the latest state of the `develop` branch on
@@ -273,7 +271,7 @@ and [`prebuilt/dist`](https://github.com/paperjs/paper.js/tree/prebuilt/dist).
 Similarly to building the library, you can run the `docs` task to build the
 documentation:
 
-    yarn docs
+    pnpm docs
 
 Your docs will then be located at `dist/docs`.
 
@@ -291,11 +289,16 @@ CORS restrictions. In order to run the browser based tests on Chrome, you need
 to run a local web-server through Gulp.js. The following command will handle it
 for you, and will also open the browser at the right address straight away:
 
-    yarn test:browser
+    pnpm test:browser
+
+To run them in headless Chrome instead, as CI does, and report the result in the
+terminal:
+
+    pnpm test:chrome
 
 To test the Node.js version of Paper.js, use this command:
 
-    yarn test
+    pnpm test
 
 ### Contributing [![Open Source Helpers](https://www.codetriage.com/paperjs/paper.js/badges/users.svg)](https://www.codetriage.com/paperjs/paper.js)