iTwin.js Authorization clients

Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.

iTwin.js is an open source platform for creating, querying, modifying, and displaying Infrastructure Digital Twins.

If you have questions, or wish to contribute to iTwin.js, see our Contributing guide.

About this Repository

This repository contains a few OAuth 2.0 client libraries to assist in authenticating with the iTwin Platform in TypeScript/JavaScript.

There are 3 clients in the repository, each of them corresponding to one of the application types supported by the iTwin Platform. See the authorization documentation for more details on the Authorization workflows supported.

• Browser/SPA
• Desktop/Electron
• Service

In addition, the OIDC Signin Tool is a test helper package to automate the sign-in workflow to aid in writing integration tests.

There is also an authorization client for command-line developer tools.

Prerequisites

• Node: an installation of the latest security patch of Node 18. The Node installation also includes the npm package manager.
• pnpm: prefer installation via npm corepack

Build Instructions

1. Clone repository (first time) with git clone or pull updates to the repository (subsequent times) with git pull
2. Install dependencies: pnpm update or pnpm install
3. Build source: pnpm build
4. Run tests: pnpm cover

Note: Sometimes lage's cache will become stale and it may refuse to build projects you've changed. If this or other odd behavior occurs on build, add the --reset-cache flag to the pnpm build command.

Extract Documentation

pnpm run docs