Refactor ResourceRef into LinkTo

Author: CarsonF

src/components/file/file.repository.ts

@@ -14,13 +14,7 @@ import { Direction } from 'cypher-query-builder/dist/typings/clauses/order-by';
 import { AnyConditions } from 'cypher-query-builder/dist/typings/clauses/where-utils';
 import { DateTime } from 'luxon';
 import { ID, NotFoundException, ServerException, Session } from '../../common';
-import {
-  CommonRepository,
-  ILogger,
-  Logger,
-  OnIndex,
-  ResourceRef,
-} from '../../core';
+import { CommonRepository, ILogger, LinkTo, Logger, OnIndex } from '../../core';
 import {
   ACTIVE,
   createNode,
@@ -407,7 +401,7 @@ export class FileRepository extends CommonRepository {
     public: isPublic,
     session,
   }: {
-    resource: ResourceRef<any>;
+    resource: LinkTo<any>;
     relation: string;
     name: string;
     public?: boolean;

src/components/prompts/dto/prompt-response.dto.ts

@@ -18,14 +18,14 @@ import {
   UnsecuredDto,
   Variant,
 } from '~/common';
-import { ResourceRef } from '~/core';
+import { LinkToUnknown } from '~/core';
 import { BaseNode } from '~/core/database/results';
 import { User } from '../../user';
 import { Prompt, SecuredPrompt } from './prompt.dto';
 
 @ObjectType()
 export class PromptResponse extends Resource {
-  readonly parent: ResourceRef<any>;
+  readonly parent: LinkToUnknown;
 
   @Field()
   readonly prompt: SecuredPrompt;

src/core/resources/resource.loader.ts

@@ -13,11 +13,29 @@ import { ResourceResolver } from './resource-resolver.service';
 
 type SomeResourceType = ValueOf<ResourceMap>;
 
-export interface ResourceRef<Key extends keyof ResourceMap> {
+/**
+ * A reference to a resource with a dynamic / unknown type.
+ */
+export interface PolymorphicLinkTo<Key extends keyof ResourceMap> {
   __typename: Key;
   id: ID;
 }
 
+/**
+ * A reference to a resource with a dynamic / unknown type.
+ */
+export type LinkToUnknown = PolymorphicLinkTo<keyof ResourceMap>;
+
+/**
+ * A reference to a resource with a static / known type.
+ */
+export interface LinkTo<Key extends keyof ResourceMap> {
+  id: ID;
+  // Here for DX, and maybe type checking.
+  // Won't be used at runtime.
+  __typename?: Key;
+}
+
 @Injectable()
 export class ResourceLoader {
   constructor(
@@ -37,7 +55,7 @@ export class ResourceLoader {
   }
 
   async loadByRef<Key extends keyof ResourceMap>(
-    obj: ResourceRef<Key>,
+    obj: PolymorphicLinkTo<Key>,
     view?: ObjectView,
   ) {
     return await this.load(obj.__typename, obj.id, view);