Skip to content

About

TypeScript libraries for Kiota-generated API clients.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

62 stars

Watchers

13 watching

Forks

Latest commit

 

History

4,006 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kiota Libraries for TypeScript

The Kiota libraries define the basic constructs needed by TypeScript and JavaScript clients generated from an OpenAPI definition and provide default implementations for serialization, authentication, and HTTP transport.

A Kiota generated project uses these runtime libraries to build and execute API requests in Node.js and browsers.

Read more about Kiota here.

Supported runtimes

The libraries support Node.js 22.x, 24.x, and 26.x, as well as browsers. Node.js 20 is no longer supported.

Build Status

Build and test

Libraries

Library npm Release
Abstractions npm version
Authentication - Azure npm version
Authentication - SharePoint Framework npm version
HTTP - Fetch npm version
Serialization - JSON npm version
Serialization - FORM npm version
Serialization - TEXT npm version
Serialization - MULTIPART npm version
Bundle npm version

Getting started

The bundle provides a Fetch-based request adapter with the default serialization libraries configured:

npm install @microsoft/kiota-bundle

Install an authentication library separately if your API requires it. See the individual library READMEs above for installation and usage details.

For client generation and a complete example, see the Kiota TypeScript quickstart.

Release notes

Release notes are available in each library's CHANGELOG.md alongside its README. Each library is versioned independently.

Building and testing

This repository is a Lerna monorepo using npm workspaces, with libraries under packages/.

Use a supported Node.js version (22.x, 24.x, or 26.x) for local development. CI builds and tests all three versions; coverage and Azure Pipelines use Node.js 26.x.

# Restore the exact dependencies from the lockfile
npm ci

# Build all libraries
npm run build

# Run Node.js and browser tests
npm test

# Lint
npm run lint

To build or run Node.js tests for a single library:

npx lerna run build --scope @microsoft/kiota-serialization-json
npx lerna run test:node --scope @microsoft/kiota-serialization-json

Build dependent libraries before testing a library that uses them.

Debugging

If you use Visual Studio Code, .vscode/launch.json contains configurations for debugging the current test file and browser tests.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

About

TypeScript libraries for Kiota-generated API clients.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

62 stars

Watchers

13 watching

Forks

Releases

Used by

Contributors

Languages