@series-inc/venus-sdk 2.2.0

package/dist/AdsApi-BbMHVPYM.d.ts

@@ -0,0 +1,692 @@
+interface AnalyticsApi {
+    recordCustomEvent(eventName: string, payload?: Record<string, any>): Promise<void>;
+    trackFunnelStep(stepNumber: number, stepName: string, funnelName?: string): Promise<void>;
+}
+
+interface NavigationStackInfo {
+    isInStack: boolean;
+    stackPosition: number;
+    isTopOfStack: boolean;
+    stackDepth: number;
+    parentInstanceId: string;
+}
+interface PushAppOptions {
+    contextData?: any;
+    appParams?: any;
+}
+interface QuitOptions {
+    reason?: string;
+    forceClose?: boolean;
+    [key: string]: any;
+}
+interface NavigationApi {
+    pushApp(appId: string, options?: PushAppOptions): Promise<void>;
+    popApp(): Promise<void>;
+    getStackInfo(): NavigationStackInfo;
+    requestPopOrQuit(options?: QuitOptions): Promise<boolean>;
+}
+
+interface ShowConfirmOptions {
+    confirmText?: string;
+    cancelText?: string;
+}
+interface ShowAlertOptions {
+    buttonText?: string;
+}
+interface ShowToastOptions {
+    duration?: number;
+    variant?: 'success' | 'error' | 'warning' | 'info';
+    action?: {
+        label: string;
+    };
+}
+interface PopupsApi {
+    showAlert(title: string, message: string, options?: ShowAlertOptions): Promise<void>;
+    showConfirm(title: string, message: string, options?: ShowConfirmOptions): Promise<boolean>;
+    showToast(message: string, options?: ShowToastOptions): Promise<boolean>;
+    showActionSheet(items: ActionSheetItem[], options?: ShowActionSheetOptions): Promise<string | number | null>;
+}
+interface ActionSheetItem {
+    id?: string;
+    label: string;
+    icon?: string;
+}
+interface ShowActionSheetOptions {
+    title?: string;
+    message?: string;
+    cancelButtonText?: string;
+    disableCancel?: boolean;
+}
+
+type SubPath = string;
+interface FetchBlobOptions {
+    timeout?: number;
+}
+interface CdnApi {
+    resolveAssetUrl(subPath: string): string;
+    resolveAvatarAssetUrl(subPath: string): string;
+    resolveSharedLibUrl(subPath: string): string;
+    getAssetCdnBaseUrl(): string;
+    fetchFromCdn(url: string, request?: RequestInit): Promise<Response>;
+    fetchBlob(path: SubPath, options?: FetchBlobOptions): Promise<Blob>;
+}
+
+interface AiMessage {
+    /**
+     * Depends on the model you are using. Most common is user, system, and assistant.
+     * If you are unsure, look up the specific model you are using.
+     */
+    role: string;
+    content: string;
+}
+type AiChatCompletionRequest = {
+    model: string;
+    messages?: Array<AiMessage>;
+    maxTokens?: number;
+    temperature?: number;
+    topP?: number;
+    topK?: number;
+    n?: number;
+    stop?: string | string[];
+    presencePenalty?: number;
+    frequencyPenalty?: number;
+    logitBias?: Record<string, number>;
+    seed?: number;
+    /**
+     * This is ONLY ever used when running the sdk outside of venus.
+     * This gets ignored when the game using the sdk is used within a venus instance.
+     *
+     * In other words, this should only be uswed when developing a game locally.
+     */
+    apiKey?: string;
+};
+type AiChatCompletionData = {
+    id: string;
+    ullm_id: string;
+    cost: {
+        prompt_cost: number;
+        completion_cost: number;
+    };
+    object: string;
+    created: number;
+    model: string;
+    choices: Array<{
+        index: number;
+        message: {
+            role: string;
+            content: string;
+        };
+        finish_reason: string;
+    }>;
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+        reasoning_tokens?: number;
+        cache_read_tokens?: number;
+        cache_write_tokens?: number;
+    };
+};
+interface AiApi {
+    requestChatCompletionAsync(request: AiChatCompletionRequest): Promise<AiChatCompletionData>;
+    getAvailableCompletionModels(): Promise<Array<string>>;
+}
+
+declare enum HapticFeedbackStyle {
+    Light = "light",
+    Medium = "medium",
+    Heavy = "heavy",
+    Success = "success",
+    Warning = "warning",
+    Error = "error"
+}
+interface HapticsApi {
+    triggerHapticAsync(style: HapticFeedbackStyle): Promise<void>;
+}
+
+interface Insets {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+interface PostInfo {
+    postId: string;
+    config: null;
+    isLiked: boolean;
+    isFollowing: boolean;
+    likesCount: number;
+    commentsCount: number;
+}
+interface PlayContext {
+    hudInsets: Insets;
+    postData?: PostInfo;
+    format: 'post';
+}
+type OnPlayCallback = (context: PlayContext) => void;
+type OnPauseCallback = () => void;
+type OnResumeCallback = () => void;
+type OnQuitCallback = () => void;
+type OnHideCallback = () => void;
+interface ShowContext {
+    hudInsets: Insets;
+    postData?: PostInfo;
+}
+type OnShowCallback = (context: ShowContext) => void;
+type OnCleanupCallback = () => void;
+interface LifecycleApi {
+    onPlay(callback: OnPlayCallback): void;
+    onPause(callback: OnPauseCallback): void;
+    onResume(callback: OnResumeCallback): void;
+    onQuit(callback: OnQuitCallback): void;
+    onHide(callback: OnHideCallback): void;
+    onShow(callback: OnShowCallback): void;
+    onCleanup(callback: OnCleanupCallback): void;
+}
+
+interface SpendCurrencyOptions {
+    screenName?: string;
+}
+interface IapApi {
+    getHardCurrencyBalance(): Promise<number>;
+    spendCurrency(productId: string, amount: number, options?: SpendCurrencyOptions): Promise<void>;
+}
+
+interface Avatar3dConfig {
+    headAsset: string | null;
+    outfitAsset: string | null;
+    hatAsset: string | null;
+    hairAsset: string | null;
+    faceAccessoryAsset: string | null;
+    animationAsset: string | null;
+    skinColor: string | null;
+}
+
+interface Asset {
+    id: string;
+    filename: string;
+    displayName: string;
+    preload?: boolean;
+    tags?: string[];
+    metadata?: Record<string, any>;
+}
+interface Category {
+    displayName?: string;
+    type: 'mesh';
+    assets: Asset[];
+}
+interface AssetManifest {
+    version: string;
+    generatedAt: string;
+    categories: Record<string, Category>;
+}
+
+interface Avatar3dEdits {
+    wasChanged: boolean;
+    config: Avatar3dConfig | null;
+    savedAvatarId: string | null;
+}
+interface ShowEditorOptions {
+    currentAvatar?: any;
+    contextData?: any;
+    onSave?: () => void;
+    onCancel?: () => void;
+}
+interface Avatar3dApi {
+    loadAvatar(avatarId?: string): Promise<Avatar3dConfig | null>;
+    saveAvatar(config: Avatar3dConfig): Promise<string>;
+    deleteAvatar(): Promise<void>;
+    downloadManifest(): Promise<AssetManifest>;
+    showEditor(options?: ShowEditorOptions): Promise<Avatar3dEdits>;
+    downloadAssetPaths(): Promise<Record<string, string[]>>;
+}
+
+declare global {
+    interface Window {
+        VenusPrototyping?: {
+            showAvatarEditorOverlay: (options: any, resolve: (args: any) => void) => Promise<void>;
+        };
+    }
+}
+declare class MockAvatarApi implements Avatar3dApi {
+    private readonly _venusApi;
+    private cachedAssets;
+    private cachedVersion;
+    constructor(venusApi: VenusAPI);
+    downloadAssetPaths(): Promise<Record<string, string[]>>;
+    deleteAvatar(): Promise<void>;
+    loadAvatar(avatar3dId?: string): Promise<Avatar3dConfig | null>;
+    saveAvatar(config: Avatar3dConfig): Promise<string>;
+    downloadManifest(): Promise<AssetManifest>;
+    showEditor(options?: ShowEditorOptions): Promise<Avatar3dEdits>;
+    private getAssets;
+    private loadAssetsManifest;
+    private selectAvatarConfig;
+    private selectAsset;
+    private seededRandom;
+    private simpleHash;
+    private getAllAssetPaths;
+    private log;
+}
+
+/**
+ * DEFINITIVE TypeScript definitions for Venus H5 API
+ *
+ * This is the single source of truth for all H5 games.
+ *
+ * Usage in H5 games:
+ * ```typescript
+ * import type { VenusAPI } from '../../venus-api/types';
+ * declare const VenusAPI: VenusAPI;
+ * ```
+ */
+
+interface RecipeRequirementResult {
+    recipeId: string;
+    entity: string | null;
+    amount?: number;
+    inputs: Record<string, any>;
+    canAfford: boolean;
+    disabled: boolean;
+}
+interface VenusSimulationState {
+    inventory: Record<string, number | string>;
+    activeRuns: Array<{
+        id: string;
+        recipeId: string;
+        status: string;
+        startTime: number;
+        expiresAt: number;
+        inputs?: Record<string, number | string>;
+        outputs?: Record<string, number | string>;
+        entity?: string;
+    }>;
+    disabledRecipes: string[];
+}
+interface VenusSimulationEffect {
+    type: string;
+    target: any;
+    value: any;
+}
+interface VenusSimulationRecipe {
+    scope: 'player' | 'room' | 'actor';
+    inputs: Record<string, any>;
+    autoRestart?: boolean;
+    beginEffects?: VenusSimulationEffect[];
+    endEffects?: VenusSimulationEffect[];
+    outputs?: Record<string, any>;
+    duration?: number;
+    maxRestartCondition?: any;
+    metadata?: {
+        startsDisabled?: boolean;
+        autoRestart?: boolean;
+        maxRestartCondition?: any;
+    };
+    guards?: Record<string, any>;
+    effects?: Array<any>;
+    clientViewable?: boolean;
+}
+interface VenusSimulationConfig {
+    version: string;
+    entities: Record<string, {
+        tags?: string[];
+        metadata?: Record<string, any>;
+        stackable?: boolean;
+        neverConsumable?: boolean;
+        clientViewable?: boolean;
+        slots?: Record<string, {
+            allowedTags: string[];
+            maxItems: number;
+        }>;
+        actorTemplate?: {
+            defaultState?: Record<string, any>;
+            availableRecipes?: string[];
+        };
+    }>;
+    recipes: Record<string, VenusSimulationRecipe>;
+    fieldResolution?: Record<string, any>;
+    matchmaking?: Record<string, any>;
+}
+interface RecipeRequirementQuery {
+    recipeId: string;
+    entity?: string;
+    batchAmount?: number;
+}
+interface BatchRecipeRequirementsResult {
+    success: boolean;
+    results: RecipeRequirementResult[];
+    errors?: Array<any>;
+}
+interface VenusSimulationAPI {
+    isEnabled(): boolean;
+    getStateAsync(options?: {
+        roomId?: string;
+    }): Promise<VenusSimulationState>;
+    getConfigAsync(): Promise<VenusSimulationConfig>;
+    executeRecipeAsync(recipeId: string, inputs?: Record<string, any>, options?: any): Promise<any>;
+    executeScopedRecipeAsync(recipeId: string, entity: string, inputs?: Record<string, any>, roomId?: string, options?: any): Promise<any>;
+    getActiveRunsAsync(): Promise<any[]>;
+    collectRecipeAsync(runId: string): Promise<any>;
+    triggerRecipeChainAsync(triggerRecipeId: string, context?: any, roomId?: string): Promise<any>;
+    getRecipeRequirementsAsync(recipeId: string, entity?: string, amount?: number): Promise<RecipeRequirementResult>;
+    getBatchRecipeRequirementsAsync(queries: RecipeRequirementQuery[]): Promise<BatchRecipeRequirementsResult>;
+    getAvailableRecipesAsync(roomId?: string, includeActorRecipes?: boolean): Promise<Array<any>>;
+    resolveFieldValueAsync(entityId: string, fieldPath: string, entity?: string): Promise<any>;
+    getEntityMetadataAsync(entityId: string): Promise<any>;
+    getSlotContainersAsync(): Promise<Array<any>>;
+    getSlotAssignmentsAsync(containerId: string): Promise<Array<any>>;
+    assignItemToSlotAsync(containerId: string, slotId: string, itemId: string): Promise<any>;
+    removeItemFromSlotAsync(containerId: string, slotId: string): Promise<any>;
+    getAvailableItemsAsync(containerId: string, slotId: string): Promise<Array<any>>;
+    calculatePowerPreviewAsync(containerId: string, slotId: string, candidateItemId: string): Promise<any>;
+    validateSlotAssignmentAsync(containerId: string, slotId: string, itemId: string): Promise<any>;
+    executeBatchOperationsAsync(operations: Array<any>, validateOnly?: boolean): Promise<any>;
+    sumContributions(contributions: Record<string, any>): Record<string, number>;
+}
+interface VenusConfig {
+    user?: {
+        id: string;
+        username?: string;
+        languageCode: string;
+        locale: string;
+    };
+    profile?: {
+        id: string;
+        username: string;
+        avatarUrl?: string;
+    };
+    device?: {
+        screenSize: {
+            width: number;
+            height: number;
+        };
+        viewportSize: {
+            width: number;
+            height: number;
+        };
+        orientation: string;
+        hapticsEnabled: boolean;
+    };
+    theme?: Record<string, any>;
+    environment?: {
+        isDevelopment: boolean;
+        platform: string;
+        platformVersion: string;
+        browserInfo?: {
+            browser: string;
+            isMobile: boolean;
+        };
+    };
+    ui: {
+        safeArea: {
+            top: number;
+            left: number;
+            right: number;
+            bottom: number;
+        };
+        controls: Record<string, any>;
+    };
+}
+interface ActionSheetOption {
+    label: string;
+    icon?: string;
+    id?: string;
+}
+interface Profile {
+    id: string;
+    name: string;
+    username: string;
+}
+interface VenusAPI {
+    config: VenusConfig;
+    _mock: any;
+    _bootstrap: {
+        apiInjected: boolean;
+        venus: any;
+    };
+    initializeAsync(options?: {
+        helpText?: string;
+        hardDisableMock?: boolean;
+        mock?: Record<string, any>;
+    }): Promise<boolean>;
+    simulation: VenusSimulationAPI;
+    log(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+    isAvailable(): boolean;
+    isMobile(): boolean;
+    isWeb(): boolean;
+    isMock(): boolean;
+    /**
+     * @deprecated Please use the new analytics API. VenusAPI.analytics
+     * @param options
+     */
+    logCustomEvent(options: {
+        eventName: string;
+        params?: Record<string, any>;
+    }): Promise<void>;
+    getExperiment(options: {
+        experimentName: string;
+    }): Promise<any>;
+    getFeatureFlag(options: {
+        flagName: string;
+    }): Promise<any>;
+    getFeatureGate(options: {
+        gateName: string;
+    }): Promise<any>;
+    getCurrentProfile(): Profile;
+    /**
+     * @deprecated Please use the popups API. (e.g, VenusAPI.popups)
+     */
+    showToast(message: string | {
+        message: string;
+        duration?: number;
+        variant?: string;
+        action?: {
+            label: string;
+        };
+    }): Promise<boolean>;
+    /**
+     * @deprecated Please use the popups API. (e.g, VenusAPI.popups)
+     */
+    showAlert(options: {
+        title: string;
+        message: string;
+        buttonText?: string;
+    }): Promise<void>;
+    /**
+     * @deprecated Please use the popups API. (e.g, VenusAPI.popups)
+     */
+    showConfirm(options: {
+        title: string;
+        message: string;
+        confirmText?: string;
+        cancelText?: string;
+    }): Promise<boolean>;
+    /**
+     * @deprecated Please use the popups API. (e.g, VenusAPI.popups)
+     */
+    showActionSheet(options: {
+        title: string;
+        message?: string;
+        options: ActionSheetOption[];
+        cancelButtonText?: string;
+        disableCancel?: boolean;
+    }): Promise<string | number | null>;
+    triggerHapticAsync(style: HapticFeedbackStyle): Promise<void>;
+    deviceCache: {
+        setItem(key: string, value: string): Promise<void>;
+        getItem(key: string): Promise<string | null>;
+        removeItem(key: string): Promise<void>;
+        clear(): Promise<void>;
+        length(): Promise<number>;
+        key(index: number): Promise<string | null>;
+    };
+    appStorage: {
+        setItem(key: string, value: string): Promise<void>;
+        getItem(key: string): Promise<string | null>;
+        removeItem(key: string): Promise<void>;
+        clear(): Promise<void>;
+        length(): Promise<number>;
+        key(index: number): Promise<string | null>;
+        getAllItems(): Promise<string[]>;
+        setMultipleItems(items: {
+            key: string;
+            value: string;
+        }[]): Promise<void>;
+        removeMultipleItems(keys: string[]): Promise<void>;
+    };
+    globalStorage: {
+        setItem(key: string, value: string): Promise<void>;
+        getItem(key: string): Promise<string | null>;
+        removeItem(key: string): Promise<void>;
+        clear(): Promise<void>;
+        length(): Promise<number>;
+        key(index: number): Promise<string | null>;
+    };
+    onShow(handler: (context?: ShowContext) => void): void;
+    onPlay(handler: (context?: PlayContext) => void): void;
+    onPause(handler: () => void): void;
+    onResume(handler: () => void): void;
+    onQuit(handler: () => void): void;
+    onHide(handler: (context?: any) => void): void;
+    onCleanup(handler: () => void): void;
+    requestPopOrQuit(options?: QuitOptions): Promise<boolean>;
+    getPostInteractionsAsync(): Promise<any>;
+    getPostInteractions(): Promise<any>;
+    toggleLikeAsync(): Promise<any>;
+    toggleFollowAsync(): Promise<any>;
+    openCommentsAsync(options?: any): Promise<void>;
+    sharePostAsync(options: {
+        message: string;
+        title?: string;
+        additionalInfo?: any;
+    }): Promise<void>;
+    /**
+     * @deprecated Please use the ads API. (e.g, VenusAPI.ads)
+     */
+    isRewardedAdReadyAsync(): Promise<boolean>;
+    /**
+     * @deprecated Please use the ads API. (e.g, VenusAPI.ads)
+     */
+    showRewardedAdAsync(): Promise<boolean>;
+    requestTimeAsync(): Promise<{
+        serverTime: number;
+    }>;
+    getFutureTimeAsync(options: {
+        days?: number;
+        hours?: number;
+        minutes?: number;
+        timeOfDay?: any;
+        timezone?: string;
+    }): Promise<number>;
+    formatTime(timestamp: number, options?: any): string;
+    formatNumber(value: number, options?: any): string;
+    /**
+     * @deprecated Please use the cdn API. VenusAPI.cdn
+     */
+    fetchFromCdn(url: string, options?: RequestInit): Promise<Response>;
+    /**
+     * @deprecated Please use the cdn API. VenusAPI.cdn
+     */
+    resolveAssetUrl(path: string): string;
+    /**
+     * @deprecated Please use the cdn API. VenusAPI.cdn
+     */
+    resolveAvatarAssetUrl(path: string): string;
+    /**
+     * @deprecated Please use the cdn API. VenusAPI.cdn
+     */
+    resolveSharedLibUrl(path: string): string;
+    /**
+     * @deprecated Please use the cdn API. VenusAPI.cdn
+     */
+    getAssetCdnBaseUrl(): string;
+    loadAsset(url: string, options?: {
+        type?: string;
+        streaming?: boolean;
+        cache?: boolean;
+        timeout?: number;
+        isOptional?: boolean;
+    }): Promise<string>;
+    preloadAssets(assets: Array<string | {
+        url: string;
+        isOptional?: boolean;
+    }>, options?: {
+        onProgress?: (progress: number, info: any) => void;
+    }): Promise<Array<{
+        success: boolean;
+        isOptional?: boolean;
+    }>>;
+    cleanupAssets(): void;
+    assetLoader?: {
+        getCached(url: string): string | null;
+    };
+    scheduleLocalNotifAsync(options: {
+        title: string;
+        body: string;
+        timeFromNow: number;
+        data?: any;
+        sound?: string;
+        badge?: number;
+    }): Promise<string>;
+    cancelLocalNotifAsync(notificationId: string): Promise<void>;
+    getAllLocalNotifsAsync(): Promise<Array<any>>;
+    isLocalNotifEnabledAsync(): Promise<boolean>;
+    setLocalNotifEnabledAsync(enabled: boolean): Promise<void>;
+    showAvatar3dEditorAsync(options: {
+        currentAvatar?: any;
+        contextData?: any;
+    }): Promise<Avatar3dEdits>;
+    loadAvatar3dAsync(avatarId?: string): Promise<any>;
+    saveAvatar3dAsync(config: any): Promise<string>;
+    deleteAvatar3dAsync(): Promise<void>;
+    downloadAvatar3dAssetPathsAsync(): Promise<Record<string, string[]>>;
+    downloadAvatar3dManifestAsync(): Promise<AssetManifest>;
+    pushAppAsync(appId: string, options?: {
+        contextData?: any;
+        appParams?: any;
+    }): Promise<any>;
+    popAppAsync(): Promise<void>;
+    getStackInfo(): {
+        isInStack: boolean;
+        stackPosition: number;
+    };
+    rooms: {
+        create(options: any): Promise<any>;
+        join(roomId: string): Promise<any>;
+        joinOrCreate(options: any): Promise<any>;
+    };
+    createRoom(options: any): Promise<any>;
+    joinRoom(roomId: string): Promise<any>;
+    joinOrCreateRoom(options: any): Promise<any>;
+    listPublicRooms(gameType?: string, limit?: number): Promise<any>;
+    searchRooms(searchQuery: string, gameType?: string, limit?: number): Promise<any>;
+    joinRoomByCode(roomCode: string): Promise<any>;
+    getUserRooms(appId: string, includeArchived?: boolean): Promise<any>;
+    quickMatch(gameType: string): Promise<any>;
+    isRoomSystemEnabled(): boolean;
+    createGameRoom(options: any): Promise<any>;
+    subscribeToGameEvents(roomId: string, callback: (event: any) => void): () => void;
+    notifyCleanupComplete(): void;
+    RoomEvents: {
+        OPTIMISTIC_GAME_STATE_UPDATED: string;
+        PROPOSED_MOVE_VALIDATION_UPDATED: string;
+    };
+    numbers?: {
+        normalize(value: string | number): string;
+    };
+    iap: IapApi;
+    cdn: CdnApi;
+    ads: AdsApi;
+    ai: AiApi;
+    popups: PopupsApi;
+    analytics: AnalyticsApi;
+}
+
+interface AdsApi {
+    isRewardedAdReadyAsync(): Promise<boolean>;
+    showRewardedAdAsync(): Promise<boolean>;
+    showInterstitialAd(): Promise<boolean>;
+}
+
+export { type VenusConfig as $, type AnalyticsApi as A, type Avatar3dEdits as B, type CdnApi as C, type SubPath as D, type AiMessage as E, type FetchBlobOptions as F, type Asset as G, type HapticsApi as H, type IapApi as I, type Category as J, type Insets as K, type LifecycleApi as L, MockAvatarApi as M, type NavigationApi as N, type OnCleanupCallback as O, type PushAppOptions as P, type QuitOptions as Q, type RecipeRequirementResult as R, type ShowActionSheetOptions as S, type PostInfo as T, type VenusSimulationState as U, type VenusAPI as V, type VenusSimulationEffect as W, type VenusSimulationRecipe as X, type RecipeRequirementQuery as Y, type BatchRecipeRequirementsResult as Z, type VenusSimulationAPI as _, type NavigationStackInfo as a, type ActionSheetOption as a0, type PopupsApi as b, type ActionSheetItem as c, type ShowAlertOptions as d, type ShowConfirmOptions as e, type ShowToastOptions as f, type Profile as g, type AiApi as h, type AiChatCompletionRequest as i, type AiChatCompletionData as j, HapticFeedbackStyle as k, type OnShowCallback as l, type OnHideCallback as m, type OnPauseCallback as n, type OnPlayCallback as o, type OnQuitCallback as p, type OnResumeCallback as q, type PlayContext as r, type ShowContext as s, type VenusSimulationConfig as t, type SpendCurrencyOptions as u, type AdsApi as v, type Avatar3dApi as w, type AssetManifest as x, type Avatar3dConfig as y, type ShowEditorOptions as z };