azcore

type Adjunct interface {
}

type AdjunctEntityAttrSet interface {
	AttrSet
}

type AdjunctEntityID[IDNumT AdjunctEntityIDNum] interface {
	azid.ID[IDNumT]
}

type AdjunctEntityIDNum interface {
	azid.IDNum

	AdjunctEntityIDNumMethods
}

type AdjunctEntityIDNumMethods interface {
}

type AdjunctEntityService interface {
	Service
}

type AdjunctEntityServiceBase struct{}

type AdjunctEntityServiceClient interface {
	AdjunctEntityService
	ServiceClient
}

type AdjunctEntityServiceClientBase struct {
	AdjunctEntityServiceBase
}

type AdjunctEntityServiceServer interface {
	AdjunctEntityService
	ServiceServer
}

type AdjunctEntityServiceServerBase struct {
	AdjunctEntityServiceBase
}

type AttrSet interface {
}

type Context interface {
	context.Context
}

type EntityAttrSet interface {
	AttrSet
}

type EntityCreationCallContext[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
	ServiceOpIdempotencyKeyT ServiceOpIdempotencyKey,
] interface {
	ServiceOpCallContext[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT,
		SessionT, ServiceOpIdempotencyKeyT]
}

type EntityCreationEvent[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
	EntityCreationInfoT EntityCreationInfo[
		SessionIDNumT, SessionIDT, TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT, SessionSubjectT, SessionT],
] interface {
	CreationInfo() EntityCreationInfoT
}

type EntityCreationInfo[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
] interface {
	OperationInfo[
		SessionIDNumT, SessionIDT, TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT,
		SessionT]
}

type EntityCreationOutput[
	IDNumT EntityIDNum,
	IDT EntityID[IDNumT],
	RevisionNumberT EntityRevisionNumber,
	DeletionInfoT EntityDeletionInfo,
	InstanceInfoT EntityInstanceInfo[
		RevisionNumberT, DeletionInfoT],
] struct {
	InstanceID   IDT
	InitialState InstanceInfoT
}

type EntityCreationResultContext interface {
	ServiceOpResultContext
}

type EntityDeletionInfo interface {
	// Deleted returns true when the instance is positively deleted.
	Deleted() bool
}

type EntityDeletionInfoBase struct {
	Deleted_ bool
}

type EntityEvent interface {
	Event
}

type EntityEventBase struct {
	EventBase
}

type EntityID[IDNumT EntityIDNum] interface {
	azid.ID[IDNumT]
}

type EntityIDNum interface {
	azid.IDNum

	EntityIDNumMethods
}

type EntityIDNumMethods interface {
}

type EntityInstanceInfo[
	RevisionNumberT EntityRevisionNumber,
	DeletionInfoT EntityDeletionInfo,
] interface {
	RevisionNumber() RevisionNumberT

	// Deletion returns a detailed information about the deletion if
	// the instance has been deleted.
	Deletion() *DeletionInfoT
	// IsDeleted returns true if the instance has been deleted.
	IsDeleted() bool
}

type EntityInstanceInfoBase[
	RevisionNumberT EntityRevisionNumber,
	DeletionInfoT EntityDeletionInfo,
] struct {
	RevisionNumber_ RevisionNumberT
	Deletion_       *DeletionInfoT
}

type EntityMutatingMessage interface {
	EntityOpMessage
	ServiceMutationOpMessage

	EntityMutatingContext() EntityMutationOpContext
}

type EntityMutatingOpCallContext[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
	ServiceOpCallContextT ServiceOpCallContext[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT,
		SessionT, ServiceOpIdempotencyKeyT],
	ServiceOpIdempotencyKeyT ServiceOpIdempotencyKey,
] interface {
	EntityMutationOpContext
	EntityOpCallContext[
		SessionIDNumT, SessionIDT, TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT, SessionSubjectT, SessionT,
		ServiceOpIdempotencyKeyT]
	ServiceMutationOpCallContext[
		SessionIDNumT, SessionIDT, TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT, SessionSubjectT, SessionT,
		ServiceOpCallContextT, ServiceOpIdempotencyKeyT]
}

type EntityMutatingOpResultContext interface {
	EntityMutationOpContext
	EntityOpResultContext
	ServiceMutationOpResultContext
}

type EntityMutationOpContext interface {
	EntityOpContext
	ServiceMutationOpContext
}

type EntityOpCallContext[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
	ServiceOpIdempotencyKeyT ServiceOpIdempotencyKey,
] interface {
	EntityOpContext
	ServiceOpCallContext[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT,
		SessionT, ServiceOpIdempotencyKeyT,
	]
}

type EntityOpContext interface {
	ServiceOpContext
}

type EntityOpMessage interface {
	ServiceOpMessage

	EntityOpContext() EntityOpContext
}

type EntityOpResultContext interface {
	EntityOpContext
	ServiceOpResultContext
}

type EntityRevisionNumber interface {
	int16 | int32 | int64
}

type EntityService interface {
}

type EntityServiceBase struct{}

type EntityServiceClient interface {
	EntityService
}

type EntityServiceServer interface {
	EntityService
}

type Error error

type Event interface {
}

type EventBase struct{}

type HumanContext interface {
	Context

	// AcceptLanguage is analogous to HTTP Accept-Language header field. The
	// languages must be ordered by the human's preference.
	// If the languages comes as weighted, as found in HTTP Accept-Language,
	// sort the languages by their weights then drop the weights.
	AcceptLanguage() []language.Tag
}

type KeyedEntityAttrSet[
	EntityIDNumT EntityIDNum,
	EntityIDT EntityID[EntityIDNumT],
	EntityAttrSetT EntityAttrSet,
] struct {
	ID      EntityIDT
	AttrSet EntityAttrSetT
}

type OperationDelegationInfo[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
] interface {
	// ParentDelegationInfo returns the delegation parent of this delegation.
	ParentDelegationInfo() OperationDelegationInfo[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT, SessionSubjectT, SessionT]

	// Actor returns the subject who delegated the action. Must not be empty
	// in server, might be empty in clients, might be queryable.
	Actor() SessionSubjectT

	// Session returns the session by the actor to delegate the action.
	// Must not be empty in server, might be empty in clients.
	Session() SessionT
}

type OperationInfo[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
] interface {
	// IdempotencyKey returns the idempotency key for this operation.
	IdempotencyKey() ServiceOpIdempotencyKey

	// Actor returns the subject who executed the action. Must not be empty
	// in server, might be empty in clients, might be queryable.
	Actor() SessionSubjectT

	// Session returns the session by the actor to perform the action.
	// Must not be empty in server, might be empty in clients.
	Session() SessionT

	// DelegationInfo returns the information about the delegation if this
	// action was delegated to other subject or session.
	DelegationInfo() OperationDelegationInfo[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT, SessionSubjectT, SessionT]

	// Timestamp returns the time when the action made the effect. This should
	// be obtained from the lowest level, e.g., database or file system.
	//
	// An analogy: in ordering process in a restaurant, the
	// timestamp is the time when the cook declared that the food is ready
	// to be served.
	Timestamp() *time.Time
}

type Service interface {
}

type ServiceClient interface {
	Service
}

type ServiceClientConfig interface {
	ServiceConfig
}

type ServiceClientError interface {
	ServiceError
}

type ServiceClientModule struct {
	ServiceClientConfigSkeleton func() ServiceClientConfig
	NewServiceClient            func(ServiceClientConfig) (ServiceClient, ServiceClientError)
}

type ServiceConfig interface {
}

type ServiceContext interface {
}

type ServiceError interface {
	Error
}

type ServiceModule interface {
}

type ServiceMutationOpCallContext[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
	ServiceOpCallContextT ServiceOpCallContext[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT,
		SessionT, ServiceOpIdempotencyKeyT],
	ServiceOpIdempotencyKeyT ServiceOpIdempotencyKey,
] interface {
	ServiceMutationOpContext
	ServiceOpCallContext[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT,
		SessionT, ServiceOpIdempotencyKeyT]
}

type ServiceMutationOpContext interface {
	ServiceOpContext
}

type ServiceMutationOpMessage interface {
	ServiceOpMessage

	MutationOpContext() ServiceMutationOpContext
}

type ServiceMutationOpResultContext interface {
	ServiceMutationOpContext
	ServiceOpResultContext
}

type ServiceOpCallContext[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT, UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
	ServiceOpIdempotencyKeyT ServiceOpIdempotencyKey,
] interface {
	ServiceOpContext

	// Session returns the session for this context.
	Session() SessionT

	// IdempotencyKey is a key used to ensure that a distinct operation is
	// performed at most once.
	//
	// This key is different from request ID, where for the same operation,
	// there could be more than one requests in attempt to retry in the event
	// of transit error.
	IdempotencyKey() ServiceOpIdempotencyKeyT

	// OriginInfo returns information about the system that made the call.
	OriginInfo() ServiceOpCallOriginInfo
}

type ServiceOpCallContextError interface {
	ServiceOpCallInvocationError
}

type ServiceOpCallData interface {
}

type ServiceOpCallInput[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT, UserIDNumT, UserIDT],
	SessionT Session[
		SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT,
		SessionSubjectT],
	ServiceOpIdempotencyKeyT ServiceOpIdempotencyKey,
	ContextT ServiceOpCallContext[
		SessionIDNumT, SessionIDT, TerminalIDNumT, TerminalIDT,
		UserIDNumT, UserIDT, SessionSubjectT, SessionT,
		ServiceOpIdempotencyKeyT],
	DataT ServiceOpCallData,
] struct {
	Context ContextT
	Data    DataT
}

type ServiceOpCallInputMetadata interface {
}

type ServiceOpCallInvocationError interface {
	ServiceOpError
}

type ServiceOpCallOriginInfo struct {
	// Address returns the IP address or hostname where this call was initiated
	// from. This field might be empty if it's not possible to resolve
	// the address (e.g., the server is behind a proxy or a load-balancer and
	// they didn't forward the the origin IP).
	Address string

	// EnvironmentString returns some details of the environment,
	// might include application's version information, where the application
	// which made the request runs on. For web app, this method usually
	// returns the browser's user-agent string.
	EnvironmentString string

	// AcceptLanguage is analogous to HTTP Accept-Language header field. The
	// languages must be ordered by the human's preference.
	// If the languages comes as weighted, as found in HTTP Accept-Language,
	// sort the languages by their weights then drop the weights.
	AcceptLanguage []language.Tag

	// DateTime is the time of the caller device when the call was initiated.
	//
	// Analogous to HTTP Date header field.
	DateTime *time.Time
}

type ServiceOpCallSessionError interface {
	ServiceOpCallContextError
}

type ServiceOpContext interface {
	ServiceContext

	// OperationName returns the name of the method or the endpoint.
	//
	// For HTTP, this method returns the method. For other protocols, it should
	// be the name of the method e.g., `getUser`.
	OperationName() string

	// ResourceID returns the identifier of the resource being accessed by
	// the call. For HTTP, it's the path. For other protocols, it should
	// be the identifier (ID) of the entity. If there's more than one
	// resources, e.g., a relationship between two entities, then it returns
	// the identifiers of the entities separated by commas.
	ResourceID() string
}

type ServiceOpError interface {
	ServiceError
}

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

type ServiceOpIdempotencyKey interface {
	azob.Equatable
}

type ServiceOpInternalError interface {
	ServiceOpError
}

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

type ServiceOpMessage interface {
	// ServiceOpContext returns the context of this message.
	//
	// Implementations must return most specialized context implementation.
	ServiceOpContext() ServiceOpContext
}

type ServiceOpResultContext interface {
	//TODO: ServiceOpCallContext, or keep it like this and
	// add a method to access the input context: OpCallContext()
	ServiceOpContext

	// Returns the error, if any.
	ServiceOpErr() ServiceOpError

	// Mutated returns true if the method made any changes to any state in the
	// server, even when the method did not succeed. It should not
	// return true if the change has been completely rolled-back before the
	// method returned this context.
	Mutated() bool
}

type ServiceOpResultContextBase struct {
	context.Context
	// contains filtered or unexported fields
}

type ServiceServer interface {
	Service
}

type ServiceServerConfig interface {
	ServiceConfig
}

type ServiceServerError interface {
	ServiceError
}

type ServiceServerModule struct {
	ServiceServerConfigSkeleton func() ServiceServerConfig
	NewServiceServer            func(ServiceServerConfig) (ServiceServer, ServiceServerError)
}

type Session[
	SessionIDNumT SessionIDNum, SessionIDT SessionID[SessionIDNumT],
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	SessionSubjectT SessionSubject[
		TerminalIDNumT, TerminalIDT, UserIDNumT, UserIDT,
	],
] interface {
	// ID returns the identifier of this Session instance.
	ID() SessionIDT

	// DelegateSession returns the session that is a delegate of
	// this session. It returns nil if this session is not a delegated session.
	//
	// A delegation is commonly used when a service is accessing another
	// service on the behalf of a user.
	//
	//     User --> Service A --> Service B
	//
	// In this example, the user is delegating Service A to accces their
	// data in Service B. As seen by Service B, the subject of the Session
	// is the delegating user and this method will return the Session of
	// Service A.
	DelegateSession() Session[SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT, UserIDNumT, UserIDT, SessionSubjectT]

	// ImpersonatorSession returns the session that is impersonating
	// the subject of this session, i.e., the session that was used to create
	// this session. It returns nil if this session is not an impersonation.
	//
	//     User A (Admin) --> (User B) --> Service
	//
	// In this example, User A, who is an admin, impersonate User B to access
	// the Service. The subject of the Session as seen by the Service is
	// User B and this method will return the Session of User A.
	ImpersonatorSession() Session[SessionIDNumT, SessionIDT,
		TerminalIDNumT, TerminalIDT, UserIDNumT, UserIDT, SessionSubjectT]

	// Subject returns the subject of this session.
	Subject() SessionSubjectT

	// IsTerminal returns true if the authorized terminal is the same as termRef.
	IsTerminal(termRef TerminalIDT) bool

	// HasUserAsSubject returns true if the subject is a user instead of
	// a service application.
	HasUserAsSubject() bool

	// IsUser checks if this session is representing a particular user.
	IsUser(userRef UserIDT) bool
}

type SessionID[IDNumT SessionIDNum] interface {
	azid.ID[IDNumT]

	// SessionIDNum returns only the ID part of this ref-key.
	SessionIDNum() IDNumT
}

type SessionIDNum interface {
	azid.IDNum

	SessionIDNumMethods
}

type SessionIDNumMethods interface {
}

type SessionSubject[
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
] interface {
	// TerminalID returns the ref-key of the terminal for this subject.
	TerminalID() TerminalIDT

	// IsRepresentingAUser returns true if this subject is representing
	// a user, i.e., the application is a user-agent, not a service application.
	//
	// If this method returns true, UserID must return a valid ref-key of
	// the user.
	IsRepresentingAUser() bool

	// UserID returns the ref-key of the user this subject represents.
	UserID() UserIDT
}

type StringDisplayable interface {
	DisplayString() string
}

type Terminal[
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
] interface {
	// ID returns the identifier of this Terminal instance.
	ID() TerminalIDT

	// PrincipalUser returns the ref-key of the User, if any, who authorized
	// this instance of Terminal.
	PrincipalUser() UserIDT
}

type TerminalID[IDNumT TerminalIDNum] interface {
	azid.ID[IDNumT]

	// TerminalIDNum returns only the ID part of this ref-key.
	TerminalIDNum() IDNumT
}

type TerminalIDNum interface {
	azid.IDNum

	TerminalIDNumMethods
}

type TerminalIDNumMethods interface {
}

type TerminalRef[
	TerminalIDNumT TerminalIDNum, TerminalIDT TerminalID[TerminalIDNumT],
	UserIDNumT UserIDNum, UserIDT UserID[UserIDNumT],
	TerminalT Terminal[TerminalIDNumT, TerminalIDT, UserIDNumT, UserIDT],
] struct {
	// contains filtered or unexported fields
}

type UserID[IDNumT UserIDNum] interface {
	azid.ID[IDNumT]

	// UserIDNum returns only the ID part of this ref-key.
	UserIDNum() IDNumT
}

type UserIDNum interface {
	azid.IDNum

	UserIDNumMethods
}

type UserIDNumMethods interface {
}

type ValueObject interface {
}

type ValueObjectAssert[T any] interface {
	azob.CloneableAssert[T]
}