@bottlebooks/valid-values 1.1.0 → 1.2.1

package/src/validValues/types/ProductType.ts

@@ -1,6 +1,5 @@
 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/ValidValueDefinition.ts

@@ -12,7 +12,7 @@ export interface ValidValueDefinition {
    *
    * Define it using `defineMessage()` from @lingui/macro.
    */
-  title?: string | MessageDescriptor;
+  title: string | MessageDescriptor;
   /**
    * Fields that will never be stored in the database,
    * because they are not relevant to the frontend rendering.

package/src/validValues/types/award_p85_100.ts

@@ -0,0 +1,19 @@
+const range: Array<string> = [
+  'p_85',
+  'p_86',
+  'p_87',
+  'p_88',
+  'p_89',
+  'p_90',
+  'p_91',
+  'p_92',
+  'p_93',
+  'p_94',
+  'p_95',
+  'p_96',
+  'p_97',
+  'p_98',
+  'p_99',
+  'p_100',
+];
+export default range;

package/src/validValues/types/productTypesSpirit.ts

@@ -0,0 +1,38 @@
+import { ProductType } from './ProductTypeKey';
+
+const PRODUCT_TYPE_SPIRITS: Array<ProductType> = [
+  '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',
+];
+export default PRODUCT_TYPE_SPIRITS;

package/src/validValues/types/productTypesWine.ts

@@ -0,0 +1,10 @@
+import { ProductType } from './ProductTypeKey';
+
+const PRODUCT_TYPE_WINES: Array<ProductType> = [
+  'wine_stillwine',
+  'wine_fortified',
+  'wine_pearlwine',
+  'wine_sparkling',
+  'wine_aromatized',
+];
+export default PRODUCT_TYPE_WINES;

package/src/validValues/utils/createValidValues.ts

@@ -12,63 +12,65 @@ 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');
+  // TODO if we provide locale argument here we can avoid getTitle without locale argument which can help in .map functions
+  // const initialLocale = locale;
+  const list = 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;
+    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 {
-        /** 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]));
+      return Object.fromEntries(list.map((value) => [value.id, value]));
     },
   };
 }

package/dist/validValues/types/Country.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/src/validValues/types/Award.ts

@@ -1,39 +0,0 @@
-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/Country.ts

@@ -1,39 +0,0 @@
-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?: {};
-}