chore: implement start past report flow

chore: revert

Author: shon-button

bciers/apps/administration/app/data/jsonSchema/operationInformation/administrationRegistrationInformation.ts

@@ -41,8 +41,8 @@ export const createAdministrationRegistrationInformationSchema =
       throw new Error("Failed to retrieve reporting activities information");
     // fetch valid reporting years for OptedOutOperation dropdown
     const validReportingYears: { reporting_year: number }[] =
-      // NOTE: getReportingYears() includes optional query param exclude_past.
-      // Not using it immediately due to timing of opt-out feature rollout relative to reporting year,
+      // NOTE: getReportingYears() includes optional query param scope.
+      // Not using it here immediately due to timing of opt-out feature rollout relative to reporting year,
       // but will be able to make use of this feature in the future to simplify the dropdown list
       await getReportingYears();
     if (validReportingYears && "error" in validReportingYears)

bciers/apps/reporting/src/app/bceidbusiness/industry_user/reports/previous-years/start-a-report/page.tsx

@@ -0,0 +1,4 @@
+import defaultPageFactory from "@bciers/components/nextPageFactory/defaultPageFactory";
+import Page from "@reporting/src/app/components/report/StartReportPage";
+
+export default defaultPageFactory(Page);

bciers/apps/reporting/src/app/bceidbusiness/industry_user_admin/reports/previous-years/start-a-report/page.tsx

@@ -0,0 +1,4 @@
+import defaultPageFactory from "@bciers/components/nextPageFactory/defaultPageFactory";
+import Page from "@reporting/src/app/components/report/StartReportPage";
+
+export default defaultPageFactory(Page);

bciers/apps/reporting/src/app/components/operations/PastReports.tsx

@@ -1,10 +1,31 @@
-import PastReports from "./PastReports";
-import { ReportSearchParams } from "./types";
+import Link from "next/link";
+import { fetchPastReportsPageData } from "./fetchPastReportsPageData";
+import PastReportsDataGrid from "./PastReportsDataGrid";
+import { ReportRow, ReportSearchParams } from "./types";
 
 export default async function PastReportsPage({
   searchParams,
 }: {
   searchParams: ReportSearchParams;
 }) {
-  return <PastReports searchParams={searchParams} />;
+  const pastReports: { rows: ReportRow[]; row_count: number } =
+    await fetchPastReportsPageData(searchParams);
+
+  const buttonStartReport = (
+    <div className="flex w-full justify-end pb-6">
+      <Link
+        className="link-button-blue"
+        href="../reports/previous-years/start-a-report"
+      >
+        Start a Report
+      </Link>
+    </div>
+  );
+
+  return (
+    <div className="mt-5">
+      {buttonStartReport}
+      <PastReportsDataGrid initialData={pastReports} />
+    </div>
+  );
 }

bciers/apps/reporting/src/app/components/operations/PastReportsPage.tsx

@@ -0,0 +1,85 @@
+"use client";
+
+import { useState } from "react";
+import { Alert, Button } from "@mui/material";
+import { actionHandler } from "@bciers/actions";
+import FormBase from "@bciers/components/form/FormBase";
+import { RJSFSchema, UiSchema } from "@rjsf/utils";
+import { useRouter } from "next/navigation";
+
+interface StartReportFormProps {
+  schema: RJSFSchema;
+  uiSchema: UiSchema;
+}
+
+interface StartReportFormData {
+  reporting_year?: number;
+  reporting_operation?: string;
+}
+
+export default function StartReportForm({
+  schema,
+  uiSchema,
+}: StartReportFormProps) {
+  const router = useRouter();
+  const [formData, setFormData] = useState<StartReportFormData>({});
+  const [errorList, setErrorList] = useState([] as any[]);
+
+  const submitHandler = async (data: { formData?: StartReportFormData }) => {
+    setErrorList([]);
+
+    const response = await actionHandler(
+      "reporting/reports/start",
+      "POST",
+      "/reports/start",
+      {
+        body: JSON.stringify({
+          reporting_year: data.formData?.reporting_year,
+          operation_id: data.formData?.reporting_operation,
+        }),
+      },
+    );
+
+    if (response.error) {
+      setErrorList([{ message: response.error }]);
+      return;
+    }
+
+    window.location.href = `/reports/${response.report_version_id}`;
+  };
+
+  return (
+    <FormBase
+      formData={formData}
+      schema={schema}
+      uiSchema={uiSchema}
+      onChange={(data: any) => setFormData(data.formData)}
+      onSubmit={submitHandler}
+    >
+      {errorList.length > 0 &&
+        errorList.map((e: any) => (
+          <Alert key={e.message} severity="error">
+            {e?.stack ?? e.message}
+          </Alert>
+        ))}
+
+      <div className="flex justify-between pt-6">
+        <Button
+          variant="outlined"
+          onClick={() => router.back()}
+          className="min-w-[120px] border-bc-blue py-2.5 text-bc-links hover:border-bc-primary-blue"
+        >
+          Back
+        </Button>
+
+        <Button
+          variant="contained"
+          type="submit"
+          className="min-w-[120px] bg-bc-blue py-2.5 hover:bg-bc-primary-blue"
+        >
+          Start Report
+        </Button>
+      </div>
+    </FormBase>
+  );
+}

bciers/apps/reporting/src/app/components/report/StartReportForm.tsx

@@ -0,0 +1,12 @@
+import { createStartReportSchemas } from "@reporting/src/data/jsonSchema/report/startReport";
+import StartReportForm from "@reporting/src/app/components/report/StartReportForm";
+
+export default async function StartReportPage() {
+  const { schema, uiSchema } = await createStartReportSchemas();
+
+  return (
+    <div className="mt-5">
+      <StartReportForm schema={schema} uiSchema={uiSchema} />
+    </div>
+  );
+}

bciers/apps/reporting/src/app/components/report/StartReportPage.tsx

@@ -0,0 +1,16 @@
+export interface ReportHistoryRow {
+  id: number;
+  version: string;
+  updated_at: string;
+  status: string;
+  report_type: string;
+  submitted_by: string;
+}
+export interface ReportHistorySearchParams {
+  [key: string]: string | number | undefined;
+  version?: string;
+  updated_at?: string;
+  status?: number;
+  report_type?: string;
+  submitted_by?: string;
+}

bciers/apps/reporting/src/app/components/report/types.ts

@@ -0,0 +1,101 @@
+import FieldTemplate from "@bciers/components/form/fields/FieldTemplate";
+import { RJSFSchema, UiSchema } from "@rjsf/utils";
+import {
+  getReportingYears,
+  getCurrentUsersOperations,
+} from "@bciers/actions/api";
+
+type ReportingYear = {
+  reporting_year: number;
+};
+
+type ReportingOperation = {
+  id: string;
+  name: string;
+  reporting_year: number;
+};
+
+interface CombinedRJSFSchemas {
+  schema: RJSFSchema;
+  uiSchema: UiSchema;
+}
+
+export const createStartReportSchemas =
+  async (): Promise<CombinedRJSFSchemas> => {
+    const [reportingYears, operations]: [
+      ReportingYear[],
+      ReportingOperation[],
+    ] = await Promise.all([
+      getReportingYears("past"),
+      getCurrentUsersOperations(),
+    ]);
+
+    const schema: RJSFSchema = {
+      type: "object",
+      title: "Start a Report",
+
+      required: ["reporting_year", "reporting_operation"],
+
+      properties: {
+        reporting_year: {
+          type: "number",
+          title: "Reporting Year",
+          anyOf: reportingYears.map((year) => ({
+            const: year.reporting_year,
+            title: String(year.reporting_year),
+          })),
+        },
+
+        reporting_operation: {
+          type: "string",
+          title: "Reporting Operation",
+        },
+      },
+
+      dependencies: {
+        reporting_year: {
+          oneOf: reportingYears.map((year) => ({
+            properties: {
+              reporting_year: {
+                const: year.reporting_year,
+              },
+
+              reporting_operation: {
+                type: "string",
+                title: "Reporting Operation",
+                anyOf: operations
+                  .filter(
+                    (operation) =>
+                      operation.reporting_year === year.reporting_year,
+                  )
+                  .map((operation) => ({
+                    const: operation.id,
+                    title: operation.name,
+                  })),
+              },
+            },
+          })),
+        },
+      },
+    };
+
+    const uiSchema: UiSchema = {
+      "ui:FieldTemplate": FieldTemplate,
+      "ui:classNames": "form-heading-label",
+
+      reporting_year: {
+        "ui:widget": "ComboBox",
+        "ui:placeholder": "Select Reporting Year",
+      },
+
+      reporting_operation: {
+        "ui:widget": "ComboBox",
+        "ui:placeholder": "Select Reporting Operation",
+      },
+    };
+
+    return {
+      schema,
+      uiSchema,
+    };
+  };

bciers/apps/reporting/src/data/jsonSchema/report/startReport.ts

@@ -1,7 +1,10 @@
 import { actionHandler } from "@bciers/actions";
 
-async function getReportingYears(exclude_past?: boolean) {
-  const query = exclude_past ? `?exclude_past=${exclude_past}` : "";
+export type ReportingYearScope = "all" | "past";
+
+async function getReportingYears(scope: ReportingYearScope = "all") {
+  const query = scope === "all" ? "" : `?scope=${scope}`;
+
   return actionHandler(`reporting/reporting-years${query}`, "GET", "");
 }