@bottlebooks/valid-values 2.1.0 → 3.1.0

package/src/validValues/wineColor.ts

@@ -1,38 +1,42 @@
 import { defineMessage } from '@lingui/macro';
-import createValidValues from './utils/createValidValues.js';
 import { ValidValueDefinition } from './types/ValidValueDefinition';
+
 export interface WineColor extends ValidValueDefinition {}
-export default createValidValues<WineColor>({
-  orange: {
+
+/** Makes sure errors are displayed where the error is introduced. */
+const wineColor = (value: WineColor) => value;
+
+const allWineColors = {
+  orange: wineColor({
     key: 'orange',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineColor.orange',
       message: 'Orange',
     }),
-    form: {},
-  },
-  red: {
+  }),
+  red: wineColor({
     key: 'red',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineColor.red',
       message: 'Red',
     }),
-    form: {},
-  },
-  rose: {
+  }),
+  rose: wineColor({
     key: 'rose',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineColor.rose',
       message: 'Rosé',
     }),
-    form: {},
-  },
-  white: {
+  }),
+  white: wineColor({
     key: 'white',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineColor.white',
       message: 'White',
     }),
-    form: {},
-  },
-});
+  }),
+} as const;
+
+export type WineColorKey = keyof typeof allWineColors;
+
+export default allWineColors;

package/src/validValues/wineType.ts

@@ -1,38 +1,42 @@
 import { defineMessage } from '@lingui/macro';
-import createValidValues from './utils/createValidValues.js';
 import { ValidValueDefinition } from './types/ValidValueDefinition';
+
 export interface WineType extends ValidValueDefinition {}
-export default createValidValues<WineType>({
-  fortified: {
+
+/** Makes sure errors are displayed where the error is introduced. */
+const wineType = (value: WineType) => value;
+
+const allWineTypes = {
+  fortified: wineType({
     key: 'fortified',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineType.fortified',
       message: 'Fortified',
     }),
-    form: {},
-  },
-  pearlwine: {
+  }),
+  pearlwine: wineType({
     key: 'pearlwine',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineType.pearlwine',
       message: 'Pearl wine',
     }),
-    form: {},
-  },
-  sparkling: {
+  }),
+  sparkling: wineType({
     key: 'sparkling',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineType.sparkling',
       message: 'Sparkling wine',
     }),
-    form: {},
-  },
-  wine: {
+  }),
+  wine: wineType({
     key: 'wine',
-    title: defineMessage({
+    label: defineMessage({
       id: 'validValues.wineType.wine',
       message: 'Still wine',
     }),
-    form: {},
-  },
-});
+  }),
+} as const;
+
+export type WineTypeKey = keyof typeof allWineTypes;
+
+export default allWineTypes;

package/dist/validValues/json/appelation.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=appelation.d.ts.map

package/dist/validValues/json/appelation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"appelation.d.ts","sourceRoot":"","sources":["../../../src/validValues/json/appelation.js"],"names":[],"mappings":""}

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

@@ -1,35 +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?: {};
-    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?: {};
-}
-export {};
-//# sourceMappingURL=Award.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Award.d.ts","sourceRoot":"","sources":["../../../src/validValues/types/Award.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtD,UAAU,oBAAoB;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACpC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;IACnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,EAKN,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC;CACf"}

package/dist/validValues/types/Award.js

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

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

@@ -1,35 +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?: {};
-    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?: {};
-}
-export {};
-//# sourceMappingURL=Country.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Country.d.ts","sourceRoot":"","sources":["../../../src/validValues/types/Country.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtD,UAAU,oBAAoB;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACpC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;IACnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,EAKN,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC;CACf"}

package/dist/validValues/types/Country.js

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

package/src/validValues/utils/createValidValues.ts

@@ -1,76 +0,0 @@
-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);
-export type Locale = keyof typeof allMessages;
-
-export default function createValidValues<
-  ValidValue extends ValidValueDefinition = ValidValueDefinition
->(values: Record<string, ValidValue>) {
-  // 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;
-      }
-    }
-
-    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]));
-    },
-  };
-}