airdcpp-apisocket 3.0.0-beta.1 → 3.0.0-beta.10

package/dist-es/tests/mocks/mock-socket.js

@@ -0,0 +1,31 @@
+import { Socket } from '../../NodeSocket.js';
+import { WebSocket } from 'mock-socket';
+import ApiConstants from '../../ApiConstants.js';
+import { DEFAULT_AUTH_RESPONSE, DEFAULT_CONNECT_PARAMS } from './mock-data.js';
+const getDefaultSocketOptions = () => ({
+    ...DEFAULT_CONNECT_PARAMS,
+    logOutput: console,
+    logLevel: 'warn',
+});
+export const getSocket = (socketOptions = {}) => {
+    const socket = Socket({
+        ...getDefaultSocketOptions(),
+        ...socketOptions,
+    }, WebSocket);
+    return { socket };
+};
+const getDefaultConnectOptions = () => ({
+    console,
+    authResponse: DEFAULT_AUTH_RESPONSE,
+});
+export const getConnectedSocket = async (server, userOptions) => {
+    const options = {
+        ...getDefaultConnectOptions(),
+        ...userOptions,
+    };
+    server.addRequestHandler('POST', ApiConstants.LOGIN_URL, options.authResponse, options.authCallback);
+    const { socket } = getSocket(options.socketOptions);
+    await socket.connect();
+    return { socket };
+};
+//# sourceMappingURL=mock-socket.js.map

package/dist-es/tests/mocks/mock-socket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-socket.js","sourceRoot":"","sources":["../../../src/tests/mocks/mock-socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAGjD,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAE/E,MAAM,uBAAuB,GAAG,GAA6B,EAAE,CAAC,CAAC;IAC/D,GAAG,sBAAsB;IACzB,SAAS,EAAE,OAAO;IAClB,QAAQ,EAAE,MAAM;CACjB,CAAC,CAAC;AAsBH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,gBAA0C,EAAE,EAAE,EAAE;IACxE,MAAM,MAAM,GAAG,MAAM,CACnB;QACE,GAAG,uBAAuB,EAAE;QAC5B,GAAG,aAAa;KACjB,EACD,SAAgB,CACjB,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,GAAG,EAAE,CAAC,CAAC;IACtC,OAAO;IACP,YAAY,EAAE,qBAAqB;CACpC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EACrC,MAAwC,EACxC,WAAiD,EACjD,EAAE;IACF,MAAM,OAAO,GAA+B;QAC1C,GAAG,wBAAwB,EAAE;QAC7B,GAAG,WAAW;KACf,CAAC;IAEF,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAErG,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACpD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,CAAC"}

package/dist-es/tests/test-utils.d.ts

@@ -0,0 +1,8 @@
+export declare const waitForExpect: (func: () => void | Promise<void>) => Promise<{}>;
+export declare const defusedPromise: (promise: Promise<any>) => Promise<any>;
+export declare const getMockConsole: (verbose?: boolean) => {
+    log: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+    info: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+    warn: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+    error: jest.Mock<void, [a1: any, a2: any, a3: any, a4: any], any>;
+};

package/dist-es/tests/test-utils.js

@@ -0,0 +1,28 @@
+import waitForExpectOriginal from 'wait-for-expect';
+const EXCEPT_TIMEOUT = 1000;
+//@ts-ignore
+export const waitForExpect = (func) => waitForExpectOriginal.default(func, EXCEPT_TIMEOUT);
+// This is a helper function that will suppress the error of a promise.
+export const defusedPromise = (promise) => {
+    promise.catch(() => { });
+    return promise;
+};
+export const getMockConsole = (verbose = false) => ({
+    log: jest.fn((a1, a2, a3, a4) => {
+        if (verbose) {
+            console.log(a1, a2, a3, a4);
+        }
+    }),
+    info: jest.fn((a1, a2, a3, a4) => {
+        if (verbose) {
+            console.info(a1, a2, a3, a4);
+        }
+    }),
+    warn: jest.fn((a1, a2, a3, a4) => {
+        console.warn(a1, a2, a3, a4);
+    }),
+    error: jest.fn((a1, a2, a3, a4) => {
+        console.error(a1, a2, a3, a4);
+    }),
+});
+//# sourceMappingURL=test-utils.js.map

package/dist-es/tests/test-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.js","sourceRoot":"","sources":["../../src/tests/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,iBAAiB,CAAC;AAEpD,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,YAAY;AACZ,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAgC,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;AAGvH,uEAAuE;AACvE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAqB,EAAE,EAAE;IACtD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACxB,OAAO,OAAO,CAAC;AACjB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC;IAClD,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QAClD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC;IACF,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACnD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC;IACF,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACnD,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAO,EAAE,EAAE;QACpD,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC;CACH,CAAC,CAAC"}

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

@@ -1,17 +1,26 @@
 import { HookSubscriberInfo } from './subscriptions.js';
-type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (selectedIds: IdT[], entityId: EntityIdT | null, permissions: string[], supports: string[]) => ReturnT | Promise<ReturnT>;
+export interface MenuCallbackProperties<IdT, EntityIdT> {
+    selectedIds: IdT[];
+    entityId: EntityIdT;
+    permissions: string[];
+    supports: string[];
+}
+export interface MenuClickHandlerProperties<IdT, EntityIdT, FormValueT extends object = object> extends MenuCallbackProperties<IdT, EntityIdT> {
+    formValues: FormValueT;
+}
+type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (props: MenuCallbackProperties<IdT, EntityIdT>) => ReturnT | Promise<ReturnT>;
 export type ContextMenuIcon = {
     [key in string]: string;
 };
 export interface ContextMenu extends HookSubscriberInfo {
     icon?: ContextMenuIcon;
 }
-export interface ContextMenuItem<IdT, EntityIdT> {
+export interface ContextMenuItem<IdT, EntityIdT, FormValueT extends object = object> {
     id: string;
     title: string;
     icon?: ContextMenuIcon;
     urls?: string[] | AsyncCallbackProperty<IdT, EntityIdT, string[] | undefined>;
-    onClick?: (selectedIds: IdT[], entityId: EntityIdT | null, permissions: string[], supports: string[], formValues: object) => void;
+    onClick?: (props: MenuClickHandlerProperties<IdT, EntityIdT, FormValueT>) => void;
     filter?: AsyncCallbackProperty<IdT, EntityIdT, boolean>;
     access?: string;
     formDefinitions?: object[] | AsyncCallbackProperty<IdT, EntityIdT, object[]>;

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

@@ -4,20 +4,20 @@ export interface SelectedMenuItemListenerData<IdT, EntityIdT> {
     menu_id: string;
     menuitem_id: string;
     selected_ids: IdT[];
-    entity_id: EntityIdT | null;
+    entity_id: EntityIdT;
     permissions: string[];
     supports: string[];
     form_values: object;
 }
 export interface MenuItemListHookData<IdT, EntityIdT> {
     selected_ids: IdT[];
-    entity_id: EntityIdT | null;
+    entity_id: EntityIdT;
     permissions: string[];
     supports: string[];
 }
 export interface ResponseMenuItemCallbackFields {
-    urls?: string[] | undefined;
-    form_definitions?: object[] | undefined;
+    urls?: string[];
+    form_definitions?: object[];
 }
 export type ResponseMenuItem<IdT, EntityIdT> = Omit<ContextMenuItem<IdT, EntityIdT>, 'onClick' | 'filter' | 'urls' | 'form_definitions'> & ResponseMenuItemCallbackFields;
 export interface MenuItemListHookAcceptData<IdT, EntityIdT> {

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

@@ -20,4 +20,5 @@ export interface APISocket extends SocketRequestMethods, SocketSubscriptions {
     onSessionReset: SessionResetCallback | null;
     onDisconnected: DisconnectedCallback | null;
     readonly nativeSocket: WebSocket | null;
+    readonly url: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airdcpp-apisocket",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.10",
   "description": "Javascript connector for AirDC++ Web API",
   "license": "MIT",
   "authors": [
@@ -41,14 +41,14 @@
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
     "@types/invariant": "^2.2.35",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.9",
-    "jest": "^29.7.0",
-    "jest-cli": "^29.7.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.1.0",
+    "jest": "^30.0.5",
+    "jest-cli": "^30.0.5",
     "jest-environment-node-debug": "^2.0.0",
     "mock-socket": "^9.1.5",
     "pre-commit": "^1.2.2",
-    "rimraf": "^4.1.2",
+    "rimraf": "^6.0.1",
     "ts-jest": "^29.1.5",
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",
@@ -57,6 +57,9 @@
     "websocket": "^1.0.34"
   },
   "main": "./dist/NodeSocket.js",
-  "exports": "./dist-es/NodeSocket.js",
+  "exports": {
+    ".": "./dist-es/NodeSocket.js",
+    "./tests": "./dist-es/tests/mocks/index.js"
+  },
   "type": "module"
 }

package/src/PublicHelpers.ts

@@ -30,7 +30,12 @@ const validateItem = async <IdT, EntityIdT>(
     return false;
   }
 
-  if (!!menuItem.filter && !(await menuItem.filter(selected_ids, entity_id, permissions, supports))) {
+  if (!!menuItem.filter && !(await menuItem.filter({
+    selectedIds: selected_ids, 
+    entityId: entity_id, 
+    permissions, 
+    supports
+  }))) {
     return false;
   }
 
@@ -42,10 +47,17 @@ const parseCallbackData = async <IdT, EntityIdT extends EntityId | undefined = u
   data: MenuItemListHookData<IdT, EntityIdT>
 ): Promise<ResponseMenuItemCallbackFields> => {
   const { selected_ids, entity_id, permissions, supports } = data;
+  const callbackProps = {
+    selectedIds: selected_ids, 
+    entityId: entity_id, 
+    permissions, 
+    supports
+  }
+
   if (!!item.urls && !!item.urls.length) {
     let urls: string[] | undefined;
     if (typeof item.urls === 'function') {
-      urls = await item.urls(selected_ids, entity_id, permissions, supports);
+      urls = await item.urls(callbackProps);
     } else {
       urls = item.urls;
     }
@@ -56,7 +68,7 @@ const parseCallbackData = async <IdT, EntityIdT extends EntityId | undefined = u
   } else if (!!item.formDefinitions && hasSupport(FORM_SUPPORT, supports)) {
     let formDefinitions: object[] | undefined;
     if (typeof item.formDefinitions === 'function') {
-      formDefinitions = await item.formDefinitions(selected_ids, entity_id, permissions, supports);
+      formDefinitions = await item.formDefinitions(callbackProps);
     } else {
       formDefinitions = item.formDefinitions;
     }
@@ -85,7 +97,13 @@ export const addContextMenuItems = async <IdT, EntityIdT extends EntityId | unde
           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);
+            menuItem.onClick({
+              selectedIds: selected_ids, 
+              entityId: entity_id, 
+              permissions, 
+              supports, 
+              formValues: form_values
+            });
           }
         }
       }

package/src/SocketBase.ts

@@ -125,11 +125,11 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
   // Connect handler for creation of new session
   const handlePasswordLogin = (username = options.username, password = options.password) => {
     if (!username) {
-      throw '"username" option was not supplied for authentication';
+      throw new Error('"username" option was not supplied for authentication');
     }
 
     if (!password) {
-      throw '"password" option was not supplied for authentication';
+      throw new Error('"password" option was not supplied for authentication');
     }
 
     const data: API.CredentialsAuthenticationData = {
@@ -146,7 +146,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
 
   const handleRefreshTokenLogin = (refreshToken: string) => {
     if (!refreshToken) {
-      throw '"refreshToken" option was not supplied for authentication';
+      throw new Error('"refreshToken" option was not supplied for authentication');
     }
 
     const data: API.RefreshTokenAuthenticationData = {
@@ -268,7 +268,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     };
 
     ws!.onerror = (event) => {
-      logger.error('Connecting socket failed');
+      logger.error('Connecting socket failed (network/system error, most likely the server is unreachable)');
       scheduleReconnect();
     };
   };
@@ -281,7 +281,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     forceNoAutoConnect = false;
     return new Promise(
       (resolve, reject) => {
-        logger.info('Starting socket connect');
+        logger.info(`Starting socket connect to ${userOptions.url}`);
         connectInternal(resolve, reject, authenticationHandler, reconnectOnFailure);
       }
     );
@@ -317,7 +317,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
         if (isActive()) {
           if (attempts >= maxAttempts) {
             logger.error(`Socket disconnect timed out after ${timeoutMs} ms`);
-            reject('Socket disconnect timed out');
+            reject(new Error('Socket disconnect timed out'));
           } else {
             setTimeout(wait, checkInterval);
             attempts++;
@@ -343,7 +343,6 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
         }
       } else {
         logger.warn('Attempting to disconnect a closed socket (ignore)');
-        //throw 'Attempting to disconnect a closed socket';
       }
 
       return;
@@ -363,7 +362,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     // Username and password are not required if those are available in socket options
     connect: (username?: string, password?: string, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Connect may only be used for a closed socket';
+        throw new Error('Connect may only be used for a closed socket');
       }
 
       resetSession();
@@ -373,7 +372,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
 
     connectRefreshToken: (refreshToken: string, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Connect may only be used for a closed socket';
+        throw new Error('Connect may only be used for a closed socket');
       }
 
       resetSession();
@@ -384,7 +383,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     // Connect and attempt to associate the socket with an existing session
     reconnect: (token: API.AuthTokenType | undefined = undefined, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Reconnect may only be used for a closed socket';
+        throw new Error('Reconnect may only be used for a closed socket');
       }
 
       if (token) {
@@ -392,7 +391,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
       }
 
       if (!authToken) {
-        throw 'No session token available for reconnecting';
+        throw new Error('No session token available for reconnecting');
       }
 
       logger.info('Reconnecting socket');
@@ -459,11 +458,15 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
       return ws;
     },
 
+    get url() {
+      return userOptions.url;
+    },
+
     ...subscriptions.socket,
     ...requests.socket,
   };
 
-  return socket!;
+  return socket;
 };
 
 export default ApiSocket;

package/src/SocketRequestHandler.ts

@@ -59,12 +59,12 @@ const SocketRequestHandler = (
     // Pre-checks
     if (!authenticating && !socket().isConnected()) {
       logger.warn(`Attempting to send request on a non-authenticated socket: ${path}`);
-      return Promise.reject('Not authorized');
+      return Promise.reject(new Error('Not authorized'));
     }
 
     if (!socket().nativeSocket) {
       logger.warn(`Attempting to send request without a socket: ${path}`);
-      return Promise.reject('No socket');
+      return Promise.reject(new Error('No socket'));
     }
 
     const callbackId = getCallbackId();
@@ -143,12 +143,10 @@ const SocketRequestHandler = (
     },
   
     delete: (path) => {
-      //invariant(!data, 'No data is allowed for delete command');
       return sendRequest('DELETE', path);
     },
   
     get: (path) => {
-      //invariant(!data, 'No data is allowed for get command');
       return sendRequest('GET', path);
     },
   
@@ -188,7 +186,7 @@ const SocketRequestHandler = (
       if (messageObj.code >= 200 && messageObj.code <= 204) {
         const { data } = messageObj as APIInternal.RequestSuccessResponse;
         if (!callbacks[id].ignored) {
-          logger.verbose(chalk.green(id.toString()), 'SUCCEEDED', data ? data : '(no data)');
+          logger.verbose(chalk.green(id.toString()), 'SUCCEEDED', data ?? '(no data)');
         }
 
         callbacks[id].resolver.resolve(data);