@darco2903/altv-web-api 1.1.0 → 1.3.0

package/dist/contract/mediaStream.d.ts

@@ -172,22 +172,156 @@ declare const _default: {
                 startTime: z.ZodNumber;
                 /** seconds */
                 duration: z.ZodNumber;
+                /** seconds, media position when the response was sent */
+                currentTime: z.ZodNumber;
                 url: z.ZodString;
                 paused: z.ZodBoolean;
+                scene: z.ZodObject<{
+                    speakers: z.ZodArray<z.ZodObject<{
+                        id: z.ZodString;
+                        x: z.ZodNumber;
+                        y: z.ZodNumber;
+                        z: z.ZodNumber;
+                        yaw: z.ZodNumber;
+                        pitch: z.ZodNumber;
+                        directional: z.ZodBoolean;
+                    }, "strip", z.ZodTypeAny, {
+                        id: string;
+                        x: number;
+                        y: number;
+                        z: number;
+                        yaw: number;
+                        pitch: number;
+                        directional: boolean;
+                    }, {
+                        id: string;
+                        x: number;
+                        y: number;
+                        z: number;
+                        yaw: number;
+                        pitch: number;
+                        directional: boolean;
+                    }>, "many">;
+                    cars: z.ZodArray<z.ZodObject<{
+                        id: z.ZodString;
+                        x: z.ZodNumber;
+                        z: z.ZodNumber;
+                        yaw: z.ZodNumber;
+                        doors: z.ZodArray<z.ZodBoolean, "many">;
+                        windows: z.ZodArray<z.ZodBoolean, "many">;
+                        radio: z.ZodBoolean;
+                    }, "strip", z.ZodTypeAny, {
+                        id: string;
+                        x: number;
+                        z: number;
+                        yaw: number;
+                        doors: boolean[];
+                        windows: boolean[];
+                        radio: boolean;
+                    }, {
+                        id: string;
+                        x: number;
+                        z: number;
+                        yaw: number;
+                        doors: boolean[];
+                        windows: boolean[];
+                        radio: boolean;
+                    }>, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    speakers: {
+                        id: string;
+                        x: number;
+                        y: number;
+                        z: number;
+                        yaw: number;
+                        pitch: number;
+                        directional: boolean;
+                    }[];
+                    cars: {
+                        id: string;
+                        x: number;
+                        z: number;
+                        yaw: number;
+                        doors: boolean[];
+                        windows: boolean[];
+                        radio: boolean;
+                    }[];
+                }, {
+                    speakers: {
+                        id: string;
+                        x: number;
+                        y: number;
+                        z: number;
+                        yaw: number;
+                        pitch: number;
+                        directional: boolean;
+                    }[];
+                    cars: {
+                        id: string;
+                        x: number;
+                        z: number;
+                        yaw: number;
+                        doors: boolean[];
+                        windows: boolean[];
+                        radio: boolean;
+                    }[];
+                }>;
             }, "strip", z.ZodTypeAny, {
                 streamId: string;
                 title: string;
                 startTime: number;
                 duration: number;
+                currentTime: number;
                 url: string;
                 paused: boolean;
+                scene: {
+                    speakers: {
+                        id: string;
+                        x: number;
+                        y: number;
+                        z: number;
+                        yaw: number;
+                        pitch: number;
+                        directional: boolean;
+                    }[];
+                    cars: {
+                        id: string;
+                        x: number;
+                        z: number;
+                        yaw: number;
+                        doors: boolean[];
+                        windows: boolean[];
+                        radio: boolean;
+                    }[];
+                };
             }, {
                 streamId: string;
                 title: string;
                 startTime: number;
                 duration: number;
+                currentTime: number;
                 url: string;
                 paused: boolean;
+                scene: {
+                    speakers: {
+                        id: string;
+                        x: number;
+                        y: number;
+                        z: number;
+                        yaw: number;
+                        pitch: number;
+                        directional: boolean;
+                    }[];
+                    cars: {
+                        id: string;
+                        x: number;
+                        z: number;
+                        yaw: number;
+                        doors: boolean[];
+                        windows: boolean[];
+                        radio: boolean;
+                    }[];
+                };
             }>;
             400: z.ZodUnion<[z.ZodObject<{
                 name: z.ZodLiteral<"ZodError">;
@@ -824,6 +958,315 @@ declare const _default: {
             }>;
         };
     };
+    scene: {
+        description: "Change the scene of a media stream, listeners get the new scene through the mediaStreamScene socket event";
+        method: "POST";
+        body: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"addSpeaker">;
+            speaker: z.ZodObject<Omit<{
+                id: z.ZodString;
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+                yaw: z.ZodNumber;
+                pitch: z.ZodNumber;
+                directional: z.ZodBoolean;
+            }, "id">, "strip", z.ZodTypeAny, {
+                x: number;
+                y: number;
+                z: number;
+                yaw: number;
+                pitch: number;
+                directional: boolean;
+            }, {
+                x: number;
+                y: number;
+                z: number;
+                yaw: number;
+                pitch: number;
+                directional: boolean;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            type: "addSpeaker";
+            speaker: {
+                x: number;
+                y: number;
+                z: number;
+                yaw: number;
+                pitch: number;
+                directional: boolean;
+            };
+        }, {
+            type: "addSpeaker";
+            speaker: {
+                x: number;
+                y: number;
+                z: number;
+                yaw: number;
+                pitch: number;
+                directional: boolean;
+            };
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"addCar">;
+            car: z.ZodObject<Pick<{
+                id: z.ZodString;
+                x: z.ZodNumber;
+                z: z.ZodNumber;
+                yaw: z.ZodNumber;
+                doors: z.ZodArray<z.ZodBoolean, "many">;
+                windows: z.ZodArray<z.ZodBoolean, "many">;
+                radio: z.ZodBoolean;
+            }, "x" | "z" | "yaw">, "strip", z.ZodTypeAny, {
+                x: number;
+                z: number;
+                yaw: number;
+            }, {
+                x: number;
+                z: number;
+                yaw: number;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            type: "addCar";
+            car: {
+                x: number;
+                z: number;
+                yaw: number;
+            };
+        }, {
+            type: "addCar";
+            car: {
+                x: number;
+                z: number;
+                yaw: number;
+            };
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"remove">;
+            id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "remove";
+            id: string;
+        }, {
+            type: "remove";
+            id: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"carDoor">;
+            id: z.ZodString;
+            index: z.ZodNumber;
+            open: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            type: "carDoor";
+            id: string;
+            index: number;
+            open: boolean;
+        }, {
+            type: "carDoor";
+            id: string;
+            index: number;
+            open: boolean;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"carWindow">;
+            id: z.ZodString;
+            index: z.ZodNumber;
+            open: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            type: "carWindow";
+            id: string;
+            index: number;
+            open: boolean;
+        }, {
+            type: "carWindow";
+            id: string;
+            index: number;
+            open: boolean;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"carRadio">;
+            id: z.ZodString;
+            on: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            type: "carRadio";
+            id: string;
+            on: boolean;
+        }, {
+            type: "carRadio";
+            id: string;
+            on: boolean;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"reset">;
+        }, "strip", z.ZodTypeAny, {
+            type: "reset";
+        }, {
+            type: "reset";
+        }>]>;
+        path: "/media-stream/scene/:streamId";
+        responses: {
+            200: typeof import("@ts-rest/core").ContractNoBody;
+            400: z.ZodUnion<[z.ZodObject<{
+                name: z.ZodLiteral<"ZodError">;
+                issues: z.ZodArray<z.ZodObject<{
+                    path: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
+                    message: z.ZodOptional<z.ZodString>;
+                    code: z.ZodNativeEnum<{
+                        invalid_type: "invalid_type";
+                        invalid_literal: "invalid_literal";
+                        custom: "custom";
+                        invalid_union: "invalid_union";
+                        invalid_union_discriminator: "invalid_union_discriminator";
+                        invalid_enum_value: "invalid_enum_value";
+                        unrecognized_keys: "unrecognized_keys";
+                        invalid_arguments: "invalid_arguments";
+                        invalid_return_type: "invalid_return_type";
+                        invalid_date: "invalid_date";
+                        invalid_string: "invalid_string";
+                        too_small: "too_small";
+                        too_big: "too_big";
+                        invalid_intersection_types: "invalid_intersection_types";
+                        not_multiple_of: "not_multiple_of";
+                        not_finite: "not_finite";
+                    }>;
+                }, "strip", z.ZodAny, z.objectOutputType<{
+                    path: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
+                    message: z.ZodOptional<z.ZodString>;
+                    code: z.ZodNativeEnum<{
+                        invalid_type: "invalid_type";
+                        invalid_literal: "invalid_literal";
+                        custom: "custom";
+                        invalid_union: "invalid_union";
+                        invalid_union_discriminator: "invalid_union_discriminator";
+                        invalid_enum_value: "invalid_enum_value";
+                        unrecognized_keys: "unrecognized_keys";
+                        invalid_arguments: "invalid_arguments";
+                        invalid_return_type: "invalid_return_type";
+                        invalid_date: "invalid_date";
+                        invalid_string: "invalid_string";
+                        too_small: "too_small";
+                        too_big: "too_big";
+                        invalid_intersection_types: "invalid_intersection_types";
+                        not_multiple_of: "not_multiple_of";
+                        not_finite: "not_finite";
+                    }>;
+                }, z.ZodAny, "strip">, z.objectInputType<{
+                    path: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
+                    message: z.ZodOptional<z.ZodString>;
+                    code: z.ZodNativeEnum<{
+                        invalid_type: "invalid_type";
+                        invalid_literal: "invalid_literal";
+                        custom: "custom";
+                        invalid_union: "invalid_union";
+                        invalid_union_discriminator: "invalid_union_discriminator";
+                        invalid_enum_value: "invalid_enum_value";
+                        unrecognized_keys: "unrecognized_keys";
+                        invalid_arguments: "invalid_arguments";
+                        invalid_return_type: "invalid_return_type";
+                        invalid_date: "invalid_date";
+                        invalid_string: "invalid_string";
+                        too_small: "too_small";
+                        too_big: "too_big";
+                        invalid_intersection_types: "invalid_intersection_types";
+                        not_multiple_of: "not_multiple_of";
+                        not_finite: "not_finite";
+                    }>;
+                }, z.ZodAny, "strip">>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                name: "ZodError";
+                issues: z.objectOutputType<{
+                    path: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
+                    message: z.ZodOptional<z.ZodString>;
+                    code: z.ZodNativeEnum<{
+                        invalid_type: "invalid_type";
+                        invalid_literal: "invalid_literal";
+                        custom: "custom";
+                        invalid_union: "invalid_union";
+                        invalid_union_discriminator: "invalid_union_discriminator";
+                        invalid_enum_value: "invalid_enum_value";
+                        unrecognized_keys: "unrecognized_keys";
+                        invalid_arguments: "invalid_arguments";
+                        invalid_return_type: "invalid_return_type";
+                        invalid_date: "invalid_date";
+                        invalid_string: "invalid_string";
+                        too_small: "too_small";
+                        too_big: "too_big";
+                        invalid_intersection_types: "invalid_intersection_types";
+                        not_multiple_of: "not_multiple_of";
+                        not_finite: "not_finite";
+                    }>;
+                }, z.ZodAny, "strip">[];
+            }, {
+                name: "ZodError";
+                issues: z.objectInputType<{
+                    path: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
+                    message: z.ZodOptional<z.ZodString>;
+                    code: z.ZodNativeEnum<{
+                        invalid_type: "invalid_type";
+                        invalid_literal: "invalid_literal";
+                        custom: "custom";
+                        invalid_union: "invalid_union";
+                        invalid_union_discriminator: "invalid_union_discriminator";
+                        invalid_enum_value: "invalid_enum_value";
+                        unrecognized_keys: "unrecognized_keys";
+                        invalid_arguments: "invalid_arguments";
+                        invalid_return_type: "invalid_return_type";
+                        invalid_date: "invalid_date";
+                        invalid_string: "invalid_string";
+                        too_small: "too_small";
+                        too_big: "too_big";
+                        invalid_intersection_types: "invalid_intersection_types";
+                        not_multiple_of: "not_multiple_of";
+                        not_finite: "not_finite";
+                    }>;
+                }, z.ZodAny, "strip">[];
+            }>, z.ZodObject<{
+                code: z.ZodType<"SCENE_FULL", z.ZodTypeDef, "SCENE_FULL">;
+                error: z.ZodType<"The scene can't have more of this object", z.ZodTypeDef, "The scene can't have more of this object">;
+                name: z.ZodLiteral<"APIError">;
+            }, "strip", z.ZodTypeAny, {
+                code: "SCENE_FULL";
+                error: "The scene can't have more of this object";
+                name: "APIError";
+            }, {
+                code: "SCENE_FULL";
+                error: "The scene can't have more of this object";
+                name: "APIError";
+            }>, z.ZodObject<{
+                code: z.ZodType<"SCENE_OBJECT_NOT_FOUND", z.ZodTypeDef, "SCENE_OBJECT_NOT_FOUND">;
+                error: z.ZodType<"The scene object was not found", z.ZodTypeDef, "The scene object was not found">;
+                name: z.ZodLiteral<"APIError">;
+            }, "strip", z.ZodTypeAny, {
+                code: "SCENE_OBJECT_NOT_FOUND";
+                error: "The scene object was not found";
+                name: "APIError";
+            }, {
+                code: "SCENE_OBJECT_NOT_FOUND";
+                error: "The scene object was not found";
+                name: "APIError";
+            }>]>;
+            404: z.ZodObject<{
+                code: z.ZodType<"STREAM_NOT_FOUND", z.ZodTypeDef, "STREAM_NOT_FOUND">;
+                error: z.ZodType<"The requested stream was not found", z.ZodTypeDef, "The requested stream was not found">;
+                name: z.ZodLiteral<"APIError">;
+            }, "strip", z.ZodTypeAny, {
+                code: "STREAM_NOT_FOUND";
+                error: "The requested stream was not found";
+                name: "APIError";
+            }, {
+                code: "STREAM_NOT_FOUND";
+                error: "The requested stream was not found";
+                name: "APIError";
+            }>;
+            500: z.ZodObject<{
+                code: z.ZodType<"INTERNAL_SERVER_ERROR", z.ZodTypeDef, "INTERNAL_SERVER_ERROR">;
+                error: z.ZodType<string, z.ZodTypeDef, string>;
+                name: z.ZodLiteral<"APIError">;
+            }, "strip", z.ZodTypeAny, {
+                code: "INTERNAL_SERVER_ERROR";
+                error: string;
+                name: "APIError";
+            }, {
+                code: "INTERNAL_SERVER_ERROR";
+                error: string;
+                name: "APIError";
+            }>;
+        };
+    };
     stream: {
         description: "Get media stream by stream ID";
         method: "GET";

package/dist/contract/mediaStream.js

@@ -1,6 +1,7 @@
 import { initContract, ZodErrorSchema } from "@ts-rest/core";
 import { z } from "zod";
 import { apiError, apiSuccess } from "../types.js";
+import { mediaStreamSceneSchema, sceneActionSchema } from "../types/scene.js";
 const c = initContract();
 export default c.router({
     init: {
@@ -33,8 +34,11 @@ export default c.router({
                 startTime: z.number(),
                 /** seconds */
                 duration: z.number(),
+                /** seconds, media position when the response was sent */
+                currentTime: z.number(),
                 url: z.string(),
                 paused: z.boolean(),
+                scene: mediaStreamSceneSchema,
             })),
             400: z.union([
                 ZodErrorSchema,
@@ -95,6 +99,23 @@ export default c.router({
             500: apiError(z.literal("INTERNAL_SERVER_ERROR"), z.string()),
         },
     },
+    scene: {
+        method: "POST",
+        path: "/media-stream/scene/:streamId",
+        description: "Change the scene of a media stream, listeners get the new scene through the mediaStreamScene socket event",
+        body: sceneActionSchema,
+        responses: {
+            200: c.noBody(),
+            400: z.union([
+                ZodErrorSchema,
+                apiError(z.literal("SCENE_FULL"), z.literal("The scene can't have more of this object")),
+                apiError(z.literal("SCENE_OBJECT_NOT_FOUND"), z.literal("The scene object was not found")),
+            ]),
+            // 401: apiError(z.literal("UNAUTHORIZED"), z.literal("Unauthorized")),
+            404: apiError(z.literal("STREAM_NOT_FOUND"), z.literal("The requested stream was not found")),
+            500: apiError(z.literal("INTERNAL_SERVER_ERROR"), z.string()),
+        },
+    },
     stream: {
         method: "GET",
         path: "/media-stream/stream/:streamId",

package/dist/socket/mediaStream.d.ts

@@ -1,9 +1,21 @@
+import type { MediaStreamScene } from "../types/scene.js";
 export interface SocketClientToServerMediaStream {
     mediaStreamListen: (streamId: string, callback: (success: boolean) => void) => void;
     mediaStreamUnlisten: (streamId: string, callback: (success: boolean) => void) => void;
 }
+/**
+ * - `ended`: the media played to the end, clients still have the last seconds buffered
+ * - `idle`: nobody listened for a while
+ * - `error`: the media couldn't be read
+ * - `shutdown`: the server is stopping
+ */
+export type MediaStreamEndReason = "ended" | "idle" | "error" | "shutdown";
 export interface SocketServerToClientMediaStream {
     mediaStreamPlay: (streamId: string, startTime: number) => void;
     mediaStreamPause: (streamId: string) => void;
     mediaStreamSeek: (streamId: string, startTime: number) => void;
+    /** The stream is gone, every request about it now returns 404 */
+    mediaStreamEnd: (streamId: string, reason: MediaStreamEndReason) => void;
+    /** The scene changed, the whole new scene */
+    mediaStreamScene: (streamId: string, scene: MediaStreamScene) => void;
 }

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export * from "./youtube.js";
+export * from "./scene.js";

package/dist/types/index.js

@@ -1 +1,2 @@
 export * from "./youtube.js";
+export * from "./scene.js";