arcadible 1.0.1 → 1.0.4

package/src/api.js

@@ -11,6 +11,18 @@ const VERSION = "v1";
 
 // [function]
 
+// an API path with each value encoded as one segment, so a handle or version
+// can't add a segment or a query: pathOf`/games/${id}`.
+const pathOf = function (strings, ...values) {
+  return strings.reduce(
+    (out, each, i) =>
+      out + each + (i < values.length ? encodeURIComponent(values[i]) : ""),
+    "",
+  );
+};
+
+// [function]
+
 // the full URL of an API path, with `params` as its query. Undefined and null
 // params are left out.
 const endpoint = function (path, params) {
@@ -45,7 +57,7 @@ const postFlow = function (form, params, headers) {
 // [function]
 
 const flow = function (id, params, headers) {
-  return request.get(endpoint(`/flows/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/flows/${id}`, params), headers);
 };
 
 // [function]
@@ -57,20 +69,23 @@ const postUpload = function (form, params, headers) {
 // [function]
 
 const discoverGame = function (id, params, headers) {
-  return request.get(endpoint(`/discover/games/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/discover/games/${id}`, params), headers);
 };
 
 // [function]
 
 const discoverGameBuilds = function (id, params, headers) {
-  return request.get(endpoint(`/discover/games/${id}/builds`, params), headers);
+  return request.get(
+    endpoint(pathOf`/discover/games/${id}/builds`, params),
+    headers,
+  );
 };
 
 // [function]
 
 const discoverGameBuild = function (id, version, params, headers) {
   return request.get(
-    endpoint(`/discover/games/${id}/builds/${version}`, params),
+    endpoint(pathOf`/discover/games/${id}/builds/${version}`, params),
     headers,
   );
 };
@@ -80,7 +95,7 @@ const discoverGameBuild = function (id, version, params, headers) {
 // a game's releases, which anyone can read: what each says about itself.
 const discoverGameReleases = function (id, params, headers) {
   return request.get(
-    endpoint(`/discover/games/${id}/releases`, params),
+    endpoint(pathOf`/discover/games/${id}/releases`, params),
     headers,
   );
 };
@@ -90,10 +105,7 @@ const discoverGameReleases = function (id, params, headers) {
 // the game's connected repository, if it's `owner/name`; otherwise 404.
 const discoverGameRepo = function (id, owner, name, params, headers) {
   return request.get(
-    endpoint(
-      `/discover/games/${id}/repos/${encodeURIComponent(owner)}/${encodeURIComponent(name)}`,
-      params,
-    ),
+    endpoint(pathOf`/discover/games/${id}/repos/${owner}/${name}`, params),
     headers,
   );
 };
@@ -102,7 +114,18 @@ const discoverGameRepo = function (id, owner, name, params, headers) {
 
 const gameBuild = function (id, version, params, headers) {
   return request.get(
-    endpoint(`/games/${id}/builds/${version}`, params),
+    endpoint(pathOf`/games/${id}/builds/${version}`, params),
+    headers,
+  );
+};
+
+// [function]
+
+// whether the caller's game could take a handle on a deploy to `channel`:
+// its status is available, taken, limit, or lapsed.
+const gameHandle = function (id, handle, params, headers) {
+  return request.get(
+    endpoint(pathOf`/games/${id}/handles/${handle}`, params),
     headers,
   );
 };
@@ -110,13 +133,16 @@ const gameBuild = function (id, version, params, headers) {
 // [function]
 
 const release = function (id, params, headers) {
-  return request.get(endpoint(`/releases/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/releases/${id}`, params), headers);
 };
 
 // [function]
 
 const accountReleases = function (id, params, headers) {
-  return request.get(endpoint(`/accounts/${id}/releases`, params), headers);
+  return request.get(
+    endpoint(pathOf`/accounts/${id}/releases`, params),
+    headers,
+  );
 };
 
 // [export]
@@ -131,6 +157,7 @@ module.exports = {
   discoverGameRepo,
   flow,
   gameBuild,
+  gameHandle,
   postAuthRefresh,
   postFlow,
   postUpload,

package/src/config/code.js

@@ -13,6 +13,7 @@ const CLI = {
   ARGUMENT_INVALID: "argument_invalid",
   BUILD_FAILED: "build_failed",
   DEPLOY_DIR_MISSING: "deploy_dir_missing",
+  DEPLOY_RATE_LIMITED: "deploy_rate_limited",
   GAME_HANDLE_TAKEN: "game_handle_taken",
   GAME_ID_MISSING: "game_id_missing",
   GAME_NOT_DEPLOYED: "game_not_deployed",
@@ -43,7 +44,6 @@ const CLI = {
   TEMPLATE_MISSING: "template_missing",
   TEMPLATE_UNAVAILABLE: "template_unavailable",
   UPLOAD_FAILED: "upload_failed",
-  UPLOAD_RATE_LIMITED: "upload_rate_limited",
   VALIDATION_FAILED: "validation_failed",
   WAIT_TIMED_OUT: "wait_timed_out",
 };
@@ -104,6 +104,8 @@ const ISSUE = {
 const WARNING = {
   DEPLOY_DIR_NOT_BUILT: "deploy_dir_not_built",
   FIELD_UNKNOWN: "field_unknown",
+  GAME_HANDLE_LAPSED: "game_handle_lapsed",
+  GAME_HANDLE_LIMIT_REACHED: "game_handle_limit_reached",
   VERSION_UNCHECKED: "version_unchecked",
 };
 // every error code, for checking one exists.

package/src/parser/readme.js

@@ -12,7 +12,7 @@ const strs = require("../util/strs");
 const deepCompact = objs.deepCompact;
 const trimWhitespace = strs.trimWhitespace;
 
-// [define]
+// [declare]
 
 const COMMENT = 8;
 

package/src/phrase.js

@@ -142,19 +142,19 @@ const didYouMean = function (near) {
 // [function]
 
 const docAttrInvalid = function (tag, attr, value) {
-  return `Value '${value}' is not valid for the '${attr}' attribute on the '${tag}' tag.`;
+  return `Value '${value}' isn't allowed for ${attr} on <${tag}>.`;
 };
 
 // [function]
 
 const docAttrUnallowed = function (tag, attr) {
-  return `Attribute '${attr}' is not permitted on the '${tag}' tag.`;
+  return `Attribute ${attr} isn't allowed on <${tag}>.`;
 };
 
 // [function]
 
 const docCommentUnallowed = function () {
-  return "HTML comments are not permitted.";
+  return "HTML comments aren't allowed.";
 };
 
 // [function]
@@ -186,7 +186,7 @@ const docMediaType = function (src) {
 // [function]
 
 const docTagUnallowed = function (tag) {
-  return `Tag '${tag}' is not permitted.`;
+  return `Tag <${tag}> isn't allowed.`;
 };
 
 // [function]
@@ -207,6 +207,18 @@ const gameHandleTaken = function (handle) {
 
 // [function]
 
+const gameHandleLapsed = function (handle) {
+  return `Handle ${handle} lapsed, so deploying without it.\nA production release takes it back.`;
+};
+
+// [function]
+
+const gameHandleLimit = function (handle) {
+  return `Handle ${handle} not applied, so deploying without it.\nYour unreleased games already hold 5 handles.`;
+};
+
+// [function]
+
 const gameNotDeployed = function (game) {
   return blocks(`${game} isn't on ${TITLE} yet.`, [
     `Deploy it once with ${cmdDeploy()}.`,
@@ -273,7 +285,7 @@ const packed = function () {
 // [function]
 
 const portInvalid = function () {
-  return "The port must be a whole number from 1 to 65535.";
+  return "`--port` must be a whole number from 1 to 65535.";
 };
 
 // [function]
@@ -299,13 +311,13 @@ const remoteName = function (name) {
 
 // arc serve's copy of one of Arcadible's files, kept from `fetchedAt`.
 const remoteKept = function (name, fetchedAt) {
-  return `${TITLE} can't be reached, so serving ${remoteName(name)} saved on ${fetchedAt.slice(0, 10)}.`;
+  return `Unable to reach ${TITLE}.\nServing ${remoteName(name)} saved on ${fetchedAt.slice(0, 10)}.`;
 };
 
 // [function]
 
 const remoteUnreachable = function (name) {
-  return `${TITLE} can't be reached, and ${remoteName(name)} isn't saved yet. The game runs without it until ${TITLE} is back.`;
+  return `Unable to reach ${TITLE}, and ${remoteName(name)} isn't saved.\nThe game runs without it until ${TITLE} is back.`;
 };
 
 // [function]
@@ -322,6 +334,20 @@ const serveAlone = function () {
 
 // [function]
 
+// the label before a play link in a result.
+const playLabel = function () {
+  return "Play:";
+};
+
+// [function]
+
+// the label before a store page's link in a result.
+const storeLabel = function () {
+  return "Store:";
+};
+
+// [function]
+
 const serveNext = function (dir) {
   return `Reloads when ${dir}/ changes. Press Ctrl+C to stop.`;
 };
@@ -347,7 +373,7 @@ const serveNextUrl = function () {
 // [function]
 
 const urlInvalid = function () {
-  return "The URL must start with http:// or https://, such as http://localhost:5173.";
+  return "`--url` must start with http:// or https://.";
 };
 
 // [function]
@@ -356,8 +382,12 @@ const urlInvalid = function () {
 // says how to add them.
 const urlNotFrameable = function (url, link) {
   return blocks(
-    `⚠ The play page can't frame ${url}.`,
-    "Send Cross-Origin-Embedder-Policy: require-corp and Cross-Origin-Resource-Policy: cross-origin.",
+    `The play page can't frame ${url}.`,
+    [
+      "Its server doesn't send the headers the play page needs:",
+      "Cross-Origin-Embedder-Policy: require-corp",
+      "Cross-Origin-Resource-Policy: cross-origin",
+    ],
     ["Add them to your server, as the starters' vite.config.js does:", link],
   );
 };
@@ -365,7 +395,7 @@ const urlNotFrameable = function (url, link) {
 // [function]
 
 const urlUnreachable = function (url) {
-  return `⚠ Nothing answers at ${url} yet. Start your server, then reload the play page.`;
+  return `Nothing answers at ${url}.\nStart your server, then reload the play page.`;
 };
 
 // [function]
@@ -384,10 +414,11 @@ const releaseFailedHeading = function () {
 
 // origin isn't the game's connected repository: none is, or another is.
 const repoNotConnected = function (game, repo, url) {
-  return blocks(`${repo} isn't ${game}'s repository on ${TITLE}.`, [
-    `Connect it in ${TITLE} Studio, on the game's Repository tab (again if it was renamed on GitHub):`,
-    url,
-  ]);
+  return blocks(
+    `${repo} isn't ${game}'s repository on ${TITLE}.`,
+    [`Connect it on the game's Repository tab in ${TITLE} Studio:`, url],
+    "If it was renamed on GitHub, connect it again.",
+  );
 };
 
 // [function]
@@ -399,10 +430,10 @@ const gameNotFound = function (idOrHandle) {
 // [function]
 
 const gameUnavailable = function (id) {
-  return blocks(`Game unavailable: ${id}`, [
-    "It was deleted, or belongs to another account.",
+  return blocks(
+    `Game unavailable: ${id}\nIt was deleted, or belongs to another account.`,
     "Give game.id a new UUID to deploy it as a new game.",
-  ]);
+  );
 };
 
 // [function]
@@ -418,7 +449,7 @@ const gitUncommitted = function () {
 
 const gitRemoteMissing = function () {
   return blocks(
-    "No Git remote 'origin'.",
+    "No Git remote origin.",
     "Add the game's GitHub repository as origin.",
   );
 };
@@ -427,8 +458,8 @@ const gitRemoteMissing = function () {
 
 const gitRemoteUnreachable = function () {
   return blocks(
-    "Unable to reach Git remote 'origin'.",
-    "Check your connection, and that you can access it.",
+    "Unable to reach Git remote origin.",
+    "Check your internet connection, and that you can access it.",
   );
 };
 
@@ -438,8 +469,14 @@ const manifestMissing = function (file, dir, found) {
   return blocks(
     dir === "." ? `No ${file} in this directory.` : `No ${file} in ${dir}.`,
     found
-      ? `The project is in \`${found}\`: run ${TOOL} there, or pass \`-C ${found}\`.`
-      : `Run ${TOOL} in the project's directory, or pass \`-C\`, or start a project with ${cmdInit()}.`,
+      ? [
+          `Found a project in ${found}.`,
+          `Run \`${TOOL}\` there, or pass \`-C ${found}\`.`,
+        ]
+      : [
+          `Run \`${TOOL}\` in a project's directory, or pass \`-C <dir>\`.`,
+          `To start a project, run ${cmdInit()}.`,
+        ],
   );
 };
 
@@ -447,7 +484,7 @@ const manifestMissing = function (file, dir, found) {
 
 const projectNotRepoRoot = function (prefix) {
   return blocks(
-    `${cmdDeployGit()} releases the project at the repository's root, and this one is in ${prefix}.`,
+    `Project is in ${prefix}, not the repository's root.\n${cmdDeployGit()} releases only a project at the root.`,
     `Deploy it with ${cmdDeploy()}, or give it a repository of its own.`,
   );
 };
@@ -475,7 +512,7 @@ const gitTagCreateFailed = function (version) {
 const gitTagPushFailed = function (version) {
   return blocks(
     `Unable to push Git tag for v${version}.`,
-    "Check that you can push to 'origin'.",
+    "Check that you can push to origin.",
   );
 };
 
@@ -552,7 +589,7 @@ const imageWidthMin = function (width) {
 // [function]
 
 const timeoutInvalid = function () {
-  return "The timeout must be a number of seconds above 0.";
+  return "`--timeout` must be a number of seconds above 0.";
 };
 
 // [function]
@@ -561,8 +598,8 @@ const timeoutInvalid = function () {
 // parsed the project again.
 const issuesAfterBuild = function (count) {
   return blocks(
-    `${count} ${count === 1 ? "issue" : "issues"} found after the build.`,
-    `The build writes files the manifest reads. Run ${cmdValidate()} for details.`,
+    `${count} ${count === 1 ? "issue" : "issues"} found after the build.\nThe build writes files the manifest reads.`,
+    `Run ${cmdValidate()} for details.`,
   );
 };
 
@@ -578,13 +615,13 @@ const issuesFound = function (count) {
 // [function]
 
 const loginCodeExpired = function () {
-  return "Login code expired.";
+  return blocks("Login code expired.", `Run ${cmdLogin()} again.`);
 };
 
 // [function]
 
 const loginFailed = function () {
-  return "Login request failed.";
+  return blocks("Login request failed.", `Run ${cmdLogin()} again.`);
 };
 
 // [function]
@@ -599,10 +636,10 @@ const gameIdMissing = function () {
 // [function]
 
 const lockfileMissing = function () {
-  return blocks("No lockfile found.", [
-    "Install your dependencies to create one.",
-    "Then commit it.",
-  ]);
+  return blocks(
+    "No lockfile found.",
+    "Install your dependencies to create one, and commit it.",
+  );
 };
 
 // [function]
@@ -676,7 +713,7 @@ const packagePathReserved = function (folder) {
 const packageTooLarge = function (size) {
   return blocks(
     `Package is larger than ${size} MB.`,
-    "Store assets don't count toward it.",
+    ".arcadible/ doesn't count toward it.",
   );
 };
 
@@ -700,7 +737,7 @@ const packageUncompressedTooLarge = function (size) {
 // open it.
 const releaseFailed = function ({ message }, studio) {
   return blocks(
-    (message ?? "").split(/(?<=\.)\s+/u).join("\n"),
+    (message ?? "No reason given.").split(/(?<=\.)\s+/u).join("\n"),
     ...(studio ? [[`${TITLE} Studio:`, studio]] : []),
   );
 };
@@ -730,10 +767,10 @@ const releaseTimedOut = function (
     ]);
   }
   if (found) {
-    return blocks(
-      head,
-      `It may still finish. The ${TITLE} check on the tagged commit says how it went.`,
-    );
+    return blocks(head, [
+      "It may still finish.",
+      `The ${TITLE} check on the tagged commit says how it went.`,
+    ]);
   }
   return blocks(
     head,
@@ -741,7 +778,7 @@ const releaseTimedOut = function (
       "GitHub Actions hasn't released it yet, or its workflow failed:",
       actions ?? "See the repository's Actions tab.",
     ],
-    `If the workflow passed, the ${TITLE} check on the tagged commit says why.`,
+    `If the workflow passed, see the ${TITLE} check on the tagged commit.`,
   );
 };
 
@@ -750,7 +787,7 @@ const releaseTimedOut = function (
 // the spinner while `--wait` waits: on GitHub Actions until the release
 // exists, then on Arcadible.
 const releaseWaiting = function (building) {
-  return building ? "Waiting for GitHub Actions... %s" : "Publishing... %s";
+  return building ? "Waiting for GitHub Actions… %s" : "Publishing… %s";
 };
 
 // [function]
@@ -875,9 +912,9 @@ const uploadFailed = function (status) {
 
 // [function]
 
-const uploadRateLimited = function (version) {
+const deployRateLimited = function (version) {
   return blocks(
-    `v${version} was uploaded in the last 5 minutes.`,
+    `v${version} was deployed in the last 5 minutes.`,
     "Wait, then deploy again.",
   );
 };
@@ -1010,6 +1047,7 @@ module.exports = {
   cmdInit,
   cmdInspect,
   deployDirMissing,
+  deployRateLimited,
   didYouMean,
   docAttrInvalid,
   docAttrUnallowed,
@@ -1020,6 +1058,8 @@ module.exports = {
   docMediaType,
   docTagUnallowed,
   errorCode,
+  gameHandleLapsed,
+  gameHandleLimit,
   gameHandleTaken,
   gameIdMissing,
   gameNotDeployed,
@@ -1069,6 +1109,7 @@ module.exports = {
   packageTooManyFiles,
   packageUncompressedTooLarge,
   packed,
+  playLabel,
   portInUse,
   portInvalid,
   pressEnterToOpen,
@@ -1096,6 +1137,7 @@ module.exports = {
   starterPhaser,
   starterPixiJs,
   starterThreeJs,
+  storeLabel,
   tagPushed,
   templateMissing,
   templateUnavailable,
@@ -1107,7 +1149,6 @@ module.exports = {
   unknownField,
   unknownTable,
   uploadFailed,
-  uploadRateLimited,
   urlInvalid,
   urlNotFrameable,
   urlUnreachable,

package/src/schema/game.js

@@ -123,16 +123,20 @@ const GALLERY_DIMENSIONS = {
 // leaving a field out is how to unset it, so an empty one is always a mistake.
 const atLeast = function (field, min, unit) {
   return min === 1
-    ? message(field, ["Must not be empty. Leave the field out instead."])
-    : message(field, [`Must be at least: ${min} ${unit}`]);
+    ? message(field, ["Must not be empty.", "Leave the field out instead."])
+    : message(field, [
+        unit === "character"
+          ? `Must be at least ${min} characters.`
+          : `Must have at least ${min} ${unit}s.`,
+      ]);
 };
 
 // [function]
 
-// a required string's error: "Must be defined." and `lines` when it's missing,
+// a required string's error: "Must be set." and `lines` when it's missing,
 // and zod's own type message (null) when it's there but isn't a string.
 const required = function (field, lines) {
-  const missing = message(field, ["Must be defined.", ...lines]).message;
+  const missing = message(field, ["Must be set.", ...lines]).message;
   return {
     error(issue) {
       return typeof issue.input === "undefined" ? missing : null;
@@ -144,14 +148,14 @@ const required = function (field, lines) {
 
 // a list of distinct values. Without a max, its length is up to the values.
 const zSet = function (field, schema, { max, min }) {
-  const list = z.array(schema).min(min, atLeast(field, min, "element"));
+  const list = z.array(schema).min(min, atLeast(field, min, "item"));
   return (
     max
-      ? list.max(max, message(field, [`Must not exceed: ${max} elements`]))
+      ? list.max(max, message(field, [`Must have at most ${max} items.`]))
       : list
   ).refine(
     (items) => new Set(items).size === items.length,
-    message(field, ["Must not contain duplicate elements."], ISSUE.DUPLICATE),
+    message(field, ["Must not repeat an item."], ISSUE.DUPLICATE),
   );
 };
 
@@ -161,12 +165,12 @@ const zSetBasefile = function (field, schema, { max, min }) {
   return z
     .array(schema)
     .min(min, atLeast(field, min, "file"))
-    .max(max, message(field, [`Must not exceed: ${max} files`]))
+    .max(max, message(field, [`Must have at most ${max} files.`]))
     .refine(
       (items) => new Set(items.map(basefile)).size === items.length,
       message(
         field,
-        ["Must not contain duplicate filenames (ignoring extensions)."],
+        ["Must not have two files of one name, whatever their extensions."],
         ISSUE.DUPLICATE,
       ),
     );
@@ -183,7 +187,7 @@ const zString = function (field, char, { max, min }) {
     .min(min, { ...atLeast(field, min, "character"), abort: min === 1 })
     .refine(
       (str) => [...str].length <= max,
-      message(field, [`Must not exceed: ${max} characters`], ISSUE.TOO_LONG),
+      message(field, [`Must be at most ${max} characters.`], ISSUE.TOO_LONG),
     )
     .superRefine((str, ctx) => {
       const invalid = invalidChars(str, char);
@@ -458,7 +462,7 @@ const zHandle = function () {
   const field = "handle";
   return z.optional(
     zString(field, /[a-z0-9-]/u, { max: 24, min: 1 })
-      .min(3, atLeast(field, 3, "characters"))
+      .min(3, atLeast(field, 3, "character"))
       .refine(
         (str) => !str.startsWith("-") && !str.endsWith("-"),
         message(
@@ -487,7 +491,7 @@ const zId = function () {
       required(field, [`Run ${phrase.cmdInit()} to generate a new game ID.`]),
     )
     .min(1, { ...atLeast(field, 1), abort: true })
-    .uuid(message(field, ["Must be a valid UUID."]))
+    .uuid(message(field, ["Must be a UUID."]))
     .refine(
       (value) => value === value.toLowerCase(),
       message(field, ["Must be lowercase."], ISSUE.UUID_INVALID),
@@ -514,8 +518,8 @@ const zPrice = function () {
   return z.optional(
     z
       .int()
-      .min(0, message(field, ["Must not be below: 0"]))
-      .max(25, message(field, ["Must not be above: 25"])),
+      .min(0, message(field, ["Must be 0 or more."]))
+      .max(25, message(field, ["Must be 25 or less."])),
   );
 };
 
@@ -547,7 +551,7 @@ const zTrailer = function () {
   return z
     .string()
     .min(1, { ...atLeast(field, 1), abort: true })
-    .max(255, message(field, ["Must not exceed: 255 characters"]))
+    .max(255, message(field, ["Must be at most 255 characters."]))
     .refine(
       (url) =>
         zVimeo().safeParse(url).success || zYouTube().safeParse(url).success,
@@ -561,18 +565,26 @@ const zTrailer = function () {
 const zVersion = function () {
   const field = "version";
   return z
-    .string(
-      required(field, ["A version is required unless one can be derived."]),
-    )
+    .string(required(field, ["Set it here, or in package.json."]))
     .min(1, { ...atLeast(field, 1), abort: true })
     .refine((value) => validSemver(value) !== null, {
-      ...message(field, ["Must be valid semver."], ISSUE.VERSION_INVALID),
+      ...message(
+        field,
+        ["Must be a version, such as 1.2.0."],
+        ISSUE.VERSION_INVALID,
+      ),
       abort: true,
     })
     .refine(
       // lowercase too, since the database refuses an uppercase prerelease.
       (value) => cleanSemver(value) === value && value === value.toLowerCase(),
-      message(field, ["Must be normalized semver."], ISSUE.VERSION_INVALID),
+      message(
+        field,
+        [
+          "Must be written as 1.2.0 or 1.2.0-beta.1: lowercase, with no v, spaces, or build metadata.",
+        ],
+        ISSUE.VERSION_INVALID,
+      ),
     );
 };
 

package/src/schema/readme.js

@@ -29,7 +29,8 @@ const main = function (value, { file }) {
           ...message(
             "description",
             [
-              `${file} has content after its title, tagline, and bio, so it needs two --- rules around the description.`,
+              "Needs two --- rules around the description.",
+              `${file} has content after its title, tagline, and bio.`,
             ],
             cfgcode.ISSUE.DESCRIPTION_RULES_MISSING,
           ),