react-sip-kit 0.5.21 → 0.7.0-beta

package/dist/events/transport/index.d.ts

@@ -1,6 +1,6 @@
-import { SipAccountConfig } from '../../configs/types';
+import { SipConfigs } from '../../configs/types';
 import { SipUserAgent } from '../../types';
-export declare function onTransportConnected(username: SipAccountConfig['username'], userAgent?: SipUserAgent | null): void;
-export declare function onTransportConnectError(error: Error, username: SipAccountConfig['username'], userAgent?: SipUserAgent | null): void;
-export declare function onTransportDisconnected(username: SipAccountConfig['username'], userAgent: SipUserAgent): void;
-export declare function reconnectTransport(username: SipAccountConfig['username'], userAgent?: SipUserAgent | null): void;
+export declare function onTransportConnected(configKey: SipConfigs['key'], userAgent?: SipUserAgent | null): void;
+export declare function onTransportConnectError(error: Error, configKey: SipConfigs['key'], userAgent?: SipUserAgent | null): void;
+export declare function onTransportDisconnected(configKey: SipConfigs['key'], userAgent: SipUserAgent): void;
+export declare function reconnectTransport(configKey: SipConfigs['key'], userAgent?: SipUserAgent | null, forceReconnect?: boolean): void;

package/dist/hooks/useSipManager/index.d.ts

@@ -1,7 +1,7 @@
-import { SipAccountConfig } from '../../configs/types';
+import { SipConfigs } from '../../configs/types';
 import { LineType } from '../../store/types';
-export declare function useSipManager({ username }: {
-    username: SipAccountConfig['username'];
+export declare function useSipManager({ configKey }: {
+    configKey: SipConfigs['key'];
 }): () => {
     status: import("../../store/types").SipUserAgentStatus;
     lines: LineType[];

package/dist/hooks/useWatchConfigs/index.d.ts

@@ -0,0 +1 @@
+export declare const useWatchConfigs: () => import("../../configs/types").SipConfigs[];

package/dist/hooks/useWatchSessionData/index.d.ts

@@ -1,21 +1,85 @@
-import { SipSessionDataType } from '../../store/types';
+import { SipConfigs } from '../../configs/types';
+import { LineType, SipSessionDataType } from '../../store/types';
 type Primitive = string | number | boolean | symbol | null | undefined;
 type Path<T> = {
     [K in keyof T & string]: T[K] extends Primitive | Array<any> ? K : K | `${K}.${Path<T[K]>}`;
 }[keyof T & string];
 /** Resolve the value type of a dot-path string. */
 type PathValue<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? Rest extends string ? PathValue<T[K], Rest> : never : never : P extends keyof T ? T[P] : never;
-/** ---------- Hook overloads ---------- */
+/**
+ * React hook to watch SIP session data for a specific line.
+ *
+ * Provide a single `key` object containing **either** `lineKey` or `remoteNumber`.
+ * You can also optionally specify `name` to access a specific property (supports dot-paths),
+ * or an array of names to get multiple properties at once.
+ *
+ * @param {Object} params
+ * @param {Object} params.key - Lookup key for the line/session.
+ * @param {number} [params.key.lineKey] - Numeric line identifier. Takes priority if both keys are somehow provided.
+ * @param {string} [params.key.remoteNumber] - Remote number of the SIP session. Used if `lineKey` is not provided.
+ * @param {string | string[]} [params.name] - Optional dot-path string (e.g., 'localMediaStreamStatus.videoEnabled')
+ *                                            or array of dot-paths to select specific data from the session.
+ *
+ * @returns {SipSessionDataType | any | any[]}
+ * Returns the full session data if `name` is undefined,
+ * a single property if `name` is a string,
+ * or an array of properties if `name` is an array.
+ *
+ * @example
+ * // Watch full session data by lineKey
+ * const sessionData = useWatchSessionData({ key: { lineKey: 1 } });
+ *
+ * // Watch a specific property by lineKey
+ * const videoEnabled = useWatchSessionData({ key: { lineKey: 1 }, name: 'localMediaStreamStatus.videoEnabled' });
+ *
+ * // Watch full session data by remoteNumber
+ * const sessionData = useWatchSessionData({ key: { remoteNumber: '1001' } });
+ *
+ * // Watch multiple properties by remoteNumber
+ * const [videoEnabled, audioEnabled] = useWatchSessionData({
+ *   key: { remoteNumber: '1001' },
+ *   name: ['localMediaStreamStatus.videoEnabled', 'localMediaStreamStatus.audioEnabled']
+ * });
+ */
 export declare function useWatchSessionData(props: {
-    lineNumber: number;
+    key: {
+        lineKey: LineType['lineKey'];
+    };
     name?: undefined;
 }): SipSessionDataType;
+export declare function useWatchSessionData(props: {
+    key: {
+        remoteNumber: SipSessionDataType['remoteNumber'];
+        configKey: SipConfigs['key'];
+    };
+    name?: undefined;
+}): SipSessionDataType;
+export declare function useWatchSessionData<P extends Path<SipSessionDataType>>(props: {
+    key: {
+        lineKey: LineType['lineKey'];
+    };
+    name: P;
+}): PathValue<SipSessionDataType, P>;
 export declare function useWatchSessionData<P extends Path<SipSessionDataType>>(props: {
-    lineNumber: number;
+    key: {
+        remoteNumber: SipSessionDataType['remoteNumber'];
+        configKey: SipConfigs['key'];
+    };
     name: P;
 }): PathValue<SipSessionDataType, P>;
 export declare function useWatchSessionData<const P extends readonly Path<SipSessionDataType>[]>(props: {
-    lineNumber: number;
+    key: {
+        lineKey: LineType['lineKey'];
+    };
+    name: P;
+}): {
+    [K in keyof P]: PathValue<SipSessionDataType, P[K] & string>;
+};
+export declare function useWatchSessionData<const P extends readonly Path<SipSessionDataType>[]>(props: {
+    key: {
+        remoteNumber: SipSessionDataType['remoteNumber'];
+        configKey: SipConfigs['key'];
+    };
     name: P;
 }): {
     [K in keyof P]: PathValue<SipSessionDataType, P[K] & string>;