Archi Semantic Core: Using Archi Models from TypeScript

Archi Semantic Core enables working with Archi models from TypeScript. Models are stored in .archimate files, which contain elements, relationships, folders, views, diagram objects, connections, properties, geometry, and other data. The @cda/archi-semantic-core package provides access to this information in TypeScript without requiring understanding of how Archi structures its native XML internally.

Installation is done via npm: npm install @cda/archi-semantic-core. The primary operation is parseArchiModel, which takes XML text of a native Archi model and returns a typed ArchiModel.

With the model, you can access elements, relationships, and views. Elements are available through model.elements, and relationships through model.relationships. Your application can work directly with concepts from the Archi model instead of manually navigating XML nodes and namespaces. Elements include information such as name, type, and xsiType. Relationships contain type, sourceId, and targetId.

To extract XML from a .archimate file, use extractArchiModelXml to retrieve the XML from the file. The library separates responsibilities between extractArchiModelXml and parseArchiModel. Working with elements can be done using for loops or filtering techniques. Elements can be filtered based on their type, such as finding all ApplicationComponent elements.

Relationships can also be filtered and queried similarly to elements. With this library, you can easily open a model created in Archi and inspect its contents.