@ifc-lite/codegen 1.0.0 → 1.1.0

package/src/serialization-generator.ts

@@ -0,0 +1,343 @@
+/* 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/. */
+
+/**
+ * Serialization Generator
+ *
+ * Generates TypeScript code for serializing IFC entities to STEP format.
+ */
+
+import type { ExpressSchema, EntityDefinition, AttributeDefinition } from './express-parser.js';
+import { getAllAttributes } from './express-parser.js';
+
+/**
+ * Generate serialization support code
+ */
+export function generateSerializers(schema: ExpressSchema): string {
+  let code = `/* 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/. */
+
+/**
+ * IFC Serialization Support
+ * Generated from EXPRESS schema: ${schema.name}
+ *
+ * Utilities for serializing IFC entities to STEP format.
+ *
+ * DO NOT EDIT - This file is auto-generated
+ */
+
+import { SCHEMA_REGISTRY } from './schema-registry.js';
+
+/**
+ * STEP value types
+ */
+export type StepValue =
+  | string
+  | number
+  | boolean
+  | null
+  | undefined
+  | StepValue[]
+  | EntityRef
+  | EnumValue;
+
+/**
+ * Entity reference (#123)
+ */
+export interface EntityRef {
+  ref: number;
+}
+
+/**
+ * Enum value (.VALUE.)
+ */
+export interface EnumValue {
+  enum: string;
+}
+
+/**
+ * Check if value is an entity reference
+ */
+export function isEntityRef(value: unknown): value is EntityRef {
+  return typeof value === 'object' && value !== null && 'ref' in value;
+}
+
+/**
+ * Check if value is an enum value
+ */
+export function isEnumValue(value: unknown): value is EnumValue {
+  return typeof value === 'object' && value !== null && 'enum' in value;
+}
+
+/**
+ * Create an entity reference
+ */
+export function ref(id: number): EntityRef {
+  return { ref: id };
+}
+
+/**
+ * Create an enum value
+ */
+export function enumVal(value: string): EnumValue {
+  return { enum: value };
+}
+
+/**
+ * Base interface for serializable entities
+ */
+export interface StepEntity {
+  /** Express ID (#123) */
+  expressId: number;
+  /** IFC type name */
+  type: string;
+  /** Attribute values */
+  [key: string]: unknown;
+}
+
+/**
+ * Serialize a single value to STEP format
+ */
+export function serializeValue(value: StepValue): string {
+  // Null/undefined -> $
+  if (value === null || value === undefined) {
+    return '$';
+  }
+
+  // Derived value -> *
+  if (value === '*') {
+    return '*';
+  }
+
+  // Boolean
+  if (typeof value === 'boolean') {
+    return value ? '.T.' : '.F.';
+  }
+
+  // Number
+  if (typeof value === 'number') {
+    if (!Number.isFinite(value)) {
+      return '$';
+    }
+    // Use exponential notation for large/small numbers
+    if (Math.abs(value) > 1e10 || (Math.abs(value) < 1e-10 && value !== 0)) {
+      return value.toExponential(10).toUpperCase().replace('E+', 'E');
+    }
+    // Otherwise use fixed notation
+    const str = value.toString();
+    // Ensure there's a decimal point for REAL values
+    return str.includes('.') ? str : str + '.';
+  }
+
+  // String
+  if (typeof value === 'string') {
+    return "'" + escapeStepString(value) + "'";
+  }
+
+  // Entity reference
+  if (isEntityRef(value)) {
+    return '#' + value.ref;
+  }
+
+  // Enum value
+  if (isEnumValue(value)) {
+    return '.' + value.enum + '.';
+  }
+
+  // Array/List
+  if (Array.isArray(value)) {
+    if (value.length === 0) {
+      return '()';
+    }
+    return '(' + value.map(v => serializeValue(v as StepValue)).join(',') + ')';
+  }
+
+  // Object (shouldn't happen for valid STEP values)
+  return '$';
+}
+
+/**
+ * Escape a string for STEP format
+ */
+function escapeStepString(str: string): string {
+  return str
+    .replace(/\\\\/g, '\\\\\\\\')  // Backslash
+    .replace(/'/g, "''");           // Single quote
+}
+
+/**
+ * Serialize an entity to a STEP line
+ */
+export function toStepLine(entity: StepEntity): string {
+  const schema = SCHEMA_REGISTRY.entities[entity.type];
+  if (!schema) {
+    throw new Error(\`Unknown entity type: \${entity.type}\`);
+  }
+
+  // Get all attributes in order
+  const values: string[] = [];
+  for (const attr of schema.allAttributes) {
+    const value = entity[attr.name];
+    values.push(serializeValue(value as StepValue));
+  }
+
+  return \`#\${entity.expressId}=\${entity.type.toUpperCase()}(\${values.join(',')});\`;
+}
+
+/**
+ * Generate STEP file header
+ */
+export function generateHeader(options: {
+  description?: string;
+  author?: string;
+  organization?: string;
+  application?: string;
+  schema: 'IFC2X3' | 'IFC4' | 'IFC4X3';
+  filename?: string;
+}): string {
+  const now = new Date().toISOString().replace(/[-:]/g, '').split('.')[0];
+  const desc = options.description || 'ViewDefinition [CoordinationView]';
+  const author = options.author || '';
+  const org = options.organization || '';
+  const app = options.application || 'ifc-lite';
+  const filename = options.filename || 'output.ifc';
+
+  return \`ISO-10303-21;
+HEADER;
+FILE_DESCRIPTION('\${desc}','2;1');
+FILE_NAME('\${filename}','\${now}',('\${author}'),('\${org}'),'\${app}','\${app}','');
+FILE_SCHEMA(('\${options.schema}'));
+ENDSEC;
+\`;
+}
+
+/**
+ * Generate complete STEP file content
+ */
+export function generateStepFile(
+  entities: StepEntity[],
+  options: Parameters<typeof generateHeader>[0]
+): string {
+  const header = generateHeader(options);
+
+  // Sort entities by ID for deterministic output
+  const sorted = [...entities].sort((a, b) => a.expressId - b.expressId);
+
+  const data = sorted.map(e => toStepLine(e)).join('\\n');
+
+  return \`\${header}DATA;
+\${data}
+ENDSEC;
+END-ISO-10303-21;
+\`;
+}
+
+/**
+ * Parse a STEP value from string
+ */
+export function parseStepValue(str: string): StepValue {
+  str = str.trim();
+
+  // Null
+  if (str === '$') {
+    return null;
+  }
+
+  // Derived
+  if (str === '*') {
+    return '*' as unknown as StepValue;
+  }
+
+  // Boolean
+  if (str === '.T.') {
+    return true;
+  }
+  if (str === '.F.') {
+    return false;
+  }
+  if (str === '.U.') {
+    return null; // Unknown/indeterminate
+  }
+
+  // Entity reference
+  if (str.startsWith('#')) {
+    return { ref: parseInt(str.substring(1), 10) };
+  }
+
+  // Enum
+  if (str.startsWith('.') && str.endsWith('.')) {
+    return { enum: str.substring(1, str.length - 1) };
+  }
+
+  // String
+  if (str.startsWith("'") && str.endsWith("'")) {
+    return unescapeStepString(str.substring(1, str.length - 1));
+  }
+
+  // List
+  if (str.startsWith('(') && str.endsWith(')')) {
+    return parseStepList(str);
+  }
+
+  // Number
+  const num = parseFloat(str);
+  if (!isNaN(num)) {
+    return num;
+  }
+
+  // Unknown
+  return str;
+}
+
+/**
+ * Parse a STEP list
+ */
+function parseStepList(str: string): StepValue[] {
+  // Remove outer parentheses
+  const inner = str.substring(1, str.length - 1).trim();
+  if (inner === '') {
+    return [];
+  }
+
+  const values: StepValue[] = [];
+  let depth = 0;
+  let current = '';
+
+  for (let i = 0; i < inner.length; i++) {
+    const char = inner[i];
+
+    if (char === '(' || char === '[') {
+      depth++;
+      current += char;
+    } else if (char === ')' || char === ']') {
+      depth--;
+      current += char;
+    } else if (char === ',' && depth === 0) {
+      values.push(parseStepValue(current));
+      current = '';
+    } else {
+      current += char;
+    }
+  }
+
+  if (current.trim()) {
+    values.push(parseStepValue(current));
+  }
+
+  return values;
+}
+
+/**
+ * Unescape a STEP string
+ */
+function unescapeStepString(str: string): string {
+  return str
+    .replace(/''/g, "'")
+    .replace(/\\\\\\\\/g, '\\\\');
+}
+`;
+
+  return code;
+}

package/src/type-ids-generator.ts

@@ -0,0 +1,166 @@
+/* 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/. */
+
+/**
+ * Type IDs Generator
+ *
+ * Generates TypeScript type ID constants and lookup maps.
+ */
+
+import type { ExpressSchema } from './express-parser.js';
+import { crc32 } from './crc32.js';
+
+/**
+ * Generate TypeScript type IDs file
+ */
+export function generateTypeIds(schema: ExpressSchema): string {
+  let code = `/* 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/. */
+
+/**
+ * IFC Type IDs
+ * Generated from EXPRESS schema: ${schema.name}
+ *
+ * CRC32 hashes for fast O(1) type lookup.
+ *
+ * DO NOT EDIT - This file is auto-generated
+ */
+
+/**
+ * CRC32 Type IDs for all IFC entities
+ */
+export const TYPE_IDS = {
+`;
+
+  // Generate type IDs for all entities
+  for (const entity of schema.entities) {
+    const id = crc32(entity.name);
+    code += `  ${entity.name}: ${id},\n`;
+  }
+
+  code += `} as const;
+
+/**
+ * Type for any valid type ID
+ */
+export type TypeId = (typeof TYPE_IDS)[keyof typeof TYPE_IDS];
+
+/**
+ * Reverse lookup: ID -> Name
+ */
+export const TYPE_NAMES: Record<number, string> = {
+`;
+
+  for (const entity of schema.entities) {
+    const id = crc32(entity.name);
+    code += `  ${id}: '${entity.name}',\n`;
+  }
+
+  code += `};
+
+/**
+ * Get type ID from name (case-insensitive)
+ */
+export function getTypeId(name: string): number | undefined {
+  // Normalize to IfcXxx format
+  const normalized = normalizeTypeName(name);
+  return (TYPE_IDS as Record<string, number>)[normalized];
+}
+
+/**
+ * Get type name from ID
+ */
+export function getTypeName(id: number): string | undefined {
+  return TYPE_NAMES[id];
+}
+
+/**
+ * Check if a type ID exists
+ */
+export function isValidTypeId(id: number): boolean {
+  return id in TYPE_NAMES;
+}
+
+/**
+ * Normalize type name to IfcXxx format
+ */
+function normalizeTypeName(name: string): string {
+  // Handle IFCWALL -> IfcWall
+  if (name.toUpperCase().startsWith('IFC')) {
+    const rest = name.substring(3);
+    // Find the entity that matches case-insensitively
+    const upperRest = rest.toUpperCase();
+    for (const key of Object.keys(TYPE_IDS)) {
+      if (key.substring(3).toUpperCase() === upperRest) {
+        return key;
+      }
+    }
+  }
+  return name;
+}
+
+/**
+ * Calculate CRC32 hash for any string
+ * (Useful for unknown types)
+ */
+export function crc32Hash(str: string): number {
+  const upper = str.toUpperCase();
+  let crc = 0xffffffff;
+  for (let i = 0; i < upper.length; i++) {
+    crc = CRC32_TABLE[(crc ^ upper.charCodeAt(i)) & 0xff] ^ (crc >>> 8);
+  }
+  return (crc ^ 0xffffffff) >>> 0;
+}
+
+// CRC32 lookup table
+const CRC32_TABLE = new Uint32Array([
+  0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
+  0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
+  0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
+  0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
+  0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
+  0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
+  0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
+  0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
+  0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
+  0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
+  0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
+  0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
+  0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
+  0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
+  0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
+  0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
+  0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
+  0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
+  0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cd9, 0x5005713c, 0x270241aa,
+  0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
+  0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
+  0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
+  0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
+  0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
+  0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
+  0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
+  0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
+  0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
+  0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
+  0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
+  0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
+  0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
+  0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
+  0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
+  0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
+  0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
+  0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
+  0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
+  0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
+  0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
+  0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd706b3,
+  0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
+  0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d,
+]);
+`;
+
+  return code;
+}

package/tsconfig.json

@@ -3,6 +3,7 @@
     "target": "ES2022",
     "module": "ES2022",
     "lib": ["ES2022"],
+    "types": ["node"],
     "moduleResolution": "node",
     "outDir": "./dist",
     "rootDir": "./src",