certification type (#108)

Author: abeglova

package.json

@@ -37,7 +37,7 @@
   },
   "homepage": "https://github.com/mitodl/course-search-utils#readme",
   "dependencies": {
-    "@mitodl/open-api-axios": "^2024.5.6",
+    "@mitodl/open-api-axios": "^2024.6.4",
     "axios": "^1.6.7",
     "fuse.js": "^7.0.0",
     "query-string": "^6.13.1",

src/constants.ts

@@ -48,4 +48,11 @@ export const LEVELS = {
   introductory:  "Introductory"
 }
 
+export const CERTIFICATION_TYPES = {
+  none:         "No Certificate",
+  completion:   "Certificate of Completion",
+  micromasters: "MicroMasters Credential",
+  professional: "Professional Certificate"
+}
+
 export const BOOLEAN_FACET_NAMES = ["certification", "professional"]

src/facet_display/FacetDisplay.tsx

@@ -10,7 +10,7 @@ import type {
   BooleanFacets,
   BucketWithLabel
 } from "./types"
-import { LEVELS, DEPARTMENTS } from "../constants"
+import { LEVELS, DEPARTMENTS, CERTIFICATION_TYPES } from "../constants"
 import MultiFacetGroup from "./MultiFacetGroup"
 
 interface FacetDisplayProps {
@@ -27,6 +27,16 @@ interface FacetDisplayProps {
   onFacetChange: (name: string, value: string, isEnabled: boolean) => void
 }
 
+export const getCertificationTypeName = (certificationType: string): string => {
+  if (certificationType in CERTIFICATION_TYPES) {
+    return CERTIFICATION_TYPES[
+      certificationType as keyof typeof CERTIFICATION_TYPES
+    ]
+  } else {
+    return certificationType
+  }
+}
+
 export const getDepartmentName = (departmentId: string): string => {
   if (departmentId in DEPARTMENTS) {
     return DEPARTMENTS[departmentId as keyof typeof DEPARTMENTS]

src/facet_display/types.ts

@@ -53,6 +53,7 @@ export interface Facets {
   resource_type?: string[]
   content_feature_type?: string[]
   learning_format?: string[]
+  certification_type?: string[]
 }
 
 export interface BooleanFacets {

src/hooks/validation.ts

@@ -9,6 +9,7 @@ const {
   LearningResourcesSearchRetrieveSortbyEnum: SortByEnum,
   LearningResourcesSearchRetrieveAggregationsEnum: AggregationsEnum,
   LearningResourcesSearchRetrieveLearningFormatEnum: LearningFormatEnum,
+  CertificationTypeEnum,
   ContentFileSearchRetrieveSortbyEnum,
   ContentFileSearchRetrieveAggregationsEnum
 } = v1
@@ -39,23 +40,24 @@ type QueryParamValidators<ReqParams> = {
 }
 
 const resourceSearchValidators: QueryParamValidators<ResourceSearchRequest> = {
-  resource_type:   withinEnum(Object.values(ResourceTypeEnum)),
-  department:      withinEnum(Object.values(DepartmentEnum)),
-  level:           withinEnum(Object.values(LevelEnum)),
-  platform:        withinEnum(Object.values(PlatformEnum)),
-  offered_by:      withinEnum(Object.values(OfferedByEnum)),
-  sortby:          values => withinEnum(Object.values(SortByEnum))(values)[0],
-  q:               first,
-  topic:           identity,
-  certification:   firstBoolean,
-  professional:    firstBoolean,
-  aggregations:    withinEnum(Object.values(AggregationsEnum)),
-  course_feature:  identity,
-  limit:           firstNumber,
-  offset:          firstNumber,
-  id:              numbers,
-  free:            firstBoolean,
-  learning_format: withinEnum(Object.values(LearningFormatEnum))
+  resource_type:      withinEnum(Object.values(ResourceTypeEnum)),
+  department:         withinEnum(Object.values(DepartmentEnum)),
+  level:              withinEnum(Object.values(LevelEnum)),
+  platform:           withinEnum(Object.values(PlatformEnum)),
+  offered_by:         withinEnum(Object.values(OfferedByEnum)),
+  sortby:             values => withinEnum(Object.values(SortByEnum))(values)[0],
+  q:                  first,
+  topic:              identity,
+  certification:      firstBoolean,
+  professional:       firstBoolean,
+  aggregations:       withinEnum(Object.values(AggregationsEnum)),
+  course_feature:     identity,
+  limit:              firstNumber,
+  offset:             firstNumber,
+  id:                 numbers,
+  free:               firstBoolean,
+  learning_format:    withinEnum(Object.values(LearningFormatEnum)),
+  certification_type: withinEnum(Object.values(CertificationTypeEnum))
 }
 
 const contentSearchValidators: QueryParamValidators<ContentFileSearchRequest> =

src/index.ts

@@ -4,7 +4,8 @@ export {
   default as FacetDisplay,
   AvailableFacets,
   getDepartmentName,
-  getLevelName
+  getLevelName,
+  getCertificationTypeName
 } from "./facet_display/FacetDisplay"
 export { default as FilterableFacet } from "./facet_display/FilterableFacet"
 export { sanitizeFacets } from "./facet_display/SanitizeFacets"

yarn.lock

@@ -762,10 +762,10 @@
   dependencies:
     make-plural "^7.0.0"
 
-"@mitodl/open-api-axios@^2024.5.6":
-  version "2024.5.6"
-  resolved "https://registry.yarnpkg.com/@mitodl/open-api-axios/-/open-api-axios-2024.5.6.tgz#81a0777198da6de54cfbb0968c6fd1f620b11686"
-  integrity sha512-Z3mmohEeWHI4csKJQlqp5G5szE+6uzE16rX9bSovSfCSui8svpGNyiwlcfsZL7VHMr/6CKT7LYl9I0ydlxvgcw==
+"@mitodl/open-api-axios@^2024.6.4":
+  version "2024.6.4"
+  resolved "https://registry.yarnpkg.com/@mitodl/open-api-axios/-/open-api-axios-2024.6.4.tgz#e906b764b115665858570f4bbf04bc065a2eeb4f"
+  integrity sha512-oJ3AwyDTrHOQXairhtqHyBHb9CzIf7En2gV7y6BANDKXhYGXKOVvxqWtvV+1jsCzgGWT6A2nBXYsKuVIGoAP6w==
   dependencies:
     "@types/node" "^20.11.19"
     axios "^1.6.5"