layer

type BucketACL struct {
	Info *data.BucketInfo
	EACL *eacl.Table
}

type Cache struct {
	// contains filtered or unexported fields
}

type CachesConfig struct {
	Logger        *zap.Logger
	Objects       *cache.Config
	ObjectsList   *cache.Config
	Names         *cache.Config
	Buckets       *cache.Config
	BucketACLs    *cache.Config
	System        *cache.Config
	AccessControl *cache.Config
}

type Client interface {
	Initialize(ctx context.Context, c EventListener) error

	GetBucketSettings(ctx context.Context, bktInfo *data.BucketInfo) (*data.BucketSettings, error)
	PutBucketSettings(ctx context.Context, p *PutSettingsParams) error

	PutBucketCORS(ctx context.Context, p *PutCORSParams) error
	GetBucketCORS(ctx context.Context, bktInfo *data.BucketInfo) (*data.CORSConfiguration, error)
	DeleteBucketCORS(ctx context.Context, bktInfo *data.BucketInfo) error

	ListBuckets(ctx context.Context) ([]*data.BucketInfo, error)
	GetBucketInfo(ctx context.Context, name string) (*data.BucketInfo, error)
	GetBucketACL(ctx context.Context, bktInfo *data.BucketInfo) (*BucketACL, error)
	PutBucketACL(ctx context.Context, p *PutBucketACLParams) error
	CreateBucket(ctx context.Context, p *CreateBucketParams) (*data.BucketInfo, error)
	DeleteBucket(ctx context.Context, p *DeleteBucketParams) error

	GetObject(ctx context.Context, p *GetObjectParams) error
	GetObjectWithPayloadReader(ctx context.Context, p *GetObjectWithPayloadReaderParams) (*ObjectWithPayloadReader, error)
	GetObjectInfo(ctx context.Context, p *HeadObjectParams) (*data.ObjectInfo, error)
	GetExtendedObjectInfo(ctx context.Context, p *HeadObjectParams) (*data.ExtendedObjectInfo, error)
	ComprehensiveObjectInfo(ctx context.Context, p *HeadObjectParams) (*data.ComprehensiveObjectInfo, error)
	GetIDForVersioningContainer(ctx context.Context, p *ShortInfoParams) (oid.ID, error)

	GetLockInfo(ctx context.Context, obj *ObjectVersion) (*data.LockInfo, error)
	PutLockInfo(ctx context.Context, p *PutLockInfoParams) error

	GetBucketTagging(ctx context.Context, bktInfo *data.BucketInfo) (map[string]string, error)
	PutBucketTagging(ctx context.Context, bktInfo *data.BucketInfo, tagSet map[string]string, copiesNumber uint32) error
	DeleteBucketTagging(ctx context.Context, bktInfo *data.BucketInfo) error

	GetObjectTagging(ctx context.Context, p *GetObjectTaggingParams) (string, map[string]string, error)
	PutObjectTagging(ctx context.Context, p *PutObjectTaggingParams) error
	DeleteObjectTagging(ctx context.Context, p *ObjectVersion, copiesNumber uint32) error

	PutObject(ctx context.Context, p *PutObjectParams) (*data.ExtendedObjectInfo, error)

	CopyObject(ctx context.Context, p *CopyObjectParams) (*data.ExtendedObjectInfo, error)

	ListObjectsV1(ctx context.Context, p *ListObjectsParamsV1) (*ListObjectsInfoV1, error)
	ListObjectsV2(ctx context.Context, p *ListObjectsParamsV2) (*ListObjectsInfoV2, error)
	ListObjectVersions(ctx context.Context, p *ListObjectVersionsParams) (*ListObjectVersionsInfo, error)

	DeleteObjects(ctx context.Context, p *DeleteObjectParams) []*VersionedObject

	CreateMultipartUpload(ctx context.Context, p *CreateMultipartParams) (string, error)
	CompleteMultipartUpload(ctx context.Context, p *CompleteMultipartParams) (*UploadData, *data.ExtendedObjectInfo, error)
	UploadPart(ctx context.Context, p *UploadPartParams) (string, error)
	UploadPartCopy(ctx context.Context, p *UploadCopyParams) (*data.ObjectInfo, error)
	ListMultipartUploads(ctx context.Context, p *ListMultipartUploadsParams) (*ListMultipartUploadsInfo, error)
	AbortMultipartUpload(ctx context.Context, p *UploadInfoParams) error
	ListParts(ctx context.Context, p *ListPartsParams) (*ListPartsInfo, error)

	PutBucketNotificationConfiguration(ctx context.Context, p *PutBucketNotificationConfigurationParams) error
	GetBucketNotificationConfiguration(ctx context.Context, bktInfo *data.BucketInfo) (*data.NotificationConfiguration, error)

	// GetObjectTaggingAndLock unifies GetObjectTagging and GetLock methods in a single search invocation.
	GetObjectTaggingAndLock(ctx context.Context, p *ObjectVersion) (map[string]string, *data.LockInfo, error)
}

type CompleteMultipartParams struct {
	Info  *UploadInfoParams
	Parts []*CompletedPart
}

type CompletedPart struct {
	ETag       string
	PartNumber int
}

type Config struct {
	ChainAddress string
	Caches       *CachesConfig
	GateKey      *keys.PrivateKey
	Anonymous    user.ID
	Resolver     Resolver
}

type CopyObjectParams struct {
	SrcObject   *data.ObjectInfo
	ScrBktInfo  *data.BucketInfo
	DstBktInfo  *data.BucketInfo
	DstObject   string
	SrcSize     int64
	Header      map[string]string
	Range       *RangeParams
	Lock        *data.ObjectLock
	Encryption  encryption.Params
	CopiesNuber uint32
}

type CreateBucketParams struct {
	Name                     string
	Policy                   PlacementPolicy
	EACL                     *eacl.Table
	SessionContainerCreation *session.Container
	SessionEACL              *session.Container
	LocationConstraint       string
	ObjectLockEnabled        bool
}

type CreateMultipartParams struct {
	Info         *UploadInfoParams
	Header       map[string]string
	Data         *UploadData
	CopiesNumber uint32
}

type DeleteBucketParams struct {
	BktInfo      *data.BucketInfo
	SessionToken *session.Container
}

type DeleteObjectParams struct {
	BktInfo  *data.BucketInfo
	Objects  []*VersionedObject
	Settings *data.BucketSettings
}

type EncryptedPart struct {
	Part
	EncryptedSize int64
}

type EventListener interface {
	Subscribe(context.Context, string, MsgHandler) error
	Listen(context.Context)
}

type GetObject struct {
	// Authentication parameters.
	PrmAuth

	// Container to read the object header from.
	Container cid.ID

	// ID of the object for which to read the header.
	Object oid.ID
}

type GetObjectParams struct {
	Range      *RangeParams
	ObjectInfo *data.ObjectInfo
	BucketInfo *data.BucketInfo
	Writer     io.Writer
	Encryption encryption.Params
}

type GetObjectTaggingParams struct {
	ObjectVersion *ObjectVersion
}

type GetObjectWithPayloadReaderParams struct {
	Owner   user.ID
	BktInfo *data.BucketInfo
	Object  oid.ID
}

type HeadObjectParams struct {
	BktInfo                   *data.BucketInfo
	Object                    string
	VersionID                 string
	IsBucketVersioningEnabled bool
}

type ListMultipartUploadsInfo struct {
	Prefixes           []string
	Uploads            []*UploadInfo
	IsTruncated        bool
	NextKeyMarker      string
	NextUploadIDMarker string
}

type ListMultipartUploadsParams struct {
	Bkt            *data.BucketInfo
	Delimiter      string
	EncodingType   string
	KeyMarker      string
	MaxUploads     int
	Prefix         string
	UploadIDMarker string
}

type ListObjectVersionsInfo struct {
	CommonPrefixes      []string
	IsTruncated         bool
	KeyMarker           string
	NextKeyMarker       string
	NextVersionIDMarker string
	Version             []*data.ExtendedObjectInfo
	DeleteMarker        []*data.ExtendedObjectInfo
	VersionIDMarker     string
}

type ListObjectVersionsParams struct {
	BktInfo         *data.BucketInfo
	Delimiter       string
	KeyMarker       string
	MaxKeys         int
	Prefix          string
	VersionIDMarker string
	Encode          string
}

type ListObjectsInfo struct {
	Prefixes    []string
	Objects     []data.ObjectListResponseContent
	IsTruncated bool
}

type ListObjectsInfoV1 struct {
	ListObjectsInfo
	NextMarker string
}

type ListObjectsInfoV2 struct {
	ListObjectsInfo
	NextContinuationToken string
}

type ListObjectsParamsCommon struct {
	BktInfo   *data.BucketInfo
	Delimiter string
	Encode    string
	MaxKeys   int
	Prefix    string
}

type ListObjectsParamsV1 struct {
	ListObjectsParamsCommon
	Marker string
}

type ListObjectsParamsV2 struct {
	ListObjectsParamsCommon
	ContinuationToken string
	StartAfter        string
	FetchOwner        bool
}

type ListPartsInfo struct {
	Parts                []*Part
	Owner                user.ID
	NextPartNumberMarker int
	IsTruncated          bool
}

type ListPartsParams struct {
	Info             *UploadInfoParams
	MaxParts         int
	PartNumberMarker int
}

type MsgHandler interface {
	HandleMessage(context.Context, *nats.Msg) error
}

type MsgHandlerFunc func(context.Context, *nats.Msg) error

type Multipart struct {
	// MultipartHashes contains hashes for the multipart object payload calculation (optional).
	MultipartHashes *MultipartHashes
	// SplitPreviousID contains [oid.ID] of previous object in chain (optional).
	SplitPreviousID *oid.ID
	// SplitFirstID contains [oid.ID] of the first object in chain (The first object has nil here).
	SplitFirstID *oid.ID
	// HeaderObject is a virtual representation of complete multipart object (optional). It is used to set Parent in
	// linking object.
	HeaderObject *object.Object
	// Link contains info for linking object.
	Link *object.Link
	// PayloadHash contains precalculated hash for object.
	PayloadHash hash.Hash
	// HomoHash contains precalculated homomorphic hash for object if enabled.
	HomoHash hash.Hash
}

type MultipartHashes struct {
	// Hash contains hash for the payload of the whole "big" multipart uploaded object.
	Hash hash.Hash
	// HomoHash contains homo hash (if enabled) for the payload of the whole "big" multipart uploaded object.
	HomoHash hash.Hash
	// PartHash contains hash for separate part in multipart upload.
	PartHash hash.Hash
}

type NeoFS interface {
	// CreateContainer creates and saves parameterized container in NeoFS.
	// It sets 'Timestamp' attribute to the current time.
	// It returns the ID of the saved container.
	//
	// Created container is public with enabled ACL extension.
	//
	// It returns exactly one non-zero value. It returns any error encountered which
	// prevented the container from being created.
	CreateContainer(context.Context, PrmContainerCreate) (cid.ID, error)

	// Container reads a container from NeoFS by ID.
	//
	// It returns exactly one non-nil value. It returns any error encountered which
	// prevented the container from being read.
	Container(context.Context, cid.ID) (*container.Container, error)

	// UserContainers reads a list of the containers owned by the specified user.
	//
	// It returns exactly one non-nil value. It returns any error encountered which
	// prevented the containers from being listed.
	UserContainers(context.Context, user.ID) ([]cid.ID, error)

	// SetContainerEACL saves the eACL table of the container in NeoFS. The
	// extended ACL is modified within session if session token is not nil.
	//
	// It returns any error encountered which prevented the eACL from being saved.
	SetContainerEACL(context.Context, eacl.Table, *session.Container) error

	// CreateContainerAndSetEACL creates container and sets EACL using the same rawClient.
	CreateContainerAndSetEACL(ctx context.Context, prm PrmContainerCreate, table eacl.Table, sessionToken *session.Container) (cid.ID, error)

	// ContainerEACL reads the container eACL from NeoFS by the container ID.
	//
	// It returns exactly one non-nil value. It returns any error encountered which
	// prevented the eACL from being read.
	ContainerEACL(context.Context, cid.ID) (*eacl.Table, error)

	// DeleteContainer marks the container to be removed from NeoFS by ID.
	// Request is sent within session if the session token is specified.
	// Successful return does not guarantee actual removal.
	//
	// It returns any error encountered which prevented the removal request from being sent.
	DeleteContainer(context.Context, cid.ID, *session.Container) error

	// ReadObject reads a part of the object from the NeoFS container by identifier.
	// Exact part is returned according to the parameters:
	//   * with header only: empty payload (both in-mem and reader parts are nil);
	//   * with payload only: header is nil (zero range means full payload);
	//   * with header and payload: full in-mem object, payload reader is nil.
	//
	// WithHeader or WithPayload is true. Range length is positive if offset is positive.
	//
	// Payload reader should be closed if it is no longer needed.
	//
	// It returns ErrAccessDenied on read access violation.
	//
	// It returns exactly one non-nil value. It returns any error encountered which
	// prevented the object header from being read.
	ReadObject(context.Context, PrmObjectRead) (*ObjectPart, error)

	// GetObject returns object head and payload Reader.
	GetObject(ctx context.Context, prm GetObject) (*ObjectPart, error)

	// CreateObject creates and saves a parameterized object in the NeoFS container.
	// It sets 'Timestamp' attribute to the current time.
	// It returns the ID of the saved object.
	//
	// Creation time should be written into the object (UTC).
	//
	// It returns ErrAccessDenied on write access violation.
	//
	// It returns exactly one non-zero value. It returns any error encountered which
	// prevented the container from being created.
	CreateObject(context.Context, PrmObjectCreate) (oid.ID, error)

	// FinalizeObjectWithPayloadChecksums fills and signs header object for complete multipart object.
	FinalizeObjectWithPayloadChecksums(context.Context, object.Object, hash.Hash, hash.Hash, uint64) (*object.Object, error)

	// DeleteObject marks the object to be removed from the NeoFS container by identifier.
	// Successful return does not guarantee actual removal.
	//
	// It returns ErrAccessDenied on remove access violation.
	//
	// It returns any error encountered which prevented the removal request from being sent.
	DeleteObject(context.Context, PrmObjectDelete) error

	// TimeToEpoch computes current epoch and the epoch that corresponds to the provided now and future time.
	// Note:
	// * future time must be after the now
	// * future time will be ceil rounded to match epoch
	//
	// It returns any error encountered which prevented computing epochs.
	TimeToEpoch(ctx context.Context, now time.Time, future time.Time) (uint64, uint64, error)

	// MaxObjectSize returns configured payload size limit for object slicing when enabled.
	MaxObjectSize() int64

	// IsHomomorphicHashingEnabled shows if homomorphic hashing is enabled in config.
	IsHomomorphicHashingEnabled() bool

	// CurrentEpoch returns current epoch.
	CurrentEpoch() uint64

	// SearchObjects searches objects with corresponding filters.
	SearchObjects(ctx context.Context, prm PrmObjectSearch) ([]oid.ID, error)

	// SearchObjectsV2 searches objects with corresponding filters and return objectID with requested attributes.
	SearchObjectsV2(context.Context, cid.ID, object.SearchFilters, []string, client.SearchObjectsOptions) ([]client.SearchResultItem, error)

	// SearchObjectsV2WithCursor searches objects with corresponding filters and return objectID with requested attributes. It uses cursor to start from required point.
	SearchObjectsV2WithCursor(ctx context.Context, cid cid.ID, filters object.SearchFilters, attributes []string, cursor string, opts client.SearchObjectsOptions) ([]client.SearchResultItem, string, error)
}

type ObjectPart struct {
	// Object header with optional in-memory payload part.
	Head *object.Object

	// Object payload part encapsulated in io.Reader primitive.
	// Returns ErrAccessDenied on read access violation.
	Payload io.ReadCloser
}

type ObjectVersion struct {
	BktInfo    *data.BucketInfo
	ObjectName string
	VersionID  string
}

type ObjectWithPayloadReader struct {
	Head       *object.Object
	Payload    io.ReadCloser
	ObjectInfo *data.ObjectInfo
}

type Part struct {
	ETag       string
	PartNumber int
	Size       int64
}

type PlacementPolicy struct {
	Version     int                    `json:"version"`
	Placement   netmap.PlacementPolicy `json:"placement"`
	Consistency string                 `json:"consistency"`
}

type PrmAuth struct {
	// Bearer token to be used for the operation. Overlaps PrivateKey. Optional.
	BearerToken *bearer.Token
}

type PrmContainerCreate struct {
	// NeoFS identifier of the container creator.
	Creator user.ID

	// Container placement policy.
	Policy PlacementPolicy

	// Name for the container.
	Name string

	// CreationTime value for Timestamp attribute
	CreationTime time.Time

	// Token of the container's creation session. Nil means session absence.
	SessionToken *session.Container

	// Basic ACL of the container.
	BasicACL acl.Basic

	// Attributes for optional parameters.
	AdditionalAttributes [][2]string

	// Executor allows to set-up custom executor to the operation.
	Executor waiter.ContainerPutExecutor
}

type PrmObjectCreate struct {
	// Authentication parameters.
	PrmAuth

	// Container to store the object.
	Container cid.ID

	// NeoFS identifier of the object creator.
	Creator user.ID

	// Key-value object attributes.
	Attributes map[string]string

	// Value for Timestamp attribute (optional).
	CreationTime time.Time

	// ID to lock (optional).
	Locked oid.ID

	// Full payload size (optional).
	PayloadSize uint64

	// Associated filepath (optional).
	Filepath string

	// Object payload encapsulated in io.Reader primitive.
	Payload io.Reader

	// Number of object copies that is enough to consider put successful.
	CopiesNumber uint32

	Multipart *Multipart
}

type PrmObjectDelete struct {
	// Authentication parameters.
	PrmAuth

	// Container to delete the object from.
	Container cid.ID

	// Identifier of the removed object.
	Object oid.ID
}

type PrmObjectRead struct {
	// Authentication parameters.
	PrmAuth

	// Container to read the object header from.
	Container cid.ID

	// ID of the object for which to read the header.
	Object oid.ID

	// Flag to read object header.
	WithHeader bool

	// Flag to read object payload. False overlaps payload range.
	WithPayload bool

	// Offset-length range of the object payload to be read.
	PayloadRange [2]uint64
}

type PrmObjectSearch struct {
	// Authentication parameters.
	PrmAuth

	// Container to read the object header from.
	Container cid.ID

	// Filters for object filtering.
	Filters object.SearchFilters

	// XHeaders for object filtering.
	XHeaders []string
}

type PutBucketACLParams struct {
	BktInfo      *data.BucketInfo
	EACL         *eacl.Table
	SessionToken *session.Container
}

type PutBucketNotificationConfigurationParams struct {
	RequestInfo   *api.ReqInfo
	BktInfo       *data.BucketInfo
	Configuration *data.NotificationConfiguration
	CopiesNumber  uint32
}

type PutCORSParams struct {
	BktInfo      *data.BucketInfo
	Reader       io.Reader
	CopiesNumber uint32
}

type PutLockInfoParams struct {
	ObjVersion   *ObjectVersion
	NewLock      *data.ObjectLock
	CopiesNumber uint32
}

type PutObjectParams struct {
	BktInfo      *data.BucketInfo
	Object       string
	Size         int64
	Reader       io.Reader
	Header       map[string]string
	Lock         *data.ObjectLock
	Encryption   encryption.Params
	CopiesNumber uint32
	Tags         map[string]string
}

type PutObjectTaggingParams struct {
	ObjectVersion *ObjectVersion
	TagSet        map[string]string

	CopiesNumber uint32
}

type PutSettingsParams struct {
	BktInfo      *data.BucketInfo
	Settings     *data.BucketSettings
	CopiesNumber uint32
}

type RangeParams struct {
	Start uint64
	End   uint64
}

type Resolver interface {
	ResolveCID(ctx context.Context, containerName string) (cid.ID, error)
}

type ShortInfoParams struct {
	CID             cid.ID
	Owner           user.ID
	Object          string
	FindNullVersion bool
}

type TestNeoFS struct {
	NeoFS
	// contains filtered or unexported fields
}

type UploadCopyParams struct {
	Info       *UploadInfoParams
	SrcObjInfo *data.ObjectInfo
	SrcBktInfo *data.BucketInfo
	PartNumber int
	Range      *RangeParams
}

type UploadData struct {
	TagSet     map[string]string
	ACLHeaders map[string]string
}

type UploadInfo struct {
	IsDir    bool
	Key      string
	UploadID string
	Owner    user.ID
	Created  time.Time
}

type UploadInfoParams struct {
	UploadID   string
	Bkt        *data.BucketInfo
	Key        string
	Encryption encryption.Params
}

type UploadPartParams struct {
	Info       *UploadInfoParams
	PartNumber int
	Size       int64
	Reader     io.Reader
}

type VersionedObject struct {
	Name              string
	VersionID         string
	DeleteMarkVersion string
	DeleteMarkerEtag  string
	Error             error
}