feat: add unraid module and fix docgen (#6)

.gitignore

@@ -2,3 +2,4 @@
 node_modules
 .env
 dist
+docs

src/instance/unraid.ts

@@ -1,4 +1,5 @@
 import { SystemModule } from '../modules/system/system-module';
+import { UnraidModule } from '../modules/unraid/unraid-module';
 import { VMModule } from '../modules/vms/vm-module';
 import { Type } from '../util';
 import { Executor, IExecute, IExecuteResult, IExecuteSimple } from './executor';
@@ -15,11 +16,14 @@ export class Unraid<ExecutorConfig, Ex extends Executor<ExecutorConfig>> {
 
   readonly system: SystemModule<ExecutorConfig, Ex>;
 
+  readonly unraid: UnraidModule<ExecutorConfig, Ex>;
+
   constructor(config: UnraidConfig<ExecutorConfig, Ex>) {
     // eslint-disable-next-line new-cap
     this.executor = new config.executor(config.executorConfig);
     this.vm = new VMModule<ExecutorConfig, Ex>(this);
     this.system = new SystemModule<ExecutorConfig, Ex>(this);
+    this.unraid = new UnraidModule<ExecutorConfig, Ex>(this);
   }
 
   async execute(command: IExecuteSimple): Promise<IExecuteResult>;

src/modules/system/extensions/lsblk.ts

@@ -11,7 +11,7 @@ export class SystemModuleLsblkExtension<
 > extends SystemModuleExtensionBase<ExecutorConfig, Ex> {
   /**
    * List all block devices
-   * @param all - toggles --all flag in lsblk
+   * @param all - toggles `--all` flag in `lsblk`
    * @example Get basic information
    * ```ts
    * await lsblk();

src/modules/unraid/extensions/casemodel.ts

@@ -0,0 +1,19 @@
+import { Executor } from '../../../instance/executor';
+import { UnraidModuleExtensionBase } from '../unraid-module-extension-base';
+
+export class UnraidModuleCaseModelExtension<
+  ExecutorConfig,
+  Ex extends Executor<ExecutorConfig>
+> extends UnraidModuleExtensionBase<ExecutorConfig, Ex> {
+  async getCaseModel(): Promise<string> {
+    const { code, stdout } = await this.instance.execute(`cat /boot/config/plugins/dynamix/case-model.cfg`);
+    if (code !== 0) throw new Error('Got non-zero exit code while getting case-model');
+
+    return stdout.join('');
+  }
+
+  async setCaseModel(caseModel: string): Promise<void> {
+    const { code } = await this.instance.execute(`echo ${caseModel} > /boot/config/plugins/dynamix/case-model.cfg`);
+    if (code !== 0) throw new Error('Got non-zero exit code while writing case-model');
+  }
+}

src/modules/unraid/extensions/index.ts

@@ -0,0 +1 @@
+export * from './casemodel';

src/modules/unraid/index.ts

@@ -0,0 +1 @@
+export * as UnraidModule from './unraid-module';

src/modules/unraid/unraid-module-extension-base.ts

@@ -0,0 +1,10 @@
+import { Executor } from '../../instance/executor';
+import { Unraid } from '../../instance/unraid';
+
+export class UnraidModuleExtensionBase<ExecutorConfig, Ex extends Executor<ExecutorConfig>> {
+  readonly instance: Unraid<ExecutorConfig, Ex>;
+
+  constructor(instance: Unraid<ExecutorConfig, Ex>) {
+    this.instance = instance;
+  }
+}

src/modules/unraid/unraid-module.ts

@@ -0,0 +1,19 @@
+import { mix } from 'ts-mixer';
+import { Executor } from '../../instance/executor';
+import { Unraid } from '../../instance/unraid';
+import { UnraidModuleCaseModelExtension } from './extensions';
+
+// required for mixins
+export interface UnraidModule<ExecutorConfig, Ex extends Executor<ExecutorConfig>>
+  extends UnraidModuleCaseModelExtension<ExecutorConfig, Ex> {
+  instance: Unraid<ExecutorConfig, Ex>;
+}
+
+@mix(UnraidModuleCaseModelExtension)
+export class UnraidModule<ExecutorConfig, Ex extends Executor<ExecutorConfig>> {
+  instance: Unraid<ExecutorConfig, Ex>;
+
+  constructor(instance: Unraid<ExecutorConfig, Ex>) {
+    this.instance = instance;
+  }
+}

typedoc.json

@@ -1,8 +1,8 @@
 {
   "name": "Unraid API Client",
-  "entryPoints": ["src/index.ts"],
+  "entryPoints": ["src/modules/"],
+  "entryPointStrategy": "Expand",
   "out": "docs",
-  "theme": "minimal",
-  "includeVersion": true,
-  "toc": ["System", "Virtual Machines"]
+  "theme": "default",
+  "includeVersion": true
 }