three-stdlib 2.23.2 → 2.23.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2023 Poimandres
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# three-stdlib
+
+[![Version](https://img.shields.io/npm/v/three-stdlib?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/three-stdlib)
+[![Downloads](https://img.shields.io/npm/dt/three-stdlib.svg?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/three-stdlib)
+[![Twitter](https://img.shields.io/twitter/follow/pmndrs?label=%40pmndrs&style=flat&colorA=000000&colorB=000000&logo=twitter&logoColor=000000)](https://twitter.com/pmndrs)
+[![Discord](https://img.shields.io/discord/740090768164651008?style=flat&colorA=000000&colorB=000000&label=discord&logo=discord&logoColor=000000)](https://discord.gg/ZZjjNvJ)
+[![release](https://github.com/pmndrs/three-stdlib/actions/workflows/main.yml/badge.svg?style=flat&colorA=000000&colorB=000000)](https://github.com/pmndrs/three-stdlib/actions/workflows/main.yml)
+
+Stand-alone version of [threejs/examples/jsm](https://github.com/mrdoob/three.js/tree/dev/examples/jsm) written in Typescript & built for ESM & CJS.
+
+## Basic usage
+
+    npm install three-stdlib
+
+```ts
+// Export collection
+import * as STDLIB from 'three-stdlib'
+// Flatbundle
+import { OrbitControls, ... } from 'three-stdlib'
+```
+
+## Problem
+
+`threejs/examples` are usually regarded as something that you copy/paste into your project and adapt to your needs. That's not how people use it, and this has caused numerous issues in the past.
+
+## Solution
+
+- A build system for esm and cjs
+- Version managed dependencies
+- Class based, optimized for tree-shaking, no globals, exports instead of collections
+- Single flatbundle as well as individual transpiles
+- Typesafety with simple annotation-like types
+- CI, tests, linting, formatting (prettier)
+
+But most importantly, allowing more people that use and rely on these primitives to hold a little stake, and to share the weight of maintaining it.
+
+## How to contribute
+
+If you want to get involved you could do any of the following:
+
+- Help to maintain and sync the existing primitives
+- Create stories for these examples for our dedicated storybook
+- Convert some of the files to Typescript
+- Add new examples for the library you think could be helpful for others

package/loaders/3DMLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Object3D } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Object3D } from 'three'
 
 export class Rhino3dmLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/3MFLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Group } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Group } from 'three'
 
 export class ThreeMFLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/AMFLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Group } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Group } from 'three'
 
 export class AMFLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/AssimpLoader.d.ts

@@ -1,5 +1,4 @@
-import { Object3D, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Object3D, LoadingManager } from 'three'
 
 export interface Assimp {
   animation: any

package/loaders/BVHLoader.d.ts

@@ -1,5 +1,4 @@
-import { AnimationClip, Skeleton, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, AnimationClip, Skeleton, LoadingManager } from 'three'
 
 export interface BVH {
   clip: AnimationClip

package/loaders/BasisTextureLoader.d.ts

@@ -1,5 +1,4 @@
-import { CompressedTexture, LoadingManager, WebGLRenderer } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, CompressedTexture, LoadingManager, WebGLRenderer } from 'three'
 
 export class BasisTextureLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/ColladaLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Scene } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Scene } from 'three'
 
 export interface Collada {
   kinematics: object

package/loaders/DRACOLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, BufferGeometry } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, BufferGeometry } from 'three'
 
 export class DRACOLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/FBXLoader.d.ts

@@ -1,5 +1,4 @@
-import { Group, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Group, LoadingManager } from 'three'
 
 export class FBXLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/FontLoader.cjs

@@ -7,8 +7,7 @@ var __publicField = (obj, key, value) => {
 };
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const THREE = require("three");
-const Loader = require("../types/Loader.cjs");
-class FontLoader extends Loader.Loader {
+class FontLoader extends THREE.Loader {
   constructor(manager) {
     super(manager);
   }
@@ -31,6 +30,9 @@ class FontLoader extends Loader.Loader {
       onError
     );
   }
+  loadAsync(url, onProgress) {
+    return super.loadAsync(url, onProgress);
+  }
   parse(json) {
     return new Font(json);
   }

package/loaders/FontLoader.d.ts

@@ -1,4 +1,4 @@
-import { Loader } from '../types/Loader';
+import { Loader } from 'three';
 import type { LoadingManager, Shape } from 'three';
 type Options = {
     lineHeight: number;
@@ -7,6 +7,7 @@ type Options = {
 export declare class FontLoader extends Loader {
     constructor(manager?: LoadingManager);
     load(url: string, onLoad?: (responseFont: Font) => void, onProgress?: (event: ProgressEvent) => void, onError?: (event: ErrorEvent) => void): void;
+    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<Font>;
     parse(json: FontData): Font;
 }
 type Glyph = {

package/loaders/FontLoader.js

@@ -4,8 +4,7 @@ var __publicField = (obj, key, value) => {
   __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
-import { FileLoader, ShapePath } from "three";
-import { Loader } from "../types/Loader.js";
+import { Loader, FileLoader, ShapePath } from "three";
 class FontLoader extends Loader {
   constructor(manager) {
     super(manager);
@@ -29,6 +28,9 @@ class FontLoader extends Loader {
       onError
     );
   }
+  loadAsync(url, onProgress) {
+    return super.loadAsync(url, onProgress);
+  }
   parse(json) {
     return new Font(json);
   }

package/loaders/GCodeLoader.d.ts

@@ -1,5 +1,4 @@
-import { Group, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Group, LoadingManager } from 'three'
 
 export class GCodeLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/GLTFLoader.d.ts

@@ -16,8 +16,8 @@ import {
   FileLoader,
   ImageBitmapLoader,
   Skeleton,
+  Loader,
 } from 'three'
-import { Loader } from '../types/Loader'
 
 import { DRACOLoader } from './DRACOLoader'
 import { KTX2Loader } from './KTX2Loader'

package/loaders/HDRCubeTextureLoader.d.ts

@@ -1,5 +1,4 @@
-import { CubeTexture, LoadingManager, TextureDataType } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, CubeTexture, LoadingManager, TextureDataType } from 'three'
 
 import { RGBELoader } from './RGBELoader'
 

package/loaders/KMZLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager } from 'three'
 
 import { Collada } from './ColladaLoader'
 

package/loaders/LDrawLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Group, Material } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Group, Material } from 'three'
 
 export class LDrawLoader extends Loader {
   materials: Material[]

package/loaders/LUT3dlLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, DataTexture, Texture } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, DataTexture, Texture } from 'three'
 
 export interface LUT3dlResult {
   size: number

package/loaders/LUTCubeLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Vector3, DataTexture, Texture } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Vector3, DataTexture, Texture } from 'three'
 
 export interface LUTCubeResult {
   title: string

package/loaders/LWOLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Material, Object3D } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Material, Object3D } from 'three'
 
 export interface LWO {
   materials: Material[]

package/loaders/LottieLoader.d.ts

@@ -1,5 +1,4 @@
-import { CanvasTexture, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, CanvasTexture, LoadingManager } from 'three'
 
 export class LottieLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/MD2Loader.d.ts

@@ -1,5 +1,4 @@
-import { BufferGeometry, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, BufferGeometry, LoadingManager } from 'three'
 
 export class MD2Loader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/MDDLoader.d.ts

@@ -1,5 +1,4 @@
-import { AnimationClip, BufferAttribute, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, AnimationClip, BufferAttribute, LoadingManager } from 'three'
 
 export interface MDD {
   morphTargets: BufferAttribute[]

package/loaders/MMDLoader.d.ts

@@ -1,5 +1,4 @@
-import { Camera, AnimationClip, FileLoader, LoadingManager, SkinnedMesh } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Camera, AnimationClip, FileLoader, LoadingManager, SkinnedMesh } from 'three'
 
 export interface MMDLoaderAnimationObject {
   animation: AnimationClip

package/loaders/MTLLoader.d.ts

@@ -1,5 +1,4 @@
-import { Material, LoadingManager, Mapping, BufferGeometry, Side, Texture, Vector2, Wrapping } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Material, LoadingManager, Mapping, BufferGeometry, Side, Texture, Vector2, Wrapping } from 'three'
 
 export interface MaterialCreatorOptions {
   /**

package/loaders/NRRDLoader.d.ts

@@ -1,8 +1,8 @@
-import { LoadingManager } from 'three'
+import { Loader, LoadingManager } from 'three'
 
 import { Volume } from '../misc/Volume'
 
-export class NRRDLoader {
+export class NRRDLoader extends Loader {
   constructor(manager?: LoadingManager)
   manager: LoadingManager
   path: string
@@ -15,6 +15,7 @@ export class NRRDLoader {
     onProgress?: (event: ProgressEvent) => void,
     onError?: (event: ErrorEvent) => void,
   ): void
+  loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<Volume>
   parse(data: string): Volume
   parseChars(array: number[], start?: number, end?: number): string
   setPath(value: string): this

package/loaders/OBJLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Group } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Group } from 'three'
 import { MaterialCreator } from './MTLLoader'
 
 export class OBJLoader extends Loader {

package/loaders/PCDLoader.d.ts

@@ -1,5 +1,4 @@
-import { Points, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Points, LoadingManager } from 'three'
 
 export class PCDLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/PDBLoader.d.ts

@@ -1,5 +1,4 @@
-import { BufferGeometry, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, BufferGeometry, LoadingManager } from 'three'
 
 export interface PDB {
   geometryAtoms: BufferGeometry

package/loaders/PLYLoader.d.ts

@@ -1,5 +1,4 @@
-import { BufferGeometry, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, BufferGeometry, LoadingManager } from 'three'
 
 export class PLYLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/PRWMLoader.d.ts

@@ -1,5 +1,4 @@
-import { BufferGeometry, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, BufferGeometry, LoadingManager } from 'three'
 
 export class PRWMLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/STLLoader.d.ts

@@ -1,5 +1,4 @@
-import { BufferGeometry, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, BufferGeometry, LoadingManager } from 'three'
 
 export class STLLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/SVGLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, ShapePath, BufferGeometry, Vector3, Shape } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, ShapePath, BufferGeometry, Vector3, Shape } from 'three'
 
 export interface SVGResultPaths extends ShapePath {
   userData?:

package/loaders/TDSLoader.d.ts

@@ -1,5 +1,4 @@
-import { Color, Group, LoadingManager, Material, Mesh, Texture } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Color, Group, LoadingManager, Material, Mesh, Texture } from 'three'
 
 export class TDSLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/TTFLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager } from 'three'
 
 export class TTFLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/TiltLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager, Group } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager, Group } from 'three'
 
 export class TiltLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/VOXLoader.d.ts

@@ -1,5 +1,4 @@
-import { Texture, Mesh, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Texture, Mesh, LoadingManager } from 'three'
 
 export interface Chunk {
   palette: number[]

package/loaders/VRMLLoader.d.ts

@@ -1,5 +1,4 @@
-import { Scene, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Scene, LoadingManager } from 'three'
 
 export class VRMLLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/VRMLoader.d.ts

@@ -1,5 +1,4 @@
-import { LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, LoadingManager } from 'three'
 
 import { GLTFLoader, GLTF } from './GLTFLoader'
 import { DRACOLoader } from './DRACOLoader'

package/loaders/VTKLoader.d.ts

@@ -1,5 +1,4 @@
-import { BufferGeometry, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, BufferGeometry, LoadingManager } from 'three'
 
 export class VTKLoader extends Loader {
   constructor(manager?: LoadingManager)

package/loaders/XLoader.d.ts

@@ -1,5 +1,4 @@
-import { Mesh, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, Mesh, LoadingManager } from 'three'
 
 export interface XResult {
   animations: object[]

package/loaders/XYZLoader.d.ts

@@ -1,5 +1,4 @@
-import { BufferGeometry, LoadingManager } from 'three'
-import { Loader } from '../types/Loader'
+import { Loader, BufferGeometry, LoadingManager } from 'three'
 
 export class XYZLoader extends Loader {
   constructor(manager?: LoadingManager)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "three-stdlib",
-  "version": "2.23.2",
+  "version": "2.23.4",
   "description": "stand-alone library of threejs examples",
   "keywords": [
     "three",
@@ -49,7 +49,7 @@
     "three": ">=0.128.0"
   },
   "scripts": {
-    "build": "rimraf dist && vite build && tsc --emitDeclarationOnly && copyfiles -u 1 \"src/**/*.d.ts\" dist && copyfiles package.json dist && json -I -f dist/package.json -e \"this.private=undefined; this.types=\\\"./index.d.ts\\\"; this.main=\\\"./index.cjs\\\"; this.module=\\\"./index.js\\\";\"",
+    "build": "rimraf dist && vite build && tsc --emitDeclarationOnly && copyfiles -u 1 \"src/**/*.d.ts\" dist && copyfiles package.json README.md LICENSE dist && json -I -f dist/package.json -e \"this.private=undefined; this.types=\\\"./index.d.ts\\\"; this.main=\\\"./index.cjs\\\"; this.module=\\\"./index.js\\\";\"",
     "lint": "tsc --noEmit"
   }
 }

package/types/Loader.cjs

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const THREE = require("three");
-function _interopNamespaceDefault(e) {
-  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
-  if (e) {
-    for (const k in e) {
-      if (k !== "default") {
-        const d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: () => e[k]
-        });
-      }
-    }
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-const THREE__namespace = /* @__PURE__ */ _interopNamespaceDefault(THREE);
-class Loader extends THREE__namespace.Loader {
-  loadAsync(url, onProgress) {
-    return super.loadAsync(url, onProgress);
-  }
-}
-exports.Loader = Loader;

package/types/Loader.d.ts

@@ -1,4 +0,0 @@
-import * as THREE from 'three';
-export declare class Loader extends THREE.Loader {
-    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<any>;
-}

package/types/Loader.js

@@ -1,9 +0,0 @@
-import * as THREE from "three";
-class Loader extends THREE.Loader {
-  loadAsync(url, onProgress) {
-    return super.loadAsync(url, onProgress);
-  }
-}
-export {
-  Loader
-};