chore: extract connect to an API plugin

.github/workflows/main.yml

@@ -162,12 +162,6 @@ jobs:
           cd ${{ github.workspace }}
           pnpm install --frozen-lockfile
 
-      - name: Lint
-        run: pnpm run lint
-
-      - name: Type Check
-        run: pnpm run type-check
-
       - name: Build
         run: pnpm run build
 

.vscode/settings.json

@@ -1,15 +1,14 @@
 {
-    "files.associations": {
-      "*.page": "php"
-    },
-    "editor.codeActionsOnSave": {
-      "source.fixAll": "never",
-      "source.fixAll.eslint": "explicit"
-    },
-    "i18n-ally.localesPaths": [
-      "locales"
-    ],
-    "i18n-ally.keystyle": "flat",
-    "eslint.experimental.useFlatConfig": true
-  }
-
+  "files.associations": {
+    "*.page": "php"
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "never",
+    "source.fixAll.eslint": "explicit"
+  },
+  "i18n-ally.localesPaths": ["locales"],
+  "i18n-ally.keystyle": "flat",
+  "eslint.experimental.useFlatConfig": true,
+  "typescript.preferences.importModuleSpecifier": "non-relative",
+  "javascript.preferences.importModuleSpecifier": "non-relative"
+}

api/.vscode/settings.json

@@ -3,5 +3,7 @@
     "eslint.options": {
         "flags": ["unstable_ts_config"],
         "overrideConfigFile": ".eslintrc.ts"
-    }
+    },
+    "typescript.preferences.importModuleSpecifier": "non-relative",
+    "javascript.preferences.importModuleSpecifier": "non-relative"
 }

api/dev/configs/api.json

@@ -0,0 +1,9 @@
+{
+  "version": "4.8.0",
+  "extraOrigins": [
+    "https://google.com",
+    "https://test.com"
+  ],
+  "sandbox": true,
+  "ssoSubIds": []
+}

api/dev/configs/connect.json

@@ -1,3 +1,16 @@
 {
-  "demo": "hello.unraider"
+  "wanaccess": false,
+  "wanport": 0,
+  "upnpEnabled": false,
+  "apikey": "",
+  "localApiKey": "",
+  "email": "",
+  "username": "",
+  "avatar": "",
+  "regWizTime": "",
+  "accesstoken": "",
+  "idtoken": "",
+  "refreshtoken": "",
+  "dynamicRemoteAccessType": "DISABLED",
+  "ssoSubIds": []
 }

api/dev/states/myservers.cfg

@@ -1,5 +1,5 @@
 [api]
-version="4.8.0"
+version="4.4.1"
 extraOrigins="https://google.com,https://test.com"
 [local]
 sandbox="yes"
@@ -20,5 +20,5 @@ dynamicRemoteAccessType="DISABLED"
 ssoSubIds=""
 allowedOrigins="/var/run/unraid-notifications.sock, /var/run/unraid-php.sock, /var/run/unraid-cli.sock, http://localhost:8080, https://localhost:4443, https://tower.local:4443, https://192.168.1.150:4443, https://tower:4443, https://192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net:4443, https://85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net:8443, https://10-252-0-1.hash.myunraid.net:4443, https://10-252-1-1.hash.myunraid.net:4443, https://10-253-3-1.hash.myunraid.net:4443, https://10-253-4-1.hash.myunraid.net:4443, https://10-253-5-1.hash.myunraid.net:4443, https://10-100-0-1.hash.myunraid.net:4443, https://10-100-0-2.hash.myunraid.net:4443, https://10-123-1-2.hash.myunraid.net:4443, https://221-123-121-112.hash.myunraid.net:4443, https://google.com, https://test.com, https://connect.myunraid.net, https://connect-staging.myunraid.net, https://dev-my.myunraid.net:4000, https://studio.apollographql.com"
 [connectionStatus]
-minigraph="ERROR_RETRYING"
+minigraph="PRE_INIT"
 upnpStatus=""

api/docs/developer/api-plugins.md

@@ -10,22 +10,115 @@ where the API provides dependencies for the plugin while the plugin provides fun
 ### Adding a local workspace package as an API plugin
 
 The challenge with local workspace plugins is that they aren't available via npm during production.
-To solve this, we vendor them inside `dist/plugins`. To prevent the build from breaking, however,
-you should mark the workspace dependency as optional. For example:
+To solve this, we vendor them during the build process. Here's the complete process:
+
+#### 1. Configure the build system
+
+Add your workspace package to the vendoring configuration in `api/scripts/build.ts`:
+
+```typescript
+const WORKSPACE_PACKAGES_TO_VENDOR = {
+    '@unraid/shared': 'packages/unraid-shared',
+    'unraid-api-plugin-connect': 'packages/unraid-api-plugin-connect',
+    'your-plugin-name': 'packages/your-plugin-path', // Add your plugin here
+} as const;
+```
+
+#### 2. Configure Vite
+
+Add your workspace package to the Vite configuration in `api/vite.config.ts`:
+
+```typescript
+const workspaceDependencies = {
+    '@unraid/shared': 'packages/unraid-shared',
+    'unraid-api-plugin-connect': 'packages/unraid-api-plugin-connect',
+    'your-plugin-name': 'packages/your-plugin-path', // Add your plugin here
+};
+```
+
+This ensures the package is:
+- Excluded from Vite's optimization during development
+- Marked as external during the build process
+- Properly handled in SSR mode
+
+#### 3. Configure the API package.json
+
+Add your workspace package as a peer dependency in `api/package.json`:
 
 ```json
 {
     "peerDependencies": {
-        "unraid-api-plugin-connect": "workspace:*"
+        "unraid-api-plugin-connect": "workspace:*",
+        "your-plugin-name": "workspace:*"
     },
     "peerDependenciesMeta": {
         "unraid-api-plugin-connect": {
             "optional": true
+        },
+        "your-plugin-name": {
+            "optional": true
+        }
+    }
+}
+```
+
+By marking the workspace dependency "optional", npm will not attempt to install it during development.
+The "workspace:*" identifier will be invalid during build-time and run-time, but won't cause problems
+because the package gets vendored instead.
+
+#### 4. Plugin package setup
+
+Your workspace plugin package should:
+
+1. **Export types and main entry**: Set up proper `main`, `types`, and `exports` fields:
+```json
+{
+    "name": "your-plugin-name",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
         }
     },
+    "files": ["dist"]
+}
+```
+
+2. **Use peer dependencies**: Declare shared dependencies as peer dependencies to avoid duplication:
+```json
+{
+    "peerDependencies": {
+        "@nestjs/common": "^11.0.11",
+        "@nestjs/core": "^11.0.11",
+        "graphql": "^16.9.0"
+    }
+}
+```
+
+3. **Include build script**: Add a build script that compiles TypeScript:
+```json
+{
+    "scripts": {
+        "build": "tsc",
+        "prepare": "npm run build"
+    }
 }
 ```
 
-By marking the workspace dependency "optional", npm will not attempt to install it.
-Thus, even though the "workspace:*" identifier will be invalid during build-time and run-time,
-it will not cause problems.
+#### 5. Build process
+
+During production builds:
+
+1. The build script (`api/scripts/build.ts`) will automatically pack and install your workspace package as a tarball
+2. This happens after `npm install --omit=dev` in the pack directory
+3. The vendored package becomes a regular node_modules dependency in the final build
+
+#### 6. Development vs Production
+
+- **Development**: Vite resolves workspace packages directly from their source
+- **Production**: Packages are vendored as tarballs in `node_modules`
+
+This approach ensures that workspace plugins work seamlessly in both development and production environments.