arcadible 0.1.27 → 0.1.29

package/package.json

@@ -61,5 +61,5 @@
   "license": "Apache-2.0",
   "main": "./src/cli/index.js",
   "name": "arcadible",
-  "version": "0.1.27"
+  "version": "0.1.29"
 }

package/src/config/ai.js

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

package/src/config/art.js

@@ -11,6 +11,6 @@ module.exports = [
   "icon_video.mp4",
   "poster.png",
   "poster_video.mp4",
-  "wordmark.svg",
-  "wordmark_animated.svg",
+  "splash.png",
+  "splash_video.mp4",
 ];

package/src/config/doc.js

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

package/src/config/html.js

@@ -3,25 +3,19 @@
 // [export]
 
 module.exports = {
-  ALLOWED_ATTR: ["href", "target", "rel", "src", "alt", "title"],
-  ALLOWED_TAGS: [
-    "h3",
-    "h4",
-    "h5",
-    "h6",
-    "hr",
-    "p",
-    "ul",
-    "ol",
-    "li",
-    "pre",
-    "img",
-    "a",
-    "code",
-    "strong",
-    "b",
-    "em",
-    "i",
-    "br",
-  ],
+  allowed: {
+    a: ["href", "title"],
+    blockquote: [],
+    em: [],
+    h3: [],
+    h4: [],
+    hr: [],
+    img: ["src", "alt", "title"],
+    li: [],
+    ol: [],
+    p: [],
+    strong: [],
+    ul: [],
+    video: ["src", "alt", "title"],
+  },
 };

package/src/config/image.js

@@ -4,5 +4,4 @@
 
 module.exports = {
   ".png": "image/png",
-  ".svg": "image/svg+xml",
 };

package/src/config/visibility.js

@@ -2,4 +2,4 @@
 
 // [export]
 
-module.exports = ["private", "unlisted", "public"];
+module.exports = ["unlisted", "public"];

package/src/phrase.js

@@ -34,6 +34,36 @@ const cmdValidate = function () {
 
 // [function]
 
+const docAttrInvalid = function (tag, attr, value) {
+  return `Value '${value}' is not valid for the '${attr}' attribute on the '${tag}' tag.`;
+};
+
+// [function]
+
+const docAttrUnallowed = function (tag, attr) {
+  return `Attribute '${attr}' is not permitted on the '${tag}' tag.`;
+};
+
+// [function]
+
+const docSanitizeFailed = function () {
+  return "Document contains invalid elements.";
+};
+
+// [function]
+
+const docTagUnallowed = function (tag) {
+  return `Tag '${tag}' is not permitted.`;
+};
+
+// [function]
+
+const docUnsupported = function () {
+  return "Document has an unsupported file type.";
+};
+
+// [function]
+
 const gameExists = function (idOrHandle) {
   return `Game exists: ${idOrHandle}`;
 };
@@ -355,8 +385,11 @@ const videoWidthMin = function (width) {
 module.exports = {
   cmdInit,
   cmdInspect,
-  cmdLogin,
-  cmdValidate,
+  docAttrInvalid,
+  docAttrUnallowed,
+  docSanitizeFailed,
+  docTagUnallowed,
+  docUnsupported,
   gameExists,
   gameVersionExists,
   gitChangesPresent,

package/src/schema/check/game.js

@@ -10,6 +10,7 @@ const fs = require("fs-extra");
 
 // [import]
 
+const docCheck = require("../../util/doc").check;
 const imageCheck = require("../../util/image").check;
 const videoCheck = require("../../util/video").check;
 
@@ -23,6 +24,12 @@ const resolve = path.resolve;
 
 // [function]
 
+const doc = function (root, str, opts) {
+  return docCheck(str, opts);
+};
+
+// [function]
+
 const exists = function (root, target) {
   return pathExistsSync(join(root, target));
 };
@@ -64,4 +71,12 @@ const video = function (root, target, opts) {
 
 // [export]
 
-module.exports = { exists, image, isIn, isOut, isRelative, video };
+module.exports = {
+  doc,
+  exists,
+  image,
+  isIn,
+  isOut,
+  isRelative,
+  video,
+};

package/src/schema/game.js

@@ -8,7 +8,9 @@ const z = require("zod");
 
 // [import]
 
+const cfgai = require("../config/ai");
 const cfgaudience = require("../config/audience");
+const cfgdoc = require("../config/doc");
 const cfggenre = require("../config/genre");
 const cfghtml = require("../config/html");
 const cfgimage = require("../config/image");
@@ -19,28 +21,41 @@ const cfgurl = require("../config/url");
 const cfgvideo = require("../config/video");
 const cfgvisibility = require("../config/visibility");
 const check = require("./check/game");
-const dom = require("../util/dom");
+const paths = require("../util/paths");
 const phrase = require("../phrase");
 const size = require("../util/size");
 const strs = require("../util/strs");
+const uris = require("../util/uris");
 
 // [use]
 
+const basefile = paths.basefile;
 const cleanSemver = semver.clean;
+const docCheck = check.doc;
 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 isSafeUri = uris.isSafeUri;
 const validSemver = semver.valid;
 const videoCheck = check.video;
 
 // [declare]
 
 const HANDLE = cfgproduct.handle;
+
+// [declare]
+
+const GALLERY = `.${HANDLE}/gallery`;
 const MEDIA = `.${HANDLE}`;
 
+// [declare]
+
+const MAX_SIZE_MP4 = size.mb(15);
+const MAX_SIZE_PNG = size.mb(2);
+
 // [function]
 
 const reference = function (field) {
@@ -61,15 +76,62 @@ const message = function (field, lines) {
 
 // [function]
 
-const zText = function (field, { max, min }) {
+const zSet = function (field, schema, { max, min }) {
+  return z
+    .array(schema)
+    .min(min, message(field, [`Must be at least: ${min} element`]))
+    .max(max, message(field, [`Must not exceed: ${max} elements`]))
+    .refine(
+      (items) => new Set(items).size === items.length,
+      message(field, ["Must not contain duplicate elements."]),
+    );
+};
+
+// [function]
+
+const zSetBasefile = function (field, schema, { max, min }) {
+  return z
+    .array(schema)
+    .min(min, message(field, [`Must be at least: ${min} file`]))
+    .max(max, message(field, [`Must not exceed: ${max} files`]))
+    .refine(
+      (items) => new Set(items.map(basefile)).size === items.length,
+      message(field, [
+        "Must not contain duplicate filenames (ignoring extensions).",
+      ]),
+    );
+};
+
+// [function]
+
+const zString = function (field, re, { max, min }) {
   return z
     .string()
     .min(min, message(field, [`Must be at least: ${min} character`]))
     .max(max, message(field, [`Must not exceed: ${max} characters`]))
-    .regex(
-      /^[\p{L}0-9 .,!?'"():;-]+$/u,
-      message(field, ["Contains invalid characters."]),
-    );
+    .regex(re, message(field, ["Contains invalid characters."]));
+};
+
+// [function]
+
+const zText = function (field, opts) {
+  const re = /^[\p{L}0-9 .,!?'"():;-]+$/u;
+  return zString(field, re, opts);
+};
+
+// [function]
+
+const zHtml = function (field, root, { max, min, ...opts }) {
+  const re = /^[\p{L}\p{M}\p{N}\p{P}\p{S}\p{Zs}\r\n]*$/u;
+  return zString(field, re, { max, min }).superRefine((str, ctx) => {
+    const issues = docCheck(root, str, { ...opts, type: cfgdoc[".html"] });
+    if (issues.length) {
+      ctx.addIssue({
+        code: "custom",
+        ...message(field, ["Invalid Markdown.", ...issues]),
+      });
+    }
+  });
 };
 
 // [function]
@@ -109,13 +171,18 @@ const zPng = function (field, root, opts) {
 
 // [function]
 
-const zSvg = function (field, root, opts) {
+const zMp4 = function (field, root, opts) {
   return zMedia(field, root).superRefine((file, ctx) => {
-    const issues = imageCheck(root, file, { ...opts, type: cfgimage[".svg"] });
+    const issues = videoCheck(root, file, {
+      maxDuration: 30,
+      minDuration: 3,
+      ...opts,
+      type: cfgvideo[".mp4"],
+    });
     if (issues.length) {
       ctx.addIssue({
         code: "custom",
-        ...message(field, ["Invalid SVG.", ...issues]),
+        ...message(field, ["Invalid MP4.", ...issues]),
       });
     }
   });
@@ -123,19 +190,27 @@ const zSvg = function (field, root, opts) {
 
 // [function]
 
-const zMp4 = function (field, root, opts) {
-  return zMedia(field, root).superRefine((file, ctx) => {
-    const issues = videoCheck(root, file, {
-      maxDuration: 30,
-      minDuration: 3,
-      ...opts,
-      type: cfgvideo[".mp4"],
-    });
-    if (issues.length) {
+const zPngMp4 = function (field, root, optsPng, optsMp4) {
+  const pngSchema = zPng(field, root, optsPng);
+  const mp4Schema = zMp4(field, root, optsMp4);
+  return z.string().superRefine((file, ctx) => {
+    let schema = null;
+    if (file?.endsWith(".png")) {
+      schema = pngSchema;
+    }
+    if (file?.endsWith(".mp4")) {
+      schema = mp4Schema;
+    }
+    if (!schema) {
       ctx.addIssue({
         code: "custom",
-        ...message(field, ["Invalid MP4.", ...issues]),
+        ...message(field, ["Must be a PNG or MP4 file."]),
       });
+      return;
+    }
+    const result = schema.safeParse(file);
+    if (!result.success) {
+      result.error.issues.forEach((issue) => ctx.addIssue(issue));
     }
   });
 };
@@ -162,6 +237,13 @@ const zYouTube = function () {
 
 // [function]
 
+const zAi = function () {
+  // const field = "ai";
+  return z.optional(z.enum(cfgai));
+};
+
+// [function]
+
 const zAudience = function () {
   // const field = "audience";
   return z.optional(z.enum(cfgaudience));
@@ -174,7 +256,7 @@ const zBanner = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "2:1",
-      maxSize: size.mb(2),
+      maxSize: MAX_SIZE_PNG,
       minHeight: 512,
       minWidth: 1024,
     }),
@@ -188,7 +270,7 @@ const zBannerVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "2:1",
-      maxSize: size.mb(15),
+      maxSize: MAX_SIZE_MP4,
       minHeight: 512,
       minWidth: 1024,
     }),
@@ -209,7 +291,7 @@ const zCover = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "3:2",
-      maxSize: size.mb(2),
+      maxSize: MAX_SIZE_PNG,
       minHeight: 512,
       minWidth: 768,
     }),
@@ -223,7 +305,7 @@ const zCoverVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "3:2",
-      maxSize: size.mb(15),
+      maxSize: MAX_SIZE_MP4,
       minHeight: 512,
       minWidth: 768,
     }),
@@ -232,22 +314,22 @@ const zCoverVideo = function (root) {
 
 // [function]
 
-const zDescription = function () {
+const zDescription = function (root) {
   const field = "description";
   return z.optional(
-    z
-      .string()
-      .min(1, message(field, ["Must be at least: 1 character"]))
-      .max(3000, message(field, ["Must not exceed: 3000 characters"]))
-      .refine(
-        (str) =>
-          str ===
-          dom.sanitize(str, {
-            ALLOWED_ATTR: cfghtml.ALLOWED_ATTR,
-            ALLOWED_TAGS: cfghtml.ALLOWED_TAGS,
-          }),
-        message(field, ["Contains invalid elements."]),
-      ),
+    zHtml(field, root, {
+      allowed: cfghtml.allowed,
+      hooks: {
+        href: (uri) => isSafeUri(uri),
+        src: (src) =>
+          isRelativeCheck(root, src) &&
+          isOutCheck(root, src) &&
+          isInCheck(root, src, GALLERY) &&
+          existsCheck(root, src),
+      },
+      max: 3000,
+      min: 1,
+    }),
   );
 };
 
@@ -256,48 +338,26 @@ const zDescription = function () {
 const zGallery = function (root) {
   const field = "gallery";
   return z.optional(
-    z
-      .array(
-        zMedia(field, root).superRefine((file, ctx) => {
-          if (file.endsWith(".png")) {
-            const issues = imageCheck(root, file, {
-              maxSize: size.mb(2),
-              type: cfgimage[".png"],
-            });
-            if (issues.length) {
-              ctx.addIssue({
-                code: "custom",
-                ...message(field, [`Invalid PNG: ${file}`, ...issues]),
-              });
-            }
-          } else if (file.endsWith(".svg")) {
-            const issues = imageCheck(root, file, {
-              maxSize: size.mb(1),
-              type: cfgimage[".svg"],
-            });
-            if (issues.length) {
-              ctx.addIssue({
-                code: "custom",
-                ...message(field, [`Invalid SVG: ${file}`, ...issues]),
-              });
-            }
-          } else if (file.endsWith(".mp4")) {
-            const issues = videoCheck(root, file, {
-              maxDuration: 30,
-              maxSize: size.mb(15),
-              minDuration: 3,
-              type: cfgvideo[".mp4"],
-            });
-            if (issues.length) {
-              ctx.addIssue({
-                code: "custom",
-                ...message(field, [`Invalid MP4: ${file}`, ...issues]),
-              });
-            }
-          }
-        }),
-      )
-      .max(12, message(field, ["Must not exceed: 12 elements"])),
+    zSetBasefile(
+      field,
+      zPngMp4(
+        field,
+        root,
+        // png
+        {
+          maxSize: MAX_SIZE_PNG,
+          minHeight: 512,
+          minWidth: 512,
+        },
+        // mp4
+        {
+          maxSize: MAX_SIZE_MP4,
+          minHeight: 512,
+          minWidth: 512,
+        },
+      ),
+      { max: 8 * 3, min: 1 },
+    ),
   );
 };
 
@@ -305,11 +365,7 @@ const zGallery = function (root) {
 
 const zGenres = function () {
   const field = "genres";
-  return z.optional(
-    z
-      .array(z.enum(cfggenre))
-      .max(3, message(field, ["Must not exceed: 3 elements"])),
-  );
+  return z.optional(zSet(field, z.enum(cfggenre), { max: 3, min: 1 }));
 };
 
 // [function]
@@ -333,7 +389,7 @@ const zIcon = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "1:1",
-      maxSize: size.mb(2),
+      maxSize: MAX_SIZE_PNG,
       minHeight: 512,
       minWidth: 512,
     }),
@@ -347,7 +403,7 @@ const zIconVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "1:1",
-      maxSize: size.mb(15),
+      maxSize: MAX_SIZE_MP4,
       minHeight: 512,
       minWidth: 512,
     }),
@@ -376,11 +432,7 @@ const zId = function () {
 
 const zInputs = function () {
   const field = "inputs";
-  return z.optional(
-    z
-      .array(z.enum(cfginput))
-      .max(3, message(field, ["Must not exceed: 3 elements"])),
-  );
+  return z.optional(zSet(field, z.enum(cfginput), { max: 3, min: 1 }));
 };
 
 // [function]
@@ -397,7 +449,7 @@ const zPoster = function (root) {
   return z.optional(
     zPng(field, root, {
       aspect: "2:3",
-      maxSize: size.mb(2),
+      maxSize: MAX_SIZE_PNG,
       minHeight: 768,
       minWidth: 512,
     }),
@@ -411,7 +463,7 @@ const zPosterVideo = function (root) {
   return z.optional(
     zMp4(field, root, {
       aspect: "2:3",
-      maxSize: size.mb(15),
+      maxSize: MAX_SIZE_MP4,
       minHeight: 768,
       minWidth: 512,
     }),
@@ -439,6 +491,34 @@ const zShortTitle = function () {
 
 // [function]
 
+const zSplash = function (root) {
+  const field = "splash";
+  return z.optional(
+    zPng(field, root, {
+      aspect: "16:9",
+      maxSize: MAX_SIZE_PNG,
+      minHeight: 576,
+      minWidth: 1024,
+    }),
+  );
+};
+
+// [function]
+
+const zSplashVideo = function (root) {
+  const field = "splash_video";
+  return z.optional(
+    zMp4(field, root, {
+      aspect: "16:9",
+      maxSize: MAX_SIZE_MP4,
+      minHeight: 576,
+      minWidth: 1024,
+    }),
+  );
+};
+
+// [function]
+
 const zTagline = function () {
   const field = "tagline";
   return z.optional(zText(field, { max: 30 * 1, min: 1 }));
@@ -496,38 +576,17 @@ const zVisibility = function () {
 
 // [function]
 
-const zWordmark = function (root) {
-  const field = "wordmark";
-  return z.optional(
-    zSvg(field, root, {
-      maxSize: size.kb(512),
-    }),
-  );
-};
-
-// [function]
-
-const zWordmarkAnimated = function (root) {
-  const field = "wordmark_animated";
-  return z.optional(
-    zSvg(field, root, {
-      maxSize: size.mb(1),
-    }),
-  );
-};
-
-// [function]
-
 const main = function (value, { root }) {
   /* eslint-disable camelcase */
   return z.object({
+    ai: zAi(),
     audience: zAudience(),
     banner: zBanner(root),
     banner_video: zBannerVideo(root),
     bio: zBio(),
     cover: zCover(root),
     cover_video: zCoverVideo(root),
-    description: zDescription(),
+    description: zDescription(root),
     gallery: zGallery(root),
     genres: zGenres(),
     handle: zHandle(),
@@ -540,13 +599,13 @@ const main = function (value, { root }) {
     poster_video: zPosterVideo(root),
     price: zPrice(),
     short_title: zShortTitle(),
+    splash: zSplash(root),
+    splash_video: zSplashVideo(root),
     tagline: zTagline(),
     title: zTitle(),
     trailer: zTrailer(),
     version: zVersion(),
     visibility: zVisibility(),
-    wordmark: zWordmark(root),
-    wordmark_animated: zWordmarkAnimated(root),
   });
   /* eslint-enable camelcase */
 };

package/src/util/doc.js

@@ -0,0 +1,65 @@
+"use strict";
+
+// [import]
+
+const cfgdoc = require("../config/doc");
+const dom = require("./dom");
+const phrase = require("../phrase");
+
+// [function]
+
+const checkAttr = function (allowed, hooks, issues) {
+  return (node, event) => {
+    const nodeName = node.nodeName.toLowerCase();
+    const attrName = event.attrName;
+    const attrValue = event.attrValue;
+    const isAllowed = allowed[nodeName]?.includes(attrName);
+    const isValid = !hooks[attrName] || hooks[attrName](attrValue);
+    if (!isAllowed || !isValid) {
+      issues.push({ attrName, attrValue, isAllowed, isValid, nodeName });
+      event.keepAttr = false;
+    }
+  };
+};
+
+// [function]
+
+const checkAllowed = function (str, allowed, hooks, issues) {
+  const attr = checkAttr(allowed, hooks, issues);
+  return str === dom.sanitize(str, { allowed, hooks: { attr } });
+};
+
+// [function]
+
+const checkHtml = function (str, { allowed, hooks }) {
+  const issues = [];
+  if (!checkAllowed(str, allowed, hooks, issues)) {
+    if (issues) {
+      return issues.map((issue) => {
+        const { attrName, attrValue, isAllowed, isValid, nodeName } = issue;
+        if (!isAllowed) {
+          return Object.hasOwn(allowed, nodeName)
+            ? phrase.docAttrUnallowed(nodeName, attrName)
+            : phrase.docTagUnallowed(nodeName);
+        }
+        return isValid
+          ? phrase.docSanitizeFailed()
+          : phrase.docAttrInvalid(nodeName, attrName, attrValue);
+      });
+    }
+    return [phrase.docSanitizeFailed()];
+  }
+  return [];
+};
+
+// [function]
+
+const check = function (str, { type, ...opts }) {
+  const checks = { [cfgdoc[".html"]]: checkHtml };
+  const checkDoc = checks[type];
+  return checkDoc ? checkDoc(str, opts) : [phrase.docUnsupported()];
+};
+
+// [export]
+
+module.exports = { check };

package/src/util/dom.js

@@ -11,17 +11,36 @@ const JSDOM = jsdom.JSDOM;
 
 // [function]
 
-const sanitize = function (str, cfg) {
-  const dom = dompurify(new JSDOM().window);
-  if (cfg) {
+const sanitizeCustom = function (dom, str, cfg) {
+  const allowed = cfg.allowed;
+  const hooks = cfg.hooks;
+  if (hooks?.attr) {
+    dom.addHook("uponSanitizeAttribute", hooks.attr);
+  }
+  if (allowed) {
+    const attrs = new Set(Object.values(allowed).flatMap((arr) => arr));
+    const tags = Object.keys(allowed);
     return dom.sanitize(str, {
-      ALLOWED_ATTR: cfg.ALLOWED_ATTR,
-      ALLOWED_TAGS: cfg.ALLOWED_TAGS,
+      ALLOWED_ATTR: attrs,
+      ALLOWED_TAGS: tags,
     });
   }
   return dom.sanitize(str);
 };
 
+// [function]
+
+const sanitizeBasic = function (dom, str) {
+  return dom.sanitize(str);
+};
+
+// [function]
+
+const sanitize = function (str, cfg) {
+  const dom = dompurify(new JSDOM().window);
+  return cfg ? sanitizeCustom(dom, str, cfg) : sanitizeBasic(dom, str);
+};
+
 // [export]
 
 module.exports = { DOM: JSDOM, sanitize };

package/src/util/image.js

@@ -71,19 +71,9 @@ const checkPng = function (file, { aspect, maxSize, minHeight, minWidth }) {
 
 // [function]
 
-const checkSvg = function (file, { maxSize }) {
-  if (!checkSize(file, maxSize)) {
-    return [phrase.imageSizeMax(formatBytes(maxSize))];
-  }
-  return [];
-};
-
-// [function]
-
 const check = function (file, { type, ...opts }) {
   const checks = {
     [cfgimage[".png"]]: checkPng,
-    [cfgimage[".svg"]]: checkSvg,
   };
   const checkImage = checks[type];
   return checkImage && cfgimage[extname(file)] === type

package/src/util/paths.js

@@ -0,0 +1,19 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [use]
+
+const extname = path.extname;
+
+// [function]
+
+const basefile = function (file) {
+  return file.slice(0, -extname(file).length);
+};
+
+// [export]
+
+module.exports = { basefile };

package/src/util/schema.js

@@ -4,6 +4,10 @@
 
 const chalk = require("chalk");
 
+// [import]
+
+const cfgurl = require("../config/url");
+
 // [function]
 
 const dereference = function (issues) {
@@ -12,7 +16,7 @@ const dereference = function (issues) {
     issue
       .split("\n")
       .filter((line) => {
-        if (/https?:\/\//u.test(line)) {
+        if (new RegExp(`${cfgurl.MANIFEST}`, "u").test(line)) {
           references.add(line.trim());
           return false;
         }

package/src/util/uris.js

@@ -0,0 +1,11 @@
+"use strict";
+
+// [function]
+
+const isSafeUri = function (uri) {
+  return /^(?:(?:https):|[^a-z]|[a-z+.-]+(?:[^a-z+.\-:]|$))/iu.test(uri);
+};
+
+// [export]
+
+module.exports = { isSafeUri };