ropegeo-common 1.2.0 → 1.2.1

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.1",
     "description": "Shared types and utilities for RopeGeo and WebScraper",
     "license": "ISC",
     "repository": {