Gathering detailed insights and metrics for mongodb-realm-api-client
Gathering detailed insights and metrics for mongodb-realm-api-client
Installations
npm install mongodb-realm-api-clientDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.22.12
NPM Version
6.14.16
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
montumodi
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
1 Stars
62 Commits
2 Watchers
6 Branches
1 Contributors
Updated on Dec 13, 2021
Maintainers
1
Package Meta Information
Latest Version
1.30.0
Package Id
mongodb-realm-api-client@1.30.0
Unpacked Size
40.33 kB
Size
8.73 kB
File Count
7
NPM Version
6.14.16
Node Version
12.22.12
Published on
Jan 30, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
3
Mongodb realm api client for NODEJS
A mongdb realm api client for nodejs.
This is using mongodb-stitch-api-client under the hood. Soon mongodb-stitch-api-client will be deprecated.
How to install
npm install mongodb-realm-api-client
Getting Started
The basic syntax is:
1const getClient = require("mongodb-realm-api-client"); 2 3const {trigger, application} = getClient({ 4 "publicKey": "some public key", 5 "privateKey": "some private key", 6 "baseUrl": "https://stitch.mongodb.com/api/admin/v3.0", 7 "projectId": "some project/group id", 8 "appId": "some stitch appId" // Optional when you are creating app using Application 9}); 10 11await trigger.getAll(); 12const createApplication = await application.create({"name": "myFirstStitchApp", "deployment_model": "LOCAL", "location": "IE"}); 13
Running the tests
npm test
API
Following entities are currently supported
Application
application.create(body, [productType]) ⇒ Promise
Creates the stitch application
Kind: instance method of Application
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
|---|---|---|---|
| body | Object | Object that contains stitch application details. | |
| [productType] | string | standard | Optional product type. standard or atlas |
application.getAll([productType]) ⇒ Promise
Returns all applications
Kind: instance method of Application
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
|---|---|---|---|
| [productType] | string | standard | Optional product type. standard or atlas |
application.get(appId) ⇒ Promise
Returns a single application as per app Id
Kind: instance method of Application
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| appId | string | Application Id |
application.delete(appId) ⇒ Promise
Deletes a single application as per app Id
Kind: instance method of Application
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| appId | string | Application Id |
Service
service.create(body) ⇒ Promise
Creates the service
Kind: instance method of Service
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| body | Object | Object that contains stitch service details. |
service.update(serviceId, body) ⇒ Promise
Updates the service
Kind: instance method of Service
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | Service Id. |
| body | Object | Object that contains stitch service details. |
service.getAll() ⇒ Promise
Returns all services
Kind: instance method of Service
Returns: Promise - - promise which resolves on success and rejects on error
service.get(serviceId) ⇒ Promise
Returns single service as per service Id
Kind: instance method of Service
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | Service Id |
service.delete(serviceId) ⇒ Promise
Deletes single service as per service Id
Kind: instance method of Service
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | Service Id |
Trigger
trigger.create(body) ⇒ Promise
Creates the trigger
Kind: instance method of Trigger
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| body | Object | Object that contains stitch trigger details. |
trigger.update(triggerId, body) ⇒ Promise
Updates the trigger
Kind: instance method of Trigger
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| triggerId | string | Service Id. |
| body | Object | Object that contains stitch trigger details. |
trigger.resume(triggerId, [useResumeToken]) ⇒ Promise
Resumes the trigger
Kind: instance method of Trigger
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| triggerId | string | Service Id. |
| useResumeToken | bool | Whether to use resume token for restarting trigger. Default is true. |
trigger.getAll() ⇒ Promise
Returns all triggers
Kind: instance method of Trigger
Returns: Promise - - promise which resolves on success and rejects on error
trigger.get(triggerId) ⇒ Promise
Returns single trigger as per trigger Id
Kind: instance method of Trigger
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| triggerId | string | Trigger Id |
trigger.delete(triggerId) ⇒ Promise
Deletes single trigger as per trigger Id
Kind: instance method of Trigger
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| triggerId | string | Trigger Id |
Token
token.getBearerToken() ⇒ Promise
Returns the bearer token as per public key and private key
Kind: instance method of Token
Returns: Promise - - promise which resolves on success and rejects on error
StitchFunction
stitchFunction.create(body) ⇒ Promise
Creates the function
Kind: instance method of StitchFunction
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| body | Object | Object that contains stitch functions details. |
stitchFunction.update(functionId, body) ⇒ Promise
Updates the function
Kind: instance method of StitchFunction
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| functionId | string | Service Id. |
| body | Object | Object that contains stitch function details. |
stitchFunction.getAll() ⇒ Promise
Returns all functions
Kind: instance method of StitchFunction
Returns: Promise - - promise which resolves on success and rejects on error
stitchFunction.get(functionId) ⇒ Promise
Returns single function as per function Id
Kind: instance method of StitchFunction
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| functionId | string | function Id |
stitchFunction.delete(functionId) ⇒ Promise
Deletes single function as per function Id
Kind: instance method of StitchFunction
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| functionId | string | function Id |
Rule
rule.create(serviceId, body) ⇒ Promise
Creates the rule
Kind: instance method of Rule
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| body | Object | Object that contains stitch rules details. |
rule.update(serviceId, ruleId, body) ⇒ Promise
Updates the rule
Kind: instance method of Rule
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| ruleId | string | Service Id. |
| body | Object | Object that contains stitch rule details. |
rule.getAll(serviceId) ⇒ Promise
Returns all rules
Kind: instance method of Rule
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
rule.get(serviceId, ruleId) ⇒ Promise
Returns single rule as per rule Id
Kind: instance method of Rule
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| ruleId | string | rule Id |
rule.delete(serviceId, ruleId) ⇒ Promise
Deletes single rule as per rule Id
Kind: instance method of Rule
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| ruleId | string | rule Id |
Log
log.get([options]) ⇒ Promise
Returns all the logs as per options passed
Kind: instance method of Log
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
|---|---|---|---|
| [options] | object | {} | Options having parameter which will be passed as query string |
Security
security.allowOrigins(body) ⇒ Promise
Set the allowed HTTP origins from which Stitch should allow requests.
Kind: instance method of Security
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| body | Object | Object that contains allowed http origins |
security.getAll() ⇒ Promise
List the allowed HTTP origins from which Stitch should allow requests.
Kind: instance method of Security
Returns: Promise - - promise which resolves on success and rejects on error
email.sendConfirmationEmail(email) ⇒ Promise
Send a confirmation email.
Kind: instance method of Email
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
string | Email address. |
email.confirmPendingUser(email) ⇒ Promise
Confirm a pending user.
Kind: instance method of Email
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
string | Email address. |
email.reRunPendingConfirmation(email) ⇒ Promise
Re-runs a pending user’s confirmation workflow.
Kind: instance method of Email
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
string | Email address. |
Webhook
webhook.create(serviceId, body) ⇒ Promise
Creates the webhook
Kind: instance method of Webhook
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| body | Object | Object that contains stitch webhooks details. |
webhook.update(serviceId, webhookId, body) ⇒ Promise
Updates the webhook
Kind: instance method of Webhook
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| webhookId | string | Service Id. |
| body | Object | Object that contains stitch webhook details. |
webhook.getAll(serviceId) ⇒ Promise
Returns all webhooks
Kind: instance method of Webhook
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
webhook.get(serviceId, webhookId) ⇒ Promise
Returns single webhook as per webhook Id
Kind: instance method of Webhook
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| webhookId | string | webhook Id |
webhook.delete(serviceId, webhookId) ⇒ Promise
Deletes single webhook as per webhook Id
Kind: instance method of Webhook
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Description |
|---|---|---|
| serviceId | string | service id |
| webhookId | string | webhook Id |
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
5 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/npm-publish.yml:1
- Info: no jobLevel write permissions found
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/montumodi/mongodb-realm-api-client/npm-publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/montumodi/mongodb-realm-api-client/npm-publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/montumodi/mongodb-realm-api-client/npm-publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/montumodi/mongodb-realm-api-client/npm-publish.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/npm-publish.yml:19
- Warn: npmCommand not pinned by hash: .github/workflows/npm-publish.yml:20
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Score
2.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More