@mondaydotcomorg/z2h-cli 0.1.1 → 0.3.0

package/dist/util/s3/upload.js

@@ -6,6 +6,7 @@ const fsExtra = require('fs-extra');
 const mimeTypes = require('mime-types');
 const pMap = require('p-map');
 const clientS3 = require('@aws-sdk/client-s3');
+const constants = require('../../constants.js');
 const util_s3_client = require('./client.js');
 
 const _interopDefault = e => e && e.__esModule ? e : { default: e };
@@ -26,7 +27,7 @@ async function uploadDir(localDir, keyPrefix) {
         const contentType = mimeTypes.lookup(rel) || 'application/octet-stream';
         const key = `${keyPrefix}/${rel.split(path__default.default.sep).join('/')}`;
         await s3.send(new clientS3.PutObjectCommand({
-            Bucket: util_s3_client.BUCKET_WRITE_NAME,
+            Bucket: constants.BUCKET_WRITE_NAME,
             Key: key,
             Body: body,
             ContentType: contentType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/z2h-cli",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "bin": "./bin/z2h-cli.js",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -10,6 +10,11 @@
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
+    "./constants": {
+      "import": "./dist/esm/constants.mjs",
+      "require": "./dist/constants.js",
+      "types": "./dist/constants.d.ts"
+    },
     "./package.json": "./package.json"
   },
   "nx": {
@@ -35,7 +40,9 @@
     "@aws-sdk/client-s3": "^3.706.0",
     "chokidar": "^3.6.0",
     "commander": "^12.1.0",
+    "cors": "^2.8.6",
     "execa": "^9.5.1",
+    "express": "^5.2.1",
     "fs-extra": "^11.2.0",
     "mime-types": "^2.1.35",
     "p-map": "^7.0.2",
@@ -44,6 +51,8 @@
   },
   "devDependencies": {
     "@mondaydotcomorg/trident-library": "^1.2.7",
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.6",
     "@types/fs-extra": "^11.0.4",
     "@types/mime-types": "^2.1.4",
     "@types/node": "^22.19.0",

package/src/commands/__tests__/create.test.ts

@@ -5,11 +5,14 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { execa } from 'execa';
 import { createCommand } from '../create';
+import * as manifest from '../../util/manifest';
 
 vi.mock('execa', () => ({
   execa: vi.fn().mockResolvedValue({ stdout: '', stderr: '', exitCode: 0 }),
 }));
 
+vi.spyOn(manifest, 'readManifest').mockResolvedValue({});
+
 async function makeWorkspace(tmp: string): Promise<void> {
   await ensureDir(tmp);
   await writeJson(path.join(tmp, 'package.json'), {

package/src/commands/build.ts

@@ -5,6 +5,7 @@ import { prepareShadow } from '../shadow/prepare';
 
 export interface BuildOptions {
   json?: boolean;
+  publicUrl?: string;
 }
 
 export async function buildCommand(opts: BuildOptions): Promise<void> {
@@ -27,7 +28,11 @@ export async function buildCommand(opts: BuildOptions): Promise<void> {
   });
 
   info(`building "${ctx.appName}" via trident`);
-  await execa('yarn', ['build'], { cwd: ctx.paths.shadowDir, stdio: 'inherit' });
+  await execa('yarn', ['build'], {
+    cwd: ctx.paths.shadowDir,
+    stdio: 'inherit',
+    env: { ...process.env, ...(opts.publicUrl ? { PUBLIC_URL: opts.publicUrl } : {}) },
+  });
 
   if (!(await pathExists(ctx.paths.shadowBuild))) {
     throw new Error(`Expected build output at ${ctx.paths.shadowBuild} — not found.`);

package/src/commands/create-workspace.ts

@@ -62,6 +62,7 @@ export async function createWorkspaceCommand(opts: CreateWorkspaceOptions): Prom
     writeFile(path.join(home, 'package.json'), renderTemplate(pkgRaw, { __Z2H_CLI_VERSION__: cliVersion })),
     copy(path.join(wsTemplatesDir, 'gitignore'), path.join(home, '.gitignore')),
     copy(path.join(wsTemplatesDir, 'yarnrc.yml'), path.join(home, '.yarnrc.yml')),
+    copy(path.join(wsTemplatesDir, 'yarnlock'), path.join(home, 'yarn.lock')),
     copy(path.join(wsTemplatesDir, 'nvmrc'), path.join(home, '.nvmrc')),
     copy(path.join(wsTemplatesDir, 'npmrc'), path.join(home, '.npmrc')),
     copy(path.join(wsTemplatesDir, 'README.md'), path.join(home, 'README.md')),

package/src/commands/create.ts

@@ -5,6 +5,9 @@ import { execa } from 'execa';
 import { info, output, setOutputMode } from '../util/logger';
 import { assertWorkspace } from '../util/workspace';
 import { getTemplatesDir, renderTemplate, APP_TEMPLATES, type AppTemplate } from '../util/templates';
+import { readManifest } from '../util/manifest';
+import { mfAppName } from '../util/app-name';
+import { APP_NAME_PATTERN } from '../constants';
 
 export interface CreateOptions {
   template?: string;
@@ -12,7 +15,10 @@ export interface CreateOptions {
   json?: boolean;
 }
 
-const APP_NAME_RE = /^[a-z][a-z0-9-]{1,49}$/;
+// Names reserved by the host MF (mf-bigbrain-zth) for platform pages under
+// /bigbrain-vibe/<name>. Creating an app with one of these would shadow the
+// platform page in the URL, so we refuse upfront.
+const RESERVED_APP_NAMES = new Set(['generate-z2h-token']);
 
 /**
  * Convert kebab-case to PascalCase. `demo-app` → `DemoApp`.
@@ -45,7 +51,12 @@ export async function createCommand(appName: string, opts: CreateOptions): Promi
   const workspace = await assertWorkspace();
 
   // Validate app name.
-  if (!APP_NAME_RE.test(appName)) {
+  if (RESERVED_APP_NAMES.has(appName)) {
+    throw new Error(
+      `App name "${appName}" is reserved by the Z2H host for a platform page under /bigbrain-vibe/${appName}. Pick a different name.`
+    );
+  }
+  if (!APP_NAME_PATTERN.test(appName)) {
     throw new Error(
       `App name "${appName}" is invalid. Use lowercase kebab-case (a-z, 0-9, -), ` +
         `2-50 chars, starting with a letter.`
@@ -69,6 +80,12 @@ export async function createCommand(appName: string, opts: CreateOptions): Promi
     throw new Error(`${appDir} is non-empty. Pick a different name or wipe it first.`);
   }
 
+  // Check for manifest collision (network call — after all local checks).
+  const manifest = await readManifest();
+  if (manifest[mfAppName(appName)]) {
+    throw new Error(`An app named "${appName}" already exists in the Z2H registry. Pick a different name.`);
+  }
+
   // Compute substitutions.
   const vars = {
     __APP_NAME__: appName,

package/src/commands/deploy.ts

@@ -1,7 +1,7 @@
 import path from 'node:path';
+import os from 'node:os';
 import { pathExists, readJson } from 'fs-extra';
-import { execa } from 'execa';
-import { info, warn, output, setOutputMode } from '../util/logger';
+import { info, output, setOutputMode } from '../util/logger';
 import { resolveConsumerPaths } from '../shadow/paths';
 import {
   nextVersion,
@@ -12,39 +12,22 @@ import {
   type ManifestEntry,
 } from '../util/manifest';
 import { uploadDir } from '../util/s3/upload';
-import { assertBucketExists, BUCKET_WRITE_NAME, BUCKET_READ_DNS_URL } from '../util/s3/client';
+import { BUCKET_WRITE_NAME, BUCKET_READ_DNS_URL } from '../constants';
+import { setupS3Client } from '../util/s3/client';
+import { readZthAuth } from '../util/auth/auth-store';
 import { cleanAppName, mfAppName } from '../util/app-name';
 import { buildCommand } from './build';
 
-const APONO_BUNDLE = '<APONO_BUNDLE_NAME>'; // TODO: replace with actual bundle name once infra setup is complete
-
 export interface DeployOptions {
   dryRun?: boolean;
   json?: boolean;
 }
 
-async function requestAponoAccess(): Promise<void> {
-  if (APONO_BUNDLE === '<APONO_BUNDLE_NAME>') {
-    warn(
-      `skipping Apono request — APONO_BUNDLE is still a placeholder ("${APONO_BUNDLE}"). Set it in deploy.ts before relying on auto-grant.`
-    );
-    return;
-  }
-  info(`requesting Apono access for bundle "${APONO_BUNDLE}"`);
-  await execa('apono', ['bundles', 'grant', APONO_BUNDLE], { stdio: 'inherit' });
-}
-
 export async function deployCommand(opts: DeployOptions): Promise<void> {
   if (opts.json) {
     setOutputMode('json');
   }
 
-  info('checking S3 bucket');
-  await assertBucketExists();
-
-  info('building');
-  await buildCommand({ json: opts.json });
-
   const paths = resolveConsumerPaths(process.cwd());
   const consumerPkg = (await readJson(paths.consumerPkg)) as { name?: string };
   if (!consumerPkg.name) {
@@ -52,6 +35,20 @@ export async function deployCommand(opts: DeployOptions): Promise<void> {
   }
   const appName = mfAppName(consumerPkg.name);
 
+  // Validate the user's deploy token is on disk before doing any expensive
+  // work. Throws Z2hAuthMissingError with a remediation hint if not.
+  await readZthAuth();
+  setupS3Client({ appName });
+
+  info('reading current Z2H manifest');
+  const manifest = await readManifest();
+  const version = nextVersion(manifest, appName);
+  const keyPrefix = `${appName}/${version}`;
+  const url = `${BUCKET_READ_DNS_URL}/${keyPrefix}`;
+
+  info('building');
+  await buildCommand({ json: opts.json, publicUrl: url });
+
   if (!(await pathExists(paths.shadowBuild))) {
     throw new Error(`No build output at ${paths.shadowBuild} after build step.`);
   }
@@ -63,11 +60,13 @@ export async function deployCommand(opts: DeployOptions): Promise<void> {
   }
   const assetManifest = (await readJson(assetManifestPath)) as AssetManifestFile;
 
-  info('reading current Z2H manifest');
-  const manifest = await readManifest();
-  const version = nextVersion(manifest, appName);
-  const keyPrefix = `${appName}/${version}`;
-  const url = `${BUCKET_READ_DNS_URL}/${keyPrefix}`;
+  const deployedBy = os.userInfo().username;
+  const entry: ManifestEntry = {
+    ...assetManifest,
+    version,
+    url,
+    deployedBy,
+  };
 
   if (opts.dryRun) {
     output(`[z2h-cli] dry-run: would upload to s3://${BUCKET_WRITE_NAME}/${keyPrefix}/ as v${version}`, {
@@ -78,22 +77,14 @@ export async function deployCommand(opts: DeployOptions): Promise<void> {
       bucket: BUCKET_WRITE_NAME,
       keyPrefix,
       url,
-      entry: { ...assetManifest, version, url },
+      entry,
     });
     return;
   }
 
-  await requestAponoAccess();
-
   info(`uploading build → s3://${BUCKET_WRITE_NAME}/${keyPrefix}/`);
   await uploadDir(paths.shadowBuild, keyPrefix);
 
-  const entry: ManifestEntry = {
-    ...assetManifest,
-    version,
-    url,
-  };
-
   info(`updating manifest entry "${appName}" → v${version}`);
   await writeManifest(upsertEntry(manifest, appName, entry));
 

package/src/commands/dev.ts

@@ -1,4 +1,6 @@
-import { readJson } from 'fs-extra';
+import path from 'node:path';
+import fs from 'node:fs';
+import { readJson, writeFile } from 'fs-extra';
 import { watch } from 'chokidar';
 import { execa } from 'execa';
 import { info, warn, errorLog, output, setOutputMode } from '../util/logger';
@@ -31,6 +33,29 @@ export async function devCommand(opts: DevOptions): Promise<void> {
     stdio: ['inherit', 'pipe', 'inherit'],
   });
 
+  const pidFile = path.join(ctx.paths.shadowDir, 'dev.pid');
+  if (server.pid) {
+    await writeFile(pidFile, String(server.pid));
+  }
+
+  const cleanupPid = () => {
+    try {
+      fs.unlinkSync(pidFile);
+    } catch (_) {
+      // file already gone — ignore
+    }
+  };
+  server.on('exit', cleanupPid);
+  process.on('exit', cleanupPid);
+  process.on('SIGINT', () => {
+    server.kill();
+    process.exit(0);
+  });
+  process.on('SIGTERM', () => {
+    server.kill();
+    process.exit(0);
+  });
+
   let readyPrinted = false;
   server.stdout?.on('data', (chunk: Buffer) => {
     process.stdout.write(chunk);

package/src/commands/generate-z2h-token.ts

@@ -0,0 +1,124 @@
+import readline from 'node:readline/promises';
+import { stdin, stdout } from 'node:process';
+import { execa } from 'execa';
+import { info, warn, output, setOutputMode } from '../util/logger';
+import { writeZthAuth, validateJwtPattern } from '../util/auth/write-auth';
+import { startLoopbackServer } from '../util/auth/loopback-server';
+
+export const DEFAULT_TOKEN_PAGE_URL = 'https://bigbrain.me/bigbrain-vibe/generate-z2h-token';
+export const LOOPBACK_TIMEOUT_MS = 120_000;
+
+export interface GenerateZ2HTokenOptions {
+  /**
+   * Skip browser auto-open AND skip the loopback callback. Prints the URL
+   * for the user to open manually, then waits for them to paste the token
+   * into the prompt. Use for SSH sessions, CI, or when the loopback can't
+   * reach the CLI for any reason.
+   */
+  noBrowser?: boolean;
+  /** Override the page URL — useful when pointing at staging. */
+  url?: string;
+  json?: boolean;
+}
+
+function browserOpenCommand(): string {
+  switch (process.platform) {
+    case 'darwin':
+      return 'open';
+    case 'win32':
+      return 'start';
+    default:
+      return 'xdg-open';
+  }
+}
+
+async function openInBrowser(url: string): Promise<void> {
+  await execa(browserOpenCommand(), [url], { stdio: 'ignore' });
+}
+
+async function promptForToken(): Promise<string> {
+  const rl = readline.createInterface({ input: stdin, output: stdout });
+  try {
+    const raw = await rl.question('Paste your token here, then press Enter:\n> ');
+    return raw.trim();
+  } finally {
+    rl.close();
+  }
+}
+
+function withQueryParam(url: string, key: string, value: string): string {
+  const sep = url.includes('?') ? '&' : '?';
+  return `${url}${sep}${key}=${encodeURIComponent(value)}`;
+}
+
+async function runManualFlow(pageUrl: string): Promise<string> {
+  info(
+    `open this URL in your browser to mint a Z2H deploy token:\n` +
+      `  ${pageUrl}\n\n` +
+      `1. Click "Generate token" on the page.\n` +
+      `2. Copy the token shown.\n` +
+      `3. Paste it below and press Enter.\n`
+  );
+  const token = await promptForToken();
+  if (!token) {
+    throw new Error('No token entered.');
+  }
+  return token;
+}
+
+async function runLoopbackFlow(pageUrl: string): Promise<string | null> {
+  const loopback = await startLoopbackServer();
+  const fullUrl = withQueryParam(pageUrl, 'cli_callback', loopback.callbackUrl);
+
+  info('opening your browser to mint a Z2H deploy token');
+  info(`  ${fullUrl}`);
+
+  try {
+    await openInBrowser(fullUrl);
+  } catch {
+    warn('could not auto-open the browser. please visit the URL above manually.');
+  }
+
+  info('waiting for the page to send the token (Ctrl+C to fall back to manual paste)…');
+
+  try {
+    return await loopback.waitForToken(LOOPBACK_TIMEOUT_MS);
+  } catch {
+    return null;
+  } finally {
+    loopback.close();
+  }
+}
+
+export async function generateZ2HTokenCommand(opts: GenerateZ2HTokenOptions = {}): Promise<void> {
+  if (opts.json) {
+    setOutputMode('json');
+  }
+
+  const pageUrl = opts.url ?? process.env.Z2H_TOKEN_PAGE_URL ?? DEFAULT_TOKEN_PAGE_URL;
+
+  // --no-browser bypasses both auto-open and the loopback round-trip — the
+  // user opens the URL themselves and pastes the token. Useful when the
+  // loopback can't be reached (SSH, CI, locked-down browsers).
+  let token: string | null = null;
+  if (!opts.noBrowser) {
+    token = await runLoopbackFlow(pageUrl);
+    if (!token) {
+      warn('loopback flow timed out or was cancelled — falling back to manual paste.');
+    }
+  }
+  if (!token) {
+    token = await runManualFlow(pageUrl);
+  }
+
+  if (!validateJwtPattern(token)) {
+    throw new Error('That does not look like a JWT (expected three dot-separated segments).');
+  }
+
+  const { filePath } = await writeZthAuth({ token });
+
+  output(`[z2h-cli] token saved ✅ ${filePath}`, {
+    ok: true,
+    filePath,
+  });
+}

package/src/constants.ts

@@ -38,3 +38,28 @@ export const YARNRC_LINES = [
   "npmAuthToken: '${NPM_TOKEN}'",
   "npmRegistryServer: 'https://registry.npmjs.org/'",
 ];
+
+// ─────────── Z2H deploy bucket / contract ─────────
+// Source of truth for the bucket layout. The CLI uses these when configuring
+// the S3 client + uploading; bigbrain-zth's STS broker imports them via
+// `@mondaydotcomorg/z2h-cli/constants` to scope the per-deploy session
+// policy to the same bucket + manifest key.
+
+export const BUCKET_WRITE_NAME = 'prod-use1-bigbrain-zth-mf-assets';
+export const REGION = 'us-east-1';
+export const BUCKET_WRITE_URL = `https://${BUCKET_WRITE_NAME}.s3.${REGION}.amazonaws.com`;
+
+export const BUCKET_READ_DNS_NAME = 'bigbrain-zth-mf-assets';
+export const BUCKET_READ_DNS_URL = `https://${BUCKET_READ_DNS_NAME}.bigbrain.me`;
+
+// No `.json` extension — TridentSkeleton's `mfUrl` API appends `/mf-assets`
+// to the bucket base when fetching, so the manifest must live at this exact
+// key. See microfrontends/mf-bigbrain-zth/.../ZeroToHeroHost.tsx.
+export const MANIFEST_KEY = 'mf-assets';
+export const MANIFEST_READ_URL = `${BUCKET_READ_DNS_URL}/${MANIFEST_KEY}`;
+
+// ─────────── App-name slug — backend & CLI both honor this ─────
+// Lowercase kebab-case, must start with a letter, 2-50 chars total. The
+// backend STS broker rejects anything else with 400; the CLI can validate
+// upfront for friendlier errors.
+export const APP_NAME_PATTERN = /^[a-z][a-z0-9-]{1,49}$/;

package/src/index.ts

@@ -5,6 +5,7 @@ import { cleanCommand } from './commands/clean';
 import { deployCommand } from './commands/deploy';
 import { createWorkspaceCommand } from './commands/create-workspace';
 import { createCommand } from './commands/create';
+import { generateZ2HTokenCommand } from './commands/generate-z2h-token';
 import { errorLog, fail } from './util/logger';
 
 async function main(): Promise<void> {
@@ -91,6 +92,22 @@ async function main(): Promise<void> {
       }
     });
 
+  program
+    .command('generate-z2h-token')
+    .description(
+      'Open the bigbrain.me token page, capture the token via a loopback callback, and persist it to ~/.zth/auth.json'
+    )
+    .option('--no-browser', "don't auto-open the browser; print the URL and prompt for manual paste")
+    .option('--url <url>', 'Override the token page URL (e.g. for staging)')
+    .option('--json', 'emit structured JSON on stdout')
+    .action(async (opts: { noBrowser?: boolean; url?: string; json?: boolean }) => {
+      try {
+        await generateZ2HTokenCommand(opts);
+      } catch (err) {
+        fail(`generate-z2h-token failed: ${(err as Error).message}`, { command: 'generate-z2h-token' }, 1);
+      }
+    });
+
   program
     .command('create <app-name>')
     .description('Scaffold a new Z2H consumer app inside ~/zth-projects/')

package/src/shadow/scaffold.ts

@@ -78,6 +78,11 @@ declare module '*.wasm' {
   const e: string;
   export default e;
 }
+
+declare module '*.html?url' {
+  const src: string;
+  export default src;
+}
 `;
 
 const TSCONFIG_TEMPLATE = {

package/src/templates/app/claude-settings.json

@@ -3,5 +3,17 @@
     "allow": [
       "Skill(z2h:*)"
     ]
+  },
+  "hooks": {
+    "Stop": [
+      {
+        "hooks": [
+          {
+            "type": "command",
+            "command": "if [ -f .zth/dev.pid ]; then kill $(cat .zth/dev.pid) 2>/dev/null; rm .zth/dev.pid; fi"
+          }
+        ]
+      }
+    ]
   }
 }

package/src/util/auth/__tests__/auth-store.test.ts

@@ -0,0 +1,50 @@
+import path from 'node:path';
+import os from 'node:os';
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { ensureDir, remove, writeJson } from 'fs-extra';
+
+let scratchHome: string;
+let originalHome: string | undefined;
+
+async function reload() {
+  // Re-import the module so HOME-derived constants pick up our scratch dir.
+  return import(`../auth-store?bust=${Date.now()}`);
+}
+
+beforeEach(async () => {
+  originalHome = process.env.HOME;
+  scratchHome = path.join(os.tmpdir(), `z2h-auth-test-${Date.now()}-${Math.random().toString(36).slice(2)}`);
+  await ensureDir(scratchHome);
+  process.env.HOME = scratchHome;
+});
+
+afterEach(async () => {
+  if (originalHome === undefined) {
+    delete process.env.HOME;
+  } else {
+    process.env.HOME = originalHome;
+  }
+  await remove(scratchHome);
+});
+
+describe('readZthAuth', () => {
+  it('throws Z2hAuthMissingError with a remediation hint when the file is absent', async () => {
+    const { readZthAuth, Z2hAuthMissingError } = await reload();
+    await expect(readZthAuth()).rejects.toBeInstanceOf(Z2hAuthMissingError);
+  });
+
+  it('throws when the file exists but lacks a token', async () => {
+    const { readZthAuth, Z2H_AUTH_FILE } = await reload();
+    await ensureDir(path.dirname(Z2H_AUTH_FILE));
+    await writeJson(Z2H_AUTH_FILE, { somethingElse: true });
+    await expect(readZthAuth()).rejects.toThrow(/missing a "token"/);
+  });
+
+  it('returns the parsed token', async () => {
+    const { readZthAuth, Z2H_AUTH_FILE } = await reload();
+    await ensureDir(path.dirname(Z2H_AUTH_FILE));
+    await writeJson(Z2H_AUTH_FILE, { token: 'abc.def.ghi' });
+    const result = await readZthAuth();
+    expect(result).toEqual({ token: 'abc.def.ghi' });
+  });
+});