ogi-addon 3.0.0 → 4.0.0

package/package.json

@@ -3,7 +3,7 @@
   "module": "./build/main.mjs",
   "type": "module",
   "main": "./build/main.cjs",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "exports": {
     ".": {
       "import": {
@@ -38,21 +38,21 @@
     "directory": "packages/ogi-addon"
   },
   "dependencies": {
+    "@ogi-sdk/connect": "workspace:*",
     "fuse.js": "^7.1.0",
-    "ws": "^8.4.0",
     "zod": "^3.23.8"
   },
   "scripts": {
     "auto-build": "tsc -w",
-    "build": "tsdown --config tsdown.config.js",
+    "build": "tsdown --config tsdown.config.js && bun run --filter '../../packages/addon-server' generate:event-proxy",
     "typecheck": "tsc --noEmit",
     "release": "bun run build && npm publish",
+    "format": "prettier --write \"src/**/*.{ts,svelte,json}\"",
     "release-beta": "bun run build && npm publish --tag future"
   },
   "devDependencies": {
     "@types/minimatch": "^6.0.0",
     "@types/node": "^20.14.12",
-    "@types/ws": "^8.4.0",
     "prettier": "^3.6.0",
     "tsdown": "^0.20.0-beta.4",
     "typescript": "^5.0.0"

package/src/SearchEngine.ts

@@ -1,34 +1 @@
-type BaseRequiredFields = {
-  name: string;
-  manifest?: Record<string, any>;
-  /**
-   * Update-only hint for OGI's setup stage.
-   * When false, OGI keeps existing files in place instead of moving them to `old_files`
-   * before running update setup. Defaults to true/undefined behavior.
-   */
-  clearOldFilesBeforeUpdate?: boolean;
-};
-
-export type SearchResult = BaseRequiredFields &
-  (
-    | {
-        downloadType: 'torrent' | 'magnet';
-        filename: string;
-        downloadURL: string;
-      }
-    | {
-        downloadType: 'direct';
-        files: {
-          name: string;
-          downloadURL: string;
-          headers?: Record<string, string>;
-        }[];
-      }
-    | {
-        downloadType: 'task';
-        taskName: string;
-      }
-    | {
-        downloadType: 'request' | 'empty';
-      }
-  );
+export type { SearchResult } from '@ogi-sdk/connect';

package/src/config/Configuration.ts

@@ -10,10 +10,7 @@ import {
   isStringOption,
   isActionOption,
 } from './ConfigurationBuilder';
-import type {
-  ConfigurationFile,
-  ConfigurationOptionType,
-} from './ConfigurationBuilder';
+import type { ConfigurationFile } from './ConfigurationBuilder';
 
 interface DefiniteConfig {
   [key: string]: string | number | boolean;
@@ -65,9 +62,9 @@ export class Configuration {
         continue;
       }
 
-      const result = this.storedConfigTemplate[key].validate(
-        this.definiteConfig[key]
-      );
+      const result = (
+        this.storedConfigTemplate[key] as unknown as ConfigurationOption<string>
+      ).validate(this.definiteConfig[key]);
       if (!result[0]) {
         erroredKeys.set(key, result[1]);
       }
@@ -145,4 +142,5 @@ export {
   isActionOption,
 };
 
-export type { ConfigurationFile, ConfigurationOptionType };
+export type { ConfigurationFile, ConfigurationOptionWire } from '@ogi-sdk/connect';
+export type { DefiniteConfig };

package/src/config/ConfigurationBuilder.ts

@@ -1,8 +1,23 @@
+import type {
+  ActionConfigurationOption,
+  BooleanConfigurationOption,
+  ConfigurationFile,
+  ConfigurationOptionType,
+  ConfigurationOptionWire,
+  NumberConfigurationOption,
+  StringConfigurationOption,
+} from '@ogi-sdk/connect';
 import z, { ZodError } from 'zod';
 
-export interface ConfigurationFile {
-  [key: string]: ConfigurationOption<string>;
-}
+export type {
+  ActionConfigurationOption,
+  BooleanConfigurationOption,
+  ConfigurationFile,
+  ConfigurationOptionType,
+  ConfigurationOptionWire,
+  NumberConfigurationOption,
+  StringConfigurationOption,
+} from '@ogi-sdk/connect';
 
 const configValidation = z.object({
   name: z.string().min(1),
@@ -10,27 +25,27 @@ const configValidation = z.object({
   description: z.string().min(1),
 });
 
-export function isStringOption<N extends string = string>(
-  option: ConfigurationOption<N>
-): option is StringOption<N> {
+export function isStringOption(
+  option: ConfigurationOptionWire
+): option is StringConfigurationOption {
   return option.type === 'string';
 }
 
-export function isNumberOption<N extends string = string>(
-  option: ConfigurationOption<N>
-): option is NumberOption<N> {
+export function isNumberOption(
+  option: ConfigurationOptionWire
+): option is NumberConfigurationOption {
   return option.type === 'number';
 }
 
-export function isBooleanOption<N extends string = string>(
-  option: ConfigurationOption<N>
-): option is BooleanOption<N> {
+export function isBooleanOption(
+  option: ConfigurationOptionWire
+): option is BooleanConfigurationOption {
   return option.type === 'boolean';
 }
 
-export function isActionOption<N extends string = string>(
-  option: ConfigurationOption<N>
-): option is ActionOption<N> {
+export function isActionOption(
+  option: ConfigurationOptionWire
+): option is ActionConfigurationOption {
   return option.type === 'action';
 }
 
@@ -38,11 +53,11 @@ export function isActionOption<N extends string = string>(
  * A builder for creating configuration screens. The generic type T accumulates
  * the types of all options added to the builder, enabling type-safe access to
  * the configuration values.
- * 
+ *
  * @template T - The accumulated type of all configuration options
  */
 export class ConfigurationBuilder<
-  T extends Record<string, string | number | boolean> = {}
+  T extends Record<string, string | number | boolean> = {},
 > {
   private options: ConfigurationOption<string>[] = [];
 
@@ -89,7 +104,7 @@ export class ConfigurationBuilder<
   }
 
   /**
-   * Add an action option to the configuration builder and return the builder for chaining. 
+   * Add an action option to the configuration builder and return the builder for chaining.
    * Action options contribute a boolean to the return type (true if clicked, false if not).
    * You must provide a name, display name, and description for the option.
    * @param option { (option: ActionOption) => ActionOption<K> }
@@ -115,21 +130,15 @@ export class ConfigurationBuilder<
           throw new ZodError(optionData.error.errors);
         }
 
-        config[option.name] = option;
+        config[option.name] = option as unknown as ConfigurationFile[string];
       } else {
-        config[option.name] = option;
+        config[option.name] = option as unknown as ConfigurationFile[string];
       }
     });
     return config;
   }
 }
 
-export type ConfigurationOptionType =
-  | 'string'
-  | 'number'
-  | 'boolean'
-  | 'action'
-  | 'unset';
 export class ConfigurationOption<N extends string = string> {
   public name: N = '' as N;
   public defaultValue: unknown = '';
@@ -175,7 +184,9 @@ export class ConfigurationOption<N extends string = string> {
   }
 }
 
-export class StringOption<N extends string = string> extends ConfigurationOption<N> {
+export class StringOption<
+  N extends string = string,
+> extends ConfigurationOption<N> {
   public allowedValues: string[] = [];
   public minTextLength: number = 0;
   public maxTextLength: number = Number.MAX_SAFE_INTEGER;
@@ -266,7 +277,9 @@ export class StringOption<N extends string = string> extends ConfigurationOption
   }
 }
 
-export class NumberOption<N extends string = string> extends ConfigurationOption<N> {
+export class NumberOption<
+  N extends string = string,
+> extends ConfigurationOption<N> {
   public min: number = 0;
   public max: number = Number.MAX_SAFE_INTEGER;
   public defaultValue: number = 0;
@@ -332,7 +345,9 @@ export class NumberOption<N extends string = string> extends ConfigurationOption
   }
 }
 
-export class BooleanOption<N extends string = string> extends ConfigurationOption<N> {
+export class BooleanOption<
+  N extends string = string,
+> extends ConfigurationOption<N> {
   public type: ConfigurationOptionType = 'boolean';
   public defaultValue: boolean = false;
 
@@ -362,7 +377,9 @@ export class BooleanOption<N extends string = string> extends ConfigurationOptio
   }
 }
 
-export class ActionOption<N extends string = string> extends ConfigurationOption<N> {
+export class ActionOption<
+  N extends string = string,
+> extends ConfigurationOption<N> {
   public type: ConfigurationOptionType = 'action';
   public manifest: Record<string, unknown> = {};
   public buttonText: string = 'Run';

package/src/extraction.ts

@@ -0,0 +1,87 @@
+import { spawn } from 'child_process';
+
+const s7ZipPath = 'C:\\Program Files\\7-Zip\\7z.exe';
+
+function waitForChildProcess(
+  childProcess: ReturnType<typeof spawn>,
+  errorMessage: string
+): Promise<void> {
+  return new Promise<void>((resolve, reject) => {
+    childProcess.once('error', reject);
+    childProcess.once('close', (code) => {
+      if (code !== 0) {
+        reject(new Error(errorMessage));
+        return;
+      }
+
+      resolve();
+    });
+  });
+}
+
+async function detectUnrarType(): Promise<
+  'unrar-free' | 'unrar-nonfree' | 'unknown'
+> {
+  const childProcess = spawn('unrar');
+
+  return await new Promise((resolve, reject) => {
+    let output = '';
+
+    const collectOutput = (data: Buffer) => {
+      output += data.toString();
+    };
+
+    childProcess.stdout.on('data', collectOutput);
+    childProcess.stderr.on('data', collectOutput);
+    childProcess.once('error', reject);
+    childProcess.once('close', () => {
+      if (output.includes('unrar-free')) {
+        resolve('unrar-free');
+        return;
+      }
+
+      if (output.includes('unrar-nonfree')) {
+        resolve('unrar-nonfree');
+        return;
+      }
+
+      resolve('unknown');
+    });
+  });
+}
+
+export async function extraction(filePath: string, outputDir: string) {
+  const lowerCaseFilePath = filePath.toLowerCase();
+
+  if (process.platform === 'win32') {
+    // expect 7zip to be installed, and use 7zip to unrar
+    const childProcess = spawn(s7ZipPath, ['x', filePath, '-o', outputDir]);
+    return await waitForChildProcess(childProcess, 'Failed to extract file');
+  } else if (process.platform === 'linux' || process.platform === 'darwin') {
+    if (lowerCaseFilePath.endsWith('.zip')) {
+      // expect unzip to be installed, and use unzip to unzip
+      const childProcess = spawn('unzip', ['-o', filePath, '-d', outputDir]);
+      return await waitForChildProcess(childProcess, 'Failed to unzip file');
+    } else if (lowerCaseFilePath.endsWith('.rar')) {
+      // check if unrar-nonfree is installed or unrar is installed
+      const unrarType = await detectUnrarType();
+
+      // now use the according unrar version to unrar
+      if (unrarType === 'unrar-free') {
+        // use unrar-free to unrar
+        const childProcess = spawn('unrar', ['-f', '-x', filePath, outputDir]);
+        return await waitForChildProcess(childProcess, 'Failed to unrar file');
+      } else if (unrarType === 'unrar-nonfree') {
+        // use unrar-nonfree to unrar
+        const childProcess = spawn('unrar', ['-o', filePath, '-d', outputDir]);
+        return await waitForChildProcess(childProcess, 'Failed to unrar file');
+      } else {
+        throw new Error('Unknown unrar type');
+      }
+    }
+
+    throw new Error(`Unsupported archive type: ${filePath}`);
+  }
+
+  throw new Error(`Unsupported platform: ${process.platform}`);
+}