refactor: add cjs support & fix docs

Author: c0reme

README.md

@@ -29,7 +29,7 @@ const xiv = new xivapi();
 // With options
 const xivCustom = new xivapi({
   version: "7.0",    // specify game version
-  language: "jp",    // specify language (jp, en, de, fr)
+  language: "ja",    // specify language (ja, en, de, fr)
   verbose: true      // output more logging
 });
 ```
@@ -40,7 +40,7 @@ const xivCustom = new xivapi({
 // Fetch the Gil item (item ID 1)
 const item = await xiv.items.get(1);
 
-console.log(item.Name); // "Gil" (or equivalent in your language)
+console.log(item.fields.Name); // "Gil" (or equivalent in your language)
 ```
 
 #### 3. Search Example
@@ -78,13 +78,15 @@ Output example:
 
 ```js
 // Fetch a raw asset file (e.g. icon image)
-const asset = await xiv.data.assets.get({
+const assets = await xiv.data.assets();
+const asset = await assets.get({
   path: "ui/icon/051000/051474_hr1.tex",
   format: "png" // jpg or webp also supported
 });
 
 // List all quests
-const quests = await xiv.data.sheets.list("Quest");
+const sheets = await xiv.data.sheets();
+const quests = await sheets.list("Quest");
 console.log(quests);
 
 // List available game versions

eslint.config.js

@@ -11,7 +11,7 @@ export default defineConfig([
 		languageOptions: { globals: globals.node },
 	},
 	{ files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-	globalIgnores(["tests/**/*.test.ts", "dist/**/*.js"]),
+	globalIgnores(["tests/**/*.test.ts", "dist/**/*.{js,cjs,mjs}"]),
 	tseslint.configs.recommended,
 	{
 		rules: {

package.json

@@ -3,19 +3,22 @@
   "name": "@xivapi/js",
   "version": "1.0.1",
   "description": "A Node.JS wrapper for xivapi.com",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "devDependencies": {
     "@eslint/js": "^9.38.0",
     "@types/node": "^24.7.2",
     "eslint": "^9.37.0",
     "globals": "^16.4.0",
     "ts-node": "^10.9.2",
+    "tsup": "^8.5.0",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.46.1",
     "vitest": "^3.2.4"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsup",
     "test": "vitest",
     "lint": "eslint --fix"
   },
@@ -33,7 +36,6 @@
     "url": "https://github.com/xivapi/xivapi-js/issues"
   },
   "homepage": "https://github.com/xivapi/xivapi-js#readme",
-  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ]

src/index.ts

@@ -2,7 +2,35 @@ import { Assets, Sheet, Sheets, Versions } from "./lib"
 import { CustomError, request } from "./utils"
 
 export default class XIVAPI {
-	private readonly options: XIVAPI.Options
+	public readonly options: XIVAPI.Options
+
+	public readonly achievements: Sheet<"Achievement">
+	public readonly minions: Sheet<"Companion">
+	public readonly mounts: Sheet<"Mount">
+	public readonly items: Sheet<"Item">
+
+	/**
+   * Raw endpoints for the API. Please consider using the typed endpoints instead.
+   * @see https://v2.xivapi.com/api/docs
+   * @since 0.5.0
+   */
+	public readonly data = {
+		/**
+     * @see https://v2.xivapi.com/api/docs#tag/sheets
+     * @since 0.5.0
+     */
+		sheets: () => new Sheets(this.options),
+		/**
+     * @see https://v2.xivapi.com/api/docs#tag/versions
+     * @since 0.5.0
+     */
+		versions: () => new Versions().all().then((versions) => versions.versions.map((version) => version.names[0])),
+		/**
+     * @see https://v2.xivapi.com/api/docs#tag/assets
+     * @since 0.5.0
+     */
+		assets: () => new Assets(),
+	}
 
 	/**
    * A wrapper for the XIVAPI v2 API.
@@ -17,35 +45,12 @@ export default class XIVAPI {
 			verbose: false,
 		}
 	) {
-		this.options = options
-	}
-
-	/**
-   * @since 0.5.0
-   */
-	public get achievements() {
-		return new Sheet("Achievement")
-	}
-
-	/**
-   * @since 0.5.0
-   */
-	public get minions() {
-		return new Sheet("Companion")
-	}
+		this.achievements = new Sheet("Achievement")
+		this.minions = new Sheet("Companion")
+		this.mounts = new Sheet("Mount")
+		this.items = new Sheet("Item")
 
-	/**
-   * @since 0.5.0
-   */
-	public get mounts() {
-		return new Sheet("Mount")
-	}
-
-	/**
-   * @since 0.5.0
-   */
-	public get items() {
-		return new Sheet("Item")
+		this.options = options
 	}
 
 	/**
@@ -63,32 +68,6 @@ export default class XIVAPI {
 		if (errors) throw new CustomError(errors[0].message)
 		return data as Models.SearchResponse
 	}
-
-	/**
-   * Raw endpoints for the API. Please consider using the typed endpoints instead.
-   * @see https://v2.xivapi.com/api/docs
-   * @since 0.5.0
-   */
-	public data = {
-		/**
-     * @see https://v2.xivapi.com/api/docs#tag/assets
-     * @since 0.5.0
-     */
-		assets: () => new Assets(),
-
-		/**
-     * @see https://v2.xivapi.com/api/docs#tag/sheets
-     * @since 0.5.0
-     */
-		sheets: () => new Sheets(this.options),
-
-		/**
-     * @see https://v2.xivapi.com/api/docs#tag/versions
-     * @since 0.5.0
-     */
-		versions: () =>
-			new Versions().all().then((versions) => versions.versions.map((version) => version.names[0])),
-	}
 }
 
 export namespace XIVAPI {

tsup.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from "tsup"
+
+export default defineConfig({
+	entry: ["src/index.ts"],
+	format: ["cjs", "esm"],
+	dts: true,
+	outDir: "dist",
+	splitting: true,
+	sourcemap: true,
+	minify: false,
+	clean: true
+})