@lycoristech/azurapi 0.0.4 → 0.0.5

package/README.md

@@ -1,12 +1,12 @@
 <img src="https://github.com/iujab/azurlane-images/blob/main/banner.png" />
 
-# AzurAPI - js
+# LycorisTech/AzurAPI
 
 A self-maintained, current Azur Lane data library. Drop-in replacement for the `@azurapi/azurapi` package.
 
 ## Why?
 
-The older and amazing `@azurapi/azurapi` ecosystem is now 3+ years stale. I have fond memories starting off my computer science hobby building a discord bot using that API. Recently, when revisiting that project, I noticed that the azurapi package was years out of date, likely due to the wiki scraper method no longer being viable. This AzurAPI builds on the [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) and [nobbyfix/AzurLane-AssetDownloader](https://github.com/nobbyfix/AzurLane-AssetDownloader) repos so our data stays fresh within hours of each game patch.
+The older and amazing `@azurapi/azurapi` ecosystem is now 3+ years stale. I have fond memories starting off my computer science hobby building a discord bot using that API. Recently, when revisiting my old discord bot, I noticed that the azurapi package was years out of date, likely due to the wiki scraper method no longer being viable. This AzurAPI builds on the [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) and [nobbyfix/AzurLane-AssetDownloader](https://github.com/nobbyfix/AzurLane-AssetDownloader) repos so our data stays fresh within hours of each game patch.
 
 ## Installation
 
@@ -43,6 +43,14 @@ const results = azur.ships.search("Enterp", 5); // top 5 matches
 
 That's it. The `ships.get()` API is compatible. Ship objects match the same schema!
 
+### Relationship to the original AzurAPI project
+
+This library is a **schema-compatible successor** to [`@azurapi/azurapi`](https://github.com/AzurAPI/azurapi-js) (GPL-3.0) and its sister data repo [`AzurAPI/azurapi-js-setup`](https://github.com/AzurAPI/azurapi-js-setup) (AGPL-3.0).
+
+**This project is not a fork and does not contain any code from those repositories.** It is an independent rewrite built from scratch against the decompiled game data from [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData), which is a completely separate data source.
+
+The output JSON schema (field names, structure, rarity values, etc.) is deliberately kept shape-compatible with the original so existing devs can migrate with a single import change.
+
 ## Data Freshness
 
 Data is auto-refreshed weekly (every Monday) via GitHub Actions from [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) (EN + CN + JP regions). The refresh pipeline:
@@ -71,7 +79,7 @@ Ships have the full AzurAPI-compatible shape including:
 The committed `data/ships.json` is fetchable via GitHub raw URL:
 
 ```
-https://raw.githubusercontent.com/iujab/AzurAPI/main/data/ships.json
+https://raw.githubusercontent.com/iujab/Lycoris-AzurAPI/main/data/ships.json
 ```
 
 Also available: `ship-list.json` (minimal index), `id-map.json` (name→id lookup), `version.json`.
@@ -102,12 +110,12 @@ Ship paintings and thumbnails are hosted in a separate GitHub repo: [iujab/azurl
 - **Paintings** — skin art in WebP format (`paintings/{asset_name}.webp`)
 - **Thumbnails** — shipyard icons in PNG format (`thumbnails/{group_type}.png`)
 
-## License
+## License and Rights
 
-MIT for the code. Game data is extracted from publicly available game files and is the property of Yostar/Manjuu/Yongshi. This project is not affiliated with or endorsed by any of these companies.
+This is an **unofficial, non-commercial, community-maintained fan project**. It is not developed, endorsed, sponsored, or in any way affiliated with Manjuu, Yongshi, Yostar, or any of their subsidiaries.
 
 ## Acknowledgments
 
 - [AzurLaneTools/AzurLaneData](https://github.com/AzurLaneTools/AzurLaneData) — upstream auto-updating game data
 - [nobbyfix/AzurLane-AssetDownloader](https://github.com/nobbyfix/AzurLane-AssetDownloader) — game asset extraction
-- [AzurAPI/azurapi-js](https://github.com/AzurAPI/azurapi-js) — the original library whose schema we replicate, and is the base inspiration for this project!❤️
+- [AzurAPI/azurapi-js](https://github.com/AzurAPI/azurapi-js) — the original library whose schema we replicate, and the base inspiration for this project!❤️

package/dist/cjs/config.js

@@ -9,6 +9,6 @@ const IMAGES_REPO = "azurlane-images";
 exports.IMAGE_BASE_URL = `https://raw.githubusercontent.com/${GITHUB_USER}/${IMAGES_REPO}/${GITHUB_BRANCH}`;
 exports.PAINTINGS_URL = `${exports.IMAGE_BASE_URL}/paintings`;
 exports.THUMBNAILS_URL = `${exports.IMAGE_BASE_URL}/thumbnails`;
-// Data URLs (AzurAPI repo — for runtime fetch)
-const DATA_REPO = "AzurAPI";
+// Data URLs (Lycoris-AzurAPI repo — for runtime fetch)
+const DATA_REPO = "Lycoris-AzurAPI";
 exports.DATA_BASE_URL = `https://raw.githubusercontent.com/${GITHUB_USER}/${DATA_REPO}/${GITHUB_BRANCH}/data`;

package/dist/config.d.ts

@@ -1,5 +1,5 @@
 export declare const IMAGE_BASE_URL = "https://raw.githubusercontent.com/iujab/azurlane-images/main";
 export declare const PAINTINGS_URL = "https://raw.githubusercontent.com/iujab/azurlane-images/main/paintings";
 export declare const THUMBNAILS_URL = "https://raw.githubusercontent.com/iujab/azurlane-images/main/thumbnails";
-export declare const DATA_BASE_URL = "https://raw.githubusercontent.com/iujab/AzurAPI/main/data";
+export declare const DATA_BASE_URL = "https://raw.githubusercontent.com/iujab/Lycoris-AzurAPI/main/data";
 //# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,cAAc,iEAAqF,CAAC;AACjH,eAAO,MAAM,aAAa,2EAAgC,CAAC;AAC3D,eAAO,MAAM,cAAc,4EAAiC,CAAC;AAI7D,eAAO,MAAM,aAAa,8DAAwF,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,cAAc,iEAAqF,CAAC;AACjH,eAAO,MAAM,aAAa,2EAAgC,CAAC;AAC3D,eAAO,MAAM,cAAc,4EAAiC,CAAC;AAI7D,eAAO,MAAM,aAAa,sEAAwF,CAAC"}

package/dist/config.js

@@ -6,7 +6,7 @@ const IMAGES_REPO = "azurlane-images";
 export const IMAGE_BASE_URL = `https://raw.githubusercontent.com/${GITHUB_USER}/${IMAGES_REPO}/${GITHUB_BRANCH}`;
 export const PAINTINGS_URL = `${IMAGE_BASE_URL}/paintings`;
 export const THUMBNAILS_URL = `${IMAGE_BASE_URL}/thumbnails`;
-// Data URLs (AzurAPI repo — for runtime fetch)
-const DATA_REPO = "AzurAPI";
+// Data URLs (Lycoris-AzurAPI repo — for runtime fetch)
+const DATA_REPO = "Lycoris-AzurAPI";
 export const DATA_BASE_URL = `https://raw.githubusercontent.com/${GITHUB_USER}/${DATA_REPO}/${GITHUB_BRANCH}/data`;
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,MAAM,WAAW,GAAG,OAAO,CAAC;AAC5B,MAAM,aAAa,GAAG,MAAM,CAAC;AAE7B,oCAAoC;AACpC,MAAM,WAAW,GAAG,iBAAiB,CAAC;AACtC,MAAM,CAAC,MAAM,cAAc,GAAG,qCAAqC,WAAW,IAAI,WAAW,IAAI,aAAa,EAAE,CAAC;AACjH,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,cAAc,YAAY,CAAC;AAC3D,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,cAAc,aAAa,CAAC;AAE7D,+CAA+C;AAC/C,MAAM,SAAS,GAAG,SAAS,CAAC;AAC5B,MAAM,CAAC,MAAM,aAAa,GAAG,qCAAqC,WAAW,IAAI,SAAS,IAAI,aAAa,OAAO,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,MAAM,WAAW,GAAG,OAAO,CAAC;AAC5B,MAAM,aAAa,GAAG,MAAM,CAAC;AAE7B,oCAAoC;AACpC,MAAM,WAAW,GAAG,iBAAiB,CAAC;AACtC,MAAM,CAAC,MAAM,cAAc,GAAG,qCAAqC,WAAW,IAAI,WAAW,IAAI,aAAa,EAAE,CAAC;AACjH,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,cAAc,YAAY,CAAC;AAC3D,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,cAAc,aAAa,CAAC;AAE7D,uDAAuD;AACvD,MAAM,SAAS,GAAG,iBAAiB,CAAC;AACpC,MAAM,CAAC,MAAM,aAAa,GAAG,qCAAqC,WAAW,IAAI,SAAS,IAAI,aAAa,OAAO,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lycoristech/azurapi",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -46,16 +46,16 @@
     "gacha",
     "waifu"
   ],
-  "homepage": "https://github.com/iujab/AzurAPI#readme",
+  "homepage": "https://github.com/iujab/Lycoris-AzurAPI#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/iujab/AzurAPI.git"
+    "url": "git+https://github.com/iujab/Lycoris-AzurAPI.git"
   },
   "bugs": {
-    "url": "https://github.com/iujab/AzurAPI/issues"
+    "url": "https://github.com/iujab/Lycoris-AzurAPI/issues"
   },
   "license": "MIT",
-  "author": "",
+  "author": "iujab",
   "publishConfig": {
     "access": "public"
   }