@ifc-lite/codegen 1.15.3 → 1.15.4

package/src/serialization-generator.ts

@@ -5,17 +5,21 @@
 /**
  * Serialization Generator
  *
- * Generates TypeScript code for serializing IFC entities to STEP format.
+ * Emits the per-schema STEP serializer bundle file. The serialization LOGIC is
+ * schema-agnostic and lives once in `@ifc-lite/data`; this generator emits only
+ * a thin binding that re-exports those primitives and binds the bundle's
+ * `SCHEMA_REGISTRY` to the registry-coupled helpers. Keeping the logic in a
+ * single place means the generated copies can never drift from the runtime.
  */
 
-import type { ExpressSchema, EntityDefinition, AttributeDefinition } from './express-parser.js';
-import { getAllAttributes } from './express-parser.js';
+import type { ExpressSchema } from './express-parser.js';
 
 /**
- * Generate serialization support code
+ * Generate serialization support code — a thin re-export of the shared
+ * `@ifc-lite/data` STEP serializer with this schema's registry bound in.
  */
 export function generateSerializers(schema: ExpressSchema): string {
-  let code = `/* This Source Code Form is subject to the terms of the Mozilla Public
+  return `/* 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/. */
 
@@ -23,321 +27,48 @@ export function generateSerializers(schema: ExpressSchema): string {
  * IFC Serialization Support
  * Generated from EXPRESS schema: ${schema.name}
  *
- * Utilities for serializing IFC entities to STEP format.
+ * Thin binding over the shared, schema-agnostic STEP serializer in
+ * \`@ifc-lite/data\`. All serialization logic lives there (single source of
+ * truth); only this bundle's \`SCHEMA_REGISTRY\` is bound to the registry-coupled
+ * helpers below.
  *
  * 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
+import {
+  generateHeader,
+  generateStepFileWithRegistry,
+  toStepLineWithRegistry,
+  type StepEntity,
+} from '@ifc-lite/data';
+
+export {
+  isEntityRef,
+  isEnumValue,
+  ref,
+  enumVal,
+  serializeValue,
+  generateHeader,
+  parseStepValue,
+} from '@ifc-lite/data';
+export type { StepValue, EntityRef, EnumValue, StepEntity } from '@ifc-lite/data';
+
+/**
+ * Serialize an entity to a STEP line (bound to this bundle's schema).
  */
 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' | 'IFC5';
-  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;
-\`;
+  return toStepLineWithRegistry(SCHEMA_REGISTRY, entity);
 }
 
 /**
- * Generate complete STEP file content
+ * Generate complete STEP file content (bound to this bundle's schema).
  */
 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 generateStepFileWithRegistry(SCHEMA_REGISTRY, entities, options);
 }
 `;
-
-  return code;
 }

package/test/serialization-generator.test.ts

@@ -0,0 +1,65 @@
+/* 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/. */
+
+/**
+ * The STEP serializer LOGIC lives once in `@ifc-lite/data`. The per-schema
+ * bundle that codegen emits must be a thin re-export + registry binding, never
+ * an inlined copy — otherwise the copies can silently drift (which is exactly
+ * the bug this refactor removed). These tests fail if anyone re-inlines logic.
+ */
+
+import { describe, it, expect } from 'vitest';
+import type { ExpressSchema } from '../src/express-parser.js';
+import { generateSerializers } from '../src/serialization-generator.js';
+
+const STUB_SCHEMA: ExpressSchema = {
+  name: 'IFC_TEST_SCHEMA',
+  entities: [],
+  types: [],
+  enums: [],
+  selects: [],
+};
+
+describe('generateSerializers', () => {
+  const out = generateSerializers(STUB_SCHEMA);
+
+  it('re-exports the shared serializer from @ifc-lite/data', () => {
+    expect(out).toContain("from '@ifc-lite/data'");
+    expect(out).toContain('toStepLineWithRegistry');
+    expect(out).toContain('generateStepFileWithRegistry');
+  });
+
+  it('binds the bundle SCHEMA_REGISTRY to the registry-coupled helpers', () => {
+    expect(out).toContain("import { SCHEMA_REGISTRY } from './schema-registry.js'");
+    expect(out).toContain('toStepLineWithRegistry(SCHEMA_REGISTRY, entity)');
+  });
+
+  it('still surfaces the full public serializer API', () => {
+    for (const sym of [
+      'serializeValue',
+      'generateHeader',
+      'parseStepValue',
+      'ref',
+      'enumVal',
+      'isEntityRef',
+      'isEnumValue',
+      'toStepLine',
+      'generateStepFile',
+    ]) {
+      expect(out).toContain(sym);
+    }
+  });
+
+  it('does NOT inline serializer logic (must stay a thin re-export)', () => {
+    // The header/escape/parse implementations belong to @ifc-lite/data only.
+    expect(out).not.toContain('function escapeStepString');
+    expect(out).not.toContain('FILE_DESCRIPTION');
+    expect(out).not.toContain("'.T.'"); // serializeValue boolean branch
+    expect(out).not.toContain('function parseStepList');
+  });
+
+  it('stamps the schema name in the banner', () => {
+    expect(out).toContain('Generated from EXPRESS schema: IFC_TEST_SCHEMA');
+  });
+});