@file-viewer/geometry-engine 2.0.11

package/LICENSE

@@ -0,0 +1,160 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work by
+the copyright owner or by an individual or Legal Entity authorized to submit on
+behalf of the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent to the
+Licensor or its representatives, including but not limited to communication on
+electronic mailing lists, source code control systems, and issue tracking systems
+that are managed by, or on behalf of, the Licensor for the purpose of discussing
+and improving the Work, but excluding communication that is conspicuously marked
+or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License,
+each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Work, where such license applies only to those patent claims
+licensable by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s) with the Work to
+which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit)
+alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of the date
+such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any part
+of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the Derivative
+Works; within the Source form or documentation, if provided along with the
+Derivative Works; or, within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents of the NOTICE
+file are for informational purposes only and do not modify the License. You may
+add Your own attribution notices within Derivative Works that You distribute,
+alongside or as an addendum to the NOTICE text from the Work, provided that such
+additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties or
+conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility of such
+damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations and/or
+rights consistent with this License. However, in accepting such obligations, You
+may act only on Your own behalf and on Your sole responsibility, not on behalf of
+any other Contributor, and only if You agree to indemnify, defend, and hold each
+Contributor harmless for any liability incurred by, or claims asserted against,
+such Contributor by reason of your accepting any such warranty or additional
+liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Flyfish Viewer

package/README.en.md

@@ -0,0 +1,24 @@
+# @file-viewer/geometry-engine
+
+Framework-neutral geometry-kernel boundary package for Flyfish File Viewer. It does not bundle heavy OpenCascade, web-ifc, or rhino3dm WASM runtimes by default. It currently provides STEP, IGES, IFC, 3DM, and BREP detection, signature inspection, recommended engine routes, and user-facing notices.
+
+```ts
+import {
+  inspectGeometryKernelFile,
+  formatGeometryKernelNotice,
+} from '@file-viewer/geometry-engine'
+
+const inspection = inspectGeometryKernelFile(new Uint8Array(buffer), 'step')
+const notice = formatGeometryKernelNotice(inspection.format, 'en-US')
+```
+
+## Scope
+
+- `inspectGeometryKernelFile()` reads a small file prefix and detects common STEP / IGES / IFC / 3DM / BREP signatures.
+- `geometryKernelRoutes` documents the recommended WASM path: OpenCascade / OCCT for STEP, IGES, and BREP; `web-ifc` / That Open for IFC; McNeel `rhino3dm` for Rhino 3DM.
+- `@file-viewer/renderer-3d` consumes this package for accurate conversion guidance without pulling CAD/BIM kernels into core or the default 3D install path.
+- Full visual rendering can evolve here later, or split into focused packages such as `@file-viewer/geometry-occt`, `@file-viewer/geometry-ifc`, and `@file-viewer/geometry-3dm`.
+
+## Why This Package Exists
+
+STEP, IGES, IFC, and 3DM are not lightweight formats that ordinary Three.js loaders can faithfully decode. They need CAD/BIM kernels, worker isolation, WASM asset hosting, license review, and real-world sample regression. Keeping the boundary in a separate package lets `@file-viewer/core` stay fast to install while engineering-format fidelity can evolve independently, the same way the native PPTX engine does.

package/README.md

@@ -0,0 +1,24 @@
+# @file-viewer/geometry-engine
+
+Flyfish File Viewer 的独立几何内核边界包。它不包含 UI，也不默认打包 OpenCascade、web-ifc 或 rhino3dm 这类重型 WASM 运行时；当前负责 STEP、IGES、IFC、3DM 和 BREP 的格式识别、文件头检查、推荐内核路线和对外提示文本。
+
+```ts
+import {
+  inspectGeometryKernelFile,
+  formatGeometryKernelNotice,
+} from '@file-viewer/geometry-engine'
+
+const inspection = inspectGeometryKernelFile(new Uint8Array(buffer), 'step')
+const notice = formatGeometryKernelNotice(inspection.format)
+```
+
+## 定位
+
+- `inspectGeometryKernelFile()` 读取文件前缀，识别 STEP / IGES / IFC / 3DM / BREP 的常见签名。
+- `geometryKernelRoutes` 明确每个格式的推荐 WASM 路线：STEP / IGES / BREP 走 OpenCascade / OCCT，IFC 走 `web-ifc` / That Open，3DM 走 McNeel `rhino3dm`。
+- `@file-viewer/renderer-3d` 使用本包展示专业、准确的转换说明；core 和普通 3D 预览不会因此安装 CAD/BIM 几何内核。
+- 后续完整可视渲染可以继续在这个包中分层演进，或拆出更细的 `@file-viewer/geometry-occt`、`@file-viewer/geometry-ifc`、`@file-viewer/geometry-3dm`。
+
+## 为什么单独拆包
+
+STEP、IGES、IFC 和 3DM 都不是普通 Three.js loader 可以完整还原的轻量格式。它们需要 CAD/BIM 专业内核、Worker 隔离、WASM 资产托管、许可证边界和真实样本长期回归。把这条路线单独固定下来，可以让 `@file-viewer/core` 保持快速安装，让工程格式能力像 PPTX 一样独立维护、独立发布。

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+export type GeometryKernelFormat = 'step' | 'iges' | 'ifc' | '3dm' | 'brep';
+export type GeometryKernelFamily = 'cad-brep' | 'bim-ifc' | 'rhino-3dm';
+export type GeometryKernelOutput = 'three-object' | 'mesh' | 'fragments';
+export type GeometryKernelConfidence = 'none' | 'low' | 'medium' | 'high';
+export type GeometryKernelLocale = 'zh-CN' | 'en-US';
+export interface GeometryKernelCapability {
+    readonly renderer: string;
+    readonly packageName: string;
+    readonly wasm: true;
+    readonly output: readonly GeometryKernelOutput[];
+    readonly note: string;
+    readonly url: string;
+}
+export interface GeometryKernelRoute {
+    readonly format: GeometryKernelFormat;
+    readonly aliases: readonly string[];
+    readonly label: string;
+    readonly family: GeometryKernelFamily;
+    readonly recommended: readonly GeometryKernelCapability[];
+    readonly serverConversionTargets: readonly string[];
+    readonly licenseNotes: readonly string[];
+}
+export interface GeometryKernelInspection {
+    readonly format?: GeometryKernelFormat;
+    readonly route?: GeometryKernelRoute;
+    readonly confidence: GeometryKernelConfidence;
+    readonly byteLength: number;
+    readonly signature?: string;
+    readonly warnings: readonly string[];
+}
+export declare const geometryKernelRoutes: readonly GeometryKernelRoute[];
+export declare const normalizeGeometryKernelFormat: (type?: string) => GeometryKernelFormat | undefined;
+export declare const getGeometryKernelRoute: (type?: string) => GeometryKernelRoute | undefined;
+export declare const isGeometryKernelFormat: (type?: string) => boolean;
+export declare const inspectGeometryKernelFile: (input: ArrayBuffer | Uint8Array, type?: string) => GeometryKernelInspection;
+export declare const formatGeometryKernelNotice: (type?: string, locale?: GeometryKernelLocale) => string;

package/dist/index.js

@@ -0,0 +1,194 @@
+const textDecoder = typeof TextDecoder === 'function'
+    ? new TextDecoder('utf-8', { fatal: false })
+    : undefined;
+const normalizeToken = (value) => {
+    return String(value || '')
+        .trim()
+        .toLowerCase()
+        .replace(/^\./, '')
+        .replace(/^model\//, '')
+        .replace(/^application\//, '')
+        .replace(/^x-/, '');
+};
+export const geometryKernelRoutes = [
+    {
+        format: 'step',
+        aliases: ['step', 'stp', 'p21', 'iso-10303-21'],
+        label: 'STEP / ISO 10303',
+        family: 'cad-brep',
+        recommended: [
+            {
+                renderer: 'OpenCascade / OCCT import',
+                packageName: 'occt-import-js',
+                wasm: true,
+                output: ['three-object', 'mesh'],
+                note: 'Imports STEP into mesh/JSON data in the browser; suitable as the first full preview path.',
+                url: 'https://github.com/kovacsv/occt-import-js',
+            },
+            {
+                renderer: 'OpenCascade.js',
+                packageName: 'opencascade.js',
+                wasm: true,
+                output: ['three-object', 'mesh'],
+                note: 'Full OpenCascade geometry kernel port for richer CAD workflows.',
+                url: 'https://ocjs.org/',
+            },
+        ],
+        serverConversionTargets: ['glb', 'gltf', 'stl', 'obj'],
+        licenseNotes: ['OCCT-based packages can have LGPL or custom distribution requirements; keep them opt-in.'],
+    },
+    {
+        format: 'iges',
+        aliases: ['iges', 'igs'],
+        label: 'IGES',
+        family: 'cad-brep',
+        recommended: [
+            {
+                renderer: 'OpenCascade / OCCT import',
+                packageName: 'occt-import-js',
+                wasm: true,
+                output: ['three-object', 'mesh'],
+                note: 'Uses OCCT importers for IGES/BREP geometry and keeps the heavy runtime behind a dedicated package.',
+                url: 'https://github.com/kovacsv/occt-import-js',
+            },
+        ],
+        serverConversionTargets: ['glb', 'gltf', 'stl', 'obj'],
+        licenseNotes: ['Treat CAD kernel licensing separately from the lightweight viewer core.'],
+    },
+    {
+        format: 'brep',
+        aliases: ['brep'],
+        label: 'BREP',
+        family: 'cad-brep',
+        recommended: [
+            {
+                renderer: 'OpenCascade / OCCT import',
+                packageName: 'occt-import-js',
+                wasm: true,
+                output: ['three-object', 'mesh'],
+                note: 'BREP is closest to the native OCCT topology model and should share the STEP/IGES engine.',
+                url: 'https://github.com/kovacsv/occt-import-js',
+            },
+        ],
+        serverConversionTargets: ['glb', 'gltf', 'stl', 'obj'],
+        licenseNotes: ['Keep OCCT WASM as an explicit renderer dependency.'],
+    },
+    {
+        format: 'ifc',
+        aliases: ['ifc', 'ifczip', 'ifcxml'],
+        label: 'IFC / BuildingSMART',
+        family: 'bim-ifc',
+        recommended: [
+            {
+                renderer: 'That Open web-ifc',
+                packageName: 'web-ifc',
+                wasm: true,
+                output: ['fragments', 'mesh'],
+                note: 'Reads IFC at native speed in the browser and can be paired with Fragments for large BIM models.',
+                url: 'https://github.com/thatopen/engine_web-ifc',
+            },
+        ],
+        serverConversionTargets: ['glb', 'gltf', 'fragments'],
+        licenseNotes: ['Large IFC models often need preprocessing, fragments, worker isolation, and property paging.'],
+    },
+    {
+        format: '3dm',
+        aliases: ['3dm', 'rhino'],
+        label: 'Rhino 3DM / OpenNURBS',
+        family: 'rhino-3dm',
+        recommended: [
+            {
+                renderer: 'McNeel rhino3dm.js',
+                packageName: 'rhino3dm',
+                wasm: true,
+                output: ['three-object', 'mesh'],
+                note: 'Official OpenNURBS WASM binding; Three.js provides Rhino3dmLoader on top of it.',
+                url: 'https://github.com/mcneel/rhino3dm',
+            },
+        ],
+        serverConversionTargets: ['glb', 'gltf', 'obj'],
+        licenseNotes: ['Ship rhino3dm.wasm only in the dedicated 3DM renderer path.'],
+    },
+];
+const routeByAlias = new Map();
+geometryKernelRoutes.forEach(route => {
+    route.aliases.forEach(alias => routeByAlias.set(alias, route));
+});
+export const normalizeGeometryKernelFormat = (type) => {
+    var _a;
+    return (_a = routeByAlias.get(normalizeToken(type))) === null || _a === void 0 ? void 0 : _a.format;
+};
+export const getGeometryKernelRoute = (type) => {
+    return routeByAlias.get(normalizeToken(type));
+};
+export const isGeometryKernelFormat = (type) => {
+    return Boolean(getGeometryKernelRoute(type));
+};
+const toBytes = (input) => {
+    return input instanceof Uint8Array ? input : new Uint8Array(input);
+};
+const decodePrefix = (bytes, maxLength = 8192) => {
+    const slice = bytes.slice(0, Math.min(bytes.byteLength, maxLength));
+    if (textDecoder) {
+        return textDecoder.decode(slice);
+    }
+    let text = '';
+    for (let index = 0; index < slice.length; index += 1) {
+        text += String.fromCharCode(slice[index]);
+    }
+    return text;
+};
+const createInspection = (bytes, format, confidence, signature, warnings = []) => {
+    const route = format ? getGeometryKernelRoute(format) : undefined;
+    return {
+        format,
+        route,
+        confidence,
+        byteLength: bytes.byteLength,
+        signature,
+        warnings,
+    };
+};
+export const inspectGeometryKernelFile = (input, type) => {
+    const bytes = toBytes(input);
+    const explicitFormat = normalizeGeometryKernelFormat(type);
+    const prefix = decodePrefix(bytes);
+    const normalizedPrefix = prefix.toUpperCase();
+    const warnings = [];
+    if (bytes.byteLength === 0) {
+        return createInspection(bytes, explicitFormat, explicitFormat ? 'low' : 'none', undefined, ['Empty file.']);
+    }
+    if (/FILE_SCHEMA\s*\(\s*\(\s*'IFC/i.test(prefix) ||
+        (normalizedPrefix.includes('IFC') && normalizedPrefix.includes('FILE_SCHEMA'))) {
+        return createInspection(bytes, 'ifc', 'high', 'IFC-SPF', warnings);
+    }
+    if (/ISO-10303-21|HEADER;\s*FILE_DESCRIPTION|DATA;\s*#\d+=/i.test(prefix)) {
+        return createInspection(bytes, 'step', 'high', 'ISO-10303-21', warnings);
+    }
+    if (/3D GEOMETRY FILE FORMAT|OPENNURBS/i.test(prefix)) {
+        return createInspection(bytes, '3dm', 'high', 'OpenNURBS 3DM', warnings);
+    }
+    if (/DBRep_DrawableShape|CASCADE Topology V|BREP/i.test(prefix)) {
+        return createInspection(bytes, 'brep', 'medium', 'OpenCascade BREP', warnings);
+    }
+    const hasIgesStartSection = /^.{0,72}S\s*\d+/m.test(prefix);
+    const hasIgesGlobalSection = /^.{0,72}G\s*\d+/m.test(prefix);
+    if (hasIgesStartSection || hasIgesGlobalSection || /S\s+1\s*\n.{0,72}G\s+1/i.test(prefix)) {
+        return createInspection(bytes, 'iges', hasIgesStartSection && hasIgesGlobalSection ? 'high' : 'medium', 'IGES section marker', warnings);
+    }
+    if (explicitFormat) {
+        warnings.push('File signature was not fully recognized; using the provided extension or MIME hint.');
+        return createInspection(bytes, explicitFormat, 'low', undefined, warnings);
+    }
+    return createInspection(bytes, undefined, 'none', undefined, ['No supported geometry kernel signature was detected.']);
+};
+export const formatGeometryKernelNotice = (type, locale = 'zh-CN') => {
+    const route = getGeometryKernelRoute(type);
+    const formatLabel = (route === null || route === void 0 ? void 0 : route.label) || String(type || 'Engineering model').toUpperCase();
+    const engines = (route === null || route === void 0 ? void 0 : route.recommended.map(item => item.packageName).join(' / ')) || 'OpenCascade / web-ifc / rhino3dm';
+    const targets = (route === null || route === void 0 ? void 0 : route.serverConversionTargets.join(' / ')) || 'GLB / GLTF';
+    if (locale === 'en-US') {
+        return `${formatLabel} requires a dedicated WebAssembly geometry kernel (${engines}) for full browser preview. Flyfish Viewer keeps these heavy runtimes outside core and the default 3D renderer install path; use the dedicated geometry engine route or convert the model to ${targets} in a private pipeline.`;
+    }
+    return `${formatLabel} 需要独立 WebAssembly 几何内核（${engines}）才能完整浏览器预览。Flyfish Viewer 不会把这类重型运行时塞进 core 或默认 3D renderer 安装路径；请通过独立几何内核路线接入，或在私有转换链路输出 ${targets} 后预览。`;
+};

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@file-viewer/geometry-engine",
+  "version": "2.0.11",
+  "private": false,
+  "type": "module",
+  "description": "Framework-neutral geometry kernel boundary package for STEP, IGES, IFC, 3DM, and BREP preview routes in Flyfish File Viewer.",
+  "keywords": [
+    "file-viewer",
+    "geometry",
+    "cad",
+    "bim",
+    "step",
+    "iges",
+    "ifc",
+    "3dm",
+    "wasm",
+    "document-preview",
+    "file-preview",
+    "self-hosted"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": {
+    "name": "Wangyu",
+    "email": "wybaby168@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flyfish-dev/geometry-engine.git",
+    "directory": "packages/renderers/geometry-engine"
+  },
+  "homepage": "https://doc.file-viewer.app/guide/format-fidelity",
+  "bugs": {
+    "url": "https://github.com/flyfish-dev/geometry-engine/issues"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://dev.flyfish.group/shop"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "README.en.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "typescript": "^6.0.3"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "tsc -b tsconfig.json",
+    "type-check": "tsc -b tsconfig.json"
+  }
+}