airdcpp-apisocket 2.4.4 → 2.5.0-beta.1

package/src/tests/Socket.test.ts

@@ -1,22 +1,26 @@
 import { 
   AUTH_RESPONSE, CONNECT_PARAMS, 
-  getConnectedSocket, getMockServer, getSocket
-} from './helpers';
+  getConnectedSocket, getMockServer, getSocket, waitForExpect
+} from './helpers.js';
 
-import ApiConstants from '../ApiConstants';
+import ApiConstants from '../ApiConstants.js';
 
-import { HookCallback, HookSubscriberInfo } from '../types/subscriptions';
-import { IncomingSubscriptionEvent } from '../types/api_internal';
-
-import * as MockDate from 'mockdate';
-import waitForExpectOriginal from 'wait-for-expect';
+import { HookCallback, HookSubscriberInfo, SubscriptionRemoveHandler } from '../types/subscriptions.js';
+import { IncomingSubscriptionEvent } from '../types/api_internal.js';
 
+import { jest } from '@jest/globals';
 
 let server: ReturnType<typeof getMockServer>;
 
-const EXCEPT_TIMEOUT = 1000;
-const waitForExpect = (func: () => void | Promise<void>) => waitForExpectOriginal(func, EXCEPT_TIMEOUT);
+const dummyfn = () => {
+  // ..
+};
 
+const useFakeTimers = () => {
+  // Mocking performance would cause an error with Node 19, can be removed when using
+  // the latest version of Jest
+  jest.useFakeTimers({doNotFake: ['performance']});
+};
 
 // tslint:disable:no-empty
 describe('socket', () => {
@@ -27,7 +31,6 @@ describe('socket', () => {
   afterEach(() => {
     server.stop();
     jest.useRealTimers();
-    MockDate.reset();
   });
 
   describe('auth', () => {
@@ -129,10 +132,10 @@ describe('socket', () => {
 
       // Dummy listener
       server.addDataHandler('POST', 'hubs/listeners/hub_updated', undefined);
-      await socket.addListener('hubs', 'hub_updated', _ => {});
+      await socket.addListener('hubs', 'hub_updated', dummyfn);
 
       // Dummy pending request
-      socket.delete('dummyLogoutDelete').catch(error => {
+      socket.delete('dummyLogoutDelete').catch((error: Error) => {
         // TODO: fix, too unreliable at the moment (depends on the timings)
         //expect(error.message).toEqual('Socket disconnected');
       });
@@ -190,7 +193,7 @@ describe('socket', () => {
     test('should handle auto reconnect', async () => {
       const { socket, mockConsole } = await getConnectedSocket(server);
 
-      jest.useFakeTimers();
+      useFakeTimers();
 
       socket.disconnect(true);
       jest.runOnlyPendingTimers();
@@ -231,7 +234,7 @@ describe('socket', () => {
     test('should cancel auto reconnect', async () => {
       const { socket, mockConsole } = await getConnectedSocket(server);
 
-      jest.useFakeTimers();
+      useFakeTimers();
 
       // Disconnect with auto reconnect
       socket.disconnect(true);
@@ -278,7 +281,7 @@ describe('socket', () => {
       // Connect and disconnect
       const { socket, mockConsole } = await getConnectedSocket(server);
 
-      jest.useFakeTimers();
+      useFakeTimers();
       socket.disconnect();
       jest.runOnlyPendingTimers();
       expect(socket.isActive()).toEqual(false);
@@ -294,7 +297,7 @@ describe('socket', () => {
       socket.reconnect();
 
       {
-        const waitForExpectTask = waitForExpectOriginal(
+        const waitForExpectTask = waitForExpect(
           () => {
             jest.runOnlyPendingTimers();
             expect(authCallback.mock.calls.length).toBe(1);
@@ -331,15 +334,15 @@ describe('socket', () => {
     test('should report request timeouts', async () => {
       const { socket, mockConsole } = await getConnectedSocket(server);
 
-      jest.useFakeTimers();
-      socket.addListener('hubs', 'hub_updated', _ => {})
+      useFakeTimers();
+      socket.addListener('hubs', 'hub_updated', dummyfn)
         .catch(() => {});
-      socket.addListener('hubs', 'hub_added', _ => {})
+      socket.addListener('hubs', 'hub_added', dummyfn)
         .catch(() => {});
 
       jest.advanceTimersByTime(35000);
 
-      MockDate.set(Date.now() + 35000);
+      jest.setSystemTime(new Date(Date.now() + 35000));
       (socket as any).reportRequestTimeouts();
 
       expect(mockConsole.warn.mock.calls.length).toBe(2);
@@ -422,8 +425,8 @@ describe('socket', () => {
       server.addDataHandler('POST', 'hubs/listeners/hub_updated', undefined, subscribeCallback);
 
       // Add two simultaneous pending add events
-      const p1 = socket.addListener('hubs', 'hub_updated', _ => {});
-      const p2 = socket.addListener('hubs', 'hub_updated', _ => {});
+      const p1 = socket.addListener('hubs', 'hub_updated', dummyfn);
+      const p2 = socket.addListener('hubs', 'hub_updated', dummyfn);
 
       expect(socket.hasListeners()).toBe(false);
       expect(socket.getPendingSubscriptionCount()).toBe(1);
@@ -486,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
       {
@@ -500,7 +503,7 @@ describe('socket', () => {
           hookSubscriberInfo
         );
 
-        expect(hookAddCallback.mock.calls[0][0].data).toEqual(hookSubscriberInfo);
+        expect((hookAddCallback.mock.calls[0][0] as any).data).toEqual(hookSubscriberInfo);
         expect(hookAddCallback.mock.calls.length).toBe(1);
       }
 
@@ -532,7 +535,7 @@ describe('socket', () => {
       });
 
       socket.disconnect(true);
-      await socket.delete('dummyLogDeleteWarning').catch(error => {
+      await socket.delete('dummyLogDeleteWarning').catch((error: Error) => {
         //...
       });
 

package/src/tests/helpers.ts

@@ -1,11 +1,17 @@
-import { Socket } from '../NodeSocket';
-import { WebSocket, Server } from 'mock-socket';
+import { Socket } from '../NodeSocket.js';
+import { Client, Server, WebSocket } from 'mock-socket';
+import { jest } from '@jest/globals';
 
-import { OutgoingRequest, RequestSuccessResponse, RequestErrorResponse } from '../types/api_internal';
-import * as Options from '../types/options';
-import ApiConstants from '../ApiConstants';
+import { OutgoingRequest, RequestSuccessResponse, RequestErrorResponse } from '../types/api_internal.js';
+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;
 
@@ -101,7 +107,7 @@ const toEmitId = (path: string, method: string) => {
 
 const getMockServer = () => {
   const mockServer = new Server(CONNECT_PARAMS.url);
-  let socket: WebSocket;
+  let socket: Client;
   const emitter = new EventEmitter();
 
   const addServerHandler = <DataT extends object | undefined>(
@@ -130,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,14 +1,15 @@
 import { 
   getMockServer,
   getConnectedSocket,
-} from './helpers';
+  waitForExpect,
+} from './helpers.js';
 
-import waitForExpect from 'wait-for-expect';
+import { jest } from '@jest/globals';
 
-import { addContextMenuItems } from '../PublicHelpers';
-import { SelectedMenuItemListenerData, MenuItemListHookData, MenuItemListHookAcceptData } from '../types/public_helpers_internal';
-import { HookSubscriberInfo } from '../types';
-import { IncomingSubscriptionEvent } from '../types/api_internal';
+import { addContextMenuItems } from '../PublicHelpers.js';
+import { SelectedMenuItemListenerData, MenuItemListHookData, MenuItemListHookAcceptData } from '../types/public_helpers_internal.js';
+import { HookSubscriberInfo } from '../types/index.js';
+import { IncomingSubscriptionEvent } from '../types/api_internal.js';
 
 
 let server: ReturnType<typeof getMockServer>;

package/src/types/api_internal.ts

@@ -5,7 +5,7 @@ export type CompletionIdType = number;
 
 // REQUESTS
 
-import { ErrorBase, FieldError, EntityId } from './api';
+import { ErrorBase, FieldError, EntityId } from './api.js';
 
 export interface RequestResponseBase {
   code: number;

package/src/types/index.ts

@@ -1,10 +1,10 @@
-export * from './api';
+export * from './api.js';
 
-export * from './logger';
-export * from './requests';
-export * from './subscriptions';
+export * from './logger.js';
+export * from './requests.js';
+export * from './subscriptions.js';
 
-export * from './socket';
-export * from './options';
+export * from './socket.js';
+export * from './options.js';
 
-export * from './public_helpers';
+export * from './public_helpers.js';

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';
+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/src/types/requests.ts

@@ -1,4 +1,4 @@
-import * as API from './api';
+import * as API from './api.js';
 
 
 export interface SocketRequestMethods {

package/src/types/socket.ts

@@ -1,23 +1,7 @@
-// REQUESTS
-
-
-
-
-// SUBSCRIPTIONS
-
-
-
-
-// LOGGER
-
-
-
-// GENERIC
-
-import { AuthTokenType, LogoutResponse, AuthenticationResponse } from './api';
-import { Logger } from './logger';
-import { SocketRequestMethods } from './requests';
-import { SocketSubscriptions } from './subscriptions';
+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;

package/src/types/subscriptions.ts

@@ -1,4 +1,4 @@
-import * as API from './api';
+import * as API from './api.js';
 
 
 // SUBSCRIPTIONS

package/src/utils.ts

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

package/tsconfig.json

@@ -2,17 +2,16 @@
   "compilerOptions": {
     "outDir": "build/dist",
     "module": "esnext",
-    "target": "es5",
-    "lib": ["es6", "dom", "esnext.asynciterable", "es2018"],
+    "target": "ES2018",
+    "lib": ["dom", "esnext.asynciterable", "ES2018"],
     "sourceMap": true,
-    "moduleResolution": "node",
+    "moduleResolution": "nodenext",
     "rootDir": "src",
     "forceConsistentCasingInFileNames": true,
     "noImplicitReturns": true,
     "noImplicitThis": true,
     "noImplicitAny": true,
     "strictNullChecks": true,
-    "suppressImplicitAnyIndexErrors": true,
     "noUnusedLocals": true,
     "baseUrl": ".",
     "experimentalDecorators": true,
@@ -20,11 +19,7 @@
     "esModuleInterop": true
   },
   "exclude": [
-    "coverage",
-    "devtools",
-    "dist",
-    "node_modules",
-    "scripts",
-    "jest",
+    "src/tests",
+    "jest.config.js",
   ]
 }

package/dist/tests/Socket.test.d.ts

@@ -1 +0,0 @@
-export {};