You would normally use CoreSDK with other CSAS SDKs.
If you just want to use the SDK, there are compiled files ready to be used in the
You can just copy these files directly from the repository or preferably, use
npm to install it into your project:
npm install cs-core-sdk --save
For usage in browser, pickup the following files from the
cs-core-sdk.sfx.js- CSCoreSDK packaged for browsers
cs-core-sdk.sfx.d.ts- CSCoreSDK typings for browsers
cs-core-sdk.sfx.js.map- CSCoreSDK sourcemap for browsers
cs-core-sdk.sfx.js in your page before any other CSAS SDKs:
The SDK will be available in global variable
For usage in node, install it through
npm (see above). You can then require it by:
var CSCoreSDK = require('cs-core-sdk');
Before using any CSAS SDKs in your application, you need to initialize CSCoreSDK by providing it your WebApiKey.
CSCoreSDK.useWebApiKey( "YourApiKey" ) //You may use the CSAS SDKs now.
See configuration guide for all the available configuration options.
The SDK itself is written in TypeScript, packaged by webpack, tested by jasmine & karma and distributed thorugh npm. It uses tsd for TypeScript definitions.
In order to to develop upon this SDK, you will need the following installed globally:
webpack- For packaging
karma- For testing
tsd- For downloading typescript definitions
After cloning the repo, run the following command to initialize the repository for development:
npm install && tsd install
You can verify everything worked as expected by running:
This project uses the following directory structure:
dist- Packaged version of this SDK ready for use.
build- Build artifacts (not checked in repository)
lib- The SDK itself
spec- Tests for the SDK
typings- Typings used by the SDK
tooling- Commands for building and packaging
npm run clean- cleans
npm run build- performs
cleanand builds the SDK into
bulidfolder. It also generates
npm run dist- performs
buildcommand and copies the packaged SDK files into
npm run test- performs
buildand runs tests in node and browser.
npm run test-browser- performs tests only in browser
npm run test-node- performs tests only in node
npm version [major|minor|patch]- releases new version of the SDK. Requires write access to repository. See npm-version for more details.
Contributions are more than welcome!
Please read our contribution guide to learn how to contribute to this project.
Please read our terms & conditions.