@workadventure/iframe-api-typings 1.25.6 → 1.25.8

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.
Files changed (117) hide show
  1. package/iframe_api.d.ts +1 -111
  2. package/libs/shared-utils/src/Events/ChatEvent.d.ts +168 -0
  3. package/package.json +2 -2
  4. package/{Api → play/src/front/Api}/Events/ActionsMenuActionClickedEvent.d.ts +2 -2
  5. package/{Api → play/src/front/Api}/Events/AddActionsMenuKeyToRemotePlayerEvent.d.ts +2 -2
  6. package/{Api → play/src/front/Api}/Events/AddPlayerEvent.d.ts +17 -11
  7. package/{Api → play/src/front/Api}/Events/AskPositionEvent.d.ts +1 -1
  8. package/{Api → play/src/front/Api}/Events/ButtonClickedEvent.d.ts +1 -1
  9. package/{Api → play/src/front/Api}/Events/CameraFollowPlayerEvent.d.ts +4 -1
  10. package/{Api → play/src/front/Api}/Events/CameraSetEvent.d.ts +8 -5
  11. package/{Api → play/src/front/Api}/Events/ChangeAreaEvent.d.ts +1 -1
  12. package/{Api → play/src/front/Api}/Events/ChangeLayerEvent.d.ts +1 -1
  13. package/{Api → play/src/front/Api}/Events/ChatVisibilityEvent.d.ts +1 -1
  14. package/{Api → play/src/front/Api}/Events/ClosePopupEvent.d.ts +1 -1
  15. package/{Api → play/src/front/Api}/Events/ColorEvent.d.ts +1 -1
  16. package/{Api/Events/CreateAreaEvent.d.ts → play/src/front/Api/Events/CreateDynamicAreaEvent.d.ts} +14 -14
  17. package/{Api → play/src/front/Api}/Events/EmbeddedWebsiteEvent.d.ts +32 -32
  18. package/{Api → play/src/front/Api}/Events/EnablePlayersTrackingEvent.d.ts +1 -1
  19. package/{Api → play/src/front/Api}/Events/EnterLeaveEvent.d.ts +1 -1
  20. package/{Api → play/src/front/Api}/Events/GameStateEvent.d.ts +17 -8
  21. package/{Api → play/src/front/Api}/Events/GoToPageEvent.d.ts +1 -1
  22. package/{Api → play/src/front/Api}/Events/HasPlayerMovedEvent.d.ts +5 -5
  23. package/{Api → play/src/front/Api}/Events/IframeEvent.d.ts +1849 -486
  24. package/{Api → play/src/front/Api}/Events/JoinMucEvent.d.ts +3 -3
  25. package/{Api → play/src/front/Api}/Events/LayerEvent.d.ts +1 -1
  26. package/{Api → play/src/front/Api}/Events/LeaveMucEvent.d.ts +1 -1
  27. package/{Api → play/src/front/Api}/Events/LoadPageEvent.d.ts +1 -1
  28. package/{Api → play/src/front/Api}/Events/LoadSoundEvent.d.ts +1 -1
  29. package/{Api → play/src/front/Api}/Events/LoadTilesetEvent.d.ts +1 -1
  30. package/{Api → play/src/front/Api}/Events/MapDataEvent.d.ts +1 -1
  31. package/play/src/front/Api/Events/ModalEvent.d.ts +27 -0
  32. package/{Api → play/src/front/Api}/Events/MovePlayerToEvent.d.ts +3 -3
  33. package/{Api → play/src/front/Api}/Events/MovePlayerToEventAnswer.d.ts +1 -1
  34. package/{Api → play/src/front/Api}/Events/OpenCoWebsiteEvent.d.ts +3 -3
  35. package/{Api → play/src/front/Api}/Events/OpenPopupEvent.d.ts +7 -7
  36. package/{Api → play/src/front/Api}/Events/OpenTabEvent.d.ts +1 -1
  37. package/{Api → play/src/front/Api}/Events/PlaySoundEvent.d.ts +3 -3
  38. package/{Api → play/src/front/Api}/Events/PlayerPosition.d.ts +1 -1
  39. package/play/src/front/Api/Events/ProximityMeeting/AppendPCMDataEvent.d.ts +14 -0
  40. package/{Api → play/src/front/Api}/Events/ProximityMeeting/JoinProximityMeetingEvent.d.ts +14 -9
  41. package/{Api → play/src/front/Api}/Events/ProximityMeeting/ParticipantProximityMeetingEvent.d.ts +14 -9
  42. package/play/src/front/Api/Events/ProximityMeeting/PlaySoundInBubbleEvent.d.ts +12 -0
  43. package/play/src/front/Api/Events/ProximityMeeting/StartStreamInBubbleEvent.d.ts +13 -0
  44. package/play/src/front/Api/Events/ReceiveEventEvent.d.ts +48 -0
  45. package/{Api → play/src/front/Api}/Events/RemoveActionsMenuKeyFromRemotePlayerEvent.d.ts +2 -2
  46. package/play/src/front/Api/Events/SendEventEvent.d.ts +48 -0
  47. package/{Api → play/src/front/Api}/Events/SetAreaPropertyEvent.d.ts +3 -3
  48. package/{Api → play/src/front/Api}/Events/SetPlayerVariableEvent.d.ts +6 -6
  49. package/{Api → play/src/front/Api}/Events/SetPropertyEvent.d.ts +3 -3
  50. package/{Api → play/src/front/Api}/Events/SetSharedPlayerVariableEvent.d.ts +4 -4
  51. package/{Api → play/src/front/Api}/Events/SetTilesEvent.d.ts +1 -1
  52. package/{Api → play/src/front/Api}/Events/SetVariableEvent.d.ts +7 -7
  53. package/play/src/front/Api/Events/SettingsEvent.d.ts +24 -0
  54. package/{Api → play/src/front/Api}/Events/ShowBusinessCardEvent.d.ts +1 -1
  55. package/{Api → play/src/front/Api}/Events/StopSoundEvent.d.ts +1 -1
  56. package/play/src/front/Api/Events/TeleportPlayerToEvent.d.ts +12 -0
  57. package/play/src/front/Api/Events/Ui/BannerEvent.d.ts +42 -0
  58. package/play/src/front/Api/Events/Ui/ButtonActionBarEvent.d.ts +38 -0
  59. package/{Api/Events/Ui/MenuRegisterEvent.d.ts → play/src/front/Api/Events/Ui/MenuEvents.d.ts} +29 -7
  60. package/{Api → play/src/front/Api}/Events/Ui/MenuItemClickedEvent.d.ts +1 -1
  61. package/play/src/front/Api/Events/Ui/PlayVideoEvent.d.ts +67 -0
  62. package/{Api → play/src/front/Api}/Events/Ui/TriggerActionMessageEvent.d.ts +3 -3
  63. package/play/src/front/Api/Events/Ui/TriggerPlayerMessageEvent.d.ts +27 -0
  64. package/{Api/Events/Ui/UIWebsite.d.ts → play/src/front/Api/Events/Ui/UIWebsiteEvent.d.ts} +95 -95
  65. package/{Api → play/src/front/Api}/Events/UserInputChatEvent.d.ts +4 -1
  66. package/play/src/front/Api/Events/WamMapDataEvent.d.ts +12 -0
  67. package/{Api → play/src/front/Api}/Events/WasCameraUpdatedEvent.d.ts +6 -6
  68. package/play/src/front/Api/Iframe/AbstractEvent.d.ts +18 -0
  69. package/play/src/front/Api/Iframe/AbstractState.d.ts +19 -0
  70. package/{Api → play/src/front/Api}/Iframe/Area/Area.d.ts +5 -4
  71. package/{Api → play/src/front/Api}/Iframe/IframeApiContribution.d.ts +2 -2
  72. package/play/src/front/Api/Iframe/MapEditor/MapEditorArea.d.ts +12 -0
  73. package/play/src/front/Api/Iframe/Player/AudioStream.d.ts +5 -0
  74. package/play/src/front/Api/Iframe/Player/ProximityMeeting.d.ts +164 -0
  75. package/{Api → play/src/front/Api}/Iframe/Players/RemotePlayer.d.ts +14 -12
  76. package/play/src/front/Api/Iframe/PrivatePlayerState.d.ts +7 -0
  77. package/play/src/front/Api/Iframe/PublicPlayerState.d.ts +11 -0
  78. package/{Api → play/src/front/Api}/Iframe/Room/EmbeddedWebsite.d.ts +0 -3
  79. package/play/src/front/Api/Iframe/RoomState.d.ts +7 -0
  80. package/{Api → play/src/front/Api}/Iframe/Sound/Sound.d.ts +1 -1
  81. package/play/src/front/Api/Iframe/Ui/Banner.d.ts +21 -0
  82. package/play/src/front/Api/Iframe/Ui/ButtonActionBar.d.ts +25 -0
  83. package/{Api → play/src/front/Api}/Iframe/Ui/ButtonDescriptor.d.ts +1 -1
  84. package/play/src/front/Api/Iframe/Ui/Menu.d.ts +12 -0
  85. package/play/src/front/Api/Iframe/Ui/Modal.d.ts +28 -0
  86. package/play/src/front/Api/Iframe/Ui/PlayerMessage.d.ts +12 -0
  87. package/{Api → play/src/front/Api}/Iframe/Ui/UIWebsite.d.ts +11 -4
  88. package/play/src/front/Api/Iframe/Ui/Video.d.ts +5 -0
  89. package/{Api → play/src/front/Api}/Iframe/area.d.ts +9 -9
  90. package/{Api → play/src/front/Api}/Iframe/camera.d.ts +9 -9
  91. package/play/src/front/Api/Iframe/chat.d.ts +69 -0
  92. package/play/src/front/Api/Iframe/controls.d.ts +116 -0
  93. package/play/src/front/Api/Iframe/event.d.ts +15 -0
  94. package/play/src/front/Api/Iframe/mapEditor.d.ts +52 -0
  95. package/{Api → play/src/front/Api}/Iframe/nav.d.ts +9 -5
  96. package/{Api → play/src/front/Api}/Iframe/player.d.ts +41 -21
  97. package/{Api → play/src/front/Api}/Iframe/playerState.d.ts +8 -6
  98. package/{Api → play/src/front/Api}/Iframe/players.d.ts +30 -18
  99. package/{Api → play/src/front/Api}/Iframe/registeredCallbacks.d.ts +1 -1
  100. package/{Api → play/src/front/Api}/Iframe/room.d.ts +23 -16
  101. package/{Api → play/src/front/Api}/Iframe/sound.d.ts +1 -1
  102. package/{Api → play/src/front/Api}/Iframe/state.d.ts +5 -6
  103. package/{Api → play/src/front/Api}/Iframe/ui.d.ts +50 -8
  104. package/{Api → play/src/front/Api}/Iframe/website.d.ts +4 -4
  105. package/play/src/front/Api/types.d.ts +3 -0
  106. package/play/src/iframe_api.d.ts +130 -0
  107. package/Api/Events/ChatEvent.d.ts +0 -44
  108. package/Api/Events/NotificationEvent.d.ts +0 -18
  109. package/Api/Events/SettingsEvent.d.ts +0 -12
  110. package/Api/Iframe/AbstractState.d.ts +0 -14
  111. package/Api/Iframe/Player/ProximityMeeting.d.ts +0 -85
  112. package/Api/Iframe/Ui/Menu.d.ts +0 -8
  113. package/Api/Iframe/chat.d.ts +0 -36
  114. package/Api/Iframe/controls.d.ts +0 -56
  115. package/Api/types.d.ts +0 -3
  116. /package/{Api → play/src/front/Api}/Iframe/Ui/ActionMessage.d.ts +0 -0
  117. /package/{Api → play/src/front/Api}/Iframe/Ui/Popup.d.ts +0 -0
@@ -5,17 +5,17 @@ export declare const isRectangle: z.ZodObject<{
5
5
  width: z.ZodNumber;
6
6
  height: z.ZodNumber;
7
7
  }, "strip", z.ZodTypeAny, {
8
+ height: number;
9
+ width: number;
8
10
  x: number;
9
11
  y: number;
10
- width: number;
11
- height: number;
12
12
  }, {
13
+ height: number;
14
+ width: number;
13
15
  x: number;
14
16
  y: number;
15
- width: number;
16
- height: number;
17
17
  }>;
18
- export declare type Rectangle = z.infer<typeof isRectangle>;
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>;
@@ -29,34 +29,34 @@ export declare const isEmbeddedWebsiteEvent: z.ZodObject<{
29
29
  origin: z.ZodOptional<z.ZodEnum<["player", "map"]>>;
30
30
  scale: z.ZodOptional<z.ZodNumber>;
31
31
  }, "strip", z.ZodTypeAny, {
32
+ name: string;
32
33
  url?: string | undefined;
34
+ height?: number | undefined;
35
+ width?: number | undefined;
33
36
  allowApi?: boolean | undefined;
34
37
  x?: number | undefined;
35
38
  y?: number | undefined;
36
- width?: number | undefined;
37
- height?: number | undefined;
38
39
  visible?: boolean | undefined;
39
40
  allow?: string | undefined;
40
- origin?: "player" | "map" | undefined;
41
+ origin?: "map" | "player" | undefined;
41
42
  scale?: number | undefined;
42
- name: string;
43
43
  }, {
44
+ name: string;
44
45
  url?: string | undefined;
46
+ height?: number | undefined;
47
+ width?: number | undefined;
45
48
  allowApi?: boolean | undefined;
46
49
  x?: number | undefined;
47
50
  y?: number | undefined;
48
- width?: number | undefined;
49
- height?: number | undefined;
50
51
  visible?: boolean | undefined;
51
52
  allow?: string | undefined;
52
- origin?: "player" | "map" | undefined;
53
+ origin?: "map" | "player" | undefined;
53
54
  scale?: number | undefined;
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 declare type ModifyEmbeddedWebsiteEvent = z.infer<typeof isEmbeddedWebsiteEvent>;
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;
@@ -66,15 +66,15 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
66
66
  width: z.ZodNumber;
67
67
  height: z.ZodNumber;
68
68
  }, "strip", z.ZodTypeAny, {
69
+ height: number;
70
+ width: number;
69
71
  x: number;
70
72
  y: number;
71
- width: number;
72
- height: number;
73
73
  }, {
74
+ height: number;
75
+ width: number;
74
76
  x: number;
75
77
  y: number;
76
- width: number;
77
- height: number;
78
78
  }>;
79
79
  visible: z.ZodOptional<z.ZodBoolean>;
80
80
  allowApi: z.ZodOptional<z.ZodBoolean>;
@@ -82,32 +82,32 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
82
82
  origin: z.ZodOptional<z.ZodEnum<["player", "map"]>>;
83
83
  scale: z.ZodOptional<z.ZodNumber>;
84
84
  }, "strip", z.ZodTypeAny, {
85
- allowApi?: boolean | undefined;
86
- visible?: boolean | undefined;
87
- allow?: string | undefined;
88
- origin?: "player" | "map" | undefined;
89
- scale?: number | undefined;
90
85
  url: string;
86
+ name: string;
91
87
  position: {
88
+ height: number;
89
+ width: number;
92
90
  x: number;
93
91
  y: number;
94
- width: number;
95
- height: number;
96
92
  };
97
- name: string;
98
- }, {
99
93
  allowApi?: boolean | undefined;
100
94
  visible?: boolean | undefined;
101
95
  allow?: string | undefined;
102
- origin?: "player" | "map" | undefined;
96
+ origin?: "map" | "player" | undefined;
103
97
  scale?: number | undefined;
98
+ }, {
104
99
  url: string;
100
+ name: string;
105
101
  position: {
102
+ height: number;
103
+ width: number;
106
104
  x: number;
107
105
  y: number;
108
- width: number;
109
- height: number;
110
106
  };
111
- name: string;
107
+ allowApi?: boolean | undefined;
108
+ visible?: boolean | undefined;
109
+ allow?: string | undefined;
110
+ origin?: "map" | "player" | undefined;
111
+ scale?: number | undefined;
112
112
  }>;
113
- export declare type CreateEmbeddedWebsiteEvent = z.infer<typeof isCreateEmbeddedWebsiteEvent>;
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 declare type EnablePlayersTrackingEvent = z.infer<typeof isEnablePlayersTrackingEvent>;
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 declare type EnterLeaveEvent = z.infer<typeof isEnterLeaveEvent>;
12
+ export type EnterLeaveEvent = z.infer<typeof isEnterLeaveEvent>;
@@ -1,6 +1,7 @@
1
1
  import { z } from "zod";
2
2
  export declare const isGameStateEvent: z.ZodObject<{
3
3
  roomId: z.ZodString;
4
+ hashParameters: z.ZodRecord<z.ZodString, z.ZodString>;
4
5
  mapUrl: z.ZodString;
5
6
  nickname: z.ZodString;
6
7
  language: z.ZodOptional<z.ZodString>;
@@ -12,34 +13,42 @@ export declare const isGameStateEvent: z.ZodObject<{
12
13
  playerVariables: z.ZodUnknown;
13
14
  userRoomToken: z.ZodOptional<z.ZodString>;
14
15
  metadata: z.ZodOptional<z.ZodUnknown>;
16
+ iframeId: z.ZodOptional<z.ZodString>;
17
+ isLogged: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
15
18
  }, "strip", z.ZodTypeAny, {
19
+ roomId: string;
20
+ hashParameters: Record<string, string>;
21
+ mapUrl: string;
22
+ nickname: string;
23
+ tags: string[];
24
+ isLogged: boolean;
25
+ uuid?: string | undefined;
16
26
  language?: string | undefined;
17
27
  playerId?: number | undefined;
18
- uuid?: string | undefined;
19
28
  startLayerName?: string | undefined;
20
29
  variables?: unknown;
21
30
  playerVariables?: unknown;
22
31
  userRoomToken?: string | undefined;
23
32
  metadata?: unknown;
33
+ iframeId?: string | undefined;
34
+ }, {
24
35
  roomId: string;
36
+ hashParameters: Record<string, string>;
25
37
  mapUrl: string;
26
38
  nickname: string;
27
39
  tags: string[];
28
- }, {
40
+ uuid?: string | undefined;
29
41
  language?: string | undefined;
30
42
  playerId?: number | undefined;
31
- uuid?: string | undefined;
32
43
  startLayerName?: string | undefined;
33
44
  variables?: unknown;
34
45
  playerVariables?: unknown;
35
46
  userRoomToken?: string | undefined;
36
47
  metadata?: unknown;
37
- roomId: string;
38
- mapUrl: string;
39
- nickname: string;
40
- tags: string[];
48
+ iframeId?: string | undefined;
49
+ isLogged?: boolean | undefined;
41
50
  }>;
42
51
  /**
43
52
  * A message sent from the game to the iFrame when the gameState is received by the script
44
53
  */
45
- export declare type GameStateEvent = z.infer<typeof isGameStateEvent>;
54
+ 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 declare type GoToPageEvent = z.infer<typeof isGoToPageEvent>;
12
+ export type GoToPageEvent = z.infer<typeof isGoToPageEvent>;
@@ -7,22 +7,22 @@ export declare const isHasPlayerMovedEvent: z.ZodObject<{
7
7
  oldX: z.ZodOptional<z.ZodNumber>;
8
8
  oldY: z.ZodOptional<z.ZodNumber>;
9
9
  }, "strip", z.ZodTypeAny, {
10
- oldX?: number | undefined;
11
- oldY?: number | undefined;
12
10
  x: number;
13
11
  y: number;
14
12
  direction: "left" | "right" | "up" | "down";
15
13
  moving: boolean;
16
- }, {
17
14
  oldX?: number | undefined;
18
15
  oldY?: number | undefined;
16
+ }, {
19
17
  x: number;
20
18
  y: number;
21
19
  direction: "left" | "right" | "up" | "down";
22
20
  moving: boolean;
21
+ oldX?: number | undefined;
22
+ oldY?: number | undefined;
23
23
  }>;
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 declare type HasPlayerMovedEvent = z.infer<typeof isHasPlayerMovedEvent>;
28
- export declare type HasPlayerMovedEventCallback = (event: HasPlayerMovedEvent) => void;
27
+ export type HasPlayerMovedEvent = z.infer<typeof isHasPlayerMovedEvent>;
28
+ export type HasPlayerMovedEventCallback = (event: HasPlayerMovedEvent) => void;