qilin

type Base64StringFunc func(data []byte) string

type BindableContext interface {
	Context
	// Bind binds json data into the provided type `i`.
	Bind(i any) error
}

type CallToolContent interface {
	GetType() string
}

type CompletionsCapability struct{}

type Context interface {
	// Get retrieves data from the context.
	Get(key any) any
	// Set saves data in the context.
	Set(key any, val any)
	// JSONRPCRequest returns the JSONRPC request
	JSONRPCRequest() jsonrpc2.Request
	// Context returns the context
	Context() context.Context
	// SetContext sets the context
	SetContext(ctx context.Context)
}

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

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

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

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

type JSONMarshalFunc func(v any) ([]byte, error)

type JSONUnmarshalFunc func(data []byte, v any) error

type LoggingCapability struct{}

type NotificationsCancelledRequestParams struct {
	// RequestID is the ID of the request to cancel.
	// This MUST correspond to the ID of a request previously issued in the same direction.
	RequestID any `json:"requestId"`
	// Reason is an optional string describing the reason for the cancellation. This MAY be logged or presented to the user.
	Reason string `json:"reason"`
}

type Notify func(ctx context.Context, method string, params interface{}) error

type NowFunc func() time.Time

type Option func(*Qilin)

type PromptCapability struct {
	// ListChanged indicates this server supports notifications for changes to the prompt list if true.
	ListChanged bool `json:"listChanged,omitzero"`
}

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

type Resource struct {
	// URI of this resource.
	URI *ResourceURI `json:"uri"`

	// Name of the resource that is human-readable.
	//
	// This can be used by clients to populate UI elements.
	Name string `json:"name"`

	// Description of what this resource represents.
	//
	// This can be used by clients to improve the LLM's understanding of available resources.
	// It can be thought of like a "hint" to the model.
	Description string `json:"description,omitzero"`

	// MimeType of this resource, if known.
	MimeType string `json:"mimeType,omitzero"`
}

type ResourceCapability struct {
	// Subscribe indicates this server supports subscribing to resource updates if true.
	Subscribe bool `json:"subscribe,omitzero"`

	// ListChanged indicates this server supports notifications for changes to the resource list if true.
	ListChanged bool `json:"listChanged,omitzero"`
}

type ResourceChangeContext interface {
	// Context returns the application scope context
	Context() context.Context

	// Publish publishes the resource change event
	Publish(uri *url.URL, modifiedAt time.Time)
	// contains filtered or unexported methods
}

type ResourceChangeObserverFunc func(c ResourceChangeContext)

type ResourceChangeSubscriber interface {
	// ID returns the unique ID of the subscriber
	ID() string
	// SubscribedURI returns the subscribed resource URI
	SubscribedURI() *url.URL
	// LastReceived returns the last received time of the subscriber
	LastReceived() time.Time
	// Publish publishes the resource change event
	Publish(uri *url.URL)
}

type ResourceContent interface {
	// GetURI returns the URI of the resource.
	GetURI() *url.URL
	// GetMimeType returns the MIME type of the resource.
	GetMimeType() string
	json.Marshaler
}

type ResourceContext interface {
	Context
	// ResourceURI returns the uri of the resource
	ResourceURI() *url.URL
	// MimeType returns the mime type of the resource
	MimeType() string
	// Param retrieves the path parameter by name
	Param(name string) string
	// String sends plain text content
	String(s string) error
	// JSON sends JSON content
	JSON(i any) error
	// Blob sends blob content
	//
	//  - data: the blob data
	//  - mimeType: (Optional) the mime type of the blob. if not provided, a resource mime type will be used.
	Blob(data []byte, mimeType string) error
}

type ResourceHandlerFunc func(c ResourceContext) error

type ResourceListChangeContext interface {
	// Context returns the application scope context
	Context() context.Context
	// Publish publishes the resource list change event
	Publish(modifiedAt time.Time)
}

type ResourceListChangeObserverFunc func(c ResourceListChangeContext)

type ResourceListChangeSubscriber interface {
	// ID returns the unique ID of the subscriber
	ID() string
	// LastReceived returns the last received time of the subscriber
	LastReceived() time.Time
	// Publish publishes the resource list change event
	Publish()
}

type ResourceListChangeSubscriptionManager interface {
	// SubscribeToResourceListChanges records that a resource list subscription has been started
	// and returns a Subscription.
	// if the subscription already exists, it returns the existing subscription.
	//
	//   ## params
	//
	//   - ctx: context
	//   - sessionID: identifier of the session
	//
	//   ## returns
	//
	//   - subscription: a subscription that can be used to check the health of the subscription
	//   - err: an error if the subscription failed
	SubscribeToResourceListChanges(
		ctx context.Context,
		sessionID string,
	) (subscription Subscription, err error)
	// UnsubscribeToResourceListChanges unsubscribes from the resource list changes
	//
	//   ## params
	//
	//   - ctx: context
	//   - sessionID: identifier of the session
	//
	//   ## returns
	//
	//   - err: an error if the unsubscription failed
	UnsubscribeToResourceListChanges(
		ctx context.Context,
		sessionID string,
	) error
	// Health returns true if the resource list subscription is healthy, otherwise false.
	//
	//   ## params
	//
	//   - ctx: context
	//   - sessionID: identifier of the session
	//
	//   ## returns
	//
	//   - healthy: true if the resource list subscription is healthy, otherwise false
	//   - err: an error if the health check failed
	Health(
		ctx context.Context,
		sessionID string,
	) (healthy bool, err error)
}

type ResourceListChangeSubscriptionStore interface {
	// Get retrieves a subscription by session ID
	Get(ctx context.Context, sessionID string) (Subscription, error)
	// Issue issues a new subscription by session ID
	Issue(ctx context.Context, sessionID string) (Subscription, error)
	// Delete removes a subscription by session ID
	Delete(ctx context.Context, sessionID string) error
}

type ResourceListContext interface {
	Context

	// Resources return registered resources.
	//
	// This includes templates, which must be replaced with the actual available paths in SetResource.
	Resources() map[string]Resource

	// SetResource sets the resource by uri
	//
	// must be the actual path and resource, not the template.
	SetResource(uri string, resource Resource)
}

type ResourceListHandlerFunc func(c ResourceListContext) error

type ResourceListMiddlewareFunc func(next ResourceListHandlerFunc) ResourceListHandlerFunc

type ResourceMiddlewareFunc func(next ResourceHandlerFunc) ResourceHandlerFunc

type ResourceModificationSubscriptionStore interface {
	// Get retrieves a subscription by session ID and URI
	Get(ctx context.Context, sessionID string, uri *url.URL) (Subscription, error)
	// Issue issues a new subscription by session ID and URI
	Issue(ctx context.Context, sessionID string, uri *url.URL) (Subscription, error)
	// Delete removes a subscription
	Delete(ctx context.Context, sessionID string, uri *url.URL) error
	// RetrieveBySessionID retrieves all subscriptions by session ID
	RetrieveBySessionID(ctx context.Context, sessionID string) ([]Subscription, error)
	// RetrieveUnhealthyURIBySessionID retrieves all unhealthy subscriptions uri by session ID
	RetrieveUnhealthyURIBySessionID(ctx context.Context, sessionID string) ([]*url.URL, error)
	// DeleteBySessionID deletes all subscriptions by session ID
	DeleteBySessionID(ctx context.Context, sessionID string) error
}

type ResourceOption func(*resourceOptions)

type ResourceURI url.URL

type ResourcesSubscriptionManager interface {
	// SubscribeToResourceModification records that a resource modification subscription has been started
	// and returns a Subscription.
	// if the subscription already exists, it returns the existing subscription.
	//
	//   ## params
	//
	//   - ctx: context
	//   - sessionID: identifier of the session
	//   - resourceURI: the URI of the resource to subscribe to
	//
	//   ## returns
	//
	//   - subscription: a subscription that can be used to check the health of the subscription
	//   - err: an error if the subscription failed
	SubscribeToResourceModification(
		ctx context.Context,
		sessionID string,
		resourceURI *url.URL,
	) (Subscription, error)
	// UnsubscribeToResourceModification records that the resource modification subscription has been ended
	//
	//   ## params
	//
	//   - ctx: context
	//   - sessionID: identifier of the session
	//   - resourceURI: the URI of the resource to unsubscribe to
	//
	//   ## returns
	//
	//   - err: an error if the unsubscription failed
	UnsubscribeToResourceModification(
		ctx context.Context,
		sessionID string,
		resourceURI *url.URL,
	) error
	// UnhealthSubscriptions returns a list of unhealth subscriptions urls
	UnhealthSubscriptions(ctx context.Context, sessionID string) ([]*url.URL, error)
}

type RootsCapability struct {
	// ListChanged indicates whether the client supports notifications for changes to the roots list.
	ListChanged bool `json:"listChanged,omitzero"`
}

type ServerCapabilities struct {
	// Experimental contains non-standard capabilities that the server supports.
	Experimental map[string]any `json:"experimental,omitzero"`

	// Logging present if the server supports sending log messages to the client.
	Logging *LoggingCapability `json:"logging,omitzero"`

	// Completions present if the server supports argument autocompletion suggestions.
	Completions *CompletionsCapability `json:"completions,omitzero"`

	// Prompts present if the server offers any prompt templates.
	Prompts *PromptCapability `json:"prompts,omitzero"`

	// Resources present if the server offers any resources to read.
	Resources *ResourceCapability `json:"resources,omitzero"`

	// Tools present if the server offers any tools to call.
	Tools *ToolCapability `json:"tools,omitzero"`
}

type SessionManager interface {
	// Start starts a session
	//
	//   ## params
	//
	//   - ctx: context
	//
	//   ## returns
	//
	//   - sessionID: the ID of the started session
	//   - err: an error if the session failed to start
	Start(ctx context.Context) (sessionID string, err error)

	// Context returns a session scoped context
	//
	//   ## params
	//
	//   - ctx: context
	//   - sessionID: session ID
	//
	//   ## returns
	//
	//   - ctx: a context that is scoped to the session
	//   - err: an error if failed to get the session context
	Context(ctx context.Context, sessionID string) (context.Context, error)

	// Discard discards a session
	Discard(ctx context.Context, sessionID string) error
}

type SessionStore interface {
	// Issue creates a new session and returns its ID.
	Issue(ctx context.Context) (sessionID string, err error)
	// Delete removes the session from the store.
	Delete(ctx context.Context, sessionID string) (err error)
	// Context returns the session-scoped context.
	Context(ctx context.Context, sessionID string) (sessionCtx context.Context, err error)
}

type StartOption func(*startOptions)

type SubscribedResources interface {
	Load(key any) (value any, ok bool)
	Store(key any, value any)
	Clear()
	LoadOrStore(key any, value any) (actual any, loaded bool)
	LoadAndDelete(key any) (value any, loaded bool)
	Delete(key any)
	Swap(key any, value any) (previous any, loaded bool)
	CompareAndSwap(key any, old any, new any) (swapped bool)
	CompareAndDelete(key any, old any) (deleted bool)
	Range(f func(key any, value any) bool)
}

type Subscription interface {
	// SignalAlive signals that the subscription is still alive.
	SignalAlive()
	// Unsubscribed returns the channel that was closed when this subscription was canceled.
	Unsubscribed() <-chan struct{}
	// LastAliveTime returns the time when the subscription was last checked for health.
	LastAliveTime() time.Time
}

type Tool struct {
	// Name of the Tool.
	Name string `json:"name"`

	// Description of the Tool that is human-readable.
	Description string `json:"description,omitzero"`

	// InputSchema defines the arguments that the Tool accepts in JSON Schema format.
	InputSchema *jsonschema.Schema `json:"inputSchema"`

	// Annotations hint to the client about the Tool's behavior.
	Annotations *ToolAnnotations `json:"annotations,omitzero"`
	// contains filtered or unexported fields
}

type ToolAnnotations struct {
	// Title is a human-readable title for the Tool.
	Title string `json:"title,omitzero"`

	// ReadOnlyHint indicates the Tool does not modify its environment if true.
	ReadOnlyHint bool `json:"readOnlyHint,omitzero"`

	// DestructiveHint indicates whether the Tool may perform destructive updates to its environment if true.
	// If false, the Tool performs only additive updates.
	//
	// (This property is meaningful only when `readOnlyHint == false`)
	DestructiveHint bool `json:"destructiveHint,omitzero"`

	// IdempotentHint indicates that calling the Tool repeatedly with the same arguments
	// will have no additional effect on the its environment if true.
	//
	// (This property is meaningful only when `readOnlyHint == false`)
	IdempotentHint bool `json:"idempotentHint,omitzero"`

	// OpenWorldHint indicates this Tool may interact with an "open world" of external entities if true.
	// If false, the Tool's domain of interaction is closed.
	// For example, the world of a web search Tool is open, whereas that
	// of a memory Tool is not.
	OpenWorldHint bool `json:"openWorldHint,omitzero"`
}

type ToolCapability struct {
	// ListChanged indicates this server supports notifications for changes to the Tool list if true.
	ListChanged bool `json:"listChanged,omitzero"`
}

type ToolContext interface {
	BindableContext
	// ToolName returns the name of the Tool
	ToolName() string
	// Arguments return the arguments passed to the Tool
	Arguments() json.RawMessage
	// String sends plain text content
	String(s string) error
	// JSON sends JSON content
	JSON(i any) error
	// Image sends image content
	Image(data []byte, mimeType string) error
	// Audio sends audio content
	Audio(data []byte, mimeType string) error
	// JSONResource sends embed JSON resource content
	JSONResource(uri *url.URL, i any, mimeType string) error
	// StringResource sends embed string resource content
	StringResource(uri *url.URL, s string, mimeType string) error
	// BinaryResource sends embed binary resource content
	BinaryResource(uri *url.URL, data []byte, mimeType string) error
}

type ToolHandlerFunc func(c ToolContext) error

type ToolMiddlewareFunc func(next ToolHandlerFunc) ToolHandlerFunc

type ToolOption func(*toolOptions)