ropegeo-common 1.2.0 → 1.2.2

package/dist/types/api/getRopewikiRegionPreviews/regionPreviewsCursor.d.ts

@@ -1,13 +1,15 @@
 /**
- * Stub cursor for region previews pagination. Encodes to base64url for the nextCursor string.
- * Cursor logic will be implemented in Webscraper.
+ * Cursor for region previews pagination. Encodes to base64url for the nextCursor string.
  */
 export declare class RegionPreviewsCursor {
-    readonly value: string;
-    constructor(value: string);
+    readonly sortKey: number;
+    readonly type: string;
+    readonly id: string;
+    constructor(sortKey: number, type: string, id: string);
     encodeBase64(): string;
     /**
-     * Decodes a base64url-encoded cursor string. Throws if the string is invalid.
+     * Decodes a base64url-encoded cursor string. Throws if the string is invalid
+     * or does not represent a valid RegionPreviewsCursor shape.
      */
     static decodeBase64(encoded: string): RegionPreviewsCursor;
 }

package/dist/types/api/getRopewikiRegionPreviews/regionPreviewsCursor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"regionPreviewsCursor.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionPreviews/regionPreviewsCursor.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,qBAAa,oBAAoB;aACD,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAEzC,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,oBAAoB;CAkB7D"}
+{"version":3,"file":"regionPreviewsCursor.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionPreviews/regionPreviewsCursor.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,qBAAa,oBAAoB;aAET,OAAO,EAAE,MAAM;aACf,IAAI,EAAE,MAAM;aACZ,EAAE,EAAE,MAAM;gBAFV,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM;IAG9B,YAAY,IAAI,MAAM;IAWtB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,oBAAoB;CA0C7D"}

package/dist/types/api/getRopewikiRegionPreviews/regionPreviewsCursor.js

@@ -5,18 +5,24 @@ exports.RegionPreviewsCursor = void 0;
 const ENCODING = 'utf8';
 const BASE64URL = 'base64url';
 /**
- * Stub cursor for region previews pagination. Encodes to base64url for the nextCursor string.
- * Cursor logic will be implemented in Webscraper.
+ * Cursor for region previews pagination. Encodes to base64url for the nextCursor string.
  */
 class RegionPreviewsCursor {
-    constructor(value) {
-        this.value = value;
+    constructor(sortKey, type, id) {
+        this.sortKey = sortKey;
+        this.type = type;
+        this.id = id;
     }
     encodeBase64() {
-        return Buffer.from(JSON.stringify({ value: this.value }), ENCODING).toString(BASE64URL);
+        return Buffer.from(JSON.stringify({
+            sortKey: this.sortKey,
+            type: this.type,
+            id: this.id,
+        }), ENCODING).toString(BASE64URL);
     }
     /**
-     * Decodes a base64url-encoded cursor string. Throws if the string is invalid.
+     * Decodes a base64url-encoded cursor string. Throws if the string is invalid
+     * or does not represent a valid RegionPreviewsCursor shape.
      */
     static decodeBase64(encoded) {
         if (typeof encoded !== 'string' || encoded === '') {
@@ -31,11 +37,25 @@ class RegionPreviewsCursor {
             const message = err instanceof Error ? err.message : String(err);
             throw new Error(`Invalid region previews cursor encoding: ${message}`);
         }
-        if (decoded == null || typeof decoded !== 'object' || !('value' in decoded)) {
-            throw new Error('Region previews cursor must be an object with value');
+        if (decoded == null ||
+            typeof decoded !== 'object' ||
+            !('sortKey' in decoded) ||
+            !('type' in decoded) ||
+            !('id' in decoded)) {
+            throw new Error('Region previews cursor must be an object with sortKey, type, and id');
         }
         const obj = decoded;
-        return new RegionPreviewsCursor(String(obj.value ?? ''));
+        const sortKey = Number(obj.sortKey);
+        if (Number.isNaN(sortKey)) {
+            throw new Error(`Region previews cursor sortKey must be a number, got: ${JSON.stringify(obj.sortKey)}`);
+        }
+        if (typeof obj.type !== 'string') {
+            throw new Error(`Region previews cursor type must be a string, got: ${typeof obj.type}`);
+        }
+        if (typeof obj.id !== 'string') {
+            throw new Error(`Region previews cursor id must be a string, got: ${typeof obj.id}`);
+        }
+        return new RegionPreviewsCursor(sortKey, obj.type, obj.id);
     }
 }
 exports.RegionPreviewsCursor = RegionPreviewsCursor;

package/dist/types/api/getRoutes/routesParams.d.ts

@@ -1,12 +1,15 @@
 import { PageDataSource } from '../../pageDataSource';
 /**
  * Validated params for getRoutes (GET /routes).
- * source and region are optional with no defaults; if one is present the other must also be present.
+ * region is null when neither source nor region id are in the query; if one query param is present the other must also be present.
  */
 export declare class RoutesParams {
-    readonly source: PageDataSource | undefined;
-    readonly region: string | undefined;
-    constructor(source: PageDataSource | undefined, region: string | undefined);
+    /** When set, both source and region id were provided in the query. */
+    readonly region: {
+        source: PageDataSource;
+        id: string;
+    } | null;
+    constructor(source: PageDataSource | undefined, regionId: string | undefined);
     /**
      * Returns an object suitable for use as query string parameters.
      */

package/dist/types/api/getRoutes/routesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routesParams.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRoutes/routesParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;GAGG;AACH,qBAAa,YAAY;IACrB,SAAgB,MAAM,EAAE,cAAc,GAAG,SAAS,CAAC;IACnD,SAAgB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE/B,MAAM,EAAE,cAAc,GAAG,SAAS,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS;IAa1E;;OAEG;IACH,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAW7C;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CACxB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,YAAY;IAWf,OAAO,CAAC,MAAM,CAAC,WAAW;CAQ7B"}
+{"version":3,"file":"routesParams.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRoutes/routesParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;GAGG;AACH,qBAAa,YAAY;IACrB,sEAAsE;IACtE,SAAgB,MAAM,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;gBAE1D,MAAM,EAAE,cAAc,GAAG,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS;IAiB5E;;OAEG;IACH,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAU7C;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CACxB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,YAAY;IAWf,OAAO,CAAC,MAAM,CAAC,WAAW;CAQ7B"}

package/dist/types/api/getRoutes/routesParams.js

@@ -4,30 +4,33 @@ exports.RoutesParams = void 0;
 const pageDataSource_1 = require("../../pageDataSource");
 /**
  * Validated params for getRoutes (GET /routes).
- * source and region are optional with no defaults; if one is present the other must also be present.
+ * region is null when neither source nor region id are in the query; if one query param is present the other must also be present.
  */
 class RoutesParams {
-    constructor(source, region) {
+    constructor(source, regionId) {
         const sourcePresent = source !== undefined;
-        const regionPresent = region !== undefined && typeof region === 'string' && region !== '';
+        const regionPresent = regionId !== undefined &&
+            typeof regionId === 'string' &&
+            regionId !== '';
         if (sourcePresent !== regionPresent) {
             throw new Error('Query parameters "source" and "region" must both be present or both be absent');
         }
-        this.source = sourcePresent ? source : undefined;
-        this.region = regionPresent ? region : undefined;
+        this.region =
+            sourcePresent && regionPresent
+                ? { source: source, id: regionId }
+                : null;
     }
     /**
      * Returns an object suitable for use as query string parameters.
      */
     toQueryStringParams() {
-        const params = {};
-        if (this.source !== undefined) {
-            params.source = this.source;
+        if (this.region === null) {
+            return {};
         }
-        if (this.region !== undefined) {
-            params.region = this.region;
-        }
-        return params;
+        return {
+            source: this.region.source,
+            region: this.region.id,
+        };
     }
     /**
      * Parses query string parameters and returns validated params.

package/package.json

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