[br3,pl3] typed API responses

browser3/src/components/LyricsViewer/LyricsViewer.tsx

@@ -23,7 +23,7 @@ export function LyricsViewer({
             (a) => a.mime === "application/json" && a.variant === variant,
         );
         if (subtitleAttachment) {
-            request({
+            request<Subtitle[]>({
                 url: attachment_path(subtitleAttachment),
                 options: { credentials: "omit" },
                 onAction: (result) => setLyrics(result),

browser3/src/hooks/api.ts

@@ -3,23 +3,23 @@ import { useCallback, useContext, useState } from "react";
 import { ClientContext } from "@/providers/client";
 import { PageContext } from "@/providers/page";
 
-type CommonRequestProps = {
+type CommonRequestProps<T = any> = {
     options?: Record<string, any>;
     notify?: string;
     notify_ok?: string;
     onProgress?: ({ done, size }: { done: number; size: number }) => void;
-    onAction?: (result: any) => void;
+    onAction?: (result: T) => void;
     onException?: () => void;
 };
-type FunctionRequestProps = CommonRequestProps & {
+type FunctionRequestProps<T = any> = CommonRequestProps<T> & {
     function: string;
     url?: never;
 };
-type UrlRequestProps = CommonRequestProps & {
+type UrlRequestProps<T = any> = CommonRequestProps<T> & {
     function?: never;
     url: string;
 };
-type ApiRequestProps = FunctionRequestProps | UrlRequestProps;
+type ApiRequestProps<T = any> = FunctionRequestProps<T> | UrlRequestProps<T>;
 
 export function useApi() {
     const { roomName } = useContext(PageContext);
@@ -32,7 +32,7 @@ export function useApi() {
     );
 
     const request = useCallback(
-        (props_: ApiRequestProps) => {
+        <T>(props_: ApiRequestProps<T>) => {
             const props = {
                 response: "json",
                 url:

browser3/src/providers/room.tsx

@@ -4,7 +4,7 @@ import { createContext, useContext, useEffect, useMemo, useState } from "react";
 
 import { useApi } from "@/hooks/api";
 import { useMemoObj } from "@/hooks/memo";
-import type { QueueItem, Settings, Track } from "@/types";
+import type { QueueItem, Settings, Track, User } from "@/types";
 import {
     current_and_future,
     get_default_settings,
@@ -84,7 +84,7 @@ export function RoomProvider(props: any) {
     }, [tracks, hiddenTags, forcedTags]);
 
     useEffect(() => {
-        request({
+        request<User>({
             function: "login",
             options: {
                 method: "POST",

browser3/src/providers/server.tsx

@@ -35,7 +35,7 @@ function InternalServerProvider(props: any) {
         setTracksUpdated(pkt.json()["tracks_json_mtime"]);
     });
     useEffect(() => {
-        request({
+        request<Record<string, Track>>({
             url: `/files/tracks.json?ver=${tracksUpdated}`,
             options: { credentials: "omit" },
             onAction: (result) => setTracks(result),

browser3/src/schemas.ts

@@ -290,11 +290,26 @@ export const LintErrorSchema = {
   }
 } as const;
 
+export const UserSchema = {
+  "type": "object",
+  "required": [
+    "is_admin"
+  ],
+  "properties": {
+    "is_admin": {
+      "type": "boolean",
+      "description": "Whether the user has admin privileges",
+      "default": false
+    }
+  }
+} as const;
+
 export const schemas = {
   Track: TrackSchema,
   Attachment: AttachmentSchema,
   Subtitle: SubtitleSchema,
   QueueItem: QueueItemSchema,
   Settings: SettingsSchema,
   LintError: LintErrorSchema,
+  User: UserSchema,
 } as const;

browser3/src/types.ts

@@ -144,6 +144,13 @@ export interface components {
             /** @description Error message */
             message: string;
         };
+        User: {
+            /**
+             * @description Whether the user has admin privileges
+             * @default false
+             */
+            is_admin: boolean;
+        };
     };
     responses: never;
     parameters: never;
@@ -157,5 +164,6 @@ export type Subtitle = components['schemas']['Subtitle'];
 export type QueueItem = components['schemas']['QueueItem'];
 export type Settings = components['schemas']['Settings'];
 export type LintError = components['schemas']['LintError'];
+export type User = components['schemas']['User'];
 export type $defs = Record<string, never>;
 export type operations = Record<string, never>;

openapi/components.yaml

@@ -229,3 +229,13 @@ components:
         message:
           type: string
           description: Error message
+
+    User:
+      type: object
+      required:
+        - is_admin
+      properties:
+        is_admin:
+          type: boolean
+          description: Whether the user has admin privileges
+          default: false

openapi/openapi-room.yaml

@@ -62,14 +62,7 @@ components:
       $ref: "./components.yaml#/components/schemas/Settings"
 
     User:
-      type: object
-      required:
-        - is_admin
-      properties:
-        is_admin:
-          type: boolean
-          description: Whether the user has admin privileges
-          default: false
+      $ref: "./components.yaml#/components/schemas/User"
 
     LoginRequest:
       type: object

player3/src/hooks/api.ts

@@ -3,23 +3,23 @@ import { useParams } from "react-router-dom";
 
 import { ClientContext } from "@/providers/client";
 
-type CommonRequestProps = {
+type CommonRequestProps<T = any> = {
     options?: Record<string, any>;
     notify?: string;
     notify_ok?: string;
     onProgress?: ({ done, size }: { done: number; size: number }) => void;
-    onAction?: (result: any) => void;
+    onAction?: (result: T) => void;
     onException?: () => void;
 };
-type FunctionRequestProps = CommonRequestProps & {
+type FunctionRequestProps<T = any> = CommonRequestProps<T> & {
     function: string;
     url?: never;
 };
-type UrlRequestProps = CommonRequestProps & {
+type UrlRequestProps<T = any> = CommonRequestProps<T> & {
     function?: never;
     url: string;
 };
-type ApiRequestProps = FunctionRequestProps | UrlRequestProps;
+type ApiRequestProps<T = any> = FunctionRequestProps<T> | UrlRequestProps<T>;
 
 export function useApi() {
     const { roomName } = useParams();
@@ -32,7 +32,7 @@ export function useApi() {
     );
 
     const request = useCallback(
-        (props_: ApiRequestProps) => {
+        <T>(props_: ApiRequestProps<T>) => {
             const props = {
                 response: "json",
                 url:

player3/src/providers/room.tsx

@@ -5,7 +5,7 @@ import { useParams } from "react-router-dom";
 
 import { useApi } from "@/hooks/api";
 import { useMemoObj } from "@/hooks/memo";
-import type { QueueItem, Settings } from "@/types";
+import type { QueueItem, Settings, User } from "@/types";
 import { current_and_future, get_default_settings } from "@/utils";
 import { ClientContext } from "./client";
 
@@ -53,7 +53,7 @@ export function RoomProvider(props: any) {
     });
 
     useEffect(() => {
-        request({
+        request<User>({
             function: "login",
             options: {
                 method: "POST",

player3/src/providers/server.tsx

@@ -36,7 +36,7 @@ function InternalServerProvider(props: any) {
         setTracksUpdated(pkt.json()["tracks_json_mtime"]);
     });
     useEffect(() => {
-        request({
+        request<Record<string, Track>>({
             url: `/files/tracks.json?ver=${tracksUpdated}`,
             options: { credentials: "omit" },
             onAction: (result) => setTracks(result),

player3/src/schemas.ts

@@ -290,11 +290,26 @@ export const LintErrorSchema = {
   }
 } as const;
 
+export const UserSchema = {
+  "type": "object",
+  "required": [
+    "is_admin"
+  ],
+  "properties": {
+    "is_admin": {
+      "type": "boolean",
+      "description": "Whether the user has admin privileges",
+      "default": false
+    }
+  }
+} as const;
+
 export const schemas = {
   Track: TrackSchema,
   Attachment: AttachmentSchema,
   Subtitle: SubtitleSchema,
   QueueItem: QueueItemSchema,
   Settings: SettingsSchema,
   LintError: LintErrorSchema,
+  User: UserSchema,
 } as const;

player3/src/screens/podium/podium.tsx

@@ -86,7 +86,7 @@ function PodiumLyrics({
                 a.variant === queue_item.subtitle_variant,
         );
         if (subtitleAttachment) {
-            request({
+            request<Subtitle[]>({
                 url: attachment_path(subtitleAttachment),
                 options: { credentials: "omit" },
                 onAction: (result) => setLyrics(add_dot_dot_dots(result)),

player3/src/types.ts

@@ -144,6 +144,13 @@ export interface components {
             /** @description Error message */
             message: string;
         };
+        User: {
+            /**
+             * @description Whether the user has admin privileges
+             * @default false
+             */
+            is_admin: boolean;
+        };
     };
     responses: never;
     parameters: never;
@@ -157,5 +164,6 @@ export type Subtitle = components['schemas']['Subtitle'];
 export type QueueItem = components['schemas']['QueueItem'];
 export type Settings = components['schemas']['Settings'];
 export type LintError = components['schemas']['LintError'];
+export type User = components['schemas']['User'];
 export type $defs = Record<string, never>;
 export type operations = Record<string, never>;

processmedia3/pm3/lib/types.py

@@ -46,6 +46,10 @@ class LintError(TypedDict):
     message: str
 
 
+class User(TypedDict):
+    is_admin: bool
+
+
 class Attachments(TypedDict):
     video: list[Attachment]
     image: list[Attachment]