updated endpoints to use lang param

Author: ZibanPirate

api/src/_utils/language.ts

@@ -0,0 +1,7 @@
+import { LANGUAGE_CODES, LanguageCode } from "@dzcode.io/utils/dist/language";
+import { IsIn } from "class-validator";
+
+export class LanguageQuery {
+  @IsIn(LANGUAGE_CODES)
+  lang!: LanguageCode;
+}

api/src/contribution/controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, NotFoundError, Param } from "routing-controllers";
+import { Controller, Get, NotFoundError, Param, QueryParams } from "routing-controllers";
 import { Service } from "typedi";
 
 import { ContributionRepository } from "./repository";
@@ -8,15 +8,18 @@ import {
   GetContributionsResponse,
   GetContributionsForSitemapResponse,
 } from "./types";
+import { LanguageQuery } from "src/_utils/language";
 
 @Service()
 @Controller("/contributions")
 export class ContributionController {
   constructor(private readonly contributionRepository: ContributionRepository) {}
 
   @Get("/")
-  public async getContributions(): Promise<GetContributionsResponse> {
-    const contributions = await this.contributionRepository.findForList();
+  public async getContributions(
+    @QueryParams() { lang }: LanguageQuery,
+  ): Promise<GetContributionsResponse> {
+    const contributions = await this.contributionRepository.findForList(lang);
 
     return {
       contributions,
@@ -33,8 +36,11 @@ export class ContributionController {
   }
 
   @Get("/:id")
-  public async getContribution(@Param("id") id: string): Promise<GetContributionResponse> {
-    const contribution = await this.contributionRepository.findByIdWithStats(id);
+  public async getContribution(
+    @Param("id") id: string,
+    @QueryParams() { lang }: LanguageQuery,
+  ): Promise<GetContributionResponse> {
+    const contribution = await this.contributionRepository.findByIdWithStats(id, lang);
 
     return {
       contribution,

api/src/contribution/repository.ts

@@ -9,6 +9,7 @@ import { PostgresService } from "src/postgres/service";
 import { Service } from "typedi";
 
 import { ContributionRow, contributionsTable } from "./table";
+import { LanguageCode } from "@dzcode.io/utils/dist/language";
 
 @Service()
 export class ContributionRepository {
@@ -113,7 +114,7 @@ export class ContributionRepository {
       .where(ne(contributionsTable.runId, runId));
   }
 
-  public async findForList() {
+  public async findForList(lang: LanguageCode) {
     const statement = sql`
     SELECT
       p.id as id,
@@ -146,7 +147,7 @@ export class ContributionRepository {
               'id',
               cr.id,
               'name',
-              cr.name,
+              cr.name_${sql.raw(lang)},
               'username',
               cr.username,
               'avatar_url',
@@ -187,7 +188,7 @@ export class ContributionRepository {
     return sortedUpdatedAt;
   }
 
-  public async findByIdWithStats(id: string) {
+  public async findByIdWithStats(id: string, lang: LanguageCode) {
     const statement = sql`
     SELECT
       p.id as id,
@@ -220,7 +221,7 @@ export class ContributionRepository {
               'id',
               cr.id,
               'name',
-              cr.name,
+              cr.name_${sql.raw(lang)},
               'username',
               cr.username,
               'avatar_url',

api/src/contributor/controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, NotFoundError, Param } from "routing-controllers";
+import { Controller, Get, NotFoundError, Param, QueryParams } from "routing-controllers";
 import { Service } from "typedi";
 
 import { ContributorRepository } from "./repository";
@@ -10,7 +10,7 @@ import {
 } from "./types";
 import { ProjectRepository } from "src/project/repository";
 import { ContributionRepository } from "src/contribution/repository";
-import { Language } from "@dzcode.io/utils/dist/language";
+import { LanguageQuery } from "src/_utils/language";
 
 @Service()
 @Controller("/contributors")
@@ -22,9 +22,9 @@ export class ContributorController {
   ) {}
 
   @Get("/")
-  public async getContributors(): Promise<GetContributorsResponse> {
-    // todo: lang query param
-    const lang: Language = "en";
+  public async getContributors(
+    @QueryParams() { lang }: LanguageQuery,
+  ): Promise<GetContributorsResponse> {
     const contributors = await this.contributorRepository.findForList(lang);
 
     return {
@@ -42,10 +42,10 @@ export class ContributorController {
   }
 
   @Get("/:id")
-  public async getContributor(@Param("id") id: string): Promise<GetContributorResponse> {
-    // todo: lang query param
-    const lang: Language = "en";
-
+  public async getContributor(
+    @Param("id") id: string,
+    @QueryParams() { lang }: LanguageQuery,
+  ): Promise<GetContributorResponse> {
     const [contributor, projects, contributions] = await Promise.all([
       this.contributorRepository.findWithStats(id, lang),
       this.projectRepository.findForContributor(id),
@@ -64,10 +64,10 @@ export class ContributorController {
   }
 
   @Get("/:id/name")
-  public async getContributorName(@Param("id") id: string): Promise<GetContributorNameResponse> {
-    // todo: lang query param
-    const lang: Language = "en";
-
+  public async getContributorName(
+    @Param("id") id: string,
+    @QueryParams() { lang }: LanguageQuery,
+  ): Promise<GetContributorNameResponse> {
     const contributor = await this.contributorRepository.findName(id, lang);
 
     if (!contributor) throw new NotFoundError("Contributor not found");

api/src/contributor/repository.ts

@@ -11,17 +11,17 @@ import {
   ContributorRow,
   contributorsTable,
 } from "./table";
-import { Language } from "@dzcode.io/utils/dist/language";
+import { LanguageCode } from "@dzcode.io/utils/dist/language";
 
 @Service()
 export class ContributorRepository {
   constructor(private readonly postgresService: PostgresService) {}
 
-  public async findName(contributorId: string, lang: Language) {
+  public async findName(contributorId: string, lang: LanguageCode) {
     const statement = sql`
     SELECT
       ${contributorsTable.id},
-      ${contributorsTable[`name_${lang}`]}
+      ${contributorsTable[`name_${lang}`]} as name
     FROM
       ${contributorsTable}
     WHERE
@@ -39,11 +39,11 @@ export class ContributorRepository {
     return camelCased;
   }
 
-  public async findForProject(projectId: string, lang: Language) {
+  public async findForProject(projectId: string, lang: LanguageCode) {
     const statement = sql`
     SELECT
       ${contributorsTable.id},
-      ${contributorsTable[`name_${lang}`]},
+      ${contributorsTable[`name_${lang}`]} as name,
       ${contributorsTable.avatarUrl},
       sum(${contributorRepositoryRelationTable.score}) as ranking
     FROM
@@ -67,11 +67,11 @@ export class ContributorRepository {
     return camelCased;
   }
 
-  public async findForList(lang: Language) {
+  public async findForList(lang: LanguageCode) {
     const statement = sql`
     SELECT
       ${contributorsTable.id},
-      ${contributorsTable[`name_${lang}`]},
+      ${contributorsTable[`name_${lang}`]} as name,
       ${contributorsTable.avatarUrl},
       sum(${contributorRepositoryRelationTable.score}) as total_contribution_score,
       count(DISTINCT ${contributorRepositoryRelationTable.repositoryId}) as total_repository_count,
@@ -152,11 +152,11 @@ export class ContributorRepository {
       .where(ne(contributorsTable.runId, runId));
   }
 
-  public async findWithStats(contributorId: string, lang: Language) {
+  public async findWithStats(contributorId: string, lang: LanguageCode) {
     const statement = sql`
     SELECT
       ${contributorsTable.id},
-      ${contributorsTable[`name_${lang}`]},
+      ${contributorsTable[`name_${lang}`]} as name,
       ${contributorsTable.avatarUrl},
       ${contributorsTable.username},
       ${contributorsTable.url},

api/src/project/controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, NotFoundError, Param } from "routing-controllers";
+import { Controller, Get, NotFoundError, Param, QueryParams } from "routing-controllers";
 import { Service } from "typedi";
 
 import { ProjectRepository } from "./repository";
@@ -11,7 +11,7 @@ import {
 import { RepositoryRepository } from "src/repository/repository";
 import { ContributorRepository } from "src/contributor/repository";
 import { ContributionRepository } from "src/contribution/repository";
-import { Language } from "@dzcode.io/utils/dist/language";
+import { LanguageQuery } from "src/_utils/language";
 
 @Service()
 @Controller("/projects")
@@ -42,10 +42,10 @@ export class ProjectController {
   }
 
   @Get("/:id")
-  public async getProject(@Param("id") id: string): Promise<GetProjectResponse> {
-    // todo: lang query param
-    const lang: Language = "en";
-
+  public async getProject(
+    @Param("id") id: string,
+    @QueryParams() { lang }: LanguageQuery,
+  ): Promise<GetProjectResponse> {
     const [project, repositories, contributors, contributions] = await Promise.all([
       this.projectRepository.findWithStats(id),
       this.repositoryRepository.findForProject(id),

packages/models/src/contributor/index.ts

@@ -1,6 +1,5 @@
 import { BaseEntity } from "src/_base";
 import { StripLanguage } from "@dzcode.io/utils/dist/ts";
-import { Language } from "@dzcode.io/utils/dist/language";
 
 export type ContributorEntity = BaseEntity & {
   name_ar: string;
@@ -10,4 +9,4 @@ export type ContributorEntity = BaseEntity & {
   avatarUrl: string;
 };
 
-export type ContributorNoLang = StripLanguage<Language, ContributorEntity>;
+export type ContributorNoLang = StripLanguage<ContributorEntity>;

packages/models/src/language/index.ts

@@ -1,11 +1,17 @@
-export const allLanguages = [
+import { LanguageCode } from "@dzcode.io/utils/dist/language";
+
+export interface Language {
+  code: LanguageCode;
+  shortLabel: string;
+  label: string;
+  direction: "ltr" | "rtl";
+  baseUrl: string;
+}
+
+// todo: renamed to LANGUAGES
+export const Languages: Language[] = [
   { code: "en", shortLabel: "EN", label: "English", direction: "ltr", baseUrl: "" },
   { code: "ar", shortLabel: "ع", label: "العربية", direction: "rtl", baseUrl: "/ar" },
-] as const;
+];
 
-export interface LanguageEntity {
-  code: (typeof allLanguages)[number]["code"];
-  shortLabel: (typeof allLanguages)[number]["shortLabel"];
-  label: (typeof allLanguages)[number]["label"];
-  direction: (typeof allLanguages)[number]["direction"];
-}
+export const DefaultLanguage: Language = Languages[0];

packages/utils/src/fetch/factory.ts

@@ -1,4 +1,5 @@
 import { FullstackConfig } from "../config";
+import { LanguageCode } from "../language";
 
 interface Endpoint {
   params?: Record<string, string>;
@@ -7,14 +8,15 @@ interface Endpoint {
 }
 
 export const fetchV2Factory =
-  <Es>(fullstackConfig: FullstackConfig) =>
+  <Es>(fullstackConfig: FullstackConfig, lang: LanguageCode) =>
   async <T extends Es, E extends keyof T, C extends T[E], D extends keyof C>(
     endpoint: E,
     config: Pick<C, Exclude<D, "response">>,
   ): Promise<C[D & "response"]> => {
     const { body, params, query } = config as Endpoint;
 
-    const queryString = query ? "?" + query.map(([key, value]) => `${key}=${value}`).join("&") : "";
+    const queryWithLang = [...(query || []), ["lang", lang]];
+    const queryString = "?" + queryWithLang.map(([key, value]) => `${key}=${value}`).join("&");
 
     const domain = (endpoint as string).slice(0, (endpoint as string).indexOf(":"));
     let url = (endpoint as string).slice(domain.length + 1);

packages/utils/src/language/index.ts

@@ -1,3 +1,2 @@
-export const LANGUAGES = ["ar", "en"] as const;
-
-export type Language = (typeof LANGUAGES)[number];
+export const LANGUAGE_CODES = ["ar", "en"] as const;
+export type LanguageCode = (typeof LANGUAGE_CODES)[number];