@workadventure/iframe-api-typings 1.17.2 → 1.17.4

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 (5) hide show
  1. package/front/Api/Events/IframeEvent.d.ts +23 -10
  2. package/front/Api/Events/TeleportPlayerToEvent.d.ts +12 -0
  3. package/front/Api/Events/Ui/BannerEvent.d.ts +4 -4
  4. package/front/Api/Iframe/player.d.ts +1 -0
  5. package/package.json +1 -1
package/front/Api/Events/IframeEvent.d.ts CHANGED
@@ -1250,8 +1250,8 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
1250
1250
  text: z.ZodString;
1251
1251
  bgColor: z.ZodOptional<z.ZodString>;
1252
1252
  textColor: z.ZodOptional<z.ZodString>;
1253
- closable: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
1254
- timeToClose: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
1253
+ closable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
1254
+ timeToClose: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
1255
1255
  link: z.ZodOptional<z.ZodObject<{
1256
1256
  url: z.ZodString;
1257
1257
  label: z.ZodString;
@@ -1267,12 +1267,12 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
1267
1267
  url: string;
1268
1268
  label: string;
1269
1269
  } | undefined;
1270
+ closable?: boolean | undefined;
1270
1271
  bgColor?: string | undefined;
1271
1272
  textColor?: string | undefined;
1273
+ timeToClose?: number | undefined;
1272
1274
  text: string;
1273
- closable: boolean;
1274
1275
  id: string;
1275
- timeToClose: number;
1276
1276
  }, {
1277
1277
  link?: {
1278
1278
  url: string;
@@ -1292,12 +1292,12 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
1292
1292
  url: string;
1293
1293
  label: string;
1294
1294
  } | undefined;
1295
+ closable?: boolean | undefined;
1295
1296
  bgColor?: string | undefined;
1296
1297
  textColor?: string | undefined;
1298
+ timeToClose?: number | undefined;
1297
1299
  text: string;
1298
- closable: boolean;
1299
1300
  id: string;
1300
- timeToClose: number;
1301
1301
  };
1302
1302
  }, {
1303
1303
  type: "openBanner";
@@ -3151,6 +3151,19 @@ export declare const iframeQueryMapTypeGuards: {
3151
3151
  cancelled: boolean;
3152
3152
  }>;
3153
3153
  };
3154
+ teleportPlayerTo: {
3155
+ query: z.ZodObject<{
3156
+ x: z.ZodNumber;
3157
+ y: z.ZodNumber;
3158
+ }, "strip", z.ZodTypeAny, {
3159
+ x: number;
3160
+ y: number;
3161
+ }, {
3162
+ x: number;
3163
+ y: number;
3164
+ }>;
3165
+ answer: z.ZodUndefined;
3166
+ };
3154
3167
  openUIWebsite: {
3155
3168
  query: z.ZodObject<{
3156
3169
  url: z.ZodString;
@@ -3565,15 +3578,15 @@ export interface IframeQueryWrapper<T extends keyof IframeQueryMap> {
3565
3578
  id: number;
3566
3579
  query: IframeQuery<T>;
3567
3580
  }
3568
- export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka";
3569
- export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
3570
- export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
3581
+ export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka";
3582
+ export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
3583
+ export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
3571
3584
  export interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
3572
3585
  id: number;
3573
3586
  type: T;
3574
3587
  data: IframeQueryMap[T]["answer"];
3575
3588
  }
3576
- export declare const isIframeAnswerEvent: (event: any) => event is IframeAnswerEvent<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
3589
+ export declare const isIframeAnswerEvent: (event: any) => event is IframeAnswerEvent<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
3577
3590
  export declare const isIframeErrorAnswerEvent: z.ZodObject<{
3578
3591
  id: z.ZodNumber;
3579
3592
  type: z.ZodString;
package/front/Api/Events/TeleportPlayerToEvent.d.ts ADDED
@@ -0,0 +1,12 @@
1
+ import { z } from "zod";
2
+ export declare const isTeleportPlayerToEventConfig: z.ZodObject<{
3
+ x: z.ZodNumber;
4
+ y: z.ZodNumber;
5
+ }, "strip", z.ZodTypeAny, {
6
+ x: number;
7
+ y: number;
8
+ }, {
9
+ x: number;
10
+ y: number;
11
+ }>;
12
+ export type TeleportPlayerToEvent = z.infer<typeof isTeleportPlayerToEventConfig>;
package/front/Api/Events/Ui/BannerEvent.d.ts CHANGED
@@ -4,8 +4,8 @@ export declare const isBannerEvent: z.ZodObject<{
4
4
  text: z.ZodString;
5
5
  bgColor: z.ZodOptional<z.ZodString>;
6
6
  textColor: z.ZodOptional<z.ZodString>;
7
- closable: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
8
- timeToClose: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
7
+ closable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
8
+ timeToClose: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
9
9
  link: z.ZodOptional<z.ZodObject<{
10
10
  url: z.ZodString;
11
11
  label: z.ZodString;
@@ -21,12 +21,12 @@ export declare const isBannerEvent: z.ZodObject<{
21
21
  url: string;
22
22
  label: string;
23
23
  } | undefined;
24
+ closable?: boolean | undefined;
24
25
  bgColor?: string | undefined;
25
26
  textColor?: string | undefined;
27
+ timeToClose?: number | undefined;
26
28
  text: string;
27
- closable: boolean;
28
29
  id: string;
29
- timeToClose: number;
30
30
  }, {
31
31
  link?: {
32
32
  url: string;
package/front/Api/Iframe/player.d.ts CHANGED
@@ -102,6 +102,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
102
102
  y: number;
103
103
  cancelled: boolean;
104
104
  }>;
105
+ teleport(x: number, y: number): Promise<void>;
105
106
  /**
106
107
  * This token can be used by third party services to authenticate a player and prove that the player is in a given room.
107
108
  * The token is generated by the administration panel linked to WorkAdventure.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workadventure/iframe-api-typings",
3
- "version": "v1.17.2",
3
+ "version": "v1.17.4",
4
4
  "description": "Typescript typings for WorkAdventure iFrame API",
5
5
  "main": "iframe_api.js",
6
6
  "types": "iframe_api.d.ts",