@advanced-rest-client/anypoint

A package for ARC with libraries to work with Anypoint Platform

1.0.0
Source
npm

Version published: 3 years ago

Weekly downloads: 1; decreased by-87.5%

Maintainers: 4

Weekly downloads

Created: 3 years ago

Source

Anypoint for ARC

An element that renders an UI to search Anypoint Exchange for available assets.

Usage

Installation

npm install --save @advanced-rest-client/anypoint

In an html file

<html>
  <head>
    <script type="module">
      import '@advanced-rest-client/anypoint/define/exchange-search.js';
    </script>
  </head>
  <body>
    <exchange-search></exchange-search>
  </body>
</html>

In a LitElement template

import { LitElement, html } from 'lit-element';
import '@advanced-rest-client/anypoint/define/exchange-search.js';

class SampleElement extends LitElement {
  render() {
    return html`
    <exchange-search
      .columns="${columns}"
      @selected="${this._assetHandler}"
    ></exchange-search>
    `;
  }

  _assetHandler(e) {
    console.log(e.detail);
  }
}
customElements.define('sample-element', SampleElement);

Authorization

The element uses @anypoint-web-components/anypoint-signin to sing a user in. Set anypointAuth, exchangeRedirectUri, and exchangeClientId attributes to enable the authorization button.

<exchange-search
  anypointAuth
  exchangeRedirectUri="${redirectUrl}"
  exchangeClientId="${clientId}"
  @anypointcodeexchange="${this._processCodeExchange}"
></exchange-search>

Note, that currently the Anypoint authorization server only support "code" oauth flow. This means you have to handle code response and exchange the code for access token. To do so, handle the anypointcodeexchange event dispatched by the anypoint-signin element.


/**
 * @param {AnypointCodeExchangeEvent} e
 */
_handleTokenExchange(e) {
  const { code } = e;
  e.detail.result = this.exchangeCode(code);
}

/**
 * @param {string} code
 * @returns {Promise<TokenInfo>}
 */
async exchangeCode(code) {
  const init = {
    method: 'POST',
    body: code,
  };
  const response = await fetch('YOUR SERVER URL', init);
  const info = await response.json();
  return {
    accessToken: info.accessToken,
    expiresAt: Date.now() + info.expiresIn,
    expiresIn: info.expiresIn,
    expiresAssumed: false,
    state: '0', // this is required by the types definition but can be anything. State is checked before this function is called
  };
  }));
}

Development

git clone https://github.com/advanced-rest-client/anypoint
cd anypoint
npm install

Running the demo locally

npm start

Running the tests

npm test

Keywords

FAQs

What is @advanced-rest-client/anypoint?

Is @advanced-rest-client/anypoint popular?

Is @advanced-rest-client/anypoint well maintained?

Package last updated on 26 Oct 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install