cmd-control-client-lib 3.0.1

package/dist/protocol/b2b/b2buserinfo.d.ts

@@ -0,0 +1,106 @@
+import { EnumBooleanStringified, JSONString } from "../../@types";
+import { EnumProductId, usrKeyType } from "../channel";
+import { ACTION } from "../command/action";
+import { baseParamsType } from "../command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IKeyValue, IRESPONSE, RESULT } from "../command/icommand";
+/**
+ *  user information and abilities
+ */
+interface IUserInfo extends IKeyValue {
+    /** product id readonly*/
+    productId?: EnumProductId;
+    /** user Login/Name to show */
+    ualias?: string;
+    /** user language, 2-symbol code lower case. "de", "en" */
+    language?: string;
+    /** avatar url */
+    imgSrc?: string;
+    /** avatar url sourceSet,  ignored in SET-Commands */
+    imgSrcSet?: string;
+    /** any json encoded string for client software */
+    payload?: JSONString<unknown>;
+    /** age verification status */
+    avs?: EnumBooleanStringified;
+    /** abilities */
+    canSendMessage?: EnumBooleanStringified;
+    canReceiveMessage?: EnumBooleanStringified;
+    canSendImage?: EnumBooleanStringified;
+    canReceiveImage?: EnumBooleanStringified;
+    canSendAudio?: EnumBooleanStringified;
+    canReceiveAudio?: EnumBooleanStringified;
+    canSendVideo?: EnumBooleanStringified;
+    canReceiveVideo?: EnumBooleanStringified;
+    canOfferMedia?: EnumBooleanStringified;
+    canPurchaseMedia?: EnumBooleanStringified;
+}
+/**
+ * product "VOne" extra information and abilities
+ */
+export interface IUserInfoVOne extends IUserInfo {
+    isVIP?: EnumBooleanStringified;
+    canCall0900?: EnumBooleanStringified;
+    canSingleSession?: EnumBooleanStringified;
+    canBuyShopContent: EnumBooleanStringified;
+    canBeDiscounted: EnumBooleanStringified;
+    canSendGifts: EnumBooleanStringified;
+    canControlToy: EnumBooleanStringified;
+    canBeBan: EnumBooleanStringified;
+}
+/**
+ * B2B basic user information
+ */
+export declare type IB2BUserInfo = IUserInfo;
+/**
+ * B2B Vone user information
+ */
+export declare type IB2BUserInfoVOne = IUserInfoVOne;
+/**
+ * user information transport object
+ */
+export declare class CMDC_USERINFO implements ICOMMAND {
+    action: ACTION;
+    params: {
+        usrId: string;
+        usrKey: string;
+    } & (IB2BUserInfo | IB2BUserInfoVOne);
+}
+/**
+ * B2B only
+ * Create/Update user information in messenger system
+ */
+export declare class CMDP_SETUSERINFO implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & usrKeyType & (IUserInfo | IUserInfoVOne);
+}
+/**
+ * Response for CMDP_SETUSERINFO
+ */
+export declare class CMDP_SETUSERINFO_RESPONSE extends CMDP_SETUSERINFO implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    values: IKeyMaybeValue;
+    /** unused */
+    commands: ICOMMAND[];
+}
+/**
+ * B2B only
+ * Get user information in messenger system
+ */
+export declare class CMDP_GETUSERINFO implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        /** userKey */
+        usrKey: string;
+    };
+}
+/**
+ * Response CMDP_GETUSERINFO
+ */
+export declare class CMDP_GETUSERINFO_RESPONSE extends CMDP_GETUSERINFO implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    values: IKeyMaybeValue;
+    /** user info */
+    commands: CMDC_USERINFO[];
+}
+export {};

package/dist/protocol/backend.d.ts

@@ -0,0 +1,48 @@
+import { JSONString } from "../@types";
+import { IMayHaveChannelId, usrKeyType } from "./channel";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "./command/icommand";
+export interface IBackEndPayload {
+    type: any;
+    data: any;
+}
+/**
+ * payload for transport to backend and from backend to client
+ */
+export interface IBACKENDPAYLOAD {
+    payload?: unknown;
+}
+/**
+ * common command for take a backend  action
+ */
+export declare class CMDP_QUERYBACKEND implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType;
+    /** if jwt-session, any json-payload for transport to backend */
+    payload?: JSONString<any>;
+}
+/**
+ * response CMDP_QUERYBACKEND
+ */
+export declare class CMDP_QUERYBACKEND_RESPONSE extends CMDP_QUERYBACKEND implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+    /** if jwt-session, any json-payload for transport to to client */
+    payload?: JSONString<any>;
+}
+/**
+ * the update commando from backend over B2B-connection to client for channel
+ */
+export declare class CMDC_BACKENDPAYLOAD implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: IMayHaveChannelId & usrKeyType & IKeyMaybeValue;
+    payload?: IBackEndPayload;
+}
+/** the b2b command for publish of CMDC_BACKENDPAYLOAD */
+export declare class CMDP_BACKENDPAYLOAD implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: IMayHaveChannelId & usrKeyType & IKeyMaybeValue;
+    payload?: IBackEndPayload;
+}

package/dist/protocol/channel.d.ts

@@ -0,0 +1,341 @@
+import { ComaSeparatedValues } from "./sessionstate";
+import { chatIdType } from "./chatstate";
+import { EnumChannelFlags, EnumBooleanStringified, EnumBooleanStringifiedExtended } from "../@types";
+import { IBACKENDPAYLOAD } from "./backend";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IKeyValue, IRESPONSE, RESULT, StringBasedType } from "./command/icommand";
+import { CMDC_CMSG } from "./message";
+import { IB2BUserInfo, IB2BUserInfoVOne } from "./b2b/b2buserinfo";
+/**
+ * channelId has Format "usrId.usrKey-partnerId.partnerKey"
+ * userPoolId - business id in messenger system, number\{10,0\}
+ * usrKey - key of your customer in your sytem, string(36 bytes), "." and "-" are not allowed
+ * partnerId - userPoolId of your partner in messenger system, number\{10,0\}
+ * partnerKey - key of partner customer, string(36 bytes), "." and "-" are not allowed
+ */
+/**
+ * Type that definitely has `channelId` field
+ */
+export declare type channelIdType = {
+    channelId: string;
+};
+/**
+ * Type that may or may not have `channelId` field
+ */
+export interface IMayHaveChannelId {
+    channelId?: string;
+}
+export declare type usrKeyType = {
+    /** key of your customer.  obligatory param for b2b session */
+    usrKey?: string;
+};
+export declare type partnerIdKeyType = {
+    /** id of your business partner in messenger system */
+    partnerId: string;
+    /** key of partners customer */
+    partnerKey: string;
+};
+/** mind one of both, please */
+export declare type channelIdOrChatId = channelIdType | chatIdType;
+/**
+ * channel
+ */
+export declare class ChannelType implements IKeyValue {
+    [key: string]: StringBasedType;
+    /** channel id */
+    channelId: string;
+    /** your business usrId in messenger system */
+    usrId: string;
+    /** the key of your customer */
+    usrKey: string;
+    /** id of your business partner in messenger system */
+    partnerId: string;
+    /** key of partner customer */
+    partnerKey: string;
+    /** time of last incoming message */
+    lastTimeIn: string;
+    /** time of last outgoing message */
+    lastTimeOut: string;
+    /** number of unseen messages */
+    unseen: string;
+    /** update spam serial */
+    serial: string;
+    /** @see EnumChannelFlags */
+    flags?: ComaSeparatedValues<EnumChannelFlags> | EnumChannelFlags;
+}
+/**
+ * the command for delivery channel info
+ */
+export declare class CMDC_CHANNEL implements ICOMMAND {
+    action: ACTION;
+    params: ChannelType;
+}
+/**
+ * create new channel. the channel must be created before send of message
+ */
+export declare class CMDP_NEWCHANNEL implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & usrKeyType & partnerIdKeyType & (IB2BUserInfo | IB2BUserInfoVOne);
+}
+/**
+ * response for CMDP_NEWCHANNEL
+ */
+export declare class CMDP_NEWCHANNEL_RESPONSE extends CMDP_NEWCHANNEL implements IRESPONSE {
+    result: RESULT;
+    /** the created channel */
+    commands: CMDC_CHANNEL[];
+    /** deprecated. the created channel, values is ChannelType */
+    values: ChannelType;
+}
+/**
+ * Get the ChannelInfo. this command works with channelId and will be reflected to backend.
+ */
+export declare class CMDP_GETCHANNEL implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType & channelIdType;
+    payload?: unknown;
+}
+/**
+ * response for CMDP_GETCHANNEL
+ */
+export declare class CMDP_GETCHANNEL_RESPONSE extends CMDP_GETCHANNEL implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    /** the channel info */
+    commands: CMDC_CHANNEL[];
+    /** unused, empty */
+    values: IKeyMaybeValue;
+    /** the backend info to the channel */
+    payload?: unknown;
+}
+/**
+ * 8320 only.
+ */
+export declare class CMDP_SGETCHANNEL extends CMDP_GETCHANNEL {
+    action: ACTION;
+}
+/**
+ * 8320 only
+ */
+export declare class CMDP_SGETCHANNEL_RESPONSE extends CMDP_SGETCHANNEL {
+    action: ACTION;
+}
+export declare enum EnumSortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export declare enum EnumChannelFilterValues {
+    ANY = "any",
+    ONLY = "only",
+    EXCLUDE = "exclude"
+}
+export declare enum EnumProductId {
+    Default = "1",
+    PAGES = "2",
+    PARTNER = "3",
+    TV = "4"
+}
+export declare type getChannelsParamsType = {
+    /** from serial, default = 0 */
+    serial?: string;
+    /** limit, default is 1000 */
+    limit?: string;
+    /** get CMDC_CONTACTNOTE in commands, default 0, deprecated */
+    contactNote?: EnumBooleanStringifiedExtended;
+    /** get CMDC_CONTACTINFO in commands, default 0, allowed for b2b session only */
+    contactInfo?: EnumBooleanStringifiedExtended;
+    /** get CMDC_CHANNELINFO in commands, default 0 */
+    channelInfo?: EnumBooleanStringifiedExtended;
+    /** get CMDC_ONLINESTATE in commands */
+    onlineState?: EnumBooleanStringifiedExtended;
+    /** search for contact-name, default empty */
+    contactSearch?: string;
+    sort: EnumSortOrder;
+    /** filter channels without incoming messages, default any */
+    filterEmptyIn?: EnumChannelFilterValues;
+    /** filter channels without outgoing messages, default any */
+    filterEmptyOut?: EnumChannelFilterValues;
+    /** filter archived channels, default any */
+    filterArchived?: EnumChannelFilterValues;
+    /** 8320 only , default any */
+    filterAdvertised?: EnumChannelFilterValues;
+    /** filter by favorite flag, default any */
+    filterRegularCustomer?: EnumChannelFilterValues;
+    /** filter by unseen, default any */
+    filterUnseen?: EnumChannelFilterValues;
+    /** filter by unanswered, default any */
+    filterUnAnswered?: EnumChannelFilterValues;
+    /** filter by pinned, default any */
+    filterPinned?: EnumChannelFilterValues;
+    /** filter by muted, default any */
+    filterMuted?: EnumChannelFilterValues;
+    /** filter by VIP status, default any */
+    filterVIP?: EnumChannelFilterValues;
+    /** filter by product id, default empty*/
+    filterProductId?: EnumProductId;
+    /** filter by banned */
+    filterBanned?: EnumChannelFilterValues;
+};
+/**
+ * Query for ChannelList
+ */
+export declare class CMDP_GETCHANNELS implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & getChannelsParamsType;
+}
+/**
+ * Response for CMDP_GETCHANNELS
+ */
+export declare class CMDP_GETCHANNELS_RESPONSE extends CMDP_GETCHANNELS implements IRESPONSE {
+    result: RESULT;
+    /** channels */
+    commands: CMDC_CHANNEL[];
+    /** unused */
+    values: IKeyMaybeValue;
+}
+/** synonym, 8320 only */
+export declare class CMDP_SGETCHANNELS extends CMDP_GETCHANNELS {
+    action: ACTION;
+}
+/** synonym, 8320 only */
+export declare class CMDP_SGETCHANNELS_RESPONSE extends CMDP_GETCHANNELS_RESPONSE {
+    action: ACTION;
+}
+/** searchAfter must be used together */
+export declare type IMayHaveSearchAfter = {
+    searchAfterTime?: string;
+    searchAfterId?: string;
+};
+export declare type getHistoryParamsType = IMayHaveChannelId & IMayHaveSearchAfter & {
+    /** number of messages, max & default is 100 */
+    limit?: string;
+    /** sort by sent, default is DESC */
+    sort: EnumSortOrder;
+    keys?: EnumBooleanStringifiedExtended;
+};
+/**
+ * Get messages history for channel
+ * Multichannel command
+ */
+export declare class CMDP_GETHISTORY implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & getHistoryParamsType;
+}
+/**
+ * Response for CMDP_GETHISTORY
+ */
+export declare class CMDP_GETHISTORY_RESPONSE extends CMDP_GETHISTORY implements IRESPONSE {
+    result: RESULT;
+    /** found messages */
+    commands: CMDC_CMSG[];
+    /** unused */
+    values: IKeyMaybeValue;
+}
+export declare type channelSeenParamsType = channelIdType & {
+    /** last seen messageId, by default all messages marked as seen */
+    messageId?: string;
+};
+/**
+ * Mark messages as seen
+ */
+export declare class CMDP_CHANNELSEEN implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & channelSeenParamsType;
+}
+/** alias, 8320 only */
+export declare class CMDP_SCHANNELSEEN extends CMDP_CHANNELSEEN {
+    action: ACTION;
+}
+/** alias, 8320 only */
+export declare class CMDP_CHANNELSEEN_RESPONSE extends CMDP_SCHANNELSEEN implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    commands: ICOMMAND[];
+    /** unused */
+    values: IKeyMaybeValue;
+}
+/** alias, 8320 only */
+export declare class CMDP_SCHANNELSEEN_RESPONSE extends CMDP_CHANNELSEEN_RESPONSE {
+    action: ACTION;
+}
+export declare enum EnumUpdateChannelPropertyName {
+    ARCHIVED = "archived",
+    REGULAR_CUSTOMER = "regularCustomer",
+    UNANSWERED = "unanswered",
+    PINNED = "pinned",
+    MUTED = "muted",
+    BANNED = "banned"
+}
+export declare class updateChannelParamsType implements IKeyMaybeValue {
+    [key: string]: string;
+    /** flag name */
+    propertyName: EnumUpdateChannelPropertyName;
+    /** flag value */
+    propertyValue: EnumBooleanStringified;
+}
+/**
+ * Set Flag on Channel
+ * @deprecated use CMDP_SETCHANNELINFO
+ */
+export declare class CMDP_UPDATECHANNEL implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType & updateChannelParamsType;
+    payload?: unknown;
+}
+/**
+ * Response for CMDP_UPDATECHANNEL
+ */
+export declare class CMDP_UPDATECHANNEL_RESPONSE extends CMDP_UPDATECHANNEL implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    /** unused */
+    commands: ICOMMAND[];
+    /** unused */
+    values: IKeyMaybeValue;
+    payload?: unknown;
+}
+/**
+ * Query the summary info about all channels
+ */
+export declare class CMDP_CHANNELSSUMMARY implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & usrKeyType;
+}
+/**
+ * Response for CMDP_CHANNELSSUMMARY
+ */
+export declare class CMDP_CHANNELSSUMMARY_RESPONSE extends CMDP_CHANNELSSUMMARY implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    commands: ICOMMAND[];
+    /** the summary info */
+    values: {
+        /** your business id */
+        usrId: string;
+        /** usrKey of your user */
+        usrKey: string;
+        /** number of channel */
+        channels: string;
+        /** number of unseen messages */
+        unseen: string;
+        /** number of unseen messages */
+        unseenWithoutArchived: string;
+        /** number of unanswered channels */
+        unanswered: string;
+        /** last time of incoming message  */
+        lastTimeIn: string;
+        /** last time of outgoing message */
+        lastTimeOut: string;
+        /** number of archived channels */
+        archived: string;
+        /** number of advertised channels */
+        advertised: string;
+        /** number of regular channels */
+        regular: string;
+        /** number of pinned channels */
+        pinned: string;
+        /** number of muted channels */
+        muted: string;
+        /** number of vip channels */
+        vip: string;
+    };
+}

package/dist/protocol/channelinfo.d.ts

@@ -0,0 +1,98 @@
+import { EnumBooleanStringified, JSONString } from "../@types";
+import { IBACKENDPAYLOAD } from "./backend";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IKeyValue, IRESPONSE, RESULT } from "./command/icommand";
+import { channelIdType, EnumProductId } from "./channel";
+import { IB2BUserInfo, IB2BUserInfoVOne } from "./b2b/b2buserinfo";
+/**
+ *  product code
+ */
+export interface IProduct {
+    productId: EnumProductId;
+}
+export interface IChannelInfoBackEndPayload {
+    freeChatDuration: number;
+    freeMessagesCount: number;
+    messagePrice: number;
+    videoChatPrice: number;
+    voyeurChatPrice: number;
+}
+/**
+ * channel information and abilities
+ */
+export interface IChanelInfo extends IKeyMaybeValue {
+    canBeArchived?: EnumBooleanStringified;
+}
+/**
+ * User channel information and abilities
+ */
+export interface IChanelInfoV extends IKeyMaybeValue {
+    /** the VOne channel(user) was advertised by user, readonly*/
+    advertised?: EnumBooleanStringified;
+    /** json-encoded string. discount information about video chat discount, readonly */
+    discount?: JSONString<any>;
+    /** the user follew me (mirrored regularCustomer), readonly */
+    followMe: EnumBooleanStringified;
+}
+/**
+ * channel note
+ */
+export default interface IChannelNote extends IKeyValue {
+    firstName?: string;
+    lastName?: string;
+    age?: string;
+    city?: string;
+    regularCustomer?: string;
+    notes?: string;
+    note?: string;
+}
+export interface ChannelInfo extends channelIdType, Partial<IProduct>, IChanelInfo, IChanelInfoV, Partial<IB2BUserInfoVOne>, IChannelNote {
+}
+export declare type ChannelInfoType = channelIdType & IProduct & IChanelInfo & IChanelInfoV & (IB2BUserInfo | IB2BUserInfoVOne) & IChannelNote;
+/**
+ * transport command for channel information
+ */
+export declare class CMDC_CHANNELINFO implements ICOMMAND {
+    action: ACTION;
+    params: ChannelInfoType;
+}
+/**
+ * get channel information
+ */
+export declare class CMDP_GETCHANNELINFO implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & channelIdType;
+}
+/**
+ * Response for CMDP_CHANNELINFO
+ */
+export declare class CMDP_GETCHANNELINFO_RESPONSE extends CMDP_GETCHANNELINFO implements IRESPONSE, IBACKENDPAYLOAD {
+    result: RESULT;
+    /** ContactInfo */
+    commands: CMDC_CHANNELINFO[];
+    /** unused */
+    values: IKeyMaybeValue;
+    /** the backend info for the channel */
+    payload?: IChannelInfoBackEndPayload;
+}
+/**
+ * set channel note.
+ */
+export declare class CMDP_SETCHANNELINFO implements ICOMMAND, IBACKENDPAYLOAD {
+    action: ACTION;
+    params: baseParamsType & channelIdType & IChanelInfoV & IChannelNote;
+    /** the backend info for the channel */
+    payload?: unknown;
+}
+/**
+ * Response for CMDP_SETCHANNELINFO
+ */
+export declare class CMDP_SETCHANNELINFO_RESPONSE extends CMDP_SETCHANNELINFO implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    /** unused */
+    values: IKeyMaybeValue;
+    /** the backend info for the channel */
+    payload?: unknown;
+}

package/dist/protocol/chatstate.d.ts

@@ -0,0 +1,42 @@
+import { EnumBooleanDigitized } from "../@types";
+/**
+ * Type that definitely has `channelId` field
+ */
+export declare type chatIdType = {
+    chatID: string;
+};
+/**
+ *  chat state
+ */
+export declare type ChatState = {
+    /** single ability */
+    canSingle?: EnumBooleanDigitized;
+    /** single status */
+    isSingle?: EnumBooleanDigitized;
+    /** audio ability */
+    hasAudio?: EnumBooleanDigitized;
+    /** audio state */
+    audioMuted?: EnumBooleanDigitized;
+    /** videotime limit */
+    videolimit?: string;
+    /** videotime limit left */
+    videolimit_left?: string;
+    /** texttime limit */
+    textlimit?: string;
+    /** timelimit  */
+    timelimit?: string;
+    /** preview video time limit */
+    previewlimit?: string;
+    /** HLS is allowed */
+    useHLSJS?: EnumBooleanDigitized;
+    /** TIP-function ability */
+    canTip?: EnumBooleanDigitized;
+    /** Preview ability */
+    canPreview?: EnumBooleanDigitized;
+    /** voyuer into single chat state */
+    voyeur2single?: EnumBooleanDigitized;
+    /** charge ability */
+    canCharge?: EnumBooleanDigitized;
+    /** the chat is lobby mass show */
+    isLobby?: EnumBooleanDigitized;
+};