contract

package
v0.1.290 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 19, 2025 License: Apache-2.0 Imports: 36 Imported by: 118

Documentation

Index

Constants

View Source 
const (
	MongoLookupFullDocument  MongoLookupTarget = "fullDocument"
	MongoLookupDocumentKey   MongoLookupTarget = "documentKey"
	MongoLookupOperationType MongoLookupTarget = "operationType"
	TypeArray                AtlasDataType     = "array"
	TypeBoolean              AtlasDataType     = "boolean"
	TypeDate                 AtlasDataType     = "date"
	TypeFacetDate            AtlasDataType     = "dateFacet"
	TypeNumber               AtlasDataType     = "number"
	TypeFacetNumber          AtlasDataType     = "numberFacet"
	TypeGeo                  AtlasDataType     = "geo"
	TypeDocument             AtlasDataType     = "document"
	TypeEmbeddedDoc          AtlasDataType     = "embeddedDocument"
	TypeObjectID             AtlasDataType     = "objectId"
	TypeString               AtlasDataType     = "string"
	TypeFacetString          AtlasDataType     = "stringFacet"
	TypeAutocomplete         AtlasDataType     = "autocomplete"
	TypeToken                AtlasDataType     = "token"
	VerbElemMatch            MongoVerb         = "$elemMatch"
	VerbMatch                MongoVerb         = "$match"
	VerbSkip                 MongoVerb         = "$skip"
	VerbLimit                MongoVerb         = "$limit"
	VerbSort                 MongoVerb         = "$sort"
	VerbCount                MongoVerb         = "$count"
	VerbSearch               MongoVerb         = "$search"
	OpAnd                    BSONOperator      = "$and"
	OpOr                     BSONOperator      = "$or"
	OpNor                    BSONOperator      = "$nor"
	OpGT                     BSONOperator      = "$gt"
	OpGTE                    BSONOperator      = "$gte"
	OpLT                     BSONOperator      = "$lt"
	OpLTE                    BSONOperator      = "$lte"
	OpNE                     BSONOperator      = "$ne"
	OpIn                     BSONOperator      = "$in"
	OpNin                    BSONOperator      = "$nin"
	Ascending                SortDirection     = 1
	Descending               SortDirection     = -1
	MatchAll                 MatchBehavior     = "$all"
	MatchIn                  MatchBehavior     = "$in"
	MatchEqual               MatchBehavior     = "$eq"
)
View Source 
const (
	SearchQueryKey   = "q"
	SearchPageKey    = "page"
	SearchPerPageKey = "per_page"
)
View Source 
const DefaultIndent = "  "
View Source 
const (
	IDKey = "id"
)

Variables

View Source 
var SearchRules = QueryParamRules{
	{
		Key:                   SearchQueryKey,
		DefaultValue:          "",
		MultipleValuesAllowed: false,
		Optional:              false,
	},
	{
		Key:                   SearchPageKey,
		DefaultValue:          "",
		MultipleValuesAllowed: false,
		Optional:              false,
	},
	{
		Key:                   SearchPerPageKey,
		DefaultValue:          "",
		MultipleValuesAllowed: false,
		Optional:              false,
	},
}

SearchRules defines validation rules for search queries.

Functions

func ExtractAuthToken added in v0.1.178 

func ExtractAuthToken(r *http.Request, opts AuthOptions) (string, error)

ExtractAuthToken extracts the auth token from the request header.

Types

type AtlasDataType added in v0.0.5 

type AtlasDataType = string

AtlasDataType represents the data types recognized by MongoDB Atlas.

type AtlasIndexes added in v0.1.77 

type AtlasIndexes map[string]string

AtlasIndexes is a map of field name to MongoDB Atlas data type.

func (AtlasIndexes) Fields added in v0.1.77 

func (a AtlasIndexes) Fields() []string

Fields returns the keys of AtlasIndexes.

type Atz added in v0.1.271 

type Atz struct {
	Authorize bool
}

type AuthOption added in v0.1.177 

type AuthOption func(*AuthOptions)

func WithAuthorizationHeaderKey added in v0.1.178 

func WithAuthorizationHeaderKey(x string) AuthOption

func WithPrefix added in v0.1.177 

func WithPrefix(x string) AuthOption

type AuthOptions added in v0.1.177 

type AuthOptions struct {
	AuthorizationHeaderKey string
	Prefix                 string
}

AuthOptions holds authentication-related configuration used across multiple systems, including OIDC & Firebase.

func ApplyAuthOptions added in v0.1.177 

func ApplyAuthOptions(opts *AuthOptions, modifiers ...AuthOption) AuthOptions

type AuthenticationOperator added in v0.1.178 

type AuthenticationOperator interface {
	FirebaseAuthenticator
	OIDCAuthenticator
	AuthenticateWithSecret(ctx context.Context, r *http.Request, opts AuthOptions) error
	AuthenticateAny(ctx context.Context, r *http.Request, opts AuthOptions) error
}

type Authorizable added in v0.1.54 

type Authorizable interface {
	Readers() []ID
	Writers() []ID
	Owners() []ID
}

type AuthorizationResult added in v0.1.56 

type AuthorizationResult struct {
	UnallowedRecords []ID `json:"unallowed_records"`
}

AuthorizationResult represents an authorization response.

func NewAuthorizationResult added in v0.1.57 

func NewAuthorizationResult(opts ...AuthorizationResultOption) *AuthorizationResult

type AuthorizationResultOption added in v0.1.56 

type AuthorizationResultOption func(*AuthorizationResult)

func WithUnallowedRecords added in v0.1.233 

func WithUnallowedRecords(x []ID) AuthorizationResultOption

type BSONOperator added in v0.0.5 

type BSONOperator = string

BSONOperator represents BSON query operators in MongoDB.

type Base64Decoder added in v0.0.5 

type Base64Decoder interface {
	DecodeString(enc *base64.Encoding, src string) ([]byte, error)
}

type BasisInt added in v0.1.10 

type BasisInt = int

type BasisInt32 added in v0.1.10 

type BasisInt32 = int32

type BasisInt64 added in v0.1.10 

type BasisInt64 = int64

type BasisOperator added in v0.1.10 

type BasisOperator interface {
	BasisIntToMajor(ctx context.Context, b BasisInt, c ConversionFactor) (MajorUnit, error)
	BasisInt32ToMajor(ctx context.Context, b BasisInt32, c ConversionFactor) (MajorUnit, error)
	BasisInt64ToMajor(ctx context.Context, b BasisInt64, c ConversionFactor) (MajorUnit, error)
	MajorToBasis(ctx context.Context, m MajorUnit, c ConversionFactor) (BasisInt64, error)
}

type CacheHit added in v0.0.5 

type CacheHit struct {
	V string `json:"v"`
}

CacheHit represents a cache entry that holds a JSON string.

type CacheHitter added in v0.0.5 

type CacheHitter interface {
	DecodeHit(ctx context.Context, c CacheHit, dst any) error
	HitFromValue(ctx context.Context, v any) (*CacheHit, error)
}

type CacheID added in v0.0.5 

type CacheID string

func (CacheID) String added in v0.0.5 

func (c CacheID) String() string

type CacheIdentifier added in v0.0.5 

type CacheIdentifier interface {
	CacheID(ctx context.Context, id string) (CacheID, error)
}

type CacheKey added in v0.0.5 

type CacheKey struct {
	ID           fmt.Stringer
	Microservice string
	Collection   string
	Multi        *CacheMulti
}

CacheKey represents a cache key. It is used to identify a cache entry & it can be used to generate a matching pattern using wildcards.

func (CacheKey) String added in v0.0.5 

func (c CacheKey) String() string

String implements the Stringer interface for Key.

type CacheMulti added in v0.0.5 

type CacheMulti struct {
	RawQuery string
}

type CacheOperator added in v0.0.5 

type CacheOperator interface {
	CacheIdentifier
	CacheHitter
	Cacher
}

type Cacher added in v0.0.5 

type Cacher interface {
	CloserWithCtx
	Get(ctx context.Context, c fmt.Stringer) (*CacheHit, error)
	Set(ctx context.Context, c fmt.Stringer, v CacheHit) error
	BatchGet(ctx context.Context, c []fmt.Stringer) ([]CacheHit, error)
	BatchSet(ctx context.Context, e map[fmt.Stringer]CacheHit) error
	Flush(ctx context.Context, c fmt.Stringer) error
	BatchFlush(ctx context.Context, c []fmt.Stringer) error
	FlushAll(ctx context.Context) error
	Exists(ctx context.Context, c fmt.Stringer) (bool, error)
}

type CertGenerator added in v0.0.5 

type CertGenerator interface {
	X509KeyPair(ctx context.Context, certPEMBlock []byte, keyPEMBlock []byte) (tls.Certificate, error)
	AppendCertsFromPEM(ctx context.Context, pool *x509.CertPool, pemCerts []byte) (bool, error)
}

type ChangeEvent added in v0.0.5 

type ChangeEvent struct {
	OperationType string `json:"operation_type"`
	FullDocument  any    `json:"full_document"`
}

type Closer added in v0.1.13 

type Closer interface {
	Close() error
}

type CloserWithCtx added in v0.1.13 

type CloserWithCtx interface {
	Close(ctx context.Context) error
}

type ComponentExtractor added in v0.1.10 

type ComponentExtractor interface {
	GetComponent(skip int, withFullFn, withFile, withFilePath, withLine bool) string
}

type ConversionFactor added in v0.1.10 

type ConversionFactor = int64

type CreateCollectionsOptions added in v0.1.37 

type CreateCollectionsOptions struct {
	Collections []string
}

type CreateIndexesOptions added in v0.1.37 

type CreateIndexesOptions struct {
	Collection string
	Indexes    []IndexEntry
}

type CreateSearchIndexesOptions added in v0.1.37 

type CreateSearchIndexesOptions struct {
	Collection string
	Indexes    []SearchIndexEntry
}

type DBOperator added in v0.0.5 

type DBOperator interface {
	InsertOne(ctx context.Context, opts InsertOneOptions) error
	FindOne(ctx context.Context, opts FindOneOptions) error
	FindMany(ctx context.Context, opts FindManyOptions) ([]any, error)
	ReplaceOne(ctx context.Context, opts ReplaceOneOptions) error
	DeleteOne(ctx context.Context, opts DeleteOneOptions) error
	DeleteMany(ctx context.Context, opts DeleteManyOptions) error
	CloserWithCtx
}

type DateFilterOptions added in v0.0.5 

type DateFilterOptions struct {
	YearField  string
	MonthField string
	DayField   string
	RefYear    uint
	RefMonth   uint
	RefDay     uint
	IncludeDay bool
}

type DecodeCursorOptions added in v0.0.5 

type DecodeCursorOptions struct {
	Cursor   MongoCursor
	Receiver any
}

type DeleteManyOptions added in v0.0.5 

type DeleteManyOptions struct {
	Collection string
	Filter     bson.M
}

type DeleteOneHandlerOptions added in v0.1.270 

type DeleteOneHandlerOptions struct {
	Atz
}

type DeleteOneOptions added in v0.0.5 

type DeleteOneOptions struct {
	Collection string
	IDKey      string
	ID         Identifier
}

type ElemMatchFilterOptions added in v0.0.5 

type ElemMatchFilterOptions struct {
	ArrayField string
	Element    any
	PrependStr string
	AppendStr  string
}

type ElemsInArrayFilterOptions added in v0.0.5 

type ElemsInArrayFilterOptions struct {
	ArrayField string
	Elements   []any
	PrependStr string
	AppendStr  string
}

type Entry added in v0.1.10 

type Entry struct {
	Handler HandlerFunc
	Weight  uint
}

Entry maps an HTTP handler to a request weight.

type Env added in v0.1.80 

type Env string
const (
	Local   Env = "local"
	Dev     Env = "dev"
	Staging Env = "staging"
	Prod    Env = "prod"
)

func (Env) Validate added in v0.1.126 

func (e Env) Validate() error

type EnvInfo added in v0.1.105 

type EnvInfo struct {
	E            Env
	L            Level
	Addr         string
	MongoConnStr string
	MongoCluster string
	RedisHost    string
	RedisPort    int
}

func ExtractEnvInfo added in v0.1.106 

func ExtractEnvInfo() (*EnvInfo, error)

ExtractEnvInfo returns the current environment information.

type EnvironmentOperator added in v0.1.105 

type EnvironmentOperator interface {
	Info(ctx context.Context) (EnvInfo, error)
	RewriteHost(ctx context.Context, u *url.URL) error
}

type FSysFileReader 

type FSysFileReader interface {
	FSysReadFile(ctx context.Context, fsys fs.ReadFileFS, path string) ([]byte, error)
}

type FactoryOperator added in v0.1.10 

type FactoryOperator interface {
	New(ctx context.Context, name string) (any, error)
}

type FieldInArrayFilterOptions added in v0.0.5 

type FieldInArrayFilterOptions struct {
	Field    string
	Elements []any
}

type FilterOptions added in v0.0.5 

type FilterOptions struct {
	ConvertValues  bool
	QueryParams    map[string][]string
	MatchBehavior  MatchBehavior
	PrependStr     string
	AppendStr      string
	ExcludedFields []string
}

type FindManyHandlerOptions added in v0.1.270 

type FindManyHandlerOptions struct {
	Atz
	Filter        bson.M
	SortDirection SortDirection
	Skip          int64
	Limit         int64
	ValidateQuery bool
}

type FindManyOptions added in v0.0.5 

type FindManyOptions struct {
	FindManyHandlerOptions
	Collection string
	Receiver   any
	SortByKey  string
}

type FindOneOptions added in v0.0.5 

type FindOneOptions struct {
	Collection string
	Receiver   any
	IDKey      string
	ID         Identifier
}

type FirebaseAuthenticator added in v0.1.178 

type FirebaseAuthenticator interface {
	AuthenticateFirebaseIDToken(ctx context.Context, r *http.Request, opts AuthOptions) error
}

type FirebaseMockUser added in v0.1.220 

type FirebaseMockUser struct {
	Email    string
	Password string
}

type FirebaseOperator added in v0.1.10 

type FirebaseOperator interface {
	FirebaseAuthenticator
	FirebaseUtil
	FirebaseTester
	InitFirebase(ctx context.Context, credentialsJSON []byte) (*firebase.App, error)
}

type FirebaseTester added in v0.1.219 

type FirebaseTester interface {
	DeleteMockUser(ctx context.Context, email string) error
	CreateMockUser(ctx context.Context) (*FirebaseMockUser, error)
}

type FirebaseUtil added in v0.1.178 

type FirebaseUtil interface {
	FirebaseIDToken(ctx context.Context, u FirebaseMockUser, apiKey string) (string, error)
	GenerateMockFirebaseUID(ctx context.Context, length int) (string, error)
	GetAPIKey(ctx context.Context) (string, error)
}

type Geocoder 

type Geocoder interface {
	TimezoneFromCoordinates(ctx context.Context, latitude, longitude float64) (string, error)
	CityFromCoordinates(ctx context.Context, latitude, longitude float64) (string, error)
	TimezoneDataFromCoordinates(ctx context.Context, latitude, longitude float64) (*maps.TimezoneResult, error)
	GeocodeCoordinates(ctx context.Context, latitude, longitude float64) ([]maps.GeocodingResult, error)
	SwapTimezone(ctx context.Context, t time.Time, tz string, toUTC, toMidnight bool) (time.Time, error)
	IsUTC(ctx context.Context, t time.Time) (bool, error)
}

type GoogleMaps added in v0.0.5 

type GoogleMaps interface {
	Timezone(ctx context.Context, r *maps.TimezoneRequest) (*maps.TimezoneResult, error)
	Geocode(ctx context.Context, r *maps.GeocodingRequest) ([]maps.GeocodingResult, error)
}

type GzipReader 

type GzipReader interface {
	Read(ctx context.Context, r io.Reader) (io.Reader, error)
}

type GzipUtil 

type GzipUtil interface {
	WriteGzip(ctx context.Context, w *gzip.Writer, r io.Reader) error
	CloseGzipWriter(ctx context.Context, w *gzip.Writer) error
	ReadGzip(ctx context.Context, r io.Reader) ([]byte, error)
	NewGzipReader(ctx context.Context, r io.Reader) (*gzip.Reader, error)
	CopyToBuffer(ctx context.Context, r *gzip.Reader, buf *bytes.Buffer) error
	CloseGzipReader(ctx context.Context, r *gzip.Reader) error
}

type GzipWriter 

type GzipWriter interface {
	Write(ctx context.Context, r io.Reader) (io.Reader, int64, error)
}

type HTTPClient added in v0.0.5 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type HTTPDoer 

type HTTPDoer interface {
	Do(ctx context.Context, r *http.Request) (*http.Response, error)
}

type HTTPHTML added in v0.1.5 

type HTTPHTML interface {
	ServeHTML(ctx context.Context, w http.ResponseWriter, body io.Reader, status int) error
}

type HTTPRequester 

type HTTPRequester interface {
	NewRequest(ctx context.Context, method, url string, opts RequestOptions) (*http.Request, error)
}

type HTTPResponder added in v0.1.5 

type HTTPResponder interface {
	RespondJSON(ctx context.Context, w http.ResponseWriter, v any, status int, escapeHTML bool) error
}

type HTTPResponseWriter added in v0.1.14 

type HTTPResponseWriter interface {
	Header() http.Header
	Write([]byte) (int, error)
	WriteHeader(statusCode int)
}

type HTTPServer added in v0.1.10 

type HTTPServer interface {
	ListenAndServe() error
	ListenAndServeTLS(certFile string, keyFile string) error
	Shutdown(ctx context.Context) error
}

type HTTPUtil added in v0.1.5 

type HTTPUtil interface {
	QueryString(ctx context.Context, pairs ...string) (string, error)
	ValidateQueryParams(ctx context.Context, q map[string][]string, rules ...QueryParamRule) error
	CopyHeaders(ctx context.Context, dst, src *http.Request, headers ...string) error
	GetHeaders(ctx context.Context, r *http.Request) (http.Header, error)
	DecodeBody(ctx context.Context, r *http.Request, v any) error
}

type HTTPWriter 

type HTTPWriter interface {
	Write(w http.ResponseWriter, b []byte) (int, error)
}

type HandlerFunc added in v0.1.11 

type HandlerFunc func(w http.ResponseWriter, r *http.Request) error

HandlerFunc defines a handler function.

func (HandlerFunc) Wrap added in v0.1.11 

func (h HandlerFunc) Wrap(RS HTTPResponder) http.HandlerFunc

type ID added in v0.0.8 

type ID struct {
	V *string `json:"id"`
}

ID is a custom type for database-agnostic unique IDs.

func NewID added in v0.0.8 

func NewID() *ID

NewDBID generates a new ID.

func NewIDFromQVals added in v0.1.61 

func NewIDFromQVals(q config.QVals) *ID

func NewIDFromString added in v0.0.8 

func NewIDFromString(v string) *ID

NewIDFromString converts string to ID.

func (*ID) GetV added in v0.0.8 

func (id *ID) GetV() string

func (*ID) IsEmpty added in v0.0.8 

func (id *ID) IsEmpty() bool

IsEmpty checks if the ID is empty.

func (ID) MarshalBSONValue added in v0.1.267 

func (id ID) MarshalBSONValue() (bson.Type, []byte, error)

MarshalBSONValue implements the bson.ValueMarshaler interface for Mongo compatibility.

func (ID) MarshalJSON added in v0.1.40 

func (id ID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*ID) SetV added in v0.0.8 

func (id *ID) SetV(x string)

func (ID) String added in v0.0.8 

func (id ID) String() string

String implements the Stringer interface.

func (*ID) UnmarshalBSON added in v0.0.8 

func (id *ID) UnmarshalBSON(data []byte) error

UnmarshalBSON implements the bson.Unmarshaler interface for Mongo compatibility.

func (*ID) UnmarshalJSON added in v0.1.40 

func (id *ID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type Identifiable added in v0.0.5 

type Identifiable interface {
	GetID() ID
	GetCreatedAt() time.Time
}

type Identifier added in v0.0.5 

type Identifier interface {
	GetV() string
	SetV(string)
	IsEmpty() bool
	fmt.Stringer
}

type IndexEntry added in v0.0.5 

type IndexEntry struct {
	Name               *string
	Field              string
	SortDirection      SortDirection
	ExpireAfterSeconds *int32
}

type Indexable added in v0.1.211 

type Indexable interface {
	Idx(collection string) CreateIndexesOptions
	IdxSrch(collection string) CreateSearchIndexesOptions
}

type InsertOneHandlerOptions added in v0.1.270 

type InsertOneHandlerOptions struct {
	Atz
}

type InsertOneOptions added in v0.0.5 

type InsertOneOptions struct {
	Collection string
	Document   Identifiable
}

type JSONOption 

type JSONOption func(*JSONOptions)

func WithJSONEscapeHTML 

func WithJSONEscapeHTML(escape bool) JSONOption

func WithJSONIndent 

func WithJSONIndent(indent string) JSONOption

func WithJSONUseNumber 

func WithJSONUseNumber(use bool) JSONOption

type JSONOptions 

type JSONOptions struct {
	Indent     string // Enables indentation if non-empty.
	EscapeHTML bool   // Determines if HTML characters should be escaped.
	UseNumber  bool   // If true, decodes numbers as `json.Number` instead of `float64`.
}

JSONOptions defines settings for encoding/decoding.

func ApplyJSONOptions 

func ApplyJSONOptions(opts *JSONOptions, modifiers ...JSONOption) JSONOptions

type Level 

type Level = slog.Level
const (
	Debug Level = slog.LevelDebug
	Info  Level = slog.LevelInfo
	Warn  Level = slog.LevelWarn
	Error Level = slog.LevelError
)

type LibraryOperator added in v0.1.45 

type LibraryOperator interface {
	Svc(context.Context) (string, error)
}

type LimiterInfo added in v0.1.11 

type LimiterInfo interface {
	GetMaxScore(ctx context.Context) (uint, error)
	GetHeaderKey(ctx context.Context) (string, error)
	GetRateLimitingMode(ctx context.Context) (string, error)
}

type LimiterOperator added in v0.1.10 

type LimiterOperator interface {
	Engage(next HandlerFunc) HandlerFunc
	LimiterInfo
}

type LogOperator added in v0.1.10 

type LogOperator interface {
	Log(ctx context.Context, l Level, v any, prefix string, msg ...string)
	Wrap(ctx context.Context, fn func() (any, error)) error
}

type MajorUnit added in v0.1.10 

type MajorUnit = float64

type Marshaler 

type Marshaler interface {
	Marshal(ctx context.Context, v any, opts JSONOptions) ([]byte, error)
}

type MatchBehavior added in v0.0.5 

type MatchBehavior = string

MatchBehavior defines different matching behaviors in MongoDB queries, such as in, all, and eq.

type MessageRole added in v0.1.245 

type MessageRole = string

MessageRole represents the role of a message. 

const (
	// MessageRoleSystem is the role for the system message.
	MessageRoleSystem MessageRole = "system"
	// MessageRoleUser is the role for the user message.
	MessageRoleUser MessageRole = "user"
	// MessageRoleAssistant is the role for the assistant message.
	MessageRoleAssistant MessageRole = "assistant"
	// GrokChatCompletionURL is the URL for the Grok LLM API.
	GrokChatCompletionURL = "https://api.x.ai/v1/chat/completions"
	// Grok2LatestModel is the latest model for the Grok LLM.
	Grok2LatestModel = "grok-2-latest"
)

type MiddlewareFunc added in v0.1.10 

type MiddlewareFunc func(HandlerFunc) HandlerFunc

MiddlewareFunc defines a composable middleware around a HandlerFunc.

type MiddlewareOperator added in v0.1.10 

type MiddlewareOperator interface {
	Chain(fns ...MiddlewareFunc) MiddlewareFunc
	Gzip(next HandlerFunc) HandlerFunc
	EnforceHTTPS(next HandlerFunc) HandlerFunc
	CheckHeaders(next HandlerFunc) HandlerFunc
	CleanURLPath(next HandlerFunc) HandlerFunc
	IdempotentPOST(next HandlerFunc) HandlerFunc
	RequireReader(next HandlerFunc) HandlerFunc
	RequireWriter(next HandlerFunc) HandlerFunc
	RequireOwner(next HandlerFunc) HandlerFunc
	AuthenticateFirebaseIDToken(next HandlerFunc) HandlerFunc
	AuthenticateFirebaseModIDToken(next HandlerFunc) HandlerFunc
	AuthenticateOIDCToken(next HandlerFunc) HandlerFunc
	AuthenticateWithSecret(next HandlerFunc) HandlerFunc
	AuthenticateAny(next HandlerFunc) HandlerFunc
}

type MongoChangeStream added in v0.0.5 

type MongoChangeStream interface {
	Close(ctx context.Context) error
	Next(ctx context.Context) bool
	Err() error
}

type MongoClient added in v0.0.5 

type MongoClient interface {
	Database(name string, opts ...options.Lister[options.DatabaseOptions]) *mongo.Database
	StartSession(opts ...options.Lister[options.SessionOptions]) (*mongo.Session, error)
	Disconnect(ctx context.Context) error
}

type MongoCollection added in v0.0.5 

type MongoCollection interface {
	InsertOne(ctx context.Context, document any, opts ...options.Lister[options.InsertOneOptions]) (*mongo.InsertOneResult, error)
	FindOne(ctx context.Context, filter any, opts ...options.Lister[options.FindOneOptions]) *mongo.SingleResult
	Find(ctx context.Context, filter any, opts ...options.Lister[options.FindOptions]) (*mongo.Cursor, error)
	ReplaceOne(ctx context.Context, filter any, document any, opts ...options.Lister[options.ReplaceOptions]) (*mongo.UpdateResult, error)
	DeleteOne(ctx context.Context, filter any, opts ...options.Lister[options.DeleteOneOptions]) (*mongo.DeleteResult, error)
	DeleteMany(ctx context.Context, filter any, opts ...options.Lister[options.DeleteManyOptions]) (*mongo.DeleteResult, error)
	Aggregate(ctx context.Context, pipeline any, opts ...options.Lister[options.AggregateOptions]) (*mongo.Cursor, error)
	Watch(ctx context.Context, pipeline any, opts ...options.Lister[options.ChangeStreamOptions]) (*mongo.ChangeStream, error)
}

type MongoCursor added in v0.0.5 

type MongoCursor interface {
	Next(ctx context.Context) bool
	Decode(receiver any) error
	Err() error
}

type MongoDatabase added in v0.0.5 

type MongoDatabase interface {
	Watch(ctx context.Context, pipeline any, opts ...options.Lister[options.ChangeStreamOptions]) (*mongo.ChangeStream, error)
}

type MongoFilter added in v0.0.5 

type MongoFilter interface {
	Filter(ctx context.Context, opts FilterOptions) (bson.M, error)
	FilterByFieldInArray(ctx context.Context, opts FieldInArrayFilterOptions) (bson.M, error)
	FilterByElemMatch(ctx context.Context, opts ElemMatchFilterOptions) (bson.M, error)
	FilterByElemsInArray(ctx context.Context, opts ElemsInArrayFilterOptions) (bson.M, error)
	FilterByAllElemsInArray(ctx context.Context, opts ElemsInArrayFilterOptions) (bson.M, error)
	FilterByFutureDate(ctx context.Context, opts DateFilterOptions) (bson.D, error)
	FilterByPastDate(ctx context.Context, opts DateFilterOptions) (bson.D, error)
	FilterByExactDate(ctx context.Context, opts DateFilterOptions) (bson.D, error)
	CombineM(ctx context.Context, op BSONOperator, m ...bson.M) (bson.M, error)
}

type MongoLookupTarget added in v0.0.5 

type MongoLookupTarget = string

MongoLookupTarget specifies the target field for the lookup stage in a MongoDB aggregation pipeline.

type MongoOperator added in v0.0.5 

type MongoOperator interface {
	MongoUtil
	MongoFilter
	MongoSpecialized
	CloserWithCtx
}

type MongoOutCSChan added in v0.0.5 

type MongoOutCSChan = chan *ChangeEvent

MongoOutCSChan is a channel type used for sending decoded MongoDB change events.

type MongoPipeliner added in v0.0.5 

type MongoPipeliner interface {
	Pipeline() mongo.Pipeline
}

type MongoSpecialized added in v0.0.5 

type MongoSpecialized interface {
	Search(ctx context.Context, opts SearchOptions) (*SearchResult, error)
	WatchCollection(ctx context.Context, opts WatchCollectionOptions) error
	WatchDB(ctx context.Context, opts WatchDBOptions) error
	ProcessChangeStream(ctx context.Context, opts ProcessChangeStreamOptions) error
	RunPipeline(ctx context.Context, opts RunPipelineOptions) ([]any, error)
}

type MongoUtil added in v0.0.5 

type MongoUtil interface {
	WithTransaction(ctx context.Context, fn func(ctx context.Context) error) error
	Collection(ctx context.Context, db, collection string) (MongoCollection, error)
	Database(ctx context.Context, db string) (MongoDatabase, error)
}

type MongoVerb added in v0.0.5 

type MongoVerb = string

MongoVerb defines a MongoDB operation keyword, such as match.

type OIDCAuthenticator added in v0.1.178 

type OIDCAuthenticator interface {
	AuthenticateOIDCToken(ctx context.Context, r *http.Request, opts AuthOptions) error
}

type OIDCCreator added in v0.1.178 

type OIDCCreator interface {
	CreateOIDCToken(ctx context.Context, credentialsJSON []byte, audience string) (*oauth2.Token, error)
}

type OIDCOperator added in v0.1.178 

type OIDCOperator interface {
	OIDCAuthenticator
	OIDCCreator
}

type OperationResult added in v0.1.56 

type OperationResult struct {
	// Message is the optional operation message.
	Message string `json:"message,omitempty"`
	// ID is the optional ressource identifier.
	ID *ID `json:"id,omitempty"`
	// Value is an optional result object.
	Value any `json:"value,omitempty"`
}

Operation is a general-purpose response struct.

func NewOperationResult added in v0.1.57 

func NewOperationResult(opts ...OperationResultOption) *OperationResult

type OperationResultOption added in v0.1.56 

type OperationResultOption func(*OperationResult)

func WithID added in v0.1.56 

func WithID(x *ID) OperationResultOption

func WithMessage added in v0.1.56 

func WithMessage(x string) OperationResultOption

func WithValue added in v0.1.56 

func WithValue(x any) OperationResultOption

type PaginationOptions added in v0.0.5 

type PaginationOptions struct {
	PageNumber int32
	PageSize   int32
}

func (*PaginationOptions) Verify added in v0.0.5 

func (p *PaginationOptions) Verify() error

type Payload added in v0.1.162 

type Payload struct {
	Message      pubsub.Message `json:"message,omitempty"`
	Subscription string         `json:"subscription,omitempty"`
}

type PeriodOperator added in v0.1.10 

type PeriodOperator interface {
	FirstPeriodStartDate(ctx context.Context, year int) (time.Time, error)
	LastDayOfLastPeriod(ctx context.Context, year int) (time.Time, error)
	FirstDayOfMonth(ctx context.Context, date time.Time) (time.Time, error)
	PeriodNumber(ctx context.Context, date time.Time) (int, error)
	TimeOfWeekday(ctx context.Context, date time.Time, weekday time.Weekday) (time.Time, error)
}

type PoolOperator added in v0.1.10 

type PoolOperator interface {
	Acquire(ctx context.Context) error
	Release(ctx context.Context) error
	ActiveWorkers(ctx context.Context) (int, error)
	WaitAll(ctx context.Context) error
	Shutdown(ctx context.Context) error
}

type ProcessChangeStreamOptions added in v0.0.5 

type ProcessChangeStreamOptions struct {
	ChangeStream MongoChangeStream
	LookupKey    string
	Receiver     any
	Output       MongoOutCSChan
}

type PromptMessage added in v0.1.245 

type PromptMessage struct {
	Role    string `json:"role"`
	Content string `json:"content"`
}

PromptMessage represents a message in the conversation. For contextual messages, see:

type PromptRequest added in v0.1.245 

type PromptRequest struct {
	Model       string                `json:"model"`
	M           []PromptMessage       `json:"messages"`
	Stream      bool                  `json:"stream,omitempty"`
	Temperature float64               `json:"temperature,omitempty"`
	R           *PromptResponseFormat `json:"response_format,omitempty"`
}

PromptRequest represents the payload for the LLM API request.

type PromptResponse added in v0.1.245 

type PromptResponse struct {
	ID      string `json:"id"`
	Object  string `json:"object"`
	Created int    `json:"created"`
	Model   string `json:"model"`
	Choices []struct {
		Index   int `json:"index"`
		Message struct {
			Role    string `json:"role"`
			Content string `json:"content"`
			Refusal string `json:"refusal,omitempty"`
		} `json:"message"`
		FinishReason string `json:"finish_reason"`
	} `json:"choices"`
	Usage struct {
		PromptTokens        int `json:"prompt_tokens"`
		CompletionTokens    int `json:"completion_tokens"`
		TotalTokens         int `json:"total_tokens"`
		PromptTokensDetails struct {
			TextTokens   int `json:"text_tokens"`
			AudioTokens  int `json:"audio_tokens"`
			ImageTokens  int `json:"image_tokens"`
			CachedTokens int `json:"cached_tokens"`
		} `json:"prompt_tokens_details"`
	} `json:"usage"`
	SystemFingerprint string `json:"system_fingerprint"`
}

PromptResponse represents the response from the Grok LLM API.

type PromptResponseFormat added in v0.1.245 

type PromptResponseFormat struct {
	Type       string        `json:"type"`
	JSONSchema *schemaFormat `json:"json_schema,omitempty"`
}

PromptResponseFormat represents the response format customization.

type Prompter added in v0.1.245 

type Prompter interface {
	Prompt(ctx context.Context, opts PrompterOpts) (string, error)
}

type PrompterOpts added in v0.1.245 

type PrompterOpts struct {
	SystemPrompt   string                // The system prompt for the LLM.
	UserPrompt     string                // The user prompt for the LLM.
	Context        []PromptMessage       // The context for the LLM.
	Temperature    float64               // The temperature for the LLM.
	R              *PromptResponseFormat // The response format for the LLM.
	AdditionalOpts map[string]any        // Additional options for the LLM to be implemented by prompters, optionally.
}

PrompterOpts represents the options for the Prompter.

type PubSubClient added in v0.1.162 

type PubSubClient interface {
	Topic(id string) *pubsub.Topic
	CreateSubscription(ctx context.Context, id string, cfg pubsub.SubscriptionConfig) (*pubsub.Subscription, error)
	CreateTopic(ctx context.Context, topicID string) (*pubsub.Topic, error)
}

type PubSubFamily added in v0.1.162 

type PubSubFamily struct {
	Topic             *PubSubTopic
	PushSubscriptions []*PubSubPushSubscription
	PullSubscriptions []*PubSubPullSubscription
}

type PubSubMessage added in v0.0.5 

type PubSubMessage interface {
	GetData() []byte
	GetAttributes() map[string]string
	GetMessageID() string
	GetPublishTime() time.Time
}

type PubSubOperator added in v0.1.10 

type PubSubOperator interface {
	MockPayload(ctx context.Context, msg PubSubMessage, sub string) (io.Reader, error)
	DecodePayload(ctx context.Context, r *http.Request) (PubSubMessage, error)
	Publish(ctx context.Context, topicID string, msg *pubsub.Message) error
	NewMessage(ctx context.Context, data string, attrs map[string]string) (*pubsub.Message, error)
	NewAttributes(ctx context.Context, attrs ...string) (map[string]string, error)
}

type PubSubPullSubscription added in v0.1.162 

type PubSubPullSubscription struct {
	ID string
}

type PubSubPushSubscription added in v0.1.162 

type PubSubPushSubscription struct {
	ID           string
	PushEndpoint string
}

type PubSubTopic added in v0.1.162 

type PubSubTopic struct {
	ID string
}

type QueryHandlerOptions added in v0.1.274 

type QueryHandlerOptions struct {
	Atz
}

type QueryParamRule added in v0.1.5 

type QueryParamRule struct {
	Key                   string   // Name of the query parameter.
	DefaultValue          string   // Default value if not provided in the request.
	AcceptedValues        []string // Accepted values; nil allows any value.
	MultipleValuesAllowed bool     // Whether multiple values are permitted.
	Optional              bool     // Whether the parameter is optional.
}

QueryParamRule defines validation rules for a query parameter. It specifies constraints such as key, default value, allowed values, and multiplicity.

type QueryParamRules added in v0.1.72 

type QueryParamRules []QueryParamRule

func (*QueryParamRules) AppendMany added in v0.1.73 

func (q *QueryParamRules) AppendMany(r QueryParamRules)

AppendMany appends multiple QueryParamRules to the QueryParamRules.

func (*QueryParamRules) AppendOne added in v0.1.73 

func (q *QueryParamRules) AppendOne(r QueryParamRule)

Append appends a QueryParamRule to the QueryParamRules.

type Queryable added in v0.1.68 

type Queryable interface {
	Rules() QueryParamRules
}

type RawCacheKey added in v0.1.3 

type RawCacheKey string

RawCacheKey wraps a string key to implement fmt.Stringer.

func (RawCacheKey) String added in v0.1.3 

func (r RawCacheKey) String() string

String implements the Stringer interface for RawCacheKey.

type Reader 

type Reader interface {
	Read(ctx context.Context, r io.Reader) ([]byte, error)
}

type RedisClient added in v0.0.5 

type RedisClient interface {
	Closer
	Get(ctx context.Context, key string) *redis.StringCmd
	Set(ctx context.Context, key string, value any, expiration time.Duration) *redis.StatusCmd
	FlushAll(ctx context.Context) *redis.StatusCmd
	Scan(ctx context.Context, cursor uint64, match string, count int64) *redis.ScanCmd
	TxPipeline() redis.Pipeliner
	Exists(ctx context.Context, keys ...string) *redis.IntCmd
	Pipeline() redis.Pipeliner
}

type RedisOperator added in v0.1.10 

type RedisOperator interface {
	Cacher
}

type ReflectOperator added in v0.1.10 

type ReflectOperator interface {
	FillNilPointers(ctx context.Context, to, from any) error
}

type RegisteredRoute added in v0.1.10 

type RegisteredRoute struct {
	MethodMap map[string]Entry
}

RegisteredRoute holds a map of HTTP methods to route entries.

type Registry added in v0.1.10 

type Registry map[*regexp.Regexp]*RegisteredRoute

Registry maps compiled regex patterns to registered routes.

func (*Registry) LenHandlers added in v0.1.10 

func (r *Registry) LenHandlers() int

LenHandlers returns the total number of handlers across all routes.

func (*Registry) LenRoutes added in v0.1.10 

func (r *Registry) LenRoutes() int

LenRoutes returns the number of registered routes.

type RegistryMutex added in v0.1.10 

type RegistryMutex struct {
	sync.RWMutex
}

RegistryMutex provides thread-safe access to the route registry.

type ReplaceOneHandlerOptions added in v0.1.270 

type ReplaceOneHandlerOptions struct {
	Atz
}

type ReplaceOneOptions added in v0.0.5 

type ReplaceOneOptions struct {
	Collection string
	Document   Identifiable
	IDKey      string
	ID         Identifier
}

type RequestOption 

type RequestOption func(*RequestOptions)

func WithRequestBody 

func WithRequestBody(x io.Reader) RequestOption

func WithRequestHeader 

func WithRequestHeader(x http.Header) RequestOption

type RequestOptions 

type RequestOptions struct {
	Header http.Header
	Body   io.Reader
}

func ApplyRequestOptions 

func ApplyRequestOptions(opts *RequestOptions, modifiers ...RequestOption) RequestOptions

type RequestWeight added in v0.1.10 

type RequestWeight = uint

RequestWeight defines the relative cost of a request for rate limiting. 

const (
	// Unlimited disables rate limiting for the request.
	Unlimited RequestWeight = 0
)

type Role added in v0.1.50 

type Role int
const (
	NA Role = iota
	Rdr
	Wrtr
	Ownr
)

func (Role) Validate added in v0.1.50 

func (r Role) Validate() error

type Route added in v0.1.10 

type Route struct {
	Svc         string
	Pairs       []string
	HandlerFunc HandlerFunc
	Weight      uint
	Methods     []string
}

Route holds route metadata to be compiled and registered.

func (Route) CompileRegex added in v0.1.10 

func (r Route) CompileRegex(pathKey string) (*regexp.Regexp, error)

compileRegex builds a compiled regex for matching the route.

func (*Route) Validate added in v0.1.10 

func (r *Route) Validate() error

type RouterKeyExtractor added in v0.1.198 

type RouterKeyExtractor interface {
	SvcKey(ctx context.Context) (string, error)
	RKey(ctx context.Context) (string, error)
}

type RouterOperator added in v0.1.10 

type RouterOperator interface {
	RouterParser
	RouterKeyExtractor
	Run(ctx context.Context) error
	Mount(ctx context.Context, r []*Route) error
	Stop(ctx context.Context) error
	Vars(ctx context.Context) (*config.Vars, error)
	AttachServer(ctx context.Context, s ServerOperator) error
}

type RouterParser added in v0.1.27 

type RouterParser interface {
	ParsePath(ctx context.Context, r *http.Request, re *regexp.Regexp) (map[string]string, error)
	ParseQuery(ctx context.Context, r *http.Request) (map[string][]string, error)
}

type RunPipelineOptions added in v0.1.79 

type RunPipelineOptions struct {
	Collection string
	Receiver   any
	Pipeline   MongoPipeliner
}

type Scopable added in v0.1.60 

type Scopable interface {
	Scope() Scope
}

type Scope added in v0.1.66 

type Scope struct {
	K  string
	ID ID
}

type SearchIndexEntry added in v0.0.5 

type SearchIndexEntry struct {
	Collection  string
	Fields      AtlasIndexes
	VectorField *VectorSearchField
}

type SearchManyHandlerOptions added in v0.1.270 

type SearchManyHandlerOptions struct {
	Atz
	Filter        bson.M
	SortByKey     string
	SortDirection SortDirection
}

type SearchOptions added in v0.0.5 

type SearchOptions struct {
	SearchManyHandlerOptions
	Collection string
	Receiver   any
	T          *TextOptions
	P          *PaginationOptions
}

type SearchResult added in v0.1.56 

type SearchResult struct {
	Results    []any `json:"results,omitempty"`
	TotalCount int32 `json:"total_count,omitempty"`
	LastPage   int32 `json:"last_page,omitempty"`
}

SearchResult represents the response from a search operation.

func NewSearchResult added in v0.1.57 

func NewSearchResult(opts ...SearchResultOption) *SearchResult

type SearchResultOption added in v0.1.56 

type SearchResultOption func(*SearchResult)

func WithSearchLastPage added in v0.1.56 

func WithSearchLastPage(x int32) SearchResultOption

func WithSearchResults added in v0.1.56 

func WithSearchResults(x []any) SearchResultOption

func WithSearchTotalCount added in v0.1.56 

func WithSearchTotalCount(x int32) SearchResultOption

type Searchable added in v0.1.75 

type Searchable interface {
	SearchIn() []string
}

type SecretInfo added in v0.1.13 

type SecretInfo struct {
	SecretID  string
	VersionID string
}

SecretInfo holds the identifiers needed to access a secret.

func (SecretInfo) BuildSecretName added in v0.1.13 

func (s SecretInfo) BuildSecretName(projectID string) string

BuildSecretName constructs the full secret name path for Secret Manager.

type SecretManagerClient added in v0.1.13 

type SecretManagerClient interface {
	AccessSecretVersion(ctx context.Context, req *secretmanagerpb.AccessSecretVersionRequest, opts ...gax.CallOption) (*secretmanagerpb.AccessSecretVersionResponse, error)
	Close() error
}

type SecretOperator added in v0.1.13 

type SecretOperator interface {
	GetSecret(ctx context.Context, s SecretInfo) ([]byte, error)
	CloserWithCtx
}

type SemaphoreInfo added in v0.1.11 

type SemaphoreInfo interface {
	GetConcurrency(ctx context.Context) (int, error)
}

type SemaphoreOperator added in v0.1.10 

type SemaphoreOperator interface {
	Acquire(ctx context.Context) error
	Release(ctx context.Context) error
	WaitAll(ctx context.Context) error
	SemaphoreInfo
}

type ServerInfo added in v0.1.11 

type ServerInfo interface {
	GetUseHTTP2(ctx context.Context) (bool, error)
	GetUseH2C(ctx context.Context) (bool, error)
	GetBoundOn(ctx context.Context) (string, error)
	GetIdleTimeout(ctx context.Context) (time.Duration, error)
	GetReadTimeout(ctx context.Context) (time.Duration, error)
	GetWriteTimeout(ctx context.Context) (time.Duration, error)
}

type ServerOperator added in v0.1.11 

type ServerOperator interface {
	http.Handler
	ServerRunner
	ServerInfo
}

type ServerRunner added in v0.1.11 

type ServerRunner interface {
	Run(ctx context.Context) error
	Shutdown(ctx context.Context) error
	WithNotFoundHandler(ctx context.Context, x HandlerFunc) error
}

type SortDirection added in v0.0.5 

type SortDirection int

SortDirection represents the sorting order for MongoDB queries.

type Sortable added in v0.1.62 

type Sortable interface {
	SortBy() string
}

type TextOptions added in v0.0.5 

type TextOptions struct {
	Query  string
	Fields []string
}

type Tool 

type Tool[C any] struct {
	Client C
	Logger LogOperator
}

func NewTool 

func NewTool[C any](client C, opts ToolOptions[C]) *Tool[C]

type ToolOption 

type ToolOption[C any] func(*ToolOptions[C])

func WithLogger 

func WithLogger[C any](x LogOperator) ToolOption[C]

type ToolOptions 

type ToolOptions[C any] struct {
	Logger LogOperator
}

func ApplyToolOptions added in v0.1.12 

func ApplyToolOptions[C any](opts *ToolOptions[C], modifiers ...ToolOption[C]) ToolOptions[C]

type Unmarshaler 

type Unmarshaler interface {
	Unmarshal(ctx context.Context, data io.Reader, v any, opts JSONOptions) error
}

type VectorSearchField added in v0.0.5 

type VectorSearchField struct {
	NumDimensions int
	Field         string
	Similarity    string
	Quantization  string
	Additionals   []string
}

type WatchCollectionOptions added in v0.0.5 

type WatchCollectionOptions struct {
	Collection string
	Receiver   any
	Pipeline   MongoPipeliner
	Options    *options.ChangeStreamOptionsBuilder
	LookupKey  string
	Output     MongoOutCSChan
}

type WatchDBOptions added in v0.0.5 

type WatchDBOptions struct {
	Receiver  any
	Pipeline  MongoPipeliner
	Options   *options.ChangeStreamOptionsBuilder
	LookupKey string
	Output    MongoOutCSChan
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.