@bscotch/sprite-source 1.4.0

package/dist/SpriteDir.js

@@ -0,0 +1,240 @@
+import { pathy, statSafe } from '@bscotch/pathy';
+import { Yy } from '@bscotch/yy';
+import { SpriteFrame } from './SpriteFrame.js';
+import { computeFilesChecksum, computeStringChecksum } from './checksum.js';
+import { retryOptions } from './constants.js';
+import { readdirSafe } from './safeFs.js';
+import { SpriteSourceError, assert } from './utility.js';
+export class SpriteDir {
+    path;
+    logs;
+    issues;
+    _frames = [];
+    _isSpine = false;
+    _spinePaths;
+    constructor(path, logs, issues) {
+        this.path = path;
+        this.logs = logs;
+        this.issues = issues;
+    }
+    get isSpine() {
+        return this._isSpine;
+    }
+    get frames() {
+        return [...this._frames];
+    }
+    get spinePaths() {
+        assert(this.isSpine, 'Not a spine sprite');
+        return { ...this._spinePaths };
+    }
+    async updateCache(cache) {
+        // Do some initial cleanup of the cache
+        // Remove the cache if there has been a spine-type-change
+        if (cache.info[this.path.relative] &&
+            cache.info[this.path.relative].spine !== this.isSpine) {
+            delete cache.info[this.path.relative];
+        }
+        // Initialize the cache if it doesn't exist
+        cache.info[this.path.relative] ||= this.isSpine
+            ? {
+                spine: true,
+                changed: 0,
+                checksum: '',
+            }
+            : {
+                spine: false,
+                frames: {},
+                checksum: '',
+            };
+        const spriteCache = cache.info[this.path.relative];
+        const frameWaits = [];
+        if (spriteCache.spine) {
+            // Handle the spine case
+            const pngs = [...this.spinePaths.pngs];
+            pngs.sort((a, b) => a.basename.localeCompare(b.basename, 'en-US'));
+            const lastChanged = Math.max(...(await Promise.all([
+                statSafe(this.spinePaths.atlas, retryOptions).then((s) => s.mtime.getTime(), () => 0),
+                statSafe(this.spinePaths.json, retryOptions).then((s) => s.mtime.getTime(), () => 0),
+                ...pngs.map((png) => statSafe(png, retryOptions).then((s) => s.mtime.getTime(), () => 0)),
+            ])));
+            if (lastChanged !== spriteCache.changed || !spriteCache.checksum) {
+                spriteCache.changed = lastChanged;
+                spriteCache.checksum = await computeFilesChecksum([
+                    this.spinePaths.atlas.absolute,
+                    this.spinePaths.json.absolute,
+                    ...pngs.map((p) => p.absolute),
+                ]);
+            }
+        }
+        else {
+            // Remove any frames that no longer exist
+            const excessFrames = new Set(Object.keys(spriteCache.frames));
+            for (const frame of this.frames) {
+                excessFrames.delete(frame.path.relative);
+                frameWaits.push(frame.updateCache(spriteCache));
+            }
+            for (const frame of excessFrames) {
+                delete spriteCache.frames[frame];
+            }
+        }
+        const frames = await Promise.all(frameWaits);
+        if (!spriteCache.spine) {
+            // Sort the checksums by checksum since filenames will change between
+            // source and dest. Creates a problem if frame *order* changes, so we
+            // may need to deal with that later.
+            const frameChecksums = frames.map((f) => f.checksum).sort();
+            spriteCache.checksum = computeStringChecksum(frameChecksums.join('-'));
+        }
+    }
+    async bleed() {
+        if (this.isSpine) {
+            return;
+        }
+        await Promise.all(this.frames.map((frame) => frame.bleed()));
+    }
+    async crop() {
+        if (this.isSpine) {
+            return;
+        }
+        // Get the boundingbox that captures the bounding boxes of
+        // all frames.
+        const bboxes = await Promise.all(this.frames.map((frame) => frame.getBoundingBox()));
+        const bbox = bboxes.slice(1).reduce((bbox, frameBbox) => {
+            return {
+                left: Math.min(bbox.left, frameBbox.left),
+                right: Math.max(bbox.right, frameBbox.right),
+                top: Math.min(bbox.top, frameBbox.top),
+                bottom: Math.max(bbox.bottom, frameBbox.bottom),
+            };
+        }, bboxes[0]);
+        // Crop all frames to that bounding box
+        await Promise.all(this.frames.map((frame) => frame.crop(bbox)));
+    }
+    async moveTo(newSpriteDir) {
+        await newSpriteDir.ensureDirectory();
+        if (this.isSpine) {
+            const fromTo = [
+                [
+                    this.spinePaths.atlas,
+                    newSpriteDir.join(this.spinePaths.atlas.basename),
+                ],
+                [
+                    this.spinePaths.json,
+                    newSpriteDir.join(this.spinePaths.json.basename),
+                ],
+                ...this.spinePaths.pngs.map((png) => [
+                    png,
+                    newSpriteDir.join(png.basename),
+                ]),
+            ];
+            await Promise.all(fromTo.map(([from, to]) => from.copy(to).then(() => from.delete({
+                ...retryOptions,
+                force: true,
+            }))));
+            this.logs.push(...fromTo.map(([from, to]) => ({
+                action: 'moved',
+                path: from.absolute,
+                to: to.absolute,
+            })));
+        }
+        else {
+            const fromTo = this.frames.map((frame) => [
+                frame.path,
+                newSpriteDir.join(frame.path.basename),
+            ]);
+            await Promise.all(this.frames.map((frame) => frame.saveTo(newSpriteDir.join(frame.path.basename)).then(() => frame.path.delete({
+                ...retryOptions,
+                force: true,
+            }))));
+            this.logs.push(...fromTo.map(([from, to]) => ({
+                action: 'moved',
+                path: from.absolute,
+                to: to.absolute,
+            })));
+        }
+        // Try to delete the folder
+        try {
+            await this.path.delete({
+                recursive: true,
+                ...retryOptions,
+                force: true,
+            });
+        }
+        catch (err) {
+            this.issues.push(new SpriteSourceError(`Could not delete source folder: ${this.path.relative}`, err));
+        }
+    }
+    /**
+     * If there are images in this directory, get a `SpriteDir`
+     * instance. Else get `undefined`.
+     */
+    static async from(path, logs = [], issues = []) {
+        const files = (await readdirSafe(path.absolute)).map((file) => pathy(file, path.absolute));
+        let pngs = files.filter((file) => file.basename.match(/\.png$/i));
+        pngs.sort();
+        if (pngs.length === 0) {
+            return;
+        }
+        const sprite = new SpriteDir(path, logs, issues);
+        const hasAtlas = !!files.find((f) => f.hasExtension('atlas'));
+        if (hasAtlas) {
+            sprite._isSpine = true;
+            // Then it's either a spine export or a spine sprite folder in GameMaker
+            // If it's a spine export, all files will be named "{exportName}.*"
+            // If it's a GameMaker spine sprite, there will be a "{exportName}.png",
+            // but the other files will be named "{GUID}.*". If there are multiple
+            // identifiers (due to incomplete cleanup of a previous import), we'll
+            // have to open the yy file to determine the correct GUID.
+            // 1. See if we have multiple {name}.atlas files. If so, use the yy file (if there is one) to determine the correct GUID.
+            const atlasFiles = files.filter((f) => f.hasExtension('atlas'));
+            let frameId = atlasFiles[0].name;
+            if (atlasFiles.length > 1) {
+                const yyFiles = files.filter((f) => f.hasExtension('yy'));
+                assert(yyFiles.length === 1, 'Multiple .atlas files found in a single folder. There must be exactly one .yy file in this folder to determine the correct GUID.');
+                const yyFile = yyFiles[0];
+                const yy = await Yy.read(yyFile.absolute, 'sprites');
+                frameId = yy.frames[0]?.name;
+                assert(frameId, `No GUID found in yy file. Cannot determine which .atlas file to use for ${path.relative}`);
+            }
+            // 2. Get the {name}.atlas and {name}.json files
+            const skeletonJson = files.find((f) => f.name === frameId && f.hasExtension('json'));
+            const skeletonAtlas = files.find((f) => f.name === frameId && f.hasExtension('atlas'));
+            assert(skeletonJson, `No .json file found for ${path.relative}/${frameId}`);
+            assert(skeletonAtlas, `No .atlas file found for ${path.relative}/${frameId}`);
+            // 3. Set the spine paths. There can be multiple PNGs, and in the case
+            //    of GameMaker assets there can be *other* PNGs (like thumbnails).
+            //    So we need to read the atlas file to determine which PNGs are
+            //    the ones we want.
+            const atlasContent = (await skeletonAtlas.read({
+                encoding: 'utf8',
+            }));
+            const pngNames = atlasContent.match(/^.*\.png$/gm);
+            pngs = pngs.filter((png) => pngNames?.includes(png.basename));
+            assert(pngs.length > 0, 'No PNGs found in atlas file.');
+            sprite._spinePaths = {
+                atlas: skeletonAtlas,
+                json: skeletonJson,
+                pngs,
+            };
+        }
+        else {
+            sprite._frames = pngs.map((png) => new SpriteFrame(png));
+            // Make sure all frames are the same size
+            const expectedSize = await sprite.frames[0].getSize();
+            for (const frame of sprite.frames.slice(1)) {
+                const size = await frame.getSize();
+                assert(size.width === expectedSize.width &&
+                    size.height === expectedSize.height, 'Frames must all be the same size.');
+            }
+        }
+        return sprite;
+    }
+    toJSON() {
+        return {
+            path: this.path,
+            isSpine: this.isSpine,
+            framePaths: this.frames,
+        };
+    }
+}
+//# sourceMappingURL=SpriteDir.js.map

package/dist/SpriteDir.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpriteDir.js","sourceRoot":"","sources":["../src/SpriteDir.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEzD,MAAM,OAAO,SAAS;IAQT;IACA;IACA;IATD,OAAO,GAAkB,EAAE,CAAC;IAC5B,QAAQ,GAAG,KAAK,CAAC;IACjB,WAAW,CAE4B;IAEjD,YACW,IAAW,EACX,IAAW,EACX,MAAe;QAFf,SAAI,GAAJ,IAAI,CAAO;QACX,SAAI,GAAJ,IAAI,CAAO;QACX,WAAM,GAAN,MAAM,CAAS;IACvB,CAAC;IAEJ,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,UAAU;QACZ,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAC3C,OAAO,EAAE,GAAG,IAAI,CAAC,WAAY,EAAE,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAkB;QAClC,uCAAuC;QACvC,yDAAyD;QACzD,IACE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,EACrD,CAAC;YACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QACD,2CAA2C;QAC3C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,OAAO;YAC7C,CAAC,CAAC;gBACE,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,EAAE;aACb;YACH,CAAC,CAAC;gBACE,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,EAAE;aACb,CAAC;QACN,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEnD,MAAM,UAAU,GAAoC,EAAE,CAAC;QACvD,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;YACtB,wBAAwB;YACxB,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAC1B,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,IAAI,CAChD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,EACxB,GAAG,EAAE,CAAC,CAAC,CACR;gBACD,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,CAC/C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,EACxB,GAAG,EAAE,CAAC,CAAC,CACR;gBACD,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAClB,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,IAAI,CAC9B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,EACxB,GAAG,EAAE,CAAC,CAAC,CACR,CACF;aACF,CAAC,CAAC,CACJ,CAAC;YACF,IAAI,WAAW,KAAK,WAAW,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;gBACjE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC;gBAClC,WAAW,CAAC,QAAQ,GAAG,MAAM,oBAAoB,CAAC;oBAChD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ;oBAC9B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ;oBAC7B,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;iBAC/B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;aAAM,CAAC;YACN,yCAAyC;YACzC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9D,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACzC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;YAClD,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;gBACjC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;YACvB,qEAAqE;YACrE,qEAAqE;YACrE,oCAAoC;YACpC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5D,WAAW,CAAC,QAAQ,GAAG,qBAAqB,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QACD,0DAA0D;QAC1D,cAAc;QACd,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CACnD,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;YACtD,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;gBACzC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;gBAC5C,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;gBACtC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC;aAChD,CAAC;QACJ,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACd,uCAAuC;QACvC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAmB;QAC9B,MAAM,YAAY,CAAC,eAAe,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,GAAG;gBACb;oBACE,IAAI,CAAC,UAAU,CAAC,KAAK;oBACrB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC;iBAClD;gBACD;oBACE,IAAI,CAAC,UAAU,CAAC,IAAI;oBACpB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;iBACjD;gBACD,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;oBACnC,GAAG;oBACH,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;iBAChC,CAAC;aACH,CAAC;YACF,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CACxB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CACtB,IAAI,CAAC,MAAM,CAAC;gBACV,GAAG,YAAY;gBACf,KAAK,EAAE,IAAI;aACZ,CAAC,CACH,CACF,CACF,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,IAAI,CACZ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC7B,MAAM,EAAE,OAAgB;gBACxB,IAAI,EAAE,IAAI,CAAC,QAAQ;gBACnB,EAAE,EAAE,EAAE,CAAC,QAAQ;aAChB,CAAC,CAAC,CACJ,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;gBACxC,KAAK,CAAC,IAAI;gBACV,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;aACvC,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC7D,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;gBAChB,GAAG,YAAY;gBACf,KAAK,EAAE,IAAI;aACZ,CAAC,CACH,CACF,CACF,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,IAAI,CACZ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC7B,MAAM,EAAE,OAAgB;gBACxB,IAAI,EAAE,IAAI,CAAC,QAAQ;gBACnB,EAAE,EAAE,EAAE,CAAC,QAAQ;aAChB,CAAC,CAAC,CACJ,CAAC;QACJ,CAAC;QACD,2BAA2B;QAC3B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;gBACrB,SAAS,EAAE,IAAI;gBACf,GAAG,YAAY;gBACf,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,IAAI,iBAAiB,CACnB,mCAAmC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EACvD,GAAG,CACJ,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,IAAW,EACX,OAAc,EAAE,EAChB,SAAkB,EAAE;QAEpB,MAAM,KAAK,GAAG,CAAC,MAAM,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC5D,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAC3B,CAAC;QACF,IAAI,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YACvB,wEAAwE;YACxE,mEAAmE;YACnE,wEAAwE;YACxE,sEAAsE;YACtE,sEAAsE;YACtE,0DAA0D;YAE1D,yHAAyH;YACzH,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;YAChE,IAAI,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACjC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC1D,MAAM,CACJ,OAAO,CAAC,MAAM,KAAK,CAAC,EACpB,kIAAkI,CACnI,CAAC;gBACF,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC1B,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;gBACrD,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;gBAC7B,MAAM,CACJ,OAAO,EACP,2EAA2E,IAAI,CAAC,QAAQ,EAAE,CAC3F,CAAC;YACJ,CAAC;YAED,gDAAgD;YAChD,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAC7B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CACpD,CAAC;YACF,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAC9B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CACrD,CAAC;YACF,MAAM,CACJ,YAAY,EACZ,2BAA2B,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE,CACtD,CAAC;YACF,MAAM,CACJ,aAAa,EACb,4BAA4B,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE,CACvD,CAAC;YAEF,sEAAsE;YACtE,sEAAsE;YACtE,mEAAmE;YACnE,uBAAuB;YACvB,MAAM,YAAY,GAAG,CAAC,MAAM,aAAa,CAAC,IAAI,CAAC;gBAC7C,QAAQ,EAAE,MAAM;aACjB,CAAC,CAAW,CAAC;YACd,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACnD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,8BAA8B,CAAC,CAAC;YACxD,MAAM,CAAC,WAAW,GAAG;gBACnB,KAAK,EAAE,aAAa;gBACpB,IAAI,EAAE,YAAY;gBAClB,IAAI;aACL,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;YACzD,yCAAyC;YACzC,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YACtD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;gBACnC,MAAM,CACJ,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,KAAK;oBAC/B,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,EACrC,mCAAmC,CACpC,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,MAAM;SACxB,CAAC;IACJ,CAAC;CACF"}

package/dist/SpriteFrame.d.ts

@@ -0,0 +1,36 @@
+import { Pathy } from '@bscotch/pathy';
+import { Image } from 'image-js';
+import type { SpriteSummary } from './SpriteCache.schemas.js';
+import type { BBox } from './types.js';
+export declare class SpriteFrame {
+    readonly path: Pathy;
+    protected _size: undefined | {
+        width: number;
+        height: number;
+    };
+    protected _bbox: undefined | BBox;
+    protected _image: undefined | Image;
+    protected _masks: {
+        [minAlpha: string]: Image;
+    };
+    protected _checksum: undefined | string;
+    constructor(path: Pathy);
+    protected clearCache(): void;
+    updateCache(cache: SpriteSummary): Promise<{
+        width: number;
+        height: number;
+        checksum: string;
+        changed: number;
+    }>;
+    getImage(): Promise<Image>;
+    getSize(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    getForegroundMask(foregroundMinAlphaFraction?: number): Promise<Image>;
+    getBoundingBox(padding?: number): Promise<BBox>;
+    crop(bbox: BBox): Promise<void>;
+    bleed(): Promise<void>;
+    saveTo(path: Pathy): Promise<void>;
+}
+//# sourceMappingURL=SpriteFrame.d.ts.map

package/dist/SpriteFrame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpriteFrame.d.ts","sourceRoot":"","sources":["../src/SpriteFrame.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAY,MAAM,gBAAgB,CAAC;AAEjD,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGvC,qBAAa,WAAW;IAOV,QAAQ,CAAC,IAAI,EAAE,KAAK;IANhC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IAClC,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,KAAK,CAAC;IACpC,SAAS,CAAC,MAAM,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE,CAAM;IACrD,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAAC;gBAEnB,IAAI,EAAE,KAAK;IAEhC,SAAS,CAAC,UAAU;IAQd,WAAW,CAAC,KAAK,EAAE,aAAa;;;;;;IAkBhC,QAAQ;IASR,OAAO;eA3CyB,MAAM;gBAAU,MAAM;;IAoDtD,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,MAAM;IAerD,cAAc,CAAC,OAAO,SAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC1C,IAAI,CAAC,IAAI,EAAE,IAAI;IAaf,KAAK;IAmFL,MAAM,CAAC,IAAI,EAAE,KAAK;CAIzB"}

package/dist/SpriteFrame.js

@@ -0,0 +1,225 @@
+import { __decorate, __metadata } from "tslib";
+import { Pathy, statSafe } from '@bscotch/pathy';
+import { sequential } from '@bscotch/utility';
+import { Image } from 'image-js';
+import { retryOptions } from './constants.js';
+import { getPngSize } from './utility.js';
+export class SpriteFrame {
+    path;
+    _size;
+    _bbox;
+    _image;
+    _masks = {};
+    _checksum;
+    constructor(path) {
+        this.path = path;
+    }
+    clearCache() {
+        this._size = undefined;
+        this._bbox = undefined;
+        this._image = undefined;
+        this._checksum = undefined;
+        this._masks = {};
+    }
+    async updateCache(cache) {
+        const lastChanged = (await statSafe(this.path, retryOptions)).mtime.getTime();
+        const needsUpdate = (cache.frames[this.path.relative]?.changed || 0) !== lastChanged;
+        if (!needsUpdate)
+            return cache.frames[this.path.relative];
+        const [size] = await Promise.all([this.getSize()]);
+        cache.frames[this.path.relative] = {
+            changed: lastChanged,
+            checksum: '', // To be batch-computed later
+            height: size.height,
+            width: size.width,
+        };
+        return cache.frames[this.path.relative];
+    }
+    async getImage() {
+        if (this._image) {
+            return this._image;
+        }
+        this._image = await Image.load(this.path.absolute);
+        return this._image;
+    }
+    async getSize() {
+        if (this._size) {
+            return { ...this._size };
+        }
+        this._size = await getPngSize(this.path);
+        return this._size;
+    }
+    async getForegroundMask(foregroundMinAlphaFraction) {
+        const alphaKey = `${foregroundMinAlphaFraction}`;
+        if (this._masks[alphaKey]) {
+            return this._masks[alphaKey];
+        }
+        const image = await this.getImage();
+        const threshold = foregroundMinAlphaFraction || 1 / Math.pow(2, image.bitDepth);
+        this._masks[alphaKey] = image
+            .getChannel(image.channels - 1)
+            .mask({ threshold });
+        return this._masks[alphaKey];
+    }
+    async getBoundingBox(padding = 1) {
+        if (this._bbox) {
+            return { ...this._bbox };
+        }
+        const foreground = await this.getForegroundMask();
+        let left = Infinity;
+        let right = -Infinity;
+        let top = Infinity;
+        let bottom = -Infinity;
+        for (let x = 0; x < foreground.width; x++) {
+            for (let y = 0; y < foreground.height; y++) {
+                if (foreground.getBitXY(x, y)) {
+                    left = Math.min(left, x);
+                    right = Math.max(right, x);
+                    top = Math.min(top, y);
+                    bottom = Math.max(bottom, y);
+                }
+            }
+        }
+        padding = Math.round(padding);
+        if (padding > 0) {
+            top = Math.max(top - padding, 0);
+            left = Math.max(left - padding, 0);
+            right = Math.min(right + padding, foreground.width - 1);
+            bottom = Math.min(bottom + padding, foreground.height - 1);
+        }
+        this._bbox = {
+            left: left == Infinity ? 0 : left,
+            right: right == -Infinity ? foreground.width - 1 : right,
+            top: top == Infinity ? 0 : top,
+            bottom: bottom == -Infinity ? foreground.height - 1 : bottom,
+        };
+        return { ...this._bbox };
+    }
+    async crop(bbox) {
+        const img = await this.getImage();
+        const cropBox = {
+            x: bbox.left,
+            y: bbox.top,
+            width: bbox.right - bbox.left + 1,
+            height: bbox.bottom - bbox.top + 1,
+        };
+        this.clearCache();
+        this._image = img.crop(cropBox);
+    }
+    async bleed() {
+        const img = await this.getImage();
+        if (!img.alpha) {
+            return;
+        }
+        const maxPixelValue = Math.pow(2, img.bitDepth);
+        const bleedMaxAlpha = Math.ceil(0.02 * maxPixelValue);
+        const transparentBlackPixel = [...Array(img.channels)].map(() => 0);
+        // Create a mask from the background (alpha zero) and then erode it by a few pixels.
+        // Add a mask from the foreground (alpha > 0)
+        // Invert to get the background pixels that need to be adjusted
+        // Set the color of those pixels to the the color of the nearest foreground, and the alpha
+        // to something very low so that it mostly isn't visible but won't be treated as background downstream
+        const foreground = await this.getForegroundMask((bleedMaxAlpha + 1) / maxPixelValue);
+        const expandedForeground = foreground.dilate({
+            kernel: [
+                [1, 1, 1],
+                [1, 1, 1],
+                [1, 1, 1],
+            ],
+        });
+        const isInForeground = (x, y) => foreground.getBitXY(x, y);
+        const isInExpandedForeground = (x, y) => expandedForeground.getBitXY(x, y);
+        const isInOutline = (x, y) => isInExpandedForeground(x, y) && !isInForeground(x, y);
+        // There does not seem to be a way to combine masks in image-js,
+        // but we don't really need to for the desired outcome.
+        // Iterate over all pixels. Those in the expanded foreground but not in the foreground
+        // should be set in the original image based on nearby non-background pixels
+        for (let x = 0; x < img.width; x++) {
+            for (let y = 0; y < img.height; y++) {
+                if (isInOutline(x, y)) {
+                    const neighbors = [];
+                    for (let ax = x - 1; ax <= x + 1; ax++) {
+                        for (let ay = y - 1; ay <= y + 1; ay++) {
+                            if (ax == x && ay == y) {
+                                continue;
+                            }
+                            if (isInForeground(ax, ay)) {
+                                neighbors.push(img.getPixelXY(ax, ay));
+                            }
+                        }
+                    }
+                    if (neighbors.length) {
+                        // average the colors
+                        const colorSamples = transparentBlackPixel.map(() => []);
+                        for (const neighbor of neighbors) {
+                            for (let channel = 0; channel < img.channels; channel++) {
+                                colorSamples[channel].push(neighbor[channel]);
+                            }
+                        }
+                        const newColor = colorSamples.map((sample, idx) => {
+                            if (idx == img.channels - 1) {
+                                // Alpha should be 2% or half the min neighboring alpha
+                                const minAlpha = sample.reduce((min, value) => Math.min(min, value), Infinity);
+                                return Math.ceil(Math.min(minAlpha * 0.5, bleedMaxAlpha));
+                            }
+                            else {
+                                // Use the average color
+                                return Math.round(sample.reduce((sum, value) => sum + value, 0) / sample.length);
+                            }
+                        });
+                        img.setPixelXY(x, y, newColor);
+                    }
+                }
+            }
+        }
+        this.clearCache();
+        this._image = img;
+    }
+    async saveTo(path) {
+        const image = await this.getImage();
+        await image.save(path.absolute);
+    }
+}
+__decorate([
+    sequential,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], SpriteFrame.prototype, "getImage", null);
+__decorate([
+    sequential,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], SpriteFrame.prototype, "getSize", null);
+__decorate([
+    sequential,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], SpriteFrame.prototype, "getForegroundMask", null);
+__decorate([
+    sequential,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], SpriteFrame.prototype, "getBoundingBox", null);
+__decorate([
+    sequential,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], SpriteFrame.prototype, "crop", null);
+__decorate([
+    sequential,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], SpriteFrame.prototype, "bleed", null);
+__decorate([
+    sequential,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Pathy]),
+    __metadata("design:returntype", Promise)
+], SpriteFrame.prototype, "saveTo", null);
+//# sourceMappingURL=SpriteFrame.js.map

package/dist/SpriteFrame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpriteFrame.js","sourceRoot":"","sources":["../src/SpriteFrame.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,WAAW;IAOD;IANX,KAAK,CAAgD;IACrD,KAAK,CAAmB;IACxB,MAAM,CAAoB;IAC1B,MAAM,GAAkC,EAAE,CAAC;IAC3C,SAAS,CAAqB;IAExC,YAAqB,IAAW;QAAX,SAAI,GAAJ,IAAI,CAAO;IAAG,CAAC;IAE1B,UAAU;QAClB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAoB;QACpC,MAAM,WAAW,GAAG,CAClB,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CACxC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,MAAM,WAAW,GACf,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC;QACnE,IAAI,CAAC,WAAW;YAAE,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACnD,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG;YACjC,OAAO,EAAE,WAAW;YACpB,QAAQ,EAAE,EAAE,EAAE,6BAA6B;YAC3C,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;QACF,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAGK,AAAN,KAAK,CAAC,QAAQ;QACZ,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAGK,AAAN,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAGK,AAAN,KAAK,CAAC,iBAAiB,CAAC,0BAAmC;QACzD,MAAM,QAAQ,GAAG,GAAG,0BAA0B,EAAE,CAAC;QACjD,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,SAAS,GACb,0BAA0B,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK;aAC1B,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC;aAC9B,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAGK,AAAN,KAAK,CAAC,cAAc,CAAC,OAAO,GAAG,CAAC;QAC9B,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAClD,IAAI,IAAI,GAAG,QAAQ,CAAC;QACpB,IAAI,KAAK,GAAG,CAAC,QAAQ,CAAC;QACtB,IAAI,GAAG,GAAG,QAAQ,CAAC;QACnB,IAAI,MAAM,GAAG,CAAC,QAAQ,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;oBAC9B,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;oBACzB,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBAC3B,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;oBACvB,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;YACjC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;YACnC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,OAAO,EAAE,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YACxD,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,OAAO,EAAE,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,KAAK,GAAG;YACX,IAAI,EAAE,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;YACjC,KAAK,EAAE,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK;YACxD,GAAG,EAAE,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;YAC9B,MAAM,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM;SAC7D,CAAC;QACF,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAGK,AAAN,KAAK,CAAC,IAAI,CAAC,IAAU;QACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG;YACd,CAAC,EAAE,IAAI,CAAC,IAAI;YACZ,CAAC,EAAE,IAAI,CAAC,GAAG;YACX,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;YACjC,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC;SACnC,CAAC;QACF,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAGK,AAAN,KAAK,CAAC,KAAK;QACT,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,CAAC;QACtD,MAAM,qBAAqB,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACpE,oFAAoF;QACpF,6CAA6C;QAC7C,+DAA+D;QAC/D,0FAA0F;QAC1F,sGAAsG;QACtG,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC7C,CAAC,aAAa,GAAG,CAAC,CAAC,GAAG,aAAa,CACpC,CAAC;QACF,MAAM,kBAAkB,GAAG,UAAU,CAAC,MAAM,CAAC;YAC3C,MAAM,EAAE;gBACN,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;aACV;SACF,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3E,MAAM,sBAAsB,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CACtD,kBAAkB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAC3C,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAExD,gEAAgE;QAChE,uDAAuD;QACvD,sFAAsF;QACtF,4EAA4E;QAC5E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACpC,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;oBACtB,MAAM,SAAS,GAAG,EAAE,CAAC;oBACrB,KAAK,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;wBACvC,KAAK,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;4BACvC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gCACvB,SAAS;4BACX,CAAC;4BACD,IAAI,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;gCAC3B,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;4BACzC,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;wBACrB,qBAAqB;wBACrB,MAAM,YAAY,GAAe,qBAAqB,CAAC,GAAG,CACxD,GAAG,EAAE,CAAC,EAAE,CACT,CAAC;wBACF,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;4BACjC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC;gCACxD,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;4BAChD,CAAC;wBACH,CAAC;wBACD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;4BAChD,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;gCAC5B,uDAAuD;gCACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC5B,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,EACpC,QAAQ,CACT,CAAC;gCACF,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC;4BAC5D,CAAC;iCAAM,CAAC;gCACN,wBAAwB;gCACxB,OAAO,IAAI,CAAC,KAAK,CACf,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAC9D,CAAC;4BACJ,CAAC;wBACH,CAAC,CAAC,CAAC;wBACH,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;oBACjC,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;IACpB,CAAC;IAGK,AAAN,KAAK,CAAC,MAAM,CAAC,IAAW;QACtB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;CACF;AAzKO;IADL,UAAU;;;;2CAOV;AAGK;IADL,UAAU;;;;0CAOV;AAGK;IADL,UAAU;;;;oDAaV;AAGK;IADL,UAAU;;;;iDAkCV;AAGK;IADL,UAAU;;;;uCAWV;AAGK;IADL,UAAU;;;;wCAiFV;AAGK;IADL,UAAU;;qCACQ,KAAK;;yCAGvB"}

package/dist/SpriteSource.d.ts

@@ -0,0 +1,60 @@
+import { Pathy } from '@bscotch/pathy';
+import { SpriteCache } from './SpriteCache.js';
+import { type SpriteSourceConfig, type SpriteSourceStage } from './SpriteSource.schemas.js';
+export declare class SpriteSource extends SpriteCache {
+    get configFile(): Pathy<{
+        [x: string]: unknown;
+        $schema?: string | undefined;
+        staging?: {
+            [x: string]: unknown;
+            dir: string;
+            transforms: {
+                [x: string]: unknown;
+                include?: string | undefined;
+                bleed?: boolean | undefined;
+                crop?: boolean | undefined;
+                synced?: boolean | undefined;
+                renames?: {
+                    [x: string]: unknown;
+                    from: string;
+                    to: string;
+                }[] | undefined;
+            }[];
+        }[] | null | undefined;
+        ignore?: string[] | null | undefined;
+    }>;
+    protected resolveStaged(staging: SpriteSourceStage): Promise<void>;
+    loadConfig(overrides?: SpriteSourceConfig): Promise<SpriteSourceConfig>;
+    /**
+     * Transform any staged sprites and add them to the source,
+     * and compute updated sprite info.
+     */
+    update(
+    /** Optionally override config options */
+    options?: SpriteSourceConfig): Promise<{
+        [x: string]: unknown;
+        version: number;
+        info: Record<string, {
+            [x: string]: unknown;
+            spine: false;
+            checksum: string;
+            frames: Record<string, {
+                width: number;
+                height: number;
+                checksum: string;
+                changed: number;
+            }>;
+        } | {
+            [x: string]: unknown;
+            spine: true;
+            checksum: string;
+            changed: number;
+        }>;
+        $schema?: string | undefined;
+    }>;
+    /**
+     * @param options If specified, creates/overwrites the config file with these options.
+     */
+    static from(spritesRoot: string | Pathy, options?: SpriteSourceConfig): Promise<SpriteSource>;
+}
+//# sourceMappingURL=SpriteSource.d.ts.map

package/dist/SpriteSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpriteSource.d.ts","sourceRoot":"","sources":["../src/SpriteSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAqB,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAEL,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACvB,MAAM,2BAA2B,CAAC;AAUnC,qBAAa,YAAa,SAAQ,WAAW;IAC3C,IAAI,UAAU;;;;;;;;;;;;;;;;;;;;OAIb;cAEe,aAAa,CAAC,OAAO,EAAE,iBAAiB;IA4ElD,UAAU,CACd,SAAS,GAAE,kBAAuB,GACjC,OAAO,CAAC,kBAAkB,CAAC;IAsC9B;;;OAGG;IAEG,MAAM;IACV,yCAAyC;IACzC,OAAO,CAAC,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;IAgB9B;;OAEG;WACU,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,CAAC,EAAE,kBAAkB;CAW5E"}