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

package/dist/types/options.d.ts

@@ -1,31 +1,31 @@
-export type PrintHandler = (...optionalParams: any[]) => void;
-export interface LogOutput {
-    log: PrintHandler;
-    info: PrintHandler;
-    warn: PrintHandler;
-    error: PrintHandler;
-}
-export type IgnoreMatcher = string[] | RegExp;
-export interface SocketRequestOptions {
-    ignoredRequestPaths?: IgnoreMatcher;
-    requestTimeout?: number;
-}
-export interface SocketSubscriptionOptions {
-    ignoredListenerEvents?: IgnoreMatcher;
-}
-export interface RequiredSocketOptions {
-    url: string;
-    username?: string;
-    password?: string;
-}
-export interface AdvancedSocketOptions {
-    autoReconnect: boolean;
-    reconnectInterval: number;
-    userSession: boolean;
-}
-export interface LoggerOptions {
-    logLevel?: string;
-    logOutput?: LogOutput;
-}
-type UserOptions = RequiredSocketOptions & Partial<AdvancedSocketOptions> & LoggerOptions & SocketSubscriptionOptions & SocketRequestOptions;
-export { UserOptions as APISocketOptions };
+export type PrintHandler = (...optionalParams: any[]) => void;
+export interface LogOutput {
+    log: PrintHandler;
+    info: PrintHandler;
+    warn: PrintHandler;
+    error: PrintHandler;
+}
+export type IgnoreMatcher = string[] | RegExp;
+export interface SocketRequestOptions {
+    ignoredRequestPaths?: IgnoreMatcher;
+    requestTimeout?: number;
+}
+export interface SocketSubscriptionOptions {
+    ignoredListenerEvents?: IgnoreMatcher;
+}
+export interface RequiredSocketOptions {
+    url: string;
+    username?: string;
+    password?: string;
+}
+export interface AdvancedSocketOptions {
+    autoReconnect: boolean;
+    reconnectInterval: number;
+    userSession: boolean;
+}
+export interface LoggerOptions {
+    logLevel?: string;
+    logOutput?: LogOutput;
+}
+type UserOptions = RequiredSocketOptions & Partial<AdvancedSocketOptions> & LoggerOptions & SocketSubscriptionOptions & SocketRequestOptions;
+export { UserOptions as APISocketOptions };

package/dist/types/options.js

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

package/dist/types/public_helpers.d.ts

@@ -1,14 +1,19 @@
-type AsyncCallbackProperty<IdT, EntityIdT, ReturnT> = (selectedIds: IdT[], entityId: EntityIdT | null, permissions: string[], supports: string[]) => ReturnT | Promise<ReturnT>;
-export interface ContextMenuItem<IdT, EntityIdT> {
-    id: string;
-    title: string;
-    icon?: {
-        [key in string]: string;
-    };
-    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 {};
+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 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=public_helpers.js.map

package/dist/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/types/public_helpers_internal.js

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

package/dist/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/types/requests.js

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

package/dist/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/types/socket.js

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

package/dist/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/types/subscriptions.js

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

package/dist/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/utils.js

@@ -1,16 +1,16 @@
-"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;
+"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-es/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-es/ApiConstants.js

@@ -1,6 +1,6 @@
-export default {
-    LOGIN_URL: 'sessions/authorize',
-    CONNECT_URL: 'sessions/socket',
-    LOGOUT_URL: 'sessions/self',
-};
+export default {
+    LOGIN_URL: 'sessions/authorize',
+    CONNECT_URL: 'sessions/socket',
+    LOGOUT_URL: 'sessions/self',
+};
 //# sourceMappingURL=ApiConstants.js.map

package/dist-es/NodeSocket.d.ts

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

package/dist-es/NodeSocket.js

@@ -1,5 +1,5 @@
-import SocketBase from './SocketBase.js';
-export * from './types/index.js';
-export * from './PublicHelpers.js';
-export { SocketBase as Socket };
+import SocketBase from './SocketBase.js';
+export * from './types/index.js';
+export * from './PublicHelpers.js';
+export { SocketBase as Socket };
 //# sourceMappingURL=NodeSocket.js.map

package/dist-es/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-es/Promise.js

@@ -1,25 +1,25 @@
-// 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
-});
-export default PendingPromise;
+// 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
+});
+export default PendingPromise;
 //# sourceMappingURL=Promise.js.map

package/dist-es/PublicHelpers.d.ts

@@ -1,2 +1,2 @@
-import { HookSubscriberInfo, APISocket, ContextMenuItem, EntityId } from './types/index.js';
-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>;