v1 feature: added playlists

api/model/interfaces.ts

@@ -141,6 +141,74 @@ export class APIException extends Error {
   }
 }
 
+/**
+ * Playlists
+ */
+
+export interface Playlist {
+  id: string;
+  userId: string;
+  title: string;
+  description?: string;
+  isPublic: boolean;
+  createdAt: Date;
+  imageMime?: string;
+  dumpCount?: number;
+}
+
+export interface PlaylistWithDumps extends Playlist {
+  dumps: Dump[];
+}
+
+export interface PlaylistMembership {
+  playlist: Playlist;
+  hasDump: boolean;
+}
+
+export interface CreatePlaylistRequest {
+  title: string;
+  description?: string;
+  isPublic: boolean;
+}
+
+export interface UpdatePlaylistRequest {
+  title?: string;
+  description?: string;
+  isPublic?: boolean;
+}
+
+export interface ReorderPlaylistRequest {
+  dumpIds: string[];
+}
+
+export function isCreatePlaylistRequest(
+  obj: unknown,
+): obj is CreatePlaylistRequest {
+  return !!obj && typeof obj === "object" &&
+    "title" in obj && typeof obj.title === "string" &&
+    (!("description" in obj) || typeof obj.description === "string" ||
+      obj.description === null) &&
+    "isPublic" in obj && typeof obj.isPublic === "boolean";
+}
+
+export function isUpdatePlaylistRequest(
+  obj: unknown,
+): obj is UpdatePlaylistRequest {
+  return !!obj && typeof obj === "object" &&
+    (!("title" in obj) || typeof obj.title === "string") &&
+    (!("description" in obj) || typeof obj.description === "string" ||
+      obj.description === null) &&
+    (!("isPublic" in obj) || typeof obj.isPublic === "boolean");
+}
+
+export function isReorderPlaylistRequest(
+  obj: unknown,
+): obj is ReorderPlaylistRequest {
+  return !!obj && typeof obj === "object" &&
+    "dumpIds" in obj && Array.isArray(obj.dumpIds) &&
+    (obj.dumpIds as unknown[]).every((id) => typeof id === "string");
+}
+
 /**
  * Request DTOs
  */