airdcpp-apisocket 2.4.5-beta.1 → 2.5.0-beta.2

package/dist-es/types/public_helpers_internal.d.ts

@@ -1,25 +1,27 @@
-import { ContextMenuItem } from './public_helpers.js';
-export interface SelectedMenuItemListenerData<IdT, EntityIdT> {
-    hook_id: string;
-    menu_id: string;
-    menuitem_id: string;
-    selected_ids: IdT[];
-    entity_id: EntityIdT | null;
-    permissions: string[];
-    supports: string[];
-    form_values: object;
-}
-export interface MenuItemListHookData<IdT, EntityIdT> {
-    selected_ids: IdT[];
-    entity_id: EntityIdT | null;
-    permissions: string[];
-    supports: string[];
-}
-export interface ResponseMenuItemCallbackFields {
-    urls?: string[] | undefined;
-    form_definitions?: object[] | undefined;
-}
-export type ResponseMenuItem<IdT, EntityIdT> = Omit<ContextMenuItem<IdT, EntityIdT>, 'onClick' | 'filter' | 'urls' | 'form_definitions'> & ResponseMenuItemCallbackFields;
-export interface MenuItemListHookAcceptData<IdT, EntityIdT> {
-    menuitems: ResponseMenuItem<IdT, EntityIdT>[];
-}
+import { ContextMenuIcon, ContextMenuItem } from './public_helpers.js';
+export interface SelectedMenuItemListenerData<IdT, EntityIdT> {
+    hook_id: string;
+    menu_id: string;
+    menuitem_id: string;
+    selected_ids: IdT[];
+    entity_id: EntityIdT | null;
+    permissions: string[];
+    supports: string[];
+    form_values: object;
+}
+export interface MenuItemListHookData<IdT, EntityIdT> {
+    selected_ids: IdT[];
+    entity_id: EntityIdT | null;
+    permissions: string[];
+    supports: string[];
+}
+export interface ResponseMenuItemCallbackFields {
+    urls?: string[] | undefined;
+    form_definitions?: object[] | undefined;
+}
+export type ResponseMenuItem<IdT, EntityIdT> = Omit<ContextMenuItem<IdT, EntityIdT>, 'onClick' | 'filter' | 'urls' | 'form_definitions'> & ResponseMenuItemCallbackFields;
+export interface MenuItemListHookAcceptData<IdT, EntityIdT> {
+    menuitems: ResponseMenuItem<IdT, EntityIdT>[];
+    icon?: ContextMenuIcon;
+    title?: string;
+}

package/dist-es/types/public_helpers_internal.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=public_helpers_internal.js.map

package/dist-es/types/requests.d.ts

@@ -1,14 +1,14 @@
-import * as API from './api.js';
-export interface SocketRequestMethods {
-    put: <ResponseT extends object | void>(path: string, data?: object) => Promise<ResponseT>;
-    patch: <ResponseT extends object | void>(path: string, data?: object) => Promise<ResponseT>;
-    post: <ResponseT extends object | void>(path: string, data?: object) => Promise<ResponseT>;
-    delete: <ResponseT extends object | void>(path: string) => Promise<ResponseT>;
-    get: <ResponseT extends object | void>(path: string) => Promise<ResponseT>;
-    getPendingRequestCount: () => number;
-}
-export interface ErrorResponse {
-    message: string;
-    code: number;
-    json: API.FieldError | API.ErrorBase;
-}
+import * as API from './api.js';
+export interface SocketRequestMethods {
+    put: <ResponseT extends object | void>(path: string, data?: object) => Promise<ResponseT>;
+    patch: <ResponseT extends object | void>(path: string, data?: object) => Promise<ResponseT>;
+    post: <ResponseT extends object | void>(path: string, data?: object) => Promise<ResponseT>;
+    delete: <ResponseT extends object | void>(path: string) => Promise<ResponseT>;
+    get: <ResponseT extends object | void>(path: string) => Promise<ResponseT>;
+    getPendingRequestCount: () => number;
+}
+export interface ErrorResponse {
+    message: string;
+    code: number;
+    json: API.FieldError | API.ErrorBase;
+}

package/dist-es/types/requests.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=requests.js.map

package/dist-es/types/socket.d.ts

@@ -1,23 +1,23 @@
-import { AuthTokenType, LogoutResponse, AuthenticationResponse } from './api.js';
-import { Logger } from './logger.js';
-import { SocketRequestMethods } from './requests.js';
-import { SocketSubscriptions } from './subscriptions.js';
-export type ConnectedCallback = (data: AuthenticationResponse) => void;
-export type SessionResetCallback = () => void;
-export type DisconnectedCallback = (reason: string, code: number, wasClean: boolean) => void;
-export interface APISocket extends SocketRequestMethods, SocketSubscriptions {
-    connect: (username?: string, password?: string, reconnectOnFailure?: boolean) => Promise<AuthenticationResponse>;
-    connectRefreshToken: (refreshToken: string, reconnectOnFailure?: boolean) => Promise<AuthenticationResponse>;
-    disconnect: (autoConnect?: boolean, reason?: string) => void;
-    waitDisconnected: (timeoutMs?: number) => Promise<void>;
-    reconnect: (token?: AuthTokenType, reconnectOnFailure?: boolean) => Promise<AuthenticationResponse>;
-    logout: () => Promise<LogoutResponse>;
-    isConnecting: () => boolean;
-    isConnected: () => boolean;
-    isActive: () => boolean;
-    logger: Logger;
-    onConnected: ConnectedCallback | null;
-    onSessionReset: SessionResetCallback | null;
-    onDisconnected: DisconnectedCallback | null;
-    readonly nativeSocket: WebSocket | null;
-}
+import { AuthTokenType, LogoutResponse, AuthenticationResponse } from './api.js';
+import { Logger } from './logger.js';
+import { SocketRequestMethods } from './requests.js';
+import { SocketSubscriptions } from './subscriptions.js';
+export type ConnectedCallback = (data: AuthenticationResponse) => void;
+export type SessionResetCallback = () => void;
+export type DisconnectedCallback = (reason: string, code: number, wasClean: boolean) => void;
+export interface APISocket extends SocketRequestMethods, SocketSubscriptions {
+    connect: (username?: string, password?: string, reconnectOnFailure?: boolean) => Promise<AuthenticationResponse>;
+    connectRefreshToken: (refreshToken: string, reconnectOnFailure?: boolean) => Promise<AuthenticationResponse>;
+    disconnect: (autoConnect?: boolean, reason?: string) => void;
+    waitDisconnected: (timeoutMs?: number) => Promise<void>;
+    reconnect: (token?: AuthTokenType, reconnectOnFailure?: boolean) => Promise<AuthenticationResponse>;
+    logout: () => Promise<LogoutResponse>;
+    isConnecting: () => boolean;
+    isConnected: () => boolean;
+    isActive: () => boolean;
+    logger: Logger;
+    onConnected: ConnectedCallback | null;
+    onSessionReset: SessionResetCallback | null;
+    onDisconnected: DisconnectedCallback | null;
+    readonly nativeSocket: WebSocket | null;
+}

package/dist-es/types/socket.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=socket.js.map

package/dist-es/types/subscriptions.d.ts

@@ -1,20 +1,20 @@
-import * as API from './api.js';
-export type SubscriptionRemoveHandler = (sendApi?: boolean) => void;
-export type SubscriptionCallback<DataT extends object | void = object, EntityIdT = API.EntityId | undefined> = (data: DataT, entityId: EntityIdT) => void;
-export interface HookSubscriberInfo {
-    id: string;
-    name: string;
-}
-export type HookRejectHandler = (rejectId: string, rejectMessage: string) => void;
-export type HookAcceptHandler<DataT extends object | undefined> = (data: DataT) => void;
-export type HookCallback<DataT extends object = object, CompletionDataT extends object | undefined = object | undefined> = (data: DataT, accept: HookAcceptHandler<CompletionDataT>, reject: HookRejectHandler) => void;
-export interface SocketSubscriptions {
-    addHook: <DataT extends object, CompletionDataT extends object | undefined>(apiModule: string, event: string, callback: HookCallback<DataT, CompletionDataT>, subscriberInfo: HookSubscriberInfo) => Promise<SubscriptionRemoveHandler>;
-    addListener: <DataT extends object | void, EntityIdT extends API.EntityId | undefined = undefined>(apiModule: string, event: string, callback: SubscriptionCallback<DataT, EntityIdT>, entityId?: API.EntityId) => Promise<SubscriptionRemoveHandler>;
-    addViewUpdateListener: <DataT extends object | void, EntityIdT extends API.EntityId | undefined = undefined>(viewName: string, callback: SubscriptionCallback<DataT, EntityIdT>, entityId?: API.EntityId) => () => void;
-    hasListeners: () => boolean;
-    getPendingSubscriptionCount: () => number;
-}
-export type AddHook = SocketSubscriptions['addHook'];
-export type AddListener = SocketSubscriptions['addListener'];
-export type AddViewUpdateListener = SocketSubscriptions['addViewUpdateListener'];
+import * as API from './api.js';
+export type SubscriptionRemoveHandler = (sendApi?: boolean) => void;
+export type SubscriptionCallback<DataT extends object | void = object, EntityIdT = API.EntityId | undefined> = (data: DataT, entityId: EntityIdT) => void;
+export interface HookSubscriberInfo {
+    id: string;
+    name: string;
+}
+export type HookRejectHandler = (rejectId: string, rejectMessage: string) => void;
+export type HookAcceptHandler<DataT extends object | undefined> = (data: DataT) => void;
+export type HookCallback<DataT extends object = object, CompletionDataT extends object | undefined = object | undefined> = (data: DataT, accept: HookAcceptHandler<CompletionDataT>, reject: HookRejectHandler) => void;
+export interface SocketSubscriptions {
+    addHook: <DataT extends object, CompletionDataT extends object | undefined>(apiModule: string, event: string, callback: HookCallback<DataT, CompletionDataT>, subscriberInfo: HookSubscriberInfo) => Promise<SubscriptionRemoveHandler>;
+    addListener: <DataT extends object | void, EntityIdT extends API.EntityId | undefined = undefined>(apiModule: string, event: string, callback: SubscriptionCallback<DataT, EntityIdT>, entityId?: API.EntityId) => Promise<SubscriptionRemoveHandler>;
+    addViewUpdateListener: <DataT extends object | void, EntityIdT extends API.EntityId | undefined = undefined>(viewName: string, callback: SubscriptionCallback<DataT, EntityIdT>, entityId?: API.EntityId) => () => void;
+    hasListeners: () => boolean;
+    getPendingSubscriptionCount: () => number;
+}
+export type AddHook = SocketSubscriptions['addHook'];
+export type AddListener = SocketSubscriptions['addListener'];
+export type AddViewUpdateListener = SocketSubscriptions['addViewUpdateListener'];

package/dist-es/types/subscriptions.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=subscriptions.js.map

package/dist-es/utils.d.ts

@@ -1,2 +1,2 @@
-import * as Options from './types/options.js';
-export declare const eventIgnored: (path: string, ignoredEvents?: Options.IgnoreMatcher) => boolean;
+import * as Options from './types/options.js';
+export declare const eventIgnored: (path: string, ignoredEvents?: Options.IgnoreMatcher) => boolean;

package/dist-es/utils.js

@@ -1,12 +1,12 @@
-export const eventIgnored = (path, ignoredEvents) => {
-    if (!ignoredEvents) {
-        return false;
-    }
-    // Array?
-    if (Array.isArray(ignoredEvents)) {
-        return ignoredEvents.indexOf(path) !== -1;
-    }
-    // Regexp
-    return ignoredEvents.test(path);
-};
+export const eventIgnored = (path, ignoredEvents) => {
+    if (!ignoredEvents) {
+        return false;
+    }
+    // Array?
+    if (Array.isArray(ignoredEvents)) {
+        return ignoredEvents.indexOf(path) !== -1;
+    }
+    // Regexp
+    return ignoredEvents.test(path);
+};
 //# sourceMappingURL=utils.js.map

package/jest.config.js

@@ -13,9 +13,6 @@ const jestConfig = {
   roots: [
     '<rootDir>/src/'
   ],
-  transformIgnorePatterns: [
-    '<rootDir>\/node_modules\/(?!chalk)\/'
-  ],
   moduleNameMapper: {
     '^(\\.{1,2}/.*)\\.js$': '$1',
     '#(.*)': '<rootDir>/node_modules/$1',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airdcpp-apisocket",
-  "version": "2.4.5-beta.1",
+  "version": "2.5.0-beta.2",
   "description": "Javascript connector for AirDC++ Web API",
   "license": "MIT",
   "authors": [
@@ -22,7 +22,7 @@
   "scripts": {
     "build": "npm run build-commonjs && npm run build-es",
     "build-commonjs": "rimraf dist && tsc -d --outDir dist --module CommonJS",
-    "build-es": "rimraf dist-es && tsc -d --outDir dist-es --module es2015",
+    "build-es": "rimraf dist-es && tsc -d --outDir dist-es --module es2020",
     "clean": "rimraf dist/*",
     "lint": "tslint --project tsconfig.json",
     "lint-fix": "tslint --project tsconfig.json --fix",
@@ -33,7 +33,7 @@
     "test"
   ],
   "dependencies": {
-    "chalk": "^5.1.2",
+    "chalk": "^4.1.2",
     "events": "^3.3.0",
     "invariant": "^2.2.4",
     "is-in-browser": "^2.0.0",
@@ -53,11 +53,11 @@
     "ts-jest": "^28.0.8",
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",
-    "typescript": "^4.8.4",
+    "typescript": "^5.0.2",
     "wait-for-expect": "^3.0.2",
     "websocket": "^1.0.34"
   },
   "main": "./dist/NodeSocket.js",
-  "module": "./dist-es/NodeSocket.js",
+  "exports": "./dist-es/NodeSocket.js",
   "type": "module"
 }

package/src/PublicHelpers.ts

@@ -1,4 +1,4 @@
-import { HookSubscriberInfo, APISocket, ContextMenuItem, EntityId } from './types/index.js';
+import { APISocket, ContextMenuItem, EntityId, ContextMenu } from './types/index.js';
 import { 
   SelectedMenuItemListenerData, MenuItemListHookData, 
   MenuItemListHookAcceptData, ResponseMenuItemCallbackFields 
@@ -71,15 +71,15 @@ const parseCallbackData = async <IdT, EntityIdT extends EntityId | undefined = u
 
 export const addContextMenuItems = async <IdT, EntityIdT extends EntityId | undefined = undefined>(
   socket: APISocket,
-  menuItems: ContextMenuItem<IdT, EntityIdT>[], 
-  menuId: string, 
-  subscriberInfo: HookSubscriberInfo
+  menuItems: ContextMenuItem<IdT, EntityIdT>[],
+  menuTypeId: string,
+  menu: ContextMenu
 ) => {
   const removeListener = await socket.addListener<SelectedMenuItemListenerData<IdT, EntityIdT>, EntityIdT>(
     'menus', 
-    `${menuId}_menuitem_selected`, 
+    `${menuTypeId}_menuitem_selected`, 
     async (data) => {
-      if (data.hook_id === subscriberInfo.id) {
+      if (data.hook_id === menu.id) {
         const menuItem = menuItems.find(i => data.menuitem_id === i.id);
         if (!!menuItem) {
           const isValid = await validateItem(menuItem, data);
@@ -97,7 +97,7 @@ export const addContextMenuItems = async <IdT, EntityIdT extends EntityId | unde
     MenuItemListHookAcceptData<IdT, EntityIdT> | undefined
   >(
     'menus', 
-    `${menuId}_list_menuitems`, 
+    `${menuTypeId}_list_menuitems`, 
     async (data, accept, reject) => {
       const validItems = [];
       for (const item of menuItems) {
@@ -118,10 +118,11 @@ export const addContextMenuItems = async <IdT, EntityIdT extends EntityId | unde
       }
 
       accept({
-        menuitems: validItems
+        menuitems: validItems,
+        icon: menu.icon,
       });
     }, 
-    subscriberInfo
+    menu
   );
 
   return () => {

package/src/SocketLogger.ts

@@ -27,7 +27,7 @@ const Severities = {
 const shouldFormatLine = isJsDom || !isBrowser;
 
 const Logger = ({ logLevel: logSetting = LOG_VERBOSE, logOutput = console }: Options.LoggerOptions) => {
-  const logLevel = Severities[logSetting];
+  const logLevel = Severities[logSetting as keyof typeof Severities];
 
   invariant(
     // @ts-ignore: This condition will always return true since the function is always defined

package/src/SocketRequestHandler.ts

@@ -25,7 +25,7 @@ const SocketRequestHandler = (
   { requestTimeout = 30, ignoredRequestPaths }: Options.SocketRequestOptions
 ) => {
 
-  let callbacks: { [key: number]: Callback } = {};
+  let callbacks: Record<string, Callback> = {};
   let currentCallbackId = 0;
   
   let timeoutReportInterval: any;
@@ -85,7 +85,7 @@ const SocketRequestHandler = (
     // Callback
     const resolver = Promise.pending();
 
-    callbacks[callbackId] = {
+    callbacks[callbackId.toString()] = {
       time: Date.now(),
       resolver,
       ignored,

package/src/tests/Socket.test.ts

@@ -1,22 +1,17 @@
 import { 
   AUTH_RESPONSE, CONNECT_PARAMS, 
-  getConnectedSocket, getMockServer, getSocket
+  getConnectedSocket, getMockServer, getSocket, waitForExpect
 } from './helpers.js';
 
 import ApiConstants from '../ApiConstants.js';
 
-import { HookCallback, HookSubscriberInfo } from '../types/subscriptions.js';
+import { HookCallback, HookSubscriberInfo, SubscriptionRemoveHandler } from '../types/subscriptions.js';
 import { IncomingSubscriptionEvent } from '../types/api_internal.js';
 
-import waitForExpectOriginal from 'wait-for-expect';
 import { jest } from '@jest/globals';
 
 let server: ReturnType<typeof getMockServer>;
 
-const EXCEPT_TIMEOUT = 1000;
-const waitForExpect = (func: () => void | Promise<void>) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);
-
-
 const dummyfn = () => {
   // ..
 };
@@ -302,7 +297,7 @@ describe('socket', () => {
       socket.reconnect();
 
       {
-        const waitForExpectTask = waitForExpectOriginal.default(
+        const waitForExpectTask = waitForExpect(
           () => {
             jest.runOnlyPendingTimers();
             expect(authCallback.mock.calls.length).toBe(1);
@@ -494,7 +489,7 @@ describe('socket', () => {
 
     test('should handle hook actions', async () => {
       const { socket, mockConsole } = await getConnectedSocket(server);
-      let removeListener = null;
+      let removeListener: SubscriptionRemoveHandler | null = null;
 
       // Add hook
       {

package/src/tests/helpers.ts

@@ -7,6 +7,11 @@ import * as Options from '../types/options.js';
 import ApiConstants from '../ApiConstants.js';
 import { EventEmitter } from 'events';
 
+import waitForExpectOriginal from 'wait-for-expect';
+
+const EXCEPT_TIMEOUT = 1000;
+//@ts-ignore
+export const waitForExpect = (func: () => void | Promise<void>) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);
 
 const VERBOSE = false;
 
@@ -131,8 +136,8 @@ const getMockServer = () => {
   mockServer.on('connection', s => {
     socket = s;
 
-    socket.on('message', (messageObj: string) => {
-      const request: OutgoingRequest = JSON.parse(messageObj);
+    socket.on('message', (messageObj) => {
+      const request: OutgoingRequest = JSON.parse(messageObj as string);
       emitter.emit(toEmitId(request.path, request.method), request, s);
     });
   });

package/src/tests/public_helpers.test.ts

@@ -1,9 +1,9 @@
 import { 
   getMockServer,
   getConnectedSocket,
+  waitForExpect,
 } from './helpers.js';
 
-import waitForExpect from 'wait-for-expect';
 import { jest } from '@jest/globals';
 
 import { addContextMenuItems } from '../PublicHelpers.js';
@@ -188,7 +188,7 @@ describe('public helpers', () => {
 
       // Validate list items results
       {
-        await waitForExpect.default(() => {
+        await waitForExpect(() => {
           expect(hookResolveCallback).toHaveBeenCalledTimes(1);
         });
 
@@ -198,7 +198,7 @@ describe('public helpers', () => {
           }),
         );
 
-        await waitForExpect.default(() => {
+        await waitForExpect(() => {
           expect(onGetUrlsItem3Mock).toHaveBeenCalledTimes(1);
         });
         expect(onGetUrlsItem3Mock).toHaveBeenCalledWith(selectedMenuIds, null, PERMISSIONS, SUPPORTS);
@@ -226,7 +226,7 @@ describe('public helpers', () => {
 
       // Validate select event results
       {
-        await waitForExpect.default(() => {
+        await waitForExpect(() => {
           expect(onClickItem1Mock).toHaveBeenCalledTimes(1);
         });
         expect(onClickItem1Mock).toHaveBeenCalledWith(selectedMenuIds, null, PERMISSIONS, SUPPORTS, FORM_VALUES);

package/src/types/public_helpers.ts

@@ -1,3 +1,4 @@
+import { HookSubscriberInfo } from './subscriptions.js';
 
 type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (
   selectedIds: IdT[], 
@@ -6,10 +7,15 @@ type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (
   supports: string[]
 ) => ReturnT | Promise<ReturnT>;
 
+export type ContextMenuIcon = { [key in string]: string };
+
+export interface ContextMenu extends HookSubscriberInfo {
+  icon?: ContextMenuIcon;
+}
 export interface ContextMenuItem<IdT, EntityIdT> {
   id: string;
   title: string;
-  icon?: { [key in string]: string };
+  icon?: ContextMenuIcon;
   urls?: string[] | AsyncCallbackProperty<IdT, EntityIdT, string[] | undefined>;
   onClick?: (
     selectedIds: IdT[], 

package/src/types/public_helpers_internal.ts

@@ -1,4 +1,4 @@
-import { ContextMenuItem } from './public_helpers.js';
+import { ContextMenuIcon, ContextMenuItem } from './public_helpers.js';
 
 
 export interface SelectedMenuItemListenerData<IdT, EntityIdT> {
@@ -28,4 +28,6 @@ export type ResponseMenuItem<IdT, EntityIdT> = Omit<ContextMenuItem<IdT, EntityI
 
 export interface MenuItemListHookAcceptData<IdT, EntityIdT> {
   menuitems: ResponseMenuItem<IdT, EntityIdT>[];
+  icon?: ContextMenuIcon;
+  title?: string;
 }

package/tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     "outDir": "build/dist",
     "module": "esnext",
-    "target": "ES2015",
-    "lib": ["es6", "dom", "esnext.asynciterable", "es2018"],
+    "target": "ES2018",
+    "lib": ["dom", "esnext.asynciterable", "ES2018"],
     "sourceMap": true,
     "moduleResolution": "nodenext",
     "rootDir": "src",
@@ -12,7 +12,6 @@
     "noImplicitThis": true,
     "noImplicitAny": true,
     "strictNullChecks": true,
-    "suppressImplicitAnyIndexErrors": true,
     "noUnusedLocals": true,
     "baseUrl": ".",
     "experimentalDecorators": true,