Skip to main content
Home
This package works with Node.js, Deno, BunIt is unknown whether this package works with Cloudflare Workers, Browsers
It is unknown whether this package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
It is unknown whether this package works with Browsers
JSR Score
35%
Published
4 weeks ago (0.1.0)

MTR SINIR/SIGOR WebService wrapper for TypeScript

jsr.io/@mtr-ws/mtr-ws-wrapper-ts jsr.io/@mtr-ws/mtr-ws-wrapper-ts score

Wrapper TrypeScript para consumo das APIs do MTR WebService - SINIR/SIGOR para consumo de MTRs. Baseado na versão: SIGOR - 1.15.0 - 21/08/24

Neste projeto está implementado:

Grupo de rotas Namespace
Consulta de dados MtrWsClient.consult
Recebimento de MTRs MtrWsClient.receive
Download de MTRs/CDFs MtrWsClient.download

Também exporta os tipos utilizados na API através do MtrWSType:

Grupo de interfaces Namespace
Consulta de dados MtrWSType.ConsultInterface
Recebimento de MTRs MtrWSType.ReceiveInterface
Download de MTRs/CDFs MtrWSType.DownloadInterface
Configs do client MtrWSType.WsClientInterface

Features

Logger estruturado
  • Estruturação utilizando LogTape
  • Tag principal: mtr-ws-wrapper-ts
    Configuração sugerida
import { configure, getConsoleSink } from "@logtape/logtape";
import { getOpenTelemetrySink } from "@logtape/otel";
import { prettyFormatter } from "@logtape/pretty";

await configure({
    sinks: {
        console: getConsoleSink({ formatter: prettyFormatter }),
        otel: getOpenTelemetrySink(),
    },
    loggers: [
        {
            category: ["mtr-ws-wrapper-ts"],
            lowestLevel: "info",
            sinks: ["console"],
        },
        {
            category: [],
            lowestLevel: "debug",
            sinks: ["otel"],
        },
    ],
});
- Fruits - Fish

Instalação

Este pacote está distribuído exclusivamente através do JavaScript Registry (JSR).

deno add        jsr:@mtr-ws/mtr-ws-wrapper-ts # for Deno
bunx jsr add        @mtr-ws/mtr-ws-wrapper-ts # for bun
npx  jsr add        @mtr-ws/mtr-ws-wrapper-ts # for npm
pnpm i          jsr:@mtr-ws/mtr-ws-wrapper-ts # for pnpm
yarn add        jsr:@mtr-ws/mtr-ws-wrapper-ts # for yarn
vlt install     jsr:@mtr-ws/mtr-ws-wrapper-ts # for vlt

Aplicação

import { MtrWsClient, type MtrWsType } from "./mod.ts";

const clientConfig: MtrWsType.WsClientInterface<"GERADOR"> = {
    baseWebServer: "SINIR", // OR "SIGOR"
    role: "GERADOR", // OR "TRANSPORTADOR" | "DESTINADOR"
    cpf: "12345678900",
    senha: "MYPASS",
    unidade: "123456",
    persistentId: "MyID",
};

// Client para execução
const client = await MtrWsClient(clientConfig);

const residuos = await client.consult.listarResiduos();
const tratamentos = await client.consult.listarTratamentos();
const dadosMtr = await client.consult.consultarMtr("12312316546");
const classesPorResiduo = await client.consult.listarClassesPorResiduo("200301");
// [...]

// Capturar buffer do arquivo PDF
const arrayBufferPDFMTR = await client.download.downloadMtr({ mtrId: "12312316546" });
// Salvar arquivo PDF em diretório local
await client.download.downloadMtr({ mtrId: "12312316546", destinationFolder: "./myFolder" });

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@mtr-ws/mtr-ws-wrapper-ts

Import symbol

import * as mtr_ws_wrapper_ts from "@mtr-ws/mtr-ws-wrapper-ts";
or

Import directly with a jsr specifier

import * as mtr_ws_wrapper_ts from "jsr:@mtr-ws/mtr-ws-wrapper-ts";

Add Package

pnpm i jsr:@mtr-ws/mtr-ws-wrapper-ts
or (using pnpm 10.8 or older)
pnpm dlx jsr add @mtr-ws/mtr-ws-wrapper-ts

Import symbol

import * as mtr_ws_wrapper_ts from "@mtr-ws/mtr-ws-wrapper-ts";

Add Package

yarn add jsr:@mtr-ws/mtr-ws-wrapper-ts
or (using Yarn 4.8 or older)
yarn dlx jsr add @mtr-ws/mtr-ws-wrapper-ts

Import symbol

import * as mtr_ws_wrapper_ts from "@mtr-ws/mtr-ws-wrapper-ts";

Add Package

vlt install jsr:@mtr-ws/mtr-ws-wrapper-ts

Import symbol

import * as mtr_ws_wrapper_ts from "@mtr-ws/mtr-ws-wrapper-ts";

Add Package

npx jsr add @mtr-ws/mtr-ws-wrapper-ts

Import symbol

import * as mtr_ws_wrapper_ts from "@mtr-ws/mtr-ws-wrapper-ts";

Add Package

bunx jsr add @mtr-ws/mtr-ws-wrapper-ts

Import symbol

import * as mtr_ws_wrapper_ts from "@mtr-ws/mtr-ws-wrapper-ts";