couchbase 4.4.6 → 4.5.0

package/dist/bindingutilities.js

@@ -27,7 +27,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.eventingFunctionLanguageCompatibilityFromCpp = exports.eventingFunctionLanguageCompatibilityToCpp = exports.eventingFunctionLogLevelFromCpp = exports.eventingFunctionLogLevelToCpp = exports.eventingFunctionProcessingStatusFromCpp = exports.eventingFunctionProcessingStatusToCpp = exports.eventingFunctionDeploymentStatusFromCpp = exports.eventingFunctionDeploymentStatusToCpp = exports.eventingFunctionDcpBoundaryFromCpp = exports.eventingFunctionDcpBoundaryToCpp = exports.eventingBucketBindingAccessFromCpp = exports.eventingBucketBindingAccessToCpp = exports.transactionKeyspaceToCpp = exports.designDocumentNamespaceToCpp = exports.designDocumentNamespaceFromCpp = exports.vectorQueryCombinationToCpp = exports.bucketConflictResolutionTypeFromCpp = exports.bucketConflictResolutionTypeToCpp = exports.bucketStorageBackendFromCpp = exports.bucketStorageBackendToCpp = exports.bucketEvictionPolicyFromCpp = exports.bucketEvictionPolicyToCpp = exports.bucketCompressionModeFromCpp = exports.bucketCompressionModeToCpp = exports.bucketTypeFromCpp = exports.bucketTypeToCpp = exports.scanTypeToCpp = exports.errorFromCpp = exports.contextFromCpp = exports.pingStateFromCpp = exports.txnOpExeptionFromCpp = exports.txnExternalExceptionStringFromCpp = exports.endpointStateFromCpp = exports.serviceTypeFromCpp = exports.serviceTypeToCpp = exports.mutationStateToCpp = exports.searchHighlightStyleToCpp = exports.searchScanConsistencyToCpp = exports.analyticsStatusFromCpp = exports.analyticsScanConsistencyToCpp = exports.queryProfileToCpp = exports.queryScanConsistencyFromCpp = exports.queryScanConsistencyToCpp = exports.viewOrderingToCpp = exports.viewScanConsistencyToCpp = exports.storeSemanticToCpp = exports.replicateToToCpp = exports.persistToToCpp = exports.durabilityFromCpp = exports.durabilityToCpp = void 0;
-exports.authDomainFromCpp = exports.authDomainToCpp = exports.encryptionSettingsFromCpp = exports.encryptionSettingsToCpp = exports.encryptionLevelToCpp = exports.couchbaseLinkEncryptionLevelFromCpp = exports.eventingFunctionStatusFromCpp = void 0;
+exports.transactionGetMultiReplicasFromPreferredServerGroupModeToCpp = exports.transactionGetMultiModeToCpp = exports.readPreferenceToCpp = exports.authDomainFromCpp = exports.authDomainToCpp = exports.encryptionSettingsFromCpp = exports.encryptionSettingsToCpp = exports.encryptionLevelToCpp = exports.couchbaseLinkEncryptionLevelFromCpp = exports.eventingFunctionStatusFromCpp = void 0;
 const analyticstypes_1 = require("./analyticstypes");
 const analyticsindexmanager_1 = require("./analyticsindexmanager");
 const binding_1 = __importDefault(require("./binding"));
@@ -39,6 +39,7 @@ const generaltypes_1 = require("./generaltypes");
 const querytypes_1 = require("./querytypes");
 const rangeScan_1 = require("./rangeScan");
 const searchtypes_1 = require("./searchtypes");
+const transactions_1 = require("./transactions");
 const utilities_1 = require("./utilities");
 const vectorsearch_1 = require("./vectorsearch");
 const viewtypes_1 = require("./viewtypes");
@@ -432,78 +433,93 @@ exports.endpointStateFromCpp = endpointStateFromCpp;
  * @internal
  */
 function txnExternalExceptionStringFromCpp(cause, message) {
-    if (cause === binding_1.default.txn_external_exception.unknown) {
+    if (cause === binding_1.default.transactions_external_exception.UNKNOWN) {
         if (message) {
             return message;
         }
         return 'unknown';
     }
     else if (cause ===
-        binding_1.default.txn_external_exception.active_transaction_record_entry_not_found) {
+        binding_1.default.transactions_external_exception
+            .ACTIVE_TRANSACTION_RECORD_ENTRY_NOT_FOUND) {
         return 'active_transaction_record_entry_not_found';
     }
-    else if (cause === binding_1.default.txn_external_exception.active_transaction_record_full) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.ACTIVE_TRANSACTION_RECORD_FULL) {
         return 'active_transaction_record_full';
     }
-    else if (cause === binding_1.default.txn_external_exception.active_transaction_record_not_found) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.ACTIVE_TRANSACTION_RECORD_NOT_FOUND) {
         return 'active_transaction_record_not_found';
     }
-    else if (cause === binding_1.default.txn_external_exception.document_already_in_transaction) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.DOCUMENT_ALREADY_IN_TRANSACTION) {
         return 'document_already_in_transaction';
     }
-    else if (cause === binding_1.default.txn_external_exception.document_exists_exception) {
+    else if (cause === binding_1.default.transactions_external_exception.DOCUMENT_EXISTS_EXCEPTION) {
         return 'document_exists_exception';
     }
-    else if (cause === binding_1.default.txn_external_exception.document_not_found_exception) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.DOCUMENT_NOT_FOUND_EXCEPTION) {
         return 'document_not_found_exception';
     }
-    else if (cause === binding_1.default.txn_external_exception.not_set) {
+    else if (cause === binding_1.default.transactions_external_exception.NOT_SET) {
         return 'not_set';
     }
-    else if (cause === binding_1.default.txn_external_exception.feature_not_available_exception) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.FEATURE_NOT_AVAILABLE_EXCEPTION) {
         return 'feature_not_available_exception';
     }
-    else if (cause === binding_1.default.txn_external_exception.transaction_aborted_externally) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.TRANSACTION_ABORTED_EXTERNALLY) {
         return 'transaction_aborted_externally';
     }
-    else if (cause === binding_1.default.txn_external_exception.previous_operation_failed) {
+    else if (cause === binding_1.default.transactions_external_exception.PREVIOUS_OPERATION_FAILED) {
         return 'previous_operation_failed';
     }
-    else if (cause === binding_1.default.txn_external_exception.forward_compatibility_failure) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.FORWARD_COMPATIBILITY_FAILURE) {
         return 'forward_compatibility_failure';
     }
-    else if (cause === binding_1.default.txn_external_exception.parsing_failure) {
+    else if (cause === binding_1.default.transactions_external_exception.PARSING_FAILURE) {
         return 'parsing_failure';
     }
-    else if (cause === binding_1.default.txn_external_exception.illegal_state_exception) {
+    else if (cause === binding_1.default.transactions_external_exception.ILLEGAL_STATE_EXCEPTION) {
         return 'illegal_state_exception';
     }
-    else if (cause === binding_1.default.txn_external_exception.couchbase_exception) {
+    else if (cause === binding_1.default.transactions_external_exception.COUCHBASE_EXCEPTION) {
         return 'couchbase_exception';
     }
-    else if (cause === binding_1.default.txn_external_exception.service_not_available_exception) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.SERVICE_NOT_AVAILABLE_EXCEPTION) {
         return 'service_not_available_exception';
     }
-    else if (cause === binding_1.default.txn_external_exception.request_canceled_exception) {
+    else if (cause === binding_1.default.transactions_external_exception.REQUEST_CANCELED_EXCEPTION) {
         return 'request_canceled_exception';
     }
     else if (cause ===
-        binding_1.default.txn_external_exception
-            .concurrent_operations_detected_on_same_document) {
+        binding_1.default.transactions_external_exception
+            .CONCURRENT_OPERATIONS_DETECTED_ON_SAME_DOCUMENT) {
         return 'concurrent_operations_detected_on_same_document';
     }
-    else if (cause === binding_1.default.txn_external_exception.commit_not_permitted) {
+    else if (cause === binding_1.default.transactions_external_exception.COMMIT_NOT_PERMITTED) {
         return 'commit_not_permitted';
     }
-    else if (cause === binding_1.default.txn_external_exception.rollback_not_permitted) {
+    else if (cause === binding_1.default.transactions_external_exception.ROLLBACK_NOT_PERMITTED) {
         return 'rollback_not_permitted';
     }
-    else if (cause === binding_1.default.txn_external_exception.transaction_already_aborted) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.TRANSACTION_ALREADY_ABORTED) {
         return 'transaction_already_aborted';
     }
-    else if (cause === binding_1.default.txn_external_exception.transaction_already_committed) {
+    else if (cause ===
+        binding_1.default.transactions_external_exception.TRANSACTION_ALREADY_COMMITTED) {
         return 'transaction_already_committed';
     }
+    else if (cause ===
+        binding_1.default.transactions_external_exception.DOCUMENT_UNRETRIEVABLE_EXCEPTION) {
+        return 'document_unretrievable_exception';
+    }
     return 'unknown';
 }
 exports.txnExternalExceptionStringFromCpp = txnExternalExceptionStringFromCpp;
@@ -515,19 +531,25 @@ function txnOpExeptionFromCpp(err, ctx) {
         return null;
     }
     const context = ctx ? ctx : undefined;
-    if (err.cause === binding_1.default.txn_external_exception.document_exists_exception) {
+    if (err.cause ===
+        binding_1.default.transactions_external_exception.DOCUMENT_EXISTS_EXCEPTION) {
         return new errs.DocumentExistsError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)), context);
     }
-    else if (err.cause === binding_1.default.txn_external_exception.document_not_found_exception) {
+    else if (err.cause ===
+        binding_1.default.transactions_external_exception.DOCUMENT_NOT_FOUND_EXCEPTION) {
         return new errs.DocumentNotFoundError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)), context);
     }
-    else if (err.cause === binding_1.default.txn_external_exception.parsing_failure) {
+    else if (err.cause === binding_1.default.transactions_external_exception.PARSING_FAILURE) {
         return new errs.ParsingFailureError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)), context);
     }
-    else if (err.cause === binding_1.default.txn_external_exception.couchbase_exception) {
+    else if (err.cause === binding_1.default.transactions_external_exception.COUCHBASE_EXCEPTION) {
         const cause = txnExternalExceptionStringFromCpp(err.cause, err.message);
         return new errs.CouchbaseError(cause, new Error(cause), context);
     }
+    else if (err.cause ===
+        binding_1.default.transactions_external_exception.DOCUMENT_UNRETRIEVABLE_EXCEPTION) {
+        return new errs.DocumentUnretrievableError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)), context);
+    }
     return err;
 }
 exports.txnOpExeptionFromCpp = txnOpExeptionFromCpp;
@@ -554,6 +576,10 @@ function contextFromCpp(err) {
     if (!err) {
         return null;
     }
+    let retry_reasons = [];
+    if ('retry_reasons' in err) {
+        retry_reasons = err.retry_reasons.map(retryReasonFromCpp);
+    }
     let context = null;
     if (err.ctxtype === 'key_value') {
         context = new errctxs.KeyValueErrorContext({
@@ -566,6 +592,12 @@ function contextFromCpp(err) {
             scope: err.id ? err.id.scope : '',
             context: err.enhanced_error_info ? err.enhanced_error_info.context : '',
             ref: err.enhanced_error_info ? err.enhanced_error_info.reference : '',
+            last_dispatched_from: err.last_dispatched_from
+                ? err.last_dispatched_from
+                : '',
+            last_dispatched_to: err.last_dispatched_to ? err.last_dispatched_to : '',
+            retry_attempts: err.retry_attempts ? err.retry_attempts : 0,
+            retry_reasons: retry_reasons,
         });
     }
     else if (err.ctxtype === 'view') {
@@ -575,6 +607,12 @@ function contextFromCpp(err) {
             parameters: err.query_string,
             http_response_code: err.http_status,
             http_response_body: err.http_body,
+            last_dispatched_from: err.last_dispatched_from
+                ? err.last_dispatched_from
+                : '',
+            last_dispatched_to: err.last_dispatched_to ? err.last_dispatched_to : '',
+            retry_attempts: err.retry_attempts ? err.retry_attempts : 0,
+            retry_reasons: retry_reasons,
         });
     }
     else if (err.ctxtype === 'query') {
@@ -584,6 +622,12 @@ function contextFromCpp(err) {
             parameters: err.parameters,
             http_response_code: err.http_status,
             http_response_body: err.http_body,
+            last_dispatched_from: err.last_dispatched_from
+                ? err.last_dispatched_from
+                : '',
+            last_dispatched_to: err.last_dispatched_to ? err.last_dispatched_to : '',
+            retry_attempts: err.retry_attempts ? err.retry_attempts : 0,
+            retry_reasons: retry_reasons,
         });
     }
     else if (err.ctxtype === 'search') {
@@ -593,6 +637,12 @@ function contextFromCpp(err) {
             parameters: err.parameters,
             http_response_code: err.http_status,
             http_response_body: err.http_body,
+            last_dispatched_from: err.last_dispatched_from
+                ? err.last_dispatched_from
+                : '',
+            last_dispatched_to: err.last_dispatched_to ? err.last_dispatched_to : '',
+            retry_attempts: err.retry_attempts ? err.retry_attempts : 0,
+            retry_reasons: retry_reasons,
         });
     }
     else if (err.ctxtype === 'analytics') {
@@ -602,6 +652,12 @@ function contextFromCpp(err) {
             parameters: err.parameters,
             http_response_code: err.http_status,
             http_response_body: err.http_body,
+            last_dispatched_from: err.last_dispatched_from
+                ? err.last_dispatched_from
+                : '',
+            last_dispatched_to: err.last_dispatched_to ? err.last_dispatched_to : '',
+            retry_attempts: err.retry_attempts ? err.retry_attempts : 0,
+            retry_reasons: retry_reasons,
         });
     }
     else if (err.ctxtype === 'http') {
@@ -610,11 +666,88 @@ function contextFromCpp(err) {
             request_path: err.path,
             response_code: err.http_status,
             response_body: err.http_body,
+            last_dispatched_from: err.last_dispatched_from
+                ? err.last_dispatched_from
+                : '',
+            last_dispatched_to: err.last_dispatched_to ? err.last_dispatched_to : '',
+            retry_attempts: err.retry_attempts ? err.retry_attempts : 0,
+            retry_reasons: retry_reasons,
         });
     }
     return context;
 }
 exports.contextFromCpp = contextFromCpp;
+/**
+ * @internal
+ */
+function retryReasonFromCpp(reason) {
+    if (reason === binding_1.default.retry_reason.do_not_retry) {
+        return 'do_not_retry';
+    }
+    else if (reason === binding_1.default.retry_reason.unknown) {
+        return 'unknown';
+    }
+    else if (reason === binding_1.default.retry_reason.socket_not_available) {
+        return 'socket_not_available';
+    }
+    else if (reason === binding_1.default.retry_reason.service_not_available) {
+        return 'service_not_available';
+    }
+    else if (reason === binding_1.default.retry_reason.node_not_available) {
+        return 'node_not_available';
+    }
+    else if (reason === binding_1.default.retry_reason.key_value_not_my_vbucket) {
+        return 'key_value_not_my_vbucket';
+    }
+    else if (reason === binding_1.default.retry_reason.key_value_collection_outdated) {
+        return 'key_value_collection_outdated';
+    }
+    else if (reason === binding_1.default.retry_reason.key_value_error_map_retry_indicated) {
+        return 'key_value_error_map_retry_indicated';
+    }
+    else if (reason === binding_1.default.retry_reason.key_value_locked) {
+        return 'key_value_locked';
+    }
+    else if (reason === binding_1.default.retry_reason.key_value_temporary_failure) {
+        return 'key_value_temporary_failure';
+    }
+    else if (reason === binding_1.default.retry_reason.key_value_sync_write_in_progress) {
+        return 'key_value_sync_write_in_progress';
+    }
+    else if (reason === binding_1.default.retry_reason.key_value_sync_write_re_commit_in_progress) {
+        return 'key_value_sync_write_re_commit_in_progress';
+    }
+    else if (reason === binding_1.default.retry_reason.service_response_code_indicated) {
+        return 'service_response_code_indicated';
+    }
+    else if (reason === binding_1.default.retry_reason.socket_closed_while_in_flight) {
+        return 'socket_closed_while_in_flight';
+    }
+    else if (reason === binding_1.default.retry_reason.circuit_breaker_open) {
+        return 'circuit_breaker_open';
+    }
+    else if (reason === binding_1.default.retry_reason.query_prepared_statement_failure) {
+        return 'query_prepared_statement_failure';
+    }
+    else if (reason === binding_1.default.retry_reason.query_index_not_found) {
+        return 'query_index_not_found';
+    }
+    else if (reason === binding_1.default.retry_reason.analytics_temporary_failure) {
+        return 'analytics_temporary_failure';
+    }
+    else if (reason === binding_1.default.retry_reason.search_too_many_requests) {
+        return 'search_too_many_requests';
+    }
+    else if (reason === binding_1.default.retry_reason.views_temporary_failure) {
+        return 'views_temporary_failure';
+    }
+    else if (reason === binding_1.default.retry_reason.views_no_active_partition) {
+        return 'views_no_active_partition';
+    }
+    else {
+        return 'unknown';
+    }
+}
 /**
  * @internal
  */
@@ -640,13 +773,13 @@ function errorFromCpp(err) {
         return txnOpExeptionFromCpp(err, txnContext);
     }
     else if (err.ctxtype === 'transaction_exception') {
-        if (err.type === binding_1.default.txn_failure_type.fail) {
+        if (err.type === binding_1.default.transactions_failure_type.FAIL) {
             return new errs.TransactionFailedError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)));
         }
-        else if (err.type === binding_1.default.txn_failure_type.expiry) {
+        else if (err.type === binding_1.default.transactions_failure_type.EXPIRY) {
             return new errs.TransactionExpiredError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)));
         }
-        else if (err.type === binding_1.default.txn_failure_type.commit_ambiguous) {
+        else if (err.type === binding_1.default.transactions_failure_type.COMMIT_AMBIGUOUS) {
             return new errs.TransactionCommitAmbiguousError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)));
         }
         return new errs.TransactionFailedError(new Error(txnExternalExceptionStringFromCpp(err.cause, err.message)));
@@ -654,6 +787,9 @@ function errorFromCpp(err) {
     const baseErr = err;
     const contextOrNull = contextFromCpp(err);
     const context = contextOrNull ? contextOrNull : undefined;
+    if ('retry_reasons' in baseErr && Array.isArray(baseErr.retry_reasons)) {
+        baseErr.retry_reasons = baseErr.retry_reasons.map(retryReasonFromCpp);
+    }
     switch (err.code) {
         case binding_1.default.errc_common.request_canceled:
             return new errs.RequestCanceledError(baseErr, context);
@@ -1431,3 +1567,69 @@ function authDomainFromCpp(domain) {
     throw new errs.InvalidArgumentError(new Error('Unrecognized CppManagementRbacAuthDomain.'));
 }
 exports.authDomainFromCpp = authDomainFromCpp;
+/**
+ * @internal
+ */
+function readPreferenceToCpp(preference) {
+    // Unspecified is allowed, and means no preference.
+    if (preference === null || preference === undefined) {
+        return binding_1.default.read_preference.no_preference;
+    }
+    if (preference === generaltypes_1.ReadPreference.NoPreference) {
+        return binding_1.default.read_preference.no_preference;
+    }
+    else if (preference === generaltypes_1.ReadPreference.SelectedServerGroup) {
+        return binding_1.default.read_preference.selected_server_group;
+    }
+    throw new errs.InvalidArgumentError(new Error('Unrecognized ReadPreference.'));
+}
+exports.readPreferenceToCpp = readPreferenceToCpp;
+/**
+ * @internal
+ */
+function transactionGetMultiModeToCpp(mode) {
+    if (mode === null || mode === undefined) {
+        return undefined;
+    }
+    if (mode === transactions_1.TransactionGetMultiMode.PrioritiseLatency) {
+        return binding_1.default.transactions_transaction_get_multi_mode.prioritise_latency;
+    }
+    else if (mode === transactions_1.TransactionGetMultiMode.DisableReadSkewDetection) {
+        return binding_1.default.transactions_transaction_get_multi_mode
+            .disable_read_skew_detection;
+    }
+    else if (mode === transactions_1.TransactionGetMultiMode.PrioritiseReadSkewDetection) {
+        return binding_1.default.transactions_transaction_get_multi_mode
+            .prioritise_read_skew_detection;
+    }
+    throw new errs.InvalidArgumentError(new Error('Unrecognized TransactionGetMultiMode.'));
+}
+exports.transactionGetMultiModeToCpp = transactionGetMultiModeToCpp;
+/**
+ * @internal
+ */
+function transactionGetMultiReplicasFromPreferredServerGroupModeToCpp(mode) {
+    if (mode === null || mode === undefined) {
+        return undefined;
+    }
+    if (mode ===
+        transactions_1.TransactionGetMultiReplicasFromPreferredServerGroupMode.PrioritiseLatency) {
+        return binding_1.default
+            .transactions_transaction_get_multi_replicas_from_preferred_server_group_mode
+            .prioritise_latency;
+    }
+    else if (mode ===
+        transactions_1.TransactionGetMultiReplicasFromPreferredServerGroupMode.DisableReadSkewDetection) {
+        return binding_1.default
+            .transactions_transaction_get_multi_replicas_from_preferred_server_group_mode
+            .disable_read_skew_detection;
+    }
+    else if (mode ===
+        transactions_1.TransactionGetMultiReplicasFromPreferredServerGroupMode.PrioritiseReadSkewDetection) {
+        return binding_1.default
+            .transactions_transaction_get_multi_replicas_from_preferred_server_group_mode
+            .prioritise_read_skew_detection;
+    }
+    throw new errs.InvalidArgumentError(new Error('Unrecognized TransactionGetMultiReplicasFromPreferredServerGroupMode.'));
+}
+exports.transactionGetMultiReplicasFromPreferredServerGroupModeToCpp = transactionGetMultiReplicasFromPreferredServerGroupModeToCpp;

package/dist/cluster.d.ts

@@ -98,6 +98,33 @@ export interface DnsConfig {
      */
     dnsSrvTimeout?: number;
 }
+/**
+ * Specifies Application Telemetry options for the client.
+ *
+ * @category Core
+ */
+export interface AppTelemetryConfig {
+    /**
+     * Specifies if application telemetry feature should be enabled or not.
+     */
+    enabled?: boolean;
+    /**
+     * Specifies an endpoint to override the application metrics endpoint discovered during configuration.
+     */
+    endpoint?: string;
+    /**
+     * Specifies the time to wait before attempting a websocket reconnection, specified in millseconds.
+     */
+    backoff?: number;
+    /**
+     * Specifies the time to wait between sending consecutive websocket PING commands to the server, specified in millseconds.
+     */
+    pingInterval?: number;
+    /**
+     * Specifies the time allowed for the server to respond to websocket PING command, specified in millseconds.
+     */
+    pingTimeout?: number;
+}
 /**
  * Specifies the options which can be specified when connecting
  * to a cluster.
@@ -150,6 +177,16 @@ export interface ConnectOptions {
      *
      */
     configProfile?: string;
+    /**
+     * Specifies the preferred server group to use for replica operations that specify a non-default
+     * read preference.
+     */
+    preferredServerGroup?: string;
+    /**
+     * Specifies the Application Telemetry config for connections of this cluster.
+     *
+     */
+    appTelemetryConfig?: AppTelemetryConfig;
 }
 /**
  * Exposes the operations which are available to be performed against a cluster.
@@ -178,6 +215,8 @@ export declare class Cluster {
     private _transactions?;
     private _openBuckets;
     private _dnsConfig;
+    private _preferredServerGroup;
+    private _appTelemetryConfig;
     /**
      * @internal
      */

package/dist/cluster.js

@@ -110,7 +110,7 @@ class Cluster {
     [util_1.inspect.custom]() {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { _auth, ...rest } = this;
-        return { ...rest, _auth: "***hidden***" };
+        return { ...rest, _auth: '***hidden***' };
     }
     /**
      * @internal
@@ -118,7 +118,7 @@ class Cluster {
     toJSON() {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { _auth, ...rest } = this;
-        return { ...rest, _auth: "***hidden***" };
+        return { ...rest, _auth: '***hidden***' };
     }
     /**
     @internal
@@ -156,6 +156,9 @@ class Cluster {
         else {
             this._transcoder = new transcoders_1.DefaultTranscoder();
         }
+        if (options.preferredServerGroup) {
+            this._preferredServerGroup = options.preferredServerGroup;
+        }
         if (options.transactions) {
             this._txnConfig = options.transactions;
         }
@@ -193,6 +196,18 @@ class Cluster {
         else {
             this._dnsConfig = null;
         }
+        if (options.appTelemetryConfig) {
+            this._appTelemetryConfig = {
+                enabled: options.appTelemetryConfig.enabled,
+                endpoint: options.appTelemetryConfig.endpoint,
+                backoff: options.appTelemetryConfig.backoff,
+                pingInterval: options.appTelemetryConfig.pingInterval,
+                pingTimeout: options.appTelemetryConfig.pingTimeout,
+            };
+        }
+        else {
+            this._appTelemetryConfig = null;
+        }
         this._openBuckets = [];
         this._conn = new binding_1.default.Connection();
     }
@@ -433,6 +448,9 @@ class Cluster {
             if (this.resolveTimeout) {
                 dsnObj.options['resolve_timeout'] = this.resolveTimeout.toString();
             }
+            if (this._preferredServerGroup) {
+                dsnObj.options['server_group'] = this._preferredServerGroup;
+            }
             const connStr = dsnObj.toString();
             const authOpts = {};
             // lets allow `allowed_sasl_mechanisms` to override legacy connstr option
@@ -463,7 +481,7 @@ class Cluster {
                     authOpts.key_path = certAuth.keyPath;
                 }
             }
-            this._conn.connect(connStr, authOpts, this._dnsConfig, (cppErr) => {
+            this._conn.connect(connStr, authOpts, this._dnsConfig, this._appTelemetryConfig, (cppErr) => {
                 if (cppErr) {
                     const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                     return reject(err);

package/dist/collection.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncrementOptions, DecrementOptions, AppendOptions, PrependOptions, BinaryCollection } from './binarycollection';
 import { CppDocumentId, CppConnection, CppScanIterator, CppRangeScanOrchestratorOptions } from './binding';
 import { Cluster } from './cluster';
 import { CounterResult, ExistsResult, GetReplicaResult, GetResult, LookupInResult, LookupInReplicaResult, MutateInResult, MutationResult, ScanResult } from './crudoptypes';
 import { CouchbaseList, CouchbaseMap, CouchbaseQueue, CouchbaseSet } from './datastructures';
-import { DurabilityLevel, StoreSemantics } from './generaltypes';
+import { DurabilityLevel, ReadPreference, StoreSemantics } from './generaltypes';
 import { MutationState } from './mutationstate';
 import { CollectionQueryIndexManager } from './queryindexmanager';
 import { RangeScan, SamplingScan, PrefixScan } from './rangeScan';
@@ -200,6 +201,10 @@ export interface GetAnyReplicaOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies how replica nodes will be filtered.
+     */
+    readPreference?: ReadPreference;
 }
 /**
  * @category Key-Value
@@ -213,6 +218,10 @@ export interface GetAllReplicasOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies how replica nodes will be filtered.
+     */
+    readPreference?: ReadPreference;
 }
 /**
  * @category Key-Value
@@ -285,6 +294,10 @@ export interface LookupInAnyReplicaOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies how replica nodes will be filtered.
+     */
+    readPreference?: ReadPreference;
 }
 /**
  * @category Key-Value
@@ -294,6 +307,10 @@ export interface LookupInAllReplicasOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies how replica nodes will be filtered.
+     */
+    readPreference?: ReadPreference;
 }
 /**
  * @category Key-Value
@@ -469,6 +486,7 @@ export declare class Collection {
     _getReplica(key: string, getAllReplicas: boolean, options?: {
         transcoder?: Transcoder;
         timeout?: number;
+        readPreference?: ReadPreference;
     }, callback?: NodeCallback<GetReplicaResult[]>): StreamableReplicasPromise<GetReplicaResult[], GetReplicaResult>;
     /**
      * Retrieves the value of the document from any of the available replicas.  This
@@ -596,6 +614,7 @@ export declare class Collection {
      */
     _lookupInReplica(key: string, lookupInAllReplicas: boolean, specs: LookupInSpec[], options?: {
         timeout?: number;
+        readPreference?: ReadPreference;
     }, callback?: NodeCallback<LookupInReplicaResult[]>): StreamableReplicasPromise<LookupInReplicaResult[], LookupInReplicaResult>;
     /**
      * Performs a lookup-in operation against a document, fetching individual fields or