@octane-xplat/gif 0.14.0 → 0.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octane-xplat/gif",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Animated images (GIF/animated webp) for Octane xplat — web <img> + @nativescript-community/ui-image",
   "keywords": [
     "android",
@@ -23,9 +23,10 @@
     "directory": "packages/gif"
   },
   "files": [
-    "dist",
     "types",
-    "src"
+    "src",
+    "!src/**/*.test.*",
+    "!src/**/*.spec.*"
   ],
   "type": "module",
   "exports": {
@@ -36,14 +37,14 @@
       },
       "web": {
         "types": "./types/generated/index.web.d.ts",
-        "default": "./dist/web/index.js"
+        "default": "./src/index.web.ts"
       },
       "native": {
         "types": "./types/generated/index.d.ts",
-        "default": "./dist/native/index.js"
+        "default": "./src/index.ts"
       },
       "types": "./types/generated/index.d.ts",
-      "default": "./dist/native/index.js"
+      "default": "./src/index.ts"
     }
   },
   "publishConfig": {
@@ -53,12 +54,13 @@
     "@nativescript-community/ui-image": "4.6.20"
   },
   "devDependencies": {
-    "@nativescript-community/octane": "0.2.4",
+    "@nativescript-community/octane": "0.2.5",
     "@nativescript/core": "9.1.3",
+    "@octane-xplat/macos-renderer": "0.15.0",
     "@octanejs/vite-plugin": "0.1.61",
     "@tsrx/typescript-plugin": "0.4.11",
     "octane": "0.11.0",
-    "tsrx-typegen": "0.2.2",
+    "tsrx-typegen": "0.3.0",
     "typescript": "5.9.3",
     "vite": "8.3.0"
   },
@@ -76,7 +78,6 @@
     }
   },
   "scripts": {
-    "build": "vite build && vite build --mode native && pnpm typegen && node ../../scripts/check-native-dist.mjs",
     "test:packed": "node tests/packed-consumer.mjs",
     "typegen": "tsrx-typegen --target octane",
     "pack:check": "tsrx-typegen --pack-check"

package/src/AnimatedImage.windows.tsrx

@@ -0,0 +1,8 @@
+/** @jsxImportSource @nativescript-community/octane */
+import type { AnimatedImageProps } from './props'
+
+/** Unsupported placeholder — the Windows host has no animated-image engine
+ *  (ui-image ships iOS/Android only). */
+export function AnimatedImage(_props: AnimatedImageProps) @{
+	<label className="vx-unsupported" text="Animated images are unsupported on the Windows host" />
+}

package/src/index.windows.ts

@@ -0,0 +1,5 @@
+// Windows barrel — explicit leaf imports keep @nativescript-community/
+// ui-image (iOS/Android only) out of the windows graph at the file boundary.
+export { AnimatedImage } from './AnimatedImage.windows.tsrx'
+export { prefetch } from './prefetch.windows'
+export type { AnimatedImageProps, PrefetchOptions } from './props'

package/src/prefetch-batch.ts

@@ -1,4 +1,4 @@
-/** VENDORED — identical copy in packages/gif/src/prefetch-batch.ts; keep in
+/** VENDORED — identical copy in packages/image/src/prefetch-batch.ts; keep in
  *  sync.
  *
  *  Shared batch driver for the image-engine leaves' `prefetch` contract:
@@ -26,16 +26,21 @@ export function prefetchBatch(
 	return new Promise<boolean>((resolve) => {
 		let next = 0
 		let active = Math.min(limit, urls.length)
+		// Surviving workers stop dequeuing once a failure decides the result —
+		// only already-running warm() calls settle on their own.
+		let failed = false
 		for (let i = 0; i < active; i++) {
 			void (async () => {
-				while (next < urls.length) {
+				while (!failed && next < urls.length) {
 					const url = urls[next++]
 					try {
 						if (!(await warm(url))) {
+							failed = true
 							resolve(false)
 							return
 						}
 					} catch {
+						failed = true
 						resolve(false)
 						return
 					}

package/src/prefetch.windows.ts

@@ -0,0 +1,8 @@
+import type { PrefetchOptions } from './props'
+
+/** prefetch — no-op on Windows: there is no image pipeline to warm
+ *  (AnimatedImage renders a placeholder there). Resolves false to report
+ *  that honestly. */
+export function prefetch(_srcs: string | string[], _options?: PrefetchOptions): Promise<boolean> {
+	return Promise.resolve(false)
+}

package/types/generated/.tsrx-typegen-manifest.json

@@ -7,6 +7,7 @@
     "escape-props.web.d.ts",
     "index.d.ts",
     "index.web.d.ts",
+    "native-elements.d.ts",
     "prefetch-batch.d.ts",
     "prefetch.d.ts",
     "prefetch.web.d.ts",

package/types/generated/native-elements.d.ts

@@ -0,0 +1,8 @@
+import { Img } from '@nativescript-community/ui-image'
+import type { Attributes } from '@nativescript-community/octane/intrinsics'
+
+declare module '@nativescript-community/octane/intrinsics' {
+	interface NativeScriptElements {
+		animatedimage: Attributes<typeof Img>
+	}
+}

package/types/generated/prefetch-batch.d.ts

@@ -1,4 +1,4 @@
-/** VENDORED — identical copy in packages/gif/src/prefetch-batch.ts; keep in
+/** VENDORED — identical copy in packages/image/src/prefetch-batch.ts; keep in
  *  sync.
  *
  *  Shared batch driver for the image-engine leaves' `prefetch` contract:

package/types/index.macos.d.ts

@@ -2,4 +2,7 @@ import type { AnimatedImageProps, PrefetchOptions } from './generated/props.js'
 
 export type { AnimatedImageProps, PrefetchOptions } from './generated/props.js'
 export declare function AnimatedImage(props: AnimatedImageProps): unknown
-export declare function prefetch(srcs: string | string[], options?: PrefetchOptions): Promise<boolean>
+export declare function prefetch(
+	srcs: string | string[],
+	options?: PrefetchOptions,
+): Promise<boolean>

package/dist/native/AnimatedImage.tsrx.js

@@ -1,39 +0,0 @@
-import { applyEscapeProps } from "./escape-props.js";
-import { defineUniversalComponent, registerElement, universalPlan, universalValue } from "@nativescript-community/octane";
-import { Img } from "@nativescript-community/ui-image";
-//#region src/AnimatedImage.tsrx
-var __octaneUniversalPlan0 = universalPlan("nativescript", {
-	"kind": "host",
-	"type": "animatedimage",
-	"props": {
-		"animatedImageView": true,
-		"autoPlayAnimations": true
-	},
-	"bindings": [
-		["ref", 0],
-		["id", 1],
-		["className", 2],
-		["style", 3],
-		["src", 4],
-		["stretch", 5],
-		["width", 6],
-		["height", 7],
-		["accessibilityLabel", 8]
-	]
-});
-registerElement("animatedimage", Img);
-var AnimatedImage = defineUniversalComponent("nativescript", function AnimatedImage(props) {
-	return universalValue(__octaneUniversalPlan0, [
-		(v) => applyEscapeProps(v, props),
-		props.id,
-		props.className,
-		props.style,
-		props.src,
-		props.stretch ?? "aspectFit",
-		props.width,
-		props.height,
-		props.alt
-	]);
-}, { "module": "@nativescript-community/octane" });
-//#endregion
-export { AnimatedImage };

package/dist/native/escape-props.js

@@ -1,12 +0,0 @@
-import { isAndroid, isIOS } from "@nativescript/core";
-//#region src/escape-props.ts
-/** Apply only the active device's escape bag after the shared props — the
-*  same convention @octane-xplat/ui uses, kept local so this leaf does not
-*  depend on ui. */
-function applyEscapeProps(view, props) {
-	if (!view) return;
-	const bag = isIOS ? props.ios : isAndroid ? props.android : void 0;
-	if (bag) Object.assign(view, bag);
-}
-//#endregion
-export { applyEscapeProps };

package/dist/native/index.js

@@ -1,3 +0,0 @@
-import { AnimatedImage } from "./AnimatedImage.tsrx.js";
-import { prefetch } from "./prefetch.js";
-export { AnimatedImage, prefetch };

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

@@ -1,8 +0,0 @@
-{
-  "version": 1,
-  "buildId": "9f62df29-bdd1-4368-8975-9d9c629a99bd",
-  "mode": "production",
-  "capabilities": {
-    "independentHydration": false
-  }
-}

package/dist/native/prefetch-batch.js

@@ -1,27 +0,0 @@
-function prefetchBatch(srcs, concurrency, warm) {
-	const urls = Array.isArray(srcs) ? srcs : [srcs];
-	if (urls.length === 0) return Promise.resolve(true);
-	const requested = Math.floor(concurrency ?? 5);
-	const limit = Number.isFinite(requested) && requested > 0 ? requested : 5;
-	return new Promise((resolve) => {
-		let next = 0;
-		let active = Math.min(limit, urls.length);
-		for (let i = 0; i < active; i++) (async () => {
-			while (next < urls.length) {
-				const url = urls[next++];
-				try {
-					if (!await warm(url)) {
-						resolve(false);
-						return;
-					}
-				} catch {
-					resolve(false);
-					return;
-				}
-			}
-			if (--active === 0) resolve(true);
-		})();
-	});
-}
-//#endregion
-export { prefetchBatch };

package/dist/native/prefetch.js

@@ -1,26 +0,0 @@
-import { prefetchBatch } from "./prefetch-batch.js";
-import { getImagePipeline, initialize } from "@nativescript-community/ui-image";
-import { isAndroid } from "@nativescript/core";
-//#region src/prefetch.ts
-/** prefetch — warm the image engine's disk cache for `srcs` without displaying
-*  anything. Android (Fresco): `prefetchToDiskCache` stores encoded bytes on
-*  disk and defers bitmap decode to display. iOS (SDWebImage): the prefetcher
-*  stores the downloaded image to the disk cache only. Either way a later
-*  `AnimatedImage` with the same src hits disk instead of the network.
-*  Resolves false when any URL fails; resolves false when the pipeline is not
-*  available yet (e.g. called before app launch).
-*  `options.concurrency` caps parallel fetches (default 5); `options.headers`
-*  is honored on Android and silently dropped on iOS (upstream gap — see
-*  PrefetchOptions). */
-function prefetch(srcs, options) {
-	try {
-		if (isAndroid) initialize();
-		const pipeline = getImagePipeline();
-		const { concurrency, ...engineOptions } = options ?? {};
-		return prefetchBatch(srcs, concurrency, (url) => pipeline.prefetchToDiskCache(url, engineOptions).then(() => true, () => false));
-	} catch {
-		return Promise.resolve(false);
-	}
-}
-//#endregion
-export { prefetch };

package/dist/web/AnimatedImage.web.tsrx.js

@@ -1,48 +0,0 @@
-import { applyEscapeProps } from "./escape-props.web.js";
-import { __s, bag7, clone, queueRefAttach, queueRefDetach, setStyle, template } from "octane";
-import { replaceRef, setClassNameIfChanged, setPlainAttributeIfChanged, setURLAttributeIfChanged } from "octane/internal/client";
-//#region src/AnimatedImage.web.tsrx
-var _t$0 = /* @__PURE__ */ template("<img/>");
-var _rm$0 = [
-	"r",
-	"b",
-	"a"
-];
-var OBJECT_FIT = {
-	none: "none",
-	fill: "fill",
-	aspectFit: "contain",
-	aspectFill: "cover"
-};
-var AnimatedImage = /* @__PURE__ */ __s(function AnimatedImage(props, __s, __extra) {
-	let _b = __s.slots[0];
-	if (_b === void 0) {
-		let _m1;
-		const _root = clone(_t$0);
-		queueRefAttach(__s, _m1 = (e) => applyEscapeProps(e, props), _root);
-		(__s.cleanups ??= []).push(() => _b && queueRefDetach(_b.b, _b.a));
-		_b = bag7(__s, _root, _root, _m1);
-		__s.refFields = _rm$0;
-	} else {
-		const _r = (e) => applyEscapeProps(e, props);
-		if (_r !== _b.b) _b.b = replaceRef(__s, _b.b, _r, _b.a);
-	}
-	_b.c = setPlainAttributeIfChanged(props.id, _b.c, _b.a, "id");
-	_b.d = setClassNameIfChanged(props.className, _b.d, _b.a);
-	{
-		const _v = {
-			objectFit: OBJECT_FIT[props.stretch ?? "aspectFit"],
-			width: props.width,
-			height: props.height,
-			...props.style
-		};
-		if (_b.e !== _v) {
-			setStyle(_b.a, _v, _b.e);
-			_b.e = _v;
-		}
-	}
-	_b.f = setURLAttributeIfChanged(props.src, _b.f, _b.a, "src");
-	_b.g = setPlainAttributeIfChanged(props.alt, _b.g, _b.a, "alt");
-});
-//#endregion
-export { AnimatedImage };

package/dist/web/escape-props.web.js

@@ -1,18 +0,0 @@
-//#region src/escape-props.web.ts
-/** Apply DOM escape props after the primitive's own props. Dash-named keys
-*  are attributes; other keys use the DOM property where available. Mirrors
-*  @octane-xplat/ui's web escape-props so this leaf does not depend on ui. */
-function applyEscapeProps(element, props) {
-	if (!element || !props.web) return;
-	for (const [key, value] of Object.entries(props.web)) if (key.includes("-")) {
-		if (value == null || value === false) element.removeAttribute(key);
-		else element.setAttribute(key, value === true ? "" : String(value));
-	} else if (key in element) try {
-		element[key] = value;
-	} catch {
-		element.setAttribute(key, String(value));
-	}
-	else if (value != null) element.setAttribute(key, String(value));
-}
-//#endregion
-export { applyEscapeProps };

package/dist/web/index.js

@@ -1,3 +0,0 @@
-import { AnimatedImage } from "./AnimatedImage.web.tsrx.js";
-import { prefetch } from "./prefetch.web.js";
-export { AnimatedImage, prefetch };

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

@@ -1,8 +0,0 @@
-{
-  "version": 1,
-  "buildId": "9a9ed12d-3da2-4093-be31-7902d623df05",
-  "mode": "production",
-  "capabilities": {
-    "independentHydration": false
-  }
-}

package/dist/web/prefetch-batch.js

@@ -1,27 +0,0 @@
-function prefetchBatch(srcs, concurrency, warm) {
-	const urls = Array.isArray(srcs) ? srcs : [srcs];
-	if (urls.length === 0) return Promise.resolve(true);
-	const requested = Math.floor(concurrency ?? 5);
-	const limit = Number.isFinite(requested) && requested > 0 ? requested : 5;
-	return new Promise((resolve) => {
-		let next = 0;
-		let active = Math.min(limit, urls.length);
-		for (let i = 0; i < active; i++) (async () => {
-			while (next < urls.length) {
-				const url = urls[next++];
-				try {
-					if (!await warm(url)) {
-						resolve(false);
-						return;
-					}
-				} catch {
-					resolve(false);
-					return;
-				}
-			}
-			if (--active === 0) resolve(true);
-		})();
-	});
-}
-//#endregion
-export { prefetchBatch };

package/dist/web/prefetch.web.js

@@ -1,17 +0,0 @@
-import { prefetchBatch } from "./prefetch-batch.js";
-//#region src/prefetch.web.ts
-/** prefetch — load each `src` through a throwaway <img> so the response lands
-*  in the browser HTTP cache; decode and render stay with the displaying
-*  element. `options.headers` is ignored — an <img> request cannot carry
-*  custom headers. `options.concurrency` caps parallel loads (default 5).
-*  Resolves false when any URL fails. */
-function prefetch(srcs, options) {
-	return prefetchBatch(srcs, options?.concurrency, (url) => new Promise((resolve) => {
-		const image = new Image();
-		image.onload = () => resolve(true);
-		image.onerror = () => resolve(false);
-		image.src = url;
-	}));
-}
-//#endregion
-export { prefetch };

package/src/prefetch.web.test.ts

@@ -1,104 +0,0 @@
-import { afterEach, describe, expect, it, vi } from 'vitest'
-import { prefetch } from './prefetch.web'
-import { prefetchBatch } from './prefetch-batch'
-
-// Same web prefetch contract as @octane-xplat/image: throwaway <img> per URL,
-// awaited until load/error, false when any URL fails, JS-side concurrency cap.
-
-class MockImage {
-	static instances: MockImage[] = []
-	onload: (() => void) | null = null
-	onerror: (() => void) | null = null
-	set src(_url: string) {
-		MockImage.instances.push(this)
-	}
-	load() {
-		this.onload?.()
-	}
-	fail() {
-		this.onerror?.()
-	}
-}
-
-const flush = () => new Promise((resolve) => setTimeout(resolve, 0))
-
-async function drainPending(promise: Promise<boolean>) {
-	let result: boolean | undefined
-	void promise.then((value) => {
-		result = value
-	})
-
-	while (result === undefined) {
-		for (const image of MockImage.instances.splice(0)) {
-			image.load()
-		}
-
-		await flush()
-	}
-
-	return result
-}
-
-describe('prefetch (web)', () => {
-	afterEach(() => {
-		MockImage.instances = []
-		vi.unstubAllGlobals()
-	})
-
-	it('resolves true only after every <img> fires load', async () => {
-		vi.stubGlobal('Image', MockImage)
-		const promise = prefetch(['https://x/a.gif', 'https://x/b.gif'])
-		let settled = false
-		void promise.then(() => {
-			settled = true
-		})
-
-		await flush()
-		expect(settled).toBe(false)
-		expect(await drainPending(promise)).toBe(true)
-	})
-
-	it('resolves false when any URL fails', async () => {
-		vi.stubGlobal('Image', MockImage)
-		const promise = prefetch(['https://x/a.gif', 'https://x/b.gif'])
-		const [failed] = MockImage.instances.splice(0)
-		failed.fail()
-		expect(await promise).toBe(false)
-	})
-
-	it('accepts a single URL and resolves true for an empty batch', async () => {
-		vi.stubGlobal('Image', MockImage)
-		expect(await prefetch([])).toBe(true)
-		const promise = prefetch('https://x/a.gif')
-		expect(MockImage.instances).toHaveLength(1)
-		expect(await drainPending(promise)).toBe(true)
-	})
-
-	it('caps in-flight loads at options.concurrency', async () => {
-		vi.stubGlobal('Image', MockImage)
-		const promise = prefetch(
-			Array.from({ length: 7 }, (_, i) => `https://x/${i}.gif`),
-			{ concurrency: 2, headers: { Authorization: 'Bearer x' } },
-		)
-
-		expect(MockImage.instances).toHaveLength(2)
-		MockImage.instances.splice(0).forEach((image) => image.load())
-		await flush()
-		await flush()
-		expect(MockImage.instances.length).toBeLessThanOrEqual(2)
-		expect(await drainPending(promise)).toBe(true)
-	})
-
-	it('defaults to five parallel loads', async () => {
-		vi.stubGlobal('Image', MockImage)
-		const promise = prefetch(Array.from({ length: 9 }, (_, i) => `https://x/${i}.gif`))
-		expect(MockImage.instances).toHaveLength(5)
-		expect(await drainPending(promise)).toBe(true)
-	})
-})
-
-describe('prefetchBatch', () => {
-	it('reports false if the warm callback throws', async () => {
-		expect(await prefetchBatch(['a', 'b'], 5, () => Promise.reject(new Error('boom')))).toBe(false)
-	})
-})