Skip to content

Latest commit

 

History

History
129 lines (87 loc) · 3.15 KB

README.md

File metadata and controls

129 lines (87 loc) · 3.15 KB
Raw

tru.ID SDK for Mobile Web Applications

License

The Web SDK for tru.ID providing a helper function for requesting the check_url for PhoneCheck and SubscriberCheck.

Installation

Via jsDelivr CDN

<script src="https://cdn.jsdelivr.net/npm/@tru_id/tru-sdk-web/dist/tru-id-sdk.umd.js"></script>

Via NPM

$ npm install @tru_id/tru-sdk-web

Usage

Via jsDelivr CDN

Reachability Check

<script src="https://cdn.jsdelivr.net/npm/@tru_id/tru-sdk-web/dist/tru-id-sdk.umd.js"></script>
<script>
  tru.ID.getReachability(url)
</script>

PhoneCheck

When installed via a CDN a tru.ID global is installed.

<script src="https://cdn.jsdelivr.net/npm/@tru_id/tru-sdk-web/dist/tru-id-sdk.umd.js"></script>
<script>
  tru.ID.openCheckUrl(url, config)
</script>

Via NPM

Reachability Check

import truID from '@tru_id/tru-sdk-web'

truID.getReachability(url)

PhoneCheck

When installed via NPM the imported object exposes the openCheckUrl function.

import truID from '@tru_id/tru-sdk-web'

truID.openCheckUrl(checkUrl, config)

openCheckUrl Config

The openCheckUrl function takes an optional config Object argument:

truID.openCheckUrl(url, config)

The configuration options are:

{
  // whether debug information will be logged to the console.
  // Defaults to `false`
  debug: boolean,

  // "image" - a zero pixel image is dynamically added to the DOM for the check_url request
  // "window" - `window.open` is called to open the check_url in a new window
  // Defaults to "image".
  checkMethod: "image" | "window",

  // If `checkMethod` was set to `window` identifies the number of
  // milliseconds after which the opened window will be closed.
  // Defaults to 3000.
  windowCloseTimeout: Number,

  // It will run the device coverage check to determine
  // if the device is on a mobile IP
  // Defaults to true
  checkDeviceCoverage: boolean,

  // Depending on what PhoneCheck API version the check is created with.
  // Defaults to "v0.2"
  version: "v0.1" | "v0.2",
}

Local development

You can run npm run dev that will open rollup with watch mode that will re-compile the SDK after every change.

In another terminal you can run npm run serve to open a test web page where you can test real phone checks if you have the node server running or you can simply check a PhoneCheck check_url.

Releasing

  1. Bump the version if required
  2. Run npm run changelog to auto-update the CHANGELOG.md and manually edit to finesse
  3. Commit the changes read for release: git commit -m 'chore(release): v{version}
  4. Tag the release git tag v{version}
  5. Push the tags git push --follow-tags origin main
  6. Build the project with npm run build
  7. Publish to NPM npm publish --access public

License

MIT

Meta

Distributed under the MIT license. See LICENSE for more information.

https://github.com/tru-ID