Skip to main content

Module types

Module types 

Source
Expand description

Core types used across the codebase.

Structs§

Advisory
A security advisory containing information about a vulnerability.
AdvisoryRegistry
A registry of security advisories.
Author
Information about a software author.
BuildDependencyV2
A build dependency with its associated build type.
CiConfig
Configuration for Continuous Integration (CI) runners.
ComplexDependencyGroup
A complex dependency group with various types of dependencies.
Config
The global Zoi configuration.
Dependencies
Defines the dependencies of a package, including runtime, build, and test.
DependenciesV2
Resolved dependencies in a simplified format (V2).
DependencyOptionGroup
A group of optional dependencies.
ExtensionInfo
Information about an extension and its applied changes.
GitLink
A link to a Git repository in a repository configuration.
Hooks
Lifecycle hooks that run during package installation, upgrade, or removal.
InstallManifest
The record of an actual package installation on disk.
LockPackageDetailV2
Detailed lock information for an installed package.
LockRegistryV2
Detailed lock information for a registry.
Maintainer
Information about a package maintainer.
MappedDir
A directory to be created.
MappedFile
A file to be mapped from the pool to a destination path.
MappedSymlink
A symlink to be created.
MiniVulnerability
A simplified vulnerability representation used in package indices.
Package
The core package definition blueprint.
PgpKey
A PGP public key in a repository configuration.
PkgLink
A link to a package index or archive in a repository configuration.
Policy
Policy settings for enforcing constraints on Zoi’s operation.
PoolFileEntry
An entry in the file pool of a ZPA package.
PooledZpaManifest
A manifest for a pooled ZPA package.
PrebuiltInfo
Information about a pre-built package.
PurlPackageIndexV2
Pre-computed metadata for a package in the registry index.
Registry
Configuration for a package registry.
RegistryIndexV2
The root structure of a packages.json registry index file (Specification v2).
RemotePolicyConfig
Configuration for remote policy enforcement.
RepoConfig
The structure of a repo.yaml repository configuration file.
RepoEntry
An entry for a sub-repository in a repository configuration.
SandboxConfig
Configuration for sandboxing a package’s execution.
ScopeMapping
Mappings of files, symlinks, and directories within a specific scope.
Service
Configuration for a background service managed by Zoi.
SharableInstallManifest
A simplified version of an install manifest that can be easily shared or compared.
ShellCompletion
Shell completion configuration.
SignatureEnforcementPolicy
Policy for enforcing cryptographic signatures on packages.
SubPackageMapping
Mappings for a sub-package across different scopes.
Transaction
A transaction containing a set of operations to be performed atomically.
TypedBuildDependencies
Build dependencies categorized by build type.
UpdateInfo
Information about an update notice.
ZoiLockV2
The root structure of a zoi.lock file (Specification v2).

Enums§

BuildDependencies
Represents build dependencies, which can be typed or a single group.
DependencyGroup
A group of dependencies, which can be simple or complex.
ExtensionChange
Defines a specific configuration change applied by an Extension.
InstallReason
The reason for a package installation.
PackageType
Defines the category of a Zoi package.
PlatformOrStringVec
A list of commands to run, either as a simple list or mapped by platform.
Scope
The installation scope for a package.
Severity
Represents the severity level of a security advisory.
SourceType
The type of source from which a package is installed.
TransactionOperation
Represents a single operation within a transaction.
UpdateType
The severity or category of an update notice.

Functions§

to_dependencies_v2
Converts a Dependencies struct to a DependenciesV2 struct.