domain

type ArchesConfig struct {
	Enabled           bool   `json:"enabled"`
	URL               string `json:"url"`
	OAuthClientID     string `json:"oAuthClientID"`
	OAuthClientSecret string `json:"oAuthClientSecret"`
	UserName          string `json:"userName"`
	Password          string `json:"password"`
	DSN               string `json:"dsn"` // arches postgresql
}

type DataSetRevisions struct {
	Number      int `json:"revisionNumber"`
	RecordCount int `json:"recordCount"`
}

type HubID struct {
	OrgID     string
	DatasetID string
	LocalID   string
}

type Namespace struct {

	// ID is the unique identifier of a namespace.
	// This identifier will be generated when empty.
	//
	// example: "f9ca66c45c2c0a61"
	ID string `json:"uuid"`

	// Base is the default base-URI for a namespace
	// example: "http://purl.org/dc/elements/1.1/"
	Base string `json:"base"`

	// Prefix is the default short version that identifies the base-URI
	// example: "dc"
	Prefix string `json:"prefix"`

	// BaseAlt are alternative base-URI for the same prefix.
	// Sometimes historically the base-URIs for a namespace changes and we still
	// have to correctly resolve both.
	//
	// example: "["http://purl.org/dc/elements/1.1/"]"
	BaseAlt []string `json:"baseAlt,omitempty"`

	// PrefixAlt are altenative prefixes for the default base URI.
	// Different content-providers and organizations have at time selected alternative
	// prefixes for the same base URI. We need to support both entry-points.
	//
	// example: "["dce", "dc11"]"
	PrefixAlt []string `json:"prefixAlt,omitempty"`

	// Schema is an URL to the RDFS or OWL definition of namespace
	// example: "https://www.dublincore.org/specifications/dublin-core/dcmi-terms/dublin_core_terms.ttl"
	Schema string `json:"schema,omitempty"`

	// Temporary defines if the NameSpace has been given a temporary prefix because
	// only the base-URI was known when the NameSpace was created.
	// Namespaces with prefix collissions will also be given a temporary prefix
	//
	// example: "true"
	// default: "false"
	Temporary bool `json:"temporary,omitempty"`
}

type OAIPMHConfig struct {
	Enabled        bool     `json:"enabled"`
	AdminEmails    []string `json:"adminEmails"`
	RepositoryName string   `json:"repositoryName"`
	Deleted        string   `json:"deleted"` // no, persistent, transient

}

type OrgConfigRetriever interface {
	RetrieveConfig(orgID string) (cfg OrganizationConfig, ok bool)
}

type Organization struct {
	ID     OrganizationID     `json:"orgID"`
	Config OrganizationConfig `json:"config"`
}

type OrganizationConfig struct {
	Domains     []string      `json:"domains,omitempty"`
	Default     bool          `json:"default"`
	CustomID    string        `json:"customID"`
	Name        string        `json:"name"`
	Description string        `json:"description"`
	IndexTypes  []string      `json:"indexTypes,omitempty"`
	Arches      *ArchesConfig `json:"arches"`
	// archivespace config
	ArchivesSpace struct {
		Enabled      bool   `json:"enabled"`
		URL          string `json:"url"`
		RepositoryID string `json:"repositoryID"`
	} `json:"archivesspace"`
	// Sitemaps       []SitemapConfig `json:"sitemaps,omitempty"`
	Sitemaps []struct {
		ID            string   `json:"id"`
		BaseURL       string   `json:"baseURL"`
		Query         string   `json:"query"`
		Filters       []string `json:"filters"` // qf and q URL params
		OrgID         string   `json:"-"`
		ExcludedSpecs []string `json:"excludedSpecs"`
	} `json:"sitemaps"`
	Config struct {
		Identifiers struct {
			ArkNAAN      string `json:"arkNAAN"`
			IsilCode     string `json:"isilCode"`
			BrocadeOrgID string `json:"brocadeOrgID"`
		} `json:"identifiers"`
		ShortName   string `json:"shortName"`
		SubTitle    string `json:"subTitle"`
		Description string `json:"description"`
		Location    string `json:"location"`
	} `json:"config"`
	ElasticSearch struct {
		// base of the index aliases
		IndexName string `json:"indexName,omitempty"`
		// if non-empty digital objects will be indexed in a dedicated v2 index
		DigitalObjectSuffix string `json:"digitalObjectSuffix,omitempty"`
		// IndexTypes options are v1, v2, fragment
		IndexTypes []string `json:"indexTypes,omitempty"`
		// Shards is the number of index shards created
		Shards int `json:"shards"`
		// Replicas is the number of replicas created
		Replicas int `json:"replicas"`
		// TrackTotalHits determins if elasticsearch counts results over 10.000
		TrackTotalHits bool `json:"trackTotalHits"`
		// Defaults are the search defaults to be used in the API
		Defaults struct {
			// maxTreeSize is the maximum size of the number of nodes in the tree navigation API
			MaxTreeSize int `json:"maxTreeSize"`
			// FacetSize is the default number of facet items returned from the v2 API
			FacetSize int `json:"facetSize"`
			// Limit is the default number of results returned from from the v2 API
			Limit int `json:"limit"`
			// MaxLimit is the maximum number of results returned from the v2 API
			MaxLimit int `json:"maxLimit"`
		} `json:"defaults"`
	} `json:"elasticSearch,omitempty"`
	OAIPMH struct {
		Enabled        bool     `json:"enabled"`
		AdminEmails    []string `json:"adminEmails"`
		RepositoryName string   `json:"repositoryName"`
		ResponseSize   int      `json:"responseSize"`
	} `json:"oaipmh,omitempty"`
	RDF struct {
		RDFBaseURL     string `json:"rdfBaseURL"`
		MintDatasetURL string `json:"mintDatasetURL"`
		MintOrgIDURL   string `json:"mintOrgIDURL"`
	} `json:"rdf,omitempty"`
	SPARQL struct {
		Enabled        bool   `json:"enabled"`    // Enable the SPARQL proxy
		Host           string `json:"host"`       // the base-url to the SPARQL endpoint including the scheme and the port
		QueryPath      string `json:"queryPath"`  // the relative path of the endpoint. This can should contain the database name that is injected when the sparql endpoint is build
		UpdatePath     string `json:"updatePath"` // the relative path of the update endpoint. This can should contain the database name that is injected when the sparql endpoint is build
		GraphStorePath string `json:"dataPath"`   // the relative GraphStore path of the endpoint. This can should contain the database name that is injected when the sparql endpoint is build
		UserName       string `json:"userName"`
		Password       string `json:"password"`
	} `json:"sparql,omitempty"`
	// contains filtered or unexported fields
}

type OrganizationFilter struct {
	// OffSet is the start of the results returned
	OffSet int
	// Limit is the number of items returned from the filter
	Limit int
	// Org can be used to filter the results based on the filled in value.
	// This is mostly useful if you want to filter by attributes..
	Org Organization
}

type OrganizationID string

type PostHookItem struct {
	Graph   *rdf2go.Graph
	Deleted bool
	Subject string

	// TODO(kiivihal): replace with single domain.HubID later
	OrgID     string
	DatasetID string
	HubID     string
	Revision  int
}

type PostHookService interface {
	// Add adds PostHookItems to the processing queue
	// Add(item ...PostHookItem) error
	// Publish pushes all the submitted jobs to PostHook endpoint
	Publish(item ...*PostHookItem) error
	Valid(datasetID string) bool
	DropDataset(id string, revision int) (*http.Response, error)
	// run this custom function before DropDataset
	Run(datasetID string) error
	// Metrics()
	// OrgID returns OrgID that the posthook applies to
	OrgID() string
	Name() string
}

type Router interface {
	Routes(pattern string, router chi.Router)
}

type Service interface {
	// Metrics() interface{}
	http.Handler
	Router
	SetServiceBuilder(b *ServiceBuilder)
	Shutdown
}

type ServiceBuilder struct {
	Logger *logger.CustomLogger
	Orgs   OrgConfigRetriever
}

type Shutdown interface {
	Shutdown(ctx context.Context) error
}

type URI string