@rtsdk/topia 0.2.4 → 0.3.0

package/dist/index.cjs

@@ -31,13 +31,13 @@ declare enum DroppedAssetMediaType {
 }
 
 type InteractiveCredentials = {
+    apiKey?: string;
     assetId?: string;
     interactiveNonce?: string;
     interactivePublicKey?: string;
-    visitorId?: number;
-    urlSlug?: string;
-    apiKey?: string;
     profileId?: string | null;
+    urlSlug?: string;
+    visitorId?: number;
 };
 
 type AssetOptions = {
@@ -56,7 +56,7 @@ type VisitorOptions = {
     credentials?: InteractiveCredentials | undefined;
 };
 type WorldOptions = {
-    attributes?: WorldInterface | undefined;
+    attributes?: WorldDetailsInterface | undefined;
     credentials?: InteractiveCredentials | undefined;
 };
 
@@ -125,8 +125,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.fetchDataObject();
-     * const { dataObject } = droppedAsset;
+     * const dataObject = await droppedAsset.fetchDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -141,7 +140,6 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     setDataObject(dataObject: object, options?: {
@@ -161,7 +159,6 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -170,6 +167,26 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a dropped asset by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
     /**
      * @summary
      * Updates broadcast options for a dropped asset.
@@ -372,6 +389,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
 declare class World extends SDKController implements WorldInterface {
     #private;
     urlSlug: string;
+    dataObject?: object | null | undefined;
     constructor(topia: Topia, urlSlug: string, options?: WorldOptionalInterface);
     get droppedAssets(): {
         [key: string]: DroppedAsset;
@@ -409,7 +427,7 @@ declare class World extends SDKController implements WorldInterface {
      * });
      * ```
      */
-    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldInterface): Promise<void | ResponseType>;
+    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType>;
     /**
      * @summary
      * Retrieve all assets dropped in a world.
@@ -496,6 +514,77 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     replaceScene(sceneId: string): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
+     *
+     * @usage
+     * ```ts
+     * await world.fetchDataObject();
+     * const { dataObject } = world;
+     * ```
+     */
+    fetchDataObject: () => Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Sets the data object for a user. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 world.setDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = world;
+     * ```
+     */
+    setDataObject: (dataObject: object | null | undefined, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }) => Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates the data object for a world. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 world.updateDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = world;
+     * ```
+     */
+    updateDataObject: (dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }) => Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a world by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 world.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 
 /**
@@ -507,7 +596,7 @@ declare class World extends SDKController implements WorldInterface {
  * await new User(topia, { interactiveNonce: "exampleNonce", interactivePublicKey: "examplePublicKey", visitorId: 1 });
  * ```
  */
-declare class User extends SDKController {
+declare class User extends SDKController implements UserInterface {
     #private;
     profileId?: string | null;
     dataObject?: object | null | undefined;
@@ -556,8 +645,7 @@ declare class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await droppedAsset.fetchDataObject();
-     * const { dataObject } = droppedAsset;
+     * const dataObject = await user.fetchDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -569,10 +657,9 @@ declare class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await droppedAsset.setDataObject({
+     * await user.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
@@ -589,10 +676,9 @@ declare class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await droppedAsset.updateUserDataObject({
+     * await user.updateUserDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -601,6 +687,26 @@ declare class User extends SDKController {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a user by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 user.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 
 /**
@@ -613,7 +719,6 @@ declare class User extends SDKController {
  * ```
  */
 declare class Visitor extends User implements VisitorInterface {
-    #private;
     readonly id: number;
     urlSlug: string;
     user?: User;
@@ -682,8 +787,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.fetchVisitorDataObject();
-     * const { dataObject } = droppedAsset;
+     * const dataObject = await visitor.fetchVisitorDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -695,10 +799,9 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.setVisitorDataObject({
+     * await visitor.setVisitorDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
@@ -715,10 +818,9 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.updateVisitorDataObject({
+     * await visitor.updateVisitorDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -727,6 +829,26 @@ declare class Visitor extends User implements VisitorInterface {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a visitor by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 visitor.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 
 type VisitorType = {
@@ -795,6 +917,35 @@ type AssetOptionalInterface = {
 };
 
 interface DroppedAssetInterface extends AssetInterface {
+    fetchDroppedAssetById(): Promise<void | ResponseType>;
+    deleteDroppedAsset(): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+    updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType>;
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType>;
+    updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType>;
+    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType>;
+    updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>;
+    updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>;
+    updatePosition(x: number, y: number): Promise<void | ResponseType>;
+    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType>;
+    updateScale(assetScale: number): Promise<void | ResponseType>;
+    updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>;
+    updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType>;
+    addWebhook({ dataObject, description, isUniqueOnly, title, type, url, }: {
+        dataObject: object;
+        description: string;
+        isUniqueOnly: boolean;
+        title: string;
+        type: string;
+        url: string;
+    }): Promise<void | AxiosResponse>;
+    setInteractiveSettings({ isInteractive, interactivePublicKey, }: {
+        isInteractive?: boolean;
+        interactivePublicKey: string;
+    }): Promise<void | ResponseType>;
     id?: string;
     assetId?: string;
     assetScale?: number | null;
@@ -898,6 +1049,7 @@ interface UpdatePrivateZoneInterface {
 }
 
 interface SceneInterface {
+    fetchSceneById(): Promise<void | ResponseType>;
     id: string;
     background?: null;
     description?: string;
@@ -933,6 +1085,14 @@ interface TopiaInterface {
     interactiveSecret?: jwt.Secret;
 }
 
+interface UserInterface {
+    fetchAssets(): Promise<void | ResponseType>;
+    fetchScenes(): Promise<void | ResponseType>;
+    fetchWorldsByKey(): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+}
 interface UserOptionalInterface {
     credentials?: InteractiveCredentials | object;
     profileId?: string | null;
@@ -941,6 +1101,14 @@ interface UserOptionalInterface {
 }
 
 interface VisitorInterface extends SDKInterface {
+    fetchVisitor(): Promise<void | ResponseType>;
+    moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType>;
+    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType>;
+    openIframe({ link, shouldOpenInDrawer, title }: OpenIframeInterface): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
     color?: string;
     dataObject?: object | null | undefined;
     displayName?: string;
@@ -998,7 +1166,7 @@ interface MoveAllVisitorsInterface {
     y: number;
 }
 
-interface WorldInterface extends SDKInterface {
+interface WorldDetailsInterface {
     background?: string | null;
     controls?: {
         allowMuteAll?: boolean;
@@ -1024,8 +1192,29 @@ interface WorldInterface extends SDKInterface {
     useTopiaPassword?: boolean;
     width?: number;
 }
+interface WorldInterface extends SDKInterface, WorldDetailsInterface {
+    fetchDetails(): Promise<void | ResponseType>;
+    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType>;
+    fetchDroppedAssets(): Promise<void | ResponseType>;
+    fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial, isReversed, }: {
+        uniqueName: string;
+        isPartial?: boolean;
+        isReversed?: boolean;
+    }): Promise<DroppedAsset[]>;
+    updateCustomTextDroppedAssets(droppedAssetsToUpdate: Array<DroppedAsset>, style: object): Promise<object>;
+    dropScene({ assetSuffix, position, sceneId, }: {
+        assetSuffix: string;
+        position: object;
+        sceneId: string;
+    }): Promise<void | ResponseType>;
+    replaceScene(sceneId: string): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+}
 interface WorldOptionalInterface {
-    attributes?: WorldInterface | object;
+    attributes?: WorldDetailsInterface | object;
     credentials?: InteractiveCredentials | object;
 }
 
@@ -1248,4 +1437,4 @@ declare class WorldFactory {
     create(urlSlug: string, options?: WorldOptionalInterface): World;
 }
 
-export { AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType, SDKInterface, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, UserFactory, UserOptionalInterface, UserOptions, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WorldActivityFactory, WorldActivityOptionalInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions };
+export { AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType, SDKInterface, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, UserFactory, UserInterface, UserOptionalInterface, UserOptions, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions };

package/dist/index.d.ts

@@ -31,13 +31,13 @@ declare enum DroppedAssetMediaType {
 }
 
 type InteractiveCredentials = {
+    apiKey?: string;
     assetId?: string;
     interactiveNonce?: string;
     interactivePublicKey?: string;
-    visitorId?: number;
-    urlSlug?: string;
-    apiKey?: string;
     profileId?: string | null;
+    urlSlug?: string;
+    visitorId?: number;
 };
 
 type AssetOptions = {
@@ -56,7 +56,7 @@ type VisitorOptions = {
     credentials?: InteractiveCredentials | undefined;
 };
 type WorldOptions = {
-    attributes?: WorldInterface | undefined;
+    attributes?: WorldDetailsInterface | undefined;
     credentials?: InteractiveCredentials | undefined;
 };
 
@@ -125,8 +125,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.fetchDataObject();
-     * const { dataObject } = droppedAsset;
+     * const dataObject = await droppedAsset.fetchDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -141,7 +140,6 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     setDataObject(dataObject: object, options?: {
@@ -161,7 +159,6 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -170,6 +167,26 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a dropped asset by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
     /**
      * @summary
      * Updates broadcast options for a dropped asset.
@@ -372,6 +389,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
 declare class World extends SDKController implements WorldInterface {
     #private;
     urlSlug: string;
+    dataObject?: object | null | undefined;
     constructor(topia: Topia, urlSlug: string, options?: WorldOptionalInterface);
     get droppedAssets(): {
         [key: string]: DroppedAsset;
@@ -409,7 +427,7 @@ declare class World extends SDKController implements WorldInterface {
      * });
      * ```
      */
-    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldInterface): Promise<void | ResponseType>;
+    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType>;
     /**
      * @summary
      * Retrieve all assets dropped in a world.
@@ -496,6 +514,77 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     replaceScene(sceneId: string): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
+     *
+     * @usage
+     * ```ts
+     * await world.fetchDataObject();
+     * const { dataObject } = world;
+     * ```
+     */
+    fetchDataObject: () => Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Sets the data object for a user. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 world.setDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = world;
+     * ```
+     */
+    setDataObject: (dataObject: object | null | undefined, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }) => Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates the data object for a world. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 world.updateDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = world;
+     * ```
+     */
+    updateDataObject: (dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }) => Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a world by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 world.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 
 /**
@@ -507,7 +596,7 @@ declare class World extends SDKController implements WorldInterface {
  * await new User(topia, { interactiveNonce: "exampleNonce", interactivePublicKey: "examplePublicKey", visitorId: 1 });
  * ```
  */
-declare class User extends SDKController {
+declare class User extends SDKController implements UserInterface {
     #private;
     profileId?: string | null;
     dataObject?: object | null | undefined;
@@ -556,8 +645,7 @@ declare class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await droppedAsset.fetchDataObject();
-     * const { dataObject } = droppedAsset;
+     * const dataObject = await user.fetchDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -569,10 +657,9 @@ declare class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await droppedAsset.setDataObject({
+     * await user.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
@@ -589,10 +676,9 @@ declare class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await droppedAsset.updateUserDataObject({
+     * await user.updateUserDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -601,6 +687,26 @@ declare class User extends SDKController {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a user by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 user.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 
 /**
@@ -613,7 +719,6 @@ declare class User extends SDKController {
  * ```
  */
 declare class Visitor extends User implements VisitorInterface {
-    #private;
     readonly id: number;
     urlSlug: string;
     user?: User;
@@ -682,8 +787,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.fetchVisitorDataObject();
-     * const { dataObject } = droppedAsset;
+     * const dataObject = await visitor.fetchVisitorDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -695,10 +799,9 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.setVisitorDataObject({
+     * await visitor.setVisitorDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
@@ -715,10 +818,9 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await droppedAsset.updateVisitorDataObject({
+     * await visitor.updateVisitorDataObject({
      *   "exampleKey": "exampleValue",
      * });
-     * const { dataObject } = droppedAsset;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -727,6 +829,26 @@ declare class Visitor extends User implements VisitorInterface {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a visitor by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * 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 visitor.incrementDataObjectValue(
+     *   "path": "key",
+     *   "amount": 1,
+     * );
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 
 type VisitorType = {
@@ -795,6 +917,35 @@ type AssetOptionalInterface = {
 };
 
 interface DroppedAssetInterface extends AssetInterface {
+    fetchDroppedAssetById(): Promise<void | ResponseType>;
+    deleteDroppedAsset(): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+    updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType>;
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType>;
+    updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType>;
+    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType>;
+    updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>;
+    updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>;
+    updatePosition(x: number, y: number): Promise<void | ResponseType>;
+    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType>;
+    updateScale(assetScale: number): Promise<void | ResponseType>;
+    updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>;
+    updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType>;
+    addWebhook({ dataObject, description, isUniqueOnly, title, type, url, }: {
+        dataObject: object;
+        description: string;
+        isUniqueOnly: boolean;
+        title: string;
+        type: string;
+        url: string;
+    }): Promise<void | AxiosResponse>;
+    setInteractiveSettings({ isInteractive, interactivePublicKey, }: {
+        isInteractive?: boolean;
+        interactivePublicKey: string;
+    }): Promise<void | ResponseType>;
     id?: string;
     assetId?: string;
     assetScale?: number | null;
@@ -898,6 +1049,7 @@ interface UpdatePrivateZoneInterface {
 }
 
 interface SceneInterface {
+    fetchSceneById(): Promise<void | ResponseType>;
     id: string;
     background?: null;
     description?: string;
@@ -933,6 +1085,14 @@ interface TopiaInterface {
     interactiveSecret?: jwt.Secret;
 }
 
+interface UserInterface {
+    fetchAssets(): Promise<void | ResponseType>;
+    fetchScenes(): Promise<void | ResponseType>;
+    fetchWorldsByKey(): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+}
 interface UserOptionalInterface {
     credentials?: InteractiveCredentials | object;
     profileId?: string | null;
@@ -941,6 +1101,14 @@ interface UserOptionalInterface {
 }
 
 interface VisitorInterface extends SDKInterface {
+    fetchVisitor(): Promise<void | ResponseType>;
+    moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType>;
+    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType>;
+    openIframe({ link, shouldOpenInDrawer, title }: OpenIframeInterface): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
     color?: string;
     dataObject?: object | null | undefined;
     displayName?: string;
@@ -998,7 +1166,7 @@ interface MoveAllVisitorsInterface {
     y: number;
 }
 
-interface WorldInterface extends SDKInterface {
+interface WorldDetailsInterface {
     background?: string | null;
     controls?: {
         allowMuteAll?: boolean;
@@ -1024,8 +1192,29 @@ interface WorldInterface extends SDKInterface {
     useTopiaPassword?: boolean;
     width?: number;
 }
+interface WorldInterface extends SDKInterface, WorldDetailsInterface {
+    fetchDetails(): Promise<void | ResponseType>;
+    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType>;
+    fetchDroppedAssets(): Promise<void | ResponseType>;
+    fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial, isReversed, }: {
+        uniqueName: string;
+        isPartial?: boolean;
+        isReversed?: boolean;
+    }): Promise<DroppedAsset[]>;
+    updateCustomTextDroppedAssets(droppedAssetsToUpdate: Array<DroppedAsset>, style: object): Promise<object>;
+    dropScene({ assetSuffix, position, sceneId, }: {
+        assetSuffix: string;
+        position: object;
+        sceneId: string;
+    }): Promise<void | ResponseType>;
+    replaceScene(sceneId: string): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+}
 interface WorldOptionalInterface {
-    attributes?: WorldInterface | object;
+    attributes?: WorldDetailsInterface | object;
     credentials?: InteractiveCredentials | object;
 }
 
@@ -1248,4 +1437,4 @@ declare class WorldFactory {
     create(urlSlug: string, options?: WorldOptionalInterface): World;
 }
 
-export { AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType, SDKInterface, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, UserFactory, UserOptionalInterface, UserOptions, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WorldActivityFactory, WorldActivityOptionalInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions };
+export { AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType, SDKInterface, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, UserFactory, UserInterface, UserOptionalInterface, UserOptions, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions };

package/package.json

@@ -59,5 +59,5 @@
     "local-publish": "yarn build && yalc publish --push --no-scripts"
   },
   "type": "module",
-  "version": "0.2.4"
+  "version": "0.3.0"
 }