@poe2-toolkit/item-extractor 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vladislav Rajtmajer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# @poe2-toolkit/item-extractor
+
+[![npm](https://img.shields.io/npm/v/@poe2-toolkit/item-extractor.svg)](https://www.npmjs.com/package/@poe2-toolkit/item-extractor)
+[![status: WIP](https://img.shields.io/badge/status-work%20in%20progress-orange.svg)](#)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+
+Builds **Path of Exile 2 item** data and icons straight from the official GGPK /
+patch server.
+
+> **Work in progress.** The API is not implemented yet. `buildItems(source)`
+> currently throws. This package exists to reserve its place in the toolkit and
+> document the intended shape.
+
+It will mirror [`@poe2-toolkit/tree-extractor`](../poe2-tree-extractor): source-agnostic,
+built on a [`@poe2-toolkit/ggpk`](../poe2-ggpk) source, returning formatted data rather
+than writing into the package. Planned coverage: base item types, their stats,
+and their icons.
+
+**Code only.** Like the rest of the toolkit, this package will ship no game data
+and no art.
+
+## Attributions and legal
+
+This is an unofficial, fan-made project, **not** affiliated with, endorsed by, or
+sponsored by Grinding Gear Games. "Path of Exile 2" is a trademark of Grinding
+Gear Games, and all game content, data, and art are their property. Thank you to
+Grinding Gear Games for making Path of Exile 2. GGPK access builds on
+[`pathofexile-dat`](https://github.com/SnosMe/poe-dat-viewer) (MIT, © SnosMe);
+full attribution is in the repository [NOTICE](../../NOTICE.md).
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @poe2-toolkit/item-extractor — builds Path of Exile 2 item data and icons from a
+ * {@link GgpkSource}.
+ *
+ * Work in progress: the API is not implemented yet. It will mirror
+ * `@poe2-toolkit/tree-extractor` — source-agnostic, GGPK-only, shipping code rather than
+ * data — extracting base item types, their stats and their icons.
+ */
+import type { GgpkSource } from '@poe2-toolkit/ggpk';
+/**
+ * Planned entry point: extract item data and icons from a GGPK source.
+ *
+ * @throws always — not implemented yet.
+ */
+export declare function buildItems(source: GgpkSource): Promise<never>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,CAInE"}

package/dist/index.js

@@ -0,0 +1,18 @@
+/**
+ * @poe2-toolkit/item-extractor — builds Path of Exile 2 item data and icons from a
+ * {@link GgpkSource}.
+ *
+ * Work in progress: the API is not implemented yet. It will mirror
+ * `@poe2-toolkit/tree-extractor` — source-agnostic, GGPK-only, shipping code rather than
+ * data — extracting base item types, their stats and their icons.
+ */
+/**
+ * Planned entry point: extract item data and icons from a GGPK source.
+ *
+ * @throws always — not implemented yet.
+ */
+export async function buildItems(source) {
+    void source;
+    throw new Error('@poe2-toolkit/item-extractor is not implemented yet');
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,MAAkB;IACjD,KAAK,MAAM,CAAC;IAEZ,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;AACzE,CAAC"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@poe2-toolkit/item-extractor",
+  "version": "0.1.0",
+  "description": "Builds Path of Exile 2 item data and icons straight from the official GGPK / patch server. Code only — ships no game data or art. Work in progress.",
+  "keywords": [
+    "path-of-exile",
+    "poe2",
+    "items",
+    "ggpk",
+    "extractor"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\"",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "prepack": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@poe2-toolkit/ggpk": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}