add lyrics field

Schlauer-Hax · Schlauer-Hax · commit ca4502d2fb64 · 2025-11-15T18:31:18.000+01:00
diff --git a/pages/music/validator.ts b/pages/music/validator.ts
@@ -2,6 +2,7 @@ import { sumOf } from "@std/collections/sum-of";
 import { PriFeaArtist, ProWriArtist } from "shared/helper.ts";
 import { z } from "zod";
 import { ArtistRef, zArtistRef, zSong } from "../../spec/mod.ts";
+import { formatTimedLyrics } from "./views/table.ts";
 
 const pageOne = z.object({
     title: z.string().min(1, { message: "Title is required" }).max(100, { message: "Title is too long" }),
@@ -57,10 +58,12 @@ export const pageThree = pageTwo.and(z.object({
         .refine((songs) => songs.every(({ artists }) => artists.filter<ProWriArtist>((artist): artist is ProWriArtist => artist.type === "SONGWRITER").every(({ name }) => name.split(" ").length > 1)), { message: "Songwriters must have a first and last name" })
         .refine((songs) => songs.every(({ artists }) => artists.filter<ProWriArtist>((artist): artist is ProWriArtist => artist.type === "PRODUCER").every(({ name }) => name.split(" ").length > 1)), { message: "Producers must have a first and last name" })
         .refine((songs) => songs.every(({ artists }) => artists.filter<ProWriArtist>((artist): artist is ProWriArtist => artist.type === "SONGWRITER").every(({ name }, index, arr) => arr.findIndex((y) => y.name === name) === index)), { message: "Duplicate Songwriter" })
-        .refine((songs) => songs.every(({ artists }) => artists.filter<ProWriArtist>((artist): artist is ProWriArtist => artist.type === "PRODUCER").every(({ name }, index, arr) => arr.findIndex((y) => y.name === name) === index)), { message: "Duplicate Producer" }),
+        .refine((songs) => songs.every(({ artists }) => artists.filter<ProWriArtist>((artist): artist is ProWriArtist => artist.type === "PRODUCER").every(({ name }, index, arr) => arr.findIndex((y) => y.name === name) === index)), { message: "Duplicate Producer" })
+        .refine((songs) => songs.every(({ lyrics, timedLyrics }) => timedLyrics ? !!lyrics : true), { message: "Lyrics must be provided when Timed Lyrics are specified" })
+        .refine((songs) => songs.every(({ timedLyrics }) => timedLyrics ? formatTimedLyrics(timedLyrics) === timedLyrics : true), { message: "Timed Lyrics are not properly formatted" }),
     uploadingSongs: z.array(z.string()).max(0, { message: "Some uploads are still in progress" }),
 }))
     .refine((object) => (object.songs.length === 1 && object.songs[0].title === object.title) || object.songs.length > 1, { message: "Drop Title and Song Title must be the same for single song drops", path: ["songs"] })
-    .refine((object) => (object.songs.length === 1 && object.songs[ 0 ].artists.length === object.artists.length && object.artists.map(normalize).toSorted().every((v, i) => v === object.songs[ 0 ].artists.map(normalize).toSorted()[ i ]) || object.songs.length > 1), { message: "All artists must be the same for single song drops", path: [ "songs" ] })
+    .refine((object) => (object.songs.length === 1 && object.songs[0].artists.length === object.artists.length && object.artists.map(normalize).toSorted().every((v, i) => v === object.songs[0].artists.map(normalize).toSorted()[i]) || object.songs.length > 1), { message: "All artists must be the same for single song drops", path: ["songs"] })
     .refine((object) => (object.songs.length === 1 && object.songs[0].secondaryGenre === object.secondaryGenre) || object.songs.length > 1, { message: "Drop Secondary Genre and Song Secondary Genre must be the same for single song drops", path: ["songs", "secondaryGenre"] });
-export const pages = <z.AnyZodObject[]> [pageOne, pageTwo, pageThree];
+export const pages = <z.ZodObject[]> [pageOne, pageTwo, pageThree];
diff --git a/pages/music/views/table.ts b/pages/music/views/table.ts
@@ -1,7 +1,7 @@
 import { Audio } from "shared/audio.ts";
-import { allowedAudioFormats, ExistingSongDialog, saveBlob, sheetStack } from "shared/helper.ts";
+import { allowedAudioFormats, ErrorMessage, ExistingSongDialog, saveBlob, sheetStack } from "shared/helper.ts";
 import { placeholder } from "shared/list.ts";
-import { asRef, asRefRecord, Box, Checkbox, createFilePicker, DropDown, Empty, Entry, Grid, Label, List, MaterialIcon, PrimaryButton, ref, RefRecord, SecondaryButton, SheetHeader, TextInput, WriteSignal } from "webgen/mod.ts";
+import { asRef, asRefRecord, Box, Checkbox, createFilePicker, DropDown, Empty, Entry, Grid, Label, List, MaterialIcon, PrimaryButton, ref, RefRecord, SecondaryButton, SheetHeader, TextAreaInput, TextInput, WriteSignal } from "webgen/mod.ts";
 import countries from "../../../data/countries.json" with { type: "json" };
 import genres from "../../../data/genres.json" with { type: "json" };
 import languages from "../../../data/language.json" with { type: "json" };
@@ -39,6 +39,50 @@ const songSheet = (song: RefRecord<Song>, save: (song: RefRecord<Song>) => void,
                 ).setTemplateColumns("max-content max-content").setGap().setJustifyItems("center"),
                 TextInput(song.isrc ?? asRef(""), "ISRC (optional)").setDisabled(disabled),
             ).setGap().setDynamicColumns(15),
+            SecondaryButton("Lyrics").setDisabled(song.instrumental).onClick(() => {
+                if (song.lyrics === undefined) {
+                    song.lyrics = asRef("");
+                }
+                if (song.timedLyrics === undefined) {
+                    song.timedLyrics = asRef("");
+                }
+                const errorState = asRef<string | undefined>(undefined);
+                sheetStack.addSheet(
+                    Grid(
+                        SheetHeader("Edit Lyrics", sheetStack),
+                        TextAreaInput(song.lyrics ?? asRef(""), "Lyrics", "change").setDisabled(disabled),
+                        TextAreaInput(song.timedLyrics ?? asRef(""), "Optional Timed Lyrics (LRC Format)", "change").setDisabled(disabled),
+                        ErrorMessage(errorState),
+                        SecondaryButton("Format Timed Lyrics").onClick(() => {
+                            if (song.timedLyrics?.value === "" || song.timedLyrics?.value === undefined) return;
+                            const formatted = formatTimedLyrics(song.timedLyrics.value);
+                            if (formatted === null) {
+                                errorState.setValue("Timed lyrics format is incorrect.");
+                            } else {
+                                song.timedLyrics.set(formatted);
+                                errorState.setValue(undefined);
+                            }
+                        }),
+                        PrimaryButton("Save").setDisabled(disabled).onClick(() => {
+                            if (!(song.timedLyrics?.value === "" || song.timedLyrics?.value === undefined)) {
+                                const formatted = formatTimedLyrics(song.timedLyrics.value);
+                                if (formatted === null) {
+                                    song.timedLyrics.set("");
+                                } else {
+                                    song.timedLyrics.set(formatted);
+                                }
+                            }
+                            if (song.lyrics?.value === "") {
+                                song.lyrics = undefined;
+                            }
+                            if (song.timedLyrics?.value === "") {
+                                song.timedLyrics = undefined;
+                            }
+                            sheetStack.removeOne();
+                        }),
+                    ).setGap(),
+                );
+            }),
             Box(blobRef.map((blob) =>
                 blob === undefined
                     ? SecondaryButton("Listen to Song").onClick(() => {
@@ -66,6 +110,16 @@ const songSheet = (song: RefRecord<Song>, save: (song: RefRecord<Song>) => void,
     ).setGap();
 };
 
+export function formatTimedLyrics(lyrics: string): string | null {
+    const regex = /\[([0-9]{1}|[0-9]{2})\:[0-9]{2}(\.[0-9]{2})?\]([\w:\s]+)/gm;
+    const matches = lyrics.match(regex);
+    if (matches === null) {
+        return null;
+    } else {
+        return matches.join("");
+    }
+}
+
 export function ManageSongs(songs: WriteSignal<Song[]>, id: string, provided: WriteSignal<Artist[] | undefined>, disabled: WriteSignal<boolean> = asRef(false)) {
     function SongEntry(song: RefRecord<Song>) {
         return Grid(
diff --git a/spec/gen/types.gen.ts b/spec/gen/types.gen.ts
@@ -104,6 +104,8 @@ export type Song = {
     explicit: boolean;
     instrumental: boolean;
     file: string;
+    lyrics?: string;
+    timedLyrics?: string;
 };
 
 export type Drop = {
@@ -393,6 +395,8 @@ export type SingleAdminDrop = {
         explicit: boolean;
         instrumental: boolean;
         file: string;
+        lyrics?: string;
+        timedLyrics?: string;
         filename: string;
     }>;
     comments?: string;
@@ -520,6 +524,8 @@ export type SearchReturn = ({
         explicit?: boolean;
         instrumental?: boolean;
         file?: string;
+        lyrics?: string;
+        timedLyrics?: string;
     };
 } | {
     _index: 'users';
@@ -588,6 +594,8 @@ export type UpdateDrop = {
         language: string;
         explicit: boolean;
         instrumental: boolean;
+        lyrics?: string;
+        timedLyrics?: string;
     }>;
     comments?: string;
     type?: DropType;
@@ -654,6 +662,8 @@ export type GetIdByDropsByAdminResponses = {
             explicit: boolean;
             instrumental: boolean;
             file: string;
+            lyrics?: string;
+            timedLyrics?: string;
             filename: string;
         }>;
         comments?: string;
@@ -1170,6 +1180,8 @@ export type PostDropByDropsByMusicResponses = {
         explicit: boolean;
         instrumental: boolean;
         file: string;
+        lyrics?: string;
+        timedLyrics?: string;
     };
 };
 
@@ -1262,6 +1274,8 @@ export type PatchIdByDropsByMusicData = {
             language: string;
             explicit: boolean;
             instrumental: boolean;
+            lyrics?: string;
+            timedLyrics?: string;
         }>;
         comments?: string;
         type?: DropType;
@@ -1436,6 +1450,8 @@ export type PostSongsByMusicData = {
         explicit: boolean;
         instrumental: boolean;
         file: string;
+        lyrics?: string;
+        timedLyrics?: string;
     };
     path?: never;
     query?: never;
@@ -1480,6 +1496,8 @@ export type GetIdBySongsByMusicResponses = {
         explicit: boolean;
         instrumental: boolean;
         file: string;
+        lyrics?: string;
+        timedLyrics?: string;
     };
 };
 
diff --git a/spec/gen/zod.gen.ts b/spec/gen/zod.gen.ts
@@ -150,7 +150,9 @@ export const zSong = z.object({
     language: z.string(),
     explicit: z.boolean(),
     instrumental: z.boolean(),
-    file: z.string()
+    file: z.string(),
+    lyrics: z.optional(z.string()),
+    timedLyrics: z.optional(z.string())
 });
 
 export const zDrop = z.object({
@@ -478,6 +480,8 @@ export const zSingleAdminDrop = z.object({
         explicit: z.boolean(),
         instrumental: z.boolean(),
         file: z.string(),
+        lyrics: z.optional(z.string()),
+        timedLyrics: z.optional(z.string()),
         filename: z.string()
     }))),
     comments: z.optional(z.string()),
@@ -627,7 +631,9 @@ export const zSearchReturn = z.intersection(z.union([
             language: z.optional(z.string()),
             explicit: z.optional(z.boolean()),
             instrumental: z.optional(z.boolean()),
-            file: z.optional(z.string())
+            file: z.optional(z.string()),
+            lyrics: z.optional(z.string()),
+            timedLyrics: z.optional(z.string())
         })
     }),
     z.object({
@@ -705,7 +711,9 @@ export const zUpdateDrop = z.object({
         country: z.optional(z.string()),
         language: z.string(),
         explicit: z.boolean(),
-        instrumental: z.boolean()
+        instrumental: z.boolean(),
+        lyrics: z.optional(z.string()),
+        timedLyrics: z.optional(z.string())
     }))),
     comments: z.optional(z.string()),
     type: z.optional(zDropType)
@@ -765,6 +773,8 @@ export const zGetIdByDropsByAdminResponse = z.object({
         explicit: z.boolean(),
         instrumental: z.boolean(),
         file: z.string(),
+        lyrics: z.optional(z.string()),
+        timedLyrics: z.optional(z.string()),
         filename: z.string()
     }))),
     comments: z.optional(z.string()),
@@ -1199,7 +1209,9 @@ export const zPostDropByDropsByMusicResponse = z.object({
     language: z.string(),
     explicit: z.boolean(),
     instrumental: z.boolean(),
-    file: z.string()
+    file: z.string(),
+    lyrics: z.optional(z.string()),
+    timedLyrics: z.optional(z.string())
 });
 
 export const zGetDownloadByDropByDropsByMusicData = z.object({
@@ -1277,7 +1289,9 @@ export const zPatchIdByDropsByMusicData = z.object({
             country: z.optional(z.string()),
             language: z.string(),
             explicit: z.boolean(),
-            instrumental: z.boolean()
+            instrumental: z.boolean(),
+            lyrics: z.optional(z.string()),
+            timedLyrics: z.optional(z.string())
         }))),
         comments: z.optional(z.string()),
         type: z.optional(zDropType)
@@ -1414,7 +1428,9 @@ export const zPostSongsByMusicData = z.object({
         language: z.string(),
         explicit: z.boolean(),
         instrumental: z.boolean(),
-        file: z.string()
+        file: z.string(),
+        lyrics: z.optional(z.string()),
+        timedLyrics: z.optional(z.string())
     })),
     path: z.optional(z.never()),
     query: z.optional(z.any())
@@ -1451,7 +1467,9 @@ export const zGetIdBySongsByMusicResponse = z.object({
     language: z.string(),
     explicit: z.boolean(),
     instrumental: z.boolean(),
-    file: z.string()
+    file: z.string(),
+    lyrics: z.optional(z.string()),
+    timedLyrics: z.optional(z.string())
 });
 
 export const zGetDownloadBySongBySongsByMusicData = z.object({
