# @phish108/web-service-core

> Basic Wrapper for Service Endpoints for REST and MQ

Latest version **1.0.2** (published 2024-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @phish108/web-service-core
pnpm add @phish108/web-service-core
yarn add @phish108/web-service-core
bun add @phish108/web-service-core
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: insecure dependencies; abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2024-02-09 |
| First published | 2024-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 28.7 KB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Christian Glahn |
| Maintainers | phish108 |

## Links

- npm: https://www.npmjs.com/package/@phish108/web-service-core
- Repository: https://github.com/sustainability-zhaw/node-web-service
- Homepage: https://github.com/sustainability-zhaw/node-web-service#readme
- Issues: https://github.com/sustainability-zhaw/node-web-service/issues
- npm.io page: https://npm.io/package/@phish108/web-service-core

## Dependencies (7)

- [koa](https://npm.io/package/koa.md) 2.15.0
- [amqplib](https://npm.io/package/amqplib.md) 0.10.3
- [koa-body](https://npm.io/package/koa-body.md) 6.0.1
- [@koa/router](https://npm.io/package/@koa/router.md) 12.0.1
- [koa-compose](https://npm.io/package/koa-compose.md) 4.1.0
- [service_logger](https://npm.io/package/service_logger.md) github:phish108/node-service-logger#5aee176
- [@phish108/yaml-configurator](https://npm.io/package/@phish108/yaml-configurator.md) 1.2.0

## Recent versions

- 1.0.2 (latest) — 2024-02-09
- 1.0.1 — 2024-02-08
- 1.0.0 — 2024-02-08

## README

# node-web-service

Synthesize common functions for JS-Koa Webserivces.

![Automatic Testing](https://github.com/sustainability-zhaw/node-web-service/actions/workflows/tests.yml/badge.svg)

This package serves as the foundation for the sdg js services. It allows to 
focus on handler functions instead by removing common code. It also enforces 
common standard practices for the services.

## Features
- JSON log format (based on `winston`)
- Endpoint level performance logging 
- Koa integration 
- Message Queue integration
- graphql backend integration
- Dynamic configuration

## Usage

```bash
npm install @phish108/web-service-core
```

After that the component can be included in the project.

```javascript
import * as App from "@phish108/web-service-core"

// load your service's request handlers
import * as ServiceHandler from "./handler"

// load your service's configuration defaults, which should
// include your endpoint definition.
import defaults from "./defaults.json" with {type: "json"};

const instance = await App.init(defaults, ServiceHandler);

// run any module level initialisation based on instance.config etc.

instance.run();
```

The instance has a single `run()` function, but includes references to 
the service's `config`, `Logger`, message queue (`mq`) and graphql 
database (`db`). These options can be used to initialise anly components 
if needed. These components are also available per request in the 
request's `ctx.state` object.

## Service configuration

This system uses `@phish108/yaml-configurator` for system configuration. 
This allows for flexible service configuation in YAML or JSON with default
presets. 

The `defaults` need to be provided as JSON (to make us of the JSON importer).

### Routes

In order to make this module work for you, you need to define your endpoint 
logic under endpoints. The following example shows a simple service 
configuation with a single endpoint. 

```json
{
    "endpoints": [
        {
            "route": "/hello",
            "method": "post",
            "handler": [
                "loadFromDatabase",
                "respondHello"
            ]
        }
    ]
}
```

The  handler list needs to be a list of type string, where each string 
is a handler provided in your `ServiceHandler`-object. Internally these 
handlers are stacked by docker compose in the given sequence. If a handler 
is missing, the service raises an error and refuses to start.

### Configuration files

The `init()` function requires the defaults and the service handler object.
Optionally, one can pass a number of locations where the module should look 
for the configuration files. By default the module will check the following
locations in the order given below: 

- `/etc/app/config.yaml`
- `/etc/app/config.json`
- `./config.yaml`
- `./tools/config.yaml`

It is convinient not to touch these locations and just place your config
in one of these locations in your Docker container. If you insist, you 
can pass custom locations to the `init()` function. These locations 
will be prepended to the default locations, so in case a sysadmin ignores 
your locations the default locations will still work.

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