@uniformdev/project-map 19.3.0 → 19.6.0

package/dist/index.d.ts

@@ -189,14 +189,19 @@ interface paths {
                     limit?: number;
                     /** Number of records to skip before returning nodes */
                     offset?: number;
-                    /** Depth of the tree to fetch */
+                    /** Depth of the tree to fetch. Only applies when fetching by path. */
                     depth?: number;
                     /** State of compositions to fetch. 0 = draft, 64 = published. */
                     state?: number;
-                    /** should the data be returned as a json tree object */
+                    /** should the data be returned as a json tree object (or a flat array) */
                     tree?: boolean;
                     /** text search filter */
                     search?: string;
+                    /**
+                     * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
+                     * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
+                     */
+                    includeAncestors?: boolean;
                     /** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
                     expanded?: boolean;
                     /** include basic composition information.  ID, type, state, name, and definition id. */
@@ -416,12 +421,18 @@ interface components {
             isSearchHit?: boolean;
             /** @description Query strings that are allowed to be passed to the node */
             queryStrings?: components["schemas"]["ProjectMapNodeAllowedQueryString"][];
+            /**
+             * @description For dynamic nodes, this is the preview value for the dynamic value.
+             * The preview value is used when editing a connected composition, and is the default
+             * dynamic node value unless the author has explicitly chosen a different value.
+             */
+            previewValue?: string;
         };
         ProjectMapNodeAllowedQueryString: {
             /** @description The name of the query string parameter */
-            name?: string;
+            name: string;
             /** @description The default value of the query string if it is not provided by an incoming route path */
-            value?: string;
+            value: string;
             /** @description Help text for authors who might be setting up a preview value for this query string */
             helpText?: string;
         };
@@ -587,6 +598,7 @@ declare class Route {
     constructor(route: string);
     get dynamicSegmentCount(): number;
     matches(path: string): MatchedRoute | UnmatchedRoute;
+    static getDynamicRouteSegmentName(segment: string): string | undefined;
     static dynamicSegmentPrefix: string;
 }
 

package/dist/index.esm.js

@@ -117,12 +117,6 @@ var ProjectMapClient = class extends ApiClient {
     };
     this.getNodes = async (options) => {
       const fetchOptions = this.setFetchOptions(options);
-      if (options.limit) {
-        fetchOptions["limit"] = options.limit.toString();
-      }
-      if (options.offset) {
-        fetchOptions["offset"] = options.offset.toString();
-      }
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       return await this.apiClient(fetchUri);
     };
@@ -130,33 +124,25 @@ var ProjectMapClient = class extends ApiClient {
   setFetchOptions(options) {
     const { projectId } = this.options;
     const fetchOptions = {
-      projectId,
-      projectMapId: options.projectMapId
+      projectId
     };
-    if (options.search) {
-      fetchOptions["search"] = options.search;
-    } else if (options.id) {
-      fetchOptions["id"] = options.id;
-    } else if (options.path) {
-      fetchOptions["path"] = options.path;
-    } else if (options.compositionId) {
-      fetchOptions["compositionId"] = options.compositionId;
-    }
-    if (options.withCompositionData) {
-      fetchOptions["withCompositionData"] = "true";
-    }
-    if (options.withCompositionUIStatus) {
-      fetchOptions["withCompositionUIStatus"] = "true";
-    }
-    if (options.depth) {
-      fetchOptions["depth"] = options.depth.toString();
-    }
-    if (options.expanded) {
-      fetchOptions["expanded"] = "true";
-    }
-    if (options.state) {
-      fetchOptions["state"] = options.state.toString();
-    }
+    Object.entries(options).forEach(([key, value]) => {
+      if (value === void 0) {
+        return;
+      }
+      if (typeof value === "boolean") {
+        if (!value) {
+          return;
+        }
+        fetchOptions[key] = "true";
+        return;
+      }
+      if (typeof value === "number") {
+        fetchOptions[key] = value.toString(10);
+        return;
+      }
+      fetchOptions[key] = value;
+    });
     return fetchOptions;
   }
   cleanProjectMapNode(node) {
@@ -231,6 +217,13 @@ var _Route = class {
     }
     return possibleMatch;
   }
+  static getDynamicRouteSegmentName(segment) {
+    var _a;
+    if (!__privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment)) {
+      return void 0;
+    }
+    return segment.slice(_Route.dynamicSegmentPrefix.length);
+  }
 };
 var Route = _Route;
 _routeInfo = new WeakMap();

package/dist/index.js

@@ -145,12 +145,6 @@ var ProjectMapClient = class extends import_api.ApiClient {
     };
     this.getNodes = async (options) => {
       const fetchOptions = this.setFetchOptions(options);
-      if (options.limit) {
-        fetchOptions["limit"] = options.limit.toString();
-      }
-      if (options.offset) {
-        fetchOptions["offset"] = options.offset.toString();
-      }
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       return await this.apiClient(fetchUri);
     };
@@ -158,33 +152,25 @@ var ProjectMapClient = class extends import_api.ApiClient {
   setFetchOptions(options) {
     const { projectId } = this.options;
     const fetchOptions = {
-      projectId,
-      projectMapId: options.projectMapId
+      projectId
     };
-    if (options.search) {
-      fetchOptions["search"] = options.search;
-    } else if (options.id) {
-      fetchOptions["id"] = options.id;
-    } else if (options.path) {
-      fetchOptions["path"] = options.path;
-    } else if (options.compositionId) {
-      fetchOptions["compositionId"] = options.compositionId;
-    }
-    if (options.withCompositionData) {
-      fetchOptions["withCompositionData"] = "true";
-    }
-    if (options.withCompositionUIStatus) {
-      fetchOptions["withCompositionUIStatus"] = "true";
-    }
-    if (options.depth) {
-      fetchOptions["depth"] = options.depth.toString();
-    }
-    if (options.expanded) {
-      fetchOptions["expanded"] = "true";
-    }
-    if (options.state) {
-      fetchOptions["state"] = options.state.toString();
-    }
+    Object.entries(options).forEach(([key, value]) => {
+      if (value === void 0) {
+        return;
+      }
+      if (typeof value === "boolean") {
+        if (!value) {
+          return;
+        }
+        fetchOptions[key] = "true";
+        return;
+      }
+      if (typeof value === "number") {
+        fetchOptions[key] = value.toString(10);
+        return;
+      }
+      fetchOptions[key] = value;
+    });
     return fetchOptions;
   }
   cleanProjectMapNode(node) {
@@ -259,6 +245,13 @@ var _Route = class {
     }
     return possibleMatch;
   }
+  static getDynamicRouteSegmentName(segment) {
+    var _a;
+    if (!__privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment)) {
+      return void 0;
+    }
+    return segment.slice(_Route.dynamicSegmentPrefix.length);
+  }
 };
 var Route = _Route;
 _routeInfo = new WeakMap();

package/dist/index.mjs

@@ -117,12 +117,6 @@ var ProjectMapClient = class extends ApiClient {
     };
     this.getNodes = async (options) => {
       const fetchOptions = this.setFetchOptions(options);
-      if (options.limit) {
-        fetchOptions["limit"] = options.limit.toString();
-      }
-      if (options.offset) {
-        fetchOptions["offset"] = options.offset.toString();
-      }
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       return await this.apiClient(fetchUri);
     };
@@ -130,33 +124,25 @@ var ProjectMapClient = class extends ApiClient {
   setFetchOptions(options) {
     const { projectId } = this.options;
     const fetchOptions = {
-      projectId,
-      projectMapId: options.projectMapId
+      projectId
     };
-    if (options.search) {
-      fetchOptions["search"] = options.search;
-    } else if (options.id) {
-      fetchOptions["id"] = options.id;
-    } else if (options.path) {
-      fetchOptions["path"] = options.path;
-    } else if (options.compositionId) {
-      fetchOptions["compositionId"] = options.compositionId;
-    }
-    if (options.withCompositionData) {
-      fetchOptions["withCompositionData"] = "true";
-    }
-    if (options.withCompositionUIStatus) {
-      fetchOptions["withCompositionUIStatus"] = "true";
-    }
-    if (options.depth) {
-      fetchOptions["depth"] = options.depth.toString();
-    }
-    if (options.expanded) {
-      fetchOptions["expanded"] = "true";
-    }
-    if (options.state) {
-      fetchOptions["state"] = options.state.toString();
-    }
+    Object.entries(options).forEach(([key, value]) => {
+      if (value === void 0) {
+        return;
+      }
+      if (typeof value === "boolean") {
+        if (!value) {
+          return;
+        }
+        fetchOptions[key] = "true";
+        return;
+      }
+      if (typeof value === "number") {
+        fetchOptions[key] = value.toString(10);
+        return;
+      }
+      fetchOptions[key] = value;
+    });
     return fetchOptions;
   }
   cleanProjectMapNode(node) {
@@ -231,6 +217,13 @@ var _Route = class {
     }
     return possibleMatch;
   }
+  static getDynamicRouteSegmentName(segment) {
+    var _a;
+    if (!__privateMethod(_a = _Route, _isDynamicRouteSegment, isDynamicRouteSegment_fn).call(_a, segment)) {
+      return void 0;
+    }
+    return segment.slice(_Route.dynamicSegmentPrefix.length);
+  }
 };
 var Route = _Route;
 _routeInfo = new WeakMap();

package/package.json

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