@nativescript/cloudflare-cli 0.1.0-beta.1 → 0.1.0-beta.3

package/README.md

@@ -1,10 +1,19 @@
 # @nativescript/cloudflare-cli
 
+```sh
+npx @nativescript/cloudflare-cli live          # a phone app: opens the IDE and prints a QR code for NativeScript Preview
+npx @nativescript/cloudflare-cli live --mac    # a Mac app: opens the IDE and runs the app on this Mac, streamed into the IDE
+```
+
+`live` creates a project on preview.nativescript.org (`--server` or `NS_EDGE_SERVER` for another edge), saves it to `.ns-edge.json` and opens its IDE. Run it again in the same folder to reopen that project, or add `--new` for another. Without a create token the project is free: a few hosted agent turns a day, no backend, deleted after 30 days unused. `--no-open` skips the browser; with `--mac`, `--allow-eval` lets the agent run code on this Mac.
+
+## Mirror a local project
+
 Mirror a NativeScript project into an ns-edge project from a terminal or a Vite dev server.
 
 ```sh
 npm i -D @nativescript/cloudflare-cli@beta
-npx ns-edge create --server https://preview.nativescript.org --token <create token>
+npx ns-edge create --server https://preview.nativescript.org --token <create token>   # --template vue for nativescript-vue
 npx ns-edge watch        # push, then every save
 npx ns-edge qr           # print the pairing QR code again
 ```

package/dist/bin.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-import { watch } from 'node:fs';
+import { spawn } from 'node:child_process';
+import { existsSync, watch } from 'node:fs';
 import { readFile, writeFile } from 'node:fs/promises';
 import { join, sep } from 'node:path';
 import { createInterface } from 'node:readline/promises';
@@ -7,6 +8,10 @@ import QRCode from 'qrcode';
 import { applyChanges, collect, createProject, projectUrl, report, SYNCED } from './sync.js';
 const CONFIG = '.ns-edge.json';
 const DEBOUNCE_MS = 120;
+const LIVE_SERVER = process.env.NS_EDGE_SERVER ?? 'https://preview.nativescript.org';
+/** The desktop host `live --mac` runs; bump it with each host release this CLI is tested against. */
+const DESKTOP_HOST = '@nativescript/cloudflare-desktop@0.1.0-alpha.2';
+const DESKTOP_TEMPLATES = new Set(['macos', 'electron']);
 const [cmd = 'help', ...args] = process.argv.slice(2);
 /**
  * Editors and tools write temp, swap and backup files next to the real one
@@ -18,6 +23,7 @@ const flag = (name) => {
     const i = args.indexOf(`--${name}`);
     return i >= 0 ? args[i + 1] : undefined;
 };
+const has = (name) => args.includes(`--${name}`);
 const root = process.cwd();
 async function loadRef() {
     let ref;
@@ -52,10 +58,75 @@ async function printPairing(ref) {
     console.log(`  device  ${device}`);
     console.log(`  ide     ${url}/#key=${ref.writeKey}`);
 }
+/** This folder's project, if it has one the server still knows. */
+async function savedProject() {
+    if (!existsSync(join(root, CONFIG)))
+        return null;
+    const ref = JSON.parse(await readFile(join(root, CONFIG), 'utf8'));
+    if (!ref.writeKey)
+        return null;
+    const res = await fetch(`${projectUrl(ref)}/files`).catch(() => null);
+    return res?.ok ? ref : null;
+}
+function openInBrowser(url) {
+    const [command, ...rest] = process.platform === 'darwin' ? ['open', url] : process.platform === 'win32' ? ['cmd', '/c', 'start', '""', url.replace(/&/g, '^&')] : ['xdg-open', url];
+    spawn(command, rest, { stdio: 'ignore', detached: true }).on('error', () => { }).unref();
+}
+/** Runs the Mac host for a desktop project until it exits; the host prints what joining allows. */
+function runDesktopHost(ref) {
+    if (process.platform !== 'darwin' || process.arch !== 'arm64') {
+        throw new Error('Mac projects run on an Apple Silicon Mac (macOS 14.4 or later). Run the same command there.');
+    }
+    const device = `${projectUrl(ref)}#${ref.deviceKey}`;
+    const extra = has('allow-eval') ? ['--allow-eval'] : [];
+    const child = spawn('npx', ['-y', DESKTOP_HOST, device, '--yes', ...extra], { stdio: 'inherit' });
+    for (const signal of ['SIGINT', 'SIGTERM'])
+        process.on(signal, () => child.kill(signal));
+    return new Promise((resolve, reject) => {
+        child.on('error', reject);
+        child.on('exit', (code) => (code ? reject(new Error(`The Mac host exited with code ${code}.`)) : resolve()));
+    });
+}
 const commands = {
+    async live() {
+        for (const later of ['ios', 'android', 'all']) {
+            if (has(later))
+                throw new Error(`--${later} isn't available yet. Run \`live\` for a phone app or \`live --mac\` for a Mac app.`);
+        }
+        const template = flag('template') ?? (has('mac') ? 'macos' : 'core');
+        const desktop = DESKTOP_TEMPLATES.has(template);
+        let ref = has('new') ? null : await savedProject();
+        if (ref && DESKTOP_TEMPLATES.has(ref.template ?? 'core') !== desktop) {
+            throw new Error(`This folder's project (${CONFIG}) is a ${desktop ? 'phone' : 'Mac'} project. Add --new to replace it, or run this in another folder.`);
+        }
+        if (ref) {
+            console.log(`Opening this folder's project ${ref.id} (${CONFIG})`);
+        }
+        else {
+            ref = await createProject(flag('server') ?? LIVE_SERVER, flag('token') ?? process.env.NS_EDGE_CREATE_TOKEN, template);
+            await writeFile(join(root, CONFIG), JSON.stringify(ref, null, 2) + '\n');
+            console.log(`Created a ${desktop ? 'Mac' : 'phone'} project, saved to ${CONFIG} (it holds the project's keys: keep it private and out of git).`);
+            if (ref.free) {
+                console.log(`It's a free project: ${ref.free.agentTurnsPerDay} hosted agent turn${ref.free.agentTurnsPerDay === 1 ? '' : 's'} a day, deleted after ${ref.free.idleDays} days unused. ` +
+                    'For an unlimited agent, add your own API key in the agent panel or connect Claude Code from Connect agent.');
+            }
+        }
+        const ide = `${projectUrl(ref)}/#key=${ref.writeKey}`;
+        console.log(`\n  IDE  ${ide}\n`);
+        if (!has('no-open'))
+            openInBrowser(ide);
+        if (desktop) {
+            console.log('Starting the app on this Mac. Its window streams to the IDE\'s Device pane. Press Ctrl+C to stop.\n');
+            return runDesktopHost(ref);
+        }
+        const device = `${projectUrl(ref)}#${ref.deviceKey}`;
+        console.log(await QRCode.toString(`${ref.pairScheme ?? 'nsedge'}://pair?url=${encodeURIComponent(device)}`, { type: 'terminal', small: true }));
+        console.log(`Scan with your phone's camera to open it in ${ref.pairScheme === 'nspreview' ? 'NativeScript Preview' : 'the edge shell'}, then edit in the IDE.`);
+        console.log('Run this command again in this folder to reopen the project.');
+    },
     async create() {
         const server = flag('server') ?? 'http://localhost:5173';
-        const ref = await createProject(server, flag('token') ?? process.env.NS_EDGE_CREATE_TOKEN);
+        const ref = await createProject(server, flag('token') ?? process.env.NS_EDGE_CREATE_TOKEN, flag('template'));
         await writeFile(join(root, CONFIG), JSON.stringify(ref, null, 2) + '\n');
         console.log(`Created project ${ref.id} (saved to ${CONFIG}; it holds the project keys, keep it out of git)`);
         await printPairing(ref);
@@ -125,7 +196,10 @@ const commands = {
     async help() {
         console.log(`ns-edge <command>
 
-  create [--server <url>] [--token <t>]
+  live [--mac] [--new] [--no-open] [--allow-eval]
+                            create a project (or reopen this folder's), open its IDE, and print a QR code
+                            for your phone; --mac runs it on this Mac instead
+  create [--server <url>] [--token <t>] [--template core|vue|react|solid|svelte|angular]
                             create an edge project and save .ns-edge.json
   push                      upload app/ and server/ in one transaction
   watch                     push, then stream every save to the edge

package/dist/sync.d.ts

@@ -5,6 +5,12 @@ export interface ProjectRef {
     deviceKey: string;
     /** URL scheme of the app the server pairs with, from its create response. */
     pairScheme?: string;
+    template?: string;
+    /** Set on free projects: their daily agent allowance and how long they last unused. */
+    free?: {
+        agentTurnsPerDay: number;
+        idleDays: number;
+    };
 }
 export interface ApplyResult {
     changed: string[];
@@ -17,7 +23,7 @@ export interface ApplyResult {
 /** Project-relative paths that are mirrored to the edge. */
 export declare const SYNCED: RegExp;
 export declare function projectUrl(ref: ProjectRef): string;
-export declare function createProject(server: string, token?: string): Promise<ProjectRef>;
+export declare function createProject(server: string, token?: string, template?: string): Promise<ProjectRef>;
 /** Sends a batch as one edge transaction, so devices see one consistent update. */
 export declare function applyChanges(ref: ProjectRef, changes: {
     path: string;

package/dist/sync.js

@@ -1,19 +1,22 @@
 import { readFile, readdir, stat } from 'node:fs/promises';
 import { join, relative, sep } from 'node:path';
 /** Project-relative paths that are mirrored to the edge. */
-export const SYNCED = /^(app|server)\/.+\.(ts|mts|js|mjs|xml|css|json)$/;
+export const SYNCED = /^(app|server)\/.+\.(ts|tsx|mts|js|jsx|mjs|vue|svelte|xml|html|css|json)$/;
 export function projectUrl(ref) {
     return `${ref.server.replace(/\/$/, '')}/p/${ref.id}`;
 }
-export async function createProject(server, token) {
-    const res = await fetch(`${server.replace(/\/$/, '')}/api/projects`, {
+export async function createProject(server, token, template) {
+    const query = template ? `?template=${encodeURIComponent(template)}` : '';
+    const res = await fetch(`${server.replace(/\/$/, '')}/api/projects${query}`, {
         method: 'POST',
         headers: token ? { authorization: `Bearer ${token}` } : {},
     });
+    if (res.status === 401)
+        throw new Error(`${server} creates projects only with a create token: pass --token or set NS_EDGE_CREATE_TOKEN.`);
     if (!res.ok)
-        throw new Error(`create failed: ${res.status} ${await res.text()}`);
-    const { id, writeKey, deviceKey, pair } = (await res.json());
-    return { server, id, writeKey, deviceKey, pairScheme: pair?.split('://')[0] };
+        throw new Error(`Couldn't create a project (${res.status}): ${await res.text()}`);
+    const { id, writeKey, deviceKey, pair, free } = (await res.json());
+    return { server, id, writeKey, deviceKey, pairScheme: pair?.split('://')[0], template: template ?? 'core', ...(free && { free }) };
 }
 /** Sends a batch as one edge transaction, so devices see one consistent update. */
 export async function applyChanges(ref, changes) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nativescript/cloudflare-cli",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.3",
   "description": "Mirror a NativeScript project into an ns-edge project from a terminal or a Vite dev server",
   "license": "Apache-2.0",
   "type": "module",