flags

type BoolFlag interface {
	// Value returns the current value of the flag.
	// If the flag is not provided, it will return the default value.
	Value() (bool, cenclierrors.CencliError)
}

type ConflictingFlagsError interface {
	cenclierrors.CencliError
}

type DurationFlag interface {
	// Value returns the current value of the flag.
	// If the flag is marked as required but not provided,
	// it returns an error of type RequiredFlagNotSetError.
	// If the flag has an invalid duration, it returns an error of type InvalidDurationFlagError.
	// An optional value is returned to keep callers from having to compare to 0.
	Value() (mo.Option[time.Duration], cenclierrors.CencliError)
}

type FileFlag interface {
	// Value returns the value of the flag.
	// Errors if the file does not exist or is not readable.
	// Special case: a value of "-" is treated as STDIN and returned as-is without filesystem validation.
	Value() (string, cenclierrors.CencliError)
	// IsSet returns true if the flag is set.
	IsSet() bool
	// Lines returns the lines of the file.
	// Takes in a cobra command in case it needs to access its stdin reader.
	// The command is not used if the flag value is a real file.
	Lines(*cobra.Command) ([]string, cenclierrors.CencliError)
}

type HumanDurationFlag interface {
	// Value returns the current value of the flag.
	// If the flag is marked as required but not provided,
	// it returns an error of type RequiredFlagNotSetError.
	// If the flag has an invalid duration, it returns an error of type InvalidDurationFlagError.
	// An optional value is returned to keep callers from having to compare to 0.
	Value() (mo.Option[time.Duration], cenclierrors.CencliError)
}

type IntegerFlag interface {
	// Value returns the current value of the flag.
	// If the flag is not provided, it will return the default value.
	// An optional value is returned to distinguish between 0 and not provided.
	Value() (mo.Option[int64], cenclierrors.CencliError)
}

type IntegerFlagInvalidValueError interface {
	cenclierrors.CencliError
}

type InvalidDurationFlagError interface {
	cenclierrors.CencliError
}

type InvalidFileFlagError interface {
	cenclierrors.CencliError
}

type InvalidTimestampFlagError interface {
	cenclierrors.CencliError
}

type InvalidUUIDFlagError interface {
	cenclierrors.CencliError
}

type OrgIDFlag interface {
	// Value returns an optional value indicating the current value of the flag.
	// If the flag is marked as required but not provided,
	// it returns an error of type RequiredFlagNotSetError.
	// If the flag has an invalid UUID, it returns an error of type InvalidUUIDFlagError.
	// An optional value is returned to keep callers from having to compare to uuid.Nil.
	Value() (mo.Option[identifiers.OrganizationID], cenclierrors.CencliError)
}

type RequiredFlagNotSetError interface {
	cenclierrors.CencliError
}

type StringFlag interface {
	// Value returns the current value of the flag.
	// If the flag is marked as required but not provided,
	// it returns an error of type RequiredFlagNotSetError.
	Value() (string, cenclierrors.CencliError)
}

type StringSliceFlag interface {
	// Value returns the current slice of values for the flag.
	// If the flag is marked as required but not provided,
	// it returns an error of type RequiredFlagNotSetError.
	Value() ([]string, cenclierrors.CencliError)
}

type TimestampFlag interface {
	// Value returns the current value of the flag, using the
	// default timezone if no timezone can be inferred.
	// If the flag is marked as required but not provided,
	// it returns an error of type RequiredFlagNotSetError.
	// If the flag has an invalid RFC3339 timestamp, it returns an error of type InvalidRFC3339TimestampFlagError.
	// An optional value is returned to keep callers from having to use IsZero().
	Value(defaultTZ datetime.TimeZone) (mo.Option[time.Time], cenclierrors.CencliError)
	// AddAlias registers an additional flag name and optional shorthand that
	// map to the same underlying value. Useful for supporting synonyms like
	// "--at" and "-a" for an "--at-time" flag.
	AddAlias(name string, short string, desc string) TimestampFlag
}

type UUIDFlag interface {
	// Value returns an optional value indicating the current value of the flag.
	// If the flag is marked as required but not provided,
	// it returns an error of type RequiredFlagNotSetError.
	// If the flag has an invalid UUID, it returns an error of type InvalidUUIDFlagError.
	// An optional value is returned to keep callers from having to compare to uuid.Nil.
	Value() (mo.Option[uuid.UUID], cenclierrors.CencliError)
}