@maesn/typescript-sdk

v0.7.0

Published

a day ago

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *maesn* API.

Downloads

53,963

0High
0Medium
0Low

marcelmulorz

rovantalani

lennart-sve

maesn

Developer-friendly & type-safe Typescript SDK specifically catered to leverage maesn API.

Summary

Maesn Unified API: Maesn is the only Unified API that provides standard endpoints tailored for ERP use cases. We will continuously work on improving and extending our portfolio of use cases and ERP systems that we offer easy integration to.

Beside great use-cases, the most relevant ERP systems and the best possible support, we provide several technical key features that enable you to accelerate your integration game:

Drop-in frontend authentication components that makes it easy to connect to your customers’ end systems.
Authenticated pass through request for the occasional API endpoint not included in our common data models.
Templates for you docs, so that you have all content for your end user-onboarding ready

Once you get started with maesn and integrate with our endpoints, you automatically have support for all existing and new integrations we add.

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @maesn/typescript-sdk

PNPM

pnpm add @maesn/typescript-sdk

Bun

bun add @maesn/typescript-sdk

Yarn

yarn add @maesn/typescript-sdk

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@maesn/typescript-sdk") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Maesn } from "@maesn/typescript-sdk";

const maesn = new Maesn({
  serverURL: "https://api.example.com",
  apiKey: "<value>",
  accountKey: "<value>",
});

async function run() {
  const result = await maesn.accounting.getAccount({
    accountId: "<id>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Accounting

AccountingV2

Auth

Events

Health

check - Health check

Tenants

User

getUserInfo

Webhooks

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Maesn } from "@maesn/typescript-sdk";

const maesn = new Maesn({
  serverURL: "https://api.example.com",
  apiKey: "<value>",
  accountKey: "<value>",
});

async function run() {
  const result = await maesn.accounting.createTransaction({
    body: {},
  });

  console.log(result);
}

run();

Retries

All GET endpoints automatically retry on 5XX errors and connection failures using exponential backoff. POST, PUT, PATCH, and DELETE endpoints never retry automatically to avoid creating duplicate records.

Default retry configuration:

| Parameter | Value | |---|---| | Strategy | Exponential backoff | | Initial interval | 500 ms | | Max interval | 60 s | | Exponent | 1.5 | | Max elapsed time | 1 h | | Retried status codes | 5XX | | Retry connection errors | Yes |

You can override the retry strategy per call:

import { Maesn } from "@maesn/typescript-sdk";

const maesn = new Maesn({
  serverURL: "https://api.example.com",
  security: {
    apiKey: process.env["MAESN_API_KEY"] ?? "",
    accountKey: process.env["MAESN_ACCOUNT_KEY"] ?? "",
  },
});

async function run() {
  const result = await maesn.accounting.getAccount({
    accountId: "<id>",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 500,
        maxInterval: 60000,
        exponent: 1.5,
        maxElapsedTime: 3600000,
      },
      retryConnectionErrors: true,
    },
  });

  console.log(result);
}

run();

Or override the default for all operations at SDK initialization:

import { Maesn } from "@maesn/typescript-sdk";

const maesn = new Maesn({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 500,
      maxInterval: 60000,
      exponent: 1.5,
      maxElapsedTime: 3600000,
    },
    retryConnectionErrors: true,
  },
  security: {
    apiKey: process.env["MAESN_API_KEY"] ?? "",
    accountKey: process.env["MAESN_ACCOUNT_KEY"] ?? "",
  },
});

async function run() {
  const result = await maesn.accounting.getAccount({
    accountId: "<id>",
  });

  console.log(result);
}

run();

Error Handling

MaesnError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { Maesn } from "@maesn/typescript-sdk";
import * as errors from "@maesn/typescript-sdk/models/errors";

const maesn = new Maesn({
  serverURL: "https://api.example.com",
  apiKey: "<value>",
  accountKey: "<value>",
});

async function run() {
  try {
    const result = await maesn.accounting.getAccount({
      accountId: "<id>",
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.MaesnError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

MaesnError: The base class for HTTP error responses.

Network errors:

ConnectionError: HTTP client was unable to make a request to a server.
RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
RequestAbortedError: HTTP request was aborted by the client.
InvalidRequestError: Any input used to create a request is invalid.
UnexpectedClientError: Unrecognised or unexpected error.

Inherit from MaesnError:

ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

route requests through a proxy server using undici's ProxyAgent
use the "beforeRequest" hook to add a custom header and a timeout to requests
use the "requestError" hook to log errors

import { Maesn } from "@maesn/typescript-sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@maesn/typescript-sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Maesn({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Maesn } from "@maesn/typescript-sdk";

const sdk = new Maesn({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable MAESN_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

maesn

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Available Resources and Operations

Standalone functions

File uploads

Retries

Error Handling

Example

Error Classes

Custom HTTP Client

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy