ogi-addon 0.1.1 → 0.1.2

package/build/main.d.ts

@@ -1,14 +1,102 @@
 import ws from 'ws';
 import events from 'node:events';
-import { ConfigurationBuilder, ConfigurationFile } from './config/ConfigurationBuilder';
-import { Configuration } from './config/Configuration';
-import EventResponse from './EventResponse';
-import { SearchResult } from './SearchEngine';
-export type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup';
-export type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification';
-export type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup';
-export { ConfigurationBuilder, Configuration, EventResponse, SearchResult };
-export interface ClientSentEventTypes {
+
+interface ConfigurationFile {
+    [key: string]: ConfigurationOption;
+}
+declare class ConfigurationBuilder {
+    private options;
+    addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder;
+    addStringOption(option: (option: StringOption) => StringOption): this;
+    addBooleanOption(option: (option: BooleanOption) => BooleanOption): this;
+    build(includeFunctions: boolean): ConfigurationFile;
+}
+type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';
+declare class ConfigurationOption {
+    name: string;
+    defaultValue: unknown;
+    displayName: string;
+    description: string;
+    type: ConfigurationOptionType;
+    setName(name: string): this;
+    setDisplayName(displayName: string): this;
+    setDescription(description: string): this;
+    validate(input: unknown): [boolean, string];
+}
+declare class StringOption extends ConfigurationOption {
+    allowedValues: string[];
+    minTextLength: number;
+    maxTextLength: number;
+    defaultValue: string;
+    type: ConfigurationOptionType;
+    setAllowedValues(allowedValues: string[]): this;
+    setDefaultValue(defaultValue: string): this;
+    setMinTextLength(minTextLength: number): this;
+    setMaxTextLength(maxTextLength: number): this;
+    validate(input: unknown): [boolean, string];
+}
+declare class NumberOption extends ConfigurationOption {
+    min: number;
+    max: number;
+    defaultValue: number;
+    type: ConfigurationOptionType;
+    inputType: 'range' | 'number';
+    setMin(min: number): this;
+    setInputType(type: 'range' | 'number'): this;
+    setMax(max: number): this;
+    setDefaultValue(defaultValue: number): this;
+    validate(input: unknown): [boolean, string];
+}
+declare class BooleanOption extends ConfigurationOption {
+    type: ConfigurationOptionType;
+    defaultValue: boolean;
+    setDefaultValue(defaultValue: boolean): this;
+    validate(input: unknown): [boolean, string];
+}
+
+interface DefiniteConfig {
+    [key: string]: string | number | boolean;
+}
+declare class Configuration {
+    readonly storedConfigTemplate: ConfigurationFile;
+    definiteConfig: DefiniteConfig;
+    constructor(configTemplate: ConfigurationFile);
+    updateConfig(config: DefiniteConfig, validate?: boolean): [boolean, {
+        [key: string]: string;
+    }];
+    private validateConfig;
+    getStringValue(optionName: string): string;
+    getNumberValue(optionName: string): number;
+    getBooleanValue(optionName: string): boolean;
+}
+
+declare class EventResponse<T> {
+    data: T | undefined;
+    deffered: boolean;
+    resolved: boolean;
+    progress: number;
+    logs: string[];
+    defer(): void;
+    resolve(data: T): void;
+    complete(): void;
+    log(message: string): void;
+}
+
+interface SearchResult {
+    name: string;
+    description: string;
+    coverURL: string;
+    downloadURL: string;
+    downloadType: 'torrent' | 'direct' | 'real-debrid-magnet' | 'real-debrid-torrent';
+    downloadSize: number;
+    filename?: string;
+}
+
+type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup';
+type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification';
+type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup';
+
+interface ClientSentEventTypes {
     response: any;
     authenticate: any;
     configure: ConfigurationFile;
@@ -18,7 +106,7 @@ export interface ClientSentEventTypes {
     };
     notification: Notification;
 }
-export interface EventListenerTypes {
+interface EventListenerTypes {
     connect: (socket: ws) => void;
     disconnect: (reason: string) => void;
     configure: (config: ConfigurationBuilder) => ConfigurationBuilder;
@@ -27,17 +115,17 @@ export interface EventListenerTypes {
     search: (query: string, event: EventResponse<SearchResult[]>) => void;
     setup: (path: string, event: EventResponse<undefined | null>) => void;
 }
-export interface WebsocketMessageClient {
+interface WebsocketMessageClient {
     event: OGIAddonClientSentEvent;
     id?: string;
     args: any;
 }
-export interface WebsocketMessageServer {
+interface WebsocketMessageServer {
     event: OGIAddonServerSentEvent;
     id?: string;
     args: any;
 }
-export interface OGIAddonConfiguration {
+interface OGIAddonConfiguration {
     name: string;
     id: string;
     description: string;
@@ -45,7 +133,7 @@ export interface OGIAddonConfiguration {
     author: string;
     repository: string;
 }
-export default class OGIAddon {
+declare class OGIAddon {
     eventEmitter: events<[never]>;
     addonWSListener: OGIAddonWSListener;
     addonInfo: OGIAddonConfiguration;
@@ -71,3 +159,5 @@ declare class OGIAddonWSListener {
     send(event: OGIAddonClientSentEvent, args: Parameters<ClientSentEventTypes[OGIAddonClientSentEvent]>): void;
     close(): void;
 }
+
+export { type ClientSentEventTypes, Configuration, ConfigurationBuilder, type EventListenerTypes, EventResponse, type OGIAddonClientSentEvent, type OGIAddonConfiguration, type OGIAddonEvent, type OGIAddonServerSentEvent, type SearchResult, type WebsocketMessageClient, type WebsocketMessageServer, OGIAddon as default };