123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240 |
- "use strict";
- Object.defineProperty(exports, "__esModule", { value: true });
- exports.Binary = void 0;
- var buffer_1 = require("buffer");
- var ensure_buffer_1 = require("./ensure_buffer");
- var uuid_utils_1 = require("./uuid_utils");
- var uuid_1 = require("./uuid");
- var error_1 = require("./error");
- /**
- * A class representation of the BSON Binary type.
- * @public
- * @category BSONType
- */
- var Binary = /** @class */ (function () {
- /**
- * @param buffer - a buffer object containing the binary data.
- * @param subType - the option binary type.
- */
- function Binary(buffer, subType) {
- if (!(this instanceof Binary))
- return new Binary(buffer, subType);
- if (!(buffer == null) &&
- !(typeof buffer === 'string') &&
- !ArrayBuffer.isView(buffer) &&
- !(buffer instanceof ArrayBuffer) &&
- !Array.isArray(buffer)) {
- throw new error_1.BSONTypeError('Binary can only be constructed from string, Buffer, TypedArray, or Array<number>');
- }
- this.sub_type = subType !== null && subType !== void 0 ? subType : Binary.BSON_BINARY_SUBTYPE_DEFAULT;
- if (buffer == null) {
- // create an empty binary buffer
- this.buffer = buffer_1.Buffer.alloc(Binary.BUFFER_SIZE);
- this.position = 0;
- }
- else {
- if (typeof buffer === 'string') {
- // string
- this.buffer = buffer_1.Buffer.from(buffer, 'binary');
- }
- else if (Array.isArray(buffer)) {
- // number[]
- this.buffer = buffer_1.Buffer.from(buffer);
- }
- else {
- // Buffer | TypedArray | ArrayBuffer
- this.buffer = ensure_buffer_1.ensureBuffer(buffer);
- }
- this.position = this.buffer.byteLength;
- }
- }
- /**
- * Updates this binary with byte_value.
- *
- * @param byteValue - a single byte we wish to write.
- */
- Binary.prototype.put = function (byteValue) {
- // If it's a string and a has more than one character throw an error
- if (typeof byteValue === 'string' && byteValue.length !== 1) {
- throw new error_1.BSONTypeError('only accepts single character String');
- }
- else if (typeof byteValue !== 'number' && byteValue.length !== 1)
- throw new error_1.BSONTypeError('only accepts single character Uint8Array or Array');
- // Decode the byte value once
- var decodedByte;
- if (typeof byteValue === 'string') {
- decodedByte = byteValue.charCodeAt(0);
- }
- else if (typeof byteValue === 'number') {
- decodedByte = byteValue;
- }
- else {
- decodedByte = byteValue[0];
- }
- if (decodedByte < 0 || decodedByte > 255) {
- throw new error_1.BSONTypeError('only accepts number in a valid unsigned byte range 0-255');
- }
- if (this.buffer.length > this.position) {
- this.buffer[this.position++] = decodedByte;
- }
- else {
- var buffer = buffer_1.Buffer.alloc(Binary.BUFFER_SIZE + this.buffer.length);
- // Combine the two buffers together
- this.buffer.copy(buffer, 0, 0, this.buffer.length);
- this.buffer = buffer;
- this.buffer[this.position++] = decodedByte;
- }
- };
- /**
- * Writes a buffer or string to the binary.
- *
- * @param sequence - a string or buffer to be written to the Binary BSON object.
- * @param offset - specify the binary of where to write the content.
- */
- Binary.prototype.write = function (sequence, offset) {
- offset = typeof offset === 'number' ? offset : this.position;
- // If the buffer is to small let's extend the buffer
- if (this.buffer.length < offset + sequence.length) {
- var buffer = buffer_1.Buffer.alloc(this.buffer.length + sequence.length);
- this.buffer.copy(buffer, 0, 0, this.buffer.length);
- // Assign the new buffer
- this.buffer = buffer;
- }
- if (ArrayBuffer.isView(sequence)) {
- this.buffer.set(ensure_buffer_1.ensureBuffer(sequence), offset);
- this.position =
- offset + sequence.byteLength > this.position ? offset + sequence.length : this.position;
- }
- else if (typeof sequence === 'string') {
- this.buffer.write(sequence, offset, sequence.length, 'binary');
- this.position =
- offset + sequence.length > this.position ? offset + sequence.length : this.position;
- }
- };
- /**
- * Reads **length** bytes starting at **position**.
- *
- * @param position - read from the given position in the Binary.
- * @param length - the number of bytes to read.
- */
- Binary.prototype.read = function (position, length) {
- length = length && length > 0 ? length : this.position;
- // Let's return the data based on the type we have
- return this.buffer.slice(position, position + length);
- };
- /**
- * Returns the value of this binary as a string.
- * @param asRaw - Will skip converting to a string
- * @remarks
- * This is handy when calling this function conditionally for some key value pairs and not others
- */
- Binary.prototype.value = function (asRaw) {
- asRaw = !!asRaw;
- // Optimize to serialize for the situation where the data == size of buffer
- if (asRaw && this.buffer.length === this.position) {
- return this.buffer;
- }
- // If it's a node.js buffer object
- if (asRaw) {
- return this.buffer.slice(0, this.position);
- }
- return this.buffer.toString('binary', 0, this.position);
- };
- /** the length of the binary sequence */
- Binary.prototype.length = function () {
- return this.position;
- };
- Binary.prototype.toJSON = function () {
- return this.buffer.toString('base64');
- };
- Binary.prototype.toString = function (format) {
- return this.buffer.toString(format);
- };
- /** @internal */
- Binary.prototype.toExtendedJSON = function (options) {
- options = options || {};
- var base64String = this.buffer.toString('base64');
- var subType = Number(this.sub_type).toString(16);
- if (options.legacy) {
- return {
- $binary: base64String,
- $type: subType.length === 1 ? '0' + subType : subType
- };
- }
- return {
- $binary: {
- base64: base64String,
- subType: subType.length === 1 ? '0' + subType : subType
- }
- };
- };
- Binary.prototype.toUUID = function () {
- if (this.sub_type === Binary.SUBTYPE_UUID) {
- return new uuid_1.UUID(this.buffer.slice(0, this.position));
- }
- throw new error_1.BSONError("Binary sub_type \"" + this.sub_type + "\" is not supported for converting to UUID. Only \"" + Binary.SUBTYPE_UUID + "\" is currently supported.");
- };
- /** @internal */
- Binary.fromExtendedJSON = function (doc, options) {
- options = options || {};
- var data;
- var type;
- if ('$binary' in doc) {
- if (options.legacy && typeof doc.$binary === 'string' && '$type' in doc) {
- type = doc.$type ? parseInt(doc.$type, 16) : 0;
- data = buffer_1.Buffer.from(doc.$binary, 'base64');
- }
- else {
- if (typeof doc.$binary !== 'string') {
- type = doc.$binary.subType ? parseInt(doc.$binary.subType, 16) : 0;
- data = buffer_1.Buffer.from(doc.$binary.base64, 'base64');
- }
- }
- }
- else if ('$uuid' in doc) {
- type = 4;
- data = uuid_utils_1.uuidHexStringToBuffer(doc.$uuid);
- }
- if (!data) {
- throw new error_1.BSONTypeError("Unexpected Binary Extended JSON format " + JSON.stringify(doc));
- }
- return new Binary(data, type);
- };
- /** @internal */
- Binary.prototype[Symbol.for('nodejs.util.inspect.custom')] = function () {
- return this.inspect();
- };
- Binary.prototype.inspect = function () {
- var asBuffer = this.value(true);
- return "new Binary(Buffer.from(\"" + asBuffer.toString('hex') + "\", \"hex\"), " + this.sub_type + ")";
- };
- /**
- * Binary default subtype
- * @internal
- */
- Binary.BSON_BINARY_SUBTYPE_DEFAULT = 0;
- /** Initial buffer default size */
- Binary.BUFFER_SIZE = 256;
- /** Default BSON type */
- Binary.SUBTYPE_DEFAULT = 0;
- /** Function BSON type */
- Binary.SUBTYPE_FUNCTION = 1;
- /** Byte Array BSON type */
- Binary.SUBTYPE_BYTE_ARRAY = 2;
- /** Deprecated UUID BSON type @deprecated Please use SUBTYPE_UUID */
- Binary.SUBTYPE_UUID_OLD = 3;
- /** UUID BSON type */
- Binary.SUBTYPE_UUID = 4;
- /** MD5 BSON type */
- Binary.SUBTYPE_MD5 = 5;
- /** Encrypted BSON type */
- Binary.SUBTYPE_ENCRYPTED = 6;
- /** Column BSON type */
- Binary.SUBTYPE_COLUMN = 7;
- /** User BSON type */
- Binary.SUBTYPE_USER_DEFINED = 128;
- return Binary;
- }());
- exports.Binary = Binary;
- Object.defineProperty(Binary.prototype, '_bsontype', { value: 'Binary' });
- //# sourceMappingURL=binary.js.map
|