cmd-control-client-lib 3.0.1

package/dist/protocol/mediaoffer.d.ts

@@ -0,0 +1,48 @@
+import { ACTION, baseParamsType, IBACKENDPAYLOAD, ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "../cmd-protocol";
+import { channelIdType } from "./channel";
+import { Currency, MediaFile, MediaPrice, MessageId } from "./message";
+export declare type PriceInstruction = {
+    min: string;
+    max: string;
+    pick: string[];
+};
+export declare type MediaPrices = {
+    imagePrices: PriceInstruction;
+    audioPrices: PriceInstruction;
+    videoPrices: PriceInstruction;
+};
+/**
+ * Command for get prices for media. Will be forwarded to B2B backend.
+ */
+export declare class CMDP_SMEDIAGETPRICES implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & channelIdType;
+}
+/**
+ * Response command for CMDP_SMEDIAGETPRICES
+ */
+export declare class CMDP_SGETPRICESMEDIA_PRESPONSE extends CMDP_SMEDIAGETPRICES implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+    /** B2B Infos */
+    payload: Currency & MediaPrices;
+}
+/**
+ * B2B Command for create of media offer
+ */
+export declare class CMDP_SMEDIAOFFERCREATE implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & channelIdType & Currency & MediaPrice & MediaFile & MessageId & {
+        userPoolId: string;
+        usrKey: string;
+    };
+}
+/**
+ * B2B Response command for CMDP_SMEDIAOFFERCREATE
+ */
+export declare class CMDP_SMEDIAOFFERCREATE_PRESPONSE extends CMDP_SMEDIAOFFERCREATE implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}

package/dist/protocol/mediapurchase.d.ts

@@ -0,0 +1,49 @@
+import { ACTION, baseParamsType, ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "../cmd-protocol";
+import { channelIdType } from "./channel";
+import { CMDC_CMSG, MediaFile, MediaPrice, MessageId } from "./message";
+/**
+ * Frontent command for media purchase. Will be forwarded to users pool B2B backend with additional infos
+
+ */
+export declare class CMDP_SMEDIAPURCHASE implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & channelIdType & 
+    /** the message id of related media offer */
+    MessageId & 
+    /** MediaPrice is added to proxy call from Cmdontrol to B2B backend */
+    MediaPrice & 
+    /** MediaFile is added to proxy call from CmdControl to B2B backend */
+    MediaFile;
+}
+/**
+ * Response command for CMDP_SMEDIAPURCHASE.
+ */
+export declare class CMDP_SMEDIAPURCHASE_PRESPONSE extends CMDP_SMEDIAPURCHASE implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+/**
+ * B2B command for inform partnter about media purchase. Will be sent to partners B2B backend.
+ */
+export declare class CMDP_SINFORMMEDIAPURCHASED implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & channelIdType & 
+    /** the message id of related media offer */
+    MessageId & 
+    /** MediaPrice is added to proxy call from CmdControl to B2B backend */
+    MediaPrice & 
+    /** MediaFile is added to proxy call from Cmdontrol to B2B backend */
+    MediaFile;
+}
+/**
+ * Response command for CMDP_SMEDIAPURCHASE.
+ */
+export declare class CMDP_SINFORMMEDIAPURCHASED_RESPONSE extends CMDP_SINFORMMEDIAPURCHASED implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}
+export declare class CMDC_MEDIAPURCHASED extends CMDC_CMSG {
+    action: ACTION;
+}

package/dist/protocol/mediaupload.d.ts

@@ -0,0 +1,86 @@
+import { IBACKENDPAYLOAD } from "./backend";
+import { channelIdType } from "./channel";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IRESPONSE, RESULT, IKeyMaybeValue } from "./command/icommand";
+import { EnumMediaType, MediaFile, MediaOffer, MessageParams } from "./message";
+export declare enum UploadStep {
+    earlyreject = "earlyreject",
+    lateaccept = "lateaccept",
+    informuploaded = "informuploaded",
+    transcoded = "transcoded",
+    error = "error"
+}
+/** internal use only, may be changed without announce*/
+export declare type UploadServiceReadOnlyParams = {
+    step: UploadStep;
+    fileformat?: EnumMediaType;
+    md5?: string;
+    transactionID?: string;
+    origfilename?: string;
+    imgSrc?: string;
+    imgSrcSet?: string;
+    height?: string;
+    width?: string;
+    audioMp3?: string;
+    audioOgg?: string;
+    audioM4a?: string;
+    audioDuration?: string;
+    videoPoster?: string;
+    videoPosterPixelated?: string;
+    videoHls?: string;
+    videoHeight?: string;
+    videoWidth?: string;
+    videoDuration?: string;
+};
+/**
+ * the upload command
+ * usage POST to \{uploadMediaUrl\}?action=CMDP_SUPLOADMEDIA&sessionId=\{\}&channelId=\{\}.....
+ */
+export declare class CMDP_SUPLOADMEDIA implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & MessageParams & UploadServiceReadOnlyParams & MediaOffer;
+}
+/**
+ * Response for CMDP_INIT
+ */
+export declare class CMDP_SUPLOADMEDIA_RESPONSE extends CMDP_SUPLOADMEDIA implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+    /** backendpayload */
+    payload?: unknown;
+}
+/**
+ *  Get the Media Cache state.
+ * md5 - is filemd5
+ */
+export declare class CMDP_SGETMEDIAINFO implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        md5: string;
+    };
+}
+/**
+ *  Media Info, if found in cache, or CHAT_NOT_FOUND, if not.
+ */
+export declare class CMDP_SGETMEDIAINFO_RESPONSE extends CMDP_SGETMEDIAINFO {
+    action: ACTION;
+    params: baseParamsType & {
+        md5: string;
+    };
+    values: MediaFile;
+}
+/**
+ *  Forward media to channel
+ */
+export declare class CMDP_SFORWARDMEDIA implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        md5: string;
+    } & channelIdType & MediaOffer;
+}
+export declare class CMDP_SFORWARDMEDIA_RESPONSE extends CMDP_SFORWARDMEDIA {
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}

package/dist/protocol/message.d.ts

@@ -0,0 +1,184 @@
+import { channelIdType, IMayHaveChannelId } from "./channel";
+import { EnumBooleanStringified, EnumCurrency } from "../@types";
+import { SystemMessageKey } from "./systemmessagekey";
+import { IBACKENDPAYLOAD } from "./backend";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "./command/icommand";
+export declare enum MessageFlags {
+    "canDeleted" = 0,
+    "isDeleted" = 1
+}
+export declare enum EnumMessageFlagValue {
+    NO = "0",
+    YES = "1"
+}
+export declare enum EnumMessageType {
+    MAIL = "mail",
+    CHAT = "chat",
+    MESSENGER = "msn",
+    SYSTEM = "sys"
+}
+export declare enum EnumMessageDirection {
+    IN = "in",
+    OUT = "out"
+}
+export declare enum EnumMediaType {
+    BITMAP = "Bitmap",
+    AUDIO = "Audio",
+    VIDEO = "Video"
+}
+export declare enum EnumMediaState {
+    OK = "ok",
+    TRANSCODING = "transcode",
+    ERROR = "error"
+}
+export declare enum EnumMessageStyle {
+    GUEST = "g" /** depretacted */,
+    SYSTEM = "s" /** depretacted */,
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+    INFO_HIGHLIGHT = "InfoHighlight"
+}
+export declare type Currency = {
+    currency?: EnumCurrency;
+};
+export declare type Chargeable = {
+    isChargeable?: EnumBooleanStringified;
+};
+/** message params */
+export declare type MessageParams = IMayHaveChannelId & {
+    /** your uniq key for message */
+    messageKey?: SystemMessageKey | string;
+    /** chat id  */
+    chatID?: string;
+    /** text-message */
+    text?: string;
+    /** tip, eurocent */
+    tip?: string;
+    /** gift ids, coma separated */
+    gift?: string;
+    /** currency, todo: */
+    currency?: EnumCurrency;
+    link?: string;
+    clientData?: string;
+};
+export declare type MediaInfo = {
+    /** the media attached */
+    mediaType?: EnumMediaType | string;
+    /** state of media attached */
+    mediaState?: EnumMediaState | string;
+};
+export declare type MediaPrice = Currency & {
+    mediaPrice?: string;
+};
+export declare type MediaOffer = Chargeable & MediaPrice;
+export declare type ImageFile = MediaInfo & {
+    /** Bitmap media*/
+    imgSrc?: string;
+    imgSrcSet?: string;
+    imgHeight?: string;
+    imgWidth?: string;
+    imgSrcBlurred?: string;
+    imgSrcSetBlurred?: string;
+};
+export declare type AudioFile = MediaInfo & {
+    /** Audio media*/
+    audioMp3?: string;
+    audioM4a?: string;
+    audioOgg?: string;
+    audioDuration?: string;
+};
+export declare type VideoFile = MediaInfo & {
+    /**Video media */
+    videoPoster?: string;
+    videoHls?: string;
+    videoHeight?: string;
+    videoWidth?: string;
+    videoDuration?: string;
+    videoPosterBlurred?: string;
+};
+export declare type MediaFile = ImageFile | AudioFile | VideoFile;
+/** id of the message */
+export declare type MessageId = {
+    messageId: string;
+};
+export declare type RelationId = {
+    /** messageId of related message */
+    relationId?: string;
+};
+/** more message params, readonly (set by server, ignored if set by client) */
+export declare type MessageReadOnlyParams = {
+    /** the uniq message id */
+    messageId?: string;
+    /** source of the message IN CMDP_MSG, writable for B2B session */
+    msgType?: EnumMessageType;
+    /** sent time */
+    time?: string;
+    /** timeSeen */
+    timeSeen?: string;
+    /** direction */
+    direction?: EnumMessageDirection;
+    /** sound name */
+    sound?: string;
+    /** Will be present for paid message **/
+    priceCode?: string;
+    /** the message was bought by the opponent*/
+    isPaid?: EnumBooleanStringified.TRUE;
+    /**
+     * coma separated MessageFlags, const flags = cmd.params.flags ? cmd.params.flags.split(',').map((flag: string) =\> flag.trim()) : [];
+     * ignored IN CMDP_MSG
+     */
+    flags?: string | "";
+    canDelete?: EnumBooleanStringified.TRUE;
+    isDeleted?: EnumBooleanStringified.TRUE;
+    /** message style/importance */
+    style?: EnumMessageStyle;
+} & RelationId & MediaFile & MediaOffer;
+/**
+ * Command for transport of MessageType
+ */
+export declare class CMDC_CMSG implements ICOMMAND {
+    action: ACTION;
+    params: MessageParams & MessageReadOnlyParams & IKeyMaybeValue;
+}
+/**
+ * send message
+ */
+export declare class CMDP_MSG implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType & MessageParams;
+    /** if jwt-session, any json-payload for transport to backend */
+    payload?: unknown;
+}
+/**
+ * Response command for CMDP_MSG
+ */
+export declare class CMDP_MSG_RESPONSE extends CMDP_MSG implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    commands: ICOMMAND[];
+    /** unused */
+    values: IKeyMaybeValue;
+    /** if jwt-session, any json-payload for transport to to client */
+    payload?: unknown;
+}
+/**
+ * delete of message
+ * your message will be deleted on your and partner side, partner message will be deleted only on your side
+ */
+export declare class CMDP_MSGDELETE implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & channelIdType & MessageId;
+}
+/**
+ * Response for CMDP_MSGDELETE
+ */
+export declare class CMDP_MSGDELETE_RESPONSE extends CMDP_MSGDELETE implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    commands: ICOMMAND[];
+    /** unused */
+    values: IKeyMaybeValue;
+}

package/dist/protocol/messenger/expo.d.ts

@@ -0,0 +1,19 @@
+import { ICOMMAND, ACTION, IRESPONSE, RESULT, IKeyMaybeValue } from "../../cmd-protocol";
+import { baseParamsType } from "../command/baseparams";
+/**
+ * update media device infos
+ */
+export declare class CMDP_SETEXPOTOKEN implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        token?: string;
+    };
+}
+/**
+ * reponse.
+ */
+export declare class CMDP_SETEXPOTOKEN_RESPONSE extends CMDP_SETEXPOTOKEN implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}

package/dist/protocol/noop.d.ts

@@ -0,0 +1,14 @@
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "./command/icommand";
+export declare class CMDP_NOOP implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType;
+}
+export declare class CMDP_NOOP_RESPONSE extends CMDP_NOOP implements IRESPONSE {
+    result: RESULT;
+    /** server commands for your session/user */
+    commands: ICOMMAND[];
+    /** unused */
+    values: IKeyMaybeValue;
+}

package/dist/protocol/onlinestate.d.ts

@@ -0,0 +1,74 @@
+import { EnumBooleanStringified } from "../@types/enum-boolean-stringified";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "./command/icommand";
+import { IMayHaveChannelId, partnerIdKeyType } from "./channel";
+/** online state of session */
+export declare type OnlineStateType = {
+    partnerId: string;
+    /** model id */
+    partnerKey: string;
+    /** is online */
+    online: EnumBooleanStringified;
+    /** normal video vchat available */
+    multi: EnumBooleanStringified;
+    /** messaging available */
+    messenger: EnumBooleanStringified;
+    /** single vchat available */
+    single: EnumBooleanStringified;
+    /** soft vchat available */
+    soft: EnumBooleanStringified;
+    /** text over vchat available  */
+    text: EnumBooleanStringified;
+    /** preview vchat available */
+    preview: EnumBooleanStringified;
+    /** visbility for Content Partnter */
+    visible: EnumBooleanStringified;
+    /** voyeur vchat available */
+    voyeur: EnumBooleanStringified;
+    /** voyeur into single vchat available */
+    voyeur2s: EnumBooleanStringified;
+    /** lobby vchat available */
+    lobby: EnumBooleanStringified;
+    /** toy state */
+    toy: EnumBooleanStringified;
+};
+/**
+ * Transport command for online state
+ */
+export declare class CMDC_ONLINESTATE implements ICOMMAND {
+    action: ACTION;
+    params: OnlineStateType;
+}
+/**
+ * Query online state of contact
+ */
+export declare class CMDP_GETONLINESTATE implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & (IMayHaveChannelId | partnerIdKeyType);
+}
+/**
+ * Response CMDP_GETONLINESTATE
+ */
+export declare class CMDP_GETONLINESTATE_RESPONSE extends CMDP_GETONLINESTATE implements IRESPONSE {
+    result: RESULT;
+    commands: CMDC_ONLINESTATE[];
+    /** unused */
+    values: IKeyMaybeValue;
+}
+/**
+ * get all onlilne 8320 users
+ */
+export declare class CMDP_GETONLINESTATES implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & IMayHaveChannelId;
+}
+/**
+ * Response for @see CMDP_GETONLINECONTACTS
+ */
+export declare class CMDP_GETONLINESTATES_RESPONSE extends CMDP_GETONLINESTATES implements IRESPONSE {
+    result: RESULT;
+    commands: CMDC_ONLINESTATE[];
+    /** unused */
+    values: IKeyMaybeValue;
+}

package/dist/protocol/sessionstate.d.ts

@@ -0,0 +1,74 @@
+import { IProductConfig } from "./live/products-config";
+import { EnumService0900State } from "./live/supdate";
+import { IKeyMaybeValue } from "./command/icommand";
+import { SupportedLanguage } from "./command/baseparams";
+import { EnumBooleanStringified, JSONString, EnumBooleanStringifiedExtended } from "../@types";
+export declare enum EnumSetTp {
+    OFFLINE = "0",
+    ONLINE = "1",
+    GOING_ONLINE = "2"
+}
+export declare enum EnumFsk {
+    SIXTEEN = "16",
+    EIGHTEEN = "18"
+}
+export declare enum SessionFlag {
+    MASTER = "MASTER",
+    B2B = "B2B",
+    FSK16 = "FSK16",
+    FSK18 = "FSK18",
+    BLOCKFSK16 = "BLOCKFSK16",
+    FSKMASK = "FSKMASK",
+    JWT = "JWT",
+    MSN = "MSN",
+    SHARED = "SHARED",
+    ADMIN = "ADMIN",
+    HASFSK18CHAT = "HASFSK18CHAT",
+    /**
+     * used only for avs moderator sessions
+     */
+    WEBCAMAVS = "WEBCAMAVS",
+    FREEMODE = "FREEMODE",
+    PARTYMODE = "PARTYMODE",
+    BBS24 = "BBS24",
+    LOBBY_OPENED = "LOBBY_OPENED"
+}
+/**
+ * @remarks String having <T>'s separated by ','
+ */
+export interface ComaSeparatedValues<T> extends String {
+    readonly _valueType: T;
+}
+export interface SessionState extends IKeyMaybeValue {
+    /** the session mnumber */
+    sessionID: string;
+    /** loginname, deprecated, use CMDP_GETUSERINFO */
+    login: string;
+    /** start time */
+    startTime: string;
+    online?: EnumBooleanStringified;
+    setTp?: EnumSetTp;
+    flags?: ComaSeparatedValues<SessionFlag> | SessionFlag;
+    /** en de */
+    language?: SupportedLanguage;
+    /** unused */
+    broadcastData?: string;
+    /** Used for client-side short-cuts (live) */
+    permanentData?: string;
+    /** avatar  */
+    imgSrc?: string;
+    /** FSKSTATE */
+    fsk?: EnumFsk;
+    /** SoftChat */
+    fsk16?: EnumBooleanStringifiedExtended;
+    /** deprecated, use service0900State*/
+    service0900state?: EnumService0900State;
+    /** service 0900 state, if missing in LOGIN values, the service is not available */
+    service0900State?: EnumService0900State;
+    /** the live preview*/
+    livePreviewState?: EnumBooleanStringified;
+    /** */
+    babeStation24State?: EnumBooleanStringified;
+    userLinks?: JSONString<IProductConfig["links"]>;
+    chatMotto?: string;
+}