add service for esdc_applicantstatusincanada

Author: faiza-jahanzeb

frontend/app/.server/domain/person-case/models.ts

@@ -74,3 +74,14 @@ export type LocalizedPreferredLanguage = Readonly<{
   id: string;
   name: string;
 }>;
+
+export type ApplicantStatusInCanadaChoice = Readonly<{
+  id: string;
+  nameEn: string;
+  nameFr: string;
+}>;
+
+export type LocalizedApplicantStatusInCanadaChoice = Readonly<{
+  id: string;
+  name: string;
+}>;

frontend/app/.server/domain/person-case/services/applicant-status-in-canada-service.ts

@@ -0,0 +1,73 @@
+import type {
+  ApplicantStatusInCanadaChoice,
+  LocalizedApplicantStatusInCanadaChoice,
+} from '~/.server/domain/person-case/models';
+import esdcApplicantStatusInCanadaChoicesData from '~/.server/resources/esdc_applicantstatusincanada.json';
+import { AppError } from '~/errors/app-error';
+import { ErrorCodes } from '~/errors/error-codes';
+
+/**
+ * Retrieves a list of applicant status in Canada choices.
+ *
+ * @returns An array of applicant status in Canada choice objects.
+ */
+export function getApplicantStatusInCanadaChoices(): readonly ApplicantStatusInCanadaChoice[] {
+  return esdcApplicantStatusInCanadaChoicesData.options.map((option) => ({
+    id: option.value.toString(),
+    nameEn: option.labelEn,
+    nameFr: option.labelFr,
+  }));
+}
+
+/**
+ * Retrieves a single applicant status in Canada choice by its ID.
+ *
+ * @param id The ID of the applicant status in Canada choice to retrieve.
+ * @returns Theapplicant status in Canada choice object if found.
+ * @throws {AppError} If the choice is not found.
+ */
+export function getApplicantStatusInCanadaChoicesById(id: string): ApplicantStatusInCanadaChoice {
+  const scenario = getApplicantStatusInCanadaChoices().find((s) => s.id === id);
+  if (!scenario) {
+    throw new AppError(
+      `Application status in Canada with ID '${id}' not found.`,
+      ErrorCodes.NO_APPLICANT_STATUS_IN_CANADA_CHOICE_FOUND,
+    );
+  }
+  return scenario;
+}
+
+/**
+ * Retrieves a list of applicant status in Canada choices localized to the specified language.
+ *
+ * @param language The language to localize the scenario names to.
+ * @returns An array of localized applicant status in Canada choice objects.
+ */
+export function getLocalizedApplicantStatusInCanadaChoices(language: Language): LocalizedApplicantStatusInCanadaChoice[] {
+  return getApplicantStatusInCanadaChoices().map((option) => ({
+    id: option.id,
+    name: language === 'fr' ? option.nameFr : option.nameEn,
+  }));
+}
+
+/**
+ * Retrieves a single localized applicant status in Canada choice by its ID.
+ *
+ * @param id The ID of the applicant status in Canada choice to retrieve.
+ * @param language The language to localize the choice name to.
+ * @returns The localized applicant status in Canada choice object if found.
+ * @throws {AppError} If the choice is not found.
+ */
+export function getLocalizedApplicantStatusInCanadaChoiceById(
+  id: string,
+  language: Language,
+): LocalizedApplicantStatusInCanadaChoice {
+  const scenario = getLocalizedApplicantStatusInCanadaChoices(language).find((s) => s.id === id);
+  if (!scenario) {
+    throw new AppError(
+      `Localized applicant status in Canada choice with ID '${id}' not found.`,
+      ErrorCodes.NO_APPLICANT_STATUS_IN_CANADA_CHOICE_FOUND,
+    );
+  }
+  return scenario;
+}

frontend/app/.server/domain/person-case/services/index.ts

@@ -6,3 +6,4 @@ export * as applicationSubmissionScenario from './application-submission-scenari
 export * as applicationTypeService from './application-type-service';
 export * as languageCorrespondenceService from './language-correspondence-service';
 export * as sinApplicationService from './sin-application-service';
+export * as applicantStatusInCanadaService from './applicant-status-in-canada-service';

frontend/app/errors/error-codes.ts

@@ -47,5 +47,6 @@ export const ErrorCodes = {
   NO_PROVINCE_FOUND: 'SVC-0008',
   NO_TYPE_OF_APPLICATION_TO_SUBMIT_FOUND: 'SVC-0009',
   NO_LANGUAGE_OF_CORRESPONDENCE_FOUND: 'SVC-0010',
-  SUBMIT_SIN_APPLICATION_FAILED: 'SVC-0011',
+  NO_APPLICANT_STATUS_IN_CANADA_CHOICE_FOUND: 'SVC-00011',
+  SUBMIT_SIN_APPLICATION_FAILED: 'SVC-0012',
 } as const;