chore: add interface

Author: durran

src/cmap/commands.ts

@@ -725,19 +725,24 @@ export class OpMsgResponse {
 const MESSAGE_HEADER_SIZE = 16;
 const COMPRESSION_DETAILS_SIZE = 9; // originalOpcode + uncompressedSize, compressorID
 
+/**
+ * @internal
+ */
+export interface OpCompressesRequestOptions {
+  zlibCompressionLevel: number;
+  agreedCompressor: CompressorName;
+}
+
 /**
  * @internal
  *
  * An OP_COMPRESSED request wraps either an OP_QUERY or OP_MSG message.
  */
 export class OpCompressedRequest {
   private command: WriteProtocolMessageType;
-  private options: { zlibCompressionLevel: number; agreedCompressor: CompressorName };
+  private options: OpCompressesRequestOptions;
 
-  constructor(
-    command: WriteProtocolMessageType,
-    options: { zlibCompressionLevel: number; agreedCompressor: CompressorName }
-  ) {
+  constructor(command: WriteProtocolMessageType, options: OpCompressesRequestOptions) {
     this.command = command;
     this.options = {
       zlibCompressionLevel: options.zlibCompressionLevel,

src/cmap/wire_protocol/compression.ts

@@ -7,6 +7,7 @@ import { MongoDecompressionError, MongoInvalidArgumentError } from '../../error'
 import {
   type MessageHeader,
   OpCompressedRequest,
+  type OpCompressesRequestOptions,
   OpMsgResponse,
   OpReply,
   type WriteProtocolMessageType
@@ -60,7 +61,7 @@ function loadSnappy() {
 
 // Facilitate compressing a message using an agreed compressor
 export async function compress(
-  options: { zlibCompressionLevel: number; agreedCompressor: CompressorName },
+  options: OpCompressesRequestOptions,
   dataToBeCompressed: Buffer
 ): Promise<Buffer> {
   const zlibOptions = {} as zlib.ZlibOptions;

src/index.ts

@@ -287,6 +287,7 @@ export type { TokenCache } from './cmap/auth/mongodb_oidc/token_cache';
 export type {
   MessageHeader,
   OpCompressedRequest,
+  OpCompressesRequestOptions,
   OpMsgOptions,
   OpMsgRequest,
   OpMsgResponse,