@bottlebooks/valid-values 1.1.0

package/src/validValues/types/Award.ts

@@ -0,0 +1,39 @@
+import type { MessageDescriptor } from '@lingui/core';
+interface ValidValueEnabledFor {
+  field: string;
+  value: string;
+}
+
+export interface Award {
+  key: string;
+  enabledFor?: ValidValueEnabledFor[];
+  /**
+   * The translatable title of the valid value.
+   *
+   * Define it using `defineMessage()` from @lingui/macro.
+   */
+  title?: string | MessageDescriptor;
+  /**
+   * Fields that will never be stored in the database,
+   * because they are not relevant to the frontend rendering.
+   * They are only used for the form, like grouping values for easier entry.
+   */
+  form?: {
+    /**
+     * A helpful description shown only when using the form.
+     */
+    // description?: MessageDescriptor;
+  };
+  medals?: string[];
+  /**
+   * Fields that are stored in the database together with each lookup value,
+   * because they affect the frontend rendering.
+   * They are also included in the hash values to detect breaking changes.
+   *
+   * We should try to avoid them if possible because if false positives:
+   * Any change in one of those fields would lead to
+   * eLabels that are marked as incompatible,
+   * although there might be no user-visible changes.
+   */
+  frontend?: {};
+}

package/src/validValues/types/Certification.ts

@@ -0,0 +1,18 @@
+import type { MessageDescriptor } from '@lingui/core';
+import { ValidValueDefinition } from './ValidValueDefinition';
+import { CertificationTag } from './CertificationTag';
+
+export interface Certification extends ValidValueDefinition {
+  /**
+   * Name which should not be translated. It is an alternative to a translatable title
+   */
+  title: string;
+
+  form?: {
+    tags: CertificationTag[];
+    description?: MessageDescriptor;
+  };
+  frontend: {
+    logo?: string;
+  };
+}

package/src/validValues/types/CertificationTag.ts

@@ -0,0 +1 @@
+export type CertificationTag = 'internationalCertification'

package/src/validValues/types/Country.ts

@@ -0,0 +1,39 @@
+import type { MessageDescriptor } from '@lingui/core';
+interface ValidValueEnabledFor {
+  field: string;
+  value: string;
+}
+
+export interface Country {
+  key: string;
+  enabledFor?: ValidValueEnabledFor[];
+  /**
+   * The translatable title of the valid value.
+   *
+   * Define it using `defineMessage()` from @lingui/macro.
+   */
+  title?: string | MessageDescriptor;
+  /**
+   * Fields that will never be stored in the database,
+   * because they are not relevant to the frontend rendering.
+   * They are only used for the form, like grouping values for easier entry.
+   */
+  form?: {
+    /**
+     * A helpful description shown only when using the form.
+     */
+    // description?: MessageDescriptor;
+  };
+  regions?: string[];
+  /**
+   * Fields that are stored in the database together with each lookup value,
+   * because they affect the frontend rendering.
+   * They are also included in the hash values to detect breaking changes.
+   *
+   * We should try to avoid them if possible because if false positives:
+   * Any change in one of those fields would lead to
+   * eLabels that are marked as incompatible,
+   * although there might be no user-visible changes.
+   */
+  frontend?: {};
+}

package/src/validValues/types/Ingredient.ts

@@ -0,0 +1,22 @@
+import type { MessageDescriptor } from '@lingui/core';
+import { ValidValueDefinition } from './ValidValueDefinition';
+import { ProductType } from './ProductTypeKey';
+import { IngredientTag } from './IngredientTag';
+
+export interface Ingredient extends ValidValueDefinition {
+  /**
+   * The translatable title of the valid value.
+   *
+   * Define it using `defineMessage()` from @lingui/macro.
+   */
+  title: MessageDescriptor;
+
+  form: {
+    productType: ProductType[];
+    tags: IngredientTag[];
+    /**
+     * A helpful description shown only when using the form.
+     */
+    description?: MessageDescriptor;
+  };
+}

package/src/validValues/types/IngredientTag.ts

@@ -0,0 +1,19 @@
+export type IngredientTag =
+  | 'ALLERGENS'
+  | 'ADDITIVES'
+  | 'SUGARS'
+  | 'RAW_MATERIAL'
+  | 'ALLERGEN'
+  | 'PRESERVATIVE'
+  | 'ENRICHMENT_SUBSTANCE'
+  | 'ENRICHMENT_SUBSTANCE'
+  | 'NATURALLY_ADDED_ACID'
+  | 'SWEETENER'
+  | 'ACIDITY_REGULATOR'
+  | 'STABILISER'
+  | 'OTHER_INGREDIENT'
+  | 'ANTIOXIDANT'
+  | 'PROCESSING_AID'
+  | 'FLAVOURING'
+  | 'COLOUR'
+  | 'ALCOHOL';

package/src/validValues/types/LocalizedValidValue.ts

@@ -0,0 +1,17 @@
+import type { MessageDescriptor } from '@lingui/core';
+import { ValidValueDefinition } from './ValidValueDefinition';
+import { ProductType } from './ProductTypeKey';
+import { IngredientTag } from './IngredientTag';
+
+export interface LocalizedValidValue extends ValidValueDefinition {
+  title: MessageDescriptor;
+
+  form: {
+    productType: ProductType[];
+    tags: IngredientTag[];
+    /**
+     * A helpful description shown only when using the form.
+     */
+    // description?: MessageDescriptor;
+  };
+}

package/src/validValues/types/ProductType.ts

@@ -0,0 +1,7 @@
+import type { MessageDescriptor } from '@lingui/core';
+import { ValidValueDefinition } from './ValidValueDefinition';
+import { IngredientTag } from './IngredientTag';
+
+export interface ProductType extends ValidValueDefinition {
+  title: MessageDescriptor;
+}

package/src/validValues/types/ProductTypeKey.ts

@@ -0,0 +1,40 @@
+export type ProductType =
+  | 'wine_stillwine'
+  | 'wine_fortified'
+  | 'wine_pearlwine'
+  | 'wine_sparkling'
+  | 'wine_aromatized'
+  | 'spirit_absinthe'
+  | 'spirit_anise'
+  | 'spirit_aquavit'
+  | 'spirit_arak'
+  | 'spirit_armagnac'
+  | 'spirit_asianspirit'
+  | 'spirit_bitter'
+  | 'spirit_cachaca'
+  | 'spirit_calvados'
+  | 'spirit_cocktail'
+  | 'spirit_cognac'
+  | 'spirit_fruitspirit'
+  | 'spirit_genever'
+  | 'spirit_gin'
+  | 'spirit_grainspirit'
+  | 'spirit_grapebrandy'
+  | 'spirit_grappa'
+  | 'spirit_liqueur'
+  | 'spirit_marc'
+  | 'spirit_mezcal'
+  | 'spirit_miscspririt'
+  | 'spirit_ouzo'
+  | 'spirit_pastis'
+  | 'spirit_pisco'
+  | 'spirit_raki'
+  | 'spirit_rum'
+  | 'spirit_sambuca'
+  | 'spirit_shochu'
+  | 'spirit_schnaps'
+  | 'spirit_tequila'
+  | 'spirit_vermouth'
+  | 'spirit_vodka'
+  | 'spirit_whisky'
+  | 'beer';

package/src/validValues/types/Region.ts

@@ -0,0 +1,39 @@
+import type { MessageDescriptor } from '@lingui/core';
+interface ValidValueEnabledFor {
+  field: string;
+  value: string;
+}
+
+export interface Region {
+  key: string;
+  enabledFor?: ValidValueEnabledFor[];
+  /**
+   * The translatable title of the valid value.
+   *
+   * Define it using `defineMessage()` from @lingui/macro.
+   */
+  title?: string | MessageDescriptor;
+  /**
+   * Fields that will never be stored in the database,
+   * because they are not relevant to the frontend rendering.
+   * They are only used for the form, like grouping values for easier entry.
+   */
+  form?: {
+    /**
+     * A helpful description shown only when using the form.
+     */
+    // description?: MessageDescriptor;
+  };
+  subregions?: string[];
+  /**
+   * Fields that are stored in the database together with each lookup value,
+   * because they affect the frontend rendering.
+   * They are also included in the hash values to detect breaking changes.
+   *
+   * We should try to avoid them if possible because if false positives:
+   * Any change in one of those fields would lead to
+   * eLabels that are marked as incompatible,
+   * although there might be no user-visible changes.
+   */
+  frontend?: {};
+}

package/src/validValues/types/ResponsibleConsumptionLogo.ts

@@ -0,0 +1,17 @@
+import type { MessageDescriptor } from '@lingui/core';
+import { ValidValueDefinition } from './ValidValueDefinition';
+import { CertificationTag } from './CertificationTag';
+
+export interface ResponsibleConsumptionLogo extends ValidValueDefinition {
+  /**
+   * Name which should not be translated. It is an alternative to a translatable title
+   */
+  title: MessageDescriptor;
+
+  form?: {
+    description?: MessageDescriptor;
+  };
+  frontend: {
+    logo?: string;
+  };
+}

package/src/validValues/types/ValidValueDefinition.ts

@@ -0,0 +1,38 @@
+import type { MessageDescriptor } from '@lingui/core';
+interface ValidValueEnabledFor {
+  field: string;
+  value: string;
+}
+
+export interface ValidValueDefinition {
+  key: string;
+  enabledFor?: ValidValueEnabledFor[];
+  /**
+   * The translatable title of the valid value.
+   *
+   * Define it using `defineMessage()` from @lingui/macro.
+   */
+  title?: string | MessageDescriptor;
+  /**
+   * Fields that will never be stored in the database,
+   * because they are not relevant to the frontend rendering.
+   * They are only used for the form, like grouping values for easier entry.
+   */
+  form?: {
+    /**
+     * A helpful description shown only when using the form.
+     */
+    // description?: MessageDescriptor;
+  };
+  /**
+   * Fields that are stored in the database together with each lookup value,
+   * because they affect the frontend rendering.
+   * They are also included in the hash values to detect breaking changes.
+   *
+   * We should try to avoid them if possible because if false positives:
+   * Any change in one of those fields would lead to
+   * eLabels that are marked as incompatible,
+   * although there might be no user-visible changes.
+   */
+  frontend?: {};
+}

package/src/validValues/types/ValidValueLocale.ts

@@ -0,0 +1,4 @@
+import type { MessageDescriptor } from '@lingui/core';
+import { allLocaleData, allMessages } from '../../locales/locales.js';
+
+export type ValidValueLocale = keyof typeof allMessages;

package/src/validValues/utils/createValidValues.ts

@@ -0,0 +1,74 @@
+import { transform } from '@babel/core';
+import { i18n } from '@lingui/core';
+import { allLocaleData, allMessages } from '../../locales/locales.js';
+const allSupportedLocales = Object.keys(allLocaleData);
+import { ValidValueDefinition } from '../types/ValidValueDefinition';
+import { ValidValueLocale } from '../types/ValidValueLocale';
+
+i18n.loadLocaleData(allLocaleData);
+i18n.load(allMessages);
+type Locale = keyof typeof allMessages;
+
+export default function createValidValues<
+  ValidValue extends ValidValueDefinition = ValidValueDefinition
+>(values: Record<string, ValidValue>) {
+  function list() {
+    // TODO if we provide locale argument here we can avoid getTitle without locale argument which can help in .map functions
+    // const initialLocale = locale;
+    return Object.entries(values).map(([id, value]) => {
+      const { key, title, form, frontend } = value;
+      if (!title) throw new Error('missing_required:title');
+
+      function getTitle(locale?: Locale) {
+        if (typeof title === 'string') {
+          return title;
+        } else if (title) {
+          i18n.activate(locale || 'en');
+          const translation = i18n._(title) || '';
+          if (translation === title.id) {
+            console.log('%c' + `WARNING: translation_missing:${title.id}:${locale}`, 'color: #d0011b;');
+            i18n.activate('en');
+            return i18n._(title) || '';
+          }
+          return translation;
+        } else {
+          return key;
+        }
+      }
+
+      return {
+        /** The value identifier. */
+        id,
+        ...value,
+        /** Returns the localized title of a lookup value. */
+        getTitle,
+        /** Returns the translatet titles for multiple locales. */
+        getTitles(locales: Locale[] = allSupportedLocales as Locale[]) {
+          const translations = Object.fromEntries(
+            locales.map((locale) => {
+              return [locale, getTitle(locale)];
+            })
+          ) as Record<Locale, string>;
+          return translations;
+        },
+        form: value.form
+          ? {
+              ...value.form,
+              /** Returns the localized description of a lookup value. */
+              // getDescription(locale: Locale) {
+              //   if (!value?.form?.description) return undefined;
+              //   i18n.activate(locale);
+              //   return i18n._(value.form?.description);
+              // },
+            }
+          : undefined,
+      };
+    });
+  }
+  return {
+    list,
+    byId: () => {
+      return Object.fromEntries(list().map((value) => [value.id, value]));
+    },
+  };
+}