arcadible 0.1.45 → 0.1.46

package/src/action/deploy/tool-git.js

@@ -2,10 +2,6 @@
 
 // [import]
 
-const semver = require("semver");
-
-// [import]
-
 const cfgcode = require("../../config/code");
 const error = require("../../util/error");
 const given = require("../../parser/given");
@@ -18,14 +14,13 @@ const repo = require("../predeploy/git");
 const ArcError = error.ArcError;
 const failWith = repo.failWith;
 const git = repo.git;
-const prereleaseSemver = semver.prerelease;
 const tagOf = repo.tagOf;
 
 // [function]
 
 const createTag = function (root, version) {
   const message =
-    prereleaseSemver(version) === null
+    links.channel(version) === links.PRODUCTION
       ? phrase.versionRelease(version)
       : phrase.versionPrerelease(version);
   return git(root, ["tag", "-a", tagOf(version), "-m", message]).then(

package/src/action/deploy/wait.js

@@ -3,8 +3,8 @@
 // [import]
 
 const api = require("../../api");
-const cfguri = require("../../config/uri");
 const delay = require("../../util/delay");
+const links = require("../../util/links");
 const repo = require("../predeploy/git");
 const time = require("../../util/time");
 
@@ -12,6 +12,7 @@ const time = require("../../util/time");
 
 const git = repo.git;
 const sleep = delay.sleep;
+const studioUrl = links.studioUrl;
 
 // [declare]
 
@@ -34,13 +35,6 @@ const transient = function (err) {
 
 // [function]
 
-// where a developer sees the release in Studio.
-const studioUrl = function (game) {
-  return `${cfguri.HOST_HTTP_STUDIO}/games/${game}/builds`;
-};
-
-// [function]
-
 // the repository's GitHub Actions page, from origin's URL, or null when
 // origin isn't on GitHub.
 const actionsUrl = function (root) {
@@ -95,7 +89,7 @@ const findGit = function ({ account, game, headers, since, version }) {
 // checks the release until it's published or failed, or `timeout` seconds
 // pass. Resolves { release, timedOut }; `release` is null when it was never
 // found. `onRelease` hears each release it finds.
-const poll = function (find, timeout, onRelease) {
+const pollRelease = function (find, timeout, onRelease) {
   const deadline = Date.now() + timeout * 1000;
   // one check, then the next, each after the last: `last` is the newest
   // release found, kept through a check that fails for a moment.
@@ -150,12 +144,12 @@ const main = function (
       })
     : findDirect(deployed.release, headers);
   return Promise.all([
-    poll(find, timeout, onRelease),
+    pollRelease(find, timeout, onRelease),
     isGit ? actionsUrl(root) : null,
   ]).then(([{ release, timedOut }, actions]) => ({
     actions,
     release,
-    studio: owns ? studioUrl(game) : null,
+    studio: owns ? studioUrl(game, "builds") : null,
     timedOut,
   }));
 };

package/src/action/init/manifest.js

@@ -11,40 +11,20 @@ const fs = require("fs-extra");
 
 // [import]
 
-const cfgcode = require("../../config/code");
-const cfgproduct = require("../../config/product");
+const cfgfile = require("../../config/file");
 const env = require("../../parser/env");
-const error = require("../../util/error");
-const phrase = require("../../phrase");
+const manifest = require("../../parser/manifest");
 const TOML = require("../../util/toml");
 
 // [use]
 
-const ArcError = error.ArcError;
 const join = path.join;
-const pathExists = fs.pathExists;
 const randomUUID = crypto.randomUUID;
-const readFile = fs.promises.readFile;
 const writeFile = fs.promises.writeFile;
 
 // [declare]
 
-const HANDLE = cfgproduct.handle;
-const MANIFEST = `${HANDLE}.toml`;
-
-// [function]
-
-const parseToml = function (buf) {
-  try {
-    return TOML.parse(buf);
-  } catch (ex) {
-    throw new ArcError(
-      cfgcode.PARSE_FAILED,
-      phrase.unableToParse(MANIFEST, ex.message),
-      { cause: ex },
-    );
-  }
-};
+const MANIFEST = cfgfile.MANIFEST;
 
 // [function]
 
@@ -64,14 +44,6 @@ const pickVersion = function (version, envVersion) {
 
 // [function]
 
-const readManifest = function (file) {
-  return pathExists(file)
-    .then((exists) => (exists ? readFile(file, "utf8") : null))
-    .then((buf) => (buf === null ? {} : parseToml(buf)));
-};
-
-// [function]
-
 // a new project always gets its own id: a template's, such as an existing
 // game's, belongs to that game.
 const patchGame = function (envVersion, game = {}, { fresh = false } = {}) {
@@ -85,10 +57,10 @@ const patchGame = function (envVersion, game = {}, { fresh = false } = {}) {
 
 // [function]
 
-const shouldWrite = function (manifest, next) {
+const shouldWrite = function (written, next) {
   return (
-    manifest.game?.id !== next.game?.id ||
-    manifest.game?.version !== next.game?.version
+    written.game?.id !== next.game?.id ||
+    written.game?.version !== next.game?.version
   );
 };
 
@@ -96,10 +68,10 @@ const shouldWrite = function (manifest, next) {
 
 const prepare = function (dest, envVersion, opts) {
   const file = join(dest, MANIFEST);
-  return readManifest(file).then((manifest) => {
-    const { game, ...rest } = manifest;
+  return manifest.read(dest).then((written) => {
+    const { game, ...rest } = written;
     const next = { game: patchGame(envVersion, game, opts), ...rest };
-    if (shouldWrite(manifest, next)) {
+    if (shouldWrite(written, next)) {
       return writeFile(file, TOML.stringify(next), "utf8");
     }
     return null;

package/src/action/login/flow.js

@@ -60,11 +60,8 @@ const createFlow = function ({ expiresAt, secret, type }, onLoginCreated) {
 
 // [function]
 
-const pollFlow = function (value, onLoginPoll) {
+const pollFlow = function (value) {
   return flow(value).then(({ data, status }) => {
-    if (onLoginPoll) {
-      onLoginPoll({ status });
-    }
     switch (status) {
       case "pending":
         return null;
@@ -83,7 +80,7 @@ const pollFlow = function (value, onLoginPoll) {
 
 // [function]
 
-const main = function ({ onLoginCreated, onLoginPoll }) {
+const main = function ({ onLoginCreated }) {
   const expiresAt = new Date(Date.now() + time.m(10));
   const secret = randomUUID();
   return createFlow(
@@ -95,11 +92,7 @@ const main = function ({ onLoginCreated, onLoginPoll }) {
     onLoginCreated,
   ).then(({ id }) => {
     const timeout = Math.max(0, expiresAt.getTime() - Date.now() - time.s(15));
-    return poll(
-      (value) => pollFlow(value, onLoginPoll),
-      { id, secret },
-      { ...POLL, timeout },
-    );
+    return poll(pollFlow, { id, secret }, { ...POLL, timeout });
   });
 };
 

package/src/action/open/tool.js

@@ -7,8 +7,9 @@ const self = require("../../parser/self");
 
 // [function]
 
+// the store page's path, which the app opens, and its URL on the web.
 const openUrl = function (id) {
-  return id ? { page: links.storePage(id) } : null;
+  return id ? { page: links.storePage(id), url: links.storeUrl(id) } : null;
 };
 
 // [function]

package/src/action/pack/limits.js

@@ -3,6 +3,7 @@
 // [import]
 
 const cfgcode = require("../../config/code");
+const cfglimit = require("../../config/limit");
 const error = require("../../util/error");
 const phrase = require("../../phrase");
 const size = require("../../util/size");
@@ -14,12 +15,9 @@ const toMb = size.toMb;
 
 // [declare]
 
-// the limits on a packed game, uncompressed, as Arcadible enforces them when
-// it publishes a release. They're checked here so a build that would fail
-// there fails before it's uploaded.
-const MAX_FILES = 10000;
-const MAX_FILE_SIZE = size.mb(64);
-const MAX_TOTAL_SIZE = size.mb(256);
+const MAX_FILES = cfglimit.FILES;
+const MAX_FILE_SIZE = cfglimit.FILE_SIZE;
+const MAX_TOTAL_SIZE = cfglimit.TOTAL_SIZE;
 
 // [function]
 

package/src/action/pack/tool.js

@@ -11,6 +11,8 @@ const fs = require("fs-extra");
 // [import]
 
 const cfgcode = require("../../config/code");
+const cfgfile = require("../../config/file");
+const cfglimit = require("../../config/limit");
 const cfgproduct = require("../../config/product");
 const error = require("../../util/error");
 const given = require("../../parser/given");
@@ -28,19 +30,18 @@ const resolve = path.resolve;
 
 // [declare]
 
-const HANDLE = cfgproduct.handle;
 const TOOL = cfgproduct.tool;
 
 // [declare]
 
 const MAIN = "index.html";
-const MANIFEST = `${HANDLE}.json`;
-const MEDIA = `.${HANDLE}`;
+const MANIFEST = cfgfile.PACKAGED;
+const MEDIA = cfgfile.MEDIA;
 const OUTPUT = `.${TOOL}/package`;
 
 // [declare]
 
-const SIZE_PARTIAL = size.mb(64);
+const SIZE_PARTIAL = cfglimit.ZIP_SIZE;
 
 // [function]
 
@@ -50,7 +51,7 @@ const verifyPartial = function (zip) {
   if (!zip.has(MAIN)) {
     throw new ArcError(
       cfgcode.PACKAGE_INDEX_MISSING,
-      phrase.packageFileMissing(MAIN),
+      phrase.packageIndexMissing(MAIN),
     );
   }
   limits.check(zip.entries());

package/src/action/play/tool.js

@@ -18,7 +18,7 @@ const ArcError = error.ArcError;
 // the game, `select`ed, or null when the API can't be reached. It rejects
 // when the game isn't on Arcadible: its builds can't say, since a game that
 // doesn't exist has none.
-const lookup = function (id, select) {
+const findGame = function (id, select) {
   return api.discoverGame(id, { select }).catch((err) => {
     if (err?.status === 404) {
       throw new ArcError(cfgcode.GAME_NOT_FOUND, phrase.gameNotFound(id));
@@ -68,7 +68,7 @@ const play = function (id, release) {
   if (!id) {
     return Promise.resolve(null);
   }
-  return lookup(id, "orientation").then((game) =>
+  return findGame(id, "orientation").then((game) =>
     target(id, game?.orientation, release),
   );
 };
@@ -85,7 +85,7 @@ const playSelf = function (root, release) {
         return [null, null];
       }
       return Promise.all([
-        release ? null : lookup(id, "id"),
+        release ? null : findGame(id, "id"),
         target(id, game.orientation, release),
       ]);
     })

package/src/action/predeploy/ac.js

@@ -14,27 +14,26 @@ const ArcError = error.ArcError;
 
 // [function]
 
-// fails when the game is on Arcadible on another account: it was deleted
-// (the API doesn't find it, and the upload is refused), or it's someone
-// else's. A game that isn't on Arcadible yet passes.
+// a lookup's failure, passed over when it's a 404: nothing there to refuse.
+const ignoreMissing = function (err) {
+  if (err.status !== 404) {
+    throw err;
+  }
+};
+
+// [function]
+
+// fails when the game is another account's. A game the API doesn't find
+// passes: it isn't on Arcadible yet, or it was deleted, which the upload
+// refuses.
 const ensureOwned = function (current, id) {
-  return api.discoverGame(id).then(
-    (game) => {
-      // a token's account isn't known yet; the server checks ownership when
-      // it authorizes the upload.
-      if (!current?.token && game.account !== current?.user?.id) {
-        throw new ArcError(
-          cfgcode.GAME_UNAVAILABLE,
-          phrase.gameUnavailable(id),
-        );
-      }
-    },
-    (err) => {
-      if (err.status !== 404) {
-        throw err;
-      }
-    },
-  );
+  return api.discoverGame(id).then((game) => {
+    // a token's account isn't known yet; the server checks ownership when
+    // it authorizes the upload.
+    if (!current?.token && game.account !== current?.user?.id) {
+      throw new ArcError(cfgcode.GAME_UNAVAILABLE, phrase.gameUnavailable(id));
+    }
+  }, ignoreMissing);
 };
 
 // [function]
@@ -45,21 +44,14 @@ const ensureHandle = function ({ handle, id }) {
   if ((handle ?? null) === null) {
     return Promise.resolve(null);
   }
-  return api.discoverGame(handle).then(
-    (game) => {
-      if (game.id !== id) {
-        throw new ArcError(
-          cfgcode.GAME_HANDLE_TAKEN,
-          phrase.gameHandleTaken(handle),
-        );
-      }
-    },
-    (err) => {
-      if (err.status !== 404) {
-        throw err;
-      }
-    },
-  );
+  return api.discoverGame(handle).then((game) => {
+    if (game.id !== id) {
+      throw new ArcError(
+        cfgcode.GAME_HANDLE_TAKEN,
+        phrase.gameHandleTaken(handle),
+      );
+    }
+  }, ignoreMissing);
 };
 
 // [function]
@@ -79,14 +71,7 @@ const ensureUnpublished = function (current, game) {
   const { id, version } = game;
   return api
     .gameBuild(id, version, null, api.auth(current?.session?.access_token))
-    .then(
-      () => published.refuse(id, version),
-      (err) => {
-        if (err.status !== 404) {
-          throw err;
-        }
-      },
-    )
+    .then(() => published.refuse(id, version), ignoreMissing)
     .then(() => game);
 };
 

package/src/action/predeploy/git.js

@@ -7,6 +7,7 @@ const cp = require("node:child_process");
 // [import]
 
 const cfgcode = require("../../config/code");
+const cfgfile = require("../../config/file");
 const cfgproduct = require("../../config/product");
 const error = require("../../util/error");
 const phrase = require("../../phrase");
@@ -20,8 +21,7 @@ const execFile = cp.execFile;
 
 const HANDLE = cfgproduct.handle;
 const PREFIX = `${HANDLE}/release/v`;
-// the release workflow, which builds the release on GitHub Actions.
-const WORKFLOW = ".github/workflows/arcadible-release.yml";
+const WORKFLOW = cfgfile.WORKFLOW;
 // a remote's URL: `scheme://[user@]host/path`, or scp-like
 // `[user@]host:path`. A path on this machine is neither.
 const URL_REMOTE = /^[a-z][a-z0-9+.-]*:\/\/(?:[^@/\s]+@)?[^/\s]+\/(\S+)$/iu;
@@ -70,7 +70,7 @@ const tagOf = function (version) {
 const ensureClean = function (root) {
   return git(root, ["status", "--porcelain"]).then((stdout) => {
     if (stdout.trim()) {
-      throw new ArcError(cfgcode.GIT_UNCOMMITTED, phrase.gitChangesPresent());
+      throw new ArcError(cfgcode.GIT_UNCOMMITTED, phrase.gitUncommitted());
     }
   });
 };
@@ -200,7 +200,7 @@ const ensureTagFree = function (root, version) {
       if (exists) {
         throw new ArcError(
           cfgcode.GIT_TAG_EXISTS,
-          phrase.gitVersionExists(version),
+          phrase.gitTagExists(version),
         );
       }
     });

package/src/action/predeploy/pm.js

@@ -37,7 +37,7 @@ const ensureLockFile = function (root) {
   const has = (file) => existsSync(join(root, file));
   if (has("package.json") && !LOCK_FILES.some(has)) {
     return Promise.reject(
-      new ArcError(cfgcode.LOCKFILE_MISSING, phrase.noLockFile()),
+      new ArcError(cfgcode.LOCKFILE_MISSING, phrase.lockfileMissing()),
     );
   }
   return Promise.resolve();

package/src/action/predeploy/published.js

@@ -52,7 +52,7 @@ const next = function (version, { production, staging }) {
 
 // the error for a version that's already published, naming what's newest on
 // each channel and a version to bump to.
-const versionPublished = function (id, version) {
+const versionExists = function (id, version) {
   return Promise.all([
     latest(id, links.PRODUCTION),
     latest(id, links.STAGING),
@@ -60,7 +60,7 @@ const versionPublished = function (id, version) {
     const found = { production, staging };
     return new ArcError(
       cfgcode.VERSION_EXISTS,
-      phrase.versionPublished(version, {
+      phrase.versionExists(version, {
         ...found,
         next: next(version, found),
       }),
@@ -70,9 +70,9 @@ const versionPublished = function (id, version) {
 
 // [function]
 
-// rejects with versionPublished's error.
+// rejects with versionExists's error.
 const refuse = function (id, version) {
-  return versionPublished(id, version).then((err) => {
+  return versionExists(id, version).then((err) => {
     throw err;
   });
 };

package/src/action/predeploy/tool-git.js

@@ -4,10 +4,10 @@
 
 const api = require("../../api");
 const cfgcode = require("../../config/code");
-const cfguri = require("../../config/uri");
 const error = require("../../util/error");
 const git = require("./git");
 const given = require("../../parser/given");
+const links = require("../../util/links");
 const phrase = require("../../phrase");
 const pm = require("./pm");
 const published = require("./published");
@@ -23,12 +23,13 @@ const ensureRoot = git.ensureRoot;
 const ensureTagFree = git.ensureTagFree;
 const ensureWorkflow = git.ensureWorkflow;
 const originRepo = git.originRepo;
+const studioUrl = links.studioUrl;
 
 // [function]
 
 // a public lookup's answer: found (200, with its data), missing (404), or
 // null for any other answer, such as when the API can't be reached.
-const lookup = function (request) {
+const answerOf = function (request) {
   return request.then(
     (data) => ({ data, status: 200 }),
     (err) => (err.status === 404 ? { status: 404 } : null),
@@ -45,8 +46,8 @@ const lookup = function (request) {
 // resolves with the game's owner, or null when Arcadible can't be reached.
 const ensurePublishable = function ({ handle, id, version }, handler) {
   return Promise.all([
-    lookup(api.discoverGame(id)),
-    lookup(api.discoverGameBuild(id, version)),
+    answerOf(api.discoverGame(id)),
+    answerOf(api.discoverGameBuild(id, version)),
   ]).then(([game, build]) => {
     if (game?.status === 404) {
       throw new ArcError(
@@ -55,10 +56,9 @@ const ensurePublishable = function ({ handle, id, version }, handler) {
       );
     }
     if (game === null || build === null) {
-      if (handler.onLogInfo) {
-        handler.onLogInfo({
+      if (handler.onWarning) {
+        handler.onWarning({
           code: cfgcode.WARNING.VERSION_UNCHECKED,
-          level: "warn",
           message: phrase.versionUnchecked(version),
         });
       }
@@ -96,17 +96,17 @@ const ensureConnected = function (root, { handle, id }) {
     .then((found) => {
       repo = found;
       return repo
-        ? lookup(api.discoverGameRepo(id, repo.owner, repo.name))
+        ? answerOf(api.discoverGameRepo(id, repo.owner, repo.name))
         : null;
     })
     .then((connected) => {
       if (connected?.status === 404) {
         throw new ArcError(
           cfgcode.REPO_NOT_CONNECTED,
-          phrase.gameRepoMissing(
+          phrase.repoNotConnected(
             handle ?? id,
             `${repo.owner}/${repo.name}`,
-            `${cfguri.HOST_HTTP_STUDIO}/games/${id}/repository`,
+            studioUrl(id, "repository"),
           ),
         );
       }

package/src/action/validate/unknown.js

@@ -5,12 +5,15 @@
 const cfgcode = require("../../config/code");
 const game = require("../../schema/game");
 const manifest = require("../../parser/manifest");
+const objs = require("../../util/objs");
+const phrase = require("../../phrase");
 const strs = require("../../util/strs");
 const workflow = require("../../schema/workflow");
 
 // [use]
 
 const closest = strs.closest;
+const isTable = objs.isTable;
 const WARNING = cfgcode.WARNING;
 
 // [function]
@@ -30,7 +33,7 @@ const known = function (root) {
 const warning = function (path, message, near) {
   return {
     code: WARNING.FIELD_UNKNOWN,
-    details: near ? [`Did you mean: ${near}?`] : [],
+    details: near ? [phrase.didYouMean(near)] : [],
     link: null,
     message,
     path,
@@ -43,13 +46,11 @@ const warning = function (path, message, near) {
 // it is, in the table that takes it, if any.
 const untabled = function (fields, name) {
   const table = Object.keys(fields).find((each) => fields[each].includes(name));
-  return warning(name, "Unknown field.", table ? `${table}.${name}` : null);
-};
-
-// [function]
-
-const isTable = function (value) {
-  return value !== null && typeof value === "object" && !Array.isArray(value);
+  return warning(
+    name,
+    phrase.unknownField(),
+    table ? `${table}.${name}` : null,
+  );
 };
 
 // [function]
@@ -65,14 +66,14 @@ const main = function (root) {
         return Object.hasOwn(fields, table) ? [] : [untabled(fields, table)];
       }
       if (!Object.hasOwn(fields, table)) {
-        return [warning(table, "Unknown table.", closest(table, tables))];
+        return [warning(table, phrase.unknownTable(), closest(table, tables))];
       }
       return Object.keys(values)
         .filter((field) => !fields[table].includes(field))
         .map((field) =>
           warning(
             `${table}.${field}`,
-            "Unknown field.",
+            phrase.unknownField(),
             closest(field, fields[table]),
           ),
         );

package/src/config/file.js

@@ -0,0 +1,23 @@
+"use strict";
+
+// [import]
+
+const cfgproduct = require("./product");
+
+// [declare]
+
+const HANDLE = cfgproduct.handle;
+const MEDIA = `.${HANDLE}`;
+
+// [export]
+
+// the project's files Arcadible reads, relative to its root, and the
+// manifest arc pack writes into the zip.
+module.exports = {
+  GALLERY: `${MEDIA}/gallery`,
+  MANIFEST: `${HANDLE}.toml`,
+  MEDIA,
+  PACKAGED: `${HANDLE}.json`,
+  // the release workflow, which builds a `git` release on GitHub Actions.
+  WORKFLOW: `.github/workflows/${HANDLE}-release.yml`,
+};

package/src/config/limit.js

@@ -0,0 +1,21 @@
+"use strict";
+
+// [declare]
+
+const MB = 1024 * 1024;
+
+// [export]
+
+// the limits on a packed game, as Arcadible enforces them when it publishes
+// a release (docs: limits.md). arc pack checks them so a build that would
+// fail there fails before it's uploaded.
+module.exports = {
+  // the most files in the zip.
+  FILES: 10000,
+  // the largest file, uncompressed.
+  FILE_SIZE: 64 * MB,
+  // everything packed, uncompressed.
+  TOTAL_SIZE: 256 * MB,
+  // the zip of deploy_dir alone, compressed.
+  ZIP_SIZE: 64 * MB,
+};

package/src/parser/env.js

@@ -58,10 +58,8 @@ const parseJson = function (buf) {
 // (node_modules/.bin), and its prebuild and postbuild run, as they do
 // locally. npm runs the scripts of a pnpm or Yarn project too.
 const extract = function (conf) {
-  /* eslint-disable camelcase */
   const game = { version: conf.version };
   const workflow = conf.scripts?.build ? { build: NPM_RUN_BUILD } : {};
-  /* eslint-enable camelcase */
   return deepCompact({ game, workflow }) ?? {};
 };