cmd-control-client-lib 3.0.1

package/dist/protocol/live/live-commands.d.ts

@@ -0,0 +1,386 @@
+import { chatIdType } from "../chatstate";
+import { ACTION } from "../command/action";
+import { baseParamsType } from "../command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "../command/icommand";
+import { EnumBooleanDigitized, EnumBooleanStringified, EnumBooleanStringifiedExtended, EnumStreamStatusType } from "../../@types";
+import { CMDC_CMSG } from "../message";
+export declare class CMDP_STARTSEND implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        camName?: string;
+        videoWidth?: string;
+        videoHeight?: string;
+        fps?: string;
+        hasAudio?: EnumBooleanDigitized;
+        microName?: string;
+        bandWidth?: string;
+        cpuLoad?: string;
+    };
+}
+export declare class CMDP_STARTSEND_RESPONSE extends CMDP_STARTSEND implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_STOPSEND implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        streamError?: EnumBooleanStringifiedExtended;
+        errorCode?: string;
+    };
+}
+export declare class CMDP_STOPSEND_RESPONSE extends CMDP_STOPSEND implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_SSTATUS implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        type: EnumStreamStatusType;
+        value: string;
+    };
+}
+export declare class CMDP_SSTATUS_RESPONSE extends CMDP_SSTATUS implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_TRACERT_REPLY implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        tracertID: string;
+        hopID: string;
+        targetIP: string;
+        replyHost: string;
+        replyIP: string;
+        replyTime: string;
+        replyCode: string;
+        replyString: string;
+    };
+}
+export declare class CMDP_TRACERT_REPLY_RESPONSE extends CMDP_TRACERT_REPLY implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_KICK implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & chatIdType & {
+        time?: string;
+    };
+}
+export declare class CMDP_KICK_RESPONSE extends CMDP_KICK implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_FSK16 implements ICOMMAND {
+    action: ACTION.CMDP_FSK16;
+    params: baseParamsType & {
+        fsk16: EnumBooleanStringified;
+    };
+}
+export declare class CMDP_SGETCHATS implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        chatID?: string;
+    };
+}
+export declare class CMDP_SGETCHATS_RESPONSE extends CMDP_SGETCHATS implements IRESPONSE {
+    result: RESULT;
+    commands: CMDC_CINIT[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_SGETCHATHISTORY implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & chatIdType & {
+        skipChannelMessages: EnumBooleanStringified;
+    };
+}
+export declare class CMDP_SGETCHATHISTORY_RESPONSE extends CMDP_SGETCHATHISTORY implements IRESPONSE {
+    result: RESULT;
+    commands: CMDC_CMSG[];
+    values: IKeyMaybeValue;
+}
+/**
+ * Chat flags
+ *   SELECT CHAT_FLAG_SHORT || ' = "' || CHAT_FLAG_SHORT || '",// ' || CHAT_FLAG_DESCRIPTION  FROM CHAT_FLAGS order by CHAT_FLAG_VAL
+ */
+export declare enum ChatFlags {
+    _FREE_ = "_FREE_",
+    VOYEUR = "VOYEUR",
+    CAM2CAM = "CAM2CAM",
+    SINGLE = "SINGLE",
+    DISCOUNT = "DISCOUNT",
+    TEXT = "TEXT",
+    FSK16 = "FSK16",
+    VOYEUR2S = "VOYEUR2S",
+    RECORD = "RECORD",
+    FREE = "FREE",
+    HASUPLPICS = "HASUPLPICS",
+    PREVIEW = "PREVIEW",
+    FSKACK = "FSKACK",
+    VOYSHOWN = "VOYSHOWN",
+    PARTY = "PARTY",
+    FREECHAT = "FREECHAT",
+    TOY = "TOY",
+    CONVERSION = "CONVERSION",
+    TESTCHAT = "TESTCHAT",
+    SECONDARY = "SECONDARY",
+    AUDIO = "AUDIO",
+    CONVERTED = "CONVERTED",
+    TIP = "TIP",
+    GUESTCHAT = "GUESTCHAT",
+    MOBILE = "MOBILE",
+    FLATRATE = "FLATRATE"
+}
+export declare class SChatInfo implements IKeyMaybeValue {
+    [key: string]: string;
+    /** the unique chatId*/
+    chatID: string;
+    /** the chat type, can be changed. 15 contentpartner, 16 prepaid, 13 - dialerchat*/
+    type: string;
+    /** chat flags coma separated. see enum ChatFlags*/
+    flags: string | keyof typeof ChatFlags;
+    /** start timestamp */
+    startTime: string;
+    /** stop timestamp */
+    stopTime?: string;
+    /** the paid time */
+    paidTime?: string;
+    /** exit code, see  */
+    exitCode?: string;
+    /** admin chat */
+    admin?: EnumBooleanDigitized;
+    /** you can kick und ban this user */
+    canBan?: EnumBooleanDigitized;
+    /** you can give a discount to this user*/
+    canDiscount?: EnumBooleanDigitized;
+    /** single ability */
+    canSingle?: EnumBooleanDigitized;
+    /** c2c ability */
+    canSingle?: EnumBooleanDigitized;
+    /** the category */
+    ccl_cat2?: string;
+    /** messenger channel id */
+    channelId?: string;
+    /** @deprecated */
+    fixedPayout?: string;
+    /** the soft/hard status */
+    fsk?: "16" | "18";
+    /** the discount */
+    hasDiscount?: string;
+    /** info message for this chat */
+    infoMessage?: string;
+    /** the chat is public, others users in ther public chats can see your messages */
+    isPublicText?: EnumBooleanDigitized;
+    /** the chat is a mass lobby show, no system messages or CMDC_CHAT_UPDATE will be arrived */
+    isLobby?: EnumBooleanDigitized;
+    /** stats about this user*/
+    jsonStats?: string;
+    /** language of user */
+    lang?: string;
+    /** the user name */
+    login?: string;
+    /** the admin is shown */
+    showAdmin?: string;
+    /** internal, the usr_id of user for type 13 chat */
+    userKey?: string;
+}
+export declare class CMDC_CINIT implements ICOMMAND {
+    action: ACTION;
+    params: SChatInfo;
+}
+export declare class CMDP_START_STREAM_PREVIEW implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        duration: string;
+    };
+}
+export declare class CMDP_START_STREAM_PREVIEW_RESPONSE extends CMDP_START_STREAM_PREVIEW implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        dataURL: string;
+    };
+}
+export declare class CMDP_STOP_STREAM_PREVIEW implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        dataURL: string;
+        dataID: string;
+    };
+}
+export declare class CMDP_STOP_STREAM_PREVIEW_RESPONSE extends CMDP_STOP_STREAM_PREVIEW implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_STARTBANDWIDTHTEST implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType;
+}
+export declare class CMDP_STARTBANDWIDTHTEST_RESPONSE extends CMDP_STARTBANDWIDTHTEST implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        testID: string;
+        seconds: string;
+        dataURL: string;
+        dataID: string;
+    };
+}
+export declare class CMDP_STOPBANDWIDTHTEST implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        testID: string;
+        seconds: string;
+        dataID: string;
+        bitrate: string;
+        cpuUsage: string;
+    };
+}
+export declare class CMDP_STOPBANDWIDTHTEST_RESPONSE extends CMDP_STOPBANDWIDTHTEST implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        validated: EnumBooleanStringified;
+    };
+}
+export declare class CMDP_STARTLOOPBACK9 implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType;
+}
+export declare class CMDP_STARTLOOPBACK9_RESPONSE extends CMDP_STARTLOOPBACK9 implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        testID: string;
+        pushUrl: string;
+        pullUrl: string;
+        pushUrlAudio: string;
+        pullUrlAudio: string;
+    };
+}
+export declare class CMDP_STOPLOOPBACK9 implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        testID: string;
+        VideoDevice: string;
+        VideoDeviceWidth: string;
+        VideoDeviceHeight: string;
+        VideoDeviceFPS: string;
+        VideoSendBitrate: string;
+        VideoSendFPS: string;
+        AudioDevice: string | "-";
+        AudioDeviceFPS: string;
+        AudioSendFPS: string;
+        AudioSendBitrate: string;
+        CPU: string | "-1";
+        localCode: string | "0";
+    };
+}
+export declare class CMDP_STOPLOOPBACK9_RESPONSE extends CMDP_STOPLOOPBACK9 implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        statusCode: string;
+        statusText: string;
+    };
+}
+export declare class CMDP_SQUERY_FORMAT implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        width: string;
+        height: string;
+        fps: string;
+        bandWidth: string;
+        cpuUsage: string;
+    };
+}
+export declare class CMDP_SQUERY_FORMAT_RESPONSE extends CMDP_SQUERY_FORMAT implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        width: string;
+        height: string;
+        fps: string;
+        ref_width: string;
+        ref_height: string;
+        ref_fps: string;
+        rtmp?: EnumBooleanDigitized.TRUE;
+        codec?: string;
+    };
+}
+export declare class CMDC_QUERYUSER implements ICOMMAND {
+    action: ACTION;
+    params: {
+        queryId: string;
+        key: string;
+        caption: string;
+        text: string;
+        btn0: string;
+        btn1: string;
+        timeout: string;
+        sound: string;
+        btnDefault: EnumBooleanDigitized;
+        btndef: "btn0" | "btn1";
+    };
+}
+export declare class CMDP_QUERYUSER implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & chatIdType & {
+        key: "fsk" | "single";
+        button: EnumBooleanDigitized;
+        queryId: string;
+        /** if the answer sent by timeout */
+        isTimeout?: EnumBooleanDigitized;
+    };
+}
+export declare class CMDP_QUERYUSER_RESPONSE extends CMDP_QUERYUSER implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDC_QUERYANSWERED implements ICOMMAND {
+    action: ACTION;
+    params: {
+        queryId: string;
+    };
+}
+export declare class CMDP_SQUERY_DISCOUNT implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        rate: string;
+        time: string;
+    };
+}
+export declare class CMDP_SQUERY_DISCOUNT_RESPONSE extends CMDP_SQUERY_DISCOUNT implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_SET_DISCOUNT implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        rate: string;
+        time: string;
+    };
+}
+export declare class CMDP_SET_DISCOUNT_RESPONSE extends CMDP_SET_DISCOUNT implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare type ChatOnlineStats = {
+    /** the video time in seconds */
+    videoTime?: string;
+    /** the  video time as string 00:33:22 */
+    videoTimeString?: string;
+    lobbyNumber?: string;
+};
+export declare class CMDC_UPDATE_CHAT implements ICOMMAND {
+    action: ACTION;
+    params: SChatInfo & ChatOnlineStats;
+}

package/dist/protocol/live/login.d.ts

@@ -0,0 +1,14 @@
+import { CMDP_LOGIN, CMDP_LOGIN_RESPONSE } from "../login";
+import { ACTION } from "../../cmd-protocol";
+/**
+ *  8320 only
+ */
+export declare class CMDP_SLOGIN extends CMDP_LOGIN {
+    action: ACTION;
+}
+/**
+ * response for CMDP_SLOGIN, 8320 only
+ */
+export declare class CMDP_SLOGIN_RESPONSE extends CMDP_LOGIN_RESPONSE {
+    action: ACTION;
+}

package/dist/protocol/live/onlinesummary.d.ts

@@ -0,0 +1,21 @@
+import { JSONString } from "../../@types/json-stringified";
+import { ACTION } from "../command/action";
+import { baseParamsType } from "../command/baseparams";
+import { ICOMMAND, IRESPONSE, RESULT } from "../command/icommand";
+/**
+ * query online time summary for last 3 month
+ */
+export declare class CMDP_GETONLINESUMMARY implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType;
+}
+/**
+ * Response for CMDP_GETONLINESUMMARY
+ */
+export declare class CMDP_GETONLINESUMMARY_RESPONSE extends CMDP_GETONLINESUMMARY implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        summary: JSONString<any> | string;
+    };
+}

package/dist/protocol/live/products-config.d.ts

@@ -0,0 +1,19 @@
+export declare enum EnumProductLinks {
+    CHAT_MOTTO = "chatmotto",
+    CHAT_SETTINGS = "chatsettings",
+    HELP = "help",
+    HELP_TOY = "helplovense",
+    MESSAGING = "messaging",
+    PICTURE_TOOL = "picturepool",
+    PROFILE = "profile",
+    /** @deprecated*/
+    PASSWORDRESET = "passwordReset",
+    PASSWORD_RESET = "passwordreset",
+    SERVICE0900 = "service0900"
+}
+export interface IProductConfig {
+    key: string;
+    links: {
+        [key in EnumProductLinks]: string;
+    };
+}

package/dist/protocol/live/streamstate.d.ts

@@ -0,0 +1,25 @@
+import { ACTION } from "../command/action";
+import { ICOMMAND } from "../command/icommand";
+import { EnumBooleanStringifiedExtended } from "../../cmd-control-lib";
+export declare enum EnumStreamQuality {
+    NONE = "NONE",
+    EXCELLENT = "EXCELLENT",
+    GOOD = "GOOD",
+    BAD = "BAD"
+}
+/**
+ * Update incomming stream state.
+ * Server inform you about the state of incloming video audio stream.
+ */
+export declare class CMDC_STREAMSTATE implements ICOMMAND {
+    action: ACTION;
+    params: {
+        bandwith?: string;
+        quality?: EnumStreamQuality;
+        videoWidth?: string;
+        videoHeigth?: string;
+        videoFps?: string;
+        hasAudio?: EnumBooleanStringifiedExtended;
+        audioMuted?: EnumBooleanStringifiedExtended;
+    };
+}

package/dist/protocol/live/supdate.d.ts

@@ -0,0 +1,34 @@
+import { ACTION } from "../command/action";
+import { baseParamsType, SupportedLanguage } from "../command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "../command/icommand";
+import { EnumBooleanStringified } from "../../cmd-control-lib";
+export declare enum EnumService0900State {
+    ACTIVE = "active",
+    INACTIVE = "inactive"
+}
+export declare enum EnumService0900Operation {
+    ENABLE = "turnOn",
+    DISABLE = "turnOff"
+}
+/**
+ * Update session state or control features
+ */
+export declare class CMDP_SUPDATE implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        language?: SupportedLanguage;
+        broadcastData?: string;
+        permanentData?: string;
+        service0900State?: EnumService0900State;
+        livePreviewState?: EnumBooleanStringified;
+        babeStation24State?: EnumBooleanStringified;
+    };
+}
+/**
+ * Response for CMDP_UPDATE
+ */
+export declare class CMDP_SUPDATE_RESPONSE extends CMDP_SUPDATE implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}

package/dist/protocol/live/usersettings.d.ts

@@ -0,0 +1,40 @@
+import { ICOMMAND, ACTION, IRESPONSE, RESULT, IKeyMaybeValue } from "../../cmd-protocol";
+import { baseParamsType } from "../command/baseparams";
+export declare enum EnumPushNotificationFilter {
+    ALL = "all",
+    REGULAR = "regular",
+    NONE = "none"
+}
+export declare type UserSettings = {
+    pushNotificationFilter?: EnumPushNotificationFilter;
+};
+/**
+ * set user setting
+ */
+export declare class CMDP_GETSETTINGS implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType;
+}
+/**
+ * set user setting response
+ */
+export declare class CMDP_GETSETTINGS_RESPONSE extends CMDP_GETSETTINGS implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue & UserSettings;
+}
+/**
+ * set user setting
+ */
+export declare class CMDP_SETSETTINGS implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & UserSettings;
+}
+/**
+ * set user setting response
+ */
+export declare class CMDP_SETSETTINGS_RESPONSE extends CMDP_SETSETTINGS implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}

package/dist/protocol/lobby.d.ts

@@ -0,0 +1,37 @@
+import { ACTION, baseParamsType, ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "../cmd-protocol";
+/**
+ * open lobby chat
+ */
+export declare class CMDP_OPEN_LOBBY implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        /** custom lobby name */
+        ualias?: string;
+    };
+}
+/**
+ * Response for CMDP_OPEN_LOBBY
+ */
+export declare class CMDP_OPEN_LOBBY_RESPONSE extends CMDP_OPEN_LOBBY implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue & {
+        /** the lobby chat id */
+        chatID: string;
+    };
+}
+/**
+ * close the lobby chat
+ */
+export declare class CMDP_CLOSE_LOBBY implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType;
+}
+/**
+ * Response for CMDP_CLOSE_LOBBY
+ */
+export declare class CMDP_CLOSE_LOBBY_RESPONSE extends CMDP_CLOSE_LOBBY implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}

package/dist/protocol/login.d.ts

@@ -0,0 +1,57 @@
+import { EnumBooleanDigitized } from "../@types/enum-boolean-digitized";
+import { IBACKENDPAYLOAD } from "./backend";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IRESPONSE, RESULT } from "./command/icommand";
+import { SessionState } from "./sessionstate";
+/** web token format need for login with web token. obligatory fields in token-payload
+ * \{
+ *   userPoolId: number \{10\}, -  the id of your user pool
+ *   usrKey: string \{36 bytes\} - the uniq user key in your pool
+ * \}
+ */
+export declare type loginWithWebtokenType = {
+    webtoken: string;
+};
+/** login with user name & password */
+export declare type loginWithUserNameType = {
+    /** your bussines Id in CmdControl system, will be obligatory in future to check the password by your backend */
+    usrId?: string;
+    /** username. if usrId not set, your B2B username. if usrId is set the username of customer. LIVE: username of Model */
+    login: string;
+    /** password in plain MD5 or other format to check it by your backend */
+    password: string;
+};
+export declare type foreignSIDType = {
+    /** upgrade from foreignSID, 8320 only */
+    foreignSID?: string;
+};
+/** additional params */
+export declare type otherLoginParamsType = {
+    /** B2B: user key. Obligatory, If you want to create end-user-session and if not set already in webtoken. max 36 symbols */
+    usrKey?: string;
+    /** this is session with messenger functions, default is "0" */
+    msn: EnumBooleanDigitized;
+};
+/** login union type */
+export declare type loginParamType = loginWithWebtokenType | loginWithUserNameType | foreignSIDType;
+export interface ILoginBackendPayload {
+    guest: any;
+}
+export declare class CMDP_LOGIN implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    /** login params */
+    params: baseParamsType & loginParamType & otherLoginParamsType;
+    /** payload to sent it to backend */
+    payload?: unknown;
+}
+/**
+ *  response for Login
+ */
+export declare class CMDP_LOGIN_RESPONSE extends CMDP_LOGIN implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: SessionState;
+    /** payload from backend */
+    payload?: ILoginBackendPayload;
+}

package/dist/protocol/logout.d.ts

@@ -0,0 +1,22 @@
+import { IBACKENDPAYLOAD } from "./backend";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "./command/icommand";
+export declare class CMDP_LOGOUT implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType & {
+        code?: number;
+    };
+    payload?: unknown;
+}
+export declare class CMDP_LOGOUT_RESPONSE extends CMDP_LOGOUT implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDP_SLOGOUT extends CMDP_LOGOUT {
+    action: ACTION;
+}
+export declare class CMDP_SLOGOUT_RESPONSE extends CMDP_LOGOUT_RESPONSE {
+    action: ACTION;
+}