[DO NOT MERGE] Credential Engine launch

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

backend/.env-sample

@@ -0,0 +1,2 @@
+CE_AUTH_TOKEN = { CE_AUTH_TOKEN }
+CE_ENVIRONMENT = { CE_ENVIRONMENT_TOKEN }

backend/package.json

@@ -70,6 +70,7 @@
     "fs-extra": "^11.1.0",
     "good-fences": "^1.1.2",
     "jest": "^29.3.1",
+    "jest-mock-axios": "^4.7.3",
     "prettier": "^3.0.0",
     "supertest": "^7.0.0",
     "ts-jest": "^29.0.3",

backend/src/app.ts

@@ -9,7 +9,6 @@ import { routerFactory } from "./routes/router";
 import emailSubmissionRouter from './routes/emailRoutes';
 import contentfulRouter from './contentful/index';
 import { PostgresDataClient } from "./database/data/PostgresDataClient";
-import { PostgresSearchClient } from "./database/search/PostgresSearchClient";
 import { findTrainingsByFactory } from "./domain/training/findTrainingsBy";
 import { searchTrainingsFactory } from "./domain/search/searchTrainings";
 import { getInDemandOccupationsFactory } from "./domain/occupations/getInDemandOccupations";
@@ -18,6 +17,7 @@ import { OnetClient } from "./oNET/OnetClient";
 import { getEducationTextFactory } from "./domain/occupations/getEducationText";
 import { getSalaryEstimateFactory } from "./domain/occupations/getSalaryEstimate";
 import { CareerOneStopClient } from "./careeronestop/CareerOneStopClient";
+import { credentialEngineFactory } from "./domain/credentialengine/CredentialEngineFactory";
 import {getOccupationDetailByCIPFactory} from "./domain/occupations/getOccupationDetailByCIP";
 
 dotenv.config();
@@ -160,11 +160,10 @@ if (!isCI) {
 }
 
 const postgresDataClient = new PostgresDataClient(connection);
-const postgresSearchClient = new PostgresSearchClient(connection);
 const findTrainingsBy = findTrainingsByFactory(postgresDataClient);
 
 const router = routerFactory({
-  searchTrainings: searchTrainingsFactory(findTrainingsBy, postgresSearchClient),
+  searchTrainings: searchTrainingsFactory(postgresDataClient),
   findTrainingsBy: findTrainingsBy,
   getInDemandOccupations: getInDemandOccupationsFactory(postgresDataClient),
   getOccupationDetail: getOccupationDetailFactory(
@@ -180,9 +179,9 @@ const router = routerFactory({
           apiValues.careerOneStopUserId,
           apiValues.careerOneStopAuthToken
       ),
-      findTrainingsBy,
       postgresDataClient
   ),
+  getAllCertificates: credentialEngineFactory(),
   getOccupationDetailByCIP: getOccupationDetailByCIPFactory(
       OnetClient(
           apiValues.onetBaseUrl,

backend/src/credentialengine/CredentialEngineAPI.testdemo.ts

@@ -0,0 +1 @@
+export {};

backend/src/credentialengine/CredentialEngineAPI.ts

@@ -0,0 +1,84 @@
+import { searchAPI } from "./CredentialEngineConfig";
+import { getRecordAPI } from "./CredentialEngineConfig";
+
+const searchGateway = `/assistant/search/ctdl`;
+const graphGateway = `/graph`;
+const resourcesGateway = `/resources`;
+
+export const credentialEngineAPI = {
+  /**
+   *
+   * @param query this should be a JSON-LD blob representing specific CE term collections.
+   * @param skip part of pagination, number of results to skip
+   * @param take part of pagination, number of results to return
+   * @param sort CE provides several sorting methods
+   *
+   * @return a collection of results from Credential Engine.
+   *
+   */
+
+  getResults: async function (query: object, skip: number, take: number, sort: string) {
+    const response = await searchAPI.request({
+      url: `${searchGateway}`,
+      method: "post",
+      data: {
+        Query: query,
+        Skip: skip,
+        Take: take,
+        Sort: sort,
+      },
+      // retrieving the signal value by using the property name
+      // signal: cancel ? cancelApiObject[this.get.name].handleRequestCancellation().signal : undefined,
+    });
+
+    // return "Connection works.";
+    return response;
+  },
+
+  getGraphByCTID: async function (ctid: string) {
+    const response = await getRecordAPI({
+      url: `${graphGateway}/${ctid}`,
+      method: "get",
+    });
+
+    return response.data;
+  },
+
+  getResourceByCTID: async function (ctid: string) {
+    const response = await getRecordAPI({
+      url: `${resourcesGateway}/${ctid}`,
+      method: "get",
+    });
+
+    return response.data;
+  },
+
+  // TODO: Discuss how we can use Cips for better results
+  // getResultByCips: async function (cips: string[]) {
+  //   if(cips.length === 0) return []
+  //   const query = `
+  //   {
+  //     "ceterms:instructionalProgramType": {
+  //       "ceterms:codedNotation": ${JSON.stringify(cips)}
+  //     },
+  //     "ceterms:availableOnlineAt": "search:anyValue",
+  //     "ceterms:availableAt": {
+  //          "ceterms:addressRegion": [
+  //            {
+  //              "search:value": "NJ",
+  //              "search:value": "jersey",
+  //              "search:matchType": "search:exactMatch"
+  //            }
+  //          ]
+  //      },
+  //     "ceterms:credentialStatusType": {
+  //         "ceterms:targetNode": "credentialStat:Active"
+  //       },
+  //     "search:recordPublishedBy": "ce-cc992a07-6e17-42e5-8ed1-5b016e743e9d"
+  //   } 
+  //   `
+  //   const result = await this.getResults(JSON.parse(query), 0, 4, "")
+  //   return result.data.data
+  // }
+
+}

backend/src/credentialengine/CredentialEngineConfig.ts

@@ -0,0 +1,49 @@
+import axios from "axios";
+
+export const searchAPI = axios.create({
+  withCredentials: true,
+  baseURL: `https://${process.env.CE_ENVIRONMENT}.credentialengine.org`,
+  responseType: "json",
+  headers: {
+    "Access-Control-Request-Method": "POST",
+    "Access-Control-Request-Headers": "Content-Type, Authorization",
+    Authorization: `Bearer ${process.env.CE_AUTH_TOKEN}`,
+    "Content-type": "application/json",
+  },
+});
+
+export const getRecordAPI = axios.create({
+  withCredentials: false,
+  baseURL: process.env.CE_ENVIRONMENT == "sandbox" ? `https://${process.env.CE_ENVIRONMENT}.credentialengineregistry.org` : `https://credentialengineregistry.org`,
+  responseType: "json"
+})
+
+const errorHandler = (error: { response: { status: unknown } }) => {
+  const statusCode = error.response?.status;
+
+  if (statusCode && statusCode !== 401) {
+    console.error(error);
+  }
+
+  return Promise.reject(error);
+};
+
+searchAPI.interceptors.response.use(undefined, (error) => {
+  return errorHandler(error);
+});
+
+getRecordAPI.interceptors.response.use(undefined, (error) => {
+  return errorHandler(error);
+});
+
+/*
+
+curl "https://sandbox.credentialengine.org/assistant/search/ctdl" \
+  -H "Origin: http://localhost:3000" \
+  -H 'Access-Control-Request-Method: POST' \
+  -H 'Access-Control-Request-Headers: Content-Type, Authorization' \
+  -H "Authorization: Bearer bc5989e5-8b5b-4099-85f3-961b4913c24c" \
+  -H 'Content-Type: application/json' \
+  -d "{'Query': { '@type': 'ceterms:Certificate' }, 'Skip': 0, 'Take': 5, 'Sort': '^search:recordCreated' }"
+
+*/