# fh-mbaas-api

> FeedHenry MBAAS Cloud APIs

Latest version **9.2.0** (published 2020-01-10) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install fh-mbaas-api
pnpm add fh-mbaas-api
yarn add fh-mbaas-api
bun add fh-mbaas-api
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.2.0 |
| Published | 2020-01-10 |
| First published | 2014-04-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 17 |
| Unpacked size | 460.5 KB |
| Known vulnerabilities | 0 (+5 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | akeating-redhat, aliok, craigbrookes, damurphy, david-martin, davidffrench, feedhenry, grdryn, jasonmadigan, lrossetti, lzuccare, maleck13, matzew, ndonnell, omatskiv, pb82, pbrookes, psturc, roregan, sedroche, thaile, tjackman-rh, weileylee, witmicko, wtrocki, ziccardi |

## Links

- npm: https://www.npmjs.com/package/fh-mbaas-api
- Repository: https://github.com/feedhenry/fh-mbaas-api
- Homepage: https://github.com/feedhenry/fh-mbaas-api#readme
- Issues: https://github.com/feedhenry/fh-mbaas-api/issues
- npm.io page: https://npm.io/package/fh-mbaas-api

## Dependencies (17)

- [async](https://npm.io/package/async.md) 2.1.5
- [debug](https://npm.io/package/debug.md) 2.6.9
- [fh-db](https://npm.io/package/fh-db.md) 3.3.2
- [redis](https://npm.io/package/redis.md) 2.8.0
- [xtend](https://npm.io/package/xtend.md) 4.0.1
- [optval](https://npm.io/package/optval.md) 1.0.1
- [fh-sync](https://npm.io/package/fh-sync.md) 2.1.0
- [request](https://npm.io/package/request.md) 2.88.0
- [fh-statsc](https://npm.io/package/fh-statsc.md) 1.0.0
- [memcached](https://npm.io/package/memcached.md) ^2.0.0
- [underscore](https://npm.io/package/underscore.md) 1.7.0
- [fh-security](https://npm.io/package/fh-security.md) 0.4.0
- [mongodb-uri](https://npm.io/package/mongodb-uri.md) 0.9.7
- [lodash-contrib](https://npm.io/package/lodash-contrib.md) ^393.0.1
- [fh-mbaas-client](https://npm.io/package/fh-mbaas-client.md) 1.1.4
- [fh-mbaas-express](https://npm.io/package/fh-mbaas-express.md) 6.1.2
- [unifiedpush-node-sender](https://npm.io/package/unifiedpush-node-sender.md) 0.12.1

## Recent versions

- 9.2.0 (latest) — 2020-01-10
- 9.2.0-dev1 (dev) — 2019-12-19
- 9.1.3-dev-1 (developement) — 2018-10-04
- 9.0.2 (next) — 2018-08-23
- 7.0.14-fhdbdowngrade.1 (fhdbdowngrade.1) — 2017-07-14
- 7.0.9 (latest-7) — 2017-05-16
- 5.13.0 (latest-next) — 2016-06-30
- 9.1.5 — 2019-04-26
- 9.1.4 — 2018-11-01
- 9.1.3 — 2018-10-19
- 9.1.2-dev-1 — 2018-10-02
- 9.1.1 — 2018-09-27
- 9.1.0 — 2018-09-19
- 9.0.4 — 2018-08-24
- 9.0.3 — 2018-08-24
- … 192 more at https://npm.io/package/fh-mbaas-api/versions

## README

# fh-mbaas-api

fh-mbaas-api provides FeedHenry MBaaS APIs for Node.js cloud apps.

[![npm package](https://nodei.co/npm/fh-mbaas-api.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/fh-mbaas-api/)

[![Build status](https://img.shields.io/travis/feedhenry/fh-mbaas-api/master.svg?style=flat-square)](https://travis-ci.org/feedhenry/fh-mbaas-api)
[![Dependency Status](https://img.shields.io/david/feedhenry/fh-mbaas-api.svg?style=flat-square)](https://david-dm.org/feedhenry/fh-mbaas-api)
[![Known Vulnerabilities](https://snyk.io/test/npm/fh-mbaas-api/badge.svg?style=flat-square)](https://snyk.io/test/npm/fh-mbaas-api)


|                 | Project Info  |
| --------------- | ------------- |
| License:        | Apache License, Version 2.0  |
| Build:          | npm  |
| Documentation:  | http://docs.feedhenry.com/v3/api/cloud_api.html  |
| Issue tracker:  | https://issues.jboss.org/projects/FH/summary  |
| Mailing list:   | [feedhenry-dev](https://www.redhat.com/archives/feedhenry-dev/) ([subscribe](https://www.redhat.com/mailman/listinfo/feedhenry-dev))  |
| IRC:            | [#feedhenry](https://webchat.freenode.net/?channels=feedhenry) channel in the [freenode](http://freenode.net/) network.  |

## Usage
fh-mbaas-api is included as standard with your cloud app code.

For custom apps, add the module via npm by running the following for the root of your app

```
npm install --save fh-mbaas-api
```

> NOTE: Original package is in mantenance mode. For latest updates please use
`fh-mbaas-api-community`

This will install the latest version of fh-mbaas-api and save the installed version in your package.json

## Documentation
Documentation for the $fh cloud API is maintained at the [Red Hat Customer Portal.](https://access.redhat.com/documentation/en-us/red_hat_mobile_application_platform_hosted/3/html/cloud_api/)

## Deprecated
Legacy Rhino functions have been deprecated. These are listed below - with their replacements **in bold**. All replacements listed but '$fh.web' have drop-in replacements available.

* $fh.web -> **[request](https://github.com/mikeal/request)**
* $fh.log -> **console.log**
* $fh.parse -> **JSON.parse**
* $fh.stringify  **JSON.stringify**

## Tests
In order to run the tests, please make sure you have [Docker](https://www.docker.com/) installed.

Before running tests do:

```
npm install
npm install -g grunt-cli
```

Then to run the tests use ```npm test```

On Windows, use ```npm run testwindows```

## API logging

Users of the fh-mbaas-api can then enable logging if they would like to see more output. This is useful for debugging purposes.
It's possible to pass environment variables to enable the logging according the rules specified for [debug](https://www.npmjs.com/package/debug) module:

```
DEBUG="fh-mbaas-api:*" ./yourscript
```
If `DEBUG_COLORS=0` is passed also it will print log messages with proper timestamps. This is automatically enabled outside properly supported terminal.

## Contributing to fh-mbaas-api

### Pull Requests

All PRs that involve a version bump to fh-mbaas-api to should also update the CHANGELOG.md file in the root of the repo. All notable changes to the codebase since the last version bump should be included.

### Commit Messages

All commit messages should adhere to the following standard:

```
<type>[optional scope]: <description> [issue reference**]
 
[optional body]
 
[optional footer]
```

** if commit relates to a specific JIRA/ issue ticket include the reference here.

Examples of commits following this convention:

- bug-fixes: `git commit -a -m "fix(parsing): fixed a bug in our parser (RHMAP-1234)"`
- features: `git commit -a -m "feat(parser): we now have a parser \o/ (FH-3456)"`
- breaking changes: 
```
git commit -a -m "feat(new-parser): introduces a new parsing library (FH-6789)
BREAKING CHANGE: new library does not support foo-construct"
```
- other changes: `git commit -a -m "docs: fixed up the docs a bit"`

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