@octane-xplat/share 0.0.1 → 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Alec Larson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,3 +1,28 @@
-# @octane-xplat/share
+# `@octane-xplat/share`
 
-Version 0.0.1 is a reservation stub so the automated release can publish this package name. It has no supported API. Use a later release for the implementation.
+The platform share sheet for Octane xplat apps. iOS and Android run
+`@nativescript/social-share`; web calls `navigator.share` where it exists
+(mobile browsers, some desktop) and degrades to a clipboard copy elsewhere
+so the call still does something useful; macOS forwards the payload to the
+AppKit host, which presents `NSSharingServicePicker`.
+
+```sh
+pnpm add @octane-xplat/share
+```
+
+```ts
+import { share } from '@octane-xplat/share'
+
+const result = await share.text('Day 3 in Kyoto — 12km walked', 'Trip update')
+const link = await share.url('https://example.com/trips/42', 'My itinerary')
+```
+
+Both methods resolve a `ShareResult`: `'shared'` when the platform sheet
+completed, `'copied'` when the web fallback put it on the clipboard, and
+`'unavailable'` when no share path exists — branch on the result rather
+than catching.
+
+Guide: [Using device features](../../docs/platform-services.md);
+per-target availability: [platform notes](../../docs/platform-notes.md).
+Exercised by the harness `Services` screen
+([`packages/app/src/Services.tsrx`](../app/src/Services.tsrx)).

package/dist/native/index.js

@@ -0,0 +1,2 @@
+import { share } from "./index2.js";
+export { share };

package/dist/native/index2.js

@@ -0,0 +1,14 @@
+import { shareText, shareUrl } from "@nativescript/social-share";
+//#region src/share.ts
+var share = {
+	async text(text, subject) {
+		shareText(text, subject);
+		return "shared";
+	},
+	async url(url, title) {
+		shareUrl(url, title ?? url);
+		return "shared";
+	}
+};
+//#endregion
+export { share };

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

@@ -0,0 +1,8 @@
+{
+  "version": 1,
+  "buildId": "96b0e82b-a6c7-419f-9b3f-1367acdd7ba1",
+  "mode": "production",
+  "capabilities": {
+    "independentHydration": false
+  }
+}

package/dist/web/index.js

@@ -0,0 +1,2 @@
+import { share } from "./index5.js";
+export { share };

package/dist/web/index2.js

@@ -0,0 +1,18 @@
+//#region ../platform/src/host-bridge.web.ts
+/** Return the native message channel when this page is hosted by a desktop app. */
+function createWebKitTransport() {
+	if (typeof window === "undefined") return null;
+	const handler = window.webkit?.messageHandlers?.xplat;
+	const host = window.__xplatHostTransport;
+	if (!handler || !host) return null;
+	return {
+		postMessage(message) {
+			handler.postMessage(message);
+		},
+		listen(listener) {
+			return host.listen(listener);
+		}
+	};
+}
+//#endregion
+export { createWebKitTransport };

package/dist/web/index3.js

@@ -0,0 +1,73 @@
+//#region ../platform/src/host-protocol.ts
+/**
+* Create the webview-side client. Host methods are typed at compile time; this
+* deliberately does not add runtime schema validation.
+*/
+function createHostClient(transport) {
+	const pending = /* @__PURE__ */ new Map();
+	const listeners = /* @__PURE__ */ new Map();
+	let nextId = 0;
+	let disposed = false;
+	const removeListener = transport.listen((message) => {
+		const packet = JSON.parse(message);
+		if (packet.type === "reply") {
+			const task = pending.get(packet.id);
+			if (!task) return;
+			pending.delete(packet.id);
+			if (packet.ok) task.resolve(packet.value);
+			else task.reject(new Error(packet.error));
+			return;
+		}
+		for (const listener of listeners.get(packet.name) ?? []) listener(packet.payload);
+	});
+	const request = (value) => {
+		if (disposed) return Promise.reject(/* @__PURE__ */ new Error("desktop host client is disposed"));
+		const id = ++nextId;
+		const promise = new Promise((resolve, reject) => pending.set(id, {
+			resolve,
+			reject
+		}));
+		try {
+			transport.postMessage(JSON.stringify({
+				...value,
+				id
+			}));
+		} catch (error) {
+			const task = pending.get(id);
+			pending.delete(id);
+			task?.reject(error instanceof Error ? error : new Error(String(error)));
+		}
+		return promise;
+	};
+	return {
+		call: ((service, method, ...args) => request({
+			type: "call",
+			service,
+			method,
+			args
+		})),
+		capabilities() {
+			return request({ type: "capabilities" });
+		},
+		on(name, listener) {
+			const eventListeners = listeners.get(name) ?? /* @__PURE__ */ new Set();
+			const receive = listener;
+			eventListeners.add(receive);
+			listeners.set(name, eventListeners);
+			return () => {
+				eventListeners.delete(receive);
+				if (!eventListeners.size) listeners.delete(name);
+			};
+		},
+		dispose() {
+			if (disposed) return;
+			disposed = true;
+			removeListener();
+			listeners.clear();
+			for (const task of pending.values()) task.reject(/* @__PURE__ */ new Error("desktop host client is disposed"));
+			pending.clear();
+		}
+	};
+}
+//#endregion
+export { createHostClient };

package/dist/web/index4.js

@@ -0,0 +1,71 @@
+import { createWebKitTransport } from "./index2.js";
+import { createHostClient } from "./index3.js";
+//#region ../platform/src/host-runtime.web.ts
+var client;
+var capabilityTable;
+/** Return the native service client when this page is inside a desktop webview. */
+function desktopHostClient() {
+	if (client !== void 0) return client;
+	const transport = createWebKitTransport();
+	client = transport ? createHostClient(transport) : null;
+	return client;
+}
+function desktopHostSupports(service, method) {
+	const host = desktopHostClient();
+	if (!host) return Promise.resolve(false);
+	capabilityTable ??= host.capabilities().catch(() => ({}));
+	return capabilityTable.then((capabilities) => capabilities[service]?.includes(method) ?? false);
+}
+/** Typed desktop service facade; null outside a supported native webview. */
+function desktopHost() {
+	const host = desktopHostClient();
+	if (!host) return null;
+	return {
+		app: {
+			getInfo: () => host.call("app", "getInfo"),
+			getState: () => host.call("app", "getState"),
+			getWindowSize: () => host.call("app", "getWindowSize"),
+			consumeInitialUrl: () => host.call("app", "consumeInitialUrl")
+		},
+		clipboard: {
+			read: () => host.call("clipboard", "read"),
+			write: (value) => host.call("clipboard", "write", value)
+		},
+		files: {
+			pick: (accept, options) => host.call("files", "pick", accept, options),
+			readText: (uri) => host.call("files", "readText", uri),
+			writeText: (name, text) => host.call("files", "writeText", name, text)
+		},
+		notifications: {
+			ensure: () => host.call("notifications", "ensure"),
+			notify: (title, body) => host.call("notifications", "notify", title, body)
+		},
+		secureStorage: {
+			get: (key) => host.call("secureStorage", "get", key),
+			set: (key, value) => host.call("secureStorage", "set", key, value),
+			remove: (key) => host.call("secureStorage", "remove", key)
+		},
+		appearance: { get: () => host.call("appearance", "get") },
+		windows: {
+			open: (options) => host.call("windows", "open", options),
+			close: (id) => host.call("windows", "close", id),
+			setTitle: (id, title) => host.call("windows", "setTitle", id, title)
+		},
+		system: {
+			openUrl: (url) => host.call("system", "openUrl", url),
+			openPath: (path) => host.call("system", "openPath", path),
+			shareContent: (input) => host.call("system", "shareContent", input)
+		},
+		storage: {
+			get: (key) => host.call("storage", "get", key),
+			set: (key, value) => host.call("storage", "set", key, value),
+			remove: (key) => host.call("storage", "remove", key)
+		},
+		capabilities: () => host.capabilities(),
+		supports: desktopHostSupports,
+		on: (name, listener) => host.on(name, listener),
+		dispose: () => host.dispose()
+	};
+}
+//#endregion
+export { desktopHost, desktopHostClient, desktopHostSupports };

package/dist/web/index5.js

@@ -0,0 +1,46 @@
+import { desktopHost, desktopHostSupports } from "./index4.js";
+//#region src/share.web.ts
+var share = {
+	async text(text, subject) {
+		const host = desktopHost();
+		if (host && await desktopHostSupports("system", "shareContent")) return host.system.shareContent({
+			text,
+			title: subject
+		});
+		const nav = navigator;
+		if (nav.share) {
+			await nav.share({
+				text,
+				title: subject
+			});
+			return "shared";
+		}
+		if (nav.clipboard) {
+			await nav.clipboard.writeText(text);
+			return "copied";
+		}
+		return "unavailable";
+	},
+	async url(url, title) {
+		const host = desktopHost();
+		if (host && await desktopHostSupports("system", "shareContent")) return host.system.shareContent({
+			url,
+			title
+		});
+		const nav = navigator;
+		if (nav.share) {
+			await nav.share({
+				url,
+				title
+			});
+			return "shared";
+		}
+		if (nav.clipboard) {
+			await nav.clipboard.writeText(url);
+			return "copied";
+		}
+		return "unavailable";
+	}
+};
+//#endregion
+export { share };

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

@@ -0,0 +1,8 @@
+{
+  "version": 1,
+  "buildId": "c1d8f637-9ae8-477f-8b6b-89c3da1bfe88",
+  "mode": "production",
+  "capabilities": {
+    "independentHydration": false
+  }
+}

package/package.json

@@ -1,19 +1,92 @@
 {
   "name": "@octane-xplat/share",
-  "version": "0.0.1",
+  "version": "0.9.0",
   "description": "Native share sheet for Octane xplat — matching web + NativeScript + AppKit implementations",
+  "keywords": [
+    "android",
+    "cross-platform",
+    "ios",
+    "macos",
+    "nativescript",
+    "octane",
+    "share",
+    "share-sheet",
+    "social-share",
+    "web",
+    "xplat"
+  ],
+  "homepage": "https://github.com/octane-xplat/octane-xplat/tree/main/packages/share",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/octane-xplat/octane-xplat.git",
+    "url": "https://github.com/octane-xplat/octane-xplat",
     "directory": "packages/share"
   },
-  "homepage": "https://github.com/octane-xplat/octane-xplat/tree/main/packages/share",
-  "main": "./index.js",
-  "types": "./index.d.ts",
   "files": [
-    "README.md",
-    "index.js",
-    "index.d.ts"
-  ]
-}
+    "dist",
+    "types",
+    "src"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "macos": {
+        "types": "./types/index.macos.d.ts",
+        "default": "./src/index.macos.ts"
+      },
+      "web": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/web/index.js"
+      },
+      "native": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/native/index.js"
+      },
+      "types": "./types/index.d.ts",
+      "default": "./dist/native/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nativescript/social-share": "2.3.0",
+    "@octane-xplat/platform": "0.9.0"
+  },
+  "devDependencies": {
+    "@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"
+  },
+  "peerDependencies": {
+    "@nativescript-community/octane": ">=0.2.1 <1",
+    "@nativescript/core": ">=9.1.0 <10",
+    "octane": ">=0.6.3 <1"
+  },
+  "peerDependenciesMeta": {
+    "@nativescript-community/octane": {
+      "optional": true
+    },
+    "@nativescript/core": {
+      "optional": true
+    },
+    "octane": {
+      "optional": true
+    }
+  },
+  "nativescript": {
+    "platforms": {
+      "android": "9.1.0",
+      "ios": "9.1.0"
+    }
+  },
+  "scripts": {
+    "build": "vite build && vite build --mode native && tsc -p tsconfig.types.json && node ../../scripts/check-native-dist.mjs",
+    "test:packed": "node tests/packed-consumer.mjs",
+    "pack:check": "tsrx-typegen --pack-check"
+  }
+}

package/src/index.macos.ts

@@ -0,0 +1,2 @@
+export * from './types'
+export { share } from './share.macos'

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './types'
+export { share } from './share'

package/src/index.web.ts

@@ -0,0 +1,2 @@
+export * from './types'
+export { share } from './share.web'

package/src/share.macos.ts

@@ -0,0 +1,15 @@
+// Share — AppKit host leaf. The macOS host owns the window and presents
+// NSSharingServicePicker itself; this leaf only forwards the payload through
+// the __xplatAppKit seam.
+import type { ShareResult } from './types'
+
+const host = () => (globalThis as any).__xplatAppKit ?? {}
+
+export const share = {
+	async text(text: string): Promise<ShareResult> {
+		return host().shareContent?.({ text }) ?? 'unavailable'
+	},
+	async url(url: string, title?: string): Promise<ShareResult> {
+		return host().shareContent?.({ url, title }) ?? 'unavailable'
+	},
+}

package/src/share.ts

@@ -0,0 +1,13 @@
+// Share — native share sheet via @nativescript/social-share.
+import { shareText, shareUrl } from '@nativescript/social-share'
+
+export const share = {
+	async text(text: string, subject?: string): Promise<'shared'> {
+		shareText(text, subject)
+		return 'shared'
+	},
+	async url(url: string, title?: string): Promise<'shared'> {
+		shareUrl(url, title ?? url)
+		return 'shared'
+	},
+}

package/src/share.web.ts

@@ -0,0 +1,44 @@
+// Share — web leaf. navigator.share where present (mobile Safari/Chrome);
+// desktop degrades to clipboard copy so the call still does something useful.
+import { desktopHost, desktopHostSupports } from '@octane-xplat/platform/host/web'
+
+export const share = {
+	async text(text: string, subject?: string): Promise<'shared' | 'copied' | 'unavailable'> {
+		const host = desktopHost()
+		if (host && (await desktopHostSupports('system', 'shareContent'))) {
+			return host.system.shareContent({ text, title: subject })
+		}
+
+		const nav = navigator as any
+		if (nav.share) {
+			await nav.share({ text, title: subject })
+			return 'shared'
+		}
+
+		if (nav.clipboard) {
+			await nav.clipboard.writeText(text)
+			return 'copied'
+		}
+
+		return 'unavailable'
+	},
+	async url(url: string, title?: string): Promise<'shared' | 'copied' | 'unavailable'> {
+		const host = desktopHost()
+		if (host && (await desktopHostSupports('system', 'shareContent'))) {
+			return host.system.shareContent({ url, title })
+		}
+
+		const nav = navigator as any
+		if (nav.share) {
+			await nav.share({ url, title })
+			return 'shared'
+		}
+
+		if (nav.clipboard) {
+			await nav.clipboard.writeText(url)
+			return 'copied'
+		}
+
+		return 'unavailable'
+	},
+}

package/src/types.ts

@@ -0,0 +1,10 @@
+export type ShareResult = 'shared' | 'copied' | 'unavailable'
+
+export interface Share {
+	/** Present the platform share sheet with text. */
+	text(text: string, subject?: string): Promise<ShareResult>
+	/** Present the platform share sheet with a URL. */
+	url(url: string, title?: string): Promise<ShareResult>
+}
+
+export declare const share: Share

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js'

package/types/index.macos.d.ts

@@ -0,0 +1,5 @@
+import type { Share, ShareResult } from './types.js'
+
+export type { Share, ShareResult } from './types.js'
+
+export declare const share: Share

package/types/types.d.ts

@@ -0,0 +1,8 @@
+export type ShareResult = 'shared' | 'copied' | 'unavailable';
+export interface Share {
+    /** Present the platform share sheet with text. */
+    text(text: string, subject?: string): Promise<ShareResult>;
+    /** Present the platform share sheet with a URL. */
+    url(url: string, title?: string): Promise<ShareResult>;
+}
+export declare const share: Share;

package/index.d.ts

@@ -1 +0,0 @@
-export {}

package/index.js

@@ -1,2 +0,0 @@
-// Reservation stub; implementation will arrive in a later release.
-module.exports = {}