0.4.2 • Published 10 months ago

dtdx-sdk v0.4.2

Weekly downloads
-
License
ISC
Repository
-
Last release
10 months ago

How to use

  1. npm i dtdx-sdk
  2. npm run test
<<<<<<<<<<<<< authenticated

if u see output above that means it works

Work as npm package

  1. npm i dtdx-sdk
  2. demo script
const dtdxConfig = {
    server: {
        url: 'http://192.168.90.240:8889'
    },
    account: {
        email: 'userxxxx@dtdx.dev',
        password: 'userxxxx',
        appId: '4bd06cfe-f611-46fa-8647-0e4a08edd78f'
    }
}

const DTDXClient = require('dtdx-sdk').DTDXClient;
const client = new DTDXClient(dtdxConfig)
// result
// {success: true}
// {success: false, message:xxx}
const login = await client.auth()
if (login.success) {
    // do something
}else {
    // show message
}

subscribe data from twinverse

// define callback function bind to each event you want
let handleData = function (service, event, data) {
  console.log(`svc ${service} event ${event} data: ${data}`)
}

// subscribe event
client.on('transform-classic-data', 'created', handleData);
client.on('transform-classic-data-1', 'created', handleData);

support ak/sk authorization

const dtdxConfig3 = {
  server: {
      url: 'http://127.0.0.1:3031'
  },
  account: {
    ak: "86ae6e76897640a5880bb4e4e8507965",
	  sk: "306d6b62d69f4ffb",
    appId: '4bd06cfe-f611-46fa-8647-0e4a08edd78f'
  }
}
  1. got your ak sk from twinverse platform
  2. debug with ak/sk info without change any code

support REST mode by configuring

dtdxConfig3 = {
  server: {
    url: 'http://192.168.90.211:30112',
    mode: 'rest'
  },
  account: {
    ak: "86ae6e76897640a5880bb4e4e8507965",
	  sk: "306d6b62d69f4ffb",
    appId: '4bd06cfe-f611-46fa-8647-0e4a08edd78f'
  }
}

pay attention

the default mode is websocket that mode: 'websocket'

if want to use rest mode that means give up two-way work mode

add rest method

  1. client.create(eventname, data)
  2. client.patch(eventname, data)
  3. client.find(eventname, data)
  4. client.get(eventname, id, data)
  5. client.update(eventname, id, data)
  6. client.remove(eventname, id, data)

All above methods support refresh token automatically

support websocket without upgrading

const dtdxConfig = {
  server: {
      url: 'http://192.168.90.211:30304',
      mode: 'ws'
  },
  account: {
    "email" : "usexxxx@dtdx.dev",
    "password" : "usexxxx",
    appId: '4bd06cfe-f611-46fa-8647-0e4a08edd78f'
  }
}

new features

  1. support sec-websocket-key
  2. support edge authorization
  3. support websocket without upgrading

connect mode

  1. rest: rest
  2. websocket: polling then upgrade to websocket
  3. ws: websocket without upgrading, to support the multi-pod instances in K8S
0.4.2

10 months ago

0.4.1

10 months ago

0.4.0

11 months ago

0.1.10

2 years ago

0.1.11

2 years ago

0.1.12

2 years ago

0.3.0

1 year ago

0.2.0

2 years ago

0.1.8

2 years ago

0.1.9

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago