@mpgd/phaser-assets 0.3.2

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import type Phaser from 'phaser';
+export type PhaserAssetKind = 'image' | 'spritesheet' | 'atlas' | 'audio' | 'json' | 'binary';
+export interface PhaserImageAsset<TKey extends string = string> {
+  readonly kind: 'image';
+  readonly key: TKey;
+  readonly url: string;
+}
+export interface PhaserSpritesheetAsset<TKey extends string = string> {
+  readonly kind: 'spritesheet';
+  readonly key: TKey;
+  readonly url: string;
+  readonly frameConfig: Phaser.Types.Loader.FileTypes.ImageFrameConfig;
+}
+export interface PhaserAtlasAsset<TKey extends string = string> {
+  readonly kind: 'atlas';
+  readonly key: TKey;
+  readonly textureUrl: string;
+  readonly atlasUrl: string;
+}
+export interface PhaserAudioAsset<TKey extends string = string> {
+  readonly kind: 'audio';
+  readonly key: TKey;
+  readonly urls: string | readonly string[];
+}
+export interface PhaserJsonAsset<TKey extends string = string> {
+  readonly kind: 'json';
+  readonly key: TKey;
+  readonly url: string;
+}
+export interface PhaserBinaryAsset<TKey extends string = string> {
+  readonly kind: 'binary';
+  readonly key: TKey;
+  readonly url: string;
+  readonly dataType?: unknown;
+}
+export type PhaserAsset<TKey extends string = string> = PhaserImageAsset<TKey> | PhaserSpritesheetAsset<TKey> | PhaserAtlasAsset<TKey> | PhaserAudioAsset<TKey> | PhaserJsonAsset<TKey> | PhaserBinaryAsset<TKey>;
+export type PhaserAssetManifest<TAsset extends PhaserAsset = PhaserAsset> = readonly TAsset[];
+export declare function createPhaserAssetUrl(path: string, baseUrl: string | URL): string;
+export declare function definePhaserAssetManifest<const TAsset extends PhaserAssetManifest>(assets: TAsset): TAsset;
+export declare function loadPhaserAssets(scene: Phaser.Scene, assets: PhaserAssetManifest): void;
+export declare function loadPhaserAsset(scene: Phaser.Scene, asset: PhaserAsset): void;

package/dist/index.js

@@ -0,0 +1,50 @@
+export function createPhaserAssetUrl(path, baseUrl) {
+    return new URL(path, baseUrl).href;
+}
+export function definePhaserAssetManifest(assets) {
+    assertUniqueAssetKeys(assets);
+    return assets;
+}
+export function loadPhaserAssets(scene, assets) {
+    for (const asset of assets) {
+        loadPhaserAsset(scene, asset);
+    }
+}
+export function loadPhaserAsset(scene, asset) {
+    switch (asset.kind) {
+        case 'image':
+            scene.load.image(asset.key, asset.url);
+            return;
+        case 'spritesheet':
+            scene.load.spritesheet(asset.key, asset.url, asset.frameConfig);
+            return;
+        case 'atlas':
+            scene.load.atlas(asset.key, asset.textureUrl, asset.atlasUrl);
+            return;
+        case 'audio':
+            scene.load.audio(asset.key, toUrlArray(asset.urls));
+            return;
+        case 'json':
+            scene.load.json(asset.key, asset.url);
+            return;
+        case 'binary':
+            scene.load.binary(asset.key, asset.url, asset.dataType);
+            return;
+    }
+    assertNeverAsset(asset);
+}
+function assertUniqueAssetKeys(assets) {
+    const keys = new Set();
+    for (const asset of assets) {
+        if (keys.has(asset.key)) {
+            throw new Error(`Duplicate Phaser asset key: ${asset.key}`);
+        }
+        keys.add(asset.key);
+    }
+}
+function toUrlArray(value) {
+    return typeof value === 'string' ? [value] : [...value];
+}
+function assertNeverAsset(asset) {
+    throw new Error(`Unhandled Phaser asset: ${JSON.stringify(asset)}`);
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@mpgd/phaser-assets",
+  "version": "0.3.2",
+  "description": "Target-portable Phaser asset manifest and loader helpers for mpgd games.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/imjlk/mpgd-kit.git",
+    "directory": "packages/phaser-assets"
+  },
+  "bugs": {
+    "url": "https://github.com/imjlk/mpgd-kit/issues"
+  },
+  "homepage": "https://github.com/imjlk/mpgd-kit#readme",
+  "keywords": [
+    "mpgd",
+    "phaser",
+    "assets",
+    "vite",
+    "apps-in-toss",
+    "capacitor",
+    "devvit"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "check": "ttsc --noEmit",
+    "lint": "ttsc --noEmit",
+    "test": "vitest run",
+    "format": "ttsc format",
+    "fix": "ttsc fix"
+  },
+  "peerDependencies": {
+    "phaser": ">=4.0.0 <5"
+  },
+  "devDependencies": {
+    "phaser": "4.2.0",
+    "ttsc": "0.16.9",
+    "typescript": "7.0.1-rc",
+    "vitest": "^4.0.0"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  }
+}