@react-three/viverse 0.2.5 → 0.2.6

package/dist/index.d.ts

@@ -1,72 +1,4 @@
-import { ClientOptions, Client, checkAuthOptions } from '@viverse/sdk';
-import AvatarClient from '@viverse/sdk/avatar-client';
-import { ReactNode } from 'react';
-declare global {
-    interface ImportMeta {
-        readonly env: {
-            readonly VITE_VIVERSE_APP_ID?: string;
-        };
-    }
-}
-/**
- * provides the BvhPhysicsWorld context and the viverse context necassary for accessing any viverse content
- * @param props.loginRequired forces the user to login before playing
- */
-export declare function Viverse({ children, loginRequired, checkAuth, ...options }: Partial<ClientOptions> & {
-    children?: ReactNode;
-    loginRequired?: boolean;
-    checkAuth?: checkAuthOptions;
-}): import("react/jsx-runtime").JSX.Element;
-/**
- * Hook to access the Viverse client instance for making API calls.
- */
-export declare function useViverseClient(): Client | undefined;
-/**
- * Hook to access the current authentication state.
- */
-export declare function useViverseAuth(): {
-    access_token?: string;
-    account_id?: string;
-    expires_in?: number;
-    state?: string;
-} | undefined;
-/**
- * Hook to access the Viverse avatar client for avatar-related operations.
- */
-export declare function useViverseAvatarClient(): AvatarClient | undefined;
-/**
- * Hook to fetch and access the user's Viverse profile information.
- * Uses React Suspense for data fetching.
- */
-export declare function useViverseProfile(): Awaited<ReturnType<AvatarClient['getProfile']>> | undefined;
-/**
- * Hook that returns a function to initiate Viverse login flow.
- */
-export declare function useViverseLogin(): (options?: import("@viverse/sdk").iframeLoginOptions | undefined) => void;
-/**
- * Hook that returns a function to initiate Viverse logout flow.
- */
-export declare function useViverseLogout(): () => void;
-/**
- * Hook to fetch the user's personal avatar collection.
- * Uses React Suspense for data fetching.
- */
-export declare function useViverseAvatarList(): Awaited<ReturnType<AvatarClient['getAvatarList']>> | undefined;
-/**
- * Hook to fetch the user's currently active/selected avatar.
- * Uses React Suspense for data fetching.
- */
-export declare function useViverseActiveAvatar(): Awaited<ReturnType<AvatarClient['getActiveAvatar']>> | undefined;
-/**
- * Hook to fetch the list of publicly available avatars in Viverse.
- * Uses React Suspense for data fetching.
- */
-export declare function useViversePublicAvatarList(): Awaited<ReturnType<AvatarClient['getPublicAvatarList']>> | undefined;
-/**
- * Hook to fetch a specific public avatar by its ID.
- * Uses React Suspense for data fetching.
- */
-export declare function useViversePublicAvatarByID(id: string): Awaited<ReturnType<AvatarClient['getPublicAvatarByID']>> | undefined;
+export * from './viverse.js';
 export * from './material.js';
 export * as Vanilla from '@pmndrs/viverse';
 export { EventAction, StateAction, BooleanOr, PointerLockRotateZoomActionBindings, KeyboardLocomotionActionBindings, updateSimpleCharacterVelocity, MoveRightAction, MoveLeftAction, MoveForwardAction, MoveBackwardAction, RunAction, JumpAction, ZoomAction, RotateYawAction, RotatePitchAction, shouldJump, lowerBody, upperBody, WalkAnimationUrl, RunAnimationUrl, IdleAnimationUrl, JumpUpAnimationUrl, JumpLoopAnimationUrl, JumpDownAnimationUrl, FirstPersonCharacterCameraBehavior, BvhCharacterPhysics, type BvhCharacterPhysicsOptions, bvhBoneMap, CharacterCameraBehavior, } from '@pmndrs/viverse';

package/dist/index.js

@@ -1,157 +1,4 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { Client } from '@viverse/sdk';
-import AvatarClient from '@viverse/sdk/avatar-client';
-import { createContext, useCallback, useContext } from 'react';
-import { suspend, clear } from 'suspend-react';
-import { BvhPhysicsWorld } from './physics.js';
-// auth
-const viverseCheckAuthSymbol = Symbol('viverse-check-auth');
-const authSuspenseKeys = [];
-function clearViverseAuthCheck() {
-    for (const keys of authSuspenseKeys) {
-        clear(keys);
-    }
-    authSuspenseKeys.length = 0;
-}
-function useViverseAuthCheck(client, options) {
-    const keys = [viverseCheckAuthSymbol, client, options?.allowedOrigin];
-    return suspend(async () => {
-        authSuspenseKeys.push(keys);
-        return client?.checkAuth({ allowedOrigin: options?.allowedOrigin });
-    }, keys);
-}
-// main viverse component
-const ViverseClientContext = createContext(undefined);
-const ViverseAuthContext = createContext(undefined);
-const ViverseAvatarClientContext = createContext(undefined);
-const viverseClientSymbol = Symbol('viverse-client');
-const viverseAvatarClientSymbol = Symbol('viverse-avatar-client');
-/**
- * provides the BvhPhysicsWorld context and the viverse context necassary for accessing any viverse content
- * @param props.loginRequired forces the user to login before playing
- */
-export function Viverse({ children, loginRequired = false, checkAuth, ...options }) {
-    const clientId = options.clientId;
-    const client = suspend(async () => clientId == null
-        ? undefined
-        : new Client({
-            domain: options.domain ?? 'account.htcvive.com',
-            authorizationParams: options.authorizationParams,
-            cookieDomain: options.cookieDomain,
-            httpTimeoutInMS: options.httpTimeoutInMS,
-            clientId,
-        }), [
-        viverseClientSymbol,
-        clientId,
-        options.authorizationParams,
-        options.cookieDomain,
-        options.domain,
-        options.httpTimeoutInMS,
-    ]);
-    const auth = useViverseAuthCheck(client);
-    if (clientId != null && auth == null && loginRequired) {
-        clearViverseAuthCheck();
-        client?.loginWithWorlds().catch(console.error);
-    }
-    const avatarClient = suspend(async () => auth?.access_token != null
-        ? new AvatarClient({ token: auth.access_token, baseURL: 'https://sdk-api.viverse.com/' })
-        : undefined, [viverseAvatarClientSymbol, auth?.access_token]);
-    if (client == null) {
-        return _jsx(BvhPhysicsWorld, { children: children });
-    }
-    return (_jsx(ViverseClientContext.Provider, { value: client, children: _jsx(ViverseAuthContext.Provider, { value: auth, children: _jsx(ViverseAvatarClientContext.Provider, { value: avatarClient, children: _jsx(BvhPhysicsWorld, { children: children }) }) }) }));
-}
-/**
- * Hook to access the Viverse client instance for making API calls.
- */
-export function useViverseClient() {
-    return useContext(ViverseClientContext);
-}
-/**
- * Hook to access the current authentication state.
- */
-export function useViverseAuth() {
-    return useContext(ViverseAuthContext);
-}
-/**
- * Hook to access the Viverse avatar client for avatar-related operations.
- */
-export function useViverseAvatarClient() {
-    return useContext(ViverseAvatarClientContext);
-}
-const viverseProfileSymbol = Symbol('viverse-profile');
-/**
- * Hook to fetch and access the user's Viverse profile information.
- * Uses React Suspense for data fetching.
- */
-export function useViverseProfile() {
-    const avatarClient = useViverseAvatarClient();
-    return suspend(async () => avatarClient?.getProfile(), [viverseProfileSymbol, avatarClient]);
-}
-/**
- * Hook that returns a function to initiate Viverse login flow.
- */
-export function useViverseLogin() {
-    const client = useViverseClient();
-    return useCallback((...params) => {
-        if (client == null) {
-            console.warn(`useViverseLogin was called without an available client either because not Viverse provider is available or because no client id was provided to the Viverse provider`);
-            return;
-        }
-        clearViverseAuthCheck();
-        client.loginWithWorlds(...params);
-    }, [client]);
-}
-/**
- * Hook that returns a function to initiate Viverse logout flow.
- */
-export function useViverseLogout() {
-    const client = useViverseClient();
-    return useCallback((...params) => {
-        if (client == null) {
-            console.warn(`useViverseLogout was called without an available client either because not Viverse provider is available or because no client id was provided to the Viverse provider`);
-            return;
-        }
-        clearViverseAuthCheck();
-        client.logoutWithWorlds(...params);
-    }, [client]);
-}
-const viverseAvatarListSymbol = Symbol('viverse-avatar-list');
-/**
- * Hook to fetch the user's personal avatar collection.
- * Uses React Suspense for data fetching.
- */
-export function useViverseAvatarList() {
-    const avatarClient = useViverseAvatarClient();
-    return suspend(async () => avatarClient?.getAvatarList(), [viverseAvatarListSymbol, avatarClient]);
-}
-const viverseActiveAvatarSymbol = Symbol('viverse-active-avatar');
-/**
- * Hook to fetch the user's currently active/selected avatar.
- * Uses React Suspense for data fetching.
- */
-export function useViverseActiveAvatar() {
-    const avatarClient = useViverseAvatarClient();
-    return suspend(async () => avatarClient?.getActiveAvatar(), [viverseActiveAvatarSymbol, avatarClient]);
-}
-const viversePublicAvatarListSymbol = Symbol('viverse-public-avatar-list');
-/**
- * Hook to fetch the list of publicly available avatars in Viverse.
- * Uses React Suspense for data fetching.
- */
-export function useViversePublicAvatarList() {
-    const avatarClient = useViverseAvatarClient();
-    return suspend(async () => avatarClient?.getPublicAvatarList(), [viversePublicAvatarListSymbol, avatarClient]);
-}
-const viversePublicAvatarByIDSymbol = Symbol('viverse-public-avatar-by-id');
-/**
- * Hook to fetch a specific public avatar by its ID.
- * Uses React Suspense for data fetching.
- */
-export function useViversePublicAvatarByID(id) {
-    const avatarClient = useViverseAvatarClient();
-    return suspend(async () => avatarClient?.getPublicAvatarByID(id), [viversePublicAvatarByIDSymbol, avatarClient, id]);
-}
+export * from './viverse.js';
 export * from './material.js';
 export * as Vanilla from '@pmndrs/viverse';
 // Direct re-exports from @pmndrs/viverse used in examples and docs

package/dist/simple.js

@@ -5,10 +5,10 @@ import { Graph, GrapthState, Parallel, RunTimeline, Switch, SwitchCase, timePass
 import { forwardRef, Suspense, useImperativeHandle, useRef } from 'react';
 import { LoopOnce, Vector3 } from 'three';
 import { CharacterAnimationAction } from './animation.js';
-import { useViverseActiveAvatar } from './index.js';
 import { CharacterModelProvider } from './model.js';
 import { useBvhCharacterPhysics } from './physics.js';
 import { useCharacterCameraBehavior, useCharacterModelLoader, useSimpleCharacterActionBindings } from './utils.js';
+import { useViverseActiveAvatar } from './viverse.js';
 export const SimpleCharacter = forwardRef(({ input, actionBindings, inputOptions, actionBindingOptions, cameraBehavior, children, movement, physics: physicsOptions, model, useViverseAvatar, animation, ...props }, ref) => {
     useSimpleCharacterActionBindings(actionBindings ?? input, actionBindingOptions ?? inputOptions);
     const internalRef = useRef(null);

package/dist/utils.js

@@ -4,8 +4,8 @@ import { useFrame, useThree } from '@react-three/fiber';
 import { useEffect, useMemo, useRef } from 'react';
 import { suspend } from 'suspend-react';
 import { Object3D } from 'three';
-import { useViverseActiveAvatar } from './index.js';
 import { useBvhPhysicsWorld } from './physics.js';
+import { useViverseActiveAvatar } from './viverse.js';
 export function useCharacterCameraBehavior(model, options) {
     const behaviorRef = useRef(undefined);
     useEffect(() => {

package/dist/viverse.d.ts

@@ -0,0 +1,69 @@
+import { ClientOptions, Client, checkAuthOptions } from '@viverse/sdk';
+import AvatarClient from '@viverse/sdk/avatar-client';
+import { ReactNode } from 'react';
+declare global {
+    interface ImportMeta {
+        readonly env: {
+            readonly VITE_VIVERSE_APP_ID?: string;
+        };
+    }
+}
+/**
+ * provides the BvhPhysicsWorld context and the viverse context necassary for accessing any viverse content
+ * @param props.loginRequired forces the user to login before playing
+ */
+export declare function Viverse({ children, loginRequired, checkAuth, ...options }: Partial<ClientOptions> & {
+    children?: ReactNode;
+    loginRequired?: boolean;
+    checkAuth?: checkAuthOptions;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to access the Viverse client instance for making API calls.
+ */
+export declare function useViverseClient(): Client | undefined;
+/**
+ * Hook to access the current authentication state.
+ */
+export declare function useViverseAuth(): {
+    access_token?: string;
+    account_id?: string;
+    expires_in?: number;
+    state?: string;
+} | undefined;
+/**
+ * Hook to access the Viverse avatar client for avatar-related operations.
+ */
+export declare function useViverseAvatarClient(): AvatarClient | undefined;
+/**
+ * Hook to fetch and access the user's Viverse profile information.
+ * Uses React Suspense for data fetching.
+ */
+export declare function useViverseProfile(): Awaited<ReturnType<AvatarClient['getProfile']>> | undefined;
+/**
+ * Hook that returns a function to initiate Viverse login flow.
+ */
+export declare function useViverseLogin(): (options?: import("@viverse/sdk").iframeLoginOptions | undefined) => void;
+/**
+ * Hook that returns a function to initiate Viverse logout flow.
+ */
+export declare function useViverseLogout(): () => void;
+/**
+ * Hook to fetch the user's personal avatar collection.
+ * Uses React Suspense for data fetching.
+ */
+export declare function useViverseAvatarList(): Awaited<ReturnType<AvatarClient['getAvatarList']>> | undefined;
+/**
+ * Hook to fetch the user's currently active/selected avatar.
+ * Uses React Suspense for data fetching.
+ */
+export declare function useViverseActiveAvatar(): Awaited<ReturnType<AvatarClient['getActiveAvatar']>> | undefined;
+/**
+ * Hook to fetch the list of publicly available avatars in Viverse.
+ * Uses React Suspense for data fetching.
+ */
+export declare function useViversePublicAvatarList(): Awaited<ReturnType<AvatarClient['getPublicAvatarList']>> | undefined;
+/**
+ * Hook to fetch a specific public avatar by its ID.
+ * Uses React Suspense for data fetching.
+ */
+export declare function useViversePublicAvatarByID(id: string): Awaited<ReturnType<AvatarClient['getPublicAvatarByID']>> | undefined;

package/dist/viverse.js

@@ -0,0 +1,154 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Client } from '@viverse/sdk';
+import AvatarClient from '@viverse/sdk/avatar-client';
+import { createContext, useCallback, useContext } from 'react';
+import { suspend, clear } from 'suspend-react';
+import { BvhPhysicsWorld } from './physics.js';
+// auth
+const viverseCheckAuthSymbol = Symbol('viverse-check-auth');
+const authSuspenseKeys = [];
+function clearViverseAuthCheck() {
+    for (const keys of authSuspenseKeys) {
+        clear(keys);
+    }
+    authSuspenseKeys.length = 0;
+}
+function useViverseAuthCheck(client, options) {
+    const keys = [viverseCheckAuthSymbol, client, options?.allowedOrigin];
+    return suspend(async () => {
+        authSuspenseKeys.push(keys);
+        return client?.checkAuth({ allowedOrigin: options?.allowedOrigin });
+    }, keys);
+}
+// main viverse component
+const ViverseClientContext = createContext(undefined);
+const ViverseAuthContext = createContext(undefined);
+const ViverseAvatarClientContext = createContext(undefined);
+const viverseClientSymbol = Symbol('viverse-client');
+const viverseAvatarClientSymbol = Symbol('viverse-avatar-client');
+/**
+ * provides the BvhPhysicsWorld context and the viverse context necassary for accessing any viverse content
+ * @param props.loginRequired forces the user to login before playing
+ */
+export function Viverse({ children, loginRequired = false, checkAuth, ...options }) {
+    const clientId = options.clientId;
+    const client = suspend(async () => clientId == null
+        ? undefined
+        : new Client({
+            domain: options.domain ?? 'account.htcvive.com',
+            authorizationParams: options.authorizationParams,
+            cookieDomain: options.cookieDomain,
+            httpTimeoutInMS: options.httpTimeoutInMS,
+            clientId,
+        }), [
+        viverseClientSymbol,
+        clientId,
+        options.authorizationParams,
+        options.cookieDomain,
+        options.domain,
+        options.httpTimeoutInMS,
+    ]);
+    const auth = useViverseAuthCheck(client);
+    if (clientId != null && auth == null && loginRequired) {
+        clearViverseAuthCheck();
+        client?.loginWithWorlds().catch(console.error);
+    }
+    const avatarClient = suspend(async () => auth?.access_token != null
+        ? new AvatarClient({ token: auth.access_token, baseURL: 'https://sdk-api.viverse.com/' })
+        : undefined, [viverseAvatarClientSymbol, auth?.access_token]);
+    if (client == null) {
+        return _jsx(BvhPhysicsWorld, { children: children });
+    }
+    return (_jsx(ViverseClientContext.Provider, { value: client, children: _jsx(ViverseAuthContext.Provider, { value: auth, children: _jsx(ViverseAvatarClientContext.Provider, { value: avatarClient, children: _jsx(BvhPhysicsWorld, { children: children }) }) }) }));
+}
+/**
+ * Hook to access the Viverse client instance for making API calls.
+ */
+export function useViverseClient() {
+    return useContext(ViverseClientContext);
+}
+/**
+ * Hook to access the current authentication state.
+ */
+export function useViverseAuth() {
+    return useContext(ViverseAuthContext);
+}
+/**
+ * Hook to access the Viverse avatar client for avatar-related operations.
+ */
+export function useViverseAvatarClient() {
+    return useContext(ViverseAvatarClientContext);
+}
+const viverseProfileSymbol = Symbol('viverse-profile');
+/**
+ * Hook to fetch and access the user's Viverse profile information.
+ * Uses React Suspense for data fetching.
+ */
+export function useViverseProfile() {
+    const avatarClient = useViverseAvatarClient();
+    return suspend(async () => avatarClient?.getProfile(), [viverseProfileSymbol, avatarClient]);
+}
+/**
+ * Hook that returns a function to initiate Viverse login flow.
+ */
+export function useViverseLogin() {
+    const client = useViverseClient();
+    return useCallback((...params) => {
+        if (client == null) {
+            console.warn(`useViverseLogin was called without an available client either because not Viverse provider is available or because no client id was provided to the Viverse provider`);
+            return;
+        }
+        clearViverseAuthCheck();
+        client.loginWithWorlds(...params);
+    }, [client]);
+}
+/**
+ * Hook that returns a function to initiate Viverse logout flow.
+ */
+export function useViverseLogout() {
+    const client = useViverseClient();
+    return useCallback((...params) => {
+        if (client == null) {
+            console.warn(`useViverseLogout was called without an available client either because not Viverse provider is available or because no client id was provided to the Viverse provider`);
+            return;
+        }
+        clearViverseAuthCheck();
+        client.logoutWithWorlds(...params);
+    }, [client]);
+}
+const viverseAvatarListSymbol = Symbol('viverse-avatar-list');
+/**
+ * Hook to fetch the user's personal avatar collection.
+ * Uses React Suspense for data fetching.
+ */
+export function useViverseAvatarList() {
+    const avatarClient = useViverseAvatarClient();
+    return suspend(async () => avatarClient?.getAvatarList(), [viverseAvatarListSymbol, avatarClient]);
+}
+const viverseActiveAvatarSymbol = Symbol('viverse-active-avatar');
+/**
+ * Hook to fetch the user's currently active/selected avatar.
+ * Uses React Suspense for data fetching.
+ */
+export function useViverseActiveAvatar() {
+    const avatarClient = useViverseAvatarClient();
+    return suspend(async () => avatarClient?.getActiveAvatar(), [viverseActiveAvatarSymbol, avatarClient]);
+}
+const viversePublicAvatarListSymbol = Symbol('viverse-public-avatar-list');
+/**
+ * Hook to fetch the list of publicly available avatars in Viverse.
+ * Uses React Suspense for data fetching.
+ */
+export function useViversePublicAvatarList() {
+    const avatarClient = useViverseAvatarClient();
+    return suspend(async () => avatarClient?.getPublicAvatarList(), [viversePublicAvatarListSymbol, avatarClient]);
+}
+const viversePublicAvatarByIDSymbol = Symbol('viverse-public-avatar-by-id');
+/**
+ * Hook to fetch a specific public avatar by its ID.
+ * Uses React Suspense for data fetching.
+ */
+export function useViversePublicAvatarByID(id) {
+    const avatarClient = useViverseAvatarClient();
+    return suspend(async () => avatarClient?.getPublicAvatarByID(id), [viversePublicAvatarByIDSymbol, avatarClient, id]);
+}

package/package.json

@@ -29,7 +29,7 @@
     "@pixiv/three-vrm": "^3.4.2",
     "zustand": "^5.0.6",
     "@react-three/xr": "^6.6.20",
-    "@pmndrs/viverse": "^0.2.5"
+    "@pmndrs/viverse": "^0.2.6"
   },
   "peerDependencies": {
     "@react-three/fiber": "*"
@@ -40,7 +40,7 @@
     "@types/react": "^19.1.8",
     "react": "^19.1.0"
   },
-  "version": "0.2.5",
+  "version": "0.2.6",
   "scripts": {
     "build": "tsc",
     "check:prettier": "prettier --check src",