@signalwire/core - npm Package Compare versions

Comparing version 4.0.0-dev.202402261426.2c4aae9.1 to 4.0.0-dev.202403070124.19281d4.1

dist/core/src/types/callfabric.d.ts

@@ -37,6 +37,3 @@ export interface PaginatedResponse<T> {
 export interface GetConversationsOptions {
-    limit?: number;
-    since?: number;
-    until?: number;
-    cursor?: string;
+    pageSize?: number;
 }
@@ -56,6 +53,3 @@ export interface Conversation {
 export interface GetMessagesOptions {
-    limit?: number;
-    since?: number;
-    until?: number;
-    cursor?: string;
+    pageSize?: number;
 }
@@ -76,6 +70,3 @@ export interface ConversationMessage {
     addressId: string;
-    limit?: number;
-    since?: number;
-    until?: number;
-    cursor?: string;
+    pageSize?: number;
 }
@@ -82,0 +73,0 @@ export interface SubscriberInfoResponse {

dist/core/src/types/index.d.ts

@@ -143,2 +143,13 @@ import type { EventEmitter } from '../utils/EventEmitter';
 export interface ClientContract<ClientInstance, EventTypes extends EventEmitter.ValidEventTypes> extends EmitterContract<EventTypes> {
+    /**
+     * Connect the underlay WebSocket connection to the SignalWire network.
+     *
+     * @returns Promise that will resolve with the Client object.
+     *
+     * @example
+     *
+     * ```js
+     * client.connect()
+     * ```
+     */
     connect(): Promise<ClientInstance>;
@@ -145,0 +156,0 @@ /**

dist/core/src/utils/interfaces.d.ts

@@ -15,3 +15,4 @@ /// <reference types="node" />
 export declare type WebRTCMethod = 'video.message' | 'webrtc.verto';
-export declare type JSONRPCMethod = 'signalwire.connect' | 'signalwire.ping' | 'signalwire.disconnect' | 'signalwire.event' | 'signalwire.reauthenticate' | 'signalwire.subscribe' | 'signalwire.unsubscribe' | WebRTCMethod | RoomMethod | VertoMethod | ChatJSONRPCMethod | MessagingJSONRPCMethod | VoiceJSONRPCMethod | ClientContextMethod;
+export declare type SubscriberMethod = 'subscriber.online' | 'subscriber.offline';
+export declare type JSONRPCMethod = 'signalwire.connect' | 'signalwire.ping' | 'signalwire.disconnect' | 'signalwire.event' | 'signalwire.reauthenticate' | 'signalwire.subscribe' | 'signalwire.unsubscribe' | SubscriberMethod | WebRTCMethod | RoomMethod | VertoMethod | ChatJSONRPCMethod | MessagingJSONRPCMethod | VoiceJSONRPCMethod | ClientContextMethod;
 export declare type JSONRPCSubscribeMethod = Extract<JSONRPCMethod, 'signalwire.subscribe' | 'chat.subscribe'>;
@@ -18,0 +19,0 @@ export declare type JSONRPCUnSubscribeMethod = Extract<JSONRPCMethod, 'signalwire.unsubscribe'>;

package.json

@@ -6,3 +6,3 @@ {
   "license": "MIT",
-  "version": "4.0.0-dev.202402261426.2c4aae9.1",
+  "version": "4.0.0-dev.202403070124.19281d4.1",
   "main": "dist/index.node.js",
@@ -9,0 +9,0 @@ "module": "dist/index.esm.js",

src/types/callfabric.ts

@@ -40,6 +40,3 @@ export interface PaginatedResponse<T> {
 export interface GetConversationsOptions {
-  limit?: number
-  since?: number
-  until?: number
-  cursor?: string
+  pageSize?: number
 }
@@ -63,6 +60,3 @@
 export interface GetMessagesOptions {
-  limit?: number
-  since?: number
-  until?: number
-  cursor?: string
+  pageSize?: number
 }
@@ -86,6 +80,3 @@
   addressId: string
-  limit?: number
-  since?: number
-  until?: number
-  cursor?: string
+  pageSize?: number
 }
@@ -92,0 +83,0 @@

src/types/index.ts

@@ -180,4 +180,14 @@ import type { EventEmitter } from '../utils/EventEmitter'
 > extends EmitterContract<EventTypes> {
+  /**
+   * Connect the underlay WebSocket connection to the SignalWire network.
+   *
+   * @returns Promise that will resolve with the Client object.
+   *
+   * @example
+   *
+   * ```js
+   * client.connect()
+   * ```
+   */
   connect(): Promise<ClientInstance>
-
   /**
@@ -184,0 +194,0 @@ * Disconnects this client. The client will stop receiving events and you will

src/utils/interfaces.ts

@@ -52,2 +52,3 @@ import type { SagaIterator } from '@redux-saga/types'
 export type WebRTCMethod = 'video.message' | 'webrtc.verto'
+export type SubscriberMethod = 'subscriber.online' | 'subscriber.offline'
 export type JSONRPCMethod =
@@ -61,2 +62,3 @@ | 'signalwire.connect'
   | 'signalwire.unsubscribe'
+  | SubscriberMethod
   | WebRTCMethod
@@ -63,0 +65,0 @@ | RoomMethod

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

Improved metrics

Total package byte prevSize

2838993

increased by0.01%

Lines of code

41254

increased by0.02%

No dependency changes