@uniformdev/project-map 19.11.0 → 19.12.0

package/dist/index.d.ts

@@ -592,14 +592,23 @@ type MatchedRoute = {
 type UnmatchedRoute = {
     match: false;
 };
+type ExpandOptions = {
+    dynamicInputValues?: Record<string, string>;
+    allowedQueryParams?: Array<string>;
+};
 declare class Route {
     #private;
     readonly route: string;
     constructor(route: string);
     get dynamicSegmentCount(): number;
+    /** Tests if an incoming path matches this route */
     matches(path: string): MatchedRoute | UnmatchedRoute;
+    /**
+     * Creates an expanded path value for this route given dynamic input values and allowed query string values
+     */
+    expand(options?: ExpandOptions): string;
     static getDynamicRouteSegmentName(segment: string): string | undefined;
     static dynamicSegmentPrefix: string;
 }
 
-export { MatchedRoute, NodeType, ProjectMapClient, ProjectMapClientOptions, ProjectMapDefinition, ProjectMapDefinitionWithId, ProjectMapDefinitions, ProjectMapDeleteRequest, ProjectMapGetRequest, ProjectMapGetResponse, ProjectMapNode, ProjectMapNodeAllowedQueryString, ProjectMapNodeData, ProjectMapNodeDeleteRequest, ProjectMapNodeGetRequest, ProjectMapNodeGetResponse, ProjectMapNodeUpsertRequest, ProjectMapNodeUpsertRequestNode, ProjectMapNodeWithId, ProjectMapNodeWithProjectMapReference, ProjectMapSubtree, ProjectMapUpsertRequest, ProjectMapUpsertResponse, ROOT_NODE_PATH, Route, UncachedProjectMapClient, UnmatchedRoute };
+export { ExpandOptions, MatchedRoute, NodeType, ProjectMapClient, ProjectMapClientOptions, ProjectMapDefinition, ProjectMapDefinitionWithId, ProjectMapDefinitions, ProjectMapDeleteRequest, ProjectMapGetRequest, ProjectMapGetResponse, ProjectMapNode, ProjectMapNodeAllowedQueryString, ProjectMapNodeData, ProjectMapNodeDeleteRequest, ProjectMapNodeGetRequest, ProjectMapNodeGetResponse, ProjectMapNodeUpsertRequest, ProjectMapNodeUpsertRequestNode, ProjectMapNodeWithId, ProjectMapNodeWithProjectMapReference, ProjectMapSubtree, ProjectMapUpsertRequest, ProjectMapUpsertResponse, ROOT_NODE_PATH, Route, UncachedProjectMapClient, UnmatchedRoute };

package/dist/index.esm.js

@@ -188,6 +188,7 @@ var _Route = class {
       0
     );
   }
+  /** Tests if an incoming path matches this route */
   matches(path) {
     var _a, _b;
     const { segments: pathSegments, queryParams: pathQuery } = __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, path);
@@ -217,6 +218,33 @@ var _Route = class {
     }
     return possibleMatch;
   }
+  /**
+   * Creates an expanded path value for this route given dynamic input values and allowed query string values
+   */
+  expand(options) {
+    const { dynamicInputValues = {}, allowedQueryParams = [] } = options != null ? options : {};
+    const path = __privateGet(this, _routeInfo).segments.map((segment) => {
+      const dynamicSegmentName = _Route.getDynamicRouteSegmentName(segment);
+      if (!dynamicSegmentName) {
+        return segment;
+      }
+      const dynamicSegmentValue = dynamicInputValues[dynamicSegmentName];
+      if (!dynamicSegmentValue) {
+        console.warn(
+          "Missing dynamic input value for",
+          dynamicSegmentName,
+          "in",
+          this.route,
+          "using literal value"
+        );
+        return segment;
+      }
+      return encodeURIComponent(dynamicSegmentValue);
+    }).join("/");
+    const queries = allowedQueryParams.filter((qs) => typeof dynamicInputValues[qs] === "string").map((qs) => `${encodeURIComponent(qs)}=${encodeURIComponent(dynamicInputValues[qs])}`);
+    const query = queries.length ? `?${queries.join("&")}` : "";
+    return `/${path}${query}`;
+  }
   static getDynamicRouteSegmentName(segment) {
     var _a;
     if (!__privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment)) {

package/dist/index.js

@@ -216,6 +216,7 @@ var _Route = class {
       0
     );
   }
+  /** Tests if an incoming path matches this route */
   matches(path) {
     var _a, _b;
     const { segments: pathSegments, queryParams: pathQuery } = __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, path);
@@ -245,6 +246,33 @@ var _Route = class {
     }
     return possibleMatch;
   }
+  /**
+   * Creates an expanded path value for this route given dynamic input values and allowed query string values
+   */
+  expand(options) {
+    const { dynamicInputValues = {}, allowedQueryParams = [] } = options != null ? options : {};
+    const path = __privateGet(this, _routeInfo).segments.map((segment) => {
+      const dynamicSegmentName = _Route.getDynamicRouteSegmentName(segment);
+      if (!dynamicSegmentName) {
+        return segment;
+      }
+      const dynamicSegmentValue = dynamicInputValues[dynamicSegmentName];
+      if (!dynamicSegmentValue) {
+        console.warn(
+          "Missing dynamic input value for",
+          dynamicSegmentName,
+          "in",
+          this.route,
+          "using literal value"
+        );
+        return segment;
+      }
+      return encodeURIComponent(dynamicSegmentValue);
+    }).join("/");
+    const queries = allowedQueryParams.filter((qs) => typeof dynamicInputValues[qs] === "string").map((qs) => `${encodeURIComponent(qs)}=${encodeURIComponent(dynamicInputValues[qs])}`);
+    const query = queries.length ? `?${queries.join("&")}` : "";
+    return `/${path}${query}`;
+  }
   static getDynamicRouteSegmentName(segment) {
     var _a;
     if (!__privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment)) {

package/dist/index.mjs

@@ -188,6 +188,7 @@ var _Route = class {
       0
     );
   }
+  /** Tests if an incoming path matches this route */
   matches(path) {
     var _a, _b;
     const { segments: pathSegments, queryParams: pathQuery } = __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, path);
@@ -217,6 +218,33 @@ var _Route = class {
     }
     return possibleMatch;
   }
+  /**
+   * Creates an expanded path value for this route given dynamic input values and allowed query string values
+   */
+  expand(options) {
+    const { dynamicInputValues = {}, allowedQueryParams = [] } = options != null ? options : {};
+    const path = __privateGet(this, _routeInfo).segments.map((segment) => {
+      const dynamicSegmentName = _Route.getDynamicRouteSegmentName(segment);
+      if (!dynamicSegmentName) {
+        return segment;
+      }
+      const dynamicSegmentValue = dynamicInputValues[dynamicSegmentName];
+      if (!dynamicSegmentValue) {
+        console.warn(
+          "Missing dynamic input value for",
+          dynamicSegmentName,
+          "in",
+          this.route,
+          "using literal value"
+        );
+        return segment;
+      }
+      return encodeURIComponent(dynamicSegmentValue);
+    }).join("/");
+    const queries = allowedQueryParams.filter((qs) => typeof dynamicInputValues[qs] === "string").map((qs) => `${encodeURIComponent(qs)}=${encodeURIComponent(dynamicInputValues[qs])}`);
+    const query = queries.length ? `?${queries.join("&")}` : "";
+    return `/${path}${query}`;
+  }
   static getDynamicRouteSegmentName(segment) {
     var _a;
     if (!__privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/project-map",
-  "version": "19.11.0",
+  "version": "19.12.0",
   "description": "Uniform Project Map",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -32,11 +32,11 @@
     "/dist"
   ],
   "dependencies": {
-    "@uniformdev/canvas": "19.11.0",
-    "@uniformdev/context": "19.11.0"
+    "@uniformdev/canvas": "19.12.0",
+    "@uniformdev/context": "19.12.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "25d492fe923f313b517cbc70d3ff13fdcf97fa34"
+  "gitHead": "ca508c44f1b274e3e47d90717a98036256ae8379"
 }