object

type ConfigName string

type ExtensionArea interface {
	extension.Extension
	// GetAreaPath returns the path for a given area.
	GetAreaPath(area string) (string, error)
}

type ExtensionContentChange interface {
	extension.Extension
	// AddFileBefore is called before a file is added to an object.
	AddFileBefore(object VersionWriter, sourceFS fs.FS, source string, dest string, area string, isDir bool) error
	// UpdateFileBefore is called before a file is updated in an object.
	UpdateFileBefore(object VersionWriter, sourceFS fs.FS, source, dest, area string, isDir bool) error
	// DeleteFileBefore is called before a file is deleted from an object.
	DeleteFileBefore(versionWriter VersionWriter, dest string, area string) error
	// AddFileAfter is called after a file is added to an object.
	AddFileAfter(versionWriter VersionWriter, sourceFS fs.FS, source []string, internalPath, digest, area string, isDir bool) error
	// UpdateFileAfter is called after a file is updated in an object.
	UpdateFileAfter(object VersionWriter, sourceFS fs.FS, source, area string, isDir bool) error
	// DeleteFileAfter is called after a file is deleted from an object.
	DeleteFileAfter(object VersionWriter, dest string, area string) error
}

type ExtensionFixityDigest interface {
	extension.Extension
	// GetFixityDigests returns the fixity digests provided by the extension.
	GetFixityDigests() []checksum.DigestAlgorithm
}

type ExtensionManager interface {
	extension.ManagerCore[ExtensionManager]
	ExtensionObjectContentPath
	ExtensionObjectStatePath
	ExtensionContentChange
	ExtensionObjectChange
	ExtensionFixityDigest
	ExtensionObjectExtractPath
	ExtensionMetadata
	ExtensionArea
	ExtensionStream
	ExtensionNewVersion
}

type ExtensionMetadata interface {
	extension.Extension
	// GetMetadata returns the metadata for an object.
	GetMetadata(sourceFS fs.FS, obj Object) (map[string]any, error)
}

type ExtensionNewVersion interface {
	extension.Extension
	// NeedNewVersion returns true if a new version is needed. Called at the end of version Close().
	NeedNewVersion(object VersionWriter) (bool, error)
	// DoNewVersion performs actions for the automatically created new version.
	DoNewVersion(object VersionWriter) error
}

type ExtensionObjectChange interface {
	extension.Extension
	// UpdateObjectBefore is called before an object is updated.
	UpdateObjectBefore(object VersionWriter) error
	// UpdateObjectAfter is called after an object is updated.
	UpdateObjectAfter(object VersionWriter) error
}

type ExtensionObjectContentPath interface {
	extension.Extension
	// BuildObjectManifestPath builds an object manifest path from an original path and an area.
	BuildObjectManifestPath(originalPath string, area string) (string, error)
}

type ExtensionObjectExtractPath interface {
	extension.Extension
	// BuildObjectExtractPath builds an object extract path from an original path and an area.
	BuildObjectExtractPath(originalPath string, area string) (string, error)
}

type ExtensionObjectStatePath interface {
	extension.Extension
	// BuildObjectStatePath builds an object state path from an original path and an area.
	BuildObjectStatePath(originalPath string, area string) (string, error)
}

type ExtensionStream interface {
	extension.Extension
	// StreamObject streams an object's content.
	// All registered StreamObject hooks are called in parallel, as the data stream is split using io.MultiWriter.
	StreamObject(object VersionWriter, reader io.Reader, stateFiles []string, dest string) error
}

type ExtensionVersionDone interface {
	extension.Extension
	// VersionDone is called when a version is done.
	VersionDone(object Object) error
}

type Extractor interface {
	io.Closer
	// Extract extracts a specific version of the object.
	Extract(version *inventory.VersionNumber, withManifest bool, area string) error
	// WithObject sets the object to extract from.
	WithObject(o Object) Extractor
	// WithDestFS sets the destination filesystem for extraction.
	WithDestFS(destFS appendfs.FS) Extractor
	// GetExtensionFileReader returns a reader for a file within an extension.
	GetExtensionFileReader(extensionName string, path string) (io.ReadCloser, int64, string, error)
	// GetFileReader returns a reader for a file in the object.
	GetFileReader(name string) (io.ReadCloser, int64, string, error)
	// GetMetadata returns the metadata of the object.
	GetMetadata() (*inventory.Metadata, error)
}

type Factory interface {
	// NewObject creates a new Object instance.
	NewObject(ctx context.Context) Object
	// NewLoader creates a new Loader instance.
	NewLoader(ctx context.Context) Loader
	// NewInitializer creates a new Initializer instance.
	NewInitializer(ctx context.Context) Initializer
	// NewValidator creates a new Validator instance.
	NewValidator(ctx context.Context) Validator
	// NewExtractor creates a new Extractor instance.
	NewExtractor(ctx context.Context) Extractor
	// NewVersionWriter creates a new VersionWriter instance.
	NewVersionWriter(ctx context.Context) VersionWriter
	// NewVersionFSMap creates a new VersionFSMap instance.
	NewVersionFSMap(ctx context.Context) VersionFSMap
}

type Initializer interface {
	io.Closer
	// Init initializes the object with the given ID and algorithms.
	Init(id string, digest checksum.DigestAlgorithm, fixity []checksum.DigestAlgorithm) error
	// WithObject sets the object to be initialized.
	WithObject(o Object) Initializer
}

type Loader interface {
	io.Closer
	// Load reads the object's inventory and state.
	Load() error
	// WithObject sets the object to be loaded.
	WithObject(o Object) Loader
	// GetFS returns the underlying filesystem.
	GetFS() fs.FS
	// SetExtensionFactory sets the factory for extension management.
	SetExtensionFactory(factory extension.Factory[ExtensionManager]) Loader
}

type NamesStruct struct {
	ExternalPaths []string // Paths outside the OCFL object.
	InternalPath  string   // Path within the OCFL object version state.
	ManifestPath  string   // Path within the OCFL object content directory.
}

type Object interface {
	io.Closer
	// GetExtractor returns an Extractor for this object.
	GetExtractor() Extractor
	// GetInitializer returns an Initializer for this object.
	GetInitializer() Initializer
	// GetLoader returns a Loader for this object.
	GetLoader() Loader
	// WithInventory sets the inventory for the object.
	WithInventory(inv inventory.Inventory) Object
	// WithExtensionManager sets the extension manager for the object.
	WithExtensionManager(manager ExtensionManager) Object
	// WithReadFS sets the read-only filesystem for the object.
	WithReadFS(fsys fs.FS) Object
	// WithWriteFS sets the writable filesystem for the object.
	WithWriteFS(fsys appendfs.FS) Object
	// GetReadFS returns the read-only filesystem.
	GetReadFS() fs.FS
	// GetWriteFS returns the writable filesystem.
	GetWriteFS() appendfs.FS
	// StartUpdate begins a new version update.
	StartUpdate(msg string, UserName string, UserAddress string, echo bool) (VersionWriter, error)
	// GetID returns the object ID.
	GetID() string
	// GetInventory returns the current inventory.
	GetInventory() inventory.Inventory
	// Stat writes statistical information about the object.
	Stat(w io.Writer, statInfo []StatInfo) error
	// GetExtensionManager returns the extension manager.
	GetExtensionManager() ExtensionManager
	// GetOCFLVersion returns the OCFL version of the object.
	GetOCFLVersion() version.OCFLVersion
	// GetValidator returns a Validator for this object.
	GetValidator() Validator
}

type StatInfo int64

type Validator interface {
	io.Closer
	// Check performs the validation of the object.
	Validate() error
	// WithObject sets the object to be checked.
	WithObject(obj Object) Validator
}

type VersionFSMap interface {
	WithBaseFS(baseFS fs.FS) VersionFSMap
	GetVersionFS(version *inventory.VersionNumber) (fs.FS, error)
	Close() error
}

type VersionWriter interface {
	io.Closer
	// AddFolder adds all files from a folder to the version.
	AddFolder(sourceFS fs.FS, checkDuplicate bool, area string) error
	// AddFile adds a single file from a filesystem to the version.
	AddFile(sourceFS fs.FS, path string, checkDuplicate bool, area string, noExtensionHook bool, isDir bool) error
	// AddData adds data from a byte slice as a file to the version.
	AddData(data []byte, path string, checkDuplicate bool, area string, noExtensionHook bool, isDir bool) error
	// AddReader adds data from an io.ReadCloser to the version.
	AddReader(r io.ReadCloser, files []string, area string, noExtensionHook bool, isDir bool) (string, error)
	// DeleteFile removes a file from the version state.
	DeleteFile(virtualFilename string, digest string) error
	// RenameFile changes the path of a file in the version state.
	RenameFile(virtualFilenameSource, virtualFilenameDest string, digest string) error
	// GetID returns the object ID.
	GetID() string
	// GetFS returns the underlying appendfs.FS.
	GetFS() appendfs.FS
	// BeginArea starts a new area (e.g. for extensions).
	BeginArea(area string)
	// EndArea ends the current area.
	EndArea() error
	// BuildNames constructs a NamesStruct for a list of files.
	BuildNames(files []string, area string) (*NamesStruct, error)
	// WithObject sets the object for the VersionWriter.
	WithObject(obj Object) VersionWriter
	// WithEcho sets whether to echo operations.
	WithEcho(echo bool) VersionWriter
	// Init initializes the VersionWriter with user information.
	Init(msg string, name string, address string) error
	// GetObject returns the associated Object.
	GetObject() Object
}