storage

type BulkError struct {
	Failures []BulkItemError
	Stopped  bool
}

type BulkItem struct {
	ID    string
	Value any
}

type BulkItemError struct {
	Index int
	Err   error
}

type BulkResult struct {
	Succeeded []int
	Failures  []BulkItemError
	Stopped   bool
}

type Func[T any] func(o *Options[T]) error

type HookFunc[T any] func(ctx context.Context, strg IStorage, id, target string, data any, param T) error

type IStorage interface {
	// Close releases the resources held by the storage.
	//
	// Close must be idempotent: a second call returns nil, so a deferred Close
	// alongside an explicit one is not a bug. In-process adapters that hold no
	// releasable resource implement Close as a no-op so the surface is uniform.
	Close() error

	// Count data.
	Count(ctx context.Context, target string, prm *count.Count, options ...Func[*count.Count]) (int64, error)

	// Delete data.
	Delete(ctx context.Context, id, target string, prm *delete.Delete, options ...Func[*delete.Delete]) error

	// Retrieve data.
	Retrieve(ctx context.Context, id, target string, v any, prm *retrieve.Retrieve, options ...Func[*retrieve.Retrieve]) error

	// List data.
	List(ctx context.Context, target string, v any, prm *list.List, options ...Func[*list.List]) error

	// Create data.
	Create(ctx context.Context, id, target string, v any, prm *create.Create, options ...Func[*create.Create]) (string, error)

	// BulkCreate creates all items using the same target, parameters, and
	// options. Each BulkItem.Value has the same semantics as a call to Create.
	// BulkItem.ID must be non-empty; an empty ID is a per-item failure. Requiring
	// caller-supplied IDs keeps successful identifiers known from the input even
	// on backends whose single-item Create can generate an ID.
	//
	// BulkCreate is not transactional: successful writes remain committed when
	// other items fail. Callers must inspect BulkResult before retrying to avoid
	// blindly repeating successful writes. Backends may chunk, parallelize, or
	// reorder work, so neither processing order nor result-slice order is
	// guaranteed. Original zero-based input indices are the only portable way
	// to correlate outcomes with inputs.
	//
	// Every input index appears exactly once in BulkResult.Succeeded or
	// BulkResult.Failures. A failure retains its underlying error. If any item
	// is unsuccessful, err is non-nil and is an inspectable *BulkError; if every
	// item succeeds, err is nil and BulkResult.AllSucceeded reports true without
	// scanning a slice. BulkResult.Stopped is true when processing stopped early
	// after a failure or context cancellation. In that case, unattempted items
	// appear in Failures with the error that stopped processing. Stopped is
	// false when processing continued through all inputs despite item failures.
	//
	// Options retain Create's per-item hook semantics: the pre-hook runs before
	// each attempted write and the post-hook runs after each successful backend
	// write. A pre-hook failure prevents that item's write. A post-hook failure
	// is reported for that item but does not roll its already-completed write
	// back, consistent with the non-atomic contract.
	//
	// Empty input succeeds with a zero BulkResult and nil error, even if ctx is
	// already canceled. BulkCreate is not atomic and makes no rollback promise.
	// If the same non-empty ID appears more than once, which value remains is
	// unspecified; each occurrence is still classified independently by its
	// input index. Callers requiring a deterministic winner must remove duplicate
	// IDs before calling BulkCreate.
	BulkCreate(
		ctx context.Context,
		target string,
		items []BulkItem,
		prm *create.Create,
		options ...Func[*create.Create],
	) (BulkResult, error)

	// Update data.
	Update(ctx context.Context, id, target string, v any, prm *update.Update, options ...Func[*update.Update]) error

	// GetType returns its type.
	GetType() string

	// GetClient returns the storage client. Use that to interact with the
	// underlying storage client.
	GetClient() any

	// GetLogger returns the logger.
	GetLogger() sypl.ISypl

	// GetName returns the storage name.
	GetName() string

	// GetCounterCounted returns the metric.
	GetCounterCounted() *expvar.Int

	// GetCounterCountedFailed returns the metric.
	GetCounterCountedFailed() *expvar.Int

	// GetCounterDeleted returns the metric.
	GetCounterDeleted() *expvar.Int

	// GetCounterDeletedFailed returns the metric.
	GetCounterDeletedFailed() *expvar.Int

	// GetCounterRetrieved returns the metric.
	GetCounterRetrieved() *expvar.Int

	// GetCounterRetrievedFailed returns the metric.
	GetCounterRetrievedFailed() *expvar.Int

	// GetCounterListed returns the metric.
	GetCounterListed() *expvar.Int

	// GetCounterListedFailed returns the metric.
	GetCounterListedFailed() *expvar.Int

	// GetCounterPingFailed returns the metric.
	GetCounterPingFailed() *expvar.Int

	// GetCounterCreated returns the metric.
	GetCounterCreated() *expvar.Int

	// GetCounterCreatedFailed returns the metric.
	GetCounterCreatedFailed() *expvar.Int

	// GetCounterUpdated returns the metric.
	GetCounterUpdated() *expvar.Int

	// GetCounterUpdatedFailed returns the metric.
	GetCounterUpdatedFailed() *expvar.Int
}

type Indexed[T any] struct {
	Index int
	Item  T
}

type Map map[string]IStorage

type Mock struct {

	// Count data.
	MockCount func(ctx context.Context, target string, prm *count.Count, options ...Func[*count.Count]) (int64, error)

	// Delete data.
	MockDelete func(ctx context.Context, id, target string, prm *delete.Delete, options ...Func[*delete.Delete]) error

	// Retrieve data.
	MockRetrieve func(ctx context.Context, id, target string, v any, prm *retrieve.Retrieve, options ...Func[*retrieve.Retrieve]) error

	// List data.
	MockList func(ctx context.Context, target string, v any, prm *list.List, options ...Func[*list.List]) error

	// Create data.
	MockCreate func(ctx context.Context, id, target string, v any, prm *create.Create, options ...Func[*create.Create]) (string, error)

	// BulkCreate creates data in bulk.
	MockBulkCreate func(ctx context.Context, target string, items []BulkItem, prm *create.Create, options ...Func[*create.Create]) (BulkResult, error)

	// Update data.
	MockUpdate func(ctx context.Context, id, target string, v any, prm *update.Update, options ...Func[*update.Update]) error

	// GetType returns its type.
	MockGetType func() string

	// GetClient returns the storage client. Use that to interact with the underlying storage client.
	MockGetClient func() any

	// GetLogger returns the logger.
	MockGetLogger func() sypl.ISypl

	// GetName returns the storage name.
	MockGetName func() string

	// GetCounterCounted returns the metric.
	MockGetCounterCounted func() *expvar.Int

	// GetCounterCountedFailed returns the metric.
	MockGetCounterCountedFailed func() *expvar.Int

	// GetCounterDeleted returns the metric.
	MockGetCounterDeleted func() *expvar.Int

	// GetCounterDeletedFailed returns the metric.
	MockGetCounterDeletedFailed func() *expvar.Int

	// GetCounterRetrieved returns the metric.
	MockGetCounterRetrieved func() *expvar.Int

	// GetCounterRetrievedFailed returns the metric.
	MockGetCounterRetrievedFailed func() *expvar.Int

	// GetCounterListed returns the metric.
	MockGetCounterListed func() *expvar.Int

	// GetCounterListedFailed returns the metric.
	MockGetCounterListedFailed func() *expvar.Int

	// GetCounterPingFailed returns the metric.
	MockGetCounterPingFailed func() *expvar.Int

	// GetCounterCreated returns the metric.
	MockGetCounterCreated func() *expvar.Int

	// GetCounterCreatedFailed returns the metric.
	MockGetCounterCreatedFailed func() *expvar.Int

	// GetCounterUpdated returns the metric.
	MockGetCounterUpdated func() *expvar.Int

	// GetCounterUpdatedFailed returns the metric.
	MockGetCounterUpdatedFailed func() *expvar.Int
}

type Operation string

type Options[T any] struct {
	// Database name.
	Database string `json:"database"`

	// PreHookFunc is the function which runs before the operation.
	PreHookFunc HookFunc[T] `json:"-"`

	// PostHookFunc is the function which runs after the operation.
	PostHookFunc HookFunc[T] `json:"-"`
}

type Storage struct {
	// Logger.
	Logger sypl.ISypl `json:"-" validate:"required"`

	// Name of the storage type.
	Name string `json:"name" validate:"required,lowercase,gte=1"`
	// contains filtered or unexported fields
}