Activate the bundle(s) by loading into the given Store.

ActivateLegacy calls Activate for the bundles but will also write their manifest to the older unnamed store location.

Deactivate the bundle(s).

EraseManifestFromStore will remove the manifest from storage.

EtagStoragePath is the storage path used for the given named bundle etag.

GenerateSignedToken will retrieve the Signer implementation based on the Plugin specified in SigningConfig, and call its implementation of GenerateSignedToken.

GetSigner returns the Signer registered under the given id.

GetVerifier returns the Verifier registered under the given id.

LegacyEraseManifestFromStore will erase the bundle manifest from the older single (unnamed) bundle manifest location.

LegacyReadRevisionFromStore will read the bundle manifest revision from the older single (unnamed) bundle manifest location.

LegacyWriteManifestToStore will write the bundle manifest to the older single (unnamed) bundle manifest location.

ManifestStoragePath is the storage path used for the given named bundle manifest.

Merge accepts a set of bundles and merges them into a single result bundle.

MergeWithRegoVersion creates a merged bundle from the provided bundles, similar to Merge.

NewCustomReader returns a new Reader configured to use the specified DirectoryLoader.

NewDirectoryLoader returns a basic DirectoryLoader implementation that will load files from a given root directory path.

NewFile returns a new FileInfo.

NewFSLoader returns a basic DirectoryLoader implementation that will load files from a fs.FS interface.

NewFSLoaderWithRoot returns a basic DirectoryLoader implementation that will load files from a fs.FS interface at the supplied root.

NewReader is deprecated.

NewSignatureHasher returns a signature hasher suitable for a particular hashing algorithm.

NewSigningConfig return a new SigningConfig.

NewTarballLoader is deprecated.

NewTarballLoaderWithBaseURL returns a new DirectoryLoader that reads files out of a gzipped tar archive.

NewVerificationConfig return a new VerificationConfig.

NewWriter returns a bundle writer that writes to w.

ReadBundleEtagFromStore returns the etag for the specified bundle.

ReadBundleMetadataFromStore returns the metadata in the specified bundle.

ReadBundleNamesFromStore will return a list of bundle names which have had their metadata stored.

ReadBundleRevisionFromStore returns the revision in the specified bundle.

ReadBundleRootsFromStore returns the roots in the specified bundle.

ReadWasmModulesFromStore will write Wasm module resolver metadata from the store.

RegisterSigner registers a Signer under the given id.

RegisterVerifier registers a Verifier under the given id.

RootPathsContain takes a set of bundle root paths and returns true if the path is contained.

RootPathsOverlap takes in two bundle root paths and returns true if they overlap.

VerifyBundleSignature will retrieve the Verifier implementation based on the Plugin specified in SignaturesConfig, and call its implementation of VerifyBundleSignature.

Write is deprecated.

WriteEtagToStore will write the bundle etag into the storage.

WriteManifestToStore will write the manifest into the storage.

Common file extensions and file names.

Common file extensions and file names.

Common file extensions and file names.

Supported values for HashingAlgorithm.

Common file extensions and file names.

Common file extensions and file names.

Supported values for HashingAlgorithm.

Supported values for HashingAlgorithm.

Supported values for HashingAlgorithm.

Supported values for HashingAlgorithm.

Supported values for HashingAlgorithm.

Supported values for HashingAlgorithm.

Supported values for HashingAlgorithm.

Common file extensions and file names.

Common file extensions and file names.

Common file extensions and file names.

BundlesBasePath is the storage path used for storing bundle metadata.

ActivateOpts defines options for the Activate API call.

Bundle represents a loaded bundle.

DeactivateOpts defines options for the Deactivate API call.

DecodedSignature represents the decoded JWT payload.

DefaultSigner is the default bundle signing implementation.

DefaultVerifier is the default bundle verification implementation.

Descriptor contains information about a file and can be used to read the file contents.

DirectoryLoader defines an interface which can be used to load files from a directory by iterating over each one in the tree.

FileInfo contains the hashing algorithm used, resulting digest etc.

HashingAlgorithm represents a subset of hashing algorithms implemented in Go.

KeyConfig holds the keys used to sign or verify bundles and tokens Moved to own package, alias kept for backwards compatibility.

Manifest represents the manifest from a bundle.

ModuleFile represents a single module contained in a bundle.

Patch contains an array of objects wherein each object represents the patch operation to be applied to the bundle data.

PatchOperation models a single patch operation against a document.

PlanModuleFile represents a single plan module contained in a bundle.

Raw contains raw bytes representing the bundle's content.

Reader contains the reader to load the bundle from.

SignatureHasher computes a signature digest for a file with (structured or unstructured) data and policy.

SignaturesConfig represents an array of JWTs that encapsulate the signatures for the bundle.

Signer is the interface expected for implementations that generate bundle signatures.

SigningConfig represents the key configuration used to generate a signed bundle.

VerificationConfig represents the key configuration used to verify a signed bundle.

Verifier is the interface expected for implementations that verify bundle signatures.

WasmModuleFile represents a single wasm module contained in a bundle.

WasmResolver maps a wasm module to an entrypoint ref.

Writer implements bundle serialization.