bc-data 102.0.0 → 102.0.1

package/index.d.ts

@@ -1,9 +1,24 @@
-import * as data from "./assetVersion.json";
+import * as versions from "./assetVersion.json";
+import * as ids from "./assetID.json";
+
+type AssetName = string;
 
 /**
  * A record containing the BC version (starting from >R98) in which each asset was added.
  *
  * The record consists of asset group names, mapped to asset names, which in turn are mapped to their respective BC version.
  */
-declare const assetVersion: { readonly [k in keyof typeof data]: Readonly<Record<string, `R${number}`>> };
-export { assetVersion };
+declare const assetVersion: { readonly [k in keyof typeof versions]: Readonly<Record<AssetName, `R${number}`>> };
+
+/**
+ * A record containing group & asset IDs.
+ *
+ * IDs are integers within the `[0, 2**16)` interval; the combination of group- and asset-ID forming a unique identifier.
+ *
+ * For a particular group- or asset-name an ID is guaranteed to *never* change. This has the following implications:
+ * * The renaming of a group or asset will yield a new ID
+ * * The removal of a group or asset will preserve the ID; it may never be reused by another group/asset
+ */
+declare const assetID: { readonly [k in keyof typeof ids]: { readonly id: number, readonly assets: Readonly<Record<AssetName, number>> } };
+
+export { assetVersion, assetID };

package/index.js

@@ -1,2 +1,3 @@
 import * as assetVersion from "./assetVersion.json";
-export { assetVersion };
+import * as assetID from "./assetID.json";
+export { assetVersion, assetID };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bc-data",
-  "version": "102.0.0",
+  "version": "102.0.1",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/bananarama92/BC-stubs.git"
@@ -11,7 +11,8 @@
   "files": [
     "index.js",
     "index.d.ts",
-    "assetVersion.json"
+    "assetVersion.json",
+    "assetID.json"
   ],
   "description": "Miscellaneous data extracted from BC",
   "bugs": {
@@ -19,8 +20,8 @@
   },
   "homepage": "https://github.com/bananarama92/BC-stubs/tree/main/bc_data#readme",
   "devDependencies": {
-    "typescript": "^5.2.2",
-    "@types/node": "^20.11.2",
+    "typescript": "^5.4.4",
+    "@types/node": "^20.12.4",
     "minimist": "^1.2.8",
     "@types/minimist": "^1.2.5"
   }