@rtsdk/topia 0.1.0 → 0.2.0

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

@@ -0,0 +1,104 @@
+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;
+    isForceLinkInIframe?: boolean;
+    isOpenLinkInDrawer?: boolean;
+    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,7 @@
+import { InteractiveCredentials } from "types";
+export interface UserOptionalInterface {
+    credentials?: InteractiveCredentials | object;
+    profileId?: string | null;
+    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;

package/package.json

@@ -26,7 +26,7 @@
     "rollup-plugin-typescript2": "^0.34.1",
     "ts-jest": "^29.0.3",
     "typedoc": "^0.23.23",
-    "typescript": "^4.9.3",
+    "typescript": "^5.0.4",
     "yalc": "^1.0.0-pre.53"
   },
   "files": [
@@ -56,5 +56,5 @@
     "local-publish": "yarn build && yalc publish --push --no-scripts"
   },
   "type": "module",
-  "version": "0.1.0"
+  "version": "0.2.0"
 }

package/dist/example.js

@@ -1,32 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-// @ts-nocheck
-// Initialization... on backend
-import { Topia, DroppedAssetFactory, WorldFactory } from "@rtsdk/topia";
-const myTopiaInstance = new Topia({
-    apiDomain: process.env.INSTANCE_DOMAIN || "api.topia.io/",
-    apiKey: process.env.API_KEY,
-    interactiveKey: process.env.INTERACTIVE_KEY,
-    interactiveSecret: process.env.INTERACTIVE_SECRET,
-});
-const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
-const World = new WorldFactory(myTopiaInstance);
-export default { myTopiaInstance, DroppedAsset, World };
-const setTextOnAsset = (req, res) => __awaiter(void 0, void 0, void 0, function* () {
-    const asset = yield DroppedAsset.get(req.body.assetId, req.body.urlSlug, { credentials: req.body });
-    yield asset.setAssetText(req.body.text);
-});
-import { myTopiaInterface } from "./src";
-const setTextOnAsset = (req, res) => __awaiter(void 0, void 0, void 0, function* () {
-    const asset = yield new DroppedAssetFactory(myTopiaInterface).get(req.body.assetId, req.body.urlSlug, {
-        credentials: req.body,
-    });
-    yield asset.setAssetText(req.body.text);
-});