@bottlebooks/valid-values 10.34.6 → 10.36.0

package/src/validValues/subregion/subregion.ts

@@ -3,8 +3,9 @@ import regions from '../region/region';
 import type { ValidValueDefinition } from '../types/ValidValueDefinition';
 import type { MessageDescriptor } from '@lingui/core';
 
-interface Subregion extends ValidValueDefinition {
+export interface Subregion extends ValidValueDefinition {
   label: MessageDescriptor;
+  isDeprecated?: boolean;
 }
 
 /** Adds the key to the subregion and makes sure we can only add valid subregions. */
@@ -6017,13 +6018,6 @@ const allSubregions = {
       message: 'Seguret AOC',
     }),
   }),
-  fr_sevre_et_maine: subregion({
-    key: 'fr_sevre_et_maine',
-    label: defineMessage({
-      id: 'validValues.subregion.fr_sevre_et_maine',
-      message: 'Sevre et Maine AOC',
-    }),
-  }),
   fr_seyssel: subregion({
     key: 'fr_seyssel',
     label: defineMessage({
@@ -6147,7 +6141,7 @@ const allSubregions = {
     key: 'fr_val_de_loire',
     label: defineMessage({
       id: 'validValues.subregion.fr_val_de_loire',
-      message: 'Val de Loire IGP',
+      message: 'IGP Val de Loire',
     }),
   }),
   fr_val_du_montferrand: subregion({
@@ -10177,6 +10171,33 @@ const allSubregions = {
   }),
 } as const;
 
+interface DeprecatedSubregion extends Subregion {
+  isDeprecated: true;
+  metadata: {
+    deprecationDescription: string;
+    deprecatedFrom: string;
+  };
+}
+
+/** Adds the key to the subregion and makes sure we can only add valid subregions. */
+const deprecatedSubregion = (value: DeprecatedSubregion) => value;
+
+const allDeprecatedSubregions = {
+  fr_sevre_et_maine: deprecatedSubregion({
+    key: 'fr_sevre_et_maine',
+    label: defineMessage({
+      id: 'validValues.subregion.fr_sevre_et_maine',
+      message: 'Sevre et Maine AOC',
+    }),
+    isDeprecated: true,
+    metadata: {
+      deprecatedFrom: '2024-12-03T03:57:54.644Z',
+      deprecationDescription:
+        'InterLoire noticed that this subregion is duplicated by fr_muscadet-sevre-et-maine',
+    },
+  }),
+} as const;
+
 export type SubregionKey = keyof typeof allSubregions;
 
 export const byRegion = Object.values(regions).reduce<
@@ -10184,6 +10205,9 @@ export const byRegion = Object.values(regions).reduce<
 >((acc, region) => {
   if (!acc[region.key]) acc[region.key] = [];
   region.subregions?.forEach((subregionKey) => {
+    const subregion = allSubregions[subregionKey];
+    // If subregion is deprecated, ignore
+    if (subregion.isDeprecated) return acc;
     acc[region.key].push(allSubregions[subregionKey]);
   });
   return acc;