@nice2dev/spatial-core 1.0.10

package/dist/serialization/index.d.ts

@@ -0,0 +1,421 @@
+/**
+ * Serialization — .nsp.json (NiceToDev Spatial Plan) format.
+ *
+ * Unified serialization format for all spatial documents:
+ * - Floor plans
+ * - Network topologies
+ * - CAD drawings
+ * - Interior designs
+ * - Game scenes
+ *
+ * @module @nice2dev/spatial-core/serialization
+ */
+import type { FloorPlanDocument, Floor } from '../floor-plan/index';
+/** Serialization options. */
+export interface SerializationOptions {
+    /** Pretty print JSON (default: false). */
+    pretty?: boolean;
+    /** Include $schema reference (default: true). */
+    includeSchema?: boolean;
+    /** Compress object IDs (default: false). */
+    compressIds?: boolean;
+    /** Exclude empty layers (default: false). */
+    excludeEmptyLayers?: boolean;
+    /** Include metadata (default: true). */
+    includeMetadata?: boolean;
+}
+/** Validation result. */
+export interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    warnings: ValidationWarning[];
+}
+/** Validation error. */
+export interface ValidationError {
+    path: string;
+    message: string;
+    code: string;
+}
+/** Validation warning. */
+export interface ValidationWarning {
+    path: string;
+    message: string;
+    code: string;
+}
+/** Import result. */
+export interface ImportResult<T> {
+    success: boolean;
+    data?: T;
+    errors?: string[];
+    warnings?: string[];
+}
+/** Export format. */
+export type ExportFormat = 'nsp' | 'svg' | 'png' | 'pdf' | 'dxf' | 'geojson' | 'ifc';
+/** JSON Schema for .nsp.json validation. */
+export declare const NSP_SCHEMA: {
+    $schema: string;
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    required: string[];
+    properties: {
+        $schema: {
+            type: string;
+        };
+        version: {
+            type: string;
+            pattern: string;
+        };
+        type: {
+            type: string;
+            enum: string[];
+        };
+        metadata: {
+            type: string;
+            required: string[];
+            properties: {
+                id: {
+                    type: string;
+                };
+                name: {
+                    type: string;
+                };
+                description: {
+                    type: string;
+                };
+                author: {
+                    type: string;
+                };
+                created: {
+                    type: string;
+                    format: string;
+                };
+                modified: {
+                    type: string;
+                    format: string;
+                };
+                tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                thumbnail: {
+                    type: string;
+                };
+            };
+        };
+        building: {
+            type: string;
+            properties: {
+                name: {
+                    type: string;
+                };
+                address: {
+                    type: string;
+                };
+                type: {
+                    type: string;
+                };
+                totalArea: {
+                    type: string;
+                };
+                floors: {
+                    type: string;
+                };
+                yearBuilt: {
+                    type: string;
+                };
+                coordinates: {
+                    type: string;
+                    properties: {
+                        lat: {
+                            type: string;
+                        };
+                        lng: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+        floors: {
+            type: string;
+            items: {
+                type: string;
+                required: string[];
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    name: {
+                        type: string;
+                    };
+                    level: {
+                        type: string;
+                    };
+                    elevation: {
+                        type: string;
+                    };
+                    ceilingHeight: {
+                        type: string;
+                    };
+                    bounds: {
+                        type: string;
+                        properties: {
+                            x: {
+                                type: string;
+                            };
+                            y: {
+                                type: string;
+                            };
+                            width: {
+                                type: string;
+                            };
+                            height: {
+                                type: string;
+                            };
+                        };
+                    };
+                    layers: {
+                        type: string;
+                    };
+                };
+            };
+        };
+        settings: {
+            type: string;
+            properties: {
+                units: {
+                    type: string;
+                    enum: string[];
+                };
+                scale: {
+                    type: string;
+                };
+                grid: {
+                    type: string;
+                };
+                defaultWallHeight: {
+                    type: string;
+                };
+                defaultWallThickness: {
+                    type: string;
+                };
+                precision: {
+                    type: string;
+                };
+            };
+        };
+    };
+};
+/**
+ * Serialize floor plan document to JSON string.
+ */
+export declare function serialize(document: FloorPlanDocument, options?: SerializationOptions): string;
+/**
+ * Deserialize JSON string to floor plan document.
+ */
+export declare function deserialize(json: string): ImportResult<FloorPlanDocument>;
+/**
+ * Validate floor plan document against schema.
+ */
+export declare function validate(document: FloorPlanDocument): ValidationResult;
+/**
+ * Parse .nsp.json file.
+ */
+export declare function importNSP(file: File | Blob): Promise<ImportResult<FloorPlanDocument>>;
+/**
+ * Create .nsp.json file blob.
+ */
+export declare function exportNSP(document: FloorPlanDocument, options?: SerializationOptions): Blob;
+/**
+ * Download .nsp.json file.
+ */
+export declare function downloadNSP(document: FloorPlanDocument, filename?: string, options?: SerializationOptions): void;
+/**
+ * Export floor to SVG.
+ */
+export declare function exportFloorToSVG(floor: Floor, options?: {
+    width?: number;
+    height?: number;
+    scale?: number;
+    background?: string;
+    showGrid?: boolean;
+    showLabels?: boolean;
+}): string;
+/**
+ * Migrate document to latest version.
+ */
+export declare function migrate(document: FloorPlanDocument): FloorPlanDocument;
+declare const _default: {
+    serialize: typeof serialize;
+    deserialize: typeof deserialize;
+    validate: typeof validate;
+    importNSP: typeof importNSP;
+    exportNSP: typeof exportNSP;
+    downloadNSP: typeof downloadNSP;
+    exportFloorToSVG: typeof exportFloorToSVG;
+    migrate: typeof migrate;
+    NSP_SCHEMA: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            $schema: {
+                type: string;
+            };
+            version: {
+                type: string;
+                pattern: string;
+            };
+            type: {
+                type: string;
+                enum: string[];
+            };
+            metadata: {
+                type: string;
+                required: string[];
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    name: {
+                        type: string;
+                    };
+                    description: {
+                        type: string;
+                    };
+                    author: {
+                        type: string;
+                    };
+                    created: {
+                        type: string;
+                        format: string;
+                    };
+                    modified: {
+                        type: string;
+                        format: string;
+                    };
+                    tags: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    thumbnail: {
+                        type: string;
+                    };
+                };
+            };
+            building: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                    address: {
+                        type: string;
+                    };
+                    type: {
+                        type: string;
+                    };
+                    totalArea: {
+                        type: string;
+                    };
+                    floors: {
+                        type: string;
+                    };
+                    yearBuilt: {
+                        type: string;
+                    };
+                    coordinates: {
+                        type: string;
+                        properties: {
+                            lat: {
+                                type: string;
+                            };
+                            lng: {
+                                type: string;
+                            };
+                        };
+                    };
+                };
+            };
+            floors: {
+                type: string;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        name: {
+                            type: string;
+                        };
+                        level: {
+                            type: string;
+                        };
+                        elevation: {
+                            type: string;
+                        };
+                        ceilingHeight: {
+                            type: string;
+                        };
+                        bounds: {
+                            type: string;
+                            properties: {
+                                x: {
+                                    type: string;
+                                };
+                                y: {
+                                    type: string;
+                                };
+                                width: {
+                                    type: string;
+                                };
+                                height: {
+                                    type: string;
+                                };
+                            };
+                        };
+                        layers: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            settings: {
+                type: string;
+                properties: {
+                    units: {
+                        type: string;
+                        enum: string[];
+                    };
+                    scale: {
+                        type: string;
+                    };
+                    grid: {
+                        type: string;
+                    };
+                    defaultWallHeight: {
+                        type: string;
+                    };
+                    defaultWallThickness: {
+                        type: string;
+                    };
+                    precision: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/serialization/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/serialization/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAOpE,6BAA6B;AAC7B,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,iDAAiD;IACjD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6CAA6C;IAC7C,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wCAAwC;IACxC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,yBAAyB;AACzB,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,wBAAwB;AACxB,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,0BAA0B;AAC1B,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,qBAAqB;AACrB,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,qBAAqB;AACrB,MAAM,MAAM,YAAY,GACpB,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,SAAS,GACT,KAAK,CAAC;AAMV,4CAA4C;AAC5C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsFtB,CAAC;AAMF;;GAEG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,GAAE,oBAAyB,GAAG,MAAM,CAmCjG;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAuBzE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,GAAG,gBAAgB,CAmGtE;AAMD;;GAEG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAU3F;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAG3F;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,GAAE,MAA8B,EACxC,OAAO,CAAC,EAAE,oBAAoB,GAC7B,IAAI,CAUN;AAMD;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,KAAK,EACZ,OAAO,GAAE;IACP,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;CACjB,GACL,MAAM,CAiDR;AA4DD;;GAEG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,iBAAiB,GAAG,iBAAiB,CActE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED,wBAUE"}