ropegeo-common 1.1.6 → 1.2.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { PermitStatus } from './types/permitStatus';
 export { GetRopewikiPagePreviewRow, PagePreview } from './types/api/getRoutePreview/pagePreview';
 export { Route, RouteGeoJsonFeature, RouteType } from './types/route';
 export { RoutesGeojson } from './types/api/getRoutes/routeGeojson';
+export { RoutesParams } from './types/api/getRoutes/routesParams';
 export type { RopewikiImageView } from './types/api/getRopewikiPageView/ropewikiImageView';
 export type { RopewikiBetaSectionView } from './types/api/getRopewikiPageView/ropewikiBetaSectionView';
 export type { RopewikiPageView } from './types/api/getRopewikiPageView/ropewikiPageView';
@@ -13,4 +14,14 @@ export type { SearchCursorType } from './types/api/search/searchCursor';
 export { SearchParams } from './types/api/search/searchParams';
 export type { SearchOrder } from './types/api/search/searchParams';
 export { SearchResults } from './types/api/search/searchResults';
+export { RopewikiRegionView } from './types/api/getRopewikiRegionView/ropewikiRegionView';
+export type { RopewikiRegionViewRow } from './types/api/getRopewikiRegionView/ropewikiRegionView';
+export { RegionPreviewsCursor } from './types/api/getRopewikiRegionPreviews/regionPreviewsCursor';
+export { RopewikiRegionPreviewsParams } from './types/api/getRopewikiRegionPreviews/ropewikiRegionPreviewsParams';
+export { RopewikiRegionPreviewsResult } from './types/api/getRopewikiRegionPreviews/ropewikiRegionPreviewsResult';
+export { RegionImagesCursor } from './types/api/getRopewikiRegionImages/regionImagesCursor';
+export { RopewikiRegionImageView } from './types/api/getRopewikiRegionImages/ropewikiRegionImageView';
+export type { RopewikiRegionImageViewRow } from './types/api/getRopewikiRegionImages/ropewikiRegionImageView';
+export { RopewikiRegionImagesParams } from './types/api/getRopewikiRegionImages/ropewikiRegionImagesParams';
+export { RopewikiRegionImagesResult } from './types/api/getRopewikiRegionImages/ropewikiRegionImagesResult';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,mBAAmB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACtH,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACjG,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,YAAY,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAC;AAC3F,YAAY,EAAE,uBAAuB,EAAE,MAAM,yDAAyD,CAAC;AACvG,YAAY,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,YAAY,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,YAAY,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,mBAAmB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACtH,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACjG,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,YAAY,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAC;AAC3F,YAAY,EAAE,uBAAuB,EAAE,MAAM,yDAAyD,CAAC;AACvG,YAAY,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,YAAY,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,YAAY,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sDAAsD,CAAC;AAC1F,YAAY,EAAE,qBAAqB,EAAE,MAAM,sDAAsD,CAAC;AAClG,OAAO,EAAE,oBAAoB,EAAE,MAAM,4DAA4D,CAAC;AAClG,OAAO,EAAE,4BAA4B,EAAE,MAAM,oEAAoE,CAAC;AAClH,OAAO,EAAE,4BAA4B,EAAE,MAAM,oEAAoE,CAAC;AAClH,OAAO,EAAE,kBAAkB,EAAE,MAAM,wDAAwD,CAAC;AAC5F,OAAO,EAAE,uBAAuB,EAAE,MAAM,6DAA6D,CAAC;AACtG,YAAY,EAAE,0BAA0B,EAAE,MAAM,6DAA6D,CAAC;AAC9G,OAAO,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAC;AAC5G,OAAO,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchResults = exports.SearchParams = exports.SearchCursor = exports.RegionPreview = exports.RoutesGeojson = exports.RouteType = exports.Route = exports.PagePreview = exports.PermitStatus = exports.DifficultyWater = exports.DifficultyTime = exports.DifficultyTechnical = exports.DifficultyRisk = exports.Difficulty = exports.PageDataSource = void 0;
+exports.RopewikiRegionImagesResult = exports.RopewikiRegionImagesParams = exports.RopewikiRegionImageView = exports.RegionImagesCursor = exports.RopewikiRegionPreviewsResult = exports.RopewikiRegionPreviewsParams = exports.RegionPreviewsCursor = exports.RopewikiRegionView = exports.SearchResults = exports.SearchParams = exports.SearchCursor = exports.RegionPreview = exports.RoutesParams = exports.RoutesGeojson = exports.RouteType = exports.Route = exports.PagePreview = exports.PermitStatus = 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 difficulty_1 = require("./types/difficulty");
@@ -18,6 +18,8 @@ Object.defineProperty(exports, "Route", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "RouteType", { enumerable: true, get: function () { return route_1.RouteType; } });
 var routeGeojson_1 = require("./types/api/getRoutes/routeGeojson");
 Object.defineProperty(exports, "RoutesGeojson", { enumerable: true, get: function () { return routeGeojson_1.RoutesGeojson; } });
+var routesParams_1 = require("./types/api/getRoutes/routesParams");
+Object.defineProperty(exports, "RoutesParams", { enumerable: true, get: function () { return routesParams_1.RoutesParams; } });
 var regionPreview_1 = require("./types/api/search/regionPreview");
 Object.defineProperty(exports, "RegionPreview", { enumerable: true, get: function () { return regionPreview_1.RegionPreview; } });
 var searchCursor_1 = require("./types/api/search/searchCursor");
@@ -26,3 +28,19 @@ var searchParams_1 = require("./types/api/search/searchParams");
 Object.defineProperty(exports, "SearchParams", { enumerable: true, get: function () { return searchParams_1.SearchParams; } });
 var searchResults_1 = require("./types/api/search/searchResults");
 Object.defineProperty(exports, "SearchResults", { enumerable: true, get: function () { return searchResults_1.SearchResults; } });
+var ropewikiRegionView_1 = require("./types/api/getRopewikiRegionView/ropewikiRegionView");
+Object.defineProperty(exports, "RopewikiRegionView", { enumerable: true, get: function () { return ropewikiRegionView_1.RopewikiRegionView; } });
+var regionPreviewsCursor_1 = require("./types/api/getRopewikiRegionPreviews/regionPreviewsCursor");
+Object.defineProperty(exports, "RegionPreviewsCursor", { enumerable: true, get: function () { return regionPreviewsCursor_1.RegionPreviewsCursor; } });
+var ropewikiRegionPreviewsParams_1 = require("./types/api/getRopewikiRegionPreviews/ropewikiRegionPreviewsParams");
+Object.defineProperty(exports, "RopewikiRegionPreviewsParams", { enumerable: true, get: function () { return ropewikiRegionPreviewsParams_1.RopewikiRegionPreviewsParams; } });
+var ropewikiRegionPreviewsResult_1 = require("./types/api/getRopewikiRegionPreviews/ropewikiRegionPreviewsResult");
+Object.defineProperty(exports, "RopewikiRegionPreviewsResult", { enumerable: true, get: function () { return ropewikiRegionPreviewsResult_1.RopewikiRegionPreviewsResult; } });
+var regionImagesCursor_1 = require("./types/api/getRopewikiRegionImages/regionImagesCursor");
+Object.defineProperty(exports, "RegionImagesCursor", { enumerable: true, get: function () { return regionImagesCursor_1.RegionImagesCursor; } });
+var ropewikiRegionImageView_1 = require("./types/api/getRopewikiRegionImages/ropewikiRegionImageView");
+Object.defineProperty(exports, "RopewikiRegionImageView", { enumerable: true, get: function () { return ropewikiRegionImageView_1.RopewikiRegionImageView; } });
+var ropewikiRegionImagesParams_1 = require("./types/api/getRopewikiRegionImages/ropewikiRegionImagesParams");
+Object.defineProperty(exports, "RopewikiRegionImagesParams", { enumerable: true, get: function () { return ropewikiRegionImagesParams_1.RopewikiRegionImagesParams; } });
+var ropewikiRegionImagesResult_1 = require("./types/api/getRopewikiRegionImages/ropewikiRegionImagesResult");
+Object.defineProperty(exports, "RopewikiRegionImagesResult", { enumerable: true, get: function () { return ropewikiRegionImagesResult_1.RopewikiRegionImagesResult; } });

package/dist/types/api/getRopewikiRegionImages/regionImagesCursor.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Stub cursor for region images pagination. Encodes to base64url for the nextCursor string.
+ * Cursor logic will be implemented in Webscraper.
+ */
+export declare class RegionImagesCursor {
+    readonly value: string;
+    constructor(value: string);
+    encodeBase64(): string;
+    /**
+     * Decodes a base64url-encoded cursor string. Throws if the string is invalid.
+     */
+    static decodeBase64(encoded: string): RegionImagesCursor;
+}
+//# sourceMappingURL=regionImagesCursor.d.ts.map

package/dist/types/api/getRopewikiRegionImages/regionImagesCursor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regionImagesCursor.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionImages/regionImagesCursor.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,qBAAa,kBAAkB;aACC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAEzC,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,kBAAkB;CAkB3D"}

package/dist/types/api/getRopewikiRegionImages/regionImagesCursor.js

@@ -0,0 +1,41 @@
+"use strict";
+/// <reference types="node" />
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegionImagesCursor = void 0;
+const ENCODING = 'utf8';
+const BASE64URL = 'base64url';
+/**
+ * Stub cursor for region images pagination. Encodes to base64url for the nextCursor string.
+ * Cursor logic will be implemented in Webscraper.
+ */
+class RegionImagesCursor {
+    constructor(value) {
+        this.value = value;
+    }
+    encodeBase64() {
+        return Buffer.from(JSON.stringify({ value: this.value }), ENCODING).toString(BASE64URL);
+    }
+    /**
+     * Decodes a base64url-encoded cursor string. Throws if the string is invalid.
+     */
+    static decodeBase64(encoded) {
+        if (typeof encoded !== 'string' || encoded === '') {
+            throw new Error('Region images cursor must be a non-empty string');
+        }
+        let decoded;
+        try {
+            const json = Buffer.from(encoded, BASE64URL).toString(ENCODING);
+            decoded = JSON.parse(json);
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            throw new Error(`Invalid region images cursor encoding: ${message}`);
+        }
+        if (decoded == null || typeof decoded !== 'object' || !('value' in decoded)) {
+            throw new Error('Region images cursor must be an object with value');
+        }
+        const obj = decoded;
+        return new RegionImagesCursor(String(obj.value ?? ''));
+    }
+}
+exports.RegionImagesCursor = RegionImagesCursor;

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImageView.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Row shape from the database (or join) for building a RopewikiRegionImageView.
+ * Column names match RopewikiImage; pageName typically comes from a join with RopewikiPage.
+ */
+export interface RopewikiRegionImageViewRow {
+    id: string;
+    ropewikiPage: string;
+    pageName: string;
+    fileUrl: string;
+    linkUrl: string;
+    caption?: string | null;
+}
+/**
+ * Image view item for getRopewikiRegionImages (GET /ropewiki/region/{id}/images).
+ */
+export declare class RopewikiRegionImageView {
+    id: string;
+    pageId: string;
+    pageName: string;
+    url: string;
+    externalLink: string;
+    caption: string | undefined;
+    constructor(row: RopewikiRegionImageViewRow);
+}
+//# sourceMappingURL=ropewikiRegionImageView.d.ts.map

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImageView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ropewikiRegionImageView.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionImages/ropewikiRegionImageView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,uBAAuB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEhB,GAAG,EAAE,0BAA0B;CAQ9C"}

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImageView.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RopewikiRegionImageView = void 0;
+/**
+ * Image view item for getRopewikiRegionImages (GET /ropewiki/region/{id}/images).
+ */
+class RopewikiRegionImageView {
+    constructor(row) {
+        this.id = row.id;
+        this.pageId = row.ropewikiPage;
+        this.pageName = row.pageName;
+        this.url = row.fileUrl;
+        this.externalLink = row.linkUrl;
+        this.caption = row.caption ?? undefined;
+    }
+}
+exports.RopewikiRegionImageView = RopewikiRegionImageView;

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImagesParams.d.ts

@@ -0,0 +1,22 @@
+import { RegionImagesCursor } from './regionImagesCursor';
+/**
+ * Validated params for getRopewikiRegionImages (GET /ropewiki/region/{id}/images).
+ * Cursor is stored decoded (RegionImagesCursor | null).
+ * The constructor accepts an encoded cursor string and decodes it.
+ */
+export declare class RopewikiRegionImagesParams {
+    readonly limit: number;
+    readonly cursor: RegionImagesCursor | null;
+    constructor(limit: number, cursorEncoded: string | null);
+    /**
+     * Returns an object suitable for use as query string parameters.
+     * Cursor is encoded for the query string.
+     */
+    toQueryStringParams(): Record<string, string>;
+    /**
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
+     */
+    static fromQueryStringParams(q: Record<string, string | undefined>): RopewikiRegionImagesParams;
+}
+//# sourceMappingURL=ropewikiRegionImagesParams.d.ts.map

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImagesParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ropewikiRegionImagesParams.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionImages/ropewikiRegionImagesParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAI1D;;;;GAIG;AACH,qBAAa,0BAA0B;IACnC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;gBAEtC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IA0BvD;;;OAGG;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,0BAA0B;CAOhC"}

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImagesParams.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RopewikiRegionImagesParams = void 0;
+const regionImagesCursor_1 = require("./regionImagesCursor");
+const DEFAULT_LIMIT = 20;
+/**
+ * Validated params for getRopewikiRegionImages (GET /ropewiki/region/{id}/images).
+ * Cursor is stored decoded (RegionImagesCursor | null).
+ * The constructor accepts an encoded cursor string and decodes it.
+ */
+class RopewikiRegionImagesParams {
+    constructor(limit, cursorEncoded) {
+        const limitNum = Number(limit);
+        if (Number.isNaN(limitNum) ||
+            !Number.isInteger(limitNum) ||
+            limitNum < 1) {
+            throw new Error('Query parameter "limit" must be a whole number greater than 0');
+        }
+        this.limit = limit;
+        if (cursorEncoded === null || cursorEncoded === '') {
+            this.cursor = null;
+        }
+        else {
+            try {
+                this.cursor = regionImagesCursor_1.RegionImagesCursor.decodeBase64(cursorEncoded);
+            }
+            catch {
+                throw new Error('Invalid or malformed query parameter: cursor');
+            }
+        }
+    }
+    /**
+     * Returns an object suitable for use as query string parameters.
+     * Cursor is encoded for the query string.
+     */
+    toQueryStringParams() {
+        const params = {
+            limit: String(this.limit),
+        };
+        if (this.cursor !== null) {
+            params.cursor = this.cursor.encodeBase64();
+        }
+        return params;
+    }
+    /**
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
+     */
+    static fromQueryStringParams(q) {
+        const limitParam = q.limit ?? q.Limit ?? '';
+        const limit = limitParam === '' ? DEFAULT_LIMIT : Number(limitParam);
+        const cursorRaw = (q.cursor ?? q.Cursor ?? '').trim();
+        const cursorEncoded = cursorRaw === '' ? null : cursorRaw;
+        return new RopewikiRegionImagesParams(limit, cursorEncoded);
+    }
+}
+exports.RopewikiRegionImagesParams = RopewikiRegionImagesParams;

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImagesResult.d.ts

@@ -0,0 +1,11 @@
+import type { RopewikiRegionImageView } from './ropewikiRegionImageView';
+import { RegionImagesCursor } from './regionImagesCursor';
+/**
+ * Result of getRopewikiRegionImages (GET /ropewiki/region/{id}/images).
+ */
+export declare class RopewikiRegionImagesResult {
+    results: RopewikiRegionImageView[];
+    nextCursor: string | null;
+    constructor(results: RopewikiRegionImageView[], nextCursor: RegionImagesCursor | null);
+}
+//# sourceMappingURL=ropewikiRegionImagesResult.d.ts.map

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImagesResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ropewikiRegionImagesResult.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionImages/ropewikiRegionImagesResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;GAEG;AACH,qBAAa,0BAA0B;IACnC,OAAO,EAAE,uBAAuB,EAAE,CAAC;IACnC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;gBAGtB,OAAO,EAAE,uBAAuB,EAAE,EAClC,UAAU,EAAE,kBAAkB,GAAG,IAAI;CAK5C"}

package/dist/types/api/getRopewikiRegionImages/ropewikiRegionImagesResult.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RopewikiRegionImagesResult = void 0;
+/**
+ * Result of getRopewikiRegionImages (GET /ropewiki/region/{id}/images).
+ */
+class RopewikiRegionImagesResult {
+    constructor(results, nextCursor) {
+        this.results = results;
+        this.nextCursor = nextCursor !== null ? nextCursor.encodeBase64() : null;
+    }
+}
+exports.RopewikiRegionImagesResult = RopewikiRegionImagesResult;

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

@@ -0,0 +1,14 @@
+/**
+ * Stub cursor for region previews pagination. Encodes to base64url for the nextCursor string.
+ * Cursor logic will be implemented in Webscraper.
+ */
+export declare class RegionPreviewsCursor {
+    readonly value: string;
+    constructor(value: string);
+    encodeBase64(): string;
+    /**
+     * Decodes a base64url-encoded cursor string. Throws if the string is invalid.
+     */
+    static decodeBase64(encoded: string): RegionPreviewsCursor;
+}
+//# sourceMappingURL=regionPreviewsCursor.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,41 @@
+"use strict";
+/// <reference types="node" />
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ */
+class RegionPreviewsCursor {
+    constructor(value) {
+        this.value = value;
+    }
+    encodeBase64() {
+        return Buffer.from(JSON.stringify({ value: this.value }), ENCODING).toString(BASE64URL);
+    }
+    /**
+     * Decodes a base64url-encoded cursor string. Throws if the string is invalid.
+     */
+    static decodeBase64(encoded) {
+        if (typeof encoded !== 'string' || encoded === '') {
+            throw new Error('Region previews cursor must be a non-empty string');
+        }
+        let decoded;
+        try {
+            const json = Buffer.from(encoded, BASE64URL).toString(ENCODING);
+            decoded = JSON.parse(json);
+        }
+        catch (err) {
+            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');
+        }
+        const obj = decoded;
+        return new RegionPreviewsCursor(String(obj.value ?? ''));
+    }
+}
+exports.RegionPreviewsCursor = RegionPreviewsCursor;

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

@@ -0,0 +1,22 @@
+import { RegionPreviewsCursor } from './regionPreviewsCursor';
+/**
+ * Validated params for getRopewikiRegionPreviews (GET /ropewiki/region/{id}/previews).
+ * Cursor is stored decoded (RegionPreviewsCursor | null).
+ * The constructor accepts an encoded cursor string and decodes it.
+ */
+export declare class RopewikiRegionPreviewsParams {
+    readonly limit: number;
+    readonly cursor: RegionPreviewsCursor | null;
+    constructor(limit: number, cursorEncoded: string | null);
+    /**
+     * Returns an object suitable for use as query string parameters.
+     * Cursor is encoded for the query string.
+     */
+    toQueryStringParams(): Record<string, string>;
+    /**
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
+     */
+    static fromQueryStringParams(q: Record<string, string | undefined>): RopewikiRegionPreviewsParams;
+}
+//# sourceMappingURL=ropewikiRegionPreviewsParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ropewikiRegionPreviewsParams.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionPreviews/ropewikiRegionPreviewsParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAI9D;;;;GAIG;AACH,qBAAa,4BAA4B;IACrC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAC;gBAExC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IA0BvD;;;OAGG;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,4BAA4B;CAOlC"}

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RopewikiRegionPreviewsParams = void 0;
+const regionPreviewsCursor_1 = require("./regionPreviewsCursor");
+const DEFAULT_LIMIT = 20;
+/**
+ * Validated params for getRopewikiRegionPreviews (GET /ropewiki/region/{id}/previews).
+ * Cursor is stored decoded (RegionPreviewsCursor | null).
+ * The constructor accepts an encoded cursor string and decodes it.
+ */
+class RopewikiRegionPreviewsParams {
+    constructor(limit, cursorEncoded) {
+        const limitNum = Number(limit);
+        if (Number.isNaN(limitNum) ||
+            !Number.isInteger(limitNum) ||
+            limitNum < 1) {
+            throw new Error('Query parameter "limit" must be a whole number greater than 0');
+        }
+        this.limit = limit;
+        if (cursorEncoded === null || cursorEncoded === '') {
+            this.cursor = null;
+        }
+        else {
+            try {
+                this.cursor = regionPreviewsCursor_1.RegionPreviewsCursor.decodeBase64(cursorEncoded);
+            }
+            catch {
+                throw new Error('Invalid or malformed query parameter: cursor');
+            }
+        }
+    }
+    /**
+     * Returns an object suitable for use as query string parameters.
+     * Cursor is encoded for the query string.
+     */
+    toQueryStringParams() {
+        const params = {
+            limit: String(this.limit),
+        };
+        if (this.cursor !== null) {
+            params.cursor = this.cursor.encodeBase64();
+        }
+        return params;
+    }
+    /**
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
+     */
+    static fromQueryStringParams(q) {
+        const limitParam = q.limit ?? q.Limit ?? '';
+        const limit = limitParam === '' ? DEFAULT_LIMIT : Number(limitParam);
+        const cursorRaw = (q.cursor ?? q.Cursor ?? '').trim();
+        const cursorEncoded = cursorRaw === '' ? null : cursorRaw;
+        return new RopewikiRegionPreviewsParams(limit, cursorEncoded);
+    }
+}
+exports.RopewikiRegionPreviewsParams = RopewikiRegionPreviewsParams;

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

@@ -0,0 +1,12 @@
+import { PagePreview } from '../getRoutePreview/pagePreview';
+import { RegionPreview } from '../search/regionPreview';
+import { RegionPreviewsCursor } from './regionPreviewsCursor';
+/**
+ * Result of getRopewikiRegionPreviews (GET /ropewiki/region/{id}/previews).
+ */
+export declare class RopewikiRegionPreviewsResult {
+    results: (PagePreview | RegionPreview)[];
+    nextCursor: string | null;
+    constructor(results: (PagePreview | RegionPreview)[], nextCursor: RegionPreviewsCursor | null);
+}
+//# sourceMappingURL=ropewikiRegionPreviewsResult.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ropewikiRegionPreviewsResult.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionPreviews/ropewikiRegionPreviewsResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;GAEG;AACH,qBAAa,4BAA4B;IACrC,OAAO,EAAE,CAAC,WAAW,GAAG,aAAa,CAAC,EAAE,CAAC;IACzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;gBAGtB,OAAO,EAAE,CAAC,WAAW,GAAG,aAAa,CAAC,EAAE,EACxC,UAAU,EAAE,oBAAoB,GAAG,IAAI;CAK9C"}

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RopewikiRegionPreviewsResult = void 0;
+/**
+ * Result of getRopewikiRegionPreviews (GET /ropewiki/region/{id}/previews).
+ */
+class RopewikiRegionPreviewsResult {
+    constructor(results, nextCursor) {
+        this.results = results;
+        this.nextCursor = nextCursor !== null ? nextCursor.encodeBase64() : null;
+    }
+}
+exports.RopewikiRegionPreviewsResult = RopewikiRegionPreviewsResult;

package/dist/types/api/getRopewikiRegionView/ropewikiRegionView.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Row shape from the database (or join) for building a RopewikiRegionView.
+ * Column names match the RopewikiRegion schema; parentRegionId/parentRegionName
+ * come from a join when loading the parent region.
+ */
+export interface RopewikiRegionViewRow {
+    name: string;
+    parentRegionId?: string | null;
+    parentRegionName?: string | null;
+    rawPageCount?: number | null;
+    truePageCount?: number | null;
+    trueRegionCount?: number | null;
+    truePageCountWithDescendents?: number | null;
+    overview?: string | null;
+    bestMonths?: string[] | null;
+    isMajorRegion?: boolean | null;
+    latestRevisionDate: Date;
+    url: string;
+}
+/**
+ * Region view for getRopewikiRegionView (GET /ropewiki/region/{id}).
+ * Contains all RopewikiRegion info for the region except the region's id.
+ */
+export declare class RopewikiRegionView {
+    name: string;
+    parentRegion: {
+        id: string;
+        name: string;
+    } | null;
+    /** Actual number of pages in this region (computed). Default 0. */
+    regionCount: number;
+    /** Pages in this region only (computed). Default 0. */
+    topLevelPageCount: number;
+    /** Raw page count from getRegions API (rawPageCount). Default 0. */
+    pageCount: number;
+    overview: string | null;
+    bestMonths: string[];
+    isMajorRegion: boolean;
+    latestRevisionDate: Date;
+    externalLink: string;
+    constructor(row: RopewikiRegionViewRow);
+}
+//# sourceMappingURL=ropewikiRegionView.d.ts.map

package/dist/types/api/getRopewikiRegionView/ropewikiRegionView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ropewikiRegionView.d.ts","sourceRoot":"","sources":["../../../../src/types/api/getRopewikiRegionView/ropewikiRegionView.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,4BAA4B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,kBAAkB,EAAE,IAAI,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAClD,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oEAAoE;IACpE,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,EAAE,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;gBAET,GAAG,EAAE,qBAAqB;CAezC"}

package/dist/types/api/getRopewikiRegionView/ropewikiRegionView.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RopewikiRegionView = void 0;
+/**
+ * Region view for getRopewikiRegionView (GET /ropewiki/region/{id}).
+ * Contains all RopewikiRegion info for the region except the region's id.
+ */
+class RopewikiRegionView {
+    constructor(row) {
+        this.name = row.name;
+        this.parentRegion =
+            row.parentRegionId != null && row.parentRegionName != null
+                ? { id: row.parentRegionId, name: row.parentRegionName }
+                : null;
+        this.regionCount = row.trueRegionCount ?? 0;
+        this.topLevelPageCount = row.truePageCount ?? 0;
+        this.pageCount = row.rawPageCount ?? 0;
+        this.overview = row.overview ?? null;
+        this.bestMonths = Array.isArray(row.bestMonths) ? row.bestMonths : [];
+        this.isMajorRegion = row.isMajorRegion ?? false;
+        this.latestRevisionDate = new Date(row.latestRevisionDate);
+        this.externalLink = row.url;
+    }
+}
+exports.RopewikiRegionView = RopewikiRegionView;

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

@@ -0,0 +1,21 @@
+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.
+ */
+export declare class RoutesParams {
+    readonly source: PageDataSource | undefined;
+    readonly region: string | undefined;
+    constructor(source: PageDataSource | undefined, region: string | undefined);
+    /**
+     * Returns an object suitable for use as query string parameters.
+     */
+    toQueryStringParams(): Record<string, string>;
+    /**
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
+     */
+    static fromQueryStringParams(q: Record<string, string | undefined>): RoutesParams;
+    private static parseSource;
+}
+//# sourceMappingURL=routesParams.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ */
+class RoutesParams {
+    constructor(source, region) {
+        const sourcePresent = source !== undefined;
+        const regionPresent = region !== undefined && typeof region === 'string' && region !== '';
+        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;
+    }
+    /**
+     * Returns an object suitable for use as query string parameters.
+     */
+    toQueryStringParams() {
+        const params = {};
+        if (this.source !== undefined) {
+            params.source = this.source;
+        }
+        if (this.region !== undefined) {
+            params.region = this.region;
+        }
+        return params;
+    }
+    /**
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
+     */
+    static fromQueryStringParams(q) {
+        const sourceRaw = (q.source ?? q.Source ?? '').trim();
+        const regionRaw = (q.region ?? q.Region ?? '').trim();
+        const source = sourceRaw === ''
+            ? undefined
+            : RoutesParams.parseSource(sourceRaw);
+        const region = regionRaw === '' ? undefined : regionRaw;
+        return new RoutesParams(source, region);
+    }
+    static parseSource(value) {
+        if (value === pageDataSource_1.PageDataSource.Ropewiki) {
+            return pageDataSource_1.PageDataSource.Ropewiki;
+        }
+        throw new Error(`Query parameter "source" must be one of: ${Object.values(pageDataSource_1.PageDataSource).join(', ')}`);
+    }
+}
+exports.RoutesParams = RoutesParams;

package/dist/types/api/search/searchParams.d.ts

@@ -21,8 +21,8 @@ export declare class SearchParams {
      */
     toQueryStringParams(): Record<string, string>;
     /**
-     * Parses and validates query string parameters. Throws with a descriptive
-     * error message if any value is invalid.
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
      */
     static fromQueryStringParams(q: Record<string, string | undefined>): SearchParams;
     /**

package/dist/types/api/search/searchParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchParams.d.ts","sourceRoot":"","sources":["../../../../src/types/api/search/searchParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,SAAS,CAAC;AAOnD;;;GAGG;AACH,qBAAa,YAAY;IACrB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAC5C,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,SAAgB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,SAAgB,KAAK,EAAE,WAAW,CAAC;IACnC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;gBAGxC,IAAI,EAAE,MAAM,EACZ,mBAAmB,EAAE,MAAM,EAC3B,YAAY,EAAE,OAAO,EACrB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,OAAO,EACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,EAAE,WAAW,EAClB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,GAAG,IAAI;IAqEhC;;;OAGG;IACH,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAmB7C;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CACxB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,YAAY;IA2Ff;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;CAY9B"}
+{"version":3,"file":"searchParams.d.ts","sourceRoot":"","sources":["../../../../src/types/api/search/searchParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,SAAS,CAAC;AAOnD;;;GAGG;AACH,qBAAa,YAAY;IACrB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAC5C,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,SAAgB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,SAAgB,KAAK,EAAE,WAAW,CAAC;IACnC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;gBAGxC,IAAI,EAAE,MAAM,EACZ,mBAAmB,EAAE,MAAM,EAC3B,YAAY,EAAE,OAAO,EACrB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,OAAO,EACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,EAAE,WAAW,EAClB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,GAAG,IAAI;IAqEhC;;;OAGG;IACH,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAmB7C;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CACxB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,YAAY;IA2Cf;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;CAY9B"}

package/dist/types/api/search/searchParams.js

@@ -82,57 +82,31 @@ class SearchParams {
         return params;
     }
     /**
-     * Parses and validates query string parameters. Throws with a descriptive
-     * error message if any value is invalid.
+     * Parses query string parameters and returns validated params.
+     * Validation is performed by the constructor.
      */
     static fromQueryStringParams(q) {
         const name = (q.name ?? q.Name ?? '').trim();
-        if (!name) {
-            throw new Error('Missing or empty required query parameter: name');
-        }
         const limitParam = q.limit ?? q.Limit ?? '';
-        let limit;
-        if (limitParam === '') {
-            limit = DEFAULT_LIMIT;
-        }
-        else {
-            const limitNum = Number(limitParam);
-            if (Number.isNaN(limitNum) ||
-                !Number.isInteger(limitNum) ||
-                limitNum < 1) {
-                throw new Error('Query parameter "limit" must be a whole number greater than 0');
-            }
-            limit = limitNum;
-        }
+        const limit = limitParam === '' ? DEFAULT_LIMIT : Number(limitParam);
         const cursorRaw = (q.cursor ?? q.Cursor ?? '').trim();
         const cursorEncoded = cursorRaw === '' ? null : cursorRaw;
         const similarityParam = q.similarity ?? q.Similarity ?? '';
         const similarity = similarityParam === '' ? 0.5 : Number(similarityParam);
         const orderParam = (q.order ?? q.Order ?? '').trim().toLowerCase();
-        if (orderParam !== '' &&
-            orderParam !== 'similarity' &&
-            orderParam !== 'quality') {
-            throw new Error('Query parameter "order" must be one of: similarity, quality');
-        }
-        const order = orderParam === 'quality' ? 'quality' : 'similarity';
+        const order = (orderParam === 'quality'
+            ? 'quality'
+            : orderParam === 'similarity'
+                ? 'similarity'
+                : orderParam || 'similarity');
         const includePages = SearchParams.parseBoolean(q['include-pages'] ?? q['Include-Pages'], true);
         const includeRegions = SearchParams.parseBoolean(q['include-regions'] ?? q['Include-Regions'], true);
-        if (!includePages && !includeRegions) {
-            throw new Error('At least one of include-pages or include-regions must be true');
-        }
         const includeAkaParam = q['include-aka'] ?? q['Include-Aka'];
         const includeAkaExplicit = (includeAkaParam ?? '').trim() !== '';
-        let includeAka = SearchParams.parseBoolean(includeAkaParam, true);
-        if (!includeAkaExplicit && !includePages) {
-            includeAka = false;
-        }
-        if (includeAkaExplicit && includeAka && !includePages) {
-            throw new Error('include-aka cannot be true when include-pages is false');
-        }
+        const includeAka = includeAkaExplicit
+            ? SearchParams.parseBoolean(includeAkaParam, true)
+            : includePages;
         const region = (q.region ?? q.Region ?? '').trim() || null;
-        if (region !== null && !UUID_REGEX.test(region)) {
-            throw new Error('Query parameter "region" must be a valid UUID');
-        }
         return new SearchParams(name, similarity, includePages, includeRegions, includeAka, region, order, limit, cursorEncoded);
     }
     /**

package/dist/types/api/search/searchResults.d.ts

@@ -3,7 +3,7 @@ import { RegionPreview } from './regionPreview';
 import { SearchCursor } from './searchCursor';
 export declare class SearchResults {
     results: (PagePreview | RegionPreview)[];
-    nextCursor: string;
-    constructor(results: (PagePreview | RegionPreview)[], nextCursorCursor: SearchCursor | null);
+    nextCursor: string | null;
+    constructor(results: (PagePreview | RegionPreview)[], nextCursor: SearchCursor | null);
 }
 //# sourceMappingURL=searchResults.d.ts.map

package/dist/types/api/search/searchResults.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchResults.d.ts","sourceRoot":"","sources":["../../../../src/types/api/search/searchResults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,qBAAa,aAAa;IACtB,OAAO,EAAE,CAAC,WAAW,GAAG,aAAa,CAAC,EAAE,CAAC;IACzC,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,CAAC,WAAW,GAAG,aAAa,CAAC,EAAE,EAAE,gBAAgB,EAAE,YAAY,GAAG,IAAI;CAI9F"}
+{"version":3,"file":"searchResults.d.ts","sourceRoot":"","sources":["../../../../src/types/api/search/searchResults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,qBAAa,aAAa;IACtB,OAAO,EAAE,CAAC,WAAW,GAAG,aAAa,CAAC,EAAE,CAAC;IACzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEd,OAAO,EAAE,CAAC,WAAW,GAAG,aAAa,CAAC,EAAE,EAAE,UAAU,EAAE,YAAY,GAAG,IAAI;CAIxF"}

package/dist/types/api/search/searchResults.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchResults = void 0;
 class SearchResults {
-    constructor(results, nextCursorCursor) {
+    constructor(results, nextCursor) {
         this.results = results;
-        this.nextCursor = nextCursorCursor !== null ? nextCursorCursor.encodeBase64() : '';
+        this.nextCursor = nextCursor !== null ? nextCursor.encodeBase64() : null;
     }
 }
 exports.SearchResults = SearchResults;

package/package.json

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