@octane-xplat/canvas 0.7.3 → 0.9.0

package/README.md

@@ -0,0 +1,32 @@
+# `@octane-xplat/canvas`
+
+A GPU/canvas surface for Octane xplat apps: the DOM `<canvas>` on web and
+`@nativescript/canvas` on iOS/Android — 2D, WebGL/WebGL2, and
+WebGPU/WGSL context kinds behind one `getContext` contract.
+
+```sh
+pnpm add @octane-xplat/canvas
+```
+
+```tsx
+import { Canvas, getGPU } from '@octane-xplat/canvas'
+
+;<Canvas
+	context="webgl"
+	width={640} // numeric size = drawing-buffer/dip size, not display size
+	height={480}
+	onReady={({ canvas, context }) => {
+		// context is null when that kind is unavailable on this target
+	}}
+/>
+```
+
+Pass `context` to have the leaf resolve it before `onReady`, or omit it and
+call `getContext` yourself — one kind per canvas, decided on first call.
+`onReady` fires after mount on web and on the plugin's `ready` event on
+native (earlier `getContext` calls can return null). For WebGPU,
+`getGPU()` normalizes adapter/device acquisition across targets.
+
+Per-target limits are recorded in
+[known limits](../../docs/known-limits.md). Exercised by
+[`CanvasDemo`](../demos/src/CanvasDemo.tsrx) (including a WGSL path).

package/dist/native/octane-client-build.json

@@ -1,6 +1,6 @@
 {
   "version": 1,
-  "buildId": "52898de3-47ca-49b9-afa9-cd2f6663022d",
+  "buildId": "e47818f6-941f-444d-a9f5-bc088c04955c",
   "mode": "production",
   "capabilities": {
     "independentHydration": false

package/dist/web/octane-client-build.json

@@ -1,6 +1,6 @@
 {
   "version": 1,
-  "buildId": "708787e6-81a1-49bc-a39c-d2481b54b95c",
+  "buildId": "41f644fb-4d8e-4f30-9e04-959bb6263619",
   "mode": "production",
   "capabilities": {
     "independentHydration": false

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@octane-xplat/canvas",
-  "version": "0.7.3",
+  "version": "0.9.0",
   "description": "Canvas/GPU surface for Octane xplat — web <canvas> + @nativescript/canvas (2D, WebGL/WebGL2, WebGPU/WGSL)",
   "keywords": [
-    "octane",
-    "xplat",
-    "cross-platform",
     "canvas",
+    "cross-platform",
+    "gpu",
+    "graphics",
+    "nativescript",
+    "octane",
     "webgl",
     "webgl2",
     "webgpu",
     "wgsl",
-    "gpu",
-    "graphics",
-    "nativescript"
+    "xplat"
   ],
-  "license": "MIT",
   "homepage": "https://github.com/octane-xplat/octane-xplat/tree/main/packages/canvas",
+  "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/octane-xplat/octane-xplat.git",
+    "url": "https://github.com/octane-xplat/octane-xplat",
     "directory": "packages/canvas"
   },
   "files": [
@@ -43,10 +43,11 @@
     "@nativescript/canvas": "3.0.0-alpha.15"
   },
   "devDependencies": {
-    "@nativescript-community/octane": "0.2.1",
+    "@nativescript-community/octane": "0.2.4",
     "@nativescript/core": "9.1.2",
     "@octanejs/vite-plugin": "0.1.61",
     "octane": "0.6.3",
+    "tsrx-typegen": "0.2.1",
     "typescript": "5.9.3",
     "vite": "8.3.0"
   },
@@ -64,6 +65,9 @@
     }
   },
   "scripts": {
-    "build": "vite build && vite build --mode native && tsc -p tsconfig.types.json && node ../../scripts/check-native-dist.mjs"
+    "build": "vite build && vite build --mode native && pnpm typegen && node ../../scripts/check-native-dist.mjs",
+    "typegen": "tsc -p tsconfig.types.json",
+    "test:packed": "node tests/packed-consumer.mjs",
+    "pack:check": "tsrx-typegen --pack-check"
   }
 }

package/src/gpu.ts

@@ -1,8 +1,8 @@
-import { GPU } from '@nativescript/canvas';
+import { GPU } from '@nativescript/canvas'
 
 /** getGPU — returns the plugin's GPU shim (wgpu over Metal/Vulkan). Same
  *  spec-shaped surface as web's `navigator.gpu`: `requestAdapter()` +
  *  `getPreferredCanvasFormat()`. */
 export function getGPU(): any {
-	return new GPU();
+	return new GPU()
 }

package/src/gpu.web.ts

@@ -3,5 +3,5 @@
  *  returned object is spec-shaped: `requestAdapter()` +
  *  `getPreferredCanvasFormat()`. */
 export function getGPU(): any {
-	return (globalThis.navigator as any)?.gpu ?? null;
+	return (globalThis.navigator as any)?.gpu ?? null
 }

package/src/index.ts

@@ -1,5 +1,5 @@
 // Platform barrels — explicit .tsrx leaf imports (moduleSuffixes don't
 // reach .tsrx; same convention as @octane-xplat/ui index.*.ts).
-export { Canvas } from './Canvas.tsrx';
-export { getGPU } from './gpu';
-export type { CanvasProps, CanvasContextKind, CanvasReady } from './props';
+export { Canvas } from './Canvas.tsrx'
+export { getGPU } from './gpu'
+export type { CanvasProps, CanvasContextKind, CanvasReady } from './props'

package/src/index.web.ts

@@ -1,5 +1,5 @@
 // Platform barrels — explicit .tsrx leaf imports (moduleSuffixes don't
 // reach .tsrx; same convention as @octane-xplat/ui index.*.ts).
-export { Canvas } from './Canvas.web.tsrx';
-export { getGPU } from './gpu.web';
-export type { CanvasProps, CanvasContextKind, CanvasReady } from './props';
+export { Canvas } from './Canvas.web.tsrx'
+export { getGPU } from './gpu.web'
+export type { CanvasProps, CanvasContextKind, CanvasReady } from './props'

package/src/props.ts

@@ -1,33 +1,28 @@
-export type CanvasContextKind =
-	| '2d'
-	| 'webgl'
-	| 'webgl2'
-	| 'webgpu'
-	| 'bitmaprenderer';
+export type CanvasContextKind = '2d' | 'webgl' | 'webgl2' | 'webgpu' | 'bitmaprenderer'
 
 export interface CanvasReady {
 	/** HTMLCanvasElement on web, the plugin's Canvas view on native —
 	 *  both expose `getContext()`. */
-	canvas: any;
+	canvas: any
 	/** The resolved context for the `context` prop, or null when that
 	 *  kind is unsupported/unavailable. WebGPU still needs a device —
 	 *  `getGPU()` normalizes adapter/device acquisition. */
-	context: any;
+	context: any
 }
 
 export interface CanvasProps {
-	className?: any;
-	style?: any;
-	id?: string;
+	className?: any
+	style?: any
+	id?: string
 	/** Context kind resolved before `onReady` fires. Omit to defer
 	 *  `getContext` to user code (only one kind per canvas — call once). */
-	context?: CanvasContextKind;
+	context?: CanvasContextKind
 	/** Web: after mount. Native: the plugin's `ready` event (fires when the
 	 *  GPU surface exists — earlier `getContext` calls can return null). */
-	onReady?: (ready: CanvasReady) => void;
+	onReady?: (ready: CanvasReady) => void
 	/** Numeric values map to the element's width/height — on web that is
 	 *  the canvas *drawing buffer* size (pair with style for display
 	 *  size), on native dip size. */
-	width?: string | number;
-	height?: string | number;
+	width?: string | number
+	height?: string | number
 }

package/types/index.d.ts

@@ -2,7 +2,7 @@
 // props.ts (tsrx-tsc can't emit .tsrx declarations; see ui/types/index.d.ts
 // for the same pattern).
 import type { UniversalComponent } from 'octane/universal'
-import type { CanvasProps } from './props'
+import type { CanvasProps } from './props.js'
 
 export declare const Canvas: UniversalComponent<CanvasProps>
 
@@ -10,4 +10,4 @@ export declare const Canvas: UniversalComponent<CanvasProps>
  *  GPU shim on native — or null where WebGPU is unavailable. */
 export declare function getGPU(): any
 
-export type { CanvasProps, CanvasContextKind, CanvasReady } from './props'
+export type { CanvasProps, CanvasContextKind, CanvasReady } from './props.js'