couchbase 4.2.1 → 4.2.3

package/dist/cluster.js

@@ -31,11 +31,84 @@ const utilities_internal_1 = require("./utilities_internal");
  * @category Core
  */
 class Cluster {
+    /**
+     * @internal
+     */
+    get conn() {
+        return this._conn;
+    }
+    /**
+    @internal
+    */
+    get transcoder() {
+        return this._transcoder;
+    }
+    /**
+    @internal
+    */
+    get kvTimeout() {
+        return this._kvTimeout;
+    }
+    /**
+    @internal
+    */
+    get kvDurableTimeout() {
+        return this._kvDurableTimeout;
+    }
+    /**
+    @internal
+    */
+    get viewTimeout() {
+        return this._viewTimeout;
+    }
+    /**
+    @internal
+    */
+    get queryTimeout() {
+        return this._queryTimeout;
+    }
+    /**
+    @internal
+    */
+    get analyticsTimeout() {
+        return this._analyticsTimeout;
+    }
+    /**
+    @internal
+    */
+    get searchTimeout() {
+        return this._searchTimeout;
+    }
+    /**
+    @internal
+    */
+    get managementTimeout() {
+        return this._managementTimeout;
+    }
+    /**
+    @internal
+    */
+    get bootstrapTimeout() {
+        return this._bootstrapTimeout;
+    }
+    /**
+    @internal
+    */
+    get connectTimeout() {
+        return this._connectTimeout;
+    }
+    /**
+    @internal
+    */
+    get resolveTimeout() {
+        return this._resolveTimeout;
+    }
     /**
     @internal
     @deprecated Use the static sdk-level {@link connect} method instead.
     */
     constructor(connStr, options) {
+        var _a, _b, _c;
         if (!options) {
             options = {};
         }
@@ -57,6 +130,9 @@ class Cluster {
         this._analyticsTimeout = options.timeouts.analyticsTimeout || 75000;
         this._searchTimeout = options.timeouts.searchTimeout || 75000;
         this._managementTimeout = options.timeouts.managementTimeout || 75000;
+        this._bootstrapTimeout = (_a = options.timeouts) === null || _a === void 0 ? void 0 : _a.bootstrapTimeout;
+        this._connectTimeout = (_b = options.timeouts) === null || _b === void 0 ? void 0 : _b.connectTimeout;
+        this._resolveTimeout = (_c = options.timeouts) === null || _c === void 0 ? void 0 : _c.resolveTimeout;
         if (options.transcoder) {
             this._transcoder = options.transcoder;
         }
@@ -88,8 +164,9 @@ class Cluster {
             };
         }
         if (options.dnsConfig &&
-            options.dnsConfig.nameserver &&
-            options.dnsConfig.port) {
+            (options.dnsConfig.nameserver ||
+                options.dnsConfig.port ||
+                options.dnsConfig.dnsSrvTimeout)) {
             this._dnsConfig = {
                 nameserver: options.dnsConfig.nameserver,
                 port: options.dnsConfig.port,
@@ -102,60 +179,6 @@ class Cluster {
         this._openBuckets = [];
         this._conn = new binding_1.default.Connection();
     }
-    /**
-     * @internal
-     */
-    get conn() {
-        return this._conn;
-    }
-    /**
-    @internal
-    */
-    get transcoder() {
-        return this._transcoder;
-    }
-    /**
-    @internal
-    */
-    get kvTimeout() {
-        return this._kvTimeout;
-    }
-    /**
-    @internal
-    */
-    get kvDurableTimeout() {
-        return this._kvDurableTimeout;
-    }
-    /**
-    @internal
-    */
-    get viewTimeout() {
-        return this._viewTimeout;
-    }
-    /**
-    @internal
-    */
-    get queryTimeout() {
-        return this._queryTimeout;
-    }
-    /**
-    @internal
-    */
-    get analyticsTimeout() {
-        return this._analyticsTimeout;
-    }
-    /**
-    @internal
-    */
-    get searchTimeout() {
-        return this._searchTimeout;
-    }
-    /**
-    @internal
-    */
-    get managementTimeout() {
-        return this._managementTimeout;
-    }
     /**
     @internal
     */
@@ -355,14 +378,30 @@ class Cluster {
             const dsnObj = connspec_1.ConnSpec.parse(this._connStr);
             dsnObj.options.user_agent_extra = (0, utilities_internal_1.generateClientString)();
             dsnObj.options.trust_certificate = this._trustStorePath;
+            if (this.bootstrapTimeout) {
+                dsnObj.options['bootstrap_timeout'] = this.bootstrapTimeout.toString();
+            }
+            if (this.connectTimeout) {
+                dsnObj.options['kv_connect_timeout'] = this.connectTimeout.toString();
+            }
+            if (this.resolveTimeout) {
+                dsnObj.options['resolve_timeout'] = this.resolveTimeout.toString();
+            }
             const connStr = dsnObj.toString();
-            const authOpts = {
-                username: undefined,
-                password: undefined,
-                certificate_path: undefined,
-                key_path: undefined,
-                allowed_sasl_mechanisms: ['SCRAM-SHA512', 'SCRAM-SHA256', 'SCRAM-SHA1'],
-            };
+            const authOpts = {};
+            // lets allow `allowed_sasl_mechanisms` to override legacy connstr option
+            for (const saslKey of ['sasl_mech_force', 'allowed_sasl_mechanisms']) {
+                if (!(saslKey in dsnObj.options)) {
+                    continue;
+                }
+                if (typeof dsnObj.options[saslKey] === 'string') {
+                    authOpts.allowed_sasl_mechanisms = [dsnObj.options[saslKey]];
+                }
+                else {
+                    authOpts.allowed_sasl_mechanisms = dsnObj.options[saslKey];
+                }
+                delete dsnObj.options[saslKey];
+            }
             if (this._auth) {
                 const passAuth = this._auth;
                 if (passAuth.username || passAuth.password) {

package/dist/collection.d.ts

@@ -5,6 +5,7 @@ import { Cluster } from './cluster';
 import { CounterResult, ExistsResult, GetReplicaResult, GetResult, LookupInResult, MutateInResult, MutationResult } from './crudoptypes';
 import { CouchbaseList, CouchbaseMap, CouchbaseQueue, CouchbaseSet } from './datastructures';
 import { DurabilityLevel, StoreSemantics } from './generaltypes';
+import { CollectionQueryIndexManager } from './queryindexmanager';
 import { Scope } from './scope';
 import { LookupInSpec, MutateInSpec } from './sdspecs';
 import { StreamableReplicasPromise } from './streamablepromises';
@@ -559,4 +560,9 @@ export declare class Collection {
      * @internal
      */
     _binaryPrepend(key: string, value: string | Buffer, options?: PrependOptions, callback?: NodeCallback<MutationResult>): Promise<MutationResult>;
+    /**
+     * Returns a CollectionQueryIndexManager which can be used to manage the query indexes
+     * of this collection.
+     */
+    queryIndexes(): CollectionQueryIndexManager;
 }

package/dist/collection.js

@@ -30,6 +30,7 @@ const bindingutilities_1 = require("./bindingutilities");
 const crudoptypes_1 = require("./crudoptypes");
 const datastructures_1 = require("./datastructures");
 const generaltypes_1 = require("./generaltypes");
+const queryindexmanager_1 = require("./queryindexmanager");
 const sdspecs_1 = require("./sdspecs");
 const sdutils_1 = require("./sdutils");
 const streamablepromises_1 = require("./streamablepromises");
@@ -41,6 +42,12 @@ const utilities_1 = require("./utilities");
  * @category Core
  */
 class Collection {
+    /**
+     * @internal
+     */
+    static get DEFAULT_NAME() {
+        return '_default';
+    }
     /**
     @internal
     */
@@ -49,12 +56,6 @@ class Collection {
         this._name = collectionName;
         this._conn = scope.conn;
     }
-    /**
-     * @internal
-     */
-    static get DEFAULT_NAME() {
-        return '_default';
-    }
     /**
     @internal
     */
@@ -1208,5 +1209,12 @@ class Collection {
             }
         }, callback);
     }
+    /**
+     * Returns a CollectionQueryIndexManager which can be used to manage the query indexes
+     * of this collection.
+     */
+    queryIndexes() {
+        return new queryindexmanager_1.CollectionQueryIndexManager(this);
+    }
 }
 exports.Collection = Collection;

package/dist/configProfile.js

@@ -16,17 +16,23 @@ class WanDevelopmentProfile {
      * @param options The Connect options the ConfigProfile should be applied toward.
      */
     apply(options) {
-        const timeouts = {
-            kvTimeout: 20000,
-            kvDurableTimeout: 20000,
-            analyticsTimeout: 120000,
-            managementTimeout: 120000,
-            queryTimeout: 120000,
-            searchTimeout: 120000,
-            viewTimeout: 120000,
-        };
         // the profile should override previously set values
-        options.timeouts = { ...options.timeouts, ...timeouts };
+        options.timeouts = {
+            ...options.timeouts,
+            ...{
+                kvTimeout: 20000,
+                kvDurableTimeout: 20000,
+                analyticsTimeout: 120000,
+                managementTimeout: 120000,
+                queryTimeout: 120000,
+                searchTimeout: 120000,
+                viewTimeout: 120000,
+                bootstrapTimeout: 120000,
+                connectTimeout: 20000,
+                resolveTimeout: 20000,
+            },
+        };
+        options.dnsConfig = { ...options.dnsConfig, ...{ dnsSrvTimeout: 20000 } };
     }
 }
 exports.WanDevelopmentProfile = WanDevelopmentProfile;

package/dist/couchbase.d.ts

@@ -22,6 +22,7 @@ export declare const lcbVersion: string;
  * SDK to perform I/O with the cluster.
  */
 export declare const cbppVersion: string;
+export declare const cbppMetadata: string;
 export * from './analyticsindexmanager';
 export * from './analyticstypes';
 export * from './authenticators';

package/dist/couchbase.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cbppVersion = exports.lcbVersion = exports.connect = void 0;
+exports.cbppMetadata = exports.cbppVersion = exports.lcbVersion = exports.connect = void 0;
 const binding_1 = __importDefault(require("./binding"));
 const cluster_1 = require("./cluster");
 /**
@@ -45,6 +45,7 @@ exports.lcbVersion = binding_1.default.cbppVersion;
  * SDK to perform I/O with the cluster.
  */
 exports.cbppVersion = binding_1.default.cbppVersion;
+exports.cbppMetadata = binding_1.default.cbppMetadata;
 __exportStar(require("./analyticsindexmanager"), exports);
 __exportStar(require("./analyticstypes"), exports);
 __exportStar(require("./authenticators"), exports);

package/dist/errors.d.ts

@@ -708,7 +708,7 @@ export declare class EventingFunctionPausedError extends CouchbaseError {
  * @category Error Handling
  */
 export declare class TransactionOperationFailedError extends CouchbaseError {
-    constructor(cause?: Error);
+    constructor(cause?: Error, context?: ErrorContext);
 }
 /**
  * Indicates a transaction failed to complete.
@@ -716,7 +716,7 @@ export declare class TransactionOperationFailedError extends CouchbaseError {
  * @category Error Handling
  */
 export declare class TransactionFailedError extends CouchbaseError {
-    constructor(cause?: Error);
+    constructor(cause?: Error, context?: ErrorContext);
 }
 /**
  * Indicates a transaction failed to complete due to expiring.

package/dist/errors.js

@@ -951,8 +951,8 @@ exports.EventingFunctionPausedError = EventingFunctionPausedError;
  * @category Error Handling
  */
 class TransactionOperationFailedError extends CouchbaseError {
-    constructor(cause) {
-        super('transaction operation failed', cause);
+    constructor(cause, context) {
+        super('transaction operation failed', cause, context);
     }
 }
 exports.TransactionOperationFailedError = TransactionOperationFailedError;
@@ -962,8 +962,8 @@ exports.TransactionOperationFailedError = TransactionOperationFailedError;
  * @category Error Handling
  */
 class TransactionFailedError extends CouchbaseError {
-    constructor(cause) {
-        super('transaction failed', cause);
+    constructor(cause, context) {
+        super('transaction failed', cause, context);
     }
 }
 exports.TransactionFailedError = TransactionFailedError;

package/dist/queryexecutor.js

@@ -103,7 +103,7 @@ class QueryExecutor {
                 scan_consistency: (0, bindingutilities_1.queryScanConsistencyToCpp)(options.scanConsistency),
                 mutation_state: (0, bindingutilities_1.mutationStateToCpp)(options.consistentWith).tokens,
                 timeout: timeout,
-                scope_qualifier: options.queryContext,
+                query_context: options.queryContext,
                 profile: (0, bindingutilities_1.queryProfileToCpp)(options.profile),
                 raw: options.raw
                     ? Object.fromEntries(Object.entries(options.raw)

package/dist/queryindexmanager.d.ts

@@ -1,4 +1,5 @@
 import { Cluster } from './cluster';
+import { Collection } from './collection';
 import { NodeCallback } from './utilities';
 /**
  * Contains a specific index configuration for the query service.
@@ -57,10 +58,14 @@ export declare class QueryIndex {
 export interface CreateQueryIndexOptions {
     /**
      * Specifies the collection of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     collectionName?: string;
     /**
      * Specifies the collection scope of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     scopeName?: string;
     /**
@@ -88,10 +93,14 @@ export interface CreateQueryIndexOptions {
 export interface CreatePrimaryQueryIndexOptions {
     /**
      * Specifies the collection of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     collectionName?: string;
     /**
      * Specifies the collection scope of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     scopeName?: string;
     /**
@@ -123,10 +132,14 @@ export interface CreatePrimaryQueryIndexOptions {
 export interface DropQueryIndexOptions {
     /**
      * Specifies the collection of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     collectionName?: string;
     /**
      * Specifies the collection scope of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     scopeName?: string;
     /**
@@ -145,10 +158,14 @@ export interface DropQueryIndexOptions {
 export interface DropPrimaryQueryIndexOptions {
     /**
      * Specifies the collection of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     collectionName?: string;
     /**
      * Specifies the collection scope of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     scopeName?: string;
     /**
@@ -171,10 +188,14 @@ export interface DropPrimaryQueryIndexOptions {
 export interface GetAllQueryIndexesOptions {
     /**
      * Specifies the collection of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     collectionName?: string;
     /**
      * Specifies the collection scope of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     scopeName?: string;
     /**
@@ -188,10 +209,14 @@ export interface GetAllQueryIndexesOptions {
 export interface BuildQueryIndexOptions {
     /**
      * Specifies the collection of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     collectionName?: string;
     /**
      * Specifies the collection scope of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     scopeName?: string;
     /**
@@ -205,10 +230,14 @@ export interface BuildQueryIndexOptions {
 export interface WatchQueryIndexOptions {
     /**
      * Specifies the collection of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     collectionName?: string;
     /**
      * Specifies the collection scope of this index.
+     *
+     * @deprecated Use {@link CollectionQueryIndexManager} instead.
      */
     scopeName?: string;
     /**
@@ -216,6 +245,76 @@ export interface WatchQueryIndexOptions {
      */
     watchPrimary?: boolean;
 }
+/**
+ * CollectionQueryIndexManager provides an interface for managing the
+ * query indexes on the collection.
+ *
+ * @category Management
+ */
+export declare class CollectionQueryIndexManager {
+    private _bucketName;
+    private _collectionName;
+    private _manager;
+    private _scopeName;
+    /**
+     * @internal
+     */
+    constructor(collection: Collection);
+    /**
+     * Creates a new query index.
+     *
+     * @param indexName The name of the new index.
+     * @param fields The fields which this index should cover.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    createIndex(indexName: string, fields: string[], options?: CreateQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Creates a new primary query index.
+     *
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    createPrimaryIndex(options?: CreatePrimaryQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Drops an existing query index.
+     *
+     * @param indexName The name of the index to drop.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    dropIndex(indexName: string, options?: DropQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Drops an existing primary index.
+     *
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    dropPrimaryIndex(options?: DropPrimaryQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Returns a list of indexes for a specific bucket.
+     *
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    getAllIndexes(options?: GetAllQueryIndexesOptions, callback?: NodeCallback<QueryIndex[]>): Promise<QueryIndex[]>;
+    /**
+     * Starts building any indexes which were previously created with deferred=true.
+     *
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    buildDeferredIndexes(options?: BuildQueryIndexOptions, callback?: NodeCallback<string[]>): Promise<string[]>;
+    /**
+     * Waits for a number of indexes to finish creation and be ready to use.
+     *
+     * @param indexNames The names of the indexes to watch.
+     * @param timeout The maximum time to wait for the index, expressed in milliseconds.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    watchIndexes(indexNames: string[], timeout: number, options?: WatchQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+}
 /**
  * QueryIndexManager provides an interface for managing the
  * query indexes on the cluster.
@@ -223,13 +322,11 @@ export interface WatchQueryIndexOptions {
  * @category Management
  */
 export declare class QueryIndexManager {
-    private _cluster;
+    private _manager;
     /**
      * @internal
      */
     constructor(cluster: Cluster);
-    private get _http();
-    private _createIndex;
     /**
      * Creates a new query index.
      *
@@ -248,7 +345,6 @@ export declare class QueryIndexManager {
      * @param callback A node-style callback to be invoked after execution.
      */
     createPrimaryIndex(bucketName: string, options?: CreatePrimaryQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
-    private _dropIndex;
     /**
      * Drops an existing query index.
      *