zwift-data 1.6.0 → 1.9.0

package/lib/{types.d.ts → types/types.d.ts}

@@ -1,259 +1,263 @@
-export interface World {
-    /**
-     * Zwift internal world/map id
-     */
-    id: number;
-    /**
-     * Name of the world/map
-     */
-    name: string;
-    /**
-     * Unique url-safe string to reference the world
-     */
-    slug: WorldSlug;
-    /**
-     * Bounds of the world
-     */
-    bounds: [
-        [
-            latitude: number,
-            longitude: number
-        ],
-        [
-            latitude: number,
-            longitude: number
-        ]
-    ];
-}
-export declare type WorldSlug = "bologna" | "crit-city" | "france" | "innsbruck" | "london" | "paris" | "makuri-islands" | "new-york" | "richmond" | "watopia" | "yorkshire";
-export interface Route {
-    /**
-     * Zwift internal route id. Optional as the id is not present for all routes
-     */
-    id?: number;
-    /**
-     * The world the route is in
-     */
-    world: WorldSlug;
-    /**
-     * Name of the route
-     */
-    name: string;
-    /**
-     * Unique url-safe string to reference the route
-     */
-    slug: string;
-    /**
-     * Distance of the route in kilometers
-     */
-    distance: number;
-    /**
-     * Total elevation gain on the route in meters
-     */
-    elevation: number;
-    /**
-     * Distance of the lead in
-     */
-    leadInDistance?: number;
-    /**
-     * Elevation gain of the lead in
-     */
-    leadInElevation?: number;
-    /**
-     * Distance of the lead in during free ride or meetups
-     */
-    leadInDistanceFreeRide?: number;
-    /**
-     * Elevation gain of the lead in during free ride or meetups
-     */
-    leadInElevationFreeRide?: number;
-    /**
-     * Distance of the lead in during meetups
-     */
-    leadInDistanceMeetups?: number;
-    /**
-     * Elevation gain of the lead in during meetups
-     */
-    leadInElevationInMeetups?: number;
-    /**
-     * Experience points you gain when finishing the route
-     */
-    experience?: number;
-    /**
-     * Official segments on the route sorted by appearance. Segments are listed multiple times if they are ridden multiple times.
-     */
-    segments: string[];
-    /**
-     * Id of the corresponding strava segment
-     */
-    stravaSegmentId?: number;
-    /**
-     * Url of the corresponding strava segment
-     */
-    stravaSegmentUrl?: string;
-    /**
-     * Url of the Zwift insiders page
-     */
-    zwiftInsiderUrl?: string;
-    /**
-     * Url of the route on What's on Zwift
-     */
-    whatsOnZwiftUrl?: string;
-    /**
-     * Types of sport that can complete this route
-     */
-    sports: Sport[];
-    /**
-     * `true`, if the route can not be selected in the start screen and can only be ridden in events
-     */
-    eventOnly: boolean;
-    /**
-     * `true`, if the route can only be ridden from a certain level
-     */
-    levelLocked: boolean;
-    /**
-     * `true`, if the route is a lap
-     */
-    lap: boolean;
-    /**
-     * `true`, if the route supports time trial events
-     */
-    supportsTT: boolean;
-    /**
-     * `true`, if the route is available for meetups
-     */
-    supportsMeetups: boolean;
-}
-export declare type Sport = "running" | "cycling";
-export interface Segment {
-    /**
-     * World the segment is in
-     */
-    world: WorldSlug;
-    /**
-     * Name of the segment
-     */
-    name: string;
-    /**
-     * Unique url-safe string to reference the segment
-     */
-    slug: string;
-    /**
-     * Distance of the segment
-     */
-    distance: number;
-    /**
-     * Total elevation gain of the segment
-     */
-    elevation?: number;
-    /**
-     * Average include of the segment. `0` if the segment is a lap.
-     */
-    avgIncline?: number;
-    /**
-     * Id of the corresponding strava segment
-     */
-    stravaSegmentId?: number;
-    /**
-     * Url of the corresponding strava segment
-     */
-    stravaSegmentUrl?: string;
-    /**
-     * Type of the segment
-     */
-    type: SegmentType;
-    /**
-     * Url of the route on What's on Zwift
-     */
-    whatsOnZwiftUrl?: string;
-    /**
-     * Rating of a climb segment. Only available if `type=climb`.
-     */
-    climbType?: "HC" | "4" | "3" | "2" | "1";
-}
-export declare type SegmentType = "sprint" | "climb" | "segment";
-export interface BikeFrame {
-    id: number;
-    name: string;
-    modelYear?: number;
-    isTT: boolean;
-}
-export interface Jersey {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface TrainingPlan {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface RunShirt {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface RunShort {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface RunShoe {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface BikeShoe {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface BikeFrontWheel {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface BikeRearWheel {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface PaintJob {
-    id: number;
-    name: string;
-}
-export interface Sock {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface Glass {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface Headgear {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface Achievements {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface Challenge {
-    id: number;
-    name: string;
-    imageName: string;
-}
-export interface NotableMomentType {
-    id: number;
-    name: string;
-    priority: number;
-    imageName: string;
-}
-export interface UnlockableCategory {
-    id: number;
-    name: string;
-}
+export interface World {
+    /**
+     * Zwift internal world/map id
+     */
+    id: number;
+    /**
+     * Name of the world/map
+     */
+    name: string;
+    /**
+     * Unique url-safe string to reference the world
+     */
+    slug: WorldSlug;
+    /**
+     * Bounds of the world
+     */
+    bounds: [
+        [
+            latitude: number,
+            longitude: number
+        ],
+        [
+            latitude: number,
+            longitude: number
+        ]
+    ];
+    /**
+     * URL to the image of the world
+     */
+    imageUrl: string;
+}
+export declare type WorldSlug = "bologna" | "crit-city" | "france" | "innsbruck" | "london" | "paris" | "makuri-islands" | "new-york" | "richmond" | "watopia" | "yorkshire";
+export interface Route {
+    /**
+     * Zwift internal route id. Optional as the id is not present for all routes
+     */
+    id?: number;
+    /**
+     * The world the route is in
+     */
+    world: WorldSlug;
+    /**
+     * Name of the route
+     */
+    name: string;
+    /**
+     * Unique url-safe string to reference the route
+     */
+    slug: string;
+    /**
+     * Distance of the route in kilometers
+     */
+    distance: number;
+    /**
+     * Total elevation gain on the route in meters
+     */
+    elevation: number;
+    /**
+     * Distance of the lead in
+     */
+    leadInDistance?: number;
+    /**
+     * Elevation gain of the lead in
+     */
+    leadInElevation?: number;
+    /**
+     * Distance of the lead in during free ride or meetups
+     */
+    leadInDistanceFreeRide?: number;
+    /**
+     * Elevation gain of the lead in during free ride or meetups
+     */
+    leadInElevationFreeRide?: number;
+    /**
+     * Distance of the lead in during meetups
+     */
+    leadInDistanceMeetups?: number;
+    /**
+     * Elevation gain of the lead in during meetups
+     */
+    leadInElevationInMeetups?: number;
+    /**
+     * Experience points you gain when finishing the route
+     */
+    experience?: number;
+    /**
+     * Official segments on the route sorted by appearance. Segments are listed multiple times if they are ridden multiple times.
+     */
+    segments: ReadonlyArray<string>;
+    /**
+     * Id of the corresponding strava segment
+     */
+    stravaSegmentId?: number;
+    /**
+     * Url of the corresponding strava segment
+     */
+    stravaSegmentUrl?: string;
+    /**
+     * Url of the Zwift insiders page
+     */
+    zwiftInsiderUrl?: string;
+    /**
+     * Url of the route on What's on Zwift
+     */
+    whatsOnZwiftUrl?: string;
+    /**
+     * Types of sport that can complete this route
+     */
+    sports: ReadonlyArray<Sport>;
+    /**
+     * `true`, if the route can not be selected in the start screen and can only be ridden in events
+     */
+    eventOnly: boolean;
+    /**
+     * `true`, if the route can only be ridden from a certain level
+     */
+    levelLocked: boolean;
+    /**
+     * `true`, if the route is a lap
+     */
+    lap: boolean;
+    /**
+     * `true`, if the route supports time trial events
+     */
+    supportsTT: boolean;
+    /**
+     * `true`, if the route is available for meetups
+     */
+    supportsMeetups: boolean;
+}
+export declare type Sport = "running" | "cycling";
+export interface Segment {
+    /**
+     * World the segment is in
+     */
+    world: WorldSlug;
+    /**
+     * Name of the segment
+     */
+    name: string;
+    /**
+     * Unique url-safe string to reference the segment
+     */
+    slug: string;
+    /**
+     * Distance of the segment
+     */
+    distance: number;
+    /**
+     * Total elevation gain of the segment
+     */
+    elevation?: number;
+    /**
+     * Average include of the segment. `0` if the segment is a lap.
+     */
+    avgIncline?: number;
+    /**
+     * Id of the corresponding strava segment
+     */
+    stravaSegmentId?: number;
+    /**
+     * Url of the corresponding strava segment
+     */
+    stravaSegmentUrl?: string;
+    /**
+     * Type of the segment
+     */
+    type: SegmentType;
+    /**
+     * Url of the route on What's on Zwift
+     */
+    whatsOnZwiftUrl?: string;
+    /**
+     * Rating of a climb segment. Only available if `type=climb`.
+     */
+    climbType?: "HC" | "4" | "3" | "2" | "1";
+}
+export declare type SegmentType = "sprint" | "climb" | "segment";
+export interface BikeFrame {
+    id: number;
+    name: string;
+    modelYear?: number;
+    isTT: boolean;
+}
+export interface Jersey {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface TrainingPlan {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface RunShirt {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface RunShort {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface RunShoe {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface BikeShoe {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface BikeFrontWheel {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface BikeRearWheel {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface PaintJob {
+    id: number;
+    name: string;
+}
+export interface Sock {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface Glass {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface Headgear {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface Achievements {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface Challenge {
+    id: number;
+    name: string;
+    imageName: string;
+}
+export interface NotableMomentType {
+    id: number;
+    name: string;
+    priority: number;
+    imageName: string;
+}
+export interface UnlockableCategory {
+    id: number;
+    name: string;
+}

package/lib/types/unlockableCategories.d.ts

@@ -0,0 +1,2 @@
+import { UnlockableCategory } from "./types";
+export declare const unlockableCategories: ReadonlyArray<UnlockableCategory>;

package/lib/{worlds.d.ts → types/worlds.d.ts}

@@ -1,2 +1,2 @@
-import { World } from "./types";
-export declare const worlds: ReadonlyArray<World>;
+import { World } from "./types";
+export declare const worlds: ReadonlyArray<World>;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "zwift-data",
-  "version": "1.6.0",
+  "version": "1.9.0",
   "description": "Data about Zwift worlds, routes and segments",
-  "main": "lib/index.js",
-  "module": "lib/index.es.js",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
   "files": [
     "lib"
   ],
-  "types": "lib/index.d.ts",
   "keywords": [
     "zwift",
     "data"
@@ -27,6 +27,7 @@
   },
   "homepage": "https://github.com/andipaetzold/zwift-data#readme",
   "devDependencies": {
+    "@octokit/rest": "18.12.0",
     "@semantic-release/changelog": "5.0.1",
     "@semantic-release/git": "9.0.0",
     "@tsconfig/recommended": "1.0.1",
@@ -35,9 +36,6 @@
     "jest": "27.0.3",
     "node-fetch": "3.1.0",
     "rimraf": "3.0.2",
-    "rollup": "2.50.5",
-    "rollup-plugin-terser": "7.0.2",
-    "rollup-plugin-typescript2": "0.30.0",
     "semantic-release": "17.4.3",
     "simple-git": "2.47.0",
     "ts-jest": "27.0.2",
@@ -46,13 +44,13 @@
   },
   "scripts": {
     "prepublishOnly": "npm run build",
-    "clean": "rimraf lib",
-    "build": "npm run clean && rollup -c",
+    "build": "rimraf lib && npm run build:cjs && npm run build:esm",
+    "build:cjs": "rimraf lib/cjs && tsc --module commonjs --outDir lib/cjs",
+    "build:esm": "rimraf lib/esm && tsc --module ES2015 --outDir lib/esm",
     "build-docs": "rimraf docs && typedoc src/index.ts",
-    "watch": "npm run clean && rollup -cw",
     "test": "jest",
     "semantic-release": "semantic-release",
     "update-data": "node ./scripts/update-data.mjs",
-    "push-changes": "node ./scripts/push-changes.mjs"
+    "prepare-pr": "node ./scripts/prepare-pr.mjs"
   }
 }

package/lib/achievements.d.ts

@@ -1,2 +0,0 @@
-import { Achievements } from "./types";
-export declare const achievements: Achievements[];

package/lib/bikeFrames.d.ts

@@ -1,2 +0,0 @@
-import { BikeFrame } from "./types";
-export declare const bikeFrames: BikeFrame[];

package/lib/bikeFrontWheels.d.ts

@@ -1,2 +0,0 @@
-import { BikeFrontWheel } from "./types";
-export declare const bikeFrontWheels: BikeFrontWheel[];

package/lib/bikeRearWheels.d.ts

@@ -1,2 +0,0 @@
-import { BikeRearWheel } from "./types";
-export declare const bikeRearWheels: BikeRearWheel[];

package/lib/bikeShoes.d.ts

@@ -1,2 +0,0 @@
-import { BikeShoe } from "./types";
-export declare const bikeShoes: BikeShoe[];

package/lib/challenges.d.ts

@@ -1,2 +0,0 @@
-import { Challenge } from "./types";
-export declare const challenges: Challenge[];

package/lib/glasses.d.ts

@@ -1,2 +0,0 @@
-import { Glass } from "./types";
-export declare const glasses: Glass[];

package/lib/headgears.d.ts

@@ -1,2 +0,0 @@
-import { Headgear } from "./types";
-export declare const headgears: Headgear[];