# @plasma-platform/tm-service-api

> Common tm microservice api methods

Latest version **2.5.0** (published 2023-10-06) · CC-BY-4.0 license · 0 weekly downloads

## Install

```sh
npm install @plasma-platform/tm-service-api
pnpm add @plasma-platform/tm-service-api
yarn add @plasma-platform/tm-service-api
bun add @plasma-platform/tm-service-api
```

## 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 | 2.5.0 |
| Published | 2023-10-06 |
| First published | 2018-01-15 |
| Weekly downloads | 0 |
| License | CC-BY-4.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anton Nemtsev |
| Maintainers | alienmonster, ch-tm, viram |
| Keywords | TM Micro Service, Template Monster, API |

## Links

- npm: https://www.npmjs.com/package/@plasma-platform/tm-service-api
- Repository: https://gitlab.com/TemplateMonster/PlasmaPlatform/Frontend/protoAPI
- Homepage: https://gitlab.com/TemplateMonster/PlasmaPlatform/Frontend/protoAPI#readme
- Issues: https://gitlab.com/TemplateMonster/PlasmaPlatform/Frontend/protoAPI/issues
- npm.io page: https://npm.io/package/@plasma-platform/tm-service-api

## Dependencies (3)

- [js-md5](https://npm.io/package/js-md5.md) ^0.7.3
- [urlencode](https://npm.io/package/urlencode.md) ^1.1.0
- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^2.2.1

## Recent versions

- 2.5.0 (latest) — 2023-10-06
- 2.3.1-0 (next) — 2018-02-09
- 2.3.4 — 2018-10-09
- 2.3.3 — 2018-10-08
- 2.3.2 — 2018-08-02
- 2.4.2 — 2018-08-01
- 2.3.0-0 — 2018-02-08
- 4.0.0-0 — 2018-02-08
- 2.2.0 — 2018-02-06
- 2.1.0 — 2018-02-05
- 2.0.19 — 2018-01-28
- 2.0.18 — 2018-01-28
- 2.0.17 — 2018-01-28
- 2.0.16 — 2018-01-28
- 2.0.15 — 2018-01-26
- … 9 more at https://npm.io/package/@plasma-platform/tm-service-api/versions

## README

# TM Micro Service API Prototype class

This class provide fetch wrapper, token and Service URL setter mainly. Just to avoid code duplication.

## Requirements

Possibly you will need babel-polyfill to use it.

# Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [ErrorBadRequest](#errorbadrequest)
-   [ErrorCache](#errorcache)
-   [ErrorNotFound](#errornotfound)
-   [ErrorServerResponse](#errorserverresponse)
-   [TMMicroServiceAPI](#tmmicroserviceapi)
    -   [url](#url)
    -   [token](#token)
    -   [messages](#messages)
    -   [setToken](#settoken)
    -   [setVersion](#setversion)
    -   [checkVersion](#checkversion)
    -   [request](#request)
-   [tmpVersion](#tmpversion)

## ErrorBadRequest

Custom error message for Bad Request server response

**Parameters**

-   `message` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

## ErrorCache

Custom error message for cache fail

**Parameters**

-   `message` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

## ErrorNotFound

Custom error message for Not Found server response

**Parameters**

-   `message` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

## ErrorServerResponse

Custom error message for abstract server response

**Parameters**

-   `statusCode` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** http status code
-   `statusText` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** http status code text
-   `message` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

## TMMicroServiceAPI

TM Micro Service Proto API

**Parameters**

-   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service url
-   `token` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** user access tocken if available (optional, default `null`)

### url

Service URL

**Properties**

-   `service` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url

### token

User access token

**Properties**

-   `token` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)?** user access tocken if available

### messages

Object with class service messages

### setToken

Set access token

**Parameters**

-   `token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** access token

### setVersion

Set service version

**Parameters**

-   `version` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service version

### checkVersion

Validate service version

**Parameters**

-   `version` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service version


-   Throws **[Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** if URL do not match format Error will be thrown

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** version - service version

### request

Fetch remote resource

**Parameters**

-   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** resource url
-   `userOptions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** user defined options

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** Promise with server [Response](https://developer.mozilla.org/docs/Web/API/Response)

## tmpVersion

Service version

**Properties**

-   `version` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** service version

---
_Source: https://npm.io/package/@plasma-platform/tm-service-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
