@sketch-hq/sketch-web-renderer 3.2.1 → 3.2.3

package/CHANGELOG.md

@@ -1,552 +0,0 @@
-# @sketch-hq/sketch-web-renderer
-
-## 3.2.1
-
-### Patch Changes
-
-- 8d267822: Improved tiling system and how images are drawn in the canvas after being downloaded
-- 0c7e22f7: - Read node's components stored as properties in marina files
-  - Update flatbuffers to v22.9.29 for both List and Marina schemas
-- 1ad70e2b: Fix potential crash when PRImage format was missing
-
-## 3.2.0
-
-### Minor Changes
-
-- e2b9ef78: Remove the shadow root and overlays from Web-renderer
-
-## 3.1.8
-
-### Patch Changes
-
-- 4a0550a1: Use linear interpolation for tiled images
-- 1339274a: Alpha masks are now always in high resolution
-- 1b49e7eb: Correctly render masked background blurs
-- 78b0da7c: Correctly draw background blurs
-- 66cf29e2: Correctly render background blur applied to transparent layers
-
-## 3.1.7
-
-### Patch Changes
-
-- 609980b: Improve blurs strength accuracy
-- 173de7b: Prevent the generation of empty surfaces
-- 059203b: Shadows with radius 0 are now rendered using the correct resolution
-- 08d6f75: Correctly render radial gradients having a transform matrix
-
-## 3.1.6
-
-### Patch Changes
-
-- d30447a: Allow to change background color at runtime
-- 9319056: Improve performance metrics
-
-## 3.1.5
-
-### Patch Changes
-
-- 880a3bf: Remove log from the `useSetZoom` callback
-
-## 3.1.4
-
-### Patch Changes
-
-- d0f7184: Marina files are now properly supported
-
-## 3.1.3
-
-### Patch Changes
-
-- de01e61: Both touch and mouse events listeners are attached, so mouse inputs can continue to work on devices having both a touchscreen and mouse
-
-## 3.1.2
-
-### Patch Changes
-
-- 9376f7f: Correctly calculate cache budget
-- 5d3ed4e: Start using new tiling system. Now the canvas should look sharper.
-- 8f522ed: Allow to change feature flags during initialisation
-
-## 3.1.1
-
-### Patch Changes
-
-- fd7739c: Touch events are not captured anymore and touchmove is not prevented
-
-## 3.1.0
-
-### Minor Changes
-
-- e83d319: Allow to pass props to both canvas and container
-
-### Patch Changes
-
-- 10d5992: Allow to use a custom cursor
-
-## 3.0.1
-
-### Patch Changes
-
-- 6fdecfc: Start using the mask transform matrix
-
-## 3.0.0
-
-### Major Changes
-
-- 81b04f2: Add support for new tree file format
-
-### Patch Changes
-
-- 1ccfe43: Start parsing binary pr tree files
-- aa9c571: Add minimum memory budget for devices with small screens
-
-## 2.2.2
-
-### Patch Changes
-
-- 6d76e58: Make the Shadow root encapsulation optional
-- 50caa54: Fix plusDarker blend mode not correctly rendered
-
-## 2.2.1
-
-### Patch Changes
-
-- b92c6e3: - Make touch events passive
-  - Hide overlay while zooming
-
-## 2.2.0
-
-### Minor Changes
-
-- cb613fa: Add support for motion and zoom blurs
-- 23f9828: Improve gaussian blur rendering fidelity
-
-### Patch Changes
-
-- 6b14864: Correctly calibrate motion and zoom blur
-
-## 2.1.0
-
-### Minor Changes
-
-- 907223c: Images having the preload flag are now preloaded correctly
-
-### Patch Changes
-
-- 5d08fcb: Fix issue https://github.com/sketch-hq/Sketch/issues/41711
-
-## 2.0.0
-
-### Major Changes
-
-- 5072a68: The web renderer now exposes a new API to manage the overlay containing the artboards' names, CTAs and outline.
-
-  ### Breaking changes
-
-  - The event `goToArtboard` is not emitted anymore.
-  - To render the artboards' names, CTAs and outlines, the new component `ArtboardsInfoOverlay` should be used.
-
-  ### How to use
-
-  ```tsx
-  import { ArtboardsInfoOverlay, SketchWebReact } from '...'
-  ;<SketchWebReact>
-    <ArtboardsInfoOverlay
-      artboardStyle={{
-        fontFamily: 'sans-serif',
-        ctaText: 'View details',
-        ctaTextColor: 'rgba(0,0,0,0.55)',
-        nameTextColor: 'rgba(0,0,0,0.7)',
-        outlineColor: 'rgb(213, 145, 12)',
-      }}
-      onGoToArtboard={(artboardUUID: string) => {}}
-    />
-  </SketchWebReact>
-  ```
-
-### Patch Changes
-
-- 2d7b8e9: - Use the shadow dom to encapsulate the web renderer.
-  - Emit an actionType parameter with the event `goToArtboard`
-- ad36971: Fix SketchWebReact type.
-- b5ebd0b: Now useEffects are correctly invoked even when using the ShadowDom
-
-## 2.0.0-next.3
-
-### Patch Changes
-
-- ad36971: Fix SketchWebReact type.
-
-## 2.0.0-next.2
-
-### Patch Changes
-
-- b5ebd0b: Now useEffects are correctly invoked even when using the ShadowDom
-
-## 2.0.0-next.1
-
-### Patch Changes
-
-- 2d7b8e9: - Use the shadow dom to encapsulate the web renderer.
-  - Emit an actionType parameter with the event `goToArtboard`
-
-## 2.0.0-next.0
-
-### Major Changes
-
-- 5072a68: The web renderer now exposes a new API to manage the overlay containing the artboards' names, CTAs and outline.
-
-  ### Breaking changes
-
-  - The event `goToArtboard` is not emitted anymore.
-  - To render the artboards' names, CTAs and outlines, the new component `ArtboardsInfoOverlay` should be used.
-
-  ### How to use
-
-  ```tsx
-  import { ArtboardsInfoOverlay, SketchWebReact } from '...'
-  ;<SketchWebReact>
-    <ArtboardsInfoOverlay
-      artboardStyle={{
-        fontFamily: 'sans-serif',
-        ctaText: 'View details',
-        ctaTextColor: 'rgba(0,0,0,0.55)',
-        nameTextColor: 'rgba(0,0,0,0.7)',
-        outlineColor: 'rgb(213, 145, 12)',
-      }}
-      onGoToArtboard={(artboardUUID: string) => {}}
-    />
-  </SketchWebReact>
-  ```
-
-## 1.0.1
-
-### Patch Changes
-
-- 18b05c2: Prevent the renderer from crashing when an end region instruction is missing
-- be70d4d: Fix lifecycle hooks to avoid unnecessary disposals.
-
-## 1.0.0
-
-### Major Changes
-
-- 0461a28: Restructure the tiled renderer to improve the tiles management
-
-### Minor Changes
-
-- f46894b: Encapsulate manager in SketchWebReact
-
-### Patch Changes
-
-- a6b2797: Memory usage improvements
-- 78202fe: Fix getArtboardAtPosition event not working correctly in certain cases
-- 343c4cf: Correctly releasing the WebGL resources
-
-## 0.11.1
-
-### Patch Changes
-
-- ffed957: Fix pan position not updated correctly on initial zoom to fit. See https://github.com/sketch-hq/Cloud/issues/11363#issuecomment-1015542659
-
-## 0.11.0
-
-### Minor Changes
-
-- 1c9a5aa: Add camera lock API to prevent user panning and zooming.
-
-## 0.10.2
-
-### Patch Changes
-
-- 7c9fc9c: - Emit a new event 'allImagesReady'
-  - Add new React hook 'useAllImagesReadyEvent'
-
-## 0.10.1
-
-### Patch Changes
-
-- bf592a8: Ensure SketchWebReact sets Logger.active from the outset.
-
-## 0.10.0
-
-### Minor Changes
-
-- 7bdcdad: Add a `getArtboardAtPosition` API.
-- 3e796b6: Introduced a SketchWeb component and started using it in the Viewer.
-- aba76e2: Internal restructure
-- 8135d4a: SketchWebReact pre-integration tweaks.
-
-### Patch Changes
-
-- 52fc201: Update the pan values correctly
-- b9cdb54: - `initialPan` and `setPan` now accept a new property: `centerPointInViewport` that will center a given point to the client's viewport.
-  - Add a new method `getPanAtPosition` that returns the correct pan value, given a point relative to the viewport
-
-## 0.9.0
-
-### Minor Changes
-
-- ef4b2d0: Emit a metrics event.
-- 3f961ec: Send action type along with goToArtboard event
-
-### Patch Changes
-
-- f98cc41: Change artboard cta copy
-- b73b553: Update to latest presentation file format `0.8.3`.
-
-## 0.8.1
-
-### Patch Changes
-
-- e33db15: Disable the page canvas boundaries limit
-- 8aa4b9a: Fix PlusDarker blend mode not working correctly when the source or destination were not opaque.
-- dbfa309: Improved cache management
-
-## 0.8.0
-
-### Minor Changes
-
-- d93733f: - The canvas is now constrained to the document boundaries, so it's not possible anymore panning outside the page region.
-  - The constructor accepts 2 new values: `initialZoom` and `initialPan`
-  - Moved the method setZoom/getZoom setPan/getPan from the `gestureManager` to the The `Manager`
-  - The manager now emits the `zoom` and `pan` events, not the manager anymore.
-- c245ca0: Update file schema to 0.8.0
-
-### Patch Changes
-
-- 407c26b: Remove gradient below artboard name
-
-## 0.7.3
-
-### Patch Changes
-
-- 15acf91: The constructor now accepts a new optional flag preserveDrawingBuffer
-- 7c975c4: Add gradient below the artboards' names to improve the readability in case there are items below the artboards.
-
-## 0.7.2
-
-### Patch Changes
-
-- 438ee6d: Invoke event listeners in next tick.
-- f01a6cf: Fix alpha masks not rendering correctly
-
-## 0.7.1
-
-### Patch Changes
-
-- adb87ba: Initialise the Text element correctly. This fixes the "Go to artboard" button not being visible when in release mode.
-- b7d7683: Adjust user interactions according to design specs
-- 5443b9b: Add support for mipmaps when using WebGL 1
-- 6110916: Fix pan/zoom events on Safari, both mobile and desktop
-- 000c45d: Replace emojis with placeholder symbol temporarily
-
-## 0.7.0
-
-### Minor Changes
-
-- 9d73444: Upgrade to version `0.6.0` of the binary schema.
-- b5c2749: Remove support for the legacy JSON format.
-
-### Patch Changes
-
-- 385f637: Correctly handle the mousedown event
-- ed068c2: It's now possible to zoom into a specific center, different from the mouse position.
-
-## 0.6.2
-
-### Patch Changes
-
-- e5815b0: Upgrade to Presentation File Format `0.5.0`.
-- 8903ff4: The mousemove and mouseup listeners are now attached correctly to the canvas and hover events are not caught anymore when the mouse is outside the canvas
-- 53fec00: Improve how the items above the artboard are resized
-- 35b2c88: The setNeedsUpdate now checks if SketchKit exists.
-
-## 0.6.1
-
-### Patch Changes
-
-- 7197bc9: The constructor now accepts a new **optional** property: `rendererConfiguration`
-- 0d6d2ad: Dispose the web renderer correctly
-
-## 0.6.0
-
-### Minor Changes
-
-- d1d657c: Min and max zoom values are now configurable
-- bf21dc2: Use `ResizeObserver to resize the canvas`.
-
-  Now the Renderer constructor expects a new **required** property: `container`:
-
-  - The container is an `HTMLDivElement` that wraps the canvas element.
-  - The size of the canvas element will always be 100% the size of the container.
-  - The canvas element width and height must be left unset, because they will be managed by the renderer.
-
-- 5165aed: Make renderer highlight color configurable.
-
-### Patch Changes
-
-- 203843f: Adjust the radius to sigma conversion to improve the blurs appearance
-- 57a44d8: Force WebGL 1 on Safari
-- 2d3235b: Refactor camera move tracking
-- 45a1459: Improve performance when traversing the doc
-- 6ef34d8: Load images asynchronously
-- 1cca8b8: Improve speed when iterating through instructions
-- ca03d9f: Do not launch decoding tasks while the camera is moving
-
-## 0.5.0
-
-### Minor Changes
-
-- e3fc36c: Evolved binary parser schema version and file id handling.
-
-### Patch Changes
-
-- f18f985: Add ui interactions to the canvas
-- 777c7d8: Fix black lines issue when using alpha masks
-- dd17bc9: Improve how artboards backgrounds and shadows are rendered
-
-## 0.4.0
-
-### Minor Changes
-
-- f4db631: Start using `@sketch-hq/sketch-presentation-file-format` package.
-- e4c1341: Refactor parser structure.
-- 87e9013: Emit renderer warnings as a list instead of individual warnings
-
-### Patch Changes
-
-- c36805a: Enable mipmaps for images, and remove grey placeholder
-- dd4ce1d: Improve visible tiles calculation
-- 4569f1d: Store images only in GPU, avoiding the CPU copy
-
-## 0.3.2
-
-### Patch Changes
-
-- 7bca57e: Create layers using the top level object layers
-
-## 0.3.1
-
-### Patch Changes
-
-- 04d04a3: Fail fast in build.
-
-## 0.3.0
-
-### Minor Changes
-
-- 64968df: Add initial support for binary Presentation Files.
-
-### Patch Changes
-
-- 4873336: Add support for region instruction
-- 95cc952: Handle webgl context lost
-- 8ff5b05: Add text rendering and draw artboards names
-- 62152af: Handle matrix property in radial gradient content type
-
-## 0.2.0
-
-### Minor Changes
-
-- 5a3c130: Add new mode parameter in Renderer constructor
-
-### Patch Changes
-
-- ff15d84: The mouse position is now relative to the canvas client rect
-- 2a3fafb: Improve cache handling for tiling
-- b7b8fab: Internal refactor
-
-## 0.1.3
-
-### Patch Changes
-
-- 830b949: Implement tiling
-
-## 0.1.2
-
-### Patch Changes
-
-- 6b303ac: Handle source blend mode, angular gradient, mask property in endSurface instruction, tiling in fill image and gaussian blur with saturation
-- db84b93: Handle presentation file version mismatch warnings.
-- 0a41322: Fix safari issue with indexedDB
-- 8aa002d: Add scaleToFit method to renderer
-
-## 0.1.1
-
-### Patch Changes
-
-- a451039: Use static/js as base path for the web renderer chunks
-
-## 0.1.0
-
-### Minor Changes
-
-- 3d6c815: Use the OffscreenCanvas when possible and slight changes to the API
-
-### Patch Changes
-
-- 3bc636c: Skip layers that are outside the viewport
-- 793784d: Improve status event handling when using a web worker
-- bf85eb5: Improve surfaces generation using SkPicture
-
-## 0.0.8
-
-### Patch Changes
-
-- 1e25c1e: Check if the property name exists in the startLayer instruction
-- b52a72c: Enable WebGL 2 on supported browsers
-
-## 0.0.7
-
-### Patch Changes
-
-- 780a8e4: Rename trait with traits in start layer instruction
-- 8bc5172: Trace Js and C++ operations and print duration in console
-- ba51d6f: Enable/disable debug mode in web renderer
-- 54d03e3: Add possibility to set a background color during the Renderer initialization
-- 9279281: Handle layer instructions and draw artboards background
-- 706f92a: Added status event to Renderer.
-
-## 0.0.6
-
-### Patch Changes
-
-- 6d328c9: It's now possible to zoom the canvas by using mouse wheel or gestures
-
-## 0.0.5
-
-### Patch Changes
-
-- c1cdd9d: Add panning
-- 2fe7471: Adjust Renderer constructor to take a locateFile function.
-
-## 0.0.4
-
-### Patch Changes
-
-- a8bf3ca: Add support for images
-- 7204aeb: Fix transformation matrix in grey squares appearing while images are being downloaded
-- 07ba889: Add blur instruction
-- 705ed9b: Rename blend mode destATop to destAtop
-- e417ce0: Update over blend mode name to normal
-- 8338c14: Add surface instructions
-
-## 0.0.3
-
-### Patch Changes
-
-- 3081694: Add linear gradient instruction
-- de31cc4: Add clear instruction
-- 4322251: Add fill instruction
-- 45caba0: Add radial gradient instruction
-- 4b83bb4: Add transform instruction
-- ba78270: Add clip instruction
-- b062c07: Include full set of files in the package dist folder.
-- fb0c2f6: Add save and restore instructions
-- f4ce343: Add blend mode instructions
-
-## 0.0.2
-
-### Patch Changes
-
-- 04ef17d: Initial publish.