@dronedeploy/rocos-js-sdk 3.0.31-rc1 → 3.1.0

package/esm/services/MapService.d.ts

@@ -1,4 +1,4 @@
-import { Asset, IBaseService, IRocosSDKConfig, Map, RocosError } from '../models';
+import { Asset, IBaseService, IRocosSDKConfig, Map, MapContent, RocosError } from '../models';
 import { CreateObservation, Observation } from '../models/maps/Panorama';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 /**
@@ -50,7 +50,14 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
      */
     get(projectId: string, mapId: string): Promise<Map>;
     /**
-     * Updates a maps metadata
+     * Updates a map's metadata.
+     *
+     * @deprecated Hits the legacy `PUT /maps/{mapId}` endpoint that only accepts
+     * metadata; the giraffe API is migrating that endpoint toward "PUT the full
+     * resource" semantics (both metadata and content together). Prefer
+     * {@link updateMetadata} for metadata-only changes and {@link updateContent}
+     * for graph-content replacement.
+     *
      * @param projectId Project ID
      * @param mapId Map ID
      * @param options New metadata
@@ -59,6 +66,30 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
         description?: string;
         callsign?: string;
     }): Promise<void>;
+    /**
+     * Updates a map's metadata via the granular `/metadata` endpoint.
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param options New metadata fields. `description` is required by the
+     * backend; sending an empty value returns a 400.
+     */
+    updateMetadata(projectId: string, mapId: string, options: {
+        description: string;
+    }): Promise<void>;
+    /**
+     * Replaces the graph content of an existing cloud map with the supplied
+     * canonical `{ nodes, edges }` payload.
+     *
+     * Server-managed parts (SUMMARY, MAP_INFO identity fields, MAP_INFO
+     * timestamp, content hash) are preserved or recomputed by the backend; a
+     * byte-identical content payload is a no-op on the server (idempotent).
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param content Canonical map content to write
+     */
+    updateContent(projectId: string, mapId: string, content: MapContent): Promise<void>;
     /**
      * Begins uploading a map from the agent
      *
@@ -86,15 +117,36 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
      */
     delete(projectId: string, mapId: string, callsign: string, hash: string): Promise<void>;
     /**
-     * Makes a copy of an uploaded map
+     * Creates a new map with the supplied canonical content.
+     *
+     * 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.
      *
      * @param projectId Project ID
-     * @param mapId Map ID
-     * @param options Options to create the new map
+     * @param mapId The mapId to create. Must be unique within the project.
+     * @param content Canonical map content (`{nodes, edges}`).
+     */
+    create(projectId: string, mapId: string, content: MapContent): Promise<void>;
+    /**
+     * Makes a copy of an existing cloud map under a new mapId.
+     *
+     * If `options.name` is omitted, the server picks an available
+     * `<sourceMapId>-copy[-N]` slot. The resolved mapId is returned so the
+     * caller knows where to look for the copy. The write is asynchronous on the
+     * server side - the copy may not be immediately readable via `get()`.
+     *
+     * @param projectId Project ID
+     * @param mapId Source map ID
+     * @param options Optional `name` (new mapId) and `description` for the copy
+     * @returns The mapId assigned to the new copy
      */
     copy(projectId: string, mapId: string, options: {
+        name?: string;
         description?: string;
-    }): Promise<void>;
+    }): Promise<{
+        mapId: string;
+    }>;
     /** Deploy a map from the cloud to a robot
      *
      * @param projectId Project ID

package/esm/services/MapService.js

@@ -1,4 +1,4 @@
-import { API_GRAPHS_MAPS_COPY_URL, API_GRAPHS_MAPS_DEPLOYED_URL, API_GRAPHS_MAPS_DEPLOY_URL, API_GRAPHS_MAPS_GEOJSON_URL, API_GRAPHS_MAPS_MERGE_URL, API_GRAPHS_MAPS_URL, API_GRAPHS_MAP_ID_URL, API_GRAPHS_OBSERVATIONS_URL, API_GRAPHS_OBSERVATION_KEYS_URL, API_GRAPHS_PANORAMA, API_GRAPHS_PANORAMA_OBSERVATIONS_URL, } from '../constants/api';
+import { API_GRAPHS_MAPS_COPY_URL, API_GRAPHS_MAPS_DEPLOYED_URL, API_GRAPHS_MAPS_DEPLOY_URL, API_GRAPHS_MAPS_GEOJSON_URL, API_GRAPHS_MAPS_MERGE_URL, API_GRAPHS_MAPS_NEW_URL, API_GRAPHS_MAPS_URL, API_GRAPHS_MAP_CONTENT_URL, API_GRAPHS_MAP_ID_URL, API_GRAPHS_MAP_METADATA_URL, API_GRAPHS_OBSERVATIONS_URL, API_GRAPHS_OBSERVATION_KEYS_URL, API_GRAPHS_PANORAMA, API_GRAPHS_PANORAMA_OBSERVATIONS_URL, } from '../constants/api';
 import { RocosError, errorCodes } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
@@ -86,7 +86,14 @@ export class MapService extends BaseServiceAbstract {
         }, this.config.insecure), 'Failed to get map.');
     }
     /**
-     * Updates a maps metadata
+     * Updates a map's metadata.
+     *
+     * @deprecated Hits the legacy `PUT /maps/{mapId}` endpoint that only accepts
+     * metadata; the giraffe API is migrating that endpoint toward "PUT the full
+     * resource" semantics (both metadata and content together). Prefer
+     * {@link updateMetadata} for metadata-only changes and {@link updateContent}
+     * for graph-content replacement.
+     *
      * @param projectId Project ID
      * @param mapId Map ID
      * @param options New metadata
@@ -98,6 +105,40 @@ export class MapService extends BaseServiceAbstract {
             mapId,
         }, this.config.insecure), options, 'Failed to update map.');
     }
+    /**
+     * Updates a map's metadata via the granular `/metadata` endpoint.
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param options New metadata fields. `description` is required by the
+     * backend; sending an empty value returns a 400.
+     */
+    async updateMetadata(projectId, mapId, options) {
+        return this.callPut(formatServiceUrl(API_GRAPHS_MAP_METADATA_URL, {
+            url: this.config.url,
+            projectId,
+            mapId,
+        }, this.config.insecure), options, 'Failed to update map metadata.');
+    }
+    /**
+     * Replaces the graph content of an existing cloud map with the supplied
+     * canonical `{ nodes, edges }` payload.
+     *
+     * Server-managed parts (SUMMARY, MAP_INFO identity fields, MAP_INFO
+     * timestamp, content hash) are preserved or recomputed by the backend; a
+     * byte-identical content payload is a no-op on the server (idempotent).
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param content Canonical map content to write
+     */
+    async updateContent(projectId, mapId, content) {
+        return this.callPut(formatServiceUrl(API_GRAPHS_MAP_CONTENT_URL, {
+            url: this.config.url,
+            projectId,
+            mapId,
+        }, this.config.insecure), content, 'Failed to update map content.');
+    }
     /**
      * Begins uploading a map from the agent
      *
@@ -121,11 +162,34 @@ export class MapService extends BaseServiceAbstract {
         }, this.config.insecure), 'Failed to delete map.', callsign ? { callsign, hash } : {});
     }
     /**
-     * Makes a copy of an uploaded map
+     * Creates a new map with the supplied canonical content.
+     *
+     * 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.
      *
      * @param projectId Project ID
-     * @param mapId Map ID
-     * @param options Options to create the new map
+     * @param mapId The mapId to create. Must be unique within the project.
+     * @param content Canonical map content (`{nodes, edges}`).
+     */
+    async create(projectId, mapId, content) {
+        return this.callPost(formatServiceUrl(API_GRAPHS_MAPS_NEW_URL, {
+            url: this.config.url,
+            projectId,
+        }, this.config.insecure), { mapId, map: content }, 'Failed to create map.');
+    }
+    /**
+     * Makes a copy of an existing cloud map under a new mapId.
+     *
+     * If `options.name` is omitted, the server picks an available
+     * `<sourceMapId>-copy[-N]` slot. The resolved mapId is returned so the
+     * caller knows where to look for the copy. The write is asynchronous on the
+     * server side - the copy may not be immediately readable via `get()`.
+     *
+     * @param projectId Project ID
+     * @param mapId Source map ID
+     * @param options Optional `name` (new mapId) and `description` for the copy
+     * @returns The mapId assigned to the new copy
      */
     async copy(projectId, mapId, options) {
         return this.callPost(formatServiceUrl(API_GRAPHS_MAPS_COPY_URL, {

package/esm/services/SpotProvisioningServiceNode.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { IBaseService, IRocosSDKConfig, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { Timezone } from '../constants/timezones';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.0.31-rc1",
+  "version": "3.1.0",
   "description": "Javascript SDK for rocos",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -22,19 +22,14 @@
   "license": "MIT",
   "devDependencies": {},
   "dependencies": {
-    "@bufbuild/protobuf": "2.2.5",
-    "@connectrpc/connect": "2.0.0",
-    "@connectrpc/connect-web": "2.0.0",
+    "@bufbuild/protobuf": "2.12.0",
+    "@connectrpc/connect": "^2.1.1",
+    "@connectrpc/connect-web": "^2.1.1",
     "@grpc/grpc-js": "^1.7.1",
     "@protobuf-ts/grpcweb-transport": "^2.9.1",
-    "@protobuf-ts/plugin": "^2.9.1",
     "@protobuf-ts/runtime": "^2.9.1",
-    "@types/json-schema": "^7.0.14",
     "acorn": "^8.11.3",
-    "buffer": "^6.0.3",
-    "loglevel": "^1.7.1",
-    "loglevel-plugin-prefix": "^0.8.4",
-    "uuid": "^9.0.0"
+    "loglevel": "^1.7.1"
   },
   "peerDependencies": {
     "rxjs": "^6.6.6 || ^7.0.0"