arcadible 0.0.1 → 0.1.0

package/package.json

@@ -1,5 +1,42 @@
 {
+  "bin": {
+    "arc": "bin/arc.js",
+    "arc-check": "bin/arc-check.js",
+    "arc-default": "bin/arc-default.js",
+    "arc-deploy": "bin/arc-deploy.js",
+    "arc-inspect": "bin/arc-inspect.js",
+    "arc-pack": "bin/arc-pack.js"
+  },
+  "dependencies": {
+    "@iarna/toml": "^2.2.5",
+    "adm-zip": "^0.5.16",
+    "chalk": "^4.1.2",
+    "dompurify": "^3.3.1",
+    "fs-extra": "^11.3.2",
+    "image-size": "^2.0.2",
+    "jsdom": "^27.3.0",
+    "marked": "^17.0.1",
+    "mp4box": "^2.3.0",
+    "rc": "^1.2.8",
+    "yargs": "^17.7.2",
+    "zod": "^4.1.13"
+  },
+  "description": "The Arcadible command-line interface.",
+  "engines": {
+    "node": ">=24.11.1"
+  },
+  "exports": {
+    "./check": "./src/cmd/check.js",
+    "./deploy": "./src/cmd/deploy.js",
+    "./inspect": "./src/cmd/inspect.js",
+    "./pack": "./src/cmd/pack.js"
+  },
+  "keywords": [
+    "arcadible",
+    "cli"
+  ],
   "license": "Apache-2.0",
+  "main": "./src/cmd/index.js",
   "name": "arcadible",
-  "version": "0.0.1"
+  "version": "0.1.0"
 }

package/src/cmd/check.js

@@ -0,0 +1,26 @@
+"use strict";
+
+// [import]
+
+const cmdCheck = require("../cmd-check");
+const log = require("../util/log");
+const project = require("../project");
+
+// [function]
+
+const main = function (conf) {
+  project
+    .parse(conf.root)
+    .then(({ game, workflow }) => {
+      cmdCheck(conf, workflow, game);
+    })
+    .catch((ex) => {
+      log.hd("Check aborted.");
+      log.pdnl(ex.message);
+      process.exit(1);
+    });
+};
+
+// [export]
+
+module.exports = main;

package/src/cmd/deploy.js

@@ -0,0 +1,22 @@
+"use strict";
+
+// [import]
+
+const cmdDeploy = require("../cmd-deploy");
+const log = require("../util/log");
+
+// [function]
+
+const main = function (conf) {
+  try {
+    cmdDeploy(conf);
+  } catch (ex) {
+    log.hd("Deploy aborted.");
+    log.pdnl(ex.message);
+    process.exit(1);
+  }
+};
+
+// [export]
+
+module.exports = main;

package/src/cmd/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+// [import]
+
+const check = require("./check");
+const deploy = require("./deploy");
+const inspect = require("./inspect");
+const pack = require("./pack");
+
+// [export]
+
+module.exports = { check, deploy, inspect, pack };

package/src/cmd/inspect.js

@@ -0,0 +1,26 @@
+"use strict";
+
+// [import]
+
+const cmdInspect = require("../cmd-inspect");
+const log = require("../util/log");
+const project = require("../project");
+
+// [function]
+
+const main = function (conf) {
+  project
+    .parse(conf.root)
+    .then(({ game, workflow }) => {
+      cmdInspect(conf, workflow, game);
+    })
+    .catch((ex) => {
+      log.hd("Inspect aborted.");
+      log.pdnl(ex.message);
+      process.exit(1);
+    });
+};
+
+// [export]
+
+module.exports = main;

package/src/cmd/pack.js

@@ -0,0 +1,24 @@
+"use strict";
+
+// [import]
+
+const cmdPack = require("../cmd-pack");
+const log = require("../util/log");
+const project = require("../project");
+
+// [function]
+
+const main = function (conf) {
+  project
+    .parse(conf.root)
+    .then(({ game, workflow }) => cmdPack(conf, workflow, game))
+    .catch((ex) => {
+      log.hd("Pack aborted.");
+      log.pdnl(ex.message);
+      process.exit(1);
+    });
+};
+
+// [export]
+
+module.exports = main;

package/src/cmd-check/index.js

@@ -0,0 +1,57 @@
+"use strict";
+
+// [import]
+
+const gameSchema = require("../schema/game");
+const log = require("../util/log");
+const workflowSchema = require("../schema/workflow");
+
+// [declare]
+
+const SUCCESS = ["Workspace and manifest are well-formed."];
+
+// [function]
+
+const formatError = function (schema, zodError) {
+  return zodError.issues.map((issue) => {
+    const field = issue.path.join(".") || "value";
+    return `✖ ${schema}.${field}: ${issue.message}`;
+  });
+};
+
+// [function]
+
+const checkGame = function (root, game) {
+  const schema = gameSchema(root, game).safeParse(game);
+  if (!schema.success) {
+    log.hd("Check failed.");
+    log.pdnl(formatError("game", schema.error));
+    process.exit(1);
+  }
+};
+
+// [function]
+
+const checkWorkflow = function (root, workflow) {
+  const schema = workflowSchema(root, workflow).safeParse(workflow);
+  if (!schema.success) {
+    log.hd("Check failed.");
+    log.pdnl(formatError("workflow", schema.error));
+    process.exit(1);
+  }
+};
+
+// [function]
+
+const main = function ({ quiet, root }, workflow, game) {
+  checkGame(root, game);
+  checkWorkflow(root, workflow);
+  if (!quiet) {
+    log.hs("Check Passed.");
+    log.pnl(SUCCESS);
+  }
+};
+
+// [export]
+
+module.exports = main;

package/src/cmd-deploy/index.js

@@ -0,0 +1,43 @@
+"use strict";
+
+// [import]
+
+const arc = require("../util/arc");
+const git = require("../util/git");
+const log = require("../util/log");
+
+// [declare]
+
+const SUCCESS = [
+  "Await an email from Arcadible confirming a successful release.",
+];
+
+// [function]
+
+const main = function ({ pre, preId, quiet, root }) {
+  if (!quiet) {
+    log.h("Attempting to deploy…");
+  }
+  git.isDirty(root, (dirty) => {
+    if (dirty) {
+      log.hd("Deploy aborted.");
+      log.pdnl("Git working directory is not clean.");
+      process.exit(1);
+    }
+    arc.deploy(root, { pre, preId }, (err, tag) => {
+      if (err) {
+        log.hd("Deploy aborted.");
+        log.pdnl(err.message);
+        process.exit(1);
+      }
+      if (!quiet) {
+        log.hs(`Deploy initiated for ${tag}.`);
+        log.pnl(SUCCESS);
+      }
+    });
+  });
+};
+
+// [export]
+
+module.exports = main;

package/src/cmd-inspect/index.js

@@ -0,0 +1,53 @@
+"use strict";
+
+// [import]
+
+const TOML = require("@iarna/toml");
+
+// [function]
+
+const write = function (data) {
+  process.stdout.write(data.trim().concat("\n"));
+};
+
+// [function]
+
+const printJson = function (data) {
+  write(JSON.stringify(data, null, 2));
+};
+
+// [function]
+
+const printToml = function (data) {
+  write(TOML.stringify(data));
+};
+
+// [function]
+
+const print = function (data, json) {
+  if (json) {
+    printJson(data);
+  } else {
+    printToml(data);
+  }
+};
+
+// [function]
+
+const main = function ({ json, topic }, workflow, game) {
+  switch (topic) {
+    case "manifest:game":
+      print({ game }, json);
+      break;
+    case "manifest:workflow":
+      print({ workflow }, json);
+      break;
+    default:
+      print({ game, workflow }, json);
+      break;
+  }
+};
+
+// [export]
+
+module.exports = main;

package/src/cmd-pack/index.js

@@ -0,0 +1,83 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const fs = require("fs-extra");
+const TOML = require("@iarna/toml");
+
+// [import]
+
+const Zip = require("../util/zip");
+
+// [use]
+
+const pathExists = fs.pathExists;
+const pathParse = path.parse;
+const resolve = path.resolve;
+
+// [declare]
+
+const MANIFEST = "arcadible.json";
+const MEDIA = ".arcadible";
+
+// [function]
+
+const write = function (data) {
+  process.stdout.write(data.trim().concat("\n"));
+};
+
+// [function]
+
+const printJson = function (data) {
+  write(JSON.stringify(data, null, 2));
+};
+
+// [function]
+
+const printToml = function (data) {
+  write(TOML.stringify(data));
+};
+
+// [function]
+
+const print = function (data, json) {
+  if (json) {
+    printJson(data);
+  } else {
+    printToml(data);
+  }
+};
+
+// [function]
+
+const main = function (conf, workflow, game) {
+  const { json, out, quiet, root } = conf;
+  const { deploy_dir: deployDir } = workflow;
+  const pathDeployDir = resolve(root, deployDir);
+  const pathMediaDir = resolve(root, MEDIA);
+  const zip = new Zip(pathParse(out).name);
+  return Promise.all([
+    pathExists(pathDeployDir),
+    pathExists(pathMediaDir),
+  ]).then(([existsDeployDir, existsMediaDir]) => {
+    if (existsDeployDir) {
+      zip.addDir(pathDeployDir);
+    }
+    if (existsMediaDir) {
+      zip.addDir(pathMediaDir, MEDIA);
+    }
+    zip.addJson(MANIFEST, { game });
+    zip.write(resolve(root, out));
+    if (!quiet) {
+      print(zip.stat(), json);
+    }
+  });
+};
+
+// [export]
+
+module.exports = main;

package/src/config/audience.js

@@ -0,0 +1,5 @@
+"use strict";
+
+// [export]
+
+module.exports = ["everyone", "mature"];

package/src/config/game.js

@@ -0,0 +1,5 @@
+"use strict";
+
+// [export]
+
+module.exports = {};

package/src/config/genre.js

@@ -0,0 +1,22 @@
+"use strict";
+
+// [export]
+
+module.exports = [
+  "action",
+  "adventure",
+  "arcade",
+  "board",
+  "card",
+  "casino",
+  "casual",
+  "music",
+  "puzzle",
+  "racing",
+  "rpg",
+  "simulation",
+  "sports",
+  "strategy",
+  "trivia",
+  "word",
+];

package/src/config/input.js

@@ -0,0 +1,14 @@
+"use strict";
+
+// [export]
+
+module.exports = [
+  "gamepad",
+  "gamepad-motion",
+  "keyboard",
+  "keyboard-mouse",
+  "motion",
+  "mouse",
+  "touch",
+  "touch-motion",
+];

package/src/config/orientation.js

@@ -0,0 +1,14 @@
+"use strict";
+
+// [export]
+
+module.exports = [
+  "any",
+  "natural",
+  "portrait",
+  "portrait-primary",
+  "portrait-secondary",
+  "landscape",
+  "landscape-primary",
+  "landscape-secondary",
+];

package/src/config/visibility.js

@@ -0,0 +1,5 @@
+"use strict";
+
+// [export]
+
+module.exports = ["private", "unlisted", "public"];

package/src/config/workflow.js

@@ -0,0 +1,5 @@
+"use strict";
+
+// [export]
+
+module.exports = {};

package/src/manifest.js

@@ -0,0 +1,46 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const fs = require("fs-extra");
+const TOML = require("@iarna/toml");
+
+// [use]
+
+const join = path.join;
+const readFile = fs.readFile;
+
+// [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 parse = function (root) {
+  return new Promise((resolve, reject) => {
+    readFile(join(root, MANIFEST), "utf8")
+      .then(parseToml)
+      .then(resolve)
+      .catch(reject);
+  });
+};
+
+// [export]
+
+module.exports = { parse };

package/src/media.js

@@ -0,0 +1,96 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const fs = require("fs-extra");
+
+// [import]
+
+const objs = require("./util/objs");
+
+// [use]
+
+const extname = path.extname;
+const join = path.join;
+const pathExists = fs.pathExists;
+const pathParse = path.parse;
+const pruneEmpty = objs.pruneEmpty;
+const readdir = fs.promises.readdir;
+
+// [declare]
+
+const ART = [
+  "banner.png",
+  "banner_video.mp4",
+  "cover.png",
+  "cover_video.mp4",
+  "icon.png",
+  "icon_video.mp4",
+  "poster.png",
+  "poster_video.mp4",
+  "wordmark.svg",
+  "wordmark_animated.svg",
+];
+
+// [declare]
+
+const MEDIA = ".arcadible";
+
+// [function]
+
+const handleArt = function (exists) {
+  return Object.fromEntries(
+    ART.map((f, i) => [pathParse(f).name, exists[i] ? join(MEDIA, f) : null]),
+  );
+};
+
+// [function]
+
+const art = function (root) {
+  return (game) =>
+    Promise.all(ART.map((value) => pathExists(join(root, MEDIA, value))))
+      .then(handleArt)
+      .then((data) => ({ ...game, ...data }));
+};
+
+// [function]
+
+const handleGallery = function (entries) {
+  return entries
+    .filter((f) => extname(f).toLowerCase() === ".png")
+    .map((f) => join(MEDIA, "gallery", f))
+    .sort();
+};
+
+// [function]
+
+const gallery = function (root) {
+  const dir = join(root, MEDIA, "gallery");
+  return (game) =>
+    pathExists(dir)
+      .then((exists) => (exists ? readdir(dir) : []))
+      .then(handleGallery)
+      .then((data) => ({ ...game, gallery: data }));
+};
+
+// [function]
+
+const parse = function (root) {
+  return new Promise((resolve, reject) => {
+    Promise.resolve({})
+      .then(art(root))
+      .then(gallery(root))
+      .then(pruneEmpty)
+      .then((game) => ({ game }))
+      .then(resolve)
+      .catch(reject);
+  });
+};
+
+// [export]
+
+module.exports = { parse };

package/src/project.js

@@ -0,0 +1,62 @@
+"use strict";
+
+// [import]
+
+const gameConfig = require("./config/game");
+const manifest = require("./manifest");
+const media = require("./media");
+const promise = require("./util/promise");
+const readme = require("./readme");
+const workflowConfig = require("./config/workflow");
+
+// [function]
+
+const parseManifest = function (root) {
+  return () => manifest.parse(root);
+};
+
+// [function]
+
+const parseMedia = function (root) {
+  return () => media.parse(root);
+};
+
+// [function]
+
+const parseReadme = function (root) {
+  return () => readme.parse(root);
+};
+
+// [function]
+
+const confGame = function (readmeGame, mediaGame, manifestGame) {
+  return {
+    ...gameConfig,
+    ...(readmeGame || {}),
+    ...(mediaGame || {}),
+    ...(manifestGame || {}),
+  };
+};
+
+// [function]
+
+const confWorkflow = function (manifestWorkflow) {
+  return { ...workflowConfig, ...(manifestWorkflow || {}) };
+};
+
+// [function]
+
+const parse = function (root) {
+  const parsers = [parseManifest, parseMedia, parseReadme];
+  return promise
+    .serial(parsers.map((fn) => fn(root)))
+    .then(([manifestData, mediaData, readmeData]) => {
+      const game = confGame(readmeData.game, mediaData.game, manifestData.game);
+      const workflow = confWorkflow(manifestData.workflow);
+      return { game, workflow };
+    });
+};
+
+// [export]
+
+module.exports = { parse };