@bottlebooks/valid-values 7.0.3 → 7.1.0

package/dist/validValues/types/IngredientTag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IngredientTag.d.ts","sourceRoot":"","sources":["../../../src/validValues/types/IngredientTag.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa,GACrB,WAAW,GACX,WAAW,GACX,QAAQ,GACR,cAAc,GACd,UAAU,GACV,cAAc,GACd,aAAa,GACb,sBAAsB,GACtB,sBAAsB,GACtB,WAAW,GACX,mBAAmB,GACnB,YAAY,GACZ,kBAAkB,GAElB,gBAAgB,GAChB,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,eAAe,GACf,aAAa,GACb,wBAAwB,GACxB,kBAAkB,GAClB,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,CAAC"}
+{"version":3,"file":"IngredientTag.d.ts","sourceRoot":"","sources":["../../../src/validValues/types/IngredientTag.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa,GACrB,WAAW,GACX,QAAQ,GACR,cAAc,GACd,UAAU,GACV,cAAc,GACd,aAAa,GACb,sBAAsB,GACtB,sBAAsB,GACtB,WAAW,GACX,mBAAmB,GACnB,YAAY,GACZ,kBAAkB,GAElB,gBAAgB,GAChB,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,eAAe,GACf,aAAa,GACb,wBAAwB,GACxB,kBAAkB,GAClB,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,CAAC"}

package/dist/validValues/types/PackagingMaterialTag.d.ts

@@ -0,0 +1,2 @@
+export declare type PackagingMaterialTag = 'COMPOSITE';
+//# sourceMappingURL=PackagingMaterialTag.d.ts.map

package/dist/validValues/types/PackagingMaterialTag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackagingMaterialTag.d.ts","sourceRoot":"","sources":["../../../src/validValues/types/PackagingMaterialTag.ts"],"names":[],"mappings":"AAAA,oBAAY,oBAAoB,GAAG,WAAW,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@bottlebooks/valid-values",
   "description": "The Bottlebooks lookup values, defined globally.",
   "private": false,
-  "version": "7.0.3",
+  "version": "7.1.0",
   "type": "commonjs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,5 +34,5 @@
     "@babel/core": "^7.15.5",
     "@lingui/core": "3.14.0"
   },
-  "gitHead": "c9bbaa9feb27eb6f9b5ca20c2899b36ae7a1613c"
+  "gitHead": "1abc4409dc4654d0677b3e19ef2cc55c8cade330"
 }

package/src/scripts/README.md

@@ -6,7 +6,14 @@ Steps for transformis legacy server side valid values
    2.2. Search `description: \{(.*?(.|[\n])*?)\}` and replace with `description: defineMessage({$1})`
 3. Generated files created under /locales/json can be copied into qr-app/src/assets/i18n-ext
 
-How to add html tag into valid values
+### How to add html tag into valid values
 
-1. Search `"validValues.ingredient.milk"\nmsgstr "(.*)"``
-2. Replace with `"validValues.ingredient.milk"\nmsgstr "<allergen-ingredient>$1</allergen-ingredient>"`
+1. Search ```"validValues.ingredient.milk"\nmsgstr "(.\*)"```
+2. Replace with `"validValues.ingredient.milk"\nmsgstr "<allergen-ingredient>$1</allergen-ingredient>"`
+
+### How to add allergen synonyms. Example on egg lysozyme
+
+1. Search `"validValues.ingredient.eggLysozyme_eCode"\nmsgstr ""`
+2. Replace with `"validValues.ingredient.eggLysozyme_eCode"\nmsgstr "E 1105 (<0>egg</0>)"`
+3. Replace '<0>egg</0>' with translation from validValues.ingredient.egg
+4. Fro synonymDescription we are reusing translation from "validValues.ingredient.eggs.synonymDescription"

package/src/validValues/ingredient/deprecatedIngredient.ts

@@ -1,13 +1,7 @@
 import { defineMessage } from '@lingui/macro';
-import type { ProductTypeKey } from '../productType/productType';
-
-import PRODUCT_TYPE_SPIRITS from '../types/productTypesSpirit';
 import PRODUCT_TYPE_WINES from '../types/productTypesWine';
-import {
-  DeprecatedIngredient,
-  Ingredient,
-  synonymOfSulfites,
-} from './ingredientTypes';
+import type { DeprecatedIngredient } from './ingredientTypes';
+import { synonymOfSulfites } from './ingredientTypes';
 
 const ingredient = (value: DeprecatedIngredient) => value;
 
@@ -121,7 +115,7 @@ const deprecatedIngredients = {
     key: 'calciumPhytate',
     label: defineMessage({
       id: 'validValues.ingredient.calciumPhytate',
-      message: 'potassium ferrocyanide',
+      message: 'calcium phytate',
     }),
     metadata: {
       tags: ['CLARIFYING_AGENT', 'STABILISER'],

package/src/validValues/ingredient/ingredient.ts

@@ -1,35 +1,11 @@
-import type { MessageDescriptor } from '@lingui/core';
 import { defineMessage } from '@lingui/macro';
 import type { ProductTypeKey } from '../productType/productType';
-import type { IngredientTag } from '../types/IngredientTag';
-import type {
-  ValidValueDefinition,
-  ValidValueMetadataDefinition,
-} from '../types/ValidValueDefinition';
+import type { ValidValueDefinition } from '../types/ValidValueDefinition';
 import PRODUCT_TYPE_SPIRITS from '../types/productTypesSpirit';
 import PRODUCT_TYPE_WINES from '../types/productTypesWine';
 import deprecatedIngredients from './deprecatedIngredient';
-
-interface IngredientValidValueMetadataDefinition
-  extends ValidValueMetadataDefinition {
-  /** Defines whether this ingredient is an allergen. Can be used to format allergens differently. */
-  isAllergen?: boolean;
-  // FIXME: Move into metadata - it's not stored in the database.
-  isDeprecated?: boolean;
-  // FIXME: Move into metadata - it's not stored in the database.
-  deprecatedFrom?: string;
-  // FIXME: Move into metadata - it's not stored in the database.
-  metadata: {
-    deprecationDescription?: MessageDescriptor;
-    /** Whether the ingredient should be hidden in the main list and only be visible when searching for the particular term. */
-    isHiddenInMainList?: boolean;
-    /** A text describing the preferred ingredient. */
-    // We're not using a pointer to the main ingredients because it could be one of many synonyms.
-    synonymDescription?: MessageDescriptor;
-    productType: ProductTypeKey[];
-    tags: IngredientTag[];
-  };
-}
+import synonymIngredient from './synonymIngredient';
+import type { IngredientValidValueMetadataDefinition } from './ingredientTypes';
 
 interface Ingredient
   extends ValidValueDefinition,
@@ -38,31 +14,9 @@ interface Ingredient
 /** Makes sure errors are displayed where the error is introduced. */
 const ingredient = (value: Ingredient) => value;
 
-// A partial to mix into synonym ingredients.
-const synonymOfSulfites: Partial<Ingredient['metadata']> = {
-  isHiddenInMainList: true,
-  synonymDescription: defineMessage({
-    id: 'validValues.ingredient.sulfites.synonymDescription',
-    message: "You can use 'sulphites' instead.",
-  }),
-};
-const synonymOfEggs: Partial<Ingredient['metadata']> = {
-  isHiddenInMainList: true,
-  synonymDescription: defineMessage({
-    id: 'validValues.ingredient.eggs.synonymDescription',
-    message: "You can use 'egg' instead.",
-  }),
-};
-const synonymOfMilk: Partial<Ingredient['metadata']> = {
-  isHiddenInMainList: true,
-  synonymDescription: defineMessage({
-    id: 'validValues.ingredient.milk.synonymDescription',
-    message: "You can use 'milk' instead.",
-  }),
-};
-
 const allIngredients = {
   ...deprecatedIngredients,
+  ...synonymIngredient,
   aleppoPineResin: ingredient({
     key: 'aleppoPineResin',
     label: defineMessage({
@@ -97,7 +51,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_WINES,
     },
   }),
-
   burnedSugar: ingredient({
     key: 'burnedSugar',
     label: defineMessage({
@@ -109,7 +62,6 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-
   calciumSulphate: ingredient({
     key: 'calciumSulphate',
     label: defineMessage({
@@ -165,51 +117,15 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-  casein: ingredient({
-    key: 'casein',
-    label: defineMessage({
-      id: 'validValues.ingredient.casein',
-      message: '<allergen-ingredient>milk</allergen-ingredient> casein',
-    }),
-    metadata: {
-      tags: ['CLARIFYING_AGENT'],
-      productType: PRODUCT_TYPE_WINES,
-      ...synonymOfMilk,
-    },
-  }),
   milk: ingredient({
     key: 'milk',
     label: defineMessage({
       id: 'validValues.ingredient.milk',
-      message: '<allergen-ingredient>milk</allergen-ingredient>',
-    }),
-    metadata: {
-      tags: ['CLARIFYING_AGENT'],
-      productType: PRODUCT_TYPE_WINES,
-    },
-  }),
-  milkProducts: ingredient({
-    key: 'milkProducts',
-    label: defineMessage({
-      id: 'validValues.ingredient.milkProducts',
-      message: '<allergen-ingredient>milk<allergen-ingredient> products',
-    }),
-    metadata: {
-      tags: ['CLARIFYING_AGENT'],
-      productType: PRODUCT_TYPE_WINES,
-      ...synonymOfMilk,
-    },
-  }),
-  milkProtein: ingredient({
-    key: 'milkProtein',
-    label: defineMessage({
-      id: 'validValues.ingredient.milkProtein',
-      message: 'milk protein',
+      message: '<Allergen>milk</Allergen>',
     }),
     metadata: {
-      tags: ['CLARIFYING_AGENT'],
+      tags: ['CLARIFYING_AGENT', 'ALLERGEN'],
       productType: PRODUCT_TYPE_WINES,
-      ...synonymOfMilk,
     },
   }),
   causticSulfiteCaramel: ingredient({
@@ -223,7 +139,6 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-
   cerealDistillateAndWater: ingredient({
     key: 'cerealDistillateAndWater',
     label: defineMessage({
@@ -235,7 +150,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_SPIRITS,
     },
   }),
-
   citricAcid: ingredient({
     key: 'citricAcid',
     label: defineMessage({
@@ -258,7 +172,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_WINES,
     },
   }),
-
   dimethyldicarbonate: ingredient({
     key: 'dimethyldicarbonate',
     label: defineMessage({
@@ -303,64 +216,15 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-
   egg: ingredient({
     key: 'egg',
     label: defineMessage({
       id: 'validValues.ingredient.egg',
-      message: '<allergen-ingredient>egg</allergen-ingredient>',
-    }),
-    metadata: {
-      tags: ['CLARIFYING_AGENT', 'ALLERGEN', 'PRESERVATIVE'],
-      productType: PRODUCT_TYPE_WINES,
-    },
-  }),
-  eggAlbumin: ingredient({
-    key: 'eggAlbumin',
-    label: defineMessage({
-      id: 'validValues.ingredient.eggAlbumin',
-      message: '<allergen-ingredient>egg</allergen-ingredient> albumin',
-    }),
-    metadata: {
-      tags: ['CLARIFYING_AGENT', 'ALLERGEN'],
-      productType: PRODUCT_TYPE_WINES,
-      ...synonymOfEggs,
-    },
-  }),
-  eggLysozyme: ingredient({
-    key: 'eggLysozyme',
-    label: defineMessage({
-      id: 'validValues.ingredient.eggLysozyme',
-      message: '<allergen-ingredient>egg</allergen-ingredient> lysozyme',
-    }),
-    metadata: {
-      tags: ['PRESERVATIVE'],
-      productType: PRODUCT_TYPE_WINES,
-      ...synonymOfEggs,
-    },
-  }),
-  eggProtein: ingredient({
-    key: 'eggProtein',
-    label: defineMessage({
-      id: 'validValues.ingredient.eggProtein',
-      message: '<allergen-ingredient>egg</allergen-ingredient> protein',
-    }),
-    metadata: {
-      tags: ['CLARIFYING_AGENT', 'ALLERGEN', 'PRESERVATIVE'],
-      productType: PRODUCT_TYPE_WINES,
-      ...synonymOfEggs,
-    },
-  }),
-  eggProduct: ingredient({
-    key: 'eggProduct',
-    label: defineMessage({
-      id: 'validValues.ingredient.eggProduct',
-      message: '<allergen-ingredient>egg</allergen-ingredient> product',
+      message: '<Allergen>egg</Allergen>',
     }),
     metadata: {
       tags: ['CLARIFYING_AGENT', 'ALLERGEN', 'PRESERVATIVE'],
       productType: PRODUCT_TYPE_WINES,
-      ...synonymOfEggs,
     },
   }),
   ethylAlcoholOfAgriculturalOrigin: ingredient({
@@ -425,18 +289,6 @@ const allIngredients = {
       ],
     },
   }),
-  // gaseousOxygen: ingredient({
-  //   key: 'gaseousOxygen',
-  //   label: defineMessage({
-  //     id: 'validValues.ingredient.gaseousOxygen',
-  //     message: 'gaseous oxygen',
-  //   }),
-  //   metadata: {
-  //     tags: ['PACKAGING_GAS'],
-  //     productType: PRODUCT_TYPE_WINES,
-  //   },
-  // }),
-
   grainDistillateAndWater: ingredient({
     key: 'grainDistillateAndWater',
     label: defineMessage({
@@ -481,7 +333,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_WINES,
     },
   }),
-
   honey: ingredient({
     key: 'honey',
     label: defineMessage({
@@ -493,7 +344,6 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-
   lacticAcid: ingredient({
     key: 'lacticAcid',
     label: defineMessage({
@@ -505,7 +355,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_WINES,
     },
   }),
-
   malicAcid: ingredient({
     key: 'malicAcid',
     label: defineMessage({
@@ -550,19 +399,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_WINES,
     },
   }),
-
-  // milkCasein: ingredient({
-  //   key: 'milkCasein',
-  //   label: defineMessage({
-  //     id: 'validValues.ingredient.milkCasein',
-  //     message: 'milk casein',
-  //   }),
-  //   metadata: {
-  //     tags: ['PROCESSING_AID', 'ALLERGEN'],
-  //     productType: PRODUCT_TYPE_WINES,
-  //   },
-  // }),
-
   plainCaramel: ingredient({
     key: 'plainCaramel',
     label: defineMessage({
@@ -574,34 +410,6 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-
-  potassiumBisulphite: ingredient({
-    isAllergen: true,
-    key: 'potassiumBisulphite',
-    label: defineMessage({
-      id: 'validValues.ingredient.potassiumBisulphite',
-      message: 'potassium bisulphite (<Allergen>sulfites</Allergen>)',
-    }),
-    metadata: {
-      tags: ['PRESERVATIVE', 'ALLERGEN'],
-      productType: PRODUCT_TYPE_WINES,
-      ...synonymOfSulfites,
-    },
-  }),
-
-  potassiumMetabisulphite: ingredient({
-    isAllergen: true,
-    key: 'potassiumMetabisulphite',
-    label: defineMessage({
-      id: 'validValues.ingredient.potassiumMetabisulphite',
-      message: 'potassium metabisulphite (<Allergen>sulfites</Allergen>)',
-    }),
-    metadata: {
-      tags: ['PRESERVATIVE', 'ALLERGEN'],
-      productType: PRODUCT_TYPE_WINES,
-      ...synonymOfSulfites,
-    },
-  }),
   potassiumPolyaspartate: ingredient({
     key: 'potassiumPolyaspartate',
     label: defineMessage({
@@ -624,7 +432,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_WINES,
     },
   }),
-
   ryeDistillateAndWater: ingredient({
     key: 'ryeDistillateAndWater',
     label: defineMessage({
@@ -636,7 +443,6 @@ const allIngredients = {
       productType: PRODUCT_TYPE_SPIRITS,
     },
   }),
-
   sucrose: ingredient({
     key: 'sucrose',
     label: defineMessage({
@@ -674,26 +480,13 @@ const allIngredients = {
     key: 'sulfites',
     label: defineMessage({
       id: 'validValues.ingredient.sulfites',
-      message: 'sulphites',
-    }),
-    metadata: {
-      tags: ['PRESERVATIVE', 'ALLERGEN', 'ACIDITY_REGULATOR'],
-      productType: PRODUCT_TYPE_WINES,
-    },
-  }),
-  sulphurDioxide: ingredient({
-    key: 'sulphurDioxide',
-    label: defineMessage({
-      id: 'validValues.ingredient.sulphurDioxide',
-      message: 'sulphur dioxide',
+      message: '<Allergen>sulphites</Allergen>',
     }),
     metadata: {
       tags: ['PRESERVATIVE', 'ALLERGEN'],
       productType: PRODUCT_TYPE_WINES,
-      ...synonymOfSulfites,
     },
   }),
-
   tirageLiqueur: ingredient({
     key: 'tirageLiqueur',
     label: defineMessage({
@@ -716,7 +509,6 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-
   wine: ingredient({
     key: 'wine',
     label: defineMessage({
@@ -761,7 +553,6 @@ const allIngredients = {
       productType: ['wine_aromatized'],
     },
   }),
-
   yeastMannoproteins: ingredient({
     key: 'yeastMannoproteins',
     label: defineMessage({

package/src/validValues/ingredient/ingredientTypes.ts

@@ -9,6 +9,9 @@ import type {
 
 export interface IngredientValidValueMetadataDefinition
   extends ValidValueMetadataDefinition {
+  /** Defines whether this ingredient is an allergen. Can be used to format allergens differently. */
+  // TODO Do we still need it? We are not using it anywhere
+  isAllergen?: boolean;
   // FIXME: Move into metadata - it's not stored in the database.
   isDeprecated?: boolean;
   // FIXME: Move into metadata - it's not stored in the database.
@@ -32,6 +35,18 @@ export interface Ingredient
 export interface DeprecatedIngredient extends Ingredient {
   isDeprecated: boolean;
 }
+export interface SynonymIngredient extends Ingredient {
+  metadata: {
+    deprecationDescription?: MessageDescriptor;
+    /** Whether the ingredient should be hidden in the main list and only be visible when searching for the particular term. */
+    isHiddenInMainList?: boolean;
+    /** A text describing the preferred ingredient. */
+    // We're not using a pointer to the main ingredients because it could be one of many synonyms.
+    synonymDescription?: MessageDescriptor;
+    productType: ProductTypeKey[];
+    tags: IngredientTag[];
+  };
+}
 
 // A partial to mix into synonym ingredients.
 const synonymOfSulfites: Partial<Ingredient['metadata']> = {