@objectifthunes/three-book 0.3.1 → 0.4.1

package/dist/mathUtils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Shared math utilities extracted from Paper.ts, StapleBinding.ts,
+ * AutoTurn.ts, and PaperMeshUtility.ts to eliminate duplication.
+ *
+ * This file has NO imports from implementation files to avoid circular deps.
+ */
+export declare const DEG2RAD: number;
+export declare const RAD2DEG: number;
+export declare function clamp(value: number, min: number, max: number): number;
+export declare function clamp01(value: number): number;
+/** Linear interpolation with `t` clamped to [0, 1]. */
+export declare function lerp(a: number, b: number, t: number): number;
+/** Linear interpolation without clamping `t`. */
+export declare function lerpUnclamped(a: number, b: number, t: number): number;
+export declare function inverseLerp(a: number, b: number, value: number): number;
+/** Unity's exact SmoothStep: clamp01((t-from)/(to-from)); t*t*(3-2*t) */
+export declare function smoothStep(from: number, to: number, t: number): number;
+//# sourceMappingURL=mathUtils.d.ts.map

package/dist/mathUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mathUtils.d.ts","sourceRoot":"","sources":["../src/mathUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,QAAgB,CAAC;AACrC,eAAO,MAAM,OAAO,QAAgB,CAAC;AAErC,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAErE;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED,uDAAuD;AACvD,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED,iDAAiD;AACjD,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAErE;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAGvE;AAED,yEAAyE;AACzE,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGtE"}

package/dist/textContentUtils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Shared utilities for canvas-based page content classes
+ * (TextOverlayContent, SpreadContent).
+ */
+import * as THREE from 'three';
+import type { TextBlock } from './TextBlock';
+import type { TextBlockOptions } from './TextBlock';
+export type MappedMaterial = THREE.Material & {
+    map: THREE.Texture;
+};
+export declare function hasMaterialMap(mat: THREE.Material): mat is MappedMaterial;
+/**
+ * Traverse `root` and set `needsUpdate = true` on every material map whose
+ * source image matches the given canvas.
+ *
+ * This compensates for three-book's Renderer cloning textures on first
+ * assignment — cloned textures share the same `image` reference but won't
+ * pick up the `needsUpdate` flag from the original CanvasTexture.
+ */
+export declare function syncMaterialsForCanvas(root: THREE.Object3D, canvas: HTMLCanvasElement): void;
+/**
+ * Apply a partial set of TextBlockOptions onto an existing TextBlock.
+ * Only provided (non-undefined) fields are written.
+ */
+export declare function applyTextBlockOptions(block: TextBlock, options: Partial<TextBlockOptions>): void;
+//# sourceMappingURL=textContentUtils.d.ts.map

package/dist/textContentUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textContentUtils.d.ts","sourceRoot":"","sources":["../src/textContentUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,GAAG;IAAE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAA;CAAE,CAAC;AAErE,wBAAgB,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,GAAG,GAAG,IAAI,cAAc,CAEzE;AAID;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,KAAK,CAAC,QAAQ,EACpB,MAAM,EAAE,iBAAiB,GACxB,IAAI,CAWN;AAID;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,EAChB,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACjC,IAAI,CAeN"}

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Shared type definitions for the three-book library.
+ *
+ * Centralises interfaces and enums that are referenced across multiple files,
+ * breaking circular dependencies between Book, Paper, BookBinding, etc.
+ */
+import * as THREE from 'three';
+import type { BookContent } from './BookContent';
+import type { BookDirection } from './BookDirection';
+import type { Paper } from './Paper';
+export interface IPageContent {
+    readonly texture: THREE.Texture | null;
+    readonly textureST: THREE.Vector4;
+    isPointOverUI(textureCoord: THREE.Vector2): boolean;
+    init(bookContent: BookContent): void;
+    setActive(active: boolean): void;
+}
+export interface BookRaycastHit {
+    point: THREE.Vector3;
+    textureCoordinate: THREE.Vector2;
+    pageContent: IPageContent | null;
+    paperIndex: number;
+    pageIndex: number;
+}
+export declare enum AutoTurnMode {
+    /** This mode simulates swiping the paper surface to turn it. */
+    Surface = 0,
+    /** This mode simulates holding the paper edge and turning it. */
+    Edge = 1
+}
+export interface IBookBound {
+    resetPaperPosition(paper: Paper): void;
+    updatePaperPosition(paper: Paper): void;
+}
+export interface IBookOwner {
+    readonly bound: IBookBound | null;
+    readonly castShadows: boolean;
+    readonly reduceShadows: boolean;
+    readonly direction: BookDirection;
+}
+export interface PropertyBlock {
+    color: THREE.Color;
+    map: THREE.Texture | null;
+    textureST: THREE.Vector4;
+}
+export interface IBinderRenderer {
+    setVisibility(visible: boolean): void;
+}
+export interface IPaperRenderer {
+    readonly transform: THREE.Object3D;
+    mesh: THREE.BufferGeometry | null;
+    castShadows: boolean;
+    setMaterials(materials: THREE.Material[]): void;
+    setPropertyBlock(props: PropertyBlock, materialIndex: number): void;
+    readonly bounds: THREE.Box3;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAMrC,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;IAClC,aAAa,CAAC,YAAY,EAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IACpD,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IACrC,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CAClC;AAMD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;IACrB,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC;IACjC,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD,oBAAY,YAAY;IACtB,gEAAgE;IAChE,OAAO,IAAI;IACX,iEAAiE;IACjE,IAAI,IAAI;CACT;AAMD,MAAM,WAAW,UAAU;IACzB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACvC,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACzC;AAMD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CACnC;AAMD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;IACnB,GAAG,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;CAC1B;AAMD,MAAM,WAAW,eAAe;IAC9B,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACvC;AAMD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC;IACnC,IAAI,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;IAClC,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC;IAChD,gBAAgB,CAAC,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACpE,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;CAC7B"}

package/dist/utils/LoopUtility.d.ts

@@ -6,9 +6,4 @@ export declare function nextIndex(index: number, arrayLength: number): number;
  * Returns the previous index in a circular array, wrapping from 0 to the end.
  */
 export declare function prevIndex(index: number, arrayLength: number): number;
-/**
- * Wraps an index into the valid range [0, arrayLength) using floor-based modulo.
- * Handles negative indices correctly (unlike the JS % operator).
- */
-export declare function loopIndex(index: number, arrayLength: number): number;
 //# sourceMappingURL=LoopUtility.d.ts.map

package/dist/utils/LoopUtility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LoopUtility.d.ts","sourceRoot":"","sources":["../../src/utils/LoopUtility.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAGpE;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAEpE"}
+{"version":3,"file":"LoopUtility.d.ts","sourceRoot":"","sources":["../../src/utils/LoopUtility.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAGpE"}

package/dist/utils/TextureUtility.d.ts

@@ -13,5 +13,4 @@ export declare function xFlipST(st: THREE.Vector4): THREE.Vector4;
  * Flip the Y axis of a texture ST vector.
  */
 export declare function yFlipST(st: THREE.Vector4): THREE.Vector4;
-export declare function fixNull(texture: THREE.Texture | null): THREE.Texture;
 //# sourceMappingURL=TextureUtility.d.ts.map

package/dist/utils/TextureUtility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextureUtility.d.ts","sourceRoot":"","sources":["../../src/utils/TextureUtility.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;;GAGG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAExD;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAExD;AAQD,wBAAgB,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC,OAAO,CAWpE"}
+{"version":3,"file":"TextureUtility.d.ts","sourceRoot":"","sources":["../../src/utils/TextureUtility.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;;GAGG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAExD;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAExD"}

package/dist/utils/VectorUtility.d.ts

@@ -6,18 +6,6 @@ import * as THREE from 'three';
  * Returns the new smoothed position.
  */
 export declare function smoothDamp(current: THREE.Vector3, target: THREE.Vector3, currentVelocity: THREE.Vector3, smoothTime: THREE.Vector3, maxSpeed?: number, deltaTime?: number): THREE.Vector3;
-/**
- * Per-component SmoothStep for Vector3.
- */
-export declare function smoothStep(from: THREE.Vector3, to: THREE.Vector3, smoothStepT: THREE.Vector3): THREE.Vector3;
-/**
- * Per-component MoveTowards for Vector3.
- */
-export declare function moveTowards(current: THREE.Vector3, target: THREE.Vector3, maxDistanceDelta: THREE.Vector3): THREE.Vector3;
-/**
- * Returns a perpendicular vector in the XZ plane (swaps x and z, negates z).
- */
-export declare function getPerpendicularXZ2(vector: THREE.Vector3): THREE.Vector3;
 /**
  * Converts an XY vector to XZ (y -> z, y set to 0).
  */

package/dist/utils/VectorUtility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VectorUtility.d.ts","sourceRoot":"","sources":["../../src/utils/VectorUtility.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAmF/B;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,EACrB,eAAe,EAAE,KAAK,CAAC,OAAO,EAC9B,UAAU,EAAE,KAAK,CAAC,OAAO,EACzB,QAAQ,GAAE,MAAiB,EAC3B,SAAS,GAAE,MAAe,GACzB,KAAK,CAAC,OAAO,CA8Bf;AAED;;GAEG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,KAAK,CAAC,OAAO,EACnB,EAAE,EAAE,KAAK,CAAC,OAAO,EACjB,WAAW,EAAE,KAAK,CAAC,OAAO,GACzB,KAAK,CAAC,OAAO,CAMf;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,EACrB,gBAAgB,EAAE,KAAK,CAAC,OAAO,GAC9B,KAAK,CAAC,OAAO,CAMf;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAExE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAErD;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAErD"}
+{"version":3,"file":"VectorUtility.d.ts","sourceRoot":"","sources":["../../src/utils/VectorUtility.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AA4D/B;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,EACrB,eAAe,EAAE,KAAK,CAAC,OAAO,EAC9B,UAAU,EAAE,KAAK,CAAC,OAAO,EACzB,QAAQ,GAAE,MAAiB,EAC3B,SAAS,GAAE,MAAe,GACzB,KAAK,CAAC,OAAO,CA8Bf;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAErD;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAErD"}

package/package.json

@@ -1,31 +1,30 @@
-{
-  "name": "@objectifthunes/three-book",
-  "version": "0.3.1",
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "vite build && tsc --emitDeclarationOnly",
-    "typecheck": "tsc --noEmit",
-    "prepack": "pnpm run build"
-  },
-  "peerDependencies": {
-    "three": ">=0.150.0"
-  },
-  "devDependencies": {
-    "three": "^0.172.0",
-    "@types/three": "^0.172.0",
-    "typescript": "^5.7.0",
-    "vite": "^6.0.0",
-    "vite-plugin-dts": "^4.0.0"
-  }
-}
+{
+  "name": "@objectifthunes/three-book",
+  "version": "0.4.1",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "three": ">=0.150.0"
+  },
+  "devDependencies": {
+    "three": "^0.172.0",
+    "@types/three": "^0.172.0",
+    "typescript": "^5.7.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.0.0"
+  },
+  "scripts": {
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/dist/utils/index.d.ts

@@ -1,8 +0,0 @@
-export * as VectorUtility from './VectorUtility';
-export * as BezierUtility from './BezierUtility';
-export * as EllipseUtility from './EllipseUtility';
-export * as TriangleUtility from './TriangleUtility';
-export * as LoopUtility from './LoopUtility';
-export * as MatrixUtility from './MatrixUtility';
-export * as TextureUtility from './TextureUtility';
-//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,eAAe,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC"}