ropegeo-common 1.10.0 → 1.10.1

package/README.md

@@ -105,7 +105,7 @@ Helper tables use columns **Name**, **Description**, **Import**. Model tables ad
 | `Q_ACA_WATER` | N/A | Query key for ACA water rating list. | `import { Q_ACA_WATER } from 'ropegeo-common/models'` |
 | `Q_ACA_TIME` | N/A | Query key for ACA time rating list. | `import { Q_ACA_TIME } from 'ropegeo-common/models'` |
 | `Q_ACA_RISK` | N/A | Query key for ACA risk rating list. | `import { Q_ACA_RISK } from 'ropegeo-common/models'` |
-| `RoutesParams` | `PaginationParams` | Validated GET /routes params (region, source, route type, difficulty, `limit`, `page`). | `import { RoutesParams } from 'ropegeo-common/models'` |
+| `RoutesParams` | `PaginationParams` | Validated GET /routes params (region, source, optional `route-types` pipe-list, difficulty, `limit`, `page`). | `import { RoutesParams } from 'ropegeo-common/models'` |
 | `SearchParams` | `CursorPaginationParams` | Validated GET /search params including cursor pagination and difficulty. | `import { SearchParams } from 'ropegeo-common/models'` |
 | `SearchOrder` | N/A | Search sort order (`similarity` \| `quality` \| `distance`). | `import type { SearchOrder } from 'ropegeo-common/models'` |
 | `SearchParamsPosition` | N/A | `{ lat, lon }` for distance search. | `import type { SearchParamsPosition } from 'ropegeo-common/models'` |

package/dist/models/api/params/routesParams.d.ts

@@ -7,6 +7,7 @@ import { DifficultyParams } from './difficultyParams';
  * Validated params for getRoutes (GET /routes).
  * Global request: no `region` query param. Region-scoped: `region` id required; optional `source`
  * pipe-list (omit or empty = all sources). `source` must not appear without `region`.
+ * Optional `route-types` query param is a pipe-list of {@link RouteType} values (omit or empty = all types).
  * Includes page-based `limit` and `page` (defaults {@link PaginationParams.DEFAULT_LIMIT} / {@link PaginationParams.DEFAULT_PAGE}).
  */
 export declare class RoutesParams extends PaginationParams {
@@ -18,14 +19,15 @@ export declare class RoutesParams extends PaginationParams {
         id: string;
         source: PageDataSource[] | null;
     } | null;
-    readonly routeType: RouteType | null;
+    /** Null = no route-type filter; non-empty = allow-list (pipe-encoded in query strings as `route-types`). */
+    readonly routeTypes: RouteType[] | null;
     readonly difficulty: DifficultyParams | null;
     constructor(options: {
         region: {
             id: string;
             source: PageDataSource[] | null;
         } | null;
-        routeType?: RouteType | null;
+        routeTypes?: RouteType[] | null;
         difficulty?: DifficultyParams | null;
         limit?: number;
         page?: number;
@@ -39,6 +41,10 @@ export declare class RoutesParams extends PaginationParams {
     private static parsePageQuery;
     private static normalizeDifficulty;
     private static parseRouteType;
+    /** Dedupes while preserving first-seen order; `null` / empty → `null`. */
+    private static normalizeRouteTypeList;
+    /** Pipe-separated tokens, same encoding as {@link RoutesParams.toQueryString}. */
+    private static parseRouteTypePipe;
     private static parseSourcePipe;
     private static parseSourceToken;
     /**
@@ -48,7 +54,7 @@ export declare class RoutesParams extends PaginationParams {
     static fromResult(result: unknown, requiredRegion?: boolean): RoutesParams;
     private static paginationFromResult;
     private static optionalPositiveInt;
-    private static optionalRouteTypeFromResult;
+    private static optionalRouteTypesFromResult;
     private static optionalDifficultyFromResult;
     private static coerceTrimmedString;
 }

package/dist/models/api/params/routesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routesParams.d.ts","sourceRoot":"","sources":["../../../../src/models/api/params/routesParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAKtD;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAC9C;;;OAGG;IACH,SAAgB,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/E,SAAgB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5C,SAAgB,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;gBAExC,OAAO,EAAE;QACjB,MAAM,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAA;SAAE,GAAG,IAAI,CAAC;QAC/D,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;QAC7B,UAAU,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB;IAqCD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY;IAUpC,kDAAkD;IAClD,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC,aAAa,IAAI,MAAM;IAevB,MAAM,CAAC,qBAAqB,CACxB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,YAAY;IA0Cf,OAAO,CAAC,MAAM,CAAC,eAAe;IAiB9B,OAAO,CAAC,MAAM,CAAC,cAAc;IAY7B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAOlC,OAAO,CAAC,MAAM,CAAC,cAAc;IAQ7B,OAAO,CAAC,MAAM,CAAC,eAAe;IAS9B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAU/B;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,cAAc,UAAQ,GAAG,YAAY;IA8ExE,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAkBnC,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAsBlC,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAW1C,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAkB3C,OAAO,CAAC,MAAM,CAAC,mBAAmB;CAWrC"}
+{"version":3,"file":"routesParams.d.ts","sourceRoot":"","sources":["../../../../src/models/api/params/routesParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAKtD;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAC9C;;;OAGG;IACH,SAAgB,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/E,4GAA4G;IAC5G,SAAgB,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC/C,SAAgB,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;gBAExC,OAAO,EAAE;QACjB,MAAM,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAA;SAAE,GAAG,IAAI,CAAC;QAC/D,UAAU,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAChC,UAAU,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB;IAkCD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY;IAUpC,kDAAkD;IAClD,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC,aAAa,IAAI,MAAM;IAevB,MAAM,CAAC,qBAAqB,CACxB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,YAAY;IA0Cf,OAAO,CAAC,MAAM,CAAC,eAAe;IAiB9B,OAAO,CAAC,MAAM,CAAC,cAAc;IAY7B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAOlC,OAAO,CAAC,MAAM,CAAC,cAAc;IAQ7B,0EAA0E;IAC1E,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAcrC,kFAAkF;IAClF,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAUjC,OAAO,CAAC,MAAM,CAAC,eAAe;IAS9B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAU/B;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,cAAc,UAAQ,GAAG,YAAY;IAoFxE,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAkBnC,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAsBlC,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAwB3C,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAkB3C,OAAO,CAAC,MAAM,CAAC,mBAAmB;CAWrC"}

package/dist/models/api/params/routesParams.js

@@ -12,16 +12,14 @@ const UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12
  * Validated params for getRoutes (GET /routes).
  * Global request: no `region` query param. Region-scoped: `region` id required; optional `source`
  * pipe-list (omit or empty = all sources). `source` must not appear without `region`.
+ * Optional `route-types` query param is a pipe-list of {@link RouteType} values (omit or empty = all types).
  * Includes page-based `limit` and `page` (defaults {@link PaginationParams.DEFAULT_LIMIT} / {@link PaginationParams.DEFAULT_PAGE}).
  */
 class RoutesParams extends paginationParams_1.PaginationParams {
     constructor(options) {
         const limit = options.limit ?? paginationParams_1.PaginationParams.DEFAULT_LIMIT;
         const page = options.page ?? paginationParams_1.PaginationParams.DEFAULT_PAGE;
-        const routeType = options.routeType ?? null;
-        if (routeType !== null && !Object.values(routeType_1.RouteType).includes(routeType)) {
-            throw new Error(`Invalid route type: ${JSON.stringify(routeType)}`);
-        }
+        const routeTypes = RoutesParams.normalizeRouteTypeList(options.routeTypes ?? null);
         const diffRaw = options.difficulty ?? null;
         const diff = diffRaw !== null && diffRaw.isActive() ? diffRaw : null;
         const reg = options.region;
@@ -42,13 +40,13 @@ class RoutesParams extends paginationParams_1.PaginationParams {
         }
         super(limit, page);
         this.region = regionNorm;
-        this.routeType = routeType;
+        this.routeTypes = routeTypes;
         this.difficulty = diff;
     }
     withPage(page) {
         return new RoutesParams({
             region: this.region,
-            routeType: this.routeType,
+            routeTypes: this.routeTypes,
             difficulty: this.difficulty,
             limit: this.limit,
             page,
@@ -76,8 +74,8 @@ class RoutesParams extends paginationParams_1.PaginationParams {
                 p.set('source', this.region.source.join('|'));
             }
         }
-        if (this.routeType != null) {
-            p.set('route-type', this.routeType);
+        if (this.routeTypes != null && this.routeTypes.length > 0) {
+            p.set('route-types', this.routeTypes.join('|'));
         }
         difficultyParams_1.DifficultyParams.appendToUrlSearchParams(p, this.difficulty);
         return p.toString();
@@ -87,10 +85,10 @@ class RoutesParams extends paginationParams_1.PaginationParams {
         const page = RoutesParams.parsePageQuery(q);
         const regionRaw = (q.region ?? q.Region ?? '').trim();
         const sourceRaw = (q.source ?? q.Source ?? '').trim();
-        const routeTypeStr = (q['route-type'] ?? q['Route-Type'] ?? '').trim();
-        const routeType = routeTypeStr === ''
+        const routeTypesStr = (q['route-types'] ?? q['Route-Types'] ?? '').trim();
+        const routeTypes = routeTypesStr === ''
             ? null
-            : RoutesParams.parseRouteType(routeTypeStr);
+            : RoutesParams.parseRouteTypePipe(routeTypesStr);
         const difficulty = RoutesParams.normalizeDifficulty(difficultyParams_1.DifficultyParams.fromQueryStringParams(q));
         if (regionRaw === '') {
             if (sourceRaw !== '') {
@@ -98,7 +96,7 @@ class RoutesParams extends paginationParams_1.PaginationParams {
             }
             return new RoutesParams({
                 region: null,
-                routeType,
+                routeTypes,
                 difficulty,
                 limit,
                 page,
@@ -109,7 +107,7 @@ class RoutesParams extends paginationParams_1.PaginationParams {
             : RoutesParams.parseSourcePipe(sourceRaw);
         return new RoutesParams({
             region: { id: regionRaw, source: sources },
-            routeType,
+            routeTypes,
             difficulty,
             limit,
             page,
@@ -149,7 +147,32 @@ class RoutesParams extends paginationParams_1.PaginationParams {
         const exact = Object.values(routeType_1.RouteType).find((v) => v === value);
         if (exact !== undefined)
             return exact;
-        throw new Error(`Query parameter "route-type" must be one of: ${Object.values(routeType_1.RouteType).join(', ')}`);
+        throw new Error(`Query parameter "route-types" must be one of: ${Object.values(routeType_1.RouteType).join(', ')}`);
+    }
+    /** Dedupes while preserving first-seen order; `null` / empty → `null`. */
+    static normalizeRouteTypeList(list) {
+        if (list == null || list.length === 0)
+            return null;
+        const out = [];
+        for (const t of list) {
+            if (!Object.values(routeType_1.RouteType).includes(t)) {
+                throw new Error(`Invalid route type: ${JSON.stringify(t)}`);
+            }
+            if (!out.includes(t))
+                out.push(t);
+        }
+        return out;
+    }
+    /** Pipe-separated tokens, same encoding as {@link RoutesParams.toQueryString}. */
+    static parseRouteTypePipe(raw) {
+        const parts = raw
+            .split('|')
+            .map((s) => s.trim())
+            .filter((s) => s.length > 0);
+        if (parts.length === 0)
+            return null;
+        const types = parts.map((p) => RoutesParams.parseRouteType(p));
+        return RoutesParams.normalizeRouteTypeList(types);
     }
     static parseSourcePipe(raw) {
         const parts = raw
@@ -186,9 +209,15 @@ class RoutesParams extends paginationParams_1.PaginationParams {
             if (requiredRegion) {
                 throw new Error('RoutesParams: region must be a non-null { id, source? } object when requiredRegion is true');
             }
-            const routeType = RoutesParams.optionalRouteTypeFromResult(r);
+            const routeTypes = RoutesParams.optionalRouteTypesFromResult(r);
             const difficulty = RoutesParams.normalizeDifficulty(RoutesParams.optionalDifficultyFromResult(r));
-            return new RoutesParams({ region: null, routeType, difficulty, limit, page });
+            return new RoutesParams({
+                region: null,
+                routeTypes,
+                difficulty,
+                limit,
+                page,
+            });
         }
         if (typeof raw !== 'object') {
             throw new Error('RoutesParams.region must be an object or null, got: ' + typeof raw);
@@ -222,14 +251,14 @@ class RoutesParams extends paginationParams_1.PaginationParams {
         else {
             throw new Error('RoutesParams.region.source must be string, string[], or null');
         }
-        const routeType = RoutesParams.optionalRouteTypeFromResult(r);
+        const routeTypes = RoutesParams.optionalRouteTypesFromResult(r);
         const difficulty = RoutesParams.normalizeDifficulty(RoutesParams.optionalDifficultyFromResult(r));
         return new RoutesParams({
             region: {
                 id: idStr,
                 source: RoutesParams.normalizeSourceList(sourceList),
             },
-            routeType,
+            routeTypes,
             difficulty,
             limit,
             page,
@@ -256,14 +285,23 @@ class RoutesParams extends paginationParams_1.PaginationParams {
         }
         return v;
     }
-    static optionalRouteTypeFromResult(r) {
-        const v = r.routeType ?? r['route-type'] ?? r.RouteType;
+    static optionalRouteTypesFromResult(r) {
+        const v = r.routeTypes ?? r['route-types'] ?? r.RouteTypes;
         if (v === null || v === undefined || v === '')
             return null;
-        if (typeof v !== 'string') {
-            throw new Error('RoutesParams.routeType must be a string or null');
+        if (typeof v === 'string') {
+            return RoutesParams.parseRouteTypePipe(v);
+        }
+        if (Array.isArray(v)) {
+            const types = v.map((item, i) => {
+                if (typeof item !== 'string') {
+                    throw new Error(`RoutesParams.routeTypes[${i}] must be a string`);
+                }
+                return RoutesParams.parseRouteType(item);
+            });
+            return RoutesParams.normalizeRouteTypeList(types);
         }
-        return RoutesParams.parseRouteType(v);
+        throw new Error('RoutesParams.routeTypes must be a string, string[], or null');
     }
     static optionalDifficultyFromResult(r) {
         const nested = r.difficulty ?? r.Difficulty;

package/dist/models/filters/routeFilter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routeFilter.d.ts","sourceRoot":"","sources":["../../../src/models/filters/routeFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,0CAA0C,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;GAEG;AACH,qBAAa,WAAW;IACpB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAChC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,iBAAiB,EAAE,uBAAuB,GAAG,IAAI,CAAC;gBAG9C,MAAM,GAAE,cAAc,EAAE,GAAG,IAAW,EACtC,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,SAAS,GAAE,SAAS,GAAG,IAAW,EAClC,iBAAiB,GAAE,uBAAuB,GAAG,IAAW;IAQ5D,cAAc,IAAI,YAAY;IAkC9B,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAYjC,QAAQ,IAAI,MAAM;IAIlB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAYhD,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,WAAW;IAqB7C,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAoB/B,OAAO,CAAC,MAAM,CAAC,cAAc;CAMhC"}
+{"version":3,"file":"routeFilter.d.ts","sourceRoot":"","sources":["../../../src/models/filters/routeFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,0CAA0C,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;GAEG;AACH,qBAAa,WAAW;IACpB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAChC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,iBAAiB,EAAE,uBAAuB,GAAG,IAAI,CAAC;gBAG9C,MAAM,GAAE,cAAc,EAAE,GAAG,IAAW,EACtC,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,SAAS,GAAE,SAAS,GAAG,IAAW,EAClC,iBAAiB,GAAE,uBAAuB,GAAG,IAAW;IAQ5D,cAAc,IAAI,YAAY;IAoC9B,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAYjC,QAAQ,IAAI,MAAM;IAIlB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAYhD,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,WAAW;IAqB7C,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAoB/B,OAAO,CAAC,MAAM,CAAC,cAAc;CAMhC"}

package/dist/models/filters/routeFilter.js

@@ -26,7 +26,7 @@ class RouteFilter {
             }
             return new routesParams_1.RoutesParams({
                 region: null,
-                routeType: this.routeType,
+                routeTypes: this.routeType !== null ? [this.routeType] : null,
                 difficulty: this.difficultyOptions !== null
                     ? this.difficultyOptions.toDifficultyParams()
                     : null,
@@ -37,7 +37,7 @@ class RouteFilter {
             : [...this.source];
         return new routesParams_1.RoutesParams({
             region: { id: rid, source: src },
-            routeType: this.routeType,
+            routeTypes: this.routeType !== null ? [this.routeType] : null,
             difficulty: this.difficultyOptions !== null
                 ? this.difficultyOptions.toDifficultyParams()
                 : null,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ropegeo-common",
-    "version": "1.10.0",
+    "version": "1.10.1",
     "description": "Shared domain models and helpers for RopeGeo and WebScraper",
     "license": "ISC",
     "repository": {