@dtducas/wh-forge-viewer 1.0.5 → 1.0.7

package/README.md

@@ -6,9 +6,12 @@ A customized Autodesk Forge Viewer component for React with enhanced PDF support
 
 - ✅ **Custom Toolbar** - Pre-configured toolbar with Pan, Document Browser, Download, and Pagination controls
 - ✅ **PDF Support** - Optimized for viewing PDF documents with page navigation
+- ✅ **Auto Document Browser** - Automatically opens on startup, positioned on left side
+- ✅ **Smooth Pagination** - Page navigation without toolbar flickering
 - ✅ **Self-Healing** - Automatic toolbar recovery mechanism ensures UI persistence
 - ✅ **3D/2D Models** - Full support for Autodesk Forge 3D and 2D models
 - ✅ **React Integration** - Easy-to-use React component with hooks support
+- ✅ **SOLID Architecture** - Follows SOLID principles with Manager pattern for maintainability
 
 ## Installation
 
@@ -62,7 +65,28 @@ The viewer includes a custom toolbar with:
 
 - React ^17.0.0 || ^18.0.0
 - Ant Design ^5.0.0
-- Autodesk Forge Viewer v7
+- Autodesk Forge Viewer v7.108.0 (pinned for stability)
+
+## Important Notes
+
+### Viewer Versioning
+
+This package uses a **specific version** of Autodesk Forge Viewer (v7.108.0) instead of wildcards (7.*) to ensure production stability and avoid unexpected breaking changes.
+
+**Why?** Using wildcards can introduce unexpected behavior changes when Autodesk releases updates. For production applications, always use a specific tested version.
+
+📖 See [docs/VERSIONING.md](docs/VERSIONING.md) for version update guide.
+
+## Architecture
+
+This package follows **SOLID principles** and uses a modular architecture:
+
+- **Managers Pattern** - Separate managers for Pagination, Toolbar, and Document Browser
+- **Service Layer** - EventBus, FileLoader, DownloadService
+- **Type Safety** - Full TypeScript type definitions
+- **Dependency Injection** - Clean separation of concerns
+
+📖 See [ARCHITECTURE.md](ARCHITECTURE.md) for detailed architecture documentation.
 
 ## Development
 

package/dist/index.d.ts

@@ -1,89 +1,79 @@
 // Type definitions for @dtducas/wh-forge-viewer
 // Project: https://github.com/DTDucas/wh-forge-viewer
 // Definitions by: Duong Tran Quang <https://github.com/DTDucas>
-
 /// <reference types="react" />
-
 declare module '@dtducas/wh-forge-viewer' {
-    import { FC } from 'react';
-
+  import { FC } from 'react';
+  /**
+   * Supported file extensions for the Forge Viewer
+   */
+  export type TSupportedFileExtension = 'pdf' | 'dwf' | 'dwfx';
+  /**
+   * Autodesk Forge Viewer namespace
+   * For full type definitions, see Autodesk Forge Viewer documentation
+   */
+  export namespace Autodesk {
+    export namespace Viewing {
+      export class GuiViewer3D {
+        // Add minimal type stubs for commonly used methods
+        start(): void;
+        loadExtension(extensionId: string, options?: any): Promise<any>;
+        loadModel(url: string, options?: any, onSuccess?: Function): void;
+        loadDocumentNode(document: any, node: any): Promise<any>;
+        addEventListener(event: string, callback: Function): void;
+        removeEventListener(event: string, callback: Function): void;
+        setReverseZoomDirection(value: boolean): void;
+        getExtension(extensionId: string): any;
+        setTool(toolName: string): void;
+        toolbar: any;
+        model: any;
+      }
+      export interface Extension {
+        load(): boolean;
+        unload(): boolean;
+      }
+      // Common event constants
+      export const GEOMETRY_LOADED_EVENT: string;
+      export const MODEL_ADDED_EVENT: string;
+      export const TOOLBAR_CREATED_EVENT: string;
+    }
+  }
+  /**
+   * Props for ViewerForgePDF component
+   */
+  export interface IViewerForgePDFProps {
     /**
-     * Supported file extensions for the Forge Viewer
+     * URL/path to the document to load
      */
-    export type TSupportedFileExtension = 'pdf' | 'dwf' | 'dwfx';
-
+    filePath: string;
     /**
-     * Autodesk Forge Viewer namespace
-     * For full type definitions, see Autodesk Forge Viewer documentation
+     * File extension (pdf, dwf, dwfx)
      */
-    export namespace Autodesk {
-        export namespace Viewing {
-            export class GuiViewer3D {
-                // Add minimal type stubs for commonly used methods
-                start(): void;
-                loadExtension(extensionId: string, options?: any): Promise<any>;
-                loadModel(url: string, options?: any, onSuccess?: Function): void;
-                loadDocumentNode(document: any, node: any): Promise<any>;
-                addEventListener(event: string, callback: Function): void;
-                removeEventListener(event: string, callback: Function): void;
-                setReverseZoomDirection(value: boolean): void;
-                getExtension(extensionId: string): any;
-                setTool(toolName: string): void;
-                toolbar: any;
-                model: any;
-            }
-
-            export interface Extension {
-                load(): boolean;
-                unload(): boolean;
-            }
-
-            // Common event constants
-            export const GEOMETRY_LOADED_EVENT: string;
-            export const MODEL_ADDED_EVENT: string;
-            export const TOOLBAR_CREATED_EVENT: string;
-        }
-    }
-
-    /**
-     * Props for ViewerForgePDF component
-     */
-    export interface IViewerForgePDFProps {
-        /**
-         * URL/path to the document to load
-         */
-        filePath: string;
-
-        /**
-         * File extension (pdf, dwf, dwfx)
-         */
-        fileExt: TSupportedFileExtension;
-
-        /**
-         * Callback to receive viewer instance when initialized
-         */
-        setViewer?: (viewer: Autodesk.Viewing.GuiViewer3D | null) => void;
-    }
-
+    fileExt: TSupportedFileExtension;
     /**
-     * ViewerForgePDF - React component for displaying PDF and CAD files using Autodesk Forge Viewer
-     * 
-     * @example
-     * ```tsx
-     * import { ViewerForgePDF } from '@dtducas/wh-forge-viewer';
-     * 
-     * function MyApp() {
-     *   const [viewer, setViewer] = useState<Autodesk.Viewing.GuiViewer3D | null>(null);
-     *   
-     *   return (
-     *     <ViewerForgePDF
-     *       filePath="https://example.com/document.pdf"
-     *       fileExt="pdf"
-     *       setViewer={setViewer}
-     *     />
-     *   );
-     * }
-     * ```
+     * Callback to receive viewer instance when initialized
      */
-    export const ViewerForgePDF: FC<IViewerForgePDFProps>;
+    setViewer?: (viewer: Autodesk.Viewing.GuiViewer3D | null) => void;
+  }
+  /**
+   * ViewerForgePDF - React component for displaying PDF and CAD files using Autodesk Forge Viewer
+   *
+   * @example
+   * ```tsx
+   * import { ViewerForgePDF } from '@dtducas/wh-forge-viewer';
+   *
+   * function MyApp() {
+   *   const [viewer, setViewer] = useState<Autodesk.Viewing.GuiViewer3D | null>(null);
+   *
+   *   return (
+   *     <ViewerForgePDF
+   *       filePath="https://example.com/document.pdf"
+   *       fileExt="pdf"
+   *       setViewer={setViewer}
+   *     />
+   *   );
+   * }
+   * ```
+   */
+  export const ViewerForgePDF: FC<IViewerForgePDFProps>;
 }