@corvina/corvina-app-connect

README

What is this repository for?

This library enables an application embedded as an iframe in Corvina to retrieve some information such as JWT, organization id, ... The iframe id must have a prefix "corvina-app-connect-" and the application must be registered in the Corvina platform.

How to use this library

• OPTION 1: Using npm:

  npm install @corvina/corvina-app-connect
  

  then in your code:

  import { CorvinaAppConnect } from '@corvina/corvina-app-connect';
  

• OPTION 2: Using script tag:

  <script src="https://unpkg.com/@corvina/corvina-app-connect"></script>
  

  or using a specific version

  <script src="https://unpkg.com/@corvina/corvina-app-connect@0.0.16/dist/index.umd.min.js"></script>
  

  then in your code:

  let { CorvinaHost, CorvinaConnect } = $corvina;
  

• OPTION 3: Using script tag of type module

  <script type="module">
      import { CorvinaHost, CorvinaConnect } from 'https://unpkg.com/@corvina/corvina-app-connect@0.0.16/dist/index.min.mjs';
  </script>
  

Then you can create an instance of CorvinaConnect and use it to retrieve the information you need:

let connect = await CorvinaConnect.create({ corvinaHost: "https://corvina.io", corvinaHostWindow: window.parent });
let jwt = connect.jwt;
let organizationId = connect.organizationId;

connect.on(CorvinaConnectEventType.ORGANIZATION_ID_CHANGED, (organizationId: string) => {
    console.log(`Organization ID changed to ${organizationId}`)
});

connect.on(CorvinaConnectEventType.JWT_CHANGED, (jwt: string) => {
    console.log(`JWT changed to ${jwt}`)
});

You can also trigger a navigation inside Corvina Platform in this way:

// navigate to the dashboard, same as clicking on the dashboard button in the Corvina menu
connect.navigateTo(CorvinaPages.DASHBOARD);
// navigate to custom page with parameters
connect.navigateTo("/another-page?param1=value1&param2=value2");

How to run the tests

• Run npm run test
• Open http://127.0.0.1:8080/commonjs/index.test.html in your browser

How to deploy a new version

• Update the version in package.json
• Run npm run build
• Run npm publish