@dronedeploy/rocos-js-sdk 3.1.4 → 3.1.5-rc1

package/cjs/services/MapService.d.ts

@@ -117,17 +117,25 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
      */
     delete(projectId: string, mapId: string, callsign: string, hash: string): Promise<void>;
     /**
-     * Creates a new map with the supplied canonical content.
+     * Creates a new map with the supplied canonical content, and optionally seeds its
+     * description in the same call.
      *
      * The server requires at least one node in the content; an empty `{nodes:{},
      * edges:{}}` payload is rejected. Server-managed metadata (SUMMARY, MAP_INFO,
      * hash, timestamp) is created automatically.
      *
+     * When `options.description` is supplied, the server writes it into the map's
+     * SUMMARY in the same goroutine as the create — atomically replacing the
+     * historic create-then-{@link updateMetadata} two-step.
+     *
      * @param projectId Project ID
      * @param mapId The mapId to create. Must be unique within the project.
      * @param content Canonical map content (`{nodes, edges}`).
+     * @param options Optional `description` to seed alongside the new map.
      */
-    create(projectId: string, mapId: string, content: MapContent): Promise<void>;
+    create(projectId: string, mapId: string, content: MapContent, options?: {
+        description?: string;
+    }): Promise<void>;
     /**
      * Makes a copy of an existing cloud map under a new mapId.
      *

package/cjs/services/MapService.js

@@ -165,21 +165,34 @@ class MapService extends BaseServiceAbstract_1.BaseServiceAbstract {
         }, this.config.insecure), 'Failed to delete map.', callsign ? { callsign, hash } : {});
     }
     /**
-     * Creates a new map with the supplied canonical content.
+     * Creates a new map with the supplied canonical content, and optionally seeds its
+     * description in the same call.
      *
      * The server requires at least one node in the content; an empty `{nodes:{},
      * edges:{}}` payload is rejected. Server-managed metadata (SUMMARY, MAP_INFO,
      * hash, timestamp) is created automatically.
      *
+     * When `options.description` is supplied, the server writes it into the map's
+     * SUMMARY in the same goroutine as the create — atomically replacing the
+     * historic create-then-{@link updateMetadata} two-step.
+     *
      * @param projectId Project ID
      * @param mapId The mapId to create. Must be unique within the project.
      * @param content Canonical map content (`{nodes, edges}`).
+     * @param options Optional `description` to seed alongside the new map.
      */
-    async create(projectId, mapId, content) {
+    async create(projectId, mapId, content, options = {}) {
+        const body = {
+            mapId,
+            content,
+        };
+        if (options.description) {
+            body.metadata = { description: options.description };
+        }
         return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_GRAPHS_MAPS_NEW_URL, {
             url: this.config.url,
             projectId,
-        }, this.config.insecure), { mapId, map: content }, 'Failed to create map.');
+        }, this.config.insecure), body, 'Failed to create map.');
     }
     /**
      * Makes a copy of an existing cloud map under a new mapId.

package/esm/services/MapService.d.ts

@@ -117,17 +117,25 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
      */
     delete(projectId: string, mapId: string, callsign: string, hash: string): Promise<void>;
     /**
-     * Creates a new map with the supplied canonical content.
+     * Creates a new map with the supplied canonical content, and optionally seeds its
+     * description in the same call.
      *
      * The server requires at least one node in the content; an empty `{nodes:{},
      * edges:{}}` payload is rejected. Server-managed metadata (SUMMARY, MAP_INFO,
      * hash, timestamp) is created automatically.
      *
+     * When `options.description` is supplied, the server writes it into the map's
+     * SUMMARY in the same goroutine as the create — atomically replacing the
+     * historic create-then-{@link updateMetadata} two-step.
+     *
      * @param projectId Project ID
      * @param mapId The mapId to create. Must be unique within the project.
      * @param content Canonical map content (`{nodes, edges}`).
+     * @param options Optional `description` to seed alongside the new map.
      */
-    create(projectId: string, mapId: string, content: MapContent): Promise<void>;
+    create(projectId: string, mapId: string, content: MapContent, options?: {
+        description?: string;
+    }): Promise<void>;
     /**
      * Makes a copy of an existing cloud map under a new mapId.
      *

package/esm/services/MapService.js

@@ -162,21 +162,34 @@ export class MapService extends BaseServiceAbstract {
         }, this.config.insecure), 'Failed to delete map.', callsign ? { callsign, hash } : {});
     }
     /**
-     * Creates a new map with the supplied canonical content.
+     * Creates a new map with the supplied canonical content, and optionally seeds its
+     * description in the same call.
      *
      * The server requires at least one node in the content; an empty `{nodes:{},
      * edges:{}}` payload is rejected. Server-managed metadata (SUMMARY, MAP_INFO,
      * hash, timestamp) is created automatically.
      *
+     * When `options.description` is supplied, the server writes it into the map's
+     * SUMMARY in the same goroutine as the create — atomically replacing the
+     * historic create-then-{@link updateMetadata} two-step.
+     *
      * @param projectId Project ID
      * @param mapId The mapId to create. Must be unique within the project.
      * @param content Canonical map content (`{nodes, edges}`).
+     * @param options Optional `description` to seed alongside the new map.
      */
-    async create(projectId, mapId, content) {
+    async create(projectId, mapId, content, options = {}) {
+        const body = {
+            mapId,
+            content,
+        };
+        if (options.description) {
+            body.metadata = { description: options.description };
+        }
         return this.callPost(formatServiceUrl(API_GRAPHS_MAPS_NEW_URL, {
             url: this.config.url,
             projectId,
-        }, this.config.insecure), { mapId, map: content }, 'Failed to create map.');
+        }, this.config.insecure), body, 'Failed to create map.');
     }
     /**
      * Makes a copy of an existing cloud map under a new mapId.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.1.4",
+  "version": "3.1.5-rc1",
   "description": "Javascript SDK for rocos",
   "main": "cjs/index.js",
   "module": "esm/index.js",