@ifc-lite/server-client 1.6.1 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @ifc-lite/server-client
|
|
2
|
+
|
|
3
|
+
TypeScript SDK for the IFClite server API. Provides client-side caching, streaming, and Parquet/Arrow decoding for server-processed IFC data.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ifc-lite/server-client
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { IfcServerClient } from '@ifc-lite/server-client';
|
|
15
|
+
|
|
16
|
+
const client = new IfcServerClient({ baseUrl: 'https://your-server.com' });
|
|
17
|
+
|
|
18
|
+
// Parse with intelligent caching (skips upload if cached)
|
|
19
|
+
const result = await client.parseParquet(file);
|
|
20
|
+
|
|
21
|
+
// Or stream for large files
|
|
22
|
+
for await (const event of client.parseStream(file)) {
|
|
23
|
+
if (event.type === 'batch') {
|
|
24
|
+
renderer.addMeshes(event.meshes);
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- Content-addressable caching (SHA-256 hash check before upload)
|
|
32
|
+
- Streaming SSE for progressive rendering
|
|
33
|
+
- Parquet and Arrow response decoding
|
|
34
|
+
- Automatic retry and error handling
|
|
35
|
+
|
|
36
|
+
## API
|
|
37
|
+
|
|
38
|
+
See the [Server Guide](../../docs/guide/server.md) and [API Reference](../../docs/api/typescript.md#ifc-liteserver-client).
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
[MPL-2.0](../../LICENSE)
|