feat: add skos and jsonld utils

built-types/index.d.ts

@@ -8,6 +8,9 @@ import { getHerokuReleaseInfo } from "./herokuUtils";
 import { Lenses } from "./lenses";
 import { recursivelyRemoveAtSigns } from "./openActiveUtils";
 import { recursivelySetAtSigns } from "./openActiveUtils";
+import { httpFetchJsonld } from "./jsonLdUtils";
+import { getConceptSchemeFromFilePath } from "./skosUtils";
+import { getConceptSchemeFromUrl } from "./skosUtils";
 export declare namespace expressUtils {
     export { validateReq };
     export { validateReqQuery };
@@ -19,4 +22,11 @@ export declare namespace openActiveUtils {
     export { recursivelyRemoveAtSigns };
     export { recursivelySetAtSigns };
 }
+export declare namespace jsonLdUtils {
+    export { httpFetchJsonld };
+}
+export declare namespace skosUtils {
+    export { getConceptSchemeFromFilePath };
+    export { getConceptSchemeFromUrl };
+}
 export { logger, kongSecretMiddleware, postgres, syncDbMigrations, Lenses };

built-types/jsonLdUtils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @param {string} url
+ */
+export function httpFetchJsonld(url: string): Promise<any>;

built-types/lenses.d.ts

@@ -19,6 +19,7 @@ export namespace Lenses {
     let aggregateOffer: R.Lens<TOpportunity, any>;
     let remainingCapacity: import('ramda').Lens<TOpportunity, number>;
     let maxCapacity: import('ramda').Lens<TOpportunity, number>;
+    let iminTag: import('ramda').Lens<TOpportunity, Array<string>>;
     namespace util {
         let throwErrorIfUsed: import('ramda').Lens<any, any>;
     }

built-types/skosUtils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @param {string} url
+ * @returns {Promise<import('./types/skos').ConceptScheme>}
+ */
+export function getConceptSchemeFromUrl(url: string): Promise<import('./types/skos').ConceptScheme>;
+/**
+ * @param {string} jsonLdFilePath
+ * @returns {Promise<import('./types/skos').ConceptScheme>}
+ */
+export function getConceptSchemeFromFilePath(jsonLdFilePath: string): Promise<import('./types/skos').ConceptScheme>;

built-types/types/skos.d.ts

@@ -0,0 +1,34 @@
+// We should give this to OpenActive when finished.
+
+export class Concept {
+  constructor();
+  id: string;
+  prefLabel: string;
+  type?: string;
+  activity?: string[];
+  getNarrower: () => Concept[];
+  getNarrowerTransitive: () => Concept[];
+  getBroader: () => Concept[];
+  getBroaderTransitive: () => Concept[];
+  getRelated: () => Concept[];
+  equals: (concept: Concept) => Boolean;
+  toString: () => string;
+  getJSON: () => Object;
+  static compare: (a: Concept, b: Concept) => Number;
+}
+export class ConceptScheme {
+  constructor(
+    scheme: Object | Array<Object>,
+    id?: string,
+    filter?: Object | Array<Object>
+  );
+  getConceptByID: (id: string) => Concept | null;
+  getConceptByLabel: (label: string) => Concept | null;
+  getAllConcepts: () => Concept[];
+  getAllConceptsByID: () => Concept[];
+  getAllConceptsByLabel: () => Concept[];
+  getTopConcepts: () => Concept[];
+  getJSON: () => Object;
+  toString: () => string;
+  generateSubset: (filter: Object | Array<Object>) => ConceptScheme;
+}