Merge pull request #1814 from IFRCGo/feature/backend-submodule

frozenhelium · web-flow · commit a2f00a9c782c · 2025-09-17T17:51:12.000+05:45
Add submodules for go-api and risk-api
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -230,24 +230,37 @@ jobs:
       - name: Lint CSS
         run: pnpm lint:css
 
-  # FIXME: Identify a way to generate schema before we run typecheck
-  # typecheck:
-  #   name: Typecheck
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - name: Install pnpm
-  #       uses: pnpm/action-setup@v4
-  #     - name: Install Node.js
-  #       uses: actions/setup-node@v4
-  #       with:
-  #         node-version: 20
-  #         cache: 'pnpm'
-  #     - name: Install dependencies
-  #       run: pnpm install
-  #
-  #     - name: Typecheck
-  #       run: pnpm typecheck
+  typecheck:
+    name: Typecheck
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: app
+    needs: [ui]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: ui-build
+          path: packages/ui/dist
+
+      - name: Generate types
+        run: pnpm generate:type
+
+      - name: Typecheck
+        run: pnpm typecheck
 
   typos:
     name: Spell Check with Typos
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,6 @@
+[submodule "go-api"]
+	path = go-api
+	url = git@github.com:IFRCGo/go-api.git
+[submodule "go-risk-module-api"]
+	path = go-risk-module-api
+	url = git@github.com:IFRCGo/go-risk-module-api.git
diff --git a/README.md b/README.md
@@ -41,13 +41,19 @@ To begin, ensure you have network access. Then, you'll need the following:
    gh repo clone IFRCGo/go-web-app # GitHub CLI
    ```
 
-2. Install the dependencies:
+2. Initialize submodules
+
+    ```bash
+    git submodule update --init --recursive --remote
+    ```
+
+3. Install the dependencies:
 
    ```bash
    pnpm install
    ```
 
-3. Create a `.env` file in the `app` directory and add variables from [env.ts](https://github.com/IFRCGo/go-web-app/blob/develop/app/env.ts). Any variables marked with `.optional()` are not mandatory for setup and can be skipped.
+4. Create a `.env` file in the `app` directory and add variables from [env.ts](https://github.com/IFRCGo/go-web-app/blob/develop/app/env.ts). Any variables marked with `.optional()` are not mandatory for setup and can be skipped.
 
    ```bash
    cd app
@@ -61,10 +67,10 @@ To begin, ensure you have network access. Then, you'll need the following:
    ...
    ```
 
-4. Start the development server:
+5. Start the development server:
 
    ```bash
-   pnpm start:app
+   pnpm start
    ```
 
 ## Contributing
diff --git a/app/package.json b/app/package.json
@@ -17,8 +17,8 @@
         "initialize:type:go-api": "test -f ./generated/types.ts && true || cp types.stub.ts ./generated/types.ts",
         "initialize:type:risk-api": "test -f ./generated/riskTypes.ts && true || cp types.stub.ts ./generated/riskTypes.ts",
         "generate:type": "pnpm generate:type:go-api && pnpm generate:type:risk-api",
-        "generate:type:go-api": "dotenv -- cross-var openapi-typescript \"%APP_API_ENDPOINT%api-docs/\" -o ./generated/types.ts --alphabetize",
-        "generate:type:risk-api": "dotenv -- cross-var openapi-typescript \"%APP_RISK_API_ENDPOINT%api-docs/\" -o ./generated/riskTypes.ts --alphabetize",
+        "generate:type:go-api": "GO_API_HASH=$(git rev-parse HEAD:go-api); dotenv -- cross-var openapi-typescript https://raw.githubusercontent.com/IFRCGo/go-api-artifacts/refs/heads/main/generated/$GO_API_HASH/openapi-schema.yaml -o ./generated/types.ts --alphabetize",
+        "generate:type:risk-api": "dotenv -- cross-var openapi-typescript ../go-risk-module-api/openapi-schema.yaml -o ./generated/riskTypes.ts --alphabetize",
         "prestart": "pnpm initialize:type",
         "start": "pnpm -F @ifrc-go/ui build && vite",
         "prebuild": "pnpm initialize:type",
diff --git a/app/src/components/domain/RiskImminentEventMap/index.tsx b/app/src/components/domain/RiskImminentEventMap/index.tsx
@@ -66,9 +66,9 @@ const mapImageOption = {
     sdf: true,
 };
 
-type HazardType = components<'read'>['schemas']['HazardTypeEnum'];
+type CommonHazardType = components<'read'>['schemas']['CommonHazardTypeEnumKey'];
 
-const hazardKeys = Object.keys(hazardKeyToIconMap) as HazardType[];
+const hazardKeys = Object.keys(hazardKeyToIconMap) as CommonHazardType[];
 
 const mapIcons = mapToList(
     hazardKeyToIconMap,
@@ -77,7 +77,7 @@ const mapIcons = mapToList(
 
 type EventPointProperties = {
     id: string | number,
-    hazard_type: HazardType,
+    hazard_type: CommonHazardType,
 }
 
 export type EventPointFeature = GeoJSON.Feature<GeoJSON.Point, EventPointProperties>;
@@ -108,7 +108,7 @@ interface Props<EVENT, EXPOSURE, KEY extends string | number> {
     source: ImminentEventSource;
     events: EVENT[] | undefined;
     keySelector: (event: EVENT) => KEY;
-    hazardTypeSelector: (event: EVENT) => HazardType | '' | undefined;
+    hazardTypeSelector: (event: EVENT) => CommonHazardType | '' | undefined;
     pointFeatureSelector: (event: EVENT) => EventPointFeature | undefined;
     footprintSelector: (activeEventExposure: EXPOSURE | undefined) => Footprint | undefined;
     activeEventExposure: EXPOSURE | undefined;
@@ -306,7 +306,7 @@ function RiskImminentEventMap<
     const [loadedIcons, setLoadedIcons] = useState<Record<string, boolean>>({});
 
     const handleIconLoad = useCallback(
-        (loaded: boolean, key: HazardType) => {
+        (loaded: boolean, key: CommonHazardType) => {
             setLoadedIcons((prevValue) => ({
                 ...prevValue,
                 [key]: loaded,
diff --git a/app/src/components/domain/RiskImminentEventMap/mapStyles.ts b/app/src/components/domain/RiskImminentEventMap/mapStyles.ts
@@ -33,9 +33,9 @@ import {
     type RiskLayerTypes,
 } from './utils';
 
-type HazardType = components<'read'>['schemas']['HazardTypeEnum'];
+type CommonHazardType = components<'read'>['schemas']['CommonHazardTypeEnumKey'];
 
-export const hazardKeyToIconMap: Record<HazardType, string | null> = {
+export const hazardKeyToIconMap: Record<CommonHazardType, string | null> = {
     EQ: earthquakeIcon,
     FL: floodIcon,
     TC: cycloneIcon,
diff --git a/app/src/components/domain/RiskImminentEvents/Gdacs/index.tsx b/app/src/components/domain/RiskImminentEvents/Gdacs/index.tsx
@@ -192,8 +192,6 @@ function Gdacs(props: Props) {
                 isNotDefined(latitude)
                 || isNotDefined(longitude)
                 || isNotDefined(hazard_type)
-                // FIXME: hazard_type should not be ''
-                || hazard_type === ''
             ) {
                 return undefined;
             }
diff --git a/app/src/components/domain/RiskImminentEvents/MeteoSwiss/index.tsx b/app/src/components/domain/RiskImminentEvents/MeteoSwiss/index.tsx
@@ -128,8 +128,6 @@ function MeteoSwiss(props: Props) {
                 isNotDefined(latitude)
                 || isNotDefined(longitude)
                 || isNotDefined(hazard_type)
-                // FIXME: hazard_type should not be ''
-                || hazard_type === ''
             ) {
                 return undefined;
             }
diff --git a/app/src/components/domain/RiskImminentEvents/Pdc/index.tsx b/app/src/components/domain/RiskImminentEvents/Pdc/index.tsx
@@ -99,8 +99,6 @@ function Pdc(props: Props) {
                 isNotDefined(latitude)
                 || isNotDefined(longitude)
                 || isNotDefined(hazard_type)
-                // FIXME: hazard_type should not be ''
-                || hazard_type === ''
             ) {
                 return undefined;
             }
@@ -138,8 +136,8 @@ function Pdc(props: Props) {
             } = exposure;
 
             // FIXME: showing five days cou when three days cou is not available
-            const cyclone_cou = (cyclone_three_days_cou as unknown[] | null)?.[0]
-                ?? (cyclone_five_days_cou as unknown[])?.[0];
+            const cyclone_cou = (cyclone_three_days_cou as unknown as object[] | null)?.[0]
+                ?? (cyclone_five_days_cou as unknown as object[] | null)?.[0];
 
             if (isNotDefined(footprint_geojson) && isNotDefined(storm_position_geojson)) {
                 return undefined;
diff --git a/app/src/components/domain/RiskImminentEvents/WfpAdam/index.tsx b/app/src/components/domain/RiskImminentEvents/WfpAdam/index.tsx
@@ -146,8 +146,6 @@ function WfpAdam(props: Props) {
                 isNotDefined(latitude)
                 || isNotDefined(longitude)
                 || isNotDefined(hazard_type)
-                // FIXME: hazard_type should not be ''
-                || hazard_type === ''
             ) {
                 return undefined;
             }
diff --git a/app/src/components/domain/RiskImminentEvents/index.tsx b/app/src/components/domain/RiskImminentEvents/index.tsx
@@ -35,7 +35,7 @@ import i18n from './i18n.json';
 import styles from './styles.module.css';
 
 export type ImminentEventSource = 'pdc' | 'wfpAdam' | 'gdacs' | 'meteoSwiss';
-type HazardType = components<'read'>['schemas']['HazardTypeEnum'];
+type HazardType = components<'read'>['schemas']['CommonHazardTypeEnumKey'];
 
 type BaseProps = {
     className?: string;
diff --git a/app/src/utils/domain/risk.ts b/app/src/utils/domain/risk.ts
@@ -32,7 +32,7 @@ import {
 } from '#utils/constants';
 import { type RiskApiResponse } from '#utils/restRequest';
 
-export type HazardType = components<'read'>['schemas']['HazardTypeEnum'];
+export type HazardType = components<'read'>['schemas']['CommonHazardTypeEnumKey'];
 type IpcEstimationType = components<'read'>['schemas']['EstimationTypeEnum'];
 type CountrySeasonal = RiskApiResponse<'/api/v1/country-seasonal/'>;
 type IpcData = CountrySeasonal[number]['ipc_displacement_data'];
@@ -189,7 +189,7 @@ export function getPrioritizedIpcData(data: IpcData) {
         (item) => {
             // FIXME: Update isFalsyString to Exclude empty string
             // FIXME: Also fix this in server
-            if (isFalsyString(item.estimation_type) || item.estimation_type === '') {
+            if (isFalsyString(item.estimation_type)) {
                 return undefined;
             }
 
diff --git a/app/src/views/CountryProfileRiskWatch/PossibleEarlyActionTable/index.tsx b/app/src/views/CountryProfileRiskWatch/PossibleEarlyActionTable/index.tsx
@@ -29,7 +29,7 @@ import { useRiskRequest } from '#utils/restRequest';
 import i18n from './i18n.json';
 import styles from './styles.module.css';
 
-type HazardType = riskApiComponents['schemas']['HazardTypeEnum'];
+type HazardType = riskApiComponents['schemas']['CommonHazardTypeEnumKey'];
 
 type PossibleEarlyActionsResponse = RiskApiResponse<'/api/v1/early-actions/'>;
 type ResponseItem = NonNullable<PossibleEarlyActionsResponse['results']>[number];
diff --git a/app/src/views/CountryProfileRiskWatch/ReturnPeriodTable/index.tsx b/app/src/views/CountryProfileRiskWatch/ReturnPeriodTable/index.tsx
@@ -28,7 +28,7 @@ import i18n from './i18n.json';
 
 type GetCountryRisk = paths['/api/v1/country-seasonal/']['get'];
 type CountryRiskResponse = GetCountryRisk['responses']['200']['content']['application/json'];
-type HazardType = components<'read'>['schemas']['HazardTypeEnum'];
+type HazardType = components<'read'>['schemas']['CommonHazardTypeEnumKey'];
 interface HazardTypeOption {
     hazard_type: HazardType;
     hazard_type_display: string;
@@ -66,7 +66,7 @@ function ReturnPeriodTable(props: Props) {
                     (datum) => {
                         // FIXME: Update isFalsyString to Exclude empty string
                         // FIXME: Also fix this in server
-                        if (isFalsyString(datum.hazard_type) || datum.hazard_type === '') {
+                        if (isFalsyString(datum.hazard_type)) {
                             return undefined;
                         }
 
diff --git a/app/src/views/CountryProfileRiskWatch/RiskBarChart/CombinedChart/index.tsx b/app/src/views/CountryProfileRiskWatch/RiskBarChart/CombinedChart/index.tsx
@@ -44,7 +44,7 @@ import styles from './styles.module.css';
 
 type CountryRiskResponse = RiskApiResponse<'/api/v1/country-seasonal/'>;
 type RiskData = CountryRiskResponse[number];
-type HazardType = components<'read'>['schemas']['HazardTypeEnum'];
+type HazardType = components<'read'>['schemas']['CommonHazardTypeEnumKey'];
 
 const selectedMonths = {
     0: true,
diff --git a/go-api b/go-api
@@ -0,0 +1 @@
+Subproject commit 0b28ce5542941c45666320b7411c4d9de6f6291a
diff --git a/go-risk-module-api b/go-risk-module-api
@@ -0,0 +1 @@
+Subproject commit e6afd9b1de44d48e114bd60470770df571360d66
diff --git a/patches/openapi-typescript@6.5.5.patch b/patches/openapi-typescript@6.5.5.patch
@@ -42,7 +42,7 @@ index 716afaa50ea30a433178843def931d6d1c4fbe33..28c9250a19081e0569b1de30662510ee
      if (output.join("\n").includes("OneOf")) {
          output.splice(1, 0, "/** OneOf type helpers */", "type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };", "type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;", "type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;", "");
 diff --git a/dist/load.js b/dist/load.js
-index aea4fe09436722e0c2d1fb272b1e067c17a9af60..69bb601d8d6bcf022acad9f5e9b0221b230d376b 100644
+index aea4fe09436722e0c2d1fb272b1e067c17a9af60..eb2f1dbbeaba9fc177943e2ac8b826b2fe80788e 100644
 --- a/dist/load.js
 +++ b/dist/load.js
 @@ -67,8 +67,7 @@ export default async function load(schema, options) {
@@ -55,22 +55,23 @@ index aea4fe09436722e0c2d1fb272b1e067c17a9af60..69bb601d8d6bcf022acad9f5e9b0221b
              const headers = { "User-Agent": "openapi-typescript" };
              if (options.auth)
                  headers.Authorization = options.auth;
-@@ -83,6 +82,14 @@ export default async function load(schema, options) {
+@@ -83,6 +82,15 @@ export default async function load(schema, options) {
                  headers,
              });
              const contentType = res.headers.get("content-type");
-+            const contentDisposition = res.headers.get("content-disposition");
++            const contentDisposition = res.headers.get("content-disposition") ?? '';
 +
 +            const match = contentDisposition.match(/^.*filename="?(?<name>.+?)"?(?:;|$)/);
 +            const filename = match
 +                ? match.groups.name
-+                : undefined;
++                : schema.pathname.substring(schema.pathname.lastIndexOf('/') + 1);
++;
 +
 +            const ext = path.extname(filename).toLowerCase();
              if (ext === ".json" || contentType?.includes("json")) {
                  options.schemas[schemaID] = {
                      hint,
-@@ -97,6 +104,7 @@ export default async function load(schema, options) {
+@@ -97,6 +105,7 @@ export default async function load(schema, options) {
              }
          }
          else {
@@ -166,4 +167,4 @@ index 9b28fc0323dae76ae04f5fcfb1e2529650d3444e..732a78968f75de19b914f9cf6015d6e9
 +    mode?: "read" | "write";
  }
  export type $defs = Record<string, SchemaObject>;
- export type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+ export type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +[submodule "go-api"]
 +	path = go-api
 +	url = [email protected]:IFRCGo/go-api.git
 +[submodule "go-risk-module-api"]
 +	path = go-risk-module-api
 +	url = [email protected]:IFRCGo/go-risk-module-api.git
Original file line number	Diff line number	Diff line change
`@@ -192,8 +192,6 @@ function Gdacs(props: Props) {`
`192`	`192`	`isNotDefined(latitude)`
`193`	`193`	`\|\| isNotDefined(longitude)`
`194`	`194`	`\|\| isNotDefined(hazard_type)`
`195`		`- // FIXME: hazard_type should not be ''`
`196`		`- \|\| hazard_type === ''`
`197`	`195`	`) {`
`198`	`196`	`return undefined;`
`199`	`197`	`}`
Original file line number	Diff line number	Diff line change
`@@ -128,8 +128,6 @@ function MeteoSwiss(props: Props) {`
`128`	`128`	`isNotDefined(latitude)`
`129`	`129`	`\|\| isNotDefined(longitude)`
`130`	`130`	`\|\| isNotDefined(hazard_type)`
`131`		`- // FIXME: hazard_type should not be ''`
`132`		`- \|\| hazard_type === ''`
`133`	`131`	`) {`
`134`	`132`	`return undefined;`
`135`	`133`	`}`
Original file line number	Diff line number	Diff line change
`@@ -146,8 +146,6 @@ function WfpAdam(props: Props) {`
`146`	`146`	`isNotDefined(latitude)`
`147`	`147`	`\|\| isNotDefined(longitude)`
`148`	`148`	`\|\| isNotDefined(hazard_type)`
`149`		`- // FIXME: hazard_type should not be ''`
`150`		`- \|\| hazard_type === ''`
`151`	`149`	`) {`
`152`	`150`	`return undefined;`
`153`	`151`	`}`