@rtsdk/topia 0.2.2 → 0.2.4

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

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

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

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

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

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

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

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

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

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

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

@@ -1,48 +0,0 @@
-import { Topia } from "controllers/Topia";
-import { SDKInterface } from "interfaces";
-import { InteractiveCredentials } from "types";
-import { AxiosError } from "axios";
-/**
- * @summary
- * Create an instance of SDKController class with credentials.
- *
- * @usage
- * ```ts
- * const credentials = {
- *   assetId: "exampleAsset",
- *   interactiveNonce: "exampleNonce"
- *   interactivePublicKey: "examplePublicKey",
- *   visitorId: 1,
- *   url: "https://topia.io",
- * }
- * const topia = await new Topia({
- *   apiDomain: "api.topia.io",
- *   apiKey: "exampleKey",
- *   interactiveKey: "key",
- *   interactiveSecret: "secret",
- * }
- * await new SDKController({ credentials, topia });
- * ```
- */
-export declare class SDKController implements SDKInterface {
-    credentials: InteractiveCredentials | undefined;
-    jwt?: string;
-    requestOptions: object;
-    topia: Topia;
-    constructor(topia: Topia, credentials?: InteractiveCredentials);
-    topiaPublicApi(): import("axios").AxiosInstance;
-    errorHandler({ error, message, }: {
-        error?: Error | AxiosError | unknown;
-        message?: string;
-    }): {
-        data: {};
-        message: string;
-        method: string;
-        stack: string;
-        stackTrace: Error;
-        status: number;
-        success: boolean;
-        url: string;
-    };
-}
-export default SDKController;

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

@@ -1,19 +0,0 @@
-import { SDKController } from "controllers/SDKController";
-import { Topia } from "controllers/Topia";
-import { SceneInterface, SceneOptionalInterface } from "interfaces";
-import { ResponseType } from "types";
-/**
- * @summary
- * Create an instance of Scene class with a given scene id and optional attributes and session credentials.
- *
- * @usage
- * ```ts
- * await new Scene(topia, "sceneId", { attributes: { name: "My Scene" } });
- * ```
- */
-export declare class Scene extends SDKController implements SceneInterface {
-    readonly id: string;
-    constructor(topia: Topia, id: string, options?: SceneOptionalInterface);
-    fetchSceneById(): Promise<void | ResponseType>;
-}
-export default Scene;

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

@@ -1,33 +0,0 @@
-import { AxiosInstance } from "axios";
-import { TopiaInterface } from "interfaces";
-import jwt from "jsonwebtoken";
-/**
- * @summary
- * Create a single instance of Topia axios used for all calls to the public API in all classes
- *
- * @usage
- * ```ts
- * const topia = await new Topia({
- *   apiDomain: "api.topia.io",
- *   apiKey: "exampleKey",
- *   interactiveKey: "key",
- *   interactiveSecret: "secret",
- * });
- * ```
- */
-export declare class Topia implements TopiaInterface {
-    axios: AxiosInstance;
-    apiDomain?: string;
-    apiKey?: string;
-    apiProtocol?: string;
-    interactiveKey?: string;
-    interactiveSecret?: jwt.Secret;
-    constructor({ apiDomain, apiKey, apiProtocol, interactiveKey, interactiveSecret, }: {
-        apiDomain?: string;
-        apiKey?: string;
-        apiProtocol?: string;
-        interactiveKey?: string;
-        interactiveSecret?: jwt.Secret;
-    });
-}
-export default Topia;