@tresjs/core 4.3.6 → 5.0.0-alpha.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tresjs/core",
   "type": "module",
-  "version": "4.3.6",
+  "version": "5.0.0-alpha.0",
   "packageManager": "pnpm@10.6.3",
   "description": "Declarative ThreeJS using Vue Components",
   "author": "Alvaro Saburido <hola@alvarosaburido.dev> (https://github.com/alvarosabu/)",
@@ -20,9 +20,15 @@
   "sideEffects": false,
   "exports": {
     ".": {
+      "development": {
+        "types": "./src/index.ts",
+        "import": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
       "types": "./dist/index.d.ts",
       "import": "./dist/tres.js",
-      "require": "./dist/tres.umd.cjs"
+      "require": "./dist/tres.js",
+      "default": "./dist/tres.js"
     },
     "./components": {
       "types": "./dist/src/components/index.d.ts"
@@ -59,27 +65,31 @@
     "coverage": "vitest run --coverage",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:serve": "vitepress serve docs",
-    "docs:preview": "vitepress preview docs",
-    "docs:contributors": "esno scripts/update-contributors.ts"
+    "typecheck": "vue-tsc --noEmit",
+    "docs:dev": "pnpm --filter='./docs' dev",
+    "docs:generate": "pnpm --filter='./docs' generate",
+    "docs:prepare": "pnpm --filter='./docs' prepare",
+    "docs:lint": "pnpm --filter='./docs' lint",
+    "docs:typecheck": "pnpm --filter='./docs' typecheck",
+    "postinstall": "pnpm run build && pnpm --filter='./docs' prepare"
   },
   "peerDependencies": {
     "three": ">=0.133",
     "vue": ">=3.4"
   },
   "dependencies": {
-    "@alvarosabu/utils": "^3.2.0",
-    "@vue/devtools-api": "^6.6.3",
-    "@vueuse/core": "^12.5.0"
+    "@pmndrs/pointer-events": "^6.6.17",
+    "@vue/devtools-api": "^7.7.2",
+    "@vueuse/core": "^12.5.0",
+    "radashi": "^12.6.0"
   },
   "devDependencies": {
     "@release-it/conventional-changelog": "^10.0.0",
     "@stackblitz/sdk": "^1.11.0",
-    "@tresjs/cientos": "4.1.0",
+    "@tresjs/cientos": "5.0.0-next.0",
     "@tresjs/eslint-config": "^1.4.0",
-    "@types/three": "^0.173.0",
+    "@tresjs/leches": "1.0.0-next.0",
+    "@types/three": "^0.177.0",
     "@typescript-eslint/eslint-plugin": "^8.23.0",
     "@typescript-eslint/parser": "^8.23.0",
     "@vitejs/plugin-vue": "^5.2.1",
@@ -100,19 +110,35 @@
     "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-visualizer": "^5.14.0",
     "sponsorkit": "^16.3.0",
-    "three": "^0.173.0",
+    "three": "^0.177.0",
     "unocss": "^65.4.3",
     "unplugin": "^2.1.2",
     "unplugin-vue-components": "^28.0.0",
     "vite": "^6.1.0",
     "vite-plugin-banner": "^0.8.0",
-    "vite-plugin-dts": "4.5.0",
+    "vite-plugin-dts": "4.5.4",
     "vite-plugin-inspect": "^10.1.0",
     "vite-plugin-require-transform": "^1.0.21",
     "vite-svg-loader": "^5.1.0",
     "vitepress": "1.6.3",
     "vitest": "3.0.5",
-    "vue": "3.5.13",
-    "vue-demi": "^0.14.10"
+    "vue": "3.5.17",
+    "vue-demi": "^0.14.10",
+    "vue-tsc": "^2.2.0"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "better-sqlite3"
+    ],
+    "ignoredBuiltDependencies": [
+      "vue-demi"
+    ],
+    "overrides": {
+      "vue": "^3.5.13",
+      "vue-router": "^4.5.0"
+    }
+  },
+  "resolutions": {
+    "unimport": "4.1.1"
   }
 }

package/dist/src/composables/useLogger.d.ts

@@ -1,11 +0,0 @@
-export declare const isProd: boolean;
-type OneOrMore<T> = {
-    0: T;
-} & Array<T>;
-interface LoggerComposition {
-    logError: (...args: OneOrMore<any>) => void;
-    logWarning: (...args: OneOrMore<any>) => void;
-    logMessage: (name: string, value: any) => void;
-}
-export declare function useLogger(): LoggerComposition;
-export {};

package/dist/src/composables/useRaycaster/index.d.ts

@@ -1,16 +0,0 @@
-import { TresEvent, TresInstance } from 'src/types';
-import { Intersection, Object3D, Object3DEventMap } from 'three';
-import { ShallowRef } from 'vue';
-import { TresContext } from '../useTresContextProvider';
-export declare const useRaycaster: (objectsWithEvents: ShallowRef<TresInstance[]>, ctx: TresContext) => {
-    intersects: ShallowRef<Intersection<Object3D<Object3DEventMap>>[]>;
-    onClick: (fn: (value: TresEvent) => void) => () => void;
-    onDblClick: (fn: (value: TresEvent) => void) => () => void;
-    onContextMenu: (fn: (value: TresEvent) => void) => () => void;
-    onPointerMove: (fn: (value: TresEvent) => void) => () => void;
-    onPointerUp: (fn: (value: TresEvent) => void) => () => void;
-    onPointerDown: (fn: (value: TresEvent) => void) => () => void;
-    onPointerMissed: (fn: (value: TresEvent) => void) => () => void;
-    onWheel: (fn: (value: TresEvent) => void) => () => void;
-    forceUpdate: () => void;
-};

package/dist/src/composables/useRenderLoop/index.d.ts

@@ -1,17 +0,0 @@
-import { EventHookOn, Fn } from '@vueuse/core';
-import { Ref } from 'vue';
-import { Clock } from 'three';
-export interface RenderLoop {
-    delta: number;
-    elapsed: number;
-    clock: Clock;
-}
-export interface UseRenderLoopReturn {
-    onBeforeLoop: EventHookOn<RenderLoop>;
-    onLoop: EventHookOn<RenderLoop>;
-    onAfterLoop: EventHookOn<RenderLoop>;
-    pause: Fn;
-    resume: Fn;
-    isActive: Ref<boolean>;
-}
-export declare const useRenderLoop: () => UseRenderLoopReturn;

package/dist/src/composables/useRenderer/const.d.ts

@@ -1,18 +0,0 @@
-export declare const rendererPresets: {
-    realistic: {
-        shadows: boolean;
-        physicallyCorrectLights: boolean;
-        outputColorSpace: "srgb";
-        toneMapping: 4;
-        toneMappingExposure: number;
-        shadowMap: {
-            enabled: boolean;
-            type: 2;
-        };
-    };
-    flat: {
-        toneMapping: 0;
-        toneMappingExposure: number;
-    };
-};
-export type RendererPresetsType = keyof typeof rendererPresets;

package/dist/src/composables/useRenderer/index.d.ts

@@ -1,91 +0,0 @@
-import { ColorSpace, Scene, ShadowMapType, ToneMapping, WebGLRendererParameters, WebGLRenderer } from 'three';
-import { EmitEventFn, TresColor } from '../../types';
-import { TresContext } from '../useTresContextProvider';
-import { RendererPresetsType } from './const';
-import { MaybeRefOrGetter } from '@vueuse/core';
-import { MaybeRef } from 'vue';
-type TransformToMaybeRefOrGetter<T> = {
-    [K in keyof T]: MaybeRefOrGetter<T[K]> | MaybeRefOrGetter<T[K]>;
-};
-export interface UseRendererOptions extends TransformToMaybeRefOrGetter<WebGLRendererParameters> {
-    /**
-     * Enable shadows in the Renderer
-     *
-     * @default false
-     */
-    shadows?: MaybeRefOrGetter<boolean>;
-    /**
-     * Set the shadow map type
-     * Can be PCFShadowMap, PCFSoftShadowMap, BasicShadowMap, VSMShadowMap
-     * [see](https://threejs.org/docs/?q=we#api/en/constants/Renderer)
-     *
-     * @default PCFSoftShadowMap
-     */
-    shadowMapType?: MaybeRefOrGetter<ShadowMapType>;
-    /**
-     * Whether to use physically correct lighting mode.
-     * See the [lights / physical example](https://threejs.org/examples/#webgl_lights_physical).
-     *
-     * @default false
-     * @deprecated Use {@link WebGLRenderer.useLegacyLights useLegacyLights} instead.
-     */
-    physicallyCorrectLights?: MaybeRefOrGetter<boolean>;
-    /**
-     * Whether to use legacy lighting mode.
-     *
-     * @type {MaybeRefOrGetter<boolean>}
-     * @memberof UseRendererOptions
-     */
-    useLegacyLights?: MaybeRefOrGetter<boolean>;
-    /**
-     * Defines the output encoding of the renderer.
-     * Can be LinearSRGBColorSpace, SRGBColorSpace
-     *
-     * @default LinearSRGBColorSpace
-     */
-    outputColorSpace?: MaybeRefOrGetter<ColorSpace>;
-    /**
-     * Defines the tone mapping used by the renderer.
-     * Can be NoToneMapping, LinearToneMapping,
-     * ReinhardToneMapping, Uncharted2ToneMapping,
-     * CineonToneMapping, ACESFilmicToneMapping,
-     * CustomToneMapping
-     *
-     * @default ACESFilmicToneMapping
-     */
-    toneMapping?: MaybeRefOrGetter<ToneMapping>;
-    /**
-     * Defines the tone mapping exposure used by the renderer.
-     *
-     * @default 1
-     */
-    toneMappingExposure?: MaybeRefOrGetter<number>;
-    /**
-     * The color value to use when clearing the canvas.
-     *
-     * @default 0x000000
-     */
-    clearColor?: MaybeRefOrGetter<TresColor>;
-    windowSize?: MaybeRefOrGetter<boolean | string>;
-    preset?: MaybeRefOrGetter<RendererPresetsType>;
-    renderMode?: MaybeRefOrGetter<'always' | 'on-demand' | 'manual'>;
-    /**
-     * A `number` sets the renderer's device pixel ratio.
-     * `[number, number]` clamp's the renderer's device pixel ratio.
-     */
-    dpr?: MaybeRefOrGetter<number | [number, number]>;
-}
-export declare function useRenderer({ canvas, options, contextParts: { sizes, render, invalidate, advance }, }: {
-    canvas: MaybeRef<HTMLCanvasElement>;
-    scene: Scene;
-    options: UseRendererOptions;
-    emit: EmitEventFn;
-    contextParts: Pick<TresContext, 'sizes' | 'camera' | 'render'> & {
-        invalidate: () => void;
-        advance: () => void;
-    };
-}): {
-    renderer: import('vue').ShallowRef<WebGLRenderer, WebGLRenderer>;
-};
-export type UseRendererReturn = ReturnType<typeof useRenderer>;
-export {};

package/dist/src/composables/useSeek/index.d.ts

@@ -1,20 +0,0 @@
-import { Object3D, Scene } from 'three';
-/**
- * Seek composable return type
- *
- * @export
- * @interface UseSeekReturn
- */
-export interface UseSeekReturn {
-    seek: (parent: Scene | Object3D, property: string, value: string) => Object3D | null;
-    seekByName: (parent: Scene | Object3D, value: string) => Object3D | null;
-    seekAll: (parent: Scene | Object3D, property: string, value: string) => Object3D[];
-    seekAllByName: (parent: Scene | Object3D, value: string) => Object3D[];
-}
-/**
- * Composable that provides utilities to easily traverse and navigate through complex scenes and object children graphs
- *
- * @export
- * @return {*}  {UseSeekReturn}
- */
-export declare function useSeek(): UseSeekReturn;

package/dist/src/composables/useTexture/component.vue.d.ts

@@ -1,29 +0,0 @@
-import { PBRUseTextureMap } from './index';
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: {
-        default?(_: {
-            textures: {
-                map: import('three').Texture;
-                displacementMap: import('three').Texture;
-                normalMap: import('three').Texture;
-                roughnessMap: import('three').Texture;
-                metalnessMap: import('three').Texture;
-                aoMap: import('three').Texture;
-                alphaMap: import('three').Texture;
-                matcap: import('three').Texture;
-            };
-        }): any;
-    };
-    refs: {};
-    rootEl: any;
-};
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<PBRUseTextureMap, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<PBRUseTextureMap> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
-export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};

package/dist/src/composables/useTexture/index.d.ts

@@ -1,103 +0,0 @@
-import { Texture } from 'three';
-export interface PBRMaterialOptions {
-    /**
-     * List of texture maps to load.
-     *
-     * @type {string[]}
-     * @memberof PBRMaterialOptions
-     */
-    maps: string[];
-    /**
-     * Path to the texture maps.
-     *
-     * @type {('png' | 'jpg')}
-     * @memberof PBRMaterialOptions
-     */
-    ext: 'png' | 'jpg';
-}
-export interface PBRTextureMaps {
-    [key: string]: Texture | null;
-}
-/**
- * Map of textures to load that can be passed to `useTexture()`.
- */
-export interface PBRUseTextureMap {
-    map?: string;
-    displacementMap?: string;
-    normalMap?: string;
-    roughnessMap?: string;
-    metalnessMap?: string;
-    aoMap?: string;
-    alphaMap?: string;
-    matcap?: string;
-}
-/**
- * Loads a single texture.
- *
- * ```ts
- * import { useTexture } from 'tres'
- *
- * const matcapTexture = await useTexture(['path/to/texture.png'])
- * ```
- * Then you can use the texture in your material.
- *
- * ```vue
- * <TresMeshMatcapMaterial :matcap="matcapTexture" />
- * ```
- * @see https://tresjs.org/examples/load-textures.html
- * @export
- * @param paths
- * @return A promise of the resulting texture
- */
-export declare function useTexture(paths: readonly [string]): Promise<Texture>;
-/**
- * Loads multiple textures.
- *
- * ```ts
- * import { useTexture } from 'tres'
- *
- * const [texture1, texture2] = await useTexture([
- *  'path/to/texture1.png',
- *  'path/to/texture2.png',
- * ])
- * ```
- * Then you can use the texture in your material.
- *
- * ```vue
- * <TresMeshStandardMaterial map="texture1" />
- * ```
- * @see https://tresjs.org/examples/load-textures.html
- * @export
- * @param paths
- * @return A promise of the resulting textures
- */
-export declare function useTexture<T extends string[]>(paths: [...T]): Promise<{
-    [K in keyof T]: Texture;
-}>;
-/**
- * Loads a PBR texture map.
- *
- * ```ts
- * import { useTexture } from 'tres'
- *
- * const pbrTexture = await useTexture({
- *  map: 'path/to/texture.png',
- *  displacementMap: 'path/to/displacement-map.png',
- *  roughnessMap: 'path/to/roughness-map.png',
- *  normalMap: 'path/to/normal-map.png',
- *  ambientOcclusionMap: 'path/to/ambient-occlusion-map.png',
- * })
- * ```
- * Then you can use the texture in your material.
- *
- * ```vue
- * <TresMeshStandardMaterial v-bind="pbrTexture" />
- * ```
- * @see https://tresjs.org/examples/load-textures.html
- * @export
- * @param paths
- * @return A promise of the resulting pbr texture map
- */
-export declare function useTexture<TextureMap extends PBRUseTextureMap>(paths: TextureMap): Promise<{
-    [K in keyof Required<PBRUseTextureMap>]: K extends keyof TextureMap ? Texture : null;
-}>;

package/dist/src/composables/useTresEventManager/index.d.ts

@@ -1,25 +0,0 @@
-import { EmitEventFn } from 'src/types';
-import { Scene } from 'three';
-import { TresContext } from '../useTresContextProvider';
-export interface TresEventManager {
-    /**
-     * Forces the event system to refire events with the previous mouse event
-     */
-    forceUpdate: () => void;
-    /**
-     * pointer-missed events by definition are fired when the pointer missed every object in the scene
-     * So we need to track them separately
-     * Note: These are used in nodeOps
-     */
-    registerObject: (object: unknown) => void;
-    deregisterObject: (object: unknown) => void;
-    registerPointerMissedObject: (object: unknown) => void;
-    deregisterPointerMissedObject: (object: unknown) => void;
-}
-export declare function useTresEventManager(scene: Scene, context: TresContext, emit: EmitEventFn): {
-    forceUpdate: () => void;
-    registerObject: (maybeTresObject: unknown) => void;
-    deregisterObject: (maybeTresObject: unknown) => void;
-    registerPointerMissedObject: (maybeTresObject: unknown) => void;
-    deregisterPointerMissedObject: (maybeTresObject: unknown) => void;
-};

package/dist/src/composables/useTresReady/createReadyEventHook/index.d.ts

@@ -1,4 +0,0 @@
-import { EventHook } from '@vueuse/core';
-export declare function createReadyEventHook<T>(getIsReady: () => boolean, triggerParams: T, pollIntervalMs?: number): EventHook<T> & {
-    cancel: () => void;
-};

package/dist/src/composables/useTresReady/index.d.ts

@@ -1,7 +0,0 @@
-import { TresContext } from '../useTresContextProvider';
-export declare function useTresReady(ctx?: TresContext): import('@vueuse/core').EventHook<TresContext> & {
-    cancel: () => void;
-};
-export declare function onTresReady(fn: (ctx: TresContext) => void): {
-    off: () => void;
-} | undefined;

package/dist/src/core/loop.d.ts

@@ -1,38 +0,0 @@
-import { Fn } from '@vueuse/core';
-import { Camera, EventDispatcher, Raycaster, Scene, WebGLRenderer, Clock } from 'three';
-import { Ref } from 'vue';
-export type LoopStage = 'before' | 'render' | 'after';
-export interface LoopCallback {
-    delta: number;
-    elapsed: number;
-    clock: Clock;
-}
-export interface LoopCallbackWithCtx extends LoopCallback {
-    camera: Camera;
-    scene: Scene;
-    renderer: WebGLRenderer;
-    raycaster: Raycaster;
-    controls: Ref<(EventDispatcher<object> & {
-        enabled: boolean;
-    }) | null>;
-    invalidate: Fn;
-    advance: Fn;
-}
-export type LoopCallbackFn = (params: LoopCallbackWithCtx) => void;
-export interface RendererLoop {
-    loopId: string;
-    register: (callback: LoopCallbackFn, stage: LoopStage, index?: number) => {
-        off: Fn;
-    };
-    start: Fn;
-    stop: Fn;
-    pause: Fn;
-    resume: Fn;
-    pauseRender: Fn;
-    resumeRender: Fn;
-    isActive: Ref<boolean>;
-    isRenderPaused: Ref<boolean>;
-    setContext: (newContext: Record<string, any>) => void;
-    setReady: (isReady: boolean) => void;
-}
-export declare function createRenderLoop(): RendererLoop;

package/dist/src/utils/is.d.ts

@@ -1,36 +0,0 @@
-import { TresObject, TresPrimitive } from 'src/types';
-import { BufferGeometry, Camera, Color, ColorRepresentation, Fog, Light, Material, Object3D, Scene, Layers } from 'three';
-export declare function und(u: unknown): u is undefined;
-export declare function arr(u: unknown): u is Array<unknown>;
-export declare function num(u: unknown): u is number;
-export declare function str(u: unknown): u is string;
-export declare function bool(u: unknown): u is boolean;
-export declare function fun(u: unknown): u is (...args: any[]) => any;
-export declare function obj(u: unknown): u is Record<string | number | symbol, unknown>;
-export declare function object3D(u: unknown): u is Object3D;
-export declare function color(u: unknown): u is Color;
-export declare function colorRepresentation(u: unknown): u is ColorRepresentation;
-interface VectorLike {
-    set: (...args: any[]) => void;
-    constructor?: (...args: any[]) => any;
-}
-export declare function vectorLike(u: unknown): u is VectorLike;
-interface Copyable {
-    copy: (...args: any[]) => void;
-    constructor?: (...args: any[]) => any;
-}
-export declare function copyable(u: unknown): u is Copyable;
-interface ClassInstance {
-    constructor?: (...args: any[]) => any;
-}
-export declare function classInstance(object: unknown): object is ClassInstance;
-export declare function layers(u: unknown): u is Layers;
-export declare function camera(u: unknown): u is Camera;
-export declare function bufferGeometry(u: unknown): u is BufferGeometry;
-export declare function material(u: unknown): u is Material;
-export declare function light(u: unknown): u is Light;
-export declare function fog(u: unknown): u is Fog;
-export declare function scene(u: unknown): u is Scene;
-export declare function tresObject(u: unknown): u is TresObject;
-export declare function tresPrimitive(u: unknown): u is TresPrimitive;
-export {};