@workadventure/iframe-api-typings 1.9.5 → 1.10.2

package/Api/Events/ui/TriggerActionMessageEvent.d.ts

@@ -1,15 +1,27 @@
-import * as tg from "generic-type-guard";
+import { z } from "zod";
 export declare const triggerActionMessage = "triggerActionMessage";
 export declare const removeActionMessage = "removeActionMessage";
-export declare const isActionMessageType: tg.TypeGuard<"message" | "warning">;
-export declare type ActionMessageType = tg.GuardedType<typeof isActionMessageType>;
-export declare const isTriggerActionMessageEvent: tg.TypeGuard<object & {
+export declare const isActionMessageType: z.ZodEnum<["message", "warning"]>;
+export declare type ActionMessageType = z.infer<typeof isActionMessageType>;
+export declare const isTriggerActionMessageEvent: z.ZodObject<{
+    message: z.ZodString;
+    uuid: z.ZodString;
+    type: z.ZodEnum<["message", "warning"]>;
+}, "strip", z.ZodTypeAny, {
     message: string;
+    type: "message" | "warning";
     uuid: string;
+}, {
+    message: string;
     type: "message" | "warning";
+    uuid: string;
 }>;
-export declare type TriggerActionMessageEvent = tg.GuardedType<typeof isTriggerActionMessageEvent>;
-export declare const isMessageReferenceEvent: tg.TypeGuard<object & {
+export declare type TriggerActionMessageEvent = z.infer<typeof isTriggerActionMessageEvent>;
+export declare const isMessageReferenceEvent: z.ZodObject<{
+    uuid: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    uuid: string;
+}, {
     uuid: string;
 }>;
-export declare type MessageReferenceEvent = tg.GuardedType<typeof isMessageReferenceEvent>;
+export declare type MessageReferenceEvent = z.infer<typeof isMessageReferenceEvent>;

package/Api/Events/ui/UIWebsite.d.ts

@@ -0,0 +1,289 @@
+import { z } from "zod";
+export declare const isUIWebsiteCSSValue: z.ZodString;
+export declare type UIWebsiteCSSValue = z.infer<typeof isUIWebsiteCSSValue>;
+export declare const isUIWebsiteMargin: z.ZodObject<{
+    top: z.ZodOptional<z.ZodString>;
+    bottom: z.ZodOptional<z.ZodString>;
+    left: z.ZodOptional<z.ZodString>;
+    right: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    right?: string | undefined;
+    left?: string | undefined;
+    top?: string | undefined;
+    bottom?: string | undefined;
+}, {
+    right?: string | undefined;
+    left?: string | undefined;
+    top?: string | undefined;
+    bottom?: string | undefined;
+}>;
+export declare type UIWebsiteMargin = z.infer<typeof isUIWebsiteMargin>;
+export declare const isViewportPositionVertical: z.ZodEnum<["top", "middle", "bottom"]>;
+export declare type ViewportPositionVertical = z.infer<typeof isViewportPositionVertical>;
+export declare const isViewportPositionHorizontal: z.ZodEnum<["left", "middle", "right"]>;
+export declare type ViewportPositionHorizontal = z.infer<typeof isViewportPositionHorizontal>;
+export declare const isUIWebsitePosition: z.ZodObject<{
+    vertical: z.ZodEnum<["top", "middle", "bottom"]>;
+    horizontal: z.ZodEnum<["left", "middle", "right"]>;
+}, "strip", z.ZodTypeAny, {
+    vertical: "top" | "middle" | "bottom";
+    horizontal: "right" | "left" | "middle";
+}, {
+    vertical: "top" | "middle" | "bottom";
+    horizontal: "right" | "left" | "middle";
+}>;
+export declare type UIWebsitePosition = z.infer<typeof isUIWebsitePosition>;
+export declare const isUIWebsiteSize: z.ZodObject<{
+    height: z.ZodString;
+    width: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    width: string;
+    height: string;
+}, {
+    width: string;
+    height: string;
+}>;
+export declare type UIWebsiteSize = z.infer<typeof isUIWebsiteSize>;
+export declare const isCreateUIWebsiteEvent: z.ZodObject<{
+    url: z.ZodString;
+    visible: z.ZodOptional<z.ZodBoolean>;
+    allowApi: z.ZodOptional<z.ZodBoolean>;
+    allowPolicy: z.ZodOptional<z.ZodString>;
+    position: z.ZodObject<{
+        vertical: z.ZodEnum<["top", "middle", "bottom"]>;
+        horizontal: z.ZodEnum<["left", "middle", "right"]>;
+    }, "strip", z.ZodTypeAny, {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    }, {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    }>;
+    size: z.ZodObject<{
+        height: z.ZodString;
+        width: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        width: string;
+        height: string;
+    }, {
+        width: string;
+        height: string;
+    }>;
+    margin: z.ZodOptional<z.ZodObject<{
+        top: z.ZodOptional<z.ZodString>;
+        bottom: z.ZodOptional<z.ZodString>;
+        left: z.ZodOptional<z.ZodString>;
+        right: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    }, {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    allowApi?: boolean | undefined;
+    allowPolicy?: string | undefined;
+    visible?: boolean | undefined;
+    margin?: {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    } | undefined;
+    url: string;
+    position: {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    };
+    size: {
+        width: string;
+        height: string;
+    };
+}, {
+    allowApi?: boolean | undefined;
+    allowPolicy?: string | undefined;
+    visible?: boolean | undefined;
+    margin?: {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    } | undefined;
+    url: string;
+    position: {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    };
+    size: {
+        width: string;
+        height: string;
+    };
+}>;
+export declare type CreateUIWebsiteEvent = z.infer<typeof isCreateUIWebsiteEvent>;
+export declare const isModifyUIWebsiteEvent: z.ZodObject<{
+    id: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    visible: z.ZodOptional<z.ZodBoolean>;
+    position: z.ZodOptional<z.ZodObject<{
+        vertical: z.ZodEnum<["top", "middle", "bottom"]>;
+        horizontal: z.ZodEnum<["left", "middle", "right"]>;
+    }, "strip", z.ZodTypeAny, {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    }, {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    }>>;
+    size: z.ZodOptional<z.ZodObject<{
+        height: z.ZodString;
+        width: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        width: string;
+        height: string;
+    }, {
+        width: string;
+        height: string;
+    }>>;
+    margin: z.ZodOptional<z.ZodObject<{
+        top: z.ZodOptional<z.ZodString>;
+        bottom: z.ZodOptional<z.ZodString>;
+        left: z.ZodOptional<z.ZodString>;
+        right: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    }, {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    url?: string | undefined;
+    position?: {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    } | undefined;
+    visible?: boolean | undefined;
+    size?: {
+        width: string;
+        height: string;
+    } | undefined;
+    margin?: {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    } | undefined;
+    id: string;
+}, {
+    url?: string | undefined;
+    position?: {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    } | undefined;
+    visible?: boolean | undefined;
+    size?: {
+        width: string;
+        height: string;
+    } | undefined;
+    margin?: {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    } | undefined;
+    id: string;
+}>;
+export declare type ModifyUIWebsiteEvent = z.infer<typeof isModifyUIWebsiteEvent>;
+export declare const isUIWebsite: z.ZodObject<{
+    id: z.ZodString;
+    url: z.ZodString;
+    visible: z.ZodBoolean;
+    allowApi: z.ZodBoolean;
+    allowPolicy: z.ZodString;
+    position: z.ZodObject<{
+        vertical: z.ZodEnum<["top", "middle", "bottom"]>;
+        horizontal: z.ZodEnum<["left", "middle", "right"]>;
+    }, "strip", z.ZodTypeAny, {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    }, {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    }>;
+    size: z.ZodObject<{
+        height: z.ZodString;
+        width: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        width: string;
+        height: string;
+    }, {
+        width: string;
+        height: string;
+    }>;
+    margin: z.ZodOptional<z.ZodObject<{
+        top: z.ZodOptional<z.ZodString>;
+        bottom: z.ZodOptional<z.ZodString>;
+        left: z.ZodOptional<z.ZodString>;
+        right: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    }, {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    margin?: {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    } | undefined;
+    url: string;
+    allowApi: boolean;
+    allowPolicy: string;
+    position: {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    };
+    id: string;
+    visible: boolean;
+    size: {
+        width: string;
+        height: string;
+    };
+}, {
+    margin?: {
+        right?: string | undefined;
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+    } | undefined;
+    url: string;
+    allowApi: boolean;
+    allowPolicy: string;
+    position: {
+        vertical: "top" | "middle" | "bottom";
+        horizontal: "right" | "left" | "middle";
+    };
+    id: string;
+    visible: boolean;
+    size: {
+        width: string;
+        height: string;
+    };
+}>;
+export declare type UIWebsite = z.infer<typeof isUIWebsite>;

package/Api/iframe/IframeApiContribution.d.ts

@@ -1,12 +1,12 @@
-import type * as tg from "generic-type-guard";
-import type { IframeEvent, IframeEventMap, IframeQuery, IframeQueryMap, IframeResponseEventMap } from "../Events/IframeEvent";
-export declare function sendToWorkadventure(content: IframeEvent<keyof IframeEventMap>): void;
+import { z } from "zod";
+import type { IframeEvent, IframeQuery, IframeQueryMap, IframeResponseEventMap } from "../Events/IframeEvent";
+export declare function sendToWorkadventure(content: IframeEvent): void;
 export declare const answerPromises: Map<number, {
     resolve: (value: IframeQueryMap[keyof IframeQueryMap]["answer"] | PromiseLike<IframeQueryMap[keyof IframeQueryMap]["answer"]>) => void;
     reject: (reason?: any) => void;
 }>;
 export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>): Promise<IframeQueryMap[T]["answer"]>;
-export interface IframeCallback<Key extends keyof IframeResponseEventMap, T = IframeResponseEventMap[Key], Guard = tg.TypeGuard<T>> {
+export interface IframeCallback<Key extends keyof IframeResponseEventMap, T = IframeResponseEventMap[Key], Guard = z.ZodType<T>> {
     typeChecker: Guard;
     callback: (payloadData: T) => void;
 }

package/Api/iframe/Ui/UIWebsite.d.ts

@@ -0,0 +1,33 @@
+import { CreateUIWebsiteEvent, UIWebsiteMargin, UIWebsitePosition, UIWebsiteSize, UIWebsite as UIWebsiteCore } from "../../Events/ui/UIWebsite";
+import { IframeApiContribution } from "../IframeApiContribution";
+export declare class UIWebsite {
+    readonly id: string;
+    private _url;
+    private _visible;
+    private readonly _allowPolicy;
+    private readonly _allowApi;
+    private _position;
+    private _size;
+    private _margin;
+    constructor(config: UIWebsiteCore);
+    get url(): string;
+    set url(url: string);
+    get visible(): boolean;
+    set visible(visible: boolean);
+    get allowPolicy(): string;
+    get allowApi(): boolean;
+    get position(): UIWebsitePosition;
+    set position(position: UIWebsitePosition);
+    get size(): UIWebsiteSize;
+    set size(size: UIWebsiteSize);
+    get margin(): UIWebsiteMargin;
+    set margin(margin: UIWebsiteMargin);
+    close(): Promise<void>;
+}
+export declare class UIWebsiteCommands extends IframeApiContribution<UIWebsiteCommands> {
+    callbacks: never[];
+    open(createUIWebsite: CreateUIWebsiteEvent): Promise<UIWebsite>;
+    getAll(): Promise<UIWebsite[]>;
+}
+declare const _default: UIWebsiteCommands;
+export default _default;

package/Api/iframe/controls.d.ts

@@ -3,6 +3,8 @@ export declare class WorkadventureControlsCommands extends IframeApiContribution
     callbacks: never[];
     disablePlayerControls(): void;
     restorePlayerControls(): void;
+    disablePlayerProximityMeeting(): void;
+    restorePlayerProximityMeeting(): void;
 }
 declare const _default: WorkadventureControlsCommands;
 export default _default;

package/Api/iframe/ui.d.ts

@@ -5,6 +5,7 @@ import { ActionMessage } from "./Ui/ActionMessage";
 import { Menu } from "./Ui/Menu";
 import type { RequireOnlyOne } from "../types";
 import { Observable, Subject } from "rxjs";
+import type { UIWebsiteCommands } from "./Ui/UIWebsite";
 interface MenuDescriptor {
     callback?: (commandDescriptor: string) => void;
     iframe?: string;
@@ -48,6 +49,7 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     displayBubble(): void;
     removeBubble(): void;
     displayActionMessage(actionMessageOptions: ActionMessageOptions): ActionMessage;
+    get website(): UIWebsiteCommands;
 }
 declare const _default: WorkAdventureUiCommands;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.9.5",
+  "version": "v1.10.2",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",

package/Api/Events/ChangeZoneEvent.d.ts

@@ -1,8 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isChangeZoneEvent: tg.TypeGuard<object & {
-    name: string;
-}>;
-/**
- * A message sent from the game to the iFrame when a user enters or leaves a zone.
- */
-export declare type ChangeZoneEvent = tg.GuardedType<typeof isChangeZoneEvent>;