ropegeo-common

Shared types and utilities for RopeGeo and WebScraper. Published to npm as 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). PagePreview includes optional permit (PermitStatus enum: Yes, No, Restricted, Closed, or null).
• Page data source – PageDataSource enum (e.g. Ropewiki) used when linking routes to pages.
• Ropewiki page view types – RopewikiPageView, RopewikiBetaSectionView, and RopewikiImageView for the getRopewikiPageView API (full Ropewiki page with beta sections and images). BetaSectionImage includes id, downloadBytes (DownloadBytes: preview/banner/full byte sizes), and page-based pagination – PaginationResults / MapDataTileKeysResults (e.g. GET /mapdata/{mapDataId}/tiles with total, page, totalBytes).
• Routes (GET /routes) – Route, RouteType, RouteGeoJsonFeature, and RoutesGeojson for the routes GeoJSON Feature Collection API. RoutesGeojson.fromRoutes(routes) builds the response shape from an array of Route.
• Search API types – SearchResults (paginated search response with results: Preview[] and nextCursor: string), RegionPreview (region search hit with id, name, parents, imageUrl, source), and PagePreview (page search hit; same type as route preview).

Usage

npm install ropegeo-common

import {
  PagePreview,
  PageDataSource,
  Difficulty,
  DifficultyTechnical,
  DifficultyWater,
  DifficultyTime,
  DifficultyRisk,
  PermitStatus,
  Route,
  RouteType,
  RoutesGeojson,
  type RopewikiPageView,
  type RopewikiBetaSectionView,
  type RopewikiImageView,
  type RegionPreview,
  type SearchResults,
  DownloadBytes,
  PaginationResults,
  MapDataTileKeysResults,
  PaginationResultType,
} from 'ropegeo-common';

Related repos

• RopeGeo – Expo app for canyoneering maps and route data.
• WebScraper – Lambdas and jobs that scrape canyoneering sites (e.g. Ropewiki), parse data, and store it for the API.