gm-pantry 0.3.1 → 0.4.0

package/dist/builder.d.ts

@@ -14,6 +14,12 @@ export interface NewVersion {
     version?: string;
     notes?: string;
     released?: string;
+    /** What is inside the archive (paths relative to its root) and its README text, if any. */
+    contents?: {
+        path: string;
+        size: number;
+    }[];
+    readme?: string;
     format?: string;
     file: {
         url: string;

package/dist/builder.js

@@ -18,6 +18,10 @@ export function addVersion(repo, v) {
         for (const old of game.versions ?? []) {
             if (old.file?.url === v.file.url) {
                 old.file = { ...old.file, sha256: v.file.sha256, size: v.file.size };
+                if (v.contents)
+                    old.contents = v.contents;
+                if (v.readme)
+                    old.readme = v.readme;
                 return game;
             }
         }
@@ -40,8 +44,8 @@ export function addVersion(repo, v) {
             ;
     else if (taken.has(label))
         throw new Error(`game ${id} already has a version ${label}`);
-    const { notes, released, format, file } = v;
-    game.versions.unshift({ version: label, file, ...(format && { format }), ...(notes && { notes }), ...(released && { released }) });
+    const { notes, released, format, file, contents, readme } = v;
+    game.versions.unshift({ version: label, file, ...(format && { format }), ...(notes && { notes }), ...(contents && { contents }), ...(readme && { readme }), ...(released && { released }) });
     return game;
 }
 /** Adds an archive by its url, deriving the game id and title from the file name. */

package/dist/parse.d.ts

@@ -13,6 +13,9 @@ export declare const LIMITS: {
     readonly metaText: 2000;
     readonly author: 120;
     readonly notes: 2000;
+    readonly contents: 2000;
+    readonly contentPath: 260;
+    readonly readme: 20000;
     readonly tags: 20;
     readonly tag: 40;
     readonly screenshots: 20;

package/dist/parse.js

@@ -14,6 +14,9 @@ export const LIMITS = {
     metaText: 2000,
     author: 120,
     notes: 2000,
+    contents: 2000,
+    contentPath: 260,
+    readme: 20000,
     tags: 20,
     tag: 40,
     screenshots: 20,
@@ -202,12 +205,34 @@ function parseVersion(v, path, baseUrl, warn) {
         version.notes = notes;
     else if (v.notes !== undefined)
         warn(`${path}.notes`, "dropped");
+    const contents = parseContents(v.contents);
+    if (contents)
+        version.contents = contents;
+    else if (v.contents !== undefined)
+        warn(`${path}.contents`, "dropped: not a list of {path, size} of at most 2000 entries");
+    if (typeof v.readme === "string" && v.readme.trim() !== "" && v.readme.length <= LIMITS.readme)
+        version.readme = v.readme;
+    else if (v.readme !== undefined)
+        warn(`${path}.readme`, "dropped");
     if (validDate(v.released))
         version.released = v.released;
     else if (v.released !== undefined)
         warn(`${path}.released`, "dropped: not an ISO-8601 date");
     return version;
 }
+function parseContents(c) {
+    if (!Array.isArray(c) || c.length === 0 || c.length > LIMITS.contents)
+        return undefined;
+    const out = [];
+    for (const e of c) {
+        if (!isObject(e) || typeof e.path !== "string" || e.path === "" || e.path.length > LIMITS.contentPath)
+            return undefined;
+        if (!Number.isSafeInteger(e.size) || e.size < 0)
+            return undefined;
+        out.push({ path: e.path, size: e.size });
+    }
+    return out;
+}
 function parseWork(w) {
     if (!isObject(w))
         return undefined;

package/dist/types.d.ts

@@ -13,6 +13,13 @@ export interface Version {
     /** Claimed hash of the normalised game payload; a hint, consumers recompute. */
     build?: string;
     notes?: string;
+    /** What is inside the archive, so a consumer can tell what it holds without downloading it. Advisory. */
+    contents?: {
+        path: string;
+        size: number;
+    }[];
+    /** The archive's README text, so it can be shown without downloading the archive. Advisory. */
+    readme?: string;
     /** YYYY-MM-DD, or a full ISO-8601 timestamp. */
     released?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gm-pantry",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Game repositories: static directories of game archives with a repo.json, plus a parser, validator and CLI.",
   "keywords": [
     "gamemaker",