Skip to content

Commit

Permalink
[Fix] Localise key name (#712)
Browse files Browse the repository at this point in the history
* fix localise key

remove the description identifier since localise we have it as just the raw item

* Add an enum

* fix tests
  • Loading branch information
andy-t-wang authored Apr 16, 2024
1 parent 20c8ec0 commit 3bf014a
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 23 deletions.
17 changes: 12 additions & 5 deletions web/api/public/apps/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { getAPIServiceGraphqlClient } from "@/api/helpers/graphql";
import { AppLocaliseKeys } from "@/lib/types";
import {
createLocaliseCategory,
createLocaliseField,
Expand Down Expand Up @@ -105,23 +106,29 @@ export async function GET(request: Request) {
? {
overview: createLocaliseField(
appMetadata.app_id,
"description_overview",
AppLocaliseKeys.description_overview,
),
how_it_works: createLocaliseField(
appMetadata.app_id,
"description_how_it_works",
AppLocaliseKeys.description_how_it_works,
),
how_to_connect: createLocaliseField(
appMetadata.app_id,
"description_connect",
AppLocaliseKeys.description_connect,
),
}
: JSON.parse(appMetadata.description),
world_app_button_text: isApp
? createLocaliseField(appMetadata.app_id, "world_app_button_text")
? createLocaliseField(
appMetadata.app_id,
AppLocaliseKeys.world_app_button_text,
)
: appMetadata.world_app_button_text,
world_app_description: isApp
? createLocaliseField(appMetadata.app_id, "world_app_description")
? createLocaliseField(
appMetadata.app_id,
AppLocaliseKeys.world_app_description,
)
: appMetadata.world_app_description,
};
});
Expand Down
8 changes: 8 additions & 0 deletions web/lib/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ export enum AppStatusType {
Inactive = "inactive",
}

export enum AppLocaliseKeys {
description_overview = "overview",
description_how_it_works = "how_it_works",
description_connect = "connect",
world_app_button_text = "world_app_button_text",
world_app_description = "world_app_description",
}

// Options for the `can_user_verify` attribute in the /precheck endpoint
export enum CanUserVerifyType {
Yes = "yes",
Expand Down
83 changes: 65 additions & 18 deletions web/tests/api/public/apps.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { GET } from "@/api/public/apps";
import { AppLocaliseKeys } from "@/lib/types";
import { createLocaliseCategory, createLocaliseField } from "@/lib/utils";
import { NextRequest } from "next/server";
import { getSdk as getAppMetadataSdk } from "../../../api/public/apps/graphql/get-app-metadata.generated";
import { getSdk as getAppRankingsSdk } from "../../../api/public/apps/graphql/get-app-rankings.generated";
Expand Down Expand Up @@ -176,19 +178,34 @@ describe("/api/public/apps", () => {
name: "Test App2",
logo_img_url: "https://cdn.test.com/2/logo.png",
hero_image_url: "https://cdn.test.com/2/hero.png",
category: "world_id_partner_category_social",
category: createLocaliseCategory("social"),
description: {
how_it_works: "world_id_partner_2_description_how_it_works",
how_to_connect: "world_id_partner_2_description_connect",
overview: "world_id_partner_2_description_overview",
overview: createLocaliseField(
"2",
AppLocaliseKeys.description_overview,
),
how_it_works: createLocaliseField(
"2",
AppLocaliseKeys.description_how_it_works,
),
how_to_connect: createLocaliseField(
"2",
AppLocaliseKeys.description_connect,
),
},
showcase_img_urls: [
"https://cdn.test.com/2/showcase1.png",
"https://cdn.test.com/2/showcase2.png",
],
team_name: "Example Team",
world_app_button_text: "world_id_partner_2_world_app_button_text",
world_app_description: "world_id_partner_2_world_app_description",
world_app_button_text: createLocaliseField(
"2",
AppLocaliseKeys.world_app_button_text,
),
world_app_description: createLocaliseField(
"2",
AppLocaliseKeys.world_app_description,
),
},
{
app_id: "1",
Expand All @@ -197,14 +214,29 @@ describe("/api/public/apps", () => {
hero_image_url: "https://cdn.test.com/1/hero1.png",
showcase_img_urls: ["https://cdn.test.com/1/showcase1.png"],
team_name: "Example Team",
category: "world_id_partner_category_social",
category: createLocaliseCategory("social"),
description: {
how_it_works: "world_id_partner_1_description_how_it_works",
how_to_connect: "world_id_partner_1_description_connect",
overview: "world_id_partner_1_description_overview",
how_it_works: createLocaliseField(
"1",
AppLocaliseKeys.description_how_it_works,
),
how_to_connect: createLocaliseField(
"1",
AppLocaliseKeys.description_connect,
),
overview: createLocaliseField(
"1",
AppLocaliseKeys.description_overview,
),
},
world_app_button_text: "world_id_partner_1_world_app_button_text",
world_app_description: "world_id_partner_1_world_app_description",
world_app_button_text: createLocaliseField(
"1",
AppLocaliseKeys.world_app_button_text,
),
world_app_description: createLocaliseField(
"1",
AppLocaliseKeys.world_app_description,
),
},
{
app_id: "3",
Expand All @@ -216,15 +248,30 @@ describe("/api/public/apps", () => {
"https://cdn.test.com/3/showcase2.png",
"https://cdn.test.com/3/showcase3.png",
],
category: "world_id_partner_category_social",
category: createLocaliseCategory("social"),
description: {
how_it_works: "world_id_partner_3_description_how_it_works",
how_to_connect: "world_id_partner_3_description_connect",
overview: "world_id_partner_3_description_overview",
how_it_works: createLocaliseField(
"3",
AppLocaliseKeys.description_how_it_works,
),
how_to_connect: createLocaliseField(
"3",
AppLocaliseKeys.description_connect,
),
overview: createLocaliseField(
"3",
AppLocaliseKeys.description_overview,
),
},
team_name: "Example Team",
world_app_button_text: "world_id_partner_3_world_app_button_text",
world_app_description: "world_id_partner_3_world_app_description",
world_app_button_text: createLocaliseField(
"3",
AppLocaliseKeys.world_app_button_text,
),
world_app_description: createLocaliseField(
"3",
AppLocaliseKeys.world_app_description,
),
},
],
});
Expand Down

0 comments on commit 3bf014a

Please sign in to comment.