test: add API shape test for build output

Author: cwillisf

.github/workflows/ci-cd.yml

@@ -40,8 +40,10 @@ jobs:
             - name: Setup & Test
               run: |
                   npm ci
+                  npm run clean
+                  npm run test # runs on source files
                   npm run build
-                  npm run test
+                  npm run test:build # requires build output
 
             - name: Semantic release (configured to run dry if branch is other than 'develop')
               env:

package.json

@@ -13,12 +13,14 @@
   "browser": "./dist/web/scratch-storage.js",
   "types": "./dist/types/index.d.ts",
   "scripts": {
-    "build": "rimraf dist && webpack --mode=production",
+    "build": "npm run clean && webpack --mode=production",
+    "clean": "rimraf dist",
     "commitmsg": "commitlint -e $GIT_PARAMS",
     "coverage": "tap ./test/{unit,integration}/*.js --coverage --coverage-report=lcov",
     "prepare": "husky install",
     "semantic-release": "semantic-release",
     "test": "npm run test:lint && jest \"test[\\\\/](unit|integration)\"",
+    "test:build": "jest \"test[\\\\/]build\"",
     "test:clearCache": "jest --clearCache",
     "test:integration": "jest \"test[\\\\/]integration\"",
     "test:lint": "eslint .",

test/build/api.test.js

@@ -0,0 +1,69 @@
+/**
+ * @fileoverview Tests the build output to verify the public API of scratch-storage.
+ */
+
+const ScratchStorageModule = require('../../dist/node/scratch-storage.js');
+
+/** @type {ScratchStorageModule.ScratchStorage} */
+let storage;
+
+beforeEach(() => {
+    const {ScratchStorage} = ScratchStorageModule;
+    storage = new ScratchStorage();
+});
+
+test('constructor', () => {
+    const {ScratchStorage} = ScratchStorageModule;
+    expect(storage).toBeInstanceOf(ScratchStorage);
+});
+
+test('DataFormat', () => {
+    const {DataFormat} = ScratchStorageModule;
+    expect(DataFormat).toBeDefined();
+    expect(DataFormat.JPG).toBe('jpg');
+    expect(DataFormat.JSON).toBe('json');
+    expect(DataFormat.MP3).toBe('mp3');
+    expect(DataFormat.PNG).toBe('png');
+    expect(DataFormat.SB2).toBe('sb2');
+    expect(DataFormat.SB3).toBe('sb3');
+    expect(DataFormat.SVG).toBe('svg');
+    expect(DataFormat.WAV).toBe('wav');
+});
+
+test('AssetType', () => {
+    const {AssetType, DataFormat} = ScratchStorageModule;
+    expect(AssetType).toBeDefined();
+    expect(AssetType.ImageBitmap.contentType).toBe('image/png');
+    expect(AssetType.ImageVector.contentType).toBe('image/svg+xml');
+    expect(AssetType.Project.runtimeFormat).toBe(DataFormat.JSON);
+    expect(AssetType.Sound.immutable).toBe(true);
+    expect(AssetType.Sprite.name).toBe('Sprite');
+});
+
+test('Asset', () => {
+    const {Asset, AssetType} = ScratchStorageModule;
+    expect(Asset).toBeDefined();
+    const asset = new Asset(
+        AssetType.ImageVector,
+        'some-hash'
+    );
+    expect(asset).toBeInstanceOf(Asset);
+    expect(asset.dataFormat).toBe('svg');
+    expect(asset.assetId).toBe('some-hash');
+});
+
+test('Helper', () => {
+    const {Helper} = ScratchStorageModule;
+    expect(Helper).toBeDefined();
+    const helper = new Helper();
+    expect(helper).toBeInstanceOf(Helper);
+});
+
+test('scratchFetch API', () => {
+    const scratchFetch = storage.scratchFetch;
+    expect(scratchFetch).toBeDefined();
+    expect(typeof scratchFetch.scratchFetch).toBe('function');
+    expect(typeof scratchFetch.setMetadata).toBe('function');
+    expect(typeof scratchFetch.unsetMetadata).toBe('function');
+    expect(typeof scratchFetch.getMetadata).toBe('function');
+});