@skullandbonestools/snbdata 5.0.0 → 5.0.1

package/README.md

@@ -2,40 +2,44 @@
 
 Welcome to the inofficial data repository for the Skull and Bones game by Ubisoft.
 
-This repository hosts data for the several elements in the game like **Materials**, **Items**, **Cosmetics** and more in a JSON format.
+This repository hosts data for the several elements in the game like **Materials**, **Items**, **Cosmetics** and more in a JSON format and provides a npm package to access the data in typescript and javascript.
 
 As the move to a public repository (see [History](#history)) includes several changes the following things are planned:
-- [ ] Extract events, locations, contracts into own data files
-  - Those are currently only stored in the translation files
+- [ ] Extract data stored in translation files into own data files
+  - [x] Sets
+  - [x] Events
+  - [x] World Events
+  - [ ] Locations
 - [ ] Crowdin workflow integration
-- [ ] npm packages with generated types for the different data (events, cosmetics, items, ...)
+- [x] npm packages with generated types for the different data (events, cosmetics, items, ...)
 
 For each update of the game a new release is provided containing the updated files which can be found under the [Releases](https://github.com/SkullAndBonesTools/SkullAndBonesData/releases) section.
 
-The version number of the release is tied to the Skull and Bones version the data represents and put together like so:\
+The version schema of the release is tied to the Skull and Bones version the data represents and put together like so:\
 **Example**: snbdata@5.2.4
 ```
-5 - Season
+5 - Season (a year has 4 seasons, so season 5 = Y2S1)
 2 - Patch Level
-4 - Bug Fixes / Minor Changes
+4 - Bug Fixes / Minor Changes (this one is related to releases of this repository)
 
-This represent the SnB game version Y2S1.2.X
+This represents the SnB game version Y2S1.2.X
 ```
 
-*Because the first published version of the package was for Y1S2, so season 5 of Skull and Bones, the first release was the 5.0.0.*
+*Because the first published version of the package was for Y2S1, so season 5 of Skull and Bones, the first release was the 5.0.0.*
 
 ## How to Use
 ### Raw Data
-You can find the raw data files as JSON in the [data](https://github.com/SkullAndBonesTools/SkullAndBonesData/tree/master/data) folder for the different types.
+You can find the raw data files as JSON in the [data](https://github.com/SkullAndBonesTools/SkullAndBonesData/tree/master/data) folder.
 
 ### Package
-Based on the raw data is the `snbdata` npm package available, featuring access to the data as typescript objects with type safety and autocompletion.
+Based on the raw data is the `snbdata` npm package available, featuring access to the data as objects with type safety and autocompletion.
 
 #### Guide
-**Install the Package**
-`TODO`
+**Install the Package**\
+~~`npm i @skullandbonestools/snbdata`~~`  // Package will be available in the coming days`
 
 **Access the Data**
+
 Getting the season of the `Barque` (TS):
 ```typescript
 import { Ships } from "@skullandbonestools/snbdata";
@@ -49,6 +53,7 @@ Getting the required materials for `Orca Intricate Apparatus` (JS):
 ```javascript
 import { Materials } from "@skullandbonestools/snbdata";
 
+// Only check required materials not their amount
 Materials.orcaIntricateApparatus.required.keys().forEach(material => {
   console.log("Id: %s - Required: %s", material.id, material.required?.keys().map((m) => m.id).toArray().join(", "));
 });

package/dist/daos/contracts.d.ts

@@ -0,0 +1,11 @@
+import contractsData from '../../data/contracts.json';
+export declare class Contract {
+    readonly id: string;
+    constructor(id: string);
+    static loadContracts(): Record<string, Contract>;
+}
+export type Contracts = {
+    [K in keyof typeof contractsData]: Contract;
+};
+export declare const Contracts: Contracts;
+//# sourceMappingURL=contracts.d.ts.map

package/dist/daos/contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../src/daos/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,2BAA2B,CAAC;AAEtD,qBAAa,QAAQ;aAEG,EAAE,EAAE,MAAM;gBAAV,EAAE,EAAE,MAAM;WAGhB,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;CAS1D;AAED,MAAM,MAAM,SAAS,GAAG;KACnB,CAAC,IAAI,MAAM,OAAO,aAAa,GAAG,QAAQ;CAC9C,CAAC;AAEF,eAAO,MAAM,SAAS,EAA+B,SAAS,CAAC"}

package/dist/daos/contracts.js

@@ -0,0 +1,15 @@
+import contractsData from '../../data/contracts.json';
+export class Contract {
+    constructor(id) {
+        this.id = id;
+    }
+    static loadContracts() {
+        const contracts = {};
+        for (const [key, value] of Object.entries(contractsData)) {
+            contracts[key] = new Contract(value.id);
+        }
+        return contracts;
+    }
+}
+export const Contracts = Contract.loadContracts();
+//# sourceMappingURL=contracts.js.map

package/dist/daos/contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../src/daos/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,2BAA2B,CAAC;AAEtD,MAAM,OAAO,QAAQ;IACjB,YACoB,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IAC3B,CAAC;IAEG,MAAM,CAAC,aAAa;QACvB,MAAM,SAAS,GAA6B,EAAE,CAAC;QAC/C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YACvD,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,QAAQ,CACzB,KAAK,CAAC,EAAE,CACX,CAAC;QACN,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AAMD,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,EAAe,CAAC"}

package/dist/daos/events.d.ts

@@ -0,0 +1,13 @@
+import eventsData from '../../data/events.json';
+import { Season } from './seasons';
+export declare class Event {
+    readonly id: string;
+    readonly seasons: Season[];
+    constructor(id: string, seasons: Season[]);
+    static loadEvents(): Record<string, Event>;
+}
+export type Events = {
+    [K in keyof typeof eventsData]: Event;
+};
+export declare const Events: Events;
+//# sourceMappingURL=events.d.ts.map

package/dist/daos/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/daos/events.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAW,MAAM,WAAW,CAAC;AAE5C,qBAAa,KAAK;aAEM,EAAE,EAAE,MAAM;aACV,OAAO,EAAE,MAAM,EAAE;gBADjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EAAE;WAGvB,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;CAcpD;AAED,MAAM,MAAM,MAAM,GAAG;KAChB,CAAC,IAAI,MAAM,OAAO,UAAU,GAAG,KAAK;CACxC,CAAC;AAEF,eAAO,MAAM,MAAM,EAAyB,MAAM,CAAC"}

package/dist/daos/events.js

@@ -0,0 +1,21 @@
+import eventsData from '../../data/events.json';
+import { Seasons } from './seasons';
+export class Event {
+    constructor(id, seasons) {
+        this.id = id;
+        this.seasons = seasons;
+    }
+    static loadEvents() {
+        const events = {};
+        for (const [key, value] of Object.entries(eventsData)) {
+            const seasons = value.seasons.map((_season) => {
+                const season = _season;
+                return Seasons[season];
+            });
+            events[key] = new Event(value.id, seasons);
+        }
+        return events;
+    }
+}
+export const Events = Event.loadEvents();
+//# sourceMappingURL=events.js.map

package/dist/daos/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/daos/events.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAU,OAAO,EAAE,MAAM,WAAW,CAAC;AAE5C,MAAM,OAAO,KAAK;IACd,YACoB,EAAU,EACV,OAAiB;QADjB,OAAE,GAAF,EAAE,CAAQ;QACV,YAAO,GAAP,OAAO,CAAU;IAClC,CAAC;IAEG,MAAM,CAAC,UAAU;QACpB,MAAM,MAAM,GAA0B,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,MAAM,OAAO,GAAa,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAe,EAAE,EAAE;gBAC5D,MAAM,MAAM,GAAG,OAA+B,CAAC;gBAC/C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,KAAK,CACnB,KAAK,CAAC,EAAE,EACR,OAAO,CACV,CAAC;QACN,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAMD,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,EAAY,CAAC"}

package/dist/daos/sets.d.ts

@@ -1,8 +1,13 @@
+import setsData from '../../data/sets.json';
+import { SetType } from '../types/SetProperties';
 export declare class Set {
     readonly id: string;
-    constructor(id: string);
-    static fromRawData(rawData: any): Set;
+    readonly type: SetType;
+    constructor(id: string, type: SetType);
     static loadSets(): Record<string, Set>;
 }
-export declare const Sets: Record<string, Set>;
+export type Sets = {
+    [K in keyof typeof setsData]: Set;
+};
+export declare const Sets: Sets;
 //# sourceMappingURL=sets.d.ts.map

package/dist/daos/sets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sets.d.ts","sourceRoot":"","sources":["../../src/daos/sets.ts"],"names":[],"mappings":"AAGA,qBAAa,GAAG;aAEQ,EAAE,EAAE,MAAM;gBAAV,EAAE,EAAE,MAAM;WAGhB,WAAW,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;WAM9B,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAUhD;AAID,eAAO,MAAM,IAAI,qBAAiB,CAAC"}
+{"version":3,"file":"sets.d.ts","sourceRoot":"","sources":["../../src/daos/sets.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,qBAAa,GAAG;aAEQ,EAAE,EAAE,MAAM;aACV,IAAI,EAAE,OAAO;gBADb,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,OAAO;WAGnB,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAUhD;AAED,MAAM,MAAM,IAAI,GAAG;KACd,CAAC,IAAI,MAAM,OAAO,QAAQ,GAAG,GAAG;CACpC,CAAC;AAEF,eAAO,MAAM,IAAI,EAAqB,IAAI,CAAC"}

package/dist/daos/sets.js

@@ -1,23 +1,16 @@
-import cosmeticsData from '../../data/cosmetics.json';
+import setsData from '../../data/sets.json';
 export class Set {
-    constructor(id) {
+    constructor(id, type) {
         this.id = id;
-    }
-    static fromRawData(rawData) {
-        return new Set(rawData.set);
+        this.type = type;
     }
     static loadSets() {
         const sets = {};
-        for (const [key, value] of Object.entries(cosmeticsData)) {
-            const cosmetic = value;
-            const set = cosmetic.set;
-            if (!set || sets[set])
-                continue;
-            sets[set] = Set.fromRawData(value);
+        for (const [key, value] of Object.entries(setsData)) {
+            sets[key] = new Set(value.id, value.type);
         }
         return sets;
     }
 }
-// TODO: Add auto completion for set names
 export const Sets = Set.loadSets();
 //# sourceMappingURL=sets.js.map

package/dist/daos/sets.js.map

@@ -1 +1 @@
-{"version":3,"file":"sets.js","sourceRoot":"","sources":["../../src/daos/sets.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,2BAA2B,CAAC;AAGtD,MAAM,OAAO,GAAG;IACZ,YACoB,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IAC3B,CAAC;IAEG,MAAM,CAAC,WAAW,CAAC,OAAY;QAClC,OAAO,IAAI,GAAG,CACV,OAAO,CAAC,GAAG,CACd,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,QAAQ;QAClB,MAAM,IAAI,GAAwB,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YACvD,MAAM,QAAQ,GAAG,KAAiB,CAAC;YACnC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAyB,CAAC;YAC/C,IAAG,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC/B,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAED,0CAA0C;AAE1C,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"sets.js","sourceRoot":"","sources":["../../src/daos/sets.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAG5C,MAAM,OAAO,GAAG;IACZ,YACoB,EAAU,EACV,IAAa;QADb,OAAE,GAAF,EAAE,CAAQ;QACV,SAAI,GAAJ,IAAI,CAAS;IAC9B,CAAC;IAEG,MAAM,CAAC,QAAQ;QAClB,MAAM,IAAI,GAAwB,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CACf,KAAK,CAAC,EAAE,EACR,KAAK,CAAC,IAAe,CACxB,CAAC;QACN,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAMD,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAU,CAAC"}

package/dist/daos/worldEvents.d.ts

@@ -0,0 +1,11 @@
+import worldEventsData from '../../data/worldEvents.json';
+export declare class WorldEvent {
+    readonly id: string;
+    constructor(id: string);
+    static loadWorldEvents(): Record<string, WorldEvent>;
+}
+export type WorldEvents = {
+    [K in keyof typeof worldEventsData]: WorldEvent;
+};
+export declare const WorldEvents: WorldEvents;
+//# sourceMappingURL=worldEvents.d.ts.map

package/dist/daos/worldEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worldEvents.d.ts","sourceRoot":"","sources":["../../src/daos/worldEvents.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAE1D,qBAAa,UAAU;aAEC,EAAE,EAAE,MAAM;gBAAV,EAAE,EAAE,MAAM;WAGhB,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;CAS9D;AAED,MAAM,MAAM,WAAW,GAAG;KACrB,CAAC,IAAI,MAAM,OAAO,eAAe,GAAG,UAAU;CAClD,CAAC;AAEF,eAAO,MAAM,WAAW,EAAmC,WAAW,CAAC"}

package/dist/daos/worldEvents.js

@@ -0,0 +1,15 @@
+import worldEventsData from '../../data/worldEvents.json';
+export class WorldEvent {
+    constructor(id) {
+        this.id = id;
+    }
+    static loadWorldEvents() {
+        const worldEvents = {};
+        for (const [key, value] of Object.entries(worldEventsData)) {
+            worldEvents[key] = new WorldEvent(value.id);
+        }
+        return worldEvents;
+    }
+}
+export const WorldEvents = WorldEvent.loadWorldEvents();
+//# sourceMappingURL=worldEvents.js.map

package/dist/daos/worldEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worldEvents.js","sourceRoot":"","sources":["../../src/daos/worldEvents.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAE1D,MAAM,OAAO,UAAU;IACnB,YACoB,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IAC3B,CAAC;IAEG,MAAM,CAAC,eAAe;QACzB,MAAM,WAAW,GAA+B,EAAE,CAAC;QACnD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;YACzD,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,UAAU,CAC7B,KAAK,CAAC,EAAE,CACX,CAAC;QACN,CAAC;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ;AAMD,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC,eAAe,EAAiB,CAAC"}

package/dist/types/SetProperties.d.ts

@@ -0,0 +1,2 @@
+export type SetType = "player" | "ship";
+//# sourceMappingURL=SetProperties.d.ts.map

package/dist/types/SetProperties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SetProperties.d.ts","sourceRoot":"","sources":["../../src/types/SetProperties.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC"}

package/dist/types/SetProperties.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SetProperties.js.map

package/dist/types/SetProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SetProperties.js","sourceRoot":"","sources":["../../src/types/SetProperties.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skullandbonestools/snbdata",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Inofficial data package for the Skull and Bones game by Ubisoft.",
   "keywords": [
     "ubisoft",