@voicenter-team/events-sdk 0.0.12 → 0.0.14

package/docs/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "voicneter-events-sdk",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "authors": {
+    "name": "",
+    "email": "bohdan.ko@voicenter.com"
+  },
+  "scripts": {
+    "dev": "vuepress dev src",
+    "build": "vuepress build src"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@vuepress/plugin-register-components": "^2.0.0-beta.62",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.3",
+    "vuepress": "^2.0.0-beta.62",
+    "vuepress-plugin-typedoc": "^0.12.1"
+  },
+  "dependencies": {
+    "dotenv": "^16.3.1"
+  }
+}

package/docs/src/.vuepress/client.js

@@ -0,0 +1,8 @@
+import { defineClientConfig } from '@vuepress/client'
+import './styles/index.scss'
+
+export default defineClientConfig({
+    enhance({ app, router, siteData }) {},
+    setup() {},
+    rootComponents: [],
+})

package/docs/src/.vuepress/components/Demo.vue

@@ -0,0 +1,191 @@
+<template>
+    <div>
+        <p v-if="loading">
+            Loading...
+        </p>
+
+        <template v-else>
+            <div>
+                <pre><code style="color: black">{{ JSON.stringify(events, null, 4) }}</code></pre>
+            </div>
+
+            <div>
+                <form @submit.prevent="login">
+                    <input type="text" v-model="token" placeholder="token"/>
+
+                    <button type="submit">Login</button>
+                </form>
+            </div>
+        </template>
+    </div>
+</template>
+
+<script lang="ts" setup>
+import {reactive, ref} from 'vue'
+import EventsSdkClass from '@/index'
+import {eventsSdkDefaultOptions} from '@/classes/events-sdk/events-sdk-default-options'
+import {EventsEnum} from '@/enum/events.enum'
+import {EventTypeData} from '@/types/events'
+import {LoginType} from "@/enum/auth.enum";
+
+/* Data */
+const token = ref('lJVBSEk084tzLaFpIWTReBw54trHD2Jlt8hThhX6OAxJ5IjyCC740znrXXgIzj1QtM67n2NOEGNn4SjrPJxuvkxbFb4tWHjS3cyh')
+const loading = ref(false)
+const loggedId = ref(false)
+const events = reactive<{ [K in EventsEnum]?: Array<EventTypeData<K>> }>({})
+
+/* Methods */
+async function login() {
+    if (!token.value) {
+        return alert('Token is required')
+    }
+
+    loading.value = true
+
+    const sdk = new EventsSdkClass({
+        "token": "lJVBSEk084tzLaFpIWTReBw54trHD2Jlt8hThhX6OAxJ5IjyCC740znrXXgIzj1QtM67n2NOEGNn4SjrPJxuvkxbFb4tWHjS3cyh",
+        "serverFetchStrategy": "remote",
+        "url": "https://monitor2.comms24x7.com/monitorAPI/getMonitorUrls",
+        "loginUrl": "https://loginapi.comms24x7.com/monitorAPI/Login",
+        "refreshTokenUrl": "https://loginapi.comms24x7.com/monitorAPI/RefreshIdentityToken",
+        "servers": [{
+            "URLID": 1,
+            "Priority": 5,
+            "Version": "1.3.7",
+            "Domain": "monitor1.comms24x7.com"
+        }, {"URLID": 2, "Priority": 4, "Version": "1.3.7", "Domain": "monitor2.comms24x7.com"}]
+    })
+
+    await sdk.init()
+
+    sdk.on(
+        EventsEnum.ALL_DIALER_STATUS,
+        ({ data }) => {
+
+            if (!events[EventsEnum.ALL_DIALER_STATUS]) {
+                events[EventsEnum.ALL_DIALER_STATUS] = []
+            }
+
+            events[EventsEnum.ALL_DIALER_STATUS]?.push(data)
+        }
+    )
+
+    sdk.on(
+        EventsEnum.ALL_EXTENSION_STATUS,
+        ({ data }) => {
+
+            if (!events[EventsEnum.ALL_EXTENSION_STATUS]) {
+                events[EventsEnum.ALL_EXTENSION_STATUS] = []
+            }
+
+            events[EventsEnum.ALL_EXTENSION_STATUS]?.push(data)
+        }
+    )
+
+    sdk.on(
+        EventsEnum.ALL_USERS_STATUS,
+        ({ data }) => {
+
+            if (!events[EventsEnum.ALL_USERS_STATUS]) {
+                events[EventsEnum.ALL_USERS_STATUS] = []
+            }
+
+            events[EventsEnum.ALL_USERS_STATUS]?.push(data)
+        }
+    )
+
+    sdk.on(
+        EventsEnum.QUEUE_EVENT,
+        ({ data }) => {
+
+            if (!events[EventsEnum.QUEUE_EVENT]) {
+                events[EventsEnum.QUEUE_EVENT] = []
+            }
+
+            events[EventsEnum.QUEUE_EVENT]?.push(data)
+        }
+    )
+
+    sdk.on(
+        EventsEnum.EXTENSION_EVENT,
+        ({ data }) => {
+
+            if (!events[EventsEnum.EXTENSION_EVENT]) {
+                events[EventsEnum.EXTENSION_EVENT] = []
+            }
+
+            events[EventsEnum.EXTENSION_EVENT]?.push(data)
+        }
+    )
+
+    sdk.on(
+        EventsEnum.LOGIN_SUCCESS,
+        ({ data }) => {
+            if (!events[EventsEnum.LOGIN_SUCCESS]) {
+                events[EventsEnum.LOGIN_SUCCESS] = []
+            }
+
+            loggedId.value = true
+            loading.value = false
+
+            events[EventsEnum.LOGIN_SUCCESS]?.push(data)
+        }
+    )
+
+    sdk.on(
+        EventsEnum.LOGIN_STATUS,
+        ({ data }) => {
+            if (!events[EventsEnum.LOGIN_STATUS]) {
+                events[EventsEnum.LOGIN_STATUS] = []
+            }
+
+            events[EventsEnum.LOGIN_STATUS]?.push(data)
+        }
+    )
+
+    sdk.on(
+        '*',
+        (data) => {
+            switch (data.name) {
+                case EventsEnum.ALL_DIALER_STATUS:
+                    console.log(`FROM ALL ${EventsEnum.ALL_DIALER_STATUS}`, data)
+                    break
+                case EventsEnum.ALL_EXTENSION_STATUS:
+                    console.log(`FROM ALL ${EventsEnum.ALL_EXTENSION_STATUS}`, data)
+                    break
+                case EventsEnum.ALL_USERS_STATUS:
+                    console.log(`FROM ALL ${EventsEnum.ALL_USERS_STATUS}`, data)
+                    break
+                case EventsEnum.QUEUE_EVENT:
+                    console.log(`FROM ALL ${EventsEnum.QUEUE_EVENT}`, data)
+                    break
+                case EventsEnum.EXTENSION_EVENT:
+                    console.log(`FROM ALL ${EventsEnum.EXTENSION_EVENT}`, data)
+                    break
+                case EventsEnum.LOGIN_SUCCESS:
+                    console.log(`FROM ALL ${EventsEnum.LOGIN_SUCCESS}`, data)
+                    break
+                case EventsEnum.LOGIN_STATUS:
+                    console.log(`FROM ALL ${EventsEnum.LOGIN_STATUS}`, data)
+                    break
+                case EventsEnum.ONLINE_STATUS_EVENT:
+                    console.log(`FROM ALL ${EventsEnum.ONLINE_STATUS_EVENT}`, data)
+                    break
+                default:
+                    console.log('Unknown event', data)
+
+            }
+        }
+    )
+
+    setTimeout(
+        () => {
+            if (!loggedId.value) {
+                loading.value = false
+                alert('Login failed')
+            }
+        },
+        5000
+    )
+}
+</script>

package/docs/src/.vuepress/config.js

@@ -0,0 +1,60 @@
+import { defineUserConfig, defaultTheme } from 'vuepress'
+import { description } from '../../package'
+import { registerComponentsPlugin } from '@vuepress/plugin-register-components'
+import { getDirname, path } from '@vuepress/utils'
+import { typedocPlugin } from 'vuepress-plugin-typedoc/next';
+import * as dotenv from 'dotenv'
+dotenv.config()
+
+const __dirname = getDirname(import.meta.url)
+
+export default defineUserConfig({
+    description: description,
+
+    head: [
+        ['link', {rel: 'icon', href: '/favicon.ico'}],
+        ['meta', {name: 'theme-color', content: '#2675FF'}],
+        ['meta', {name: 'apple-mobile-web-app-capable', content: 'yes'}],
+        ['meta', {name: 'apple-mobile-web-app-status-bar-style', content: '#2675FF'}]
+    ],
+
+    theme: defaultTheme({
+        repo: '',
+        editLinks: false,
+        logo: '/images/logo.png',
+        docsDir: '',
+        editLinkText: '',
+        colorMode: 'light',
+        lastUpdated: false,
+        sidebar: [
+            {
+                text: 'General',
+                link: '/',
+                collapsible: false,
+                children: [
+                    'demo',
+                    {
+                        text: 'API',
+                        link: 'api',
+                        rel: 'api'
+                    }
+                ]
+            }
+        ]
+    }),
+
+    plugins: [
+        registerComponentsPlugin({
+            componentsDir: path.resolve(__dirname, './components')
+        }),
+        // typedocPlugin({
+        //     entryPoints: ['../src/types/public-api.d.ts'],
+        //     tsconfig: '../tsconfig.json'
+        // })
+    ],
+
+    alias: {
+        '@': path.resolve(__dirname, '../', '../', '../', 'src'),
+        'root': path.resolve(__dirname, '../', '../', '../'),
+    }
+})

package/docs/src/.vuepress/styles/index.styl

@@ -0,0 +1,8 @@
+/**
+ * Custom Styles here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/config/#index-styl
+ */
+
+.home .hero img
+  max-width 450px!important

package/docs/src/.vuepress/styles/palette.styl

@@ -0,0 +1,10 @@
+/**
+ * Custom palette here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
+ */
+
+$accentColor = #a5c544
+$textColor = #2c3e50
+$borderColor = #eaecef
+$codeBgColor = #282c34

package/docs/src/demo.md

@@ -0,0 +1,7 @@
+# Demo
+
+<ClientOnly>
+<div class="py-5">
+    <Demo />
+</div>
+</ClientOnly>

package/docs/src/index.md

@@ -0,0 +1,4 @@
+# Voicenter Events SDK
+
+- [Demo](demo.md)
+- [API](api/modules.md)

package/interface.ts

@@ -0,0 +1,261 @@
+interface options {
+
+    /**
+     * the authentication payload sent when connecting to the Namespace
+     */
+    auth?: {
+        [key: string]: any;
+    } | ((cb: (data: object) => void) => void);
+    /**
+     * The maximum number of retries. Above the limit, the packet will be discarded.
+     *
+     * Using `Infinity` means the delivery guarantee is "at-least-once" (instead of "at-most-once" by default), but a
+     * smaller value like 10 should be sufficient in practice.
+     */
+    retries?: number;
+    /**
+     * The default timeout in milliseconds used when waiting for an acknowledgement.
+     */
+    ackTimeout?: number;
+
+    /**
+     * The host that we're connecting to. Set from the URI passed when connecting
+     */
+    host: string;
+    /**
+     * The hostname for our connection. Set from the URI passed when connecting
+     */
+    hostname: string;
+    /**
+     * If this is a secure connection. Set from the URI passed when connecting
+     */
+    secure: boolean;
+    /**
+     * The port for our connection. Set from the URI passed when connecting
+     */
+    port: string | number;
+    /**
+     * Any query parameters in our uri. Set from the URI passed when connecting
+     */
+    query: {
+        [key: string]: any;
+    };
+    /**
+     * `http.Agent` to use, defaults to `false` (NodeJS only)
+     *
+     * Note: the type should be "undefined | http.Agent | https.Agent | false", but this would break browser-only clients.
+     *
+     * @see https://nodejs.org/api/http.html#httprequestoptions-callback
+     */
+    agent: string | boolean;
+    /**
+     * Whether the client should try to upgrade the transport from
+     * long-polling to something better.
+     * @default true
+     */
+    upgrade: boolean;
+    /**
+     * Forces base 64 encoding for polling transport even when XHR2
+     * responseType is available and WebSocket even if the used standard
+     * supports binary.
+     */
+    forceBase64: boolean;
+    /**
+     * The param name to use as our timestamp key
+     * @default 't'
+     */
+    timestampParam: string;
+    /**
+     * Whether to add the timestamp with each transport request. Note: this
+     * is ignored if the browser is IE or Android, in which case requests
+     * are always stamped
+     * @default false
+     */
+    timestampRequests: boolean;
+    /**
+     * A list of transports to try (in order). Engine.io always attempts to
+     * connect directly with the first one, provided the feature detection test
+     * for it passes.
+     *
+     * @default ['polling','websocket', 'webtransport']
+     */
+    transports: string[];
+    /**
+     * If true and if the previous websocket connection to the server succeeded,
+     * the connection attempt will bypass the normal upgrade process and will
+     * initially try websocket. A connection attempt following a transport error
+     * will use the normal upgrade process. It is recommended you turn this on
+     * only when using SSL/TLS connections, or if you know that your network does
+     * not block websockets.
+     * @default false
+     */
+    rememberUpgrade: boolean;
+    /**
+     * Are we only interested in transports that support binary?
+     */
+    onlyBinaryUpgrades: boolean;
+    /**
+     * Timeout for xhr-polling requests in milliseconds (0) (only for polling transport)
+     */
+    requestTimeout: number;
+    /**
+     * Transport options for Node.js client (headers etc)
+     */
+    transportOptions: Object;
+    /**
+     * (SSL) Certificate, Private key and CA certificates to use for SSL.
+     * Can be used in Node.js client environment to manually specify
+     * certificate information.
+     */
+    pfx: string;
+    /**
+     * (SSL) Private key to use for SSL. Can be used in Node.js client
+     * environment to manually specify certificate information.
+     */
+    key: string;
+    /**
+     * (SSL) A string or passphrase for the private key or pfx. Can be
+     * used in Node.js client environment to manually specify certificate
+     * information.
+     */
+    passphrase: string;
+    /**
+     * (SSL) Public x509 certificate to use. Can be used in Node.js client
+     * environment to manually specify certificate information.
+     */
+    cert: string;
+    /**
+     * (SSL) An authority certificate or array of authority certificates to
+     * check the remote host against.. Can be used in Node.js client
+     * environment to manually specify certificate information.
+     */
+    ca: string | string[];
+    /**
+     * (SSL) A string describing the ciphers to use or exclude. Consult the
+     * [cipher format list]
+     * (http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT) for
+     * details on the format.. Can be used in Node.js client environment to
+     * manually specify certificate information.
+     */
+    ciphers: string;
+    /**
+     * (SSL) If true, the server certificate is verified against the list of
+     * supplied CAs. An 'error' event is emitted if verification fails.
+     * Verification happens at the connection level, before the HTTP request
+     * is sent. Can be used in Node.js client environment to manually specify
+     * certificate information.
+     */
+    rejectUnauthorized: boolean;
+    /**
+     * Headers that will be passed for each request to the server (via xhr-polling and via websockets).
+     * These values then can be used during handshake or for special proxies.
+     */
+    extraHeaders?: {
+        [header: string]: string;
+    };
+    /**
+     * Whether to include credentials (cookies, authorization headers, TLS
+     * client certificates, etc.) with cross-origin XHR polling requests
+     * @default false
+     */
+    withCredentials: boolean;
+    /**
+     * Whether to automatically close the connection whenever the beforeunload event is received.
+     * @default false
+     */
+    closeOnBeforeunload: boolean;
+    /**
+     * Whether to always use the native timeouts. This allows the client to
+     * reconnect when the native timeout functions are overridden, such as when
+     * mock clocks are installed.
+     * @default false
+     */
+    useNativeTimers: boolean;
+    /**
+     * weather we should unref the reconnect timer when it is
+     * create automatically
+     * @default false
+     */
+    autoUnref: boolean;
+    /**
+     * parameters of the WebSocket permessage-deflate extension (see ws module api docs). Set to false to disable.
+     * @default false
+     */
+    perMessageDeflate: {
+        threshold: number;
+    };
+    /**
+     * The path to get our client file from, in the case of the server
+     * serving it
+     * @default '/engine.io'
+     */
+    path: string;
+    /**
+     * Whether we should add a trailing slash to the request path.
+     * @default true
+     */
+    addTrailingSlash: boolean;
+    /**
+     * Either a single protocol string or an array of protocol strings. These strings are used to indicate sub-protocols,
+     * so that a single server can implement multiple WebSocket sub-protocols (for example, you might want one server to
+     * be able to handle different types of interactions depending on the specified protocol)
+     * @default []
+     */
+    protocols: string | string[];
+
+    /**
+     * Should we force a new Manager for this connection?
+     * @default false
+     */
+    forceNew: boolean;
+    /**
+     * Should we multiplex our connection (reuse existing Manager) ?
+     * @default true
+     */
+    multiplex: boolean;
+    /**
+     * The path to get our client file from, in the case of the server
+     * serving it
+     * @default '/socket.io'
+     */
+    path: string;
+    /**
+     * Should we allow reconnections?
+     * @default true
+     */
+    reconnection: boolean;
+    /**
+     * How many reconnection attempts should we try?
+     * @default Infinity
+     */
+    reconnectionAttempts: number;
+    /**
+     * The time delay in milliseconds between reconnection attempts
+     * @default 1000
+     */
+    reconnectionDelay: number;
+    /**
+     * The max time delay in milliseconds between reconnection attempts
+     * @default 5000
+     */
+    reconnectionDelayMax: number;
+    /**
+     * Used in the exponential backoff jitter when reconnecting
+     * @default 0.5
+     */
+    randomizationFactor: number;
+    /**
+     * The timeout in milliseconds for our connection attempt
+     * @default 20000
+     */
+    timeout: number;
+    /**
+     * Should we automatically connect?
+     * @default true
+     */
+    autoConnect: boolean;
+    /**
+     * the parser to use. Defaults to an instance of the Parser that ships with socket.io.
+     */
+    parser: any;
+}

package/jest.config.js

@@ -0,0 +1,11 @@
+// jest.config.js
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    roots: [ '<rootDir>/src' ],
+    transform: {
+        '^.+\\.tsx?$': 'ts-jest',
+    },
+    testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+    moduleFileExtensions: [ 'ts', 'tsx', 'js', 'jsx', 'json', 'node' ],
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voicenter-team/events-sdk",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "",
   "main": "dist/voicenter-events-sdk.cjs.js",
   "jsdelivr": "dist/voicenter-events-sdk.umd.js",
@@ -21,9 +21,6 @@
     "npm": ">= 9.6.7",
     "yarn": ">= 1.22.4"
   },
-  "files": [
-    "dist"
-  ],
   "precommit": "ts-check, lint",
   "keywords": [],
   "author": "",