rhea-promise - npm Package Compare versions

Comparing version 2.1.0 to 3.0.0

changelog.md

@@ -0,1 +1,10 @@
+### 3.0.0 - (2023-03-02)
+
+- Update `rhea` dependency to the 3.x major version.
+- Update dev dependency `typescript` to `~4.3.0`
+
+#### Breaking changes
+
+- rhea has one breaking change introduced in version 3.x that impact this library: The TLS options type to `Container.listen()` now requires a `transport` property which is either "ssl" or "tls".
+
 ### 2.1.0 - (2021-06-30)
@@ -2,0 +11,0 @@

dist/lib/awaitableSender.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AwaitableSender = void 0;
 const rhea_1 = require("rhea");
@@ -7,0 +8,0 @@ const log = require("./log");

dist/lib/connection.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connection = void 0;
 const tslib_1 = require("tslib");
@@ -31,7 +32,2 @@ const log = require("./log");
         super();
-        if (!options)
-            options = {};
-        if (options.operationTimeoutInSeconds == undefined) {
-            options.operationTimeoutInSeconds = constants_1.defaultOperationTimeoutInSeconds;
-        }
         if (isCreatedRheaConnectionOptions(options)) {
@@ -42,3 +38,8 @@ this._connection = options.rheaConnection;
         else {
-            const connectionOptions = options;
+            let connectionOptions = options;
+            if (!connectionOptions)
+                connectionOptions = { transport: "tls" };
+            if (connectionOptions.operationTimeoutInSeconds == undefined) {
+                connectionOptions.operationTimeoutInSeconds = constants_1.defaultOperationTimeoutInSeconds;
+            }
             if (connectionOptions.webSocketOptions) {
@@ -50,2 +51,3 @@ const ws = rhea_1.websocket_connect(connectionOptions.webSocketOptions.webSocket);
             this.container = container_1.Container.copyFromContainerInstance(this._connection.container);
+            options = connectionOptions;
         }
@@ -487,4 +489,4 @@ this.options = this._connection.options;
             const [sender, receiver] = yield Promise.all([
-                session.createSender(Object.assign({}, senderOptions, { abortSignal })),
-                session.createReceiver(Object.assign({}, receiverOptions, { abortSignal }))
+                session.createSender(Object.assign(Object.assign({}, senderOptions), { abortSignal })),
+                session.createReceiver(Object.assign(Object.assign({}, receiverOptions), { abortSignal }))
             ]);
@@ -491,0 +493,0 @@ log.connection("[%s] Successfully created the sender '%s' and receiver '%s' on the same " +

dist/lib/container.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Container = void 0;
 const tslib_1 = require("tslib");
@@ -7,0 +8,0 @@ const rhea_1 = require("rhea");

dist/lib/entity.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entity = void 0;
 const events_1 = require("events");
@@ -7,0 +8,0 @@ /**

dist/lib/errorDefinitions.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SendOperationFailedError = exports.InsufficientCreditError = exports.OperationTimeoutError = void 0;
 /**
@@ -7,0 +8,0 @@ * Defines the error that occurs when an operation timeout occurs.

dist/lib/eventContext.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventContext = void 0;
 const connection_1 = require("./connection");
@@ -7,0 +8,0 @@ const session_1 = require("./session");

dist/lib/index.js

@@ -5,40 +5,41 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SendOperationFailedError = exports.OperationTimeoutError = exports.InsufficientCreditError = exports.parseConnectionString = exports.messageProperties = exports.messageHeader = exports.delay = exports.isAmqpError = exports.AmqpResponseStatusCode = exports.AwaitableSender = exports.SenderSendOptions = exports.Sender = exports.Receiver = exports.Session = exports.Connection = exports.Container = exports.EventContext = exports.Typed = exports.SessionEvents = exports.ConnectionEvents = exports.SenderEvents = exports.ReceiverEvents = exports.string_to_uuid = exports.generate_uuid = exports.uuid_to_string = exports.filter = exports.message = exports.types = void 0;
 var rhea_1 = require("rhea");
-exports.types = rhea_1.types;
-exports.message = rhea_1.message;
-exports.filter = rhea_1.filter;
-exports.uuid_to_string = rhea_1.uuid_to_string;
-exports.generate_uuid = rhea_1.generate_uuid;
-exports.string_to_uuid = rhea_1.string_to_uuid;
-exports.ReceiverEvents = rhea_1.ReceiverEvents;
-exports.SenderEvents = rhea_1.SenderEvents;
-exports.ConnectionEvents = rhea_1.ConnectionEvents;
-exports.SessionEvents = rhea_1.SessionEvents;
-exports.Typed = rhea_1.Typed;
+Object.defineProperty(exports, "types", { enumerable: true, get: function () { return rhea_1.types; } });
+Object.defineProperty(exports, "message", { enumerable: true, get: function () { return rhea_1.message; } });
+Object.defineProperty(exports, "filter", { enumerable: true, get: function () { return rhea_1.filter; } });
+Object.defineProperty(exports, "uuid_to_string", { enumerable: true, get: function () { return rhea_1.uuid_to_string; } });
+Object.defineProperty(exports, "generate_uuid", { enumerable: true, get: function () { return rhea_1.generate_uuid; } });
+Object.defineProperty(exports, "string_to_uuid", { enumerable: true, get: function () { return rhea_1.string_to_uuid; } });
+Object.defineProperty(exports, "ReceiverEvents", { enumerable: true, get: function () { return rhea_1.ReceiverEvents; } });
+Object.defineProperty(exports, "SenderEvents", { enumerable: true, get: function () { return rhea_1.SenderEvents; } });
+Object.defineProperty(exports, "ConnectionEvents", { enumerable: true, get: function () { return rhea_1.ConnectionEvents; } });
+Object.defineProperty(exports, "SessionEvents", { enumerable: true, get: function () { return rhea_1.SessionEvents; } });
+Object.defineProperty(exports, "Typed", { enumerable: true, get: function () { return rhea_1.Typed; } });
 var eventContext_1 = require("./eventContext");
-exports.EventContext = eventContext_1.EventContext;
+Object.defineProperty(exports, "EventContext", { enumerable: true, get: function () { return eventContext_1.EventContext; } });
 var container_1 = require("./container");
-exports.Container = container_1.Container;
+Object.defineProperty(exports, "Container", { enumerable: true, get: function () { return container_1.Container; } });
 var connection_1 = require("./connection");
-exports.Connection = connection_1.Connection;
+Object.defineProperty(exports, "Connection", { enumerable: true, get: function () { return connection_1.Connection; } });
 var session_1 = require("./session");
-exports.Session = session_1.Session;
+Object.defineProperty(exports, "Session", { enumerable: true, get: function () { return session_1.Session; } });
 var receiver_1 = require("./receiver");
-exports.Receiver = receiver_1.Receiver;
+Object.defineProperty(exports, "Receiver", { enumerable: true, get: function () { return receiver_1.Receiver; } });
 var sender_1 = require("./sender");
-exports.Sender = sender_1.Sender;
-exports.SenderSendOptions = sender_1.SenderSendOptions;
+Object.defineProperty(exports, "Sender", { enumerable: true, get: function () { return sender_1.Sender; } });
+Object.defineProperty(exports, "SenderSendOptions", { enumerable: true, get: function () { return sender_1.SenderSendOptions; } });
 var awaitableSender_1 = require("./awaitableSender");
-exports.AwaitableSender = awaitableSender_1.AwaitableSender;
+Object.defineProperty(exports, "AwaitableSender", { enumerable: true, get: function () { return awaitableSender_1.AwaitableSender; } });
 var utils_1 = require("./util/utils");
-exports.AmqpResponseStatusCode = utils_1.AmqpResponseStatusCode;
-exports.isAmqpError = utils_1.isAmqpError;
-exports.delay = utils_1.delay;
-exports.messageHeader = utils_1.messageHeader;
-exports.messageProperties = utils_1.messageProperties;
-exports.parseConnectionString = utils_1.parseConnectionString;
+Object.defineProperty(exports, "AmqpResponseStatusCode", { enumerable: true, get: function () { return utils_1.AmqpResponseStatusCode; } });
+Object.defineProperty(exports, "isAmqpError", { enumerable: true, get: function () { return utils_1.isAmqpError; } });
+Object.defineProperty(exports, "delay", { enumerable: true, get: function () { return utils_1.delay; } });
+Object.defineProperty(exports, "messageHeader", { enumerable: true, get: function () { return utils_1.messageHeader; } });
+Object.defineProperty(exports, "messageProperties", { enumerable: true, get: function () { return utils_1.messageProperties; } });
+Object.defineProperty(exports, "parseConnectionString", { enumerable: true, get: function () { return utils_1.parseConnectionString; } });
 var errorDefinitions_1 = require("./errorDefinitions");
-exports.InsufficientCreditError = errorDefinitions_1.InsufficientCreditError;
-exports.OperationTimeoutError = errorDefinitions_1.OperationTimeoutError;
-exports.SendOperationFailedError = errorDefinitions_1.SendOperationFailedError;
+Object.defineProperty(exports, "InsufficientCreditError", { enumerable: true, get: function () { return errorDefinitions_1.InsufficientCreditError; } });
+Object.defineProperty(exports, "OperationTimeoutError", { enumerable: true, get: function () { return errorDefinitions_1.OperationTimeoutError; } });
+Object.defineProperty(exports, "SendOperationFailedError", { enumerable: true, get: function () { return errorDefinitions_1.SendOperationFailedError; } });
 //# sourceMappingURL=index.js.map

dist/lib/link.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Link = exports.LinkType = void 0;
 const tslib_1 = require("tslib");
@@ -7,0 +8,0 @@ const log = require("./log");

dist/lib/log.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.contextTranslator = exports.eventHandler = exports.error = exports.receiver = exports.sender = exports.session = exports.connection = exports.container = void 0;
 const debugModule = require("debug");
@@ -7,0 +8,0 @@ /**

dist/lib/receiver.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Receiver = void 0;
 const link_1 = require("./link");
@@ -7,0 +8,0 @@ /**

dist/lib/sender.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sender = exports.SenderSendOptions = exports.BaseSender = void 0;
 const link_1 = require("./link");
@@ -7,0 +8,0 @@ /**

dist/lib/session.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Session = void 0;
 const tslib_1 = require("tslib");
@@ -7,0 +8,0 @@ const log = require("./log");

dist/lib/util/constants.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultOperationTimeoutInSeconds = void 0;
 /**
@@ -7,0 +8,0 @@ * Describes the default operation timeout in seconds. Value: `60`.

dist/lib/util/utils.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAbortError = exports.abortErrorName = exports.emitEvent = exports.parseConnectionString = exports.delay = exports.isAmqpError = exports.messageHeader = exports.messageProperties = exports.AmqpResponseStatusCode = void 0;
 const log = require("../log");
@@ -99,3 +100,3 @@ const eventContext_1 = require("../eventContext");
  * @param {T} value - The value to be resolved with after a timeout of t milliseconds.
- * @returns {Promise<T>} - Resolved promise
+ * @returns {Promise<T | void>} - Resolved promise
  */
@@ -118,3 +119,3 @@ function delay(t, value) {
         const splitIndex = part.indexOf(keyValueSeparator);
-        return Object.assign({}, acc, { [part.substring(0, splitIndex)]: part.substring(splitIndex + 1) });
+        return Object.assign(Object.assign({}, acc), { [part.substring(0, splitIndex)]: part.substring(splitIndex + 1) });
     }, {});
@@ -121,0 +122,0 @@ }

lib/connection.ts

@@ -107,3 +107,3 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
  */
-export interface ConnectionOptions extends RheaConnectionOptions {
+export type ConnectionOptions = RheaConnectionOptions & {
   /**
@@ -145,3 +145,3 @@ * @property {number} [operationTimeoutInSeconds] - The duration in which the promise should
   };
-}
+};
 
@@ -173,3 +173,3 @@
 // Determines whether the given object is a CreatedRheConnectionOptions object.
-function isCreatedRheaConnectionOptions(obj: any): boolean {
+function isCreatedRheaConnectionOptions(obj: any): obj is CreatedRheaConnectionOptions {
   return (obj && typeof obj.container === "object" && typeof obj.rheaConnection === "object");
@@ -236,6 +236,2 @@ }
     super();
-    if (!options) options = {};
-    if (options.operationTimeoutInSeconds == undefined) {
-      options.operationTimeoutInSeconds = defaultOperationTimeoutInSeconds;
-    }
 
@@ -246,3 +242,7 @@ if (isCreatedRheaConnectionOptions(options)) {
     } else {
-      const connectionOptions = options as ConnectionOptions;
+      let connectionOptions = options as ConnectionOptions;
+      if (!connectionOptions) connectionOptions = { transport: "tls" };
+      if (connectionOptions.operationTimeoutInSeconds == undefined) {
+        connectionOptions.operationTimeoutInSeconds = defaultOperationTimeoutInSeconds;
+      }
       if (connectionOptions.webSocketOptions) {
@@ -257,2 +257,3 @@ const ws = websocket_connect(connectionOptions.webSocketOptions.webSocket);
       this.container = Container.copyFromContainerInstance(this._connection.container);
+      options = connectionOptions;
     }
@@ -259,0 +260,0 @@

lib/container.ts

@@ -12,2 +12,3 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
 import { ListenOptions, Server, Socket } from "net";
+import { TlsServerConnectionOptions } from "rhea/typings/connection";
 
@@ -84,3 +85,3 @@ /**
 
-  listen(options: ListenOptions | TlsOptions): Server | TlsServer {
+  listen(options: ListenOptions | TlsOptions & TlsServerConnectionOptions): Server | TlsServer {
     return this._container.listen(options);
@@ -87,0 +88,0 @@ }

lib/util/utils.ts

@@ -135,5 +135,5 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
  * @param {T} value - The value to be resolved with after a timeout of t milliseconds.
- * @returns {Promise<T>} - Resolved promise
+ * @returns {Promise<T | void>} - Resolved promise
  */
-export function delay<T>(t: number, value?: T): Promise<T> {
+export function delay<T>(t: number, value?: T): Promise<T | void> {
   return new Promise((resolve) => setTimeout(() => resolve(value), t));
@@ -140,0 +140,0 @@ }

package.json

 {
   "name": "rhea-promise",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "A Promisified layer over rhea AMQP client",
@@ -10,3 +10,3 @@ "license": "Apache-2.0",
     "debug": "^3.1.0",
-    "rhea": "^2.0.3",
+    "rhea": "^3.0.0",
     "tslib": "^2.2.0"
@@ -34,6 +34,6 @@ },
     "tslint": "^5.17.0",
-    "typescript": "3.5.1"
+    "typescript": "~4.3.0"
   },
   "scripts": {
-    "tslint": "tslint -p . -c tslint.json --exclude tests/**/*.ts",
+    "tslint": "tslint -p . -c tslint.json --exclude test/**/*.ts",
     "tsc": "tsc",
@@ -40,0 +40,0 @@ "prebuild": "rimraf dist && rimraf typings",

tsconfig.json

@@ -26,4 +26,5 @@ {
       "./lib/**/*.ts",
-      "./examples/**/*.ts"
+      "./examples/**/*.ts",
+      "./test/**/*.ts"
     ]
-  }
+  }

typings/lib/connection.d.ts

@@ -89,3 +89,3 @@ /// <reference types="node" />
  */
-export interface ConnectionOptions extends RheaConnectionOptions {
+export declare type ConnectionOptions = RheaConnectionOptions & {
     /**
@@ -126,3 +126,3 @@ * @property {number} [operationTimeoutInSeconds] - The duration in which the promise should
     };
-}
+};
 /**
@@ -207,3 +207,3 @@ * Describes the options that can be provided while creating a rhea-promise connection from an
      */
-    readonly id: string;
+    get id(): string;
     /**
@@ -213,3 +213,3 @@ * @property {Dictionary<any> | undefined} [properties] Provides the connection properties.
      */
-    readonly properties: Dictionary<any> | undefined;
+    get properties(): Dictionary<any> | undefined;
     /**
@@ -219,3 +219,3 @@ * @property {number | undefined} [maxFrameSize] Provides the max frame size.
      */
-    readonly maxFrameSize: number | undefined;
+    get maxFrameSize(): number | undefined;
     /**
@@ -225,3 +225,3 @@ * @property {number | undefined} [idleTimeout] Provides the idle timeout for the connection.
      */
-    readonly idleTimeout: number | undefined;
+    get idleTimeout(): number | undefined;
     /**
@@ -231,3 +231,3 @@ * @property {number | undefined} [channelMax] Provides the maximum number of channels supported.
      */
-    readonly channelMax: number | undefined;
+    get channelMax(): number | undefined;
     /**
@@ -237,3 +237,3 @@ * @property {AmqpError | Error | undefined} [error] Provides the last error that occurred on the
      */
-    readonly error: AmqpError | Error | undefined;
+    get error(): AmqpError | Error | undefined;
     /**
@@ -240,0 +240,0 @@ * Removes the provided session from the internal map in rhea.

typings/lib/container.d.ts

@@ -7,2 +7,3 @@ /// <reference types="node" />
 import { ListenOptions, Server, Socket } from "net";
+import { TlsServerConnectionOptions } from "rhea/typings/connection";
 /**
@@ -31,11 +32,11 @@ * Descibes the options that can be provided while creating the Container.
     constructor(options?: ContainerOptions);
-    readonly id: string;
-    readonly filter: Filter;
-    readonly types: Types;
-    readonly message: MessageUtil;
-    readonly sasl: Sasl;
-    readonly saslServerMechanisms: any;
+    get id(): string;
+    get filter(): Filter;
+    get types(): Types;
+    get message(): MessageUtil;
+    get sasl(): Sasl;
+    get saslServerMechanisms(): any;
     createConnection(options?: ConnectionOptions): Connection;
     connect(options?: ConnectionOptions): Promise<Connection>;
-    listen(options: ListenOptions | TlsOptions): Server | TlsServer;
+    listen(options: ListenOptions | TlsOptions & TlsServerConnectionOptions): Server | TlsServer;
     generateUUid(): string;
@@ -42,0 +43,0 @@ stringToUuid(uuidString: string): Buffer;

typings/lib/link.d.ts

@@ -27,16 +27,18 @@ import { link, LinkOptions, AmqpError, Dictionary, Source, TerminusOptions } from "rhea";
     constructor(type: LinkType, session: Session, link: link, options?: LinkOptions);
-    readonly name: string;
-    readonly error: AmqpError | Error | undefined;
-    readonly properties: Dictionary<any>;
-    readonly sendSettleMode: 0 | 1 | 2;
-    readonly receiveSettleMode: 0 | 1;
-    source: Source;
-    target: TerminusOptions;
-    readonly maxMessageSize: number;
-    readonly offeredCapabilities: string | string[];
-    readonly desiredCapabilities: string | string[];
-    readonly address: string;
-    readonly credit: number;
-    readonly session: Session;
-    readonly connection: Connection;
+    get name(): string;
+    get error(): AmqpError | Error | undefined;
+    get properties(): Dictionary<any>;
+    get sendSettleMode(): 0 | 1 | 2;
+    get receiveSettleMode(): 0 | 1;
+    get source(): Source;
+    set source(fields: Source);
+    get target(): TerminusOptions;
+    set target(fields: TerminusOptions);
+    get maxMessageSize(): number;
+    get offeredCapabilities(): string | string[];
+    get desiredCapabilities(): string | string[];
+    get address(): string;
+    get credit(): number;
+    get session(): Session;
+    get connection(): Connection;
     /**
@@ -43,0 +45,0 @@ * Determines whether the sender link and its underlying session is open.

typings/lib/receiver.d.ts

@@ -54,3 +54,4 @@ import { Session } from "./session";
     constructor(session: Session, receiver: RheaReceiver, options?: ReceiverOptions);
-    drain: boolean;
+    get drain(): boolean;
+    set drain(value: boolean);
     addCredit(credit: number): void;
@@ -57,0 +58,0 @@ drainCredit(): void;

typings/lib/session.d.ts

@@ -34,4 +34,4 @@ import { Connection } from "./connection";
      */
-    readonly connection: Connection;
-    readonly incoming: {
+    get connection(): Connection;
+    get incoming(): {
         deliveries: {
@@ -42,4 +42,4 @@ size: number;
     };
-    readonly outgoing: any;
-    readonly error: AmqpError | Error | undefined;
+    get outgoing(): any;
+    get error(): AmqpError | Error | undefined;
     /**
@@ -50,3 +50,3 @@ * Returns the unique identifier for the session in the format:
      */
-    readonly id: string;
+    get id(): string;
     /**
@@ -53,0 +53,0 @@ * Determines whether the session and the underlying connection is open.

typings/lib/util/utils.d.ts

@@ -105,5 +105,5 @@ import { EventContext as RheaEventContext } from "rhea";
  * @param {T} value - The value to be resolved with after a timeout of t milliseconds.
- * @returns {Promise<T>} - Resolved promise
+ * @returns {Promise<T | void>} - Resolved promise
  */
-export declare function delay<T>(t: number, value?: T): Promise<T>;
+export declare function delay<T>(t: number, value?: T): Promise<T | void>;
 /**
@@ -110,0 +110,0 @@ * Parses the connection string and returns an object of type T.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

545604

increased by25.86%

Number of package files

98

increased by19.51%

Lines of code

8795

increased by16.6%

Dependency changes

• + Addeddebug@4.3.7(transitive)

• + Addedrhea@3.0.3(transitive)

• - Removedrhea@2.0.8(transitive)

• Updatedrhea@^3.0.0