@rtsdk/topia 0.1.0 → 0.1.1

package/dist/index.cjs

@@ -41039,19 +41039,6 @@ class WorldFactory {
     }
 }
 
-exports.DroppedAssetClickType = void 0;
-(function (DroppedAssetClickType) {
-    DroppedAssetClickType["NONE"] = "none";
-    DroppedAssetClickType["LINK"] = "link";
-    DroppedAssetClickType["PORTAL"] = "portal";
-    DroppedAssetClickType["TELEPORT"] = "teleport";
-})(exports.DroppedAssetClickType || (exports.DroppedAssetClickType = {}));
-exports.DroppedAssetMediaType = void 0;
-(function (DroppedAssetMediaType) {
-    DroppedAssetMediaType["NONE"] = "none";
-    DroppedAssetMediaType["LINK"] = "link";
-})(exports.DroppedAssetMediaType || (exports.DroppedAssetMediaType = {}));
-
 Error.stackTraceLimit = 20;
 process.on("unhandledRejection", (reason) => {
     if (reason && reason.data) {

package/dist/index.js

@@ -41037,19 +41037,6 @@ class WorldFactory {
     }
 }
 
-var DroppedAssetClickType;
-(function (DroppedAssetClickType) {
-    DroppedAssetClickType["NONE"] = "none";
-    DroppedAssetClickType["LINK"] = "link";
-    DroppedAssetClickType["PORTAL"] = "portal";
-    DroppedAssetClickType["TELEPORT"] = "teleport";
-})(DroppedAssetClickType || (DroppedAssetClickType = {}));
-var DroppedAssetMediaType;
-(function (DroppedAssetMediaType) {
-    DroppedAssetMediaType["NONE"] = "none";
-    DroppedAssetMediaType["LINK"] = "link";
-})(DroppedAssetMediaType || (DroppedAssetMediaType = {}));
-
 Error.stackTraceLimit = 20;
 process.on("unhandledRejection", (reason) => {
     if (reason && reason.data) {
@@ -41076,4 +41063,4 @@ process.on("uncaughtException", function (err) {
     process.exit(1);
 });
 
-export { AssetFactory, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetMediaType, SceneFactory, Topia, UserFactory, VisitorFactory, WorldActivityFactory, WorldFactory };
+export { AssetFactory, DroppedAssetFactory, SceneFactory, Topia, UserFactory, VisitorFactory, WorldActivityFactory, WorldFactory };

package/dist/types/example.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    myTopiaInstance: any;
+    DroppedAsset: any;
+    World: any;
+};
+export default _default;

package/dist/types/src/__mocks__/assets.d.ts

@@ -0,0 +1,99 @@
+export declare const assets: ({
+    id: string;
+    addedOn: string;
+    assetName: string;
+    specialType: null;
+    topLayerURL: string;
+    bottomLayerURL: string;
+    creatorTags?: undefined;
+    isPublic?: undefined;
+    kitId?: undefined;
+    layer0?: undefined;
+    layer1?: undefined;
+    library?: undefined;
+    originalAssetId?: undefined;
+    originalKit?: undefined;
+    ownerId?: undefined;
+    ownerName?: undefined;
+    purchased?: undefined;
+    purchasedDate?: undefined;
+    purchasedFrom?: undefined;
+    tagJson?: undefined;
+    transactionId?: undefined;
+    type?: undefined;
+    urlSlug?: undefined;
+} | {
+    addedOn: string;
+    assetName: string;
+    creatorTags: {};
+    isPublic: boolean;
+    kitId: string;
+    layer0: null;
+    layer1: string;
+    library: string;
+    originalAssetId: string;
+    originalKit: string;
+    ownerId: string;
+    ownerName: string;
+    purchased: boolean;
+    purchasedDate: string;
+    purchasedFrom: string;
+    tagJson: string;
+    transactionId: string;
+    type: string;
+    urlSlug: string;
+    id?: undefined;
+    specialType?: undefined;
+    topLayerURL?: undefined;
+    bottomLayerURL?: undefined;
+})[];
+export declare const droppedAssets: {
+    id: string;
+    assetId: string;
+    assetName: string;
+    assetScale: number;
+    assetBroadcastAll: boolean;
+    assetBroadcast: boolean;
+    audioRadius: null;
+    audioSliderVolume: null;
+    isPrivateZone: boolean;
+    isPrivateZoneChatDisabled: boolean;
+    privateZoneUserCap: null;
+    broadcasterEmail: null;
+    clickType: null;
+    clickableLink: null;
+    clickableLinkTitle: null;
+    clickablePortal: null;
+    creationDatetime: number;
+    clickableDisplayTextDescription: null;
+    clickableDisplayTextHeadline: null;
+    position: {
+        x: number;
+        y: number;
+    };
+    portalCoordsX: null;
+    portalCoordsY: null;
+    specialType: null;
+    topLayerURL: string;
+    bottomLayerURL: string;
+    text: null;
+    textStyle: {
+        textColor: string;
+        textSize: number;
+        textWidth: number;
+        textWeight: string;
+        textFont: string;
+        textFontFamily: string;
+    };
+    teleportX: null;
+    teleportY: null;
+    syncUserMedia: null;
+    mediaLink: null;
+    mediaType: null;
+    mediaUploadedId: null;
+    mediaName: null;
+    isMutezone: null;
+    isVideo: null;
+    isVideoPlayer: null;
+    uniqueName: null;
+}[];

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

@@ -1,4 +1,4 @@
-export * from "./assets";
-export * from "./scenes";
-export * from "./visitors";
-export * from "./worlds";
+export * from "./assets";
+export * from "./scenes";
+export * from "./visitors";
+export * from "./worlds";

package/dist/types/src/__mocks__/scenes.d.ts

@@ -0,0 +1,79 @@
+export declare const scenes: ({
+    description: string;
+    height: number;
+    name: string;
+    urlSlug: string;
+    purchasedDate: {
+        _seconds: number;
+        _nanoseconds: number;
+    };
+    background: string;
+    spawnPosition: {
+        radius: number;
+        y: number;
+        x: number;
+    };
+    worldCenteredAtZero: boolean;
+    width: number;
+    price: string;
+    originalKit: string;
+    isPublic: boolean;
+    created: {
+        _seconds: number;
+        _nanoseconds: number;
+    };
+    id: string;
+    timesGetFree?: undefined;
+    timesUsed?: undefined;
+} | {
+    background: null;
+    description: string;
+    price: number;
+    height: number;
+    urlSlug: string;
+    originalKit: string;
+    worldCenteredAtZero: boolean;
+    spawnPosition: {
+        x: number;
+        radius: number;
+        y: number;
+    };
+    timesGetFree: number;
+    isPublic: boolean;
+    timesUsed: number;
+    created: {
+        _seconds: number;
+        _nanoseconds: number;
+    };
+    purchasedDate: {
+        _seconds: number;
+        _nanoseconds: number;
+    };
+    name: string;
+    width: number;
+    id: string;
+} | {
+    background: string;
+    name: string;
+    timesUsed: number;
+    height: number;
+    spawnPosition: {
+        x: number;
+        y: number;
+        radius: number;
+    };
+    price: number;
+    urlSlug: string;
+    created: {
+        _seconds: number;
+        _nanoseconds: number;
+    };
+    description: string;
+    width: number;
+    id: string;
+    purchasedDate?: undefined;
+    worldCenteredAtZero?: undefined;
+    originalKit?: undefined;
+    isPublic?: undefined;
+    timesGetFree?: undefined;
+})[];

package/dist/types/src/__mocks__/visitors.d.ts

@@ -0,0 +1,83 @@
+export declare const visitor: {
+    visitorId: number;
+    color: string;
+    moveTo: {
+        x: number;
+        y: number;
+    };
+    moveFrom: {};
+    username: string;
+    sitting: boolean;
+    gestureType: number;
+    performer: boolean;
+    performerNear: boolean;
+    shareScreen: boolean;
+    isBackground: boolean;
+    muted: boolean;
+    hidden: boolean;
+    newId: string;
+    displayName: string;
+    movedOn: number;
+    lastUpdate: number;
+    isMobile: boolean;
+    token: string;
+    isAdmin: boolean;
+    isRecording: boolean;
+    isRecordingBot: boolean;
+};
+export declare const visitors: {
+    "1": {
+        visitorId: number;
+        color: string;
+        moveTo: {
+            x: number;
+            y: number;
+        };
+        moveFrom: {};
+        username: string;
+        sitting: boolean;
+        gestureType: number;
+        performer: boolean;
+        performerNear: boolean;
+        shareScreen: boolean;
+        isBackground: boolean;
+        muted: boolean;
+        hidden: boolean;
+        newId: string;
+        displayName: string;
+        movedOn: number;
+        lastUpdate: number;
+        isMobile: boolean;
+        token: string;
+        isAdmin: boolean;
+        isRecording: boolean;
+        isRecordingBot: boolean;
+    };
+    "2": {
+        visitorId: number;
+        color: string;
+        moveTo: {
+            x: number;
+            y: number;
+        };
+        moveFrom: {};
+        username: string;
+        sitting: boolean;
+        gestureType: number;
+        performer: boolean;
+        performerNear: boolean;
+        shareScreen: boolean;
+        isBackground: boolean;
+        muted: boolean;
+        hidden: boolean;
+        newId: string;
+        displayName: string;
+        movedOn: number;
+        lastUpdate: number;
+        isMobile: boolean;
+        token: string;
+        isAdmin: boolean;
+        isRecording: boolean;
+        isRecordingBot: boolean;
+    };
+};

package/dist/types/src/__mocks__/worlds.d.ts

@@ -0,0 +1,73 @@
+export declare const worlds: ({
+    description: string;
+    name: string;
+    heroImage: string;
+    urlSlug: string;
+    background?: undefined;
+    created?: undefined;
+    controls?: undefined;
+    enforceWhitelistOnLogin?: undefined;
+    forceAuthOnLogin?: undefined;
+    height?: undefined;
+    mapExists?: undefined;
+    redirectTo?: undefined;
+    spawnPosition?: undefined;
+    tileBackgroundEverywhere?: undefined;
+    useTopiaPassword?: undefined;
+    width?: undefined;
+    alt?: undefined;
+} | {
+    background: null;
+    created: {
+        _seconds: number;
+        _nanoseconds: number;
+    };
+    controls: {
+        isShowingCurrentGuests: boolean;
+        hideShareScreen: boolean;
+        isZoneConversationHidden: boolean;
+        allowUserToTurnOnNotifications: boolean;
+        isPeerConversationHidden: boolean;
+        disableHideVideo: boolean;
+        isWorldConversationHidden: boolean;
+        allowUsersToTurnOnNotifications: boolean;
+        allowMuteAll: boolean;
+        isMobileDisabled: boolean;
+    };
+    description: string;
+    enforceWhitelistOnLogin: boolean;
+    forceAuthOnLogin: boolean;
+    height: number;
+    heroImage: string;
+    mapExists: boolean;
+    name: string;
+    redirectTo: null;
+    spawnPosition: {
+        radius: number;
+        y: number;
+        x: number;
+    };
+    tileBackgroundEverywhere: null;
+    useTopiaPassword: boolean;
+    urlSlug: string;
+    width: number;
+    alt?: undefined;
+} | {
+    alt: string;
+    description: string;
+    name: string;
+    heroImage: string;
+    urlSlug: string;
+    background?: undefined;
+    created?: undefined;
+    controls?: undefined;
+    enforceWhitelistOnLogin?: undefined;
+    forceAuthOnLogin?: undefined;
+    height?: undefined;
+    mapExists?: undefined;
+    redirectTo?: undefined;
+    spawnPosition?: undefined;
+    tileBackgroundEverywhere?: undefined;
+    useTopiaPassword?: undefined;
+    width?: undefined;
+})[];

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

@@ -0,0 +1,20 @@
+import { SDKController } from "controllers/SDKController";
+import { Topia } from "controllers/Topia";
+import { AssetInterface, AssetOptionalInterface } from "interfaces";
+import { ResponseType } from "types";
+/**
+ * @summary
+ * Create an instance of Asset class with a given asset id and optional attributes and session credentials.
+ *
+ * @usage
+ * ```ts
+ * await new Asset(topia, "assetId", { attributes: { assetName: "My Asset", isPublic: false } });
+ * ```
+ */
+export declare class Asset extends SDKController implements AssetInterface {
+    readonly id?: string;
+    jwt?: string;
+    constructor(topia: Topia, id: string, options?: AssetOptionalInterface);
+    fetchPlatformAssets(): Promise<object | ResponseType>;
+}
+export default Asset;

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

@@ -0,0 +1,285 @@
+import { AxiosResponse } from "axios";
+import { Asset } from "controllers/Asset";
+import { Topia } from "controllers/Topia";
+import { DroppedAssetInterface, DroppedAssetOptionalInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface } from "interfaces";
+import { ResponseType } from "types";
+/**
+ * @summary
+ * Create an instance of Dropped Asset class with a given dropped asset id, url slug, and optional attributes and session credentials.
+ *
+ * @usage
+ * ```ts
+ * await new DroppedAsset(topia, "1giFZb0sQ3X27L7uGyQX", "example", { attributes: { text: "" }, credentials: { assetId: "1giFZb0sQ3X27L7uGyQX" } } });
+ * ```
+ */
+export declare class DroppedAsset extends Asset implements DroppedAssetInterface {
+    #private;
+    dataObject?: object | null;
+    readonly id?: string | undefined;
+    text?: string | null | undefined;
+    urlSlug: string;
+    isInteractive?: boolean | null;
+    interactivePublicKey?: string | null;
+    constructor(topia: Topia, id: string, urlSlug: string, options?: DroppedAssetOptionalInterface);
+    /**
+     * @summary
+     * Retrieves dropped asset details.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchDroppedAssetById();
+     * const { assetName } = droppedAsset;
+     * ```
+     */
+    fetchDroppedAssetById(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Delete dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.deleteDroppedAsset();
+     * ```
+     */
+    deleteDroppedAsset(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Retrieves the data object for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchDroppedAssetDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    fetchDroppedAssetDataObject(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Sets the data object for a dropped asset.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.setDroppedAssetDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    setDroppedAssetDataObject(dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates the data object for a dropped asset.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateDroppedAssetDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    updateDroppedAssetDataObject(dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates broadcast options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateBroadcast({
+     *   assetBroadcast: true,
+     *   assetBroadcastAll: true,
+     *   broadcasterEmail: "example@email.com"
+     * });
+     * ```
+     */
+    updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates click options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateClickType({
+     *   "clickType": "portal",
+     *   "clickableLink": "https://topia.io",
+     *   "clickableLinkTitle": "My awesome link!",
+     *   "clickableDisplayTextDescription": "Description",
+     *   "clickableDisplayTextHeadline": "Title",
+     *   "position": {
+     *     "x": 0,
+     *     "y": 0
+     *   },
+     *   "portalName": "community"
+     * });
+     * ```
+     */
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates text and style of a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * const style = {
+     *   "textColor": "#abc123",
+     *   "textFontFamily": "Arial",
+     *   "textSize": 40,
+     *   "textWeight": "normal",
+     *   "textWidth": 200
+     * };
+     * await droppedAsset.updateCustomTextAsset(style, "hello world");
+     * ```
+     */
+    updateCustomTextAsset(style: object, text: string | null | undefined): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates media options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateMediaType({
+     *   "mediaType": "link",
+     *   "mediaLink": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+     *   "isVideo": true,
+     *   "syncUserMedia": true,
+     *   "audioSliderVolume: 30"
+     *   "portalName": "community",
+     *   "audioRadius": 0,
+     *   "mediaName": "string"
+     * });
+     * ```
+     */
+    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates mute zone options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateMuteZone(true);
+     * ```
+     */
+    updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates webhook zone options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateWebhookZone(true);
+     * ```
+     */
+    updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Moves a dropped asset to specified coordinates.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updatePosition(100,200);
+     * ```
+     */
+    updatePosition(x: number, y: number): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates private zone options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updatePrivateZone({
+     *   "isPrivateZone": false,
+     *   "isPrivateZoneChatDisabled": true,
+     *   "privateZoneUserCap": 10
+     * });
+     * ```
+     */
+    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates the size of a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.assetScale(.5);
+     * ```
+     */
+    updateScale(assetScale: number): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Change or remove media embedded in a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
+     * ```
+     */
+    updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Change or remove top and bottom layers of a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateWebImageLayers("","https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg");
+     * ```
+     */
+    updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Add a webhook to a dropped asset
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.addWebhook({
+     *   active: true,
+     *   dataObject: {},
+     *   description: "Webhook desc",
+     *   enteredBy: "you",
+     *   isUniqueOnly: false,
+     *   title: "title",
+     *   type: "type",
+     *   url: "https://url.com",
+     *   urlSlug: "world",
+     * });
+     * ```
+     */
+    addWebhook({ dataObject, description, isUniqueOnly, title, type, url, }: {
+        dataObject: object;
+        description: string;
+        isUniqueOnly: boolean;
+        title: string;
+        type: string;
+        url: string;
+    }): Promise<void | AxiosResponse>;
+    /**
+     * @summary
+     * Set the interactive settings on a dropped asset
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.setInteractiveSettings({
+     *   isInteractive: true,
+     *   interactivePublicKey: "xyz"
+     * });
+     * ```
+     */
+    setInteractiveSettings({ isInteractive, interactivePublicKey, }: {
+        isInteractive?: boolean;
+        interactivePublicKey: string;
+    }): Promise<void | ResponseType>;
+}
+export default DroppedAsset;