arcadible 0.1.4 → 0.1.6

package/src/schema/check/game.js

@@ -0,0 +1,67 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const fs = require("fs-extra");
+
+// [import]
+
+const imageCheck = require("../../util/image").check;
+const videoCheck = require("../../util/video").check;
+
+// [use]
+
+const isAbsolute = path.isAbsolute;
+const join = path.join;
+const pathExistsSync = fs.pathExistsSync; // eslint-disable-line no-sync
+const relative = path.relative;
+const resolve = path.resolve;
+
+// [function]
+
+const exists = function (root, target) {
+  return pathExistsSync(join(root, target));
+};
+
+// [function]
+
+const image = function (root, target, opts) {
+  return imageCheck(join(root, target), opts);
+};
+
+// [function]
+
+const isIn = function (root, target, parent) {
+  const parentRoot = resolve(root, parent);
+  const targetPath = resolve(root, target);
+  const rel = relative(parentRoot, targetPath);
+  return rel && !rel.startsWith("..") && !isAbsolute(rel);
+};
+
+// [function]
+
+const isOut = function (root, target) {
+  const rootPath = resolve(root);
+  const targetPath = resolve(root, target);
+  return targetPath === rootPath || targetPath.startsWith(rootPath + path.sep);
+};
+
+// [function]
+
+const isRelative = function (root, target) {
+  return !isAbsolute(target);
+};
+
+// [function]
+
+const video = function (root, target, opts) {
+  return videoCheck(join(root, target), opts);
+};
+
+// [export]
+
+module.exports = { exists, image, isIn, isOut, isRelative, video };

package/src/schema/check/workflow.js

@@ -0,0 +1,47 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const fs = require("fs-extra");
+
+// [use]
+
+const isAbsolute = path.isAbsolute;
+const join = path.join;
+const pathExistsSync = fs.pathExistsSync; // eslint-disable-line no-sync
+const resolve = path.resolve;
+
+// [function]
+
+const exists = function (root, target) {
+  return pathExistsSync(join(root, target));
+};
+
+// [function]
+
+const isOut = function (root, target) {
+  const rootPath = resolve(root);
+  const targetPath = resolve(root, target);
+  return targetPath === rootPath || targetPath.startsWith(rootPath + path.sep);
+};
+
+// [function]
+
+const isRelative = function (root, target) {
+  return !isAbsolute(target);
+};
+
+// [function]
+
+const isReserved = function (root, target, parent) {
+  const targetPath = resolve(root, target);
+  return !targetPath.split(path.sep).includes(parent);
+};
+
+// [export]
+
+module.exports = { exists, isOut, isRelative, isReserved };

package/src/schema/game.js

@@ -15,32 +15,35 @@ const cfginput = require("../config/input");
 const cfgorientation = require("../config/orientation");
 const cfgurl = require("../config/url");
 const cfgvisibility = require("../config/visibility");
+const check = require("./check/game");
 const dom = require("../util/dom");
+const strs = require("../util/strs");
 
 // [use]
 
+const existsCheck = check.exists;
+const imageCheck = check.image;
+const indentLines = strs.indentLines;
+const isInCheck = check.isIn;
+const isOutCheck = check.isOut;
+const isRelativeCheck = check.isRelative;
 const validSemver = semver.valid;
+const videoCheck = check.video;
 
-// [function]
+// [declare]
 
-const reference = function (field) {
-  return chalk.cyan.underline(`${cfgurl.MANIFEST}#${field}`);
-};
+const MEDIA = ".arcadible";
 
 // [function]
 
-const indent = function (text, spaces = 2) {
-  const pad = " ".repeat(spaces);
-  return text
-    .split("\n")
-    .map((line) => pad + line)
-    .join("\n");
+const reference = function (field) {
+  return chalk.cyan.underline(`${cfgurl.MANIFEST}#game.${field}`);
 };
 
 // [function]
 
 const message = function (field, msg) {
-  return { message: [msg, indent(reference(field))].join("\n") };
+  return { message: [msg, indentLines(reference(field))].join("\n") };
 };
 
 // [function]
@@ -58,20 +61,55 @@ const zText = function (field, { max, min }) {
 
 // [function]
 
-const zPng = function () {
-  return z.string();
+const zMedia = function (field, root) {
+  return z
+    .string()
+    .min(1)
+    .refine(
+      (file) => isRelativeCheck(root, file),
+      message(field, "Must be a relative path."),
+    )
+    .refine(
+      (file) => isOutCheck(root, file),
+      message(field, "Must be within the project."),
+    )
+    .refine(
+      (file) => isInCheck(root, file, MEDIA),
+      message(field, `Must be within ${MEDIA}.`),
+    )
+    .refine((file) => existsCheck(root, file), message(field, "Must exist."));
+};
+
+// [function]
+
+const zPng = function (field, root, opts) {
+  return zMedia(field, root).refine(
+    (file) => imageCheck(root, file, { ...opts, type: "image/png" }),
+    message(field, "Invalid PNG."),
+  );
 };
 
 // [function]
 
-const zSvg = function () {
-  return z.string();
+const zSvg = function (field, root, opts) {
+  return zMedia(field, root).refine(
+    (file) => imageCheck(root, file, { ...opts, type: "image/svg+xml" }),
+    message(field, "Invalid SVG."),
+  );
 };
 
 // [function]
 
-const zMp4 = function () {
-  return z.string();
+const zMp4 = function (field, root, opts) {
+  return zMedia(field, root).refine(
+    (file) =>
+      videoCheck(root, file, {
+        maxDuration: 10,
+        ...opts,
+        type: "video/mp4",
+      }),
+    message(field, "Invalid MP4."),
+  );
 };
 
 // [function]
@@ -97,49 +135,77 @@ const zYouTube = function () {
 // [function]
 
 const zAudience = function () {
-  // const field = "game.audience";
+  // const field = "audience";
   return z.optional(z.enum(cfgaudience));
 };
 
 // [function]
 
-const zBanner = function () {
-  // const field = "game.banner";
-  return z.optional(zPng());
+const zBanner = function (root) {
+  const field = "banner";
+  return z.optional(
+    zPng(field, root, {
+      aspect: "2:1",
+      maxSize: 2 * 1024 * 1024,
+      minHeight: 512,
+      minWidth: 1024,
+    }),
+  );
 };
 
 // [function]
 
-const zBannerVideo = function () {
-  // const field = "game.banner_video";
-  return z.optional(zMp4());
+const zBannerVideo = function (root) {
+  const field = "banner_video";
+  return z.optional(
+    zMp4(field, root, {
+      aspect: "2:1",
+      maxSize: 5 * 1024 * 1024,
+      minHeight: 512,
+      minWidth: 1024,
+    }),
+  );
 };
 
 // [function]
 
 const zBio = function () {
-  const field = "game.bio";
+  const field = "bio";
   return z.optional(zText(field, { max: 192, min: 1 }));
 };
 
 // [function]
 
-const zCover = function () {
-  // const field = "game.cover";
-  return z.optional(zPng());
+const zCover = function (root) {
+  const field = "cover";
+  return z.optional(
+    zPng(field, root, {
+      aspect: "3:2",
+      maxSize: 2 * 1024 * 1024,
+      minHeight: 512,
+      minWidth: 768,
+    }),
+  );
 };
 
 // [function]
 
-const zCoverVideo = function () {
-  // const field = "game.cover_video";
-  return z.optional(zMp4());
+const zCoverVideo = function (root) {
+  const field = "cover_video";
+  return z.optional(
+    zMp4(field, root, {
+      aspect: "3:2",
+      maxSize: 5 * 1024 * 1024,
+      minHeight: 512,
+      minWidth: 768,
+    }),
+  );
 };
 
 // [function]
 
 const zDescription = function () {
-  const field = "game.description";
+  const field = "description";
   return z.optional(
     z
       .string()
@@ -159,22 +225,32 @@ const zDescription = function () {
 
 // [function]
 
-const zGallery = function () {
-  // const field = "game.gallery";
-  return z.optional(z.array(zPng()).min(1).max(12));
+const zGallery = function (root) {
+  const field = "gallery";
+  return z.optional(
+    z
+      .array(
+        z.union([
+          zPng(field, root, { maxSize: 2 * 1024 * 1024 }),
+          zMp4(field, root, { maxSize: 5 * 1024 * 1024 }),
+        ]),
+      )
+      .min(1)
+      .max(12),
+  );
 };
 
 // [function]
 
 const zGenres = function () {
-  // const field = "game.genres";
+  // const field = "genres";
   return z.optional(z.array(z.enum(cfggenre)).max(3));
 };
 
 // [function]
 
 const zHandle = function () {
-  const field = "game.handle";
+  const field = "handle";
   return z.optional(
     z
       .string()
@@ -187,85 +263,126 @@ const zHandle = function () {
 
 // [function]
 
-const zIcon = function () {
-  // const field = "game.icon";
-  return z.optional(zPng());
+const zIcon = function (root) {
+  const field = "icon";
+  return z.optional(
+    zPng(field, root, {
+      aspect: "1:1",
+      maxSize: 2 * 1024 * 1024,
+      minHeight: 512,
+      minWidth: 512,
+    }),
+  );
 };
 
 // [function]
 
-const zIconVideo = function () {
-  // const field = "game.icon_video";
-  return z.optional(zMp4());
+const zIconVideo = function (root) {
+  const field = "icon_video";
+  return z.optional(
+    zMp4(field, root, {
+      aspect: "1:1",
+      maxSize: 5 * 1024 * 1024,
+      minHeight: 512,
+      minWidth: 512,
+    }),
+  );
+};
+
+// [function]
+
+const zId = function () {
+  const field = "id";
+  return z
+    .string()
+    .uuid(message(field, "Must be a valid UUID."))
+    .refine(
+      (value) => value === value.toLowerCase(),
+      message(field, "Must use lowercase characters."),
+    );
 };
 
 // [function]
 
 const zInputs = function () {
-  // const field = "game.inputs";
+  // const field = "inputs";
   return z.optional(z.array(z.enum(cfginput)).max(3));
 };
 
 // [function]
 
 const zOrientation = function () {
-  // const field = "game.orientation";
+  // const field = "orientation";
   return z.optional(z.enum(cfgorientation));
 };
 
 // [function]
 
-const zPoster = function () {
-  // const field = "game.poster";
-  return z.optional(zPng());
+const zPoster = function (root) {
+  const field = "poster";
+  return z.optional(
+    zPng(field, root, {
+      aspect: "2:3",
+      maxSize: 2 * 1024 * 1024,
+      minHeight: 768,
+      minWidth: 512,
+    }),
+  );
 };
 
 // [function]
 
-const zPosterVideo = function () {
-  // const field = "game.poster_video";
-  return z.optional(zMp4());
+const zPosterVideo = function (root) {
+  const field = "poster_video";
+  return z.optional(
+    zMp4(field, root, {
+      aspect: "2:3",
+      maxSize: 5 * 1024 * 1024,
+      minHeight: 768,
+      minWidth: 512,
+    }),
+  );
 };
 
 // [function]
 
 const zPrice = function () {
-  // const field = "game.price";
+  // const field = "price";
   return z.optional(z.int().min(0).max(25));
 };
 
 // [function]
 
 const zShortTitle = function () {
-  const field = "game.short_title";
+  const field = "short_title";
   return z.optional(zText(field, { max: 16, min: 1 }));
 };
 
 // [function]
 
 const zTagline = function () {
-  const field = "game.tagline";
+  const field = "tagline";
   return z.optional(zText(field, { max: 96, min: 1 }));
 };
 
 // [function]
 
 const zTitle = function () {
-  const field = "game.title";
+  const field = "title";
   return z.optional(zText(field, { max: 64, min: 1 }));
 };
 
 // [function]
 
 const zTrailer = function () {
-  const field = "game.trailer";
+  const field = "trailer";
   return z
     .string()
     .max(255)
     .refine(
       (url) =>
         zVimeo().safeParse(url).success || zYouTube().safeParse(url).success,
-      message(field, "Must be a YouTube (or Viemo) URL."),
+      message(field, "Must be a YouTube (or Vimeo) URL."),
     )
     .optional();
 };
@@ -273,7 +390,7 @@ const zTrailer = function () {
 // [function]
 
 const zVersion = function () {
-  const field = "game.version";
+  const field = "version";
   return z
     .string()
     .refine(
@@ -285,22 +402,32 @@ const zVersion = function () {
 // [function]
 
 const zVisibility = function () {
-  // const field = "game.visibility";
+  // const field = "visibility";
   return z.optional(z.enum(cfgvisibility));
 };
 
 // [function]
 
-const zWordmark = function () {
-  // const field = "game.wordmark";
-  return z.optional(zSvg());
+const zWordmark = function (root) {
+  const field = "wordmark";
+  return z.optional(
+    zSvg(field, root, {
+      aspect: "1:1",
+      maxSize: 512 * 1024,
+    }),
+  );
 };
 
 // [function]
 
-const zWordmarkAnimated = function () {
-  // const field = "game.wordmark_animated";
-  return z.optional(zSvg());
+const zWordmarkAnimated = function (root) {
+  const field = "wordmark_animated";
+  return z.optional(
+    zSvg(field, root, {
+      aspect: "1:1",
+      maxSize: 1024 * 1024,
+    }),
+  );
 };
 
 // [function]
@@ -320,6 +447,7 @@ const main = function (value, { root }) {
     handle: zHandle(),
     icon: zIcon(root),
     icon_video: zIconVideo(root),
+    id: zId(),
     inputs: zInputs(),
     orientation: zOrientation(),
     poster: zPoster(root),

package/src/schema/workflow.js

@@ -2,24 +2,22 @@
 
 // [import]
 
-const path = require("node:path");
-
-// [import]
-
 const chalk = require("chalk");
-const fs = require("fs-extra");
 const z = require("zod");
 
 // [import]
 
 const cfgurl = require("../config/url");
+const check = require("./check/workflow");
+const strs = require("../util/strs");
 
 // [use]
 
-const isAbsolute = path.isAbsolute;
-const join = path.join;
-const pathExistsSync = fs.pathExistsSync; // eslint-disable-line no-sync
-const resolve = path.resolve;
+const existsCheck = check.exists;
+const indentLines = strs.indentLines;
+const isOutCheck = check.isOut;
+const isRelativeCheck = check.isRelative;
+const isReservedCheck = check.isReserved;
 
 // [declare]
 
@@ -28,78 +26,50 @@ const MEDIA = ".arcadible";
 // [function]
 
 const reference = function (field) {
-  return chalk.cyan.underline(`${cfgurl.MANIFEST}#${field}`);
-};
-
-// [function]
-
-const indent = function (text, spaces = 2) {
-  const pad = " ".repeat(spaces);
-  return text
-    .split("\n")
-    .map((line) => pad + line)
-    .join("\n");
+  return chalk.cyan.underline(`${cfgurl.MANIFEST}#workflow.${field}`);
 };
 
 // [function]
 
 const message = function (field, msg) {
-  return { message: [msg, indent(reference(field))].join("\n") };
-};
-
-// [function]
-
-const isOutPath = function (root, dir) {
-  const resolvedRoot = resolve(root);
-  const resolvedTarget = resolve(root, dir);
-  const outside =
-    resolvedTarget !== resolvedRoot &&
-    !resolvedTarget.startsWith(resolvedRoot + path.sep);
-  return outside;
-};
-
-// [function]
-
-const isMediaPath = function (root, dir) {
-  const resolvedTarget = resolve(root, dir);
-  const containsMedia = resolvedTarget.split(path.sep).includes(MEDIA);
-  return containsMedia;
+  return { message: [msg, indentLines(reference(field))].join("\n") };
 };
 
 // [function]
 
-const isRealPath = function (root, dir) {
-  return pathExistsSync(join(root, dir));
-};
-
-// [function]
-
-const zDeployDir = function (root, { skip_build: skipBuild }) {
-  const field = "workflow.deploy_dir";
-  let zz = z
+const zMedia = function (field, root, { skipBuild }) {
+  return z
     .string()
     .min(1)
-    .refine((dir) => !isAbsolute(dir), message(field, "Must be relative."))
     .refine(
-      (dir) => !isOutPath(root, dir),
+      (file) => isRelativeCheck(root, file),
+      message(field, "Must be a relative path."),
+    )
+    .refine(
+      (file) => isOutCheck(root, file),
       message(field, "Must be within the project."),
     )
     .refine(
-      (dir) => !isMediaPath(root, dir),
-      message(field, "Must not contain reserved names."),
-    );
-  if (skipBuild) {
-    zz = zz.refine(
-      (dir) => isRealPath(root, dir),
+      (file) => isReservedCheck(root, file, MEDIA),
+      message(field, `Must not contain ${MEDIA}.`),
+    )
+    .refine(
+      (file) => !skipBuild || existsCheck(root, file),
       message(field, "Must exist."),
     );
-  }
-  return zz;
+};
+
+// [function]
+
+const zDeployDir = function (root, { skip_build: skipBuild }) {
+  const field = "deploy_dir";
+  return zMedia(field, root, { skipBuild });
 };
 
 // [function]
 
 const zSkipBuild = function () {
+  // const field = "skip_build";
   return z.boolean();
 };
 

package/src/user.js

@@ -17,10 +17,10 @@ const os = require("./util/os");
 // [use]
 
 const configDir = os.configDir;
+const deepCompact = objs.deepCompact;
 const join = path.join;
 const mkdir = fs.promises.mkdir;
 const readFile = fs.promises.readFile;
-const sortObjs = objs.sort;
 const unlink = fs.promises.unlink;
 const writeFile = fs.promises.writeFile;
 
@@ -45,7 +45,7 @@ const expired = function (session) {
 const save = function (user) {
   return mkdir(dir, { recursive: true })
     .then(() =>
-      writeFile(file, JSON.stringify(sortObjs(user), null, 2), "utf8"),
+      writeFile(file, JSON.stringify(deepCompact(user), null, 2), "utf8"),
     )
     .then(() => user);
 };