cmd-control-client-lib 3.0.1

package/dist/protocol/systemmessagekey.d.ts

@@ -0,0 +1,157 @@
+/** messageKey for msgTyp="sys" */
+export declare enum SystemMessageKey {
+    bonusCodeRedemption = "bonusCodeRedemption",
+    g_chat_auto_charged = "g_chat_auto_charged",
+    g_chat_host_micro_off = "g_chat_host_micro_off",
+    g_chat_host_micro_on = "g_chat_host_micro_on",
+    g_discount_client = "g_discount_client",
+    g_discount_client_once = "g_discount_client_once",
+    g_single_not_started = "g_single_not_started",
+    g_single_rejected = "g_single_rejected",
+    g_single_started = "g_single_started",
+    g_video_cancel = "g_video_cancel",
+    g_video_delayed = "g_video_delayed",
+    g_video_delerror = "g_video_delerror",
+    h_chat_admin_start = "h_chat_admin_start",
+    h_chat_admin_stop = "h_chat_admin_stop",
+    h_chat_audio_start = "h_chat_audio_start",
+    h_chat_ban_failed = "h_chat_ban_failed",
+    h_chat_ban_ok = "h_chat_ban_ok",
+    h_chat_button_yes_close = "h_chat_button_yes_close",
+    h_chat_cam2cam_running = "h_chat_cam2cam_running",
+    h_chat_cam2cam_start = "h_chat_cam2cam_start",
+    h_chat_cam2cam_stop = "h_chat_cam2cam_stop",
+    h_chat_category_from = "h_chat_category_from",
+    h_chat_client_software = "h_chat_client_software",
+    h_chat_conversion_info_has_top_up = "h_chat_conversion_info_has_top_up",
+    h_chat_conversion_info_no_top_up = "h_chat_conversion_info_no_top_up",
+    h_chat_conversion_start = "h_chat_conversion_start",
+    h_chat_duration = "h_chat_duration",
+    h_chat_free_mode_converted = "h_chat_free_mode_converted",
+    h_chat_freeuserconv = "h_chat_freeuserconv",
+    h_chat_fsk_attention = "h_chat_fsk_attention",
+    h_chat_fsk_denied = "h_chat_fsk_denied",
+    h_chat_fsk_text_warn = "h_chat_fsk_text_warn",
+    h_chat_guest_mobile = "h_chat_guest_mobile",
+    h_chat_guest_sound_off = "h_chat_guest_sound_off",
+    h_chat_guest_sound_on = "h_chat_guest_sound_on",
+    h_chat_guest_visit = "h_chat_guest_visit",
+    h_chat_guest_visit_first = "h_chat_guest_visit_first",
+    h_chat_info_about = "h_chat_info_about",
+    h_chat_kicked = "h_chat_kicked",
+    h_chat_lovense_not_available = "h_chat_lovense_not_available",
+    h_chat_no_history = "h_chat_no_history",
+    h_chat_not_visitx_guest = "h_chat_not_visitx_guest",
+    h_chat_note_caption = "h_chat_note_caption",
+    h_chat_note_create = "h_chat_note_create",
+    h_chat_note_edit = "h_chat_note_edit",
+    h_chat_note_not_available = "h_chat_note_not_available",
+    h_chat_party_mode_converted = "h_chat_party_mode_converted",
+    h_chat_paused_4107 = "h_chat_paused_4107",
+    h_chat_please_micro_on = "h_chat_please_micro_on",
+    h_chat_preview_start = "h_chat_preview_start",
+    h_chat_preview_stop = "h_chat_preview_stop",
+    h_chat_pseudo_user = "h_chat_pseudo_user",
+    h_chat_quest_voyeur_shown = "h_chat_quest_voyeur_shown",
+    h_chat_quest_voyeur_start = "h_chat_quest_voyeur_start",
+    h_chat_rectuited_guest = "h_chat_rectuited_guest",
+    h_chat_single_available = "h_chat_single_available",
+    h_chat_single_not_available = "h_chat_single_not_available",
+    h_chat_single_running = "h_chat_single_running",
+    h_chat_stop = "h_chat_stop",
+    h_chat_stop_guest_error = "h_chat_stop_guest_error",
+    h_chat_test_chat = "h_chat_test_chat",
+    h_chat_text_chat_goal_video = "h_chat_text_chat_goal_video",
+    h_chat_text_muted = "h_chat_text_muted",
+    h_chat_text_start = "h_chat_text_start",
+    h_chat_text_to_video = "h_chat_text_to_video",
+    h_chat_text_unmuted = "h_chat_text_unmuted",
+    h_chat_tip = "h_chat_tip",
+    h_chat_url_blocked = "h_chat_url_blocked",
+    h_chat_userisnovip = "h_chat_userisnovip",
+    h_chat_userisvip = "h_chat_userisvip",
+    h_chat_video_start = "h_chat_video_start",
+    h_chat_video_start_voyeur = "h_chat_video_start_voyeur",
+    h_chat_voyer2single_video_disabled = "h_chat_voyer2single_video_disabled",
+    h_chat_voyeur2single = "h_chat_voyeur2single",
+    h_chat_voyeur2single_off = "h_chat_voyeur2single_off",
+    h_chat_voyeur2single_video_audio_warn = "h_chat_voyeur2single_video_audio_warn",
+    h_chat_voyeur2single_video_warn = "h_chat_voyeur2single_video_warn",
+    h_chat_voyeur_shown = "h_chat_voyeur_shown",
+    h_chat_voyuer = "h_chat_voyuer",
+    h_chat_voyuer_shown = "h_chat_voyuer_shown",
+    h_discount_available = "h_discount_available",
+    h_discount_current = "h_discount_current",
+    h_discount_invalid = "h_discount_invalid",
+    h_discount_not_available = "h_discount_not_available",
+    h_discount_set_ok = "h_discount_set_ok",
+    h_discount_setforinfo = "h_discount_setforinfo",
+    h_error_video_send_failed = "h_error_video_send_failed",
+    h_instant_start = "h_instant_start",
+    h_instant_stop = "h_instant_stop",
+    h_media_audio_error = "h_media_audio_error",
+    h_media_audio_informuploaded = "h_media_audio_informuploaded",
+    h_media_bitmap_error = "h_media_bitmap_error",
+    h_media_video_error = "h_media_video_error",
+    h_media_video_informuploaded = "h_media_video_informuploaded",
+    h_session_appear_offline = "h_session_appear_offline",
+    h_session_audio_device_error = "h_session_audio_device_error",
+    h_session_audio_device_frozen = "h_session_audio_device_frozen",
+    h_session_audio_loudness_ok = "h_session_audio_loudness_ok",
+    h_session_audio_no_loudness = "h_session_audio_no_loudness",
+    h_session_audio_off = "h_session_audio_off",
+    h_session_audio_on = "h_session_audio_on",
+    h_session_button_cancel = "h_session_button_cancel",
+    h_session_button_no = "h_session_button_no",
+    h_session_button_yes = "h_session_button_yes",
+    h_session_cpu_overload = "h_session_cpu_overload",
+    h_session_error = "h_session_error",
+    h_session_free_mode_off = "h_session_free_mode_off",
+    h_session_free_mode_on = "h_session_free_mode_on",
+    h_session_fsk_mixed_profile = "h_session_fsk_mixed_profile",
+    h_session_livepreview_off = "h_session_livepreview_off",
+    h_session_livepreview_on = "h_session_livepreview_on",
+    h_session_mixed_profile_auto_off = "h_session_mixed_profile_auto_off",
+    h_session_mixed_profile_no = "h_session_mixed_profile_no",
+    h_session_mixed_profile_not_available = "h_session_mixed_profile_not_available",
+    h_session_mixed_profile_off = "h_session_mixed_profile_off",
+    h_session_mixed_profile_on = "h_session_mixed_profile_on",
+    h_session_mixed_profile_reminder = "h_session_mixed_profile_reminder",
+    h_session_no_video_allowed = "h_session_no_video_allowed",
+    h_session_offline = "h_session_offline",
+    h_session_offline_title = "h_session_offline_title",
+    h_session_old_ssw = "h_session_old_ssw",
+    h_session_online = "h_session_online",
+    h_session_online_today = "h_session_online_today",
+    h_session_party_mode_off = "h_session_party_mode_off",
+    h_session_party_mode_on = "h_session_party_mode_on",
+    h_session_preview_picture_missed = "h_session_preview_picture_missed",
+    h_session_preview_picture_upload = "h_session_preview_picture_upload",
+    h_session_service0900state_turnoff = "h_session_service0900state_turnoff",
+    h_session_service0900state_turnon = "h_session_service0900state_turnon",
+    h_session_stream_not_found = "h_session_stream_not_found",
+    h_session_stream_restart = "h_session_stream_restart",
+    h_session_stream_wait = "h_session_stream_wait",
+    h_session_toy_start = "h_session_toy_start",
+    h_session_toy_stop = "h_session_toy_stop",
+    h_session_user_locked = "h_session_user_locked",
+    h_session_video_device_error = "h_session_video_device_error",
+    h_session_video_device_frozen = "h_session_video_device_frozen",
+    h_single_error = "h_single_error",
+    h_single_init_failed = "h_single_init_failed",
+    h_single_init_ok = "h_single_init_ok",
+    h_single_not_available = "h_single_not_available",
+    h_single_query = "h_single_query",
+    h_single_rejected = "h_single_rejected",
+    h_single_request_90s = "h_single_request_90s",
+    h_single_started = "h_single_started",
+    h_single_timeout = "h_single_timeout",
+    h_video_cancel = "h_video_cancel",
+    h_video_delayed = "h_video_delayed",
+    h_video_reconnect = "h_video_reconnect",
+    h_vcall_code = "h_vcall_code",
+    h_session_media_purchased = "h_session_media_purchased",
+    h_media_bitmap_purchased = "h_media_bitmap_purchased",
+    h_media_video_purchased = "h_media_video_purchased",
+    h_media_audio_purchased = "h_media_audio_purchased"
+}

package/dist/protocol/toy.d.ts

@@ -0,0 +1,60 @@
+import { IMayHaveChannelId } from "./channel";
+import { ACTION } from "./command/action";
+import { baseParamsType } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "./command/icommand";
+/**
+ * update the toy state
+ */
+export declare class CMDP_TOYSTATE implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        online: boolean;
+    };
+}
+/**
+ * response for CMDP_TOYSTATE
+ */
+export declare class CMDP_TOYSTATE_RESPONSE extends CMDP_TOYSTATE implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    values: IKeyMaybeValue;
+    /** unused */
+    commands: ICOMMAND[];
+}
+/** the toy action parameters */
+export declare type toyActionParams = {
+    /** milliseconds */
+    duration: string;
+    /** float value from 0.0 to 1.0 */
+    intensity: string;
+    /**  the messageKey - corelation to CMDP_MSG with gift */
+    messageKey?: string;
+    /**  the relationId of this Action */
+    relationId?: string;
+    /**  the text message from backend */
+    text?: string;
+    /** language */
+    language?: string;
+};
+/**
+ * command to send the toy action to channel
+ */
+export declare class CMDP_TOYACTION implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & IMayHaveChannelId & toyActionParams;
+}
+/** response for CMDP_TOYACTION */
+export declare class CMDP_TOYACTION_RESPONSE extends CMDP_TOYACTION implements IRESPONSE {
+    result: RESULT;
+    /** unused */
+    values: IKeyMaybeValue;
+    /** unused */
+    commands: ICOMMAND[];
+}
+/**
+ * the toy action command
+ */
+export declare class CMDC_TOYACTION implements ICOMMAND {
+    action: ACTION;
+    params: IMayHaveChannelId & toyActionParams & IKeyMaybeValue;
+}

package/dist/protocol/unused.d.ts

@@ -0,0 +1,26 @@
+import { ACTION } from "./command/action";
+import { baseParamsType, SupportedLanguage } from "./command/baseparams";
+import { ICOMMAND, IKeyMaybeValue, IRESPONSE, RESULT } from "./command/icommand";
+/**
+ * unused
+ */
+export declare class CMDP_UPDATE implements ICOMMAND {
+    action: ACTION;
+    params: baseParamsType & {
+        usrId?: string;
+        usrKey?: string;
+        language?: SupportedLanguage;
+        broadcastData?: string;
+        permanentData?: string;
+        jwtKey?: string;
+        state?: string;
+    };
+}
+/**
+ * Response for CMDP_UPDATE
+ */
+export declare class CMDP_UPDATE_RESPONSE extends CMDP_UPDATE implements IRESPONSE {
+    result: RESULT;
+    commands: ICOMMAND[];
+    values: IKeyMaybeValue;
+}

package/dist/protocol/update-state.d.ts

@@ -0,0 +1,11 @@
+import { ChatState } from "./chatstate";
+import { ACTION } from "./command/action";
+import { ICOMMAND } from "./command/icommand";
+import { SessionState } from "./sessionstate";
+/**
+ * Update state command for vchat-core or for cmdcontrol-session
+ */
+export declare class CMDC_UPDATE implements ICOMMAND {
+    action: ACTION;
+    params: ChatState | SessionState;
+}

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "__VERSION__";

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "cmd-control-client-lib",
+  "description": "Cmd-Client-Library",
+  "version": "3.0.1",
+  "directories": {
+    "lib": "./dist"
+  },
+  "main": "./dist/cmd-control-lib.js",
+  "types": "./dist/cmd-control-lib.d.ts",
+  "private": false,
+  "license": "MIT",
+  "author": "Vladimir Lidberg, camPoint AG",
+  "contributors": [
+    {
+      "name": "Vladimir Lidberg",
+      "email": "vl@campoint.net"
+    },
+    {
+      "name": "Igor Timoshenkov",
+      "email": "igor@aporia.su"
+    }
+  ],
+  "keywords": [],
+  "dependencies": {
+    "xmlentities": "^0.2.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.10.2",
+    "@babel/preset-env": "^7.10.2",
+    "@babel/preset-typescript": "^7.10.1",
+    "@types/jest": "^26.0.23",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "clean-webpack-plugin": "^4.0.0-alpha.0",
+    "eslint": "^7.25.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-deprecation": "^1.2.0",
+    "eslint-plugin-jest": "^24.3.6",
+    "eslint-plugin-jest-formatting": "^3.0.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-sonarjs": "^0.7.0",
+    "eslint-plugin-tsdoc": "^0.2.14",
+    "eslint-plugin-unicorn": "^32.0.0",
+    "eslint-teamcity": "^3.0.1",
+    "husky": "^6.0.0",
+    "jest": "^26.6.3",
+    "lint-staged": "^11.0.0",
+    "pinst": "^2.1.6",
+    "prettier": "^2.2.1",
+    "pretty-quick": "^3.1.0",
+    "rimraf": "^3.0.0",
+    "string-replace-loader": "^3.0.1",
+    "ts-loader": "^9.1.1",
+    "typedoc": "^0.20.36",
+    "typedoc-plugin-markdown": "^3.7.2",
+    "typescript": "^4.2.4",
+    "webpack": "^5.36.1",
+    "webpack-cli": "^4.6.0",
+    "webpack-merge": "^5.7.3"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "clean:docs": "rimraf ./doc",
+    "build": "webpack --config webpack.prod.js",
+    "build:dev": "webpack --config webpack.dev.js",
+    "watch": "webpack --config webpack.dev.js --watch",
+    "lint": "eslint src test --ext .ts",
+    "lint:teamcity": "yarn lint --format ./node_modules/eslint-teamcity/index.js",
+    "style": "prettier --write \"{src,test}/**/*.ts\"",
+    "test": "jest",
+    "generate:docs": "typedoc --out doc/ src/cmd-control-lib.ts --theme markdown",
+    "_postinstall": "husky install",
+    "prepack": "yarn run prepublishOnly",
+    "postpack": "yarn run postpublish",
+    "prepublishOnly": "pinst --disable",
+    "postpublish": "pinst --enable"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "trailingComma": "all",
+    "singleQuote": false,
+    "semi": true,
+    "arrowParens": "always"
+  },
+  "lint-staged": {
+    "*.ts": "eslint --cache"
+  }
+}

package/test/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: ["../.eslintrc.js", "plugin:jest/recommended", "plugin:jest-formatting/recommended"],
+  plugins: ["jest", "jest-formatting"],
+  env: {
+    "jest/globals": true,
+  },
+  rules: {
+    "sonarjs/no-duplicate-string": "off",
+    "unicorn/consistent-function-scoping": "off",
+    "jest/expect-expect": "off",
+  },
+};

package/test/json-stringified.spec.ts

@@ -0,0 +1,11 @@
+import { SupportedLanguage } from "../src/protocol/command/baseparams";
+import { InitialTranslations } from "../src/protocol/init";
+import { JSONString } from "../src/@types";
+
+describe("JSONStringified", () => {
+  it("should be OK to JSON.parse", () => {
+    const response: JSONString<InitialTranslations> = '{"de": {"some": "token"}}';
+    const parsed = JSON.parse(response);
+    expect(parsed[SupportedLanguage.DE]?.some).toEqual("token");
+  });
+});

package/test/result.spec.ts

@@ -0,0 +1,18 @@
+import { RESULT } from "../src/protocol/command/icommand";
+import { CODE } from "../src/protocol/command/resultcode";
+
+describe("RESULT", () => {
+  it("Should accept ENUM OK value as result codes", () => {
+    const result: RESULT = {
+      code: CODE.OK,
+      reason: "All good",
+    };
+  });
+
+  it("Should accept ENUM ERROR value as result codes", () => {
+    const result: RESULT = {
+      code: CODE.SESSION_ERROR,
+      reason: "Unknown session",
+    };
+  });
+});

package/test/session-state.spec.ts

@@ -0,0 +1,23 @@
+import { EnumSetTp, SessionState } from "../src/protocol/sessionstate";
+
+describe("SessionState", () => {
+  // it("Should accept ENUM values as strings (flags)", () => {
+  //   const flags = CommaSp;
+
+  //   const withFlags: SessionState = {
+  //     sessionID: "test",
+  //     login: "test",
+  //     startTime: Date.now().toString(),
+  //     flags: `${SessionFlag.ADMIN},${SessionFlag.HASFSK18CHAT}`,
+  //   };
+  // });
+
+  it("Should accept ENUM values as strings (setTp)", () => {
+    const withSetTp: SessionState = {
+      sessionID: "test",
+      login: "test",
+      startTime: Date.now().toString(),
+      setTp: EnumSetTp.OFFLINE,
+    };
+  });
+});

package/workspace.code-workspace

@@ -0,0 +1,13 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+        "cSpell.diagnosticLevel": "Hint",
+        "cSpell.ignoreRegExpList": [
+            ".*"
+        ]
+    }
+}