Merge pull request #202 from FoxxMD/validateGranular

feat: Improve client/source schema validation generation and error handling

.dockerignore

@@ -25,4 +25,5 @@ build
 *.secrets
 .devcontainer
 .vscode
-**/act/*
+**/act/*
+tmp-*

.gitignore

@@ -133,4 +133,5 @@ flatpak/generated-sources.json
 build
 !setupProxy.js
 **/generated-sources.*
-.github/act/out
+.github/act/out
+tmp-*

.mocharc.json

@@ -2,5 +2,6 @@
   "reporter": "dot",
   "extension": "ts",
   "import": "tsx/esm",
-  "spec": "./src/backend/tests/**/*.test.ts"
+  "spec": "./src/backend/tests/**/*.test.ts",
+  "exit": true
 }

config/lastfm.json.example

@@ -1,12 +1,22 @@
 [
   {
-    "name": "myLastFm",
+    "name": "myLastFmClient",
     "enable": true,
     "configureAs": "client",
     "data": {
       "apiKey": "a89cba1569901a0671d5a9875fed4be1",
       "secret": "ec42e09d5ae0ee0f0816ca151008412a",
       "redirectUri": "http://localhost:9078/lastfm/callback"
     }
+  },
+  {
+    "name": "myLastFmSource",
+    "enable": true,
+    "configureAs": "source",
+    "data": {
+      "apiKey": "a89cba1569901a0671d5a9875fed4be1",
+      "secret": "ec42e09d5ae0ee0f0816ca151008412a",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
   }
 ]

config/listenbrainz.json.example

@@ -1,11 +1,20 @@
 [
   {
-    "name": "brainz",
+    "name": "brainzClient",
     "enable": true,
     "configureAs": "client",
     "data": {
       "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
       "username": "FoxxMD"
     }
+  },
+  {
+    "name": "brainzSource",
+    "enable": true,
+    "configureAs": "source",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "FoxxMD"
+    }
   }
 ]

config/webscrobbler.json.example

@@ -2,7 +2,7 @@
   {
     "name": "MyWebScrobbler",
     "data": {
-      "slug": null,
+      "slug": "MyOptionalSlug",
       "whitelist": [],
       "blacklist": []
     }

package.json

@@ -82,6 +82,7 @@
     "fast-deep-equal": "^3.1.3",
     "fixed-size-list": "^0.3.0",
     "formidable": "^3.5",
+    "glob": "^11.0.0",
     "gotify": "^1.1.0",
     "iso-websocket": "^0.3.0",
     "iti": "^0.6.0",
@@ -157,7 +158,8 @@
     "typescript": "^5.5.4",
     "typescript-eslint": "^7.0.1",
     "typescript-json-schema": "^0.61.0",
-    "vite": "^5.2.12"
+    "vite": "^5.2.12",
+    "with-local-tmp-dir": "^5.1.1"
   },
   "browserslist": {
     "production": [
@@ -174,6 +176,11 @@
   "overrides": {
     "spotify-web-api-node": {
       "superagent": "$superagent"
+    },
+    "with-local-tmp-dir": {
+      "tmp-promise": {
+        "tmp": "0.2.1"
+      }
     }
   }
 }

src/backend/common/infrastructure/Atomic.ts

@@ -48,6 +48,10 @@ export const sourceTypes: SourceType[] = [
     'vlc'
 ];
 
+export const isSourceType = (data: string): data is SourceType => {
+    return sourceTypes.includes(data as SourceType);
+}
+
 export const lowGranularitySources: SourceType[] = ['subsonic', 'ytmusic'];
 
 export type ClientType =
@@ -59,6 +63,9 @@ export const clientTypes: ClientType[] = [
     'lastfm',
     'listenbrainz'
 ];
+export const isClientType = (data: string): data is ClientType => {
+    return clientTypes.includes(data as ClientType);
+}
 
 export type InitState = 0 | 1 | 2;
 export const NOT_INITIALIZED: InitState = 0;

src/backend/common/infrastructure/config/aioConfig.ts

@@ -5,6 +5,7 @@ import { RequestRetryOptions } from "./common.js";
 import { WebhookConfig } from "./health/webhooks.js";
 import { CommonSourceOptions, SourceRetryOptions } from "./source/index.js";
 import { SourceAIOConfig } from "./source/sources.js";
+import { ClientType, SourceType } from "../Atomic.js";
 
 
 export interface SourceDefaults extends CommonSourceOptions {
@@ -70,7 +71,22 @@ export interface AIOClientConfig {
     clients?: ClientAIOConfig[]
 }
 
+export interface AIOClientRelaxedConfig {
+    clientDefaults?: RequestRetryOptions
+    clients?: object[]
+}
+
 export interface AIOSourceConfig {
     sourceDefaults?: SourceRetryOptions
     sources?: SourceAIOConfig[]
 }
+
+export interface AIOSourceRelaxedConfig {
+    sourceDefaults?: SourceRetryOptions
+    sources?: object[]
+}
+
+export interface TypedConfig<T = string> {
+    type: T
+    // [key: string]: any
+}

src/backend/common/infrastructure/config/source/deezer.ts

@@ -19,7 +19,7 @@ export interface DeezerData extends CommonSourceData {
      * @default "http://localhost:9078/deezer/callback"
      * @examples ["http://localhost:9078/deezer/callback"]
      * */
-    redirectUri: string
+    redirectUri?: string
     /**
      * optional, how long to wait before calling spotify for new tracks (in seconds)
      *

src/backend/common/infrastructure/config/source/jellyfin.ts

@@ -89,3 +89,6 @@ export interface JellyApiSourceConfig extends CommonSourceConfig {
 export interface JellyApiSourceAIOConfig extends JellyApiSourceConfig {
     type: 'jellyfin'
 }
+
+
+export type JellyfinCompatConfig = JellyApiSourceConfig | JellySourceConfig;

src/backend/common/infrastructure/config/source/spotify.ts

@@ -20,7 +20,7 @@ export interface SpotifySourceData extends CommonSourceData, PollingOptions {
      * @default "http://localhost:9078/callback"
      * @examples ["http://localhost:9078/callback"]
      * */
-    redirectUri: string
+    redirectUri?: string
     /**
      * How long to wait before polling the source API for new tracks (in seconds)
      *