index.ts

/**
 * SSHOC Marketplace API
 *
 * Social Sciences and Humanities Open Cloud Marketplace
 *
 * License: Apache 2.0
 * Version: 0.1.1
 */

/* eslint-disable @typescript-eslint/no-namespace */

import type {
  UseMutationOptions,
  UseMutationResult,
  UseQueryOptions,
  UseQueryResult,
} from 'react-query'
import { useMutation, useQuery } from 'react-query'

export type LicenseTypeDto = {
  code?: string
  label?: string
}

export type ItemRelationDto = {
  code?: string
  label?: string
}

export type ItemRelationId = {
  code?: string
}

export type ItemBasicDto = {
  id?: number /* int64 */
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  version?: string
  persistentId?: string
}

export type ItemRelatedItemDto = {
  subject?: ItemBasicDto
  object?: ItemBasicDto
  relation?: ItemRelationDto
}

export type ActorDto = {
  id?: number /* int64 */
  name?: string
  externalIds?: Array<ActorExternalIdDto>
  website?: string
  email?: string
  affiliations?: Array<ActorDto>
}

export type ActorExternalIdDto = {
  identifierService?: ActorSourceDto
  identifier?: string
}

export type ActorSourceDto = {
  code?: string
  label?: string
}

export type PaginatedActors = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  actors?: Array<ActorDto>
}

export type ActorCore = {
  name?: string
  externalIds?: Array<ActorExternalIdCore>
  website?: string
  email?: string
  affiliations?: Array<ActorId>
}

export type ActorExternalIdCore = {
  identifierService: ActorSourceId
  identifier: string
}

export type ActorId = {
  id?: number /* int64 */
}

export type ActorSourceId = {
  code?: string
}

export type ActorRoleDto = {
  code?: string
  label?: string
}

export type ConceptBasicDto = {
  code?: string
  vocabulary?: VocabularyBasicDto
  label?: string
  notation?: string
  definition?: string
  uri?: string
}

export type ItemContributorDto = {
  actor?: ActorDto
  role?: ActorRoleDto
}

export type ItemExternalIdDto = {
  identifierService?: ItemSourceDto
  identifier?: string
}

export type ItemMediaDto = {
  info?: MediaDetails
  caption?: string
}

export type ItemSourceDto = {
  code?: string
  label?: string
}

export type ItemThumbnailId = {
  mediaId?: string /* uuid */
}

export type LicenseDto = {
  code?: string
  label?: string
  types?: Array<LicenseTypeDto>
  accessibleAt?: string
}

export type MediaDetails = {
  mediaId?: string /* uuid */
  category?: 'image' | 'video' | 'object' | 'thumbnail'
  location?: MediaLocation
  filename?: string
  mimeType?: string
  hasThumbnail?: boolean
}

export type MediaLocation = {
  sourceUrl?: string /* url */
}

export type PaginatedWorkflows = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  workflows?: Array<WorkflowDto>
}

export type PropertyDto = {
  id?: number /* int64 */
  type?: PropertyTypeDto
  value?: string
  concept?: ConceptBasicDto
}

export type PropertyTypeDto = {
  code?: string
  label?: string
  type?: 'concept' | 'string' | 'url' | 'int' | 'float' | 'date'
  groupName?: string
  hidden?: boolean
  ord?: number /* int32 */
  allowedVocabularies?: Array<VocabularyBasicDto>
}

export type RelatedItemDto = {
  id?: number /* int64 */
  persistentId?: string
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  description?: string
  relation?: ItemRelationDto
}

export type SourceBasicDto = {
  id?: number /* int64 */
  label?: string
  url?: string
  urlTemplate?: string
}

export type StepDto = {
  id?: number /* int64 */
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  version?: string
  persistentId?: string
  description?: string
  licenses?: Array<LicenseDto>
  contributors?: Array<ItemContributorDto>
  properties?: Array<PropertyDto>
  externalIds?: Array<ItemExternalIdDto>
  accessibleAt?: Array<string>
  source?: SourceBasicDto
  sourceItemId?: string
  relatedItems?: Array<RelatedItemDto>
  media?: Array<ItemMediaDto>
  thumbnail?: ItemThumbnailId
  informationContributor?: UserDto
  lastInfoUpdate?: string
  status?:
    | 'draft'
    | 'ingested'
    | 'suggested'
    | 'approved'
    | 'disapproved'
    | 'deprecated'
  olderVersions?: Array<ItemBasicDto>
  newerVersions?: Array<ItemBasicDto>
}

export type UserDto = {
  id?: number /* int64 */
  username?: string
  displayName?: string
  status?: 'during-registration' | 'enabled' | 'locked'
  registrationDate?: string
  role?: 'contributor' | 'system-contributor' | 'moderator' | 'administrator'
  email?: string
}

export type VocabularyBasicDto = {
  code?: string
  label?: string
  accessibleAt?: string
}

export type WorkflowDto = {
  id?: number /* int64 */
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  version?: string
  persistentId?: string
  description?: string
  licenses?: Array<LicenseDto>
  contributors?: Array<ItemContributorDto>
  properties?: Array<PropertyDto>
  externalIds?: Array<ItemExternalIdDto>
  accessibleAt?: Array<string>
  source?: SourceBasicDto
  sourceItemId?: string
  relatedItems?: Array<RelatedItemDto>
  media?: Array<ItemMediaDto>
  thumbnail?: ItemThumbnailId
  informationContributor?: UserDto
  lastInfoUpdate?: string
  status?:
    | 'draft'
    | 'ingested'
    | 'suggested'
    | 'approved'
    | 'disapproved'
    | 'deprecated'
  olderVersions?: Array<ItemBasicDto>
  newerVersions?: Array<ItemBasicDto>
  composedOf?: Array<StepDto>
}

export type ActorRoleId = {
  code?: string
}

export type ConceptId = {
  code?: string
  vocabulary?: VocabularyId
  uri?: string
}

export type ItemContributorId = {
  actor?: ActorId
  role?: ActorRoleId
}

export type ItemExternalIdCore = {
  identifierService: ItemExternalIdId
  identifier: string
}

export type ItemExternalIdId = {
  code?: string
}

export type ItemMediaCore = {
  info?: MediaDetailsId
  caption?: string
}

export type LicenseId = {
  code?: string
}

export type MediaDetailsId = {
  mediaId?: string /* uuid */
}

export type PropertyCore = {
  type?: PropertyTypeId
  value?: string
  concept?: ConceptId
}

export type PropertyTypeId = {
  code?: string
}

export type RelatedItemCore = {
  persistentId?: string
  relation?: ItemRelationId
}

export type SourceId = {
  id?: number /* int64 */
}

export type StepCore = {
  label?: string
  version?: string
  description?: string
  licenses?: Array<LicenseId>
  contributors?: Array<ItemContributorId>
  externalIds?: Array<ItemExternalIdCore>
  properties?: Array<PropertyCore>
  relatedItems?: Array<RelatedItemCore>
  media?: Array<ItemMediaCore>
  thumbnail?: ItemThumbnailId
  accessibleAt?: Array<string>
  source?: SourceId
  sourceItemId?: string
  stepNo?: number /* int32 */
}

export type VocabularyId = {
  code?: string
}

export type WorkflowCore = {
  label?: string
  version?: string
  description?: string
  licenses?: Array<LicenseId>
  contributors?: Array<ItemContributorId>
  externalIds?: Array<ItemExternalIdCore>
  properties?: Array<PropertyCore>
  relatedItems?: Array<RelatedItemCore>
  media?: Array<ItemMediaCore>
  thumbnail?: ItemThumbnailId
  accessibleAt?: Array<string>
  source?: SourceId
  sourceItemId?: string
}

export type OAuthRegistrationData = {
  id?: number /* int64 */
  displayName?: string
  email?: string
  acceptedRegulations?: boolean
}

export type ConceptRelationDto = {
  code?: string
  label?: string
}

export type PaginatedLicenses = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  licenses?: Array<LicenseDto>
}

export type ItemSourceCore = {
  code?: string
  label: string
  ord?: number /* int32 */
}

export type PublicationDto = {
  id?: number /* int64 */
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  version?: string
  persistentId?: string
  description?: string
  licenses?: Array<LicenseDto>
  contributors?: Array<ItemContributorDto>
  properties?: Array<PropertyDto>
  externalIds?: Array<ItemExternalIdDto>
  accessibleAt?: Array<string>
  source?: SourceBasicDto
  sourceItemId?: string
  relatedItems?: Array<RelatedItemDto>
  media?: Array<ItemMediaDto>
  thumbnail?: ItemThumbnailId
  informationContributor?: UserDto
  lastInfoUpdate?: string
  status?:
    | 'draft'
    | 'ingested'
    | 'suggested'
    | 'approved'
    | 'disapproved'
    | 'deprecated'
  olderVersions?: Array<ItemBasicDto>
  newerVersions?: Array<ItemBasicDto>
  dateCreated?: string
  dateLastUpdated?: string
}

export type PublicationCore = {
  label?: string
  version?: string
  description?: string
  licenses?: Array<LicenseId>
  contributors?: Array<ItemContributorId>
  externalIds?: Array<ItemExternalIdCore>
  properties?: Array<PropertyCore>
  relatedItems?: Array<RelatedItemCore>
  media?: Array<ItemMediaCore>
  thumbnail?: ItemThumbnailId
  accessibleAt?: Array<string>
  source?: SourceId
  sourceItemId?: string
  dateCreated?: string
  dateLastUpdated?: string
}

export type PaginatedPublications = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  publications?: Array<PublicationDto>
}

export type ActorRoleCore = {
  code?: string
  label: string
  ord?: number /* int32 */
}

export type PaginatedSources = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  sources?: Array<SourceDto>
}

export type SourceDto = {
  id?: number /* int64 */
  label?: string
  url?: string
  urlTemplate?: string
  lastHarvestedDate?: string
}

export type SourceCore = {
  label?: string
  url?: string
  urlTemplate?: string
}

export type ToolCore = {
  label?: string
  version?: string
  description?: string
  licenses?: Array<LicenseId>
  contributors?: Array<ItemContributorId>
  externalIds?: Array<ItemExternalIdCore>
  properties?: Array<PropertyCore>
  relatedItems?: Array<RelatedItemCore>
  media?: Array<ItemMediaCore>
  thumbnail?: ItemThumbnailId
  accessibleAt?: Array<string>
  source?: SourceId
  sourceItemId?: string
}

export type ToolDto = {
  id?: number /* int64 */
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  version?: string
  persistentId?: string
  description?: string
  licenses?: Array<LicenseDto>
  contributors?: Array<ItemContributorDto>
  properties?: Array<PropertyDto>
  externalIds?: Array<ItemExternalIdDto>
  accessibleAt?: Array<string>
  source?: SourceBasicDto
  sourceItemId?: string
  relatedItems?: Array<RelatedItemDto>
  media?: Array<ItemMediaDto>
  thumbnail?: ItemThumbnailId
  informationContributor?: UserDto
  lastInfoUpdate?: string
  status?:
    | 'draft'
    | 'ingested'
    | 'suggested'
    | 'approved'
    | 'disapproved'
    | 'deprecated'
  olderVersions?: Array<ItemBasicDto>
  newerVersions?: Array<ItemBasicDto>
}

export type PaginatedTools = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  tools?: Array<ToolDto>
}

export type CountedPropertyType = {
  code?: string
  label?: string
  count?: number /* int64 */
  checked?: boolean
}

export type PaginatedSearchConcepts = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  q?: string
  concepts?: Array<SearchConcept>
  types?: Record<string, CountedPropertyType>
}

export type SearchConcept = {
  code?: string
  vocabulary?: VocabularyId
  label?: string
  notation?: string
  definition?: string
  uri?: string
  types?: Array<PropertyTypeId>
}

export type CheckedCount = {
  count?: number /* int64 */
  checked?: boolean
}

export type LabeledCheckedCount = {
  count?: number /* int64 */
  checked?: boolean
  label?: string
}

export type PaginatedSearchItems = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  q?: string
  order?: Array<'score' | 'label' | 'modified-on'>
  items?: Array<SearchItem>
  categories?: Record<string, LabeledCheckedCount>
  facets?: Record<string, Record<string, CheckedCount>>
}

export type SearchItem = {
  id?: number /* int64 */
  persistentId?: string
  label?: string
  description?: string
  contributors?: Array<ItemContributorDto>
  properties?: Array<PropertyDto>
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  status?:
    | 'draft'
    | 'ingested'
    | 'suggested'
    | 'approved'
    | 'disapproved'
    | 'deprecated'
  owner?: string
}

export type SuggestedSearchPhrases = {
  phrase?: string
  suggestions?: Array<string>
}

export type ItemCommentCore = {
  body?: string
}

export type ItemCommentDto = {
  id?: number /* int64 */
  body?: string
  creator?: UserDto
  dateCreated?: string
  dateLastUpdated?: string
}

export type PaginatedPropertyTypes = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  propertyTypes?: Array<PropertyTypeDto>
}

export type PropertyTypeCore = {
  code?: string
  label?: string
  type?: 'concept' | 'string' | 'url' | 'int' | 'float' | 'date'
  groupName?: string
  hidden?: boolean
  ord?: number /* int32 */
  allowedVocabularies?: Array<string>
}

export type PropertyTypeReorder = {
  code: string
  ord?: number /* int32 */
}

export type PropertyTypesReordering = {
  shifts: Array<PropertyTypeReorder>
}

export type Resource = {
  open?: boolean
  file?: string /* binary */
  url?: string /* url */
  readable?: boolean
  uri?: string /* uri */
  filename?: string
  description?: string
  inputStream?: {}
}

export type MediaUploadInfo = {
  mediaId?: string /* uuid */
  filename?: string
  mimeType?: string
  nextChunkNo?: number /* int32 */
}

export type LoginData = {
  username?: string
  password?: string
}

export type PaginatedUsers = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  users?: Array<UserDto>
}

export type ActorSourceCore = {
  code?: string
  label: string
  ord?: number /* int32 */
}

export type MediaSourceDto = {
  code?: string
  serviceUrl?: string
  mediaCategory?: 'image' | 'video' | 'object' | 'thumbnail'
}

export type MediaSourceCore = {
  code?: string
  serviceUrl?: string
  mediaCategory?: 'image' | 'video' | 'object' | 'thumbnail'
  ord?: number /* int32 */
}

export type ImplicitGrantTokenData = {
  token?: string
  registration?: boolean
}

export type OAuthRegistrationDto = {
  id?: number /* int64 */
  displayName?: string
  email?: string
}

export type DatasetDto = {
  id?: number /* int64 */
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  version?: string
  persistentId?: string
  description?: string
  licenses?: Array<LicenseDto>
  contributors?: Array<ItemContributorDto>
  properties?: Array<PropertyDto>
  externalIds?: Array<ItemExternalIdDto>
  accessibleAt?: Array<string>
  source?: SourceBasicDto
  sourceItemId?: string
  relatedItems?: Array<RelatedItemDto>
  media?: Array<ItemMediaDto>
  thumbnail?: ItemThumbnailId
  informationContributor?: UserDto
  lastInfoUpdate?: string
  status?:
    | 'draft'
    | 'ingested'
    | 'suggested'
    | 'approved'
    | 'disapproved'
    | 'deprecated'
  olderVersions?: Array<ItemBasicDto>
  newerVersions?: Array<ItemBasicDto>
  dateCreated?: string
  dateLastUpdated?: string
}

export type DatasetCore = {
  label?: string
  version?: string
  description?: string
  licenses?: Array<LicenseId>
  contributors?: Array<ItemContributorId>
  externalIds?: Array<ItemExternalIdCore>
  properties?: Array<PropertyCore>
  relatedItems?: Array<RelatedItemCore>
  media?: Array<ItemMediaCore>
  thumbnail?: ItemThumbnailId
  accessibleAt?: Array<string>
  source?: SourceId
  sourceItemId?: string
  dateCreated?: string
  dateLastUpdated?: string
}

export type PaginatedDatasets = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  datasets?: Array<DatasetDto>
}

export type TrainingMaterialDto = {
  id?: number /* int64 */
  category?:
    | 'tool-or-service'
    | 'training-material'
    | 'publication'
    | 'dataset'
    | 'workflow'
    | 'step'
  label?: string
  version?: string
  persistentId?: string
  description?: string
  licenses?: Array<LicenseDto>
  contributors?: Array<ItemContributorDto>
  properties?: Array<PropertyDto>
  externalIds?: Array<ItemExternalIdDto>
  accessibleAt?: Array<string>
  source?: SourceBasicDto
  sourceItemId?: string
  relatedItems?: Array<RelatedItemDto>
  media?: Array<ItemMediaDto>
  thumbnail?: ItemThumbnailId
  informationContributor?: UserDto
  lastInfoUpdate?: string
  status?:
    | 'draft'
    | 'ingested'
    | 'suggested'
    | 'approved'
    | 'disapproved'
    | 'deprecated'
  olderVersions?: Array<ItemBasicDto>
  newerVersions?: Array<ItemBasicDto>
  dateCreated?: string
  dateLastUpdated?: string
}

export type TrainingMaterialCore = {
  label?: string
  version?: string
  description?: string
  licenses?: Array<LicenseId>
  contributors?: Array<ItemContributorId>
  externalIds?: Array<ItemExternalIdCore>
  properties?: Array<PropertyCore>
  relatedItems?: Array<RelatedItemCore>
  media?: Array<ItemMediaCore>
  thumbnail?: ItemThumbnailId
  accessibleAt?: Array<string>
  source?: SourceId
  sourceItemId?: string
  dateCreated?: string
  dateLastUpdated?: string
}

export type PaginatedTrainingMaterials = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  trainingMaterials?: Array<TrainingMaterialDto>
}

export type PaginatedVocabularies = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  vocabularies?: Array<VocabularyBasicDto>
}

export type ConceptDto = {
  code?: string
  vocabulary?: VocabularyBasicDto
  label?: string
  notation?: string
  definition?: string
  uri?: string
  relatedConcepts?: Array<RelatedConceptDto>
}

export type PaginatedConcepts = {
  hits?: number /* int64 */
  count?: number /* int32 */
  page?: number /* int32 */
  perpage?: number /* int32 */
  pages?: number /* int32 */
  concepts?: Array<ConceptDto>
}

export type RelatedConceptDto = {
  code?: string
  vocabulary?: VocabularyBasicDto
  label?: string
  notation?: string
  definition?: string
  uri?: string
  relation?: ConceptRelationDto
}

export type VocabularyDto = {
  code?: string
  label?: string
  accessibleAt?: string
  description?: string
  conceptResults?: PaginatedConcepts
}

const defaultBaseUrl =
  process.env.SSHOC_API_BASE_URL ?? process.env.NEXT_PUBLIC_SSHOC_API_BASE_URL

export { defaultBaseUrl as baseUrl }

export class HttpError extends Error {
  response: Response
  statusCode: number

  constructor(response: Response, message?: string) {
    super((message ?? response.statusText) || 'Unexpected HTTP error.')
    this.name = 'HttpError'
    this.response = response
    this.statusCode = response.status
  }
}

function createUrl(
  path: string,
  baseUrl = defaultBaseUrl,
  query: Record<string, unknown> = {},
) {
  const url = new URL(path, baseUrl)
  Object.entries(query).forEach(([key, value]) => {
    if (Array.isArray(value)) {
      value.forEach((v) => {
        if (v != null) {
          url.searchParams.append(key, String(v))
        }
      })
    } else if (value != null) {
      url.searchParams.set(key, String(value))
    }
  })
  return url.toString()
}

type RequestOptions<T> = {
  hooks?: {
    request?: (request: Request) => Request
    response?: (response: Response) => Promise<T>
  }
  token?: string
}
export async function request<T = unknown>({
  path,
  baseUrl,
  query,
  options,
  hooks = {},
  token,
  returnType = 'json',
}: {
  path: string
  baseUrl?: string
  query?: Record<string, unknown>
  options?: RequestInit
  hooks?: RequestOptions<T>['hooks']
  token?: RequestOptions<T>['token']
  returnType?: 'json'
}): Promise<T> {
  const url = createUrl(path, baseUrl, query)
  const req = new Request(url, options)
  const request = typeof hooks.request === 'function' ? hooks.request(req) : req
  if (token !== undefined && token.length > 0) {
    request.headers.set('Authorization', token)
  }
  const response = await fetch(request)
  if (!response.ok) {