@eveshipfit/images 1.3542233.0

package/lib/generated/images/images.js

@@ -0,0 +1,171 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+import * as flatbuffers from 'flatbuffers';
+import { FrameImages } from '../images/frame-images.js';
+import { Image } from '../images/image.js';
+import { KeyedImage } from '../images/keyed-image.js';
+import { TypeIcon } from '../images/type-icon.js';
+import { UiTexture } from '../images/ui-texture.js';
+export class Images {
+    bb = null;
+    bb_pos = 0;
+    __init(i, bb) {
+        this.bb_pos = i;
+        this.bb = bb;
+        return this;
+    }
+    static getRootAsImages(bb, obj) {
+        return (obj || new Images()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
+    }
+    static getSizePrefixedRootAsImages(bb, obj) {
+        bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
+        return (obj || new Images()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
+    }
+    static bufferHasIdentifier(bb) {
+        return bb.__has_identifier('ESFI');
+    }
+    images(index, obj) {
+        const offset = this.bb.__offset(this.bb_pos, 4);
+        return offset ? (obj || new Image()).__init(this.bb.__vector(this.bb_pos + offset) + index * 8, this.bb) : null;
+    }
+    imagesLength() {
+        const offset = this.bb.__offset(this.bb_pos, 4);
+        return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+    }
+    blueprint(obj) {
+        const offset = this.bb.__offset(this.bb_pos, 6);
+        return offset ? (obj || new FrameImages()).__init(this.bb_pos + offset, this.bb) : null;
+    }
+    blueprintCopy(obj) {
+        const offset = this.bb.__offset(this.bb_pos, 8);
+        return offset ? (obj || new FrameImages()).__init(this.bb_pos + offset, this.bb) : null;
+    }
+    relic(obj) {
+        const offset = this.bb.__offset(this.bb_pos, 10);
+        return offset ? (obj || new FrameImages()).__init(this.bb_pos + offset, this.bb) : null;
+    }
+    reaction(obj) {
+        const offset = this.bb.__offset(this.bb_pos, 12);
+        return offset ? (obj || new FrameImages()).__init(this.bb_pos + offset, this.bb) : null;
+    }
+    /**
+     * Sorted on type_id.
+     */
+    types(index, obj) {
+        const offset = this.bb.__offset(this.bb_pos, 14);
+        return offset ? (obj || new TypeIcon()).__init(this.bb.__vector(this.bb_pos + offset) + index * 8, this.bb) : null;
+    }
+    typesLength() {
+        const offset = this.bb.__offset(this.bb_pos, 14);
+        return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+    }
+    /**
+     * Blueprints whose copy has its own icon, by type ID. Sorted on id.
+     */
+    blueprintCopies(index, obj) {
+        const offset = this.bb.__offset(this.bb_pos, 16);
+        return offset ? (obj || new KeyedImage()).__init(this.bb.__vector(this.bb_pos + offset) + index * 8, this.bb) : null;
+    }
+    blueprintCopiesLength() {
+        const offset = this.bb.__offset(this.bb_pos, 16);
+        return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+    }
+    /**
+     * Sorted on id.
+     */
+    marketGroups(index, obj) {
+        const offset = this.bb.__offset(this.bb_pos, 18);
+        return offset ? (obj || new KeyedImage()).__init(this.bb.__vector(this.bb_pos + offset) + index * 8, this.bb) : null;
+    }
+    marketGroupsLength() {
+        const offset = this.bb.__offset(this.bb_pos, 18);
+        return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+    }
+    /**
+     * Sorted on id.
+     */
+    metaGroups(index, obj) {
+        const offset = this.bb.__offset(this.bb_pos, 20);
+        return offset ? (obj || new KeyedImage()).__init(this.bb.__vector(this.bb_pos + offset) + index * 8, this.bb) : null;
+    }
+    metaGroupsLength() {
+        const offset = this.bb.__offset(this.bb_pos, 20);
+        return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+    }
+    uiTextures(index, obj) {
+        const offset = this.bb.__offset(this.bb_pos, 22);
+        return offset ? (obj || new UiTexture()).__init(this.bb.__indirect(this.bb.__vector(this.bb_pos + offset) + index * 4), this.bb) : null;
+    }
+    uiTexturesLength() {
+        const offset = this.bb.__offset(this.bb_pos, 22);
+        return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+    }
+    static startImages(builder) {
+        builder.startObject(10);
+    }
+    static addImages(builder, imagesOffset) {
+        builder.addFieldOffset(0, imagesOffset, 0);
+    }
+    static startImagesVector(builder, numElems) {
+        builder.startVector(8, numElems, 8);
+    }
+    static addBlueprint(builder, blueprintOffset) {
+        builder.addFieldStruct(1, blueprintOffset, 0);
+    }
+    static addBlueprintCopy(builder, blueprintCopyOffset) {
+        builder.addFieldStruct(2, blueprintCopyOffset, 0);
+    }
+    static addRelic(builder, relicOffset) {
+        builder.addFieldStruct(3, relicOffset, 0);
+    }
+    static addReaction(builder, reactionOffset) {
+        builder.addFieldStruct(4, reactionOffset, 0);
+    }
+    static addTypes(builder, typesOffset) {
+        builder.addFieldOffset(5, typesOffset, 0);
+    }
+    static startTypesVector(builder, numElems) {
+        builder.startVector(8, numElems, 4);
+    }
+    static addBlueprintCopies(builder, blueprintCopiesOffset) {
+        builder.addFieldOffset(6, blueprintCopiesOffset, 0);
+    }
+    static startBlueprintCopiesVector(builder, numElems) {
+        builder.startVector(8, numElems, 4);
+    }
+    static addMarketGroups(builder, marketGroupsOffset) {
+        builder.addFieldOffset(7, marketGroupsOffset, 0);
+    }
+    static startMarketGroupsVector(builder, numElems) {
+        builder.startVector(8, numElems, 4);
+    }
+    static addMetaGroups(builder, metaGroupsOffset) {
+        builder.addFieldOffset(8, metaGroupsOffset, 0);
+    }
+    static startMetaGroupsVector(builder, numElems) {
+        builder.startVector(8, numElems, 4);
+    }
+    static addUiTextures(builder, uiTexturesOffset) {
+        builder.addFieldOffset(9, uiTexturesOffset, 0);
+    }
+    static createUiTexturesVector(builder, data) {
+        builder.startVector(4, data.length, 4);
+        for (let i = data.length - 1; i >= 0; i--) {
+            builder.addOffset(data[i]);
+        }
+        return builder.endVector();
+    }
+    static startUiTexturesVector(builder, numElems) {
+        builder.startVector(4, numElems, 4);
+    }
+    static endImages(builder) {
+        const offset = builder.endObject();
+        return offset;
+    }
+    static finishImagesBuffer(builder, offset) {
+        builder.finish(offset, 'ESFI');
+    }
+    static finishSizePrefixedImagesBuffer(builder, offset) {
+        builder.finish(offset, 'ESFI', true);
+    }
+}

package/lib/generated/images/keyed-image.d.ts

@@ -0,0 +1,13 @@
+import * as flatbuffers from 'flatbuffers';
+export declare class KeyedImage {
+    bb: flatbuffers.ByteBuffer | null;
+    bb_pos: number;
+    __init(i: number, bb: flatbuffers.ByteBuffer): KeyedImage;
+    id(): number;
+    /**
+     * Index into Images.images.
+     */
+    image(): number;
+    static sizeOf(): number;
+    static createKeyedImage(builder: flatbuffers.Builder, id: number, image: number): flatbuffers.Offset;
+}

package/lib/generated/images/keyed-image.js

@@ -0,0 +1,31 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+import * as flatbuffers from 'flatbuffers';
+export class KeyedImage {
+    bb = null;
+    bb_pos = 0;
+    __init(i, bb) {
+        this.bb_pos = i;
+        this.bb = bb;
+        return this;
+    }
+    id() {
+        return this.bb.readInt32(this.bb_pos);
+    }
+    /**
+     * Index into Images.images.
+     */
+    image() {
+        return this.bb.readUint16(this.bb_pos + 4);
+    }
+    static sizeOf() {
+        return 8;
+    }
+    static createKeyedImage(builder, id, image) {
+        builder.prep(4, 8);
+        builder.pad(2);
+        builder.writeInt16(image);
+        builder.writeInt32(id);
+        return builder.offset();
+    }
+}

package/lib/generated/images/type-icon.d.ts

@@ -0,0 +1,22 @@
+import * as flatbuffers from 'flatbuffers';
+import { Frame } from '../images/frame.js';
+/**
+ * Drawn bottom to top: frame background, icon, frame overlay, marker.
+ */
+export declare class TypeIcon {
+    bb: flatbuffers.ByteBuffer | null;
+    bb_pos: number;
+    __init(i: number, bb: flatbuffers.ByteBuffer): TypeIcon;
+    typeId(): number;
+    /**
+     * Index into Images.images.
+     */
+    icon(): number;
+    /**
+     * Index into Images.meta_groups, or 255 for no marker.
+     */
+    marker(): number;
+    frame(): Frame;
+    static sizeOf(): number;
+    static createTypeIcon(builder: flatbuffers.Builder, type_id: number, icon: number, marker: number, frame: Frame): flatbuffers.Offset;
+}

package/lib/generated/images/type-icon.js

@@ -0,0 +1,45 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+import * as flatbuffers from 'flatbuffers';
+import { Frame } from '../images/frame.js';
+/**
+ * Drawn bottom to top: frame background, icon, frame overlay, marker.
+ */
+export class TypeIcon {
+    bb = null;
+    bb_pos = 0;
+    __init(i, bb) {
+        this.bb_pos = i;
+        this.bb = bb;
+        return this;
+    }
+    typeId() {
+        return this.bb.readInt32(this.bb_pos);
+    }
+    /**
+     * Index into Images.images.
+     */
+    icon() {
+        return this.bb.readUint16(this.bb_pos + 4);
+    }
+    /**
+     * Index into Images.meta_groups, or 255 for no marker.
+     */
+    marker() {
+        return this.bb.readUint8(this.bb_pos + 6);
+    }
+    frame() {
+        return this.bb.readUint8(this.bb_pos + 7);
+    }
+    static sizeOf() {
+        return 8;
+    }
+    static createTypeIcon(builder, type_id, icon, marker, frame) {
+        builder.prep(4, 8);
+        builder.writeInt8(frame);
+        builder.writeInt8(marker);
+        builder.writeInt16(icon);
+        builder.writeInt32(type_id);
+        return builder.offset();
+    }
+}

package/lib/generated/images/ui-texture.d.ts

@@ -0,0 +1,22 @@
+import * as flatbuffers from 'flatbuffers';
+export declare class UiTexture {
+    bb: flatbuffers.ByteBuffer | null;
+    bb_pos: number;
+    __init(i: number, bb: flatbuffers.ByteBuffer): UiTexture;
+    static getRootAsUiTexture(bb: flatbuffers.ByteBuffer, obj?: UiTexture): UiTexture;
+    static getSizePrefixedRootAsUiTexture(bb: flatbuffers.ByteBuffer, obj?: UiTexture): UiTexture;
+    /**
+     * The path below res:/ui/texture/, without extension.
+     */
+    name(): string | null;
+    name(optionalEncoding: flatbuffers.Encoding): string | Uint8Array | null;
+    /**
+     * Index into Images.images.
+     */
+    image(): number;
+    static startUiTexture(builder: flatbuffers.Builder): void;
+    static addName(builder: flatbuffers.Builder, nameOffset: flatbuffers.Offset): void;
+    static addImage(builder: flatbuffers.Builder, image: number): void;
+    static endUiTexture(builder: flatbuffers.Builder): flatbuffers.Offset;
+    static createUiTexture(builder: flatbuffers.Builder, nameOffset: flatbuffers.Offset, image: number): flatbuffers.Offset;
+}

package/lib/generated/images/ui-texture.js

@@ -0,0 +1,50 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+import * as flatbuffers from 'flatbuffers';
+export class UiTexture {
+    bb = null;
+    bb_pos = 0;
+    __init(i, bb) {
+        this.bb_pos = i;
+        this.bb = bb;
+        return this;
+    }
+    static getRootAsUiTexture(bb, obj) {
+        return (obj || new UiTexture()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
+    }
+    static getSizePrefixedRootAsUiTexture(bb, obj) {
+        bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
+        return (obj || new UiTexture()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
+    }
+    name(optionalEncoding) {
+        const offset = this.bb.__offset(this.bb_pos, 4);
+        return offset ? this.bb.__string(this.bb_pos + offset, optionalEncoding) : null;
+    }
+    /**
+     * Index into Images.images.
+     */
+    image() {
+        const offset = this.bb.__offset(this.bb_pos, 6);
+        return offset ? this.bb.readUint16(this.bb_pos + offset) : 0;
+    }
+    static startUiTexture(builder) {
+        builder.startObject(2);
+    }
+    static addName(builder, nameOffset) {
+        builder.addFieldOffset(0, nameOffset, 0);
+    }
+    static addImage(builder, image) {
+        builder.addFieldInt16(1, image, 0);
+    }
+    static endUiTexture(builder) {
+        const offset = builder.endObject();
+        builder.requiredField(offset, 4); // name
+        return offset;
+    }
+    static createUiTexture(builder, nameOffset, image) {
+        UiTexture.startUiTexture(builder);
+        UiTexture.addName(builder, nameOffset);
+        UiTexture.addImage(builder, image);
+        return UiTexture.endUiTexture(builder);
+    }
+}

package/lib/generated/images.d.ts

@@ -0,0 +1,7 @@
+export { Frame } from './images/frame.js';
+export { FrameImages } from './images/frame-images.js';
+export { Image } from './images/image.js';
+export { Images } from './images/images.js';
+export { KeyedImage } from './images/keyed-image.js';
+export { TypeIcon } from './images/type-icon.js';
+export { UiTexture } from './images/ui-texture.js';

package/lib/generated/images.js

@@ -0,0 +1,9 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+export { Frame } from './images/frame.js';
+export { FrameImages } from './images/frame-images.js';
+export { Image } from './images/image.js';
+export { Images } from './images/images.js';
+export { KeyedImage } from './images/keyed-image.js';
+export { TypeIcon } from './images/type-icon.js';
+export { UiTexture } from './images/ui-texture.js';

package/lib/index.d.ts

@@ -0,0 +1,33 @@
+export type Source = {
+    url: string | URL;
+} | {
+    bytes: Uint8Array;
+};
+/** Layers are drawn at their own size, from the top-left corner of a 64 by 64 pixel icon. */
+export interface Layer {
+    src: string;
+    /** Draw additively; in CSS, `mix-blend-mode: plus-lighter`. */
+    additive?: true;
+}
+export interface TypeIconOptions {
+    /** The icon of a blueprint copy; ignored for other types. */
+    copy?: boolean;
+    /** Include the tech level or faction marker; defaults to true. */
+    marker?: boolean;
+}
+export interface ImagesOptions {
+    /** Where this package's dist/images/ folder is served from. */
+    baseUrl: string | URL;
+}
+export declare class Images {
+    #private;
+    constructor(bytes: Uint8Array, options: ImagesOptions);
+    /** The layers, bottom first. */
+    typeIcon(typeId: number, options?: TypeIconOptions): Layer[] | undefined;
+    marketGroupIcon(marketGroupId: number): string | undefined;
+    /** Also the marker of the meta group's types. */
+    metaGroupIcon(metaGroupId: number): string | undefined;
+    /** By its path below res:/ui/texture/, without extension. */
+    uiTexture(name: string): string | undefined;
+}
+export declare function loadImages(source: Source, options: ImagesOptions): Promise<Images>;

package/lib/index.js

@@ -0,0 +1,106 @@
+import { ByteBuffer } from "flatbuffers";
+import { Frame, Images as RawImages } from "./generated/images.js";
+const NO_MARKER = 0xff;
+export class Images {
+    #raw;
+    #baseUrl;
+    #urls = [];
+    constructor(bytes, options) {
+        const buffer = new ByteBuffer(bytes);
+        if (!RawImages.bufferHasIdentifier(buffer)) {
+            throw new Error("Not an images file: the identifier is missing");
+        }
+        this.#raw = RawImages.getRootAsImages(buffer);
+        const baseUrl = options.baseUrl.toString();
+        this.#baseUrl = baseUrl.endsWith("/") ? baseUrl : `${baseUrl}/`;
+    }
+    /** The layers, bottom first. */
+    typeIcon(typeId, options = {}) {
+        const icon = search(this.#raw.typesLength(), (index) => this.#raw.types(index), (entry) => entry.typeId() - typeId);
+        if (icon === undefined)
+            return undefined;
+        const layers = [];
+        const frame = this.#frame(icon.frame(), options.copy === true);
+        if (frame === undefined) {
+            const copy = options.copy ? this.#keyed(this.#raw.blueprintCopiesLength(), (index) => this.#raw.blueprintCopies(index), typeId) : undefined;
+            layers.push({ src: this.#url(copy ?? icon.icon()) });
+        }
+        else {
+            layers.push({ src: this.#url(frame.background()) }, { src: this.#url(icon.icon()) }, { src: this.#url(frame.overlay()), additive: true });
+        }
+        const marker = icon.marker();
+        if (options.marker !== false && marker !== NO_MARKER)
+            layers.push({ src: this.#url(this.#raw.metaGroups(marker).image()) });
+        return layers;
+    }
+    marketGroupIcon(marketGroupId) {
+        const image = this.#keyed(this.#raw.marketGroupsLength(), (index) => this.#raw.marketGroups(index), marketGroupId);
+        return image === undefined ? undefined : this.#url(image);
+    }
+    /** Also the marker of the meta group's types. */
+    metaGroupIcon(metaGroupId) {
+        const image = this.#keyed(this.#raw.metaGroupsLength(), (index) => this.#raw.metaGroups(index), metaGroupId);
+        return image === undefined ? undefined : this.#url(image);
+    }
+    /** By its path below res:/ui/texture/, without extension. */
+    uiTexture(name) {
+        const texture = search(this.#raw.uiTexturesLength(), (index) => this.#raw.uiTextures(index), (entry) => compare(entry.name(), name));
+        return texture === undefined ? undefined : this.#url(texture.image());
+    }
+    #frame(frame, copy) {
+        switch (frame) {
+            case Frame.Blueprint:
+                return copy ? this.#raw.blueprintCopy() : this.#raw.blueprint();
+            case Frame.Relic:
+                return this.#raw.relic();
+            case Frame.Reaction:
+                return this.#raw.reaction();
+            default:
+                return undefined;
+        }
+    }
+    #keyed(length, at, id) {
+        return search(length, at, (entry) => entry.id() - id)?.image();
+    }
+    #url(index) {
+        let url = this.#urls[index];
+        if (url === undefined) {
+            const hash = this.#raw.images(index).hash();
+            url = `${this.#baseUrl}${hash.toString(16).padStart(16, "0")}.webp`;
+            this.#urls[index] = url;
+        }
+        return url;
+    }
+}
+export async function loadImages(source, options) {
+    return new Images(await readSource(source), options);
+}
+async function readSource(source) {
+    if ("bytes" in source)
+        return source.bytes;
+    const response = await fetch(source.url);
+    if (!response.ok) {
+        throw new Error(`Fetching ${source.url.toString()} failed: ${response.status} ${response.statusText}`);
+    }
+    return new Uint8Array(await response.arrayBuffer());
+}
+function search(length, at, compareTo) {
+    let low = 0;
+    let high = length - 1;
+    while (low <= high) {
+        const middle = (low + high) >>> 1;
+        const entry = at(middle);
+        const order = compareTo(entry);
+        if (order === 0)
+            return entry;
+        if (order < 0)
+            low = middle + 1;
+        else
+            high = middle - 1;
+    }
+    return undefined;
+}
+// Go sorts the names on bytes; for ASCII that is the same order as JavaScript's.
+function compare(a, b) {
+    return a < b ? -1 : a > b ? 1 : 0;
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@eveshipfit/images",
+  "version": "1.3542233.0",
+  "description": "EVE Online's icons, as WebP",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EVEShipFit/images.git"
+  },
+  "author": "EVEShipFit Team <info@eveship.fit>",
+  "license": "SEE LICENSE IN LICENSE",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./dist/*": "./dist/*",
+    "./specs/*": "./specs/*"
+  },
+  "files": [
+    "lib",
+    "dist/images.dat",
+    "dist/images",
+    "specs/images.fbs",
+    "LICENSE.EVE"
+  ],
+  "scripts": {
+    "gen": "flatc --ts -o src/generated specs/images.fbs",
+    "build": "tsc",
+    "test": "node --test"
+  },
+  "dependencies": {
+    "flatbuffers": "^25.9.23"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.3",
+    "typescript": "^7.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/specs/images.fbs

@@ -0,0 +1,66 @@
+namespace images;
+
+/// Stored as images/<hash in 16 lowercase hex digits>.webp. An unchanged image
+/// keeps its hash between releases.
+struct Image {
+    hash: uint64;
+}
+
+struct KeyedImage {
+    id: int32;
+    /// Index into Images.images.
+    image: uint16;
+}
+
+/// The background and overlay the client draws around blueprints, relics and reactions.
+enum Frame: uint8 {
+    None = 0,
+    Blueprint = 1,
+    Relic = 2,
+    Reaction = 3,
+}
+
+/// The overlay is drawn additively.
+struct FrameImages {
+    /// Index into Images.images.
+    background: uint16;
+    /// Index into Images.images.
+    overlay: uint16;
+}
+
+/// Drawn bottom to top: frame background, icon, frame overlay, marker.
+struct TypeIcon {
+    type_id: int32;
+    /// Index into Images.images.
+    icon: uint16;
+    /// Index into Images.meta_groups, or 255 for no marker.
+    marker: uint8;
+    frame: Frame;
+}
+
+table UiTexture {
+    /// The path below res:/ui/texture/, without extension.
+    name: string (key);
+    /// Index into Images.images.
+    image: uint16;
+}
+
+table Images {
+    images: [Image];
+    blueprint: FrameImages;
+    blueprint_copy: FrameImages;
+    relic: FrameImages;
+    reaction: FrameImages;
+    /// Sorted on type_id.
+    types: [TypeIcon];
+    /// Blueprints whose copy has its own icon, by type ID. Sorted on id.
+    blueprint_copies: [KeyedImage];
+    /// Sorted on id.
+    market_groups: [KeyedImage];
+    /// Sorted on id.
+    meta_groups: [KeyedImage];
+    ui_textures: [UiTexture];
+}
+
+root_type Images;
+file_identifier "ESFI";