fabric 6.0.0-beta10 → 6.0.0-beta11

package/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 ## [next]
 
+## [6.0.0-beta11]
+
+- patch(): Avoid unwanted mutation to passed objects array to Group constructor [#9151](https://github.com/fabricjs/fabric.js/pull/9151)
+- patch(): ActiveSelection initialization + types [#9143](https://github.com/fabricjs/fabric.js/pull/9143)
+- chore(TS): BREAKING remove canvas.interactive, added typings for canvas options [#9140](https://github.com/fabricjs/fabric.js/pull/9140)
+- chore(TS): BREAKING PREVIOUS BETA mv + rename `TProps` => `TOptions` [#9139](https://github.com/fabricjs/fabric.js/pull/9139)
+- test(playwright): Use embedded eval from playwright [#9133](https://github.com/fabricjs/fabric.js/pull/9133)
+- chore(TS): Fix event types and .once this binding [#9119](https://github.com/fabricjs/fabric.js/pull/9130)
+- docs(): rm `canvas2pdf` [#9135](https://github.com/fabricjs/fabric.js/pull/9135)
+- chore(TS): export types [#9129](https://github.com/fabricjs/fabric.js/pull/9129)
+- ci(e2e): support relative imports [#9108](https://github.com/fabricjs/fabric.js/pull/9108)
+- chore(TS): complete type check [#9119](https://github.com/fabricjs/fabric.js/pull/9119)
+- chore(TS): Add type-checking to files excluded with ts-nocheck [#9097](https://github.com/fabricjs/fabric.js/pull/9097)
+- chore(TS): Add type-checking to files excluded with ts-nocheck ( Parser mostly ) [#9085](https://github.com/fabricjs/fabric.js/pull/9085)
+- docs(): revise test section [#9114](https://github.com/fabricjs/fabric.js/pull/9114)
+- fix(): #8344 stroke projection [#8374](https://github.com/fabricjs/fabric.js/pull/8374)
+- fix(Filters) Removing type from the options passed in the constructor [#9089](https://github.com/fabricjs/fabric.js/pull/9089)
+- feat(InteractiveObject): add `getActiveControl()` to expose `__corner` [#9102](https://github.com/fabricjs/fabric.js/pull/9102)
+- ci(sandbox): bump next.js [#9100](https://github.com/fabricjs/fabric.js/pull/9100)
+- test(playwright): add snapshots, refactor utils, coverage [#9078](https://github.com/fabricjs/fabric.js/pull/9078)
+- test(Text): Add some tests for text in Jest [#9083](https://github.com/fabricjs/fabric.js/pull/9083)
+- ci(): Install system deps only when necessary [#9086](https://github.com/fabricjs/fabric.js/pull/9086)
+- fix(util, Path): path distance measurement fix for M cmd [#9076](https://github.com/fabricjs/fabric.js/pull/9076)
+- chore(TS): Image class type checks, BREAKING change to FromURL static method [#9036](https://github.com/fabricjs/fabric.js/pull/9036)
+- ci(): properly checkout head for stats [#9080](https://github.com/fabricjs/fabric.js/pull/9080)
+- fix(Text): `_getFontDeclaration` wasn't considering fontFamily from the style object [#9082](https://github.com/fabricjs/fabric.js/pull/9082)
+- chore(TS): Fix ITextBehaviour enterEditing type [#9075](https://github.com/fabricjs/fabric.js/pull/9075)
+- chore(TS): export FabricObjectProps and GroupProps [#9025](https://github.com/fabricjs/fabric.js/pull/9025)
+- chore(TS): Replace BaseFabricObject with FabricObject [#9016](https://github.com/fabricjs/fabric.js/pull/9016)
+- refactor(svgImport): remove the css/gradient/clipPath global definitions [#9030](https://github.com/fabricjs/fabric.js/pull/9030)
+- fix(): tweaks to type getter [#9022](https://github.com/fabricjs/fabric.js/pull/9022)
+- ci() Refactor GHA actions for caching and reuse [#9029](https://github.com/fabricjs/fabric.js/pull/9029)
+- ci(): install dev deps types [#9039](https://github.com/fabricjs/fabric.js/pull/9039)
+
 ## [6.0.0-beta10]
 
 - chore(TS): Remove @ts-nocheck from Text class. [#9018](https://github.com/fabricjs/fabric.js/pull/9018)

package/CONTRIBUTING.md

@@ -64,6 +64,8 @@ Answering questions and addressing issues, as well as fixing and adding types (s
 
 ### 🎮 Adding a DEMO (currently not possible)
 
+**New website is under construction. Contributions are welcome.**
+
 Take a look at an existing [demo file][demo_file].\
 Create a new file in the same directory (`posts/demos/_posts`) and follow [**developing the website**](#fabricjscom-deprecated).
 
@@ -104,11 +106,12 @@ Fabric is an open source project 🦄 and as such depends on the **genuine effor
   Do not reorder imports. Irrelevant changes in a PR that are not created by prettier aren't needed nor welcome.
 - **Tests** \
   PRs must be backed with relevant tests, follow [TESTING](#-testing). If you never wrote a test or you find our tests unclear to extend, just ask for help.
+  Aim to cover 100% of the changes.
 - **Docs** \
   Add relevant comments to your code if necessary using [JSDoc 3][jsdoc] and update relevant guides.\
   The generated documentation can be found at [fabricjs.com][docs], see [DOCS](#-improving-docs).
 - **Changelog**\
-  Add a concise listing to the [**CHANGELOG**](CHANGELOG.md) describing what has changed.
+  Add a concise listing to the [**CHANGELOG**](CHANGELOG.md) describing what has changed or let github actions add the PR title for you.
 - **1️⃣ PR per feature/bug** \
   Create a new branch for every pull request.\
   If you want to do more than one thing, create multiple pull requests 💪.
@@ -125,19 +128,33 @@ It is more than likely you will be requested to change stuff and refine your wor
 [![🧪](../../actions/workflows/tests.yml/badge.svg)](../../actions/workflows/tests.yml)
 [![CodeQL](../../actions/workflows/codeql-analysis.yml/badge.svg)](../../actions/workflows/codeql-analysis.yml)
 
-Test suites use [`QUnit`][qunit] for assertions and [`testem`][testem] for serving the browser tests
+| Suite                                                                        | unit (node)                                                                                              | e2e (browser)                                                                                                                                                                                                                               |
+| ---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Framework                                                                    | [`jest`][jest]                                                                                           | [`playwright`][playwright]                                                                                                                                                                                                                  |
+| Setup                                                                        |                                                                                                          | <pre>npm run build -- -f -w</pre>                                                                                                                                                                                                           |
+| Running Tests<br><br><br><br><br><pre>\<test cmd\> -- [filter] [watch]</pre> | <pre>npm run test:jest -- [filters] [-w]</pre><br><br><br>It is advised to use filters to save time.<br> | <pre>npm run test:e2e -- [filters] [--ui]</pre><br>In some machines babel is flaky and doesn't build the test files. In that is the case, try running the command using `npx` directly, see [`playwright.setup.ts`](./playwright.setup.ts). |
+| Writing Tests                                                                | Add/update `src/*.(spec\|test).ts` files                                                                 | - Update tests in `e2e/tests`<br>- Create a new test based on `e2e/template`                                                                                                                                                                |
+| Test Gen                                                                     |                                                                                                          | <pre>npm start vanilla<br>npx playwright codegen http://localhost:1234</pre>                                                                                                                                                                |
+| Test Spec                                                                    |                                                                                                          | - `index.ts`: built and loaded into the web app<br> - `index.spec.ts`: test spec<br>                                                                                                                                                        |
+| Outputs                                                                      | Snapshots next to the test file                                                                          | - Snapshots next to the test file <br>- `e2e/test-report`<br>- `e2e/test-results`                                                                                                                                                           |
+
+### Legacy Test Suite
+
+We **discourage** writing new tests in the legacy suite and **encourage** migrating failing tests to the new suite.
+However, it is not carved in stone.
+
+The test suites use [`QUnit`][qunit] for assertions and [`testem`][testem] for serving the browser tests.
 
 - `unit` tests: test logic and state
 - `visual` tests: test visual outcome against image refs located at `test/visual/golden`
-- `UI` tests: testing with playwright
 
-### Getting Started
+#### Getting Started
 
 - Build and watch for changes
   ```bash
   npm run build -- -f -w
   ```
-- Run the entire test suite on `chrome` (many tests are skipped on `node`)
+- Run the _legacy_ test suite on `chrome` (many tests are skipped on `node`)
   ```bash
   npm test -- -a -c chrome
   ```
@@ -172,17 +189,7 @@ Test suites use [`QUnit`][qunit] for assertions and [`testem`][testem] for servi
   npm test -- -h
   ```
 
-## UI tests
-
-Run UI tests with Playwright in parallel in Chrome (headed mode).
-
-```bash
-$ npm run test:e2e
-```
-
-### Adding Tests
-
-Backing a PR with tests that cover the changes that were made is a **MUST**. Aim to cover 100% of the cases.
+#### Adding Tests
 
 Add tests to relevant files or add new files when necessary under `test/unit` or `test/visual`.
 
@@ -256,6 +263,8 @@ Don't forget to unlink the package once you're done.
 [prettier_extension]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
 [eslint]: https://eslint.org/
 [jsdoc]: https://jsdoc.app/
+[playwright]: https://playwright.dev/
+[jest]: https://jestjs.io/
 [qunit]: https://qunitjs.com/
 [testem]: https://github.com/testem/testem
 [unit_test]: https://github.com/fabricjs/fabric.js/blob/93dd2dcca705a4b481fbc9982da4952ef5b4ed1d/test/unit/point.js#L227-L237

package/README.md

@@ -202,7 +202,6 @@ See our ready to use [templates](./.codesandbox/templates/).
 | [Three.js][three.js]           | 3D graphics          |
 | [PixiJS][pixijs]               | WebGL renderer       |
 | [Konva][konva]                 | Similar features     |  ❌  |
-| [Canvas2PDF][canvas2pdf]       | PDF renderer         |
 | [html-to-image][html-to-image] | HTML to image/canvas |
 
 ## More Resources
@@ -230,7 +229,6 @@ See our ready to use [templates](./.codesandbox/templates/).
 
 [asturur]: https://github.com/asturur
 [asturur_twitter]: https://twitter.com/AndreaBogazzi
-[canvas2pdf]: https://github.com/joshua-gould/canvas2pdf
 [cdnjs]: https://cdnjs.com/libraries/fabric.js
 [code_triage]: https://www.codetriage.com/kangax/fabric.js
 [codepens]: https://codepen.io/tag/fabricjs

package/dist/fabric.d.ts

@@ -7,8 +7,11 @@ export { runningAnimations } from './src/util/animation/AnimationRegistry';
 export * from './src/typedefs';
 export * from './src/EventTypeDefs';
 export { Observable } from './src/Observable';
+export type { TCanvasSizeOptions, TSVGExportOptions, } from './src/canvas/StaticCanvas';
+export type { StaticCanvasOptions } from './src/canvas/StaticCanvasOptions';
 export { StaticCanvas } from './src/canvas/StaticCanvas';
 export { Canvas } from './src/canvas/Canvas';
+export type { CanvasOptions } from './src/canvas/CanvasOptions';
 export { CanvasDOMManager } from './src/canvas/DOMManagers/CanvasDOMManager';
 export { StaticCanvasDOMManager } from './src/canvas/DOMManagers/StaticCanvasDOMManager';
 export type { XY } from './src/Point';
@@ -28,26 +31,45 @@ export { CircleBrush } from './src/brushes/CircleBrush';
 export { SprayBrush } from './src/brushes/SprayBrush';
 export { PatternBrush } from './src/brushes/PatternBrush';
 export { FabricObject as Object } from './src/shapes/Object/FabricObject';
-export type { TProps } from './src/shapes/Object/types';
+export type { TFabricObjectProps, FabricObjectProps, SerializedObjectProps, } from './src/shapes/Object/types';
+export type { SerializedLineProps } from './src/shapes/Line';
 export { Line } from './src/shapes/Line';
+export type { CircleProps, SerializedCircleProps } from './src/shapes/Circle';
 export { Circle } from './src/shapes/Circle';
 export { Triangle } from './src/shapes/Triangle';
+export type { EllipseProps, SerializedEllipseProps, } from './src/shapes/Ellipse';
 export { Ellipse } from './src/shapes/Ellipse';
+export type { RectProps, SerializedRectProps } from './src/shapes/Rect';
 export { Rect } from './src/shapes/Rect';
+export type { PathProps, SerializedPathProps } from './src/shapes/Path';
 export { Path } from './src/shapes/Path';
+export type { SerializedPolylineProps } from './src/shapes/Polyline';
 export { Polyline } from './src/shapes/Polyline';
 export { Polygon } from './src/shapes/Polygon';
+export type { GraphemeBBox, SerializedTextProps, TPathAlign, TPathSide, TextProps, } from './src/shapes/Text/Text';
 export { Text } from './src/shapes/Text/Text';
+export type { ITextProps, SerializedITextProps, } from './src/shapes/IText/IText';
 export { IText } from './src/shapes/IText/IText';
+export type { GraphemeData, SerializedTextboxProps, TextboxProps, } from './src/shapes/Textbox';
 export { Textbox } from './src/shapes/Textbox';
-export type { TextStyleDeclaration, TextStyle, } from './src/shapes/Text/StyledText';
+export type { CompleteTextStyleDeclaration, TextStyleDeclaration, TextStyle, } from './src/shapes/Text/StyledText';
+export type { GroupEvents, GroupProps, LayoutContext, GroupOwnProps, LayoutContextType, LayoutResult, LayoutStrategy, SerializedGroupProps, } from './src/shapes/Group';
 export { Group } from './src/shapes/Group';
+export type { ActiveSelectionOptions, MultiSelectionStacking, } from './src/shapes/ActiveSelection';
 export { ActiveSelection } from './src/shapes/ActiveSelection';
 export { Image } from './src/shapes/Image';
 export type { ImageSource, SerializedImageProps, ImageProps, } from './src/shapes/Image';
 export { createCollectionMixin } from './src/Collection';
 export * as util from './src/util';
-export * from './src/parser';
+export { loadSVGFromString } from './src/parser/loadSVGFromString';
+export { loadSVGFromURL } from './src/parser/loadSVGFromURL';
+export { parseSVGDocument } from './src/parser/parseSVGDocument';
+export { parseAttributes } from './src/parser/parseAttributes';
+export { parseStyleAttribute } from './src/parser/parseStyleAttribute';
+export { parsePointsAttribute } from './src/parser/parsePointsAttribute';
+export { parseTransformAttribute } from './src/parser/parseTransformAttribute';
+export { getCSSRules } from './src/parser/getCSSRules';
+export { parseFontDeclaration } from './src/parser/parseFontDeclaration';
 export { Control } from './src/controls/Control';
 export * as controlsUtils from './src/controls';
 export * from './src/filters';