@ifc-lite/server-client 1.2.0

package/dist/types.d.ts

@@ -0,0 +1,338 @@
+/**
+ * Configuration options for the IFC server client.
+ */
+export interface ServerConfig {
+    /** Base URL of the IFC-Lite server (e.g., 'https://ifc-lite.railway.app') */
+    baseUrl: string;
+    /** Request timeout in milliseconds (default: 300000 = 5 minutes) */
+    timeout?: number;
+}
+/**
+ * Individual mesh data with geometry and metadata.
+ */
+export interface MeshData {
+    /** Express ID of the IFC element */
+    express_id: number;
+    /** IFC type name (e.g., "IfcWall") */
+    ifc_type: string;
+    /** Vertex positions as flat array (x, y, z triplets) */
+    positions: number[];
+    /** Vertex normals as flat array (x, y, z triplets) */
+    normals: number[];
+    /** Triangle indices */
+    indices: number[];
+    /** RGBA color [r, g, b, a] in 0-1 range */
+    color: [number, number, number, number];
+}
+/**
+ * Model metadata extracted from the IFC file.
+ */
+export interface ModelMetadata {
+    /** IFC schema version (e.g., "IFC2X3", "IFC4", "IFC4X3") */
+    schema_version: string;
+    /** Total number of entities in the file */
+    entity_count: number;
+    /** Number of geometry-bearing entities */
+    geometry_entity_count: number;
+    /** Coordinate system information */
+    coordinate_info: CoordinateInfo;
+}
+/**
+ * Coordinate system information.
+ */
+export interface CoordinateInfo {
+    /** Origin shift applied to coordinates (for RTC rendering) */
+    origin_shift: [number, number, number];
+    /** Whether the model is geo-referenced */
+    is_geo_referenced: boolean;
+}
+/**
+ * Processing statistics.
+ */
+export interface ProcessingStats {
+    /** Total number of meshes generated */
+    total_meshes: number;
+    /** Total number of vertices */
+    total_vertices: number;
+    /** Total number of triangles */
+    total_triangles: number;
+    /** Time spent parsing entities (ms) */
+    parse_time_ms: number;
+    /** Time spent processing geometry (ms) */
+    geometry_time_ms: number;
+    /** Total processing time (ms) */
+    total_time_ms: number;
+    /** Whether result was from cache */
+    from_cache: boolean;
+}
+/**
+ * Full parse response with all meshes.
+ */
+export interface ParseResponse {
+    /** Cache key for this result (SHA256 of file content) */
+    cache_key: string;
+    /** All meshes extracted from the IFC file */
+    meshes: MeshData[];
+    /** Model metadata */
+    metadata: ModelMetadata;
+    /** Processing statistics */
+    stats: ProcessingStats;
+}
+/**
+ * Metadata-only response (no geometry).
+ */
+export interface MetadataResponse {
+    /** Total number of entities */
+    entity_count: number;
+    /** Number of geometry-bearing entities */
+    geometry_count: number;
+    /** IFC schema version */
+    schema_version: string;
+    /** File size in bytes */
+    file_size: number;
+}
+/**
+ * Health check response.
+ */
+export interface HealthResponse {
+    /** Server status */
+    status: string;
+    /** Server version */
+    version: string;
+    /** Service name */
+    service: string;
+}
+/**
+ * Error response from the server.
+ */
+export interface ErrorResponse {
+    /** Error message */
+    error: string;
+    /** Error code */
+    code: string;
+}
+/**
+ * Server-Sent Event types for streaming responses.
+ */
+export type StreamEvent = StreamStartEvent | StreamProgressEvent | StreamBatchEvent | StreamCompleteEvent | StreamErrorEvent;
+/**
+ * Initial event with estimated totals.
+ */
+export interface StreamStartEvent {
+    type: 'start';
+    /** Estimated number of geometry entities */
+    total_estimate: number;
+}
+/**
+ * Progress update event.
+ */
+export interface StreamProgressEvent {
+    type: 'progress';
+    /** Number of entities processed */
+    processed: number;
+    /** Total entities to process */
+    total: number;
+    /** Current entity type being processed */
+    current_type: string;
+}
+/**
+ * Batch of processed meshes.
+ */
+export interface StreamBatchEvent {
+    type: 'batch';
+    /** Meshes in this batch */
+    meshes: MeshData[];
+    /** Batch sequence number */
+    batch_number: number;
+}
+/**
+ * Processing complete event.
+ */
+export interface StreamCompleteEvent {
+    type: 'complete';
+    /** Final processing statistics */
+    stats: ProcessingStats;
+    /** Model metadata */
+    metadata: ModelMetadata;
+    /** Cache key for the result */
+    cache_key: string;
+}
+/**
+ * Error event.
+ */
+export interface StreamErrorEvent {
+    type: 'error';
+    /** Error message */
+    message: string;
+}
+/**
+ * Metadata header from Parquet response (sent via X-IFC-Metadata header).
+ */
+export interface ParquetMetadataHeader {
+    /** Cache key for this result (SHA256 of file content) */
+    cache_key: string;
+    /** Model metadata */
+    metadata: ModelMetadata;
+    /** Processing statistics */
+    stats: ProcessingStats;
+    /** Data model statistics (if included) */
+    data_model_stats?: {
+        entity_count: number;
+        property_set_count: number;
+        relationship_count: number;
+        spatial_node_count: number;
+    };
+}
+/**
+ * Parquet parse response with decoded geometry.
+ */
+export interface ParquetParseResponse {
+    /** Cache key for this result (SHA256 of file content) */
+    cache_key: string;
+    /** All meshes extracted from the IFC file */
+    meshes: MeshData[];
+    /** Model metadata */
+    metadata: ModelMetadata;
+    /** Processing statistics */
+    stats: ProcessingStats;
+    /** Additional stats for Parquet transfer */
+    parquet_stats: {
+        /** Size of Parquet payload in bytes */
+        payload_size: number;
+        /** Time spent decoding Parquet (ms) */
+        decode_time_ms: number;
+    };
+    /** Data model binary (Parquet format) - optional */
+    data_model?: ArrayBuffer;
+}
+/**
+ * Optimization statistics from the server.
+ */
+export interface OptimizationStats {
+    /** Number of input meshes before deduplication */
+    input_meshes: number;
+    /** Number of unique meshes after deduplication */
+    unique_meshes: number;
+    /** Number of unique materials */
+    unique_materials: number;
+    /** Mesh reuse ratio (higher = more instancing benefit) */
+    mesh_reuse_ratio: number;
+    /** Whether normals are included in the response */
+    has_normals: boolean;
+}
+/**
+ * Metadata header from optimized Parquet response.
+ */
+export interface OptimizedParquetMetadataHeader {
+    /** Cache key for this result */
+    cache_key: string;
+    /** Model metadata */
+    metadata: ModelMetadata;
+    /** Processing statistics */
+    stats: ProcessingStats;
+    /** Optimization statistics */
+    optimization_stats: OptimizationStats;
+    /** Vertex multiplier for dequantization (default: 10000 = 0.1mm precision) */
+    vertex_multiplier: number;
+}
+/**
+ * Optimized Parquet parse response with ara3d BOS-compatible format.
+ */
+export interface OptimizedParquetParseResponse {
+    /** Cache key for this result */
+    cache_key: string;
+    /** All meshes extracted from the IFC file */
+    meshes: MeshData[];
+    /** Model metadata */
+    metadata: ModelMetadata;
+    /** Processing statistics */
+    stats: ProcessingStats;
+    /** Optimization statistics */
+    optimization_stats: OptimizationStats;
+    /** Transfer/decode stats */
+    parquet_stats: {
+        /** Size of Parquet payload in bytes */
+        payload_size: number;
+        /** Time spent decoding Parquet (ms) */
+        decode_time_ms: number;
+    };
+}
+/**
+ * SSE event types for Parquet streaming responses.
+ */
+export type ParquetStreamEvent = ParquetStreamStartEvent | ParquetStreamProgressEvent | ParquetStreamBatchEvent | ParquetStreamCompleteEvent | ParquetStreamErrorEvent;
+/**
+ * Initial streaming event with estimated totals.
+ */
+export interface ParquetStreamStartEvent {
+    type: 'start';
+    /** Estimated number of geometry entities */
+    total_estimate: number;
+    /** Cache key for this file (use for data model fetch) */
+    cache_key: string;
+}
+/**
+ * Progress update event.
+ */
+export interface ParquetStreamProgressEvent {
+    type: 'progress';
+    /** Number of entities processed */
+    processed: number;
+    /** Total entities to process */
+    total: number;
+}
+/**
+ * Batch of geometry data as Parquet.
+ */
+export interface ParquetStreamBatchEvent {
+    type: 'batch';
+    /** Base64-encoded Parquet data */
+    data: string;
+    /** Number of meshes in this batch */
+    mesh_count: number;
+    /** Batch sequence number (1-indexed) */
+    batch_number: number;
+}
+/**
+ * Processing complete event.
+ */
+export interface ParquetStreamCompleteEvent {
+    type: 'complete';
+    /** Final processing statistics */
+    stats: ProcessingStats;
+    /** Model metadata */
+    metadata: ModelMetadata;
+}
+/**
+ * Error event.
+ */
+export interface ParquetStreamErrorEvent {
+    type: 'error';
+    /** Error message */
+    message: string;
+}
+/**
+ * Decoded geometry batch from streaming.
+ */
+export interface ParquetBatch {
+    /** Meshes in this batch */
+    meshes: MeshData[];
+    /** Batch sequence number */
+    batch_number: number;
+    /** Decode time in ms */
+    decode_time_ms: number;
+}
+/**
+ * Complete streaming result.
+ */
+export interface ParquetStreamResult {
+    /** Cache key for data model fetch */
+    cache_key: string;
+    /** Total meshes received */
+    total_meshes: number;
+    /** Processing statistics */
+    stats: ProcessingStats;
+    /** Model metadata */
+    metadata: ModelMetadata;
+}
+//# 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":"AAIA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,sDAAsD;IACtD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,uBAAuB;IACvB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,2CAA2C;IAC3C,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4DAA4D;IAC5D,cAAc,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oCAAoC;IACpC,eAAe,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,8DAA8D;IAC9D,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,0CAA0C;IAC1C,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,gCAAgC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,iCAAiC;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,yBAAyB;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,mBAAmB,GACnB,gBAAgB,GAChB,mBAAmB,GACnB,gBAAgB,CAAC;AAErB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,UAAU,CAAC;IACjB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,2BAA2B;IAC3B,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,4BAA4B;IAC5B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,UAAU,CAAC;IACjB,kCAAkC;IAClC,KAAK,EAAE,eAAe,CAAC;IACvB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAC;IACvB,0CAA0C;IAC1C,gBAAgB,CAAC,EAAE;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,kBAAkB,EAAE,MAAM,CAAC;QAC3B,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAC;IACvB,4CAA4C;IAC5C,aAAa,EAAE;QACb,uCAAuC;QACvC,YAAY,EAAE,MAAM,CAAC;QACrB,uCAAuC;QACvC,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,oDAAoD;IACpD,UAAU,CAAC,EAAE,WAAW,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAC;IACvB,8BAA8B;IAC9B,kBAAkB,EAAE,iBAAiB,CAAC;IACtC,8EAA8E;IAC9E,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAC;IACvB,8BAA8B;IAC9B,kBAAkB,EAAE,iBAAiB,CAAC;IACtC,4BAA4B;IAC5B,aAAa,EAAE;QACb,uCAAuC;QACvC,YAAY,EAAE,MAAM,CAAC;QACrB,uCAAuC;QACvC,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC;CACH;AAMD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,uBAAuB,GACvB,0BAA0B,GAC1B,uBAAuB,GACvB,0BAA0B,GAC1B,uBAAuB,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,kCAAkC;IAClC,KAAK,EAAE,eAAe,CAAC;IACvB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,4BAA4B;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAC;IACvB,qBAAqB;IACrB,QAAQ,EAAE,aAAa,CAAC;CACzB"}

package/dist/types.js

@@ -0,0 +1,5 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,sEAAsE;AACtE,4DAA4D"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@ifc-lite/server-client",
+  "version": "1.2.0",
+  "description": "TypeScript client SDK for IFC-Lite Server",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "peerDependencies": {
+    "apache-arrow": ">=14.0.0",
+    "parquet-wasm": ">=0.5.0"
+  },
+  "peerDependenciesMeta": {
+    "apache-arrow": {
+      "optional": true
+    },
+    "parquet-wasm": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0"
+  },
+  "license": "MPL-2.0",
+  "author": "Louis True",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/louistrue/ifc-lite.git",
+    "directory": "packages/server-client"
+  },
+  "homepage": "https://louistrue.github.io/ifc-lite/",
+  "bugs": "https://github.com/louistrue/ifc-lite/issues",
+  "keywords": [
+    "ifc",
+    "bim",
+    "server",
+    "client",
+    "api",
+    "aec"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc || true",
+    "dev": "tsc --watch"
+  }
+}