Rename locale to variant name

src/api/dto/CalloutDto.ts

@@ -51,7 +51,7 @@ export class GetCalloutOptsDto extends GetExportQuery {
 
   @IsOptional()
   @IsString()
-  locale?: string;
+  variant?: string;
 
   // This property can only be set internally, not via query params
   @Equals(false)
@@ -65,7 +65,7 @@ export class ListCalloutsDto extends GetPaginatedQuery {
 
   @IsOptional()
   @IsString()
-  locale?: string;
+  variant?: string;
 
   @IsIn(["title", "starts", "expires"])
   sort?: string;

src/api/dto/CalloutVariantDto.ts

@@ -3,7 +3,7 @@ import { IsString, IsOptional, IsUrl } from "class-validator";
 
 export class CalloutVariantDto implements CalloutVariantData {
   @IsString()
-  locale!: string;
+  name!: string;
 
   @IsString()
   title!: string;

src/api/transformers/CalloutTransformer.ts

@@ -6,7 +6,11 @@ import {
   PaginatedQuery
 } from "@beabee/beabee-common";
 import { TransformPlainToInstance } from "class-transformer";
-import { BadRequestError, UnauthorizedError } from "routing-controllers";
+import {
+  BadRequestError,
+  NotFoundError,
+  UnauthorizedError
+} from "routing-controllers";
 import { SelectQueryBuilder } from "typeorm";
 
 import { createQueryBuilder } from "@core/database";
@@ -25,10 +29,10 @@ import { mergeRules, statusFilterHandler } from "@api/utils/rules";
 import Contact from "@models/Contact";
 import Callout from "@models/Callout";
 import CalloutResponse from "@models/CalloutResponse";
+import CalloutVariant from "@models/CalloutVariant";
 
 import { AuthInfo } from "@type/auth-info";
 import { FilterHandlers } from "@type/filter-handlers";
-import CalloutVariant from "@models/CalloutVariant";
 
 class CalloutTransformer extends BaseTransformer<
   Callout,
@@ -80,14 +84,14 @@ class CalloutTransformer extends BaseTransformer<
   convert(callout: Callout, opts?: GetCalloutOptsDto): GetCalloutDto {
     const variants = Object.fromEntries(
       callout.variants.map((variant) => [
-        variant.locale,
+        variant.name,
         CalloutVariantTransformer.convert(variant)
       ])
     );
 
-    const variant = variants[opts?.locale || "default"];
+    const variant = variants[opts?.variant || "default"];
     if (!variant) {
-      throw new BadRequestError("No variant found for locale");
+      throw new NotFoundError(`Variant ${opts?.variant} not found`);
     }
 
     return {
@@ -186,12 +190,9 @@ class CalloutTransformer extends BaseTransformer<
     }
 
     // Always load a variant for filtering and sorting
-    qb.leftJoinAndSelect(
-      `${fieldPrefix}variants`,
-      "cvd",
-      "cvd.locale = :locale",
-      { locale: query.locale || "default" }
-    );
+    qb.leftJoinAndSelect(`${fieldPrefix}variants`, "cvd", "cvd.name = :name", {
+      name: query.variant || "default"
+    });
 
     if (query.sort === "title") {
       qb.orderBy("cvd.title", query.order || "ASC");

src/api/transformers/CalloutVariantTransformer.ts

@@ -13,7 +13,7 @@ class CalloutVariantTransformer extends BaseTransformer<
   @TransformPlainToInstance(CalloutVariantDto)
   convert(variant: CalloutVariant): CalloutVariantDto {
     return {
-      locale: variant.locale,
+      name: variant.name,
       title: variant.title,
       excerpt: variant.excerpt,
       intro: variant.intro,

src/apps/share/app.ts

@@ -27,7 +27,7 @@ async function getCalloutShareSettings(
     .getOne();
 
   if (callout) {
-    const variant = callout.variants.find((v) => v.locale === locale);
+    const variant = callout.variants.find((v) => v.name === locale);
     if (!variant) {
       throw new Error(
         `No variant found for callout ${callout.slug} and locale ${locale}`

src/core/services/CalloutsService.ts

@@ -349,10 +349,10 @@ class CalloutsService {
     responderName: string
   ): Promise<void> {
     const variant =
-      callout.variants.find((v) => v.locale === "default") ||
+      callout.variants.find((v) => v.name === "default") ||
       (await getRepository(CalloutVariant).findOneBy({
         calloutId: callout.id,
-        locale: "default"
+        name: "default"
       }));
 
     await EmailService.sendTemplateToAdmin("new-callout-response", {

src/migrations/1708688873027-ChangeVariantLocaleToName.ts

@@ -0,0 +1,31 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class ChangeVariantLocaleToName1708688873027
+  implements MigrationInterface
+{
+  name = "ChangeVariantLocaleToName1708688873027";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "callout_variant" DROP CONSTRAINT "FK_59870aea0a069e0beadd31b5853"`
+    );
+    await queryRunner.query(
+      `ALTER TABLE "callout_variant" RENAME COLUMN "locale" TO "name"`
+    );
+    await queryRunner.query(
+      `ALTER TABLE "callout_variant" ADD CONSTRAINT "FK_0b3fcedbb2f66d24718bbe58d41" FOREIGN KEY ("calloutId") REFERENCES "callout"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "callout_variant" DROP CONSTRAINT "FK_0b3fcedbb2f66d24718bbe58d41"`
+    );
+    await queryRunner.query(
+      `ALTER TABLE "callout_variant" RENAME COLUMN "name" TO "locale"`
+    );
+    await queryRunner.query(
+      `ALTER TABLE "callout_variant" ADD CONSTRAINT "FK_59870aea0a069e0beadd31b5853" FOREIGN KEY ("calloutId") REFERENCES "callout"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`
+    );
+  }
+}

src/models/CalloutVariant.ts

@@ -9,7 +9,7 @@ export default class CalloutVariant {
   callout!: Callout;
 
   @PrimaryColumn()
-  locale!: string;
+  name!: string;
 
   @Column()
   title!: string;

src/type/callout-variant-data.ts

@@ -1,5 +1,5 @@
 export interface CalloutVariantData {
-  locale: string;
+  name: string;
   title: string;
   excerpt: string;
   intro: string;