@tabbr/module-cli 0.1.0 → 0.3.0

package/src/publish.js

@@ -1,29 +1,103 @@
-'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();
+}
+
+/**
+ * Submits the zipped build as a new version of a store package (docs/module-store.md): POST
+ * /api/store/packages/<publisher>/<name>/versions with the build and the version's metadata. The
+ * version then waits for review; clubs install it from the store once it is approved.
+ */
+async function publishToStore({ apiHost, packageName, meta, zipBuffer, accessToken }) {
+  const form = new FormData();
+  form.append('file', new Blob([zipBuffer], { type: 'application/zip' }), 'module.zip');
+  form.append('meta', new Blob([JSON.stringify(meta)], { type: 'application/json' }));
+
+  const url = `${apiHost}/api/store/packages/${packageName}/versions`;
+  console.log(`Submitting ${packageName} ${meta.version} to the module store at ${url} ...`);
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: { Authorization: `Bearer ${accessToken}` },
+    body: form,
+  });
+  if (!response.ok) {
+    throw new Error(`Submit failed: ${response.status} ${await response.text()}`);
+  }
+  return response.json();
+}
+
+/** The version's metadata for the store, from tabbr.config.json (and the command line). */
+function storeMeta(args) {
+  const missing = [];
+  if (!args.package) missing.push('"package" (e.g. "acme/groups")');
+  if (!args.version) missing.push('"version" (e.g. "1.0.0")');
+  if (!args.engines || !args.engines.tabbr) missing.push('"engines": { "tabbr": "^1.0" } (the module API levels it runs on)');
+  if (missing.length) {
+    throw new Error(`Missing in tabbr.config.json for --store: ${missing.join(', ')}`);
+  }
+  return {
+    version: args.version,
+    moduleId: args.moduleId,
+    exposedModule: args.exposedModule,
+    exportName: args.exportName,
+    title: args.title,
+    icon: args.icon,
+    summary: args.summary,
+    changelog: args.changelog,
+    visibility: args.visibility,
+    engines: args.engines,
+    dependencies: args.dependencies || {},
+    optionalDependencies: args.optionalDependencies || {},
+    permissions: args.permissions || {},
+  };
+}
+
+/**
+ * Submits the workspace's source as a new version of a store package: POST
+ * /api/store/packages/<publisher>/<name>/sources. The store builds it (tabbr-module-builder) and
+ * only then puts it in review.
+ */
+async function submitSourceToStore({ apiHost, packageName, meta, sourceZip, accessToken }) {
+  const form = new FormData();
+  form.append('source', new Blob([sourceZip], { type: 'application/zip' }), 'source.zip');
+  form.append('meta', new Blob([JSON.stringify(meta)], { type: 'application/json' }));
+
+  const url = `${apiHost}/api/store/packages/${packageName}/sources`;
+  console.log(`Submitting the source of ${packageName} ${meta.version} to the module store at ${url} ...`);
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: { Authorization: `Bearer ${accessToken}` },
+    body: form,
+  });
+  if (!response.ok) {
+    throw new Error(`Submit failed: ${response.status} ${await response.text()}`);
+  }
+  return response.json();
+}
+
+module.exports = { publish, publishToStore, submitSourceToStore, storeMeta };

package/src/source.js

@@ -0,0 +1,70 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const { execFileSync } = require('child_process');
+const archiver = require('archiver');
+
+/** Never part of a module's source: installed packages, build output, caches, editor state. */
+const SKIP = new Set(['node_modules', 'dist', '.angular', 'out-tsc', '.git', '.yalc', '.idea', '.vscode', 'coverage']);
+
+/**
+ * The workspace's source files, as the module store builds them: the files git tracks (plus new ones git doesn't ignore)
+ * when the workspace is in a git repository, otherwise every file outside the SKIP folders. Paths relative to `cwd`.
+ */
+function sourceFiles(cwd) {
+  let listed = null;
+  try {
+    const out = execFileSync('git', ['ls-files', '-z', '--cached', '--others', '--exclude-standard', '--', '.'],
+      { cwd, encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] });
+    listed = out.split('\0').filter(Boolean);
+  } catch {
+    // not a git repository (or no git): walk the folder instead
+  }
+  const files = listed ?? walk(cwd, '');
+  return files
+    .filter(file => !file.split('/').some(part => SKIP.has(part)))
+    .filter(file => fs.existsSync(path.join(cwd, file)) && fs.statSync(path.join(cwd, file)).isFile())
+    .sort();
+}
+
+function walk(root, rel) {
+  const result = [];
+  for (const entry of fs.readdirSync(path.join(root, rel), { withFileTypes: true })) {
+    if (SKIP.has(entry.name)) continue;
+    const child = rel ? `${rel}/${entry.name}` : entry.name;
+    if (entry.isDirectory()) result.push(...walk(root, child));
+    else if (entry.isFile()) result.push(child);
+  }
+  return result;
+}
+
+/** A zip of the workspace's source (see sourceFiles), checked to have what the store needs to build it. */
+function packSource(cwd) {
+  const files = sourceFiles(cwd);
+  for (const required of ['package.json', 'package-lock.json']) {
+    if (!files.includes(required)) {
+      throw new Error(`${required} is missing in ${cwd}` +
+        (required === 'package-lock.json' ? ' - the store installs exactly the locked dependencies; run "npm install" and commit it' : ''));
+    }
+  }
+  // yalc-linked packages exist only on this machine: the store uses the platform's own SDK and CLI instead
+  const lock = fs.readFileSync(path.join(cwd, 'package-lock.json'), 'utf8');
+  if (lock.includes('file:.yalc/')) {
+    throw new Error('package-lock.json links @tabbr packages with yalc ("npm run link-local") - run "npm run unlink-local" ' +
+      'first: the store builds against the published packages and replaces @tabbr/module-sdk and -cli with the platform\'s own.');
+  }
+  return new Promise((resolve, reject) => {
+    const archive = archiver('zip', { zlib: { level: 9 } });
+    const chunks = [];
+    archive.on('data', chunk => chunks.push(chunk));
+    archive.on('end', () => resolve({ zip: Buffer.concat(chunks), files }));
+    archive.on('error', reject);
+    for (const file of files) {
+      archive.file(path.join(cwd, file), { name: file });
+    }
+    archive.finalize();
+  });
+}
+
+module.exports = { packSource, sourceFiles };