Skip to content

formancehq/formance-sdk-typescript

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits

.github/workflows

.github/workflows

 
 

.speakeasy

.speakeasy

 
 

docs

docs

 
 

src

src

 
 

.eslintrc.js

.eslintrc.js

 
 

.eslintrc.yml

.eslintrc.yml

 
 

.gitattributes

.gitattributes

 
 

.gitignore

.gitignore

 
 

.npmignore

.npmignore

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

RELEASES.md

RELEASES.md

 
 

RUNTIMES.md

RUNTIMES.md

 
 

USAGE.md

USAGE.md

 
 

gen.yaml

gen.yaml

 
 

jsr.json

jsr.json

 
 

package-lock.json

package-lock.json

 
 

package.json

package.json

 
 

tsconfig.json

tsconfig.json

 
 

Repository files navigation

@formance/formance-sdk

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

SDK Installation

NPM

npm add @formance/formance-sdk

Yarn

yarn add @formance/formance-sdk

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // Handle the result
    console.log(result);
}

run();

Available Resources and Operations

SDK

auth

ledger

orchestration

payments

reconciliation

search

wallets

webhooks

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object Status Code Content Type
errors.ErrorResponse default application/json
errors.SDKError 4xx-5xx /

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { SDK } from "@formance/formance-sdk";
import * as errors from "@formance/formance-sdk/sdk/models/errors";

const sdk = new SDK({
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    let result;
    try {
        result = await sdk.ledger.createTransactions({
            transactions: {
                transactions: [
                    {
                        metadata: {
                            key: "<value>",
                        },
                        postings: [
                            {
                                amount: BigInt(100),
                                asset: "COIN",
                                destination: "users:002",
                                source: "users:001",
                            },
                        ],
                        reference: "ref:001",
                    },
                ],
            },
            ledger: "ledger001",
        });
    } catch (err) {
        switch (true) {
            case err instanceof errors.SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof errors.ErrorResponse: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

    // Handle the result
    console.log(result);
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 http://localhost None 
import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
    serverIdx: 0,
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // Handle the result
    console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
    serverURL: "http://localhost",
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // Handle the result
    console.log(result);
}

run();

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 use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { SDK } from "@formance/formance-sdk";
import { HTTPClient } from "@formance/formance-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 SDK({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
authorization oauth2 OAuth2 token

To authenticate with the API the authorization parameter must be set when initializing the SDK client instance. For example:

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // Handle the result
    console.log(result);
}

run();

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

4 stars

Watchers

1 watching

Forks

3 forks
Report repository

Releases 50

typescript - v2.3.1 - 2024-04-30 13:08:31 Latest
Apr 30, 2024
+ 49 releases

Packages

No packages published

Contributors 5

Languages