feat(rpc): make controller decorator name optional (#491)

* feat(rpc): make controller decorator name or definition optional The rpc controller metadata name would then default to the name of the class Signed-off-by: Marcus S. Abildskov <[email protected]> * Update controller.spec.ts Signed-off-by: Marcus S. Abildskov <[email protected]> * Update controller.spec.ts Signed-off-by: Marcus S. Abildskov <[email protected]> * Update decorators.ts Signed-off-by: Marcus S. Abildskov <[email protected]> * Update decorators.ts Signed-off-by: Marcus S. Abildskov <[email protected]> * Update decorators.ts Signed-off-by: Marcus S. Abildskov <[email protected]> * Update decorators.ts Signed-off-by: Marcus S. Abildskov <[email protected]> * feat(rpc): add support for class typeName in rpc class decorator --------- Signed-off-by: Marcus S. Abildskov <[email protected]>
deepkit · Nov 9, 2023 · 525ed39 · 525ed39
1 parent 318d091
commit 525ed39
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 5 deletions.
diff --git a/packages/rpc/src/decorators.ts b/packages/rpc/src/decorators.ts
@@ -9,18 +9,26 @@
  */
 
 import { ClassType } from '@deepkit/core';
-import { ClassDecoratorResult, createClassDecoratorContext, createPropertyDecoratorContext, mergeDecorator, PropertyDecoratorResult } from '@deepkit/type';
+import {
+    ClassDecoratorResult,
+    createClassDecoratorContext,
+    createPropertyDecoratorContext,
+    mergeDecorator,
+    PropertyDecoratorResult,
+    reflect
+} from '@deepkit/type';
 import { ControllerDefinition } from './model.js';
 
 class RpcController {
-    name?: string;
+    // Defaults to the name of the class
+    name: string = '';
 
     definition?: ControllerDefinition<any>;
 
     actions = new Map<string, RpcAction>();
 
     getPath(): string {
-        return this.definition ? this.definition.path : this.name || '';
+        return this.definition ? this.definition.path : this.name;
     }
 }
 
@@ -38,7 +46,7 @@ export class RpcAction {
 class RpcClass {
     t = new RpcController;
 
-    controller(nameOrDefinition: string | ControllerDefinition<any>) {
+    controller(nameOrDefinition?: string | ControllerDefinition<any>) {
         if ('string' === typeof nameOrDefinition) {
             this.t.name = nameOrDefinition;
         } else {
@@ -49,6 +57,10 @@ class RpcClass {
     addAction(name: string, action: RpcAction) {
         this.t.actions.set(name, action);
     }
+
+    onDecorator(classType: ClassType) {
+        this.t.name ??= reflect(classType).typeName || classType.name;
+    }
 }
 
 export const rpcClass: ClassDecoratorResult<typeof RpcClass> = createClassDecoratorContext(RpcClass);

diff --git a/packages/rpc/tests/controller.spec.ts b/packages/rpc/tests/controller.spec.ts
@@ -1,13 +1,22 @@
 import { assertType, entity, Positive, ReflectionClass, ReflectionKind } from '@deepkit/type';
 import { expect, test } from '@jest/globals';
 import { DirectClient } from '../src/client/client-direct.js';
-import { getActions, rpc } from '../src/decorators.js';
+import { getActions, rpc, rpcClass } from '../src/decorators.js';
 import { RpcKernel, RpcKernelConnection } from '../src/server/kernel.js';
 import { Session, SessionState } from '../src/server/security.js';
 import { BehaviorSubject } from 'rxjs';
 import { getClassName, sleep } from '@deepkit/core';
 import { ProgressTracker } from '@deepkit/core-rxjs';
 
+test('default name', () => {
+    @rpc.controller()
+    class Controller {}
+
+    expect(rpcClass._fetch(Controller)).toMatchObject({
+        name: 'Controller',
+    });
+});
+
 test('decorator', async () => {
     @rpc.controller('name')
     class Controller {