@azure/event-hubs 5.13.0-alpha.20240729.1 → 5.13.0-alpha.20240730.2

package/dist/commonjs/eventData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventData.js","sourceRoot":"","sources":["../../src/eventData.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAmLlC,0CA8EC;AAQD,sCA2DC;AA2HD,wDAKC;AAyDD,oFA6BC;AAxhBD,gDAAmE;AACnE,6DAAyE;AACzE,+CAKsB;AACtB,gDAAwF;AACxF,sDAG6B;AA+I7B,MAAM,oBAAoB,GAAG;IAC3B,UAAU,EAAE,WAAW;IACvB,OAAO,EAAE,QAAQ;IACjB,EAAE,EAAE,IAAI;IACR,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,SAAS;IACnB,cAAc,EAAE,eAAe;IAC/B,YAAY,EAAE,aAAa;IAC3B,gBAAgB,EAAE,iBAAiB;IACnC,oBAAoB,EAAE,oBAAoB;IAC1C,aAAa,EAAE,cAAc;IAC7B,QAAQ,EAAE,SAAS;IACnB,cAAc,EAAE,eAAe;IAC/B,iBAAiB,EAAE,gBAAgB;CAC3B,CAAC;AAEX;;;;;GAKG;AACH,SAAgB,eAAe,CAC7B,GAAgB,EAChB,qBAA8B;IAE9B,MAAM,UAAU,GAAG,gCAAoB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC7D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,2CAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IAC1F,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAE/B,MAAM,IAAI,GAAsB;QAC9B,IAAI;QACJ,iBAAiB;YACf,OAAO,UAAU,CAAC;QACpB,CAAC;KACF,CAAC;IAEF,IAAI,GAAG,CAAC,mBAAmB,EAAE,CAAC;QAC5B,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACjE,QAAQ,aAAa,EAAE,CAAC;gBACtB,KAAK,qBAAS,CAAC,YAAY;oBACzB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;oBAC3D,MAAM;gBACR,KAAK,qBAAS,CAAC,cAAc;oBAC3B,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;oBAC7D,MAAM;gBACR,KAAK,qBAAS,CAAC,YAAY;oBACzB,IAAI,CAAC,eAAe,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;oBACxE,MAAM;gBACR,KAAK,qBAAS,CAAC,MAAM;oBACnB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;oBACrD,MAAM;gBACR;oBACE,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBAC3B,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;oBAC7B,CAAC;oBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,GAAG,qBAAqB,CAC1D,GAAG,CAAC,mBAAmB,CAAC,aAAa,CAAC,CACvC,CAAC;oBACF,MAAM;YACV,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,GAAG,CAAC,sBAAsB,EAAE,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,GAAG,CAAC,oBAAoB,EAAE,CAAC;QAC7B,IAAI,CAAC,kBAAkB,GAAG,GAAG,CAAC,oBAAoB,CAAC,oBAAoB,CAAC;QACxE,IAAI,CAAC,kBAAkB,GAAG,GAAG,CAAC,oBAAoB,CAAC,6BAA6B,CAAC;QACjF,IAAI,CAAC,gBAAgB,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,sBAAgC,CAAC,CAAC;QAC5F,IAAI,CAAC,aAAa,GAAG,IAAI,IAAI,CAC3B,GAAG,CAAC,oBAAoB,CAAC,+BAAyC,CACnE,CAAC;IACJ,CAAC;IAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAEzD,CAAC;IACF,KAAK,MAAM,eAAe,IAAI,iBAAiB,EAAE,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,IAAI,GAAG,CAAC,eAAe,CAAC,IAAI,IAAI,EAAE,CAAC;YACjC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC,GAAG,qBAAqB,CAClF,GAAG,CAAC,eAAe,CAAC,CACrB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,GAAG,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,YAAY,CAAC;IACtC,CAAC;IACD,IAAI,GAAG,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,cAAc,CAAC;IAC1C,CAAC;IACD,IAAI,GAAG,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC;IAClC,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,IAAsC,EACtC,YAAqB;;IAErB,IAAI,WAAwB,CAAC;IAC7B,IAAI,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;QACjC,WAAW,mCACN,gCAAoB,CAAC,aAAa,CAAC,IAAI,CAAC,KAC3C,IAAI,EAAE,2CAAsB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,MAAM,CAAC,GACxE,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,IAAI,QAAQ,GAAc,MAAM,CAAC;QACjC,IAAI,OAAQ,IAA0B,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;YACxE;;;cAGE;YACF,QAAQ,GAAG,MAAC,IAA0B,CAAC,iBAAiB,EAAE,CAAC,QAAQ,mCAAI,MAAM,CAAC;QAChF,CAAC;QAED,WAAW,GAAG;YACZ,IAAI,EAAE,2CAAsB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;SACzD,CAAC;QACF,kGAAkG;QAClG,2FAA2F;QAC3F,WAAW,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAErC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,WAAW,CAAC,sBAAsB,GAAG,IAAI,CAAC,UAAU,CAAC;QACvD,CAAC;QAED,IAAI,IAAA,qBAAS,EAAC,YAAY,CAAC,EAAE,CAAC;YAC5B,WAAW,CAAC,mBAAmB,CAAC,qBAAS,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;YACvE,6FAA6F;YAC7F,8FAA8F;YAC9F,6EAA6E;YAC7E,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;QAC7B,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;YAC7B,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QAC9C,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE,CAAC;YAC/B,WAAW,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC;QAClD,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC3B,IACE,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ;gBAClC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,qBAAS,CAAC,kBAAkB,EACpD,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,sEAAsE,qBAAS,CAAC,kBAAkB,cAAc,CACjH,CAAC;YACJ,CAAC;YACD,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAwHD;;GAEG;AACH,SAAgB,sBAAsB,CAAC,QAAiB;IACtD,OAAO,CACL,IAAA,kCAAsB,EAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACtD,CAAC,IAAA,6BAAiB,EAAC,QAAQ,EAAE,mBAAmB,CAAC,CAClD,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,qBAAqB,CAAc,KAAQ;IAClD,YAAY;IACZ,IAAI,CAAC,IAAA,qBAAS,EAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEpC,2DAA2D;IAC3D,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,IAAA,6BAAiB,EAAC,KAAK,EAAE,SAAS,CAAC;QACnC,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU,EACnC,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAED;;;MAGE;IACF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,qBAAqB,CAAiB,CAAC;IAC1D,CAAC;IAED;;;MAGE;IACF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAA,qBAAS,EAAS,KAAK,CAAC,EAAE,CAAC;QAC1D,MAAM,gBAAgB,qBAAQ,KAAK,CAAE,CAAC;QACtC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC/C,gBAAwB,CAAC,GAAG,CAAC,GAAG,qBAAqB,CAAE,gBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAYD;;;GAGG;AACH,SAAgB,oCAAoC,CAClD,WAAwB,EACxB,EACE,6BAA6B,EAC7B,UAAU,EACV,eAAe,EACf,qBAAqB,GAC0B;IAEjD,IAAI,CAAC,6BAA6B,EAAE,CAAC;QACnC,OAAO;IACT,CAAC;IAED,MAAM,kBAAkB,GAAG,WAAW,CAAC,mBAAmB,IAAI,EAAE,CAAC;IACjE,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC;QACrC,WAAW,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;IACvD,CAAC;IAED,IAAI,IAAA,qBAAS,EAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,kBAAkB,CAAC,kDAAmC,CAAC,KAAK,CAAC,GAAG,oBAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAC/F,CAAC;IACD,IAAI,IAAA,qBAAS,EAAC,eAAe,CAAC,EAAE,CAAC;QAC/B,kBAAkB,CAAC,kDAAmC,CAAC,UAAU,CAAC;YAChE,oBAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,IAAA,qBAAS,EAAC,qBAAqB,CAAC,EAAE,CAAC;QACrC,kBAAkB,CAAC,kDAAmC,CAAC,sBAAsB,CAAC;YAC5E,oBAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AmqpAnnotatedMessage, Constants } from \"@azure/core-amqp\";\nimport { BodyTypes, defaultDataTransformer } from \"./dataTransformer.js\";\nimport {\n  DeliveryAnnotations,\n  MessageAnnotations,\n  Message as RheaMessage,\n  types,\n} from \"rhea-promise\";\nimport { isDefined, isObjectWithProperties, objectHasProperty } from \"@azure/core-util\";\nimport {\n  idempotentProducerAmqpPropertyNames,\n  PENDING_PUBLISH_SEQ_NUM_SYMBOL,\n} from \"./util/constants.js\";\n\n/**\n * Describes the delivery annotations.\n * @internal\n */\nexport interface EventHubDeliveryAnnotations extends DeliveryAnnotations {\n  /**\n   * The offset of the last event.\n   */\n  last_enqueued_offset?: string;\n  /**\n   * The sequence number of the last event.\n   */\n  last_enqueued_sequence_number?: number;\n  /**\n   * The enqueued time of the last event.\n   */\n  last_enqueued_time_utc?: number;\n  /**\n   * The retrieval time of the last event.\n   */\n  runtime_info_retrieval_time_utc?: number;\n  /**\n   * Any unknown delivery annotations.\n   */\n  [x: string]: any;\n}\n\n/**\n * Map containing message attributes that will be held in the message header.\n * @internal\n */\nexport interface EventHubMessageAnnotations extends MessageAnnotations {\n  /**\n   * Annotation for the partition key set for the event.\n   */\n  \"x-opt-partition-key\"?: string | null;\n  /**\n   * Annotation for the sequence number of the event.\n   */\n  \"x-opt-sequence-number\"?: number;\n  /**\n   * Annotation for the enqueued time of the event.\n   */\n  \"x-opt-enqueued-time\"?: number;\n  /**\n   * Annotation for the offset of the event.\n   */\n  \"x-opt-offset\"?: string;\n  /**\n   * Any other annotation that can be added to the message.\n   */\n  [x: string]: any;\n}\n\n/**\n * Describes the structure of an event to be sent or received from the EventHub.\n * @internal\n */\nexport interface EventDataInternal {\n  /**\n   * The message body that needs to be sent or is received.\n   */\n  body: any;\n  /**\n   * The enqueued time of the event.\n   */\n  enqueuedTimeUtc?: Date;\n  /**\n   * If specified EventHub will hash this to a partitionId.\n   * It guarantees that messages end up in a specific partition on the event hub.\n   */\n  partitionKey?: string | null;\n  /**\n   * The offset of the event.\n   */\n  offset?: string;\n  /**\n   * The sequence number of the event.\n   */\n  sequenceNumber?: number;\n  /**\n   * The application specific properties.\n   */\n  properties?: { [property: string]: any };\n  /**\n   * The last sequence number of the event within the partition stream of the Event Hub.\n   */\n  lastSequenceNumber?: number;\n  /**\n   * The offset of the last enqueued event.\n   */\n  lastEnqueuedOffset?: string;\n  /**\n   * The enqueued UTC time of the last event.\n   */\n  lastEnqueuedTime?: Date;\n  /**\n   * The time when the runtime info was retrieved\n   */\n  retrievalTime?: Date;\n  /**\n   * The properties set by the service.\n   */\n  systemProperties?: { [property: string]: any };\n  /**\n   * The content type of the message. Optionally describes\n   * the payload of the message, with a descriptor following the format of RFC2045, Section 5, for\n   * example \"application/json\".\n   */\n  contentType?: string;\n\n  /**\n   * The correlation identifier that allows an\n   * application to specify a context for the message for the purposes of correlation, for example\n   * reflecting the MessageId of a message that is being replied to.\n   */\n  correlationId?: string | number | Buffer;\n\n  /**\n   * The message identifier is an\n   * application-defined value that uniquely identifies the message and its payload.\n   *\n   * Note: Numbers that are not whole integers are not allowed.\n   */\n  messageId?: string | number | Buffer;\n  /**\n   * Returns the underlying raw amqp message.\n   */\n  getRawAmqpMessage(): AmqpAnnotatedMessage;\n  /**\n   * The pending publish sequence number, set while the event\n   * is being published with idempotent partitions enabled.\n   */\n  [PENDING_PUBLISH_SEQ_NUM_SYMBOL]?: number;\n  /**\n   * The sequence number the event was published with\n   * when idempotent partitions are enabled.\n   */\n  _publishedSequenceNumber?: number;\n}\n\nconst messagePropertiesMap = {\n  message_id: \"messageId\",\n  user_id: \"userId\",\n  to: \"to\",\n  subject: \"subject\",\n  reply_to: \"replyTo\",\n  correlation_id: \"correlationId\",\n  content_type: \"contentType\",\n  content_encoding: \"contentEncoding\",\n  absolute_expiry_time: \"absoluteExpiryTime\",\n  creation_time: \"creationTime\",\n  group_id: \"groupId\",\n  group_sequence: \"groupSequence\",\n  reply_to_group_id: \"replyToGroupId\",\n} as const;\n\n/**\n * Converts the AMQP message to an EventData.\n * @param msg - The AMQP message that needs to be converted to EventData.\n * @param skipParsingBodyAsJson - Boolean to skip running JSON.parse() on message body when body type is `content`.\n * @internal\n */\nexport function fromRheaMessage(\n  msg: RheaMessage,\n  skipParsingBodyAsJson: boolean,\n): EventDataInternal {\n  const rawMessage = AmqpAnnotatedMessage.fromRheaMessage(msg);\n  const { body, bodyType } = defaultDataTransformer.decode(msg.body, skipParsingBodyAsJson);\n  rawMessage.bodyType = bodyType;\n\n  const data: EventDataInternal = {\n    body,\n    getRawAmqpMessage() {\n      return rawMessage;\n    },\n  };\n\n  if (msg.message_annotations) {\n    for (const annotationKey of Object.keys(msg.message_annotations)) {\n      switch (annotationKey) {\n        case Constants.partitionKey:\n          data.partitionKey = msg.message_annotations[annotationKey];\n          break;\n        case Constants.sequenceNumber:\n          data.sequenceNumber = msg.message_annotations[annotationKey];\n          break;\n        case Constants.enqueuedTime:\n          data.enqueuedTimeUtc = new Date(msg.message_annotations[annotationKey]);\n          break;\n        case Constants.offset:\n          data.offset = msg.message_annotations[annotationKey];\n          break;\n        default:\n          if (!data.systemProperties) {\n            data.systemProperties = {};\n          }\n          data.systemProperties[annotationKey] = convertDatesToNumbers(\n            msg.message_annotations[annotationKey],\n          );\n          break;\n      }\n    }\n  }\n  if (msg.application_properties) {\n    data.properties = convertDatesToNumbers(msg.application_properties);\n  }\n  if (msg.delivery_annotations) {\n    data.lastEnqueuedOffset = msg.delivery_annotations.last_enqueued_offset;\n    data.lastSequenceNumber = msg.delivery_annotations.last_enqueued_sequence_number;\n    data.lastEnqueuedTime = new Date(msg.delivery_annotations.last_enqueued_time_utc as number);\n    data.retrievalTime = new Date(\n      msg.delivery_annotations.runtime_info_retrieval_time_utc as number,\n    );\n  }\n\n  const messageProperties = Object.keys(messagePropertiesMap) as Array<\n    keyof typeof messagePropertiesMap\n  >;\n  for (const messageProperty of messageProperties) {\n    if (!data.systemProperties) {\n      data.systemProperties = {};\n    }\n    if (msg[messageProperty] != null) {\n      data.systemProperties[messagePropertiesMap[messageProperty]] = convertDatesToNumbers(\n        msg[messageProperty],\n      );\n    }\n  }\n\n  if (msg.content_type != null) {\n    data.contentType = msg.content_type;\n  }\n  if (msg.correlation_id != null) {\n    data.correlationId = msg.correlation_id;\n  }\n  if (msg.message_id != null) {\n    data.messageId = msg.message_id;\n  }\n\n  return data;\n}\n\n/**\n * Converts an EventData object to an AMQP message.\n * @param data - The EventData object that needs to be converted to an AMQP message.\n * @param partitionKey - An optional key to determine the partition that this event should land in.\n * @internal\n */\nexport function toRheaMessage(\n  data: EventData | AmqpAnnotatedMessage,\n  partitionKey?: string,\n): RheaMessage {\n  let rheaMessage: RheaMessage;\n  if (isAmqpAnnotatedMessage(data)) {\n    rheaMessage = {\n      ...AmqpAnnotatedMessage.toRheaMessage(data),\n      body: defaultDataTransformer.encode(data.body, data.bodyType ?? \"data\"),\n    };\n  } else {\n    let bodyType: BodyTypes = \"data\";\n    if (typeof (data as EventDataInternal).getRawAmqpMessage === \"function\") {\n      /*\n        If the event is being round-tripped, then we respect the `bodyType` of the\n        underlying AMQP message.\n      */\n      bodyType = (data as EventDataInternal).getRawAmqpMessage().bodyType ?? \"data\";\n    }\n\n    rheaMessage = {\n      body: defaultDataTransformer.encode(data.body, bodyType),\n    };\n    // As per the AMQP 1.0 spec If the message-annotations or delivery-annotations section is omitted,\n    // it is equivalent to a message-annotations section containing anempty map of annotations.\n    rheaMessage.message_annotations = {};\n\n    if (data.properties) {\n      rheaMessage.application_properties = data.properties;\n    }\n\n    if (isDefined(partitionKey)) {\n      rheaMessage.message_annotations[Constants.partitionKey] = partitionKey;\n      // Event Hub service cannot route messages to a specific partition based on the partition key\n      // if AMQP message header is an empty object. Hence we make sure that header is always present\n      // with atleast one property. Setting durable to true, helps us achieve that.\n      rheaMessage.durable = true;\n    }\n\n    if (data.contentType != null) {\n      rheaMessage.content_type = data.contentType;\n    }\n    if (data.correlationId != null) {\n      rheaMessage.correlation_id = data.correlationId;\n    }\n    if (data.messageId != null) {\n      if (\n        typeof data.messageId === \"string\" &&\n        data.messageId.length > Constants.maxMessageIdLength\n      ) {\n        throw new Error(\n          `Length of 'messageId' property on the event cannot be greater than ${Constants.maxMessageIdLength} characters.`,\n        );\n      }\n      rheaMessage.message_id = data.messageId;\n    }\n  }\n\n  return rheaMessage;\n}\n\n/**\n * The interface that describes the data to be sent to Event Hub.\n * Use this as a reference when creating the object to be sent when using the `EventHubProducerClient`.\n * For example, `{ body: \"your-data\" }` or\n * ```\n * {\n *    body: \"your-data\",\n *    properties: {\n *       propertyName: \"property value\"\n *    }\n * }\n * ```\n */\nexport interface EventData {\n  /**\n   * The message body that needs to be sent.\n   * If the application reading the events is not using this SDK,\n   * convert your body payload to a byte array or Buffer for better\n   * cross-language compatibility.\n   */\n  body: any;\n\n  /**\n   * The content type of the message. Optionally describes\n   * the payload of the message, with a descriptor following the format of RFC2045, Section 5, for\n   * example \"application/json\".\n   */\n  contentType?: string;\n\n  /**\n   * The correlation identifier that allows an\n   * application to specify a context for the message for the purposes of correlation, for example\n   * reflecting the MessageId of a message that is being replied to.\n   */\n  correlationId?: string | number | Buffer;\n\n  /**\n   * The message identifier is an\n   * application-defined value that uniquely identifies the message and its payload.\n   *\n   * Note: Numbers that are not whole integers are not allowed.\n   */\n  messageId?: string | number | Buffer;\n\n  /**\n   * Set of key value pairs that can be used to set properties specific to user application.\n   */\n  properties?: {\n    [key: string]: any;\n  };\n}\n\n/**\n * The interface that describes the structure of the event received from Event Hub.\n * Use this as a reference when creating the `processEvents` function to process the events\n * recieved from an Event Hub when using the `EventHubConsumerClient`.\n */\nexport interface ReceivedEventData {\n  /**\n   * The message body that needs to be sent or is received.\n   */\n  body: any;\n  /**\n   * The application specific properties.\n   */\n  properties?: {\n    [key: string]: any;\n  };\n  /**\n   * The enqueued time of the event.\n   */\n  enqueuedTimeUtc: Date;\n  /**\n   * When specified Event Hub will hash this to a partitionId.\n   * It guarantees that messages end up in a specific partition on the event hub.\n   */\n  partitionKey: string | null;\n  /**\n   * The offset of the event.\n   */\n  offset: string;\n  /**\n   * The sequence number of the event.\n   */\n  sequenceNumber: number;\n  /**\n   * The properties set by the service.\n   */\n  systemProperties?: {\n    [key: string]: any;\n  };\n\n  /**\n   * The content type of the message. Optionally describes\n   * the payload of the message, with a descriptor following the format of RFC2045, Section 5, for\n   * example \"application/json\".\n   */\n  contentType?: string;\n\n  /**\n   * The correlation identifier that allows an\n   * application to specify a context for the message for the purposes of correlation, for example\n   * reflecting the MessageId of a message that is being replied to.\n   */\n  correlationId?: string | number | Buffer;\n\n  /**\n   * The message identifier is an\n   * application-defined value that uniquely identifies the message and its payload.\n   */\n  messageId?: string | number | Buffer;\n\n  /**\n   * Returns the underlying raw amqp message.\n   */\n  getRawAmqpMessage(): AmqpAnnotatedMessage;\n}\n\n/**\n * @internal\n */\nexport function isAmqpAnnotatedMessage(possible: unknown): possible is AmqpAnnotatedMessage {\n  return (\n    isObjectWithProperties(possible, [\"body\", \"bodyType\"]) &&\n    !objectHasProperty(possible, \"getRawAmqpMessage\")\n  );\n}\n\n/**\n * Converts any Date objects into a number representing date.getTime().\n * Recursively checks for any Date objects in arrays and objects.\n * @internal\n */\nfunction convertDatesToNumbers<T = unknown>(thing: T): T {\n  // fast exit\n  if (!isDefined(thing)) return thing;\n\n  // When 'thing' is a Date, return the number representation\n  if (\n    typeof thing === \"object\" &&\n    objectHasProperty(thing, \"getTime\") &&\n    typeof thing.getTime === \"function\"\n  ) {\n    return thing.getTime();\n  }\n\n  /*\n    Examples:\n    [0, 'foo', new Date(), { nested: new Date()}]\n  */\n  if (Array.isArray(thing)) {\n    return thing.map(convertDatesToNumbers) as unknown as T;\n  }\n\n  /*\n    Examples:\n    { foo: new Date(), children: { nested: new Date() }}\n  */\n  if (typeof thing === \"object\" && isDefined<object>(thing)) {\n    const thingShallowCopy = { ...thing };\n    for (const key of Object.keys(thingShallowCopy)) {\n      (thingShallowCopy as any)[key] = convertDatesToNumbers((thingShallowCopy as any)[key]);\n    }\n    return thingShallowCopy;\n  }\n\n  return thing;\n}\n\n/**\n * @internal\n */\nexport interface PopulateIdempotentMessageAnnotationsParameters {\n  isIdempotentPublishingEnabled: boolean;\n  ownerLevel?: number;\n  producerGroupId?: number;\n  publishSequenceNumber?: number;\n}\n\n/**\n * Populates a rhea message with idempotent producer properties.\n * @internal\n */\nexport function populateIdempotentMessageAnnotations(\n  rheaMessage: RheaMessage,\n  {\n    isIdempotentPublishingEnabled,\n    ownerLevel,\n    producerGroupId,\n    publishSequenceNumber,\n  }: PopulateIdempotentMessageAnnotationsParameters,\n): void {\n  if (!isIdempotentPublishingEnabled) {\n    return;\n  }\n\n  const messageAnnotations = rheaMessage.message_annotations || {};\n  if (!rheaMessage.message_annotations) {\n    rheaMessage.message_annotations = messageAnnotations;\n  }\n\n  if (isDefined(ownerLevel)) {\n    messageAnnotations[idempotentProducerAmqpPropertyNames.epoch] = types.wrap_short(ownerLevel);\n  }\n  if (isDefined(producerGroupId)) {\n    messageAnnotations[idempotentProducerAmqpPropertyNames.producerId] =\n      types.wrap_long(producerGroupId);\n  }\n  if (isDefined(publishSequenceNumber)) {\n    messageAnnotations[idempotentProducerAmqpPropertyNames.producerSequenceNumber] =\n      types.wrap_int(publishSequenceNumber);\n  }\n}\n"]}

package/dist/commonjs/eventDataAdapter.d.ts

@@ -0,0 +1,69 @@
+import { EventData } from "./eventData.js";
+/**
+ * A message with payload and content type fields
+ *
+ * This interface is hidden because it is already exported by `@azure/schema-registry-avro`
+ *
+ * @hidden
+ */
+export interface MessageContent {
+    /**
+     * The message's binary data
+     */
+    data: Uint8Array;
+    /**
+     * The message's content type
+     */
+    contentType: string;
+}
+/**
+ * A message adapter interface that specifies methods for producing and consuming
+ * messages with payloads and content type fields.
+ *
+ * This interface is hidden because it is already exported by `@azure/schema-registry-avro`
+ *
+ * @hidden
+ */
+export interface MessageAdapter<MessageT> {
+    /**
+     * defines how to create a message from a payload and a content type
+     */
+    produce: (MessageContent: MessageContent) => MessageT;
+    /**
+     * defines how to access the payload and the content type of a message
+     */
+    consume: (message: MessageT) => MessageContent;
+}
+/**
+ * Parameters to the `createEventDataAdapter` function that creates an event data adapter.
+ */
+export interface EventDataAdapterParameters {
+    /**
+     * The correlation identifier that allows an
+     * application to specify a context for the message for the purposes of correlation, for example
+     * reflecting the MessageId of a message that is being replied to.
+     */
+    correlationId?: string | number | Buffer;
+    /**
+     * The message identifier is an
+     * application-defined value that uniquely identifies the message and its payload.
+     *
+     * Note: Numbers that are not whole integers are not allowed.
+     */
+    messageId?: string | number | Buffer;
+    /**
+     * Set of key value pairs that can be used to set properties specific to user application.
+     */
+    properties?: {
+        [key: string]: any;
+    };
+}
+/**
+ * A function that constructs an event data adapter. That adapter can be used
+ * with `@azure/schema-registry-avro` to encode and decode body in event data.
+ *
+ * @param params - parameters to create the event data
+ * @returns An event data adapter that can produce and consume event data
+ */
+export declare function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>;
+//# sourceMappingURL=eventDataAdapter.d.ts.map

package/dist/commonjs/eventDataAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventDataAdapter.d.ts","sourceRoot":"","sources":["../../src/eventDataAdapter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAAC,QAAQ;IACtC;;OAEG;IACH,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,QAAQ,CAAC;IACtD;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,cAAc,CAAC;CAChD;AAGD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAEzC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,GAAE,0BAA+B,GACtC,cAAc,CAAC,SAAS,CAAC,CA2B3B"}

package/dist/commonjs/eventDataAdapter.js

@@ -0,0 +1,38 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEventDataAdapter = createEventDataAdapter;
+/**
+ * A function that constructs an event data adapter. That adapter can be used
+ * with `@azure/schema-registry-avro` to encode and decode body in event data.
+ *
+ * @param params - parameters to create the event data
+ * @returns An event data adapter that can produce and consume event data
+ */
+function createEventDataAdapter(params = {}) {
+    return {
+        produce: ({ data: body, contentType }) => {
+            return Object.assign(Object.assign({}, params), { body,
+                contentType });
+        },
+        consume: (message) => {
+            const { body, contentType } = message;
+            if (body === undefined) {
+                throw new Error("Expected the body field to be defined");
+            }
+            if (contentType === undefined) {
+                throw new Error("Expected the contentType field to be defined");
+            }
+            return {
+                /**
+                 * If the raw response was parsed as JSON, we need to convert it to a Uint8Array,
+                 * otherwise, leave the payload as is.
+                 */
+                data: typeof body === "object" ? Uint8Array.from(Object.values(body)) : body,
+                contentType,
+            };
+        },
+    };
+}
+//# sourceMappingURL=eventDataAdapter.js.map

package/dist/commonjs/eventDataAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventDataAdapter.js","sourceRoot":"","sources":["../../src/eventDataAdapter.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AA4ElC,wDA6BC;AApCD;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,SAAqC,EAAE;IAEvC,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAkB,EAAE,EAAE;YACvD,uCACK,MAAM,KACT,IAAI;gBACJ,WAAW,IACX;QACJ,CAAC;QACD,OAAO,EAAE,CAAC,OAAkB,EAAkB,EAAE;YAC9C,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;YACtC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;YAC3D,CAAC;YACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAClE,CAAC;YACD,OAAO;gBACL;;;mBAGG;gBACH,IAAI,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBAC5E,WAAW;aACZ,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { EventData } from \"./eventData.js\";\n\n/**\n * A message with payload and content type fields\n *\n * This interface is hidden because it is already exported by `@azure/schema-registry-avro`\n *\n * @hidden\n */\nexport interface MessageContent {\n  /**\n   * The message's binary data\n   */\n  data: Uint8Array;\n  /**\n   * The message's content type\n   */\n  contentType: string;\n}\n\n/**\n * A message adapter interface that specifies methods for producing and consuming\n * messages with payloads and content type fields.\n *\n * This interface is hidden because it is already exported by `@azure/schema-registry-avro`\n *\n * @hidden\n */\nexport interface MessageAdapter<MessageT> {\n  /**\n   * defines how to create a message from a payload and a content type\n   */\n  produce: (MessageContent: MessageContent) => MessageT;\n  /**\n   * defines how to access the payload and the content type of a message\n   */\n  consume: (message: MessageT) => MessageContent;\n}\n\n// This type should always be equivalent to Omit<Omit<EventData, \"body\">, \"contentType\">\n/**\n * Parameters to the `createEventDataAdapter` function that creates an event data adapter.\n */\nexport interface EventDataAdapterParameters {\n  /**\n   * The correlation identifier that allows an\n   * application to specify a context for the message for the purposes of correlation, for example\n   * reflecting the MessageId of a message that is being replied to.\n   */\n  correlationId?: string | number | Buffer;\n\n  /**\n   * The message identifier is an\n   * application-defined value that uniquely identifies the message and its payload.\n   *\n   * Note: Numbers that are not whole integers are not allowed.\n   */\n  messageId?: string | number | Buffer;\n\n  /**\n   * Set of key value pairs that can be used to set properties specific to user application.\n   */\n  properties?: {\n    [key: string]: any;\n  };\n}\n\n/**\n * A function that constructs an event data adapter. That adapter can be used\n * with `@azure/schema-registry-avro` to encode and decode body in event data.\n *\n * @param params - parameters to create the event data\n * @returns An event data adapter that can produce and consume event data\n */\nexport function createEventDataAdapter(\n  params: EventDataAdapterParameters = {},\n): MessageAdapter<EventData> {\n  return {\n    produce: ({ data: body, contentType }: MessageContent) => {\n      return {\n        ...params,\n        body,\n        contentType,\n      };\n    },\n    consume: (message: EventData): MessageContent => {\n      const { body, contentType } = message;\n      if (body === undefined) {\n        throw new Error(\"Expected the body field to be defined\");\n      }\n      if (contentType === undefined) {\n        throw new Error(\"Expected the contentType field to be defined\");\n      }\n      return {\n        /**\n         * If the raw response was parsed as JSON, we need to convert it to a Uint8Array,\n         * otherwise, leave the payload as is.\n         */\n        data: typeof body === \"object\" ? Uint8Array.from(Object.values(body)) : body,\n        contentType,\n      };\n    },\n  };\n}\n"]}

package/dist/commonjs/eventDataBatch.d.ts

@@ -0,0 +1,225 @@
+import { AmqpAnnotatedMessage } from "@azure/core-amqp";
+import { EventData } from "./eventData.js";
+import { ConnectionContext } from "./connectionContext.js";
+import { OperationTracingOptions, TracingContext } from "@azure/core-tracing";
+import { PartitionPublishingProperties } from "./models/private.js";
+/**
+ * Checks if the provided eventDataBatch is an instance of `EventDataBatch`.
+ * @param eventDataBatch - The instance of `EventDataBatch` to verify.
+ * @internal
+ */
+export declare function isEventDataBatch(eventDataBatch: unknown): eventDataBatch is EventDataBatch;
+/**
+ * Options to configure the behavior of the `tryAdd` method on the `EventDataBatch` class.
+ */
+export interface TryAddOptions {
+    /**
+     * The options to use when creating Spans for tracing.
+     */
+    tracingOptions?: OperationTracingOptions;
+}
+/**
+ * An interface representing a batch of events which can be used to send events to Event Hub.
+ *
+ * To create the batch, use the `createBatch()` method on the `EventHubProducerClient`.
+ * To send the batch, use the `sendBatch()` method on the same client.
+ * To fill the batch, use the `tryAdd()` method on the batch itself.
+ *
+ */
+export interface EventDataBatch {
+    /**
+     * A value that is hashed and used by the Azure Event Hubs service to determine the partition to
+     * which the events are sent. Use the `createBatch()` method on the `EventHubProducerClient` to
+     * set the partitionKey.
+     * @readonly
+     * @internal
+     */
+    readonly partitionKey?: string;
+    /**
+     * Id of the partition to which the batch of events are sent. Use the `createBatch()` method on
+     * the `EventHubProducerClient` to set the partitionId.
+     * @readonly
+     * @internal
+     */
+    readonly partitionId?: string;
+    /**
+     * Size of the batch in bytes after the events added to it have been encoded into a single AMQP
+     * message.
+     * @readonly
+     */
+    readonly sizeInBytes: number;
+    /**
+     * Number of events added to the batch.
+     * @readonly
+     */
+    readonly count: number;
+    /**
+     * The maximum size of the batch, in bytes. The `tryAdd` function on the batch will return `false`
+     * if the event being added causes the size of the batch to exceed this limit. Use the `createBatch()` method on
+     * the `EventHubProducerClient` to set the maxSizeInBytes.
+     * @readonly
+     */
+    readonly maxSizeInBytes: number;
+    /**
+     * Adds an event to the batch if permitted by the batch's size limit.
+     * **NOTE**: Always remember to check the return value of this method, before calling it again
+     * for the next event.
+     *
+     * @param eventData -  An individual event data object or AmqpAnnotatedMessage.
+     * @returns A boolean value indicating if the event data has been added to the batch or not.
+     */
+    tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean;
+}
+/**
+ * An internal class representing a batch of events which can be used to send events to Event Hub.
+ *
+ * @internal
+ */
+export declare class EventDataBatchImpl implements EventDataBatch {
+    /**
+     * Describes the amqp connection context for the Client.
+     */
+    private _context;
+    /**
+     * The Id of the partition to which the batch is expected to be sent to.
+     * Specifying this will throw an error if the batch was created using a `partitionKey`.
+     */
+    private _partitionId?;
+    /**
+     * A value that is hashed to produce a partition assignment.
+     * It guarantees that messages with the same partitionKey end up in the same partition.
+     * Specifying this will throw an error if the batch was created using a `partitionId`.
+     */
+    private _partitionKey?;
+    /**
+     * The maximum size allowed for the batch.
+     */
+    private _maxSizeInBytes;
+    /**
+     * Current size of the batch in bytes.
+     */
+    private _sizeInBytes;
+    /**
+     * Encoded amqp messages.
+     */
+    private _encodedMessages;
+    /**
+     * Number of events in the batch.
+     */
+    private _count;
+    /**
+     * List of 'message' span contexts.
+     */
+    private _spanContexts;
+    /**
+     * The message annotations to apply on the batch envelope.
+     * This will reflect the message annotations on the first event
+     * that was added to the batch.
+     * A common annotation is the partition key.
+     */
+    private _batchAnnotations?;
+    /**
+     * Indicates that the batch should be treated as idempotent.
+     */
+    private _isIdempotent;
+    /**
+     * The sequence number assigned to the first event in the batch while
+     * the batch is being sent to the service.
+     */
+    private _pendingStartingSequenceNumber?;
+    /**
+     * The publishing sequence number assigned to the first event in the batch at the time
+     * the batch was successfully published.
+     * If the producer was not configured to apply sequence numbering or if the batch
+     * has not yet been successfully published, the value will be `undefined`.
+     */
+    private _startingPublishSequenceNumber?;
+    /**
+     * EventDataBatch should not be constructed using `new EventDataBatch()`
+     * Use the `createBatch()` method on your `EventHubProducer` instead.
+     * @internal
+     */
+    constructor(context: ConnectionContext, maxSizeInBytes: number, isIdempotent: boolean, partitionKey?: string, partitionId?: string);
+    /**
+     * The maximum size of the batch, in bytes.
+     * @readonly
+     */
+    get maxSizeInBytes(): number;
+    /**
+     * The partitionKey set during `EventDataBatch` creation. This value is hashed to
+     * produce a partition assignment when the producer is created without a `partitionId`
+     * @readonly
+     */
+    get partitionKey(): string | undefined;
+    /**
+     * The partitionId set during `EventDataBatch` creation.
+     * If this value is set then partitionKey can not be set.
+     * @readonly
+     */
+    get partitionId(): string | undefined;
+    /**
+     * Size of the `EventDataBatch` instance after the events added to it have been
+     * encoded into a single AMQP message.
+     * @readonly
+     */
+    get sizeInBytes(): number;
+    /**
+     * Number of events in the `EventDataBatch` instance.
+     * @readonly
+     */
+    get count(): number;
+    /**
+     * The publishing sequence number assigned to the first event in the batch at the time
+     * the batch was successfully published.
+     * If the producer was not configured to apply sequence numbering or if the batch
+     * has not yet been successfully published, the value will be `undefined`.
+     */
+    get startingPublishedSequenceNumber(): number | undefined;
+    /**
+     * Gets the "message" span contexts that were created when adding events to the batch.
+     * @internal
+     */
+    get _messageSpanContexts(): TracingContext[];
+    /**
+     * Generates an AMQP message that contains the provided encoded events and annotations.
+     * @param encodedEvents - The already encoded events to include in the AMQP batch.
+     * @param annotations - The message annotations to set on the batch.
+     * @param publishingProps - Idempotent publishing properties used to decorate the events in the batch while sending.
+     */
+    private _generateBatch;
+    /**
+     * Uses the publishingProps to add idempotent properties as message annotations to rhea messages.
+     */
+    private _decorateRheaMessagesWithPublishingProps;
+    /**
+     * Annotates a rhea message with placeholder idempotent properties if the batch is idempotent.
+     * This is necessary so that we can accurately calculate the size of the batch while adding events.
+     * Placeholder values are used because real values won't be known until we attempt to send the batch.
+     */
+    private _decorateRheaMessageWithPlaceholderIdempotencyProps;
+    /**
+     * Generates the single AMQP message which is the result of encoding all the events
+     * added into the `EventDataBatch` instance.
+     *
+     * This is not meant for the user to use directly.
+     *
+     * When the `EventDataBatch` instance is passed to the `send()` method on the `EventHubProducer`,
+     * this single batched AMQP message is what gets sent over the wire to the service.
+     * @readonly
+     */
+    _generateMessage(publishingProps?: PartitionPublishingProperties): Buffer;
+    /**
+     * Sets startingPublishSequenceNumber to the pending publish sequence number.
+     */
+    _commitPublish(): void;
+    /**
+     * Tries to add an event data to the batch if permitted by the batch's size limit.
+     * **NOTE**: Always remember to check the return value of this method, before calling it again
+     * for the next event.
+     *
+     * @param eventData -  An individual event data object.
+     * @returns A boolean value indicating if the event data has been added to the batch or not.
+     */
+    tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean;
+}
+//# sourceMappingURL=eventDataBatch.d.ts.map

package/dist/commonjs/eventDataBatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventDataBatch.d.ts","sourceRoot":"","sources":["../../src/eventDataBatch.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAuD,MAAM,gBAAgB,CAAC;AAChG,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAG9E,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAepE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,cAAc,EAAE,OAAO,GAAG,cAAc,IAAI,cAAc,CAO1F;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,uBAAuB,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,oBAAoB,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC;CACvF;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAoB;IACpC;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B;;;;OAIG;IACH,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B;;OAEG;IACH,OAAO,CAAC,eAAe,CAAS;IAChC;;OAEG;IACH,OAAO,CAAC,YAAY,CAAS;IAC7B;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAgB;IACxC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;IACvB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAwB;IAC7C;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAAqB;IAC/C;;OAEG;IACH,OAAO,CAAC,aAAa,CAAU;IAC/B;;;OAGG;IACH,OAAO,CAAC,8BAA8B,CAAC,CAAS;IAChD;;;;;OAKG;IACH,OAAO,CAAC,8BAA8B,CAAC,CAAS;IAEhD;;;;OAIG;gBAED,OAAO,EAAE,iBAAiB,EAC1B,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,OAAO,EACrB,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,MAAM;IAWtB;;;OAGG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAErC;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;;OAKG;IACH,IAAI,+BAA+B,IAAI,MAAM,GAAG,SAAS,CAExD;IAED;;;OAGG;IACH,IAAI,oBAAoB,IAAI,cAAc,EAAE,CAE3C;IAED;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IA4BtB;;OAEG;IACH,OAAO,CAAC,wCAAwC;IAwBhD;;;;OAIG;IACH,OAAO,CAAC,mDAAmD;IAoB3D;;;;;;;;;OASG;IACH,gBAAgB,CAAC,eAAe,CAAC,EAAE,6BAA6B,GAAG,MAAM;IAIzE;;OAEG;IACH,cAAc,IAAI,IAAI;IAItB;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,oBAAoB,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO;CAsDjG"}

package/dist/commonjs/eventDataBatch.js

@@ -0,0 +1,251 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventDataBatchImpl = void 0;
+exports.isEventDataBatch = isEventDataBatch;
+const eventData_js_1 = require("./eventData.js");
+const rhea_promise_1 = require("rhea-promise");
+const core_util_1 = require("@azure/core-util");
+const instrumentEventData_js_1 = require("./diagnostics/instrumentEventData.js");
+const error_js_1 = require("./util/error.js");
+/**
+ * The amount of bytes to reserve as overhead for a small message.
+ */
+const smallMessageOverhead = 5;
+/**
+ * The amount of bytes to reserve as overhead for a large message.
+ */
+const largeMessageOverhead = 8;
+/**
+ * The maximum number of bytes that a message may be to be considered small.
+ */
+const smallMessageMaxBytes = 255;
+/**
+ * Checks if the provided eventDataBatch is an instance of `EventDataBatch`.
+ * @param eventDataBatch - The instance of `EventDataBatch` to verify.
+ * @internal
+ */
+function isEventDataBatch(eventDataBatch) {
+    return ((0, core_util_1.isObjectWithProperties)(eventDataBatch, ["count", "sizeInBytes", "tryAdd"]) &&
+        typeof eventDataBatch.tryAdd === "function" &&
+        typeof eventDataBatch.count === "number" &&
+        typeof eventDataBatch.sizeInBytes === "number");
+}
+/**
+ * An internal class representing a batch of events which can be used to send events to Event Hub.
+ *
+ * @internal
+ */
+class EventDataBatchImpl {
+    /**
+     * EventDataBatch should not be constructed using `new EventDataBatch()`
+     * Use the `createBatch()` method on your `EventHubProducer` instead.
+     * @internal
+     */
+    constructor(context, maxSizeInBytes, isIdempotent, partitionKey, partitionId) {
+        /**
+         * Encoded amqp messages.
+         */
+        this._encodedMessages = [];
+        /**
+         * List of 'message' span contexts.
+         */
+        this._spanContexts = [];
+        this._context = context;
+        this._maxSizeInBytes = maxSizeInBytes;
+        this._isIdempotent = isIdempotent;
+        this._partitionKey = (0, core_util_1.isDefined)(partitionKey) ? String(partitionKey) : partitionKey;
+        this._partitionId = (0, core_util_1.isDefined)(partitionId) ? String(partitionId) : partitionId;
+        this._sizeInBytes = 0;
+        this._count = 0;
+    }
+    /**
+     * The maximum size of the batch, in bytes.
+     * @readonly
+     */
+    get maxSizeInBytes() {
+        return this._maxSizeInBytes;
+    }
+    /**
+     * The partitionKey set during `EventDataBatch` creation. This value is hashed to
+     * produce a partition assignment when the producer is created without a `partitionId`
+     * @readonly
+     */
+    get partitionKey() {
+        return this._partitionKey;
+    }
+    /**
+     * The partitionId set during `EventDataBatch` creation.
+     * If this value is set then partitionKey can not be set.
+     * @readonly
+     */
+    get partitionId() {
+        return this._partitionId;
+    }
+    /**
+     * Size of the `EventDataBatch` instance after the events added to it have been
+     * encoded into a single AMQP message.
+     * @readonly
+     */
+    get sizeInBytes() {
+        return this._sizeInBytes;
+    }
+    /**
+     * Number of events in the `EventDataBatch` instance.
+     * @readonly
+     */
+    get count() {
+        return this._count;
+    }
+    /**
+     * The publishing sequence number assigned to the first event in the batch at the time
+     * the batch was successfully published.
+     * If the producer was not configured to apply sequence numbering or if the batch
+     * has not yet been successfully published, the value will be `undefined`.
+     */
+    get startingPublishedSequenceNumber() {
+        return this._startingPublishSequenceNumber;
+    }
+    /**
+     * Gets the "message" span contexts that were created when adding events to the batch.
+     * @internal
+     */
+    get _messageSpanContexts() {
+        return this._spanContexts;
+    }
+    /**
+     * Generates an AMQP message that contains the provided encoded events and annotations.
+     * @param encodedEvents - The already encoded events to include in the AMQP batch.
+     * @param annotations - The message annotations to set on the batch.
+     * @param publishingProps - Idempotent publishing properties used to decorate the events in the batch while sending.
+     */
+    _generateBatch(encodedEvents, annotations, publishingProps) {
+        if (this._isIdempotent && publishingProps) {
+            // We need to decode the encoded events, add the idempotent annotations, and re-encode them.
+            // We can't lazily encode the events because we rely on `message.encode` to capture the
+            // byte length of anything not in `event.body`.
+            // Events can't be decorated ahead of time because the publishing properties aren't known
+            // until the events are being sent to the service.
+            const decodedEvents = encodedEvents.map(rhea_promise_1.message.decode);
+            const decoratedEvents = this._decorateRheaMessagesWithPublishingProps(decodedEvents, publishingProps);
+            encodedEvents = decoratedEvents.map(rhea_promise_1.message.encode);
+        }
+        const batchEnvelope = {
+            body: rhea_promise_1.message.data_sections(encodedEvents),
+        };
+        if (annotations) {
+            batchEnvelope.message_annotations = annotations;
+        }
+        return rhea_promise_1.message.encode(batchEnvelope);
+    }
+    /**
+     * Uses the publishingProps to add idempotent properties as message annotations to rhea messages.
+     */
+    _decorateRheaMessagesWithPublishingProps(events, publishingProps) {
+        if (!this._isIdempotent) {
+            return events;
+        }
+        const { lastPublishedSequenceNumber = 0, ownerLevel, producerGroupId } = publishingProps;
+        const startingSequenceNumber = lastPublishedSequenceNumber + 1;
+        for (let i = 0; i < events.length; i++) {
+            const event = events[i];
+            (0, eventData_js_1.populateIdempotentMessageAnnotations)(event, {
+                isIdempotentPublishingEnabled: this._isIdempotent,
+                ownerLevel,
+                producerGroupId,
+                publishSequenceNumber: startingSequenceNumber + i,
+            });
+        }
+        this._pendingStartingSequenceNumber = startingSequenceNumber;
+        return events;
+    }
+    /**
+     * Annotates a rhea message with placeholder idempotent properties if the batch is idempotent.
+     * This is necessary so that we can accurately calculate the size of the batch while adding events.
+     * Placeholder values are used because real values won't be known until we attempt to send the batch.
+     */
+    _decorateRheaMessageWithPlaceholderIdempotencyProps(event) {
+        if (!this._isIdempotent) {
+            return event;
+        }
+        if (!event.message_annotations) {
+            event.message_annotations = {};
+        }
+        // Set placeholder values for these annotations.
+        (0, eventData_js_1.populateIdempotentMessageAnnotations)(event, {
+            isIdempotentPublishingEnabled: this._isIdempotent,
+            ownerLevel: 0,
+            publishSequenceNumber: 0,
+            producerGroupId: 0,
+        });
+        return event;
+    }
+    /**
+     * Generates the single AMQP message which is the result of encoding all the events
+     * added into the `EventDataBatch` instance.
+     *
+     * This is not meant for the user to use directly.
+     *
+     * When the `EventDataBatch` instance is passed to the `send()` method on the `EventHubProducer`,
+     * this single batched AMQP message is what gets sent over the wire to the service.
+     * @readonly
+     */
+    _generateMessage(publishingProps) {
+        return this._generateBatch(this._encodedMessages, this._batchAnnotations, publishingProps);
+    }
+    /**
+     * Sets startingPublishSequenceNumber to the pending publish sequence number.
+     */
+    _commitPublish() {
+        this._startingPublishSequenceNumber = this._pendingStartingSequenceNumber;
+    }
+    /**
+     * Tries to add an event data to the batch if permitted by the batch's size limit.
+     * **NOTE**: Always remember to check the return value of this method, before calling it again
+     * for the next event.
+     *
+     * @param eventData -  An individual event data object.
+     * @returns A boolean value indicating if the event data has been added to the batch or not.
+     */
+    tryAdd(eventData, options = {}) {
+        (0, error_js_1.throwTypeErrorIfParameterMissing)(this._context.connectionId, "tryAdd", "eventData", eventData);
+        const { entityPath, host } = this._context.config;
+        const { event: instrumentedEvent, spanContext } = (0, instrumentEventData_js_1.instrumentEventData)(eventData, options, entityPath, host);
+        // Convert EventData to RheaMessage.
+        const amqpMessage = (0, eventData_js_1.toRheaMessage)(instrumentedEvent, this._partitionKey);
+        const originalAnnotations = amqpMessage.message_annotations && Object.assign({}, amqpMessage.message_annotations);
+        this._decorateRheaMessageWithPlaceholderIdempotencyProps(amqpMessage);
+        const encodedMessage = rhea_promise_1.message.encode(amqpMessage);
+        let currentSize = this._sizeInBytes;
+        // The first time an event is added, we need to calculate
+        // the overhead of creating an AMQP batch, including the
+        // message_annotations that are taken from the 1st message.
+        if (this.count === 0) {
+            if (originalAnnotations) {
+                this._batchAnnotations = originalAnnotations;
+            }
+            // Figure out the overhead of creating a batch by generating an empty batch
+            // with the expected batch annotations.
+            currentSize += this._generateBatch([], this._batchAnnotations).length;
+        }
+        const messageSize = encodedMessage.length;
+        const messageOverhead = messageSize <= smallMessageMaxBytes ? smallMessageOverhead : largeMessageOverhead;
+        currentSize += messageSize + messageOverhead;
+        // Check if the size of the batch exceeds the maximum allowed size
+        // once we add the new event to it.
+        if (currentSize > this._maxSizeInBytes) {
+            return false;
+        }
+        // The event will fit in the batch, so it is now safe to store it.
+        this._encodedMessages.push(encodedMessage);
+        if (spanContext) {
+            this._spanContexts.push(spanContext);
+        }
+        this._sizeInBytes = currentSize;
+        this._count++;
+        return true;
+    }
+}
+exports.EventDataBatchImpl = EventDataBatchImpl;
+//# sourceMappingURL=eventDataBatch.js.map