airdcpp-apisocket 2.4.4 → 2.5.0-beta.1

package/GUIDE.md

@@ -9,8 +9,8 @@
   - [isConnected](#isconnected)
   - [logout](#logout)
 - [Connect state events](#connect-state-events)
-  - [onSocketConnected](#onsocketconnected)
-  - [onSocketDisconnected](#onsocketdisconnected)
+  - [onConnected](#onconnected)
+  - [onDisconnected](#ondisconnected)
   - [onSessionReset](#onsessionreset)
 - [Logger](#logger)
 - [API requests](#api-requests)
@@ -71,7 +71,7 @@ const socket = Socket(settings, w3cwebsocket);
 | :--- | :--- | :---: | :--- |
 | **url** | `string` |  | Fully qualified API URL (**required**). Example: ws://localhost:5600/api/v1/ |
 | **username, password** | `string` |  | Username and password to use when connecting to the API. Alternatively you may provide the credentials when calling [`connect`](#connect). |
-| **autoReconnect** | `boolean` | true | Reconnect automatically if the socket gets disconnected |
+| **autoReconnect** | `boolean` | true | Reconnect automatically if there are network errors when initializing connection or when a connected socket gets disconnected |
 | **reconnectInterval** | `number` | 10 | Interval of automatic reconnection (seconds) |
 | **requestTimeout** | `number` | 30 | Notify about about API requests that have taken longer than this to complete (seconds). This is mainly used for detecting possible issues (deadlocks) with the backend as messages sent via WebSocket should always be delivered (pending request will be aborted automatically when the socket is disconnected). |
 | **reconnectInterval** | `number` | 10 | Interval of automatic reconnection (seconds) |
@@ -160,13 +160,13 @@ Promise that will be resolved with the possible response of the [DELETE /session
 
 ## Connect state events
 
-### `onSocketConnected`
+### `onConnected`
 
-`onSocketConnected(data)`
+`onConnected(data)`
 
 Fired after the socket was connected and authenticated. `data` is the data received from the API authentication request ([`connect`](#connect)/[`reconnect`](#reconnect)).
 
-### `onSocketDisconnected`
+### `onDisconnected`
 
 Fired after the socket was disconnected.
 
@@ -393,7 +393,7 @@ Optional form definitions:
 
 **`menuType`** (string, required)
 
-Menu type (see the (Menu API documentation)[https://airdcpp.docs.apiary.io/#reference/menus] for available types)
+Menu type (see the [Menu API documentation](https://airdcpp.docs.apiary.io/#reference/menus) for available types)
 
 **`subscriberInfo`** (object, required)
 

package/README.md

@@ -97,8 +97,9 @@ If you are using AirDC++ Web Client, you can start the client with ``--cdm-clien
 The ADC protocol specifications can be found from http://adc.sourceforge.net/ADC.html
 
 
-[build-badge]: https://img.shields.io/travis/airdcpp-web/airdcpp-apisocket-js/master.svg?style=flat-square
-[build]: https://travis-ci.org/airdcpp-web/airdcpp-apisocket-js
+
+[build-badge]: https://github.com/airdcpp-web/airdcpp-apisocket-js/actions/workflows/node.js.yml/badge.svg
+[build]: https://github.com/airdcpp-web/airdcpp-apisocket-js/actions/workflows/node.js.yml
 
 [npm-badge]: https://img.shields.io/npm/v/airdcpp-apisocket.svg?style=flat-square
 [npm]: https://www.npmjs.org/package/airdcpp-apisocket

package/babel.config.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    '@babel/preset-env'
+  ]
+};
+

package/dist/ApiConstants.d.ts

@@ -1,6 +1,6 @@
-declare const _default: {
-    LOGIN_URL: string;
-    CONNECT_URL: string;
-    LOGOUT_URL: string;
-};
-export default _default;
+declare const _default: {
+    LOGIN_URL: string;
+    CONNECT_URL: string;
+    LOGOUT_URL: string;
+};
+export default _default;

package/dist/ApiConstants.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    LOGIN_URL: 'sessions/authorize',
-    CONNECT_URL: 'sessions/socket',
-    LOGOUT_URL: 'sessions/self',
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    LOGIN_URL: 'sessions/authorize',
+    CONNECT_URL: 'sessions/socket',
+    LOGOUT_URL: 'sessions/self',
+};
 //# sourceMappingURL=ApiConstants.js.map

package/dist/NodeSocket.d.ts

@@ -1,4 +1,4 @@
-import SocketBase from './SocketBase';
-export * from './types';
-export * from './PublicHelpers';
-export { SocketBase as Socket };
+import SocketBase from './SocketBase.js';
+export * from './types/index.js';
+export * from './PublicHelpers.js';
+export { SocketBase as Socket };

package/dist/NodeSocket.js

@@ -1,21 +1,25 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Socket = void 0;
-var SocketBase_1 = __importDefault(require("./SocketBase"));
-exports.Socket = SocketBase_1.default;
-__exportStar(require("./types"), exports);
-__exportStar(require("./PublicHelpers"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Socket = void 0;
+const SocketBase_js_1 = __importDefault(require("./SocketBase.js"));
+exports.Socket = SocketBase_js_1.default;
+__exportStar(require("./types/index.js"), exports);
+__exportStar(require("./PublicHelpers.js"), exports);
 //# sourceMappingURL=NodeSocket.js.map

package/dist/NodeSocket.js.map

@@ -1 +1 @@
-{"version":3,"file":"NodeSocket.js","sourceRoot":"","sources":["../src/NodeSocket.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAAsC;AAMf,iBANhB,oBAAU,CAMY;AAH7B,0CAAwB;AACxB,kDAAgC"}
+{"version":3,"file":"NodeSocket.js","sourceRoot":"","sources":["../src/NodeSocket.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,oEAAyC;AAMlB,iBANhB,uBAAU,CAMY;AAH7B,mDAAiC;AACjC,qDAAmC"}

package/dist/Promise.d.ts

@@ -1,8 +1,8 @@
-export interface PendingResult extends Pick<PromiseConstructor, 'resolve' | 'reject'> {
-    promise: Promise<any>;
-}
-export interface AppPromise extends PromiseConstructor {
-    pending: () => PendingResult;
-}
-declare const PendingPromise: AppPromise;
-export default PendingPromise;
+export interface PendingResult extends Pick<PromiseConstructor, 'resolve' | 'reject'> {
+    promise: Promise<any>;
+}
+export interface AppPromise extends PromiseConstructor {
+    pending: () => PendingResult;
+}
+declare const PendingPromise: AppPromise;
+export default PendingPromise;

package/dist/Promise.js

@@ -1,27 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// Use native promises when available
-var AppPromise;
-if (typeof Promise !== 'undefined') {
-    AppPromise = Promise;
-}
-else {
-    AppPromise = require('promise');
-}
-function pending() {
-    var resolve, reject;
-    var promise = new AppPromise(function () {
-        resolve = arguments[0];
-        reject = arguments[1];
-    });
-    return {
-        resolve: resolve,
-        reject: reject,
-        promise: promise
-    };
-}
-var PendingPromise = Object.assign(AppPromise, {
-    pending: pending
-});
-exports.default = PendingPromise;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Use native promises when available
+let AppPromise;
+if (typeof Promise !== 'undefined') {
+    AppPromise = Promise;
+}
+else {
+    AppPromise = require('promise');
+}
+function pending() {
+    let resolve, reject;
+    let promise = new AppPromise(function () {
+        resolve = arguments[0];
+        reject = arguments[1];
+    });
+    return {
+        resolve: resolve,
+        reject: reject,
+        promise
+    };
+}
+const PendingPromise = Object.assign(AppPromise, {
+    pending
+});
+exports.default = PendingPromise;
 //# sourceMappingURL=Promise.js.map

package/dist/Promise.js.map

@@ -1 +1 @@
-{"version":3,"file":"Promise.js","sourceRoot":"","sources":["../src/Promise.ts"],"names":[],"mappings":";;AAAA,qCAAqC;AACrC,IAAI,UAA8B,CAAC;AACnC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE;IAClC,UAAU,GAAG,OAAO,CAAC;CACtB;KAAM;IACL,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACjC;AAOD,SAAS,OAAO;IACd,IAAI,OAAkC,EAAE,MAAgC,CAAC;IACzE,IAAI,OAAO,GAAG,IAAI,UAAU,CAAC;QAC3B,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,OAAQ;QACjB,MAAM,EAAE,MAAO;QACf,OAAO,SAAA;KACR,CAAC;AACJ,CAAC;AAMD,IAAM,cAAc,GAAe,MAAM,CAAC,MAAM,CAC9C,UAAU,EACV;IACE,OAAO,SAAA;CACR,CACF,CAAC;AAEF,kBAAe,cAAc,CAAC"}
+{"version":3,"file":"Promise.js","sourceRoot":"","sources":["../src/Promise.ts"],"names":[],"mappings":";;AAAA,qCAAqC;AACrC,IAAI,UAA8B,CAAC;AACnC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE;IAClC,UAAU,GAAG,OAAO,CAAC;CACtB;KAAM;IACL,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACjC;AAOD,SAAS,OAAO;IACd,IAAI,OAAkC,EAAE,MAAgC,CAAC;IACzE,IAAI,OAAO,GAAG,IAAI,UAAU,CAAC;QAC3B,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,OAAQ;QACjB,MAAM,EAAE,MAAO;QACf,OAAO;KACR,CAAC;AACJ,CAAC;AAMD,MAAM,cAAc,GAAe,MAAM,CAAC,MAAM,CAC9C,UAAU,EACV;IACE,OAAO;CACR,CACF,CAAC;AAEF,kBAAe,cAAc,CAAC"}

package/dist/PublicHelpers.d.ts

@@ -1,2 +1,2 @@
-import { HookSubscriberInfo, APISocket, ContextMenuItem, EntityId } from './types';
-export declare const addContextMenuItems: <IdT, EntityIdT extends EntityId | undefined = undefined>(socket: APISocket, menuItems: ContextMenuItem<IdT, EntityIdT>[], menuId: string, subscriberInfo: HookSubscriberInfo) => Promise<() => void>;
+import { APISocket, ContextMenuItem, EntityId, ContextMenu } from './types/index.js';
+export declare const addContextMenuItems: <IdT, EntityIdT extends EntityId | undefined = undefined>(socket: APISocket, menuItems: ContextMenuItem<IdT, EntityIdT>[], menuTypeId: string, menu: ContextMenu) => Promise<() => void>;

package/dist/PublicHelpers.js

@@ -1,193 +1,95 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addContextMenuItems = void 0;
-var checkAccess = function (menuItem, permissions) {
-    if (!menuItem.access) {
-        return true;
-    }
-    return permissions.indexOf('admin') !== -1 || permissions.indexOf(menuItem.access) !== -1;
-};
-var URLS_SUPPORT = 'urls';
-var FORM_SUPPORT = 'form';
-var hasSupport = function (support, supports) {
-    return !!supports && supports.indexOf(support) !== -1;
-};
-// Check whether the item passes the access and filter checks
-var validateItem = function (menuItem, data) { return __awaiter(void 0, void 0, void 0, function () {
-    var selected_ids, entity_id, permissions, supports, _a;
-    return __generator(this, function (_b) {
-        switch (_b.label) {
-            case 0:
-                selected_ids = data.selected_ids, entity_id = data.entity_id, permissions = data.permissions, supports = data.supports;
-                if (!!menuItem.urls && !hasSupport(URLS_SUPPORT, supports)) {
-                    return [2 /*return*/, false];
-                }
-                _a = !!menuItem.filter;
-                if (!_a) return [3 /*break*/, 2];
-                return [4 /*yield*/, menuItem.filter(selected_ids, entity_id, permissions, supports)];
-            case 1:
-                _a = !(_b.sent());
-                _b.label = 2;
-            case 2:
-                if (_a) {
-                    return [2 /*return*/, false];
-                }
-                return [2 /*return*/, checkAccess(menuItem, data.permissions)];
-        }
-    });
-}); };
-var parseCallbackData = function (item, data) { return __awaiter(void 0, void 0, void 0, function () {
-    var selected_ids, entity_id, permissions, supports, urls, formDefinitions;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                selected_ids = data.selected_ids, entity_id = data.entity_id, permissions = data.permissions, supports = data.supports;
-                if (!(!!item.urls && !!item.urls.length)) return [3 /*break*/, 4];
-                urls = void 0;
-                if (!(typeof item.urls === 'function')) return [3 /*break*/, 2];
-                return [4 /*yield*/, item.urls(selected_ids, entity_id, permissions, supports)];
-            case 1:
-                urls = _a.sent();
-                return [3 /*break*/, 3];
-            case 2:
-                urls = item.urls;
-                _a.label = 3;
-            case 3: return [2 /*return*/, {
-                    urls: urls,
-                }];
-            case 4:
-                if (!(!!item.formDefinitions && hasSupport(FORM_SUPPORT, supports))) return [3 /*break*/, 8];
-                formDefinitions = void 0;
-                if (!(typeof item.formDefinitions === 'function')) return [3 /*break*/, 6];
-                return [4 /*yield*/, item.formDefinitions(selected_ids, entity_id, permissions, supports)];
-            case 5:
-                formDefinitions = _a.sent();
-                return [3 /*break*/, 7];
-            case 6:
-                formDefinitions = item.formDefinitions;
-                _a.label = 7;
-            case 7: return [2 /*return*/, {
-                    form_definitions: formDefinitions,
-                }];
-            case 8: return [2 /*return*/, {}];
-        }
-    });
-}); };
-var addContextMenuItems = function (socket, menuItems, menuId, subscriberInfo) { return __awaiter(void 0, void 0, void 0, function () {
-    var removeListener, removeHook;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, socket.addListener('menus', menuId + "_menuitem_selected", function (data) { return __awaiter(void 0, void 0, void 0, function () {
-                    var menuItem, isValid, selected_ids, entity_id, permissions, supports, form_values;
-                    return __generator(this, function (_a) {
-                        switch (_a.label) {
-                            case 0:
-                                if (!(data.hook_id === subscriberInfo.id)) return [3 /*break*/, 2];
-                                menuItem = menuItems.find(function (i) { return data.menuitem_id === i.id; });
-                                if (!!!menuItem) return [3 /*break*/, 2];
-                                return [4 /*yield*/, validateItem(menuItem, data)];
-                            case 1:
-                                isValid = _a.sent();
-                                if (isValid && !!menuItem.onClick) {
-                                    selected_ids = data.selected_ids, entity_id = data.entity_id, permissions = data.permissions, supports = data.supports, form_values = data.form_values;
-                                    menuItem.onClick(selected_ids, entity_id, permissions, supports, form_values);
-                                }
-                                _a.label = 2;
-                            case 2: return [2 /*return*/];
-                        }
-                    });
-                }); })];
-            case 1:
-                removeListener = _a.sent();
-                return [4 /*yield*/, socket.addHook('menus', menuId + "_list_menuitems", function (data, accept, reject) { return __awaiter(void 0, void 0, void 0, function () {
-                        var validItems, _i, menuItems_1, item, isValid, parsedCallbackData, onClick, id, title, icon;
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0:
-                                    validItems = [];
-                                    _i = 0, menuItems_1 = menuItems;
-                                    _a.label = 1;
-                                case 1:
-                                    if (!(_i < menuItems_1.length)) return [3 /*break*/, 5];
-                                    item = menuItems_1[_i];
-                                    return [4 /*yield*/, validateItem(item, data)];
-                                case 2:
-                                    isValid = _a.sent();
-                                    if (!isValid) return [3 /*break*/, 4];
-                                    return [4 /*yield*/, parseCallbackData(item, data)];
-                                case 3:
-                                    parsedCallbackData = _a.sent();
-                                    onClick = item.onClick, id = item.id, title = item.title, icon = item.icon;
-                                    if (!!onClick || (!!parsedCallbackData.urls && parsedCallbackData.urls.length)) {
-                                        validItems.push(__assign({ id: id, title: title, icon: icon }, parsedCallbackData));
-                                    }
-                                    _a.label = 4;
-                                case 4:
-                                    _i++;
-                                    return [3 /*break*/, 1];
-                                case 5:
-                                    accept({
-                                        menuitems: validItems
-                                    });
-                                    return [2 /*return*/];
-                            }
-                        });
-                    }); }, subscriberInfo)];
-            case 2:
-                removeHook = _a.sent();
-                return [2 /*return*/, function () {
-                        removeHook();
-                        removeListener();
-                    }];
-        }
-    });
-}); };
-exports.addContextMenuItems = addContextMenuItems;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addContextMenuItems = void 0;
+const checkAccess = (menuItem, permissions) => {
+    if (!menuItem.access) {
+        return true;
+    }
+    return permissions.indexOf('admin') !== -1 || permissions.indexOf(menuItem.access) !== -1;
+};
+const URLS_SUPPORT = 'urls';
+const FORM_SUPPORT = 'form';
+const hasSupport = (support, supports) => {
+    return !!supports && supports.indexOf(support) !== -1;
+};
+// Check whether the item passes the access and filter checks
+const validateItem = async (menuItem, data) => {
+    const { selected_ids, entity_id, permissions, supports } = data;
+    if (!!menuItem.urls && !hasSupport(URLS_SUPPORT, supports)) {
+        return false;
+    }
+    if (!!menuItem.filter && !(await menuItem.filter(selected_ids, entity_id, permissions, supports))) {
+        return false;
+    }
+    return checkAccess(menuItem, data.permissions);
+};
+const parseCallbackData = async (item, data) => {
+    const { selected_ids, entity_id, permissions, supports } = data;
+    if (!!item.urls && !!item.urls.length) {
+        let urls;
+        if (typeof item.urls === 'function') {
+            urls = await item.urls(selected_ids, entity_id, permissions, supports);
+        }
+        else {
+            urls = item.urls;
+        }
+        return {
+            urls,
+        };
+    }
+    else if (!!item.formDefinitions && hasSupport(FORM_SUPPORT, supports)) {
+        let formDefinitions;
+        if (typeof item.formDefinitions === 'function') {
+            formDefinitions = await item.formDefinitions(selected_ids, entity_id, permissions, supports);
+        }
+        else {
+            formDefinitions = item.formDefinitions;
+        }
+        return {
+            form_definitions: formDefinitions,
+        };
+    }
+    return {};
+};
+const addContextMenuItems = async (socket, menuItems, menuTypeId, menu) => {
+    const removeListener = await socket.addListener('menus', `${menuTypeId}_menuitem_selected`, async (data) => {
+        if (data.hook_id === menu.id) {
+            const menuItem = menuItems.find(i => data.menuitem_id === i.id);
+            if (!!menuItem) {
+                const isValid = await validateItem(menuItem, data);
+                if (isValid && !!menuItem.onClick) {
+                    const { selected_ids, entity_id, permissions, supports, form_values } = data;
+                    menuItem.onClick(selected_ids, entity_id, permissions, supports, form_values);
+                }
+            }
+        }
+    });
+    const removeHook = await socket.addHook('menus', `${menuTypeId}_list_menuitems`, async (data, accept, reject) => {
+        const validItems = [];
+        for (const item of menuItems) {
+            const isValid = await validateItem(item, data);
+            if (isValid) {
+                const parsedCallbackData = await parseCallbackData(item, data);
+                const { onClick, id, title, icon } = item;
+                if (!!onClick || (!!parsedCallbackData.urls && parsedCallbackData.urls.length)) {
+                    validItems.push({
+                        id,
+                        title,
+                        icon,
+                        ...parsedCallbackData,
+                    });
+                }
+            }
+        }
+        accept({
+            menuitems: validItems,
+            icon: menu.icon,
+        });
+    }, menu);
+    return () => {
+        removeHook();
+        removeListener();
+    };
+};
+exports.addContextMenuItems = addContextMenuItems;
 //# sourceMappingURL=PublicHelpers.js.map

package/dist/PublicHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicHelpers.js","sourceRoot":"","sources":["../src/PublicHelpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,IAAM,WAAW,GAAG,UAAiB,QAAyC,EAAE,WAAqB;IACnG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;QACpB,OAAO,IAAI,CAAC;KACb;IAED,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5F,CAAC,CAAC;AAEF,IAAM,YAAY,GAAG,MAAM,CAAC;AAC5B,IAAM,YAAY,GAAG,MAAM,CAAC;AAE5B,IAAM,UAAU,GAAG,UAAC,OAAe,EAAE,QAAkB;IACrD,OAAO,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,6DAA6D;AAC7D,IAAM,YAAY,GAAG,UACnB,QAAyC,EACzC,IAA0C;;;;;gBAElC,YAAY,GAAuC,IAAI,aAA3C,EAAE,SAAS,GAA4B,IAAI,UAAhC,EAAE,WAAW,GAAe,IAAI,YAAnB,EAAE,QAAQ,GAAK,IAAI,SAAT,CAAU;gBAChE,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE;oBAC1D,sBAAO,KAAK,EAAC;iBACd;gBAEG,KAAA,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAA;yBAAjB,wBAAiB;gBAAM,qBAAM,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAA;;gBAAvE,KAAA,CAAC,CAAC,SAAqE,CAAC,CAAA;;;gBAAjG,QAAmG;oBACjG,sBAAO,KAAK,EAAC;iBACd;gBAED,sBAAO,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,EAAC;;;KAChD,CAAC;AAEF,IAAM,iBAAiB,GAAG,UACxB,IAAqC,EACrC,IAA0C;;;;;gBAElC,YAAY,GAAuC,IAAI,aAA3C,EAAE,SAAS,GAA4B,IAAI,UAAhC,EAAE,WAAW,GAAe,IAAI,YAAnB,EAAE,QAAQ,GAAK,IAAI,SAAT,CAAU;qBAC5D,CAAA,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA,EAAjC,wBAAiC;gBAC/B,IAAI,SAAsB,CAAC;qBAC3B,CAAA,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAA,EAA/B,wBAA+B;gBAC1B,qBAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAA;;gBAAtE,IAAI,GAAG,SAA+D,CAAC;;;gBAEvE,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;;oBAGnB,sBAAO;oBACL,IAAI,MAAA;iBACL,EAAC;;qBACO,CAAA,CAAC,CAAC,IAAI,CAAC,eAAe,IAAI,UAAU,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA,EAA5D,wBAA4D;gBACjE,eAAe,SAAsB,CAAC;qBACtC,CAAA,OAAO,IAAI,CAAC,eAAe,KAAK,UAAU,CAAA,EAA1C,wBAA0C;gBAC1B,qBAAM,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAA;;gBAA5F,eAAe,GAAG,SAA0E,CAAC;;;gBAE7F,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;;oBAGzC,sBAAO;oBACL,gBAAgB,EAAE,eAAe;iBAClC,EAAC;oBAGJ,sBAAO,EAAE,EAAC;;;KACX,CAAC;AAEK,IAAM,mBAAmB,GAAG,UACjC,MAAiB,EACjB,SAA4C,EAC5C,MAAc,EACd,cAAkC;;;;oBAEX,qBAAM,MAAM,CAAC,WAAW,CAC7C,OAAO,EACJ,MAAM,uBAAoB,EAC7B,UAAO,IAAI;;;;;qCACL,CAAA,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC,EAAE,CAAA,EAAlC,wBAAkC;gCAC9B,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC,EAAE,EAAzB,CAAyB,CAAC,CAAC;qCAC5D,CAAC,CAAC,QAAQ,EAAV,wBAAU;gCACI,qBAAM,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAA;;gCAA5C,OAAO,GAAG,SAAkC;gCAClD,IAAI,OAAO,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE;oCACzB,YAAY,GAAoD,IAAI,aAAxD,EAAE,SAAS,GAAyC,IAAI,UAA7C,EAAE,WAAW,GAA4B,IAAI,YAAhC,EAAE,QAAQ,GAAkB,IAAI,SAAtB,EAAE,WAAW,GAAK,IAAI,YAAT,CAAU;oCAC7E,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;iCAC/E;;;;;qBAGN,CACF,EAAA;;gBAfK,cAAc,GAAG,SAetB;gBAEkB,qBAAM,MAAM,CAAC,OAAO,CAIrC,OAAO,EACJ,MAAM,oBAAiB,EAC1B,UAAO,IAAI,EAAE,MAAM,EAAE,MAAM;;;;;oCACnB,UAAU,GAAG,EAAE,CAAC;0CACM,EAAT,uBAAS;;;yCAAT,CAAA,uBAAS,CAAA;oCAAjB,IAAI;oCACG,qBAAM,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,EAAA;;oCAAxC,OAAO,GAAG,SAA8B;yCAC1C,OAAO,EAAP,wBAAO;oCACkB,qBAAM,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAA;;oCAAxD,kBAAkB,GAAG,SAAmC;oCAEtD,OAAO,GAAsB,IAAI,QAA1B,EAAE,EAAE,GAAkB,IAAI,GAAtB,EAAE,KAAK,GAAW,IAAI,MAAf,EAAE,IAAI,GAAK,IAAI,KAAT,CAAU;oCAC1C,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;wCAC9E,UAAU,CAAC,IAAI,YACb,EAAE,IAAA,EACF,KAAK,OAAA,EACL,IAAI,MAAA,IACD,kBAAkB,EACrB,CAAC;qCACJ;;;oCAbc,IAAS,CAAA;;;oCAiB5B,MAAM,CAAC;wCACL,SAAS,EAAE,UAAU;qCACtB,CAAC,CAAC;;;;yBACJ,EACD,cAAc,CACf,EAAA;;gBA9BK,UAAU,GAAG,SA8BlB;gBAED,sBAAO;wBACL,UAAU,EAAE,CAAC;wBACb,cAAc,EAAE,CAAC;oBACnB,CAAC,EAAC;;;KACH,CAAC;AA3DW,QAAA,mBAAmB,uBA2D9B"}
+{"version":3,"file":"PublicHelpers.js","sourceRoot":"","sources":["../src/PublicHelpers.ts"],"names":[],"mappings":";;;AAOA,MAAM,WAAW,GAAG,CAAiB,QAAyC,EAAE,WAAqB,EAAW,EAAE;IAChH,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;QACpB,OAAO,IAAI,CAAC;KACb;IAED,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5F,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,MAAM,CAAC;AAC5B,MAAM,YAAY,GAAG,MAAM,CAAC;AAE5B,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,QAAkB,EAAE,EAAE;IACzD,OAAO,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,6DAA6D;AAC7D,MAAM,YAAY,GAAG,KAAK,EACxB,QAAyC,EACzC,IAA0C,EACxB,EAAE;IACpB,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAChE,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE;QAC1D,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE;QACjG,OAAO,KAAK,CAAC;KACd;IAED,OAAO,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,KAAK,EAC7B,IAAqC,EACrC,IAA0C,EACD,EAAE;IAC3C,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAChE,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;QACrC,IAAI,IAA0B,CAAC;QAC/B,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;YACnC,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;SACxE;aAAM;YACL,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SAClB;QAED,OAAO;YACL,IAAI;SACL,CAAC;KACH;SAAM,IAAI,CAAC,CAAC,IAAI,CAAC,eAAe,IAAI,UAAU,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE;QACvE,IAAI,eAAqC,CAAC;QAC1C,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,UAAU,EAAE;YAC9C,eAAe,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;SAC9F;aAAM;YACL,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;SACxC;QAED,OAAO;YACL,gBAAgB,EAAE,eAAe;SAClC,CAAC;KACH;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEK,MAAM,mBAAmB,GAAG,KAAK,EACtC,MAAiB,EACjB,SAA4C,EAC5C,UAAkB,EAClB,IAAiB,EACjB,EAAE;IACF,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,WAAW,CAC7C,OAAO,EACP,GAAG,UAAU,oBAAoB,EACjC,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,EAAE,EAAE;YAC5B,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,CAAC,QAAQ,EAAE;gBACd,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACnD,IAAI,OAAO,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE;oBACjC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;oBAC7E,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;iBAC/E;aACF;SACF;IACH,CAAC,CACF,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAIrC,OAAO,EACP,GAAG,UAAU,iBAAiB,EAC9B,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QAC7B,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE;YAC5B,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC/C,IAAI,OAAO,EAAE;gBACX,MAAM,kBAAkB,GAAG,MAAM,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAE/D,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;gBAC1C,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBAC9E,UAAU,CAAC,IAAI,CAAC;wBACd,EAAE;wBACF,KAAK;wBACL,IAAI;wBACJ,GAAG,kBAAkB;qBACtB,CAAC,CAAC;iBACJ;aACF;SACF;QAED,MAAM,CAAC;YACL,SAAS,EAAE,UAAU;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;IACL,CAAC,EACD,IAAI,CACL,CAAC;IAEF,OAAO,GAAG,EAAE;QACV,UAAU,EAAE,CAAC;QACb,cAAc,EAAE,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC,CAAC;AA5DW,QAAA,mBAAmB,uBA4D9B"}

package/dist/SocketBase.d.ts

@@ -1,4 +1,4 @@
-import * as Options from './types/options';
-import * as Socket from './types/socket';
-declare const ApiSocket: (userOptions: Options.APISocketOptions, WebSocketImpl: WebSocket) => Socket.APISocket;
-export default ApiSocket;
+import * as Options from './types/options.js';
+import * as Socket from './types/socket.js';
+declare const ApiSocket: (userOptions: Options.APISocketOptions, WebSocketImpl: WebSocket) => Socket.APISocket;
+export default ApiSocket;