@antha/asset 0.0.1

package/LICENSE-CC0

@@ -0,0 +1,121 @@
+CC0 1.0 Universal
+
+Creative Commons Legal Code
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 electrovir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @antha/asset
+
+A pre-built [Antha](https://www.npmjs.com/package/antha) mod for handling asset loading.
+
+## Install
+
+```sh
+npm i @antha/asset
+```

package/dist/antha-asset.mod.d.ts

@@ -0,0 +1,83 @@
+import { type PartialWithUndefined } from '@augment-vir/common';
+import { AssetLoader } from './asset-loader.js';
+/**
+ * Engine state for the Antha asset mod loading screen.
+ *
+ * @category Internal
+ */
+export type AnthaAssetModLoadingScreenState = {
+    /** The total number to load. Once `current` reaches this, loading is considered complete. */
+    total: number;
+    /**
+     * The current number of loaded assets. Once this reaches `total`, the loading is considered
+     * complete.
+     */
+    current: number;
+    currentResourceName?: string | undefined;
+    completedAt: DOMHighResTimeStamp | undefined;
+};
+/**
+ * State for {@link AnthaAssetMod}.
+ *
+ * @category Internal
+ */
+export type AnthaAssetModState = {
+    assetLoader: AssetLoader;
+    isShowingLoadingScreen: boolean;
+    loadingScreenState: AnthaAssetModLoadingScreenState | undefined;
+};
+/**
+ * Configuration options for {@link createAnthaAssetMod}.
+ *
+ * @category Internal
+ */
+export type AnthaAssetModOptions = PartialWithUndefined<{
+    /**
+     * If set to `true`, the default loading screen is not rendered. You should probably make your
+     * own loading screen in that case.
+     *
+     * @default false
+     */
+    hideLoadingScreen: boolean;
+}>;
+/**
+ * Duration in milliseconds for the loading screen fade-out animation.
+ *
+ * @category Internal
+ */
+export declare const loadingScreenFadeMs = 1000;
+/**
+ * Duration in milliseconds for the progress bar grow transition.
+ *
+ * @category Internal
+ */
+export declare const loadingScreenProgressGrowMs = 200;
+/**
+ * Default loading screen element rendered by the Antha asset mod while assets are being loaded.
+ *
+ * @category Internal
+ */
+export declare const AnthaAssetLoadingScreen: import("element-vir").DeclarativeElementDefinition<"antha-asset-loading-screen", {
+    progressPercent: number;
+    dotCount: number;
+    completed: boolean;
+    currentResourceName: string | undefined;
+}, {}, {}, "antha-asset-loading-screen-completed", "antha-asset-loading-screen-", readonly [], readonly []>;
+/**
+ * The Antha Asset mod, created by {@link createAnthaAssetMod}.
+ *
+ * @category Pre-Built Mods
+ */
+export type AnthaAssetMod = ReturnType<typeof createAnthaAssetMod>;
+/**
+ * Name for the mod {@link AnthaAssetMod}.
+ *
+ * @category Internal
+ */
+export declare const anthaAssetModName = "antha-asset";
+/**
+ * Creates the Antha asset mod which manages asset loading and an optional loading screen overlay.
+ *
+ * @category Pre-Built Mods
+ */
+export declare function createAnthaAssetMod(options?: Readonly<AnthaAssetModOptions>): import("@antha/engine").AnthaMod<NoInfer<AnthaAssetModState>>;

package/dist/antha-asset.mod.js

@@ -0,0 +1,175 @@
+import { defineAnthaMod } from '@antha/engine';
+import { css, defineElement, html } from 'element-vir';
+import { AssetLoader, AssetLoaderProgressUpdateEvent } from './asset-loader.js';
+/**
+ * Duration in milliseconds for the loading screen fade-out animation.
+ *
+ * @category Internal
+ */
+export const loadingScreenFadeMs = 1000;
+/**
+ * Duration in milliseconds for the progress bar grow transition.
+ *
+ * @category Internal
+ */
+export const loadingScreenProgressGrowMs = 200;
+/**
+ * Default loading screen element rendered by the Antha asset mod while assets are being loaded.
+ *
+ * @category Internal
+ */
+export const AnthaAssetLoadingScreen = defineElement()({
+    tagName: 'antha-asset-loading-screen',
+    hostClasses: {
+        'antha-asset-loading-screen-completed': ({ inputs }) => inputs.completed,
+    },
+    styles: ({ hostClasses }) => css `
+        :host {
+            position: fixed;
+            inset: 0;
+            display: flex;
+            flex-direction: column;
+            align-items: center;
+            justify-content: center;
+            background-color: black;
+            color: white;
+            z-index: 9999;
+            gap: 24px;
+            opacity: 1;
+            transition: opacity ${loadingScreenFadeMs}ms ease-in;
+        }
+
+        .loading-text {
+            font-size: 24px;
+            position: relative;
+        }
+
+        .dots {
+            font-family: monospace;
+            position: absolute;
+            left: 100%;
+            bottom: 0;
+        }
+
+        .progress-track {
+            width: 300px;
+            height: 1em;
+            overflow: hidden;
+            border: 4px solid white;
+        }
+
+        .current-resource-name {
+            font-size: 14px;
+            opacity: 0.7;
+        }
+
+        .progress-fill {
+            height: 100%;
+            background-color: white;
+            transition: width ${loadingScreenProgressGrowMs}ms ease-in;
+        }
+
+        ${hostClasses['antha-asset-loading-screen-completed'].selector} {
+            opacity: 0;
+        }
+    `,
+    render({ inputs }) {
+        const dotCount = inputs.dotCount % 4;
+        const dots = '.'.repeat(dotCount) + '\u00A0'.repeat(3 - dotCount);
+        return html `
+            <span class="loading-text">
+                Loading
+                <span class="dots">${dots}</span>
+            </span>
+            <div>
+                <span class="current-resource-name">
+                    ${inputs.currentResourceName ||
+            html `
+                        &nbsp;
+                    `}
+                </span>
+                <div class="progress-track">
+                    <div
+                        class="progress-fill"
+                        style=${css `
+                            width: ${inputs.progressPercent}%;
+                        `}
+                    ></div>
+                </div>
+            </div>
+        `;
+    },
+});
+/**
+ * Name for the mod {@link AnthaAssetMod}.
+ *
+ * @category Internal
+ */
+export const anthaAssetModName = 'antha-asset';
+/**
+ * Creates the Antha asset mod which manages asset loading and an optional loading screen overlay.
+ *
+ * @category Pre-Built Mods
+ */
+export function createAnthaAssetMod(options = {}) {
+    return defineAnthaMod({
+        modName: anthaAssetModName,
+        async cleanup({ state }) {
+            await state.assetLoader?.destroy();
+            state.loadingScreenState = undefined;
+            state.isShowingLoadingScreen = false;
+        },
+        execute({ state, engine }) {
+            if (!state.assetLoader) {
+                state.assetLoader = new AssetLoader({
+                    logger: engine.log,
+                });
+                if (!options.hideLoadingScreen) {
+                    state.assetLoader.listen(AssetLoaderProgressUpdateEvent, (event) => {
+                        if (event.detail.complete) {
+                            state.loadingScreenState = {
+                                current: 1,
+                                total: 1,
+                                currentResourceName: event.detail.currentResourceName ||
+                                    state.loadingScreenState?.currentResourceName,
+                                completedAt: engine.totalMs,
+                            };
+                            state.isShowingLoadingScreen = false;
+                        }
+                        else {
+                            state.isShowingLoadingScreen = true;
+                            state.loadingScreenState = {
+                                current: event.detail.current,
+                                total: event.detail.total,
+                                currentResourceName: event.detail.currentResourceName,
+                                completedAt: undefined,
+                            };
+                        }
+                    });
+                }
+            }
+            if (options.hideLoadingScreen) {
+                return;
+            }
+            const shouldShowLoadingScreen = state.loadingScreenState?.completedAt
+                ? engine.totalMs <= state.loadingScreenState.completedAt + loadingScreenFadeMs
+                : true;
+            if (state.loadingScreenState && shouldShowLoadingScreen) {
+                const progressPercent = state.loadingScreenState.total > 0
+                    ? (state.loadingScreenState.current / state.loadingScreenState.total) * 100
+                    : 0;
+                return html `
+                    <${AnthaAssetLoadingScreen.assign({
+                    progressPercent,
+                    dotCount: Math.floor(engine.totalMs / 500) % 4,
+                    completed: !!state.loadingScreenState.completedAt,
+                    currentResourceName: state.loadingScreenState.currentResourceName,
+                })}></${AnthaAssetLoadingScreen}>
+                `;
+            }
+            else {
+                return undefined;
+            }
+        },
+    });
+}

package/dist/asset-loader.d.ts

@@ -0,0 +1,171 @@
+import { type AnthaLogger } from '@antha/engine';
+import { type MaybePromise, type PartialWithUndefined } from '@augment-vir/common';
+import { ListenTarget } from 'typed-event-target';
+/**
+ * Call this to increment the loading progress of this asset. It is expected that this gets called
+ * enough times to increment the progress count until the asset's `maxProgress` is reached.
+ *
+ * @category Internal
+ */
+export type AssetIncrementProgressCallback = (
+/** The amount that the progress should be incremented with this call. */
+amount?: number | undefined) => void;
+/**
+ * A callback for loading / creating an {@link Asset} value.
+ *
+ * @category Internal
+ */
+export type AssetLoaderCallback<AssetValue> = (params: Readonly<{
+    /**
+     * Call this to increment the loading progress of this asset. It is expected that this gets
+     * called enough times to increment the progress count until the asset's `maxProgress` is
+     * reached.
+     */
+    incrementProgressCallback: AssetIncrementProgressCallback;
+}>) => MaybePromise<AssetLoaderResult<AssetValue>>;
+/**
+ * A loaded {@link Asset} result, returned from {@link AssetLoaderCallback}
+ *
+ * @category Internal
+ */
+export type AssetLoaderResult<AssetValue = any> = {
+    value: AssetValue;
+    cleanup?: undefined | AssetCleanupCallback;
+};
+/**
+ * Cleanup callback for {@link Asset}.
+ *
+ * @category Internal
+ */
+export type AssetCleanupCallback = () => MaybePromise<void>;
+/**
+ * Extracts the loaded value type from an {@link Asset}.
+ *
+ * @category Internal
+ */
+export type AssetValue<SpecificAsset extends Pick<Asset, 'load'>> = Awaited<ReturnType<SpecificAsset['load']>>['value'];
+/**
+ * Defines a loadable asset.
+ *
+ * @category Asset
+ */
+export type Asset<AssetValue = any> = {
+    name: string;
+    maxProgress: number;
+    load: AssetLoaderCallback<AssetValue>;
+};
+/**
+ * A helper for defining and inferring the value type of an {@link Asset}.
+ *
+ * @category Asset
+ */
+export declare function defineAsset<AssetValue>(asset: Asset<AssetValue>): Asset<NoInfer<AssetValue>>;
+/**
+ * Options for {@link AssetLoader.bulkLoadAssets}.
+ *
+ * @category Internal
+ */
+export type AssetBulkLoaderLoadOptions = PartialWithUndefined<{
+    /**
+     * How many assets can be loaded in parallel at once.
+     *
+     * @default Infinity // no limit
+     */
+    maxParallelism: number;
+    /**
+     * If `true`, previous assets will not be unloaded. By default, when loading new bulk assets,
+     * all previous assets that are not included in the new asset list will be cleaned up.
+     *
+     * @default false
+     */
+    doNotUnload: boolean;
+    /**
+     * If `true`, the loading screen events will not be emitted.
+     *
+     * @default false
+     */
+    hideLoadingScreen: boolean;
+}>;
+/**
+ * Options for {@link AssetLoader}.
+ *
+ * @category Internal
+ */
+export type AssetLoaderOptions = PartialWithUndefined<{
+    /**
+     * A custom logger to handle mod and engine logs. By default, this merely logs to the browser
+     * console.
+     */
+    logger: AnthaLogger;
+}>;
+declare const AssetLoaderProgressUpdateEvent_base: (new (eventInitDict: {
+    bubbles?: boolean;
+    cancelable?: boolean;
+    composed?: boolean;
+    detail: {
+        current: number;
+        total: number;
+        currentResourceName?: string | undefined;
+        /**
+         * Always check this complete field first, as any misconfigured assets ma not correctly
+         * increment `total` but complete will always reliably mark the end of loading.
+         */
+        complete: boolean;
+    };
+}) => import("typed-event-target").TypedCustomEvent<{
+    current: number;
+    total: number;
+    currentResourceName?: string | undefined;
+    /**
+     * Always check this complete field first, as any misconfigured assets ma not correctly
+     * increment `total` but complete will always reliably mark the end of loading.
+     */
+    complete: boolean;
+}, "antha-asset-loader-progress-update-event">) & Pick<{
+    new (type: string, eventInitDict?: EventInit): Event;
+    prototype: Event;
+    readonly NONE: 0;
+    readonly CAPTURING_PHASE: 1;
+    readonly AT_TARGET: 2;
+    readonly BUBBLING_PHASE: 3;
+}, "prototype" | "NONE" | "CAPTURING_PHASE" | "AT_TARGET" | "BUBBLING_PHASE"> & Pick<import("typed-event-target").TypedCustomEvent<{
+    current: number;
+    total: number;
+    currentResourceName?: string | undefined;
+    /**
+     * Always check this complete field first, as any misconfigured assets ma not correctly
+     * increment `total` but complete will always reliably mark the end of loading.
+     */
+    complete: boolean;
+}, "antha-asset-loader-progress-update-event">, "type">;
+/**
+ * Custom event dispatched by {@link AssetLoader} whenever bulk loading progress changes. Used for
+ * loading screen progression.
+ *
+ * @category Internal
+ */
+export declare class AssetLoaderProgressUpdateEvent extends AssetLoaderProgressUpdateEvent_base {
+}
+/**
+ * Manages loading, caching, and cleanup of game assets with progress tracking.
+ *
+ * @category Asset
+ */
+export declare class AssetLoader extends ListenTarget<AssetLoaderProgressUpdateEvent> {
+    constructor(options?: Readonly<AssetLoaderOptions>);
+    /** Logs data. This will use the user's provided logger or default to browser logs. */
+    protected readonly log: AnthaLogger;
+    protected readonly assetCache: Map<Readonly<Asset<any>>, Promise<AssetLoaderResult<any>>>;
+    /** Loads a single asset, returning its cached value if already loaded. */
+    loadIndividualAsset<ThisAsset extends Asset>({ asset, incrementProgressCallback, }: Readonly<{
+        asset: Readonly<ThisAsset>;
+        incrementProgressCallback?: AssetIncrementProgressCallback | undefined;
+    }>): Promise<AssetValue<ThisAsset>>;
+    /** Runs cleanup callbacks for the given assets and removes them from the cache. */
+    unloadAssets(assets: ReadonlyArray<Asset>): Promise<void>;
+    destroy(): Promise<void>;
+    /** Loads multiple assets. */
+    bulkLoadAssets(assets: ReadonlyArray<Readonly<Asset>>, options?: Readonly<AssetBulkLoaderLoadOptions>): Promise<ReadonlyArray<unknown>>;
+    private dispatchProgressUpdate;
+}
+export {};

package/dist/asset-loader.js

@@ -0,0 +1,172 @@
+import { browserAnthaLogger } from '@antha/engine';
+import { awaitedBlockingMap, awaitedForEach, chunkArray, DeferredPromise, ensureErrorAndPrependMessage, } from '@augment-vir/common';
+import { defineTypedCustomEvent, ListenTarget } from 'typed-event-target';
+/**
+ * A helper for defining and inferring the value type of an {@link Asset}.
+ *
+ * @category Asset
+ */
+export function defineAsset(asset) {
+    return asset;
+}
+/**
+ * Custom event dispatched by {@link AssetLoader} whenever bulk loading progress changes. Used for
+ * loading screen progression.
+ *
+ * @category Internal
+ */
+export class AssetLoaderProgressUpdateEvent extends defineTypedCustomEvent()('antha-asset-loader-progress-update-event') {
+}
+/**
+ * Manages loading, caching, and cleanup of game assets with progress tracking.
+ *
+ * @category Asset
+ */
+export class AssetLoader extends ListenTarget {
+    constructor(options = {}) {
+        super();
+        this.log = options.logger || browserAnthaLogger;
+    }
+    /** Logs data. This will use the user's provided logger or default to browser logs. */
+    log;
+    assetCache = new Map();
+    /** Loads a single asset, returning its cached value if already loaded. */
+    async loadIndividualAsset({ asset, incrementProgressCallback, }) {
+        const cached = this.assetCache.get(asset);
+        if (cached) {
+            const assetResult = await cached;
+            return assetResult.value;
+        }
+        const deferredLoadPromise = new DeferredPromise();
+        this.assetCache.set(asset, deferredLoadPromise.promise);
+        const loadedAsset = await asset.load({
+            incrementProgressCallback(progressParams) {
+                incrementProgressCallback?.(progressParams);
+            },
+        });
+        deferredLoadPromise.resolve(loadedAsset);
+        return loadedAsset.value;
+    }
+    /** Runs cleanup callbacks for the given assets and removes them from the cache. */
+    async unloadAssets(assets) {
+        await awaitedForEach(assets, async (asset) => {
+            const entry = await this.assetCache.get(asset);
+            if (entry?.cleanup) {
+                try {
+                    await entry.cleanup();
+                }
+                catch (error) {
+                    this.log.error(ensureErrorAndPrependMessage(error, `Failed to cleanup asset: ${asset.name}`));
+                }
+            }
+            this.assetCache.delete(asset);
+        });
+    }
+    async destroy() {
+        super.destroy();
+        const entries = Array.from(this.assetCache.entries());
+        await awaitedForEach(entries, async ([asset, result,]) => {
+            await (await result).cleanup?.();
+            this.assetCache.delete(asset);
+        });
+    }
+    /** Loads multiple assets. */
+    async bulkLoadAssets(assets, options = {}) {
+        const assetsToCleanup = options.doNotUnload
+            ? []
+            : Array.from(this.assetCache.keys()).filter((asset) => {
+                return !assets.includes(asset);
+            });
+        const assetsToLoad = assets.filter((asset) => {
+            return !this.assetCache.has(asset);
+        });
+        const cleanupCount = assetsToCleanup.length ? 1 : 0;
+        const maxProgress = assetsToLoad.reduce((count, asset) => {
+            return count + asset.maxProgress;
+        }, 0) + cleanupCount;
+        let currentProgress = 0;
+        if (!options.hideLoadingScreen && assetsToLoad.length) {
+            this.dispatchProgressUpdate({
+                current: currentProgress,
+                total: maxProgress,
+                currentResourceName: assetsToLoad[0]?.name,
+                complete: false,
+            });
+        }
+        await this.unloadAssets(assetsToCleanup);
+        if (!assetsToLoad.length) {
+            return assets.map((asset) => this.assetCache.get(asset));
+        }
+        currentProgress += cleanupCount;
+        if (!options.hideLoadingScreen) {
+            this.dispatchProgressUpdate({
+                current: currentProgress,
+                total: maxProgress,
+                currentResourceName: assetsToLoad[0]?.name,
+                complete: false,
+            });
+        }
+        const chunkedAssets = options.maxParallelism
+            ? chunkArray(assets, {
+                chunkSize: options.maxParallelism,
+            })
+            : [[...assets]];
+        const createIncrementProgressCallback = (asset) => (amount) => {
+            currentProgress += amount ?? 1;
+            if (!options.hideLoadingScreen) {
+                this.dispatchProgressUpdate({
+                    current: currentProgress,
+                    total: maxProgress,
+                    currentResourceName: asset.name,
+                    complete: false,
+                });
+            }
+        };
+        const results = (await awaitedBlockingMap(chunkedAssets, async (assetChunk) => {
+            return await Promise.all(assetChunk.map(async (asset) => {
+                if (this.assetCache.has(asset)) {
+                    return (await this.assetCache.get(asset))?.value;
+                }
+                if (!options.hideLoadingScreen) {
+                    this.dispatchProgressUpdate({
+                        current: currentProgress,
+                        total: maxProgress,
+                        currentResourceName: asset.name,
+                        complete: false,
+                    });
+                }
+                return await this.loadIndividualAsset({
+                    incrementProgressCallback: createIncrementProgressCallback(asset),
+                    asset,
+                });
+            }));
+        })).flat();
+        if (currentProgress !== maxProgress) {
+            this.log.error(new Error('Finished loading assets but did not reach max loading progress.'), {
+                context: {
+                    currentProgress,
+                    maxProgress,
+                    assetCount: assetsToLoad.length,
+                    assetNames: assetsToLoad.map((entry) => entry.name).filter(Boolean),
+                },
+                tags: {
+                    mod: '@antha/asset',
+                },
+            });
+        }
+        if (!options.hideLoadingScreen) {
+            this.dispatchProgressUpdate({
+                current: maxProgress,
+                total: maxProgress,
+                currentResourceName: assetsToLoad[assetsToLoad.length - 1]?.name,
+                complete: true,
+            });
+        }
+        return results;
+    }
+    dispatchProgressUpdate(detail) {
+        this.dispatch(new AssetLoaderProgressUpdateEvent({
+            detail,
+        }));
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './antha-asset.mod.js';
+export * from './asset-loader.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './antha-asset.mod.js';
+export * from './asset-loader.js';

package/package.json

@@ -0,0 +1,59 @@
+{
+    "name": "@antha/asset",
+    "version": "0.0.1",
+    "description": "An Antha mod for handling asset loading.",
+    "keywords": [
+        "vir",
+        "antha",
+        "asset",
+        "loading"
+    ],
+    "homepage": "https://github.com/electrovir/antha",
+    "bugs": {
+        "url": "https://github.com/electrovir/antha/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/electrovir/antha.git"
+    },
+    "license": "(MIT OR CC0-1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "sideEffects": false,
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "compile": "virmator compile",
+        "docs": "virmator docs",
+        "test": "virmator test web",
+        "test:coverage": "npm test coverage",
+        "test:docs": "virmator docs check"
+    },
+    "dependencies": {
+        "@augment-vir/assert": "^31.73.1",
+        "@augment-vir/common": "^31.73.1",
+        "typed-event-target": "^4.3.1"
+    },
+    "devDependencies": {
+        "@augment-vir/test": "^31.73.1",
+        "@web/dev-server-esbuild": "^1.0.5",
+        "@web/test-runner": "^0.20.2",
+        "@web/test-runner-playwright": "^0.11.1",
+        "istanbul-smart-text-reporter": "^1.1.5",
+        "pixi.js": "^8.19.0"
+    },
+    "peerDependencies": {
+        "@antha/engine": "*",
+        "element-vir": ">=26"
+    },
+    "engines": {
+        "node": ">=22"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}