couchbase 4.2.10 → 4.2.11-rc.1

package/dist/viewindexmanager.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ViewIndexManager = exports.DesignDocument = exports.DesignDocumentView = void 0;
-const errors_1 = require("./errors");
-const httpexecutor_1 = require("./httpexecutor");
 const utilities_1 = require("./utilities");
+const viewtypes_1 = require("./viewtypes");
+const bindingutilities_1 = require("./bindingutilities");
 /**
  * Contains information about a view in a design document.
  *
@@ -27,6 +27,25 @@ class DesignDocumentView {
         this.map = data.map;
         this.reduce = data.reduce;
     }
+    /**
+     * @internal
+     */
+    static _toCppData(name, data) {
+        return {
+            name: name,
+            map: data.map,
+            reduce: data.reduce,
+        };
+    }
+    /**
+     * @internal
+     */
+    static _fromCppData(data) {
+        return new DesignDocumentView({
+            map: data.map,
+            reduce: data.reduce,
+        });
+    }
 }
 exports.DesignDocumentView = DesignDocumentView;
 /**
@@ -59,6 +78,8 @@ class DesignDocument {
         }
         this.name = data.name;
         this.views = data.views || {};
+        this.namespace = data.namespace || viewtypes_1.DesignDocumentNamespace.Production;
+        this.rev = data.rev;
     }
     /**
      * @internal
@@ -74,6 +95,36 @@ class DesignDocument {
         }
         return new DesignDocument({ name: ddocName, views: views });
     }
+    /**
+     * @internal
+     */
+    static _toCppData(data, namespace) {
+        const cppView = {};
+        for (const [k, v] of Object.entries(data.views)) {
+            cppView[k] = DesignDocumentView._toCppData(k, v);
+        }
+        return {
+            rev: data.rev,
+            name: data.name,
+            ns: (0, bindingutilities_1.designDocumentNamespaceToCpp)(namespace),
+            views: cppView,
+        };
+    }
+    /**
+     * @internal
+     */
+    static _fromCppData(ddoc) {
+        const views = {};
+        for (const [viewName, viewData] of Object.entries(ddoc.views)) {
+            views[viewName] = DesignDocumentView._fromCppData(viewData);
+        }
+        return new DesignDocument({
+            name: ddoc.name,
+            views: views,
+            namespace: (0, bindingutilities_1.designDocumentNamespaceFromCpp)(ddoc.ns),
+            rev: ddoc.rev,
+        });
+    }
 }
 exports.DesignDocument = DesignDocument;
 /**
@@ -89,12 +140,6 @@ class ViewIndexManager {
     constructor(bucket) {
         this._bucket = bucket;
     }
-    /**
-     * @internal
-     */
-    get _http() {
-        return new httpexecutor_1.HttpExecutor(this._bucket.conn);
-    }
     /**
      * @internal
      */
@@ -102,142 +147,232 @@ class ViewIndexManager {
         return this._bucket.cluster;
     }
     /**
-     * Returns a list of all the design documents in this bucket.
-     *
-     * @param options Optional parameters for this operation.
-     * @param callback A node-style callback to be invoked after execution.
+     * @internal
      */
-    async getAllDesignDocuments(options, callback) {
-        if (options instanceof Function) {
-            callback = arguments[0];
+    async getAllDesignDocuments() {
+        let namespace;
+        let options;
+        let callback;
+        // deprecated path: options and maybe callback passed in
+        if (typeof arguments[0] === 'object') {
+            namespace = undefined;
+            options = arguments[0];
+            callback = arguments[1];
+        }
+        else if (arguments[0] instanceof Function) {
+            // deprecated path: no options, only callback passed in
+            namespace = undefined;
             options = undefined;
+            callback = arguments[0];
+        }
+        else {
+            // either no args passed in or desired path (namespace is 1st arg)
+            namespace = arguments[0];
+            // still need to handle possible no options, but callback passed in
+            if (arguments[1] instanceof Function) {
+                callback = arguments[1];
+                options = undefined;
+            }
+            else {
+                options = arguments[1];
+                callback = arguments[2];
+            }
         }
         if (!options) {
             options = {};
         }
         const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrapAsync(async () => {
-            const bucketName = this._bucket.name;
-            const res = await this._http.request({
-                type: httpexecutor_1.HttpServiceType.Management,
-                method: httpexecutor_1.HttpMethod.Get,
-                path: `/pools/default/buckets/${bucketName}/ddocs`,
+        const ns = namespace !== null && namespace !== void 0 ? namespace : viewtypes_1.DesignDocumentNamespace.Production;
+        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
+            this._cluster.conn.managementViewIndexGetAll({
+                bucket_name: this._bucket.name,
+                ns: (0, bindingutilities_1.designDocumentNamespaceToCpp)(ns),
                 timeout: timeout,
+            }, (cppErr, resp) => {
+                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+                if (err) {
+                    return wrapCallback(err, null);
+                }
+                const ddocs = [];
+                for (const ddoc of resp.design_documents) {
+                    ddocs.push(DesignDocument._fromCppData(ddoc));
+                }
+                wrapCallback(null, ddocs);
             });
-            if (res.statusCode !== 200) {
-                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                throw new errors_1.CouchbaseError('failed to get design documents', undefined, errCtx);
-            }
-            const ddocsData = JSON.parse(res.body.toString());
-            const ddocs = ddocsData.rows.map((ddocData) => {
-                const ddocName = ddocData.doc.meta.id.substr(8);
-                return DesignDocument._fromNsData(ddocName, ddocData.doc.json);
-            });
-            return ddocs;
         }, callback);
     }
     /**
-     * Returns the specified design document.
-     *
-     * @param designDocName The name of the design document to fetch.
-     * @param options Optional parameters for this operation.
-     * @param callback A node-style callback to be invoked after execution.
+     * @internal
      */
-    async getDesignDocument(designDocName, options, callback) {
-        if (options instanceof Function) {
-            callback = arguments[1];
+    async getDesignDocument() {
+        let designDocName = arguments[0];
+        let namespace;
+        let options;
+        let callback;
+        // deprecated path: options and maybe callback passed in
+        if (typeof arguments[1] === 'object') {
+            namespace = undefined;
+            options = arguments[1];
+            callback = arguments[2];
+        }
+        else if (arguments[1] instanceof Function) {
+            // deprecated path: no options, only callback passed in
+            namespace = undefined;
             options = undefined;
+            callback = arguments[1];
+        }
+        else {
+            // either no other args passed in or desired path (namespace is 2nd arg)
+            namespace = arguments[1];
+            // still need to handle possible no options, but callback passed in
+            if (arguments[2] instanceof Function) {
+                callback = arguments[2];
+                options = undefined;
+            }
+            else {
+                options = arguments[2];
+                callback = arguments[3];
+            }
         }
         if (!options) {
             options = {};
         }
         const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrapAsync(async () => {
-            const bucketName = this._bucket.name;
-            const res = await this._http.request({
-                type: httpexecutor_1.HttpServiceType.Views,
-                method: httpexecutor_1.HttpMethod.Get,
-                path: `/${bucketName}/_design/${designDocName}`,
+        // for compatibility with older SDK versions (i.e. deprecated getDesignDocument())
+        if (designDocName.startsWith('dev_')) {
+            namespace = viewtypes_1.DesignDocumentNamespace.Development;
+            designDocName = designDocName.substring(4);
+        }
+        const ns = namespace !== null && namespace !== void 0 ? namespace : viewtypes_1.DesignDocumentNamespace.Production;
+        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
+            this._cluster.conn.managementViewIndexGet({
+                bucket_name: this._bucket.name,
+                document_name: designDocName,
+                ns: (0, bindingutilities_1.designDocumentNamespaceToCpp)(ns),
                 timeout: timeout,
-            });
-            if (res.statusCode !== 200) {
-                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                if (res.statusCode === 404) {
-                    throw new errors_1.DesignDocumentNotFoundError(undefined, errCtx);
+            }, (cppErr, resp) => {
+                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+                if (err) {
+                    return wrapCallback(err, null);
                 }
-                throw new errors_1.CouchbaseError('failed to get the design document', undefined, errCtx);
-            }
-            const ddocData = JSON.parse(res.body.toString());
-            return DesignDocument._fromNsData(designDocName, ddocData);
+                const ddoc = DesignDocument._fromCppData(resp.document);
+                wrapCallback(null, ddoc);
+            });
         }, callback);
     }
     /**
-     * Creates or updates a design document.
-     *
-     * @param designDoc The DesignDocument to upsert.
-     * @param options Optional parameters for this operation.
-     * @param callback A node-style callback to be invoked after execution.
+     * @internal
      */
-    async upsertDesignDocument(designDoc, options, callback) {
-        if (options instanceof Function) {
-            callback = arguments[1];
+    async upsertDesignDocument() {
+        const designDoc = arguments[0];
+        let namespace;
+        let options;
+        let callback;
+        // deprecated path: options and maybe callback passed in
+        if (typeof arguments[1] === 'object') {
+            namespace = undefined;
+            options = arguments[1];
+            callback = arguments[2];
+        }
+        else if (arguments[1] instanceof Function) {
+            // deprecated path: no options, only callback passed in
+            namespace = undefined;
             options = undefined;
+            callback = arguments[1];
+        }
+        else {
+            // either no other args passed in or desired path (namespace is 2nd arg)
+            namespace = arguments[1];
+            // still need to handle possible no options, but callback passed in
+            if (arguments[2] instanceof Function) {
+                callback = arguments[2];
+                options = undefined;
+            }
+            else {
+                options = arguments[2];
+                callback = arguments[3];
+            }
         }
         if (!options) {
             options = {};
         }
         const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrapAsync(async () => {
-            const bucketName = this._bucket.name;
-            const designDocData = {
-                views: designDoc.views,
-            };
-            const encodedData = JSON.stringify(designDocData);
-            const res = await this._http.request({
-                type: httpexecutor_1.HttpServiceType.Views,
-                method: httpexecutor_1.HttpMethod.Put,
-                path: `/${bucketName}/_design/${designDoc.name}`,
-                contentType: 'application/json',
-                body: encodedData,
+        // for compatibility with older SDK versions (i.e. deprecated upsertDesignDocument())
+        if (designDoc.name.startsWith('dev_')) {
+            namespace = viewtypes_1.DesignDocumentNamespace.Development;
+            designDoc.name = designDoc.name.substring(4);
+        }
+        const ns = namespace !== null && namespace !== void 0 ? namespace : viewtypes_1.DesignDocumentNamespace.Production;
+        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
+            this._cluster.conn.managementViewIndexUpsert({
+                bucket_name: this._bucket.name,
+                document: DesignDocument._toCppData(designDoc, ns),
                 timeout: timeout,
+            }, (cppErr) => {
+                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+                if (err) {
+                    return wrapCallback(err, null);
+                }
+                wrapCallback(err);
             });
-            if (res.statusCode !== 201) {
-                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                throw new errors_1.CouchbaseError('failed to upsert the design document', undefined, errCtx);
-            }
         }, callback);
     }
     /**
-     * Drops an existing design document.
-     *
-     * @param designDocName The name of the design document to drop.
-     * @param options Optional parameters for this operation.
-     * @param callback A node-style callback to be invoked after execution.
+     * @internal
      */
-    async dropDesignDocument(designDocName, options, callback) {
-        if (options instanceof Function) {
-            callback = arguments[1];
+    async dropDesignDocument() {
+        let designDocName = arguments[0];
+        let namespace;
+        let options;
+        let callback;
+        // deprecated path: options and maybe callback passed in
+        if (typeof arguments[1] === 'object') {
+            namespace = undefined;
+            options = arguments[1];
+            callback = arguments[2];
+        }
+        else if (arguments[1] instanceof Function) {
+            // deprecated path: no options, only callback passed in
+            namespace = undefined;
             options = undefined;
+            callback = arguments[1];
+        }
+        else {
+            // either no other args passed in or desired path (namespace is 2nd arg)
+            namespace = arguments[1];
+            // still need to handle possible no options, but callback passed in
+            if (arguments[2] instanceof Function) {
+                callback = arguments[2];
+                options = undefined;
+            }
+            else {
+                options = arguments[2];
+                callback = arguments[3];
+            }
         }
         if (!options) {
             options = {};
         }
         const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrapAsync(async () => {
-            const bucketName = this._bucket.name;
-            const res = await this._http.request({
-                type: httpexecutor_1.HttpServiceType.Views,
-                method: httpexecutor_1.HttpMethod.Delete,
-                path: `/${bucketName}/_design/${designDocName}`,
+        // for compatibility with older SDK versions (i.e. deprecated dropDesignDocument())
+        if (designDocName.startsWith('dev_')) {
+            namespace = viewtypes_1.DesignDocumentNamespace.Development;
+            designDocName = designDocName.substring(4);
+        }
+        const ns = namespace !== null && namespace !== void 0 ? namespace : viewtypes_1.DesignDocumentNamespace.Production;
+        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
+            this._cluster.conn.managementViewIndexDrop({
+                bucket_name: this._bucket.name,
+                document_name: designDocName,
+                ns: (0, bindingutilities_1.designDocumentNamespaceToCpp)(ns),
                 timeout: timeout,
-            });
-            if (res.statusCode !== 200) {
-                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                if (res.statusCode === 404) {
-                    throw new errors_1.DesignDocumentNotFoundError(undefined, errCtx);
+            }, (cppErr) => {
+                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+                if (err) {
+                    return wrapCallback(err, null);
                 }
-                throw new errors_1.CouchbaseError('failed to drop the design document', undefined, errCtx);
-            }
+                wrapCallback(err);
+            });
         }, callback);
     }
     /**
@@ -261,12 +396,10 @@ class ViewIndexManager {
         const timeout = options.timeout || this._cluster.managementTimeout;
         const timer = new utilities_1.CompoundTimeout(timeout);
         return utilities_1.PromiseHelper.wrapAsync(async () => {
-            const designDoc = await this.getDesignDocument(`dev_${designDocName}`, {
+            const designDoc = await this.getDesignDocument(designDocName, viewtypes_1.DesignDocumentNamespace.Development, {
                 timeout: timer.left(),
             });
-            // Replace the name without the `dev_` prefix on it.
-            designDoc.name = designDocName;
-            await this.upsertDesignDocument(designDoc, {
+            await this.upsertDesignDocument(designDoc, viewtypes_1.DesignDocumentNamespace.Production, {
                 timeout: timer.left(),
             });
         }, callback);

package/dist/viewtypes.d.ts

@@ -69,6 +69,21 @@ export declare class ViewRow<TValue = any, TKey = any> {
      */
     constructor(data: ViewRow);
 }
+/**
+ * Specifies the namespace for the associated Design Document.
+ *
+ * @category Views
+ */
+export declare enum DesignDocumentNamespace {
+    /**
+     * Indicates that the Design Document namespace is within the development environment.
+     */
+    Development = "development",
+    /**
+     * Indicates that the Design Document namespace is within the producion environment.
+     */
+    Production = "production"
+}
 /**
  * Represents the various scan consistency options that are available when
  * querying against the views service.
@@ -270,4 +285,15 @@ export interface ViewQueryOptions {
      * @deprecated Use {@link ViewQueryOptions.onError} instead.
      */
     on_error?: ViewErrorMode;
+    /**
+     * Specifies any additional parameters which should be passed to the view engine
+     * when executing the view query.
+     */
+    raw?: {
+        [key: string]: string;
+    };
+    /**
+     * Specifies the design document namespace to use when executing the view query.
+     */
+    namespace?: DesignDocumentNamespace;
 }

package/dist/viewtypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewErrorMode = exports.ViewOrdering = exports.ViewScanConsistency = exports.ViewRow = exports.ViewMetaData = exports.ViewResult = void 0;
+exports.ViewErrorMode = exports.ViewOrdering = exports.ViewScanConsistency = exports.DesignDocumentNamespace = exports.ViewRow = exports.ViewMetaData = exports.ViewResult = void 0;
 /**
  * Contains the results of a view query.
  *
@@ -56,6 +56,22 @@ class ViewRow {
     }
 }
 exports.ViewRow = ViewRow;
+/**
+ * Specifies the namespace for the associated Design Document.
+ *
+ * @category Views
+ */
+var DesignDocumentNamespace;
+(function (DesignDocumentNamespace) {
+    /**
+     * Indicates that the Design Document namespace is within the development environment.
+     */
+    DesignDocumentNamespace["Development"] = "development";
+    /**
+     * Indicates that the Design Document namespace is within the producion environment.
+     */
+    DesignDocumentNamespace["Production"] = "production";
+})(DesignDocumentNamespace || (exports.DesignDocumentNamespace = DesignDocumentNamespace = {}));
 /**
  * Represents the various scan consistency options that are available when
  * querying against the views service.

package/package.json

@@ -54,7 +54,7 @@
     "type": "git",
     "url": "http://github.com/couchbase/couchnode.git"
   },
-  "version": "4.2.10",
+  "version": "4.2.11-rc.1",
   "config": {
     "native": false
   },
@@ -79,12 +79,12 @@
     ]
   },
   "optionalDependencies": {
-    "@couchbase/couchbase-darwin-arm64-napi": "4.2.10",
-    "@couchbase/couchbase-darwin-x64-napi": "4.2.10",
-    "@couchbase/couchbase-linux-arm64-napi": "4.2.10",
-    "@couchbase/couchbase-linuxmusl-x64-napi": "4.2.10",
-    "@couchbase/couchbase-linux-x64-napi": "4.2.10",
-    "@couchbase/couchbase-win32-x64-napi": "4.2.10"
+    "@couchbase/couchbase-darwin-arm64-napi": "4.2.11-rc.1",
+    "@couchbase/couchbase-darwin-x64-napi": "4.2.11-rc.1",
+    "@couchbase/couchbase-linux-arm64-napi": "4.2.11-rc.1",
+    "@couchbase/couchbase-linuxmusl-x64-napi": "4.2.11-rc.1",
+    "@couchbase/couchbase-linux-x64-napi": "4.2.11-rc.1",
+    "@couchbase/couchbase-win32-x64-napi": "4.2.11-rc.1"
   },
   "files": [
     "LICENSE",

package/src/constants.cpp

@@ -865,6 +865,7 @@ void Constants::InitAutogen(Napi::Env env, Napi::Object exports)
                  couchbase::key_value_status_code::opaque_no_match},
                 {"locked", couchbase::key_value_status_code::locked},
                 {"not_locked", couchbase::key_value_status_code::not_locked},
+                {"config_only", couchbase::key_value_status_code::config_only},
                 {"auth_stale", couchbase::key_value_status_code::auth_stale},
                 {"auth_error", couchbase::key_value_status_code::auth_error},
                 {"auth_continue",