@uniformdev/project-map 18.5.0 → 18.7.0

package/dist/{chunk-VEO6RNDL.mjs → chunk-4GWDA2EG.mjs}

@@ -106,26 +106,7 @@ var ProjectMapClient = class extends ApiClient {
     };
     this.getSubtree = async (options) => {
       var _a;
-      const { projectId } = this.options;
-      const fetchOptions = {
-        projectId,
-        projectMapId: options.projectMapId
-      };
-      if (options.search) {
-        fetchOptions["search"] = options.search;
-      } else if (options.id) {
-        fetchOptions["id"] = options.id;
-      } else if (options.path && this.validatePath(options.path)) {
-        fetchOptions["path"] = options.path;
-      } else if (options.compositionId) {
-        fetchOptions["compositionId"] = options.compositionId;
-      }
-      if (options.depth) {
-        fetchOptions["depth"] = options.depth.toString();
-      }
-      if (options.expanded) {
-        fetchOptions["expanded"] = "true";
-      }
+      const fetchOptions = this.setFetchOptions(options);
       fetchOptions["tree"] = "true";
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       const result = await this.apiClient(fetchUri);
@@ -149,35 +130,46 @@ var ProjectMapClient = class extends ApiClient {
       return root;
     };
     this.getNodes = async (options) => {
-      const { projectId } = this.options;
-      const fetchOptions = {
-        projectId
-      };
-      if (options.projectMapId) {
-        fetchOptions["projectMapId"] = options.projectMapId;
-      }
-      if (options.search) {
-        fetchOptions["search"] = options.search;
-      } else if (options.id) {
-        fetchOptions["id"] = options.id;
-      } else if (options.path && this.validatePath(options.path)) {
-        fetchOptions["path"] = options.path;
-      } else if (options.compositionId) {
-        fetchOptions["compositionId"] = options.compositionId;
-      }
+      const fetchOptions = this.setFetchOptions(options);
       if (options.limit) {
         fetchOptions["limit"] = options.limit.toString();
       }
       if (options.offset) {
         fetchOptions["offset"] = options.offset.toString();
       }
-      if (options.expanded) {
-        fetchOptions["expanded"] = "true";
-      }
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       return await this.apiClient(fetchUri);
     };
   }
+  setFetchOptions(options) {
+    const { projectId } = this.options;
+    const fetchOptions = {
+      projectId,
+      projectMapId: options.projectMapId
+    };
+    if (options.search) {
+      fetchOptions["search"] = options.search;
+    } else if (options.id) {
+      fetchOptions["id"] = options.id;
+    } else if (options.path && this.validatePath(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";
+    }
+    return fetchOptions;
+  }
   cleanProjectMapNode(node) {
     var _a, _b, _c;
     return {

package/dist/cli/cli.js

@@ -18220,26 +18220,7 @@ var ProjectMapClient = class extends import_api.ApiClient {
     };
     this.getSubtree = async (options) => {
       var _a2;
-      const { projectId } = this.options;
-      const fetchOptions = {
-        projectId,
-        projectMapId: options.projectMapId
-      };
-      if (options.search) {
-        fetchOptions["search"] = options.search;
-      } else if (options.id) {
-        fetchOptions["id"] = options.id;
-      } else if (options.path && this.validatePath(options.path)) {
-        fetchOptions["path"] = options.path;
-      } else if (options.compositionId) {
-        fetchOptions["compositionId"] = options.compositionId;
-      }
-      if (options.depth) {
-        fetchOptions["depth"] = options.depth.toString();
-      }
-      if (options.expanded) {
-        fetchOptions["expanded"] = "true";
-      }
+      const fetchOptions = this.setFetchOptions(options);
       fetchOptions["tree"] = "true";
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       const result = await this.apiClient(fetchUri);
@@ -18263,35 +18244,46 @@ var ProjectMapClient = class extends import_api.ApiClient {
       return root;
     };
     this.getNodes = async (options) => {
-      const { projectId } = this.options;
-      const fetchOptions = {
-        projectId
-      };
-      if (options.projectMapId) {
-        fetchOptions["projectMapId"] = options.projectMapId;
-      }
-      if (options.search) {
-        fetchOptions["search"] = options.search;
-      } else if (options.id) {
-        fetchOptions["id"] = options.id;
-      } else if (options.path && this.validatePath(options.path)) {
-        fetchOptions["path"] = options.path;
-      } else if (options.compositionId) {
-        fetchOptions["compositionId"] = options.compositionId;
-      }
+      const fetchOptions = this.setFetchOptions(options);
       if (options.limit) {
         fetchOptions["limit"] = options.limit.toString();
       }
       if (options.offset) {
         fetchOptions["offset"] = options.offset.toString();
       }
-      if (options.expanded) {
-        fetchOptions["expanded"] = "true";
-      }
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       return await this.apiClient(fetchUri);
     };
   }
+  setFetchOptions(options) {
+    const { projectId } = this.options;
+    const fetchOptions = {
+      projectId,
+      projectMapId: options.projectMapId
+    };
+    if (options.search) {
+      fetchOptions["search"] = options.search;
+    } else if (options.id) {
+      fetchOptions["id"] = options.id;
+    } else if (options.path && this.validatePath(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";
+    }
+    return fetchOptions;
+  }
   cleanProjectMapNode(node) {
     var _a2, _b2, _c2;
     return {

package/dist/cli/cli.mjs

@@ -6,7 +6,7 @@ import {
   __require,
   __toCommonJS,
   __toESM
-} from "../chunk-VEO6RNDL.mjs";
+} from "../chunk-4GWDA2EG.mjs";
 
 // ../../node_modules/.pnpm/ms@2.1.2/node_modules/ms/index.js
 var require_ms = __commonJS({

package/dist/index.d.ts

@@ -196,6 +196,13 @@ interface paths {
                     search?: string;
                     /** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
                     expanded?: boolean;
+                    /** include basic composition information.  ID, type, state, name, and definition id. */
+                    withCompositionData?: boolean;
+                    /**
+                     * @deprecated Returns the UI status string of the composition.
+                     * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
+                     */
+                    withCompositionUIStatus?: boolean;
                 };
             };
             responses: {
@@ -342,6 +349,32 @@ interface components {
             pathSegment?: string;
             /** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
             isLeaf?: boolean;
+            compositionData?: components["schemas"]["ProjectMapNodeCompositionData"];
+        };
+        /** @description Basic information about a composition from the context of a project map node. */
+        ProjectMapNodeCompositionData: {
+            /** @description Type of the composition instance (public_id of its definition) */
+            type: string;
+            /**
+             * Format: uuid
+             * @description The public UUID of the composition.
+             */
+            id: string;
+            /** @description Slug pattern of this composition. */
+            slug?: string | null;
+            /** @description Friendly name of this composition. */
+            name: string;
+            /**
+             * @deprecated
+             * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
+             * @enum {string}
+             */
+            uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
+            /**
+             * @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+             * @default screen
+             */
+            icon?: string;
         };
         ProjectMapNodeUpdate: {
             /**
@@ -503,6 +536,7 @@ declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
     deleteProjectMapNode: (options: WithoutProjectId<ProjectMapNodeDeleteRequest>) => Promise<void>;
     getSubtree: (options: WithoutProjectId<ProjectMapNodeGetRequest>) => Promise<ProjectMapSubtree | undefined>;
     getNodes: (options: WithoutProjectId<ProjectMapNodeGetRequest>) => Promise<ProjectMapNodeGetResponse>;
+    private setFetchOptions;
     private cleanProjectMapNode;
     private validatePath;
 }

package/dist/index.esm.js

@@ -2,7 +2,7 @@ import {
   ProjectMapClient,
   ROOT_NODE_PATH,
   UncachedProjectMapClient
-} from "./chunk-VEO6RNDL.mjs";
+} from "./chunk-4GWDA2EG.mjs";
 export {
   ProjectMapClient,
   ROOT_NODE_PATH,

package/dist/index.js

@@ -97,26 +97,7 @@ var ProjectMapClient = class extends import_api.ApiClient {
     };
     this.getSubtree = async (options) => {
       var _a;
-      const { projectId } = this.options;
-      const fetchOptions = {
-        projectId,
-        projectMapId: options.projectMapId
-      };
-      if (options.search) {
-        fetchOptions["search"] = options.search;
-      } else if (options.id) {
-        fetchOptions["id"] = options.id;
-      } else if (options.path && this.validatePath(options.path)) {
-        fetchOptions["path"] = options.path;
-      } else if (options.compositionId) {
-        fetchOptions["compositionId"] = options.compositionId;
-      }
-      if (options.depth) {
-        fetchOptions["depth"] = options.depth.toString();
-      }
-      if (options.expanded) {
-        fetchOptions["expanded"] = "true";
-      }
+      const fetchOptions = this.setFetchOptions(options);
       fetchOptions["tree"] = "true";
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       const result = await this.apiClient(fetchUri);
@@ -140,35 +121,46 @@ var ProjectMapClient = class extends import_api.ApiClient {
       return root;
     };
     this.getNodes = async (options) => {
-      const { projectId } = this.options;
-      const fetchOptions = {
-        projectId
-      };
-      if (options.projectMapId) {
-        fetchOptions["projectMapId"] = options.projectMapId;
-      }
-      if (options.search) {
-        fetchOptions["search"] = options.search;
-      } else if (options.id) {
-        fetchOptions["id"] = options.id;
-      } else if (options.path && this.validatePath(options.path)) {
-        fetchOptions["path"] = options.path;
-      } else if (options.compositionId) {
-        fetchOptions["compositionId"] = options.compositionId;
-      }
+      const fetchOptions = this.setFetchOptions(options);
       if (options.limit) {
         fetchOptions["limit"] = options.limit.toString();
       }
       if (options.offset) {
         fetchOptions["offset"] = options.offset.toString();
       }
-      if (options.expanded) {
-        fetchOptions["expanded"] = "true";
-      }
       const fetchUri = this.createUrl("/api/v1/project-map-nodes", fetchOptions);
       return await this.apiClient(fetchUri);
     };
   }
+  setFetchOptions(options) {
+    const { projectId } = this.options;
+    const fetchOptions = {
+      projectId,
+      projectMapId: options.projectMapId
+    };
+    if (options.search) {
+      fetchOptions["search"] = options.search;
+    } else if (options.id) {
+      fetchOptions["id"] = options.id;
+    } else if (options.path && this.validatePath(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";
+    }
+    return fetchOptions;
+  }
   cleanProjectMapNode(node) {
     var _a, _b, _c;
     return {

package/dist/index.mjs

@@ -2,7 +2,7 @@ import {
   ProjectMapClient,
   ROOT_NODE_PATH,
   UncachedProjectMapClient
-} from "./chunk-VEO6RNDL.mjs";
+} from "./chunk-4GWDA2EG.mjs";
 export {
   ProjectMapClient,
   ROOT_NODE_PATH,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/project-map",
-  "version": "18.5.0",
+  "version": "18.7.0",
   "description": "Uniform Project Map",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -46,17 +46,17 @@
     "/dist"
   ],
   "dependencies": {
-    "@uniformdev/canvas": "18.5.0",
-    "@uniformdev/context": "18.5.0",
+    "@uniformdev/canvas": "18.7.0",
+    "@uniformdev/context": "18.7.0",
     "p-limit": "^3.1.0"
   },
   "devDependencies": {
     "@types/yargs": "17.0.20",
-    "@uniformdev/cli": "18.5.0",
+    "@uniformdev/cli": "18.7.0",
     "yargs": "17.6.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "757923e90bece28162621d867709e08674bdaa05"
+  "gitHead": "eaf3d0e5c1c124d6b449a2f2b16b327d6f3d3666"
 }