# apicco-sdk

> Apicco SDK creates dynamically an [Apicco API](https://github.com/SokratisVidros/apicco/blob/master/lib/README.md) client, that works both in Node and browser environments.

Latest version **1.0.13** (published 2021-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install apicco-sdk
pnpm add apicco-sdk
yarn add apicco-sdk
bun add apicco-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.13 |
| Published | 2021-05-29 |
| First published | 2018-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Sokratis Vidros |
| Maintainers | sokratis |

## Links

- npm: https://www.npmjs.com/package/apicco-sdk
- Repository: https://github.com/sokratisvidros/apicco
- Homepage: https://github.com/sokratisvidros/apicco#readme
- Issues: https://github.com/sokratisvidros/apicco/issues
- npm.io page: https://npm.io/package/apicco-sdk

## Dependencies (1)

- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^3.0

## Recent versions

- 1.0.13 (latest) — 2021-05-29
- 1.0.12 — 2020-10-31
- 1.0.11 — 2020-10-30
- 1.0.10 — 2020-09-28
- 1.0.9 — 2020-07-16
- 1.0.8 — 2020-05-20
- 1.0.7 — 2019-12-31
- 1.0.6 — 2019-08-28
- 1.0.5 — 2019-03-20
- 1.0.4 — 2019-02-22
- 1.0.3 — 2019-02-04
- 1.0.2 — 2018-10-12
- 1.0.1 — 2018-08-23
- 1.0.0 — 2018-05-18

## README

# Apicco-SDK

Apicco SDK creates dynamically an [Apicco API](https://github.com/SokratisVidros/apicco/blob/master/lib/README.md) client, that works both in Node and browser environments.

```
POST /api/movies.create      api.movies.create({ title: 'Foo' })
POST /api/movies.info        api.movies.info({ movie_id: 42 })
POST /api/movies.list    =>  api.movies.list()
POST /api/movies.update      api.movies.update({ movie_id: 42, title: 'Bar' }
POST /api/movies.delete      api.movies.delete({ movie_id: 42 }
```

## Usage

```JS
const apicco = require('apicco-sdk');

apicco({
  origin: 'http://apicco.test/',
}).then(api => {
  return api.users.sayHello();
});
```

### Sending session cookies along with requests (`credentials: include`)

Apicco will detect access control headers sent by the server during `/discovery` request and will include credentials in subsequent xhr requests.

Prerequisite for that is the server to send the following headers:
```
  'Access-Control-Allow-Credentials': true,
  'Access-Control-Expose-Headers': 'Access-Control-Allow-Credentials'
```

## RPC style method invocation

Apicco SDK enables developers to invoke remote endpoints in an RPC fashion. For example:

```
POST /api/users.sayHello  =>  api.users.sayHello({ name: 'John Doe' })
```

## Minimal versionless clients

Apicco SDK leverages discovery endpoint and fetches latest API description upon initialization. That way, client updates are not required when the API is modified and changes are backwards compatible.

Moreover, client size is minimal since there is no static code for any of endpoint.

## Human friendly error messages

Apicco API returns JSON error objects that contain human friendly error messages. For example when `foo_id` request parameter validation fails, the following error will be returned to the client:

```json
{
  "error": "Bad Request",
  "message": "Invalid Request Body - child \"foo_id\" fails because [\"foo_id\" must be a number]",
  "statusCode": 400
```

### Options

**origin**

Specify the origin of the Apicco API server

_Defaults to `''`_

**relPath**

Specify the relative of the Apicco API

_Defaults to `api/v1`_

**intercept**

Specify an interceptor function that will be executed before each request

_Defaults to `async (req) => req`_

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