couchbase 4.2.1 → 4.2.2

package/deps/couchbase-cxx-client/tools/version.hxx

@@ -0,0 +1,26 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#include "command.hxx"
+
+namespace cbc
+{
+class version : public command
+{
+    void execute(const std::vector<std::string>& argv);
+};
+} // namespace cbc

package/dist/authenticators.d.ts

@@ -51,7 +51,7 @@ export declare class PasswordAuthenticator implements IPasswordAuthenticator {
     /**
      * The sasl mechanisms to authenticate with.
      */
-    allowed_sasl_mechanisms?: string[];
+    allowed_sasl_mechanisms?: string[] | undefined;
     /**
      * Constructs this PasswordAuthenticator with the passed username and password.
      *
@@ -61,7 +61,7 @@ export declare class PasswordAuthenticator implements IPasswordAuthenticator {
     constructor(username: string, password: string);
     /**
      * Creates a LDAP compatible password authenticator which is INSECURE if not used with TLS.
-     * <p>
+     *
      * Please note that this is INSECURE and will leak user credentials on the wire to eavesdroppers.
      * This should only be enabled in trusted environments.
      *

package/dist/authenticators.js

@@ -16,11 +16,10 @@ class PasswordAuthenticator {
     constructor(username, password) {
         this.username = username;
         this.password = password;
-        this.allowed_sasl_mechanisms = ['SCRAM-SHA512', 'SCRAM-SHA256', 'SCRAM-SHA1'];
     }
     /**
      * Creates a LDAP compatible password authenticator which is INSECURE if not used with TLS.
-     * <p>
+     *
      * Please note that this is INSECURE and will leak user credentials on the wire to eavesdroppers.
      * This should only be enabled in trusted environments.
      *

package/dist/binding.d.ts

@@ -5,6 +5,18 @@ export declare type CppBytes = string | Buffer;
 export declare type CppDocFlags = number;
 export declare type CppExpiry = number;
 export declare type CppJsonString = string | Buffer;
+export interface CppClusterCredentials {
+    username?: string;
+    password?: string;
+    certificate_path?: string;
+    key_path?: string;
+    allowed_sasl_mechanisms?: string[];
+}
+export interface CppDnsConfig {
+    nameserver?: string;
+    port?: number;
+    dnsSrvTimeout?: number;
+}
 export interface CppDocumentId {
     bucket: string;
     scope: string;
@@ -20,6 +32,10 @@ export interface CppMutationToken {
     toString(): string;
     toJSON(): any;
 }
+export interface CppQueryContext {
+    bucket_name: string;
+    scope_name: string;
+}
 export declare enum CppManagementAnalyticsCouchbaseLinkEncryptionLevel {
 }
 export declare enum CppManagementClusterBucketType {
@@ -568,9 +584,7 @@ export interface CppQueryRequest {
     pipeline_cap?: number;
     scan_consistency?: CppQueryScanConsistency;
     mutation_state: CppMutationToken[];
-    bucket_name?: string;
-    scope_name?: string;
-    scope_qualifier?: string;
+    query_context?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
     profile: CppQueryProfile;
@@ -1046,6 +1060,7 @@ export interface CppManagementQueryIndexGetAllRequest {
     bucket_name: string;
     scope_name: string;
     collection_name: string;
+    query_ctx: CppQueryContext;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1097,6 +1112,7 @@ export interface CppManagementQueryIndexBuildDeferredRequest {
     bucket_name: string;
     scope_name?: string;
     collection_name?: string;
+    query_ctx: CppQueryContext;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1158,6 +1174,7 @@ export interface CppManagementQueryIndexDropRequest {
     scope_name: string;
     collection_name: string;
     index_name: string;
+    query_ctx: CppQueryContext;
     is_primary: boolean;
     ignore_if_does_not_exist: boolean;
     client_context_id?: string;
@@ -1209,6 +1226,7 @@ export interface CppManagementQueryIndexCreateRequest {
     collection_name: string;
     index_name: string;
     fields: string[];
+    query_ctx: CppQueryContext;
     is_primary: boolean;
     ignore_if_exists: boolean;
     condition?: string;
@@ -1296,6 +1314,13 @@ export interface CppManagementCollectionsManifestGetRequest {
     opaque: number;
     timeout?: CppMilliseconds;
 }
+export interface CppManagementChangePasswordResponse {
+}
+export interface CppManagementChangePasswordRequest {
+    newPassword: string;
+    client_context_id?: string;
+    timeout?: CppMilliseconds;
+}
 export interface CppManagementClusterDeveloperPreviewEnableResponse {
 }
 export interface CppManagementClusterDeveloperPreviewEnableRequest {
@@ -1700,6 +1725,7 @@ export interface CppManagementQueryIndexGetAllDeferredRequest {
     bucket_name: string;
     scope_name: string;
     collection_name: string;
+    query_ctx: CppQueryContext;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1715,6 +1741,7 @@ export interface CppManagementQueryIndexBuildRequest {
     bucket_name: string;
     scope_name: string;
     collection_name: string;
+    query_ctx: CppQueryContext;
     index_names: string[];
     client_context_id?: string;
     timeout?: CppMilliseconds;
@@ -1890,6 +1917,7 @@ export interface CppConnectionAutogen {
     managementAnalyticsDataverseDrop(options: CppManagementAnalyticsDataverseDropRequest, callback: (err: CppError | null, result: CppManagementAnalyticsDataverseDropResponse) => void): void;
     managementAnalyticsLinkConnect(options: CppManagementAnalyticsLinkConnectRequest, callback: (err: CppError | null, result: CppManagementAnalyticsLinkConnectResponse) => void): void;
     managementCollectionsManifestGet(options: CppManagementCollectionsManifestGetRequest, callback: (err: CppError | null, result: CppManagementCollectionsManifestGetResponse) => void): void;
+    managementChangePassword(options: CppManagementChangePasswordRequest, callback: (err: CppError | null, result: CppManagementChangePasswordResponse) => void): void;
     managementClusterDeveloperPreviewEnable(options: CppManagementClusterDeveloperPreviewEnableRequest, callback: (err: CppError | null, result: CppManagementClusterDeveloperPreviewEnableResponse) => void): void;
     managementAnalyticsLinkDrop(options: CppManagementAnalyticsLinkDropRequest, callback: (err: CppError | null, result: CppManagementAnalyticsLinkDropResponse) => void): void;
     managementBucketDescribe(options: CppManagementBucketDescribeRequest, callback: (err: CppError | null, result: CppManagementBucketDescribeResponse) => void): void;
@@ -2486,17 +2514,7 @@ export interface CppTxnError extends CppErrorBase {
 }
 export declare type CppError = CppGenericError | CppKeyValueError | CppViewError | CppQueryError | CppSearchError | CppAnalyticsError | CppHttpError | CppTxnOperationFailed | CppTxnError;
 export interface CppConnection extends CppConnectionAutogen {
-    connect(connStr: string, credentials: {
-        username?: string;
-        password?: string;
-        certificate_path?: string;
-        key_path?: string;
-        allowed_sasl_mechanisms?: string[];
-    }, dnsOptions: {
-        nameserver?: string;
-        port?: number;
-        dnsSrvTimeout?: number;
-    } | null, callback: (err: CppError | null) => void): void;
+    connect(connStr: string, credentials: CppClusterCredentials, dnsOptions: CppDnsConfig | null, callback: (err: CppError | null) => void): void;
     shutdown(callback: (err: CppError | null) => void): void;
     openBucket(bucketName: string, callback: (err: CppError | null) => void): void;
     diagnostics(options: {
@@ -2627,8 +2645,6 @@ export interface CppTransaction {
         named_parameters?: {
             [key: string]: CppJsonString;
         };
-        bucket_name?: string;
-        scope_name?: string;
     }, callback: (err: CppError | null, resp: CppQueryResponse | null) => void): void;
     commit(callback: (err: CppError | null, resp: CppTransactionResult) => void): void;
     rollback(callback: (err: CppError | null) => void): void;

package/dist/cluster.js

@@ -356,13 +356,20 @@ class Cluster {
             dsnObj.options.user_agent_extra = (0, utilities_internal_1.generateClientString)();
             dsnObj.options.trust_certificate = this._trustStorePath;
             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");
@@ -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/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.
      *