pouchdb-seed-design

v0.3.0

Seed CouchDB's design documents with PouchDB

NPM

README

GitHub

Website

MIT

Latest version published 5 years ago

    npm install pouchdb-seed-design

We couldn't find any similar packages Browse all packages

Package Health Score

40 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (77)

Dependents: 15
GitHub Stars: 13
Forks: 8
Contributors: 3

The npm package pouchdb-seed-design receives a total of 77 downloads a week. As such, we scored pouchdb-seed-design popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package pouchdb-seed-design, we found that it has been starred 13 times, and that 15 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.0.6

0.2.2

0.3.0

Indirect Vulnerabilities

0.0.6

0.2.2

0.3.0

License Risks

0.0.6

0.2.2

0.3.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like pouchdb-seed-design is missing a security policy.

Snyk detected that the latest version of pouchdb-seed-design has a security vulnerability.

We highly advise you to review these security issues.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like pouchdb-seed-design is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test pouchdb-seed-design

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 1
Merged PR: 1
Open PR: 2
Last Commit: 5 years ago

Further analysis of the maintenance status of pouchdb-seed-design based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for pouchdb-seed-design is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: No
Contributing.md: No
Code of Conduct: No
Contributors: 3
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like pouchdb-seed-design is missing a Code of Conduct.

How about a good first contribution to this project? It seems that pouchdb-seed-design is missing a README file.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 4 Direct / 16 Total
Versions: 6
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

We detected a total of 16 direct & transitive dependencies for pouchdb-seed-design. See the full dependency tree of pouchdb-seed-design

pouchdb-seed-design has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

pouchdb-seed-design

Seed CouchDB design documents with PouchDB.

##Build status

Installation

npm install pouchdb-seed-design

Usage

var PouchDB = require('pouchdb');
var pouchSeed = require('pouchdb-seed-design');
var db = new PouchDB('https://localhost:5984/design');

var ddoc = {
 person: {
   views: {
     byFirstName: function (doc) {
       emit(doc.firstName);
     },
     byLastName: function (doc) {
       emit(doc.lastName);
     },
     byFullName: function (doc) {
       emit(doc.firstName + ' ' + doc.lastName);
     }
   }
 }
};

var promise = pouchSeed(db, ddoc).then(function(updated) {
  if(updated) {
    console.log('DDocs updated!');
  } else {
    console.log('No update was necessary');
  }
});

API

`pouchSeed(db, design, cb)`

db (object, required) - PouchDB (or compatible) database object
design (object, required) - design object
cb (function, optional) - callback

Creates a set of CouchDB design documents basing on design object. Each key in design object becomes a separate design document called ('_design/' + key).

If no changes between remote design documents and design object are detected, no updates are sent to CouchDB.

Seed will return a Promise that fulfills with false if no updates were necessary, or the result of the bulkDocs operation if changes were pushed. (You will need a Promise shim if you are using an older browser or version of Node.)

The browser version will export window.pouchSeed.

Updates

(0.3.0) 2016-05-08

You can now use docs with absolutely any JSON schema. All functions in the tree are converted to strings. This will future proof pouchdb-seed-design as the design doc standards evolve. Added browser support.

(0.2.0) 2015-09-16

Added support for filters, lists, shows, and validate_doc_update thanks to Will Holley.

Credits

This project is forked from couchdb-seed-design by Maciej Małecki.

A huge round of applause goes to Dale Harvey, Calvin Metcalf, and Nolan Lawson for all the tireless work they put into maintaining PouchDB!

And a special thanks goes to Mirco Zeiss for all the awesome blog articles on how to use Node.js, Express, and CouchDB!