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

package/dist/esm/util/utils.d.ts

@@ -0,0 +1,247 @@
+import type { ServiceBusLogger } from "../log.js";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import { AbortError } from "@azure/abort-controller";
+import type { PipelineResponse } from "@azure/core-rest-pipeline";
+import type { HttpResponse } from "./compat/index.js";
+/**
+ * @internal
+ * Provides a uniue name by appending a string guid to the given string in the following format:
+ * `{name}-{uuid}`.
+ * @param name - The nme of the entity
+ */
+export declare function getUniqueName(name: string): string;
+/**
+ * @internal
+ * Returns the passed identifier if it is not undefined or empty;
+ * otherwise generate and returns a unique one in the following format;
+ *   `{prefix}-{uuid}`.
+ * @param prefix - The prefix used to generate identifier
+ * @param identifier - an identifier name
+ */
+export declare function ensureValidIdentifier(prefix: string, identifier?: string): string;
+/**
+ * @internal
+ * If you try to turn a Guid into a Buffer in .NET, the bytes of the first three groups get
+ * flipped within the group, but the last two groups don't get flipped, so we end up with a
+ * different byte order. This is the order of bytes needed to make Service Bus recognize the token.
+ *
+ * @param lockToken - The lock token whose bytes need to be reorded.
+ * @returns Buffer representing reordered bytes.
+ */
+export declare function reorderLockToken(lockTokenBytes: Buffer): Buffer;
+/**
+ * @internal
+ * Provides the time in milliseconds after which the lock renewal should occur.
+ * @param lockedUntilUtc - The time until which the message is locked.
+ */
+export declare function calculateRenewAfterDuration(lockedUntilUtc: Date): number;
+/**
+ * @internal
+ * Converts the .net ticks to a JS Date object.
+ *
+ * - The epoch for the DateTimeOffset type is `0000-01-01`, while the epoch for JS Dates is
+ * `1970-01-01`.
+ * - The DateTimeOffset ticks value for the date `1970-01-01` is `621355968000000000`.
+ *   - Hence, to convert it to the JS epoch; we `subtract` the delta from the given value.
+ * - Ticks in DateTimeOffset is `1/10000000` second, while ticks in JS Date is `1/1000` second.
+ *   - Thus, we `divide` the value by `10000` to convert it to JS Date ticks.
+ *
+ * @param buf - Input as a Buffer
+ * @returns The JS Date object.
+ */
+export declare function convertTicksToDate(buf: number[]): Date;
+/**
+ * @internal
+ * Converts any given input to a Buffer.
+ * @param input - The input that needs to be converted to a Buffer.
+ */
+export declare function toBuffer(input: unknown): Buffer;
+/**
+ * @internal
+ * Helper utility to retrieve `string` value from given string,
+ * or throws error if undefined.
+ */
+export declare function getString(value: unknown, nameOfProperty: string): string;
+/**
+ * @internal
+ * Helper utility to retrieve `string` value from given input,
+ * or undefined if not passed in.
+ */
+export declare function getStringOrUndefined(value: any): string | undefined;
+/**
+ * @internal
+ * Helper utility to retrieve `integer` value from given string,
+ * or throws error if undefined.
+ */
+export declare function getInteger(value: unknown, nameOfProperty: string): number;
+/**
+ * @internal
+ * Helper utility to retrieve `integer` value from given string,
+ * or undefined if not passed in.
+ */
+export declare function getIntegerOrUndefined(value: any): number | undefined;
+/**
+ * @internal
+ * Helper utility to convert ISO-8601 time into Date type.
+ */
+export declare function getDate(value: string, nameOfProperty: string): Date;
+/**
+ * @internal
+ * Helper utility to retrieve `boolean` value from given string,
+ * or throws error if undefined.
+ */
+export declare function getBoolean(value: unknown, nameOfProperty: string): boolean;
+/**
+ * @internal
+ * Helper utility to retrieve `boolean` value from given string,
+ * or undefined if not passed in.
+ */
+export declare function getBooleanOrUndefined(value: any): boolean | undefined;
+/**
+ * @internal
+ * Returns `true` if given input is a JSON like object.
+ */
+export declare function isJSONLikeObject(value: any): boolean;
+/**
+ * @internal
+ * Helper utility to retrieve message count details from given input,
+ */
+export declare function getMessageCountDetails(value: any): MessageCountDetails;
+/**
+ * @internal
+ * Gets the xmlns prefix from the root of the objects that are part of the parsed response body.
+ */
+export declare function getXMLNSPrefix(value: any): string;
+/**
+ * Represents type of message count details in ATOM based management operations.
+ * @internal
+ */
+export type MessageCountDetails = {
+    activeMessageCount: number;
+    deadLetterMessageCount: number;
+    scheduledMessageCount: number;
+    transferMessageCount: number;
+    transferDeadLetterMessageCount: number;
+};
+/**
+ * Represents type of `AuthorizationRule` in ATOM based management operations.
+ */
+export interface AuthorizationRule {
+    /**
+     * The claim type.
+     */
+    claimType: string;
+    /**
+     * The list of rights("Manage" | "Send" | "Listen").
+     */
+    accessRights?: ("Manage" | "Send" | "Listen")[];
+    /**
+     * The authorization rule key name.
+     */
+    keyName: string;
+    /**
+     * The primary key for the authorization rule.
+     */
+    primaryKey?: string;
+    /**
+     * The secondary key for the authorization rule.
+     */
+    secondaryKey?: string;
+}
+/**
+ * @internal
+ * Helper utility to retrieve array of `AuthorizationRule` from given input,
+ * or undefined if not passed in.
+ */
+export declare function getAuthorizationRulesOrUndefined(value: any): AuthorizationRule[] | undefined;
+/**
+ * @internal
+ * Helper utility to extract output containing array of `RawAuthorizationRule` instances from given input,
+ * or undefined if not passed in.
+ */
+export declare function getRawAuthorizationRules(authorizationRules: AuthorizationRule[] | undefined): any;
+/**
+ * @internal
+ * Helper utility to check if given string is an absolute URL
+ */
+export declare function isAbsoluteUrl(url: string): boolean;
+/**
+ * Possible values for `status` of the Service Bus messaging entities.
+ */
+export type EntityStatus = "Active" | "Creating" | "Deleting" | "ReceiveDisabled" | "SendDisabled" | "Disabled" | "Renaming" | "Restoring" | "Unknown";
+/**
+ * Possible values for `availabilityStatus` of the Service Bus messaging entities.
+ */
+export type EntityAvailabilityStatus = "Available" | "Limited" | "Renaming" | "Restoring" | "Unknown";
+/**
+ * @internal
+ */
+type setTimeoutArgs = (callback: (...args: any[]) => void, ms: number, ...args: any[]) => any;
+/**
+ * An executor for a function that returns a Promise that obeys both a timeout and an
+ * optional AbortSignal.
+ * @param timeoutMs - The number of milliseconds to allow before throwing an OperationTimeoutError.
+ * @param timeoutMessage - The message to place in the .description field for the thrown exception for Timeout.
+ * @param abortSignal - The abortSignal associated with containing operation.
+ * @param abortErrorMsg - The abort error message associated with containing operation.
+ * @param value - The value to be resolved with after a timeout of t milliseconds.
+ *
+ * @internal
+ */
+export declare function waitForTimeoutOrAbortOrResolve<T>(args: {
+    actionFn: () => Promise<T>;
+    timeoutMs: number;
+    timeoutMessage: string;
+    abortSignal?: AbortSignalLike;
+    timeoutFunctions?: {
+        setTimeoutFn: setTimeoutArgs;
+        clearTimeoutFn: (timeoutId: any) => void;
+    };
+}): Promise<T>;
+/**
+ * Registers listener to the abort event on the abortSignal to call your abortFn and
+ * returns a function that will clear the same listener.
+ *
+ * If abort signal is already aborted, then throws an AbortError and returns a function that does nothing
+ *
+ * @returns A function that removes any of our attached event listeners on the abort signal or an empty function if
+ * the abortSignal was not defined.
+ *
+ * @internal
+ */
+export declare function checkAndRegisterWithAbortSignal(onAbortFn: (abortError: AbortError) => void, abortSignal?: AbortSignalLike): () => void;
+/**
+ * @internal
+ * The user agent prefix string for the ServiceBus client.
+ * See guideline at https://azure.github.io/azure-sdk/general_azurecore.html#telemetry-policy
+ */
+export declare const libInfo: string;
+/**
+ * @internal
+ * Returns the formatted prefix by removing the spaces, by appending the libInfo.
+ */
+export declare function formatUserAgentPrefix(prefix?: string): string;
+/**
+ * @internal
+ * Helper method which returns `HttpResponse` from an object of shape `PipelineResponse`.
+ * TODO: remove this and use toHttpResponse() directly
+ */
+export declare const getHttpResponseOnly: (pipelineResponse: PipelineResponse) => HttpResponse;
+/**
+ * @internal
+ * Type with the service versions for the ATOM API.
+ */
+export type ServiceBusAtomAPIVersion = "2021-05" | "2017-04";
+/**
+ * @internal
+ * Waits for one second if a sender is not sendable then check again. Throws
+ * SenderBusyError if it is still not sendable.
+ * Only waits when operation timeout is greater than one second.
+ * @returns the actual waiting time.
+ */
+export declare function waitForSendable(sendLogger: ServiceBusLogger, logPrefix: string, name: string, timeout: number, sender: {
+    sendable: () => boolean;
+    credit: number;
+} | undefined, outgoingAvaiable: number): Promise<number>;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/dist/esm/util/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/util/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAMlD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAElE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAKtD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjF;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,CA2B/D;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,cAAc,EAAE,IAAI,GAAG,MAAM,CAcxE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAOtD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CA2B/C;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAQxE;AAED;;;;GAIG;AAEH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAKnE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAQzE;AAED;;;;GAIG;AAEH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAMpE;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,CAEnE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAQ1E;AAED;;;;GAIG;AAEH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,GAAG,SAAS,CAKrE;AAQD;;;GAGG;AAEH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAcpD;AAED;;;GAGG;AAEH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,GAAG,GAAG,mBAAmB,CAatE;AAED;;;GAGG;AAEH,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,CAiCjD;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,8BAA8B,EAAE,MAAM,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AAEH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,GAAG,GAAG,iBAAiB,EAAE,GAAG,SAAS,CAqB5F;AA0BD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,SAAS,GAAG,GAAG,CAoBjG;AAoCD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAGlD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,UAAU,GACV,UAAU,GACV,iBAAiB,GACjB,cAAc,GACd,UAAU,GACV,UAAU,GACV,WAAW,GACX,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,WAAW,GACX,SAAS,GACT,UAAU,GACV,WAAW,GACX,SAAS,CAAC;AAEd;;GAEG;AACH,KAAK,cAAc,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAE9F;;;;;;;;;;GAUG;AACH,wBAAsB,8BAA8B,CAAC,CAAC,EAAE,IAAI,EAAE;IAC5D,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B,gBAAgB,CAAC,EAAE;QACjB,YAAY,EAAE,cAAc,CAAC;QAC7B,cAAc,EAAE,CAAC,SAAS,EAAE,GAAG,KAAK,IAAI,CAAC;KAC1C,CAAC;CACH,GAAG,OAAO,CAAC,CAAC,CAAC,CA6Bb;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,EAC3C,WAAW,CAAC,EAAE,eAAe,GAC5B,MAAM,IAAI,CAmBZ;AAED;;;;GAIG;AACH,eAAO,MAAM,OAAO,EAAE,MAAwE,CAAC;AAE/F;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,kBAAkB,gBAAgB,KAAG,YACvC,CAAC;AAEnC;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,SAAS,CAAC;AAE7D;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,UAAU,EAAE,gBAAgB,EAC5B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,MAAM,EACF;IACE,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB,GACD,SAAS,EACb,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,CAAC,CAkCjB"}