@xvia/webgate-connect

Lib to simplify the integration with X-Via Portal

Installation

npm install @xvia/webgate-connect

Usage

import { connect } from "@xvia/webgate-connect";

const portalConnect = connect({
  portalUrl: "https://portal.demo.xvia.com.br",
});

API

Login

Redirects the portal to the login page

portalConnect.login(PortalLoginOptions);

Logout

Asks the portal to logout the current user

portalConnect.logout(PortalLogoutOptions);

Register

Redirects the portal to the registration page

portalConnect.register(PortalRegisterOptions);

Account Management

Redirects the portal to the account management page

portalConnect.accountManagement();

Deeplink between apps

The portal restricts the way an app can navigate by default. Links and route changes will only have affect within the app. if you want to deeplink to another app, it is necessary to tell the notify the portal using the redirectTo function:

portalConnect.redirectTo(uri);

Is Running in Portal

Checks if the code is running inside the X-Via portal

portalConnect.isRunningInPortal();

Is Running in Webview

Checks if the code is running inside the X-Via mobile webview

portalConnect.isRunningInWebview();

Native download and share dialog (webview only)

Sends a message to the native mobile app asking it to download an url on the native side. If the property share is set to true, the native app will also trigger the share options after the download is complete. NOTE: The download will always go to the Downloads folder

interface PortalDownloadOptions {
  url: string;
  filename?: string;
  showShareDialog?: boolean;
  headers?: Record<string, string>;
}

portalConnect.download(PortalDownloadOptions);

Get current location

Gets the current location. Works both on the browser and webview

interface PositionCoords {
  latitude: number;
  longitude: number;
}

portalConnect.getCurrentPosition(): PositionCoords;

Event Listeners

New Access Token

Event triggered every time a new access token is generated / refreshed by the portal. This event can be used to make sure the application always have a valid token available

portalConnect.on("NEW_ACCESS_TOKEN", (accessToken) => {
  console.log(accessToken);
});

Development (with auto registration)

You can automatically integrate your local app into a development instance of the portal by using the webgate-cli dev command line interface. Note that this cli will only work on development instances of the portal, the automatic registration feature is disabled on production instances.

1. Create a webgate.yaml file with the following configuration:

portal:
  devServer:
    # The development app port
    port: 3000
    # The portal url (development instance)
    portalUrl: http://localhost:8080
    # The integration type (iframe will enable hot reload)
    integrationType: bundle

2. update your package.json to include the webgate-cli dev server, providing the npm script to be run after the automatic registration

    // in your package.json scripts...
    // start-app is the script we want to run after the auto registration
+   "dev": "webgate-cli dev"
    "start": "react-scripts start",

3. Run the webgate-connect development server

npm run dev

NOTE: The auto registration will only work on DEVELOPMENT instances of the portal. The webgate-connect cli will generate an error if the portal url is set to a production version

Integration with React

This library exports a Provider that can be used together with the React Context API.

Furst, you need to render the Provider on your high level component:

import { WebgateProvider } from "@xvia/webgate-connect";

function App() {
  return (
    <WebgateProvider portalUrl="https://portal.demo.xvia.com.br">
      <MyApp>
    </WebgateProvider>
  );
}

export default App;

Then you can use the portalConnect in your components

import { useWebgate } from "@xvia/webgate-connect";

export const MyComponent: FC = () => {
  const { accessToken, portalConnect } = useWebgate();
  return (
    <div onClick={() => portalConnect.redirectTo("/app/another-app")}>
      {accessToken}
    </div>
  );
};

License

MIT License

Copyright (c) 2020 X-Via

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, startDev, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.