@uniformdev/project-map 19.1.1-alpha.1 → 19.3.0

package/dist/index.d.ts

@@ -335,10 +335,7 @@ interface components {
             path: string;
             /** @description Ordering of the node, higher numbers go after lower numbers. */
             order?: number;
-            /** @description Data associated with this projectMap node */
-            data?: {
-                [key: string]: unknown;
-            };
+            data?: components["schemas"]["ProjectMapNodeData"];
             /** @description The name of the projectMap entry */
             name: string;
             /**
@@ -398,10 +395,7 @@ interface components {
             path: string;
             /** @description Ordering of the node, higher numbers go after lower numbers. */
             order?: number;
-            /** @description Data associated with this projectMap node */
-            data?: {
-                [key: string]: unknown;
-            };
+            data?: components["schemas"]["ProjectMapNodeData"];
             /** @description The name of the projectMap entry */
             name: string;
             /**
@@ -417,6 +411,20 @@ interface components {
             /** @description Description of the projectMap node */
             description?: string;
         };
+        ProjectMapNodeData: {
+            /** @description While performing a search if a node is a hit, this property will return true.  If it's supporting structure, like a parent of a search hit, it will return false */
+            isSearchHit?: boolean;
+            /** @description Query strings that are allowed to be passed to the node */
+            queryStrings?: components["schemas"]["ProjectMapNodeAllowedQueryString"][];
+        };
+        ProjectMapNodeAllowedQueryString: {
+            /** @description The name of the query string parameter */
+            name?: string;
+            /** @description The default value of the query string if it is not provided by an incoming route path */
+            value?: string;
+            /** @description Help text for authors who might be setting up a preview value for this query string */
+            helpText?: string;
+        };
     };
 }
 interface external {
@@ -500,6 +508,8 @@ type ProjectMapDefinitions = {
     projectMaps: ProjectMapDefinitionWithId[];
     projectMapNodes: ProjectMapNodeWithProjectMapReference[];
 };
+type ProjectMapNodeData = components['schemas']['ProjectMapNodeData'];
+type ProjectMapNodeAllowedQueryString = components['schemas']['ProjectMapNodeAllowedQueryString'];
 
 declare const ROOT_NODE_PATH = "/";
 type ProjectMapClientOptions = {
@@ -558,4 +568,26 @@ declare class UncachedProjectMapClient extends ProjectMapClient {
     constructor(options: Omit<ProjectMapClientOptions, 'bypassCache'>);
 }
 
-export { NodeType, ProjectMapClient, ProjectMapClientOptions, ProjectMapDefinition, ProjectMapDefinitionWithId, ProjectMapDefinitions, ProjectMapDeleteRequest, ProjectMapGetRequest, ProjectMapGetResponse, ProjectMapNode, ProjectMapNodeDeleteRequest, ProjectMapNodeGetRequest, ProjectMapNodeGetResponse, ProjectMapNodeUpsertRequest, ProjectMapNodeUpsertRequestNode, ProjectMapNodeWithId, ProjectMapNodeWithProjectMapReference, ProjectMapSubtree, ProjectMapUpsertRequest, ProjectMapUpsertResponse, ROOT_NODE_PATH, UncachedProjectMapClient };
+type MatchedRoute = {
+    match: true;
+    dynamicSegmentCount: number;
+    pathParams: {
+        [key: string]: string;
+    };
+    queryParams: {
+        [key: string]: string;
+    };
+};
+type UnmatchedRoute = {
+    match: false;
+};
+declare class Route {
+    #private;
+    readonly route: string;
+    constructor(route: string);
+    get dynamicSegmentCount(): number;
+    matches(path: string): MatchedRoute | UnmatchedRoute;
+    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 };

package/dist/index.esm.js

@@ -1,3 +1,26 @@
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+var __privateMethod = (obj, member, method) => {
+  __accessCheck(obj, member, "access private method");
+  return method;
+};
+
 // src/projectMapClient.ts
 import { ApiClient } from "@uniformdev/context/api";
 var ROOT_NODE_PATH = "/";
@@ -160,8 +183,78 @@ var cutReferences = (node) => node ? {
   parent: void 0,
   children: void 0
 } : void 0;
+
+// src/util/Route.ts
+var _routeInfo, _parseRouteOrPath, parseRouteOrPath_fn, _isDynamicRouteSegment, isDynamicRouteSegment_fn;
+var _Route = class {
+  constructor(route) {
+    this.route = route;
+    __privateAdd(this, _routeInfo, void 0);
+    var _a;
+    __privateSet(this, _routeInfo, __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, this.route));
+  }
+  get dynamicSegmentCount() {
+    return __privateGet(this, _routeInfo).segments.reduce(
+      (count, segment) => {
+        var _a;
+        return __privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment) ? count + 1 : count;
+      },
+      0
+    );
+  }
+  matches(path) {
+    var _a, _b;
+    const { segments: pathSegments, queryParams: pathQuery } = __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, path);
+    const { segments: routeSegments } = __privateGet(this, _routeInfo);
+    if (pathSegments.length !== routeSegments.length) {
+      return { match: false };
+    }
+    const possibleMatch = {
+      match: true,
+      dynamicSegmentCount: 0,
+      pathParams: {},
+      queryParams: {}
+    };
+    for (let i = 0; i < routeSegments.length; i++) {
+      const routeSegment = routeSegments[i];
+      const pathSegment = pathSegments[i];
+      if (__privateMethod(_b = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_b, routeSegment)) {
+        const key = routeSegment.slice(1);
+        possibleMatch.pathParams[key] = pathSegment;
+        possibleMatch.dynamicSegmentCount++;
+      } else if (routeSegment !== pathSegment) {
+        return { match: false };
+      }
+    }
+    for (const [key, value] of __privateGet(this, _routeInfo).queryParams) {
+      possibleMatch.queryParams[key] = pathQuery.has(key) ? pathQuery.get(key) : value;
+    }
+    return possibleMatch;
+  }
+};
+var Route = _Route;
+_routeInfo = new WeakMap();
+_parseRouteOrPath = new WeakSet();
+parseRouteOrPath_fn = function(path) {
+  if (!path.startsWith("/") || path === "") {
+    throw new Error(`Path must start with a slash: ${path}`);
+  }
+  const pathSegments = path.substring(1).split("/");
+  const [lastSegmentWithoutQuery, queryString] = pathSegments[pathSegments.length - 1].split("?");
+  pathSegments[pathSegments.length - 1] = lastSegmentWithoutQuery;
+  const queryParams = new URLSearchParams(queryString);
+  return { segments: pathSegments, queryParams };
+};
+_isDynamicRouteSegment = new WeakSet();
+isDynamicRouteSegment_fn = function(segment) {
+  return segment.startsWith(_Route.dynamicSegmentPrefix);
+};
+__privateAdd(Route, _parseRouteOrPath);
+__privateAdd(Route, _isDynamicRouteSegment);
+Route.dynamicSegmentPrefix = ":";
 export {
   ProjectMapClient,
   ROOT_NODE_PATH,
+  Route,
   UncachedProjectMapClient
 };

package/dist/index.js

@@ -16,12 +16,35 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+var __privateMethod = (obj, member, method) => {
+  __accessCheck(obj, member, "access private method");
+  return method;
+};
 
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
   ProjectMapClient: () => ProjectMapClient,
   ROOT_NODE_PATH: () => ROOT_NODE_PATH,
+  Route: () => Route,
   UncachedProjectMapClient: () => UncachedProjectMapClient
 });
 module.exports = __toCommonJS(src_exports);
@@ -188,9 +211,79 @@ var cutReferences = (node) => node ? {
   parent: void 0,
   children: void 0
 } : void 0;
+
+// src/util/Route.ts
+var _routeInfo, _parseRouteOrPath, parseRouteOrPath_fn, _isDynamicRouteSegment, isDynamicRouteSegment_fn;
+var _Route = class {
+  constructor(route) {
+    this.route = route;
+    __privateAdd(this, _routeInfo, void 0);
+    var _a;
+    __privateSet(this, _routeInfo, __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, this.route));
+  }
+  get dynamicSegmentCount() {
+    return __privateGet(this, _routeInfo).segments.reduce(
+      (count, segment) => {
+        var _a;
+        return __privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment) ? count + 1 : count;
+      },
+      0
+    );
+  }
+  matches(path) {
+    var _a, _b;
+    const { segments: pathSegments, queryParams: pathQuery } = __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, path);
+    const { segments: routeSegments } = __privateGet(this, _routeInfo);
+    if (pathSegments.length !== routeSegments.length) {
+      return { match: false };
+    }
+    const possibleMatch = {
+      match: true,
+      dynamicSegmentCount: 0,
+      pathParams: {},
+      queryParams: {}
+    };
+    for (let i = 0; i < routeSegments.length; i++) {
+      const routeSegment = routeSegments[i];
+      const pathSegment = pathSegments[i];
+      if (__privateMethod(_b = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_b, routeSegment)) {
+        const key = routeSegment.slice(1);
+        possibleMatch.pathParams[key] = pathSegment;
+        possibleMatch.dynamicSegmentCount++;
+      } else if (routeSegment !== pathSegment) {
+        return { match: false };
+      }
+    }
+    for (const [key, value] of __privateGet(this, _routeInfo).queryParams) {
+      possibleMatch.queryParams[key] = pathQuery.has(key) ? pathQuery.get(key) : value;
+    }
+    return possibleMatch;
+  }
+};
+var Route = _Route;
+_routeInfo = new WeakMap();
+_parseRouteOrPath = new WeakSet();
+parseRouteOrPath_fn = function(path) {
+  if (!path.startsWith("/") || path === "") {
+    throw new Error(`Path must start with a slash: ${path}`);
+  }
+  const pathSegments = path.substring(1).split("/");
+  const [lastSegmentWithoutQuery, queryString] = pathSegments[pathSegments.length - 1].split("?");
+  pathSegments[pathSegments.length - 1] = lastSegmentWithoutQuery;
+  const queryParams = new URLSearchParams(queryString);
+  return { segments: pathSegments, queryParams };
+};
+_isDynamicRouteSegment = new WeakSet();
+isDynamicRouteSegment_fn = function(segment) {
+  return segment.startsWith(_Route.dynamicSegmentPrefix);
+};
+__privateAdd(Route, _parseRouteOrPath);
+__privateAdd(Route, _isDynamicRouteSegment);
+Route.dynamicSegmentPrefix = ":";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ProjectMapClient,
   ROOT_NODE_PATH,
+  Route,
   UncachedProjectMapClient
 });

package/dist/index.mjs

@@ -1,3 +1,26 @@
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+var __privateMethod = (obj, member, method) => {
+  __accessCheck(obj, member, "access private method");
+  return method;
+};
+
 // src/projectMapClient.ts
 import { ApiClient } from "@uniformdev/context/api";
 var ROOT_NODE_PATH = "/";
@@ -160,8 +183,78 @@ var cutReferences = (node) => node ? {
   parent: void 0,
   children: void 0
 } : void 0;
+
+// src/util/Route.ts
+var _routeInfo, _parseRouteOrPath, parseRouteOrPath_fn, _isDynamicRouteSegment, isDynamicRouteSegment_fn;
+var _Route = class {
+  constructor(route) {
+    this.route = route;
+    __privateAdd(this, _routeInfo, void 0);
+    var _a;
+    __privateSet(this, _routeInfo, __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, this.route));
+  }
+  get dynamicSegmentCount() {
+    return __privateGet(this, _routeInfo).segments.reduce(
+      (count, segment) => {
+        var _a;
+        return __privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment) ? count + 1 : count;
+      },
+      0
+    );
+  }
+  matches(path) {
+    var _a, _b;
+    const { segments: pathSegments, queryParams: pathQuery } = __privateMethod(_a = _Route, _parseRouteOrPath, parseRouteOrPath_fn).call(_a, path);
+    const { segments: routeSegments } = __privateGet(this, _routeInfo);
+    if (pathSegments.length !== routeSegments.length) {
+      return { match: false };
+    }
+    const possibleMatch = {
+      match: true,
+      dynamicSegmentCount: 0,
+      pathParams: {},
+      queryParams: {}
+    };
+    for (let i = 0; i < routeSegments.length; i++) {
+      const routeSegment = routeSegments[i];
+      const pathSegment = pathSegments[i];
+      if (__privateMethod(_b = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_b, routeSegment)) {
+        const key = routeSegment.slice(1);
+        possibleMatch.pathParams[key] = pathSegment;
+        possibleMatch.dynamicSegmentCount++;
+      } else if (routeSegment !== pathSegment) {
+        return { match: false };
+      }
+    }
+    for (const [key, value] of __privateGet(this, _routeInfo).queryParams) {
+      possibleMatch.queryParams[key] = pathQuery.has(key) ? pathQuery.get(key) : value;
+    }
+    return possibleMatch;
+  }
+};
+var Route = _Route;
+_routeInfo = new WeakMap();
+_parseRouteOrPath = new WeakSet();
+parseRouteOrPath_fn = function(path) {
+  if (!path.startsWith("/") || path === "") {
+    throw new Error(`Path must start with a slash: ${path}`);
+  }
+  const pathSegments = path.substring(1).split("/");
+  const [lastSegmentWithoutQuery, queryString] = pathSegments[pathSegments.length - 1].split("?");
+  pathSegments[pathSegments.length - 1] = lastSegmentWithoutQuery;
+  const queryParams = new URLSearchParams(queryString);
+  return { segments: pathSegments, queryParams };
+};
+_isDynamicRouteSegment = new WeakSet();
+isDynamicRouteSegment_fn = function(segment) {
+  return segment.startsWith(_Route.dynamicSegmentPrefix);
+};
+__privateAdd(Route, _parseRouteOrPath);
+__privateAdd(Route, _isDynamicRouteSegment);
+Route.dynamicSegmentPrefix = ":";
 export {
   ProjectMapClient,
   ROOT_NODE_PATH,
+  Route,
   UncachedProjectMapClient
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/project-map",
-  "version": "19.1.1-alpha.1+3ec68fe9d",
+  "version": "19.3.0",
   "description": "Uniform Project Map",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -32,11 +32,11 @@
     "/dist"
   ],
   "dependencies": {
-    "@uniformdev/canvas": "19.1.1-alpha.1+3ec68fe9d",
-    "@uniformdev/context": "19.1.1-alpha.1+3ec68fe9d"
+    "@uniformdev/canvas": "19.3.0",
+    "@uniformdev/context": "19.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3ec68fe9d54c7128e57cc8a5c8116fe968f65865"
+  "gitHead": "57552ffe10ca66f905d8908c82dde39935fb1803"
 }