Begin auth plugin support

1 files changed, 33 insertions, 0 deletions

diff --git a/shared/models/plugins/register-server-auth.model.ts b/shared/models/plugins/register-server-auth.model.ts
new file mode 100644
index 000000000..34ebbe712
--- /dev/null
+++ b/shared/models/plugins/register-server-auth.model.ts
@@ -0,0 +1,33 @@
+import { UserRole } from '@shared/models'
+
+export type RegisterServerAuthOptions = RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions
+
+export interface RegisterServerAuthPassOptions {
+  type: 'id-and-pass'
+
+  onLogout?: Function
+
+  getWeight(): number
+
+  // Used by PeerTube to login a user
+  // Returns null if the login failed, or { username, email } on success
+  login(body: {
+    id: string
+    password: string
+  }): Promise<{
+    username: string
+    email: string
+    role?: UserRole
+    displayName?: string
+  } | null>
+}
+
+export interface RegisterServerAuthExternalOptions {
+  type: 'external'
+
+  onLogout?: Function
+}
+
+export interface RegisterServerAuthExternalResult {
+  onAuth (options: { username: string, email: string }): void
+}