@tf2-automatic/tf2-format 8.1.0 → 8.2.0

package/README.md

@@ -17,3 +17,7 @@ For parsing items, e.g. econ items from inventories and trades, or TF2 items fro
 ### SKU
 
 For working with SKUs, use the [SKU](./src/lib/sku) class.
+
+### Generating names
+
+For generating the name of items, use the [NameGenerator](./src/lib/naming) class.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tf2-automatic/tf2-format",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "dependencies": {
     "tslib": "^2.7.0",
     "protobufjs": "^7.4.0"
@@ -10,6 +10,7 @@
     "type": "git",
     "url": "https://github.com/tf2-automatic/tf2-automatic.git"
   },
+  "license": "MIT",
   "types": "./src/index.d.ts",
   "main": "./src/index.js",
   "type": "commonjs"

package/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from './lib/types';
 export * from './lib/parsing';
 export * from './lib/sku';
+export * from './lib/naming';

package/src/index.js

@@ -4,4 +4,5 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./lib/types"), exports);
 tslib_1.__exportStar(require("./lib/parsing"), exports);
 tslib_1.__exportStar(require("./lib/sku"), exports);
+tslib_1.__exportStar(require("./lib/naming"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/tf2-format/src/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,wDAA8B;AAC9B,oDAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/tf2-format/src/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,wDAA8B;AAC9B,oDAA0B;AAC1B,uDAA6B"}

package/src/lib/naming/index.d.ts

@@ -0,0 +1,6 @@
+import { ItemNamingSchema, RequiredItemAttributes } from '../types';
+export declare class NameGenerator {
+    private readonly schema;
+    constructor(schema: ItemNamingSchema);
+    getName(item: RequiredItemAttributes, proper?: boolean): Promise<string>;
+}

package/src/lib/naming/index.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NameGenerator = void 0;
+const tslib_1 = require("tslib");
+const KILLSTREAKS = [
+    'Killstreak',
+    'Specialized Killstreak',
+    'Professional Killstreak',
+];
+const WEAR = [
+    'Factory New',
+    'Minimal Wear',
+    'Field-Tested',
+    'Well-Worn',
+    'Battle Scarred',
+];
+class NameGenerator {
+    constructor(schema) {
+        this.schema = schema;
+    }
+    getName(item_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function* (item, proper = true) {
+            let name = '';
+            let schemaItem = this.schema.getItemByDefindex(item.defindex);
+            if (schemaItem === undefined) {
+                schemaItem = yield this.schema.fetchItemByDefindex(item.defindex);
+            }
+            else if (schemaItem instanceof Error) {
+                throw schemaItem;
+            }
+            if (item.tradable === false) {
+                name += 'Non-Tradable ';
+            }
+            if (item.craftable === false) {
+                name += 'Non-Craftable ';
+            }
+            if (item.elevated === true) {
+                let quality = this.schema.getQualityById(11);
+                if (quality === undefined) {
+                    quality = yield this.schema.fetchQualityById(11);
+                }
+                else if (quality instanceof Error) {
+                    throw quality;
+                }
+                name += quality + ' ';
+            }
+            if ((item.quality === 6 && item.elevated === true) ||
+                (item.quality !== 6 && item.quality !== 15 && item.quality !== 5) ||
+                (item.quality === 5 && !item.effect) ||
+                schemaItem.item_quality == 5) {
+                let quality = this.schema.getQualityById(item.quality);
+                if (quality === undefined) {
+                    quality = yield this.schema.fetchQualityById(item.quality);
+                }
+                else if (quality instanceof Error) {
+                    throw quality;
+                }
+                name += quality + ' ';
+            }
+            if (item.effect) {
+                let effect = this.schema.getEffectById(item.effect);
+                if (effect === undefined) {
+                    effect = yield this.schema.fetchEffectById(item.effect);
+                }
+                else if (effect instanceof Error) {
+                    throw effect;
+                }
+                name += effect + ' ';
+            }
+            if (item.festivized) {
+                name += 'Festivized ';
+            }
+            if (item.killstreak !== undefined && item.killstreak !== 0) {
+                name += KILLSTREAKS[item.killstreak - 1] + ' ';
+            }
+            if (item.target) {
+                let target = this.schema.getItemByDefindex(item.target);
+                if (target === undefined) {
+                    target = yield this.schema.fetchItemByDefindex(item.target);
+                }
+                else if (target instanceof Error) {
+                    throw target;
+                }
+                name += target.item_name + ' ';
+            }
+            if (item.outputQuality && item.outputQuality !== 6) {
+                let quality = this.schema.getQualityById(item.outputQuality);
+                if (quality === undefined) {
+                    quality = yield this.schema.fetchQualityById(item.outputQuality);
+                }
+                else if (quality instanceof Error) {
+                    throw quality;
+                }
+                name += quality + ' ';
+            }
+            if (item.output) {
+                let output = this.schema.getItemByDefindex(item.output);
+                if (output === undefined) {
+                    output = yield this.schema.fetchItemByDefindex(item.output);
+                }
+                else if (output instanceof Error) {
+                    throw output;
+                }
+                name += output.item_name + ' ';
+            }
+            if (item.australium) {
+                name += 'Australium ';
+            }
+            if (item.paintkit) {
+                let paintkit = this.schema.getPaintkitById(item.paintkit);
+                if (paintkit === undefined) {
+                    paintkit = yield this.schema.fetchPaintkitById(item.paintkit);
+                }
+                else if (paintkit instanceof Error) {
+                    throw paintkit;
+                }
+                name += paintkit + ' ';
+            }
+            if (proper === true && name === '' && schemaItem.proper_name === true) {
+                name = 'The ';
+            }
+            name += schemaItem.item_name;
+            if (item.wear) {
+                name += ' (' + WEAR[item.wear - 1] + ')';
+            }
+            if (item.crateSeries) {
+                name += ' #' + item.crateSeries;
+            }
+            return name;
+        });
+    }
+}
+exports.NameGenerator = NameGenerator;
+//# sourceMappingURL=index.js.map

package/src/lib/naming/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/tf2-format/src/lib/naming/index.ts"],"names":[],"mappings":";;;;AAEA,MAAM,WAAW,GAAG;IAClB,YAAY;IACZ,wBAAwB;IACxB,yBAAyB;CAC1B,CAAC;AACF,MAAM,IAAI,GAAG;IACX,aAAa;IACb,cAAc;IACd,cAAc;IACd,WAAW;IACX,gBAAgB;CACjB,CAAC;AAEF,MAAa,aAAa;IACxB,YAA6B,MAAwB;QAAxB,WAAM,GAAN,MAAM,CAAkB;IAAG,CAAC;IAEnD,OAAO;qEAAC,IAA4B,EAAE,MAAM,GAAG,IAAI;YACvD,IAAI,IAAI,GAAG,EAAE,CAAC;YAEd,IAAI,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC9D,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpE,CAAC;iBAAM,IAAI,UAAU,YAAY,KAAK,EAAE,CAAC;gBACvC,MAAM,UAAU,CAAC;YACnB,CAAC;YAED,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBAC5B,IAAI,IAAI,eAAe,CAAC;YAC1B,CAAC;YAED,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;gBAC7B,IAAI,IAAI,gBAAgB,CAAC;YAC3B,CAAC;YAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;gBAC3B,IAAI,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBAC7C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;gBACnD,CAAC;qBAAM,IAAI,OAAO,YAAY,KAAK,EAAE,CAAC;oBACpC,MAAM,OAAO,CAAC;gBAChB,CAAC;gBAED,IAAI,IAAI,OAAO,GAAG,GAAG,CAAC;YACxB,CAAC;YAED,IACE,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC;gBAC9C,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,CAAC;gBACjE,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;gBACpC,UAAU,CAAC,YAAY,IAAI,CAAC,EAC5B,CAAC;gBACD,IAAI,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC7D,CAAC;qBAAM,IAAI,OAAO,YAAY,KAAK,EAAE,CAAC;oBACpC,MAAM,OAAO,CAAC;gBAChB,CAAC;gBAED,IAAI,IAAI,OAAO,GAAG,GAAG,CAAC;YACxB,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACpD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1D,CAAC;qBAAM,IAAI,MAAM,YAAY,KAAK,EAAE,CAAC;oBACnC,MAAM,MAAM,CAAC;gBACf,CAAC;gBAED,IAAI,IAAI,MAAM,GAAG,GAAG,CAAC;YACvB,CAAC;YAED,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,IAAI,IAAI,aAAa,CAAC;YACxB,CAAC;YAED,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;gBAC3D,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;YACjD,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACxD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC9D,CAAC;qBAAM,IAAI,MAAM,YAAY,KAAK,EAAE,CAAC;oBACnC,MAAM,MAAM,CAAC;gBACf,CAAC;gBAED,IAAI,IAAI,MAAM,CAAC,SAAS,GAAG,GAAG,CAAC;YACjC,CAAC;YAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,EAAE,CAAC;gBACnD,IAAI,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC7D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBACnE,CAAC;qBAAM,IAAI,OAAO,YAAY,KAAK,EAAE,CAAC;oBACpC,MAAM,OAAO,CAAC;gBAChB,CAAC;gBAED,IAAI,IAAI,OAAO,GAAG,GAAG,CAAC;YACxB,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACxD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC9D,CAAC;qBAAM,IAAI,MAAM,YAAY,KAAK,EAAE,CAAC;oBACnC,MAAM,MAAM,CAAC;gBACf,CAAC;gBAED,IAAI,IAAI,MAAM,CAAC,SAAS,GAAG,GAAG,CAAC;YACjC,CAAC;YAED,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,IAAI,IAAI,aAAa,CAAC;YACxB,CAAC;YAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC1D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAChE,CAAC;qBAAM,IAAI,QAAQ,YAAY,KAAK,EAAE,CAAC;oBACrC,MAAM,QAAQ,CAAC;gBACjB,CAAC;gBAED,IAAI,IAAI,QAAQ,GAAG,GAAG,CAAC;YACzB,CAAC;YAED,IAAI,MAAM,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,IAAI,UAAU,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;gBACtE,IAAI,GAAG,MAAM,CAAC;YAChB,CAAC;YAED,IAAI,IAAI,UAAU,CAAC,SAAS,CAAC;YAE7B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;YAC3C,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;YAClC,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;CACF;AAnID,sCAmIC"}

package/src/lib/types.d.ts

@@ -60,7 +60,12 @@ export interface ItemsGameItem {
         value: string;
     }>;
 }
-interface GetItem {
+export interface SchemaItem {
+    item_name: string;
+    proper_name: boolean;
+    item_quality: number;
+}
+interface GetItemsGameItem {
     /**
      * Synchronously get an item by its defindex from items_game.txt.
      * @param defindex The defindex of the item.
@@ -81,11 +86,92 @@ interface GetItem {
      */
     fetchItemByDefindex(defindex: number): Promise<ItemsGameItem>;
 }
+/**
+ * Various information needs to be retrieved externally to name items.
+ * This schema is used to define the getters for this information.
+ */
+export interface ItemNamingSchema {
+    /**
+     * Syncronously get an item by its defindex from the TF2 GetItemsGame API.
+     * @param defindex The defindex of the item.
+     * @returns Returns the matching item, undefined if it is not possible to get
+     * the item synchronously or an error to exit early.
+     * @example schema.getItemByDefindex(5021) -> { item_name: "Mann Co. Supply Crate Key", ... }
+     * @example schema.getItemByDefindex(5021) -> undefined
+     * @example schema.getItemByDefindex(-1) -> new Error("Item not found")
+     */
+    getItemByDefindex(defindex: number): SchemaItem | undefined | Error;
+    /**
+     * Asynchronously get an item by its defindex from the TF2 GetItemsGame API.
+     * @param defindex The defindex of the item.
+     * @returns Returns the matching item or throws an error if it was not found.
+     * @example schema.fetchItemByDefindex(5021) -> Promise.resolve({ item_name: "Mann Co. Supply Crate Key", ... })
+     * @example schema.fetchItemByDefindex(-1) -> Promise.reject(new Error("Item not found"))
+     */
+    fetchItemByDefindex(defindex: number): Promise<SchemaItem>;
+    /**
+     * Syncronously get the name of an item by its defindex.
+     * @param id The id of the quality.
+     * @returns Returns the name of the quality, undefined if the quality cannot
+     * be found syncronously or an error to exit early.
+     * @example schema.getQualityById(6) -> "Unique"
+     * @example schema.getQualityById(6) -> undefined
+     * @example schema.getQualityById(-1) -> new Error("Quality not found")
+     */
+    getQualityById(id: number): string | undefined | Error;
+    /**
+     * Asynchronously get the name of a quality by its id.
+     * @param id The id of the quality.
+     * @returns Returns the name of the quality or throws an error if the quality
+     * cannot be found.
+     * @example schema.fetchQualityById(6) -> Promise.resolve("Unique")
+     * @example schema.fetchQualityById(-1) -> Promise.reject(new Error("Quality not found"))
+     */
+    fetchQualityById(id: number): Promise<string>;
+    /**
+     * Syncronously get the name of an effect by its id.
+     * @param id The id of the effect.
+     * @returns Returns the name of the effect, undefined if the effect cannot
+     * be found syncronously or an error to exit early.
+     * @example schema.getEffectById(13) -> "Burning Flames"
+     * @example schema.getEffectById(13) -> undefined
+     * @example schema.getEffectById(-1) -> new Error("Effect not found")
+     */
+    getEffectById(id: number): string | undefined | Error;
+    /**
+     * Asynchronously get the name of an effect by its id.
+     * @param id The id of the effect.
+     * @returns Returns the name of the effect or throws an error if the effect
+     * cannot be found.
+     * @example schema.fetchEffectById(13) -> Promise.resolve("Burning Flames")
+     * @example schema.fetchEffectById(-1) -> Promise.reject(new Error("Effect not found"))
+     */
+    fetchEffectById(id: number): Promise<string>;
+    /**
+     * Syncronously get the name of a texture by its id.
+     * @param id The id of the texture.
+     * @returns Returns the name of the texture, undefined if the texture cannot
+     * be found syncronously or an error to exit early.
+     * @example schema.getTextureById(14) -> "Night Owl"
+     * @example schema.getTextureById(14) -> undefined
+     * @example schema.getTextureById(-1) -> new Error("Texture not found")
+     */
+    getPaintkitById(id: number): string | undefined | Error;
+    /**
+     * Asynchronously get the name of a texture by its id.
+     * @param id The id of the texture.
+     * @returns Returns the name of the texture or throws an error if the texture
+     * cannot be found.
+     * @example schema.fetchTextureById(14) -> Promise.resolve("Night Owl")
+     * @example schema.fetchTextureById(-1) -> Promise.reject(new Error("Texture not found"))
+     */
+    fetchPaintkitById(id: number): Promise<string>;
+}
 /**
  * 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 {
+export interface EconParserSchema extends GetItemsGameItem {
     /**
      * Syncronously get the defindex of an item by its `item_name` using the
      * GetSchemaItems API.
@@ -249,7 +335,7 @@ export interface EconParserSchema extends GetItem {
  * 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 {
+export interface TF2ParserSchema extends GetItemsGameItem {
     getSpellById(defindex: number, id: number): number | undefined | Error;
     /**
      * Asynchronously get the defindex of a spell by the attribute defindex and value.