# sara-sdk-ts

> > SDK developed by Synkar to use SARA APIs.

Latest version **1.3.0** (published 2025-05-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install sara-sdk-ts
pnpm add sara-sdk-ts
yarn add sara-sdk-ts
bun add sara-sdk-ts
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2025-05-13 |
| First published | 2023-02-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 7.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Synkar Autonomous |
| Maintainers | synkar |

## Links

- npm: https://www.npmjs.com/package/sara-sdk-ts
- npm.io page: https://npm.io/package/sara-sdk-ts

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^1.3.1
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.2
- [webrtc](https://npm.io/package/webrtc.md) ^1.14.1
- [websocket](https://npm.io/package/websocket.md) ^1.0.34

## Recent versions

- 1.3.0 (latest) — 2025-05-13
- 1.2.10 — 2025-04-08
- 1.2.9 — 2024-11-13
- 1.2.8 — 2023-10-04
- 1.2.7 — 2023-10-04
- 1.2.6 — 2023-08-24
- 1.2.5 — 2023-08-08
- 1.2.4 — 2023-07-13
- 1.2.3 — 2023-07-13
- 1.2.2 — 2023-07-13
- 1.2.1 — 2023-07-06
- 1.2.0 — 2023-07-05
- 1.1.1 — 2023-03-21
- 1.1.0 — 2023-02-09

## README

# SARA Typescript SDK
> SDK developed by Synkar to use SARA APIs.

## Table of Contents
- [SARA Typescript SDK](#sara-typescript-sdk)
	- [Table of Contents](#table-of-contents)
	- [General Information](#general-information)
	- [Features](#features)
	- [Setup](#setup)
	- [Usage](#usage)
	- [Project Status](#project-status)
	- [Next Improvement](#next-improvement)
	- [Contact](#contact)
<!-- * [License](#license) -->


## General Information
- Access SARA APIs in typescript/javascript project.
- Allow users and clients create its own project that communicate with SARA APIs in a easily way.
- Better understanding of SARA resources
- Uxception handling
<!-- You don't have to answer all the questions - just the ones relevant to your project. -->


## Features
List the ready features here:
- IAM
- Mapping
- Missions V2
- Metrics
- Telemetry
- SRS
- Webhook
- Hivemind
- Toolbox
- Demos (Examples)


## Setup
SARA Typescript SDK can be installed via npm.

> `npm install sara-sdk-ts`

Or you can install in your package by adding:
> `npm install https://github.com/Synkar/SARA-TS-SDK`


## Usage
For usage is simple. You will need to import sara-sdk-ts in you JS/TS project.

> `import { Sara, Client as SaraClient } from "sara-sdk-ts";`

Second you authenticate with you ACCESS_KEY and SECRET_KEY:

> `await SaraClient.auth(access_key, secret_key);`

After authentication process complete you can use modules and resources like:

> `Sara.Iam.Users.Create({name: "John", email: "john@email.com"})`


## Project Status
Project is _in progress_.


## Next Improvement

New modules:
- Websocket module
To do:
- E2E testing
- Syntatic exceptions


## Contact
Created by [@synkar](https://www.synkar.com/) - feel free to contact us!


<!-- Optional -->
<!-- ## License -->
<!-- This project is open source and available under the [... License](). -->

<!-- You don't have to include all sections - just the one's relevant to your project -->

---
_Source: https://npm.io/package/sara-sdk-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._