fix: authorization type error (#987)

Co-authored-by: Eli Bosley <ekbosley@gmail.com>

api/codegen.ts

@@ -0,0 +1,105 @@
+import type { CodegenConfig } from '@graphql-codegen/cli';
+
+const config: CodegenConfig = {
+  overwrite: true,
+  emitLegacyCommonJSImports: false,
+  verbose: true,
+  config: {
+  namingConvention: {
+      typeNames: './fix-array-type.cjs',
+      enumValues: 'change-case#upperCase',
+      useTypeImports: true,
+    },
+    scalars: {
+      DateTime: 'string',
+      Long: 'number',
+      JSON: '{ [key: string]: any }',
+      URL: 'URL',
+      Port: 'number',
+      UUID: 'string',
+    },
+  },
+  generates: {
+    'src/graphql/generated/client/': {
+      documents: './src/graphql/mothership/*.ts',
+      schema: {
+        [process.env.MOTHERSHIP_GRAPHQL_LINK as string]: {
+          headers: {
+            origin: 'https://forums.unraid.net',
+          },
+        },
+      },
+      preset: 'client',
+      presetConfig: {
+        gqlTagName: 'graphql',
+      },
+      config: {
+        useTypeImports: true,
+        withObjectType: true,
+      },
+      plugins: [
+        { add: { content: '/* eslint-disable */' } },
+      ],
+    },
+    // Generate Types for the API Server
+    'src/graphql/generated/api/types.ts': {
+      schema: [
+        './src/graphql/types.ts',
+        './src/graphql/schema/types/**/*.graphql',
+      ],
+      plugins: [
+        'typescript',
+        'typescript-resolvers',
+        { add: { content: '/* eslint-disable */' } },
+      ],
+      config: {
+        contextType: '@app/graphql/schema/utils#Context',
+        useIndexSignature: true,
+      },
+    },
+    // Generate Operations for any built-in API Server Operations (e.g., report.ts)
+    'src/graphql/generated/api/operations.ts': {
+      documents: './src/graphql/client/api/*.ts',
+      schema: [
+        './src/graphql/types.ts',
+        './src/graphql/schema/types/**/*.graphql',
+      ],
+      preset: 'import-types',
+      presetConfig: {
+        typesPath: '@app/graphql/generated/api/types',
+      },
+      plugins: [
+        'typescript-validation-schema',
+        'typescript-operations',
+        'typed-document-node',
+        { add: { content: '/* eslint-disable */' } },
+      ],
+      config: {
+        importFrom: '@app/graphql/generated/api/types',
+        strictScalars: false,
+        schema: 'zod',
+        withObjectType: true,
+      },
+    },
+    'src/graphql/generated/client/validators.ts': {
+      schema: {
+        [process.env.MOTHERSHIP_GRAPHQL_LINK as string]: {
+          headers: {
+            origin: 'https://forums.unraid.net',
+          },
+        },
+      },
+      plugins: [
+        'typescript-validation-schema',
+        { add: { content: '/* eslint-disable */' } },
+      ],
+      config: {
+        importFrom: '@app/graphql/generated/client/graphql',
+        strictScalars: false,
+        schema: 'zod',
+      },
+    },
+  },
+};
+
+export default config;

api/codegen.yml

@@ -1,77 +0,0 @@
-overwrite: true
-emitLegacyCommonJSImports: false
-verbose: true
-require: 
-  - ts-node/register
-config:
-  namingConvention: 
-    typeNames: './fix-array-type.cjs'
-    enumValues: 'change-case#upperCase'
-    useTypeImports: true
-  scalars:
-    DateTime: string
-    Long: number
-    JSON: "{ [key: string]: any }"
-    URL: URL
-    Port: number
-    UUID: string
-
-generates:
-  src/graphql/generated/client/:
-    documents: './src/graphql/mothership/*.ts'
-    schema: 
-      '${MOTHERSHIP_GRAPHQL_LINK}':
-        headers:
-          origin: 'https://forums.unraid.net'
-    preset: client
-    presetConfig:
-      gqlTagName: graphql
-    config: 
-      useTypeImports: true
-      withObjectType: true
-    plugins:
-      - add: { content: '/* eslint-disable */' }
-  
-# Generate Types for the API Server
-  src/graphql/generated/api/types.ts:
-    schema: 
-      - './src/graphql/types.ts'
-      - './src/graphql/schema/types/**/*.graphql'
-    plugins:
-      - typescript
-      - typescript-resolvers
-      - add: { content: '/* eslint-disable */' }
-    config:
-      contextType: '@app/graphql/schema/utils#Context'
-      useIndexSignature: true
-# Generate Operations for any built in API Server Operations (ie report.ts)
-  src/graphql/generated/api/operations.ts:
-    documents: './src/graphql/client/api/*.ts'
-    schema: 
-      - './src/graphql/types.ts'
-      - './src/graphql/schema/types/**/*.graphql'
-    preset: import-types
-    presetConfig:
-      typesPath: '@app/graphql/generated/api/types'
-    plugins:
-      - typescript-validation-schema
-      - typescript-operations
-      - typed-document-node
-      - add: { content: '/* eslint-disable */' }
-    config:
-      importFrom: '@app/graphql/generated/api/types'
-      strictScalars: false
-      schema: 'zod'
-      withObjectType: true
-  src/graphql/generated/client/validators.ts:
-    schema: 
-      '${MOTHERSHIP_GRAPHQL_LINK}':
-        headers:
-          origin: 'https://forums.unraid.net'
-    plugins:
-      - typescript-validation-schema
-      - add: { content: '/* eslint-disable */'}
-    config:
-      importFrom: '@app/graphql/generated/client/graphql'
-      strictScalars: false
-      schema: 'zod'

api/docker-compose.yml

@@ -17,7 +17,7 @@ x-volumes: &volumes
   - ./.env.staging:/app/.env.staging
   - ./.env.test:/app/.env.test
   - ./.env.development:/app/.env.development
-  - ./codegen.yml:/app/codegen.yml
+  - ./codegen.ts:/app/codegen.ts
   - ./fix-array-type.cjs:/app/fix-array-type.cjs
   - /var/run/docker.sock:/var/run/docker.sock
   - ./unraid-api.js:/app/unraid-api.js

api/package.json

@@ -12,9 +12,9 @@
         "build": "vite build --mode=production",
         "postbuild": "chmod +x dist/main.js && chmod +x dist/cli.js",
         "build-and-pack": "./scripts/build.mjs",
-    "codegen": "MOTHERSHIP_GRAPHQL_LINK='https://staging.mothership.unraid.net/ws' graphql-codegen --config codegen.yml -r dotenv/config './.env.staging'",
+        "codegen": "MOTHERSHIP_GRAPHQL_LINK='https://staging.mothership.unraid.net/ws' graphql-codegen --config codegen.ts -r dotenv/config './.env.staging'",
-    "codegen:watch": "DOTENV_CONFIG_PATH='./.env.staging' graphql-codegen --config codegen.yml --watch -r dotenv/config",
+        "codegen:watch": "DOTENV_CONFIG_PATH='./.env.staging' graphql-codegen --config codegen.ts --watch -r dotenv/config",
-    "codegen:local": "NODE_TLS_REJECT_UNAUTHORIZED=0  MOTHERSHIP_GRAPHQL_LINK='https://mothership.localhost/ws' graphql-codegen-esm --config codegen.yml --watch",
+        "codegen:local": "NODE_TLS_REJECT_UNAUTHORIZED=0  MOTHERSHIP_GRAPHQL_LINK='https://mothership.localhost/ws' graphql-codegen --config codegen.ts --watch",
         "tsc": "tsc --noEmit",
         "lint": "eslint --flag unstable_ts_config --config .eslintrc.ts src/",
         "lint:fix": "eslint --flag unstable_ts_config --fix --config .eslintrc.ts src/",
@@ -22,7 +22,7 @@
         "test": "vitest run --pool=forks",
         "coverage": "vitest run --pool=forks --coverage",
         "release": "standard-version",
-    "dev": "nodemon --ext ts,gql --ignore \"dist/\" --ignore \"dev/\" --signal SIGKILL --exec \"vite\"",
+        "dev": "vite",
         "container:build": "./scripts/dc.sh build dev",
         "container:start": "./scripts/dc.sh run --rm --service-ports dev",
         "container:test": "./scripts/dc.sh run --rm builder npm run test",
@@ -138,6 +138,7 @@
         "@nestjs/testing": "^10.4.7",
         "@originjs/vite-plugin-commonjs": "^1.0.3",
         "@rollup/plugin-node-resolve": "^15.3.0",
+        "@swc/core": "^1.10.1",
         "@types/async-exit-hook": "^2.0.2",
         "@types/btoa": "^1.2.5",
         "@types/bytes": "^3.1.4",
@@ -162,7 +163,7 @@
         "@types/uuid": "^10.0.0",
         "@types/ws": "^8.5.13",
         "@types/wtfnode": "^0.7.3",
-    "@vitest/coverage-v8": "^2.1.4",
+        "@vitest/coverage-v8": "^2.1.8",
         "@vitest/ui": "^2.1.4",
         "cz-conventional-changelog": "3.3.0",
         "eslint": "^9.14.0",
@@ -173,11 +174,12 @@
         "standard-version": "^9.5.0",
         "typescript": "^5.6.3",
         "typescript-eslint": "^8.13.0",
+        "unplugin-swc": "^1.5.1",
         "vite": "^5.4.10",
         "vite-plugin-node": "^4.0.0",
         "vite-plugin-static-copy": "^2.0.0",
         "vite-tsconfig-paths": "^5.1.0",
-    "vitest": "^2.1.4",
+        "vitest": "^2.1.8",
         "zx": "^8.2.0"
     },
     "optionalDependencies": {

api/scripts/build.mjs

@@ -32,8 +32,9 @@ try {
         '.env.production',
         '.env.staging',
         'tsconfig.json',
-        'codegen.yml',
+        'codegen.ts',
-        'ecosystem.config.json'
+        'ecosystem.config.json',
+        'vite.config.ts',
     ]
 
     for (const file of files) {

api/src/unraid-api/graph/resolvers/notifications/notifications.resolver.ts

@@ -5,9 +5,9 @@ import { AuthActionVerb, AuthPossession, UsePermissions } from 'nest-authz';
 import { AppError } from '@app/core/errors/app-error';
 import { createSubscription, PUBSUB_CHANNEL } from '@app/core/pubsub';
 import {
-    NotificationData,
+    type NotificationData,
-    NotificationFilter,
+    type NotificationFilter,
-    NotificationOverview,
+    type NotificationOverview,
     NotificationType,
     Resource,
 } from '@app/graphql/generated/api/types';

api/vite.config.ts

@@ -1,6 +1,8 @@
+
 import { viteCommonjs } from '@originjs/vite-plugin-commonjs';
 import nodeResolve from '@rollup/plugin-node-resolve';
 import nodeExternals from 'rollup-plugin-node-externals';
+import swc from 'unplugin-swc';
 import { VitePluginNode } from 'vite-plugin-node';
 import { viteStaticCopy } from 'vite-plugin-static-copy';
 import tsconfigPaths from 'vite-tsconfig-paths';
@@ -26,9 +28,35 @@ export default defineConfig(({ mode }) => {
                       adapter: 'nest',
                       appPath: 'src/index.ts',
                       tsCompiler: 'swc',
+                      swcOptions: {
+                            jsc: {
+                                parser: {
+                                    syntax: 'typescript',
+                                    decorators: true,
+                                },
+                                target: 'es2024',
+                                transform: {
+                                    legacyDecorator: true,
+                                    decoratorMetadata: true,
+                                },
+                            },
+                      },
                       initAppOnBoot: true,
                   })
                 : []),
+            swc.vite({
+                jsc: {
+                    parser: {
+                        syntax: 'typescript',
+                        decorators: true,
+                    },
+                    target: 'es2024',
+                    transform: {
+                        legacyDecorator: true,
+                        decoratorMetadata: true,
+                    },
+                },
+            }),
         ],
         define: {
             // Allows vite to preserve process.env variables and not hardcode them
@@ -43,7 +71,15 @@ export default defineConfig(({ mode }) => {
                 'class-transformer/storage',
                 'unicorn-magic',
             ],
-            include: ['@nestjs/common', '@nestjs/core', 'reflect-metadata', 'fastify'],
+            include: [
+                '@nestjs/common',
+                '@nestjs/core',
+                '@nestjs/platform-express',
+                'reflect-metadata',
+                'fastify',
+                'passport',
+                'passport-custom',
+            ],
         },
         build: {
             sourcemap: true,
@@ -55,17 +91,46 @@ export default defineConfig(({ mode }) => {
                 },
                 output: {
                     entryFileNames: '[name].js',
-                    format: 'es', // Change the format to 'es' to support top-level await
+                    format: 'es',
+                    interop: 'auto',
                 },
                 preserveEntrySignatures: 'strict',
+                external: [
+                    'class-validator',
+                    'class-transformer',
+                    /^@nestjs\/.*/,
+                    'reflect-metadata',
+                    'rxjs',
+                    'fastify',
+                    '@fastify/cors',
+                    '@fastify/cookie',
+                    'passport',
+                    'passport-custom',
+                    'passport-http-header-strategy',
+                    'casbin',
+                    'nest-authz',
+                    'nest-access-control',
+                    '@nestjs/passport',
+                    'passport-http-header-strategy',
+                    'accesscontrol',
+                ],
             },
             modulePreload: false,
             minify: false,
             target: 'node20',
             commonjsOptions: {
                 transformMixedEsModules: true,
-                include: [/node_modules/, /fastify/],
+                include: [/node_modules/, /fastify/, /reflect-metadata/],
-                exclude: ['cpu-features'],
+                exclude: [
+                    'cpu-features',
+                    '@nestjs',
+                    'rxjs',
+                    'passport',
+                    'passport-custom',
+                    'passport-http-header-strategy',
+                ],
+                requireReturnsDefault: 'preferred',
+                strictRequires: true,
             },
         },
         server: {

web/composables/gql/graphql.ts

@@ -43,17 +43,34 @@ export type AccessUrlInput = {
   type: URL_TYPE;
 };
 
+export type AddPermissionInput = {
+  action: Scalars['String']['input'];
+  possession: Scalars['String']['input'];
+  resource: Resource;
+  role: Role;
+};
+
+export type AddRoleForApiKeyInput = {
+  apiKeyId: Scalars['ID']['input'];
+  role: Role;
+};
+
+export type AddRoleForUserInput = {
+  role: Role;
+  userId: Scalars['ID']['input'];
+};
+
 export type AllowedOriginInput = {
   origins: Array<Scalars['String']['input']>;
 };
 
 export type ApiKey = {
   __typename?: 'ApiKey';
+  createdAt: Scalars['DateTime']['output'];
   description?: Maybe<Scalars['String']['output']>;
-  expiresAt: Scalars['Long']['output'];
+  id: Scalars['ID']['output'];
-  key: Scalars['String']['output'];
   name: Scalars['String']['output'];
-  scopes: Scalars['JSON']['output'];
+  roles: Array<Role>;
 };
 
 export type ApiKeyResponse = {
@@ -62,6 +79,16 @@ export type ApiKeyResponse = {
   valid: Scalars['Boolean']['output'];
 };
 
+export type ApiKeyWithSecret = {
+  __typename?: 'ApiKeyWithSecret';
+  createdAt: Scalars['DateTime']['output'];
+  description?: Maybe<Scalars['String']['output']>;
+  id: Scalars['ID']['output'];
+  key: Scalars['String']['output'];
+  name: Scalars['String']['output'];
+  roles: Array<Role>;
+};
+
 export type ArrayType = Node & {
   __typename?: 'Array';
   /** Current boot disk */
@@ -322,6 +349,12 @@ export enum ContainerState {
   Running = 'RUNNING'
 }
 
+export type CreateApiKeyInput = {
+  description?: InputMaybe<Scalars['String']['input']>;
+  name: Scalars['String']['input'];
+  roles: Array<Role>;
+};
+
 export type Devices = {
   __typename?: 'Devices';
   gpu?: Maybe<Array<Maybe<Gpu>>>;
@@ -567,7 +600,7 @@ export type Me = UserAccount & {
   id: Scalars['ID']['output'];
   name: Scalars['String']['output'];
   permissions?: Maybe<Scalars['JSON']['output']>;
-  roles: Scalars['String']['output'];
+  roles: Array<Role>;
 };
 
 export enum MemoryFormFactor {
@@ -620,10 +653,11 @@ export type Mount = {
 
 export type Mutation = {
   __typename?: 'Mutation';
-  /** Create a new API key */
-  addApikey?: Maybe<ApiKey>;
   /** Add new disk to array */
   addDiskToArray?: Maybe<ArrayType>;
+  addPermission: Scalars['Boolean']['output'];
+  addRoleForApiKey: Scalars['Boolean']['output'];
+  addRoleForUser: Scalars['Boolean']['output'];
   /** Add a new user */
   addUser?: Maybe<User>;
   archiveAll: NotificationOverview;
@@ -635,6 +669,7 @@ export type Mutation = {
   clearArrayDiskStatistics?: Maybe<Scalars['JSON']['output']>;
   connectSignIn: Scalars['Boolean']['output'];
   connectSignOut: Scalars['Boolean']['output'];
+  createApiKey: ApiKeyWithSecret;
   createNotification: Notification;
   /** Deletes all archived notifications on server. */
   deleteArchivedNotifications: NotificationOverview;
@@ -642,8 +677,6 @@ export type Mutation = {
   /** Delete a user */
   deleteUser?: Maybe<User>;
   enableDynamicRemoteAccess: Scalars['Boolean']['output'];
-  /** Get an existing API key */
-  getApiKey?: Maybe<ApiKey>;
   login?: Maybe<Scalars['String']['output']>;
   mountArrayDisk?: Maybe<Disk>;
   /** Pause parity check */
@@ -653,6 +686,7 @@ export type Mutation = {
   recalculateOverview: NotificationOverview;
   /** Remove existing disk from array. NOTE: The array must be stopped before running this otherwise it'll throw an error. */
   removeDiskFromArray?: Maybe<ArrayType>;
+  removeRoleFromApiKey: Scalars['Boolean']['output'];
   /** Resume parity check */
   resumeParityCheck?: Maybe<Scalars['JSON']['output']>;
   setAdditionalAllowedOrigins: Array<Scalars['String']['output']>;
@@ -669,14 +703,6 @@ export type Mutation = {
   unmountArrayDisk?: Maybe<Disk>;
   /** Marks a notification as unread. */
   unreadNotification: Notification;
-  /** Update an existing API key */
-  updateApikey?: Maybe<ApiKey>;
-};
-
-
-export type MutationaddApikeyArgs = {
-  input?: InputMaybe<updateApikeyInput>;
-  name: Scalars['String']['input'];
 };
 
 
@@ -685,6 +711,21 @@ export type MutationaddDiskToArrayArgs = {
 };
 
 
+export type MutationaddPermissionArgs = {
+  input: AddPermissionInput;
+};
+
+
+export type MutationaddRoleForApiKeyArgs = {
+  input: AddRoleForApiKeyInput;
+};
+
+
+export type MutationaddRoleForUserArgs = {
+  input: AddRoleForUserInput;
+};
+
+
 export type MutationaddUserArgs = {
   input: addUserInput;
 };
@@ -715,6 +756,11 @@ export type MutationconnectSignInArgs = {
 };
 
 
+export type MutationcreateApiKeyArgs = {
+  input: CreateApiKeyInput;
+};
+
+
 export type MutationcreateNotificationArgs = {
   input: NotificationData;
 };
@@ -736,12 +782,6 @@ export type MutationenableDynamicRemoteAccessArgs = {
 };
 
 
-export type MutationgetApiKeyArgs = {
-  input?: InputMaybe<authenticateInput>;
-  name: Scalars['String']['input'];
-};
-
-
 export type MutationloginArgs = {
   password: Scalars['String']['input'];
   username: Scalars['String']['input'];
@@ -758,6 +798,11 @@ export type MutationremoveDiskFromArrayArgs = {
 };
 
 
+export type MutationremoveRoleFromApiKeyArgs = {
+  input: RemoveRoleFromApiKeyInput;
+};
+
+
 export type MutationsetAdditionalAllowedOriginsArgs = {
   input: AllowedOriginInput;
 };
@@ -792,12 +837,6 @@ export type MutationunreadNotificationArgs = {
   id: Scalars['String']['input'];
 };
 
-
-export type MutationupdateApikeyArgs = {
-  input?: InputMaybe<updateApikeyInput>;
-  name: Scalars['String']['input'];
-};
-
 export type Network = Node & {
   __typename?: 'Network';
   accessUrls?: Maybe<Array<AccessUrl>>;
@@ -999,8 +1038,8 @@ export type ProfileModel = {
 
 export type Query = {
   __typename?: 'Query';
-  /** Get all API keys */
+  apiKey?: Maybe<ApiKey>;
-  apiKeys?: Maybe<Array<Maybe<ApiKey>>>;
+  apiKeys: Array<ApiKey>;
   /** An Unraid array consisting of 1 or 2 Parity disks and a number of Data disks. */
   array: ArrayType;
   cloud?: Maybe<Cloud>;
@@ -1046,6 +1085,11 @@ export type Query = {
 };
 
 
+export type QueryapiKeyArgs = {
+  id: Scalars['ID']['input'];
+};
+
+
 export type QuerydiskArgs = {
   id: Scalars['ID']['input'];
 };
@@ -1140,6 +1184,52 @@ export type RemoteAccess = {
   port?: Maybe<Scalars['Port']['output']>;
 };
 
+export type RemoveRoleFromApiKeyInput = {
+  apiKeyId: Scalars['ID']['input'];
+  role: Role;
+};
+
+/** Available resources for permissions */
+export enum Resource {
+  ApiKey = 'api_key',
+  Array = 'array',
+  Cloud = 'cloud',
+  Config = 'config',
+  Connect = 'connect',
+  CrashReportingEnabled = 'crash_reporting_enabled',
+  Customizations = 'customizations',
+  Dashboard = 'dashboard',
+  Disk = 'disk',
+  Display = 'display',
+  Docker = 'docker',
+  Flash = 'flash',
+  Info = 'info',
+  Logs = 'logs',
+  Me = 'me',
+  Network = 'network',
+  Notifications = 'notifications',
+  Online = 'online',
+  Os = 'os',
+  Owner = 'owner',
+  Permission = 'permission',
+  Registration = 'registration',
+  Servers = 'servers',
+  Services = 'services',
+  Share = 'share',
+  Vars = 'vars',
+  Vms = 'vms',
+  Welcome = 'welcome'
+}
+
+/** Available roles for API keys and users */
+export enum Role {
+  Admin = 'admin',
+  Guest = 'guest',
+  MyServers = 'my_servers',
+  Notifier = 'notifier',
+  Upc = 'upc'
+}
+
 export type Server = {
   __typename?: 'Server';
   apikey: Scalars['String']['output'];
@@ -1203,7 +1293,6 @@ export type Share = {
 
 export type Subscription = {
   __typename?: 'Subscription';
-  apikeys?: Maybe<Array<Maybe<ApiKey>>>;
   array: ArrayType;
   config: Config;
   display?: Maybe<Display>;
@@ -1361,14 +1450,14 @@ export type User = UserAccount & {
   name: Scalars['String']['output'];
   /** If the account has a password set */
   password?: Maybe<Scalars['Boolean']['output']>;
-  roles: Scalars['String']['output'];
+  roles: Array<Role>;
 };
 
 export type UserAccount = {
   description: Scalars['String']['output'];
   id: Scalars['ID']['output'];
   name: Scalars['String']['output'];
-  roles: Scalars['String']['output'];
+  roles: Array<Role>;
 };
 
 export type Vars = Node & {
@@ -1607,12 +1696,6 @@ export type Welcome = {
   message: Scalars['String']['output'];
 };
 
-export type addApiKeyInput = {
-  key?: InputMaybe<Scalars['String']['input']>;
-  name?: InputMaybe<Scalars['String']['input']>;
-  userId?: InputMaybe<Scalars['String']['input']>;
-};
-
 export type addUserInput = {
   description?: InputMaybe<Scalars['String']['input']>;
   name: Scalars['String']['input'];
@@ -1626,10 +1709,6 @@ export type arrayDiskInput = {
   slot?: InputMaybe<Scalars['Int']['input']>;
 };
 
-export type authenticateInput = {
-  password: Scalars['String']['input'];
-};
-
 export type deleteUserInput = {
   name: Scalars['String']['input'];
 };
@@ -1650,11 +1729,6 @@ export enum registrationType {
   Unleashed = 'UNLEASHED'
 }
 
-export type updateApikeyInput = {
-  description?: InputMaybe<Scalars['String']['input']>;
-  expiresAt: Scalars['Long']['input'];
-};
-
 export type usersInput = {
   slim?: InputMaybe<Scalars['Boolean']['input']>;
 };