concept

type Clause interface {
	// Key returns the key to match against.
	Key() string
	// Seek returns the first matching value for this Clause or "" if not applicable.
	Seek() string
	// Match returns the string that should match each subsequent test when using a cursor or something equal.
	Match() string
	// Type returns the clause identifier type. This type is used for mapping to the underlying DB query language
	Type() string
}

type Concept map[string]interface{}

type Config struct {
	// Concept groups multiple credentials under a single name
	Concept string `yaml:"concept"`
	// CredentialType defines the type of the credential. 'VerifiableCredential' is omitted.
	CredentialType string `yaml:"credentialType"`
	// Indices contains a set of Index values
	Indices []Index `yaml:"indices"`
	// Public indicates if this credential may be published on the DAG
	Public bool `yaml:"public"`
	// Template is the string template for outputting a credential to a common format
	// Each <<JSONPath>> value is substituted with the outcome of the JSONPath query
	Template *string `yaml:"template"`
}

type CredentialQuery struct {
	Clauses []Clause
	// contains filtered or unexported fields
}

type Index struct {
	// Name identifies the index, must be unique per credential
	Name string `yaml:"name"`
	// Parts defines the individual index parts, the ordering is significant
	Parts []IndexPart `yaml:"parts"`
}

type IndexPart struct {
	// Alias defines an optional alias that can be used within a search query
	Alias *string `yaml:"alias"`
	// JSONPath defines the JSON search path
	JSONPath string `yaml:"path"`
	// Tokenizer defines an optional tokenizer. Possible values: [whitespace]
	Tokenizer *string `yaml:"tokenizer"`
	// Transformer defines an optional transformer. Possible values: [cologne, lowercase]
	Transformer *string `yaml:"transformer"`
}

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

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

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

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

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

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

type Query interface {
	// Concept returns the concept name.
	Concept() string
	// Parts returns the different concept queries
	Parts() []*CredentialQuery
	// AddClause adds a clause to the query.
	AddClause(clause Clause)
}

type Reader interface {
	// Concepts returns a list of concept configs
	Concepts() []Config
	// FindByType returns the Config if the given credentialType is registered, nil otherwise
	FindByType(credentialType string) *Config
	// QueryFor creates a query for the given concept.
	// The query is preloaded with required fixed values like the type.
	// It returns ErrUnknownConcept if the concept is not found
	QueryFor(concept string) (Query, error)
	// Transform a VerifiableCredential to concept format.
	Transform(concept string, VC vc.VerifiableCredential) (Concept, error)
}

type Registry interface {
	Reader
	Writer
}

type Writer interface {
	// Add a credential config to the registry
	Add(config Config) error
}