couchbase 4.4.6-dev.1 → 4.5.0

package/dist/collection.js

@@ -327,6 +327,7 @@ class Collection {
             this._conn.getAllReplicas({
                 id: this._cppDocId(key),
                 timeout: timeout,
+                read_preference: (0, bindingutilities_1.readPreferenceToCpp)(options.readPreference),
             }, (cppErr, resp) => {
                 const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                 if (err) {
@@ -356,6 +357,7 @@ class Collection {
             this._conn.getAnyReplica({
                 id: this._cppDocId(key),
                 timeout: timeout,
+                read_preference: (0, bindingutilities_1.readPreferenceToCpp)(options.readPreference),
             }, (cppErr, resp) => {
                 const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                 if (err) {
@@ -930,6 +932,9 @@ class Collection {
         if (!options) {
             options = {};
         }
+        if (specs.length === 0) {
+            throw new errors_1.InvalidArgumentError(new Error('At least one lookup spec must be provided.'));
+        }
         const cppSpecs = [];
         for (let i = 0; i < specs.length; ++i) {
             cppSpecs.push({
@@ -989,6 +994,9 @@ class Collection {
         if (!options) {
             options = {};
         }
+        if (specs.length === 0) {
+            throw new errors_1.InvalidArgumentError(new Error('At least one lookup spec must be provided.'));
+        }
         const emitter = new streamablepromises_1.StreamableReplicasPromise((replicas) => replicas);
         const cppSpecs = [];
         for (let i = 0; i < specs.length; ++i) {
@@ -1005,6 +1013,7 @@ class Collection {
                 id: this._cppDocId(key),
                 specs: cppSpecs,
                 timeout: timeout,
+                read_preference: (0, bindingutilities_1.readPreferenceToCpp)(options.readPreference),
             }, (cppErr, resp) => {
                 const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                 if (err) {
@@ -1044,6 +1053,7 @@ class Collection {
                 id: this._cppDocId(key),
                 specs: cppSpecs,
                 timeout: timeout,
+                read_preference: (0, bindingutilities_1.readPreferenceToCpp)(options.readPreference),
             }, (cppErr, resp) => {
                 const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                 if (err) {
@@ -1128,6 +1138,9 @@ class Collection {
         if (!options) {
             options = {};
         }
+        if (specs.length === 0) {
+            throw new errors_1.InvalidArgumentError(new Error('At least one lookup spec must be provided.'));
+        }
         const cppSpecs = [];
         for (let i = 0; i < specs.length; ++i) {
             cppSpecs.push({

package/dist/errorcontexts.d.ts

@@ -1,10 +1,33 @@
 import { Cas } from './utilities';
+/**
+ * Specific error context types.
+ *
+ * @category Error Handling
+ */
+type ErrorContextTypes = KeyValueErrorContext | ViewErrorContext | QueryErrorContext | SearchErrorContext | AnalyticsErrorContext | HttpErrorContext;
 /**
  * Generic base class for all known error context types.
  *
  * @category Error Handling
  */
 export declare class ErrorContext {
+    /**
+     * The host and port that the request was last sent to.
+     */
+    last_dispatched_to: string;
+    /**
+     * The host and port that the request was last sent from.
+     */
+    last_dispatched_from: string;
+    /**
+     * The number of times the operation has been retried.
+     */
+    retry_attempts: number;
+    /**
+     * A list of the reasons for retrying the operation.
+     */
+    retry_reasons: string[];
+    constructor(data: ErrorContextTypes);
 }
 /**
  * The error context information for a key-value operation.
@@ -206,3 +229,4 @@ export declare class HttpErrorContext extends ErrorContext {
      */
     constructor(data: HttpErrorContext);
 }
+export {};

package/dist/errorcontexts.js

@@ -7,6 +7,12 @@ exports.HttpErrorContext = exports.AnalyticsErrorContext = exports.SearchErrorCo
  * @category Error Handling
  */
 class ErrorContext {
+    constructor(data) {
+        this.last_dispatched_to = data.last_dispatched_to || '';
+        this.last_dispatched_from = data.last_dispatched_from || '';
+        this.retry_attempts = data.retry_attempts || 0;
+        this.retry_reasons = data.retry_reasons || [];
+    }
 }
 exports.ErrorContext = ErrorContext;
 /**
@@ -19,7 +25,7 @@ class KeyValueErrorContext extends ErrorContext {
      * @internal
      */
     constructor(data) {
-        super();
+        super(data);
         this.status_code = data.status_code;
         this.opaque = data.opaque;
         this.cas = data.cas;
@@ -42,7 +48,7 @@ class ViewErrorContext extends ErrorContext {
      * @internal
      */
     constructor(data) {
-        super();
+        super(data);
         this.design_document = data.design_document;
         this.view = data.view;
         this.parameters = data.parameters;
@@ -61,7 +67,7 @@ class QueryErrorContext extends ErrorContext {
      * @internal
      */
     constructor(data) {
-        super();
+        super(data);
         this.statement = data.statement;
         this.client_context_id = data.client_context_id;
         this.parameters = data.parameters;
@@ -80,7 +86,7 @@ class SearchErrorContext extends ErrorContext {
      * @internal
      */
     constructor(data) {
-        super();
+        super(data);
         this.index_name = data.index_name;
         this.query = data.query;
         this.parameters = data.parameters;
@@ -99,7 +105,7 @@ class AnalyticsErrorContext extends ErrorContext {
      * @internal
      */
     constructor(data) {
-        super();
+        super(data);
         this.statement = data.statement;
         this.client_context_id = data.client_context_id;
         this.parameters = data.parameters;
@@ -118,7 +124,7 @@ class HttpErrorContext extends ErrorContext {
      * @internal
      */
     constructor(data) {
-        super();
+        super(data);
         this.method = data.method;
         this.request_path = data.request_path;
         this.response_code = data.response_code;

package/dist/generaltypes.d.ts

@@ -78,3 +78,19 @@ export declare enum StoreSemantics {
      */
     Insert = 2
 }
+/**
+ * Represents the various scan consistency options that are available when
+ * querying against the query service.
+ */
+export declare enum ReadPreference {
+    /**
+     * Indicates that filtering for replica set should not be enforced.
+     */
+    NoPreference = "no_preference",
+    /**
+     * Indicates that any nodes that do not belong to local group selected during
+     * cluster instantiation using the `ConnectOptions.preferredServerGroup` option
+     * should be excluded.
+     */
+    SelectedServerGroup = "selected_server_group"
+}

package/dist/generaltypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StoreSemantics = exports.DurabilityLevel = exports.ServiceType = void 0;
+exports.ReadPreference = exports.StoreSemantics = exports.DurabilityLevel = exports.ServiceType = void 0;
 /**
  * Represents the various service types available.
  */
@@ -84,3 +84,20 @@ var StoreSemantics;
      */
     StoreSemantics[StoreSemantics["Insert"] = 2] = "Insert";
 })(StoreSemantics || (exports.StoreSemantics = StoreSemantics = {}));
+/**
+ * Represents the various scan consistency options that are available when
+ * querying against the query service.
+ */
+var ReadPreference;
+(function (ReadPreference) {
+    /**
+     * Indicates that filtering for replica set should not be enforced.
+     */
+    ReadPreference["NoPreference"] = "no_preference";
+    /**
+     * Indicates that any nodes that do not belong to local group selected during
+     * cluster instantiation using the `ConnectOptions.preferredServerGroup` option
+     * should be excluded.
+     */
+    ReadPreference["SelectedServerGroup"] = "selected_server_group";
+})(ReadPreference || (exports.ReadPreference = ReadPreference = {}));

package/dist/httpexecutor.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { CppConnection } from './binding';
-import { HttpErrorContext } from './errorcontexts';
 import * as events from 'events';
 /**
  * @internal
@@ -59,5 +59,4 @@ export declare class HttpExecutor {
      */
     streamRequest(options: HttpRequestOptions): events.EventEmitter;
     request(options: HttpRequestOptions): Promise<HttpResponse>;
-    static errorContextFromResponse(resp: HttpResponse): HttpErrorContext;
 }

package/dist/httpexecutor.js

@@ -30,7 +30,6 @@ exports.HttpExecutor = exports.HttpMethod = exports.HttpServiceType = void 0;
 /* eslint jsdoc/require-jsdoc: off */
 const binding_1 = __importDefault(require("./binding"));
 const bindingutilities_1 = require("./bindingutilities");
-const errorcontexts_1 = require("./errorcontexts");
 const events = __importStar(require("events"));
 /**
  * @internal
@@ -170,13 +169,5 @@ class HttpExecutor {
             });
         });
     }
-    static errorContextFromResponse(resp) {
-        return new errorcontexts_1.HttpErrorContext({
-            method: resp.requestOptions.method,
-            request_path: resp.requestOptions.path,
-            response_code: resp.statusCode,
-            response_body: resp.body.toString(),
-        });
-    }
 }
 exports.HttpExecutor = HttpExecutor;

package/dist/streamablepromises.d.ts

@@ -3,42 +3,60 @@ import EventEmitter from 'events';
 /**
  * @internal
  */
-type PromisifyFunc<T> = (emitter: StreamablePromise<T>, resolve: (result: T) => void, reject: (err: Error) => void) => void;
+type ListenerFunc = (...args: any[]) => void;
+/**
+ * @internal
+ */
+interface PromisifyEmitter {
+    on(eventName: string | symbol, listener: ListenerFunc): void;
+}
+/**
+ * @internal
+ */
+type PromisifyFunc<T> = (emitter: PromisifyEmitter, resolve: (result: T) => void, reject: (err: Error) => void) => void;
 /**
  * @internal
  */
 export declare class StreamablePromise<T> extends EventEmitter implements Promise<T> {
     private _promise;
-    private _promiseifyFn;
+    private _promiseOns;
     /**
      * @internal
      */
     constructor(promisefyFn: PromisifyFunc<T>);
     private get promise();
+    private _depromisify;
     then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
     catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
     finally(onfinally?: (() => void) | undefined | null): Promise<T>;
+    addListener(eventName: string | symbol, listener: ListenerFunc): this;
+    on(eventName: string | symbol, listener: ListenerFunc): this;
     /**
      * @internal
      */
     get [Symbol.toStringTag](): string;
 }
 /**
- * Provides the ability to be used as both a promise, or an event emitter.  Enabling
- * an application to easily retrieve all results using async/await, while also enabling
+ * Provides the ability to be used as either a promise or an event emitter.  Enabling
+ * an application to easily retrieve all results using async/await or enabling
  * streaming of results by listening for the row and meta events.
  */
 export declare class StreamableRowPromise<T, TRow, TMeta> extends StreamablePromise<T> {
     constructor(fn: (rows: TRow[], meta: TMeta) => T);
 }
 /**
- * Provides the ability to be used as both a promise, or an event emitter.  Enabling
- * an application to easily retrieve all results using async/await, while also enabling
- * streaming of results by listening for the replica event.
+ * Provides the ability to be used as either a promise or an event emitter.  Enabling
+ * an application to easily retrieve all replicas using async/await or enabling
+ * streaming of replicas by listening for the replica event.
  */
 export declare class StreamableReplicasPromise<T, TRep> extends StreamablePromise<T> {
     constructor(fn: (replicas: TRep[]) => T);
 }
+/**
+ * Provides the ability to be used as either a promise or an event emitter.  Enabling
+ * an application to easily retrieve all scan results using async/await or enabling
+ * streaming of scan results by listening for the result event.
+ */
 export declare class StreamableScanPromise<T, TRes> extends StreamablePromise<T> {
     private _cancelRequested;
     constructor(fn: (results: TRes[]) => T);

package/dist/streamablepromises.js

@@ -16,14 +16,26 @@ class StreamablePromise extends events_1.default {
     constructor(promisefyFn) {
         super();
         this._promise = null;
-        this._promiseifyFn = promisefyFn;
+        this._promiseOns = [];
+        this._promise = new Promise((resolve, reject) => {
+            promisefyFn({
+                on: (eventName, listener) => {
+                    this._promiseOns.push([eventName, listener]);
+                    super.on(eventName, listener);
+                },
+            }, resolve, reject);
+        });
     }
     get promise() {
         if (!this._promise) {
-            this._promise = new Promise((resolve, reject) => this._promiseifyFn(this, resolve, reject));
+            throw new Error('Cannot await a promise that is already registered for events');
         }
         return this._promise;
     }
+    _depromisify() {
+        this._promiseOns.forEach((e) => this.off(...e));
+        this._promise = null;
+    }
     then(onfulfilled, onrejected) {
         return this.promise.then(onfulfilled, onrejected);
     }
@@ -33,6 +45,14 @@ class StreamablePromise extends events_1.default {
     finally(onfinally) {
         return this.promise.finally(onfinally);
     }
+    addListener(eventName, listener) {
+        this._depromisify();
+        return super.on(eventName, listener);
+    }
+    on(eventName, listener) {
+        this._depromisify();
+        return super.on(eventName, listener);
+    }
     /**
      * @internal
      */
@@ -42,8 +62,8 @@ class StreamablePromise extends events_1.default {
 }
 exports.StreamablePromise = StreamablePromise;
 /**
- * Provides the ability to be used as both a promise, or an event emitter.  Enabling
- * an application to easily retrieve all results using async/await, while also enabling
+ * Provides the ability to be used as either a promise or an event emitter.  Enabling
+ * an application to easily retrieve all results using async/await or enabling
  * streaming of results by listening for the row and meta events.
  */
 class StreamableRowPromise extends StreamablePromise {
@@ -66,9 +86,9 @@ class StreamableRowPromise extends StreamablePromise {
 }
 exports.StreamableRowPromise = StreamableRowPromise;
 /**
- * Provides the ability to be used as both a promise, or an event emitter.  Enabling
- * an application to easily retrieve all results using async/await, while also enabling
- * streaming of results by listening for the replica event.
+ * Provides the ability to be used as either a promise or an event emitter.  Enabling
+ * an application to easily retrieve all replicas using async/await or enabling
+ * streaming of replicas by listening for the replica event.
  */
 class StreamableReplicasPromise extends StreamablePromise {
     constructor(fn) {
@@ -87,6 +107,11 @@ class StreamableReplicasPromise extends StreamablePromise {
     }
 }
 exports.StreamableReplicasPromise = StreamableReplicasPromise;
+/**
+ * Provides the ability to be used as either a promise or an event emitter.  Enabling
+ * an application to easily retrieve all scan results using async/await or enabling
+ * streaming of scan results by listening for the result event.
+ */
 class StreamableScanPromise extends StreamablePromise {
     constructor(fn) {
         super((emitter, resolve, reject) => {

package/dist/transactions.d.ts

@@ -1,4 +1,4 @@
-import { CppTransactions, CppTransaction, CppTransactionLinks, CppTransactionGetMetaData } from './binding';
+import { CppDocumentId, CppTransactions, CppTransaction, CppTransactionLinks, CppTransactionGetMetaData } from './binding';
 import { Cluster } from './cluster';
 import { Collection } from './collection';
 import { DurabilityLevel } from './generaltypes';
@@ -49,6 +49,44 @@ export interface TransactionKeyspace {
      */
     collection?: string;
 }
+/**
+ * Represents the mode of the Transactional GetMulti operation.
+ *
+ * @category Transactions
+ */
+export declare enum TransactionGetMultiMode {
+    /**
+     * Indicates that the Transactional GetMulti op should prioritise latency.
+     */
+    PrioritiseLatency = "prioritise_latency",
+    /**
+     * Indicates that the Transactional GetMulti op should disable read skew detection.
+     */
+    DisableReadSkewDetection = "disable_read_skew_detection",
+    /**
+     * Indicates that the Transactional GetMulti op should prioritise read skew detection.
+     */
+    PrioritiseReadSkewDetection = "prioritise_read_skew_detection"
+}
+/**
+ * Represents the mode of the Transactional GetMultiReplicasFromPreferredServerGroup operation.
+ *
+ * @category Transactions
+ */
+export declare enum TransactionGetMultiReplicasFromPreferredServerGroupMode {
+    /**
+     * Indicates that the Transactional GetMultiReplicasFromPreferredServerGroup op should prioritise latency.
+     */
+    PrioritiseLatency = "prioritise_latency",
+    /**
+     * Indicates that the Transactional GetMultiReplicasFromPreferredServerGroup op should disable read skew detection.
+     */
+    DisableReadSkewDetection = "disable_read_skew_detection",
+    /**
+     * Indicates that the Transactional GetMultiReplicasFromPreferredServerGroup op should prioritise read skew detection.
+     */
+    PrioritiseReadSkewDetection = "prioritise_read_skew_detection"
+}
 /**
  * Specifies the configuration options for Transactions cleanup.
  *
@@ -127,6 +165,54 @@ export interface TransactionOptions {
      */
     timeout?: number;
 }
+/**
+ * Represents the path to a document.
+ *
+ * @category Transactions
+ */
+export declare class TransactionGetMultiSpec {
+    constructor(collection: Collection, id: string, transcoder?: Transcoder);
+    /**
+     * The Collection where the document belongs.
+     */
+    collection: Collection;
+    /**
+     * The id (or key) of the document.
+     */
+    id: string;
+    /**
+     * The Transcoder to encode/decode the document.
+     */
+    transcoder?: Transcoder;
+    /**
+     * @internal
+     */
+    _toCppDocumentId(): CppDocumentId;
+}
+/**
+ * Represents the path to a document.
+ *
+ * @category Transactions
+ */
+export declare class TransactionGetMultiReplicasFromPreferredServerGroupSpec {
+    constructor(collection: Collection, id: string, transcoder?: Transcoder);
+    /**
+     * The Collection where the document belongs.
+     */
+    collection: Collection;
+    /**
+     * The id (or key) of the document.
+     */
+    id: string;
+    /**
+     * The Transcoder to encode/decode the document.
+     */
+    transcoder?: Transcoder;
+    /**
+     * @internal
+     */
+    _toCppDocumentId(): CppDocumentId;
+}
 /**
  * Contains the results of a Transaction.
  *
@@ -181,6 +267,109 @@ export declare class TransactionGetResult {
      */
     _metadata: CppTransactionGetMetaData;
 }
+/**
+ * Contains the results of a specific sub-operation within a transactional GetMulti operation.
+ *
+ * @category Transactions
+ */
+export declare class TransactionGetMultiResultEntry {
+    /**
+     * The error, if any, which occured when attempting to perform this sub-operation.
+     */
+    error: Error | null;
+    /**
+     * The value returned by the sub-operation.
+     */
+    value?: any;
+    /**
+     * @internal
+     */
+    constructor(data: {
+        value?: any;
+        error?: Error;
+    });
+}
+/**
+ * Contains the results of a transactional GetMulti operation.
+ *
+ * @category Transactions
+ */
+export declare class TransactionGetMultiResult {
+    /**
+     * @internal
+     */
+    constructor(data: {
+        content: TransactionGetMultiResultEntry[];
+    });
+    /**
+     * The content of the document.
+     */
+    content: TransactionGetMultiResultEntry[];
+    /**
+     * Indicates whether the document at the specified index exists.
+     *
+     * @param index The result index to check.
+     */
+    exists(index: number): boolean;
+    /**
+     * Provides the content at the specified index, if it exists.
+     *
+     * @param index The result index to check.
+     */
+    contentAt(index: number): any;
+}
+/**
+ * Contains the results of a specific sub-operation within
+ * a transactional GetMultiReplicasFromPreferredServerGroup operation.
+ *
+ * @category Transactions
+ */
+export declare class TransactionGetMultiReplicasFromPreferredServerGroupResultEntry {
+    /**
+     * The error, if any, which occured when attempting to access the document.
+     */
+    error: Error | null;
+    /**
+     * The value of the document.
+     */
+    value?: any;
+    /**
+     * @internal
+     */
+    constructor(data: {
+        value?: any;
+        error?: Error;
+    });
+}
+/**
+ * Contains the results of a transactional GetMultiReplicasFromPreferredServerGroup operation.
+ *
+ * @category Transactions
+ */
+export declare class TransactionGetMultiReplicasFromPreferredServerGroupResult {
+    /**
+     * @internal
+     */
+    constructor(data: {
+        content: TransactionGetMultiReplicasFromPreferredServerGroupResultEntry[];
+    });
+    /**
+     * The content of the document.
+     */
+    content: TransactionGetMultiReplicasFromPreferredServerGroupResultEntry[];
+    /**
+     * Indicates whether the document at the specified index exists.
+     *
+     * @param index The result index to check.
+     */
+    exists(index: number): boolean;
+    /**
+     * Provides the content at the specified index, if it exists.
+     *
+     * @param index The result index to check.
+     */
+    contentAt(index: number): any;
+}
 /**
  * Contains the results of a transactional Query operation.
  *
@@ -286,6 +475,33 @@ export interface TransactionGetOptions {
      */
     transcoder?: Transcoder;
 }
+/**
+ * @category Transactions
+ */
+export interface TransactionGetReplicaFromPreferredServerGroupOptions {
+    /**
+     * Specifies an explicit transcoder to use for this specific operation.
+     */
+    transcoder?: Transcoder;
+}
+/**
+ * @category Transactions
+ */
+export interface TransactionGetMultiOptions {
+    /**
+     * Specifies a mode to use for this specific operation.
+     */
+    mode?: TransactionGetMultiMode;
+}
+/**
+ * @category Transactions
+ */
+export interface TransactionGetMultiReplicasFromPreferredServerGroupOptions {
+    /**
+     * Specifies a mode to use for this specific operation.
+     */
+    mode?: TransactionGetMultiReplicasFromPreferredServerGroupMode;
+}
 /**
  * @category Transactions
  */
@@ -332,6 +548,28 @@ export declare class TransactionAttemptContext {
      * @param options Optional parameters for this operation.
      */
     get(collection: Collection, key: string, options?: TransactionGetOptions): Promise<TransactionGetResult>;
+    /**
+     * Retrieves the value of a document from the collection.
+     *
+     * @param collection The collection the document lives in.
+     * @param key The document key to retrieve.
+     * @param options Optional parameters for this operation.
+     */
+    getReplicaFromPreferredServerGroup(collection: Collection, key: string, options?: TransactionGetReplicaFromPreferredServerGroupOptions): Promise<TransactionGetResult>;
+    /**
+     * Retrieves the documents specified in the list of specs.
+     *
+     * @param specs The documents to retrieve.
+     * @param options Optional parameters for this operation.
+     */
+    getMultiReplicasFromPreferredServerGroup(specs: TransactionGetMultiReplicasFromPreferredServerGroupSpec[], options?: TransactionGetMultiReplicasFromPreferredServerGroupOptions): Promise<TransactionGetMultiReplicasFromPreferredServerGroupResult>;
+    /**
+     * Retrieves the documents specified in the list of specs.
+     *
+     * @param specs The documents to retrieve.
+     * @param options Optional parameters for this operation.
+     */
+    getMulti(specs: TransactionGetMultiSpec[], options?: TransactionGetMultiOptions): Promise<TransactionGetMultiResult>;
     /**
      * Inserts a new document to the collection, failing if the document already exists.
      *