couchbase 4.4.3 → 4.4.5

package/dist/transcoders.d.ts

@@ -47,3 +47,71 @@ export declare class DefaultTranscoder implements Transcoder {
      */
     decode(bytes: Buffer, flags: number): any;
 }
+/**
+ * The raw binary transcoder provides an explicit mechanism for storing and retrieving raw
+ * byte data.
+ *
+ * @category Key-Value
+ */
+export declare class RawBinaryTranscoder implements Transcoder {
+    /**
+     * Encodes the specified value, returning a buffer and flags that are
+     * stored to the server and later used for decoding.
+     *
+     * @param value The value to encode.
+     */
+    encode(value: Buffer): [Buffer, number];
+    /**
+     * Decodes a buffer and flags tuple back to the original type of the
+     * document.
+     *
+     * @param bytes The bytes that were previously encoded.
+     * @param flags The flags associated with the data.
+     */
+    decode(bytes: Buffer, flags: number): any;
+}
+/**
+ * The raw string transcoder provides an explicit mechanism for storing and retrieving raw
+ * string data.
+ *
+ * @category Key-Value
+ */
+export declare class RawStringTranscoder implements Transcoder {
+    /**
+     * Encodes the specified value, returning a buffer and flags that are
+     * stored to the server and later used for decoding.
+     *
+     * @param value The value to encode.
+     */
+    encode(value: string): [Buffer, number];
+    /**
+     * Decodes a buffer and flags tuple back to the original type of the
+     * document.
+     *
+     * @param bytes The bytes that were previously encoded.
+     * @param flags The flags associated with the data.
+     */
+    decode(bytes: Buffer, flags: number): string;
+}
+/**
+ * The raw JSON transcoder provides an explicit mechanism for storing and retrieving JSON data.
+ *
+ * @category Key-Value
+ */
+export declare class RawJsonTranscoder implements Transcoder {
+    /**
+     * Encodes the specified value, returning a buffer and flags that are
+     * stored to the server and later used for decoding.
+     *
+     * @param value The value to encode.
+     */
+    encode(value: string): [Buffer, number];
+    /**
+     * Decodes a buffer and flags tuple back to the original type of the
+     * document.
+     *
+     * @param bytes The bytes that were previously encoded.
+     * @param flags The flags associated with the data.
+     */
+    decode(bytes: Buffer, flags: number): Buffer;
+}

package/dist/transcoders.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultTranscoder = void 0;
+exports.RawJsonTranscoder = exports.RawStringTranscoder = exports.RawBinaryTranscoder = exports.DefaultTranscoder = void 0;
 const NF_JSON = 0x00;
 const NF_RAW = 0x02;
 const NF_UTF8 = 0x04;
@@ -86,3 +86,196 @@ class DefaultTranscoder {
     }
 }
 exports.DefaultTranscoder = DefaultTranscoder;
+/**
+ * The raw binary transcoder provides an explicit mechanism for storing and retrieving raw
+ * byte data.
+ *
+ * @category Key-Value
+ */
+class RawBinaryTranscoder {
+    /**
+     * Encodes the specified value, returning a buffer and flags that are
+     * stored to the server and later used for decoding.
+     *
+     * @param value The value to encode.
+     */
+    encode(value) {
+        // If its a buffer, write that directly as raw.
+        if (Buffer.isBuffer(value)) {
+            return [value, CF_RAW | NF_RAW];
+        }
+        throw new Error('Only binary data supported by RawBinaryTranscoder.');
+    }
+    /**
+     * Decodes a buffer and flags tuple back to the original type of the
+     * document.
+     *
+     * @param bytes The bytes that were previously encoded.
+     * @param flags The flags associated with the data.
+     */
+    decode(bytes, flags) {
+        let format = flags & NF_MASK;
+        const cfformat = flags & CF_MASK;
+        if (cfformat !== CF_NONE) {
+            if (cfformat === CF_JSON) {
+                format = NF_JSON;
+            }
+            else if (cfformat === CF_RAW) {
+                format = NF_RAW;
+            }
+            else if (cfformat === CF_UTF8) {
+                format = NF_UTF8;
+            }
+            else if (cfformat !== CF_PRIVATE) {
+                // Unknown CF Format!  The following will force
+                //   fallback to reporting RAW data.
+                format = NF_UNKNOWN;
+            }
+        }
+        if (format === NF_RAW) {
+            return bytes;
+        }
+        else if (format === NF_UTF8) {
+            throw new Error('String format not supported by RawBinaryTranscoder.');
+        }
+        else if (format === NF_JSON) {
+            throw new Error('JSON format not supported by RawBinaryTranscoder.');
+        }
+        else if (format === NF_UNKNOWN) {
+            throw new Error('Unknown format not supported by RawBinaryTranscoder.');
+        }
+        else {
+            throw new Error(`Unrecognized format provided: ${format}.`);
+        }
+    }
+}
+exports.RawBinaryTranscoder = RawBinaryTranscoder;
+/**
+ * The raw string transcoder provides an explicit mechanism for storing and retrieving raw
+ * string data.
+ *
+ * @category Key-Value
+ */
+class RawStringTranscoder {
+    /**
+     * Encodes the specified value, returning a buffer and flags that are
+     * stored to the server and later used for decoding.
+     *
+     * @param value The value to encode.
+     */
+    encode(value) {
+        // If its a string, encode it as a UTF8 string.
+        if (typeof value === 'string') {
+            return [Buffer.from(value), CF_UTF8 | NF_UTF8];
+        }
+        throw new Error('Only string data supported by RawStringTranscoder.');
+    }
+    /**
+     * Decodes a buffer and flags tuple back to the original type of the
+     * document.
+     *
+     * @param bytes The bytes that were previously encoded.
+     * @param flags The flags associated with the data.
+     */
+    decode(bytes, flags) {
+        let format = flags & NF_MASK;
+        const cfformat = flags & CF_MASK;
+        if (cfformat !== CF_NONE) {
+            if (cfformat === CF_JSON) {
+                format = NF_JSON;
+            }
+            else if (cfformat === CF_RAW) {
+                format = NF_RAW;
+            }
+            else if (cfformat === CF_UTF8) {
+                format = NF_UTF8;
+            }
+            else if (cfformat !== CF_PRIVATE) {
+                // Unknown CF Format!  The following will force
+                //   fallback to reporting RAW data.
+                format = NF_UNKNOWN;
+            }
+        }
+        if (format === NF_UTF8) {
+            return bytes.toString('utf8');
+        }
+        else if (format === NF_RAW) {
+            throw new Error('Binary format not supported by RawStringTranscoder.');
+        }
+        else if (format === NF_JSON) {
+            throw new Error('JSON format not supported by RawStringTranscoder.');
+        }
+        else if (format === NF_UNKNOWN) {
+            throw new Error('Unknown format not supported by RawStringTranscoder.');
+        }
+        else {
+            throw new Error(`Unrecognized format provided: ${format}.`);
+        }
+    }
+}
+exports.RawStringTranscoder = RawStringTranscoder;
+/**
+ * The raw JSON transcoder provides an explicit mechanism for storing and retrieving JSON data.
+ *
+ * @category Key-Value
+ */
+class RawJsonTranscoder {
+    /**
+     * Encodes the specified value, returning a buffer and flags that are
+     * stored to the server and later used for decoding.
+     *
+     * @param value The value to encode.
+     */
+    encode(value) {
+        if (typeof value === 'string') {
+            return [Buffer.from(value), CF_JSON | NF_JSON];
+        }
+        if (Buffer.isBuffer(value)) {
+            return [value, CF_JSON | NF_JSON];
+        }
+        throw new Error('Only binary and string data supported by RawJsonTranscoder.');
+    }
+    /**
+     * Decodes a buffer and flags tuple back to the original type of the
+     * document.
+     *
+     * @param bytes The bytes that were previously encoded.
+     * @param flags The flags associated with the data.
+     */
+    decode(bytes, flags) {
+        let format = flags & NF_MASK;
+        const cfformat = flags & CF_MASK;
+        if (cfformat !== CF_NONE) {
+            if (cfformat === CF_JSON) {
+                format = NF_JSON;
+            }
+            else if (cfformat === CF_RAW) {
+                format = NF_RAW;
+            }
+            else if (cfformat === CF_UTF8) {
+                format = NF_UTF8;
+            }
+            else if (cfformat !== CF_PRIVATE) {
+                // Unknown CF Format!  The following will force
+                //   fallback to reporting RAW data.
+                format = NF_UNKNOWN;
+            }
+        }
+        if (format === NF_UTF8) {
+            throw new Error('string format not supported by RawJsonTranscoder.');
+        }
+        else if (format === NF_RAW) {
+            throw new Error('Binary format not supported by RawJsonTranscoder.');
+        }
+        else if (format === NF_JSON) {
+            return bytes;
+        }
+        else if (format === NF_UNKNOWN) {
+            throw new Error('Unknown format not supported by RawJsonTranscoder.');
+        }
+        else {
+            throw new Error(`Unrecognized format provided: ${format}.`);
+        }
+    }
+}
+exports.RawJsonTranscoder = RawJsonTranscoder;

package/dist/usermanager.d.ts

@@ -1,4 +1,5 @@
 import { Cluster } from './cluster';
+import { CppManagementRbacGroup, CppManagementRbacOrigin, CppManagementRbacRole, CppManagementRbacRoleAndDescription, CppManagementRbacRoleAndOrigins, CppManagementRbacUser, CppManagementRbacUserAndMetadata } from './binding';
 import { NodeCallback } from './utilities';
 /**
  * Contains information about an origin for a role.
@@ -13,7 +14,7 @@ export declare class Origin {
     /**
      * The name of this origin.
      */
-    name: string;
+    name?: string;
     /**
      * @internal
      */
@@ -21,7 +22,7 @@ export declare class Origin {
     /**
      * @internal
      */
-    static _fromNsData(data: any): Origin;
+    static _fromCppData(data: CppManagementRbacOrigin): Origin;
 }
 /**
  * Contains information about a role.
@@ -52,11 +53,11 @@ export declare class Role {
     /**
      * @internal
      */
-    static _fromNsData(data: any): Role;
+    static _fromCppData(data: CppManagementRbacRole): Role;
     /**
      * @internal
      */
-    static _toNsStr(role: string | Role): string;
+    static _toCppData(data: Role): CppManagementRbacRole;
 }
 /**
  * Contains information about a role along with its description.
@@ -79,7 +80,7 @@ export declare class RoleAndDescription extends Role {
     /**
      * @internal
      */
-    static _fromNsData(data: any): RoleAndDescription;
+    static _fromCppData(data: CppManagementRbacRoleAndDescription): RoleAndDescription;
 }
 /**
  * Contains information about a role along with its origin.
@@ -98,7 +99,7 @@ export declare class RoleAndOrigin extends Role {
     /**
      * @internal
      */
-    static _fromNsData(data: any): RoleAndOrigin;
+    static _fromCppData(data: CppManagementRbacRoleAndOrigins): RoleAndOrigin;
 }
 /**
  * Specifies information about a user.
@@ -140,7 +141,7 @@ export declare class User implements IUser {
     /**
      * The display name of the user.
      */
-    displayName: string;
+    displayName?: string;
     /**
      * The groups associated with this user.
      */
@@ -160,11 +161,11 @@ export declare class User implements IUser {
     /**
      * @internal
      */
-    static _fromNsData(data: any): User;
+    static _fromCppData(data: CppManagementRbacUser): User;
     /**
      * @internal
      */
-    static _toNsData(user: IUser): any;
+    static _toCppData(data: IUser): CppManagementRbacUser;
 }
 /**
  * Contains information about a user along with some additional meta-data
@@ -184,7 +185,7 @@ export declare class UserAndMetadata extends User {
     /**
      * The last time the users password was changed.
      */
-    passwordChanged: Date;
+    passwordChanged?: Date;
     /**
      * The external groups that this user is associated with.
      */
@@ -203,7 +204,7 @@ export declare class UserAndMetadata extends User {
     /**
      * @internal
      */
-    static _fromNsData(data: any): UserAndMetadata;
+    static _fromCppData(data: CppManagementRbacUserAndMetadata): UserAndMetadata;
 }
 /**
  * Specifies information about a group.
@@ -257,11 +258,11 @@ export declare class Group {
     /**
      * @internal
      */
-    static _fromNsData(data: any): Group;
+    static _fromCppData(data: CppManagementRbacGroup): Group;
     /**
      * @internal
      */
-    static _toNsData(group: IGroup): any;
+    static _toCppData(data: IGroup): CppManagementRbacGroup;
 }
 /**
  * @category Management
@@ -381,7 +382,6 @@ export declare class UserManager {
      * @internal
      */
     constructor(cluster: Cluster);
-    private get _http();
     /**
      * Returns a specific user by their username.
      *