@droz-js/sdk

@droz-js/sdk

Setup (required)

To set up the sdk you need to tell the tenant and the authentication method, the tenant is required. You must run this first before making any sdk calls. The sdk will fail if you don't set up the tenant.

import { DrozSdk } from '@droz-js/sdk';

DrozSdk.forTenant('dev').withAuthentication('Basic', 'username', 'password');

You can also split the setup in two steps

import { DrozSdk } from '@droz-js/sdk';

// first step (required)
DrozSdk.forTenant('dev');

// (optional) later when you have the authentication token you can set it and it will automatically be used in the new requests
DrozSdk.withAuthentication('Basic', 'username', 'password');

Websocket

For websockets we use graphql-ws protocol with AsyncIterator to handle the subscriptions. The sdk will automatically handle the connection and reconnection for you, see https://the-guild.dev/graphql/ws/recipes#client-usage-with-asynciterator on how to use the AsyncIterator.

Example with AsyncIterator

import { DrozSdk } from '@droz-js/sdk';
import { DrozChat } from '@droz-js/sdk/drozchat';

DrozSdk.forTenant('dev');

const chat = new DrozChat();
const iterable = chat.onTicketInQueue();
for await (const result of iterable) {
  console.log(result);
}

For the React developers

import { DrozSdk } from '@droz-js/sdk';
import { DrozChat } from '@droz-js/sdk/drozchat';

DrozSdk.forTenant('dev');

function useOnTicketInQueue() {
  const chat = new DrozChat();
  const [tickets, setTickets] = useState<Ticket[]>([]);

  useEffect(() => {
    const subscription = chat.onTicketInQueue();

    // YES I KNOW, REACT SUCKS
    (async () => {
      // attention! this is just an example what you do with the result is up to you
      for await (const each of subscription) setTickets(tickets => [...tickets, each]);
    })();

    // this is required to close the subscription when the component unmounts
    return () => subscription.return();
  }, []);
}

Available Sdks

Droz Nexo

import { DrozNexo } from '@droz-js/sdk/droznexo';

Droz Chat

import { DrozChat } from '@droz-js/sdk/drozchat';