@dronedeploy/rocos-js-sdk 1.0.0-alpha-2 → 2.6.1

package/demo/html/styles.css

@@ -0,0 +1,190 @@
+/* You can add global styles to this file, and also import other style files */
+:root {
+  --color-text: #333;
+  --color-link: #61dafb;
+  --color-link-active: #0C8DFF;
+  --color-headline: #fff;
+  --color-background: #000000;
+  --color-button: #0C8DFF;
+  --color-button-hover: #0D5EA6;
+}
+
+@font-face {
+  font-family: HKGrotesk;
+  src: url(assets/HKGrotesk-Bold.otf);
+}
+
+@font-face {
+  font-family: HKGrotesk-Regular;
+  src: url(assets/HKGrotesk-Regular.otf);
+}
+
+
+@import url('https://fonts.googleapis.com/css2?family=Roboto+Mono&display=swap');
+
+
+h3 {
+  margin:0px;
+  margin-bottom: 16px;
+}
+
+body {
+  margin: 0;
+  font-family: HKGrotesk;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  background-color: #F4F4F4;
+}
+
+code {
+  font-family: 'Roboto Mono', monospace;
+}
+
+.app {}
+
+.app header {
+  top: 0;
+  left: 0;
+  /*width: 100%;*/
+  height: 60px;
+  background-color: var(--color-background);
+  text-transform: uppercase;
+  font-size: 20px;
+  position: fixed;
+  right: 0;
+  z-index: 10;
+  padding: 0 60px;
+  display: flex;
+  justify-content: space-between;
+}
+
+.app header .logo {
+  margin-top: 15px;
+  text-decoration: none;
+  color: var(--color-text);
+  line-height: 60px;
+  background-image: url(./assets/logo.svg);
+  background-repeat: no-repeat;
+  background-position: left center;
+  height: 30px;
+  width: 226px;
+}
+
+.app header h1 {
+
+  color: var(--color-headline);
+  text-transform: initial;
+  font-size: 20px;
+  line-height: 60px;
+  margin: 0;
+}
+
+.app a {
+  color: var(--color-link);
+}
+
+.app .content {
+  padding: 80px 40px;
+  height: 100%;
+}
+
+.app .content .boxRow {
+  display: flex;
+  justify-content: flex-start;
+}
+
+.app .content .boxRow .boxColumn {
+  width: 25%;
+}
+
+.app .content .box {
+  border-radius: 4px;
+  margin: 24px 24px 24px 0px;
+  border: 1px solid #D2D3D4;
+  overflow: hidden;
+  background-color: #ffffff;
+  min-width: 200px;
+}
+
+.app .content .box .boxContent {
+  padding: 24px;
+}
+
+.app .content .box label {
+  display: block;
+  padding: 5px 0 5px 0;
+}
+
+.app .content .box button {
+  display: inline-block;
+  font-family: HKGrotesk;
+  color: var(--color-headline);
+  text-align: center;
+  vertical-align: middle;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+  background-color: var(--color-button);
+  border: none;
+  padding: .375rem .75rem;
+  font-size: 15px;
+  line-height: 1.5;
+  border-radius: 3px;
+  transition: color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;
+  cursor: pointer;
+}
+.app .content .box button:hover {
+  background-color: var(--color-button-hover);
+}
+.app .content .box button:focus {
+  outline: 0;
+}
+.app .content .box pre {
+  font-family: 'Roboto Mono', monospace;
+  font-size: 12px;
+  background-color: #E2F1FF;
+  padding: 20px;
+  margin: auto;
+  overflow: auto;
+  overflow-wrap: break-word;
+  white-space: pre-wrap;       /* css-3 */
+  white-space: -moz-pre-wrap;  /* Mozilla, since 1999 */
+  white-space: -o-pre-wrap;    /* Opera 7 */
+  word-wrap: break-word;
+}
+
+.app .content .box input[type=text],
+.app .content .box textarea {
+  margin-bottom:12px;
+  font-family: HKGrotesk-Regular;
+  display: block;
+  width: 90%;
+  height: calc(1.5em + .75rem + 2px);
+  padding: 0 .375rem 0 .75rem;
+  font-size: 15px;
+  font-weight: 500;
+  line-height: 1.5;
+  color: #1F252D;
+  background-color: #fff;
+  background-clip: padding-box;
+  border: 1px solid #ffffff;
+  border-bottom: 1px solid #D2D3D4 !important;
+}
+
+input:focus {
+  outline: 0;
+  border-width: 0 0 2px;
+  border-color: blue;
+}
+
+textarea:focus {
+  outline: 0;
+  border-width: 0 0 2px;
+  border-color: blue;
+}
+
+
+.app .content .box textarea {
+  height: 100px;
+}

package/demo/node/README.md

@@ -0,0 +1,17 @@
+## How to run this demo?
+
+Before running the demo, build the lib first
+```
+yarn build
+```
+
+After the build, you need to link the package to this directory by runnint `yarn install`.
+
+```bash
+yarn install
+```
+`
+Run the demo with
+```
+node index.js
+```

package/demo/node/index.js

@@ -0,0 +1,134 @@
+// node, on dev server use the following path to the node sdk
+// const { RocosSDKNode } = require('@team-rocos/rocos-js-sdk/dist/node')
+const { RocosSDKNode } = require('@team-rocos/rocos-js-sdk/node')
+const { generateUUID } = require('@team-rocos/rocos-js-sdk')
+
+const url = '' // your app url
+const appId = '' // your app id
+const appKey = '' // your project key
+const projectId = '' // your project id
+const sources = [
+  '/rocos/agent/telemetry/subscribed',
+  // '/rocos/agent/telemetry/sources',
+  // '/rocos/agent/telemetry/noop',
+  '/rocos/agent/telemetry/heartbeat',
+  // '/video/camera',
+  // '/ros/turtle1/pose?txp=UNARY&rg=4321&int=2s&dbg.trace=true', // Subscription source without acknowledgement
+  // '/ros/turtle1/pose?txp=UNARY&rg=1234&int=2s&rx.p=unary&dbg.trace=true', // Subscription source requires acknowledgement
+]
+
+const sdk = new RocosSDKNode({ url, appId, appKey })
+sdk.setDebugLevel('trace')
+sdk.enableDebugMode(true)
+
+const testToken = async () => {
+  console.log('get auth token')
+  const token = await sdk.getAuthService().getToken()
+  console.log('token', token)
+}
+testToken()
+
+const testRobotList = async () => {
+  console.log('get robot list')
+  const robots = await sdk.getRobotService().getRobots(projectId)
+  console.log('robotsResult', robots)
+}
+testRobotList()
+
+const testSubscription = async () => {
+  const name = 'telemetry -'
+  console.log(`${name} service`)
+  console.log(`${name} sources`, sources)
+  const robots = await sdk.getRobotService().getRobots(projectId)
+  const callsigns = robots.map((item) => item.callsign)
+  console.log(`${name} callsigns`, callsigns)
+  const subscription = sdk.getTelemetryService().subscribe({ projectId, callsigns, sources })
+  console.log(`${name} subscription`, subscription)
+  subscription.subscribe((msg) => {
+    console.log(`${name} telemetry message`, msg)
+  })
+}
+testSubscription()
+
+const testServiceCall = async () => {
+  const name = 'service call -'
+  console.log(`${name} service`)
+  const robots = await sdk.getRobotService().getRobots(projectId)
+  const { callsign } = robots[0]
+  console.log(`${name} callsign`, callsign)
+  if (callsign) {
+    const result = sdk.getCallerService().invokeRequest({
+      uid: generateUUID(),
+      projectId,
+      callsign,
+      component: 'ros',
+      topic: 'getServices', // 'rosout/get_loggers',
+      subSystem: '',
+      payload: JSON.stringify({
+        query: {
+          type: 0,
+          data: {
+            depth: 0,
+            path: '*',
+            showHidden: false,
+          },
+        },
+      }),
+      responseLevelNumber: 0,
+    })
+    console.log(`${name} result`, result)
+    const subscription = result.subscribe((msg) => {
+      console.log(`${name} subscribe msg`, msg)
+      if (msg && msg.responses && msg.responses.responsesList && msg.responses.responsesList[0]
+        && msg.responses.responsesList[0].pb_return && msg.responses.responsesList[0].pb_return.payload) {
+        const { payload } = msg.responses.responsesList[0].pb_return
+        console.log(`${name} payload`, JSON.parse(Buffer.from(payload.toString(), 'base64').toString()))
+        // this is just to stop test, in real world scenario the messages depend on payload
+        console.log(`${name} unsubscribing to stop the stream`)
+        subscription.unsubscribe()
+      }
+    })
+  } else {
+    console.log(`${name} no callsign`)
+  }
+}
+testServiceCall()
+
+const testCommand = async () => {
+  const name = 'command -'
+  console.log(`${name} service`)
+  const robots = await sdk.getRobotService().getRobots(projectId)
+  const { callsign } = robots[0]
+  console.log(`${name} callsign`, callsign)
+  if (callsign) {
+    const result = sdk.getCommandService().invokeRequest({
+      projectId,
+      callsign,
+      commandId: 'turnLeft', // forward
+      parameters: {},
+    })
+    console.log(`${name} result`, result)
+    result.subscribe((msg) => {
+      console.log(`${name} subscribe msg`, msg)
+      if (msg.response) {
+        const payload = msg.response
+        console.log(`${name} payload`, payload)
+      }
+    })
+  } else {
+    console.log(`${name} no callsign`)
+  }
+}
+testCommand()
+
+const tareDown = async () => {
+  await new Promise((resolve) => {
+    const wait = setTimeout(async () => {
+      clearTimeout(wait)
+      console.log('removing all streams')
+      sdk.cleanup()
+      resolve(true)
+    }, 30000)
+  })
+}
+tareDown()

package/demo/node/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "rocos-js-sdk-node-demo",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "preinstall": "cd ../../ && yarn link && cd demo/node && yarn link \"@team-rocos/rocos-js-sdk\""
+  }
+}

package/demo/react/.env

@@ -0,0 +1 @@
+SKIP_PREFLIGHT_CHECK=true

package/demo/react/.env.dist

@@ -0,0 +1 @@
+SKIP_PREFLIGHT_CHECK=true

package/demo/react/.eslintrc.json

@@ -0,0 +1,46 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020, // Allows for the parsing of modern ECMAScript features
+    "sourceType": "module", // Allows for the use of imports
+    "ecmaFeatures": {
+      "jsx": true // Allows for the parsing of JSX
+    }
+  },
+  "root": true,
+  "plugins": [
+    "@typescript-eslint",
+    "react-hooks"
+  ],
+  "extends": [
+    "plugin:react/recommended", // Uses the recommended rules from @eslint-plugin-react
+    "plugin:@typescript-eslint/recommended", // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    "plugin:prettier/recommended" // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+  ],
+  "rules": {
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn",
+    "react/prop-types": "off",
+    "prettier/prettier": [
+      "error",
+      {
+        "singleQuote": true,
+        "trailingComma": "es5",
+        "semi": false,
+        "useTabs": false,
+        "bracketSpacing": true,
+        "arrowParens": "always",
+        "spaceBeforeFunctionParen": false,
+        "printWidth": 120,
+        "tabWidth": 4
+      }
+    ],
+    "comma-dangle": ["off"]
+  },
+  "settings": {
+    "react": {
+      "pragma": "React",
+      "version": "detect"
+    }
+  }
+}

package/demo/react/README.md

@@ -0,0 +1,65 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+
+## Dev Pre-requisites
+
+Before installing local libraries, the `@team-rocos/rocos-js-sdk` needs to be build first. To build it go to the root folder and run the build command.
+
+`$ yarn build`
+
+Once the library has been built, you can install the packages using.
+
+`$ yarn install`
+
+Due to a jest version bug in react, you need to skip preflight check. To do this copy the `.env.dist` file to `.env`.
+You can do this by running this command:
+
+```bash
+cp .env.dist .env
+```
+
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

package/demo/react/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "rocos-js-sdk-react-demo",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@reduxjs/toolkit": "^1.5.0",
+    "@testing-library/jest-dom": "^5.11.9",
+    "@testing-library/react": "^14.0.0",
+    "@testing-library/user-event": "^14.4.3",
+    "@types/jest": "^29.5.1",
+    "@types/node": "^18.15.11",
+    "@types/react": "^18.0.37",
+    "@types/react-dom": "^18.0.11",
+    "@types/react-redux": "^7.1.16",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-redux": "^8.0.5",
+    "react-scripts": "5.0.1",
+    "rxjs": "^7",
+    "typescript": "^5.0.4",
+    "uuid": "^9.0.0",
+    "web-vitals": "^3.3.1"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject",
+    "lint": "eslint '*/**/*.{js,ts,tsx}' --quiet --fix",
+    "preinstall": "cd ../../ && yarn link && cd demo/react && yarn link \"@team-rocos/rocos-js-sdk\""
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.59.0",
+    "@typescript-eslint/parser": "^5.59.0",
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.23.1",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "prettier": "^2.2.1"
+  }
+}

package/demo/react/public/index.html

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Rocos JS SDK React demo"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>Rocos JS SDK - React demo</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

package/demo/react/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

package/demo/react/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow: