fix: use libvirt types

[elibosley]

Summary by CodeRabbit

• New Features

  • Expanded domain management functionality to provide enhanced lifecycle operations, resource configuration, and status monitoring capabilities, offering streamlined control and improved operational efficiency.

• Chores

  • Updated the organization of type definitions to ensure smoother integration and a more consistent development experience.
  • Adjusted the GitHub Actions workflow to allow the release job to run on branches other than main, while still gating the release step by the branch condition.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request extends the Domain class by adding a comprehensive set of new asynchronous methods for domain operations such as querying status, managing resources, and controlling lifecycle events. New enumerations and interfaces have also been introduced to support these operations. Additionally, the path for TypeScript declarations in the package configuration has been updated to reflect a directory reorganization.

Changes

File	Change Summary
lib/…/get-bindings.d.ts	Added multiple Domain methods (e.g., isActive, suspend, resume, shutdown, reboot, reset, getState, get/setMemory, get/setVcpus, getXMLDesc, defineXML, hasSnapshot related methods, getBlockInfo, getBlockDevices, getInterfaceAddresses); Added enums (DomainRebootFlags, DomainInterfaceAddressesSource) and interfaces (DomainBlockInfo, DomainInterfaceInfo, DomainInterfaceAddress).
package.json	Updated TypeScript declaration path from "./dist/index.d.ts" to "./dist/types/index.d.ts".
.github/…/main.yml	Modified conditional execution of the release-please job to allow it to run on branches other than main, with the release step gated by the main branch condition.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Domain
    Client->>Domain: isActive(), isPersistent(), isUpdated()
    Domain-->>Client: boolean responses
    Client->>Domain: suspend(), resume(), shutdown(), reboot(), reset()
    Domain-->>Client: confirmation (void responses)
    Client->>Domain: getState(), getMaxMemory(), getMemory(), getMaxVcpus(), getVcpus()
    Domain-->>Client: state & numeric values
    Client->>Domain: setMaxMemory(), setMemory(), setVcpus()
    Domain-->>Client: acknowledgment
    Client->>Domain: getXMLDesc(), defineXML(), hasCurrentSnapshot(), hasSnapshot(), getBlockInfo(), getBlockDevices(), getInterfaceAddresses()
    Domain-->>Client: string, object, and array responses

Loading

Possibly related PRs

• fix: use libvirt types #33: The changes in the main PR and the retrieved PR are directly related as both involve the addition of the same methods, enumerations, and interfaces to the Domain class in lib/get-bindings.d.ts.

Poem

I'm a rambunctious rabbit, hopping with glee,
New methods in my garden—so spry and free!
With enums and interfaces lining the code path,
I nibble on features; they make me laugh!
A joyful hop to celebrate changes so neat,
Bound with code and carrot treats!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

lib/get-bindings.d.ts

Oops! Something went wrong! :(

ESLint: 9.22.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 2e78ca4 and a537722.

📒 Files selected for processing (2)

• .github/workflows/main.yml (1 hunks)
• lib/get-bindings.d.ts (1 hunks)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aceff5a and 2e78ca4.

📒 Files selected for processing (2)

• lib/get-bindings.d.ts (1 hunks)
• package.json (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

lib/get-bindings.d.ts (1)

lib/get-bindings.ts (2)

• DomainState (44-55)
• DomainGetXMLDescFlags (36-41)

🪛 Biome (1.9.4)

lib/get-bindings.d.ts

[error] 92-98: The enum declaration should not be const

Const enums are not supported by bundlers and are incompatible with the 'isolatedModules' mode. Their use can lead to import inexistent values.
See TypeScript Docs for more details.
Safe fix: Turn the const enum into a regular enum.

(lint/suspicious/noConstEnum)

---

[error] 100-104: The enum declaration should not be const

Const enums are not supported by bundlers and are incompatible with the 'isolatedModules' mode. Their use can lead to import inexistent values.
See TypeScript Docs for more details.
Safe fix: Turn the const enum into a regular enum.

(lint/suspicious/noConstEnum)

🔇 Additional comments (5)

lib/get-bindings.d.ts (4)

60-90: Validate the newly introduced domain operations.
All these async domain operations appear adequate for a full range of lifecycle and resource management needs. However, consider clarifying the meaning of isUpdated(), as the intent is unclear. If it checks for configuration changes, you might rename it to something like isModified() or isConfigUpdated() to be more explicit. Also, verify in usages that each method handles errors appropriately and returns consistent results in edge cases, for example domains that are already shut down or suspended.

---

106-110: No issues found with DomainBlockInfo.
The shape of this interface aligns well with libvirt’s block info (capacity, allocation, etc.). Nothing to address here.

---

112-116: Looks good for DomainInterfaceInfo.
Appropriate fields for interface name, MAC address, and IP addresses. This interface is consistent with typical libvirt network/device modeling.

---

118-122: DomainInterfaceAddress definition.
This interface properly captures basic address details. No further suggestions.

package.json (1)

6-6: Check for consistency between types path and exports.
You updated "types": "./dist/types/index.d.ts" at the top level, but the "exports" block on lines 12–17 still references "types": "./dist/index.d.ts". Confirm both references match the new directory layout, ensuring that imported types from @unraid/libvirt resolve correctly without confusion.