feat: Add log settings, view and download to UI

.vscode/settings.json

@@ -38,5 +38,8 @@
   "typescript.preferences.importModuleSpecifier": "relative",
   "files.associations": {
     "globals.css": "tailwindcss"
+  },
+  "search.exclude": {
+    "**/.yarn": true
   }
 }

package.json

@@ -10,15 +10,17 @@
   "license": "MIT",
   "scripts": {
     "build": "turbo build",
-    "dev": "turbo dev",
+    "dev": "turbo run dev @maintainerr/server#generate-metadata",
     "lint": "turbo lint",
     "format": "turbo format",
     "format:check": "turbo format:check",
-    "knip": "knip"
+    "knip": "knip",
+    "check-types": "turbo check-types"
   },
   "workspaces": [
     "ui",
-    "server"
+    "server",
+    "packages/*"
   ],
   "engines": {
     "node": ">=18"

packages/contracts/.gitignore

@@ -0,0 +1 @@
+dist

packages/contracts/eslint.config.mjs

@@ -0,0 +1,19 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+import eslintConfigPrettier from "eslint-config-prettier";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  { files: ["**/*.{js,mjs,cjs,ts}"] },
+  {
+    languageOptions: { globals: globals.node },
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.strictTypeChecked,
+  eslintConfigPrettier,
+];

packages/contracts/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@maintainerr/contracts",
+  "version": "2.8.0",
+  "private": true,
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "import": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "require": "./dist/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint \"{src,test}/**/*.ts\" --fix",
+    "format": "prettier --write --ignore-path .gitignore .",
+    "format:check": "prettier --check --ignore-path .gitignore .",
+    "check-types": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.19.0",
+    "eslint": "^9.19.0",
+    "eslint-config-prettier": "^10.0.1",
+    "globals": "^15.14.0",
+    "prettier": "^3.4.2",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.22.0"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.10",
+    "@nestjs/core": "^11.0.10",
+    "@nestjs/swagger": "^11.0.3",
+    "nestjs-zod": "^4.3.1",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1",
+    "zod": "^3.24.1"
+  }
+}

packages/contracts/src/index.ts

@@ -0,0 +1 @@
+export * from "./settings/logs";

packages/contracts/src/settings/logs/index.ts

@@ -0,0 +1,2 @@
+export * from "./logSetting";
+export * from "./logSetting.dto";

packages/contracts/src/settings/logs/logSetting.dto.ts

@@ -0,0 +1,4 @@
+import { createZodDto } from "nestjs-zod";
+import { logSettingSchema } from "./logSetting";
+
+export class LogSettingDto extends createZodDto(logSettingSchema) {}

packages/contracts/src/settings/logs/logSetting.ts

@@ -0,0 +1,24 @@
+import z from "zod";
+
+export const LOG_LEVELS = [
+  "debug",
+  "verbose",
+  "info",
+  "warn",
+  "error",
+  "fatal",
+] as const;
+
+type LogLevelTuple = typeof LOG_LEVELS;
+
+export type LogLevel = LogLevelTuple[number];
+
+export const logSettingSchema = z.object({
+  level: z.enum(LOG_LEVELS),
+  max_size: z
+    .number({ invalid_type_error: "Max size must be a number" })
+    .min(0),
+  max_files: z
+    .number({ invalid_type_error: "Max backups must be a number" })
+    .min(1),
+});

packages/contracts/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "baseUrl": "src",
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "incremental": false,
+    "isolatedModules": true,
+    "lib": ["es2022", "DOM", "DOM.Iterable"],
+    "outDir": "dist",
+    "module": "NodeNext",
+    "moduleDetection": "force",
+    "moduleResolution": "NodeNext",
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "target": "ES2022"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}

packages/contracts/tsup.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  sourcemap: true,
+  clean: true,
+  format: ["cjs", "esm"],
+  dts: true,
+});

packages/contracts/turbo.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "outputs": ["dist/**"]
+    }
+  }
+}

server/nest-cli.json

@@ -1,4 +1,7 @@
 {
   "collection": "@nestjs/schematics",
-  "sourceRoot": "src"
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "plugins": ["@nestjs/swagger"]
+  }
 }

server/package.json

@@ -2,9 +2,6 @@
   "name": "@maintainerr/server",
   "version": "2.10.0",
   "private": true,
-  "exports": {
-    "./*": "./src/*.ts"
-  },
   "installConfig": {
     "hoistingLimits": "workspaces"
   },
@@ -25,28 +22,36 @@
     "migration:run": "ts-node node_modules/typeorm/cli.js migration:run -d ./src/datasource-config.ts",
     "migration:revert": "ts-node node_modules/typeorm/cli.js migration:revert -d ./src/datasource-config.ts",
     "migration:generate": "ts-node node_modules/typeorm/cli.js migration:generate --dataSource ./src/datasource-config.ts -p",
-    "migration:show": "ts-node node_modules/typeorm/cli.js migration:show --dataSource ./src/datasource-config.ts"
+    "migration:show": "ts-node node_modules/typeorm/cli.js migration:show --dataSource ./src/datasource-config.ts",
+    "generate-metadata": "ts-node src/generate-metadata.ts"
   },
   "dependencies": {
+    "@maintainerr/contracts": "*",
     "@nestjs/common": "^11.0.10",
     "@nestjs/core": "^11.0.10",
+    "@nestjs/event-emitter": "^3.0.0",
     "@nestjs/platform-express": "^11.0.10",
     "@nestjs/schedule": "^5.0.1",
+    "@nestjs/swagger": "^11.0.3",
     "@nestjs/typeorm": "^11.0.0",
+    "@types/express": "^5.0.0",
     "axios": "^1.7.9",
     "chalk": "^4.1.2",
     "cron-validator": "^1.3.1",
     "lodash": "^4.17.21",
-    "nest-winston": "^1.10.2",
+    "mime-types": "^2.1.35",
+    "nestjs-zod": "^4.3.1",
     "node-cache": "^5.1.2",
+    "read-last-lines": "^1.8.0",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "sqlite3": "^5.1.6",
     "typeorm": "^0.3.20",
     "winston": "^3.17.0",
     "winston-daily-rotate-file": "^5.0.0",
     "xml2js": "^0.6.2",
-    "yaml": "^2.7.0"
+    "yaml": "^2.7.0",
+    "zod": "^3.24.1"
   },
   "devDependencies": {
     "@automock/adapters.nestjs": "^2.1.0",
@@ -58,6 +63,7 @@
     "@nestjs/testing": "^11.0.10",
     "@types/jest": "^29.5.14",
     "@types/lodash": "^4.17.15",
+    "@types/mime-types": "^2",
     "@types/node": "^22",
     "@types/xml2js": "^0.4.14",
     "@typescript-eslint/eslint-plugin": "^8.24.0",

server/src/app/app.module.ts

@@ -16,10 +16,16 @@ import { OverseerrApiService } from '../modules/api/overseerr-api/overseerr-api.
 import ormConfig from './config/typeOrmConfig';
 import { TautulliApiModule } from '../modules/api/tautulli-api/tautulli-api.module';
 import { TautulliApiService } from '../modules/api/tautulli-api/tautulli-api.service';
+import { LogsModule } from '../modules/logging/logs.module';
+import { EventEmitterModule } from '@nestjs/event-emitter';
+import { APP_PIPE } from '@nestjs/core';
+import { ZodValidationPipe } from 'nestjs-zod';
 
 @Module({
   imports: [
     TypeOrmModule.forRoot(ormConfig),
+    EventEmitterModule.forRoot(),
+    LogsModule,
     SettingsModule,
     PlexApiModule,
     ExternalApiModule,
@@ -31,7 +37,13 @@ import { TautulliApiService } from '../modules/api/tautulli-api/tautulli-api.ser
     CollectionsModule,
   ],
   controllers: [AppController],
-  providers: [AppService],
+  providers: [
+    AppService,
+    {
+      provide: APP_PIPE,
+      useClass: ZodValidationPipe,
+    },
+  ],
 })
 export class AppModule implements OnModuleInit {
   constructor(

server/src/database/migrations/1740094282798-Add_log_settings.ts

@@ -0,0 +1,29 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddLogSettings1740094282798 implements MigrationInterface {
+  name = 'AddLogSettings1740094282798';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+            CREATE TABLE "log_settings" (
+                "id" integer PRIMARY KEY AUTOINCREMENT NOT NULL,
+                "level" varchar NOT NULL DEFAULT ('info'),
+                "max_size" integer NOT NULL DEFAULT (20),
+                "max_files" integer NOT NULL DEFAULT (7)
+            )
+        `);
+
+    await queryRunner.query(`
+            INSERT INTO "log_settings"("level", "max_size", "max_files")
+            SELECT 'info',
+                20,
+                7
+        `);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+            DROP TABLE "log_settings"
+        `);
+  }
+}

server/src/generate-metadata.ts

@@ -0,0 +1,10 @@
+import { PluginMetadataGenerator } from '@nestjs/cli/lib/compiler/plugins/plugin-metadata-generator';
+import { ReadonlyVisitor } from '@nestjs/swagger/dist/plugin';
+
+const generator = new PluginMetadataGenerator();
+generator.generate({
+  visitors: [new ReadonlyVisitor({ pathToSource: __dirname })],
+  outputDir: __dirname,
+  watch: true,
+  tsconfigPath: 'tsconfig.build.json',
+});