@dronedeploy/rocos-js-sdk v2.6.1

rocos-js-sdk

Javascript SDK for interacting with the Rocos platform.

Using with Node

In order to use the SDK with node, you must be using node version 18.13 or higher.

Installation

Add a .npmrc to your project, in the same directory as your package.json

@team-rocos:registry=https://npm.pkg.github.com

Then install the package with npm

npm install @team-rocos/rocos-js-sdk

or yarn

yarn add @team-rocos/rocos-js-sdk rxjs@^7

What's New?

3.0.0

Breaking Changes

• IToken interface changes
  • created is now issuedAt and is a Date object instead of a string
  • expiresIn is now expires and is a Date object instead of a number
• Token class is now only functional for JWT tokens
• Logging in and signing up with email and password has been removed
• Resetting password has been removed

New Features

• NodeJS requirement has been dropped, so that the SDK can be used in the browser regardless of node version. When using node SDK, you must be using node version 18.13 or higher.
• AuthService now supports refreshToken method to refresh the access token
• Auth Token will now be refreshed automatically when it expires

2.6.1

• Modify map service response type

2.6.0

• Change rxjs dependency to a peer dependency (support for ^6.6.6 || ^7.0.0)
  • If you are using yarn you may need to add rxjs to your dependencies

2.4.0

• deleted unused endpoints relating to legacy accounts which are no longer supported

2.3.0

• Added mapService for supporting agent map functionality

2.2.0

• Added listUsers method in ProjectService to list project users
• Added additional debug information for failed HTTP responses

2.1.0

• Added getPlansPaged method to the IntegrationService to retrieve plans in a paged manner

2.0.2

• Fix no-content responses attempting to parse as JSON

2.0.1

• Security updates for React demo app dependencies

2.0.0

• Updating base class for all REST requests to go via fetch instead of axios
• Remove unused dependencies source-map-loader, ts-loader, axios
• Mark certain auth methods as deprecated in AuthService
  • login Login with email and password.
  • signup
  • resetPassword
• Deleted legacy services, these services are prefixed with BC, e.g. BCRocosClient
• Updated outdated dependencies in the Angular demo application

Migrating from 1.x to 2.x

• NodeJS engine requirements need to be v18.13 and npm v8 to use in NodeJS as the underlying HTTP services now use fetch API
• Legacy services prefixed with BC will need to be migrated to use the standard services

1.19.0

New method added to the IntegrationService to create a new issue in the current location.

• createIssue - Creates a new issue in a specific location on the latest map plan

1.18.0

Added new integration service to be able to retrieve plans created in DroneDeploy

This can be retrieved by getIntegrationService(). Available methods:

• getPlans - Gets a list of plans
• getPlanById - Retrieves a specific plan with the tiled layer that can be used to render meshes, point clouds, or tiled maps
• getWMTS - Returns WMTS tiles that can be rendered in tools such as mapbox if your project has WMTS feature enabled)