@rtsdk/topia 0.2.2 → 0.2.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 (58) hide show
  1. package/dist/index.cjs +1179 -41168
  2. package/dist/index.d.ts +1251 -0
  3. package/dist/index.js +194 -101
  4. package/package.json +5 -2
  5. package/dist/types/example.d.ts +0 -6
  6. package/dist/types/src/__mocks__/assets.d.ts +0 -99
  7. package/dist/types/src/__mocks__/index.d.ts +0 -4
  8. package/dist/types/src/__mocks__/scenes.d.ts +0 -79
  9. package/dist/types/src/__mocks__/visitors.d.ts +0 -83
  10. package/dist/types/src/__mocks__/worlds.d.ts +0 -73
  11. package/dist/types/src/controllers/Asset.d.ts +0 -20
  12. package/dist/types/src/controllers/DroppedAsset.d.ts +0 -285
  13. package/dist/types/src/controllers/SDKController.d.ts +0 -48
  14. package/dist/types/src/controllers/Scene.d.ts +0 -19
  15. package/dist/types/src/controllers/Topia.d.ts +0 -33
  16. package/dist/types/src/controllers/User.d.ts +0 -112
  17. package/dist/types/src/controllers/Visitor.d.ts +0 -102
  18. package/dist/types/src/controllers/World.d.ts +0 -143
  19. package/dist/types/src/controllers/WorldActivity.d.ts +0 -83
  20. package/dist/types/src/controllers/__tests__/asset.test.d.ts +0 -1
  21. package/dist/types/src/controllers/__tests__/droppedAsset.test.d.ts +0 -1
  22. package/dist/types/src/controllers/__tests__/scene.test.d.ts +0 -1
  23. package/dist/types/src/controllers/__tests__/user.test.d.ts +0 -1
  24. package/dist/types/src/controllers/__tests__/visitor.test.d.ts +0 -1
  25. package/dist/types/src/controllers/__tests__/world.test.d.ts +0 -1
  26. package/dist/types/src/controllers/__tests__/worldActivity.test.d.ts +0 -1
  27. package/dist/types/src/controllers/index.d.ts +0 -9
  28. package/dist/types/src/factories/AssetFactory.d.ts +0 -8
  29. package/dist/types/src/factories/DroppedAssetFactory.d.ts +0 -16
  30. package/dist/types/src/factories/SceneFactory.d.ts +0 -9
  31. package/dist/types/src/factories/UserFactory.d.ts +0 -8
  32. package/dist/types/src/factories/VisitorFactory.d.ts +0 -9
  33. package/dist/types/src/factories/WorldActivityFactory.d.ts +0 -8
  34. package/dist/types/src/factories/WorldFactory.d.ts +0 -8
  35. package/dist/types/src/factories/index.d.ts +0 -7
  36. package/dist/types/src/index.d.ts +0 -4
  37. package/dist/types/src/interfaces/AssetInterfaces.d.ts +0 -26
  38. package/dist/types/src/interfaces/DroppedAssetInterfaces.d.ts +0 -104
  39. package/dist/types/src/interfaces/SDKInterfaces.d.ts +0 -8
  40. package/dist/types/src/interfaces/SceneInterfaces.d.ts +0 -27
  41. package/dist/types/src/interfaces/TopiaInterfaces.d.ts +0 -10
  42. package/dist/types/src/interfaces/UserInterfaces.d.ts +0 -7
  43. package/dist/types/src/interfaces/VisitorInterfaces.d.ts +0 -37
  44. package/dist/types/src/interfaces/WorldActivityInterfaces.d.ts +0 -11
  45. package/dist/types/src/interfaces/WorldInterfaces.d.ts +0 -32
  46. package/dist/types/src/interfaces/index.d.ts +0 -9
  47. package/dist/types/src/types/DroppedAssetTypes.d.ts +0 -10
  48. package/dist/types/src/types/InteractiveCredentialsTypes.d.ts +0 -9
  49. package/dist/types/src/types/OptionsTypes.d.ts +0 -21
  50. package/dist/types/src/types/ResponseTypes.d.ts +0 -4
  51. package/dist/types/src/types/VisitorTypes.d.ts +0 -33
  52. package/dist/types/src/types/index.d.ts +0 -5
  53. package/dist/types/src/utils/__tests__/removeUndefined.test.d.ts +0 -1
  54. package/dist/types/src/utils/__tests__/scatterVisitors.test.d.ts +0 -1
  55. package/dist/types/src/utils/getBrowserWarning.d.ts +0 -1
  56. package/dist/types/src/utils/index.d.ts +0 -3
  57. package/dist/types/src/utils/removeUndefined.d.ts +0 -8
  58. package/dist/types/src/utils/scatterVisitors.d.ts +0 -4
@@ -1,104 +0,0 @@
1
- import { DroppedAssetClickType, DroppedAssetMediaType, InteractiveCredentials } from "types";
2
- import { AssetInterface } from "interfaces";
3
- export interface DroppedAssetInterface extends AssetInterface {
4
- id?: string;
5
- assetId?: string;
6
- assetScale?: number | null;
7
- assetPodium?: boolean | null;
8
- audioRadius?: number | null;
9
- assetBroadcastAll?: boolean | null;
10
- assetPrivateConversation?: boolean | null;
11
- assetPrivateZoneChannelDisabled?: boolean | null;
12
- assetPrivateConversationCap?: number | null;
13
- audioSliderVolume?: number | null;
14
- broadcasterEmail?: string | null;
15
- clickType?: string | null;
16
- clickableLink?: string | null;
17
- clickableLinkTitle?: string | null;
18
- clickablePortal?: string | null;
19
- creationDatetime?: number;
20
- contractAddress?: string | null;
21
- dataObject?: object | null;
22
- clickableDisplayTextDescription?: string | null;
23
- clickableDisplayTextHeadline?: string | null;
24
- existingKey?: string | null;
25
- interactivePublicKey?: string | null;
26
- isInteractive?: boolean | null;
27
- isVideoPlayer?: boolean | null;
28
- kitId?: string | null;
29
- layer0?: string | null;
30
- layer1?: string | null;
31
- mediaLink?: string | null;
32
- mediaPlayTime?: number | null;
33
- mediaType?: string | null;
34
- mediaName?: string | null;
35
- muteZone?: boolean | null;
36
- mediaUploadedId?: string | null;
37
- mediaUploadedLink?: string | null;
38
- metaName?: string | null;
39
- position?: {
40
- x?: number;
41
- y?: number;
42
- };
43
- portalCoordsX?: number | null;
44
- portalCoordsY?: number | null;
45
- showMediaAsIfPeer?: boolean | null;
46
- syncUserMedia?: boolean | null;
47
- urlSlug: string;
48
- tagJson?: string | null;
49
- text?: string | null;
50
- textColor?: string | null;
51
- textSize?: number | null;
52
- textWidth?: number | null;
53
- textWeight?: string | null;
54
- textFont?: string | null;
55
- textFontFamily?: string | null;
56
- teleportX?: number | null;
57
- teleportY?: number | null;
58
- tokenSymbol?: string | null;
59
- tokenName?: string | null;
60
- worldId?: string | null;
61
- walletAddress?: string | null;
62
- yOrderAdjust?: number | null;
63
- }
64
- export interface DroppedAssetOptionalInterface {
65
- attributes?: DroppedAssetInterface | {
66
- text: string;
67
- urlSlug?: string;
68
- };
69
- credentials?: InteractiveCredentials | object;
70
- }
71
- export interface UpdateBroadcastInterface {
72
- assetBroadcast?: boolean;
73
- assetBroadcastAll?: boolean;
74
- broadcasterEmail?: string;
75
- }
76
- export interface UpdateClickTypeInterface {
77
- clickType: DroppedAssetClickType;
78
- clickableLink: string;
79
- clickableLinkTitle: string;
80
- clickableDisplayTextDescription: string;
81
- clickableDisplayTextHeadline: string;
82
- isForceLinkInIframe?: boolean;
83
- isOpenLinkInDrawer?: boolean;
84
- portalName: string;
85
- position: {
86
- x: number;
87
- y: number;
88
- };
89
- }
90
- export interface UpdateMediaTypeInterface {
91
- audioRadius: number;
92
- audioSliderVolume: number;
93
- isVideo: boolean;
94
- mediaLink: string;
95
- mediaName: string;
96
- mediaType: DroppedAssetMediaType;
97
- portalName: string;
98
- syncUserMedia: boolean;
99
- }
100
- export interface UpdatePrivateZoneInterface {
101
- isPrivateZone: boolean;
102
- isPrivateZoneChatDisabled: boolean;
103
- privateZoneUserCap: number;
104
- }
@@ -1,8 +0,0 @@
1
- import { InteractiveCredentials } from "types";
2
- import { Topia } from "controllers";
3
- export interface SDKInterface {
4
- credentials?: InteractiveCredentials;
5
- jwt?: string;
6
- requestOptions: object;
7
- topia: Topia;
8
- }
@@ -1,27 +0,0 @@
1
- import { InteractiveCredentials } from "types";
2
- export interface SceneInterface {
3
- id: string;
4
- background?: null;
5
- description?: string;
6
- created?: {
7
- _seconds?: number;
8
- _nanoseconds?: number;
9
- };
10
- height?: number;
11
- kitWorldOwner?: string;
12
- name?: string;
13
- price?: number;
14
- spawnPosition?: {
15
- radius?: number;
16
- y?: number;
17
- x?: number;
18
- };
19
- timesUsed?: number;
20
- urlSlug?: string;
21
- width?: number;
22
- worldCenteredAtZero?: boolean;
23
- }
24
- export type SceneOptionalInterface = {
25
- attributes?: SceneInterface | object;
26
- credentials?: InteractiveCredentials | object;
27
- };
@@ -1,10 +0,0 @@
1
- import { AxiosInstance } from "axios";
2
- import jwt from "jsonwebtoken";
3
- export interface TopiaInterface {
4
- apiDomain?: string;
5
- apiKey?: string;
6
- apiProtocol?: string;
7
- axios: AxiosInstance;
8
- interactiveKey?: string;
9
- interactiveSecret?: jwt.Secret;
10
- }
@@ -1,7 +0,0 @@
1
- import { InteractiveCredentials } from "types";
2
- export interface UserOptionalInterface {
3
- credentials?: InteractiveCredentials | object;
4
- profileId?: string | null;
5
- visitorId?: number | null;
6
- urlSlug?: string;
7
- }
@@ -1,37 +0,0 @@
1
- import { InteractiveCredentials } from "types";
2
- import { SDKInterface } from "interfaces/SDKInterfaces";
3
- export interface VisitorInterface extends SDKInterface {
4
- color?: string;
5
- displayName?: string;
6
- gestureType?: number;
7
- hidden?: boolean;
8
- isAdmin?: boolean;
9
- isBackground?: boolean;
10
- isMobile?: boolean;
11
- isRecording?: boolean;
12
- isRecordingBot?: boolean;
13
- lastUpdate?: number | undefined;
14
- moveFrom?: object;
15
- movedOn?: number | undefined;
16
- moveTo?: {
17
- x?: number;
18
- y?: number;
19
- };
20
- muted?: boolean;
21
- performer?: boolean;
22
- performerNear?: boolean;
23
- id?: number | undefined;
24
- shareScreen?: boolean;
25
- sitting?: boolean;
26
- urlSlug: string;
27
- username?: string | undefined;
28
- }
29
- export interface VisitorOptionalInterface {
30
- attributes?: VisitorInterface | object;
31
- credentials?: InteractiveCredentials | object;
32
- }
33
- export interface MoveVisitorInterface {
34
- shouldTeleportVisitor: boolean;
35
- x: number;
36
- y: number;
37
- }
@@ -1,11 +0,0 @@
1
- import { InteractiveCredentials } from "types";
2
- export interface WorldActivityOptionalInterface {
3
- credentials?: InteractiveCredentials | object;
4
- }
5
- export interface MoveAllVisitorsInterface {
6
- shouldFetchVisitors?: boolean;
7
- shouldTeleportVisitors?: boolean;
8
- scatterVisitorsBy?: number;
9
- x: number;
10
- y: number;
11
- }
@@ -1,32 +0,0 @@
1
- import { InteractiveCredentials } from "types";
2
- import { SDKInterface } from "interfaces/SDKInterfaces";
3
- export interface WorldInterface extends SDKInterface {
4
- background?: string | null;
5
- controls?: {
6
- allowMuteAll?: boolean;
7
- disableHideVideo?: boolean;
8
- isMobileDisabled?: boolean;
9
- isShowingCurrentGuests?: boolean;
10
- };
11
- created?: object;
12
- description?: string;
13
- enforceWhitelistOnLogin?: boolean;
14
- forceAuthOnLogin?: boolean;
15
- height?: number;
16
- heroImage?: string;
17
- mapExists?: boolean;
18
- name?: string;
19
- redirectTo?: string | null;
20
- spawnPosition?: {
21
- x?: number;
22
- y?: number;
23
- };
24
- tileBackgroundEverywhere?: boolean | null;
25
- urlSlug: string;
26
- useTopiaPassword?: boolean;
27
- width?: number;
28
- }
29
- export interface WorldOptionalInterface {
30
- attributes?: WorldInterface | object;
31
- credentials?: InteractiveCredentials | object;
32
- }
@@ -1,9 +0,0 @@
1
- export * from "./AssetInterfaces";
2
- export * from "./DroppedAssetInterfaces";
3
- export * from "./SceneInterfaces";
4
- export * from "./SDKInterfaces";
5
- export * from "./TopiaInterfaces";
6
- export * from "./UserInterfaces";
7
- export * from "./VisitorInterfaces";
8
- export * from "./WorldActivityInterfaces";
9
- export * from "./WorldInterfaces";
@@ -1,10 +0,0 @@
1
- export declare enum DroppedAssetClickType {
2
- NONE = "none",
3
- LINK = "link",
4
- PORTAL = "portal",
5
- TELEPORT = "teleport"
6
- }
7
- export declare enum DroppedAssetMediaType {
8
- NONE = "none",
9
- LINK = "link"
10
- }
@@ -1,9 +0,0 @@
1
- export type InteractiveCredentials = {
2
- assetId?: string;
3
- interactiveNonce?: string;
4
- interactivePublicKey?: string;
5
- visitorId?: number;
6
- urlSlug?: string;
7
- apiKey?: string;
8
- profileId?: string | null;
9
- };
@@ -1,21 +0,0 @@
1
- import { AssetInterface, DroppedAssetInterface, VisitorInterface, WorldInterface } from "interfaces";
2
- import { InteractiveCredentials } from "./InteractiveCredentialsTypes";
3
- export type AssetOptions = {
4
- attributes?: AssetInterface | undefined;
5
- credentials?: InteractiveCredentials | undefined;
6
- };
7
- export type DroppedAssetOptions = {
8
- attributes?: DroppedAssetInterface | undefined;
9
- credentials?: InteractiveCredentials | undefined;
10
- };
11
- export type UserOptions = {
12
- credentials?: InteractiveCredentials | undefined;
13
- };
14
- export type VisitorOptions = {
15
- attributes?: VisitorInterface | undefined;
16
- credentials?: InteractiveCredentials | undefined;
17
- };
18
- export type WorldOptions = {
19
- attributes?: WorldInterface | undefined;
20
- credentials?: InteractiveCredentials | undefined;
21
- };
@@ -1,4 +0,0 @@
1
- export type ResponseType = {
2
- message: string;
3
- success: boolean;
4
- };
@@ -1,33 +0,0 @@
1
- import Visitor from "../controllers/Visitor";
2
- export type VisitorType = {
3
- visitorId: number;
4
- color: string;
5
- displayName: string;
6
- gestureType: number;
7
- hidden: boolean;
8
- isAdmin: boolean;
9
- isBackground: boolean;
10
- isMobile: boolean;
11
- isRecording: boolean;
12
- isRecordingBot: boolean;
13
- lastUpdate: number;
14
- moveFrom: object;
15
- movedOn: number;
16
- moveTo: {
17
- x: number;
18
- y: number;
19
- };
20
- muted: boolean;
21
- performer: boolean;
22
- performerNear: boolean;
23
- shareScreen: boolean;
24
- sitting: boolean;
25
- username: string;
26
- };
27
- export type VisitorsToMoveType = {
28
- visitorObj: Visitor;
29
- shouldTeleportVisitor: boolean;
30
- x: number;
31
- y: number;
32
- };
33
- export type VisitorsToMoveArrayType = Array<VisitorsToMoveType>;
@@ -1,5 +0,0 @@
1
- export * from "./DroppedAssetTypes";
2
- export * from "./InteractiveCredentialsTypes";
3
- export * from "./OptionsTypes";
4
- export * from "./ResponseTypes";
5
- export * from "./VisitorTypes";
@@ -1 +0,0 @@
1
- export declare const getBrowserWarning: () => void;
@@ -1,3 +0,0 @@
1
- export { getBrowserWarning } from "./getBrowserWarning";
2
- export { removeUndefined } from "./removeUndefined";
3
- export { scatterVisitors } from "./scatterVisitors";
@@ -1,8 +0,0 @@
1
- /**
2
- * Parses object, removes keys with undefined value, and returns clean object.
3
- */
4
- export declare const removeUndefined: (obj: {
5
- [key: string]: any;
6
- }) => {
7
- [key: string]: any;
8
- };
@@ -1,4 +0,0 @@
1
- /**
2
- * Returns a random whole number within range of (original number - scatterBy) to (original number + scatterBy)
3
- */
4
- export declare const scatterVisitors: (original: number, scatterBy: number) => number;