@rtsdk/topia 0.17.8 → 0.17.9

package/dist/index.d.ts

@@ -131,6 +131,8 @@ declare class Scene extends SDKController implements SceneInterface {
     /**
      * Retrieves scene details and assigns response data to the instance.
      *
+     * @keywords get, fetch, retrieve, load, details, info, information, scene
+     *
      * @example
      * ```ts
      * await scene.fetchSceneById();
@@ -168,6 +170,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Retrieves dropped asset details and assigns response data to the instance.
      *
+     * @keywords get, fetch, retrieve, load, details, info, information
+     *
      * @example
      * ```ts
      * await droppedAsset.fetchDroppedAssetById();
@@ -178,6 +182,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates dropped asset details and assigns the response data to the instance. Requires Public Key to have the `canUpdateDroppedAssets` permission.
      *
+     * @keywords update, modify, change, edit, alter, transform
+     *
      * @example
      * ```ts
      * const payload = {
@@ -209,6 +215,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Deletes the dropped asset (removes it from the world).
      *
+     * @keywords remove, delete, erase, destroy, eliminate
+     *
      * @example
      * ```ts
      * await droppedAsset.deleteDroppedAsset();
@@ -218,6 +226,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Retrieves the data object for a dropped asset.
      *
+     * @keywords get, fetch, retrieve, load, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -234,6 +244,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * @remarks
      * 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
      *
+     * @keywords set, assign, store, save, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -266,6 +278,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * @remarks
      * 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
      *
+     * @keywords update, modify, change, edit, alter, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -295,6 +309,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * @remarks
      * 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
      *
+     * @keywords increment, increase, add, count, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -316,6 +332,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates broadcast options for a dropped asset.
      *
+     * @keywords broadcast, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateBroadcast({
@@ -331,6 +349,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates click options for a dropped asset.
      *
+     * @keywords click, link, interaction, url, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateClickType({
@@ -353,6 +373,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Adds an array of links to an asset. Maximum is 20 links.
      *
+     * @keywords links, multiple, clickable, urls, hyperlinks, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.setClickableLinkMulti({
@@ -382,6 +404,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * @remarks
      * Pass in an 'existingLinkId' to edit an existing link.
      *
+     * @keywords links, multiple, clickable, urls, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateClickableLinkMulti({
@@ -399,6 +423,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Removes a clickable link from a dropped asset.
      *
+     * @keywords remove, delete, link, clickable, url, erase, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.removeClickableLink({ linkId: "link-id" });
@@ -410,6 +436,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates text and style of a dropped asset.
      *
+     * @keywords text, style, dropped asset settings
+     *
      * @example
      * ```ts
      * const style = {
@@ -428,6 +456,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates media options for a dropped asset.
      *
+     * @keywords media, video, audio, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateMediaType({
@@ -448,6 +478,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates mute zone options for a dropped asset.
      *
+     * @keywords mute, zone, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateMuteZone(true);
@@ -459,6 +491,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates landmark zone options for a dropped asset.
      *
+     * @keywords landmark, zone, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateLandmarkZone({
@@ -478,6 +512,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates webhook zone options for a dropped asset.
      *
+     * @keywords webhook, zone, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateWebhookZone(true);
@@ -489,6 +525,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Moves a dropped asset to specified coordinates.
      *
+     * @keywords position, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updatePosition(100, 200, 100);
@@ -500,6 +538,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates private zone options for a dropped asset.
      *
+     * @keywords private, zone, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updatePrivateZone({
@@ -515,6 +555,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Updates the size of a dropped asset.
      *
+     * @keywords size, scale, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.assetScale(.5);
@@ -526,6 +568,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Flip an dropped asset.
      *
+     * @keywords flip, layout, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.flip(.5);
@@ -537,6 +581,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Change or remove media embedded in a dropped asset.
      *
+     * @keywords media, update, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
@@ -548,6 +594,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Change or remove top and bottom layers of a dropped asset.
      *
+     * @keywords layers, images, urls, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.updateWebImageLayers("","https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg");
@@ -559,6 +607,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Add a webhook to a dropped asset
      *
+     * @keywords webhook, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.addWebhook({
@@ -587,6 +637,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Set the interactive settings on a dropped asset
      *
+     * @keywords interactive, dropped asset settings
+     *
      * @example
      * ```ts
      * await droppedAsset.setInteractiveSettings({
@@ -602,6 +654,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     /**
      * Retrieve analytics for a dropped asset by day, week, month, quarter, or year
      *
+     * @keywords get, fetch, retrieve, load, analytics
+     *
      * @example
      * ```ts
      * const analytics = await droppedAsset.fetchDroppedAssetAnalytics({
@@ -647,6 +701,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieves details of a world.
      *
+     * @keywords get, fetch, retrieve, details, info, information, world
+     *
      * @example
      * ```ts
      * await world.fetchDetails();
@@ -657,6 +713,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Update details of a world.
      *
+     * @keywords update, modify, change, edit, world, settings, details
+     *
      * @example
      * ```ts
      * await world.updateDetails({
@@ -681,6 +739,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Set close world settings
      *
+     * @keywords update, modify, change, edit, world, settings, details, close, closed
+     *
      * @example
      * ```ts
      * await world.updateCloseWorldSettings({
@@ -708,6 +768,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieve all assets dropped in a world.
      *
+     * @keywords get, fetch, retrieve, list, current, dropped assets
+     *
      * @category Dropped Assets
      *
      * @example
@@ -720,6 +782,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieve all assets dropped in a world matching uniqueName.
      *
+     * @keywords get, fetch, retrieve, list, current, dropped assets, uniqueName
+     *
      * @category Dropped Assets
      *
      * @example
@@ -737,6 +801,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieve all assets dropped in a world matching sceneDropId.
      *
+     * @keywords get, fetch, retrieve, list, current, dropped assets, sceneDropId
+     *
      * @category Dropped Assets
      *
      * @example
@@ -756,6 +822,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Update multiple custom text dropped assets with a single style while preserving text for specified dropped assets only.
      *
+     * @keywords update, modify, change, edit, dropped assets, custom text, style, text
+     *
      * @category Dropped Assets
      *
      * @example
@@ -778,6 +846,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieve all landmark zone assets dropped in a world.
      *
+     * @keywords get, fetch, retrieve, list, landmark, zones, dropped assets
+     *
      * @category Dropped Assets
      *
      * @example
@@ -807,6 +877,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Fetch a list of all scene drop ids and dropped assets in a world
      *
+     * @keywords get, fetch, retrieve, list, scenes
+     *
      * @category Scenes
      *
      * @example
@@ -837,6 +909,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Drops a scene in a world and returns sceneDropId.
      *
+     * @keywords drop, add, place, scene
+     *
      * @category Scenes
      *
      * @example
@@ -866,6 +940,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Replace the current scene of a world.
      *
+     * @keywords replace, change, scene
+     *
      * @category Scenes
      *
      * @example
@@ -887,6 +963,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Get all particles available
      *
+     * @keywords get, fetch, retrieve, list, particles
+     *
      * @category Particles
      *
      * @example
@@ -900,6 +978,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Trigger a particle effect at a position in the world
      *
+     * @keywords trigger, start, play, particle, effect
+     *
      * @category Particles
      *
      * @example
@@ -921,6 +1001,8 @@ declare class World extends SDKController implements WorldInterface {
      * Add an activity to a world
      * excludeFromNotification is an array of visitorIds to exclude from the notification
      *
+     * @keywords start, trigger, activity
+     *
      * @example
      * ```ts
      * await world.triggerActivity({ type: "GAME_ON", assetId: "abc123" });
@@ -936,6 +1018,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Display a message via a toast to all visitors currently in a world.
      *
+     * @keywords send, display, show, toast, message, notification
+     *
      * @example
      * ```ts
      * await world.fireToast({
@@ -951,6 +1035,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
      *
+     * @keywords get, fetch, retrieve, load, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -966,6 +1052,8 @@ declare class World extends SDKController implements WorldInterface {
      * @remarks
      * 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
      *
+     * @keywords set, assign, store, save, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -997,6 +1085,8 @@ declare class World extends SDKController implements WorldInterface {
      * @remarks
      * 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
      *
+     * @keywords update, modify, change, edit, alter, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -1025,6 +1115,8 @@ declare class World extends SDKController implements WorldInterface {
      * @remarks
      * 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
      *
+     * @keywords increment, increase, add, count, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -1046,6 +1138,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieve all webhooks in a world.
      *
+     * @keywords get, fetch, retrieve, list, current, webhooks
+     *
      * @category Webhooks
      *
      * @example
@@ -1058,6 +1152,8 @@ declare class World extends SDKController implements WorldInterface {
     /**
      * Retrieve world analytics by day, week, month, quarter, or year
      *
+     * @keywords get, fetch, retrieve, analytics, stats, statistics, data, metrics
+     *
      * @category Analytics
      *
      * @example
@@ -1111,6 +1207,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Returns all avatars owned by User
      *
+     * @keywords get, fetch, retrieve, list, avatars, characters
+     *
      * @category Avatars
      *
      * @example
@@ -1124,6 +1222,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Add a new avatar
      *
+     * @keywords add, create, upload, avatar, character
+     *
      * @category Avatars
      *
      * @example
@@ -1196,6 +1296,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Update avatar and sprite sheet records and upload files to existing sprite sheet and avatar storage buckets
      *
+     * @keywords update, modify, change, edit, avatar, character
+     *
      * @category Avatars
      *
      * @example
@@ -1268,6 +1370,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Update avatar and sprite sheet records and upload files to existing sprite sheet and avatar storage buckets
      *
+     * @keywords delete, remove, erase, destroy, eliminate, avatar
+     *
      * @category Avatars
      *
      * @example
@@ -1279,6 +1383,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Returns all assets owned by User when an email address is provided.
      *
+     * @keywords get, fetch, retrieve, list, user assets, objects
+     *
      * @category Assets
      *
      * @example
@@ -1291,6 +1397,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Returns all platform assets.
      *
+     * @keywords get, fetch, retrieve, list, platform assets, objects
+     *
      * @category Assets
      *
      * @example
@@ -1304,6 +1412,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Returns all scenes owned by User.
      *
+     * @keywords get, fetch, retrieve, list, user scenes
+     *
      * @category Scenes
      *
      * @example
@@ -1316,6 +1426,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Retrieves all worlds owned by user with matching API Key, creates a new World object for each, and creates new map of Worlds accessible via user.worlds.
      *
+     * @keywords get, fetch, retrieve, list, user worlds
+     *
      * @category Worlds
      *
      * @example
@@ -1333,6 +1445,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Retrieves all worlds a user with matching API Key is an admin in, creates a new World object for each, and creates new map of Worlds accessible via user.adminWorlds.
      *
+     * @keywords get, fetch, retrieve, list, admin worlds, user worlds
+     *
      * @category Worlds
      *
      * @example
@@ -1345,6 +1459,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Retrieves ids of all dropped assets in all worlds with a matching interactivePublicKey.
      *
+     * @keywords get, fetch, retrieve, list, interactive worlds, public key
+     *
      * @category Dropped Assets
      *
      * @example
@@ -1359,6 +1475,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Send an email
      *
+     * @keywords send, email, message, notify
+     *
      * @example
      * ```ts
      * const html = `<p><b>Hello World!</b></p><p>This email is being sent from via SDK.</p>`
@@ -1375,6 +1493,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Get expressions
      *
+     * @keywords get, fetch, retrieve, list, expressions, emotes
+     *
      * @category Expressions
      *
      * @example
@@ -1391,6 +1511,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Retrieves the data object for a user.
      *
+     * @keywords get, fetch, retrieve, load, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -1404,6 +1526,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Sets the data object for a user.
      *
+     * @keywords set, assign, store, save, data, object, state
+     *
      * @remarks
      * 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
      *
@@ -1436,6 +1560,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * Updates the data object for a user.
      *
+     * @keywords update, modify, change, edit, alter, data, object, state
+     *
      * @remarks
      * 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
      *
@@ -1466,6 +1592,8 @@ declare class User extends SDKController implements UserInterface {
     /**
      * 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.
      *
+     * @keywords increment, increase, add, count, data, object, state
+     *
      * @remarks
      * 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
      *
@@ -1507,6 +1635,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Get a single visitor from a world
      *
+     * @keywords get, fetch, retrieve, load, visitor, details
+     *
      * @example
      * ```ts
      * await visitor.fetchVisitor();
@@ -1519,6 +1649,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Teleport or walk a visitor currently in a world to a single set of coordinates.
      *
+     * @keywords move, teleport, walk, position, coordinate, location, place
+     *
      * @example
      * ```ts
      * await visitor.moveVisitor({
@@ -1535,6 +1667,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Display a message via a toast to a visitor currently in a world.
      *
+     * @keywords toast, message, notification, alert, display, show, popup
+     *
      * @example
      * ```ts
      * await visitor.fireToast({
@@ -1550,6 +1684,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Open an iframe in a drawer or modal for a visitor currently in a world.
      *
+     * @keywords open, iframe, drawer, modal, link, url, website, web page
+     *
      * @category iframes
      *
      * @example
@@ -1568,6 +1704,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Reload an iframe for a visitor currently in a world.
      *
+     * @keywords reload, iframe, drawer, modal, link, url, website, web page
+     *
      * @category iframes
      *
      * @example
@@ -1581,6 +1719,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Close an iframe for a visitor currently in a world.
      *
+     * @keywords close, iframe, drawer, modal
+     *
      * @category iframes
      *
      * @example
@@ -1594,6 +1734,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Mute and turn video off for a visitor currently in a world.
      *
+     * @keywords mute, video, av, turn off, disable
+     *
      * @example
      * ```ts
      * await visitor.turnAVOff();
@@ -1605,6 +1747,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Get expressions
      *
+     * @keywords get, fetch, retrieve, list, expressions, emotes
+     *
      * @category Expressions
      *
      * @example
@@ -1620,6 +1764,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Grant expression to a visitor by id or name.
      *
+     * @keywords grant, give, add, expression, emote
+     *
      * @category Expressions
      *
      * @example
@@ -1637,6 +1783,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Get all particles available
      *
+     * @keywords get, fetch, retrieve, list, particles, effects
+     *
      * @category Particle Effects
      *
      * @example
@@ -1650,6 +1798,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Trigger a particle effect on a visitor
      *
+     * @keywords trigger, particle, effect, spawn, start, play
+     *
      * @category Particle Effects
      *
      * @example
@@ -1667,6 +1817,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Retrieves the data object for a visitor.
      *
+     * @keywords get, fetch, retrieve, load, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -1680,6 +1832,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Sets the data object for a visitor.
      *
+     * @keywords set, assign, store, save, data, object, state
+     *
      * @remarks
      * 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
      *
@@ -1715,6 +1869,8 @@ declare class Visitor extends User implements VisitorInterface {
      * @remarks
      * 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
      *
+     * @keywords update, modify, change, edit, alter, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -1745,6 +1901,8 @@ declare class Visitor extends User implements VisitorInterface {
      * @remarks
      * 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
      *
+     * @keywords increment, increase, add, count, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -1766,6 +1924,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Update analytics for a given public key. Must have valid interactive credentials from a visitor in the world.
      *
+     * @keywords update, modify, change, edit, analytics, analytic, stats, statistics, data
+     *
      * @example
      * ```ts
      * await visitor.updatePublicKeyAnalytics([{ analyticName: "joins", profileId, uniqueKey: profileId, urlSlug }]);
@@ -1775,6 +1935,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Setup signal to visitor
      *
+     * @keywords signal, webrtc, answer, connect, p2p
+     *
      * @example
      * ```ts
      * await visitor.sendSignalToVisitor(iceServers);
@@ -2444,6 +2606,8 @@ declare class Asset extends SDKController implements AssetInterface {
     /**
      * Retrieves platform asset details and assigns response data to the instance.
      *
+     * @keywords get, fetch, retrieve, load, details, info, information
+     *
      * @example
      * ```ts
      * await asset.fetchAssetById();
@@ -2456,6 +2620,8 @@ declare class Asset extends SDKController implements AssetInterface {
     /**
      * Updates platform asset details.
      *
+     * @keywords update, modify, change, edit, alter, transform
+     *
      * @example
      * ```ts
      * await asset.updateAsset({
@@ -2499,6 +2665,8 @@ declare class Ecosystem extends SDKController {
     /**
      * Retrieves the data object for a Topia ecosystem. Requires canUpdateEcosystemDataObjects permission to be set to true for the public key.
      *
+     * @keywords get, fetch, retrieve, load, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -2517,6 +2685,8 @@ declare class Ecosystem extends SDKController {
      *
      * 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
      *
+     * @keywords set, assign, store, save, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -2547,6 +2717,8 @@ declare class Ecosystem extends SDKController {
      *
      * 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
      *
+     * @keywords update, modify, change, edit, alter, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -2583,6 +2755,8 @@ declare class Ecosystem extends SDKController {
      *
      * 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
      *
+     * @keywords increment, increase, add, count, data, object, state
+     *
      * @category Data Objects
      *
      * @example
@@ -2658,6 +2832,8 @@ declare class WorldActivity extends SDKController {
     /**
      * Retrieve all visitors currently in a world.
      *
+     * @keywords get, fetch, retrieve, list, current, visitors, users, players
+     *
      * @category Visitors
      *
      * @example
@@ -2673,6 +2849,8 @@ declare class WorldActivity extends SDKController {
     /**
      * Retrieve all visitors currently in a Landmark Zone.
      *
+     * @keywords get, fetch, retrieve, list, zone, area, landmark, visitors, users
+     *
      * @category Visitors
      *
      * @example
@@ -2695,6 +2873,8 @@ declare class WorldActivity extends SDKController {
      * 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.
      *
+     * @keywords move, teleport, position, coordinate, visitors, users, relocate
+     *
      * @category Visitors
      *
      * @example
@@ -2715,6 +2895,8 @@ declare class WorldActivity extends SDKController {
     /**
      * Teleport or walk a list of visitors currently in a world to various coordinates.
      *
+     * @keywords move, teleport, position, coordinate, visitor, user, relocate
+     *
      * @category Visitors
      *
      * @example
@@ -2742,109 +2924,270 @@ declare class WorldActivity extends SDKController {
 }
 
 /**
+ * Factory for creating Asset instances. Use this factory to create or upload assets in the Topia platform.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ *
+ * @keywords asset, factory, create, upload, instantiate, topia
+ *
  * @example
  * ```ts
- * const Asset = new AssetFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, AssetFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const Asset = new AssetFactory(topia);
  * ```
  */
 declare class AssetFactory extends SDKController {
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of Asset class.
+     * Instantiate a new instance of Asset class with the specified asset ID.
+     *
+     * @remarks
+     * This method creates a new Asset controller instance that can be used to interact with an existing asset.
+     * It does not create a new asset in the database.
+     *
+     * @keywords create, instantiate, asset, initialize, get, instance
      *
      * @example
-     * ```
-     * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { Asset } from "utils/topiaInit.ts";
+     *
+     * // Create an Asset instance with credentials
+     * const assetInstance = await Asset.create(assetId, {
+     *   credentials: {
+     *     interactiveNonce,
+     *     interactivePublicKey,
+     *     assetId,
+     *     urlSlug,
+     *     visitorId
+     *   }
+     * });
+     *
+     * // Use the instance to interact with the asset
+     * await assetInstance.fetchAssetById();
      * ```
      *
      * @returns {Asset} Returns a new Asset object with the asset id.
      */
     create(id: string, options?: AssetOptionalInterface): Asset;
     /**
-     * Upload a new Asset and return a new instance of Asset class.
+     * Upload a new Asset to the Topia platform and return a new instance of Asset class.
+     *
+     * @remarks
+     * This method both creates a new asset in the database and returns an Asset controller instance.
+     * A valid API key with appropriate permissions is required.
+     *
+     * @keywords upload, create, new, asset, add, store
      *
      * @example
-     * ```
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { Asset } from "utils/topiaInit.ts";
+     *
+     * // Prepare the asset payload
      * const assetPayload = {
-     *   assetName: "exampleAssetName"
-     *   bottomLayerURL: "https://example.bottomLayerURL"
+     *   assetName: "My Decorative Asset",
+     *   bottomLayerURL: "https://example.com/bottom-layer.png",
      *   creatorTags: { "decorations": true },
      *   tagJson: "[{"label":"decorations","value":"decorations"}]",
      *   isPublic: true,
-     *   topLayerURL: "https://example.topLayerURL"
-     * }
+     *   topLayerURL: "https://example.com/top-layer.png"
+     * };
+     *
+     * // Upload the asset using your API key
      * const asset = await Asset.upload(assetPayload, apiKey);
+     *
+     * // Access the new asset's properties
+     * console.log(asset.id);
      * ```
      *
-     * @returns {AssetType} Returns a new Asset object with the asset details.
+     * @returns {Asset} Returns a new Asset object with the asset details.
      */
     upload(assetPayload: AssetType, apiKey: string): Promise<Asset>;
 }
 
 /**
+ * Factory for creating and retrieving DroppedAsset instances. Use this factory to work with assets that have been placed in a Topia world.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ *
+ * @keywords dropped asset, factory, create, get, retrieve, instantiate, topia
+ *
  * @example
  * ```ts
- * const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, DroppedAssetFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const DroppedAsset = new DroppedAssetFactory(topia);
  * ```
  */
 declare class DroppedAssetFactory extends SDKController {
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of DroppedAsset class.
+     * Instantiate a new instance of DroppedAsset class for an existing dropped asset in a world.
+     *
+     * @remarks
+     * This method creates a controller instance for an existing dropped asset but does not fetch its properties.
+     * Use this when you need a lightweight instance and will fetch properties separately if needed or when you already have the properties.
+     *
+     * @keywords create, instantiate, dropped asset, initialize, instance
      *
      * @example
-     * ```
-     * const droppedAssetInstance = await DroppedAsset.create(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { DroppedAsset } from "utils/topiaInit.ts";
+     *
+     * // Create a DroppedAsset instance with credentials
+     * const droppedAssetInstance = DroppedAsset.create(
+     *   assetId,
+     *   urlSlug,
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     }
+     *   }
+     * );
+     *
+     * // Later fetch its properties if needed
+     * await droppedAssetInstance.fetchDroppedAssetById();
      * ```
      *
-     * @returns {DroppedAsset} Returns a new DroppedAsset object.
+     * @returns {DroppedAsset} Returns a new DroppedAsset object without fetching its properties.
      */
     create(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): DroppedAsset;
     /**
-     * Instantiate a new instance of DroppedAsset class and retrieve all properties.
+     * Instantiate a new instance of DroppedAsset class and automatically fetch all its properties.
+     *
+     * @remarks
+     * This method creates a controller instance and immediately fetches all properties of the dropped asset.
+     * It's a convenience method that combines creating an instance and calling fetchDroppedAssetById().
+     *
+     * @keywords get, fetch, retrieve, dropped asset, load, instance
      *
      * @example
-     * ```
-     * const droppedAssetInstance = await DroppedAsset.get(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { DroppedAsset } from "utils/topiaInit.ts";
+     *
+     * // Get a fully populated DroppedAsset instance
+     * const droppedAssetInstance = await DroppedAsset.get(
+     *   assetId,
+     *   urlSlug,
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     }
+     *   }
+     * );
+     *
+     * // The properties are already loaded, so you can use them immediately
+     * console.log(droppedAssetInstance.position);
      * ```
      *
-     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties.
+     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties already fetched.
      */
     get(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): Promise<DroppedAsset>;
     /**
-     * Searches dropped assets within a world by a provide `uniqueName`. If a single match is found, a new instance of DroppedAsset class is returned all properties.
+     * Searches for and retrieves a dropped asset by its unique name within a world.
      *
      * @remarks
-     * This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with matching uniqueName for the given urlSlug.
+     * This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with the matching uniqueName for the given urlSlug.
+     * Use this when you need to find a dropped asset by its uniqueName rather than its ID.
+     *
+     * @keywords find, search, unique name, retrieve, locate, lookup, dropped asset
      *
      * @example
-     * ```
-     * const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, interactiveSecret, credentials);
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { DroppedAsset } from "utils/topiaInit.ts";
+     *
+     * // Find and retrieve a dropped asset by its unique name
+     * const droppedAssetInstance = await DroppedAsset.getWithUniqueName(
+     *   "banner-sign-northeast",
+     *   "my-world-slug",
+     *   "your-interactive-secret",
+     *   {
+     *     apiKey: "your-api-key",
+     *     interactivePublicKey: "your-public-key",
+     *     // other credentials...
+     *   }
+     * );
+     *
+     * // The properties are already loaded, so you can use them immediately
+     * console.log(droppedAssetInstance.position);
      * ```
      *
-     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties.
+     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties already fetched.
      */
     getWithUniqueName(uniqueName: string, urlSlug: string, interactiveSecret: string, credentials: InteractiveCredentials): Promise<DroppedAsset>;
     /**
      * Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
      *
+     * @remarks
+     * This method places an existing Asset into a world at specified coordinates, effectively "dropping" it into the environment.
+     * You can customize various properties of the dropped asset during placement, such as scale, position, interactive settings, and visual layers.
+     *
+     * @keywords drop, place, add, create, position, asset, deploy
+     *
      * @example
-     * ```
-     * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
-     * const droppedAssetInstance = await DroppedAsset.get(assetInstance, {
-          assetScale: 1.5,
-          flipped: true,
-          layer0: "",
-          layer1: "https://pathtoimage.png",
-          interactivePublicKey,
-          isInteractive: true,
-          position: { x: 0, y: 0 },
-          uniqueName: "exampleUniqueName",
-          urlSlug,
-        });
+     * ```ts
+     * // Import the pre-initialized factories from your app's initialization file
+     * import { Asset, DroppedAsset } from "utils/topiaInit.ts";
+     *
+     * // First get an asset instance
+     * const assetInstance = Asset.create("asset-id-123", {
+     *   credentials: {
+     *     interactiveNonce,
+     *     interactivePublicKey,
+     *     assetId,
+     *     urlSlug,
+     *     visitorId
+     *   }
+     * });
+     *
+     * // Then drop (place) the asset in a world
+     * const droppedAssetInstance = await DroppedAsset.drop(
+     *   assetInstance,
+     *   {
+     *     // Basic positioning and appearance
+     *     position: { x: 250, y: 350 },
+     *     assetScale: 1.5,
+     *     flipped: true,
+     *     uniqueName: "welcome-sign",
+     *     urlSlug: "my-world-slug",
+     *
+     *     // For web images (optional)
+     *     layer0: "https://example.com/background.png",
+     *     layer1: "https://example.com/foreground.png",
+     *
+     *     // For interactive assets (optional)
+     *     interactivePublicKey: "your-public-key",
+     *     isInteractive: true,
+     *
+     *     // For clickable assets (optional)
+     *     clickType: "link",
+     *     clickableLink: "https://example.com",
+     *     clickableLinkTitle: "Visit Example"
+     *   }
+     * );
+     *
+     * // The dropped asset is ready to use
+     * console.log(droppedAssetInstance.id);
      * ```
      *
-     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties.
+     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object representing the placed asset in the world.
      */
     drop(asset: Asset, { assetScale, clickType, clickableDisplayTextDescription, clickableDisplayTextHeadline, clickableLink, clickableLinkTitle, flipped, interactivePublicKey, isInteractive, isForceLinkInIframe, isOpenLinkInDrawer, isTextTopLayer, layer0, layer1, position: { x, y }, sceneDropId, text, textColor, textFontFamily, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }: {
         assetScale?: number;
@@ -2879,45 +3222,113 @@ declare class DroppedAssetFactory extends SDKController {
 }
 
 /**
+ * Factory for creating Ecosystem instances. Use this factory to work with ecosystem-wide data and operations.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ * The Ecosystem controller provides methods to interact with data shared across multiple worlds.
+ *
+ * @keywords ecosystem, factory, create, multi-world, global, shared data, platform
+ *
  * @example
  * ```ts
- * const Ecosystem = new EcosystemFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, EcosystemFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const Ecosystem = new EcosystemFactory(topia);
  * ```
  */
 declare class EcosystemFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of Ecosystem class.
+     * Instantiate a new instance of Ecosystem class for interacting with ecosystem-wide data.
+     *
+     * @remarks
+     * This method creates a controller instance for accessing and managing data that spans multiple worlds.
+     * Use this for cross-world data sharing, global data objects, and ecosystem-wide operations.
+     *
+     * @keywords create, instantiate, ecosystem, initialize, global, shared data, platform
      *
      * @example
-     * ```
-     * const ecosystemInstance = await Ecosystem.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }});
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { Ecosystem } from "utils/topiaInit.ts";
+     *
+     * // Create an Ecosystem instance with credentials
+     * const ecosystemInstance = Ecosystem.create({
+     *   credentials: {
+     *     interactiveNonce,
+     *     interactivePublicKey,
+     *     assetId,
+     *     urlSlug,
+     *     visitorId
+     *   }
+     * });
+     *
+     * // Work with ecosystem-wide data objects
+     * await ecosystemInstance.fetchDataObject("global-leaderboard");
+     * await ecosystemInstance.setDataObject("global-leaderboard", { scores: [...] });
      * ```
      *
-     * @returns {Ecosystem} Returns a new Ecosystem object.
+     * @returns {Ecosystem} Returns a new Ecosystem object for interacting with ecosystem-wide data.
      */
     create(options?: EcosystemOptionalInterface): Ecosystem;
 }
 
 /**
+ * Factory for creating Scene instances. Use this factory to work with scenes in the Topia platform.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ * Scenes represent the template or blueprint for a world's design and layout.
+ *
+ * @keywords scene, factory, create, template, blueprint, layout, design
+ *
  * @example
  * ```ts
- * const Scene = new SceneFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, SceneFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const Scene = new SceneFactory(topia);
  * ```
  */
 declare class SceneFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of Scene class.
+     * Instantiate a new instance of Scene class for an existing scene in the platform.
+     *
+     * @remarks
+     * This method creates a controller instance for working with a scene but does not fetch its properties.
+     * Use this when you need to interact with a specific scene by its ID.
+     *
+     * @keywords create, instantiate, scene, initialize, instance, template
      *
      * @example
-     * ```
-     * const sceneInstance = await Scene.create(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { Scene } from "utils/topiaInit.ts";
+     *
+     * // Create a Scene instance with credentials
+     * const sceneInstance = Scene.create(
+     *   "scene-id-123",
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     }
+     *   }
+     * );
+     *
+     * // Fetch scene details if needed
+     * await sceneInstance.fetchSceneById();
      * ```
      *
-     * @returns {Scene} Returns a new Scene object.
+     * @returns {Scene} Returns a new Scene object for interacting with the specified scene.
      */
     create(id: string, options?: SceneOptionalInterface): Scene;
     /**
@@ -2934,132 +3345,363 @@ declare class SceneFactory {
 }
 
 /**
+ * Factory for creating User instances. Use this factory to work with user data in the Topia platform.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ * The User controller allows you to interact with user-specific information and operations.
+ *
+ * @keywords user, factory, create, account, profile, member, visitor
+ *
  * @example
  * ```ts
- * const User = new UserFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, UserFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const User = new UserFactory(topia);
  * ```
  */
 declare class UserFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of User class.
+     * Instantiate a new instance of User class for working with user data.
+     *
+     * @remarks
+     * This method creates a controller instance for interacting with user-specific operations.
+     * The User controller doesn't require an ID since it represents the currently authenticated user.
+     *
+     * @keywords create, instantiate, user, initialize, account, profile, member
      *
      * @example
-     * ```
-     * const userInstance = await User.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { User } from "utils/topiaInit.ts";
+     *
+     * // Create a User instance with credentials
+     * const userInstance = User.create({
+     *   credentials: {
+     *     interactiveNonce,
+     *     interactivePublicKey,
+     *     assetId,
+     *     urlSlug,
+     *     visitorId
+     *   }
+     * });
+     *
+     * // Use methods on the user instance
+     * await userInstance.checkInteractiveCredentials();
+     * const avatars = await userInstance.fetchAvatars();
      * ```
      *
-     * @returns {User} Returns a new User object.
+     * @returns {User} Returns a new User object for interacting with user data.
      */
     create(options?: UserOptionalInterface): User;
 }
 
 /**
+ * Factory for creating Visitor instances. Use this factory to work with visitors in Topia worlds.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ * The Visitor controller represents a specific visitor/avatar instance in a world.
+ *
+ * @keywords visitor, factory, create, get, avatar, user, participant
+ *
  * @example
  * ```ts
- * const Visitor = new VisitorFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, VisitorFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const Visitor = new VisitorFactory(topia);
  * ```
  */
 declare class VisitorFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of Visitor class.
+     * Instantiate a new instance of Visitor class for an existing visitor in a world.
+     *
+     * @remarks
+     * This method creates a controller instance for a visitor but does not fetch its properties.
+     * Use this when you need a lightweight instance and will fetch properties separately or when you already have the properties.
+     *
+     * @keywords create, instantiate, visitor, initialize, avatar, instance
      *
      * @example
-     * ```
-     * const visitorInstance = await Visitor.create(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { Visitor } from "utils/topiaInit.ts";
+     *
+     * // Create a Visitor instance with credentials
+     * const visitorInstance = Visitor.create(
+     *   12345, // visitor ID
+     *   "my-world-slug",
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     }
+     *   }
+     * );
+     *
+     * // Later fetch visitor properties if needed
+     * await visitorInstance.fetchVisitor();
      * ```
      *
-     * @returns {Visitor} Returns a new Visitor object.
+     * @returns {Visitor} Returns a new Visitor object without fetching its properties.
      */
     create(id: number, urlSlug: string, options?: VisitorOptionalInterface): Visitor;
     /**
-     * Instantiate a new instance of Visitor class and retrieve all properties.
+     * Instantiate a new instance of Visitor class and automatically fetch all its properties.
+     *
+     * @remarks
+     * This method creates a controller instance and immediately fetches all properties of the visitor.
+     * It's a convenience method that combines creating an instance and calling fetchVisitor().
+     *
+     * @keywords get, fetch, retrieve, visitor, load, avatar, instance
      *
      * @example
-     * ```
-     * const visitorInstance = await Visitor.get(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { Visitor } from "utils/topiaInit.ts";
+     *
+     * // Get a fully populated Visitor instance
+     * const visitorInstance = await Visitor.get(
+     *   12345, // visitor ID
+     *   "my-world-slug",
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     }
+     *   }
+     * );
+     *
+     * // The properties are already loaded, so you can use them immediately
+     * console.log(visitorInstance.username);
+     * console.log(visitorInstance.position);
      * ```
      *
-     * @returns {Promise<Visitor>} Returns a new Visitor object with all properties.
+     * @returns {Promise<Visitor>} Returns a new Visitor object with all properties already fetched.
      */
     get(id: number, urlSlug: string, options?: VisitorOptionalInterface): Promise<Visitor>;
 }
 
 /**
+ * Factory for creating WebRTCConnector instances. Use this factory to establish WebRTC connections for audio/video in Topia worlds.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ * The WebRTCConnector provides methods to set up and manage real-time audio/video communication.
+ *
+ * @keywords webrtc, factory, create, audio, video, communication, real-time, conference
+ *
  * @example
  * ```ts
- * const WebRTCConnector = new WebRTCConnectorFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, WebRTCConnectorFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const WebRTCConnector = new WebRTCConnectorFactory(topia);
  * ```
  */
 declare class WebRTCConnectorFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of WebRTCConnector class.
+     * Instantiate a new instance of WebRTCConnector class for managing audio/video communication.
+     *
+     * @remarks
+     * This method creates a controller instance for establishing and managing WebRTC connections.
+     * Use this for implementing real-time audio/video communication features in Topia worlds.
+     *
+     * @keywords create, instantiate, webrtc, initialize, audio, video, communication, stream
      *
      * @example
-     * ```
-     * const webRTCInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { WebRTCConnector } from "utils/topiaInit.ts";
+     *
+     * // Create a WebRTCConnector instance with credentials and configuration
+     * const webRTCInstance = WebRTCConnector.create(
+     *   "my-world-slug",
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     },
+     *     twilioConfig: {
+     *       // Twilio configuration options
+     *     }
+     *   }
+     * );
+     *
+     * // Use the instance to establish connections
+     * await webRTCInstance.connect();
      * ```
      *
-     * @returns {WebRTCConnector} Returns a new WebRTCConnector object.
+     * @returns {WebRTCConnector} Returns a new WebRTCConnector object for managing audio/video communication.
      */
     create(urlSlug: string, options?: WebRTCConnectorOptionalInterface): WebRTCConnector;
 }
 
 /**
+ * Factory for creating WorldActivity instances. Use this factory to monitor and manage visitor activity in Topia worlds.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ * The WorldActivity controller provides methods to interact with real-time visitor activities and movements.
+ *
+ * @keywords world activity, factory, create, visitors, movement, tracking, presence, real-time
+ *
  * @example
  * ```ts
- * const WorldActivity = new WorldActivityFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, WorldActivityFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const WorldActivity = new WorldActivityFactory(topia);
  * ```
  */
 declare class WorldActivityFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of WorldActivity class.
+     * Instantiate a new instance of WorldActivity class for monitoring visitor activity in a specific world.
+     *
+     * @remarks
+     * This method creates a controller instance for tracking and managing visitor activity in a world.
+     * Use this to fetch current visitors, move visitors, or monitor specific zones within a world.
+     *
+     * @keywords create, instantiate, world activity, initialize, visitors, tracking, presence
      *
      * @example
-     * ```
-     * const worldActivityInstance = await WorldActivity.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { WorldActivity } from "utils/topiaInit.ts";
+     *
+     * // Create a WorldActivity instance with credentials
+     * const worldActivityInstance = WorldActivity.create(
+     *   "my-world-slug",
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     }
+     *   }
+     * );
+     *
+     * // Get current visitors in the world
+     * const visitors = await worldActivityInstance.currentVisitors();
+     * console.log(`There are ${visitors.length} visitors in the world`);
+     *
+     * // Check visitors in a specific zone
+     * const zoneVisitors = await worldActivityInstance.fetchVisitorsInZone("stage-area");
      * ```
      *
-     * @returns {WorldActivity} Returns a new WorldActivity object.
+     * @returns {WorldActivity} Returns a new WorldActivity object for tracking and managing visitor activity.
      */
     create(urlSlug: string, options?: WorldOptionalInterface): WorldActivity;
 }
 
 /**
+ * Factory for creating World instances. Use this factory to interact with Topia worlds.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ * The World controller provides methods to manage world settings, retrieve world details, and perform world-level operations.
+ *
+ * @keywords world, factory, create, virtual space, environment, room, topia
+ *
  * @example
  * ```ts
- * const World = new WorldFactory(myTopiaInstance);
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, WorldFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const World = new WorldFactory(topia);
  * ```
  */
 declare class WorldFactory extends SDKController {
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of World class.
+     * Instantiate a new instance of World class for interacting with a specific Topia world.
+     *
+     * @remarks
+     * This method creates a controller instance for a world identified by its URL slug.
+     * The world controller can be used to fetch details, update world settings, and perform other world-level operations.
+     *
+     * @keywords create, instantiate, world, initialize, virtual space, environment, room
      *
      * @example
-     * ```
-     * const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { World } from "utils/topiaInit.ts";
+     *
+     * // Create a World instance with credentials
+     * const worldInstance = World.create(
+     *   "my-world-slug",
+     *   {
+     *     credentials: {
+     *       interactiveNonce,
+     *       interactivePublicKey,
+     *       assetId,
+     *       urlSlug,
+     *       visitorId
+     *     }
+     *   }
+     * );
+     *
+     * // Fetch world details
+     * await worldInstance.fetchDetails();
+     * console.log(worldInstance.name);
      * ```
      *
-     * @returns {World} Returns a new World object.
+     * @returns {World} Returns a new World object for interacting with the specified world.
      */
     create(urlSlug: string, options?: WorldOptionalInterface): World;
     /**
-     * Deletes an array of Dropped Assets from within a world and returns success: true
+     * Deletes multiple dropped assets from a world in a single operation.
+     *
+     * @remarks
+     * This method provides a convenient way to delete multiple dropped assets at once rather than
+     * deleting them one by one. Requires appropriate permissions via interactive credentials.
+     *
+     * @keywords delete, remove, dropped assets, multiple, batch, cleanup, world
      *
      * @example
-     * ```
-     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], interactiveSecret, credentials);
+     * ```ts
+     * // Import the pre-initialized factory from your app's initialization file
+     * import { World } from "utils/topiaInit.ts";
+     *
+     * // Delete multiple dropped assets from a world
+     * const result = await World.deleteDroppedAssets(
+     *   "my-world-slug",
+     *   ["asset-id-123", "asset-id-456", "asset-id-789"],
+     *   "your-interactive-secret",
+     *   {
+     *     apiKey: "your-api-key",
+     *     interactivePublicKey: "your-public-key",
+     *     visitorId: 12345
+     *   }
+     * );
+     *
+     * if (result.success) {
+     *   console.log("Assets successfully deleted");
+     * }
      * ```
      *
-     * @returns {Promise<{ success: boolean }>} Returns `{ success: true }` or an error.
+     * @returns {Promise<{ success: boolean }>} Returns `{ success: true }` if all assets were deleted successfully.
      */
     deleteDroppedAssets(urlSlug: string, droppedAssetIds: string[], interactiveSecret: string, credentials: {
         apiKey?: string;