ropegeo-common 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,31 @@
+# ropegeo-common
+
+Shared types and utilities for [RopeGeo](https://github.com/yurst3/RopeGeo) and [WebScraper](https://github.com/yurst3/WebScraper). Published to npm as [`ropegeo-common`](https://www.npmjs.com/package/ropegeo-common) so both projects can depend on a single set of types instead of duplicating code.
+
+## What’s in this package
+
+- **Page preview types** – `PagePreview`, `Difficulty`, and related enums used by the route preview API (e.g. GET /route/{routeId}/preview).
+- **Page data source** – `PageDataSource` enum (e.g. Ropewiki) used when linking routes to pages.
+
+## Usage
+
+```bash
+npm install ropegeo-common
+```
+
+```ts
+import {
+  PagePreview,
+  PageDataSource,
+  Difficulty,
+  DifficultyTechnical,
+  DifficultyWater,
+  DifficultyTime,
+  DifficultyRisk,
+} from 'ropegeo-common';
+```
+
+## Related repos
+
+- **[RopeGeo](https://github.com/yurst3/RopeGeo)** – Expo app for canyoneering maps and route data.
+- **[WebScraper](https://github.com/yurst3/WebScraper)** – Lambdas and jobs that scrape canyoneering sites (e.g. Ropewiki), parse data, and store it for the API.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { PageDataSource } from './types/pageDataSource';
+export { Difficulty, DifficultyRisk, DifficultyTechnical, DifficultyTime, DifficultyWater, GetRopewikiPagePreviewRow, PagePreview, } from './types/api/getRoutePreview/pagePreview';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EACH,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,yBAAyB,EACzB,WAAW,GACd,MAAM,yCAAyC,CAAC"}

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PagePreview = exports.DifficultyWater = exports.DifficultyTime = exports.DifficultyTechnical = exports.DifficultyRisk = exports.Difficulty = exports.PageDataSource = void 0;
+var pageDataSource_1 = require("./types/pageDataSource");
+Object.defineProperty(exports, "PageDataSource", { enumerable: true, get: function () { return pageDataSource_1.PageDataSource; } });
+var pagePreview_1 = require("./types/api/getRoutePreview/pagePreview");
+Object.defineProperty(exports, "Difficulty", { enumerable: true, get: function () { return pagePreview_1.Difficulty; } });
+Object.defineProperty(exports, "DifficultyRisk", { enumerable: true, get: function () { return pagePreview_1.DifficultyRisk; } });
+Object.defineProperty(exports, "DifficultyTechnical", { enumerable: true, get: function () { return pagePreview_1.DifficultyTechnical; } });
+Object.defineProperty(exports, "DifficultyTime", { enumerable: true, get: function () { return pagePreview_1.DifficultyTime; } });
+Object.defineProperty(exports, "DifficultyWater", { enumerable: true, get: function () { return pagePreview_1.DifficultyWater; } });
+Object.defineProperty(exports, "PagePreview", { enumerable: true, get: function () { return pagePreview_1.PagePreview; } });

package/dist/types/api/getRoutePreview/pagePreview.d.ts

@@ -0,0 +1,103 @@
+import { PageDataSource } from '../../pageDataSource';
+/**
+ * Row shape returned by the getRopewikiPagePreview query.
+ * Used when building a PagePreview from Ropewiki data via PagePreview.fromDbRow.
+ */
+export interface GetRopewikiPagePreviewRow {
+    pageId: string;
+    title: string;
+    quality: number | null;
+    userVotes: number | null;
+    technicalRating: string | null;
+    timeRating: string | null;
+    waterRating: string | null;
+    riskRating: string | null;
+    regionId: string;
+    regionName: string;
+    bannerFileUrl: string | null;
+    url: string | null;
+}
+/** Technical difficulty: 1–4 */
+export declare enum DifficultyTechnical {
+    One = "1",
+    Two = "2",
+    Three = "3",
+    Four = "4"
+}
+/** Water difficulty: A, B, C, or C1–C4 */
+export declare enum DifficultyWater {
+    A = "A",
+    B = "B",
+    C = "C",
+    C1 = "C1",
+    C2 = "C2",
+    C3 = "C3",
+    C4 = "C4"
+}
+/** Time difficulty: I–VI (Roman numerals) */
+export declare enum DifficultyTime {
+    I = "I",
+    II = "II",
+    III = "III",
+    IV = "IV",
+    V = "V",
+    VI = "VI"
+}
+/** Risk rating: G, PG, PG13, R, X, XX */
+export declare enum DifficultyRisk {
+    G = "G",
+    PG = "PG",
+    PG13 = "PG13",
+    R = "R",
+    X = "X",
+    XX = "XX"
+}
+/**
+ * Difficulty ratings for a page (e.g. Ropewiki technical, water, time, risk).
+ * Each property is nullable; the object is always present on PagePreview.
+ * Throws if a non-empty rating string is not one of the allowed enum values.
+ */
+export declare class Difficulty {
+    technical: DifficultyTechnical | null;
+    water: DifficultyWater | null;
+    time: DifficultyTime | null;
+    risk: DifficultyRisk | null;
+    constructor(technicalRating: string | null | undefined, waterRating: string | null | undefined, timeRating: string | null | undefined, riskRating: string | null | undefined);
+    private static parseDifficultyField;
+}
+/**
+ * Preview of a page linked to a route (e.g. Ropewiki page).
+ * Used by GET /route/{routeId}/preview.
+ */
+export declare class PagePreview {
+    /** Page identifier (e.g. RopewikiPage id) */
+    id: string;
+    /** Source of the page (e.g. ropewiki) */
+    source: PageDataSource;
+    /** Banner image URL (e.g. first non–beta-section image for Ropewiki) */
+    imageUrl: string | null;
+    /** Numeric rating (e.g. quality for Ropewiki) */
+    rating: number | null;
+    /** Number of votes (e.g. userVotes for Ropewiki) */
+    ratingCount: number | null;
+    /** Display title */
+    title: string;
+    /** Region names (not ids) */
+    regions: string[];
+    /** Difficulty ratings (technical, water, time, risk); always present. risk is set to effective risk when built via fromDbRow. */
+    difficulty: Difficulty;
+    /** Map data id for the page route, or null if none */
+    mapData: string | null;
+    /** External link to the page (e.g. Ropewiki page URL) */
+    externalLink: string | null;
+    constructor(id: string, source: PageDataSource, imageUrl: string | null, rating: number | null, ratingCount: number | null, title: string, regions: string[], difficulty: Difficulty, mapData: string | null, externalLink: string | null);
+    /**
+     * Builds a PagePreview from a getRopewikiPagePreview query row.
+     * Sets difficulty.risk to the effective risk (derived from technical when risk is not set).
+     */
+    static fromDbRow(row: GetRopewikiPagePreviewRow, mapData: string | null, regions?: string[]): PagePreview;
+    private static readonly RISK_ORDER;
+    private static getDefaultRisk;
+    private static getEffectiveRisk;
+}
+//# sourceMappingURL=pagePreview.d.ts.map

package/dist/types/api/getRoutePreview/pagePreview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagePreview.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRoutePreview/pagePreview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,gCAAgC;AAChC,oBAAY,mBAAmB;IAC3B,GAAG,MAAM;IACT,GAAG,MAAM;IACT,KAAK,MAAM;IACX,IAAI,MAAM;CACb;AAED,0CAA0C;AAC1C,oBAAY,eAAe;IACvB,CAAC,MAAM;IACP,CAAC,MAAM;IACP,CAAC,MAAM;IACP,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;CACZ;AAED,6CAA6C;AAC7C,oBAAY,cAAc;IACtB,CAAC,MAAM;IACP,EAAE,OAAO;IACT,GAAG,QAAQ;IACX,EAAE,OAAO;IACT,CAAC,MAAM;IACP,EAAE,OAAO;CACZ;AAED,yCAAyC;AACzC,oBAAY,cAAc;IACtB,CAAC,MAAM;IACP,EAAE,OAAO;IACT,IAAI,SAAS;IACb,CAAC,MAAM;IACP,CAAC,MAAM;IACP,EAAE,OAAO;CACZ;AAED;;;;GAIG;AACH,qBAAa,UAAU;IACnB,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACtC,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9B,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;gBAGxB,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC1C,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACtC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACrC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAwBzC,OAAO,CAAC,MAAM,CAAC,oBAAoB;CActC;AAED;;;GAGG;AACH,qBAAa,WAAW;IACpB,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,MAAM,EAAE,cAAc,CAAC;IACvB,wEAAwE;IACxE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,iDAAiD;IACjD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,oDAAoD;IACpD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,iIAAiI;IACjI,UAAU,EAAE,UAAU,CAAC;IACvB,sDAAsD;IACtD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,yDAAyD;IACzD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;gBAGxB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,cAAc,EACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EAAE,EACjB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,YAAY,EAAE,MAAM,GAAG,IAAI;IAc/B;;;OAGG;IACH,MAAM,CAAC,SAAS,CACZ,GAAG,EAAE,yBAAyB,EAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,OAAO,CAAC,EAAE,MAAM,EAAE,GACnB,WAAW;IAsBd,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAOhC;IAEF,OAAO,CAAC,MAAM,CAAC,cAAc;IAS7B,OAAO,CAAC,MAAM,CAAC,gBAAgB;CAUlC"}

package/dist/types/api/getRoutePreview/pagePreview.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PagePreview = exports.Difficulty = exports.DifficultyRisk = exports.DifficultyTime = exports.DifficultyWater = exports.DifficultyTechnical = void 0;
+const pageDataSource_1 = require("../../pageDataSource");
+/** Technical difficulty: 1–4 */
+var DifficultyTechnical;
+(function (DifficultyTechnical) {
+    DifficultyTechnical["One"] = "1";
+    DifficultyTechnical["Two"] = "2";
+    DifficultyTechnical["Three"] = "3";
+    DifficultyTechnical["Four"] = "4";
+})(DifficultyTechnical || (exports.DifficultyTechnical = DifficultyTechnical = {}));
+/** Water difficulty: A, B, C, or C1–C4 */
+var DifficultyWater;
+(function (DifficultyWater) {
+    DifficultyWater["A"] = "A";
+    DifficultyWater["B"] = "B";
+    DifficultyWater["C"] = "C";
+    DifficultyWater["C1"] = "C1";
+    DifficultyWater["C2"] = "C2";
+    DifficultyWater["C3"] = "C3";
+    DifficultyWater["C4"] = "C4";
+})(DifficultyWater || (exports.DifficultyWater = DifficultyWater = {}));
+/** Time difficulty: I–VI (Roman numerals) */
+var DifficultyTime;
+(function (DifficultyTime) {
+    DifficultyTime["I"] = "I";
+    DifficultyTime["II"] = "II";
+    DifficultyTime["III"] = "III";
+    DifficultyTime["IV"] = "IV";
+    DifficultyTime["V"] = "V";
+    DifficultyTime["VI"] = "VI";
+})(DifficultyTime || (exports.DifficultyTime = DifficultyTime = {}));
+/** Risk rating: G, PG, PG13, R, X, XX */
+var DifficultyRisk;
+(function (DifficultyRisk) {
+    DifficultyRisk["G"] = "G";
+    DifficultyRisk["PG"] = "PG";
+    DifficultyRisk["PG13"] = "PG13";
+    DifficultyRisk["R"] = "R";
+    DifficultyRisk["X"] = "X";
+    DifficultyRisk["XX"] = "XX";
+})(DifficultyRisk || (exports.DifficultyRisk = DifficultyRisk = {}));
+/**
+ * Difficulty ratings for a page (e.g. Ropewiki technical, water, time, risk).
+ * Each property is nullable; the object is always present on PagePreview.
+ * Throws if a non-empty rating string is not one of the allowed enum values.
+ */
+class Difficulty {
+    constructor(technicalRating, waterRating, timeRating, riskRating) {
+        this.technical = Difficulty.parseDifficultyField(technicalRating, Object.values(DifficultyTechnical), 'technical');
+        this.water = Difficulty.parseDifficultyField(waterRating, Object.values(DifficultyWater), 'water');
+        this.time = Difficulty.parseDifficultyField(timeRating, Object.values(DifficultyTime), 'time');
+        this.risk = Difficulty.parseDifficultyField(riskRating, Object.values(DifficultyRisk), 'risk');
+    }
+    static parseDifficultyField(value, allowed, fieldName) {
+        if (value == null || value === '')
+            return null;
+        const trimmed = value.trim();
+        if (!allowed.includes(trimmed)) {
+            throw new Error(`Invalid difficulty ${fieldName}: "${value}" is not one of [${allowed.join(', ')}]`);
+        }
+        return trimmed;
+    }
+}
+exports.Difficulty = Difficulty;
+/**
+ * Preview of a page linked to a route (e.g. Ropewiki page).
+ * Used by GET /route/{routeId}/preview.
+ */
+class PagePreview {
+    constructor(id, source, imageUrl, rating, ratingCount, title, regions, difficulty, mapData, externalLink) {
+        this.id = id;
+        this.source = source;
+        this.imageUrl = imageUrl;
+        this.rating = rating;
+        this.ratingCount = ratingCount;
+        this.title = title;
+        this.regions = regions;
+        this.difficulty = difficulty;
+        this.mapData = mapData;
+        this.externalLink = externalLink;
+    }
+    /**
+     * Builds a PagePreview from a getRopewikiPagePreview query row.
+     * Sets difficulty.risk to the effective risk (derived from technical when risk is not set).
+     */
+    static fromDbRow(row, mapData, regions) {
+        const difficulty = new Difficulty(row.technicalRating, row.waterRating, row.timeRating, row.riskRating);
+        difficulty.risk = PagePreview.getEffectiveRisk(difficulty);
+        return new PagePreview(row.pageId, pageDataSource_1.PageDataSource.Ropewiki, row.bannerFileUrl ?? null, row.quality != null ? Number(row.quality) : null, row.userVotes ?? null, row.title, regions ?? [row.regionName], difficulty, mapData, row.url ?? null);
+    }
+    static getDefaultRisk(difficulty) {
+        if (difficulty.technical === DifficultyTechnical.One)
+            return DifficultyRisk.G;
+        if (difficulty.technical === DifficultyTechnical.Two)
+            return DifficultyRisk.PG;
+        if (difficulty.technical === DifficultyTechnical.Three || difficulty.technical === DifficultyTechnical.Four) {
+            return DifficultyRisk.PG13;
+        }
+        return null;
+    }
+    static getEffectiveRisk(difficulty) {
+        const defaultRisk = PagePreview.getDefaultRisk(difficulty);
+        if (difficulty.risk != null) {
+            return defaultRisk != null &&
+                PagePreview.RISK_ORDER[difficulty.risk] < PagePreview.RISK_ORDER[defaultRisk]
+                ? defaultRisk
+                : difficulty.risk;
+        }
+        return defaultRisk;
+    }
+}
+exports.PagePreview = PagePreview;
+PagePreview.RISK_ORDER = {
+    [DifficultyRisk.G]: 0,
+    [DifficultyRisk.PG]: 1,
+    [DifficultyRisk.PG13]: 2,
+    [DifficultyRisk.R]: 3,
+    [DifficultyRisk.X]: 4,
+    [DifficultyRisk.XX]: 5,
+};

package/dist/types/pageDataSource.d.ts

@@ -0,0 +1,4 @@
+export declare enum PageDataSource {
+    Ropewiki = "ropewiki"
+}
+//# sourceMappingURL=pageDataSource.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pageDataSource.d.ts","sourceRoot":"","sources":["../../src/types/pageDataSource.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACtB,QAAQ,aAAa;CACxB"}

package/dist/types/pageDataSource.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageDataSource = void 0;
+var PageDataSource;
+(function (PageDataSource) {
+    PageDataSource["Ropewiki"] = "ropewiki";
+})(PageDataSource || (exports.PageDataSource = PageDataSource = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ropegeo-common",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Shared types and utilities for RopeGeo and WebScraper",
   "license": "ISC",
   "repository": {