arcadible 0.1.7 → 0.1.9

package/bin/arc-init.js

@@ -7,6 +7,7 @@ const path = require("node:path");
 
 // [import]
 
+const fs = require("fs-extra");
 const hideBin = require("yargs/helpers").hideBin;
 const prompts = require("@inquirer/prompts");
 const yargs = require("yargs/yargs");
@@ -18,14 +19,14 @@ const init = require("../src/cli/init");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const pkg = require("../package.json");
-const project = require("../src/prompt/project");
 const rc = require("../src/util/rc");
 const template = require("../src/prompt/template");
 
 // [use]
 
 const findRc = rc.findRc;
-const input = prompts.input;
+const join = path.join;
+const pathExists = fs.pathExists;
 const print = output.print;
 const relative = path.relative;
 const resolve = path.resolve;
@@ -39,8 +40,8 @@ const SUBCMD = "init";
 // [define]
 
 const conf = {
-  force: false,
   json: false,
+  project: ".",
   quiet: false,
   yes: false,
   ...findRc(CMD, SUBCMD, process.argv, ["--cwd", "-C"]),
@@ -66,8 +67,9 @@ const start = function (argv) {
   const quiet = argv.quiet;
   const root = resolve(process.cwd(), argv.cwd);
   return init({
-    force: argv.force,
+    force: false,
     handler: handler({ json, quiet }),
+    patch: argv.patch,
     project: argv.project,
     root,
     template: argv.template,
@@ -106,17 +108,20 @@ const start = function (argv) {
 
 // [function]
 
+const patch = function (cwd, project) {
+  return pathExists(join(resolve(process.cwd(), cwd), project));
+};
+
+// [function]
+
 const prompt = async function ({ yes, ...argv }) {
   const opts = { ...argv };
-  if (yes) {
-    opts.project ??= project.input.default;
+  opts.patch = await patch(opts.cwd, opts.project);
+  if (opts.patch || yes) {
     opts.template ??= template.select.default;
     return opts;
   }
-  if (!argv.project) {
-    opts.project = await input(project.input);
-  }
-  if (!argv.template) {
+  if (!opts.template) {
     opts.template = await select(template.select);
   }
   return opts;
@@ -128,9 +133,10 @@ const main = function (argv) {
   return prompt(
     yargs(hideBin(argv))
       .scriptName(`${CMD} ${SUBCMD}`)
-      .usage("$0 <project> [options]")
-      .command("$0 <project>", false, (cli) =>
+      .usage("$0 [project] [options]")
+      .command("$0 [project]", false, (cli) =>
         cli.positional("project", {
+          default: conf.project,
           describe: "Project directory",
           type: "string",
         }),
@@ -146,12 +152,6 @@ const main = function (argv) {
         describe: "Answer prompts using default values",
         type: "boolean",
       })
-      .option("force", {
-        alias: "f",
-        default: conf.force,
-        describe: "Overwrite an existing directory",
-        type: "boolean",
-      })
       .option("json", {
         alias: "j",
         default: conf.json,

package/bin/arc-pack.js

@@ -34,7 +34,7 @@ const SUBCMD = "pack";
 
 const conf = {
   json: false,
-  output: "project.zip",
+  output: null,
   quiet: false,
   ...findRc(CMD, SUBCMD, process.argv, ["--cwd", "-C"]),
 };

package/package.json

@@ -51,5 +51,5 @@
   "license": "Apache-2.0",
   "main": "./src/cli/index.js",
   "name": "arcadible",
-  "version": "0.1.7"
+  "version": "0.1.9"
 }

package/src/action/init/manifest.js

@@ -0,0 +1,94 @@
+"use strict";
+
+// [import]
+
+const crypto = require("node:crypto");
+const path = require("node:path");
+
+// [import]
+
+const fs = require("fs-extra");
+const TOML = require("@iarna/toml");
+
+// [use]
+
+const join = path.join;
+const pathExists = fs.pathExists;
+const randomUUID = crypto.randomUUID;
+const readFile = fs.promises.readFile;
+const writeFile = fs.promises.writeFile;
+
+// [declare]
+
+const MANIFEST = "arcadible.toml";
+
+// [function]
+
+const parseToml = function (buf) {
+  try {
+    return TOML.parse(buf);
+  } catch (ex) {
+    throw new Error(`Unable to parse ${MANIFEST}: ${ex.message}`, {
+      cause: ex,
+    });
+  }
+};
+
+// [function]
+
+const pickVersion = function (version, envVersion) {
+  switch (true) {
+    case Boolean(version):
+      return { version };
+    case Boolean(envVersion):
+      return {};
+    default:
+      return { version: "0.1.0" };
+  }
+};
+
+// [function]
+
+const readManifest = function (file) {
+  return pathExists(file)
+    .then((exists) => (exists ? readFile(file, "utf8") : null))
+    .then((buf) => (buf === null ? {} : parseToml(buf)));
+};
+
+// [function]
+
+const prepareGame = function (envVersion, game = {}) {
+  const { id, version, ...rest } = game;
+  return {
+    id: id ?? randomUUID(),
+    ...pickVersion(version, envVersion),
+    ...rest,
+  };
+};
+
+// [function]
+
+const shouldWrite = function (manifest, next) {
+  return (
+    manifest.game?.id !== next.game?.id ||
+    manifest.game?.version !== next.game?.version
+  );
+};
+
+// [function]
+
+const prepare = function (dest, envVersion) {
+  const file = join(dest, MANIFEST);
+  return readManifest(file).then((manifest) => {
+    const { game, ...rest } = manifest;
+    const next = { game: prepareGame(envVersion, game), ...rest };
+    if (shouldWrite(manifest, next)) {
+      return writeFile(file, TOML.stringify(next), "utf8");
+    }
+    return null;
+  });
+};
+
+// [export]
+
+module.exports = { prepare };

package/src/action/init/tool-patch.js

@@ -0,0 +1,41 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const env = require("../../parser/env");
+const manifest = require("./manifest");
+
+// [use]
+
+const prepare = manifest.prepare;
+const resolve = path.resolve;
+
+// [function]
+
+const inferVersion = function (root) {
+  return env(root).then(({ game }) => game?.version ?? null);
+};
+
+// [function]
+
+const init = function () {
+  return Promise.resolve();
+};
+
+// [function]
+
+const main = function ({ project, root }) {
+  const dest = resolve(root, project);
+  return init()
+    .then(() => inferVersion(dest))
+    .then((version) => prepare(dest, version))
+    .then(() => ({ path: dest }));
+};
+
+// [export]
+
+module.exports = main;

package/src/action/init/tool.js

@@ -9,20 +9,42 @@ const path = require("node:path");
 const degit = require("degit");
 const fs = require("fs-extra");
 
+// [import]
+
+const env = require("../../parser/env");
+const manifest = require("./manifest");
+
 // [use]
 
+const join = path.join;
 const pathExists = fs.pathExists;
+const prepare = manifest.prepare;
 const remove = fs.remove;
 const resolve = path.resolve;
 
+// [declare]
+
+const LICENSE = "LICENSE";
+
+// [function]
+
+const removeLicense = function (dest) {
+  return remove(join(dest, LICENSE));
+};
+
+// [function]
+
+const inferVersion = function (root) {
+  return env(root).then(({ game }) => game?.version ?? null);
+};
+
 // [function]
 
 const init = function (src, dest, { onBegin, onInfo }) {
   onBegin({ dest, src });
   return degit(src, { cache: false, force: true, verbose: false })
     .on("info", onInfo)
-    .clone(dest)
-    .then(() => remove(resolve(dest, "LICENSE")));
+    .clone(dest);
 };
 
 // [function]
@@ -38,6 +60,9 @@ const main = function ({ force, project, root, template }, handler) {
       }
       return init(template, dest, handler);
     })
+    .then(() => removeLicense(dest))
+    .then(() => inferVersion(dest))
+    .then((version) => prepare(dest, version))
     .then(() => ({ path: dest }));
 };
 

package/src/action/login/flow.js

@@ -8,10 +8,12 @@ const crypto = require("node:crypto");
 
 const api = require("../../api");
 const cfgurl = require("../../config/url");
+const delay = require("../../util/delay");
 const time = require("../../util/time");
 
 // [use]
 
+const poll = delay.poll;
 const randomUUID = crypto.randomUUID;
 
 // [function]
@@ -75,7 +77,7 @@ const main = function ({ onCreated, onPoll }) {
     onCreated,
   ).then(({ id }) => {
     const timeout = Math.max(0, expiresAt.getTime() - Date.now() - time.s(15));
-    return time.poll(
+    return poll(
       (flow) => pollFlow(flow, onPoll),
       { id, token },
       {

package/src/action/pack/tool.js

@@ -11,6 +11,7 @@ const fs = require("fs-extra");
 // [import]
 
 const project = require("../../parser/project");
+const size = require("../../util/size");
 const Zip = require("../../util/zip");
 
 // [use]
@@ -21,38 +22,78 @@ const resolve = path.resolve;
 
 // [declare]
 
+const MAIN = "index.html";
 const MANIFEST = "arcadible.json";
 const MEDIA = ".arcadible";
+const OUTPUT = ".arc/package";
+
+// [declare]
+
+const SIZE_PARTIAL = size.mb(64);
+const SIZE_TOTAL = size.mb(256);
+
+// [function]
+
+const verifyPartial = function (zip) {
+  if (!zip.has(MAIN)) {
+    throw new Error(`Package is missing "${MAIN}".`);
+  }
+  if (zip.stat().size > SIZE_PARTIAL) {
+    const max = SIZE_PARTIAL / 1024 / 1024;
+    throw new Error(`Package size (excluding store assets) exceeds ${max} MB.`);
+  }
+  return zip;
+};
+
+// [function]
+
+const verifyTotal = function (zip) {
+  if (zip.stat().size > SIZE_TOTAL) {
+    const max = SIZE_TOTAL / 1024 / 1024;
+    throw new Error(`Package size (including store assets) exceeds ${max} MB.`);
+  }
+  return zip;
+};
 
 // [function]
 
 const pack = function (name, game, { deployPath, mediaPath, zipPath }) {
   const zip = new Zip(name);
-  return Promise.all([pathExists(deployPath), pathExists(mediaPath)])
-    .then(([existsDeploy, existsMedia]) => {
+  return pathExists(deployPath)
+    .then((existsDeploy) => {
       if (existsDeploy) {
         zip.addDir(deployPath);
       }
+      return zip;
+    })
+    .then(verifyPartial)
+    .then(() => pathExists(mediaPath))
+    .then((existsMedia) => {
       if (existsMedia) {
         zip.addDir(mediaPath, MEDIA);
       }
       zip.addJson(MANIFEST, { game });
-      zip.write(zipPath);
-      return zip.stat();
+      return zip;
     })
-    .then((stat) => ({ path: zipPath, ...stat }));
+    .then(verifyTotal)
+    .then((file) => {
+      file.write(zipPath);
+      return { path: zipPath, ...file.stat() };
+    });
 };
 
 // [function]
 
 const main = function ({ output, root }) {
-  return project(root).then(({ game, workflow }) =>
-    pack(parse(output).name, game, {
+  return project(root).then(({ game, workflow }) => {
+    const name = game.handle || game.id;
+    const file = output || `${OUTPUT}/${name}-v${game.version}.zip`;
+    return pack(parse(file).name, game, {
       deployPath: resolve(root, workflow.deploy_dir),
       mediaPath: resolve(root, MEDIA),
-      zipPath: resolve(root, output),
-    }),
-  );
+      zipPath: resolve(root, file),
+    });
+  });
 };
 
 // [export]

package/src/cli/deploy.js

@@ -2,13 +2,13 @@
 
 // [import]
 
-const deployGitTool = require("../action/deploy-git/tool");
 const deployTool = require("../action/deploy/tool");
+const deployToolGit = require("../action/deploy/tool-git");
 
 // [function]
 
 const main = function ({ git, handler, ...conf }) {
-  const tool = git ? deployGitTool : deployTool;
+  const tool = git ? deployToolGit : deployTool;
   return tool(conf, handler);
 };
 

package/src/cli/init.js

@@ -3,11 +3,13 @@
 // [import]
 
 const initTool = require("../action/init/tool");
+const initToolPatch = require("../action/init/tool-patch");
 
 // [function]
 
-const main = function ({ handler, ...conf }) {
-  return initTool(conf, handler);
+const main = function ({ handler, patch, ...conf }) {
+  const tool = patch ? initToolPatch : initTool;
+  return tool(conf, handler);
 };
 
 // [export]

package/src/parser/project.js

@@ -4,31 +4,31 @@
 
 const cfggame = require("../config/game");
 const cfgworkflow = require("../config/workflow");
+const env = require("./env");
 const manifest = require("./manifest");
 const media = require("./media");
-const pkg = require("./pkg");
 const promise = require("../util/promise");
 const readme = require("./readme");
 
 // [function]
 
-const configGame = function (readmeGame, mediaGame, pkgGame, manifestGame) {
+const configGame = function (readmeGame, mediaGame, envGame, manifestGame) {
   return {
     ...cfggame,
-    ...(readmeGame || {}),
-    ...(mediaGame || {}),
-    ...(pkgGame || {}),
-    ...(manifestGame || {}),
+    ...(readmeGame ?? {}),
+    ...(mediaGame ?? {}),
+    ...(envGame ?? {}),
+    ...(manifestGame ?? {}),
   };
 };
 
 // [function]
 
-const configWorkflow = function (pkgWorkflow, manifestWorkflow) {
+const configWorkflow = function (envWorkflow, manifestWorkflow) {
   return {
     ...cfgworkflow,
-    ...(pkgWorkflow || {}),
-    ...(manifestWorkflow || {}),
+    ...(envWorkflow ?? {}),
+    ...(manifestWorkflow ?? {}),
   };
 };
 
@@ -36,23 +36,22 @@ const configWorkflow = function (pkgWorkflow, manifestWorkflow) {
 
 const main = function (root) {
   const parsers = [
-    () => manifest(root),
-    () => media(root),
-    () => pkg(root),
     () => readme(root),
+    () => media(root),
+    () => env(root),
+    () => manifest(root),
   ];
   return promise
     .serial(parsers)
-    .then(([manifestData, mediaData, pkgData, readmeData]) => {
-      const game = configGame(
+    .then(([readmeData, mediaData, envData, manifestData]) => ({
+      game: configGame(
         readmeData.game,
         mediaData.game,
-        pkgData.game,
+        envData.game,
         manifestData.game,
-      );
-      const workflow = configWorkflow(pkgData.workflow, manifestData.workflow);
-      return { game, workflow };
-    });
+      ),
+      workflow: configWorkflow(envData.workflow, manifestData.workflow),
+    }));
 };
 
 // [export]

package/src/schema/game.js

@@ -17,6 +17,7 @@ const cfgurl = require("../config/url");
 const cfgvisibility = require("../config/visibility");
 const check = require("./check/game");
 const dom = require("../util/dom");
+const size = require("../util/size");
 const strs = require("../util/strs");
 
 // [use]
@@ -152,7 +153,7 @@ const zBanner = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "2:1",
-      maxSize: 2 * 1024 * 1024,
+      maxSize: size.mb(2),
       minHeight: 512,
       minWidth: 1024,
     }),
@@ -166,7 +167,7 @@ const zBannerVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "2:1",
-      maxSize: 5 * 1024 * 1024,
+      maxSize: size.mb(5),
       minHeight: 512,
       minWidth: 1024,
     }),
@@ -187,7 +188,7 @@ const zCover = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "3:2",
-      maxSize: 2 * 1024 * 1024,
+      maxSize: size.mb(2),
       minHeight: 512,
       minWidth: 768,
     }),
@@ -201,7 +202,7 @@ const zCoverVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "3:2",
-      maxSize: 5 * 1024 * 1024,
+      maxSize: size.mb(5),
       minHeight: 512,
       minWidth: 768,
     }),
@@ -237,8 +238,8 @@ const zGallery = function (root) {
     z
       .array(
         z.union([
-          zPng(field, root, { maxSize: 2 * 1024 * 1024 }),
-          zMp4(field, root, { maxSize: 5 * 1024 * 1024 }),
+          zPng(field, root, { maxSize: size.mb(2) }),
+          zMp4(field, root, { maxSize: size.mb(5) }),
         ]),
       )
       .min(1)
@@ -274,7 +275,7 @@ const zIcon = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "1:1",
-      maxSize: 2 * 1024 * 1024,
+      maxSize: size.mb(2),
       minHeight: 512,
       minWidth: 512,
     }),
@@ -288,7 +289,7 @@ const zIconVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "1:1",
-      maxSize: 5 * 1024 * 1024,
+      maxSize: size.mb(5),
       minHeight: 512,
       minWidth: 512,
     }),
@@ -329,7 +330,7 @@ const zPoster = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "2:3",
-      maxSize: 2 * 1024 * 1024,
+      maxSize: size.mb(2),
       minHeight: 768,
       minWidth: 512,
     }),
@@ -343,7 +344,7 @@ const zPosterVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "2:3",
-      maxSize: 5 * 1024 * 1024,
+      maxSize: size.mb(5),
       minHeight: 768,
       minWidth: 512,
     }),
@@ -419,7 +420,7 @@ const zWordmark = function (root) {
   return z.optional(
     zSvg(field, root, {
       aspect: "1:1",
-      maxSize: 512 * 1024,
+      maxSize: size.kb(512),
     }),
   );
 };
@@ -431,7 +432,7 @@ const zWordmarkAnimated = function (root) {
   return z.optional(
     zSvg(field, root, {
       aspect: "1:1",
-      maxSize: 1024 * 1024,
+      maxSize: size.mb(1),
     }),
   );
 };

package/src/schema/workflow.js

@@ -45,7 +45,7 @@ const message = function (field, lines) {
 
 const zBuild = function () {
   // const field = "build";
-  return z.string();
+  return z.union([z.string(), z.array(z.string())]);
 };
 
 // [function]

package/src/util/delay.js

@@ -0,0 +1,59 @@
+"use strict";
+
+// [import]
+
+const time = require("./time");
+
+// [function]
+
+const backoff = function (elapsed, delay, factor, interval, maxDelay) {
+  const step = Math.floor(elapsed / interval);
+  return Math.min(delay * factor ** step, maxDelay);
+};
+
+// [function]
+
+const sleep = function (delay) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, delay);
+  });
+};
+
+// [function]
+
+const wait = function (delay, next) {
+  return sleep(delay).then(next);
+};
+
+// [function]
+
+const poll = function (
+  fn,
+  value,
+  {
+    delay = time.s(1),
+    factor = 1,
+    interval = time.m(1),
+    maxDelay = delay,
+    timeout = Infinity,
+  } = {},
+) {
+  const started = Date.now();
+  const next = function () {
+    return fn(value).then((result) => {
+      if (result !== null) {
+        return result;
+      }
+      const elapsed = Date.now() - started;
+      if (elapsed >= timeout) {
+        throw new Error("Timed out.");
+      }
+      return wait(backoff(elapsed, delay, factor, interval, maxDelay), next);
+    });
+  };
+  return next();
+};
+
+// [export]
+
+module.exports = { poll };

package/src/util/size.js

@@ -0,0 +1,29 @@
+"use strict";
+
+// [function]
+
+const b = function (value) {
+  return value;
+};
+
+// [function]
+
+const kb = function (value) {
+  return b(value * 1024);
+};
+
+// [function]
+
+const mb = function (value) {
+  return kb(value * 1024);
+};
+
+// [function]
+
+const gb = function (value) {
+  return mb(value * 1024);
+};
+
+// [export]
+
+module.exports = { b, gb, kb, mb };

package/src/util/time.js

@@ -24,56 +24,6 @@ const h = function (value) {
   return m(value * 60);
 };
 
-// [function]
-
-const backoff = function (elapsed, delay, factor, interval, maxDelay) {
-  const step = Math.floor(elapsed / interval);
-  return Math.min(delay * factor ** step, maxDelay);
-};
-
-// [function]
-
-const sleep = function (delay) {
-  return new Promise((resolve) => {
-    setTimeout(resolve, delay);
-  });
-};
-
-// [function]
-
-const wait = function (delay, next) {
-  return sleep(delay).then(next);
-};
-
-// [function]
-
-const poll = function (
-  fn,
-  value,
-  {
-    delay = s(1),
-    factor = 1,
-    interval = m(1),
-    maxDelay = delay,
-    timeout = Infinity,
-  } = {},
-) {
-  const started = Date.now();
-  const next = function () {
-    return fn(value).then((result) => {
-      if (result !== null) {
-        return result;
-      }
-      const elapsed = Date.now() - started;
-      if (elapsed >= timeout) {
-        throw new Error("Timed out.");
-      }
-      return wait(backoff(elapsed, delay, factor, interval, maxDelay), next);
-    });
-  };
-  return next();
-};
-
 // [export]
 
-module.exports = { h, m, ms, poll, s };
+module.exports = { h, m, ms, s };

package/src/util/zip.js

@@ -49,6 +49,12 @@ const Main = class {
 
   // [method]
 
+  has(name) {
+    return this.zip.getEntry(join(this.prefix, name)) !== null;
+  }
+
+  // [method]
+
   stat() {
     const buffer = this.zip.toBuffer();
     const hash = createHash("sha256").update(buffer).digest("hex");

package/src/prompt/project.js

@@ -1,10 +0,0 @@
-"use strict";
-
-// [export]
-
-module.exports = {
-  input: {
-    default: ".",
-    message: "Project",
-  },
-};