ogi-addon 1.0.0 → 1.1.5

package/package.json

@@ -1,50 +1,51 @@
-{
-  "name": "ogi-addon",
-  "module": "./build/main.js",
-  "type": "module",
-  "main": "./build/main.cjs",
-  "exports": {
-    ".": {
-      "import": {
-        "default": "./build/main.js",
-        "types": "./build/main.d.ts"
-      },
-      "require": {
-        "default": "./build/main.cjs",
-        "types": "./build/main.d.cts"
-      }
-    },
-    "./config": {
-      "import": {
-        "default": "./build/config/Configuration.js",
-        "types": "./build/config/Configuration.d.ts"
-      },
-      "require": {
-        "default": "./build/config/Configuration.cjs",
-        "types": "./build/config/Configuration.d.cts"
-      }
-    }
-  },
-  "typings": "./build/main.d.ts",
-  "author": {
-    "name": "Nat3z",
-    "email": "me@nat3z.com",
-    "url": "https://nat3z.com/"
-  },
-  "version": "1.0.0",
-  "dependencies": {
-    "ws": "^8.4.0",
-    "zod": "^3.23.8"
-  },
-  "scripts": {
-    "auto-build": "tsc -w",
-    "build": "tsup --config tsup.config.js",
-    "release": "bun run build && npm publish"
-  },
-  "devDependencies": {
-    "@types/node": "^20.14.12",
-    "@types/ws": "^8.4.0",
-    "tsup": "^8.2.3",
-    "typescript": "^5.0.0"
-  }
+{
+  "name": "ogi-addon",
+  "module": "./build/main.js",
+  "type": "module",
+  "main": "./build/main.cjs",
+  "version": "1.1.5",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./build/main.js",
+        "types": "./build/main.d.ts"
+      },
+      "require": {
+        "default": "./build/main.cjs",
+        "types": "./build/main.d.cts"
+      }
+    },
+    "./config": {
+      "import": {
+        "default": "./build/config/Configuration.js",
+        "types": "./build/config/Configuration.d.ts"
+      },
+      "require": {
+        "default": "./build/config/Configuration.cjs",
+        "types": "./build/config/Configuration.d.cts"
+      }
+    }
+  },
+  "typings": "./build/main.d.ts",
+  "author": {
+    "name": "Nat3z",
+    "email": "me@nat3z.com",
+    "url": "https://nat3z.com/"
+  },
+  "dependencies": {
+    "fuse.js": "^7.1.0",
+    "ws": "^8.4.0",
+    "zod": "^3.23.8"
+  },
+  "scripts": {
+    "auto-build": "tsc -w",
+    "build": "tsup --config tsup.config.js",
+    "release": "bun run build && npm publish"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.12",
+    "@types/ws": "^8.4.0",
+    "tsup": "^8.2.3",
+    "typescript": "^5.0.0"
+  }
 }

package/schema.json

@@ -1,31 +1,31 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "AddonFileConfigurationSchema",
-  "type": "object",
-  "properties": {
-    "author": {
-      "type": "string"
-    },
-    "scripts": {
-      "type": "object",
-      "properties": {
-        "setup": {
-          "type": "string"
-        },
-        "run": {
-          "type": "string"
-        },
-        "preSetup": {
-          "type": "string"
-        },
-        "postSetup": {
-          "type": "string"
-        }
-      },
-      "required": ["run"],
-      "additionalProperties": false
-    }
-  },
-  "required": ["author", "scripts"],
-  "additionalProperties": false
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "AddonFileConfigurationSchema",
+  "type": "object",
+  "properties": {
+    "author": {
+      "type": "string"
+    },
+    "scripts": {
+      "type": "object",
+      "properties": {
+        "setup": {
+          "type": "string"
+        },
+        "run": {
+          "type": "string"
+        },
+        "preSetup": {
+          "type": "string"
+        },
+        "postSetup": {
+          "type": "string"
+        }
+      },
+      "required": ["run"],
+      "additionalProperties": false
+    }
+  },
+  "required": ["author", "scripts"],
+  "additionalProperties": false
 }

package/src/EventResponse.ts

@@ -1,41 +1,60 @@
-import { ConfigurationBuilder } from "./main";
-
-export default class EventResponse<T> {
-  data: T | undefined = undefined;
-  deffered: boolean = false;
-  resolved: boolean = false;
-  progress: number = 0;
-  logs: string[] = [];
-  onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>;
-
-  constructor(onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>) {
-    this.onInputAsked = onInputAsked;
-  }
-  
-
-  public defer() {
-    this.deffered = true;
-  }
-
-  public resolve(data: T) {
-    this.resolved = true;
-    this.data = data;
-  }
-
-  public complete() {
-    this.resolved = true;
-  }
-
-  public log(message: string) {
-    this.logs.push(message);
-  }
-
-  public async askForInput(name: string, description: string, screen: ConfigurationBuilder) {
-    if (!this.onInputAsked) {
-      throw new Error('No input asked callback');
-    }
-    return await this.onInputAsked(screen, name, description);
-  }
-
-  
+import { ConfigurationBuilder } from "./main";
+
+export default class EventResponse<T> {
+  data: T | undefined = undefined;
+  deffered: boolean = false;
+  resolved: boolean = false;
+  progress: number = 0;
+  logs: string[] = [];
+  onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>;
+
+  constructor(onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>) {
+    this.onInputAsked = onInputAsked;
+  }
+  
+
+  public defer() {
+    this.deffered = true;
+  }
+
+  /**
+   * Resolve the event with data. This acts like a promise resolve, and will stop the event from being processed further. **You must always call this method when you are done with the event.** 
+   * @param data {T}
+   */
+  public resolve(data: T) {
+    this.resolved = true;
+    this.data = data;
+  }
+
+  /**
+   * Completes the event and resolves it, but does not return any data. **You must always call this method when you are done with the event.** 
+   */
+  public complete() {
+    this.resolved = true;
+  }
+
+  /**
+   * Logs a message to the event. This is useful for debugging and logging information to the user. 
+   * @param message {string}
+   */
+  public log(message: string) {
+    this.logs.push(message);
+  }
+
+  /**
+   * Send a screen to the client to ask for input. Use the `ConfigurationBuilder` system to build the screen. Once sent to the user, the addon cannot change the screen.
+   * @async
+   * @param name {string}
+   * @param description {string}
+   * @param screen {ConfigurationBuilder}
+   * @returns {Promise<{ [key: string]: boolean | string | number }>}
+   */
+  public async askForInput(name: string, description: string, screen: ConfigurationBuilder): Promise<{ [key: string]: boolean | string | number; }> {
+    if (!this.onInputAsked) {
+      throw new Error('No input asked callback');
+    }
+    return await this.onInputAsked(screen, name, description);
+  }
+
+  
 }

package/src/SearchEngine.ts

@@ -1,16 +1,16 @@
-export type SearchResult = {
-  name: string;
-  description: string;
-  coverURL: string;
-  downloadType: 'torrent' | 'direct' | 'magnet';
-  downloadSize: number;
-  appID: number;
-  storefront: 'steam' | 'internal';
-  filename?: string;
-  downloadURL?: string;
-  files?: {
-    name: string;
-    downloadURL: string;
-  }[];
-}
-
+export type SearchResult = {
+  name: string;
+  description: string;
+  coverURL: string;
+  downloadType: 'torrent' | 'direct' | 'magnet' | 'request';
+  downloadSize: number;
+  appID: number;
+  storefront: 'steam' | 'internal';
+  filename?: string;
+  downloadURL?: string;
+  files?: {
+    name: string;
+    downloadURL: string;
+  }[];
+}
+

package/src/config/Configuration.ts

@@ -1,83 +1,83 @@
-import { ConfigurationFile, ConfigurationBuilder, BooleanOption, ConfigurationOption, ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption } from "./ConfigurationBuilder";
-
-interface DefiniteConfig {
-  [key: string]: string | number | boolean;
-}
-export class Configuration {
-  readonly storedConfigTemplate: ConfigurationFile;
-  definiteConfig: DefiniteConfig = {};
-  constructor(configTemplate: ConfigurationFile) {
-    this.storedConfigTemplate = configTemplate;
-  }
-
-  updateConfig(config: DefiniteConfig, validate: boolean = true): [ boolean, { [key: string]: string } ] {
-    this.definiteConfig = config;
-    if (validate) {
-      const result = this.validateConfig();
-      return result;
-    }
-    return [ true, {} ];
-  }
-  // provides falsey or truthy value, and an error message if falsey
-  private validateConfig(): [ boolean, { [key: string]: string } ] {
-    const erroredKeys = new Map<string, string>();
-    for (const key in this.storedConfigTemplate) {
-      if (this.definiteConfig[key] === null || this.definiteConfig[key] === undefined) {
-        console.warn('Option ' + key + ' is not defined. Using default value Value: ' + this.definiteConfig[key]);
-        this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue as string | number | boolean;
-      }
-      if (this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]) {
-        throw new Error('Option ' + key + ' is not of the correct type');
-      }
-
-      const result = this.storedConfigTemplate[key].validate(this.definiteConfig[key]);
-      if (!result[0]) {
-        erroredKeys.set(key, result[1]);
-      }
-    }
-
-    for (const key in this.definiteConfig) {
-      if (!this.storedConfigTemplate[key]) {
-        throw new Error('Option ' + key + ' is not defined in the configuration template');
-      }
-    }
-
-    if (erroredKeys.size > 0) {
-      return [ false, Object.fromEntries(erroredKeys) ];
-    }
-
-    return [ true, Object.fromEntries(erroredKeys) ];
-  }
-
-  getStringValue(optionName: string): string {
-    if (!this.definiteConfig[optionName] === null) {
-      throw new Error('Option ' + optionName + ' is not defined');
-    }
-    if (typeof this.definiteConfig[optionName] !== 'string') {
-      throw new Error('Option ' + optionName + ' is not a string');
-    }
-    return this.definiteConfig[optionName];
-  }
-
-  getNumberValue(optionName: string): number {
-    if (!this.definiteConfig[optionName] === null) {
-      throw new Error('Option ' + optionName + ' is not defined');
-    }
-    if (typeof this.definiteConfig[optionName] !== 'number') {
-      throw new Error('Option ' + optionName + ' is not a number');
-    }
-    return this.definiteConfig[optionName];
-  }
-
-  getBooleanValue(optionName: string): boolean {
-    if (this.definiteConfig[optionName] === null) {
-      throw new Error('Option ' + optionName + ' is not defined');
-    }
-    if (typeof this.definiteConfig[optionName] !== 'boolean') {
-      throw new Error('Option ' + optionName + ' is not a boolean');
-    }
-    return this.definiteConfig[optionName];
-  }
-}
-
+import { ConfigurationFile, ConfigurationBuilder, BooleanOption, ConfigurationOption, ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption } from "./ConfigurationBuilder";
+
+interface DefiniteConfig {
+  [key: string]: string | number | boolean;
+}
+export class Configuration {
+  readonly storedConfigTemplate: ConfigurationFile;
+  definiteConfig: DefiniteConfig = {};
+  constructor(configTemplate: ConfigurationFile) {
+    this.storedConfigTemplate = configTemplate;
+  }
+
+  updateConfig(config: DefiniteConfig, validate: boolean = true): [ boolean, { [key: string]: string } ] {
+    this.definiteConfig = config;
+    if (validate) {
+      const result = this.validateConfig();
+      return result;
+    }
+    return [ true, {} ];
+  }
+  // provides falsey or truthy value, and an error message if falsey
+  private validateConfig(): [ boolean, { [key: string]: string } ] {
+    const erroredKeys = new Map<string, string>();
+    for (const key in this.storedConfigTemplate) {
+      if (this.definiteConfig[key] === null || this.definiteConfig[key] === undefined) {
+        console.warn('Option ' + key + ' is not defined. Using default value Value: ' + this.definiteConfig[key]);
+        this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue as string | number | boolean;
+      }
+      if (this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]) {
+        throw new Error('Option ' + key + ' is not of the correct type');
+      }
+
+      const result = this.storedConfigTemplate[key].validate(this.definiteConfig[key]);
+      if (!result[0]) {
+        erroredKeys.set(key, result[1]);
+      }
+    }
+
+    for (const key in this.definiteConfig) {
+      if (!this.storedConfigTemplate[key]) {
+        throw new Error('Option ' + key + ' is not defined in the configuration template');
+      }
+    }
+
+    if (erroredKeys.size > 0) {
+      return [ false, Object.fromEntries(erroredKeys) ];
+    }
+
+    return [ true, Object.fromEntries(erroredKeys) ];
+  }
+
+  getStringValue(optionName: string): string {
+    if (!this.definiteConfig[optionName] === null) {
+      throw new Error('Option ' + optionName + ' is not defined');
+    }
+    if (typeof this.definiteConfig[optionName] !== 'string') {
+      throw new Error('Option ' + optionName + ' is not a string');
+    }
+    return this.definiteConfig[optionName];
+  }
+
+  getNumberValue(optionName: string): number {
+    if (!this.definiteConfig[optionName] === null) {
+      throw new Error('Option ' + optionName + ' is not defined');
+    }
+    if (typeof this.definiteConfig[optionName] !== 'number') {
+      throw new Error('Option ' + optionName + ' is not a number');
+    }
+    return this.definiteConfig[optionName];
+  }
+
+  getBooleanValue(optionName: string): boolean {
+    if (this.definiteConfig[optionName] === null) {
+      throw new Error('Option ' + optionName + ' is not defined');
+    }
+    if (typeof this.definiteConfig[optionName] !== 'boolean') {
+      throw new Error('Option ' + optionName + ' is not a boolean');
+    }
+    return this.definiteConfig[optionName];
+  }
+}
+
 export { ConfigurationFile, ConfigurationBuilder, BooleanOption, ConfigurationOption, ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption };