@openremote/rest 1.0.2 → 1.2.0-snapshot.20240512154942

package/README.md

@@ -1,27 +1,74 @@
-# or-core
-
-> ${DESCRIPTION}
-
+# @openremote/rest
 [![NPM Version][npm-image]][npm-url]
 [![Linux Build][travis-image]][travis-url]
 [![Test Coverage][coveralls-image]][coveralls-url]
 
-## Install
+ES6 modules for connecting to an OpenRemote Manager as well as utilities for performing common tasks.
+
+The default export is a singleton of type `RestApi` that can be used to communicate with the OpenRemote Manager REST API.
+It uses an [axios](https://github.com/axios/axios) client to perform the requests and it contains strongly typed
+definitions for each OpenRemote Manager REST API endpoint (JAX-RS resource). 
+
 
+
+## Install
 ```bash
-npm i -S @openremote/or-core
+npm i @openremote/rest
+yarn add @openremote/rest 
 ```
 
 ## Usage
+For a full list of properties, methods and options refer to the TypeDoc generated [documentation]().
 
-TODO
+If used in conjunction with `@openremote/core` and the `Manager` `init` method has been called then the default export
+will be ready to use, the endpoints can be accessed via the `RestApi` `api` property and each JAX-RS resource defined
+in the OpenRemote Manager is also defined with the same name in the `RestApi` object.
 
-## License
+```$typescript
+import openremote from "@openremote/core";
+import rest from "@openremote/rest";
+
+openremote.init({
+    ...
+}).then((success) => {
+    if (success) {
+        let assetQuery = ...;
+        let response = await rest.api.AssetResource.queryAssets(assetQuery);
+        let assets = response.data;
+        
+        // Do something with the assets
+    } else {
+        // Something has gone wrong
+    }
+});
+```
 
+It is possible to add additional request interceptors by calling the `addRequestInterceptor` method, it is also possible
+to access the `AxiosInstance` by calling the `axiosInstance` property.
+
+It is also possible to instantiate the `RestApi` object on demand but note you will need to ensure the Authorization
+header is correctly set if calling secure endpoints on the OpenRemote Manager REST API.
+
+```$typescript
+import {RestApi} from "@openremote/rest";
+
+let rest = new RestApi();
+rest.setTimeout(10000);
+rest.addRequestInterceptor(...);
+rest.initialise();
+```
+
+
+## Supported Browsers
+The last 2 versions of all modern browsers are supported, including Chrome, Safari, Opera, Firefox, Edge. In addition,
+Internet Explorer 11 is also supported.
+
+
+## License
 [GNU AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)
 
 [npm-image]: https://img.shields.io/npm/v/live-xxx.svg
-[npm-url]: https://npmjs.org/package/live-xxx
+[npm-url]: https://npmjs.org/package/@openremote/core
 [travis-image]: https://img.shields.io/travis/live-js/live-xxx/master.svg
 [travis-url]: https://travis-ci.org/live-js/live-xxx
 [coveralls-image]: https://img.shields.io/coveralls/live-js/live-xxx/master.svg

package/lib/index.d.ts

@@ -0,0 +1,18 @@
+import { AxiosInstance, AxiosRequestConfig, GenericAxiosResponse, AxiosError } from "axios";
+import { ApiClient, RestResponse } from "./restclient";
+declare const isAxiosError: (payload: any) => payload is AxiosError<any, any>;
+export { RestResponse, GenericAxiosResponse, AxiosError, isAxiosError };
+export declare class RestApi {
+    get api(): ApiClient;
+    protected _client: ApiClient;
+    protected _axiosInstance: AxiosInstance;
+    protected _baseUrl: string;
+    constructor();
+    get axiosInstance(): AxiosInstance;
+    get baseUrl(): string;
+    setTimeout(timeout: number): void;
+    addRequestInterceptor(interceptor: (config: AxiosRequestConfig) => AxiosRequestConfig): void;
+    initialise(baseUrl: string): void;
+}
+declare const _default: RestApi;
+export default _default;

package/lib/index.js

@@ -0,0 +1 @@
+import axios from"axios";import{ApiClient}from"./restclient";import Qs from"qs";const isAxiosError=axios.isAxiosError;export{isAxiosError};export class RestApi{get api(){return this._client}constructor(){this._axiosInstance=axios.create(),this._axiosInstance.defaults.headers.common["Content-Type"]="application/json",this._axiosInstance.interceptors.request.use((t=>(t.paramsSerializer=t=>Qs.stringify(t,{arrayFormat:"repeat"}),t)))}get axiosInstance(){return this._axiosInstance}get baseUrl(){return this._baseUrl}setTimeout(t){this._axiosInstance.defaults.timeout=t}addRequestInterceptor(t){this._axiosInstance.interceptors.request.use(t)}initialise(t){this._baseUrl=t,this._client=new ApiClient(t,this._axiosInstance)}}export default new RestApi;

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA4E,MAAM,OAAO,CAAC;AACjG,OAAO,EAAC,SAAS,EAAe,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;AAExC,OAAO,EAAiD,YAAY,EAAC,CAAC;AAEtE,MAAM,OAAO,OAAO;IAEhB,IAAI,GAAG;QACH,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAMD;QACI,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACrC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACjF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACpD,MAAM,CAAC,gBAAgB,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC,CAAC;YACpF,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI,aAAa;QACb,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAEM,UAAU,CAAC,OAAe;QAC7B,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IACnD,CAAC;IAEM,qBAAqB,CAAC,WAA+D;QACxF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC9D,CAAC;IAEM,UAAU,CAAC,OAAe;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;CACJ;AAED,eAAe,IAAI,OAAO,EAAE,CAAC"}