create track queue, add types to api views, clean up model types

ufosc · Sep 13, 2024 · 72d7204 · 72d7204
1 parent 8534281
commit 72d7204
Show file tree

Hide file tree

Showing 27 changed files with 1,031 additions and 757 deletions.
diff --git a/docs/conventions.md b/docs/conventions.md
@@ -0,0 +1,10 @@
+# Project Conventions
+
+## Objects, Models, Schemas
+
+When handling objects in typescript, often it is useful to know if the object represents minimum fields required for creation, or the full list of fields given from the model serialization process. When differentiating between the two, stick with this convention:
+
+For some model named `Model`,
+
+- Use `IModel` to describe all possible fields, including the ID field
+- Use `IModelFields` to describe fields needed when creating the model.
diff --git a/server/controllers/groupController.ts b/server/controllers/groupController.ts
@@ -28,11 +28,19 @@ export const assignSpotifyToGroup = async (
   return group
 }
 
-export const getGroupSpotify = async (groupId: string) => {
+export const getGroupSpotifyAuth = async (groupId) => {
   const group = await getOrError(groupId, Group)
+  const auth = await getOrError(group.spotifyAuthId?.toString() ?? '', SpotifyAuth)
+
+  return auth
+}
+
+export const getGroupSpotify = async (groupId: string) => {
+  const auth = await getGroupSpotifyAuth(groupId)
+  // const group = await getOrError(groupId, Group)
 
-  const auth = await SpotifyAuth.findById(group.spotifyAuthId)
-  if (!auth) throw new Error(`No linked Spotify accounts for group ${group.name}.`)
+  // const auth = await SpotifyAuth.findById(group.spotifyAuthId)
+  // if (!auth) throw new Error(`No linked Spotify accounts for group ${group.name}.`)
 
   return SpotifyService.connect(auth.spotifyEmail)
 }

diff --git a/server/controllers/index.ts b/server/controllers/index.ts
@@ -1 +1,2 @@
+export * from './groupController'
 export * from './userController'
diff --git a/server/controllers/jamController.ts b/server/controllers/jamController.ts
diff --git a/server/docs/swagger.ts b/server/docs/swagger.ts
@@ -1,5 +1,5 @@
 import { BASE_URL } from 'server/config'
-import type { IGroup } from 'server/models'
+import type { IGroup, IGroupFields } from 'server/models'
 import { ResponseCodes, formatJsonResponse } from 'server/utils'
 import swaggerAutogen from 'swagger-autogen'
 
@@ -43,7 +43,8 @@ const doc = {
     }
   },
   definitions: {
-    Group: { name: '', ownerId: '' } as IGroup
+    IGroupFields: { name: '', ownerId: '' } as IGroupFields,
+    IGroup: { id: '', name: '', ownerId: '' } as IGroup
   }
 }
 const generateResponseDocs = () => {
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		export * from './groupController'
		export * from './userController'