Package Exports

@localazy/generic-connector-client
@localazy/generic-connector-client/lib/main.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@localazy/generic-connector-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

📦 Localazy Generic Connector Client

Node.js module that allows to interact with the Localazy Generic Connector.

🔧 Install

npm install @localazy/generic-connector-client
# or you can use yarn or pnpm

🚀 Usage

ESM

import { GenericConnectorClient, getOAuthAuthorizationUrl } from '@localazy/generic-connector-client';

const api = new GenericConnectorClient({ pluginId: 99 });             // Create Api client with your `pluginId`

const keys = await GenericConnectorClient.public.keys();              // Get read and write keys for OAuth.
const url = getOAuthAuthorizationUrl({
  clientId: 'your-client-id',
  customId: 'your-write-key',
});                                                                   // Get OAuth authorization URL.
window.open(url);
const pollResult = await GenericConnectorClient.oauth.continuousPoll({
  readKey: keys.readKey,
});                                                                   // Poll for the result.

console.log(pollResult);                                              // Print the result with access token.

TypeScript

import { GenericConnectorClient, getOAuthAuthorizationUrl, GeneratedKeys, PollResponseCompleted } from '@localazy/generic-connector-client';

const api: GenericConnectorClient = new GenericConnectorClient({ pluginId: 99 });             // Create Api client with your `pluginId`

const keys: GeneratedKeys = await GenericConnectorClient.public.keys();              // Get read and write keys for OAuth.
const url: string = getOAuthAuthorizationUrl({
  clientId: 'your-client-id',
  customId: 'your-write-key',
});                                                                   // Get OAuth authorization URL.
window.open(url);
const pollResult: PollResponseCompleted = await GenericConnectorClient.oauth.continuousPoll({
  readKey: keys.readKey,
});                                                                   // Poll for the result.

console.log(pollResult);                                              // Print the result with access token.