@tabbr/module-cli 0.1.0 → 0.2.0

package/src/config.js

@@ -1,75 +1,75 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const readline = require('readline/promises');
-
-const CONFIG_FILE = 'tabbr.config.json';
-const DEFAULT_API_HOST = 'https://api.tabbr.be';
-
-/**
- * Reads the workspace's tabbr.config.json - the one place a module project records which club it
- * targets, its module id and so on. Both this CLI and the module's own dev-preview harness read it,
- * so they can't drift apart. Returns {} when there is no such file.
- */
-function readConfig(cwd) {
-  const file = path.join(cwd, CONFIG_FILE);
-  if (!fs.existsSync(file)) return {};
-  try {
-    return JSON.parse(fs.readFileSync(file, 'utf-8'));
-  } catch (err) {
-    throw new Error(`${file} is not valid JSON: ${err.message}`);
-  }
-}
-
-/** Uppercase club code, or throws with instructions when none is configured. */
-function requireClub(club) {
-  if (!club) {
-    throw new Error(`No club configured. Run "npx tabbr-module init" (or set "club" in ${CONFIG_FILE}).`);
-  }
-  return club.toUpperCase();
-}
-
-function slug(text) {
-  return text.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '');
-}
-
-/**
- * Asks for the club code (and offers defaults for the rest) and writes tabbr.config.json, keeping
- * any values already in it as the defaults.
- */
-async function runInit(cwd, overrides) {
-  const file = path.join(cwd, CONFIG_FILE);
-  const current = readConfig(cwd);
-  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
-  const ask = async (question, fallback) => {
-    if (!process.stdin.isTTY) return fallback;
-    const answer = (await rl.question(fallback ? `${question} [${fallback}]: ` : `${question}: `)).trim();
-    return answer || fallback;
-  };
-
-  try {
-    const club = (overrides.club || await ask('Club code (the part before .tabbr.be, e.g. abc)', current.club))?.toUpperCase();
-    if (!club) throw new Error('A club code is required.');
-    const name = slug(path.basename(cwd)) || 'my-module';
-    const moduleId = overrides.moduleId
-      || await ask('Module id (unique within the club)', current.moduleId || `club.${club.toLowerCase()}.${name}`);
-    const title = overrides.title || await ask('Menu title', current.title || 'My module');
-
-    const config = {
-      ...current,
-      club,
-      apiHost: overrides.apiHost || current.apiHost || DEFAULT_API_HOST,
-      moduleId,
-      title,
-      exposedModule: current.exposedModule || './Module',
-      exportName: current.exportName || 'Module',
-    };
-    fs.writeFileSync(file, JSON.stringify(config, null, 2) + '\n');
-    console.log(`\nWrote ${file}. Next: "npm start" to preview, "npm run publish-module" to publish.`);
-  } finally {
-    rl.close();
-  }
-}
-
-module.exports = { CONFIG_FILE, DEFAULT_API_HOST, readConfig, requireClub, runInit };
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline/promises');
+
+const CONFIG_FILE = 'tabbr.config.json';
+const DEFAULT_API_HOST = 'https://api.tabbr.be';
+
+/**
+ * Reads the workspace's tabbr.config.json - the one place a module project records which club it
+ * targets, its module id and so on. Both this CLI and the module's own dev-preview harness read it,
+ * so they can't drift apart. Returns {} when there is no such file.
+ */
+function readConfig(cwd) {
+  const file = path.join(cwd, CONFIG_FILE);
+  if (!fs.existsSync(file)) return {};
+  try {
+    return JSON.parse(fs.readFileSync(file, 'utf-8'));
+  } catch (err) {
+    throw new Error(`${file} is not valid JSON: ${err.message}`);
+  }
+}
+
+/** Uppercase club code, or throws with instructions when none is configured. */
+function requireClub(club) {
+  if (!club) {
+    throw new Error(`No club configured. Run "npx tabbr-module init" (or set "club" in ${CONFIG_FILE}).`);
+  }
+  return club.toUpperCase();
+}
+
+function slug(text) {
+  return text.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '');
+}
+
+/**
+ * Asks for the club code (and offers defaults for the rest) and writes tabbr.config.json, keeping
+ * any values already in it as the defaults.
+ */
+async function runInit(cwd, overrides) {
+  const file = path.join(cwd, CONFIG_FILE);
+  const current = readConfig(cwd);
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  const ask = async (question, fallback) => {
+    if (!process.stdin.isTTY) return fallback;
+    const answer = (await rl.question(fallback ? `${question} [${fallback}]: ` : `${question}: `)).trim();
+    return answer || fallback;
+  };
+
+  try {
+    const club = (overrides.club || await ask('Club code (the part before .tabbr.be, e.g. abc)', current.club))?.toUpperCase();
+    if (!club) throw new Error('A club code is required.');
+    const name = slug(path.basename(cwd)) || 'my-module';
+    const moduleId = overrides.moduleId
+      || await ask('Module id (unique within the club)', current.moduleId || `club.${club.toLowerCase()}.${name}`);
+    const title = overrides.title || await ask('Fallback title (the translated one is module.title in your i18n bundle)', current.title || 'My module');
+
+    const config = {
+      ...current,
+      club,
+      apiHost: overrides.apiHost || current.apiHost || DEFAULT_API_HOST,
+      moduleId,
+      title,
+      exposedModule: current.exposedModule || './Module',
+      exportName: current.exportName || 'Module',
+    };
+    fs.writeFileSync(file, JSON.stringify(config, null, 2) + '\n');
+    console.log(`\nWrote ${file}. Next: "npm start" to preview, "npm run publish-module" to publish.`);
+  } finally {
+    rl.close();
+  }
+}
+
+module.exports = { CONFIG_FILE, DEFAULT_API_HOST, readConfig, requireClub, runInit };

package/src/fetch-types.js

@@ -1,49 +1,49 @@
-'use strict';
-
-// Mirrors ScriptTypeGenerator.ScriptKind (tabbr-api-server) - keep in sync if that enum changes.
-const VALID_KINDS = ['HOOK', 'CALCULATION', 'DEFAULT_CALCULATION', 'RELEVANT_CONDITION'];
-
-/**
- * Fetches the ambient .d.ts tabbr-ui's own script editor (Monaco, for club-configured hook/
- * calculation/default-value/relevancy-condition scripts) feeds itself, for a given club/entity/
- * kind - see ScriptTypeGenerator (tabbr-api-server) and ScriptEditorMonacoService (tabbr-ui).
- */
-async function fetchScriptTypes({ apiHost, club, entity, kind, accessToken }) {
-  if (!VALID_KINDS.includes(kind)) {
-    throw new Error(`Invalid --kind "${kind}". Must be one of: ${VALID_KINDS.join(', ')}`);
-  }
-
-  const url = `${apiHost}/api/${entity}/meta/script?kind=${kind}`;
-  console.log(`Fetching script types for entity "${entity}" (kind ${kind}) from ${url} ...`);
-  const response = await fetch(url, {
-    // X-club is required: CurrentClubFilter (tabbr-api-server) resolves the "current club" for
-    // this request from this header, not from any path variable - same pattern as publish.js.
-    headers: { Authorization: `Bearer ${accessToken}`, 'X-club': club.toUpperCase() },
-  });
-
-  if (!response.ok) {
-    throw new Error(`Fetching script types failed: ${response.status} ${await response.text()}`);
-  }
-  return response.text();
-}
-
-/**
- * Every entity this club has, as plain TypeScript data interfaces in ONE combined file - no
- * script-sandbox globals, so (unlike fetchScriptTypes) safe to fetch for every entity at once and
- * write to a single .d.ts. See ScriptTypeGenerator#generateAllEntityTypes (tabbr-api-server) for
- * why. For general club-data typing in module component code, not the script editor.
- */
-async function fetchAllEntityTypes({ apiHost, club, accessToken }) {
-  const url = `${apiHost}/api/club/${club.toUpperCase()}/entities/types`;
-  console.log(`Fetching all entity types for club ${club.toUpperCase()} from ${url} ...`);
-  const response = await fetch(url, {
-    headers: { Authorization: `Bearer ${accessToken}`, 'X-club': club.toUpperCase() },
-  });
-
-  if (!response.ok) {
-    throw new Error(`Fetching entity types failed: ${response.status} ${await response.text()}`);
-  }
-  return response.text();
-}
-
-module.exports = { fetchScriptTypes, fetchAllEntityTypes, VALID_KINDS };
+'use strict';
+
+// Mirrors ScriptTypeGenerator.ScriptKind (tabbr-api-server) - keep in sync if that enum changes.
+const VALID_KINDS = ['HOOK', 'CALCULATION', 'DEFAULT_CALCULATION', 'RELEVANT_CONDITION'];
+
+/**
+ * Fetches the ambient .d.ts tabbr-ui's own script editor (Monaco, for club-configured hook/
+ * calculation/default-value/relevancy-condition scripts) feeds itself, for a given club/entity/
+ * kind - see ScriptTypeGenerator (tabbr-api-server) and ScriptEditorMonacoService (tabbr-ui).
+ */
+async function fetchScriptTypes({ apiHost, club, entity, kind, accessToken }) {
+  if (!VALID_KINDS.includes(kind)) {
+    throw new Error(`Invalid --kind "${kind}". Must be one of: ${VALID_KINDS.join(', ')}`);
+  }
+
+  const url = `${apiHost}/api/${entity}/meta/script?kind=${kind}`;
+  console.log(`Fetching script types for entity "${entity}" (kind ${kind}) from ${url} ...`);
+  const response = await fetch(url, {
+    // X-club is required: CurrentClubFilter (tabbr-api-server) resolves the "current club" for
+    // this request from this header, not from any path variable - same pattern as publish.js.
+    headers: { Authorization: `Bearer ${accessToken}`, 'X-club': club.toUpperCase() },
+  });
+
+  if (!response.ok) {
+    throw new Error(`Fetching script types failed: ${response.status} ${await response.text()}`);
+  }
+  return response.text();
+}
+
+/**
+ * Every entity this club has, as plain TypeScript data interfaces in ONE combined file - no
+ * script-sandbox globals, so (unlike fetchScriptTypes) safe to fetch for every entity at once and
+ * write to a single .d.ts. See ScriptTypeGenerator#generateAllEntityTypes (tabbr-api-server) for
+ * why. For general club-data typing in module component code, not the script editor.
+ */
+async function fetchAllEntityTypes({ apiHost, club, accessToken }) {
+  const url = `${apiHost}/api/club/${club.toUpperCase()}/entities/types`;
+  console.log(`Fetching all entity types for club ${club.toUpperCase()} from ${url} ...`);
+  const response = await fetch(url, {
+    headers: { Authorization: `Bearer ${accessToken}`, 'X-club': club.toUpperCase() },
+  });
+
+  if (!response.ok) {
+    throw new Error(`Fetching entity types failed: ${response.status} ${await response.text()}`);
+  }
+  return response.text();
+}
+
+module.exports = { fetchScriptTypes, fetchAllEntityTypes, VALID_KINDS };

package/src/local.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const { spawnSync } = require('child_process');
+
+/** The developer's own backend, behind the local reverse proxy (see tabbr-ui's api-host.ts). */
+const DEFAULT_LOCAL_API_HOST = 'https://api.local.tabbr.be';
+
+const LOCAL_SUFFIX = '.local.tabbr.be';
+const RESPAWNED_MARKER = 'TABBR_CLI_LOCAL_TRUST_APPLIED';
+
+function isLocalApiHost(apiHost) {
+  try {
+    return new URL(apiHost).hostname.endsWith(LOCAL_SUFFIX);
+  } catch {
+    return false;
+  }
+}
+
+/** Where `mkcert -install` keeps its root CA, which signs the *.local.tabbr.be certificate. */
+function mkcertRootCa() {
+  const candidates = [];
+  if (process.env.CAROOT) candidates.push(path.join(process.env.CAROOT, 'rootCA.pem'));
+  if (process.platform === 'win32') {
+    candidates.push(path.join(process.env.LOCALAPPDATA || '', 'mkcert', 'rootCA.pem'));
+  } else if (process.platform === 'darwin') {
+    candidates.push(path.join(os.homedir(), 'Library', 'Application Support', 'mkcert', 'rootCA.pem'));
+  } else {
+    candidates.push(path.join(os.homedir(), '.local', 'share', 'mkcert', 'rootCA.pem'));
+  }
+  return candidates.find((candidate) => fs.existsSync(candidate));
+}
+
+/**
+ * Node ignores the OS trust store by default, so a local dev environment signed by mkcert's private
+ * root CA fails with a certificate error even though the browser trusts it. NODE_EXTRA_CA_CERTS is
+ * only read at process start, so when the target is a *.local.tabbr.be host this re-runs the CLI
+ * once as a child with it set (and exits with the child's status). No-op for any other host, when
+ * the variable is already set, or when mkcert's root CA can't be found.
+ */
+function trustLocalCertificateOrRespawn(apiHost) {
+  if (!isLocalApiHost(apiHost) || process.env.NODE_EXTRA_CA_CERTS || process.env[RESPAWNED_MARKER]) {
+    return;
+  }
+  const rootCa = mkcertRootCa();
+  if (!rootCa) {
+    console.warn(
+      `Publishing to ${apiHost} needs your mkcert root CA to be trusted, but it was not found. If the upload fails ` +
+      'with a certificate error, set NODE_EXTRA_CA_CERTS to the path of mkcert\'s rootCA.pem (see "mkcert -CAROOT").'
+    );
+    return;
+  }
+  const result = spawnSync(process.execPath, process.argv.slice(1), {
+    stdio: 'inherit',
+    env: { ...process.env, NODE_EXTRA_CA_CERTS: rootCa, [RESPAWNED_MARKER]: '1' },
+  });
+  process.exit(result.status === null ? 1 : result.status);
+}
+
+module.exports = { DEFAULT_LOCAL_API_HOST, isLocalApiHost, trustLocalCertificateOrRespawn };

package/src/publish.js

@@ -1,29 +1,31 @@
-'use strict';
-
-/** Uploads the zipped module build to the tabbr backend and returns the parsed JSON response. */
-async function publish({ apiHost, club, moduleId, exposedModule, exportName, icon, title, zipBuffer, accessToken }) {
-  const form = new FormData();
-  form.append('file', new Blob([zipBuffer], { type: 'application/zip' }), 'module.zip');
-  form.append('moduleId', moduleId);
-  form.append('exposedModule', exposedModule);
-  form.append('exportName', exportName);
-  if (icon) form.append('icon', icon);
-  if (title) form.append('title', title);
-
-  const url = `${apiHost}/api/custommodule`;
-  console.log(`Publishing ${moduleId} to club ${club.toUpperCase()} at ${url} ...`);
-  const response = await fetch(url, {
-    method: 'POST',
-    // X-club selects the club: the server publishes into the club CurrentClubFilter
-    // (tabbr-api-server) resolves from this header, the same club its ADMIN check runs against.
-    headers: { Authorization: `Bearer ${accessToken}`, 'X-club': club.toUpperCase() },
-    body: form,
-  });
-
-  if (!response.ok) {
-    throw new Error(`Publish failed: ${response.status} ${await response.text()}`);
-  }
-  return response.json();
-}
-
-module.exports = { publish };
+'use strict';
+
+/** Uploads the zipped module build to the tabbr backend and returns the parsed JSON response. */
+async function publish({ apiHost, club, moduleId, exposedModule, exportName, icon, title, zipBuffer, accessToken }) {
+  const form = new FormData();
+  form.append('file', new Blob([zipBuffer], { type: 'application/zip' }), 'module.zip');
+  form.append('moduleId', moduleId);
+  // Only present for a module with a frontend part - a backend-only module has neither, and the
+  // server's /api/custommodule accepts both as optional for exactly that reason.
+  if (exposedModule) form.append('exposedModule', exposedModule);
+  if (exportName) form.append('exportName', exportName);
+  if (icon) form.append('icon', icon);
+  if (title) form.append('title', title);
+
+  const url = `${apiHost}/api/custommodule`;
+  console.log(`Publishing ${moduleId} to club ${club.toUpperCase()} at ${url} ...`);
+  const response = await fetch(url, {
+    method: 'POST',
+    // X-club selects the club: the server publishes into the club CurrentClubFilter
+    // (tabbr-api-server) resolves from this header, the same club its ADMIN check runs against.
+    headers: { Authorization: `Bearer ${accessToken}`, 'X-club': club.toUpperCase() },
+    body: form,
+  });
+
+  if (!response.ok) {
+    throw new Error(`Publish failed: ${response.status} ${await response.text()}`);
+  }
+  return response.json();
+}
+
+module.exports = { publish };