Shared Types¶

Types used across multiple API methods.

PluginContext¶

Current state in HydroSym, passed to menu actions and state queries.

Field	Type	Description
`projectPath`	`string`	Path to the currently open project file. Null if no project is open.
`projectId`	`string`	Current project identifier, if known.
`selectedComponentId`	`string`	Internal ID of the currently selected component, if any.
`selectedArticleCode`	`string`	Article code of the currently selected component, if any.
`selectedIBorderId`	`string`	Internal ID of the selected i-border. Reserved for future use.
`selectedIBorderName`	`string`	Display name of the selected i-border. Reserved for future use.

A menu item declared by the plugin in GetInfo.

Field	Type	Required	Description
`id`	`string`	✅	Unique identifier for this menu item.
`type`	`string`		'action' (default) or 'separator'.
`label`	`string`		Display text. Supports & for accelerator keys.
`location`	`string`	✅	Where to place the item: plugin, file, tools, toolbar, context:iborder.
`icon`	`string`		Built-in icon name (checkout, checkin, search, upload, download, settings, info, refresh) or a file path.
`shortcut`	`string`		Keyboard shortcut (e.g. Ctrl+Shift+O).
`requiresOpenProject`	`boolean`		If true, grayed out when no project is open. Default false.
`resultType`	`string`		What data this action returns: none, component, openFile, projectId, variables. Default none.

Dynamic state of a menu item.

Field	Type	Required	Description
`enabled`	`boolean`	✅	Whether the menu item is clickable.
`checked`	`boolean`		Whether the menu item shows a checkmark. Default false.
`label`	`string`		Override the label dynamically.

A single item in a Bill of Materials.

Field	Type	Required	Description
`position`	`integer`	✅	Position number in the BOM.
`articleCode`	`string`	✅	Article code.
`description`	`string`		Item description.
`quantity`	`number`	✅	Quantity.
`unit`	`string`		Unit of measure (e.g. pcs, m, kg). Default: pcs.
`level`	`integer`		Nesting level for multi-level BOMs. 0 = top level.
`parentPosition`	`integer`		Position number of parent item. Null for top-level.
`properties`	`map`		Additional properties as key-value pairs.

A pre-rendered export file.

Field	Type	Required	Description
`format`	`string`	✅	File format: pdf, xml, csv.
`filePath`	`string`	✅	Full path to the file.

A drawing file to upload.

Field	Type	Required	Description
`format`	`string`	✅	File format: pdf, dxf, dwg.
`filePath`	`string`	✅	Full path to the file.
`description`	`string`		Description or title for the drawing.

A manifold identifier.

Field	Type	Required	Description
`id`	`string`	✅	Unique identifier in the external system.
`articleCode`	`string`		Article code.
`description`	`string`		Human-readable description.

A member of a part family.

Field	Type	Required	Description
`id`	`string`	✅	Unique identifier.
`articleCode`	`string`	✅	Article code.
`description`	`string`		Human-readable description.
`status`	`string`		Component status: released, draft, obsolete, blocked.