aas-configuration-web-component
v1.0.0
Published
Framework-agnostic AAS configuration form built with Angular Elements.
Readme
AAS Configuration Web Component
A framework-agnostic configuration form for Asset Administration Shell services. Angular and Angular Elements are bundled inside the distributable, so consumers only need a browser and the generated JavaScript file.
Build
Requires Node.js 20.19+ or 22.12+ and npm.
cd aas-configuration
npm install
npm run buildThe production artifact is dist/aas-configuration/aas-configuration.bundle.js. The generated demo.html can be used for a local smoke test.
Consume the component
<script src="https://cdn.example.com/aas-configuration.bundle.js"></script>
<aas-configuration
primary-color="#0078d4"
secondary-color="#106ebe"
background-color="#ffffff"
text-color="#323130"
button-color="#0078d4"
border-radius="8px"
font-family="Segoe UI"
>
</aas-configuration>
<script>
const component = document.querySelector("aas-configuration");
component.configuration = {
general: {
customerDomainUrl: "https://mm-software.com",
dataEngineRepositoryBaseUrl: "http://localhost:5059",
maxFileAttachmentSizeBytes: 104857600,
enableNoCacheParameter: false,
},
headerSanitization: {
maxHeaderSize: 8192,
maxHeaderNameSize: 256,
allowedHeaderNames: "^[a-zA-Z0-9\\-_]+$",
allowedHeaderValues: "^[\\x20-\\x7E]+$",
blockedPatterns: "\\r|\\n, \\x00, <script",
},
plugins: {
submodelElementIndexContextPrefix: "_aastwinengineindex_",
defaultLanguages: "",
semanticPostfixSeparator: "_",
name: "RelationalDatabasePlugin",
baseUrl: "http://localhost:8086",
healthEndpoint: "/healthz",
},
templateManagement: {
batchSize: 250,
batchMaxConcurrency: 10,
internalSemanticId: "InternalSemanticId",
aasTemplateRepositoryUrl: "http://localhost:8081",
submodelTemplateRepositoryUrl: "http://localhost:8081",
aasTemplateRegistryUrl: "http://localhost:8082",
submodelTemplateRegistryUrl: "http://localhost:8083",
},
};
component.addEventListener("configurationUpdated", (event) => {
console.log(event.detail);
});
</script>configurationUpdated is emitted only after the form is valid. The event is composed and bubbles through the shadow boundary. The payload is grouped into general, headerSanitization, plugins, and templateManagement sections that correspond to the DataEngine appsettings.json structure.
Deployment
Upload dist/aas-configuration/aas-configuration.bundle.js to an Azure Storage Static Website container or Azure App Service static file directory. Put the file behind Azure CDN or Front Door when it is shared across applications. Configure the host application to allow the bundle's origin through its Content Security Policy and CORS policy where applicable.
The bundle is static and contains no service credentials. Do not place client secrets in the component attributes, configuration object, or emitted event. Authentication fields are identifiers only; token acquisition remains the host application's responsibility.
