airdcpp-apisocket 2.5.0-beta.2 → 3.0.0-beta.10

package/dist/types/public_helpers.d.ts

@@ -1,19 +0,0 @@
-import { HookSubscriberInfo } from './subscriptions.js';
-type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (selectedIds: IdT[], entityId: EntityIdT | null, permissions: string[], 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?: ContextMenuIcon;
-    urls?: string[] | AsyncCallbackProperty<IdT, EntityIdT, string[] | undefined>;
-    onClick?: (selectedIds: IdT[], entityId: EntityIdT | null, permissions: string[], supports: string[], formValues: object) => void;
-    filter?: AsyncCallbackProperty<IdT, EntityIdT, boolean>;
-    access?: string;
-    formDefinitions?: object[] | AsyncCallbackProperty<IdT, EntityIdT, object[]>;
-}
-export {};

package/dist/types/public_helpers.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=public_helpers.js.map

package/dist/types/public_helpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"public_helpers.js","sourceRoot":"","sources":["../../src/types/public_helpers.ts"],"names":[],"mappings":""}

package/dist/types/public_helpers_internal.d.ts

@@ -1,27 +0,0 @@
-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/types/public_helpers_internal.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=public_helpers_internal.js.map

package/dist/types/public_helpers_internal.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"public_helpers_internal.js","sourceRoot":"","sources":["../../src/types/public_helpers_internal.ts"],"names":[],"mappings":""}

package/dist/types/requests.d.ts

@@ -1,14 +0,0 @@
-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/types/requests.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=requests.js.map

package/dist/types/requests.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requests.js","sourceRoot":"","sources":["../../src/types/requests.ts"],"names":[],"mappings":""}

package/dist/types/socket.d.ts

@@ -1,23 +0,0 @@
-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/types/socket.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=socket.js.map

package/dist/types/socket.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"socket.js","sourceRoot":"","sources":["../../src/types/socket.ts"],"names":[],"mappings":""}

package/dist/types/subscriptions.d.ts

@@ -1,20 +0,0 @@
-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/types/subscriptions.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=subscriptions.js.map

package/dist/types/subscriptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/types/subscriptions.ts"],"names":[],"mappings":""}

package/dist/utils.d.ts

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

package/dist/utils.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.eventIgnored = void 0;
-const eventIgnored = (path, ignoredEvents) => {
-    if (!ignoredEvents) {
-        return false;
-    }
-    // Array?
-    if (Array.isArray(ignoredEvents)) {
-        return ignoredEvents.indexOf(path) !== -1;
-    }
-    // Regexp
-    return ignoredEvents.test(path);
-};
-exports.eventIgnored = eventIgnored;
-//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAGO,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,aAAqC,EAAE,EAAE;IAClF,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IAED,SAAS;IACT,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QAChC,OAAO,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;KAC3C;IAED,SAAS;IACT,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC,CAAC;AAZW,QAAA,YAAY,gBAYvB"}

package/src/tests/helpers.ts

@@ -1,195 +0,0 @@
-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.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;
-
-const getMockConsole = () => ({
-  log: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    if (VERBOSE) {
-      console.log(a1, a2, a3, a4);
-    }
-  }),
-  info: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    if (VERBOSE) {
-      console.info(a1, a2, a3, a4);
-    }
-  }),
-  warn: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    console.warn(a1, a2, a3, a4);
-  }),
-  error: jest.fn((a1: any, a2: any, a3: any, a4: any) => {
-    console.error(a1, a2, a3, a4);
-  }),
-});
-
-const CONNECT_PARAMS = {
-  username: 'test',
-  password: 'test',
-  url: 'ws://localhost:7171/api/v1/',
-};
-
-const getDefaultSocketOptions = (mockConsole: Options.LogOutput): Options.APISocketOptions => ({
-  ...CONNECT_PARAMS,
-  logOutput: mockConsole,
-  logLevel: VERBOSE ? 'verbose' : 'warn',
-});
-
-const AUTH_RESPONSE = {
-  auth_token: 'b823187f-4aab-4b71-9764-e63e88401a26',
-  refresh_token: '5124faasf-4aab-4b71-9764-e63e88401a26',
-  user: {
-    permissions: [ 'admin' ],
-    username: 'test',
-    active_sessions: 1,
-    last_login: 0,
-  },
-  system: {
-    cid: 'AHLUODI2YZ2U7FDWMHFNJU65ERGKUN4MH7GW5LY',
-    hostname: 'ubuntu-htpc',
-    network_type: 'private',
-    path_separator: '/',
-    platform: 'other',
-    language: 'fi',
-  },
-  wizard_pending: false,
-};
-
-export type MockSocketOptions = Omit<Options.APISocketOptions, 'username' | 'password' | 'url'> & {
-  username?: string;
-  password?: string;
-  url?: string;
-};
-
-const getSocket = (options: MockSocketOptions = {}) => {
-  const mockConsole = getMockConsole();
-  const socket = Socket(
-    {
-      ...getDefaultSocketOptions(mockConsole),
-      ...options,
-    }, 
-    WebSocket as any
-  );
-  
-  return { socket, mockConsole };
-};
-
-
-type Callback = (requestData: object) => void;
-
-const getConnectedSocket = async (
-  server: ReturnType<typeof getMockServer>, 
-  options?: MockSocketOptions, 
-  authCallback?: Callback
-) => {
-  server.addDataHandler('POST', ApiConstants.LOGIN_URL, AUTH_RESPONSE, authCallback);
-
-  const { socket, mockConsole } = getSocket(options);
-  await socket.connect();
-
-  return { socket, mockConsole };
-};
-
-const toEmitId = (path: string, method: string) => {
-  return `${path}_${method}`;
-};
-
-const getMockServer = () => {
-  const mockServer = new Server(CONNECT_PARAMS.url);
-  let socket: Client;
-  const emitter = new EventEmitter();
-
-  const addServerHandler = <DataT extends object | undefined>(
-    method: string, 
-    path: string, 
-    responseData: Omit<RequestSuccessResponse<DataT>, 'callback_id'> | Omit<RequestErrorResponse, 'callback_id'>, 
-    subscriptionCallback?: Callback
-  ) => {
-    emitter.addListener(
-      toEmitId(path, method), 
-      (request: OutgoingRequest, s: WebSocket) => {
-        if (subscriptionCallback) {
-          subscriptionCallback(request);
-        }
-
-        const response: RequestSuccessResponse | RequestErrorResponse = {
-          callback_id: request.callback_id,
-          ...responseData,
-        };
-
-        s.send(JSON.stringify(response));
-      }
-    );
-  };
-
-  mockServer.on('connection', s => {
-    socket = s;
-
-    socket.on('message', (messageObj) => {
-      const request: OutgoingRequest = JSON.parse(messageObj as string);
-      emitter.emit(toEmitId(request.path, request.method), request, s);
-    });
-  });
-
-  mockServer.on('close', () => {
-    emitter.removeAllListeners();
-  });
-
-  return {
-    addDataHandler: <DataT extends object | undefined>(
-      method: string, 
-      path: string, 
-      data?: DataT, 
-      subscriptionCallback?: Callback
-    ) => {
-      addServerHandler<DataT>(
-        method, 
-        path, {
-          data,
-          code: 200,
-        }, 
-        subscriptionCallback
-      );
-    },
-    addErrorHandler: (
-      method: string, 
-      path: string, 
-      errorStr: string | null, 
-      errorCode: number, 
-      subscriptionCallback?: Callback
-    ) => {
-      addServerHandler(
-        method, 
-        path, 
-        {
-          error: !errorStr ? null as any : {
-            message: errorStr,
-          },
-          code: errorCode,
-        }, 
-        subscriptionCallback
-      );
-    },
-    stop: () => {
-      mockServer.stop(() => {
-        // ...
-      });
-    },
-    send: (data: object) => {
-      socket.send(JSON.stringify(data));
-    },
-  };
-};
-
-export { getMockServer, getSocket, getConnectedSocket, CONNECT_PARAMS, AUTH_RESPONSE };