@bscotch/gamemaker-releases 0.3.1 → 0.4.0

package/README.md

@@ -17,13 +17,19 @@ Latest releases document: https://github.com/bscotch/gamemaker-info/releases/lat
 ## Usage
 
 ```ts
-import { listReleasesWithNotes } from '@bscotch/gamemaker-releases';
-
-// Get info for all releases, including IDE and Runtime, across
-// all channels, with release notes. The first run may take a while,
-// since there are many files that need to be fetched. These are
-// cached for future runs, however.
-const releases = await listReleasesWithNotes();
+import {
+  fetchReleasesSummaryWithNotes,
+  computeReleasesSummaryWithNotes
+} from '@bscotch/gamemaker-releases';
+
+// 🚀 Fetch the latest already-computed summary
+// of all GameMaker releases:
+const releases = await fetchReleasesSummaryWithNotes();
+
+// 🐌 Freshly compile the centralized release summary.
+// This can be useful if the pre-computed
+// summary is out of date.
+const releases = await computeReleasesSummaryWithNotes();
 ```
 
 ## Background Info

package/dist/browser.d.ts

@@ -4,10 +4,5 @@
 export { ideFeedUrls, runtimeFeedUrls } from './urls.js';
 export { gameMakerReleaseWithNotesSchema } from './feeds.types.js';
 export type { ArtifactType, Channel, GameMakerRelease, GameMakerReleaseWithNotes, } from './feeds.types.js';
-/**
- * This package is used to generate a releases object, stored
- * as a JSON file for public download. The latest version of this
- * releases object can be downloaded from this URL.
- */
-export declare const releasesUrl = "https://github.com/bscotch/gamemaker-info/releases/latest/download/releases-summary.json";
+export { releasesUrl } from './releases.js';
 //# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,kBAAkB,CAAC;AACnE,YAAY,EACV,YAAY,EACZ,OAAO,EACP,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B;;;;GAIG;AACH,eAAO,MAAM,WAAW,6FACoE,CAAC"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,kBAAkB,CAAC;AACnE,YAAY,EACV,YAAY,EACZ,OAAO,EACP,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/dist/browser.js

@@ -3,10 +3,5 @@
  */
 export { ideFeedUrls, runtimeFeedUrls } from './urls.js';
 export { gameMakerReleaseWithNotesSchema } from './feeds.types.js';
-/**
- * This package is used to generate a releases object, stored
- * as a JSON file for public download. The latest version of this
- * releases object can be downloaded from this URL.
- */
-export const releasesUrl = 'https://github.com/bscotch/gamemaker-info/releases/latest/download/releases-summary.json';
+export { releasesUrl } from './releases.js';
 //# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,kBAAkB,CAAC;AAOnE;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GACtB,0FAA0F,CAAC"}
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,kBAAkB,CAAC;AAOnE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/dist/releases.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This package is used to generate a releases object, stored
+ * as a JSON file for public download. The latest version of this
+ * releases object can be downloaded from this URL.
+ */
+export declare const releasesUrl = "https://github.com/bscotch/gamemaker-info/releases/latest/download/releases-summary.json";
+/**
+ * Given a URL to an already-synthesized
+ * GameMaker Studio merged-releases feed,
+ * download the feed and return the list of
+ * releases.
+ */
+export declare function downloadGameMakerInfo(url?: string): Promise<{
+    ide: {
+        link?: string | undefined;
+        type: "ide" | "runtime";
+        channel: "lts" | "stable" | "beta" | "unstable";
+        version: string;
+        feedUrl: string;
+        publishedAt: string;
+        notesUrl: string;
+        notes: {
+            since: string | null;
+            groups: {
+                title: string;
+                changes: string[];
+            }[];
+        };
+    };
+    runtime: {
+        link?: string | undefined;
+        type: "ide" | "runtime";
+        channel: "lts" | "stable" | "beta" | "unstable";
+        version: string;
+        feedUrl: string;
+        publishedAt: string;
+        notesUrl: string;
+        notes: {
+            since: string | null;
+            groups: {
+                title: string;
+                changes: string[];
+            }[];
+        };
+    };
+    channel: "lts" | "stable" | "beta" | "unstable";
+    summary: string;
+    publishedAt: string;
+}[]>;
+//# sourceMappingURL=releases.d.ts.map

package/dist/releases.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"releases.d.ts","sourceRoot":"","sources":["../src/releases.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,WAAW,6FACoE,CAAC;AAE7F;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,GAAG,SAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAM5D"}

package/dist/releases.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { gameMakerReleaseWithNotesSchema } from './feeds.types.js';
+import { fetchJson } from './fetch.js';
+/**
+ * This package is used to generate a releases object, stored
+ * as a JSON file for public download. The latest version of this
+ * releases object can be downloaded from this URL.
+ */
+export const releasesUrl = 'https://github.com/bscotch/gamemaker-info/releases/latest/download/releases-summary.json';
+/**
+ * Given a URL to an already-synthesized
+ * GameMaker Studio merged-releases feed,
+ * download the feed and return the list of
+ * releases.
+ */
+export async function downloadGameMakerInfo(url = releasesUrl) {
+    const releases = await fetchJson(url, z.array(gameMakerReleaseWithNotesSchema));
+    return releases;
+}
+//# sourceMappingURL=releases.js.map

package/dist/releases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"releases.js","sourceRoot":"","sources":["../src/releases.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,+BAA+B,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GACtB,0FAA0F,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,GAAG,GAAG,WAAW;IAC3D,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,GAAG,EACH,CAAC,CAAC,KAAK,CAAC,+BAA+B,CAAC,CACzC,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bscotch/gamemaker-releases",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Utility for combining GameMaker release data into a single feed.",
   "keywords": [
     "gamemaker",
@@ -37,33 +37,32 @@
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc --build",
-    "clean": "rimraf build dist",
-    "test": "mocha --config ../../config/.mocharc.cjs",
-    "test:dev": "mocha --config ../../config/.mocharc.cjs --forbid-only=false --parallel=false --timeout=9999999999",
-    "watch": "tsc --build --watch"
-  },
   "dependencies": {
-    "@bscotch/pathy": "^2.5.1",
-    "@bscotch/utility": "^6.7.0",
+    "@bscotch/pathy": "^2.6.0",
+    "@bscotch/utility": "^6.8.0",
     "entities": "^4.4.0",
-    "fast-xml-parser": "^4.0.12",
+    "fast-xml-parser": "^4.1.2",
     "node-fetch": "^3.3.0",
-    "tslib": "^2.4.1",
-    "zod": "^3.19.1"
+    "tslib": "^2.5.0",
+    "zod": "^3.20.6"
   },
   "devDependencies": {
     "@types/chai": "^4",
     "@types/mocha": "^10.0.1",
     "@types/rimraf": "^3",
     "chai": "^4.3.7",
-    "mocha": "^10.1.0",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.9.3"
+    "mocha": "^10.2.0",
+    "rimraf": "^4.1.2",
+    "typescript": "^4.9.5"
   },
-  "packageManager": "yarn@3.2.4",
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf build dist",
+    "test": "mocha --config ../../config/.mocharc.cjs",
+    "test:dev": "mocha --config ../../config/.mocharc.cjs --forbid-only=false --parallel=false --timeout=9999999999",
+    "watch": "tsc --build --watch"
   }
 }

package/dist/feeds.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=feeds.test.d.ts.map

package/dist/feeds.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"feeds.test.d.ts","sourceRoot":"","sources":["../src/feeds.test.ts"],"names":[],"mappings":""}

package/dist/feeds.test.js

@@ -1,42 +0,0 @@
-import { pathy } from '@bscotch/pathy';
-import { expect } from 'chai';
-import { cleanNote } from './notes.js';
-import { listReleases, listReleasesWithNotes } from './feeds.js';
-import { rawReleaseNotesCacheSchema } from './feeds.types.js';
-const notesCache = pathy('release-notes-cache.json').withValidator(rawReleaseNotesCacheSchema);
-const tmpSummaryPath = pathy('releases-summary.json');
-const sampleReleaseNotesPath = pathy('samples/release_notes.json');
-describe('Release Feeds', function () {
-    it('can parse runtime release_notes HTML', async function () {
-        const notes = (await sampleReleaseNotesPath.read());
-        const cleaned = cleanNote({
-            type: 'runtime',
-            version: '2022.1100.0.259',
-            url: 'https://gms.yoyogames.com/release-notes-2022.1100.0.259.json',
-            ...notes,
-        });
-        expect(cleaned.title).to.equal('Changes Since Beta Runtime 258');
-        expect(cleaned.changes.groups).to.exist;
-        expect(cleaned.changes.groups.length).to.be.greaterThan(0);
-        expect(cleaned.changes.since).to.equal('258');
-        expect(cleaned.changes.groups[0].title).to.equal('Other Bugs Fixed');
-        expect(cleaned.changes.groups[0].changes.length).to.equal(2);
-    });
-    it('can create a centralized GameMaker Releases database', async function () {
-        const releases = await listReleases();
-        const withNotes = await listReleasesWithNotes(releases, notesCache);
-        await tmpSummaryPath.write(withNotes);
-        expect(withNotes.length).to.be.greaterThan(0);
-        expect(withNotes.every((r) => r.channel)).to.exist;
-        for (const type of ['ide', 'runtime']) {
-            expect(withNotes.every((r) => r[type])).to.exist;
-            expect(withNotes.every((r) => r[type].version)).to.exist;
-            expect(withNotes.every((r) => r[type].notes)).to.exist;
-            expect(withNotes.every((r) => r[type].notes.groups)).to.exist;
-        }
-        const sampleRelease = withNotes.find((r) => r.runtime.version === '2022.1100.0.259');
-        expect(sampleRelease.runtime.notes.groups).to.exist;
-        expect(sampleRelease.runtime.notes.groups.length).to.be.greaterThan(0);
-    });
-});
-//# sourceMappingURL=feeds.test.js.map

package/dist/feeds.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"feeds.test.js","sourceRoot":"","sources":["../src/feeds.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAE9D,MAAM,UAAU,GAAG,KAAK,CAAC,0BAA0B,CAAC,CAAC,aAAa,CAChE,0BAA0B,CAC3B,CAAC;AACF,MAAM,cAAc,GAAG,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAEtD,MAAM,sBAAsB,GAAG,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAEnE,QAAQ,CAAC,eAAe,EAAE;IACxB,EAAE,CAAC,sCAAsC,EAAE,KAAK;QAC9C,MAAM,KAAK,GAAG,CAAC,MAAM,sBAAsB,CAAC,IAAI,EAAE,CAEjD,CAAC;QACF,MAAM,OAAO,GAAG,SAAS,CAAC;YACxB,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,iBAAiB;YAC1B,GAAG,EAAE,8DAA8D;YACnE,GAAG,KAAK;SACT,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACjE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK;QAC9D,MAAM,QAAQ,GAAG,MAAM,YAAY,EAAE,CAAC;QACtC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpE,MAAM,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;QACnD,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,SAAS,CAAU,EAAE;YAC9C,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;YACjD,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;YACzD,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;YACvD,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;SAC/D;QACD,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,KAAK,iBAAiB,CAC9C,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;QACpD,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}