(#6355) - extract changes filter into its own plugin
diff --git a/packages/node_modules/pouchdb-ajax/tmp.js b/packages/node_modules/pouchdb-ajax/tmp.js
deleted file mode 100644
index 5a48787..0000000
--- a/packages/node_modules/pouchdb-ajax/tmp.js
+++ /dev/null
@@ -1 +0,0 @@
-testUtils.ajax = require('./lib/index-browser')
diff --git a/packages/node_modules/pouchdb-changes-filter/LICENSE b/packages/node_modules/pouchdb-changes-filter/LICENSE
new file mode 100644
index 0000000..f6cd2bc
--- /dev/null
+++ b/packages/node_modules/pouchdb-changes-filter/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/packages/node_modules/pouchdb-changes-filter/README.md b/packages/node_modules/pouchdb-changes-filter/README.md
new file mode 100644
index 0000000..8d6bac0
--- /dev/null
+++ b/packages/node_modules/pouchdb-changes-filter/README.md
@@ -0,0 +1,28 @@
+pouchdb-changes-filter
+======
+
+Plugin to add the ability to use the `"filter"`, `"selector"`, `"doc_ids"`, `"query_params"`, and `"query"` fields in the `changes()`, `replicate()`, and `sync()` APIs.
+
+This is extract as a separate plugin because 1) it's fairly heavyweight, and 2) it contains `eval()`, which some environments disallow. So if you're not using filtered changes/replication, then you don't need this module.
+
+### Usage
+
+```bash
+npm install pouchdb-changes-filter
+```
+
+```js
+var PouchDB = require('pouchdb');
+var changesFilter = require('pouchdb-changes-filter');
+PouchDB.plugin(changesFilter);
+```
+
+For full API documentation and guides on PouchDB, see [PouchDB.com](http://pouchdb.com/). For details on PouchDB sub-packages, see the [Custom Builds documentation](http://pouchdb.com/custom.html).
+
+### Source
+
+PouchDB and its sub-packages are distributed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md).
+
+For a full list of packages, see [the GitHub source](https://github.com/pouchdb/pouchdb/tree/master/packages).
+
+
diff --git a/packages/node_modules/pouchdb-changes-filter/package.json b/packages/node_modules/pouchdb-changes-filter/package.json
new file mode 100644
index 0000000..ebcff5c
--- /dev/null
+++ b/packages/node_modules/pouchdb-changes-filter/package.json
@@ -0,0 +1,16 @@
+{
+ "name": "pouchdb-changes-filter",
+ "version": "6.2.0-prerelease",
+ "description": "Adds \"filter\", \"selector\", etc. to PouchDB's changes/replicate/sync APIs",
+ "main": "./lib/index.js",
+ "keywords": [],
+ "author": "Dale Harvey <dale@arandomurl.com>",
+ "license": "Apache-2.0",
+ "repository": "https://github.com/pouchdb/pouchdb",
+ "jsnext:main": "./src/index.js",
+ "browser": {
+ "./lib/index.js": "./lib/index-browser.js",
+ "./src/evalFilter.js": "./src/evalFilter-browser.js",
+ "./src/evalView.js": "./src/evalView-browser.js"
+ }
+}
diff --git a/packages/node_modules/pouchdb-core/src/evalFilter-browser.js b/packages/node_modules/pouchdb-changes-filter/src/evalFilter-browser.js
similarity index 100%
rename from packages/node_modules/pouchdb-core/src/evalFilter-browser.js
rename to packages/node_modules/pouchdb-changes-filter/src/evalFilter-browser.js
diff --git a/packages/node_modules/pouchdb-core/src/evalFilter.js b/packages/node_modules/pouchdb-changes-filter/src/evalFilter.js
similarity index 100%
rename from packages/node_modules/pouchdb-core/src/evalFilter.js
rename to packages/node_modules/pouchdb-changes-filter/src/evalFilter.js
diff --git a/packages/node_modules/pouchdb-core/src/evalView-browser.js b/packages/node_modules/pouchdb-changes-filter/src/evalView-browser.js
similarity index 100%
rename from packages/node_modules/pouchdb-core/src/evalView-browser.js
rename to packages/node_modules/pouchdb-changes-filter/src/evalView-browser.js
diff --git a/packages/node_modules/pouchdb-core/src/evalView.js b/packages/node_modules/pouchdb-changes-filter/src/evalView.js
similarity index 100%
rename from packages/node_modules/pouchdb-core/src/evalView.js
rename to packages/node_modules/pouchdb-changes-filter/src/evalView.js
diff --git a/packages/node_modules/pouchdb-changes-filter/src/index.js b/packages/node_modules/pouchdb-changes-filter/src/index.js
new file mode 100644
index 0000000..ff1621b
--- /dev/null
+++ b/packages/node_modules/pouchdb-changes-filter/src/index.js
@@ -0,0 +1,117 @@
+import {
+ MISSING_DOC,
+ BAD_REQUEST,
+ createError,
+ generateErrorFromResponse
+} from 'pouchdb-errors';
+import {
+ parseDdocFunctionName,
+ normalizeDdocFunctionName,
+ isRemote
+} from 'pouchdb-utils';
+import { matchesSelector } from 'pouchdb-selector-core';
+import evalFilter from './evalFilter';
+import evalView from './evalView';
+
+function validate(opts, callback) {
+ if (opts.selector) {
+ if (opts.filter && opts.filter !== '_selector') {
+ var filterName = typeof opts.filter === 'string' ?
+ opts.filter : 'function';
+ return callback(new Error('selector invalid for filter "' + filterName + '"'));
+ }
+ }
+ callback();
+}
+
+function normalize(opts) {
+ if (opts.view && !opts.filter) {
+ opts.filter = '_view';
+ }
+
+ if (opts.selector && !opts.filter) {
+ opts.filter = '_selector';
+ }
+
+ if (opts.filter && typeof opts.filter === 'string') {
+ if (opts.filter === '_view') {
+ opts.view = normalizeDdocFunctionName(opts.view);
+ } else {
+ opts.filter = normalizeDdocFunctionName(opts.filter);
+ }
+ }
+}
+
+function shouldFilter(changesHandler, opts) {
+ return opts.filter && typeof opts.filter === 'string' &&
+ !opts.doc_ids && !isRemote(changesHandler.db);
+}
+
+function filter(changesHandler, opts) {
+ var callback = opts.complete;
+ if (opts.filter === '_view') {
+ if (!opts.view || typeof opts.view !== 'string') {
+ var err = createError(BAD_REQUEST,
+ '`view` filter parameter not found or invalid.');
+ return callback(err);
+ }
+ // fetch a view from a design doc, make it behave like a filter
+ var viewName = parseDdocFunctionName(opts.view);
+ changesHandler.db.get('_design/' + viewName[0], function (err, ddoc) {
+ /* istanbul ignore if */
+ if (changesHandler.isCancelled) {
+ return callback(null, {status: 'cancelled'});
+ }
+ /* istanbul ignore next */
+ if (err) {
+ return callback(generateErrorFromResponse(err));
+ }
+ var mapFun = ddoc && ddoc.views && ddoc.views[viewName[1]] &&
+ ddoc.views[viewName[1]].map;
+ if (!mapFun) {
+ return callback(createError(MISSING_DOC,
+ (ddoc.views ? 'missing json key: ' + viewName[1] :
+ 'missing json key: views')));
+ }
+ opts.filter = evalView(mapFun);
+ changesHandler.doChanges(opts);
+ });
+ } else if (opts.selector) {
+ opts.filter = function (doc) {
+ return matchesSelector(doc, opts.selector);
+ };
+ changesHandler.doChanges(opts);
+ } else {
+ // fetch a filter from a design doc
+ var filterName = parseDdocFunctionName(opts.filter);
+ changesHandler.db.get('_design/' + filterName[0], function (err, ddoc) {
+ /* istanbul ignore if */
+ if (changesHandler.isCancelled) {
+ return callback(null, {status: 'cancelled'});
+ }
+ /* istanbul ignore next */
+ if (err) {
+ return callback(generateErrorFromResponse(err));
+ }
+ var filterFun = ddoc && ddoc.filters && ddoc.filters[filterName[1]];
+ if (!filterFun) {
+ return callback(createError(MISSING_DOC,
+ ((ddoc && ddoc.filters) ? 'missing json key: ' + filterName[1]
+ : 'missing json key: filters')));
+ }
+ opts.filter = evalFilter(filterFun);
+ changesHandler.doChanges(opts);
+ });
+ }
+}
+
+function applyChangesFilterPlugin(PouchDB) {
+ PouchDB._changesFilterPlugin = {
+ validate: validate,
+ normalize: normalize,
+ shouldFilter: shouldFilter,
+ filter: filter
+ };
+}
+
+export default applyChangesFilterPlugin;
\ No newline at end of file
diff --git a/packages/node_modules/pouchdb-core/package.json b/packages/node_modules/pouchdb-core/package.json
index c12b60a..993a8e4 100644
--- a/packages/node_modules/pouchdb-core/package.json
+++ b/packages/node_modules/pouchdb-core/package.json
@@ -7,10 +7,5 @@
"author": "Dale Harvey <dale@arandomurl.com>",
"license": "Apache-2.0",
"repository": "https://github.com/pouchdb/pouchdb",
- "jsnext:main": "./src/index.js",
- "browser": {
- "./lib/index.js": "./lib/index-browser.js",
- "./src/evalFilter.js": "./src/evalFilter-browser.js",
- "./src/evalView.js": "./src/evalView-browser.js"
- }
+ "jsnext:main": "./src/index.js"
}
diff --git a/packages/node_modules/pouchdb-core/src/changes.js b/packages/node_modules/pouchdb-core/src/changes.js
index 3004e3f..9a3d8bb 100644
--- a/packages/node_modules/pouchdb-core/src/changes.js
+++ b/packages/node_modules/pouchdb-core/src/changes.js
@@ -3,28 +3,18 @@
clone,
listenerCount,
once,
- parseDdocFunctionName,
- normalizeDdocFunctionName,
- guardedConsole,
- isRemote
+ guardedConsole
} from 'pouchdb-utils';
import {
isDeleted,
collectLeaves,
collectConflicts
} from 'pouchdb-merge';
-import { matchesSelector } from 'pouchdb-selector-core';
import inherits from 'inherits';
import { EventEmitter as EE } from 'events';
-import evalFilter from './evalFilter';
-import evalView from './evalView';
-import {
- MISSING_DOC,
- BAD_REQUEST,
- createError,
- generateErrorFromResponse
-} from 'pouchdb-errors';
+
+import PouchDB from './setup';
inherits(Changes, EE);
@@ -141,16 +131,17 @@
var callback = opts.complete;
var self = this;
- if (opts.selector) {
- if (opts.filter && opts.filter !== '_selector') {
- var filterName = typeof opts.filter === 'string' ?
- opts.filter : 'function';
- callback(new Error('selector invalid for filter "' + filterName + '"'));
- return;
- }
+ /* istanbul ignore else */
+ if (PouchDB._changesFilterPlugin) {
+ PouchDB._changesFilterPlugin.validate(opts, function (err) {
+ if (err) {
+ return callback(err);
+ }
+ self.doChanges(opts);
+ });
+ } else {
+ self.doChanges(opts);
}
-
- self.doChanges(opts);
};
Changes.prototype.doChanges = function (opts) {
@@ -182,25 +173,22 @@
return;
}
-
- if (opts.view && !opts.filter) {
- opts.filter = '_view';
- }
-
- if (opts.selector && !opts.filter) {
- opts.filter = '_selector';
- }
-
- if (opts.filter && typeof opts.filter === 'string') {
- if (opts.filter === '_view') {
- opts.view = normalizeDdocFunctionName(opts.view);
- } else {
- opts.filter = normalizeDdocFunctionName(opts.filter);
+ /* istanbul ignore else */
+ if (PouchDB._changesFilterPlugin) {
+ PouchDB._changesFilterPlugin.normalize(opts);
+ if (PouchDB._changesFilterPlugin.shouldFilter(this, opts)) {
+ return PouchDB._changesFilterPlugin.filter(this, opts);
}
-
- if (!isRemote(this.db) && !opts.doc_ids) {
- return this.filterChanges(opts);
- }
+ } else {
+ ['doc_ids', 'filter', 'selector', 'view'].forEach(function (key) {
+ if (key in opts) {
+ guardedConsole('warn',
+ 'The "' + key + '" option was passed in to changes/replicate, ' +
+ 'but pouchdb-changes-filter plugin is not installed, so it ' +
+ 'was ignored. Please install the plugin to enable filtering.'
+ );
+ }
+ });
}
if (!('descending' in opts)) {
@@ -221,66 +209,4 @@
}
};
-Changes.prototype.filterChanges = function (opts) {
- var self = this;
- var callback = opts.complete;
- if (opts.filter === '_view') {
- if (!opts.view || typeof opts.view !== 'string') {
- var err = createError(BAD_REQUEST,
- '`view` filter parameter not found or invalid.');
- return callback(err);
- }
- // fetch a view from a design doc, make it behave like a filter
- var viewName = parseDdocFunctionName(opts.view);
- this.db.get('_design/' + viewName[0], function (err, ddoc) {
- /* istanbul ignore if */
- if (self.isCancelled) {
- return callback(null, {status: 'cancelled'});
- }
- /* istanbul ignore next */
- if (err) {
- return callback(generateErrorFromResponse(err));
- }
- var mapFun = ddoc && ddoc.views && ddoc.views[viewName[1]] &&
- ddoc.views[viewName[1]].map;
- if (!mapFun) {
- return callback(createError(MISSING_DOC,
- (ddoc.views ? 'missing json key: ' + viewName[1] :
- 'missing json key: views')));
- }
- opts.filter = evalView(mapFun);
- self.doChanges(opts);
- });
- } else if (opts.selector) {
- opts.filter = function (doc) {
- return matchesSelector(doc, opts.selector);
- };
- self.doChanges(opts);
- } else {
- // fetch a filter from a design doc
- var filterName = parseDdocFunctionName(opts.filter);
- if (!filterName) {
- return self.doChanges(opts);
- }
- this.db.get('_design/' + filterName[0], function (err, ddoc) {
- /* istanbul ignore if */
- if (self.isCancelled) {
- return callback(null, {status: 'cancelled'});
- }
- /* istanbul ignore next */
- if (err) {
- return callback(generateErrorFromResponse(err));
- }
- var filterFun = ddoc && ddoc.filters && ddoc.filters[filterName[1]];
- if (!filterFun) {
- return callback(createError(MISSING_DOC,
- ((ddoc && ddoc.filters) ? 'missing json key: ' + filterName[1]
- : 'missing json key: filters')));
- }
- opts.filter = evalFilter(filterFun);
- self.doChanges(opts);
- });
- }
-};
-
export default Changes;
diff --git a/packages/node_modules/pouchdb-core/src/index.js b/packages/node_modules/pouchdb-core/src/index.js
index 080cc0e..dee2b8e 100644
--- a/packages/node_modules/pouchdb-core/src/index.js
+++ b/packages/node_modules/pouchdb-core/src/index.js
@@ -1,10 +1,14 @@
import PouchDB from './setup';
import version from './version';
import pouchDebug from 'pouchdb-debug';
+import pouchChangesFilter from 'pouchdb-changes-filter';
// TODO: remove from pouchdb-core (breaking)
PouchDB.plugin(pouchDebug);
+// TODO: remove from pouchdb-core (breaking)
+PouchDB.plugin(pouchChangesFilter);
+
PouchDB.version = version;
export default PouchDB;
\ No newline at end of file
