@workadventure/iframe-api-typings 1.9.3 → 1.10.0

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/{front/src/Api → 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/{front/src/Api → 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/{front/src/Api → 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/{front/src/iframe_api.d.ts → iframe_api.d.ts}

@@ -77,4 +77,10 @@ declare const wa: {
     onLeaveZone(name: string, callback: () => void): void;
 };
 export declare type WorkAdventureApi = typeof wa;
+declare global {
+    interface Window {
+        WA: WorkAdventureApi;
+    }
+    let WA: WorkAdventureApi;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.9.3",
+  "version": "v1.10.0",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",
@@ -9,5 +9,8 @@
   "license": "MIT",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "rxjs": "^6.6.3"
   }
 }

package/desktop/electron/src/preload-app/types.d.ts

@@ -1,8 +0,0 @@
-export declare type WorkAdventureDesktopApi = {
-    desktop: boolean;
-    isDevelopment: () => Promise<boolean>;
-    getVersion: () => Promise<string>;
-    notify: (txt: string) => void;
-    onMuteToggle: (callback: () => void) => void;
-    onCameraToggle: (callback: () => void) => void;
-};

package/front/src/Api/Events/ActionsMenuActionClickedEvent.d.ts

@@ -1,7 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isActionsMenuActionClickedEvent: tg.TypeGuard<object & {
-    id: number;
-    actionName: string;
-}>;
-export declare type ActionsMenuActionClickedEvent = tg.GuardedType<typeof isActionsMenuActionClickedEvent>;
-export declare type ActionsMenuActionClickedEventCallback = (event: ActionsMenuActionClickedEvent) => void;

package/front/src/Api/Events/AddActionsMenuKeyToRemotePlayerEvent.d.ts

@@ -1,7 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isAddActionsMenuKeyToRemotePlayerEvent: tg.TypeGuard<object & {
-    id: number;
-    actionKey: string;
-}>;
-export declare type AddActionsMenuKeyToRemotePlayerEvent = tg.GuardedType<typeof isAddActionsMenuKeyToRemotePlayerEvent>;
-export declare type AddActionsMenuKeyToRemotePlayerEventCallback = (event: AddActionsMenuKeyToRemotePlayerEvent) => void;

package/front/src/Api/Events/ButtonClickedEvent.d.ts

@@ -1,9 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isButtonClickedEvent: tg.TypeGuard<object & {
-    popupId: number;
-    buttonId: number;
-}>;
-/**
- * A message sent from the game to the iFrame when a user enters or leaves a zone marked with the "zone" property.
- */
-export declare type ButtonClickedEvent = tg.GuardedType<typeof isButtonClickedEvent>;

package/front/src/Api/Events/CameraFollowPlayerEvent.d.ts

@@ -1,8 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isCameraFollowPlayerEvent: tg.TypeGuard<object & {
-    smooth: boolean;
-}>;
-/**
- * A message sent from the iFrame to the game to make the camera follow player.
- */
-export declare type CameraFollowPlayerEvent = tg.GuardedType<typeof isCameraFollowPlayerEvent>;

package/front/src/Api/Events/CameraSetEvent.d.ts

@@ -1,13 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isCameraSetEvent: tg.TypeGuard<object & {
-    x: number;
-    y: number;
-    width: number | undefined;
-    height: number | undefined;
-    lock: boolean;
-    smooth: boolean;
-}>;
-/**
- * A message sent from the iFrame to the game to change the camera position.
- */
-export declare type CameraSetEvent = tg.GuardedType<typeof isCameraSetEvent>;

package/front/src/Api/Events/ChangeLayerEvent.d.ts

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

package/front/src/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>;

package/front/src/Api/Events/ChatEvent.d.ts

@@ -1,9 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isChatEvent: tg.TypeGuard<object & {
-    message: string;
-    author: string;
-}>;
-/**
- * A message sent from the iFrame to the game to add a message in the chat.
- */
-export declare type ChatEvent = tg.GuardedType<typeof isChatEvent>;

package/front/src/Api/Events/ClosePopupEvent.d.ts

@@ -1,8 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isClosePopupEvent: tg.TypeGuard<object & {
-    popupId: number;
-}>;
-/**
- * A message sent from the iFrame to the game to add a message in the chat.
- */
-export declare type ClosePopupEvent = tg.GuardedType<typeof isClosePopupEvent>;

package/front/src/Api/Events/ColorEvent.d.ts

@@ -1,10 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isColorEvent: tg.TypeGuard<object & {
-    red: number;
-    green: number;
-    blue: number;
-}>;
-/**
- * A message sent from the iFrame to the game to dynamically set the outline of the player.
- */
-export declare type ColorEvent = tg.GuardedType<typeof isColorEvent>;

package/front/src/Api/Events/EmbeddedWebsiteEvent.d.ts

@@ -1,43 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isRectangle: tg.TypeGuard<object & {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}>;
-export declare const isEmbeddedWebsiteEvent: tg.TypeGuard<object & {
-    name: string;
-} & Partial<{
-    url: string;
-    visible: boolean;
-    allowApi: boolean;
-    allow: string;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    origin: "player" | "map";
-    scale: number;
-}>>;
-export declare const isCreateEmbeddedWebsiteEvent: tg.TypeGuard<object & {
-    name: string;
-    url: string;
-    position: object & {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-} & Partial<{
-    visible: boolean;
-    allowApi: boolean;
-    allow: string;
-    origin: "player" | "map";
-    scale: number;
-}>>;
-/**
- * A message sent from the iFrame to the game to modify an embedded website
- */
-export declare type ModifyEmbeddedWebsiteEvent = tg.GuardedType<typeof isEmbeddedWebsiteEvent>;
-export declare type CreateEmbeddedWebsiteEvent = tg.GuardedType<typeof isCreateEmbeddedWebsiteEvent>;
-export declare type Rectangle = tg.GuardedType<typeof isRectangle>;

package/front/src/Api/Events/EnterLeaveEvent.d.ts

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

package/front/src/Api/Events/GameStateEvent.d.ts

@@ -1,17 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isGameStateEvent: tg.TypeGuard<object & {
-    roomId: string;
-    mapUrl: string;
-    nickname: string;
-    language: string | undefined;
-    uuid: string | undefined;
-    startLayerName: string | null;
-    tags: string[];
-    variables: object;
-    playerVariables: object;
-    userRoomToken: string | undefined;
-}>;
-/**
- * A message sent from the game to the iFrame when the gameState is received by the script
- */
-export declare type GameStateEvent = tg.GuardedType<typeof isGameStateEvent>;

package/front/src/Api/Events/GoToPageEvent.d.ts

@@ -1,8 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isGoToPageEvent: tg.TypeGuard<object & {
-    url: string;
-}>;
-/**
- * A message sent from the iFrame to the game to add a message in the chat.
- */
-export declare type GoToPageEvent = tg.GuardedType<typeof isGoToPageEvent>;

package/front/src/Api/Events/HasPlayerMovedEvent.d.ts

@@ -1,14 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isHasPlayerMovedEvent: tg.TypeGuard<object & {
-    direction: string;
-    moving: boolean;
-    x: number;
-    y: number;
-    oldX: number | undefined;
-    oldY: number | undefined;
-}>;
-/**
- * A message sent from the game to the iFrame to notify a movement from the current player.
- */
-export declare type HasPlayerMovedEvent = tg.GuardedType<typeof isHasPlayerMovedEvent>;
-export declare type HasPlayerMovedEventCallback = (event: HasPlayerMovedEvent) => void;