cmd-control-client-lib 3.0.1

package/dist/protocol/command/action.d.ts

@@ -0,0 +1,116 @@
+/**
+ * command names that CmdControl can handle
+ */
+export declare enum ACTION {
+    CMDP_INIT = "CMDP_INIT",
+    CMDP_SINIT = "CMDP_SINIT",
+    CMDP_LOGIN = "CMDP_LOGIN",
+    CMDP_SLOGIN = "CMDP_SLOGIN",
+    CMDP_LOGOUT = "CMDP_LOGOUT",
+    CMDP_SLOGOUT = "CMDP_SLOGOUT",
+    CMDC_USERINFO = "CMDC_USERINFO",
+    CMDP_SETUSERINFO = "CMDP_SETUSERINFO",
+    CMDP_GETUSERINFO = "CMDP_GETUSERINFO",
+    CMDC_CONTACTNOTE = "CMDC_CONTACTNOTE",
+    CMDP_SETCONTACTNOTE = "CMDP_SETCONTACTNOTE",
+    CMDP_SSETCONTACTNOTE = "CMDP_SSETCONTACTNOTE",
+    CMDP_GETCONTACTNOTE = "CMDP_GETCONTACTNOTE",
+    CMDP_SGETCONTACTNOTE = "CMDP_SGETCONTACTNOTE",
+    CMDC_CONTACTINFO = "CMDC_CONTACTINFO",
+    CMDP_SETCONTACTINFO = "CMDP_SETCONTACTINFO",
+    CMDP_SGETCONTACTINFO = "CMDP_SGETCONTACTINFO",
+    CMDP_GETCONTACTINFO = "CMDP_GETCONTACTINFO",
+    CMDC_CHANNELINFO = "CMDC_CHANNELINFO",
+    CMDP_GETCHANNELINFO = "CMDP_GETCHANNELINFO",
+    CMDP_SETCHANNELINFO = "CMDP_SETCHANNELINFO",
+    CMDC_CHANNEL = "CMDC_CHANNEL",
+    CMDP_NEWCHANNEL = "CMDP_NEWCHANNEL",
+    CMDP_GETCHANNELS = "CMDP_GETCHANNELS",
+    CMDP_SGETCHANNELS = "CMDP_SGETCHANNELS",
+    CMDP_GETCHANNEL = "CMDP_GETCHANNEL",
+    CMDP_SGETCHANNEL = "CMDP_SGETCHANNEL",
+    CMDP_CHANNELSEEN = "CMDP_CHANNELSEEN",
+    CMDP_SCHANNELSEEN = "CMDP_SCHANNELSEEN",
+    CMDP_UPDATECHANNEL = "CMDP_UPDATECHANNEL",
+    CMDC_CHANNELSSUMMARY = "CMDC_CHANNELSSUMMARY",
+    CMDP_CHANNELSSUMMARY = "CMDP_CHANNELSSUMMARY",
+    CMDP_SUPLOADPIC = "CMDP_SUPLOADPIC",
+    CMDC_CMSG = "CMDC_CMSG",
+    CMDP_GETHISTORY = "CMDP_GETHISTORY",
+    CMDP_MSG = "CMDP_MSG",
+    CMDP_MSGDELETE = "CMDP_MSGDELETE",
+    CMDC_ONLINESTATE = "CMDC_ONLINESTATE",
+    CMDP_GETONLINESTATE = "CMDP_GETONLINESTATE",
+    CMDP_GETONLINESTATES = "CMDP_GETONLINESTATES",
+    CMDC_VALUE = "CMDC_VALUE",
+    CMDP_SET_DISCOUNT = "CMDP_SET_DISCOUNT",
+    CMDP_SQUERY_DISCOUNT = "CMDP_SQUERY_DISCOUNT",
+    CMDP_QUERYUSER = "CMDP_QUERYUSER",
+    CMDC_QUERYANSWERED = "CMDC_QUERYANSWERED",
+    CMDP_SQUERY_FORMAT = "CMDP_SQUERY_FORMAT",
+    CMDP_STOPLOOPBACK9 = "CMDP_STOPLOOPBACK9",
+    CMDP_STARTLOOPBACK9 = "CMDP_STARTLOOPBACK9",
+    CMDP_STOPBANDWIDTHTEST = "CMDP_STOPBANDWIDTHTEST",
+    CMDP_STARTBANDWIDTHTEST = "CMDP_STARTBANDWIDTHTEST",
+    CMDP_STOP_STREAM_PREVIEW = "CMDP_STOP_STREAM_PREVIEW",
+    CMDP_START_STREAM_PREVIEW = "CMDP_START_STREAM_PREVIEW",
+    CMDP_UPDATE = "CMDP_UPDATE",
+    CMDP_SGETCHATS = "CMDP_SGETCHATS",
+    CMDP_FSK16 = "CMDP_FSK16",
+    CMDP_KICK = "CMDP_KICK",
+    CMDP_TRACERT_REPLY = "CMDP_TRACERT_REPLY",
+    CMDP_STOPSEND = "CMDP_STOPSEND",
+    CMDP_STARTSEND = "CMDP_STARTSEND",
+    CMDP_SERVICE0900 = "CMDP_SERVICE0900",
+    CMDP_NOOP = "CMDP_NOOP",
+    CMDP_QUERYBACKEND = "CMDP_QUERYBACKEND",
+    CMDP_UNDEFINED = "CMDP_UNDEFINED",
+    CMDC_CINIT = "CMDC_CINIT",
+    CMDC_FEEDBACK = "CMDC_FEEDBACK",
+    CMDC_DSRELOAD = "CMDC_DSRELOAD",
+    CMDC_UPDATE = "CMDC_UPDATE",
+    CMDC_CEXIT = "CMDC_CEXIT",
+    CMDC_CSTARTSTREAMPUSH = "CMDC_CSTARTSTREAMPUSH",
+    CMDC_CSTOPVIDEOPUSH = "CMDC_CSTOPVIDEOPUSH",
+    CMDC_QUERYUSER = "CMDC_QUERYUSER",
+    CMDC_CQUERYUSER = "CMDC_CQUERYUSER",
+    CMDC_UPDATE_CHAT = "CMDC_UPDATE_CHAT",
+    CMDC_BACKENDPAYLOAD = "CMDC_BACKENDPAYLOAD",
+    CMDP_BACKENDPAYLOAD = "CMDP_BACKENDPAYLOAD",
+    CMDP_TOYSTATE = "CMDP_TOYSTATE",
+    CMDP_TOYACTION = "CMDP_TOYACTION",
+    CMDC_TOYACTION = "CMDC_TOYACTION",
+    CMDC_CSTREAMRESTART = "CMDC_CSTREAMRESTART",
+    CMDP_SUPLOADMEDIA = "CMDP_SUPLOADMEDIA",
+    /** Commands used on Live but not mentioned here **/
+    CMDC_CSTOPAUDIOPUSH = "CMDC_CSTOPAUDIOPUSH",
+    CMDC_CSTARTAUDIOPUSH = "CMDC_CSTARTAUDIOPUSH",
+    CMDP_CSTOPTEXT = "CMDP_CSTOPTEXT",
+    CMDC_CSTARTVIDEOPULL = "CMDC_CSTARTVIDEOPULL",
+    CMDC_CSTARTVOYEUR = "CMDC_CSTARTVOYEUR",
+    CMDC_CSTOPVIDEOPULL = "CMDC_CSTOPVIDEOPULL",
+    CMDC_CSTOPVOYEUR = "CMDC_CSTOPVOYEUR",
+    CMDP_SUPDATE = "CMDP_SUPDATE",
+    CMDC_CSHOWADMIN = "CMDC_CSHOWADMIN",
+    CMDC_CSTOPSTREAMPUSH = "CMDC_CSTOPSTREAMPUSH",
+    CMDP_SSTATUS = "CMDP_SSTATUS",
+    CMDC_CSTARTTEXT = "CMDC_CSTARTTEXT",
+    CMDC_CSTARTVIDEOPUSH = "CMDC_CSTARTVIDEOPUSH",
+    CMDC_SLOGOUT = "CMDC_SLOGOUT",
+    CMDP_SDEVICESTATUS = "CMDP_SDEVICESTATUS",
+    CMDC_STREAMSTATE = "CMDC_STREAMSTATE",
+    CMDP_GETONLINESUMMARY = "CMDP_GETONLINESUMMARY",
+    CMDP_SMEDIAGETPRICES = "CMDP_SMEDIAGETPRICES",
+    CMDP_SMEDIAPURCHASE = "CMDP_SMEDIAPURCHASE",
+    CMDP_OPEN_LOBBY = "CMDP_OPEN_LOBBY",
+    CMDP_CLOSE_LOBBY = "CMDP_CLOSE_LOBBY",
+    CMDP_SMEDIAOFFERCREATE = "CMDP_SMEDIAOFFERCREATE",
+    CMDP_SINFORMMEDIAPURCHASED = "CMDP_SINFORMMEDIAPURCHASED",
+    CMDP_SETEXPOTOKEN = "CMDP_SETEXPOTOKEN",
+    CMDP_SGETCHATHISTORY = "CMDP_SGETCHATHISTORY",
+    CMDP_SETSETTINGS = "CMDP_SETSETTINGS",
+    CMDP_GETSETTINGS = "CMDP_GETSETTINGS",
+    CMDC_MEDIAPURCHASED = "CMDC_MEDIAPURCHASED",
+    CMDP_SGETMEDIAINFO = "CMDP_SGETMEDIAINFO",
+    CMDP_SFORWARDMEDIA = "CMDP_SFORWARDMEDIA"
+}

package/dist/protocol/command/baseparams.d.ts

@@ -0,0 +1,40 @@
+import { EnumBooleanStringified } from "../../@types/enum-boolean-stringified";
+export declare enum SupportedLanguage {
+    DE = "de",
+    EN = "en",
+    ES = "es"
+}
+export declare enum CmdClientAgent {
+    WEB = "we",
+    MC = "mc"
+}
+/** the format, use 'json', 'plain' is default, but depricated */
+export declare enum EnumFormatValues {
+    JSON = "json",
+    PLAIN = "plain"
+}
+export declare type baseParamsType = {
+    [key: string]: string;
+    /** your app instance id, internal */
+    _iid?: string;
+    /** your app type */
+    agent?: CmdClientAgent;
+    /** your sessionID from CMDP_LOGIN_RESPONSE, Ignored in CMDP_LOGIN, CMDP_INIT */
+    sessionID?: string;
+    /** the format, use 'json', 'plain' is default, but depricated */
+    format?: EnumFormatValues;
+    /** short json, use '1' , default is '0' and force delivery of plain-text non-json format response */
+    strip?: EnumBooleanStringified;
+    /** version info */
+    version?: string;
+    /** language, CmdControl has only de and en implemented */
+    language?: SupportedLanguage;
+    /** webtoken for call into Backend
+     * https://jwt.io/
+     * \{
+     * usrId -  your content partner usrId
+     * usrKey - your customer key
+     * \}
+     */
+    webtoken?: string;
+};

package/dist/protocol/command/icommand.d.ts

@@ -0,0 +1,61 @@
+import { JSONString } from "../../@types/json-stringified";
+import { ComaSeparatedValues } from "../sessionstate";
+import { ResultCode } from "./resultcode";
+import { ACTION } from "./action";
+/**
+ * @remarks cmd-control socket by default returns only string values
+ */
+export declare type StringBasedType = ComaSeparatedValues<string> | JSONString<Object> | string;
+/**
+ * Base dictionary\<strting,string\> object used for params and values
+ * @remarks might not have some of the values, e.g. value might be undefined
+ */
+export interface IKeyMaybeValue {
+    [key: string]: StringBasedType | undefined;
+}
+/**
+ * @remarks always has values
+ */
+export interface IKeyValue {
+    [key: string]: StringBasedType;
+}
+/**
+ * Base command interface
+ */
+export interface ICOMMAND {
+    /**
+     * action is the name of command
+     */
+    action: ACTION;
+    /**
+     * command parameters
+     */
+    params: IKeyMaybeValue;
+}
+/**
+ * result object is the status of CMDP_XXXX_RESPONSE
+ */
+export declare class RESULT {
+    code: ResultCode;
+    /**
+     * infostring string to client
+     */
+    reason: string;
+}
+/**
+ * Response from CmdControl to client
+ */
+export interface IRESPONSE extends ICOMMAND {
+    /**
+     * Response status
+     */
+    result: RESULT;
+    /**
+     * command array to client
+     */
+    commands: ICOMMAND[];
+    /**
+     * response values
+     */
+    values: IKeyMaybeValue;
+}

package/dist/protocol/command/resultcode.d.ts

@@ -0,0 +1,44 @@
+/**
+ * known values for RESULT.code
+ *
+ * for B2B : Use for your custom ERROR_CODE the range 6001-6999
+ */
+export declare enum ResultCode {
+    OK = 2000,
+    WRONG_USER_NAME_OR_PASSWORD = 4002,
+    ACCESS_DENIED = 4003,
+    SESSION_NOT_FOUND = 4004,
+    LOGIN_FAILED = 4006,
+    LOGIN_DOUBLE = 4007,
+    SESSION_ERROR = 4008,
+    PROFIL_NOT_COMPLETE = 4009,
+    TOO_MANY_SESSIONS = 4010,
+    TOO_MANY_SESSIONS2 = 4011,
+    TOO_MANY_SESSIONS3 = 4012,
+    VERSION_NOT_SUPPORTED = 4013,
+    MAIL_NOT_VERYFIED = 4014,
+    AUDIO_NOT_AVAILABLE = 4015,
+    SINGLE_NOT_STARTED = 4016,
+    CHAT_NOT_CLOSED = 4020,
+    CHAT_NOT_FOUND = 4104,
+    NOT_ENOUGH_MONEY = 4141,
+    CANT_UPDATE_CHAT = 4150,
+    CANT_UPDATE_CHAT2 = 4151,
+    INVALID_PARAMETER = 5001,
+    FEATURE_NOT_AVAILABLE = 5002,
+    UNEXPECTED = 5004,
+    NOT_IMPLEMENTED = 5005,
+    NO_CONNECTION = 5096,
+    SCRIPT_ERROR = 5097,
+    TIMEOUT = 5098,
+    NETWORK_ERROR = 5099,
+    /** B2B error-codes start with 6000 */
+    B2B_INTERFACE_ERROR = 6000,
+    UNKNOWN_ERROR = 6001,
+    INVALID_WEB_TOKEN = 6002,
+    NO_CREDIT_VIDEOCHAT = 6106,
+    MODEL_IS_OFFLINE = 6403,
+    SOFT_CHAT = 6601,
+    PREVIEW_LIMIT_EXCEEDED = 6401,
+    MODEL_IS_IN_PRIVATE_CHAT = 6906
+}

package/dist/protocol/connection.d.ts

@@ -0,0 +1,16 @@
+import { ACTION } from "./command/action";
+import { ICOMMAND } from "./command/icommand";
+/**
+ * internal commando used for maintenance of CmdControl-Server-Farm
+ */
+export declare class CMDC_DSRELOAD implements ICOMMAND {
+    action: ACTION;
+    params: {
+        id: string;
+        host: string;
+        PlatformUrl: string;
+        wsshost: string;
+        wssport: string;
+        wsspath: string;
+    };
+}

package/dist/protocol/contactnote.d.ts

@@ -0,0 +1,62 @@
+import { ICOMMAND, ACTION, IRESPONSE, RESULT, IKeyMaybeValue } from "../cmd-protocol";
+import { IBACKENDPAYLOAD } from "./backend";
+import { baseParamsType } from "./command/baseparams";
+import { channelIdOrChatId } from "./channel";
+import IChannelNote from "./channelinfo";
+/**
+ * Transport for Contact note
+ */
+export declare class CMDC_CONTACTNOTE implements ICOMMAND {
+    action: ACTION;
+    params: channelIdOrChatId & IChannelNote;
+}
+/**
+ * Set Contact note
+ */
+export declare class CMDP_SETCONTACTNOTE implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType & channelIdOrChatId & IChannelNote;
+    payload?: unknown;
+}
+/**
+ * Response for CMDP_SETCONTACTNOTE
+ */
+export declare class CMDP_SETCONTACTNOTE_RESPONSE extends CMDP_SETCONTACTNOTE implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    commands: ICOMMAND[];
+    /** unused */
+    values: IKeyMaybeValue;
+}
+/**
+ * Get Contact Note
+ */
+export declare class CMDP_GETCONTACTNOTE implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType & channelIdOrChatId;
+    payload?: unknown;
+}
+/**
+ * Response for CMDP_GETCONTACTNOTE
+ */
+export declare class CMDP_GETCONTACTNOTE_RESPONSE extends CMDP_GETCONTACTNOTE implements IRESPONSE {
+    result: RESULT;
+    commands: CMDC_CONTACTNOTE[];
+    /** unused */
+    values: IKeyMaybeValue;
+}
+/** depricated, 8320 only  */
+export declare class CMDP_SSETCONTACTNOTE extends CMDP_SETCONTACTNOTE {
+    action: ACTION;
+}
+/** depricated, 8320 only  */
+export declare class CMDP_SSETCONTACTNOTE_RESPONSE extends CMDP_SETCONTACTNOTE_RESPONSE {
+    action: ACTION;
+}
+/** depricated, 8320 only  */
+export declare class CMDP_SGETCONTACTNOTE extends CMDP_GETCONTACTNOTE {
+    action: ACTION;
+}
+/** depricated, 8320 only  */
+export declare class CMDP_SGETCONTACTNOTE_RESPONSE extends CMDP_GETCONTACTNOTE_RESPONSE {
+    action: ACTION;
+}

package/dist/protocol/gifts.d.ts

@@ -0,0 +1,19 @@
+import { EnumBooleanStringified, EnumCurrency } from "../@types";
+import { SupportedLanguage } from "./command/baseparams";
+export interface IGiftPrice {
+    value: number | string;
+    currency: EnumCurrency;
+}
+export interface IGiftTranslation {
+    language: SupportedLanguage;
+    value: string;
+}
+export interface IGift {
+    id: number | string;
+    name: string;
+    price: IGiftPrice;
+    imageUrl: string;
+    active: EnumBooleanStringified;
+    categoryId: number | string;
+    translations: IGiftTranslation[];
+}

package/dist/protocol/init.d.ts

@@ -0,0 +1,64 @@
+import { EnumCurrency, ICurrencyDescription, IEmoji, JSONString } from "../@types";
+import { IGift } from "./gifts";
+import { IBACKENDPAYLOAD } from "./backend";
+import { ACTION } from "./command/action";
+import { baseParamsType, SupportedLanguage } from "./command/baseparams";
+import { ICOMMAND, IKeyValue, IRESPONSE, RESULT } from "./command/icommand";
+export interface IInitBackendPayload {
+    giftBundles: any;
+    giftCategories: any;
+    gifts: any;
+    emoticons: any;
+    currency: any;
+    toyControls: any;
+    icons: any;
+}
+/**
+ * the initial command
+ */
+export declare class CMDP_INIT implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        login?: string;
+        initData?: string;
+    };
+}
+/**
+ * Response for CMDP_INIT
+ */
+export declare class CMDP_INIT_RESPONSE extends CMDP_INIT implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: {
+        /** minimal version info */
+        versionRequired?: string;
+        /** version last */
+        versionLast?: string;
+        /** update url */
+        versionUpdateUrl?: string;
+        /** where to send message media */
+        uploadMediaUrl?: string;
+        translations?: JSONString<InitialTranslations>;
+        gifts?: JSONString<IGift[]>;
+        emojiList?: JSONString<IEmoji[]>;
+        currency?: JSONString<InitialCurrencies>;
+    };
+    /** backendpayload */
+    payload?: IInitBackendPayload;
+}
+export declare type InitialTranslations = {
+    [key in SupportedLanguage]?: IKeyValue;
+};
+export declare type InitialCurrencies = {
+    [key in EnumCurrency]?: ICurrencyDescription;
+};
+/**
+ * the initial command, 8320 only
+ */
+export declare class CMDP_SINIT extends CMDP_INIT {
+    action: ACTION;
+}
+/** Response for CMDP_SINIT, 8320 only */
+export declare class CMDP_SINIT_RESPONSE extends CMDP_INIT_RESPONSE {
+    action: ACTION;
+}

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

@@ -0,0 +1,30 @@
+import { ICOMMAND, ACTION, IRESPONSE, RESULT, IKeyMaybeValue } from "../../cmd-protocol";
+import { baseParamsType } from "../command/baseparams";
+/**
+ * update media device infos
+ */
+export declare class CMDP_SDEVICESTATUS implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        camName?: string;
+        width?: number;
+        height?: number;
+        fps?: number;
+        microName?: string;
+        muted?: boolean;
+        volume?: number;
+        channels?: number;
+        sampleRate?: number;
+        sampleSize?: number;
+        bandWidth?: number;
+        cpuLoad?: number;
+    };
+}
+/**
+ * reponse.
+ */
+export declare class CMDP_SDEVICESTATUS_RESPONSE extends CMDP_SDEVICESTATUS implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}