@darco2903/altv-web-api 1.1.0 → 1.3.0

package/dist/types/scene.d.ts

@@ -0,0 +1,309 @@
+import { z } from "zod";
+/** Half size of the square ground (meters), x and z stay within ±SCENE_SIZE */
+export declare const SCENE_SIZE = 40;
+export declare const SCENE_MAX_SPEAKERS = 16;
+export declare const SCENE_MAX_CARS = 4;
+/** Front left, front right, rear left, rear right */
+export declare const CAR_DOORS = 4;
+export declare const sceneSpeakerSchema: z.ZodObject<{
+    id: z.ZodString;
+    x: z.ZodNumber;
+    /** Height of the speaker center */
+    y: z.ZodNumber;
+    z: z.ZodNumber;
+    /** The speaker faces its local +z, rotated like a three.js object (Euler order YXZ) */
+    yaw: z.ZodNumber;
+    pitch: z.ZodNumber;
+    /** Only projects forward (cone), otherwise all around */
+    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;
+}>;
+export declare const sceneCarSchema: z.ZodObject<{
+    id: z.ZodString;
+    x: z.ZodNumber;
+    z: z.ZodNumber;
+    /** The car front faces its local -z */
+    yaw: z.ZodNumber;
+    /** Open doors, see CAR_DOORS for the order */
+    doors: z.ZodArray<z.ZodBoolean, "many">;
+    /** Open (lowered) windows, one per door */
+    windows: z.ZodArray<z.ZodBoolean, "many">;
+    /** The radio plays the stream */
+    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;
+}>;
+/** Where the stream is heard, shared by every listener of the stream */
+export declare const mediaStreamSceneSchema: z.ZodObject<{
+    speakers: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        x: z.ZodNumber;
+        /** Height of the speaker center */
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+        /** The speaker faces its local +z, rotated like a three.js object (Euler order YXZ) */
+        yaw: z.ZodNumber;
+        pitch: z.ZodNumber;
+        /** Only projects forward (cone), otherwise all around */
+        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;
+        /** The car front faces its local -z */
+        yaw: z.ZodNumber;
+        /** Open doors, see CAR_DOORS for the order */
+        doors: z.ZodArray<z.ZodBoolean, "many">;
+        /** Open (lowered) windows, one per door */
+        windows: z.ZodArray<z.ZodBoolean, "many">;
+        /** The radio plays the stream */
+        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;
+    }[];
+}>;
+export declare const sceneActionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"addSpeaker">;
+    speaker: z.ZodObject<Omit<{
+        id: z.ZodString;
+        x: z.ZodNumber;
+        /** Height of the speaker center */
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+        /** The speaker faces its local +z, rotated like a three.js object (Euler order YXZ) */
+        yaw: z.ZodNumber;
+        pitch: z.ZodNumber;
+        /** Only projects forward (cone), otherwise all around */
+        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;
+        /** The car front faces its local -z */
+        yaw: z.ZodNumber;
+        /** Open doors, see CAR_DOORS for the order */
+        doors: z.ZodArray<z.ZodBoolean, "many">;
+        /** Open (lowered) windows, one per door */
+        windows: z.ZodArray<z.ZodBoolean, "many">;
+        /** The radio plays the stream */
+        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";
+}>]>;
+export type SceneSpeaker = z.infer<typeof sceneSpeakerSchema>;
+export type SceneCar = z.infer<typeof sceneCarSchema>;
+export type MediaStreamScene = z.infer<typeof mediaStreamSceneSchema>;
+export type SceneAction = z.infer<typeof sceneActionSchema>;

package/dist/types/scene.js

@@ -0,0 +1,73 @@
+import { z } from "zod";
+/** Half size of the square ground (meters), x and z stay within ±SCENE_SIZE */
+export const SCENE_SIZE = 40;
+export const SCENE_MAX_SPEAKERS = 16;
+export const SCENE_MAX_CARS = 4;
+/** Front left, front right, rear left, rear right */
+export const CAR_DOORS = 4;
+const coordinate = z.number().min(-SCENE_SIZE).max(SCENE_SIZE);
+/** Radians, rotation around the vertical axis */
+const yaw = z.number().min(-2 * Math.PI).max(2 * Math.PI);
+export const sceneSpeakerSchema = z.object({
+    id: z.string(),
+    x: coordinate,
+    /** Height of the speaker center */
+    y: z.number().min(0).max(10),
+    z: coordinate,
+    /** The speaker faces its local +z, rotated like a three.js object (Euler order YXZ) */
+    yaw,
+    pitch: z.number().min(-Math.PI / 2).max(Math.PI / 2),
+    /** Only projects forward (cone), otherwise all around */
+    directional: z.boolean(),
+});
+export const sceneCarSchema = z.object({
+    id: z.string(),
+    x: coordinate,
+    z: coordinate,
+    /** The car front faces its local -z */
+    yaw,
+    /** Open doors, see CAR_DOORS for the order */
+    doors: z.array(z.boolean()).length(CAR_DOORS),
+    /** Open (lowered) windows, one per door */
+    windows: z.array(z.boolean()).length(CAR_DOORS),
+    /** The radio plays the stream */
+    radio: z.boolean(),
+});
+/** Where the stream is heard, shared by every listener of the stream */
+export const mediaStreamSceneSchema = z.object({
+    speakers: z.array(sceneSpeakerSchema),
+    cars: z.array(sceneCarSchema),
+});
+const carId = z.string();
+const doorIndex = z
+    .number()
+    .int()
+    .min(0)
+    .max(CAR_DOORS - 1);
+export const sceneActionSchema = z.discriminatedUnion("type", [
+    z.object({
+        type: z.literal("addSpeaker"),
+        speaker: sceneSpeakerSchema.omit({ id: true }),
+    }),
+    z.object({
+        type: z.literal("addCar"),
+        car: sceneCarSchema.pick({ x: true, z: true, yaw: true }),
+    }),
+    /** Removes a speaker or a car */
+    z.object({ type: z.literal("remove"), id: z.string() }),
+    z.object({
+        type: z.literal("carDoor"),
+        id: carId,
+        index: doorIndex,
+        open: z.boolean(),
+    }),
+    z.object({
+        type: z.literal("carWindow"),
+        id: carId,
+        index: doorIndex,
+        open: z.boolean(),
+    }),
+    z.object({ type: z.literal("carRadio"), id: carId, on: z.boolean() }),
+    /** Back to the default scene */
+    z.object({ type: z.literal("reset") }),
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darco2903/altv-web-api",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "",
   "main": "./dist/index.js",
   "keywords": [],