@rtsdk/topia 0.0.31 → 0.1.1

package/dist/types/src/controllers/WorldActivity.d.ts

@@ -0,0 +1,83 @@
+import { SDKController } from "controllers/SDKController";
+import { Topia } from "controllers/Topia";
+import { Visitor } from "controllers/Visitor";
+import { MoveAllVisitorsInterface, WorldActivityOptionalInterface } from "interfaces";
+import { ResponseType, VisitorsToMoveArrayType } from "types";
+/**
+ * @summary
+ * Create an instance of WorldActivity class with a given url slug and optional attributes and session credentials.
+ *
+ * This class is responsible for all activity of a specified world including editing dropped assets, moving current visitors, etc.
+ *
+ * @usage
+ * ```ts
+ * await new WorldActivity(topia, "exampleWorld", { attributes: { name: "Example World" } });
+ * ```
+ */
+export declare class WorldActivity extends SDKController {
+    #private;
+    urlSlug: string;
+    constructor(topia: Topia, urlSlug: string, options?: WorldActivityOptionalInterface);
+    get visitors(): {
+        [key: string]: Visitor;
+    };
+    private fetchVisitors;
+    /**
+     * @summary
+     * Retrieve all visitors currently in a world.
+     *
+     * @usage
+     * ```ts
+     * const visitors = await world.currentVisitors();
+     * ```
+     */
+    currentVisitors(): Promise<unknown>;
+    /**
+     * @summary
+     * Move all visitors currently in a world to a single set of coordinates.
+     * Optionally refetch visitors, teleport or walk visitors to new location,
+     * and scatter visitors by any number so that they don't all move to the exact same location.
+     *
+     * @usage
+     * ```ts
+     * await world.moveAllVisitors({
+     *   shouldFetchVisitors: true,
+     *   shouldTeleportVisitors: true,
+     *   scatterVisitorsBy: 40,
+     *   x: 100,
+     *   y: 100,
+     * });
+     * ```
+     *
+     * @result
+     * Updates each Visitor instance and world.visitors map.
+     */
+    moveAllVisitors({ shouldFetchVisitors, shouldTeleportVisitors, scatterVisitorsBy, x, y, }: MoveAllVisitorsInterface): Promise<(void | ResponseType)[] | undefined>;
+    /**
+     * @summary
+     * Teleport or walk a list of visitors currently in a world to various coordinates.
+     *
+     * @usage
+     * ```ts
+     * const visitorsToMove = [
+     *   {
+     *     visitorObj: world.visitors["1"],
+     *     shouldTeleportVisitor: true,
+     *     x: 100,
+     *     y: 100
+     *   }, {
+     *     visitorObj: world.visitors["2"],
+     *     shouldTeleportVisitor: false,
+     *     x: 100,
+     *     y: 100
+     *   }
+     * ];
+     * await world.moveVisitors(visitorsToMove);
+     * ```
+     *
+     * @result
+     * Updates each Visitor instance and world.visitors map.
+     */
+    moveVisitors(visitorsToMove: VisitorsToMoveArrayType): Promise<(void | ResponseType)[]>;
+}
+export default WorldActivity;

package/dist/{src/interfaces/AssetInterfaces.js → types/src/controllers/__tests__/asset.test.d.ts}

@@ -1 +1 @@
-export {};
+export {};

package/dist/{src/interfaces/DroppedAssetInterfaces.js → types/src/controllers/__tests__/droppedAsset.test.d.ts}

@@ -1 +1 @@
-export {};
+export {};

package/dist/{src/interfaces/SDKInterfaces.js → types/src/controllers/__tests__/scene.test.d.ts}

@@ -1 +1 @@
-export {};
+export {};

package/dist/{src/interfaces/SceneInterfaces.js → types/src/controllers/__tests__/user.test.d.ts}

@@ -1 +1 @@
-export {};
+export {};

package/dist/types/src/controllers/__tests__/visitor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/controllers/__tests__/world.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/controllers/__tests__/worldActivity.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/{src/controllers/index.js → types/src/controllers/index.d.ts}

@@ -1,9 +1,9 @@
-export { Asset } from "./Asset";
-export { DroppedAsset } from "./DroppedAsset";
-export { Scene } from "./Scene";
-export { SDKController } from "./SDKController";
-export { User } from "./User";
-export { Visitor } from "./Visitor";
-export { World } from "./World";
-export { WorldActivity } from "./WorldActivity";
-export { Topia } from "./Topia";
+export { Asset } from "./Asset";
+export { DroppedAsset } from "./DroppedAsset";
+export { Scene } from "./Scene";
+export { SDKController } from "./SDKController";
+export { User } from "./User";
+export { Visitor } from "./Visitor";
+export { World } from "./World";
+export { WorldActivity } from "./WorldActivity";
+export { Topia } from "./Topia";

package/dist/types/src/factories/AssetFactory.d.ts

@@ -0,0 +1,8 @@
+import { Asset, Topia } from "controllers";
+import { AssetOptionalInterface } from "interfaces";
+export declare class AssetFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    create(id: string, options?: AssetOptionalInterface): Asset;
+}
+export default AssetFactory;

package/dist/types/src/factories/DroppedAssetFactory.d.ts

@@ -0,0 +1,16 @@
+import { DroppedAsset, Topia, Asset, SDKController } from "controllers";
+import { DroppedAssetOptionalInterface } from "interfaces";
+export declare class DroppedAssetFactory extends SDKController {
+    constructor(topia: Topia);
+    create(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): DroppedAsset;
+    get(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): Promise<DroppedAsset>;
+    drop(asset: Asset, { position: { x, y }, uniqueName, urlSlug, }: {
+        position: {
+            x: number;
+            y: number;
+        };
+        uniqueName?: string;
+        urlSlug: string;
+    }): Promise<DroppedAsset>;
+}
+export default DroppedAssetFactory;

package/dist/types/src/factories/SceneFactory.d.ts

@@ -0,0 +1,9 @@
+import { Scene, Topia } from "controllers";
+import { SceneOptionalInterface } from "interfaces";
+export declare class SceneFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    create(id: string, options?: SceneOptionalInterface): Scene;
+    get(id: string, options?: SceneOptionalInterface): Promise<Scene>;
+}
+export default SceneFactory;

package/dist/types/src/factories/UserFactory.d.ts

@@ -0,0 +1,8 @@
+import { Topia, User } from "controllers";
+import { UserOptionalInterface } from "interfaces";
+export declare class UserFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    create(options?: UserOptionalInterface): User;
+}
+export default UserFactory;

package/dist/types/src/factories/VisitorFactory.d.ts

@@ -0,0 +1,9 @@
+import { Topia, Visitor } from "controllers";
+import { VisitorOptionalInterface } from "interfaces";
+export declare class VisitorFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    create(id: number, urlSlug: string, options?: VisitorOptionalInterface): Visitor;
+    get(id: number, urlSlug: string, options?: VisitorOptionalInterface): Promise<Visitor>;
+}
+export default VisitorFactory;

package/dist/types/src/factories/WorldActivityFactory.d.ts

@@ -0,0 +1,8 @@
+import { Topia, WorldActivity } from "controllers";
+import { WorldOptionalInterface } from "interfaces";
+export declare class WorldActivityFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    create(urlSlug: string, options?: WorldOptionalInterface): WorldActivity;
+}
+export default WorldActivityFactory;

package/dist/types/src/factories/WorldFactory.d.ts

@@ -0,0 +1,8 @@
+import { Topia, World } from "controllers";
+import { WorldOptionalInterface } from "interfaces";
+export declare class WorldFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    create(urlSlug: string, options?: WorldOptionalInterface): World;
+}
+export default WorldFactory;

package/dist/{src/factories/index.js → types/src/factories/index.d.ts}

@@ -1,7 +1,7 @@
-export { AssetFactory } from "./AssetFactory";
-export { DroppedAssetFactory } from "./DroppedAssetFactory";
-export { SceneFactory } from "./SceneFactory";
-export { UserFactory } from "./UserFactory";
-export { VisitorFactory } from "./VisitorFactory";
-export { WorldActivityFactory } from "./WorldActivityFactory";
-export { WorldFactory } from "./WorldFactory";
+export { AssetFactory } from "./AssetFactory";
+export { DroppedAssetFactory } from "./DroppedAssetFactory";
+export { SceneFactory } from "./SceneFactory";
+export { UserFactory } from "./UserFactory";
+export { VisitorFactory } from "./VisitorFactory";
+export { WorldActivityFactory } from "./WorldActivityFactory";
+export { WorldFactory } from "./WorldFactory";

package/dist/types/src/index.d.ts

@@ -0,0 +1,4 @@
+export { Topia } from "controllers";
+export { AssetFactory, DroppedAssetFactory, SceneFactory, UserFactory, VisitorFactory, WorldActivityFactory, WorldFactory, } from "factories";
+export type { AssetOptions, DroppedAssetClickType, DroppedAssetMediaType, DroppedAssetOptions, InteractiveCredentials, ResponseType, UserOptions, VisitorOptions, VisitorType, VisitorsToMoveType, VisitorsToMoveArrayType, WorldOptions, } from "types";
+export * from "interfaces";

package/dist/types/src/interfaces/AssetInterfaces.d.ts

@@ -0,0 +1,26 @@
+import { InteractiveCredentials } from "types";
+import { SDKInterface } from "interfaces/SDKInterfaces";
+export interface AssetInterface extends SDKInterface {
+    fetchPlatformAssets(): Promise<object>;
+    addedOn?: string;
+    assetName?: string;
+    creatorTags?: object;
+    readonly id?: string;
+    isPublic?: boolean;
+    library?: string;
+    originalAssetId?: string;
+    originalKit?: string;
+    ownerId?: string;
+    ownerName?: string;
+    platformAsset?: boolean;
+    purchased?: boolean;
+    purchaseDate?: string;
+    purchasedFrom?: string;
+    specialType?: string | null;
+    transactionId?: string;
+    type?: string;
+}
+export type AssetOptionalInterface = {
+    attributes?: AssetInterface | object;
+    credentials?: InteractiveCredentials | object;
+};

package/dist/types/src/interfaces/DroppedAssetInterfaces.d.ts

@@ -0,0 +1,102 @@
+import { DroppedAssetClickType, DroppedAssetMediaType, InteractiveCredentials } from "types";
+import { AssetInterface } from "interfaces";
+export interface DroppedAssetInterface extends AssetInterface {
+    id?: string;
+    assetId?: string;
+    assetScale?: number | null;
+    assetPodium?: boolean | null;
+    audioRadius?: number | null;
+    assetBroadcastAll?: boolean | null;
+    assetPrivateConversation?: boolean | null;
+    assetPrivateZoneChannelDisabled?: boolean | null;
+    assetPrivateConversationCap?: number | null;
+    audioSliderVolume?: number | null;
+    broadcasterEmail?: string | null;
+    clickType?: string | null;
+    clickableLink?: string | null;
+    clickableLinkTitle?: string | null;
+    clickablePortal?: string | null;
+    creationDatetime?: number;
+    contractAddress?: string | null;
+    dataObject?: object | null;
+    clickableDisplayTextDescription?: string | null;
+    clickableDisplayTextHeadline?: string | null;
+    existingKey?: string | null;
+    interactivePublicKey?: string | null;
+    isInteractive?: boolean | null;
+    isVideoPlayer?: boolean | null;
+    kitId?: string | null;
+    layer0?: string | null;
+    layer1?: string | null;
+    mediaLink?: string | null;
+    mediaPlayTime?: number | null;
+    mediaType?: string | null;
+    mediaName?: string | null;
+    muteZone?: boolean | null;
+    mediaUploadedId?: string | null;
+    mediaUploadedLink?: string | null;
+    metaName?: string | null;
+    position?: {
+        x?: number;
+        y?: number;
+    };
+    portalCoordsX?: number | null;
+    portalCoordsY?: number | null;
+    showMediaAsIfPeer?: boolean | null;
+    syncUserMedia?: boolean | null;
+    urlSlug: string;
+    tagJson?: string | null;
+    text?: string | null;
+    textColor?: string | null;
+    textSize?: number | null;
+    textWidth?: number | null;
+    textWeight?: string | null;
+    textFont?: string | null;
+    textFontFamily?: string | null;
+    teleportX?: number | null;
+    teleportY?: number | null;
+    tokenSymbol?: string | null;
+    tokenName?: string | null;
+    worldId?: string | null;
+    walletAddress?: string | null;
+    yOrderAdjust?: number | null;
+}
+export interface DroppedAssetOptionalInterface {
+    attributes?: DroppedAssetInterface | {
+        text: string;
+        urlSlug?: string;
+    };
+    credentials?: InteractiveCredentials | object;
+}
+export interface UpdateBroadcastInterface {
+    assetBroadcast?: boolean;
+    assetBroadcastAll?: boolean;
+    broadcasterEmail?: string;
+}
+export interface UpdateClickTypeInterface {
+    clickType: DroppedAssetClickType;
+    clickableLink: string;
+    clickableLinkTitle: string;
+    clickableDisplayTextDescription: string;
+    clickableDisplayTextHeadline: string;
+    portalName: string;
+    position: {
+        x: number;
+        y: number;
+    };
+}
+export interface UpdateMediaTypeInterface {
+    audioRadius: number;
+    audioSliderVolume: number;
+    isVideo: boolean;
+    mediaLink: string;
+    mediaName: string;
+    mediaType: DroppedAssetMediaType;
+    portalName: string;
+    syncUserMedia: boolean;
+}
+export interface UpdatePrivateZoneInterface {
+    isPrivateZone: boolean;
+    isPrivateZoneChatDisabled: boolean;
+    privateZoneUserCap: number;
+}

package/dist/types/src/interfaces/SDKInterfaces.d.ts

@@ -0,0 +1,8 @@
+import { InteractiveCredentials } from "types";
+import { Topia } from "controllers";
+export interface SDKInterface {
+    credentials?: InteractiveCredentials;
+    jwt?: string;
+    requestOptions: object;
+    topia: Topia;
+}

package/dist/types/src/interfaces/SceneInterfaces.d.ts

@@ -0,0 +1,27 @@
+import { InteractiveCredentials } from "types";
+export interface SceneInterface {
+    id: string;
+    background?: null;
+    description?: string;
+    created?: {
+        _seconds?: number;
+        _nanoseconds?: number;
+    };
+    height?: number;
+    kitWorldOwner?: string;
+    name?: string;
+    price?: number;
+    spawnPosition?: {
+        radius?: number;
+        y?: number;
+        x?: number;
+    };
+    timesUsed?: number;
+    urlSlug?: string;
+    width?: number;
+    worldCenteredAtZero?: boolean;
+}
+export type SceneOptionalInterface = {
+    attributes?: SceneInterface | object;
+    credentials?: InteractiveCredentials | object;
+};

package/dist/types/src/interfaces/TopiaInterfaces.d.ts

@@ -0,0 +1,10 @@
+import { AxiosInstance } from "axios";
+import jwt from "jsonwebtoken";
+export interface TopiaInterface {
+    apiDomain?: string;
+    apiKey?: string;
+    apiProtocol?: string;
+    axios: AxiosInstance;
+    interactiveKey?: string;
+    interactiveSecret?: jwt.Secret;
+}

package/dist/types/src/interfaces/UserInterfaces.d.ts

@@ -0,0 +1,6 @@
+import { InteractiveCredentials } from "types";
+export interface UserOptionalInterface {
+    credentials?: InteractiveCredentials | object;
+    visitorId?: number | null;
+    urlSlug?: string;
+}

package/dist/types/src/interfaces/VisitorInterfaces.d.ts

@@ -0,0 +1,37 @@
+import { InteractiveCredentials } from "types";
+import { SDKInterface } from "interfaces/SDKInterfaces";
+export interface VisitorInterface extends SDKInterface {
+    color?: string;
+    displayName?: string;
+    gestureType?: number;
+    hidden?: boolean;
+    isAdmin?: boolean;
+    isBackground?: boolean;
+    isMobile?: boolean;
+    isRecording?: boolean;
+    isRecordingBot?: boolean;
+    lastUpdate?: number | undefined;
+    moveFrom?: object;
+    movedOn?: number | undefined;
+    moveTo?: {
+        x?: number;
+        y?: number;
+    };
+    muted?: boolean;
+    performer?: boolean;
+    performerNear?: boolean;
+    id?: number | undefined;
+    shareScreen?: boolean;
+    sitting?: boolean;
+    urlSlug: string;
+    username?: string | undefined;
+}
+export interface VisitorOptionalInterface {
+    attributes?: VisitorInterface | object;
+    credentials?: InteractiveCredentials | object;
+}
+export interface MoveVisitorInterface {
+    shouldTeleportVisitor: boolean;
+    x: number;
+    y: number;
+}

package/dist/types/src/interfaces/WorldActivityInterfaces.d.ts

@@ -0,0 +1,11 @@
+import { InteractiveCredentials } from "types";
+export interface WorldActivityOptionalInterface {
+    credentials?: InteractiveCredentials | object;
+}
+export interface MoveAllVisitorsInterface {
+    shouldFetchVisitors?: boolean;
+    shouldTeleportVisitors?: boolean;
+    scatterVisitorsBy?: number;
+    x: number;
+    y: number;
+}

package/dist/types/src/interfaces/WorldInterfaces.d.ts

@@ -0,0 +1,32 @@
+import { InteractiveCredentials } from "types";
+import { SDKInterface } from "interfaces/SDKInterfaces";
+export interface WorldInterface extends SDKInterface {
+    background?: string | null;
+    controls?: {
+        allowMuteAll?: boolean;
+        disableHideVideo?: boolean;
+        isMobileDisabled?: boolean;
+        isShowingCurrentGuests?: boolean;
+    };
+    created?: object;
+    description?: string;
+    enforceWhitelistOnLogin?: boolean;
+    forceAuthOnLogin?: boolean;
+    height?: number;
+    heroImage?: string;
+    mapExists?: boolean;
+    name?: string;
+    redirectTo?: string | null;
+    spawnPosition?: {
+        x?: number;
+        y?: number;
+    };
+    tileBackgroundEverywhere?: boolean | null;
+    urlSlug: string;
+    useTopiaPassword?: boolean;
+    width?: number;
+}
+export interface WorldOptionalInterface {
+    attributes?: WorldInterface | object;
+    credentials?: InteractiveCredentials | object;
+}

package/dist/{src/interfaces/index.js → types/src/interfaces/index.d.ts}

@@ -1,9 +1,9 @@
-export * from "./AssetInterfaces";
-export * from "./DroppedAssetInterfaces";
-export * from "./SceneInterfaces";
-export * from "./SDKInterfaces";
-export * from "./TopiaInterfaces";
-export * from "./UserInterfaces";
-export * from "./VisitorInterfaces";
-export * from "./WorldActivityInterfaces";
-export * from "./WorldInterfaces";
+export * from "./AssetInterfaces";
+export * from "./DroppedAssetInterfaces";
+export * from "./SceneInterfaces";
+export * from "./SDKInterfaces";
+export * from "./TopiaInterfaces";
+export * from "./UserInterfaces";
+export * from "./VisitorInterfaces";
+export * from "./WorldActivityInterfaces";
+export * from "./WorldInterfaces";

package/dist/types/src/types/DroppedAssetTypes.d.ts

@@ -0,0 +1,10 @@
+export declare enum DroppedAssetClickType {
+    NONE = "none",
+    LINK = "link",
+    PORTAL = "portal",
+    TELEPORT = "teleport"
+}
+export declare enum DroppedAssetMediaType {
+    NONE = "none",
+    LINK = "link"
+}

package/dist/types/src/types/InteractiveCredentialsTypes.d.ts

@@ -0,0 +1,8 @@
+export type InteractiveCredentials = {
+    assetId?: string;
+    interactiveNonce?: string;
+    interactivePublicKey?: string;
+    visitorId?: number;
+    urlSlug?: string;
+    apiKey?: string;
+};

package/dist/types/src/types/OptionsTypes.d.ts

@@ -0,0 +1,21 @@
+import { AssetInterface, DroppedAssetInterface, VisitorInterface, WorldInterface } from "interfaces";
+import { InteractiveCredentials } from "./InteractiveCredentialsTypes";
+export type AssetOptions = {
+    attributes?: AssetInterface | undefined;
+    credentials?: InteractiveCredentials | undefined;
+};
+export type DroppedAssetOptions = {
+    attributes?: DroppedAssetInterface | undefined;
+    credentials?: InteractiveCredentials | undefined;
+};
+export type UserOptions = {
+    credentials?: InteractiveCredentials | undefined;
+};
+export type VisitorOptions = {
+    attributes?: VisitorInterface | undefined;
+    credentials?: InteractiveCredentials | undefined;
+};
+export type WorldOptions = {
+    attributes?: WorldInterface | undefined;
+    credentials?: InteractiveCredentials | undefined;
+};

package/dist/types/src/types/ResponseTypes.d.ts

@@ -0,0 +1,4 @@
+export type ResponseType = {
+    message: string;
+    success: boolean;
+};

package/dist/types/src/types/VisitorTypes.d.ts

@@ -0,0 +1,33 @@
+import Visitor from "../controllers/Visitor";
+export type VisitorType = {
+    visitorId: number;
+    color: string;
+    displayName: string;
+    gestureType: number;
+    hidden: boolean;
+    isAdmin: boolean;
+    isBackground: boolean;
+    isMobile: boolean;
+    isRecording: boolean;
+    isRecordingBot: boolean;
+    lastUpdate: number;
+    moveFrom: object;
+    movedOn: number;
+    moveTo: {
+        x: number;
+        y: number;
+    };
+    muted: boolean;
+    performer: boolean;
+    performerNear: boolean;
+    shareScreen: boolean;
+    sitting: boolean;
+    username: string;
+};
+export type VisitorsToMoveType = {
+    visitorObj: Visitor;
+    shouldTeleportVisitor: boolean;
+    x: number;
+    y: number;
+};
+export type VisitorsToMoveArrayType = Array<VisitorsToMoveType>;

package/dist/{src/types/index.js → types/src/types/index.d.ts}

@@ -1,4 +1,5 @@
-export * from "./DroppedAssetTypes";
-export * from "./InteractiveCredentialsTypes";
-export * from "./VisitorTypes";
-export * from "./ResponseTypes";
+export * from "./DroppedAssetTypes";
+export * from "./InteractiveCredentialsTypes";
+export * from "./OptionsTypes";
+export * from "./ResponseTypes";
+export * from "./VisitorTypes";

package/dist/types/src/utils/__tests__/removeUndefined.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/utils/__tests__/scatterVisitors.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/utils/getBrowserWarning.d.ts

@@ -0,0 +1 @@
+export declare const getBrowserWarning: () => void;

package/dist/{src/utils/index.js → types/src/utils/index.d.ts}

@@ -1,3 +1,3 @@
-export { getBrowserWarning } from "./getBrowserWarning";
-export { removeUndefined } from "./removeUndefined";
-export { scatterVisitors } from "./scatterVisitors";
+export { getBrowserWarning } from "./getBrowserWarning";
+export { removeUndefined } from "./removeUndefined";
+export { scatterVisitors } from "./scatterVisitors";

package/dist/types/src/utils/removeUndefined.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Parses object, removes keys with undefined value, and returns clean object.
+ */
+export declare const removeUndefined: (obj: {
+    [key: string]: any;
+}) => {
+    [key: string]: any;
+};

package/dist/types/src/utils/scatterVisitors.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns a random whole number within range of (original number - scatterBy) to (original number + scatterBy)
+ */
+export declare const scatterVisitors: (original: number, scatterBy: number) => number;