didman

type CompoundServiceResolver interface {
	// GetCompoundServiceEndpoint retrieves the endpoint with the specified endpointType from the specified compound service.
	// It returns the serviceEndpoint of the specified service (which must be an absolute URL endpoint).
	// If resolveReferences is true and the specified endpointType contains a reference, it is resolved and the referenced endpoint is returned instead.
	// It returns ErrServiceNotFound if the specified compound service or endpoint can't be found in the DID Document.
	// It returns ErrInvalidServiceQuery if the endpoint doesn't contain a (valid) reference and resolveReferences = true.
	// It returns ErrServiceReferenceToDeep if the endpoint reference is nested too deep.
	GetCompoundServiceEndpoint(id did.DID, compoundServiceType string, endpointType string, resolveReferences bool) (string, error)

	// GetCompoundServices returns a list of all compoundServices defined on the given DID document.
	// It does not include special compound services like ContactInformation
	// It can also return various errors from DocResolver.Resolve
	GetCompoundServices(id did.DID) ([]did.Service, error)
}

type ContactInformation struct {

	// Email contains the email address for normal priority support
	Email string `json:"email"`

	// Name contains the commonly known name of the service provider
	Name string `json:"name"`

	// Phone contains a phone number for high priority support
	Phone string `json:"phone"`

	// Website contains the URL of the public website of this Service Provider. Can point to a Nuts specific page with more information about the node and how to contact.
	Website string `json:"website"`
}

type Didman interface {
	CompoundServiceResolver

	// AddEndpoint adds a service to a DID Document. The serviceEndpoint is set to the given URL.
	// It returns ErrDuplicateService if a service with the given type already exists.
	// It can also return various errors from DocResolver.Resolve and VDR.Update
	AddEndpoint(id did.DID, serviceType string, u url.URL) (*did.Service, error)

	// DeleteEndpointsByType takes a did and type and removes all endpoint with the type from the DID Document.
	// It returns ErrServiceNotFound if no services with the given type can't be found in the DID Document.
	// It returns ErrServiceInUse if the service is referenced by other services.
	// It can also return various errors from DocResolver.Resolve
	DeleteEndpointsByType(id did.DID, serviceType string) error

	// DeleteService removes a service from a DID Document.
	// It returns ErrServiceInUse if the service is referenced by other services.
	// It returns ErrServiceNotFound if the service can't be found in the DID Document.
	// It can also return various errors from DocResolver.Resolve and VDR.Update
	DeleteService(id ssi.URI) error

	// AddCompoundService adds a compound endpoint to a DID Document.
	// It returns ErrDuplicateService if a service with the given type already exists.
	// It returns ErrInvalidServiceQuery if one of the service references is invalid.
	// It returns ErrReferencedServiceNotAnEndpoint if one of the references does not resolve to a single endpoint URL.
	// It can also return various errors from DocResolver.Resolve and VDR.Update
	AddCompoundService(id did.DID, serviceType string, endpoints map[string]ssi.URI) (*did.Service, error)

	// UpdateContactInformation adds or updates the compoundService with type equal to node-contact-info with provided
	// contact information to the DID Document.
	// It returns the contact information when the update was successful.
	// It can also return various errors from DocResolver.Resolve and VDR.Update
	UpdateContactInformation(id did.DID, information ContactInformation) (*ContactInformation, error)

	// GetContactInformation finds and returns the contact information from the provided DID Document.
	// Returns nil, nil when no contactInformation for the DID was found.
	// It can also return various errors from DocResolver.Resolve
	GetContactInformation(id did.DID) (*ContactInformation, error)

	// SearchOrganizations searches VCR for organizations which's name matches the given query.
	// It then optionally filters on those which have a service of the specified type on their DID Document.
	SearchOrganizations(ctx context.Context, query string, didServiceType *string) ([]OrganizationSearchResult, error)
}

type ErrReferencedServiceNotAnEndpoint struct {
	Cause error
}

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

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

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

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

type OrganizationSearchResult struct {
	// DIDDocument contains the organization's DID Document.
	DIDDocument did.Document `json:"didDocument"`
	// Organization contains the organization's information derived from its Verifiable Credential.
	Organization map[string]interface{} `json:"organization"`
}