@tf2-automatic/tf2-format 8.0.0

package/src/lib/sku/sku.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SKU = void 0;
+class SKU {
+    static fromObject(item) {
+        let sku = `${item.defindex};${item.quality}`;
+        if (item.effect) {
+            sku += `;u${item.effect}`;
+        }
+        if (item.australium === true) {
+            sku += ';australium';
+        }
+        if (item.craftable === false) {
+            sku += ';uncraftable';
+        }
+        if (item.tradable === false) {
+            sku += ';untradable';
+        }
+        if (item.wear) {
+            sku += `;w${item.wear}`;
+        }
+        if (item.paintkit) {
+            sku += `;pk${item.paintkit}`;
+        }
+        if (item.elevated === true) {
+            sku += ';strange';
+        }
+        if (item.killstreak !== undefined && item.killstreak !== 0) {
+            sku += `;kt-${item.killstreak}`;
+        }
+        if (item.target) {
+            sku += `;td-${item.target}`;
+        }
+        if (item.festivized === true) {
+            sku += ';festive';
+        }
+        if (item.crateSeries) {
+            sku += `;c${item.crateSeries}`;
+        }
+        if (item.output) {
+            sku += `;od-${item.output}`;
+        }
+        if (item.outputQuality) {
+            sku += `;oq-${item.outputQuality}`;
+        }
+        return sku;
+    }
+    static fromString(sku) {
+        const item = {
+            defindex: -1,
+            quality: -1,
+            craftable: true,
+            tradable: true,
+            australium: false,
+            festivized: false,
+            effect: null,
+            elevated: false,
+            killstreak: 0,
+            paintkit: null,
+            wear: null,
+            output: null,
+            outputQuality: null,
+            target: null,
+            crateSeries: null,
+        };
+        const length = sku.length;
+        let start = 0;
+        let numValue = 0;
+        // Extract only defindex and quality
+        for (let i = 0; i < length; i++) {
+            const charCode = sku.charCodeAt(i);
+            if (charCode <= 57) {
+                // We know that defindex and quality should only be numbers, so we
+                // just assume that it is the character '0' to '9'.
+                numValue = numValue * 10 + (charCode - 48);
+            }
+            else if (charCode === 59) {
+                // Found the seperator ';' ASCII 59
+                if (start === 0) {
+                    // First time we found the seperator, so this is the defindex
+                    item.defindex = numValue;
+                    // Reset numValue for the next part
+                    numValue = 0;
+                    // Update the start defindex for the next part
+                    start = i + 1;
+                }
+                else if (start !== 0) {
+                    // Second time we found the seperator, so this is the quality
+                    start = i + 1;
+                    break;
+                }
+            }
+        }
+        // We have to set the quality outside of the loop because there may not be a second seperator
+        item.quality = numValue;
+        // Now process remaining attributes
+        while (start < length) {
+            let separatorIndex = length;
+            let numIndex = undefined;
+            let numValue = 0;
+            // Loop through the remaining part of the SKU
+            for (let i = start; i < length; i++) {
+                if (sku.charAt(i) === ';') {
+                    // Found seperator, break the loop to process the attribute
+                    separatorIndex = i;
+                    break;
+                }
+                else {
+                    // Check if the character is less than 57 (ASCII for '9')
+                    const charCode = sku.charCodeAt(i);
+                    if (charCode <= 57) {
+                        // The character should be either a number or a hyphen (but we don't
+                        // care about validating it)
+                        if (numIndex === undefined) {
+                            // Set the index, everything after should be a number
+                            numIndex = i;
+                        }
+                        // Check if the character is a number
+                        if (charCode >= 48) {
+                            // It is a number, accumulate the numeric value
+                            numValue = numValue * 10 + (charCode - 48);
+                        }
+                    }
+                }
+            }
+            const partLength = (numIndex || separatorIndex) - start;
+            // Handle without numeric values first
+            switch (partLength) {
+                case 11:
+                    item.craftable = false;
+                    break;
+                case 10:
+                    if (sku.charAt(start) === 'a') {
+                        item.australium = true;
+                    }
+                    else {
+                        item.tradable = false;
+                    }
+                    break;
+                case 7:
+                    if (sku.charAt(start) === 's') {
+                        item.elevated = true;
+                    }
+                    else {
+                        item.festivized = true;
+                    }
+                    break;
+                default: {
+                    // Handle prefixes
+                    const prefix = sku.charAt(start);
+                    switch (prefix) {
+                        case 'u':
+                            item.effect = numValue;
+                            break;
+                        case 'w':
+                            item.wear = numValue;
+                            break;
+                        case 'p':
+                            item.paintkit = numValue;
+                            break;
+                        case 'k':
+                            item.killstreak = numValue;
+                            break;
+                        case 't':
+                            item.target = numValue;
+                            break;
+                        case 'c':
+                            item.crateSeries = numValue;
+                            break;
+                        case 'o':
+                            if (sku.charAt(start + 1) === 'd') {
+                                item.output = numValue;
+                            }
+                            else if (sku.charAt(start + 1) === 'q') {
+                                item.outputQuality = numValue;
+                            }
+                            break;
+                    }
+                }
+            }
+            start = separatorIndex + 1;
+        }
+        return item;
+    }
+}
+exports.SKU = SKU;
+//# sourceMappingURL=sku.js.map

package/src/lib/sku/sku.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sku.js","sourceRoot":"","sources":["../../../../../../libs/tf2-format/src/lib/sku/sku.ts"],"names":[],"mappings":";;;AAEA,MAAa,GAAG;IACd,MAAM,CAAC,UAAU,CAAC,IAA4B;QAC5C,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAE7C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,GAAG,IAAI,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC7B,GAAG,IAAI,aAAa,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;YAC7B,GAAG,IAAI,cAAc,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YAC5B,GAAG,IAAI,aAAa,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,GAAG,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,GAAG,IAAI,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC3B,GAAG,IAAI,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YAC3D,GAAG,IAAI,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,GAAG,IAAI,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC7B,GAAG,IAAI,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,GAAG,IAAI,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,GAAG,IAAI,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,GAAG,IAAI,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;QACrC,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAW;QAC3B,MAAM,IAAI,GAA0B;YAClC,QAAQ,EAAE,CAAC,CAAC;YACZ,OAAO,EAAE,CAAC,CAAC;YACX,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,KAAK;YACf,UAAU,EAAE,CAAC;YACb,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,IAAI;YACZ,aAAa,EAAE,IAAI;YACnB,MAAM,EAAE,IAAI;YACZ,WAAW,EAAE,IAAI;SAClB,CAAC;QAEF,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,QAAQ,GAAG,CAAC,CAAC;QAEjB,oCAAoC;QACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACnC,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;gBACnB,kEAAkE;gBAClE,mDAAmD;gBACnD,QAAQ,GAAG,QAAQ,GAAG,EAAE,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAC;YAC7C,CAAC;iBAAM,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;gBAC3B,mCAAmC;gBACnC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAChB,6DAA6D;oBAC7D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBACzB,mCAAmC;oBACnC,QAAQ,GAAG,CAAC,CAAC;oBACb,8CAA8C;oBAC9C,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;gBAChB,CAAC;qBAAM,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBACvB,6DAA6D;oBAC7D,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;oBACd,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,6FAA6F;QAC7F,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;QAExB,mCAAmC;QACnC,OAAO,KAAK,GAAG,MAAM,EAAE,CAAC;YACtB,IAAI,cAAc,GAAG,MAAM,CAAC;YAC5B,IAAI,QAAQ,GAAuB,SAAS,CAAC;YAC7C,IAAI,QAAQ,GAAG,CAAC,CAAC;YAEjB,6CAA6C;YAC7C,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACpC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;oBAC1B,2DAA2D;oBAC3D,cAAc,GAAG,CAAC,CAAC;oBACnB,MAAM;gBACR,CAAC;qBAAM,CAAC;oBACN,yDAAyD;oBACzD,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;oBACnC,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;wBACnB,oEAAoE;wBACpE,4BAA4B;wBAC5B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;4BAC3B,qDAAqD;4BACrD,QAAQ,GAAG,CAAC,CAAC;wBACf,CAAC;wBAED,qCAAqC;wBACrC,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;4BACnB,+CAA+C;4BAC/C,QAAQ,GAAG,QAAQ,GAAG,EAAE,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAC;wBAC7C,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,UAAU,GAAG,CAAC,QAAQ,IAAI,cAAc,CAAC,GAAG,KAAK,CAAC;YAExD,sCAAsC;YACtC,QAAQ,UAAU,EAAE,CAAC;gBACnB,KAAK,EAAE;oBACL,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;oBACvB,MAAM;gBACR,KAAK,EAAE;oBACL,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;wBAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;oBACzB,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;oBACxB,CAAC;oBACD,MAAM;gBACR,KAAK,CAAC;oBACJ,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;wBAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;oBACvB,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;oBACzB,CAAC;oBACD,MAAM;gBACR,OAAO,CAAC,CAAC,CAAC;oBACR,kBAAkB;oBAClB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBACjC,QAAQ,MAAM,EAAE,CAAC;wBACf,KAAK,GAAG;4BACN,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;4BACvB,MAAM;wBACR,KAAK,GAAG;4BACN,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC;4BACrB,MAAM;wBACR,KAAK,GAAG;4BACN,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;4BACzB,MAAM;wBACR,KAAK,GAAG;4BACN,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;4BAC3B,MAAM;wBACR,KAAK,GAAG;4BACN,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;4BACvB,MAAM;wBACR,KAAK,GAAG;4BACN,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;4BAC5B,MAAM;wBACR,KAAK,GAAG;4BACN,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gCAClC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;4BACzB,CAAC;iCAAM,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gCACzC,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC;4BAChC,CAAC;4BACD,MAAM;oBACV,CAAC;gBACH,CAAC;YACH,CAAC;YAED,KAAK,GAAG,cAAc,GAAG,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5LD,kBA4LC"}

package/src/lib/types.d.ts

@@ -0,0 +1,313 @@
+/**
+ * A common representation of a TF2 item.
+ */
+export type Item = PrimaryItemAttributes & ExtraItemAttributes;
+/**
+ * A TF2 item from an inventory.
+ */
+export interface InventoryItem extends Item {
+    assetid: string;
+}
+/**
+ * The primary attributes of a TF2 item that are used to identify it.
+ */
+export interface PrimaryItemAttributes {
+    defindex: number;
+    quality: number;
+    craftable: boolean;
+    tradable: boolean;
+    australium: boolean;
+    festivized: boolean;
+    killstreak: number;
+    effect: number | null;
+    paintkit: number | null;
+    wear: number | null;
+    target: number | null;
+    output: number | null;
+    outputQuality: number | null;
+    elevated: boolean;
+    crateSeries: number | null;
+}
+export interface RecipeInput {
+    defindex?: number;
+    killstreak?: number;
+    quality: number;
+    amount: number;
+}
+/**
+ * Extra attributes of a TF2 item.
+ */
+export interface ExtraItemAttributes {
+    paint: number | null;
+    spells: number[];
+    parts: number[];
+    sheen: string | null;
+    killstreaker: string | null;
+    inputs: RecipeInput[] | null;
+}
+type RequiredKeys<T extends keyof U, U> = {
+    [K in T]-?: K extends keyof U ? U[K] : never;
+} & {
+    [K in Exclude<keyof U, T>]?: U[K];
+};
+export type RequiredItemAttributes = RequiredKeys<'defindex' | 'quality', PrimaryItemAttributes>;
+export interface ItemsGameItem {
+    name: string;
+    capabilities?: Record<string, '0' | '1'>;
+    static_attrs?: Record<string, string>;
+    attributes?: Record<string, {
+        attribute_class: string;
+        value: string;
+    }>;
+}
+interface GetItem {
+    /**
+     * Synchronously get an item by its defindex from items_game.txt.
+     * @param defindex The defindex of the item.
+     * @returns Returns the matching item from items_game.txt, undefined if it
+     * is not possible to get the item synchronously or an error to exit early.
+     * @example schema.getItemByDefindex(5021) -> { name: "Decoder Ring", ... }
+     * @example schema.getItemByDefindex(-1) -> undefined
+     * @example schema.getItemByDefindex(-1) -> new Error("Item not found")
+     */
+    getItemByDefindex(defindex: number): ItemsGameItem | undefined | Error;
+    /**
+     * Asynchronously get an item by its defindex from items_game.txt.
+     * @param defindex The defindex of the item.
+     * @returns Returns the matching item from items_game.txt or throws an error
+     * if it was not found.
+     * @example schema.fetchItemByDefindex(5021) -> Promise.resolve({ name: "Decoder Ring", ... })
+     * @example schema.fetchItemByDefindex(-1) -> Promise.reject(new Error("Item not found"))
+     */
+    fetchItemByDefindex(defindex: number): Promise<ItemsGameItem>;
+}
+/**
+ * Various information needs to be retrieved externally to format the Econ items.
+ * This schema is used to define the getters for this information.
+ */
+export interface EconParserSchema extends GetItem {
+    /**
+     * Syncronously get the defindex of an item by its `item_name` using the
+     * GetSchemaItems API.
+     * @param name The name of the item.
+     * @returns Returns the defindex of the item, null if an item with the given
+     * name is known not to exist or undefined if it could not be found syncronously.
+     * @example schema.getDefindexByName("Mann Co. Supply Crate Key") -> 5021
+     * @example schema.getDefindexByName("Mann Co. Supply Crate Key") -> undefined
+     * @example schema.getDefindexByName("Non-existent item") -> null
+     */
+    getDefindexByName(name: string): number | null | undefined;
+    /**
+     * Asyncronously get the defindex of an item by its `item_name` using
+     * the GetSchemaItems API.
+     * @param name The name of the item.
+     * @returns Returns the defindex of the item or null if an item with the given
+     * name does not exist.
+     * @example schema.fetchDefindexByName("Mann Co. Supply Crate Key") -> Promise.resolve(5021)
+     * @example schema.fetchDefindexByName("Non-existent item") -> Promise.resolve(null)
+     */
+    fetchDefindexByName(name: string): Promise<number | null>;
+    /**
+     * Synchronously get the id of a quality by its name.
+     * @param name The name of the quality.
+     * @returns Returns the id of the quality, undefined if the quality cannot be
+     * found syncronously or an error to exit early.
+     * @example schema.getQualityByName("Unique") -> 6
+     * @example schema.getQualityByName("Non-existent quality") -> undefined
+     * @example schema.getQualityByName("Non-existent quality") -> new Error("Quality not found")
+     */
+    getQualityByName(name: string): number | undefined | Error;
+    /**
+     * Asynchronously get the id of a quality by its name.
+     * @param name The name of the quality.
+     * @returns Returns the id of the quality or throws an error if the quality
+     * cannot be found.
+     * @example schema.fetchQualityByName("Unique") -> Promise.resolve(6)
+     * @example schema.fetchQualityByName("Non-existent quality") -> Promise.reject(new Error("Quality not found"))
+     */
+    fetchQualityByName(name: string): Promise<number>;
+    /**
+     * Synchronously get the id of an effect by its name.
+     * @param name The name of the effect.
+     * @returns Returns the id of the effect, undefined if the effect cannot be
+     * found synchronously or an error to exit early.
+     * @example schema.getEffectByName("Burning Flames") -> 13
+     * @example schema.getEffectByName("Non-existent effect") -> undefined
+     * @example schema.getEffectByName("Non-existent effect") -> new Error("Effect not found")
+     */
+    getEffectByName(name: string): number | undefined | Error;
+    /**
+     * Asynchronously get the id of an effect by its name.
+     * @param name The name of the effect.
+     * @returns Returns the id of the effect or throws an error if the effect
+     * cannot be found.
+     * @example schema.fetchEffectByName("Burning Flames") -> Promise.resolve(13)
+     * @example schema.fetchEffectByName("Non-existent effect") -> Promise.reject(new Error("Effect not found"))
+     */
+    fetchEffectByName(name: string): Promise<number>;
+    /**
+     * Synchronously get the id of a texture by its name.
+     * @param name The name of the texture.
+     * @returns Returns the id of the texture, undefined if the texture cannot be
+     * found synchronously or an error to exit early.
+     * @example schema.getTextureByName("Night Owl") -> 14
+     * @example schema.getTextureByName("Non-existent texture") -> undefined
+     * @example schema.getTextureByName("Non-existent texture") -> new Error("Texture not found")
+     */
+    getTextureByName(name: string): number | undefined | Error;
+    /**
+     * Asynchronously get the id of a texture by its name.
+     * @param name The name of the texture.
+     * @returns Returns the id of the texture or throws an error if the texture
+     * cannot be found.
+     * @example schema.fetchTextureByName("Night Owl") -> Promise.resolve(14)
+     * @example schema.fetchTextureByName("Non-existent texture") -> Promise.reject(new Error("Texture not found"))
+     */
+    fetchTextureByName(name: string): Promise<number>;
+    /**
+     * Syncronously get the id of a spell by its name.
+     * @param name The name of the spell.
+     * @returns Returns the id of the spell, undefined if the spell cannot be
+     * found syncronously or an error to exit early.
+     * @example schema.getSpellByName("Exorcism") -> 1009
+     * @example schema.getSpellByName("Non-existent spell") -> undefined
+     * @example schema.getSpellByName("Non-existent spell") -> new Error("Spell not found")
+     */
+    getSpellByName(name: string): number | undefined | Error;
+    /**
+     * Asynchronously get the id of a spell by its name.
+     * @param name The name of the spell.
+     * @returns Returns the id of the spell or throws an error if the spell
+     * cannot be found.
+     * @example schema.fetchSpellByName("Exorcism") -> Promise.resolve(1009)
+     * @example schema.fetchSpellByName("Non-existent spell") -> Promise.reject(new Error("Spell not found"))
+     */
+    fetchSpellByName(name: string): Promise<number>;
+    /**
+     * Syncronously get the defindex of a strange part by its score type. Because
+     * some score types may not have a corresponding strange part, e.g. "Kills", then
+     * this method has to return null when no match instead of throwing an error.
+     * @param scoreType The score type.
+     * @returns Returns the id of the strange part, null if a strange part with the
+     * given score type does not exist or undefined if it could not be found syncronously.
+     * @example schema.getStrangePartByScoreType("Kills Under A Full Moon") -> 6015
+     * @example schema.getStrangePartByScoreType("Kills Under A Full Moon") -> undefined
+     * @example schema.getStrangePartByScoreType("Non-existent score type") -> null
+     */
+    getStrangePartByScoreType(scoreType: string): number | null | undefined;
+    /**
+     * Asynchronously get the defindex of a strange part by its score type. Because
+     * some score types may not have a corresponding strange part, e.g. "Kills", then
+     * this method has to return null when no match instead of throwing an error.
+     * @param scoreType The score type.
+     * @returns Returns the id of the strange part or null if a strange part with
+     * the given score type does not exist.
+     * @example schema.fetchStrangePartByScoreType("Kills Under A Full Moon") -> Promise.resolve(6015)
+     * @example schema.fetchStrangePartByScoreType("Non-existent score type") -> Promise.resolve(null)
+     */
+    fetchStrangePartByScoreType(scoreType: string): Promise<number | null>;
+}
+/**
+ * Various information needs to be retrieved externally to format the TF2 items.
+ * This schema is used to define the getters for this information.
+ */
+export interface TF2ParserSchema extends GetItem {
+    /**
+     * Syncronously get the name of a sheen by its id.
+     * @param id The id of the sheen.
+     * @returns Returns the name of the sheen, undefined if the sheen cannot be
+     * found syncronously or an error to exit early.
+     * @example schema.getSheenById(6) -> "Villainous Violet"
+     * @example schema.getSheenById(6) -> undefined
+     * @example schema.getSheenById(-1) -> new Error("Sheen not found")
+     */
+    getSheenById(id: number): string | undefined | Error;
+    /**
+     * Asynchronously get the name of a sheen by its id.
+     * @param id The id of the sheen.
+     * @returns Returns the name of the sheen or throws an error if the sheen
+     * cannot be found.
+     * @example schema.fetchSheenById(6) -> Promise.resolve("Villainous Violet")
+     * @example schema.fetchSheenById(-1) -> Promise.reject(new Error("Sheen not found"))
+     */
+    fetchSheenById(id: number): Promise<string>;
+    /**
+     * Syncronously get the name of a killstreaker by its id.
+     * @param id The id of the killstreaker.
+     * @returns Returns the name of the killstreaker, undefined if the killstreaker
+     * cannot be found syncronously or an error to exit early.
+     * @example schema.getKillstreakerById(2003) -> "Cerebral Discharge"
+     * @example schema.getKillstreakerById(2003) -> undefined
+     * @example schema.getKillstreakerById(-1) -> new Error("Killstreaker not found")
+     */
+    getKillstreakerById(id: number): string | undefined | Error;
+    /**
+     * Asynchronously get the name of a killstreaker by its id.
+     * @param id The id of the killstreaker.
+     * @returns Returns the name of the killstreaker or throws an error if the
+     * killstreaker cannot be found.
+     * @example schema.fetchKillstreakerById(2003) -> Promise.resolve("Cerebral Discharge")
+     * @example schema.fetchKillstreakerById(-1) -> Promise.reject(new Error("Killstreaker not found"))
+     */
+    fetchKillstreakerById(id: number): Promise<string>;
+    /**
+     * Syncronously get the defindex of a spell by the attribute defindex and value.
+     * @param defindex The defindex of the spell attribute.
+     * @param id The value of the spell attribute.
+     * @returns Returns the defindex of the spell, undefined if the spell cannot
+     * be found syncronously or an error to exit early.
+     * @example schema.getSpellById(1004, 1) -> 8902
+     * @example schema.getSpellById(1004, 1) -> undefined
+     * @example schema.getSpellById(-1, -1) -> new Error("Spell not found")
+     */
+    getSpellById(defindex: number, id: number): number | undefined | Error;
+    /**
+     * Asynchronously get the defindex of a spell by the attribute defindex and value.
+     * @param defindex The defindex of the spell attribute.
+     * @param id The value of the spell attribute.
+     * @returns Returns the defindex of the spell or throws an error if the spell
+     * cannot be found.
+     * @example schema.fetchSpellById(1004, 1) -> Promise.resolve(8902)
+     * @example schema.fetchSpellById(1004, 1) -> Promise.reject(new Error("Spell not found"))
+     */
+    fetchSpellById(defindex: number, id: number): Promise<number>;
+    /**
+     * Syncronously get the defindex of a paint by its hex color code.
+     * @param color The hex color code of the paint.
+     * @returns Returns the defindex of the paint, undefined if the paint cannot
+     * be found syncronously or an error to exit early.
+     * @example schema.getPaintByColor("e7b53b") -> 5037
+     * @example schema.getPaintByColor("e7b53b") -> undefined
+     * @example schema.getPaintByColor("") -> new Error("Paint not found")
+     */
+    getPaintByColor(color: string): number | undefined | Error;
+    /**
+     * Asynchronously get the defindex of a paint by its hex color code.
+     * @param color The hex color code of the paint.
+     * @returns Returns the defindex of the paint or throws an error if the paint
+     * cannot be found.
+     * @example schema.fetchPaintByColor("e7b53b") -> Promise.resolve(5037)
+     * @example schema.fetchPaintByColor("e7b53b") -> Promise.reject(new Error("Paint not found"))
+     */
+    fetchPaintByColor(color: string): Promise<number>;
+    /**
+     * Syncronously get the defindex of a strange part by its id.
+     * @param id The id of the strange part.
+     * @returns Returns the defindex of the strange part, undefined if the strange
+     * part cannot be found syncronously or an error to exit early.
+     * @example schema.getStrangePartById(27) -> 6015
+     * @example schema.getStrangePartById(27) -> undefined
+     * @example schema.getStrangePartById(-1) -> new Error("Strange part not found")
+     */
+    getStrangePartById(id: number): number | undefined | Error;
+    /**
+     * Asynchronously get the defindex of a strange part by its id.
+     * @param id The id of the strange part.
+     * @returns Returns the defindex of the strange part or throws an error if the
+     * strange part cannot be found.
+     * @example schema.fetchStrangePartById(27) -> Promise.resolve(6015)
+     * @example schema.fetchStrangePartById(-1) -> Promise.reject(new Error("Strange part not found"))
+     */
+    fetchStrangePartById(id: number): Promise<number>;
+}
+export {};

package/src/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/src/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../libs/tf2-format/src/lib/types.ts"],"names":[],"mappings":""}