@tripsnek/tmf
Version:
TypeScript Modeling Framework - A TypeScript port of the Eclipse Modeling Framework (EMF)
111 lines • 13.1 kB
JavaScript
import { EcoreStringWriter } from './ecore-string-writer.js';
import { Environment, safeDynamicImport } from '../utils/environment.js';
/**
* Writes an EPackage metamodel to an XML Ecore file.
*/
export class EcoreWriter {
stringWriter = new EcoreStringWriter();
/**
* Converts an EPackage to Ecore XML string format.
* @param ePackage The root package to serialize
* @returns The XML string representation
*/
writeToString(ePackage) {
return this.stringWriter.writeToString(ePackage);
}
/**
* Writes an EPackage to an Ecore XML file.
* @param ePackage The root package to serialize
* @param filePath The path where the .ecore file will be written
* @deprecated Use writeToFileAsync instead for bundle-safe operation
*/
async writeToFile(ePackage, filePath) {
return this.writeToFileAsync(ePackage, filePath);
}
/**
* Async version of writeToFile for better error handling
*/
async writeToFileAsync(ePackage, filePath) {
Environment.requireNodeEnvironment('File writing');
const xmlContent = this.writeToString(ePackage);
try {
const fs = await safeDynamicImport('fs');
const path = await safeDynamicImport('path');
fs.writeFileSync(path.resolve(filePath), xmlContent, 'utf8');
}
catch (error) {
throw new Error(`File system access failed: ${error.message}. This operation requires Node.js environment.`);
}
}
/**
* Browser-compatible file saving via download
* @param ePackage The root package to serialize
* @param filename The filename for download
*/
saveAsDownload(ePackage, filename) {
if (!Environment.isBrowser) {
throw new Error('Download functionality only available in browser environment');
}
// try {
// const xmlContent = this.writeToString(ePackage);
// const blob = new Blob([xmlContent], { type: 'application/xml' });
// const url = URL.createObjectURL(blob);
// // Create temporary download link
// const a = document.createElement('a');
// a.href = url;
// a.download = filename.endsWith('.ecore') ? filename : `${filename}.ecore`;
// document.body.appendChild(a);
// a.click();
// document.body.removeChild(a);
// URL.revokeObjectURL(url);
// } catch (error) {
// throw new Error(`Browser download failed: ${(error as Error).message}`);
// }
}
/**
* Universal save method - chooses appropriate strategy based on environment
*/
async save(ePackage, pathOrFilename) {
if (Environment.isNode) {
await this.writeToFileAsync(ePackage, pathOrFilename);
}
else if (Environment.isBrowser) {
this.saveAsDownload(ePackage, pathOrFilename);
}
else {
throw new Error('File saving not supported in this environment');
}
}
/**
* Universal async save method
*/
async saveAsync(ePackage, pathOrFilename) {
return this.save(ePackage, pathOrFilename);
}
/**
* Check if file writing is supported in current environment
*/
static isFileWritingSupported() {
return Environment.isNode;
}
/**
* Check if download saving is supported in current environment
*/
static isDownloadSupported() {
return Environment.isBrowser;
}
/**
* Get supported operations in current environment
*/
static getSupportedOperations() {
const operations = ['writeToString'];
if (this.isFileWritingSupported()) {
operations.push('writeToFile', 'writeToFileAsync', 'save', 'saveAsync');
}
if (this.isDownloadSupported()) {
operations.push('saveAsDownload', 'save', 'saveAsync');
}
return operations;
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"ecorewriter.js","sourceRoot":"","sources":["../../../src/lib/ecore/ecorewriter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAsB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE7F;;GAEG;AACH,MAAM,OAAO,WAAW;IACd,YAAY,GAAG,IAAI,iBAAiB,EAAE,CAAC;IAE/C;;;;OAIG;IACI,aAAa,CAAC,QAAkB;QACrC,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,QAAkB,EAAE,QAAgB;QAC3D,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,gBAAgB,CAAC,QAAkB,EAAE,QAAgB;QAChE,WAAW,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;QAEnD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAEhD,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;YAE7C,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,CAAC,OAAO,gDAAgD,CAAC,CAAC;QAC/G,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,QAAkB,EAAE,QAAgB;QACxD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QAED,QAAQ;QACR,qDAAqD;QACrD,sEAAsE;QACtE,2CAA2C;QAE3C,sCAAsC;QACtC,2CAA2C;QAC3C,kBAAkB;QAClB,+EAA+E;QAC/E,kCAAkC;QAClC,eAAe;QACf,kCAAkC;QAClC,8BAA8B;QAC9B,oBAAoB;QACpB,6EAA6E;QAC7E,IAAI;IACN,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAAC,QAAkB,EAAE,cAAsB;QAC1D,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACxD,CAAC;aAAM,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,QAAkB,EAAE,cAAsB;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB;QAClC,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,mBAAmB;QAC/B,OAAO,WAAW,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB;QAClC,MAAM,UAAU,GAAG,CAAC,eAAe,CAAC,CAAC;QAErC,IAAI,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC;YAClC,UAAU,CAAC,IAAI,CAAC,aAAa,EAAE,kBAAkB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAC1E,CAAC;QAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC/B,UAAU,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF","sourcesContent":["// ecorewriter-safe.ts\r\nimport { EPackage } from '../metamodel/api/epackage.js';\r\nimport { EcoreStringWriter } from './ecore-string-writer.js';\r\nimport { Environment, ConditionalImports, safeDynamicImport } from '../utils/environment.js';\r\n\r\n/**\r\n * Writes an EPackage metamodel to an XML Ecore file.\r\n */\r\nexport class EcoreWriter {\r\n  private stringWriter = new EcoreStringWriter();\r\n  \r\n  /**\r\n   * Converts an EPackage to Ecore XML string format.\r\n   * @param ePackage The root package to serialize\r\n   * @returns The XML string representation\r\n   */\r\n  public writeToString(ePackage: EPackage): string {\r\n    return this.stringWriter.writeToString(ePackage);\r\n  }\r\n  \r\n  /**\r\n   * Writes an EPackage to an Ecore XML file.\r\n   * @param ePackage The root package to serialize\r\n   * @param filePath The path where the .ecore file will be written\r\n   * @deprecated Use writeToFileAsync instead for bundle-safe operation\r\n   */\r\n  public async writeToFile(ePackage: EPackage, filePath: string): Promise<void> {\r\n    return this.writeToFileAsync(ePackage, filePath);\r\n  }\r\n\r\n  /**\r\n   * Async version of writeToFile for better error handling\r\n   */\r\n  public async writeToFileAsync(ePackage: EPackage, filePath: string): Promise<void> {\r\n    Environment.requireNodeEnvironment('File writing');\r\n    \r\n    const xmlContent = this.writeToString(ePackage);\r\n    \r\n    try {\r\n      const fs = await safeDynamicImport('fs');\r\n      const path = await safeDynamicImport('path');\r\n      \r\n      fs.writeFileSync(path.resolve(filePath), xmlContent, 'utf8');\r\n    } catch (error: any) {\r\n      throw new Error(`File system access failed: ${error.message}. This operation requires Node.js environment.`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Browser-compatible file saving via download\r\n   * @param ePackage The root package to serialize  \r\n   * @param filename The filename for download\r\n   */\r\n  public saveAsDownload(ePackage: EPackage, filename: string): void {\r\n    if (!Environment.isBrowser) {\r\n      throw new Error('Download functionality only available in browser environment');\r\n    }\r\n\r\n    // try {\r\n    //   const xmlContent = this.writeToString(ePackage);\r\n    //   const blob = new Blob([xmlContent], { type: 'application/xml' });\r\n    //   const url = URL.createObjectURL(blob);\r\n      \r\n    //   // Create temporary download link\r\n    //   const a = document.createElement('a');\r\n    //   a.href = url;\r\n    //   a.download = filename.endsWith('.ecore') ? filename : `${filename}.ecore`;\r\n    //   document.body.appendChild(a);\r\n    //   a.click();\r\n    //   document.body.removeChild(a);\r\n    //   URL.revokeObjectURL(url);\r\n    // } catch (error) {\r\n    //   throw new Error(`Browser download failed: ${(error as Error).message}`);\r\n    // }\r\n  }\r\n\r\n  /**\r\n   * Universal save method - chooses appropriate strategy based on environment\r\n   */\r\n  public async save(ePackage: EPackage, pathOrFilename: string): Promise<void> {\r\n    if (Environment.isNode) {\r\n      await this.writeToFileAsync(ePackage, pathOrFilename);\r\n    } else if (Environment.isBrowser) {\r\n      this.saveAsDownload(ePackage, pathOrFilename);\r\n    } else {\r\n      throw new Error('File saving not supported in this environment');\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Universal async save method\r\n   */\r\n  public async saveAsync(ePackage: EPackage, pathOrFilename: string): Promise<void> {\r\n    return this.save(ePackage, pathOrFilename);\r\n  }\r\n\r\n  /**\r\n   * Check if file writing is supported in current environment\r\n   */\r\n  public static isFileWritingSupported(): boolean {\r\n    return Environment.isNode;\r\n  }\r\n\r\n  /**\r\n   * Check if download saving is supported in current environment\r\n   */\r\n  public static isDownloadSupported(): boolean {\r\n    return Environment.isBrowser;\r\n  }\r\n\r\n  /**\r\n   * Get supported operations in current environment\r\n   */\r\n  public static getSupportedOperations(): string[] {\r\n    const operations = ['writeToString'];\r\n    \r\n    if (this.isFileWritingSupported()) {\r\n      operations.push('writeToFile', 'writeToFileAsync', 'save', 'saveAsync');\r\n    }\r\n    \r\n    if (this.isDownloadSupported()) {\r\n      operations.push('saveAsDownload', 'save', 'saveAsync');\r\n    }\r\n    \r\n    return operations;\r\n  }\r\n}"]}