@solace-community/angular-solace-message-client - npm Package Compare versions

Comparing version 13.1.0 to 14.0.0

lib/oauth-access-token-provider.d.ts

@@ -14,5 +14,5 @@ import { Observable } from 'rxjs';
  *     The method should return an Observable that, when being subscribed, emits the user's access token, and then emits continuously when
- *     the token is renewed. It should never complete. Otherwise, the connection to the broker could not be re-established in the event
+ *     the token is renewed. It should never complete. Otherwise, the connection to the broker would not be re-established in the event
  *     of a network interruption.
- * - Enable OAUTH and configure the access token in the config passed to {@link SolaceMessageClientModule#forRoot} or {@link SolaceMessageClient#connect}, as follows:
+ * - Enable OAUTH and configure the access token in the config passed to {@link SolaceMessageClientModule.forRoot} or {@link SolaceMessageClient#connect}, as follows:
  *   - Set {@link SolaceMessageClientConfig#authenticationScheme} to {@link AuthenticationScheme.OAUTH2}.
@@ -60,5 +60,5 @@ *   - Set {@link SolaceMessageClientConfig#accessToken} to the above provider class.
      * Returns an Observable that, when being subscribed, emits the user's access token, and then emits continuously when the token is renewed.
-     * It should never complete. Otherwise, the connection to the broker could not be re-established in the event of a network interruption.
+     * It should never complete. Otherwise, the connection to the broker would not be re-established in the event of a network interruption.
      */
     provide$(): Observable<string>;
 }

lib/ɵsolace-message-client.d.ts

@@ -50,3 +50,2 @@ import { Injector, NgZone, OnDestroy } from '@angular/core';
     reply(request: Message, data?: Data | Message, options?: PublishOptions): Promise<void>;
-    enqueue(queue: string, data?: Data | Message, options?: PublishOptions): Promise<void>;
     private sendMessage;
@@ -53,0 +52,0 @@ get session(): Promise<Session>;

lib/solace-message-client.d.ts

@@ -203,2 +203,4 @@ import { BehaviorSubject, Observable, OperatorFunction } from 'rxjs';
      * @param  destination - Specifies the destination where to send the message to. If of the type `string`, sends it to a topic destination.
+     *         To send a message to a queue, pass a queue {@link Destination} which can be constructed using the {@link SolclientFactory}, as following:
+     *         `SolclientFactory.createDurableQueueDestination('queue')`
      * @param  data - Specifies optional {@link Data transfer data} to be carried along with this message. A message may contain unstructured byte data,
@@ -247,49 +249,2 @@ *         or structured data in the form of a {@link SDTField}. Alternatively, to have full control over the message to be published, pass the
     abstract reply(request: Message, data?: Data | Message, options?: PublishOptions): Promise<void>;
-    /**
-     * Sends a message to the given queue destination. A queue is typically used in a point-to-point (P2P) messaging environment.
-     *
-     * A queue differs from the topic distribution mechanism that the message is transported to exactly a single consumer, i.e., the message is load
-     * balanced to a single consumer in round‑robin fashion, or for exclusive queues, it is always transported to the same subscription.
-     * When sending a message to a queue, the broker retains the message until it is consumed, or until it expires.
-     * Refer to the subsequent chapter 'Durability of Endpoints' for more information.
-     *
-     * ## Queue destination name
-     * Queues are case-sensitive and consist of one or more segments, each separated by a forward slash. The queue name must be exact, thus not contain wildcards.
-     *
-     * ## Payload
-     * A message may contain unstructured byte data, or a structured container. See {@link Data} for further information.
-     *
-     * ## Delivery Mode
-     * Solace supports two delivery modes, also known as qualities of service (QoS):
-     *  - Direct Messaging (default if not specified)
-     *  - Guaranteed or Persistent Messaging
-     *
-     * You can change the message delivery mode via the {@link PublishOptions.deliveryMode} property.
-     * For more information, refer to the documentation of {@link PublishOptions.deliveryMode}.
-     *
-     * ## Durability of Endpoints
-     * Solace distinguishes between durable und non-durable queues.
-     *
-     * When sending the message to a durable queue, the broker retains the message until it is consumed (and also acknowledged) by the consumer, or until
-     * it expires. In constract, a non-durable queue, also known as a temporary queue, has a shorter lifecycle than a durable queue. It has the lifespan
-     * of the client that created it, with an additional 60 seconds in case of unexpected disconnect. The 60 seconds provides the client with some time to
-     * reconnect to the endpoint before it and its contents are deleted from the Solace broker.
-     *
-     * Although the terms durable and persistent are related, keep in mind that the concept 'durability' applies to endpoints, whereas 'persistence' applies to event messages.
-     *
-     * For further information refer to:
-     * - https://docs.solace.com/PubSub-Basics/Endpoints.htm
-     * - https://solace.com/blog/solace-endpoints-durable-vs-non-durable
-     *
-     * @param  queue - Specifies the queue to which the message should be sent.
-     * @param  data - Specifies optional {@link Data transfer data} to be carried along with this message. A message may contain unstructured byte data,
-     *         or structured data in the form of a {@link SDTField}. Alternatively, to have full control over the message to be published, pass the
-     *         {@link Message} object instead, which you can construct using {@link SolclientFactory#createMessage}.
-     *         For more information, refer to the documentation of {@link Data}.
-     * @param  options - Controls how to publish the message.
-     * @return A Promise that resolves when dispatched the message, or that rejects if the message could not be dispatched.
-     *
-     * @deprecated This API will be removed in version 14.0.0. Instead, use {@link #publish} passing a queue destination, as follows: `solaceMessageClient.publish(SolclientFactory.createDurableQueueDestination('queue'))`
-     */
-    abstract enqueue(queue: string, data?: Data | Message, options?: PublishOptions): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<SolaceMessageClient, never>;
@@ -309,3 +264,2 @@ static ɵprov: i0.ɵɵInjectableDeclaration<SolaceMessageClient>;
     reply(request: Message, data?: ArrayBufferLike | DataView | string | SDTField | Message, options?: PublishOptions): Promise<void>;
-    enqueue(queue: string, data?: ArrayBufferLike | DataView | string | SDTField | Message, options?: PublishOptions): Promise<void>;
     get session(): Promise<Session>;
@@ -324,10 +278,3 @@ connect(config: SolaceMessageClientConfig): Promise<Session>;
      * If specified, overrides the global timeout as set via {@link SessionProperties#readTimeoutInMsecs}.
-     *
-     * @deprecated This API will be removed in a future release. Instead, use {@link #subscribeTimeout} instead.
      */
-    requestTimeout?: number;
-    /**
-     * Specifies the maximum time (in milliseconds) to wait for the destination to be subscribed.
-     * If specified, overrides the global timeout as set via {@link SessionProperties#readTimeoutInMsecs}.
-     */
     subscribeTimeout?: number;
@@ -334,0 +281,0 @@ /**

package.json

 {
   "name": "@solace-community/angular-solace-message-client",
-  "version": "13.1.0",
+  "version": "14.0.0",
   "description": "Message client to communicate with a Solace messaging broker for sending and receiving messages using the native SMF protocol (Solace Message Format) over web socket. The library is designed to be used in Angular applications.",
@@ -18,5 +18,5 @@ "license": "MIT",
   "peerDependencies": {
-    "@angular/common": "^13.0.0",
-    "@angular/core": "^13.0.0",
-    "@scion/toolkit": "^13.0.0-beta.0 || ^13.0.0-rc.0 || ^13.0.0",
+    "@angular/common": "^14.0.0",
+    "@angular/core": "^14.0.0",
+    "@scion/toolkit": "^1.0.0",
     "rxjs": "^7.5.0",
@@ -46,3 +46,3 @@ "solclientjs": "^10.10.0"
   "fesm2015": "fesm2015/solace-community-angular-solace-message-client.mjs",
-  "typings": "solace-community-angular-solace-message-client.d.ts",
+  "typings": "index.d.ts",
   "exports": {
@@ -53,3 +53,3 @@ "./package.json": {
     ".": {
-      "types": "./solace-community-angular-solace-message-client.d.ts",
+      "types": "./index.d.ts",
       "esm2020": "./esm2020/solace-community-angular-solace-message-client.mjs",
@@ -56,0 +56,0 @@ "es2020": "./fesm2020/solace-community-angular-solace-message-client.mjs",

public-api.d.ts

@@ -5,3 +5,3 @@ export { SolaceMessageClientModule } from './lib/solace-message-client.module';
 export { SolaceSessionProvider } from './lib/solace-session-provider';
-export { MessageEnvelope, Params, SolaceMessageClient, mapToText, mapToBinary, ObserveOptions, ConsumeOptions, BrowseOptions, PublishOptions, NullSolaceMessageClient, Data } from './lib/solace-message-client';
+export { MessageEnvelope, Params, SolaceMessageClient, mapToText, mapToBinary, ObserveOptions, ConsumeOptions, BrowseOptions, PublishOptions, NullSolaceMessageClient, Data, RequestOptions } from './lib/solace-message-client';
 export * from './lib/solclientjs-typedef-augmentation';

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

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

665087

decreased by-2.89%

Lines of code

4585

decreased by-1.63%

No dependency changes