@gjsify/canvas2d 0.22.0 → 0.23.0

package/README.md

@@ -30,6 +30,39 @@ widget.onReady((canvas, ctx) => {
 window.set_child(widget);
 ```
 
+## Globals
+
+The package root is a **side-effect-free barrel** — importing it gives you named
+exports and nothing else. Browser globals are installed by the dedicated
+`/register` subpath:
+
+```typescript
+import '@gjsify/canvas2d/register';   // globalThis.ImageData, globalThis.Path2D
+```
+
+You normally never write that import: `gjsify build` defaults to `--globals auto`,
+which detects a free `ImageData` / `Path2D` reference in the bundled output and
+injects the subpath for you. Application and example code should rely on that (see
+the tree-shakeable-globals convention in `AGENTS.md`) — an explicit `/register`
+import in app code hides auto-detection gaps.
+
+What each entry point gives you:
+
+| | `@gjsify/canvas2d` | `@gjsify/canvas2d/register` |
+|---|---|---|
+| `CanvasRenderingContext2D`, `CanvasGradient`, `CanvasPattern`, `Path2D`, `ImageData`, `parseColor`, `Canvas2DBridge` | named exports | — |
+| `globalThis.ImageData`, `globalThis.Path2D` | — | ✅ |
+| `globalThis.CanvasRenderingContext2D`, `globalThis.HTMLCanvasElement`, `globalThis.DOMMatrix{,ReadOnly}` and the `'2d'` context factory | — | ✅ (delegated to `@gjsify/dom-elements/register/canvas`, which owns them) |
+
+`Canvas2DBridge` depends on the `'2d'` context factory and imports
+`@gjsify/dom-elements/register/canvas` itself, so `canvas.getContext('2d')` works
+on a bridge even with `--globals none`.
+
+> **Changed after 0.22.0** — up to and including 0.22.0, `import { Canvas2DBridge } from '@gjsify/canvas2d'`
+> installed `ImageData` / `Path2D` / `CanvasRenderingContext2D` on `globalThis` as an
+> import side effect and registered a second, duplicate `'2d'` context factory. See
+> [ADR 0012](https://github.com/gjsify/gjsify/blob/main/docs/adr/0012-framework-register-ownership.md).
+
 ## License
 
 MIT

package/lib/esm/canvas2d-bridge.js

@@ -1 +1 @@
-import"./_virtual/_rolldown/runtime.js";import e from"gi://GObject";import t from"gi://GLib?version=2.0";import n from"gi://Gtk?version=4.0";import{HTMLCanvasElement as r,notifyElementResize as i}from"@gjsify/dom-elements";import{attachEventControllers as a}from"@gjsify/event-bridge";import{Event as o}from"@gjsify/dom-events";const s=e.registerClass({GTypeName:`GjsifyCanvas2DBridge`},class Canvas2DBridge extends n.DrawingArea{constructor(e){super(e),this._canvas=null,this._ctx=null,this._readyCallbacks=[],this._resizeCallbacks=[],this._tickCallbackId=null,this._frameCallback=null,this._timeOrigin=t.get_monotonic_time(),this.set_draw_func(this._onDraw.bind(this)),a(this,()=>this._canvas,{captureKeys:!0}),this.connect(`unrealize`,()=>{this._tickCallbackId!==null&&(this.remove_tick_callback(this._tickCallbackId),this._tickCallbackId=null),this._ctx&&this._ctx._dispose(),this._canvas=null,this._ctx=null})}_onDraw(e,t,n,a){if(!this._canvas){if(this._canvas=new r,this._canvas.width=n,this._canvas.height=a,this._ctx=this._canvas.getContext(`2d`),this._ctx){for(let e of this._readyCallbacks)e(this._canvas,this._ctx);this._readyCallbacks=[]}}else if(this._canvas.width!==n||this._canvas.height!==a){this._canvas.width=n,this._canvas.height=a,this._canvas.dispatchEvent(new o(`resize`)),i(this._canvas,n,a);for(let e of this._resizeCallbacks)e(n,a)}if(this._ctx){let e=this._ctx._getSurface();t.setSourceSurface(e,0,0),t.paint()}}get canvas(){return this._canvas}getContext(e){return this._ctx}onReady(e){if(this._canvas&&this._ctx){e(this._canvas,this._ctx);return}this._readyCallbacks.push(e)}onResize(e){this._resizeCallbacks.push(e)}requestAnimationFrame(e){return this._frameCallback=e,this._tickCallbackId===null&&(this._tickCallbackId=this.add_tick_callback((e,n)=>{this._tickCallbackId=null;let r=(n.get_frame_time()-this._timeOrigin)/1e3;return this._frameCallback?.(r),this.queue_draw(),t.SOURCE_REMOVE})),this.queue_draw(),0}installGlobals(){let e=globalThis;e.requestAnimationFrame=e=>this.requestAnimationFrame(e);let n=this._timeOrigin;e.performance={now:()=>(t.get_monotonic_time()-n)/1e3,timeOrigin:Date.now()}}});export{s as Canvas2DBridge};
+import"./_virtual/_rolldown/runtime.js";import e from"gi://GObject";import t from"gi://GLib?version=2.0";import n from"gi://Gtk?version=4.0";import{HTMLCanvasElement as r,notifyElementResize as i}from"@gjsify/dom-elements";import"@gjsify/dom-elements/register/canvas";import"@gjsify/canvas2d-core/gdk";import{attachEventControllers as a}from"@gjsify/event-bridge";import{Event as o}from"@gjsify/dom-events";const s=e.registerClass({GTypeName:`GjsifyCanvas2DBridge`},class Canvas2DBridge extends n.DrawingArea{constructor(e){super(e),this._canvas=null,this._ctx=null,this._readyCallbacks=[],this._resizeCallbacks=[],this._tickCallbackId=null,this._frameCallback=null,this._timeOrigin=t.get_monotonic_time(),this.set_draw_func(this._onDraw.bind(this)),a(this,()=>this._canvas,{captureKeys:!0}),this.connect(`unrealize`,()=>{this._tickCallbackId!==null&&(this.remove_tick_callback(this._tickCallbackId),this._tickCallbackId=null),this._ctx&&this._ctx._dispose(),this._canvas=null,this._ctx=null})}_onDraw(e,t,n,a){if(!this._canvas){if(this._canvas=new r,this._canvas.width=n,this._canvas.height=a,this._ctx=this._canvas.getContext(`2d`),this._ctx){for(let e of this._readyCallbacks)e(this._canvas,this._ctx);this._readyCallbacks=[]}}else if(this._canvas.width!==n||this._canvas.height!==a){this._canvas.width=n,this._canvas.height=a,this._canvas.dispatchEvent(new o(`resize`)),i(this._canvas,n,a);for(let e of this._resizeCallbacks)e(n,a)}if(this._ctx){let e=this._ctx._getSurface();t.setSourceSurface(e,0,0),t.paint()}}get canvas(){return this._canvas}getContext(e){return this._ctx}onReady(e){if(this._canvas&&this._ctx){e(this._canvas,this._ctx);return}this._readyCallbacks.push(e)}onResize(e){this._resizeCallbacks.push(e)}requestAnimationFrame(e){return this._frameCallback=e,this._tickCallbackId===null&&(this._tickCallbackId=this.add_tick_callback((e,n)=>{this._tickCallbackId=null;let r=(n.get_frame_time()-this._timeOrigin)/1e3;return this._frameCallback?.(r),this.queue_draw(),t.SOURCE_REMOVE})),this.queue_draw(),0}installGlobals(){let e=globalThis;e.requestAnimationFrame=e=>this.requestAnimationFrame(e);let n=this._timeOrigin;e.performance={now:()=>(t.get_monotonic_time()-n)/1e3,timeOrigin:Date.now()}}});export{s as Canvas2DBridge};

package/lib/esm/index.js

@@ -1 +1 @@
-import"./_virtual/_rolldown/runtime.js";import{Canvas2DBridge as e}from"./canvas2d-bridge.js";import{CanvasGradient as t,CanvasPattern as n,CanvasRenderingContext2D as r,CanvasRenderingContext2D as i,ImageData as a,ImageData as o,Path2D as s,Path2D as c,parseColor as l}from"@gjsify/canvas2d-core";import{HTMLCanvasElement as u}from"@gjsify/dom-elements";const d=Symbol.for(`gjsify_canvas2d_context`);u.registerContextFactory(`2d`,(e,t)=>{let n=e,r=n[d];if(r)return r;let a=new i(e,t);return n[d]=a,a}),Object.defineProperty(globalThis,`CanvasRenderingContext2D`,{value:i,writable:!0,configurable:!0}),Object.defineProperty(globalThis,`ImageData`,{value:o,writable:!0,configurable:!0}),Object.defineProperty(globalThis,`Path2D`,{value:c,writable:!0,configurable:!0});export{e as Canvas2DBridge,t as CanvasGradient,n as CanvasPattern,r as CanvasRenderingContext2D,a as ImageData,s as Path2D,l as parseColor};
+import{Canvas2DBridge as e}from"./canvas2d-bridge.js";import{CanvasGradient as t,CanvasPattern as n,CanvasRenderingContext2D as r,ImageData as i,Path2D as a,parseColor as o}from"@gjsify/canvas2d-core";export{e as Canvas2DBridge,t as CanvasGradient,n as CanvasPattern,r as CanvasRenderingContext2D,i as ImageData,a as Path2D,o as parseColor};

package/lib/esm/register.js

@@ -0,0 +1 @@
+import"./_virtual/_rolldown/runtime.js";import{ImageData as e,Path2D as t}from"@gjsify/canvas2d-core";import"@gjsify/dom-elements/register/canvas";function defineGlobalIfMissing(e,t){globalThis[e]===void 0&&Object.defineProperty(globalThis,e,{value:t,writable:!0,configurable:!0})}defineGlobalIfMissing(`ImageData`,e),defineGlobalIfMissing(`Path2D`,t);

package/lib/types/canvas2d-bridge.d.ts

@@ -4,6 +4,8 @@ import GLib from 'gi://GLib?version=2.0';
 import Gtk from 'gi://Gtk?version=4.0';
 import type Cairo from 'cairo';
 import { HTMLCanvasElement as GjsifyHTMLCanvasElement } from '@gjsify/dom-elements';
+import '@gjsify/dom-elements/register/canvas';
+import '@gjsify/canvas2d-core/gdk';
 import type { CanvasRenderingContext2D } from '@gjsify/canvas2d-core';
 type Canvas2DReadyCallback = (canvas: globalThis.HTMLCanvasElement, ctx: CanvasRenderingContext2D) => void;
 /**

package/lib/types/index.spec.d.ts

@@ -1,3 +1,3 @@
-import '@gjsify/canvas2d';
+import '@gjsify/dom-elements/register/canvas';
 declare const _default: () => Promise<void>;
 export default _default;

package/lib/types/register.d.ts

@@ -0,0 +1 @@
+import '@gjsify/dom-elements/register/canvas';

package/lib/types/register.spec.d.ts

@@ -0,0 +1,3 @@
+import '@gjsify/canvas2d/register';
+declare const _default: () => Promise<void>;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/canvas2d",
-    "version": "0.22.0",
+    "version": "0.23.0",
     "description": "Canvas 2D rendering context for GJS, backed by Cairo",
     "type": "module",
     "module": "lib/esm/index.js",
@@ -9,8 +9,15 @@
         ".": {
             "types": "./lib/types/index.d.ts",
             "default": "./lib/esm/index.js"
+        },
+        "./register": {
+            "types": "./lib/types/register.d.ts",
+            "default": "./lib/esm/register.js"
         }
     },
+    "sideEffects": [
+        "./lib/esm/register.js"
+    ],
     "files": [
         "lib"
     ],
@@ -40,15 +47,15 @@
         "@girs/gtk-4.0": "^4.1.0",
         "@girs/pango-1.0": "^4.1.0",
         "@girs/pangocairo-1.0": "^4.1.0",
-        "@gjsify/canvas2d-core": "^0.22.0",
-        "@gjsify/dom-elements": "^0.22.0",
-        "@gjsify/dom-events": "^0.22.0",
-        "@gjsify/event-bridge": "^0.22.0",
-        "@gjsify/utils": "^0.22.0"
+        "@gjsify/canvas2d-core": "^0.23.0",
+        "@gjsify/dom-elements": "^0.23.0",
+        "@gjsify/dom-events": "^0.23.0",
+        "@gjsify/event-bridge": "^0.23.0",
+        "@gjsify/utils": "^0.23.0"
     },
     "devDependencies": {
-        "@gjsify/cli": "^0.22.0",
-        "@gjsify/unit": "^0.22.0",
+        "@gjsify/cli": "^0.23.0",
+        "@gjsify/unit": "^0.23.0",
         "@types/node": "^25.9.2",
         "typescript": "^6.0.3"
     },