# cloudify-ui-common-backend

> Common Cloudify UI backend library

Latest version **1.3.5** (published 2024-10-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install cloudify-ui-common-backend
pnpm add cloudify-ui-common-backend
yarn add cloudify-ui-common-backend
bun add cloudify-ui-common-backend
```

## 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.3.5 |
| Published | 2024-10-14 |
| First published | 2022-10-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | 18.20.x |
| Dependencies | 8 |
| Unpacked size | 93.8 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Cloudify Platform Ltd. |
| Maintainers | cloudify-it |

## Links

- npm: https://www.npmjs.com/package/cloudify-ui-common-backend
- Repository: https://github.com/cloudify-cosmo/cloudify-ui-common
- Homepage: https://github.com/cloudify-cosmo/cloudify-ui-common/blob/master/packages/backend/README.md
- Issues: https://github.com/cloudify-cosmo/cloudify-ui-common/issues
- npm.io page: https://npm.io/package/cloudify-ui-common-backend

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) ^1.7.2
- [umzug](https://npm.io/package/umzug.md) ^3.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [winston](https://npm.io/package/winston.md) ^3.3.3
- [sequelize](https://npm.io/package/sequelize.md) ^6.29.0
- [short-uuid](https://npm.io/package/short-uuid.md) ^4.2.2
- [simple-git](https://npm.io/package/simple-git.md) ^3.17.0

## Recent versions

- 1.3.5 (latest) — 2024-10-14
- 1.3.4 — 2024-06-03
- 1.3.3 — 2023-03-31
- 1.3.2 — 2023-03-30
- 1.3.1 — 2023-03-29
- 1.3.0 — 2023-03-28
- 1.2.0 — 2023-03-17
- 1.1.1 — 2023-02-23
- 1.1.0 — 2023-02-21
- 1.0.0 — 2022-10-10
- 1.0.0-pre.0 — 2022-10-10

## README

# Cloudify UI Common Backend

[![npm](https://img.shields.io/npm/v/cloudify-ui-common-backend.svg?style=flat)](https://www.npmjs.com/package/cloudify-ui-common-backend)

This package contains common TypeScript code for Cloudify UI backend applications.

The following features are provided by the package:
1. Database connection and access handling - see [`getDbModule` function](./src/db.ts)
2. Logging framework initialization  - see [`initLogging` function](./src/logger.ts)
3. Database migration capabilities - see [`runMigration` function](./src/migration.ts)

## Installation

```npm
npm install cloudify-ui-common-backend
```

## Usage

Example of how to create logger and send a log:

```typescript
import { initLogging } from 'cloudify-ui-common-backend';

const loggerFactory = initLogging({ logLevel: "debug" });
const logger = loggerFactory.getLogger('MyCatagory');

logger.log('Something happened!')
```

## Development

- add new code to `src` folder
- remember to export new files in `src/index.ts` (otherwise the new code will not be available in the distribution package)
- build: `npm run build` (TypeScript compilation)
- test: `npm run test` (unit testing with [Jest](https://jestjs.io/en/) testing framework), `npm run lint` (static analysis, code style check) and `npm run check-types` (TypeScript types check)
- document your code (we are using [JSdoc block tags](https://jsdoc.app/#block-tags))

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