@rtsdk/topia 0.17.6 → 0.17.8

package/dist/index.d.ts

@@ -117,9 +117,11 @@ type ResponseType$1 = {
  *
  * @example
  * ```ts
- * const scene = await new Scene(topia, "sceneId", {
+ * import { Scene } from "utils/topiaInit.ts";
+ *
+ * const scene = await Scene.get(exampleSceneId, {
  *   attributes: { name: "My Scene" },
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */
@@ -143,9 +145,10 @@ declare class Scene extends SDKController implements SceneInterface {
  *
  * @example
  * ```ts
- * const droppedAsset = await new DroppedAsset(topia, "1giFZb0sQ3X27L7uGyQX", "example", {
- *   attributes: { text: "My Dropped Asset" },
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ * import { DroppedAsset } from "utils/topiaInit.ts";
+ *
+ * const droppedAsset = await DroppedAsset.get(exampleDroppedAssetId, exampleUrlSlug, {
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */
@@ -622,9 +625,11 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
  *
  * @example
  * ```ts
- * const world = await new World(topia, "exampleWorld", {
+ * import { World } from "utils/topiaInit.ts";
+ *
+ * const world = await World.create(exampleUrlSlug, {
  *   attributes: { name: "Example World" },
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */
@@ -1076,9 +1081,11 @@ declare class World extends SDKController implements WorldInterface {
  *
  * @example
  * ```ts
- * const user = await new User(topia, {
- *   profileId: 1,
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ * import { User } from "utils/topiaInit.ts";
+ *
+ * const user = await User.create({
+ *   profileId: "exampleProfileId",
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", profileId: "exampleProfileId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */
@@ -1487,7 +1494,9 @@ declare class User extends SDKController implements UserInterface {
  *
  * @example
  * ```ts
- * const visitor = await new Visitor(topia, id, urlSlug, { attributes: { moveTo: { x: 0, y: 0 } }, credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" } });
+ * import { Visitor } from "utils/topiaInit.ts";
+ *
+ * const visitor = await Visitor.get(visitorId, urlSlug, { attributes: { moveTo: { x: 0, y: 0 } }, credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", profileId: "exampleProfileId", visitorId: 1, urlSlug: "exampleUrlSlug" } });
  * ```
  */
 declare class Visitor extends User implements VisitorInterface {
@@ -1824,6 +1833,15 @@ interface SDKInterface {
 
 interface AssetInterface extends SDKInterface {
     fetchAssetById(): Promise<object | ResponseType>;
+    updateAsset({ assetName, bottomLayerURL, creatorTags, isPublic, shouldUploadImages, tagJson, topLayerURL, }: {
+        assetName: string;
+        bottomLayerURL?: string;
+        creatorTags: object;
+        isPublic: boolean;
+        shouldUploadImages?: boolean;
+        tagJson: string;
+        topLayerURL?: string;
+    }): Promise<object | ResponseType>;
     addedOn?: string;
     assetName?: string;
     creatorTags?: object;
@@ -1859,10 +1877,16 @@ interface DroppedAssetInterface extends AssetInterface {
     updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType$1>;
     updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType$1>;
     updateMuteZone(isMutezone: boolean): Promise<void | ResponseType$1>;
+    updateLandmarkZone({ isLandmarkZoneEnabled, landmarkZoneName, landmarkZoneIsVisible, }: {
+        isLandmarkZoneEnabled: boolean;
+        landmarkZoneName?: string;
+        landmarkZoneIsVisible?: boolean;
+    }): Promise<void | ResponseType$1>;
     updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType$1>;
     updatePosition(x: number, y: number, yOrderAdjust?: number): Promise<void | ResponseType$1>;
     updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType$1>;
     updateScale(assetScale: number): Promise<void | ResponseType$1>;
+    flip(): Promise<void | ResponseType$1>;
     updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType$1>;
     updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType$1>;
     addWebhook({ dataObject, description, isUniqueOnly, title, type, url, }: {
@@ -1880,6 +1904,11 @@ interface DroppedAssetInterface extends AssetInterface {
     setClickableLinkMulti({ clickableLinks }: SetClickableLinkMultiInterface): Promise<void | ResponseType$1>;
     updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }: UpdateClickableLinkMultiInterface): Promise<void | ResponseType$1>;
     removeClickableLink({ linkId }: RemoveClickableLinkInterface): Promise<void | ResponseType$1>;
+    fetchDroppedAssetAnalytics({ periodType, dateValue, year, }: {
+        periodType: "week" | "month" | "quarter" | "year";
+        dateValue: number;
+        year: number;
+    }): Promise<void | ResponseType$1>;
     id?: string;
     assetId?: string;
     assetScale?: number | null;
@@ -2094,10 +2123,24 @@ interface TopiaInterface {
 }
 
 interface UserInterface {
+    checkInteractiveCredentials(): Promise<void | ResponseType$1>;
+    fetchAvatars(): Promise<void | ResponseType$1>;
+    addAvatar(formData: FormData): Promise<void | ResponseType$1>;
+    updateAvatar(avatarId: string, formData: FormData): Promise<void | ResponseType$1>;
+    deleteAvatar(avatarId: string): Promise<void | ResponseType$1>;
     fetchAssets(): Promise<void | ResponseType$1>;
     fetchPlatformAssets(): Promise<object | ResponseType$1>;
     fetchScenes(): Promise<void | ResponseType$1>;
     fetchWorldsByKey(): Promise<void | ResponseType$1>;
+    sendEmail({ html, subject, to }: {
+        html: string;
+        subject: string;
+        to: string;
+    }): Promise<object | ResponseType$1>;
+    getExpressions({ name, getUnlockablesOnly }: {
+        name?: string;
+        getUnlockablesOnly?: boolean;
+    }): Promise<ResponseType$1>;
     fetchDataObject(appPublicKey?: string, appJWT?: string): Promise<void | ResponseType$1>;
     setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
     incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
@@ -2115,17 +2158,30 @@ interface VisitorInterface extends SDKInterface {
     moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType$1>;
     fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
     openIframe({ link, shouldOpenInDrawer, title }: OpenIframeInterface): Promise<void | ResponseType$1>;
+    reloadIframe(droppedAssetId: string): Promise<void | ResponseType$1>;
     closeIframe(droppedAssetId: string): Promise<void | ResponseType$1>;
-    fetchDataObject(appPublicKey?: string, appJWT?: string, sharedAppPublicKey?: string, sharedAppJWT?: string): Promise<void | ResponseType$1>;
-    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
-    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
-    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
-    updatePublicKeyAnalytics(analytics?: AnalyticType[]): Promise<void | ResponseType$1>;
+    turnAVOff(): Promise<void | ResponseType$1>;
+    getExpressions({ name, getUnlockablesOnly }: {
+        name?: string;
+        getUnlockablesOnly?: boolean;
+    }): Promise<ResponseType$1>;
+    grantExpression({ id, name }: {
+        id?: string;
+        name?: string;
+    }): Promise<ResponseType$1>;
     getAllParticles(): Promise<ResponseType$1>;
     triggerParticle({ id, name, duration, }: {
         id?: string;
         name?: string;
         duration?: number;
+        fetchDataObject(appPublicKey?: string, appJWT?: string, sharedAppPublicKey?: string, sharedAppJWT?: string): Promise<void | ResponseType$1>;
+        setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
+        updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
+        incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
+        updatePublicKeyAnalytics(analytics?: AnalyticType[]): Promise<void | ResponseType$1>;
+        sendSignalToVisitor(signal: any): Promise<void | (ResponseType$1 & {
+            answerSignal: any;
+        })>;
     }): Promise<ResponseType$1 | string>;
     color?: string;
     dataObject?: object | null | undefined;
@@ -2234,6 +2290,10 @@ interface WorldDetailsInterface {
 interface WorldInterface extends SDKInterface, WorldDetailsInterface {
     fetchDetails(): Promise<void | ResponseType$1>;
     updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType$1>;
+    updateCloseWorldSettings({ closeWorldDescription, isWorldClosed, }: {
+        closeWorldDescription: string;
+        isWorldClosed: boolean;
+    }): Promise<void | ResponseType$1>;
     fetchDroppedAssets(): Promise<void | ResponseType$1>;
     fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial, isReversed, }: {
         uniqueName: string;
@@ -2245,17 +2305,15 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
         uniqueName?: string;
     }): Promise<DroppedAsset[]>;
     updateCustomTextDroppedAssets(droppedAssetsToUpdate: Array<DroppedAsset>, style: object): Promise<object>;
+    fetchLandmarkZones(landmarkZoneName?: string, sceneDropId?: string): Promise<DroppedAsset[]>;
+    fetchSceneDropIds(): Promise<object | ResponseType$1>;
+    fetchScenes(): Promise<object | ResponseType$1>;
     dropScene({ assetSuffix, position, sceneId, }: {
         assetSuffix: string;
         position: object;
         sceneId: string;
     }): Promise<object | ResponseType$1>;
     replaceScene(sceneId: string): Promise<void | ResponseType$1>;
-    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
-    fetchDataObject(appPublicKey?: string, appJWT?: string, sharedAppPublicKey?: string, sharedAppJWT?: string): Promise<void | ResponseType$1>;
-    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
-    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
-    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
     getAllParticles(): Promise<ResponseType$1>;
     triggerParticle({ id, name, duration, position, }: {
         id?: string;
@@ -2263,6 +2321,22 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
         duration?: number;
         position?: object;
     }): Promise<ResponseType$1 | string>;
+    triggerActivity({ type, assetId, excludeFromNotification, }: {
+        type: WorldActivityType;
+        assetId: string;
+        excludeFromNotification?: (string | number)[];
+    }): Promise<ResponseType$1 | string>;
+    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
+    fetchDataObject(appPublicKey?: string, appJWT?: string, sharedAppPublicKey?: string, sharedAppJWT?: string): Promise<void | ResponseType$1>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
+    fetchWebhooks(): Promise<void | ResponseType$1>;
+    fetchWorldAnalytics({ periodType, dateValue, year, }: {
+        periodType: "week" | "month" | "quarter" | "year";
+        dateValue: number;
+        year: number;
+    }): Promise<void | ResponseType$1>;
     dataObject?: object | null;
 }
 interface WorldOptionalInterface {
@@ -2356,9 +2430,11 @@ declare abstract class SDKController implements SDKInterface {
  *
  * @example
  * ```ts
- * const asset = await new Asset(topia, "id", {
+ * import { Asset } from "utils/topiaInit.ts";
+ *
+ * const asset = await Asset.create(assetId, {
  *   attributes: { assetName: "My Asset", isPublic: false },
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */
@@ -2402,7 +2478,7 @@ declare class Asset extends SDKController implements AssetInterface {
         shouldUploadImages?: boolean;
         tagJson: string;
         topLayerURL?: string;
-    }): Promise<void | ResponseType$1>;
+    }): Promise<object | ResponseType$1>;
 }
 
 /**
@@ -2410,8 +2486,10 @@ declare class Asset extends SDKController implements AssetInterface {
  *
  * @example
  * ```ts
- * const ecosystem =await new Ecosystem(topia, {
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ * import { Ecosystem } from "utils/topiaInit.ts";
+ *
+ * const ecosystem = await Ecosystem.create({
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */
@@ -2534,7 +2612,7 @@ declare class Ecosystem extends SDKController {
  * @example
  * ```ts
  * const webRTC = await new WebRTCConnector(topia, {
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", profileId: "exampleProfileId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */
@@ -2561,9 +2639,11 @@ declare class WebRTCConnector extends SDKController implements WebRTCConnectorIn
  *
  * @example
  * ```ts
- * const activity = await new WorldActivity(topia, "exampleWorld", {
+ * import { WorldActivity } from "utils/topiaInit.ts";
+ *
+ * const activity = await WorldActivity.create(urlSlug, {
  *   attributes: { name: "Example World" },
- *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ *   credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", visitorId: 1, urlSlug: "exampleUrlSlug" }
  * });
  * ```
  */