@acrobits/ipc-sdk 0.1.0 → 0.1.1

package/lib/index.d.ts

@@ -1,26 +1,124 @@
-import type { BaseContactItem } from '@acrobits/ipc-protocol';
-import type { CloudUsernameContactItem } from '@acrobits/ipc-protocol';
-import { ContactItem } from '@acrobits/ipc-protocol';
-import type { ContactLabel } from '@acrobits/ipc-protocol';
-import { DetailedContactItem } from '@acrobits/ipc-protocol';
-import { HostType } from '@acrobits/ipc-protocol';
-import { ILogger } from '@acrobits/log-helper';
-import { IpcProtocolVersion } from '@acrobits/ipc-protocol';
-import type { SipUriContactItem } from '@acrobits/ipc-protocol';
+/**
+ * Defines the base properties of a contact item.
+ *
+ * @public
+ */
+export declare interface BaseContactItem {
+    /**
+     * Type of contact item.
+     */
+    type: ContactType;
+    /**
+     * Cloud ID associated with the contact.
+     */
+    cloudId: string;
+}
 
-export { BaseContactItem }
+/**
+ * Defines the properties of a CloudUsername based contact item.
+ *
+ * @public
+ */
+export declare interface CloudUsernameContactItem extends BaseContactItem {
+    type: 'cloudUsername';
+    /**
+     * Cloud username associated with the contact.
+     */
+    cloudUsername: string;
+}
 
-export { CloudUsernameContactItem }
+/**
+ * Represents either a CloudUsername or Sip URI based contact item.
+ *
+ * @public
+ */
+export declare type ContactItem = CloudUsernameContactItem | UriContactItem;
 
-export { ContactItem }
+/**
+ * Label of contact being described.
+ *
+ * @public
+ */
+export declare type ContactLabel = 'home' | 'work' | 'mobile' | 'other';
 
-export { ContactLabel }
+/**
+ * Defines a basic Contact Item type.
+ *
+ * @public
+ */
+export declare type ContactType = 'cloudUsername' | 'uri';
 
-export { DetailedContactItem }
+/**
+ * Defines a URI for a contact item.
+ *
+ * @example
+ * ```ts
+ * const uri1 = 'sip:my-sip-uri';
+ * const uri2 = 'tel:+1234567890';
+ * ```
+ *
+ * @public
+ */
+export declare type ContactURI = `sip:${string}` | `tel:${string}` | `sips:${string}` | `tels:${string}`;
 
-export { HostType }
+/**
+ * Defines a {@link DetailedContactItem} object with additional fields like profile picture,
+ * SIP URIs and contact type etc.
+ *
+ * @public
+ */
+export declare interface DetailedContactItem {
+    /**
+     * Label of {@link ContactLabel} number associated with this contact.
+     */
+    contactLabel: ContactLabel;
+    /**
+     * Type of contact item.
+     */
+    type: ContactType;
+    /**
+     * Cloud ID associated with the contact.
+     */
+    cloudId: string;
+    /**
+     * Cloud username associated with the contact.
+     */
+    cloudUsername: string;
+    /**
+     * URI or number associated with the contact with prefix (e.g. sip: or tel:)
+     */
+    uri?: ContactURI;
+    /**
+     * Name of the contact entry.
+     */
+    displayName?: string;
+    /**
+     * An optional URL for the contact's profile picture.
+     */
+    profilePictureUrl?: string;
+}
 
-export { ILogger }
+/**
+ * Type of the Host app. Valid values are only `webrtc`, `desktop`, `ios`, `android`, `ios_jitsi`
+ * and `electron`.
+ *
+ * @public
+ */
+export declare type HostType = 'webrtc' | 'desktop' | 'ios' | 'android' | 'ios_jitsi' | 'electron';
+
+/**
+ * A Console-like logger interface that is used by the library to log output. `window.console` is
+ * a valid implementation of this interface.
+ *
+ * @public
+ */
+export declare interface ILogger {
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    log(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+}
 
 /**
  * Defines the context the web app is running under.
@@ -60,7 +158,6 @@ export declare const enum IPCEvents {
  * @public
  */
 export declare class IPCManager {
-    #private;
     /**
      * The type of the `Host` app the `Client` is embedded in.
      */
@@ -177,11 +274,15 @@ export declare class IPCManager {
      * @returns An unsubscribe callback to remove the listener.
      */
     onHostInForeground(callback: () => void): UnsubscribeCallback;
+    private evaluateContext;
 }
 
-export { IpcProtocolVersion }
-
-export { SipUriContactItem }
+/**
+ * Supported versions of the IPC Protocol.
+ *
+ * @public
+ */
+export declare type IpcProtocolVersion = '0.1' | '0.2' | '0.3' | '0.4' | '0.5' | '0.6' | '0.7' | '0.8' | '0.9' | '0.10' | '2.0';
 
 /**
  * A callback function to unsubscribe the registered listener.
@@ -190,4 +291,17 @@ export { SipUriContactItem }
  */
 export declare type UnsubscribeCallback = () => void;
 
+/**
+ * Defines the properties of a SIP URI based contact item.
+ *
+ * @public
+ */
+export declare interface UriContactItem extends BaseContactItem {
+    type: 'uri';
+    /**
+     * URI or number associated with the contact with prefix (e.g. sip: or tel:)
+     */
+    uri: ContactURI;
+}
+
 export { }