Skip to content

README.md

Latest commit

 

History

History
62 lines (50 loc) · 8.43 KB

README.md

File metadata and controls

62 lines (50 loc) · 8.43 KB

APIMatic Runtime Packages for JavaScript SDKs

CI Coverage Vulnerabilities Maintainability Rating License

This is a collection of packages used in SDKs generated by the APIMatic Code Generator.

They provide common runtime utilities needed by SDKs to make API calls and handle request/response data.

List of Packages

Name Version Description
@apimatic/schema npm shield Validate and transform data using schema definitions.
@apimatic/authentication-adapters npm shield Provides pluggable adapters for different authentication schemes.
@apimatic/axios-client-adapter npm shield Axios HTTP Client adapter which can be plugged into @apimatic/core package.
@apimatic/convert-to-stream npm shield Provides bidirectional conversion between strings and streams/blobs.
@apimatic/core npm shield Provides core http logic of request building, response handling and validation and using api error classes
@apimatic/core-interfaces npm shield Abstraction layer for @apimatic/core.
@apimatic/file-wrapper npm shield Wrapper around the file types and their utilities.
@apimatic/http-headers npm shield HTTP Headers utilities for apimatic-js-runtime libraries.
@apimatic/http-query npm shield HTTP Query utilities for apimatic-js-runtime libraries
@apimatic/oauth-adapters npm shield Provides pluggable adapters for OAuth 2.0 authentication schemes.
@apimatic/xml-adapter npm shield Provides XML serialization and deserialization utilities for apimatic-js-runtime libraries.
@apimatic/test-utilities npm shield Provides assertion utilities for testing api calls. It can be plugged in as dev dependency to any library.
@apimatic/pagination npm shield Provides utilities to handle paginated API responses, including support for asynchronous iteration over pages or items.
@apimatic/proxy npm shield Provides proxy configuration utilities for HTTP clients.
@apimatic/hmac-signature-verifier npm shield Provides HMAC signature verification utilities to secure HTTP requests.

Builds and Usage

The following environments are supported:

  1. Node.js v14.15.0+
  2. Bundlers like Rollup or Webpack
  3. Web browsers

To support multiple environments, we export various builds:

Environment Usage
Common.js Import like this: require('@apimatic/<package-name>').
ES Module Import like this: import { /* your imports */ } from '@apimatic/<package-name>'.
Browsers *Use script: https://unpkg.com/@apimatic/<package-name>@VERSION/umd/<package-name>.js
Modern Browsers (supports ESM and uses modern JS) *Use script: https://unpkg.com/@apimatic/<package-name>@VERSION/umd/<package-name>.esm.js

* Don't forget to replace VERSION with the version number.

Note: We discourage importing files or modules directly from the package. These are likely to change in the future and should not be considered stable.