# restaurelia

> Aurelia services to handle Restful Resources properly and easily

Latest version **1.0.0-alpha.3** (published 2016-09-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install restaurelia
pnpm add restaurelia
yarn add restaurelia
bun add restaurelia
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.3 |
| Published | 2016-09-22 |
| First published | 2016-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gery Hirschfeld |
| Maintainers | hirsch88 |
| Keywords | aurelia, restful, plugin, orm, rest, client, api |

## Links

- npm: https://www.npmjs.com/package/restaurelia
- Repository: https://github.com/w3tecch/restaurelia
- Homepage: http://www.w3tec.ch
- Issues: https://github.com/w3tecch/restaurelia/issues
- npm.io page: https://npm.io/package/restaurelia

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.15.0
- [aurelia-path](https://npm.io/package/aurelia-path.md) ^1.0.0
- [aurelia-logging](https://npm.io/package/aurelia-logging.md) ^1.0.0
- [aurelia-framework](https://npm.io/package/aurelia-framework.md) ^1.0.0
- [aurelia-fetch-client](https://npm.io/package/aurelia-fetch-client.md) ^1.0.0
- [aurelia-dependency-injection](https://npm.io/package/aurelia-dependency-injection.md) ^1.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0-alpha.3 (latest) — 2016-09-22
- 1.0.0-alpha.1 — 2016-09-21
- 1.0.0-alpha — 2016-09-21

## README

# REST-Aurelia [![Build Status](https://api.travis-ci.org/w3tecch/restaurelia.svg?branch=master)](https://travis-ci.org/w3tecch/restaurelia)

This library is part of the [Aurelia](http://www.aurelia.io/) platform and contains a lightweight, extensible services to handle Restful Resources properly and easily

> To keep up to date on [Aurelia](http://www.aurelia.io/), please visit and subscribe to [the official blog](http://blog.aurelia.io/) and [our email list](http://eepurl.com/ces50j). We also invite you to [follow us on twitter](https://twitter.com/aureliaeffect). If you have questions, please [join our community on Gitter](https://gitter.im/aurelia/discuss) or use [stack overflow](http://stackoverflow.com/search?q=aurelia). Documentation can be found [in our developer hub](http://aurelia.io/hub.html). If you would like to have deeper insight into our development process, please install the [ZenHub](https://zenhub.io) Chrome or Firefox Extension and visit any of our repository's boards.

##Usage
###Configuration
This is all you need to start whith your defined api.
```js
aurelia.use
  ...
  .plugin('restaurelia', config => {

    // Add hosts
		config.addApi('my-api', {
    	url: 'http://localhost:3030',
    	headers: {
      	'Accept': 'application/json'
      }
    });
  })
	...
```

###Define your API-Service
First import the library:

```js
import {inject} from 'aurelia-framework';
import {RESTService, api} from 'restaurelia';
```

Than there are 2 ways to describe your api servcie.

```js
// For the default api or if there is only one, the endpoint is enough
@api('/pets')
export class MyService extends RESTService {

}

// For multiple apis the name and enpoint are important. Moreover,
// headers can also be defined for this service
@api({
	name: 'my-api',
	endpoint: '/pets',
	headers: {
		'Content-Type': 'application/json'
	}
})
export class MyService extends RESTService {

	// Besides the applied methods(see below), custom methods can also be added
	customMethod() {
		return this.request(path, options);
	}

}
```

####Request method params
- `path`: `string` - has the url to your endpoint
- `options`: `Object`
  - `method`: `string` - like GET, POST, PUT, DELETE
  - `body`: `Object|string` - Can be a simple string or a json-object
  - `query`: `Object` - these are the query-params
  - `headers`: `Object` - this overwrites all the other default headers

###Service methods
These servcie methods will be available if you attacht the annotation `@api(...)`

```js
// GET - Gets a list of the main entity
find(query, headers) => Promise<T>

// GET - Used to get a single entity
get(id, query, headers) => Promise<T>

// POST - Creates a new entity
create(data, query, headers) => Promise<T>

// PUT - Updates an entity
update(id, data, query, headers) => Promise<T>

// DELETE - Deletes the given entity
remove(id, query, headers) => Promise<void>
```

**Params**
- `id`: `string` - identifier of the entity
- `data`: `Object|string` - can be a simple string or a json-object
- `query`: `Object` - these are the query-params
- `headers`: `Object` - this overwrites all the other default headers

## Platform Support

This library can be used in the **browser** as well as on the **server**.

## Building The Code

To build the code, follow these steps.

1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:

	```shell
	npm install
	```
3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:

	```shell
	npm install -g gulp
	```
4. To build the code, you can now run:

	```shell
	gulp build
	```
5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.

6. See `gulpfile.js` for other tasks related to generating the docs and linting.

## Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:

	```shell
	npm install -g karma-cli
	```
2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:

	```shell
	npm install -g jspm
	```
3. Install the client-side dependencies with jspm:

	```shell
	jspm install
	```

4. You can now run the tests with this command:

	```shell
	karma start
	```

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