geonetwork-ui 2.1.0-initial

package/src/libs/common/domain/src/lib/organizations.service.interface.ts

@@ -0,0 +1,19 @@
+import { Observable } from 'rxjs'
+import { FieldFilters } from './search/filter.model'
+import { Organization } from './record/organization.model'
+import { BaseRecord, CatalogRecord } from './record/metadata.model'
+
+export abstract class OrganizationsServiceInterface {
+  public abstract organisations$: Observable<Organization[]>
+  public abstract organisationsCount$: Observable<number>
+  public abstract getFiltersForOrgs(
+    organisations: Organization[]
+  ): Observable<FieldFilters>
+  public abstract getOrgsFromFilters(
+    filters: FieldFilters
+  ): Observable<Organization[]>
+  public abstract addOrganizationToRecordFromSource(
+    source: Record<string, unknown>,
+    sourceRecord: BaseRecord
+  ): Observable<CatalogRecord>
+}

package/src/libs/common/domain/src/lib/record/contact.model.ts

@@ -0,0 +1,38 @@
+import { Organization } from './organization.model'
+
+export const RoleValues = [
+  'unspecified',
+  'other',
+  'author', // Party who authored the resource
+  'collaborator', // party who assists with the generation of the resource other than the principal investigator
+  'contributor', // party contributing to the resource
+  'custodian', // Party that accepts accountability and responsibility for the data and ensures appropriate care and maintenance of the resource
+  'distributor', // Party who distributes the resource
+  'editor', // party who reviewed or modified the resource to improve the content
+  'funder', // party providing monetary support for the resource
+  'mediator', // a class of entity that mediates access to the resource and for whom the resource is intended or useful
+  'originator', // Party who created the resource
+  'owner', // Party that owns the resource
+  'point_of_contact', // Party who can be contacted for acquiring knowledge about or acquisition of the resource
+  'principal_investigator', // Key party responsible for gathering information and conducting research
+  'processor', // Party who has processed the data in a manner such that the resource has been modified
+  'publisher', // Party who published the resource
+  'resource_provider', // Party that supplies the resource
+  'rights_holder', // party owning or managing rights over the resource
+  'sponsor', // party that sponsors the resource
+  'stakeholder', // party who has an interest in the resource or the use of the resource
+  'user', // Party who uses the resource
+]
+
+export type Role = typeof RoleValues[number]
+
+export interface Individual {
+  firstName?: string
+  lastName?: string
+  email: string
+  role: Role
+  position?: string
+  organization: Organization
+  address?: string
+  phone?: string
+}

package/src/libs/common/domain/src/lib/record/index.ts

@@ -0,0 +1,3 @@
+export * from './contact.model'
+export * from './organization.model'
+export * from './metadata.model'

package/src/libs/common/domain/src/lib/record/metadata.model.ts

@@ -0,0 +1,188 @@
+import { marker } from '@biesbjerg/ngx-translate-extract-marker'
+import { Individual } from './contact.model'
+import { Organization } from './organization.model'
+
+type Uuid = string
+
+marker('domain.record.updateFrequency.unknown')
+marker('domain.record.updateFrequency.notPlanned')
+marker('domain.record.updateFrequency.asNeeded')
+marker('domain.record.updateFrequency.irregular')
+marker('domain.record.updateFrequency.continual')
+marker('domain.record.updateFrequency.periodic')
+
+export type UpdateFrequencyCode =
+  | 'unknown'
+  | 'notPlanned'
+  | 'asNeeded'
+  | 'irregular'
+  | 'continual'
+  | 'periodic'
+
+marker('domain.record.updateFrequency.day')
+marker('domain.record.updateFrequency.week')
+marker('domain.record.updateFrequency.month')
+marker('domain.record.updateFrequency.year')
+
+export type UpdateFrequencyCustom = {
+  updatedTimes: number // this should be an integer
+  per: 'day' | 'week' | 'month' | 'year'
+}
+export type UpdateFrequency = UpdateFrequencyCode | UpdateFrequencyCustom
+
+export type RecordKind = 'dataset' | 'service'
+
+marker('domain.record.status.completed')
+marker('domain.record.status.ongoing')
+marker('domain.record.status.under_development')
+marker('domain.record.status.deprecated')
+marker('domain.record.status.removed')
+
+export const RecordStatusValues = [
+  'completed',
+  'ongoing',
+  'under_development',
+  'deprecated',
+  'removed',
+]
+export type RecordStatus = typeof RecordStatusValues[number]
+
+export type AccessConstraintType = 'security' | 'privacy' | 'legal' | 'other'
+export interface AccessConstraint {
+  text: string
+  type: AccessConstraintType
+}
+
+export type License = {
+  text: string
+  url?: URL
+}
+
+export type SpatialRepresentationType =
+  | 'grid'
+  | 'vector'
+  | 'tin'
+  | 'table'
+  | 'point'
+
+export interface BaseRecord {
+  uniqueIdentifier: Uuid
+  ownerOrganization: Organization
+  contacts: Array<Individual>
+  title: string
+  abstract: string
+  recordCreated?: Date
+  recordUpdated: Date
+  kind: RecordKind
+  themes: Array<string> // TODO: handle codelists
+  keywords: Array<string> // TODO: handle thesaurus and id
+  accessConstraints: Array<AccessConstraint>
+  useLimitations: Array<string>
+  legalConstraints?: Array<string>
+  licenses: Array<License>
+  overviews: Array<GraphicOverview>
+  extras?: Record<string, unknown>
+  landingPage?: URL
+  updateFrequency?: UpdateFrequency
+
+  // to add: iso19139.topicCategory
+  // to add: canonical url
+  // to add: source catalog (??)
+  // to add: is open data ?
+}
+
+// TODO: handle actual codelists
+export type ServiceProtocol =
+  | 'wms'
+  | 'wfs'
+  | 'wps'
+  | 'wmts'
+  | 'esriRest'
+  | 'other'
+
+export type DatasetDistributionType = 'service' | 'download' | 'link'
+
+export interface DatasetServiceDistribution {
+  type: 'service'
+  url: URL
+  accessServiceProtocol: ServiceProtocol
+  identifierInService?: string
+  name?: string
+  description?: string
+}
+
+export interface DatasetDownloadDistribution {
+  type: 'download'
+  url: URL
+  mimeType?: string
+  sizeBytes?: number
+  // removed because what's the use? encoding can be exposed by the file server or
+  // even found out by trial and error; besides we can reasonably expect unicode or iso most of the time
+  // textEncoding?: string
+  name?: string
+  description?: string
+}
+
+export interface OnlineLinkResource {
+  type: 'link'
+  url: URL
+  name?: string
+  description?: string
+}
+
+export type DatasetDistribution = (
+  | DatasetServiceDistribution
+  | DatasetDownloadDistribution
+  | OnlineLinkResource
+) & {
+  type: DatasetDistributionType
+}
+
+export interface GraphicOverview {
+  url: URL
+  description?: string
+}
+
+export interface DatasetSpatialExtent {
+  geometry: unknown // GeoJSON
+  description?: string
+}
+
+export interface DatasetTemporalExtent {
+  start: Date
+  end: Date
+  description?: string
+}
+
+export interface DatasetRecord extends BaseRecord {
+  kind: 'dataset'
+  contactsForResource: Array<Individual>
+  status: RecordStatus
+  datasetCreated?: Date
+  datasetUpdated?: Date
+  lineage: string // Explanation of the origin of this record (e.g: how, why)"
+  distributions: Array<DatasetDistribution>
+  spatialExtents: Array<DatasetSpatialExtent> // not handled yet
+  temporalExtents: Array<DatasetTemporalExtent> // not handled yet
+  spatialRepresentation?: SpatialRepresentationType
+}
+
+export type ServiceOnlineResourceType = 'endpoint' | 'link'
+
+export interface ServiceEndpoint {
+  endpointUrl: URL
+  protocol: string
+  type: 'endpoint'
+  description?: string
+}
+
+export type ServiceOnlineResource = (ServiceEndpoint | OnlineLinkResource) & {
+  type: ServiceOnlineResourceType
+}
+
+export interface ServiceRecord extends BaseRecord {
+  kind: 'service'
+  onlineResources: Array<ServiceOnlineResource>
+}
+
+export type CatalogRecord = ServiceRecord | DatasetRecord

package/src/libs/common/domain/src/lib/record/organization.model.ts

@@ -0,0 +1,7 @@
+export interface Organization {
+  name: string
+  description?: string
+  website?: URL
+  logoUrl?: URL
+  recordCount?: number
+}

package/src/libs/common/domain/src/lib/records-repository.interface.ts

@@ -0,0 +1,22 @@
+import { Observable } from 'rxjs'
+import {
+  Aggregations,
+  AggregationsParams,
+  FieldFilters,
+  SearchParams,
+  SearchResults,
+} from './search'
+import { CatalogRecord } from './record/metadata.model'
+
+export abstract class RecordsRepositoryInterface {
+  abstract search(params: SearchParams): Observable<SearchResults>
+  abstract getMatchesCount(filters: FieldFilters): Observable<number>
+  abstract getByUniqueIdentifier(
+    uniqueIdentifier: string
+  ): Observable<CatalogRecord | null>
+  abstract aggregate(params: AggregationsParams): Observable<Aggregations>
+  abstract getSimilarRecords(
+    similarTo: CatalogRecord
+  ): Observable<CatalogRecord[]>
+  abstract fuzzySearch(query: string): Observable<SearchResults>
+}

package/src/libs/common/domain/src/lib/search/aggregation.model.ts

@@ -0,0 +1,52 @@
+import { FieldName } from './search.model'
+import { FieldFilter } from './filter.model'
+
+export interface TermsAggregationParams {
+  type: 'terms'
+  field: FieldName
+  limit: number
+  sort: AggregationSort
+  filter?: string
+}
+export interface HistogramAggregationParams {
+  type: 'histogram'
+  field: FieldName
+  interval: number
+}
+export type FilterAggregationParams = Record<string, FieldFilter> | string
+export interface FiltersAggregationParams {
+  type: 'filters'
+  filters: Record<string, FilterAggregationParams>
+}
+export type AggregationParams =
+  | TermsAggregationParams
+  | HistogramAggregationParams
+  | FiltersAggregationParams
+export type AggregationsParams = Record<FieldName, AggregationParams>
+
+export type AggregationsTypes = AggregationParams['type']
+
+export interface TermBucket {
+  term: string
+  count: number
+}
+export interface HistogramBucket {
+  lowValue: number
+  highValue: number
+  count: number
+}
+export interface FiltersBucket {
+  name: string
+  count: number
+}
+
+export type Bucket = TermBucket | HistogramBucket | FiltersBucket
+
+export type AggregationSort = ['desc' | 'asc', 'key' | 'count']
+
+export interface AggregationBuckets {
+  buckets: Bucket[]
+}
+export type AggregationCounts = Record<string, number>
+export type Aggregation = AggregationBuckets | AggregationCounts
+export type Aggregations = Record<FieldName, Aggregation>

package/src/libs/common/domain/src/lib/search/filter.model.ts

@@ -0,0 +1,6 @@
+import { FieldName } from './search.model'
+
+export type FieldFilterByValues = Record<string, boolean>
+export type FieldFilterByExpression = string | number
+export type FieldFilter = FieldFilterByExpression | FieldFilterByValues
+export type FieldFilters = Record<FieldName, FieldFilter>

package/src/libs/common/domain/src/lib/search/index.ts

@@ -0,0 +1,4 @@
+export * from './aggregation.model'
+export * from './filter.model'
+export * from './search.model'
+export * from './sort-by.model'

package/src/libs/common/domain/src/lib/search/search.model.ts

@@ -0,0 +1,22 @@
+import { FieldFilters } from './filter.model'
+import { CatalogRecord } from '../record'
+import { Geometry } from 'geojson'
+
+type FieldSort = ['desc' | 'asc', FieldName]
+export type SortByField = FieldSort | FieldSort[] // several sort criteria can be used!
+export type FieldName = string
+
+export interface SearchParams {
+  filters?: FieldFilters
+  offset: number
+  limit: number
+  sort?: SortByField
+  fields?: FieldName[]
+  filterIds?: string[]
+  filterGeometry?: Geometry
+}
+
+export interface SearchResults {
+  records: CatalogRecord[]
+  count: number
+}

package/src/libs/common/domain/src/lib/search/sort-by.model.ts

@@ -0,0 +1,8 @@
+import { SortByField } from './search.model'
+
+export const SortByEnum: Record<string, SortByField> = {
+  CREATE_DATE: ['desc', 'createDate'],
+  POPULARITY: ['desc', 'userSavedCount'],
+  RELEVANCY: ['desc', '_score'],
+  QUALITY_SCORE: ['desc', 'qualityScore'],
+}

package/src/libs/common/domain/src/lib/user.model.ts

@@ -0,0 +1,10 @@
+export interface UserModel {
+  id: string
+  profile: string
+  username: string
+  name: string
+  surname: string
+  email: string
+  organisation: string
+  profileIcon?: string
+}

package/src/libs/common/fixtures/src/index.ts

@@ -0,0 +1,11 @@
+export * from './lib/geojson.fixtures'
+export * from './lib/ol-feature.fixture'
+export * from './lib/record-link.fixtures'
+export * from './lib/link.fixtures'
+export * from './lib/records.fixtures'
+export * from './lib/organisations.fixture'
+export * from './lib/elasticsearch'
+export * from './lib/search'
+export * from './lib/user.fixtures'
+export * from './lib/repository.fixtures'
+export * from './lib/gn4'

package/src/libs/common/fixtures/src/lib/elasticsearch/aggregations-request.ts

@@ -0,0 +1,26 @@
+import { deepFreeze } from '../utils/freeze'
+
+export const ES_FIXTURE_AGGS_REQUEST = deepFreeze({
+  'tag.default': { terms: { field: 'tag.default', include: '.*', size: 10 } },
+  availableInServices: {
+    filters: {
+      filters: {
+        availableInViewService: {
+          query_string: { query: '+linkProtocol:/OGC:WMS.*/' },
+        },
+        availableInDownloadService: {
+          query_string: { query: '+linkProtocol:/OGC:WFS.*/' },
+        },
+      },
+    },
+  },
+  resolutionScaleDenominator: {
+    histogram: {
+      field: 'resolutionScaleDenominator',
+      interval: 10000,
+      keyed: true,
+      min_doc_count: 1,
+    },
+    meta: { collapsed: true },
+  },
+})

package/src/libs/common/fixtures/src/lib/elasticsearch/aggregations-response.ts

@@ -0,0 +1,79 @@
+import { deepFreeze } from '../utils/freeze'
+
+const BUCKETS = deepFreeze([
+  { key: 'Hungary', doc_count: 20 },
+  {
+    key: 'Austria',
+    doc_count: 3,
+  },
+  { key: 'Belgium', doc_count: 8 },
+  {
+    key: 'Bulgaria',
+    doc_count: 2,
+  },
+  { key: 'Croatia', doc_count: 15 },
+  {
+    key: 'Cyprus',
+    doc_count: 5,
+  },
+])
+
+export const ES_FIXTURE_AGGS_RESPONSE = deepFreeze({
+  'tag.default': {
+    doc_count_error_upper_bound: 0,
+    sum_other_doc_count: 458,
+    buckets: BUCKETS,
+  },
+  availableInServices: {
+    buckets: {
+      availableInDownloadService: { doc_count: 0 },
+      availableInViewService: { doc_count: 299 },
+    },
+  },
+  resolutionScaleDenominator: {
+    meta: { collapsed: true },
+    buckets: {
+      '0.0': { key: 0, doc_count: 2 },
+      '10000.0': { key: 10000, doc_count: 291 },
+      '20000.0': { key: 20000, doc_count: 1 },
+      '50000.0': { key: 50000, doc_count: 9 },
+      '100000.0': { key: 100000, doc_count: 135 },
+      '250000.0': { key: 250000, doc_count: 54 },
+      '1000000.0': { key: 1000000, doc_count: 55 },
+      '2000000.0': { key: 2000000, doc_count: 3 },
+      '3000000.0': { key: 3000000, doc_count: 10 },
+      '1.0E7': { key: 10000000, doc_count: 93 },
+      '2.0E7': { key: 20000000, doc_count: 9 },
+      '6.0E7': { key: 60000000, doc_count: 8 },
+    },
+  },
+  resolutionScaleDenominatorArray: {
+    meta: { collapsed: true },
+    buckets: [
+      { key: 0, doc_count: 2 },
+      { key: 10000, doc_count: 291 },
+      { key: 20000, doc_count: 1 },
+      { key: 50000, doc_count: 9 },
+      { key: 100000, doc_count: 135 },
+      { key: 250000, doc_count: 54 },
+      { key: 1000000, doc_count: 55 },
+      { key: 2000000, doc_count: 3 },
+      { key: 3000000, doc_count: 10 },
+      { key: 10000000, doc_count: 93 },
+      { key: 20000000, doc_count: 9 },
+      { key: 60000000, doc_count: 8 },
+    ],
+  },
+})
+
+export const ES_FIXTURE_AGGS_RESPONSE_MORE = deepFreeze({
+  'tag.default': {
+    doc_count_error_upper_bound: 0,
+    sum_other_doc_count: 456,
+    buckets: [
+      ...BUCKETS,
+      { key: 'Spain', doc_count: 86 },
+      { key: 'United Kingdom', doc_count: 84 },
+    ],
+  },
+})