Pack Manager Communication Library

Description

Esta biblioteca TypeScript/Javascript foi desenvolvida para facilitar a comunicação entre o aplicativo Pack Manager e um módulo implementado via iframe. Ela fornece métodos simples e eficazes para acessar dados compartilhados pelo aplicativo Pack Manager.

Installation

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

``bash
npm install packmanager-communication-lib


or


yarn add packmanager-communication-lib
`

Available Methods

$3

Recupera dados genéricos do Pack Manager com base no usuário conectado e no Pack instalado. O parâmetro propertyName é o nome da propriedade que você precisa recuperar.

#### JavaScript usando Promises

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

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

#### TypeScript usando Async/Await

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

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

fetchProfileData();
`

$3

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

#### JavaScript usando Promises

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

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

#### TypeScript usando Async/Await

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

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

fetchUserProfile();
`

$3

Recupera dados do roteador instalado.

Esta é a definição do tipo RouterData:

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

skillTransbordo: {
shortName: string;
};
};
`

#### JavaScript usando Promises

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

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

#### TypeScript usando Async/Await

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

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

fetchRouterData();
`

$3

Recupera o ID do locatário do roteador instalado.

#### JavaScript usando Promises

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

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

#### TypeScript usando Async/Await

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

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

fetchTenantId();
`

$3

Recupera a identidade do proprietário do roteador instalado.

#### JavaScript usando Promises

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

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

#### TypeScript usando Async/Await

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

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

fetchOwner();
`

$3

Envia uma notificação de texto para o Pack Manager. É usado para mostrar mensagens de aviso, mensagens de erro e mensagens de sucesso.

#### Parâmetros

| Nome do Parâmetro | Tipo | Descrição |
| --------------------- | ---------------------------------------------- | ------------------------------------- |
| notificationType | enumeração de string (Warning, Error, Success) | Tipo de toast a ser exibido |
| notificationTitle | string | Título do toast a ser exibido |
| notificationText | string | Texto a ser exibido |

#### JavaScript usando Promises

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

// Success
packmanager.showTextNotification("Success", "Title", "Text");

// Warning
packmanager.showTextNotification("Warning", "Title", "Text");

// Error
packmanager.showTextNotification("Error", "Title", "Text");
`

#### TypeScript usando Async/Await

`typescript
import { showTextNotification } from "packmanager-communication-lib";

async function showMessages() {
// Success
await showTextNotification("Success", "Title", "Text");

// Warning
await showTextNotification("Warning", "Title", "Text");

// Error
await showTextNotification("Error", "Title", "Text");
}

showMessages();
`

$3

Mostra uma notificação de ícone, atualizando a cor de fundo do ícone do módulo.

#### Parâmetros

| Nome do Parâmetro | Tipo | Descrição |
| --------------------- | -------- | ------------------------------------------------ |
| backgroundColor | string | A cor para alterar a cor de fundo do ícone |
| duration | number | Duração em milissegundos da alteração de cor |

#### JavaScript usando Promises

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

// Change color to red over 10 seconds
packmanager.showIconNotification("red", 10000);
`

#### TypeScript usando Async/Await

`typescript
import { showIconNotification } from "packmanager-communication-lib";

async function showNotification() {
// Change color to red over 10 seconds
await showIconNotification("red", 10000);
}

showNotification();
``

Suporte

Se você precisar de suporte para esta biblioteca, ou se precisar de um novo recurso, envie um e-mail para scalability.solutions@blip.ai

Licença

Esta biblioteca é distribuída sob a licença ISC. Consulte a LICENÇA para obter mais detalhes. Sinta-se à vontade para contribuir ou relatar problemas!