@workadventure/iframe-api-typings 1.14.8 → 1.15.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/front/Api/Events/ActionsMenuActionClickedEvent.d.ts +2 -2
- package/front/Api/Events/AddActionsMenuKeyToRemotePlayerEvent.d.ts +2 -2
- package/front/Api/Events/AddPlayerEvent.d.ts +2 -2
- package/front/Api/Events/AskPositionEvent.d.ts +1 -1
- package/front/Api/Events/ButtonClickedEvent.d.ts +1 -1
- package/front/Api/Events/CameraFollowPlayerEvent.d.ts +1 -1
- package/front/Api/Events/CameraSetEvent.d.ts +1 -1
- package/front/Api/Events/ChangeAreaEvent.d.ts +1 -1
- package/front/Api/Events/ChangeLayerEvent.d.ts +1 -1
- package/front/Api/Events/ChatEvent.d.ts +2 -2
- package/front/Api/Events/ChatVisibilityEvent.d.ts +1 -1
- package/front/Api/Events/ClosePopupEvent.d.ts +1 -1
- package/front/Api/Events/ColorEvent.d.ts +1 -1
- package/front/Api/Events/CreateAreaEvent.d.ts +2 -2
- package/front/Api/Events/EmbeddedWebsiteEvent.d.ts +7 -7
- package/front/Api/Events/EnablePlayersTrackingEvent.d.ts +1 -1
- package/front/Api/Events/EnterLeaveEvent.d.ts +1 -1
- package/front/Api/Events/GameStateEvent.d.ts +4 -1
- package/front/Api/Events/GoToPageEvent.d.ts +1 -1
- package/front/Api/Events/HasPlayerMovedEvent.d.ts +2 -2
- package/front/Api/Events/IframeEvent.d.ts +308 -76
- package/front/Api/Events/JoinMucEvent.d.ts +1 -1
- package/front/Api/Events/LayerEvent.d.ts +1 -1
- package/front/Api/Events/LeaveMucEvent.d.ts +1 -1
- package/front/Api/Events/LoadPageEvent.d.ts +1 -1
- package/front/Api/Events/LoadSoundEvent.d.ts +1 -1
- package/front/Api/Events/LoadTilesetEvent.d.ts +1 -1
- package/front/Api/Events/MapDataEvent.d.ts +1 -1
- package/front/Api/Events/ModalEvent.d.ts +1 -1
- package/front/Api/Events/MovePlayerToEvent.d.ts +1 -1
- package/front/Api/Events/MovePlayerToEventAnswer.d.ts +1 -1
- package/front/Api/Events/NotificationEvent.d.ts +1 -1
- package/front/Api/Events/OpenCoWebsiteEvent.d.ts +1 -1
- package/front/Api/Events/OpenPopupEvent.d.ts +1 -1
- package/front/Api/Events/OpenTabEvent.d.ts +1 -1
- package/front/Api/Events/PlaySoundEvent.d.ts +1 -1
- package/front/Api/Events/PlayerPosition.d.ts +1 -1
- package/front/Api/Events/ProximityMeeting/JoinProximityMeetingEvent.d.ts +1 -1
- package/front/Api/Events/ProximityMeeting/ParticipantProximityMeetingEvent.d.ts +1 -1
- package/front/Api/Events/RemoveActionsMenuKeyFromRemotePlayerEvent.d.ts +2 -2
- package/front/Api/Events/SetAreaPropertyEvent.d.ts +1 -1
- package/front/Api/Events/SetPlayerVariableEvent.d.ts +1 -1
- package/front/Api/Events/SetPropertyEvent.d.ts +1 -1
- package/front/Api/Events/SetSharedPlayerVariableEvent.d.ts +1 -1
- package/front/Api/Events/SetTilesEvent.d.ts +1 -1
- package/front/Api/Events/SetVariableEvent.d.ts +1 -1
- package/front/Api/Events/SettingsEvent.d.ts +1 -1
- package/front/Api/Events/ShowBusinessCardEvent.d.ts +1 -1
- package/front/Api/Events/StopSoundEvent.d.ts +1 -1
- package/front/Api/Events/Ui/BannerEvent.d.ts +39 -0
- package/front/Api/Events/Ui/ButtonActionBarEvent.d.ts +53 -4
- package/front/Api/Events/Ui/MenuItemClickedEvent.d.ts +1 -1
- package/front/Api/Events/Ui/MenuRegisterEvent.d.ts +2 -2
- package/front/Api/Events/Ui/TriggerActionMessageEvent.d.ts +3 -3
- package/front/Api/Events/Ui/UIWebsite.d.ts +49 -49
- package/front/Api/Events/UserInputChatEvent.d.ts +1 -1
- package/front/Api/Events/WasCameraUpdatedEvent.d.ts +2 -2
- package/front/Api/Events/XmppSettingsMessageEvent.d.ts +1 -1
- package/front/Api/Iframe/Area/Area.d.ts +1 -1
- package/front/Api/Iframe/Players/RemotePlayer.d.ts +1 -1
- package/front/Api/Iframe/Sound/Sound.d.ts +1 -1
- package/front/Api/Iframe/Ui/Banner.d.ts +21 -0
- package/front/Api/Iframe/Ui/ButtonActionBar.d.ts +22 -3
- package/front/Api/Iframe/Ui/ButtonDescriptor.d.ts +1 -1
- package/front/Api/Iframe/Ui/UIWebsite.d.ts +7 -0
- package/front/Api/Iframe/player.d.ts +1 -1
- package/front/Api/Iframe/ui.d.ts +3 -1
- package/front/Api/types.d.ts +1 -1
- package/iframe_api.d.ts +9 -1
- package/package.json +1 -1
|
@@ -9,5 +9,5 @@ export declare const isActionsMenuActionClickedEvent: z.ZodObject<{
|
|
|
9
9
|
id: number;
|
|
10
10
|
actionName: string;
|
|
11
11
|
}>;
|
|
12
|
-
export
|
|
13
|
-
export
|
|
12
|
+
export type ActionsMenuActionClickedEvent = z.infer<typeof isActionsMenuActionClickedEvent>;
|
|
13
|
+
export type ActionsMenuActionClickedEventCallback = (event: ActionsMenuActionClickedEvent) => void;
|
|
@@ -9,5 +9,5 @@ export declare const isAddActionsMenuKeyToRemotePlayerEvent: z.ZodObject<{
|
|
|
9
9
|
id: number;
|
|
10
10
|
actionKey: string;
|
|
11
11
|
}>;
|
|
12
|
-
export
|
|
13
|
-
export
|
|
12
|
+
export type AddActionsMenuKeyToRemotePlayerEvent = z.infer<typeof isAddActionsMenuKeyToRemotePlayerEvent>;
|
|
13
|
+
export type AddActionsMenuKeyToRemotePlayerEventCallback = (event: AddActionsMenuKeyToRemotePlayerEvent) => void;
|
|
@@ -79,8 +79,8 @@ export declare const isRemotePlayerChangedEvent: z.ZodObject<{
|
|
|
79
79
|
/**
|
|
80
80
|
* A message sent from the game to the iFrame to notify a new player arrived in our viewport
|
|
81
81
|
*/
|
|
82
|
-
export
|
|
82
|
+
export type AddPlayerEvent = z.infer<typeof isAddPlayerEvent>;
|
|
83
83
|
/**
|
|
84
84
|
* A message sent from the game to the iFrame to notify a player has changed (moved / changed name, etc...)
|
|
85
85
|
*/
|
|
86
|
-
export
|
|
86
|
+
export type RemotePlayerChangedEvent = z.infer<typeof isRemotePlayerChangedEvent>;
|
|
@@ -12,4 +12,4 @@ export declare const isAskPositionEvent: z.ZodObject<{
|
|
|
12
12
|
/**
|
|
13
13
|
* A message sent from the iFrame to the game to ask the position of the user with uuid and walk to him.
|
|
14
14
|
*/
|
|
15
|
-
export
|
|
15
|
+
export type AskPositionEvent = z.infer<typeof isAskPositionEvent>;
|
|
@@ -12,4 +12,4 @@ export declare const isButtonClickedEvent: z.ZodObject<{
|
|
|
12
12
|
/**
|
|
13
13
|
* A message sent from the game to the iFrame when a user enters or leaves a zone marked with the "zone" property.
|
|
14
14
|
*/
|
|
15
|
-
export
|
|
15
|
+
export type ButtonClickedEvent = z.infer<typeof isButtonClickedEvent>;
|
|
@@ -9,4 +9,4 @@ export declare const isCameraFollowPlayerEvent: z.ZodObject<{
|
|
|
9
9
|
/**
|
|
10
10
|
* A message sent from the iFrame to the game to make the camera follow player.
|
|
11
11
|
*/
|
|
12
|
-
export
|
|
12
|
+
export type CameraFollowPlayerEvent = z.infer<typeof isCameraFollowPlayerEvent>;
|
|
@@ -24,4 +24,4 @@ export declare const isCameraSetEvent: z.ZodObject<{
|
|
|
24
24
|
/**
|
|
25
25
|
* A message sent from the iFrame to the game to change the camera position.
|
|
26
26
|
*/
|
|
27
|
-
export
|
|
27
|
+
export type CameraSetEvent = z.infer<typeof isCameraSetEvent>;
|
|
@@ -9,4 +9,4 @@ export declare const isChangeAreaEvent: z.ZodObject<{
|
|
|
9
9
|
/**
|
|
10
10
|
* A message sent from the game to the iFrame when a user enters or leaves an area.
|
|
11
11
|
*/
|
|
12
|
-
export
|
|
12
|
+
export type ChangeAreaEvent = z.infer<typeof isChangeAreaEvent>;
|
|
@@ -9,4 +9,4 @@ export declare const isChangeLayerEvent: z.ZodObject<{
|
|
|
9
9
|
/**
|
|
10
10
|
* A message sent from the game to the iFrame when a user enters or leaves a layer.
|
|
11
11
|
*/
|
|
12
|
-
export
|
|
12
|
+
export type ChangeLayerEvent = z.infer<typeof isChangeLayerEvent>;
|
|
@@ -40,8 +40,8 @@ export declare const isChatMessage: z.ZodObject<{
|
|
|
40
40
|
type: ChatMessageTypes;
|
|
41
41
|
date: Date;
|
|
42
42
|
}>;
|
|
43
|
-
export
|
|
43
|
+
export type ChatMessage = z.infer<typeof isChatMessage>;
|
|
44
44
|
/**
|
|
45
45
|
* A message sent from the iFrame to the game to add a message in the chat.
|
|
46
46
|
*/
|
|
47
|
-
export
|
|
47
|
+
export type ChatEvent = z.infer<typeof isChatEvent>;
|
|
@@ -9,4 +9,4 @@ export declare const isClosePopupEvent: z.ZodObject<{
|
|
|
9
9
|
/**
|
|
10
10
|
* A message sent from the iFrame to the game to add a message in the chat.
|
|
11
11
|
*/
|
|
12
|
-
export
|
|
12
|
+
export type ClosePopupEvent = z.infer<typeof isClosePopupEvent>;
|
|
@@ -15,4 +15,4 @@ export declare const isColorEvent: z.ZodObject<{
|
|
|
15
15
|
/**
|
|
16
16
|
* A message sent from the iFrame to the game to dynamically set the outline of the player.
|
|
17
17
|
*/
|
|
18
|
-
export
|
|
18
|
+
export type ColorEvent = z.infer<typeof isColorEvent>;
|
|
@@ -21,7 +21,7 @@ export declare const isAreaEvent: z.ZodObject<{
|
|
|
21
21
|
/**
|
|
22
22
|
* A message sent from the iFrame to the game to modify an embedded website
|
|
23
23
|
*/
|
|
24
|
-
export
|
|
24
|
+
export type ModifyAreaEvent = z.infer<typeof isAreaEvent>;
|
|
25
25
|
export declare const isCreateAreaEvent: z.ZodObject<{
|
|
26
26
|
name: z.ZodString;
|
|
27
27
|
x: z.ZodNumber;
|
|
@@ -41,4 +41,4 @@ export declare const isCreateAreaEvent: z.ZodObject<{
|
|
|
41
41
|
width: number;
|
|
42
42
|
height: number;
|
|
43
43
|
}>;
|
|
44
|
-
export
|
|
44
|
+
export type CreateAreaEvent = z.infer<typeof isCreateAreaEvent>;
|
|
@@ -15,7 +15,7 @@ export declare const isRectangle: z.ZodObject<{
|
|
|
15
15
|
width: number;
|
|
16
16
|
height: number;
|
|
17
17
|
}>;
|
|
18
|
-
export
|
|
18
|
+
export type Rectangle = z.infer<typeof isRectangle>;
|
|
19
19
|
export declare const isEmbeddedWebsiteEvent: z.ZodObject<{
|
|
20
20
|
name: z.ZodString;
|
|
21
21
|
url: z.ZodOptional<z.ZodString>;
|
|
@@ -37,7 +37,7 @@ export declare const isEmbeddedWebsiteEvent: z.ZodObject<{
|
|
|
37
37
|
height?: number | undefined;
|
|
38
38
|
visible?: boolean | undefined;
|
|
39
39
|
allow?: string | undefined;
|
|
40
|
-
origin?: "
|
|
40
|
+
origin?: "map" | "player" | undefined;
|
|
41
41
|
scale?: number | undefined;
|
|
42
42
|
name: string;
|
|
43
43
|
}, {
|
|
@@ -49,14 +49,14 @@ export declare const isEmbeddedWebsiteEvent: z.ZodObject<{
|
|
|
49
49
|
height?: number | undefined;
|
|
50
50
|
visible?: boolean | undefined;
|
|
51
51
|
allow?: string | undefined;
|
|
52
|
-
origin?: "
|
|
52
|
+
origin?: "map" | "player" | undefined;
|
|
53
53
|
scale?: number | undefined;
|
|
54
54
|
name: string;
|
|
55
55
|
}>;
|
|
56
56
|
/**
|
|
57
57
|
* A message sent from the iFrame to the game to modify an embedded website
|
|
58
58
|
*/
|
|
59
|
-
export
|
|
59
|
+
export type ModifyEmbeddedWebsiteEvent = z.infer<typeof isEmbeddedWebsiteEvent>;
|
|
60
60
|
export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
|
|
61
61
|
name: z.ZodString;
|
|
62
62
|
url: z.ZodString;
|
|
@@ -85,7 +85,7 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
|
|
|
85
85
|
allowApi?: boolean | undefined;
|
|
86
86
|
visible?: boolean | undefined;
|
|
87
87
|
allow?: string | undefined;
|
|
88
|
-
origin?: "
|
|
88
|
+
origin?: "map" | "player" | undefined;
|
|
89
89
|
scale?: number | undefined;
|
|
90
90
|
name: string;
|
|
91
91
|
url: string;
|
|
@@ -99,7 +99,7 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
|
|
|
99
99
|
allowApi?: boolean | undefined;
|
|
100
100
|
visible?: boolean | undefined;
|
|
101
101
|
allow?: string | undefined;
|
|
102
|
-
origin?: "
|
|
102
|
+
origin?: "map" | "player" | undefined;
|
|
103
103
|
scale?: number | undefined;
|
|
104
104
|
name: string;
|
|
105
105
|
url: string;
|
|
@@ -110,4 +110,4 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
|
|
|
110
110
|
height: number;
|
|
111
111
|
};
|
|
112
112
|
}>;
|
|
113
|
-
export
|
|
113
|
+
export type CreateEmbeddedWebsiteEvent = z.infer<typeof isCreateEmbeddedWebsiteEvent>;
|
|
@@ -12,4 +12,4 @@ export declare const isEnablePlayersTrackingEvent: z.ZodObject<{
|
|
|
12
12
|
/**
|
|
13
13
|
* A message sent from the game to the iFrame to notify the game that the iframe is interested in tracking users.
|
|
14
14
|
*/
|
|
15
|
-
export
|
|
15
|
+
export type EnablePlayersTrackingEvent = z.infer<typeof isEnablePlayersTrackingEvent>;
|
|
@@ -9,4 +9,4 @@ export declare const isEnterLeaveEvent: z.ZodObject<{
|
|
|
9
9
|
/**
|
|
10
10
|
* A message sent from the game to the iFrame when a user enters or leaves a zone marked with the "zone" property.
|
|
11
11
|
*/
|
|
12
|
-
export
|
|
12
|
+
export type EnterLeaveEvent = z.infer<typeof isEnterLeaveEvent>;
|
|
@@ -12,6 +12,7 @@ export declare const isGameStateEvent: z.ZodObject<{
|
|
|
12
12
|
playerVariables: z.ZodUnknown;
|
|
13
13
|
userRoomToken: z.ZodOptional<z.ZodString>;
|
|
14
14
|
metadata: z.ZodOptional<z.ZodUnknown>;
|
|
15
|
+
iframeId: z.ZodOptional<z.ZodString>;
|
|
15
16
|
isLogged: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
16
17
|
}, "strip", z.ZodTypeAny, {
|
|
17
18
|
language?: string | undefined;
|
|
@@ -22,6 +23,7 @@ export declare const isGameStateEvent: z.ZodObject<{
|
|
|
22
23
|
playerVariables?: unknown;
|
|
23
24
|
userRoomToken?: string | undefined;
|
|
24
25
|
metadata?: unknown;
|
|
26
|
+
iframeId?: string | undefined;
|
|
25
27
|
roomId: string;
|
|
26
28
|
mapUrl: string;
|
|
27
29
|
nickname: string;
|
|
@@ -36,6 +38,7 @@ export declare const isGameStateEvent: z.ZodObject<{
|
|
|
36
38
|
playerVariables?: unknown;
|
|
37
39
|
userRoomToken?: string | undefined;
|
|
38
40
|
metadata?: unknown;
|
|
41
|
+
iframeId?: string | undefined;
|
|
39
42
|
isLogged?: boolean | undefined;
|
|
40
43
|
roomId: string;
|
|
41
44
|
mapUrl: string;
|
|
@@ -45,4 +48,4 @@ export declare const isGameStateEvent: z.ZodObject<{
|
|
|
45
48
|
/**
|
|
46
49
|
* A message sent from the game to the iFrame when the gameState is received by the script
|
|
47
50
|
*/
|
|
48
|
-
export
|
|
51
|
+
export type GameStateEvent = z.infer<typeof isGameStateEvent>;
|
|
@@ -9,4 +9,4 @@ export declare const isGoToPageEvent: z.ZodObject<{
|
|
|
9
9
|
/**
|
|
10
10
|
* A message sent from the iFrame to the game to add a message in the chat.
|
|
11
11
|
*/
|
|
12
|
-
export
|
|
12
|
+
export type GoToPageEvent = z.infer<typeof isGoToPageEvent>;
|
|
@@ -24,5 +24,5 @@ export declare const isHasPlayerMovedEvent: z.ZodObject<{
|
|
|
24
24
|
/**
|
|
25
25
|
* A message sent from the game to the iFrame to notify a movement from the current player.
|
|
26
26
|
*/
|
|
27
|
-
export
|
|
28
|
-
export
|
|
27
|
+
export type HasPlayerMovedEvent = z.infer<typeof isHasPlayerMovedEvent>;
|
|
28
|
+
export type HasPlayerMovedEventCallback = (event: HasPlayerMovedEvent) => void;
|