Component Types (dw::meta::Component)

Use this topic to understand the DataWeave types in a component descriptor. These types define how DataWeave represents components and their owned modules in dw-components.dwl.

Type Definition Description

Type	Definition	Description
ComponentDescriptor	`type ComponentDescriptor = { name: ComponentName, resources: { (NameIdentifier): ModuleDescriptor } }`	Describes a single component. Contains the following fields: `name`: Component identifier referenced from `@VisibleTo`. `resources`: Modules owned by the component, keyed by `NameIdentifier`. Introduced in DataWeave version 2.12.0.
ComponentName	`type ComponentName = String`	Identifier of a component that matches the `name` field of a `ComponentDescriptor`. Introduced in DataWeave version 2.12.0.
ComponentsDescriptor	`type ComponentsDescriptor = Array<ComponentDescriptor>`	Top-level type of a `dw-components.dwl` file: an array of components. Introduced in DataWeave version 2.12.0.
ModuleDescriptor	`type ModuleDescriptor = {}`	Per-resource metadata. Reserved for future fields; emit `{}` for every entry. Introduced in DataWeave version 2.12.0.
NameIdentifier	`type NameIdentifier = String`	Fully qualified DataWeave module name written with the `::` separator, such as `"dw::core::Strings"`. Introduced in DataWeave version 2.12.0.

ComponentDescriptor

type ComponentDescriptor = { name: ComponentName, resources: { (NameIdentifier): ModuleDescriptor } }

Describes a single component. Contains the following fields:

name: Component identifier referenced from @VisibleTo.
resources: Modules owned by the component, keyed by NameIdentifier.