@elastic-suite/gally-admin-shared/src/types/hydra.ts

Shared package for gally admin BO

import { Method } from './network'
import {
  IJsonldBase,
  IJsonldBoolean,
  IJsonldContext,
  IJsonldId,
  IJsonldNumber,
  IJsonldRange,
  IJsonldString,
  IJsonldType,
} from './jsonld'
import { IOptions } from './option'
import { IHydraSimpleCatalog } from './catalog'
import { IFieldDepends, IFieldGuesserProps } from './field'

export enum HydraType {
  ARRAY = 'array',
  BOOLEAN = 'boolean',
  INTEGER = 'integer',
  OBJECT = 'object',
  STRING = 'string',
}

export interface IHydraPropertyTypeRef {
  $ref?: string
}

export interface IHydraPropertyTypeArray {
  type: HydraType.ARRAY
  items: HydraPropertyType
}

export interface IHydraPropertyTypeBoolean {
  type: HydraType.BOOLEAN
}

export interface IHydraPropertyTypeInteger {
  type: HydraType.INTEGER
  default?: number
  minimum?: number
  maximum?: number
}

export interface IHydraPropertyTypeObject {
  type: HydraType.OBJECT
  properties: Record<string, HydraPropertyType>
  required?: string[]
}

export interface IHydraPropertyTypeString {
  type: HydraType.STRING
  format?: string
  nullable?: boolean
}

export type HydraPropertyType =
  | IHydraPropertyTypeRef
  | IHydraPropertyTypeArray
  | IHydraPropertyTypeBoolean
  | IHydraPropertyTypeInteger
  | IHydraPropertyTypeObject
  | IHydraPropertyTypeString

export interface IOwlEquivalentClass {
  'owl:onProperty': IJsonldId
  'owl:allValuesFrom': IJsonldId
}

export interface IRdfsRange {
  'owl:equivalentClass': IOwlEquivalentClass
}

export interface IHydraSupportedOperation extends IJsonldType {
  expects?: string
  'hydra:method': Method
  'hydra:title'?: string
  'rdfs:label': string
  returns: string
}

export interface IHydraProperty extends IJsonldBase {
  domain: string
  'hydra:supportedOperation'?:
    | IHydraSupportedOperation
    | IHydraSupportedOperation[]
  'owl:maxCardinality'?: number
  range?: string
  'rdfs:label': string
  'rdfs:range'?: (IJsonldId | IRdfsRange)[]
}

export interface IDependsForm {
  field?: string
  value?: string
}

export interface IInputDependencies {
  field: string
  value: string
  input: string
  jsonKeyValue: string
  fieldProps: IFieldGuesserProps
}
export interface IMultipleInputConfiguration {
  inputDependencies: IInputDependencies[]
}

export interface IMultipleValueFormat {
  separator?: string
  maxCount?: number
}

export interface IGallyProperty {
  context?: Record<string, IGallyProperty>
  depends?: IFieldDepends
  editable?: boolean
  input?: string
  options?: IDropdownOptions & (IDropdownStaticOptions | IDropdownApiOptions)
  position?: number
  required?: boolean
  type?: string
  validation?: Record<string, string | number | boolean>
  visible?: boolean
  alias?: string
  multipleValueFormat?: IMultipleValueFormat
  fieldset?: string
  rangeDateType?: string
  rangeDateId?: number | string
  requestTypeConfigurations?: Record<string, string>
  form?: IGallyProperty
  grid?: IGallyProperty
  infoTooltip?: string
  multipleInputConfiguration?: IMultipleInputConfiguration
  placeholder?: string
  defaultValue?: unknown
  showError?: boolean
  gridHeaderInfoTooltip?: string
}
export interface IDropdownOptions {
  objectKeyValue?: string
}

export interface IDropdownStaticOptions {
  values: IOptions<string>
}

export interface IDropdownApiOptions {
  api_rest: string
  api_graphql: string
}

export interface IHydraSupportedProperty extends IJsonldType {
  'hydra:description'?: string
  'hydra:property': IHydraProperty
  'hydra:readable': boolean
  'hydra:required'?: boolean
  'hydra:title': string
  'hydra:writeable': boolean
  gally?: IGallyProperty
}

export interface IHydraSupportedClass extends IJsonldBase {
  'hydra:description'?: string
  'hydra:supportedOperation'?:
    | IHydraSupportedOperation
    | IHydraSupportedOperation[]
  'hydra:supportedProperty': IHydraSupportedProperty[]
  'hydra:title': string
  'rdfs:label'?: string
  subClassOf?: string
}

export interface IHydraMember extends IJsonldBase {
  id: number | string
}

export interface IHydraLabelMember extends IHydraMember {
  localizedCatalog: IHydraSimpleCatalog
  label: string
}

export interface IHydraTrace {
  args: [string, unknown][]
  class: string
  file: string
  function: string
  line: number
  namespace: string
  short_class: string
  type: string
}

export interface IHydraError extends IJsonldType, IJsonldContext {
  '@context': '/contexts/Error'
  '@type': 'hydra:Error'
  'hydra:description': string
  'hydra:title': string
  trace: IHydraTrace[]
}

export interface IHydraMapping extends IJsonldType {
  variable: string
  property: string
  required: boolean
}

export interface IHydraSearch extends IJsonldType {
  'hydra:mapping': IHydraMapping[]
  'hydra:template': string
  'hydra:variableRepresentation': string
}

export interface IHydraResponse<Member>
  extends IJsonldContext,
    IJsonldType,
    IJsonldId {
  'hydra:member': Member[]
  'hydra:search'?: IHydraSearch
  'hydra:totalItems': number
}

export interface IExpandedHydraSupportedOperation extends IJsonldType {
  'http://www.w3.org/2000/01/rdf-schema#label': [IJsonldString]
  'http://www.w3.org/ns/hydra/core#expects'?: [IJsonldString]
  'http://www.w3.org/ns/hydra/core#method': [IJsonldString]
  'http://www.w3.org/ns/hydra/core#returns': [IJsonldId]
  'http://www.w3.org/ns/hydra/core#title'?: [IJsonldString]
}

export interface IExpandedHydraProperty extends IJsonldBase {
  'http://www.w3.org/2000/01/rdf-schema#domain': [IJsonldId]
  'http://www.w3.org/2000/01/rdf-schema#label': [IJsonldString]
  'http://www.w3.org/2000/01/rdf-schema#range':
    | [IJsonldId]
    | [IJsonldId, IJsonldRange]
  'http://www.w3.org/2002/07/owl#maxCardinality'?: [IJsonldNumber]
  'http://www.w3.org/ns/hydra/core#supportedOperation'?: IExpandedHydraSupportedOperation[]
}

export interface IExpandedGallyProperty {
  'https://localhost/docs.jsonld#editable'?: [IJsonldBoolean]
  'https://localhost/docs.jsonld#position'?: [IJsonldNumber]
  'https://localhost/docs.jsonld#visible'?: [IJsonldBoolean]
  'https://localhost/docs.jsonld#context'?: [
    Record<string, [IExpandedGallyProperty]>
  ]
}

export interface IExpandedHydraSupportedProperty extends IJsonldType {
  'http://www.w3.org/ns/hydra/core#property': IExpandedHydraProperty[]
  'http://www.w3.org/ns/hydra/core#readable': [IJsonldBoolean]
  'http://www.w3.org/ns/hydra/core#required'?: [IJsonldBoolean]
  'http://www.w3.org/ns/hydra/core#title': [IJsonldString]
  'http://www.w3.org/ns/hydra/core#writeable': [IJsonldBoolean]
  'https://localhost/docs.jsonld#gally'?: IExpandedGallyProperty
}

export interface IExpandedHydraSupportedClass extends IJsonldBase {
  'http://www.w3.org/2000/01/rdf-schema#label'?: [IJsonldString]
  'http://www.w3.org/ns/hydra/core#supportedOperation': IExpandedHydraSupportedOperation[]
  'http://www.w3.org/ns/hydra/core#supportedProperty': IExpandedHydraSupportedProperty[]
  'http://www.w3.org/ns/hydra/core#title': [IJsonldString]
}