Stronger actor association typing in AP functions

7 files changed, 41 insertions, 2 deletions

diff --git a/server/typings/activitypub-processor.model.ts b/server/typings/activitypub-processor.model.ts
index 7c70251ca..37b2859de 100644
--- a/server/typings/activitypub-processor.model.ts
+++ b/server/typings/activitypub-processor.model.ts
@@ -1,9 +1,10 @@
 import { Activity } from '../../shared/models/activitypub'
 import { ActorModel } from '../models/activitypub/actor'
+import { SignatureActorModel } from './models'
 
 export type APProcessorOptions<T extends Activity> = {
   activity: T
-  byActor: ActorModel
+  byActor: SignatureActorModel
   inboxActor?: ActorModel
   fromFetch?: boolean
 }
diff --git a/server/typings/express.ts b/server/typings/express.ts
index 3bffc1e9a..f7da55ab0 100644
--- a/server/typings/express.ts
+++ b/server/typings/express.ts
@@ -22,6 +22,7 @@ import { VideoCaptionModel } from '../models/video/video-caption'
 import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
 import { RegisteredPlugin } from '../lib/plugins/plugin-manager'
 import { PluginModel } from '../models/server/plugin'
+import { SignatureActorModel } from './models'
 
 declare module 'express' {
 
@@ -75,7 +76,7 @@ declare module 'express' {
       }
 
       signature?: {
-        actor: ActorModel
+        actor: SignatureActorModel
       }
 
       authenticated?: boolean
diff --git a/server/typings/models/actor-follow.ts b/server/typings/models/actor-follow.ts
new file mode 100644
index 000000000..952ef877b
--- /dev/null
+++ b/server/typings/models/actor-follow.ts
@@ -0,0 +1,8 @@
+import { ActorFollowModel } from '../../models/activitypub/actor-follow'
+import { ActorModelOnly } from './actor'
+
+export type ActorFollowModelOnly = Omit<ActorFollowModel, 'ActorFollower' | 'ActorFollowing'>
+export type ActorFollowModelLight = ActorFollowModelOnly & {
+  ActorFollower: ActorModelOnly
+  ActorFollowing: ActorModelOnly
+}
diff --git a/server/typings/models/actor.ts b/server/typings/models/actor.ts
new file mode 100644
index 000000000..2656c7b66
--- /dev/null
+++ b/server/typings/models/actor.ts
@@ -0,0 +1,22 @@
+import { ActorModel } from '../../models/activitypub/actor'
+import { VideoChannelModel } from '../../models/video/video-channel'
+import { AccountModel } from '../../models/account/account'
+import { FunctionProperties } from '../utils'
+
+export type VideoChannelModelId = FunctionProperties<VideoChannelModel>
+export type AccountModelId = FunctionProperties<AccountModel> | Pick<AccountModel, 'id'>
+
+export type VideoChannelModelIdActor = VideoChannelModelId & Pick<VideoChannelModel, 'Actor'>
+export type AccountModelIdActor = AccountModelId & Pick<AccountModel, 'Actor'>
+
+export type ActorModelUrl = Pick<ActorModel, 'url'>
+export type ActorModelOnly = Omit<ActorModel, 'Account' | 'VideoChannel' | 'ActorFollowing' | 'Avatar' | 'ActorFollowers' | 'Server'>
+export type ActorModelId = Pick<ActorModelOnly, 'id'>
+
+export type SignatureActorModel = ActorModelOnly & {
+  VideoChannel: VideoChannelModelIdActor
+
+  Account: AccountModelIdActor
+}
+
+export type ActorFollowerException = Pick<ActorModel, 'sharedInboxUrl' | 'inboxUrl'>
diff --git a/server/typings/models/index.d.ts b/server/typings/models/index.d.ts
new file mode 100644
index 000000000..c90656965
--- /dev/null
+++ b/server/typings/models/index.d.ts
@@ -0,0 +1 @@
+export * from './actor'
diff --git a/server/typings/models/video-share.ts b/server/typings/models/video-share.ts
new file mode 100644
index 000000000..1406749d2
--- /dev/null
+++ b/server/typings/models/video-share.ts
@@ -0,0 +1,3 @@
+import { VideoShareModel } from '../../models/video/video-share'
+
+export type VideoShareModelOnly = Omit<VideoShareModel, 'Actor' | 'Video'>
diff --git a/server/typings/utils.ts b/server/typings/utils.ts
new file mode 100644
index 000000000..a86b05be2
--- /dev/null
+++ b/server/typings/utils.ts
@@ -0,0 +1,3 @@
+export type FunctionPropertyNames<T> = { [K in keyof T]: T[K] extends Function ? K : never }[keyof T]
+
+export type FunctionProperties<T> = Pick<T, FunctionPropertyNames<T>>