@tf2-automatic/tf2-format 8.0.0

package/README.md

@@ -0,0 +1,19 @@
+# tf2-format
+
+This is a standard library for working with different formats in Team Fortress 2. It is designed with speed and interoperability in mind, and it is a many times faster than alternatives.
+
+## Why another library?
+
+I created this library because I needed fast, simple, and reliable handling of different formats in Team Fortress 2. Other libraries are slow, complicated, and rely heavily on hard-coded values. This library can parse different formats into a single common format.
+
+## Guides
+
+This library is organized into different classes, each made for working with specific formats. By separating functionality this way, you can easily find and work with the format you need without unnecessary complexity.
+
+### Item parsing
+
+For parsing items, e.g. econ items from inventories and trades, or TF2 items from the TF2 GC ([node-tf2](https://github.com/DoctorMckay/node-tf2)), use one of the implementations of the `Parser` class. For parsing econ items, use the [EconParser](./src/lib/parsing/econ) class. For parsing tf2 items, use the [TF2Parser](./src/lib/parsing/tf2) class. See [here](./src/lib/parsing/) for the item parser documentation.
+
+### SKU
+
+For working with SKUs, use the [SKU](./src/lib/sku) class.

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@tf2-automatic/tf2-format",
+  "version": "8.0.0",
+  "dependencies": {
+    "tslib": "^2.7.0",
+    "protobufjs": "^7.4.0"
+  },
+  "main": "./src/index.js",
+  "type": "commonjs",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

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

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

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

package/src/lib/parsing/econ/parser.d.ts

@@ -0,0 +1,43 @@
+import { Parser } from '../parser';
+import { EconParserSchema, InventoryItem } from '../../types';
+import { DescriptionAttributes, EconItem, ExtractedEconItem, TagAttributes } from './types';
+declare enum IdentifiableDescription {
+    Skip = 0,
+    All = 1,
+    Paint = 1,
+    Spells = 1,
+    Parts = 1,
+    Effect = 2,
+    Festivized = 3,
+    Killstreaker = 4,
+    Sheen = 5,
+    Killstreak = 6,
+    Texture = 7,
+    Input = 8,
+    Output = 9,
+    Target = 10,
+    Uses = 11,
+    Craftable = 12
+}
+export declare class EconParser extends Parser<EconParserSchema, EconItem, ExtractedEconItem> {
+    extract(item: EconItem): ExtractedEconItem;
+    parse(raw: ExtractedEconItem): Promise<InventoryItem>;
+    private getPartByScoreType;
+    private getInputByName;
+    private fetchInputByName;
+    static getDefindex(item: EconItem): number | null;
+    static getKillstreak(descriptions: DescriptionAttributes): number;
+    static getCrateSeries(tags: TagAttributes, item: EconItem): number | null;
+    static getTagAttributes(item: EconItem): TagAttributes;
+    static isAustralium(item: EconItem, tags: TagAttributes): boolean;
+    /**
+     * This function tries to extract as much useful information as possible from
+     * the descriptions of an item.
+     * @param item The item to extract the information from
+     * @param tags The tags of the item
+     * @param start The description to start from
+     * @returns An object with the extracted information
+     */
+    static getDescriptionAttributes(item: EconItem, tags: TagAttributes, start?: IdentifiableDescription): DescriptionAttributes;
+}
+export * from './types';