packmanager-communication-lib v1.4.0

Pack Manager Communication Library Bíblioteca de comunicação Pack Manager

Descrição

Esta biblioteca TypeScript/Javascript foi desenvolvida para facilitar a comunicação entre a aplicação PackManager e um módulo implementado via iframe. Ela oferece métodos simples e eficazes para acessar informações disponibilizadas pela aplicação Pack Manager.

Instalação

Para começar a utilizar a biblioteca, basta instalá-la em seu projeto usando npm ou yarn:

npm install packmanager-communication-lib
# ou
yarn add packmanager-communication-lib

Métodos Disponíveis

1. getDataFromPackManager(propertyName: string)

Recupera dados genéricos do PackManager com base no usuário logado e no pacote de instalação. O parâmetro propertyName é o nome da propriedade que você precisa recuperar.

JavaScript and Promises

const packmanager = require("packmanager-communication-lib");

packmanager.getDataFromPackManager("profile").then(profile => {
  console.log("Profile:", profile);
});

TypeScript and Async/Await

import { getDataFromPackManager } from "packmanager-communication-lib";

async function fetchProfileData() {
  const profile: string = await getDataFromPackManager("profile");
  console.log("Profile:", profile);
}

fetchProfileData();

2. getProfile()

Obtenha o perfil do usuário logado, seguindo as reivindicações padrão do OpenID Connect Core 1.0.

JavaScript and Promises

const packmanager = require("packmanager-communication-lib");

packmanager.getProfile().then(profile => {
  console.log("User Profile:", profile);
});

TypeScript and Async/Await

import { getProfile } from "packmanager-communication-lib";

async function fetchUserProfile() {
  const profile: Profile = await getProfile();
  console.log("User Profile:", profile);
}

fetchUserProfile();

3. getRouterData()

Obtenha os dados do roteador instalado.

A definição do tipo RouterData é esta:

/**
 * @description Interface para tipar os dados do roteador
 * @interface RouterData
 * @property {string} shortName - Nome curto do roteador
 * @property {string} accessKey - Chave de acesso do roteador
 * @property {object} skillTransbordo - Skill de transbordo
 * @property {string} skillTransbordo.shortName - Nome curto da skill de transbordo
 * @property {string} skillTransbordo.accessKey - Chave de acesso da skill de transbordo
 */
export type RouterData = {
  shortName: string;
  accessKey: string;

  skillTransbordo: {
    shortName: string;
    accessKey: string;
  };
};

JavaScript and Promises

const packmanager = require("packmanager-communication-lib");

packmanager.getRouterData().then(routerData => {
  console.log("Installed Router Data:", routerData);
});

TypeScript and Async/Await

import { getRouterData } from "packmanager-communication-lib";

async function fetchRouterData() {
  const routerData: RouterData = await getRouterData();
  console.log("Installed Router Data:", routerData);
}

fetchRouterData();

4. getTenantId()

Obtenha o ID do roteador instalado.

JavaScript and Promises

const packmanager = require("packmanager-communication-lib");

packmanager.getTenantId().then(tenantId => {
  console.log("Tenant ID:", tenantId);
});

TypeScript and Async/Await

import { getTenantId } from "packmanager-communication-lib";

async function fetchTenantId() {
  const tenantId: string = await getTenantId();
  console.log("Tenant ID:", tenantId);
}

fetchTenantId();

5. getOwnerIdentity()

Retorna o owner identity (dono da instalação) do router instalado.

JavaScript and Promises

const packmanager = require("packmanager-communication-lib");

packmanager.getOwnerIdentity().then(owner => {
  console.log("Owner:", owner);
});

TypeScript and Async/Await

import { getOwnerIdentity } from "packmanager-communication-lib";

async function fetchOwner() {
  const owner: string = await getOwnerIdentity();
  console.log("Owner:", owner);
}

fetchOwner();

Licença

Esta biblioteca é distribuída sob a licença ISC. Consulte o conteúdo AQUI para obter mais detalhes. Sinta-se à vontade para contribuir ou relatar problemas!