# test-oda-rest-client

> Oracle Bots Custom Component Package

Latest version **0.1.2** (published 2019-10-17) · 0 weekly downloads

## Install

```sh
npm install test-oda-rest-client
pnpm add test-oda-rest-client
yarn add test-oda-rest-client
bun add test-oda-rest-client
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2019-10-17 |
| First published | 2019-10-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | simingmu |

## Links

- npm: https://www.npmjs.com/package/test-oda-rest-client
- npm.io page: https://npm.io/package/test-oda-rest-client

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.88.0

## Recent versions

- 0.1.2 (latest) — 2019-10-17
- 0.1.1 — 2019-10-17
- 0.1.0 — 2019-10-17

## README

# Custom Component Package

This project is in format of a Component Package. Component Packages are the
recommended way to organize Bots Custom Components code and allow the custom
component code to be more portable to different runtime environments.

> Generated by `@oracle/bots-node-sdk` on **Wed Oct 02 2019**

## Structure

```text
.
├── .npmignore
├── components
│   └── ...
├── main.js
├── package.json
└── spec
    └── ...
```

| | Description |
|--|--|
| `.npmignore` | Ignore files when packaging as `npm` module |
| `components` | Directory _(default)_ where Component implementations are added |
| `main.js` | Entrypoint for the Custom Component Package configuration |
| `spec` | Placeholder for unit test implementations |

The Component Package behaves like any other `npm` project. Directly install
any dependencies or tools required to implement the customizations.

## Development

With `@oracle/bots-node-sdk` as a `devDependency` in a Component Package
gives the project some valuable command line functionality.

> **TIP:** Use `npm run bots-node-sdk` for additional CLI help and usage information.

This component package is ready to run as a local development service. Once the
service starts you may use a local tunnel, such as [`ngrok`](https://ngrok.com/),
and configure an _External_ Service to connect the components to your Skill.

```shell
npm start
# or run with additional options
npm run bots-node-sdk -- service .
# or run with debugger
node --inspect $(npm bin)/bots-node-sdk service .
```

With custom component services running, test endpoints like so:

```shell
# get component metadata
curl -X GET localhost:3000/components

# invoke custom component
curl -H "Content-Type: application/json" -d @./spec/test.req.json localhost:3000/components/RestClient
```

## Deployment

As this package is designed to be installed and run with a corresponding service
wrapper, run `npm pack` and upload the resulting `.tgz` as a package for
the _Embedded Container_ service.

```shell
npm pack
# or validate and package with the @oracle/bots-node-sdk command line
npm run bots-node-sdk -- pack .
```

> **TIP:** use `npm run bots-node-sdk -- pack --help` for additional packaging
options.

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