@azure/service-bus 7.10.0-beta.1 → 7.10.0-beta.2

package/dist/commonjs/serviceBusMessageBatch.d.ts

@@ -0,0 +1,153 @@
+import type { ServiceBusMessage } from "./serviceBusMessage.js";
+import type { ConnectionContext } from "./connectionContext.js";
+import type { TracingContext } from "@azure/core-tracing";
+import type { TryAddOptions } from "./modelsToBeSharedWithEventHubs.js";
+import type { AmqpAnnotatedMessage } from "@azure/core-amqp";
+/**
+ * A batch of messages that you can create using the {@link createBatch} method.
+ *
+ */
+export interface ServiceBusMessageBatch {
+    /**
+     * 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 messages added to the batch.
+     * @readonly
+     */
+    readonly count: number;
+    /**
+     * The maximum size of the batch, in bytes. The `tryAddMessage` function on the batch will return `false`
+     * if the message being added causes the size of the batch to exceed this limit. Use the `createMessageBatch()` method on
+     * the `Sender` to set the maxSizeInBytes.
+     * @readonly
+     */
+    readonly maxSizeInBytes: number;
+    /**
+     * Adds a message 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 message - The message to add to the batch.
+     * @returns A boolean value indicating if the message has been added to the batch or not.
+     */
+    tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean;
+    /**
+     * The AMQP message containing encoded events that were added to the batch.
+     * Used internally by the `sendBatch()` method on the `Sender`.
+     * This is not meant for the user to use directly.
+     *
+     * @readonly
+     * @internal
+     * @hidden
+     */
+    _generateMessage(): Buffer;
+    /**
+     * Gets the "message" span contexts that were created when adding events to the batch.
+     * Used internally by the `sendBatch()` method to set up the right spans in traces if tracing is enabled.
+     * @internal
+     * @hidden
+     */
+    readonly _messageSpanContexts: TracingContext[];
+}
+/**
+ * An internal class representing a batch of messages which can be used to send messages to Service Bus.
+ *
+ * @internal
+ */
+export declare class ServiceBusMessageBatchImpl implements ServiceBusMessageBatch {
+    private _context;
+    private _maxSizeInBytes;
+    /**
+     * Current size of the batch in bytes.
+     */
+    private _sizeInBytes;
+    /**
+     * Encoded amqp messages.
+     */
+    private _encodedMessages;
+    /**
+     * List of 'message' span contexts.
+     */
+    private _spanContexts;
+    /**
+     * ServiceBusMessageBatch should not be constructed using `new ServiceBusMessageBatch()`
+     * Use the `createBatch()` method on your `Sender` instead.
+     * @internal
+     * @hidden
+     */
+    constructor(_context: ConnectionContext, _maxSizeInBytes: number);
+    /**
+     * The maximum size of the batch, in bytes.
+     * @readonly
+     */
+    get maxSizeInBytes(): number;
+    /**
+     * Size of the `ServiceBusMessageBatch` instance after the messages added to it have been
+     * encoded into a single AMQP message.
+     * @readonly
+     */
+    get sizeInBytes(): number;
+    /**
+     * Number of messages in the `ServiceBusMessageBatch` instance.
+     * @readonly
+     */
+    get count(): number;
+    /**
+     * Gets the "message" span contexts that were created when adding messages to the batch.
+     * @internal
+     * @hidden
+     */
+    get _messageSpanContexts(): TracingContext[];
+    /**
+     * Generates an AMQP message that contains the provided encoded messages and annotations.
+     *
+     * @param encodedMessages - The already encoded messages to include in the AMQP batch.
+     * @param annotations - The message annotations to set on the batch.
+     * @param applicationProperties - The application properties to set on the batch.
+     * @param messageProperties - The message properties to set on the batch.
+     */
+    private _generateBatch;
+    /**
+     * Represents the single AMQP message which is the result of encoding all the events
+     * added into the `ServiceBusMessageBatch` instance.
+     *
+     * This is not meant for the user to use directly.
+     *
+     * When the `ServiceBusMessageBatch` instance is passed to the `sendBatch()` method on the `Sender`,
+     * this single batched AMQP message is what gets sent over the wire to the service.
+     * @readonly
+     */
+    _generateMessage(): Buffer;
+    /**
+     * The message annotations to apply on the batch envelope.
+     * This will reflect the message annotations on the first message
+     * that was added to the batch.
+     */
+    private _batchAnnotations?;
+    /**
+     * The message properties to apply on the batch envelope.
+     * This will reflect the message properties on the first message
+     * that was added to the batch.
+     */
+    private _batchMessageProperties?;
+    /**
+     * The application properties to apply on the batch envelope.
+     * This will reflect the application properties on the first message
+     * that was added to the batch.
+     */
+    private _batchApplicationProperties?;
+    /**
+     * Tries to add a message 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 message.
+     *
+     * @param originalMessage - An individual service bus message.
+     * @returns A boolean value indicating if the message has been added to the batch or not.
+     */
+    tryAddMessage(originalMessage: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean;
+}
+//# sourceMappingURL=serviceBusMessageBatch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serviceBusMessageBatch.d.ts","sourceRoot":"","sources":["../../src/serviceBusMessageBatch.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAOhE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAMhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAoB7D;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;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,aAAa,CACX,OAAO,EAAE,iBAAiB,GAAG,oBAAoB,EACjD,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC;IAEX;;;;;;;;OAQG;IACH,gBAAgB,IAAI,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,oBAAoB,EAAE,cAAc,EAAE,CAAC;CACjD;AAED;;;;GAIG;AACH,qBAAa,0BAA2B,YAAW,sBAAsB;IAoBrE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,eAAe;IApBzB;;OAEG;IACH,OAAO,CAAC,YAAY,CAAS;IAC7B;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAgB;IACxC;;OAEG;IACH,OAAO,CAAC,aAAa,CAAwB;IAC7C;;;;;OAKG;gBAEO,QAAQ,EAAE,iBAAiB,EAC3B,eAAe,EAAE,MAAM;IAMjC;;;OAGG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,oBAAoB,IAAI,cAAc,EAAE,CAE3C;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAqBtB;;;;;;;;;OASG;IACH,gBAAgB,IAAI,MAAM;IAS1B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAAqB;IAC/C;;;;OAIG;IACH,OAAO,CAAC,uBAAuB,CAAC,CAA4B;IAC5D;;;;OAIG;IACH,OAAO,CAAC,2BAA2B,CAAC,CAAyB;IAE7D;;;;;;;OAOG;IACI,aAAa,CAClB,eAAe,EAAE,iBAAiB,GAAG,oBAAoB,EACzD,OAAO,GAAE,aAAkB,GAC1B,OAAO;CA+DX"}

package/dist/commonjs/serviceBusMessageBatch.js

@@ -0,0 +1,172 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceBusMessageBatchImpl = void 0;
+const serviceBusMessage_js_1 = require("./serviceBusMessage.js");
+const errors_js_1 = require("./util/errors.js");
+const rhea_promise_1 = require("rhea-promise");
+const dataTransformer_js_1 = require("./dataTransformer.js");
+const instrumentServiceBusMessage_js_1 = require("./diagnostics/instrumentServiceBusMessage.js");
+/**
+ * @internal
+ * The amount of bytes to reserve as overhead for a small message.
+ */
+const smallMessageOverhead = 5;
+/**
+ * @internal
+ * The amount of bytes to reserve as overhead for a large message.
+ */
+const largeMessageOverhead = 8;
+/**
+ * @internal
+ * The maximum number of bytes that a message may be to be considered small.
+ */
+const smallMessageMaxBytes = 255;
+/**
+ * An internal class representing a batch of messages which can be used to send messages to Service Bus.
+ *
+ * @internal
+ */
+class ServiceBusMessageBatchImpl {
+    /**
+     * ServiceBusMessageBatch should not be constructed using `new ServiceBusMessageBatch()`
+     * Use the `createBatch()` method on your `Sender` instead.
+     * @internal
+     * @hidden
+     */
+    constructor(_context, _maxSizeInBytes) {
+        this._context = _context;
+        this._maxSizeInBytes = _maxSizeInBytes;
+        /**
+         * Encoded amqp messages.
+         */
+        this._encodedMessages = [];
+        /**
+         * List of 'message' span contexts.
+         */
+        this._spanContexts = [];
+        this._sizeInBytes = 0;
+        this._batchMessageProperties = {};
+    }
+    /**
+     * The maximum size of the batch, in bytes.
+     * @readonly
+     */
+    get maxSizeInBytes() {
+        return this._maxSizeInBytes;
+    }
+    /**
+     * Size of the `ServiceBusMessageBatch` instance after the messages added to it have been
+     * encoded into a single AMQP message.
+     * @readonly
+     */
+    get sizeInBytes() {
+        return this._sizeInBytes;
+    }
+    /**
+     * Number of messages in the `ServiceBusMessageBatch` instance.
+     * @readonly
+     */
+    get count() {
+        return this._encodedMessages.length;
+    }
+    /**
+     * Gets the "message" span contexts that were created when adding messages to the batch.
+     * @internal
+     * @hidden
+     */
+    get _messageSpanContexts() {
+        return this._spanContexts;
+    }
+    /**
+     * Generates an AMQP message that contains the provided encoded messages and annotations.
+     *
+     * @param encodedMessages - The already encoded messages to include in the AMQP batch.
+     * @param annotations - The message annotations to set on the batch.
+     * @param applicationProperties - The application properties to set on the batch.
+     * @param messageProperties - The message properties to set on the batch.
+     */
+    _generateBatch(encodedMessages, annotations, applicationProperties, messageProperties) {
+        const batchEnvelope = {
+            body: rhea_promise_1.message.data_sections(encodedMessages),
+            message_annotations: annotations,
+            application_properties: applicationProperties,
+        };
+        if (messageProperties) {
+            for (const prop of rhea_promise_1.messageProperties) {
+                if (messageProperties[prop]) {
+                    batchEnvelope[prop] = messageProperties[prop];
+                }
+            }
+        }
+        return rhea_promise_1.message.encode(batchEnvelope);
+    }
+    /**
+     * Represents the single AMQP message which is the result of encoding all the events
+     * added into the `ServiceBusMessageBatch` instance.
+     *
+     * This is not meant for the user to use directly.
+     *
+     * When the `ServiceBusMessageBatch` instance is passed to the `sendBatch()` method on the `Sender`,
+     * this single batched AMQP message is what gets sent over the wire to the service.
+     * @readonly
+     */
+    _generateMessage() {
+        return this._generateBatch(this._encodedMessages, this._batchAnnotations, this._batchApplicationProperties, this._batchMessageProperties);
+    }
+    /**
+     * Tries to add a message 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 message.
+     *
+     * @param originalMessage - An individual service bus message.
+     * @returns A boolean value indicating if the message has been added to the batch or not.
+     */
+    tryAddMessage(originalMessage, options = {}) {
+        (0, errors_js_1.throwTypeErrorIfParameterMissing)(this._context.connectionId, "message", originalMessage);
+        (0, errors_js_1.throwIfNotValidServiceBusMessage)(originalMessage, errors_js_1.errorInvalidMessageTypeSingle);
+        const { message, spanContext } = (0, instrumentServiceBusMessage_js_1.instrumentMessage)(originalMessage, options, this._context.config.entityPath, this._context.config.host, "publish");
+        // Convert ServiceBusMessage to AmqpMessage.
+        const amqpMessage = (0, serviceBusMessage_js_1.toRheaMessage)(message, dataTransformer_js_1.defaultDataTransformer);
+        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, application_properties and message_properties
+        // that are taken from the 1st message.
+        if (this.count === 0) {
+            if (amqpMessage.message_annotations) {
+                this._batchAnnotations = amqpMessage.message_annotations;
+            }
+            if (amqpMessage.application_properties) {
+                this._batchApplicationProperties = amqpMessage.application_properties;
+            }
+            for (const prop of rhea_promise_1.messageProperties) {
+                if (amqpMessage[prop]) {
+                    this._batchMessageProperties[prop] = amqpMessage[prop];
+                }
+            }
+            // Figure out the overhead of creating a batch by generating an empty batch
+            // with the expected batch annotations.
+            currentSize += this._generateBatch([], this._batchAnnotations, this._batchApplicationProperties, this._batchMessageProperties).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 message 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;
+        return true;
+    }
+}
+exports.ServiceBusMessageBatchImpl = ServiceBusMessageBatchImpl;
+//# sourceMappingURL=serviceBusMessageBatch.js.map

package/dist/commonjs/serviceBusMessageBatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceBusMessageBatch.js","sourceRoot":"","sources":["../../src/serviceBusMessageBatch.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,iEAAuD;AACvD,gDAI0B;AAG1B,+CAGsB;AAItB,6DAA8D;AAC9D,iGAAiF;AAEjF;;;GAGG;AACH,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B;;;GAGG;AACH,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B;;;GAGG;AACH,MAAM,oBAAoB,GAAG,GAAG,CAAC;AA6DjC;;;;GAIG;AACH,MAAa,0BAA0B;IAarC;;;;;OAKG;IACH,YACU,QAA2B,EAC3B,eAAuB;QADvB,aAAQ,GAAR,QAAQ,CAAmB;QAC3B,oBAAe,GAAf,eAAe,CAAQ;QAhBjC;;WAEG;QACK,qBAAgB,GAAa,EAAE,CAAC;QACxC;;WAEG;QACK,kBAAa,GAAqB,EAAE,CAAC;QAW3C,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,uBAAuB,GAAG,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACK,cAAc,CACpB,eAAyB,EACzB,WAAgC,EAChC,qBAA8C,EAC9C,iBAA6C;QAE7C,MAAM,aAAa,GAAgB;YACjC,IAAI,EAAE,sBAAe,CAAC,aAAa,CAAC,eAAe,CAAC;YACpD,mBAAmB,EAAE,WAAW;YAChC,sBAAsB,EAAE,qBAAqB;SAC9C,CAAC;QACF,IAAI,iBAAiB,EAAE,CAAC;YACtB,KAAK,MAAM,IAAI,IAAI,gCAAyB,EAAE,CAAC;gBAC7C,IAAK,iBAAyB,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpC,aAAqB,CAAC,IAAI,CAAC,GAAI,iBAAyB,CAAC,IAAI,CAAC,CAAC;gBAClE,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,sBAAe,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,cAAc,CACxB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,2BAA2B,EAChC,IAAI,CAAC,uBAAuB,CAC7B,CAAC;IACJ,CAAC;IAqBD;;;;;;;OAOG;IACI,aAAa,CAClB,eAAyD,EACzD,UAAyB,EAAE;QAE3B,IAAA,4CAAgC,EAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;QACzF,IAAA,4CAAgC,EAAC,eAAe,EAAE,yCAA6B,CAAC,CAAC;QAEjF,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAA,kDAAiB,EAChD,eAAe,EACf,OAAO,EACP,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAW,EAChC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EACzB,SAAS,CACV,CAAC;QAEF,4CAA4C;QAC5C,MAAM,WAAW,GAAG,IAAA,oCAAa,EAAC,OAAO,EAAE,2CAAsB,CAAC,CAAC;QAEnE,MAAM,cAAc,GAAG,sBAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QAEpC,yDAAyD;QACzD,wDAAwD;QACxD,qEAAqE;QACrE,uCAAuC;QACvC,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YACrB,IAAI,WAAW,CAAC,mBAAmB,EAAE,CAAC;gBACpC,IAAI,CAAC,iBAAiB,GAAG,WAAW,CAAC,mBAAmB,CAAC;YAC3D,CAAC;YACD,IAAI,WAAW,CAAC,sBAAsB,EAAE,CAAC;gBACvC,IAAI,CAAC,2BAA2B,GAAG,WAAW,CAAC,sBAAsB,CAAC;YACxE,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,gCAAyB,EAAE,CAAC;gBAC7C,IAAK,WAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,IAAI,CAAC,uBAA+B,CAAC,IAAI,CAAC,GAAI,WAAmB,CAAC,IAAI,CAAC,CAAC;gBAC3E,CAAC;YACH,CAAC;YACD,2EAA2E;YAC3E,uCAAuC;YACvC,WAAW,IAAI,IAAI,CAAC,cAAc,CAChC,EAAE,EACF,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,2BAA2B,EAChC,IAAI,CAAC,uBAAuB,CAC7B,CAAC,MAAM,CAAC;QACX,CAAC;QAED,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC;QAC1C,MAAM,eAAe,GACnB,WAAW,IAAI,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC;QACpF,WAAW,IAAI,WAAW,GAAG,eAAe,CAAC;QAC7C,kEAAkE;QAClE,mCAAmC;QACnC,IAAI,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YACvC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,oEAAoE;QACpE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3C,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA1MD,gEA0MC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ServiceBusMessage } from \"./serviceBusMessage.js\";\nimport { toRheaMessage } from \"./serviceBusMessage.js\";\nimport {\n  errorInvalidMessageTypeSingle,\n  throwIfNotValidServiceBusMessage,\n  throwTypeErrorIfParameterMissing,\n} from \"./util/errors.js\";\nimport type { ConnectionContext } from \"./connectionContext.js\";\nimport type { MessageAnnotations, Message as RheaMessage } from \"rhea-promise\";\nimport {\n  messageProperties as RheaMessagePropertiesList,\n  message as RheaMessageUtil,\n} from \"rhea-promise\";\nimport type { TracingContext } from \"@azure/core-tracing\";\nimport type { TryAddOptions } from \"./modelsToBeSharedWithEventHubs.js\";\nimport type { AmqpAnnotatedMessage } from \"@azure/core-amqp\";\nimport { defaultDataTransformer } from \"./dataTransformer.js\";\nimport { instrumentMessage } from \"./diagnostics/instrumentServiceBusMessage.js\";\n\n/**\n * @internal\n * The amount of bytes to reserve as overhead for a small message.\n */\nconst smallMessageOverhead = 5;\n/**\n * @internal\n * The amount of bytes to reserve as overhead for a large message.\n */\nconst largeMessageOverhead = 8;\n/**\n * @internal\n * The maximum number of bytes that a message may be to be considered small.\n */\nconst smallMessageMaxBytes = 255;\n\n/**\n * A batch of messages that you can create using the {@link createBatch} method.\n *\n */\nexport interface ServiceBusMessageBatch {\n  /**\n   * Size of the batch in bytes after the events added to it have been encoded into a single AMQP\n   * message.\n   * @readonly\n   */\n  readonly sizeInBytes: number;\n\n  /**\n   * Number of messages added to the batch.\n   * @readonly\n   */\n  readonly count: number;\n\n  /**\n   * The maximum size of the batch, in bytes. The `tryAddMessage` function on the batch will return `false`\n   * if the message being added causes the size of the batch to exceed this limit. Use the `createMessageBatch()` method on\n   * the `Sender` to set the maxSizeInBytes.\n   * @readonly\n   */\n  readonly maxSizeInBytes: number;\n\n  /**\n   * Adds a message to the batch if permitted by the batch's size limit.\n   * **NOTE**: Always remember to check the return value of this method, before calling it again\n   * for the next event.\n   *\n   * @param message - The message to add to the batch.\n   * @returns A boolean value indicating if the message has been added to the batch or not.\n   */\n  tryAddMessage(\n    message: ServiceBusMessage | AmqpAnnotatedMessage,\n    options?: TryAddOptions,\n  ): boolean;\n\n  /**\n   * The AMQP message containing encoded events that were added to the batch.\n   * Used internally by the `sendBatch()` method on the `Sender`.\n   * This is not meant for the user to use directly.\n   *\n   * @readonly\n   * @internal\n   * @hidden\n   */\n  _generateMessage(): Buffer;\n\n  /**\n   * Gets the \"message\" span contexts that were created when adding events to the batch.\n   * Used internally by the `sendBatch()` method to set up the right spans in traces if tracing is enabled.\n   * @internal\n   * @hidden\n   */\n  readonly _messageSpanContexts: TracingContext[];\n}\n\n/**\n * An internal class representing a batch of messages which can be used to send messages to Service Bus.\n *\n * @internal\n */\nexport class ServiceBusMessageBatchImpl implements ServiceBusMessageBatch {\n  /**\n   * Current size of the batch in bytes.\n   */\n  private _sizeInBytes: number;\n  /**\n   * Encoded amqp messages.\n   */\n  private _encodedMessages: Buffer[] = [];\n  /**\n   * List of 'message' span contexts.\n   */\n  private _spanContexts: TracingContext[] = [];\n  /**\n   * ServiceBusMessageBatch should not be constructed using `new ServiceBusMessageBatch()`\n   * Use the `createBatch()` method on your `Sender` instead.\n   * @internal\n   * @hidden\n   */\n  constructor(\n    private _context: ConnectionContext,\n    private _maxSizeInBytes: number,\n  ) {\n    this._sizeInBytes = 0;\n    this._batchMessageProperties = {};\n  }\n\n  /**\n   * The maximum size of the batch, in bytes.\n   * @readonly\n   */\n  get maxSizeInBytes(): number {\n    return this._maxSizeInBytes;\n  }\n\n  /**\n   * Size of the `ServiceBusMessageBatch` instance after the messages added to it have been\n   * encoded into a single AMQP message.\n   * @readonly\n   */\n  get sizeInBytes(): number {\n    return this._sizeInBytes;\n  }\n\n  /**\n   * Number of messages in the `ServiceBusMessageBatch` instance.\n   * @readonly\n   */\n  get count(): number {\n    return this._encodedMessages.length;\n  }\n\n  /**\n   * Gets the \"message\" span contexts that were created when adding messages to the batch.\n   * @internal\n   * @hidden\n   */\n  get _messageSpanContexts(): TracingContext[] {\n    return this._spanContexts;\n  }\n\n  /**\n   * Generates an AMQP message that contains the provided encoded messages and annotations.\n   *\n   * @param encodedMessages - The already encoded messages to include in the AMQP batch.\n   * @param annotations - The message annotations to set on the batch.\n   * @param applicationProperties - The application properties to set on the batch.\n   * @param messageProperties - The message properties to set on the batch.\n   */\n  private _generateBatch(\n    encodedMessages: Buffer[],\n    annotations?: MessageAnnotations,\n    applicationProperties?: { [key: string]: any },\n    messageProperties?: { [key: string]: string },\n  ): Buffer {\n    const batchEnvelope: RheaMessage = {\n      body: RheaMessageUtil.data_sections(encodedMessages),\n      message_annotations: annotations,\n      application_properties: applicationProperties,\n    };\n    if (messageProperties) {\n      for (const prop of RheaMessagePropertiesList) {\n        if ((messageProperties as any)[prop]) {\n          (batchEnvelope as any)[prop] = (messageProperties as any)[prop];\n        }\n      }\n    }\n    return RheaMessageUtil.encode(batchEnvelope);\n  }\n\n  /**\n   * Represents the single AMQP message which is the result of encoding all the events\n   * added into the `ServiceBusMessageBatch` instance.\n   *\n   * This is not meant for the user to use directly.\n   *\n   * When the `ServiceBusMessageBatch` instance is passed to the `sendBatch()` method on the `Sender`,\n   * this single batched AMQP message is what gets sent over the wire to the service.\n   * @readonly\n   */\n  _generateMessage(): Buffer {\n    return this._generateBatch(\n      this._encodedMessages,\n      this._batchAnnotations,\n      this._batchApplicationProperties,\n      this._batchMessageProperties,\n    );\n  }\n\n  /**\n   * The message annotations to apply on the batch envelope.\n   * This will reflect the message annotations on the first message\n   * that was added to the batch.\n   */\n  private _batchAnnotations?: MessageAnnotations;\n  /**\n   * The message properties to apply on the batch envelope.\n   * This will reflect the message properties on the first message\n   * that was added to the batch.\n   */\n  private _batchMessageProperties?: { [key: string]: string };\n  /**\n   * The application properties to apply on the batch envelope.\n   * This will reflect the application properties on the first message\n   * that was added to the batch.\n   */\n  private _batchApplicationProperties?: { [key: string]: any };\n\n  /**\n   * Tries to add a message to the batch if permitted by the batch's size limit.\n   * **NOTE**: Always remember to check the return value of this method, before calling it again\n   * for the next message.\n   *\n   * @param originalMessage - An individual service bus message.\n   * @returns A boolean value indicating if the message has been added to the batch or not.\n   */\n  public tryAddMessage(\n    originalMessage: ServiceBusMessage | AmqpAnnotatedMessage,\n    options: TryAddOptions = {},\n  ): boolean {\n    throwTypeErrorIfParameterMissing(this._context.connectionId, \"message\", originalMessage);\n    throwIfNotValidServiceBusMessage(originalMessage, errorInvalidMessageTypeSingle);\n\n    const { message, spanContext } = instrumentMessage(\n      originalMessage,\n      options,\n      this._context.config.entityPath!,\n      this._context.config.host,\n      \"publish\",\n    );\n\n    // Convert ServiceBusMessage to AmqpMessage.\n    const amqpMessage = toRheaMessage(message, defaultDataTransformer);\n\n    const encodedMessage = RheaMessageUtil.encode(amqpMessage);\n    let currentSize = this._sizeInBytes;\n\n    // The first time an event is added, we need to calculate\n    // the overhead of creating an AMQP batch, including the\n    // message_annotations, application_properties and message_properties\n    // that are taken from the 1st message.\n    if (this.count === 0) {\n      if (amqpMessage.message_annotations) {\n        this._batchAnnotations = amqpMessage.message_annotations;\n      }\n      if (amqpMessage.application_properties) {\n        this._batchApplicationProperties = amqpMessage.application_properties;\n      }\n      for (const prop of RheaMessagePropertiesList) {\n        if ((amqpMessage as any)[prop]) {\n          (this._batchMessageProperties as any)[prop] = (amqpMessage as any)[prop];\n        }\n      }\n      // Figure out the overhead of creating a batch by generating an empty batch\n      // with the expected batch annotations.\n      currentSize += this._generateBatch(\n        [],\n        this._batchAnnotations,\n        this._batchApplicationProperties,\n        this._batchMessageProperties,\n      ).length;\n    }\n\n    const messageSize = encodedMessage.length;\n    const messageOverhead =\n      messageSize <= smallMessageMaxBytes ? smallMessageOverhead : largeMessageOverhead;\n    currentSize += messageSize + messageOverhead;\n    // Check if the size of the batch exceeds the maximum allowed size\n    // once we add the new event to it.\n    if (currentSize > this._maxSizeInBytes) {\n      return false;\n    }\n\n    // The message will fit in the batch, so it is now safe to store it.\n    this._encodedMessages.push(encodedMessage);\n    if (spanContext) {\n      this._spanContexts.push(spanContext);\n    }\n\n    this._sizeInBytes = currentSize;\n    return true;\n  }\n}\n"]}

package/dist/commonjs/serviceBusRuleManager.d.ts

@@ -0,0 +1,103 @@
+import type { OperationOptionsBase } from "./modelsToBeSharedWithEventHubs.js";
+import type { ConnectionContext } from "./connectionContext.js";
+import type { RetryOptions } from "@azure/core-amqp";
+import type { CorrelationRuleFilter } from "./core/managementClient.js";
+import type { RuleProperties, SqlRuleAction } from "./serializers/ruleResourceSerializer.js";
+import type { SqlRuleFilter } from "./serializers/ruleResourceSerializer.js";
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { OperationOptions } from "@azure/core-client";
+/**
+ * Allows rules for a subscription to be managed. This rule manager requires only Listen claims, whereas the
+ * {@link ServiceBusAdministrationClient} requires Manage claims.
+ */
+export interface ServiceBusRuleManager {
+    /**
+     * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.
+     *
+     * @param ruleName - the name of the rule
+     * @param filter - the filter expression that the rule evaluates.
+     * @param options - The options that can be used to abort, trace and control other configurations on the request.
+     */
+    createRule(ruleName: string, filter: SqlRuleFilter | CorrelationRuleFilter, options?: OperationOptionsBase): Promise<void>;
+    /**
+     * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.
+     *
+     * @param ruleName - the name of the rule
+     * @param filter - the filter expression that the rule evaluates.
+     * @param ruleAction - The SQL like expression that can be executed on the message should the associated filter apply.
+     * @param options - The options that can be used to abort, trace and control other configurations on the request.
+     */
+    createRule(ruleName: string, filter: SqlRuleFilter | CorrelationRuleFilter, ruleAction?: SqlRuleAction, options?: OperationOptionsBase): Promise<void>;
+    /**
+     * Deletes a rule.
+     *
+     * @param ruleName - the name of the rule
+     */
+    deleteRule(ruleName: string, options?: OperationOptionsBase): Promise<void>;
+    /**
+     * Returns an async iterable iterator to list all the rules
+     * under the specified subscription.
+     *
+     * .byPage() returns an async iterable iterator to list the rules in pages.
+     *
+     * @returns An asyncIterableIterator that supports paging.
+     */
+    listRules(options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties>;
+}
+/**
+ * @internal
+ */
+export declare class ServiceBusRuleManagerImpl implements ServiceBusRuleManager {
+    private _context;
+    private _entityPath;
+    private _retryOptions;
+    /**
+     * Denotes if close() was called on this sender
+     */
+    private _isClosed;
+    private name;
+    entityPath: string;
+    /**
+     * @internal
+     * @throws Error if the underlying connection is closed.
+     */
+    constructor(_context: ConnectionContext, _entityPath: string, _retryOptions?: RetryOptions);
+    get isClosed(): boolean;
+    /**
+     * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.
+     *
+     * @param ruleName - the name of the rule
+     * @param filter - the filter expression that the rule evaluates.
+     * @param options - The options that can be used to abort, trace and control other configurations on the request.
+     */
+    createRule(ruleName: string, filter: SqlRuleFilter | CorrelationRuleFilter, options?: OperationOptions): Promise<void>;
+    /**
+     * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.
+     *
+     * @param ruleName - the name of the rule
+     * @param filter - the filter expression that the rule evaluates.
+     * @param ruleAction - The SQL like expression that can be executed on the message should the associated filter apply.
+     * @param options - The options that can be used to abort, trace and control other configurations on the request.
+     */
+    createRule(ruleName: string, filter: SqlRuleFilter | CorrelationRuleFilter, ruleAction?: SqlRuleAction, options?: OperationOptions): Promise<void>;
+    /**
+     * Get all rules associated with the subscription.
+     */
+    private getRules;
+    /**
+     * Returns an async iterable iterator to list all the rules
+     * under the specified subscription.
+     *
+     * .byPage() returns an async iterable iterator to list the rules in pages.
+     *
+     * @returns An asyncIterableIterator that supports paging.
+     */
+    listRules(options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties, RuleProperties[], {
+        maxPageSize?: number;
+    }>;
+    /**
+     * Deletes a rule.
+     */
+    deleteRule(ruleName: string, options?: OperationOptions): Promise<void>;
+}
+//# sourceMappingURL=serviceBusRuleManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serviceBusRuleManager.d.ts","sourceRoot":"","sources":["../../src/serviceBusRuleManager.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAe,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAElE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAExE,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAI7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAE7E,OAAO,KAAK,EAAE,0BAA0B,EAAe,MAAM,oBAAoB,CAAC;AAElF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG3D;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,aAAa,GAAG,qBAAqB,EAC7C,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;;;;OAOG;IACH,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,aAAa,GAAG,qBAAqB,EAC7C,UAAU,CAAC,EAAE,aAAa,EAC1B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACnF;AAED;;GAEG;AACH,qBAAa,yBAA0B,YAAW,qBAAqB;IAanE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,aAAa;IAdvB;;OAEG;IACH,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,IAAI,CAAS;IACd,UAAU,EAAE,MAAM,CAAC;IAE1B;;;OAGG;gBAEO,QAAQ,EAAE,iBAAiB,EAC3B,WAAW,EAAE,MAAM,EACnB,aAAa,GAAE,YAAiB;IAO1C,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;;;;;OAMG;IACH,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,aAAa,GAAG,qBAAqB,EAC7C,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,IAAI,CAAC;IAChB;;;;;;;OAOG;IACH,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,aAAa,GAAG,qBAAqB,EAC7C,UAAU,CAAC,EAAE,aAAa,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,IAAI,CAAC;IA8ChB;;OAEG;YACW,QAAQ;IA2BtB;;;;;;;OAOG;IACI,SAAS,CACd,OAAO,CAAC,EAAE,gBAAgB,GACzB,0BAA0B,CAAC,cAAc,EAAE,cAAc,EAAE,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAuBzF;;OAEG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;CAwBlF"}

package/dist/commonjs/serviceBusRuleManager.js

@@ -0,0 +1,129 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceBusRuleManagerImpl = void 0;
+const core_amqp_1 = require("@azure/core-amqp");
+const log_js_1 = require("./log.js");
+const ruleResourceSerializer_js_1 = require("./serializers/ruleResourceSerializer.js");
+const utils_js_1 = require("./util/utils.js");
+const errors_js_1 = require("./util/errors.js");
+const tracing_js_1 = require("./diagnostics/tracing.js");
+const core_paging_1 = require("@azure/core-paging");
+/**
+ * @internal
+ */
+class ServiceBusRuleManagerImpl {
+    /**
+     * @internal
+     * @throws Error if the underlying connection is closed.
+     */
+    constructor(_context, _entityPath, _retryOptions = {}) {
+        this._context = _context;
+        this._entityPath = _entityPath;
+        this._retryOptions = _retryOptions;
+        /**
+         * Denotes if close() was called on this sender
+         */
+        this._isClosed = false;
+        (0, errors_js_1.throwErrorIfConnectionClosed)(_context);
+        this.entityPath = _entityPath;
+        this.name = (0, utils_js_1.getUniqueName)("ruleManager");
+    }
+    get isClosed() {
+        return this._isClosed || this._context.wasConnectionCloseCalled;
+    }
+    async createRule(ruleName, filter, ruleActionOrOperationOptions, options = {}) {
+        let sqlRuleAction = undefined;
+        let operOptions;
+        if (ruleActionOrOperationOptions) {
+            if ((0, ruleResourceSerializer_js_1.isSqlRuleAction)(ruleActionOrOperationOptions)) {
+                // Overload#2 - where the sqlExpression in the ruleAction is defined
+                sqlRuleAction = ruleActionOrOperationOptions;
+                operOptions = options;
+            }
+            else {
+                // Overload#1 - where the sqlExpression in the ruleAction is undefined
+                operOptions = Object.assign(Object.assign({}, ruleActionOrOperationOptions), options);
+            }
+        }
+        return tracing_js_1.tracingClient.withSpan("ServiceBusRuleManager.createRule", operOptions !== null && operOptions !== void 0 ? operOptions : {}, async (updatedOptions) => {
+            const addRuleOperationPromise = async () => {
+                return this._context
+                    .getManagementClient(this._entityPath)
+                    .addRule(ruleName, filter, sqlRuleAction === null || sqlRuleAction === void 0 ? void 0 : sqlRuleAction.sqlExpression, Object.assign(Object.assign({}, updatedOptions), { associatedLinkName: this.name, requestName: "addRule", timeoutInMs: this._retryOptions.timeoutInMs }));
+            };
+            const config = {
+                operation: addRuleOperationPromise,
+                connectionId: this._context.connectionId,
+                operationType: core_amqp_1.RetryOperationType.management,
+                retryOptions: this._retryOptions,
+                abortSignal: updatedOptions === null || updatedOptions === void 0 ? void 0 : updatedOptions.abortSignal,
+            };
+            return (0, core_amqp_1.retry)(config);
+        });
+    }
+    /**
+     * Get all rules associated with the subscription.
+     */
+    async getRules(options) {
+        return tracing_js_1.tracingClient.withSpan("ServiceBusRuleManager.getRules", options !== null && options !== void 0 ? options : {}, async (updatedOptions) => {
+            const getRulesOperationPromise = async () => {
+                return this._context.getManagementClient(this._entityPath).getRules(Object.assign(Object.assign({}, updatedOptions), { associatedLinkName: this.name, requestName: "getRules", timeoutInMs: this._retryOptions.timeoutInMs }));
+            };
+            const config = {
+                operation: getRulesOperationPromise,
+                connectionId: this._context.connectionId,
+                operationType: core_amqp_1.RetryOperationType.management,
+                retryOptions: this._retryOptions,
+                abortSignal: updatedOptions === null || updatedOptions === void 0 ? void 0 : updatedOptions.abortSignal,
+            };
+            return (0, core_amqp_1.retry)(config);
+        });
+    }
+    /**
+     * Returns an async iterable iterator to list all the rules
+     * under the specified subscription.
+     *
+     * .byPage() returns an async iterable iterator to list the rules in pages.
+     *
+     * @returns An asyncIterableIterator that supports paging.
+     */
+    listRules(options) {
+        log_js_1.ruleManagerLogger.verbose(`Performing operation - listRules() with options: %j`, options);
+        const pagedResult = {
+            firstPageLink: 0,
+            getPage: async (pageLink, maxPageSize) => {
+                const top = maxPageSize !== null && maxPageSize !== void 0 ? maxPageSize : 100;
+                const rules = await this.getRules(Object.assign({ skip: pageLink, maxCount: top }, options));
+                return rules.length
+                    ? {
+                        page: rules,
+                        nextPageLink: rules.length > 0 ? pageLink + rules.length : undefined,
+                    }
+                    : undefined;
+            },
+        };
+        return (0, core_paging_1.getPagedAsyncIterator)(pagedResult);
+    }
+    /**
+     * Deletes a rule.
+     */
+    async deleteRule(ruleName, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("ServiceBusRuleManager.deleteRule", options, async (updatedOptions) => {
+            const removeRuleOperationPromise = async () => {
+                return this._context.getManagementClient(this._entityPath).removeRule(ruleName, Object.assign(Object.assign({}, updatedOptions), { associatedLinkName: this.name, requestName: "removeRule", timeoutInMs: this._retryOptions.timeoutInMs }));
+            };
+            const config = {
+                operation: removeRuleOperationPromise,
+                connectionId: this._context.connectionId,
+                operationType: core_amqp_1.RetryOperationType.management,
+                retryOptions: this._retryOptions,
+                abortSignal: updatedOptions === null || updatedOptions === void 0 ? void 0 : updatedOptions.abortSignal,
+            };
+            return (0, core_amqp_1.retry)(config);
+        });
+    }
+}
+exports.ServiceBusRuleManagerImpl = ServiceBusRuleManagerImpl;
+//# sourceMappingURL=serviceBusRuleManager.js.map

package/dist/commonjs/serviceBusRuleManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceBusRuleManager.js","sourceRoot":"","sources":["../../src/serviceBusRuleManager.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAKlC,gDAA6D;AAE7D,qCAAuD;AAEvD,uFAA0E;AAC1E,8CAAgD;AAChD,gDAAgE;AAEhE,yDAAyD;AAEzD,oDAA2D;AAoD3D;;GAEG;AACH,MAAa,yBAAyB;IAQpC;;;OAGG;IACH,YACU,QAA2B,EAC3B,WAAmB,EACnB,gBAA8B,EAAE;QAFhC,aAAQ,GAAR,QAAQ,CAAmB;QAC3B,gBAAW,GAAX,WAAW,CAAQ;QACnB,kBAAa,GAAb,aAAa,CAAmB;QAd1C;;WAEG;QACK,cAAS,GAAY,KAAK,CAAC;QAajC,IAAA,wCAA4B,EAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAA,wBAAa,EAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAClE,CAAC;IA4BD,KAAK,CAAC,UAAU,CACd,QAAgB,EAChB,MAA6C,EAC7C,4BAAmE,EACnE,UAA4B,EAAE;QAE9B,IAAI,aAAa,GAA8B,SAAS,CAAC;QACzD,IAAI,WAAyC,CAAC;QAC9C,IAAI,4BAA4B,EAAE,CAAC;YACjC,IAAI,IAAA,2CAAe,EAAC,4BAA4B,CAAC,EAAE,CAAC;gBAClD,oEAAoE;gBACpE,aAAa,GAAG,4BAA4B,CAAC;gBAC7C,WAAW,GAAG,OAAO,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACN,sEAAsE;gBACtE,WAAW,mCAAQ,4BAA4B,GAAK,OAAO,CAAE,CAAC;YAChE,CAAC;QACH,CAAC;QAED,OAAO,0BAAa,CAAC,QAAQ,CAC3B,kCAAkC,EAClC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,EAAE,EACjB,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,uBAAuB,GAAG,KAAK,IAAmB,EAAE;gBACxD,OAAO,IAAI,CAAC,QAAQ;qBACjB,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC;qBACrC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,aAAa,kCAClD,cAAc,KACjB,kBAAkB,EAAE,IAAI,CAAC,IAAI,EAC7B,WAAW,EAAE,SAAS,EACtB,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,IAC3C,CAAC;YACP,CAAC,CAAC;YACF,MAAM,MAAM,GAAsB;gBAChC,SAAS,EAAE,uBAAuB;gBAClC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;gBACxC,aAAa,EAAE,8BAAkB,CAAC,UAAU;gBAC5C,YAAY,EAAE,IAAI,CAAC,aAAa;gBAChC,WAAW,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW;aACzC,CAAC;YACF,OAAO,IAAA,iBAAK,EAAO,MAAM,CAAC,CAAC;QAC7B,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,QAAQ,CACpB,OAA+C;QAE/C,OAAO,0BAAa,CAAC,QAAQ,CAC3B,gCAAgC,EAChC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,EACb,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,wBAAwB,GAAG,KAAK,IAA+B,EAAE;gBACrE,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,iCAC9D,cAAc,KACjB,kBAAkB,EAAE,IAAI,CAAC,IAAI,EAC7B,WAAW,EAAE,UAAU,EACvB,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,IAC3C,CAAC;YACL,CAAC,CAAC;YACF,MAAM,MAAM,GAAkC;gBAC5C,SAAS,EAAE,wBAAwB;gBACnC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;gBACxC,aAAa,EAAE,8BAAkB,CAAC,UAAU;gBAC5C,YAAY,EAAE,IAAI,CAAC,aAAa;gBAChC,WAAW,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW;aACzC,CAAC;YACF,OAAO,IAAA,iBAAK,EAAmB,MAAM,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CACd,OAA0B;QAE1B,0BAAM,CAAC,OAAO,CAAC,qDAAqD,EAAE,OAAO,CAAC,CAAC;QAC/E,MAAM,WAAW,GAAoE;YACnF,aAAa,EAAE,CAAC;YAChB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE;gBACvC,MAAM,GAAG,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,GAAG,CAAC;gBAC/B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,iBAC/B,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,GAAG,IACV,OAAO,EACV,CAAC;gBACH,OAAO,KAAK,CAAC,MAAM;oBACjB,CAAC,CAAC;wBACE,IAAI,EAAE,KAAK;wBACX,YAAY,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;qBACrE;oBACH,CAAC,CAAC,SAAS,CAAC;YAChB,CAAC;SACF,CAAC;QAEF,OAAO,IAAA,mCAAqB,EAAC,WAAW,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,UAA4B,EAAE;QAC/D,OAAO,0BAAa,CAAC,QAAQ,CAC3B,kCAAkC,EAClC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,0BAA0B,GAAG,KAAK,IAAmB,EAAE;gBAC3D,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,QAAQ,kCACzE,cAAc,KACjB,kBAAkB,EAAE,IAAI,CAAC,IAAI,EAC7B,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,IAC3C,CAAC;YACL,CAAC,CAAC;YACF,MAAM,MAAM,GAAsB;gBAChC,SAAS,EAAE,0BAA0B;gBACrC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;gBACxC,aAAa,EAAE,8BAAkB,CAAC,UAAU;gBAC5C,YAAY,EAAE,IAAI,CAAC,aAAa;gBAChC,WAAW,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW;aACzC,CAAC;YACF,OAAO,IAAA,iBAAK,EAAO,MAAM,CAAC,CAAC;QAC7B,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AA3LD,8DA2LC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OperationOptionsBase } from \"./modelsToBeSharedWithEventHubs.js\";\nimport type { ConnectionContext } from \"./connectionContext.js\";\nimport type { RetryConfig, RetryOptions } from \"@azure/core-amqp\";\nimport { RetryOperationType, retry } from \"@azure/core-amqp\";\nimport type { CorrelationRuleFilter } from \"./core/managementClient.js\";\nimport { ruleManagerLogger as logger } from \"./log.js\";\nimport type { RuleProperties, SqlRuleAction } from \"./serializers/ruleResourceSerializer.js\";\nimport { isSqlRuleAction } from \"./serializers/ruleResourceSerializer.js\";\nimport { getUniqueName } from \"./util/utils.js\";\nimport { throwErrorIfConnectionClosed } from \"./util/errors.js\";\nimport type { SqlRuleFilter } from \"./serializers/ruleResourceSerializer.js\";\nimport { tracingClient } from \"./diagnostics/tracing.js\";\nimport type { PagedAsyncIterableIterator, PagedResult } from \"@azure/core-paging\";\nimport { getPagedAsyncIterator } from \"@azure/core-paging\";\nimport type { OperationOptions } from \"@azure/core-client\";\nimport type { ListRequestOptions } from \"./serviceBusAtomManagementClient.js\";\n\n/**\n * Allows rules for a subscription to be managed. This rule manager requires only Listen claims, whereas the\n * {@link ServiceBusAdministrationClient} requires Manage claims.\n */\nexport interface ServiceBusRuleManager {\n  /**\n   * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.\n   *\n   * @param ruleName - the name of the rule\n   * @param filter - the filter expression that the rule evaluates.\n   * @param options - The options that can be used to abort, trace and control other configurations on the request.\n   */\n  createRule(\n    ruleName: string,\n    filter: SqlRuleFilter | CorrelationRuleFilter,\n    options?: OperationOptionsBase,\n  ): Promise<void>;\n  /**\n   * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.\n   *\n   * @param ruleName - the name of the rule\n   * @param filter - the filter expression that the rule evaluates.\n   * @param ruleAction - The SQL like expression that can be executed on the message should the associated filter apply.\n   * @param options - The options that can be used to abort, trace and control other configurations on the request.\n   */\n  createRule(\n    ruleName: string,\n    filter: SqlRuleFilter | CorrelationRuleFilter,\n    ruleAction?: SqlRuleAction,\n    options?: OperationOptionsBase,\n  ): Promise<void>;\n  /**\n   * Deletes a rule.\n   *\n   * @param ruleName - the name of the rule\n   */\n  deleteRule(ruleName: string, options?: OperationOptionsBase): Promise<void>;\n  /**\n   * Returns an async iterable iterator to list all the rules\n   * under the specified subscription.\n   *\n   * .byPage() returns an async iterable iterator to list the rules in pages.\n   *\n   * @returns An asyncIterableIterator that supports paging.\n   */\n  listRules(options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties>;\n}\n\n/**\n * @internal\n */\nexport class ServiceBusRuleManagerImpl implements ServiceBusRuleManager {\n  /**\n   * Denotes if close() was called on this sender\n   */\n  private _isClosed: boolean = false;\n  private name: string;\n  public entityPath: string;\n\n  /**\n   * @internal\n   * @throws Error if the underlying connection is closed.\n   */\n  constructor(\n    private _context: ConnectionContext,\n    private _entityPath: string,\n    private _retryOptions: RetryOptions = {},\n  ) {\n    throwErrorIfConnectionClosed(_context);\n    this.entityPath = _entityPath;\n    this.name = getUniqueName(\"ruleManager\");\n  }\n\n  public get isClosed(): boolean {\n    return this._isClosed || this._context.wasConnectionCloseCalled;\n  }\n\n  /**\n   * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.\n   *\n   * @param ruleName - the name of the rule\n   * @param filter - the filter expression that the rule evaluates.\n   * @param options - The options that can be used to abort, trace and control other configurations on the request.\n   */\n  createRule(\n    ruleName: string,\n    filter: SqlRuleFilter | CorrelationRuleFilter,\n    options?: OperationOptions,\n  ): Promise<void>;\n  /**\n   * Adds a rule to the current subscription to filter the messages reaching from topic to the subscription.\n   *\n   * @param ruleName - the name of the rule\n   * @param filter - the filter expression that the rule evaluates.\n   * @param ruleAction - The SQL like expression that can be executed on the message should the associated filter apply.\n   * @param options - The options that can be used to abort, trace and control other configurations on the request.\n   */\n  createRule(\n    ruleName: string,\n    filter: SqlRuleFilter | CorrelationRuleFilter,\n    ruleAction?: SqlRuleAction,\n    options?: OperationOptions,\n  ): Promise<void>;\n  async createRule(\n    ruleName: string,\n    filter: SqlRuleFilter | CorrelationRuleFilter,\n    ruleActionOrOperationOptions?: SqlRuleAction | OperationOptionsBase,\n    options: OperationOptions = {},\n  ): Promise<void> {\n    let sqlRuleAction: SqlRuleAction | undefined = undefined;\n    let operOptions: OperationOptions | undefined;\n    if (ruleActionOrOperationOptions) {\n      if (isSqlRuleAction(ruleActionOrOperationOptions)) {\n        // Overload#2 - where the sqlExpression in the ruleAction is defined\n        sqlRuleAction = ruleActionOrOperationOptions;\n        operOptions = options;\n      } else {\n        // Overload#1 - where the sqlExpression in the ruleAction is undefined\n        operOptions = { ...ruleActionOrOperationOptions, ...options };\n      }\n    }\n\n    return tracingClient.withSpan(\n      \"ServiceBusRuleManager.createRule\",\n      operOptions ?? {},\n      async (updatedOptions) => {\n        const addRuleOperationPromise = async (): Promise<void> => {\n          return this._context\n            .getManagementClient(this._entityPath)\n            .addRule(ruleName, filter, sqlRuleAction?.sqlExpression, {\n              ...updatedOptions,\n              associatedLinkName: this.name,\n              requestName: \"addRule\",\n              timeoutInMs: this._retryOptions.timeoutInMs,\n            });\n        };\n        const config: RetryConfig<void> = {\n          operation: addRuleOperationPromise,\n          connectionId: this._context.connectionId,\n          operationType: RetryOperationType.management,\n          retryOptions: this._retryOptions,\n          abortSignal: updatedOptions?.abortSignal,\n        };\n        return retry<void>(config);\n      },\n    );\n  }\n\n  /**\n   * Get all rules associated with the subscription.\n   */\n  private async getRules(\n    options?: ListRequestOptions & OperationOptions,\n  ): Promise<RuleProperties[]> {\n    return tracingClient.withSpan(\n      \"ServiceBusRuleManager.getRules\",\n      options ?? {},\n      async (updatedOptions) => {\n        const getRulesOperationPromise = async (): Promise<RuleProperties[]> => {\n          return this._context.getManagementClient(this._entityPath).getRules({\n            ...updatedOptions,\n            associatedLinkName: this.name,\n            requestName: \"getRules\",\n            timeoutInMs: this._retryOptions.timeoutInMs,\n          });\n        };\n        const config: RetryConfig<RuleProperties[]> = {\n          operation: getRulesOperationPromise,\n          connectionId: this._context.connectionId,\n          operationType: RetryOperationType.management,\n          retryOptions: this._retryOptions,\n          abortSignal: updatedOptions?.abortSignal,\n        };\n        return retry<RuleProperties[]>(config);\n      },\n    );\n  }\n\n  /**\n   * Returns an async iterable iterator to list all the rules\n   * under the specified subscription.\n   *\n   * .byPage() returns an async iterable iterator to list the rules in pages.\n   *\n   * @returns An asyncIterableIterator that supports paging.\n   */\n  public listRules(\n    options?: OperationOptions,\n  ): PagedAsyncIterableIterator<RuleProperties, RuleProperties[], { maxPageSize?: number }> {\n    logger.verbose(`Performing operation - listRules() with options: %j`, options);\n    const pagedResult: PagedResult<RuleProperties[], { maxPageSize?: number }, number> = {\n      firstPageLink: 0,\n      getPage: async (pageLink, maxPageSize) => {\n        const top = maxPageSize ?? 100;\n        const rules = await this.getRules({\n          skip: pageLink,\n          maxCount: top,\n          ...options,\n        });\n        return rules.length\n          ? {\n              page: rules,\n              nextPageLink: rules.length > 0 ? pageLink + rules.length : undefined,\n            }\n          : undefined;\n      },\n    };\n\n    return getPagedAsyncIterator(pagedResult);\n  }\n\n  /**\n   * Deletes a rule.\n   */\n  async deleteRule(ruleName: string, options: OperationOptions = {}): Promise<void> {\n    return tracingClient.withSpan(\n      \"ServiceBusRuleManager.deleteRule\",\n      options,\n      async (updatedOptions) => {\n        const removeRuleOperationPromise = async (): Promise<void> => {\n          return this._context.getManagementClient(this._entityPath).removeRule(ruleName, {\n            ...updatedOptions,\n            associatedLinkName: this.name,\n            requestName: \"removeRule\",\n            timeoutInMs: this._retryOptions.timeoutInMs,\n          });\n        };\n        const config: RetryConfig<void> = {\n          operation: removeRuleOperationPromise,\n          connectionId: this._context.connectionId,\n          operationType: RetryOperationType.management,\n          retryOptions: this._retryOptions,\n          abortSignal: updatedOptions?.abortSignal,\n        };\n        return retry<void>(config);\n      },\n    );\n  }\n}\n"]}