couchbase 4.2.9 → 4.2.11-rc.1

package/dist/searchtypes.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchScanConsistency = exports.HighlightStyle = exports.SearchResult = exports.SearchRow = exports.SearchMetaData = void 0;
+exports.SearchRequest = exports.SearchScanConsistency = exports.HighlightStyle = exports.SearchResult = exports.SearchRow = exports.SearchMetaData = void 0;
+const errors_1 = require("./errors");
+const searchquery_1 = require("./searchquery");
+const vectorsearch_1 = require("./vectorsearch");
 /**
  * SearchMetaData represents the meta-data available from a search query.
  * This class is currently incomplete and must be casted to `any` in
@@ -67,3 +70,80 @@ var SearchScanConsistency;
      */
     SearchScanConsistency["NotBounded"] = "not_bounded";
 })(SearchScanConsistency || (exports.SearchScanConsistency = SearchScanConsistency = {}));
+/**
+ *  Represents a search query and/or vector search to execute via the Couchbase Full Text Search (FTS) service.
+ *
+ *  Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+class SearchRequest {
+    constructor(query) {
+        if (query instanceof searchquery_1.SearchQuery) {
+            this._searchQuery = query;
+        }
+        else if (query instanceof vectorsearch_1.VectorSearch) {
+            this._vectorSearch = query;
+        }
+        else {
+            throw new errors_1.InvalidArgumentError(new Error('Must provide either a SearchQuery or VectorSearch when creating SearchRequest.'));
+        }
+    }
+    /**
+     * @internal
+     */
+    get searchQuery() {
+        return this._searchQuery;
+    }
+    /**
+     * @internal
+     */
+    get vectorSearch() {
+        return this._vectorSearch;
+    }
+    /**
+     * Adds a search query to the request if the request does not already have a search query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query A SearchQuery to add to the request.
+     */
+    withSearchQuery(query) {
+        if (!(query instanceof searchquery_1.SearchQuery)) {
+            throw new errors_1.InvalidArgumentError(new Error('Must provide a SearchQuery.'));
+        }
+        if (this._searchQuery) {
+            throw new errors_1.InvalidArgumentError(new Error('Request already has a SearchQuery.'));
+        }
+        this._searchQuery = query;
+        return this;
+    }
+    /**
+     * Adds a vector search to the request if the request does not already have a vector search.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param search A VectorSearch to add to the request.
+     */
+    withVectorSearch(search) {
+        if (!(search instanceof vectorsearch_1.VectorSearch)) {
+            throw new errors_1.InvalidArgumentError(new Error('Must provide a VectorSearch.'));
+        }
+        if (this._vectorSearch) {
+            throw new errors_1.InvalidArgumentError(new Error('Request already has a VectorSearch.'));
+        }
+        this._vectorSearch = search;
+        return this;
+    }
+    /**
+     * Creates a search request.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query Either a SearchQuery or VectorSearch to add to the search request.
+     */
+    static create(query) {
+        return new SearchRequest(query);
+    }
+}
+exports.SearchRequest = SearchRequest;

package/dist/vectorsearch.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Specifies how multiple vector searches are combined.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export declare enum VectorQueryCombination {
+    /**
+     * Indicates that multiple vector queries should be combined with logical AND.
+     */
+    AND = "and",
+    /**
+     * Indicates that multiple vector queries should be combined with logical OR.
+     */
+    OR = "or"
+}
+/**
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export interface VectorSearchOptions {
+    /**
+     * Specifies how multiple vector queries should be combined.
+     */
+    vectorQueryCombination?: VectorQueryCombination;
+}
+/**
+ * Represents a vector query.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export declare class VectorQuery {
+    private _fieldName;
+    private _vector;
+    private _numCandidates;
+    private _boost;
+    constructor(fieldName: string, vector: number[]);
+    /**
+     * @internal
+     */
+    toJSON(): any;
+    /**
+     * Adds boost option to vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param boost A floating point value.
+     */
+    boost(boost: number): VectorQuery;
+    /**
+     * Adds numCandidates option to vector query. Value must be >= 1.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param numCandidates An integer value.
+     */
+    numCandidates(numCandidates: number): VectorQuery;
+    /**
+     * Creates a vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @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;
+}
+/**
+ * Represents a vector search.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export declare class VectorSearch {
+    private _queries;
+    private _options;
+    constructor(queries: VectorQuery[], options?: VectorSearchOptions);
+    /**
+     * @internal
+     */
+    get queries(): VectorQuery[];
+    /**
+     * @internal
+     */
+    get options(): VectorSearchOptions | undefined;
+    /**
+     * Creates a vector search.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query A vectory query that should be a part of the vector search.
+     */
+    static fromVectorQuery(query: VectorQuery): VectorSearch;
+}

package/dist/vectorsearch.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VectorSearch = exports.VectorQuery = exports.VectorQueryCombination = void 0;
+const errors_1 = require("./errors");
+/**
+ * Specifies how multiple vector searches are combined.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+var VectorQueryCombination;
+(function (VectorQueryCombination) {
+    /**
+     * Indicates that multiple vector queries should be combined with logical AND.
+     */
+    VectorQueryCombination["AND"] = "and";
+    /**
+     * Indicates that multiple vector queries should be combined with logical OR.
+     */
+    VectorQueryCombination["OR"] = "or";
+})(VectorQueryCombination || (exports.VectorQueryCombination = VectorQueryCombination = {}));
+/**
+ * Represents a vector query.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+class VectorQuery {
+    constructor(fieldName, vector) {
+        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.'));
+        }
+        this._vector = vector;
+    }
+    /**
+     * @internal
+     */
+    toJSON() {
+        var _a;
+        const output = {
+            field: this._fieldName,
+            vector: this._vector,
+            k: (_a = this._numCandidates) !== null && _a !== void 0 ? _a : 3,
+        };
+        if (this._boost) {
+            output['boost'] = this._boost;
+        }
+        return output;
+    }
+    /**
+     * Adds boost option to vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param boost A floating point value.
+     */
+    boost(boost) {
+        this._boost = boost;
+        return this;
+    }
+    /**
+     * Adds numCandidates option to vector query. Value must be >= 1.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param numCandidates An integer value.
+     */
+    numCandidates(numCandidates) {
+        if (numCandidates < 1) {
+            throw new errors_1.InvalidArgumentError(new Error('Provided value for numCandidates must be >= 1.'));
+        }
+        this._numCandidates = numCandidates;
+        return this;
+    }
+    /**
+     * Creates a vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @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, vector) {
+        return new VectorQuery(fieldName, vector);
+    }
+}
+exports.VectorQuery = VectorQuery;
+/**
+ * Represents a vector search.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+class VectorSearch {
+    constructor(queries, options) {
+        if (!Array.isArray(queries) || queries.length == 0) {
+            throw new errors_1.InvalidArgumentError(new Error('Provided queries must be an array and cannot be empty.'));
+        }
+        if (!queries.every((q) => q instanceof VectorQuery)) {
+            throw new errors_1.InvalidArgumentError(new Error('All provided queries must be a VectorQuery.'));
+        }
+        this._queries = queries;
+        this._options = options;
+    }
+    /**
+     * @internal
+     */
+    get queries() {
+        return this._queries;
+    }
+    /**
+     * @internal
+     */
+    get options() {
+        return this._options;
+    }
+    /**
+     * Creates a vector search.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query A vectory query that should be a part of the vector search.
+     */
+    static fromVectorQuery(query) {
+        return new VectorSearch([query]);
+    }
+}
+exports.VectorSearch = VectorSearch;

package/dist/viewexecutor.js

@@ -1,11 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ViewExecutor = void 0;
 /* eslint jsdoc/require-jsdoc: off */
-const binding_1 = __importDefault(require("./binding"));
 const bindingutilities_1 = require("./bindingutilities");
 const streamablepromises_1 = require("./streamablepromises");
 const viewtypes_1 = require("./viewtypes");
@@ -29,6 +25,7 @@ class ViewExecutor {
      * @internal
      */
     query(designDoc, viewName, options) {
+        var _a;
         const emitter = new streamablepromises_1.StreamableRowPromise((rows, meta) => {
             return new viewtypes_1.ViewResult({
                 rows: rows,
@@ -36,12 +33,18 @@ class ViewExecutor {
             });
         });
         const timeout = options.timeout || this._cluster.viewTimeout;
+        const raw = options.raw || {};
+        const ns = (_a = options.namespace) !== null && _a !== void 0 ? _a : viewtypes_1.DesignDocumentNamespace.Production;
+        let fullSet = options.full_set;
+        if (typeof options.fullSet !== 'undefined') {
+            fullSet = options.fullSet;
+        }
         this._cluster.conn.documentView({
             timeout: timeout,
             bucket_name: this._bucket.name,
             document_name: designDoc,
             view_name: viewName,
-            ns: binding_1.default.design_document_namespace.production,
+            ns: (0, bindingutilities_1.designDocumentNamespaceToCpp)(ns),
             limit: options.limit,
             skip: options.skip,
             consistency: (0, bindingutilities_1.viewScanConsistencyToCpp)(options.scanConsistency),
@@ -55,10 +58,10 @@ class ViewExecutor {
                 : undefined,
             inclusive_end: options.range ? options.range.inclusiveEnd : undefined,
             start_key_doc_id: options.idRange && options.idRange.start
-                ? JSON.stringify(options.idRange.start)
+                ? options.idRange.start
                 : undefined,
             end_key_doc_id: options.idRange && options.idRange.end
-                ? JSON.stringify(options.idRange.end)
+                ? options.idRange.end
                 : undefined,
             reduce: options.reduce,
             group: options.group,
@@ -66,7 +69,8 @@ class ViewExecutor {
             order: (0, bindingutilities_1.viewOrderingToCpp)(options.order),
             debug: false,
             query_string: [],
-            raw: {},
+            raw: raw,
+            full_set: fullSet,
         }, (cppErr, resp) => {
             const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
             if (err) {
@@ -78,7 +82,7 @@ class ViewExecutor {
                 emitter.emit('row', new viewtypes_1.ViewRow({
                     value: JSON.parse(row.value),
                     id: row.id,
-                    key: row.key,
+                    key: JSON.parse(row.key),
                 }));
             });
             {

package/dist/viewindexmanager.d.ts

@@ -1,5 +1,7 @@
 import { Bucket } from './bucket';
 import { NodeCallback } from './utilities';
+import { DesignDocumentNamespace } from './viewtypes';
+import { CppManagementViewsDesignDocument, CppManagementViewsDesignDocumentView } from './binding';
 /**
  * Contains information about a view in a design document.
  *
@@ -9,19 +11,27 @@ export declare class DesignDocumentView {
     /**
      * The mapping function to use for this view.
      */
-    map: string;
+    map: string | undefined;
     /**
      * The reduction function to use for this view.
      */
     reduce: string | undefined;
     constructor(data: {
-        map: string;
+        map?: string;
         reduce?: string;
     });
     /**
      * @deprecated
      */
-    constructor(map: string, reduce?: string);
+    constructor(map?: string, reduce?: string);
+    /**
+     * @internal
+     */
+    static _toCppData(name: string, data: DesignDocumentView): CppManagementViewsDesignDocumentView;
+    /**
+     * @internal
+     */
+    static _fromCppData(data: CppManagementViewsDesignDocumentView): DesignDocumentView;
 }
 /**
  * Contains information about a design document.
@@ -45,11 +55,21 @@ export declare class DesignDocument {
     views: {
         [viewName: string]: DesignDocumentView;
     };
+    /**
+     * The namespace for this design document.
+     */
+    namespace: DesignDocumentNamespace;
+    /**
+     * The revision of the design document.
+     */
+    rev: string | undefined;
     constructor(data: {
         name: string;
         views?: {
             [viewName: string]: DesignDocumentView;
         };
+        namespace?: DesignDocumentNamespace;
+        rev?: string;
     });
     /**
      * @deprecated
@@ -61,6 +81,14 @@ export declare class DesignDocument {
      * @internal
      */
     static _fromNsData(ddocName: string, ddocData: any): DesignDocument;
+    /**
+     * @internal
+     */
+    static _toCppData(data: DesignDocument, namespace: DesignDocumentNamespace): CppManagementViewsDesignDocument;
+    /**
+     * @internal
+     */
+    static _fromCppData(ddoc: CppManagementViewsDesignDocument): DesignDocument;
 }
 /**
  * @category Management
@@ -119,10 +147,6 @@ export declare class ViewIndexManager {
      * @internal
      */
     constructor(bucket: Bucket);
-    /**
-     * @internal
-     */
-    private get _http();
     /**
      * @internal
      */
@@ -132,32 +156,71 @@ export declare class ViewIndexManager {
      *
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
+     * @deprecated
      */
     getAllDesignDocuments(options?: GetAllDesignDocumentOptions, callback?: NodeCallback<DesignDocument[]>): Promise<DesignDocument[]>;
+    /**
+     * Returns a list of all the design documents in this bucket.
+     *
+     * @param namespace The DesignDocument namespace.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    getAllDesignDocuments(namespace: DesignDocumentNamespace, options?: GetAllDesignDocumentOptions, callback?: NodeCallback<DesignDocument[]>): Promise<DesignDocument[]>;
     /**
      * Returns the specified design document.
      *
      * @param designDocName The name of the design document to fetch.
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
+     * @deprecated
      */
     getDesignDocument(designDocName: string, options?: GetDesignDocumentOptions, callback?: NodeCallback<DesignDocument>): Promise<DesignDocument>;
+    /**
+     * Returns the specified design document.
+     *
+     * @param designDocName The name of the design document to fetch.
+     * @param namespace The DesignDocument namespace.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    getDesignDocument(designDocName: string, namespace: DesignDocumentNamespace, options?: GetDesignDocumentOptions, callback?: NodeCallback<DesignDocument>): Promise<DesignDocument>;
     /**
      * Creates or updates a design document.
      *
      * @param designDoc The DesignDocument to upsert.
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
+     * @deprecated
      */
     upsertDesignDocument(designDoc: DesignDocument, options?: UpsertDesignDocumentOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Creates or updates a design document.
+     *
+     * @param designDoc The DesignDocument to upsert.
+     * @param namespace The DesignDocument namespace.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    upsertDesignDocument(designDoc: DesignDocument, namespace?: DesignDocumentNamespace, options?: UpsertDesignDocumentOptions, callback?: NodeCallback<void>): Promise<void>;
     /**
      * Drops an existing design document.
      *
      * @param designDocName The name of the design document to drop.
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
+     * @deprecated
      */
     dropDesignDocument(designDocName: string, options?: DropDesignDocumentOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Drops an existing design document.
+     *
+     * @param designDocName The name of the design document to drop.
+     * @param namespace The DesignDocument namespace.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    dropDesignDocument(designDocName: string, namespace: DesignDocumentNamespace, options?: DropDesignDocumentOptions, callback?: NodeCallback<void>): Promise<void>;
     /**
      * Publishes a development design document to be a production design document.
      * It does this by fetching the design document by the passed name with `dev_`