sourcesync-sdk v0.1.18

SourceSync SDK for JavaScript

The SourceSync SDK for JavaScript is a collection of libraries that enable you to interact with SourceSync services from your JavaScript applications.

Getting Started

1. Install the SDK

This library is distributed on npm. In order to add it as a dependency, run the following command:

npm install sourcesync-sdk

You can alternatively install a submodule as its own dependency. Replace with your preferred module name:

npm install @sourcesync-sdk/app

2. Initialize the SDK

import { initializeApp } from 'sourcesync-sdk/app'

const sourcesyncConfig = { 
  appKey: 'your-app-key',

  env: 'prod' // default is 'prod'
}

const app = await initializeApp(sourcesyncConfig)

A SourceSync app instance stores common configuration settings and provides access to the SDK's services.

3. Use the SDK modules in your application

SourceSync SDK modules are designed to be used in a modular fashion. You can import the modules you need and use them in your application.

import { initializeApp } from 'sourcesync-sdk/app'
import { createMomentSelector } from 'sourcesync-sdk/moment'

const sourcesyncConfig = { 
  appKey: 'your-app-key',
  
  env: 'prod' // default is 'prod'
}

const app = await initializeApp(sourcesyncConfig)

const momentSelector = await createMomentSelector(app, { /* options */ })

Available SourceSync Modules

Moment

import {} from 'sourcesync-sdk/moment'

Whisper Web

import {} from 'sourcesync-sdk/whisper-web'

Render Experience Web

import {} from 'sourcesync-sdk/render-experience-web'

Render Activation Web

import {} from 'sourcesync-sdk/render-activation-web'

License

This SDK is distributed under the Apache License, Version 2.0. The Apache 2.0 License applies to the SDK only and not any other component of the SourceSync Platform.