@sequent-org/ifc-viewer 1.0.5-ci.9.0 → 1.0.6-ci.11.0

package/README.md

@@ -4,12 +4,58 @@ IFC 3D model viewer component for web applications. Основан на Three.js
 
 **✨ Полностью автономный пакет** - не требует внешних CSS фреймворков (Tailwind, Bootstrap и т.д.).
 
+## ⚡ Быстрый старт для интеграции
+
+### Минимальная настройка
+
+1. **Установите пакет:**
+   ```bash
+   npm install @sequent-org/ifc-viewer
+   ```
+
+2. **Скопируйте WASM файл (один раз):**
+   ```bash
+   cp node_modules/web-ifc/web-ifc.wasm public/wasm/
+   ```
+
+3. **Используйте в коде:**
+   ```javascript
+   import { IfcViewer } from '@sequent-org/ifc-viewer'
+   
+   const viewer = new IfcViewer({
+     container: '#viewer-container',
+     ifcUrl: '/path/to/model.ifc'
+   })
+   
+   await viewer.init()
+   ```
+
+**Готово!** Пакет автоматически найдет WASM файл по стандартным путям.
+
 ## 🚀 Установка
 
 ```bash
 npm install @sequent-org/ifc-viewer
 ```
 
+### 📁 Настройка WASM файла
+
+После установки пакета скопируйте WASM файл в публичную папку:
+
+```bash
+# Скопируйте web-ifc.wasm в папку public/wasm/
+cp node_modules/web-ifc/web-ifc.wasm public/wasm/
+```
+
+**Умный поиск:** Пакет автоматически ищет WASM файл по популярным путям:
+- `/wasm/web-ifc.wasm` (рекомендуемый)
+- `/web-ifc.wasm`
+- `/wasm/`
+- `/node_modules/web-ifc/web-ifc.wasm`
+- И другие стандартные пути
+
+**Важно:** Пакет использует парсинг в главном потоке (Web Workers отключены) для максимальной совместимости с различными окружениями.
+
 ## 📋 Основное использование
 
 ### Простой пример
@@ -24,6 +70,21 @@ const viewer = new IfcViewer({
   // showSidebar: false (по умолчанию)
   // showControls: false (по умолчанию) 
   // showToolbar: true (по умолчанию)
+  // wasmUrl: null (автоматически определяет путь к WASM)
+})
+
+await viewer.init()
+```
+
+### Пример с кастомным WASM путем
+
+```javascript
+import { IfcViewer } from '@sequent-org/ifc-viewer'
+
+const viewer = new IfcViewer({
+  container: document.getElementById('viewer-container'),
+  ifcUrl: '/models/building.ifc',
+  wasmUrl: '/custom-path/web-ifc.wasm'  // Кастомный путь к WASM файлу
 })
 
 await viewer.init()
@@ -56,26 +117,52 @@ function showIfcModal(ifcUrl) {
 
 **Настройка WASM файла в Laravel:**
 
-1. Скопируйте `web-ifc.wasm` в папку `public/storage/`:
+1. **Скопируйте WASM файл в public папку:**
 ```bash
-cp node_modules/web-ifc/web-ifc.wasm public/storage/
+cp node_modules/web-ifc/web-ifc.wasm public/wasm/
 ```
 
-2. Или используйте символическую ссылку:
+2. **Или используйте Laravel Storage:**
 ```bash
+cp node_modules/web-ifc/web-ifc.wasm storage/app/public/
 php artisan storage:link
-# Затем скопируйте файл в storage/app/public/
 ```
 
-3. Альтернативно, укажите путь к файлу в `node_modules`:
+3. **Для кастомных путей:**
 ```javascript
 const viewer = new IfcViewer({
   container: container,
   ifcUrl: ifcUrl,
-  wasmUrl: '/node_modules/web-ifc/web-ifc.wasm'
+  wasmUrl: '/storage/web-ifc.wasm'  // Путь к WASM в Laravel storage
 })
 ```
 
+**Важно для Laravel:** Убедитесь, что Vite настроен для обслуживания статических файлов из `public/` папки.
+
+## 🔧 Особенности и совместимость
+
+### ✅ Что включено в пакет
+
+- **Автономные стили** - не требует Tailwind CSS, Bootstrap или других фреймворков
+- **Умный поиск WASM** - автоматический поиск по популярным путям
+- **Отключенные Web Workers** - парсинг в главном потоке для максимальной совместимости
+- **Fallback защита** - автоматическое переключение на резервные пути при ошибках WASM
+- **Обработка ошибок** - graceful degradation при критических ошибках
+- **Поддержка wasmUrl** - гибкая настройка пути к WASM файлу
+
+### 🚫 Что НЕ включено
+
+- **IFCWorker** - Web Workers отключены для предотвращения проблем интеграции
+- **Внешние зависимости** - все стили и ресурсы включены в пакет
+- **WASM файл** - нужно скопировать из node_modules (один раз)
+
+### 🎯 Совместимость
+
+- **Браузеры:** Chrome 80+, Firefox 75+, Safari 13+, Edge 80+
+- **Фреймворки:** React, Vue, Angular, Laravel, Next.js, Nuxt.js
+- **Сборщики:** Vite, Webpack, Rollup
+- **Серверы:** Node.js, PHP, Python, .NET
+
 ### Загрузка пользовательского файла
 
 ```javascript
@@ -315,6 +402,56 @@ Failed to load web-ifc.wasm
 - Проверьте консоль на предупреждения о `wasmUrl`
 - Убедитесь, что файл `web-ifc.wasm` существует и доступен
 
+### Проблемы с Web Workers
+
+**Ошибка IFCWorker:**
+```
+Failed to load IFCWorker.js
+```
+
+**Решение:** Эта ошибка не должна возникать, так как Web Workers отключены в пакете. Если она появляется:
+
+1. **Проверьте версию пакета:**
+   ```bash
+   npm list @sequent-org/ifc-viewer
+   ```
+
+2. **Очистите кэш:**
+   ```bash
+   npm cache clean --force
+   rm -rf node_modules package-lock.json
+   npm install
+   ```
+
+3. **Проверьте консоль браузера** - должно быть сообщение "Web Workers отключены"
+
+### Проблемы интеграции
+
+**Ошибка при импорте:**
+```
+Cannot resolve module '@sequent-org/ifc-viewer'
+```
+
+**Решения:**
+1. **Убедитесь в правильной установке:**
+   ```bash
+   npm install @sequent-org/ifc-viewer
+   ```
+
+2. **Проверьте package.json:**
+   ```json
+   {
+     "dependencies": {
+       "@sequent-org/ifc-viewer": "^1.0.1"
+     }
+   }
+   ```
+
+3. **Для TypeScript проектов:**
+   ```typescript
+   import { IfcViewer } from '@sequent-org/ifc-viewer'
+   ```
+
 ## 🔧 Системные требования
 
 - Node.js >= 16
@@ -322,6 +459,40 @@ Failed to load web-ifc.wasm
 - Для работы требуются файлы `web-ifc.wasm` в публичной папке проекта
 - Поддержка ES6 модулей в браузере
 
+## 👨‍💻 Информация для разработчиков
+
+### Архитектура пакета
+
+- **IfcViewer** - основной класс-обертка для интеграции
+- **IfcService** - сервис загрузки и парсинга IFC файлов
+- **Viewer** - Three.js сцена и рендеринг
+- **IfcTreeView** - компонент дерева IFC структуры
+
+### Ключевые особенности
+
+- **Web Workers отключены** - парсинг в главном потоке
+- **IFCWorker исключен** - предотвращает проблемы интеграции
+- **Fallback защита** - множественные пути к WASM файлу
+- **Автономные стили** - встроенные CSS без внешних зависимостей
+
+### Для ассистентов по интеграции
+
+При помощи с интеграцией пакета учитывайте:
+
+1. **Обязательно скопируйте WASM файл** в публичную папку проекта (один раз)
+2. **Web Workers отключены** - не пытайтесь их включить
+3. **Используйте параметр wasmUrl** для кастомных путей к WASM файлу
+4. **Пакет полностью автономен** - не требует внешних CSS фреймворков
+5. **Поддерживает все современные фреймворки** - React, Vue, Angular, Laravel
+6. **Умный поиск WASM** - автоматически найдет файл по стандартным путям
+
+### Отладка
+
+- Проверьте консоль на сообщение "Web Workers отключены"
+- Убедитесь, что WASM файл скопирован в публичную папку
+- Используйте DevTools → Network для проверки загрузки ресурсов
+- При проблемах используйте параметр `wasmUrl` для кастомного пути
+
 ## 📄 Лицензия
 
 MIT License

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sequent-org/ifc-viewer",
   "private": false,
-  "version": "1.0.5-ci.9.0",
+  "version": "1.0.6-ci.11.0",
   "type": "module",
   "description": "IFC 3D model viewer component for web applications",
   "main": "src/index.js",
@@ -14,7 +14,6 @@
   },
   "files": [
     "src/",
-    "public/wasm/",
     "README.md"
   ],
   "keywords": [

package/src/ifc/IfcService.js

@@ -2,12 +2,8 @@
 // Требует three@^0.149 и web-ifc-three совместимой версии
 
 import { IFCLoader } from "web-ifc-three/IFCLoader";
-// Абсолютный URL до wasm-асета из папки public (Vite подставит корректный путь)
-import WEBIFC_WASM_URL from '/wasm/web-ifc.wasm?url';
-// URL собранного воркера через Vite (даёт корректный путь для useWebWorkers)
-// Важно: используем ?url, чтобы получить сырой URL ассета и создать классический Worker,
-// т.к. web-ifc-three создаёт воркер без { type: 'module' }
-import IFCWorkerUrl from 'web-ifc-three/IFCWorker.js?url';
+// Примечание: IFCWorker не используется, так как мы отключаем Web Workers
+// для стабильности работы в различных окружениях
 
 export class IfcService {
   /**
@@ -28,8 +24,14 @@ export class IfcService {
   init() {
     try {
       this.loader = new IFCLoader();
-      // Отключаем Web Worker: временно парсим в главном потоке для стабильности
-      try { this.loader.ifcManager.useWebWorkers?.(false); } catch(_) {}
+      // Отключаем Web Workers: парсим в главном потоке для стабильности
+      // Это предотвращает проблемы с загрузкой IFCWorker в различных окружениях
+      try { 
+        this.loader.ifcManager.useWebWorkers?.(false);
+        console.log('IfcService: Web Workers отключены, парсинг в главном потоке');
+      } catch (error) {
+        console.warn('IfcService: не удалось отключить Web Workers:', error.message);
+      }
       
       // Настройка пути к WASM файлу с улучшенной обработкой ошибок
       this._setupWasmPath();
@@ -77,18 +79,15 @@ export class IfcService {
       paths.push(this.wasmUrl);
     }
     
-    // 2. Пути по умолчанию
-    try {
-      const wasmDir = new URL('.', WEBIFC_WASM_URL).href;
-      paths.push(wasmDir);
-    } catch (_) {}
-    
-    try {
-      paths.push(WEBIFC_WASM_URL);
-    } catch (_) {}
-    
-    // 3. Резервные пути
-    paths.push('/wasm/', '/wasm/web-ifc.wasm', '/web-ifc.wasm');
+    // 2. Популярные пути по умолчанию
+    paths.push(
+      '/wasm/web-ifc.wasm',           // Стандартный путь в public/wasm/
+      '/web-ifc.wasm',                // Корневой путь
+      '/wasm/',                       // Директория wasm
+      '/node_modules/web-ifc/web-ifc.wasm', // Прямо из node_modules
+      './web-ifc.wasm',               // Относительный путь
+      'web-ifc.wasm'                  // Просто имя файла
+    );
     
     return paths;
   }