@octane-xplat/workshop 0.1.0 → 0.15.0

package/src/mobile-node.mjs

@@ -0,0 +1,126 @@
+import { createRequire } from 'node:module'
+import { existsSync, readFileSync } from 'node:fs'
+import { dirname, join, resolve } from 'node:path'
+import { spawn } from 'node:child_process'
+
+const CONFIGS = [
+	'vite.config.native.mts',
+	'vite.config.native.ts',
+	'vite.config.mts',
+	'vite.config.ts',
+	'vite.config.mjs',
+]
+
+export function mobilePrerequisites(root, target, host = process.platform, env = process.env) {
+	const req = createRequire(join(root, 'package.json'))
+	const installed = (name) => {
+		try {
+			req.resolve(name)
+			return true
+		} catch {
+			return false
+		}
+	}
+
+	const configFile = CONFIGS.map((name) => join(root, name)).find(existsSync)
+	const requirements = {
+		'nativescript.config.ts': existsSync(join(root, 'nativescript.config.ts')),
+		'native workshop Vite setup': Boolean(
+			configFile && /withWorkshopMobile/.test(readFileSync(configFile, 'utf8')),
+		),
+		'@nativescript/core': installed('@nativescript/core'),
+		'@nativescript-community/octane': installed('@nativescript-community/octane'),
+		'@nativescript-community/vite-octane': installed('@nativescript-community/vite-octane'),
+		'@valor/nativescript-websockets': installed('@valor/nativescript-websockets'),
+		'nativescript CLI': installed('nativescript'),
+	}
+
+	if (target === 'ios') {
+		requirements['macOS / Xcode host'] = host === 'darwin' && existsSync('/Applications/Xcode.app')
+	} else {
+		requirements['Android SDK directory'] = Boolean(
+			(env.ANDROID_HOME || env.ANDROID_SDK_ROOT) &&
+			existsSync(env.ANDROID_HOME || env.ANDROID_SDK_ROOT),
+		)
+
+		requirements['JAVA_HOME directory'] = Boolean(env.JAVA_HOME && existsSync(env.JAVA_HOME))
+	}
+
+	return {
+		backend: 'nativescript (Octane universal renderer)',
+		requirements,
+		status:
+			target === 'ios' && host !== 'darwin'
+				? 'remote-host-required'
+				: Object.values(requirements).every(Boolean)
+					? 'unqualified-backend'
+					: 'missing-prerequisites',
+		note: 'Mobile adapter installed; actual-host lifecycle, touch, keyboard, screen-reader and IME qualification remain open. Doctor does not launch or select a device.',
+	}
+}
+
+export function mobileLaunchSpec({ root, target, device, config, story }) {
+	if (!['ios', 'android'].includes(target)) {
+		throw new Error('Expected ios or android')
+	}
+
+	if (!device || typeof device !== 'string' || device.startsWith('-')) {
+		throw new Error(
+			'Mobile workshop requires --device <device-id>; it never chooses or boots a device implicitly',
+		)
+	}
+
+	const req = createRequire(join(root, 'package.json'))
+	const packageFile = req.resolve('nativescript/package.json')
+	const manifest = JSON.parse(readFileSync(packageFile, 'utf8'))
+	const binary =
+		typeof manifest.bin === 'string' ? manifest.bin : (manifest.bin.ns ?? manifest.bin.nativescript)
+
+	if (!binary) {
+		throw new Error('Installed NativeScript CLI has no ns binary')
+	}
+
+	return {
+		command: process.execPath,
+		args: [resolve(dirname(packageFile), binary), 'run', target, '--device', device],
+		options: {
+			cwd: root,
+			stdio: 'inherit',
+			shell: false,
+			env: {
+				...process.env,
+				XPLAT_WORKSHOP_TARGET: target,
+				XPLAT_WORKSHOP_CONFIG: JSON.stringify(config),
+				XPLAT_WORKSHOP_STORY: story ?? '',
+			},
+		},
+	}
+}
+
+export async function launchMobile(options) {
+	const spec = mobileLaunchSpec(options)
+	const child = spawn(spec.command, spec.args, spec.options)
+	const interrupt = () => child.kill('SIGINT')
+	const terminate = () => child.kill('SIGTERM')
+	process.on('SIGINT', interrupt)
+	process.on('SIGTERM', terminate)
+	try {
+		await new Promise((resolve, reject) => {
+			child.once('error', reject)
+			child.once('exit', (code, signal) =>
+				code === 0
+					? resolve()
+					: reject(
+							new Error(
+								`NativeScript workshop ${options.target} exited ${signal ?? code}; check launch logs and restart the target`,
+							),
+						),
+			)
+		})
+	} finally {
+		process.off('SIGINT', interrupt)
+		process.off('SIGTERM', terminate)
+	}
+
+	return { target: options.target, exited: true }
+}

package/src/mobile-regex.mjs

@@ -0,0 +1,60 @@
+import { transformAsync, types } from '@babel/core'
+import unicodeProperties from '@babel/plugin-transform-unicode-property-regex'
+
+// Compatibility approach shared with apps/mobile/visual-regex.mjs; no testing-host dependency.
+/** Compile Unicode properties for the pinned iOS runtime without changing globals. */
+export function transformMobileRegex(code, filename = 'workshop-host.mjs') {
+	return transformAsync(code, {
+		filename,
+		configFile: false,
+		babelrc: false,
+		sourceMaps: true,
+		plugins: [
+			// Storybook also embeds constant RegExp constructors. Turn only unshadowed
+			// built-in constructors into literals for Babel's standard regex transform.
+			() => ({
+				visitor: {
+					NewExpression(path) {
+						const node = path.node
+						if (
+							!types.isIdentifier(node.callee, { name: 'RegExp' }) ||
+							path.scope.getBinding('RegExp') ||
+							node.arguments.length !== 2
+						) {
+							return
+						}
+
+						const [pattern, flags] = node.arguments
+						if (
+							types.isStringLiteral(pattern) &&
+							types.isStringLiteral(flags) &&
+							flags.value.includes('u') &&
+							/\\[pP]\{/.test(pattern.value)
+						) {
+							path.replaceWith(types.regExpLiteral(pattern.value, flags.value))
+						}
+					},
+				},
+			}),
+			unicodeProperties.default ?? unicodeProperties,
+		],
+	})
+}
+
+export function mobileRegexPlugin() {
+	return {
+		name: 'xplat-workshop-mobile-unicode-regex',
+		async transform(code, id) {
+			if (!/\\[pP]\{/.test(code) || !/\.[cm]?js(?:\?|$)/.test(id)) {
+				return null
+			}
+
+			const result = await transformMobileRegex(code, id.split('?')[0])
+			return result ? { code: result.code, map: result.map } : null
+		},
+		async renderChunk(code, chunk) {
+			const result = await transformMobileRegex(code, chunk.fileName)
+			return result ? { code: result.code, map: result.map } : null
+		},
+	}
+}

package/src/node.d.ts

@@ -0,0 +1,65 @@
+export interface WorkshopListResult {
+	entries: unknown[]
+	diagnostics: { file: string; exportName?: string; message: string }[]
+}
+
+export interface WorkshopDoctorReport {
+	root: string
+	targets: Record<
+		string,
+		{
+			backend: string
+			requirements: Record<string, boolean>
+			status: string
+			note?: string
+			executionHost?: { required: string; current: string; reachable: boolean }
+			qualification?: 'unverified'
+		}
+	>
+}
+
+export class WorkshopUsageError extends Error {}
+export declare function workshopList(options?: {
+	cwd?: string
+	target?: string
+	json?: boolean
+}): Promise<WorkshopListResult>
+
+export declare function workshopDoctor(options?: {
+	cwd?: string
+	json?: boolean
+}): Promise<WorkshopDoctorReport>
+
+export declare function workshopInit(options?: {
+	cwd?: string
+	scripts?: boolean
+}): Promise<{ created: string[]; skipped: string[] }>
+
+export declare function workshopDev(options?: {
+	cwd?: string
+	target?: string
+	story?: string
+	port?: number
+	device?: string
+}): Promise<unknown>
+
+/**
+ * Shared dev-server seam for DOM targets — the caller owns process
+ * lifecycle. Exported so qualification harnesses can boot the exact
+ * production wiring.
+ */
+export declare function startWorkshopServer(options?: {
+	root?: string
+	config?: object
+	target?: string
+	story?: string
+	port?: number
+}): Promise<{ server: unknown; url: string }>
+
+/** Linux host prerequisites as a missing-item list (empty when satisfied). */
+export declare function linuxMissingPrerequisites(): string[]
+
+export declare function findConfigFile(root: string): string | null
+export declare function loadWorkshopConfig(
+	root: string,
+): Promise<{ config: object; file: string | null }>