couchbase 4.3.1 → 4.4.1-dev.1

package/dist/binding.d.ts

@@ -42,6 +42,10 @@ export interface CppScanIterator {
     next(callback: (err: CppError | null, result: CppRangeScanItem | undefined) => void): void;
     cancel(): boolean;
 }
+export interface CppEncodedValue {
+    data: Buffer;
+    flags: number;
+}
 export declare enum CppManagementAnalyticsCouchbaseLinkEncryptionLevel {
 }
 export declare enum CppManagementClusterBucketType {
@@ -132,6 +136,8 @@ export declare enum CppPersistTo {
 }
 export declare enum CppReplicateTo {
 }
+export declare enum CppReadPreference {
+}
 export declare enum CppVectorQueryCombination {
 }
 export interface CppManagementAnalyticsDataset {
@@ -1054,6 +1060,7 @@ export interface CppMutateInRequest {
     durability_level: CppDurabilityLevel;
     timeout?: CppMilliseconds;
     preserve_expiry: boolean;
+    flags?: number;
 }
 export interface CppMutateInWithLegacyDurabilityRequest {
     id: CppDocumentId;
@@ -1067,6 +1074,7 @@ export interface CppMutateInWithLegacyDurabilityRequest {
     specs: CppImplSubdocCommand[];
     timeout?: CppMilliseconds;
     preserve_expiry: boolean;
+    flags?: number;
     persist_to: CppPersistTo;
     replicate_to: CppReplicateTo;
 }
@@ -1133,7 +1141,7 @@ export interface CppManagementCollectionCreateRequest {
     bucket_name: string;
     scope_name: string;
     collection_name: string;
-    max_expiry: number;
+    max_expiry?: number;
     history?: boolean;
     client_context_id?: string;
     timeout?: CppMilliseconds;
@@ -1424,6 +1432,23 @@ export interface CppManagementCollectionUpdateRequest {
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
+export interface CppManagementServerNodeAddress {
+    hostname: string;
+    kv_plain: number;
+    kv_tls: number;
+}
+export interface CppManagementServerNode {
+    server_group_name: string;
+    server_index: number;
+    default_network: CppManagementServerNodeAddress;
+    external_network: CppManagementServerNodeAddress;
+    active_vbuckets: number[];
+    replica_vbuckets: number[];
+}
+export interface CppManagementServerGroup {
+    name: string;
+    nodes: CppManagementServerNode[];
+}
 export interface CppManagementBucketDescribeResponse {
     info: CppManagementBucketDescribeResponseBucketInfo;
 }
@@ -1433,7 +1458,11 @@ export interface CppManagementBucketDescribeResponseBucketInfo {
     number_of_nodes: number;
     number_of_replicas: number;
     bucket_capabilities: string[];
+    server_groups: {
+        [key: string]: CppManagementServerGroup;
+    };
     storage_backend: CppManagementClusterBucketStorageBackend;
+    config_json: string;
 }
 export interface CppManagementBucketDescribeRequest {
     name: string;
@@ -2511,6 +2540,11 @@ export interface CppBindingAutogen {
         two: CppReplicateTo;
         three: CppReplicateTo;
     };
+    read_preference: {
+        no_preference: CppReadPreference;
+        selected_server_group: CppReadPreference;
+        selected_server_group_or_all_available: CppReadPreference;
+    };
     vector_query_combination: {
         combination_and: CppVectorQueryCombination;
         combination_or: CppVectorQueryCombination;
@@ -2720,7 +2754,8 @@ export interface CppTransactionLinks {
     staged_transaction_id: string;
     staged_attempt_id: string;
     staged_operation_id: string;
-    staged_content: string;
+    staged_content_json: string;
+    staged_content_binary?: Buffer;
     cas_pre_txn: string;
     revid_pre_txn: string;
     exptime_pre_txn: number;
@@ -2757,11 +2792,11 @@ export interface CppTransaction {
     }, callback: (err: CppError | null, result: CppTransactionGetResult | null) => void): void;
     insert(options: {
         id: CppDocumentId;
-        content: CppJsonString;
+        content: CppEncodedValue;
     }, callback: (err: CppError | null, result: CppTransactionGetResult | null) => void): void;
     replace(options: {
         doc: CppTransactionGetResult;
-        content: CppJsonString;
+        content: CppEncodedValue;
     }, callback: (err: CppError | null, result: CppTransactionGetResult | null) => void): void;
     remove(options: {
         doc: CppTransactionGetResult;

package/dist/binding.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CppTxnExternalException = exports.CppTxnFailureType = exports.CppVectorQueryCombination = exports.CppReplicateTo = exports.CppPersistTo = exports.CppStoreSemantics = exports.CppImplSubdocOpcode = exports.CppKeyValueStatusCode = exports.CppErrcNetwork = exports.CppErrcFieldLevelEncryption = exports.CppErrcManagement = exports.CppErrcView = exports.CppErrcSearch = exports.CppErrcAnalytics = exports.CppErrcQuery = exports.CppErrcKeyValue = exports.CppErrcCommon = exports.CppDurabilityLevel = exports.CppAnalyticsResponseAnalyticsStatus = exports.CppViewSortOrder = exports.CppViewScanConsistency = exports.CppViewOnError = exports.CppServiceType = exports.CppSearchScanConsistency = exports.CppSearchHighlightStyle = exports.CppQueryScanConsistency = exports.CppQueryProfile = exports.CppDiagPingState = exports.CppDiagEndpointState = exports.CppDiagClusterState = exports.CppDesignDocumentNamespace = exports.CppAnalyticsScanConsistency = exports.CppProtocolSubdocOpcode = exports.CppRetryReason = exports.CppManagementRbacAuthDomain = exports.CppManagementEventingFunctionProcessingStatus = exports.CppManagementEventingFunctionDeploymentStatus = exports.CppManagementEventingFunctionStatus = exports.CppManagementEventingFunctionBucketAccess = exports.CppManagementEventingFunctionLogLevel = exports.CppManagementEventingFunctionLanguageCompatibility = exports.CppManagementEventingFunctionDcpBoundary = exports.CppManagementClusterBucketStorageBackend = exports.CppManagementClusterBucketConflictResolution = exports.CppManagementClusterBucketEvictionPolicy = exports.CppManagementClusterBucketCompression = exports.CppManagementClusterBucketType = exports.CppManagementAnalyticsCouchbaseLinkEncryptionLevel = exports.zeroCas = void 0;
+exports.CppTxnExternalException = exports.CppTxnFailureType = exports.CppVectorQueryCombination = exports.CppReadPreference = exports.CppReplicateTo = exports.CppPersistTo = exports.CppStoreSemantics = exports.CppImplSubdocOpcode = exports.CppKeyValueStatusCode = exports.CppErrcNetwork = exports.CppErrcFieldLevelEncryption = exports.CppErrcManagement = exports.CppErrcView = exports.CppErrcSearch = exports.CppErrcAnalytics = exports.CppErrcQuery = exports.CppErrcKeyValue = exports.CppErrcCommon = exports.CppDurabilityLevel = exports.CppAnalyticsResponseAnalyticsStatus = exports.CppViewSortOrder = exports.CppViewScanConsistency = exports.CppViewOnError = exports.CppServiceType = exports.CppSearchScanConsistency = exports.CppSearchHighlightStyle = exports.CppQueryScanConsistency = exports.CppQueryProfile = exports.CppDiagPingState = exports.CppDiagEndpointState = exports.CppDiagClusterState = exports.CppDesignDocumentNamespace = exports.CppAnalyticsScanConsistency = exports.CppProtocolSubdocOpcode = exports.CppRetryReason = exports.CppManagementRbacAuthDomain = exports.CppManagementEventingFunctionProcessingStatus = exports.CppManagementEventingFunctionDeploymentStatus = exports.CppManagementEventingFunctionStatus = exports.CppManagementEventingFunctionBucketAccess = exports.CppManagementEventingFunctionLogLevel = exports.CppManagementEventingFunctionLanguageCompatibility = exports.CppManagementEventingFunctionDcpBoundary = exports.CppManagementClusterBucketStorageBackend = exports.CppManagementClusterBucketConflictResolution = exports.CppManagementClusterBucketEvictionPolicy = exports.CppManagementClusterBucketCompression = exports.CppManagementClusterBucketType = exports.CppManagementAnalyticsCouchbaseLinkEncryptionLevel = exports.zeroCas = void 0;
 /*
 eslint
 jsdoc/require-jsdoc: off,
@@ -147,6 +147,9 @@ var CppPersistTo;
 var CppReplicateTo;
 (function (CppReplicateTo) {
 })(CppReplicateTo || (exports.CppReplicateTo = CppReplicateTo = {}));
+var CppReadPreference;
+(function (CppReadPreference) {
+})(CppReadPreference || (exports.CppReadPreference = CppReadPreference = {}));
 var CppVectorQueryCombination;
 (function (CppVectorQueryCombination) {
 })(CppVectorQueryCombination || (exports.CppVectorQueryCombination = CppVectorQueryCombination = {}));

package/dist/collection.js

@@ -112,7 +112,6 @@ class Collection {
      */
     _encodeDoc(transcoder, value, callback) {
         try {
-            // BUG(JSCBC-1054): We should avoid doing buffer conversion.
             const [bytesBuf, flagsOut] = transcoder.encode(value);
             callback(null, bytesBuf, flagsOut);
         }

package/dist/diagnosticstypes.js

@@ -96,7 +96,7 @@ class PingResult {
                             remote: svc.remote,
                             local: svc.local,
                             id: svc.id,
-                            state: svc.state,
+                            state: svc.state, // state enum is already a string
                             namespace: svc.bucket,
                             error: svc.error,
                         };
@@ -159,7 +159,7 @@ class DiagnosticsResult {
                             remote: svc.remote,
                             local: svc.local,
                             id: svc.id,
-                            state: svc.state,
+                            state: svc.state, // state enum is already a string
                             namespace: svc.bucket,
                             details: svc.details,
                         };

package/dist/searchtypes.d.ts

@@ -181,16 +181,12 @@ export declare class SearchRequest {
     /**
      * Adds a search query to the request if the request does not already have a search query.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param query A SearchQuery to add to the request.
      */
     withSearchQuery(query: SearchQuery): SearchRequest;
     /**
      * Adds a vector search to the request if the request does not already have a vector search.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param search A VectorSearch to add to the request.
      */
     withVectorSearch(search: VectorSearch): SearchRequest;

package/dist/searchtypes.js

@@ -102,8 +102,6 @@ class SearchRequest {
     /**
      * Adds a search query to the request if the request does not already have a search query.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param query A SearchQuery to add to the request.
      */
     withSearchQuery(query) {
@@ -119,8 +117,6 @@ class SearchRequest {
     /**
      * Adds a vector search to the request if the request does not already have a vector search.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param search A VectorSearch to add to the request.
      */
     withVectorSearch(search) {

package/dist/transactions.d.ts

@@ -283,6 +283,7 @@ export interface TransactionQueryOptions {
  */
 export declare class TransactionAttemptContext {
     private _impl;
+    private _transcoder;
     /**
      * @internal
      */

package/dist/transactions.js

@@ -8,6 +8,7 @@ const binding_1 = __importDefault(require("./binding"));
 const bindingutilities_1 = require("./bindingutilities");
 const errors_1 = require("./errors");
 const queryexecutor_1 = require("./queryexecutor");
+const transcoders_1 = require("./transcoders");
 const utilities_1 = require("./utilities");
 /**
  * Represents the path to a document.
@@ -113,6 +114,7 @@ class TransactionAttemptContext {
             timeout: config.timeout,
             query_scan_consistency: (0, bindingutilities_1.queryScanConsistencyToCpp)(undefined),
         });
+        this._transcoder = new transcoders_1.DefaultTranscoder();
     }
     /**
     @internal
@@ -161,9 +163,13 @@ class TransactionAttemptContext {
     async insert(collection, key, content) {
         return utilities_1.PromiseHelper.wrap((wrapCallback) => {
             const id = collection._cppDocId(key);
+            const [data, flags] = this._transcoder.encode(content);
             this._impl.insert({
                 id,
-                content: Buffer.from(JSON.stringify(content)),
+                content: {
+                    data,
+                    flags,
+                },
             }, (cppErr, cppRes) => {
                 const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                 if (err) {
@@ -181,6 +187,7 @@ class TransactionAttemptContext {
      */
     async replace(doc, content) {
         return utilities_1.PromiseHelper.wrap((wrapCallback) => {
+            const [data, flags] = this._transcoder.encode(content);
             this._impl.replace({
                 doc: {
                     id: doc.id,
@@ -189,7 +196,10 @@ class TransactionAttemptContext {
                     links: doc._links,
                     metadata: doc._metadata,
                 },
-                content: Buffer.from(JSON.stringify(content)),
+                content: {
+                    data,
+                    flags,
+                },
             }, (cppErr, cppRes) => {
                 const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                 if (err) {

package/dist/vectorsearch.d.ts

@@ -1,8 +1,6 @@
 /**
  * Specifies how multiple vector searches are combined.
  *
- * Uncommitted: This API is subject to change in the future.
- *
  * @category Full Text Search
  */
 export declare enum VectorQueryCombination {
@@ -16,8 +14,6 @@ export declare enum VectorQueryCombination {
     OR = "or"
 }
 /**
- * Uncommitted: This API is subject to change in the future.
- *
  * @category Full Text Search
  */
 export interface VectorSearchOptions {
@@ -29,16 +25,15 @@ export interface VectorSearchOptions {
 /**
  * Represents a vector query.
  *
- * Uncommitted: This API is subject to change in the future.
- *
  * @category Full Text Search
  */
 export declare class VectorQuery {
     private _fieldName;
     private _vector;
+    private _vectorBase64;
     private _numCandidates;
     private _boost;
-    constructor(fieldName: string, vector: number[]);
+    constructor(fieldName: string, vector: number[] | string);
     /**
      * @internal
      */
@@ -46,34 +41,26 @@ export declare class VectorQuery {
     /**
      * Adds boost option to vector query.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param boost A floating point value.
      */
     boost(boost: number): VectorQuery;
     /**
      * Adds numCandidates option to vector query. Value must be >= 1.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param numCandidates An integer value.
      */
     numCandidates(numCandidates: number): VectorQuery;
     /**
      * Creates a vector query.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param fieldName The name of the field in the JSON document that holds the vector.
      * @param vector List of floating point values that represent the vector.
      */
-    static create(fieldName: string, vector: number[]): VectorQuery;
+    static create(fieldName: string, vector: number[] | string): VectorQuery;
 }
 /**
  * Represents a vector search.
  *
- * Uncommitted: This API is subject to change in the future.
- *
  * @category Full Text Search
  */
 export declare class VectorSearch {
@@ -89,9 +76,7 @@ export declare class VectorSearch {
      */
     get options(): VectorSearchOptions | undefined;
     /**
-     * Creates a vector search.
-     *
-     * Uncommitted: This API is subject to change in the future.
+     * Creates a vector search from a single VectorQuery.
      *
      * @param query A vectory query that should be a part of the vector search.
      */

package/dist/vectorsearch.js

@@ -5,8 +5,6 @@ const errors_1 = require("./errors");
 /**
  * Specifies how multiple vector searches are combined.
  *
- * Uncommitted: This API is subject to change in the future.
- *
  * @category Full Text Search
  */
 var VectorQueryCombination;
@@ -23,17 +21,29 @@ var VectorQueryCombination;
 /**
  * Represents a vector query.
  *
- * Uncommitted: This API is subject to change in the future.
- *
  * @category Full Text Search
  */
 class VectorQuery {
     constructor(fieldName, vector) {
+        if (!fieldName) {
+            throw new errors_1.InvalidArgumentError(new Error('Must provide a field name.'));
+        }
         this._fieldName = fieldName;
-        if (!Array.isArray(vector) || vector.length == 0) {
-            throw new errors_1.InvalidArgumentError(new Error('Provided vector must be an array and cannot be empty.'));
+        if (!vector) {
+            throw new errors_1.InvalidArgumentError(new Error('Provided vector cannot be empty.'));
+        }
+        if (Array.isArray(vector)) {
+            if (vector.length == 0) {
+                throw new errors_1.InvalidArgumentError(new Error('Provided vector cannot be empty.'));
+            }
+            this._vector = vector;
+        }
+        else if (typeof vector === 'string') {
+            this._vectorBase64 = vector;
+        }
+        else {
+            throw new errors_1.InvalidArgumentError(new Error('Provided vector must be either a number[] or base64 encoded string.'));
         }
-        this._vector = vector;
     }
     /**
      * @internal
@@ -42,9 +52,14 @@ class VectorQuery {
         var _a;
         const output = {
             field: this._fieldName,
-            vector: this._vector,
             k: (_a = this._numCandidates) !== null && _a !== void 0 ? _a : 3,
         };
+        if (this._vector) {
+            output['vector'] = this._vector;
+        }
+        else {
+            output['vector_base64'] = this._vectorBase64;
+        }
         if (this._boost) {
             output['boost'] = this._boost;
         }
@@ -53,8 +68,6 @@ class VectorQuery {
     /**
      * Adds boost option to vector query.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param boost A floating point value.
      */
     boost(boost) {
@@ -64,8 +77,6 @@ class VectorQuery {
     /**
      * Adds numCandidates option to vector query. Value must be >= 1.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param numCandidates An integer value.
      */
     numCandidates(numCandidates) {
@@ -78,8 +89,6 @@ class VectorQuery {
     /**
      * Creates a vector query.
      *
-     * Uncommitted: This API is subject to change in the future.
-     *
      * @param fieldName The name of the field in the JSON document that holds the vector.
      * @param vector List of floating point values that represent the vector.
      */
@@ -91,8 +100,6 @@ exports.VectorQuery = VectorQuery;
 /**
  * Represents a vector search.
  *
- * Uncommitted: This API is subject to change in the future.
- *
  * @category Full Text Search
  */
 class VectorSearch {
@@ -119,9 +126,7 @@ class VectorSearch {
         return this._options;
     }
     /**
-     * Creates a vector search.
-     *
-     * Uncommitted: This API is subject to change in the future.
+     * Creates a vector search from a single VectorQuery.
      *
      * @param query A vectory query that should be a part of the vector search.
      */

package/package.json

@@ -20,41 +20,41 @@
   "license": "Apache-2.0",
   "name": "couchbase",
   "dependencies": {
-    "cmake-js": "^7.2.1",
-    "node-addon-api": "^7.0.0"
+    "cmake-js": "^7.3.0",
+    "node-addon-api": "^8.0.0"
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
-    "@tsconfig/node12": "^12.1.0",
-    "@types/bindings": "^1.5.4",
+    "@tsconfig/node12": "^12.1.3",
+    "@types/bindings": "^1.5.5",
     "@types/debug": "^4.1.12",
-    "@types/node": "^20.9.0",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
-    "chai": "^4.3.10",
-    "eslint": "^8.53.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jsdoc": "^46.9.0",
-    "eslint-plugin-mocha": "^10.2.0",
+    "@types/node": "^20.14.5",
+    "@typescript-eslint/eslint-plugin": "^7.13.1",
+    "@typescript-eslint/parser": "^7.13.1",
+    "chai": "^4.4.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jsdoc": "^48.2.12",
+    "eslint-plugin-mocha": "^10.4.3",
     "eslint-plugin-node": "^11.1.0",
     "expose-gc": "^1.0.0",
-    "mocha": "^10.2.0",
-    "npm-check-updates": "^16.14.6",
-    "nyc": "^15.1.0",
-    "prettier": "^3.1.0",
+    "mocha": "^10.4.0",
+    "npm-check-updates": "^16.14.20",
+    "nyc": "^17.0.0",
+    "prettier": "^3.3.2",
     "segfault-handler": "^1.3.0",
-    "semver": "^7.5.4",
+    "semver": "^7.6.2",
     "ts-mocha": "^10.0.0",
-    "ts-node": "^10.9.1",
-    "typedoc": "^0.25.3",
-    "typescript": "^5.2.2",
-    "uuid": "^9.0.1"
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.4.5",
+    "uuid": "^10.0.0"
   },
   "repository": {
     "type": "git",
     "url": "http://github.com/couchbase/couchnode.git"
   },
-  "version": "4.3.1",
+  "version": "4.4.1-dev.1",
   "config": {
     "native": false
   },
@@ -79,12 +79,13 @@
     ]
   },
   "optionalDependencies": {
-    "@couchbase/couchbase-darwin-arm64-napi": "4.3.1",
-    "@couchbase/couchbase-darwin-x64-napi": "4.3.1",
-    "@couchbase/couchbase-linux-arm64-napi": "4.3.1",
-    "@couchbase/couchbase-linuxmusl-x64-napi": "4.3.1",
-    "@couchbase/couchbase-linux-x64-napi": "4.3.1",
-    "@couchbase/couchbase-win32-x64-napi": "4.3.1"
+    "@couchbase/couchbase-darwin-arm64-napi": "4.4.1-dev.1",
+    "@couchbase/couchbase-darwin-x64-napi": "4.4.1-dev.1",
+    "@couchbase/couchbase-linux-arm64-napi": "4.4.1-dev.1",
+    "@couchbase/couchbase-linuxmusl-arm64-napi": "4.4.1-dev.1",
+    "@couchbase/couchbase-linuxmusl-x64-napi": "4.4.1-dev.1",
+    "@couchbase/couchbase-linux-x64-napi": "4.4.1-dev.1",
+    "@couchbase/couchbase-win32-x64-napi": "4.4.1-dev.1"
   },
   "files": [
     "LICENSE",