ckan: more precise types

zazuko · Feb 5, 2024 · accb0e3 · accb0e3
1 parent 3cab541
commit accb0e3
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 8 deletions.
diff --git a/packages/ckan/src/ckan.js b/packages/ckan/src/ckan.js
@@ -3,14 +3,14 @@ import ParsingClient from 'sparql-http-client/ParsingClient.js'
 import { toXML } from './xml.js'
 import { datasetsQuery } from './query.js'
 
-export function createAPI (config) {
+export const createAPI = (config) => {
   const client = new ParsingClient({
     endpointUrl: config.endpointUrl,
     user: config.user,
     password: config.password,
   })
 
-  async function fetchDatasets (organizationId) {
+  const fetchDatasets = async (organizationId) => {
     const query = datasetsQuery(organizationId)
     return await client.query.construct(query.toString())
   }

diff --git a/packages/ckan/src/query.js b/packages/ckan/src/query.js
@@ -2,7 +2,13 @@
 import { sparql } from '@tpluscode/rdf-string'
 import * as ns from './namespace.js'
 
-function datasetsQuery (organizationId) {
+/**
+ * Query to retrieve all datasets for a given organization.
+ *
+ * @param {string} organizationId The organization identifier.
+ * @returns {import('@tpluscode/rdf-string').SparqlTemplateResult}
+ */
+const datasetsQuery = (organizationId) => {
   return sparql`
     CONSTRUCT {
       ?dataset ?p ?o .

diff --git a/packages/ckan/src/xml.js b/packages/ckan/src/xml.js
@@ -138,6 +138,12 @@ const serializeTerm = (pointer) => {
   })
 }
 
+/**
+ * Serialize a literal.
+ *
+ * @param {import('clownface').MultiPointer} pointer Pointer to serialize.
+ * @return {Record<string, unknown>} Serialized literal.
+ */
 const serializeLiteral = (pointer) => {
   if (!isLiteral(pointer)) return null
 
@@ -158,6 +164,12 @@ const serializeLiteral = (pointer) => {
   }
 }
 
+/**
+ * Serialize a named node.
+ *
+ * @param {import('clownface').MultiPointer} pointer Pointer to serialize.
+ * @return {Record<string, unknown>} Serialized named node.
+ */
 const serializeNamedNode = (pointer) => {
   if (!isNamedNode(pointer)) return null
 
@@ -167,10 +179,11 @@ const serializeNamedNode = (pointer) => {
 }
 
 /**
+ * Serialize a blank node.
  *
- * @param {import('clownface').MultiPointer} pointer
- * @param {Array<import('@rdfjs/types').NamedNode>} [allowedTypesArr]
- * @return {Record<string, unknown>}
+ * @param {import('clownface').MultiPointer} pointer Pointer to serialize.
+ * @param {Array<import('@rdfjs/types').NamedNode>} [allowedTypesArr] Allowed types for the blank node.
+ * @return {Record<string, unknown>} Serialized blank node.
  */
 const serializeBlankNode = (pointer, allowedTypesArr = []) => {
   if (!isBlankNode(pointer)) return null
@@ -193,10 +206,15 @@ const serializeBlankNode = (pointer, allowedTypesArr = []) => {
   }
 }
 
+/**
+ * Convert encoding format to distribution format.
+ *
+ * @param {import('clownface').MultiPointer} encodingPointer Pointer to encoding format.
+ * @return {string} Distribution format.
+ */
 const distributionFormatFromEncoding = (encodingPointer) => {
   const encoding = encodingPointer.values[0] || ''
 
-  /* eslint-disable indent */
   switch (encoding) {
     case 'text/html': {
       return 'HTML'
@@ -208,7 +226,6 @@ const distributionFormatFromEncoding = (encodingPointer) => {
       return 'UNKNOWN'
     }
   }
-  /* eslint-enable indent */
 }
 
 /**