drop2run 0.2.1 → 0.4.0

package/README.md

@@ -16,6 +16,7 @@ drop2run login [--device]                    Sign in and store a token
 drop2run logout                              Remove the stored token
 drop2run init [dir] [--site <subdomain>]     Tie this folder to a site
 drop2run deploy [dir] [--site <subdomain>]   Publish a folder
+drop2run init|deploy --subdomain <name>      Create a new site under a name you pick
 drop2run ls                                  List your sites
 drop2run open [site]                         Open a site in a browser
 drop2run rollback <deployId> [--site X]      Put an earlier version back live
@@ -30,14 +31,26 @@ drop2run --version                           Print the version
 
 ## Which site a command acts on
 
-`--site`, then `drop2run.json`, then a new one. `init` writes that file, so this is the whole of a
-normal project:
+`--subdomain` creates one under the name you give; otherwise `--site`, then `drop2run.json`, then a new
+site with a generated name. `init` writes that file, so this is the whole of a normal project:
 
 ```bash
 drop2run init dist        # creates a site, writes drop2run.json
 drop2run deploy           # publishes dist to it, no arguments
 ```
 
+```bash
+drop2run init dist --subdomain my-docs    # same, but you choose the address
+```
+
+Lowercase letters, digits and hyphens, not starting or ending with one. A name that is taken, reserved,
+or past the number of self-picked names your plan allows is refused with the reason. It cannot be changed
+later — a site is reached by the address it was created with — so a wrong name means deleting the site,
+which is not undoable.
+
+`--site` never creates anything: it finds a site you already have, and fails when nothing matches. That
+is what keeps a subdomain typed one letter wrong from quietly becoming a second site.
+
 `deploy` never creates a second site while a `drop2run.json` sits next to it — that would leave the real
 site untouched and you looking at a URL you did not expect.
 

package/dist/index.js

@@ -55,11 +55,17 @@ async function listSites(credentials) {
   const body = await call(credentials, "sites");
   return body.sites;
 }
-async function createSite(credentials) {
+async function createSite(credentials, subdomain) {
   const created = await call(
     credentials,
     "sites",
-    { method: "POST", body: JSON.stringify({}) }
+    {
+      method: "POST",
+      // An absent field rather than a null one, because the API reads null, empty and missing the
+      // same way and a body carrying only what was asked for is the one that reads correctly in a
+      // log.
+      body: JSON.stringify(subdomain === void 0 ? {} : { subdomain })
+    }
   );
   return { ...created, name: null };
 }
@@ -369,6 +375,7 @@ const ClientErrorCode = {
   /** An upload kept failing after every retry. */
   UploadFailed: "upload_failed"
 };
+const ACCOUNT_HEADER = "X-Drop2Run-Account";
 const CLAIM_TOKEN_HEADER = "X-Claim-Token";
 async function prepareDeploy(siteId, files, options, signal) {
   const manifest = files.map((file) => ({
@@ -405,6 +412,7 @@ async function request(path, body, options, signal) {
   if (body !== void 0) headers["Content-Type"] = "application/json";
   if (options.claimToken) headers[CLAIM_TOKEN_HEADER] = options.claimToken;
   if (options.token) headers.Authorization = `Bearer ${options.token}`;
+  if (options.accountId) headers[ACCOUNT_HEADER] = options.accountId;
   const response = await doFetch(`${base}/${path}`, {
     method: "POST",
     headers,
@@ -517,7 +525,7 @@ function renameOfLoneHtmlPage(paths) {
   const lower = only.toLowerCase();
   return lower.endsWith(".html") || lower.endsWith(".htm") ? only : null;
 }
-function formatBytes(bytes) {
+function formatBytes$1(bytes) {
   if (bytes < 1024) return `${bytes} B`;
   if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
   if (bytes < 1024 * 1024 * 1024) return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
@@ -548,7 +556,7 @@ function checkLimits(files, limits) {
   if (oversized) {
     throw new DeployError(
       ClientErrorCode.FileTooLarge,
-      `${oversized.path} is ${formatBytes(oversized.bytes.length)}, and this plan allows ${formatBytes(limits.maxFileBytes)} per file.`,
+      `${oversized.path} is ${formatBytes$1(oversized.bytes.length)}, and this plan allows ${formatBytes$1(limits.maxFileBytes)} per file.`,
       {
         path: oversized.path,
         limit: limits.maxFileBytes,
@@ -560,7 +568,7 @@ function checkLimits(files, limits) {
   if (limits.maxSiteBytes !== null && total > limits.maxSiteBytes) {
     throw new DeployError(
       ClientErrorCode.TooLarge,
-      `That drop is ${formatBytes(total)}, and this plan allows ${formatBytes(limits.maxSiteBytes)}.`,
+      `That drop is ${formatBytes$1(total)}, and this plan allows ${formatBytes$1(limits.maxSiteBytes)}.`,
       { limit: limits.maxSiteBytes, actual: total }
     );
   }
@@ -698,7 +706,7 @@ async function uploadAll(targets, uploadUrl, files, onProgress, signal, deps = {
       });
       done += 1;
       uploadedBytes += file.bytes.length;
-      onProgress?.(done, targets.length, uploadedBytes);
+      onProgress?.(done, targets.length, uploadedBytes, file.path);
     }
   };
   const workers = Array.from(
@@ -793,12 +801,13 @@ async function deploy(source, siteId, onProgress, signal, options = {}) {
       prepared.upload,
       prepared.uploadUrl,
       hashed,
-      (done, _total, bytes) => onProgress({
+      (done, _total, bytes, path) => onProgress({
         type: "uploading",
         done: prepared.reused + done,
         total: prepared.total,
         bytes,
-        reused: prepared.reused
+        reused: prepared.reused,
+        path
       }),
       signal,
       options.upload
@@ -864,7 +873,15 @@ function escapesRoot(root, candidate) {
   const inside = relative(root, candidate);
   return inside === "" || inside.startsWith("..");
 }
-async function resolveSite(credentials, site) {
+async function resolveSite(credentials, site, subdomain) {
+  if (subdomain !== void 0) {
+    if (site !== void 0) {
+      throw new Error(
+        "Give either an existing site or a subdomain for a new one, not both: publishing over a site and creating one are different requests."
+      );
+    }
+    return await createSite(credentials, subdomain);
+  }
   if (site === void 0) return await createSite(credentials);
   const wanted = site.trim().toLowerCase();
   const found = (await listSites(credentials)).find(
@@ -872,13 +889,13 @@ async function resolveSite(credentials, site) {
   );
   if (found === void 0) {
     throw new Error(
-      `No site of yours is called "${site}". Leave the site out to publish to a new one, or use list_sites to see what exists.`
+      `No site of yours is called "${site}". Leave the site out to publish to a new one, or list your sites to see what exists.`
     );
   }
   return found;
 }
-async function publish(credentials, source, site) {
-  const target = await resolveSite(credentials, site);
+async function publish(credentials, source, site, onProgress, subdomain) {
+  const target = await resolveSite(credentials, site, subdomain);
   let files = 0;
   let url = target.url;
   let unchanged = false;
@@ -895,6 +912,7 @@ async function publish(credentials, source, site) {
       failure2 = event.message;
       failureDetail = event.detail;
     }
+    onProgress?.(event);
   };
   await deploy(source, target.siteId, record, void 0, {
     baseUrl: credentials.apiBaseUrl,
@@ -908,8 +926,75 @@ async function publish(credentials, source, site) {
   });
   return { url, siteId: target.siteId, subdomain: target.subdomain, files, unchanged };
 }
-function publishDirectory(credentials, directory, site) {
-  return publish(credentials, directorySource(directory), site);
+function publishDirectory(credentials, directory, site, onProgress, subdomain) {
+  return publish(credentials, directorySource(directory), site, onProgress, subdomain);
+}
+const silentProgress = Object.assign(() => {
+}, { done: () => {
+} });
+const STEP = 1024;
+const UNITS = ["B", "KB", "MB", "GB"];
+function formatBytes(bytes) {
+  let value = bytes;
+  let unit = 0;
+  while (value >= STEP && unit < UNITS.length - 1) {
+    value /= STEP;
+    unit += 1;
+  }
+  return `${unit === 0 ? value : value.toFixed(1)} ${UNITS[unit]}`;
+}
+function shortenPath(path, width) {
+  if (path.length <= width) return path;
+  return `…${path.slice(path.length - width + 1)}`;
+}
+function describe(event, width = 80) {
+  switch (event.type) {
+    case "collecting":
+      return `Collected ${event.files.toLocaleString()} ${event.files === 1 ? "file" : "files"}`;
+    case "hashing":
+      return `Hashing ${event.done.toLocaleString()}/${event.total.toLocaleString()}`;
+    case "preparing":
+      return "Asking the server which files it already has";
+    case "uploading": {
+      const counted = `Uploading ${event.done.toLocaleString()}/${event.total.toLocaleString()}`;
+      const reused = event.reused === 0 ? "" : ` (${event.reused.toLocaleString()} already there)`;
+      const head = `${counted}${reused} · ${formatBytes(event.bytes)}`;
+      const room = width - head.length - 3;
+      return event.path === void 0 || room < 12 ? head : `${head} · ${shortenPath(event.path, room)}`;
+    }
+    case "completing":
+      return "Publishing";
+    // Both end the deploy, and the command prints the URL from the result it returns. Saying it here
+    // as well would print it twice, once on stderr and once on stdout.
+    case "done":
+    case "unchanged":
+    case "error":
+      return null;
+  }
+}
+function progressWriter(write, isTerminal, width = 80) {
+  let painted = 0;
+  let lastStage = null;
+  const writer = ((event) => {
+    const line = describe(event, width - 1);
+    if (line === null) return;
+    if (!isTerminal) {
+      if (event.type === lastStage) return;
+      lastStage = event.type;
+      write(`${line}
+`);
+      return;
+    }
+    lastStage = event.type;
+    write(`\r${line}${" ".repeat(Math.max(0, painted - line.length))}`);
+    painted = line.length;
+  });
+  writer.done = () => {
+    if (!isTerminal || painted === 0) return;
+    write(`\r${" ".repeat(painted)}\r`);
+    painted = 0;
+  };
+  return writer;
 }
 function failure(text) {
   return { text, json: { error: text }, code: 1 };
@@ -1053,14 +1138,20 @@ async function list() {
     code: 0
   };
 }
-async function deployCommand(directory, site) {
+async function deployCommand(directory, site, report = silentProgress, subdomain) {
   const found = credentialsOr();
   if ("result" in found) return found.result;
   const project = readProject();
-  const target = site ?? project?.siteId;
   const folder = directory ?? project?.dir ?? ".";
+  const target = subdomain === void 0 ? site ?? project?.siteId : void 0;
   try {
-    const result = await publishDirectory(found.credentials, resolve(folder), target);
+    const result = await publishDirectory(
+      found.credentials,
+      resolve(folder),
+      target,
+      report,
+      subdomain
+    );
     const what = result.unchanged ? "Already up to date — nothing needed publishing." : `Published ${result.files.toLocaleString()} ${result.files === 1 ? "file" : "files"}.`;
     return {
       text: `${what}
@@ -1070,9 +1161,11 @@ ${result.url}`,
     };
   } catch (error) {
     return failureFrom(error);
+  } finally {
+    report.done();
   }
 }
-async function init(directory, site) {
+async function init(directory, site, subdomain) {
   const found = credentialsOr();
   if ("result" in found) return found.result;
   if (readProject() !== null) {
@@ -1081,7 +1174,7 @@ async function init(directory, site) {
     );
   }
   try {
-    const target = site === void 0 ? await createSite(found.credentials) : await findSite(found.credentials, site);
+    const target = site === void 0 ? await createSite(found.credentials, subdomain) : await findSite(found.credentials, site);
     const project = {
       siteId: target.siteId,
       subdomain: target.subdomain,
@@ -1219,6 +1312,7 @@ const HELP = `drop2run — publish a static site from the command line
   drop2run logout                              Remove the stored token
   drop2run init [dir] [--site <subdomain>]     Tie this folder to a site (writes drop2run.json)
   drop2run deploy [dir] [--site <subdomain>]   Publish a folder (default: . or drop2run.json)
+  drop2run init|deploy --subdomain <name>      Create a new site under a name you pick
   drop2run ls                                  List your sites
   drop2run open [site]                         Open a site in a browser
   drop2run rollback <deployId> [--site X]      Put an earlier version back live
@@ -1229,14 +1323,19 @@ const HELP = `drop2run — publish a static site from the command line
   drop2run --version                           Print the version
 
 Flags
-  --json      Print machine-readable output instead of text
-  --site X    Act on an existing site rather than the one in drop2run.json
-  --device    Sign in by approving a code on another machine
-  --yes       Confirm a deletion, which cannot be undone
+  --json         Print machine-readable output instead of text
+  --site X       Act on an existing site rather than the one in drop2run.json
+  --subdomain X  Create a new site under this name (init and deploy only)
+  --device       Sign in by approving a code on another machine
+  --yes          Confirm a deletion, which cannot be undone
 
 Where a site comes from
-  --site, then drop2run.json, then a new one. \`init\` writes that file, so
-  \`deploy\` in the same folder needs no arguments at all.
+  --subdomain creates one under the name you give. Otherwise: --site, then
+  drop2run.json, then a new site with a generated name. \`init\` writes that
+  file, so \`deploy\` in the same folder needs no arguments at all.
+
+  --site only ever finds a site you already have; it never creates one, so a
+  subdomain typed wrong fails instead of quietly becoming a second site.
 
 Signing in
   \`login\` opens a browser and listens on 127.0.0.1, so it needs both on this
@@ -1253,12 +1352,25 @@ function flagValue(args, flag) {
   const value = args[at + 1];
   return value === void 0 || value.startsWith("-") ? void 0 : value;
 }
+function subdomainFlagProblem(argv, command, site, subdomain) {
+  if (!argv.includes("--subdomain")) return void 0;
+  if (subdomain === void 0) {
+    return "`--subdomain` needs a name after it, for example `--subdomain my-docs`.";
+  }
+  if (site !== void 0) {
+    return "`--site` and `--subdomain` cannot both be given: `--site` publishes to a site you already have, and `--subdomain` creates a new one. Drop whichever is not what you meant.";
+  }
+  if (command !== "init" && command !== "deploy") {
+    return `\`--subdomain\` only applies to \`init\` and \`deploy\`, which can create a site. Use \`--site\` to tell \`${command}\` which of your sites to act on.`;
+  }
+  return void 0;
+}
 async function run(argv) {
   const json = argv.includes("--json");
   const positional = argv.filter((argument) => !argument.startsWith("-"));
   const [command, ...rest] = positional;
   if (argv.includes("--version")) {
-    const { version } = await import("./package-D-UHpX_a.js").then(
+    const { version } = await import("./package-Cz51eZ2C.js").then(
       (module) => module.default
     );
     return { text: version, json: { version }, code: 0 };
@@ -1267,17 +1379,24 @@ async function run(argv) {
   if (askedForHelp) return { text: HELP, json: { help: HELP }, code: 0 };
   if (command === void 0) return { text: HELP, json: { help: HELP }, code: 1 };
   const site = flagValue(argv, "--site");
+  const subdomain = flagValue(argv, "--subdomain");
+  const refusal = subdomainFlagProblem(argv, command, site, subdomain);
+  if (refusal !== void 0) {
+    const failed = { text: refusal, json: { error: refusal }, code: 1 };
+    return json ? { ...failed, text: JSON.stringify(failed.json, null, 2) } : failed;
+  }
   const result = await dispatch(
     command,
     rest,
     site,
     json,
     argv.includes("--device"),
-    argv.includes("--yes")
+    argv.includes("--yes"),
+    subdomain
   );
   return json ? { ...result, text: JSON.stringify(result.json, null, 2) } : result;
 }
-async function dispatch(command, rest, site, json, device, confirmed) {
+async function dispatch(command, rest, site, json, device, confirmed, subdomain) {
   switch (command) {
     case "login": {
       const print = json ? () => {
@@ -1287,9 +1406,15 @@ async function dispatch(command, rest, site, json, device, confirmed) {
     case "logout":
       return logout();
     case "init":
-      return await init(rest[0] ?? ".", site);
-    case "deploy":
-      return await deployCommand(rest[0], site);
+      return await init(rest[0] ?? ".", site, subdomain);
+    case "deploy": {
+      const report = json ? silentProgress : progressWriter(
+        (text) => process.stderr.write(text),
+        process.stderr.isTTY === true,
+        process.stderr.columns ?? 80
+      );
+      return await deployCommand(rest[0], site, report, subdomain);
+    }
     case "ls":
     case "list":
       return await list();

package/dist/{package-D-UHpX_a.js → package-Cz51eZ2C.js}

@@ -1,5 +1,5 @@
 const name = "drop2run";
-const version = "0.2.1";
+const version = "0.4.0";
 const description = "Publish a static site to Drop2Run from the command line.";
 const license = "MIT";
 const type = "module";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "drop2run",
-	"version": "0.2.1",
+	"version": "0.4.0",
 	"description": "Publish a static site to Drop2Run from the command line.",
 	"license": "MIT",
 	"type": "module",