@bottlebooks/valid-values 2.1.0 → 3.0.0

package/src/validValues/types/ValidValueDefinition.ts

@@ -4,26 +4,22 @@ interface ValidValueEnabledFor {
   value: string;
 }
 
+/**
+ * Encapsulates the title of a valid value, and if it is localized or not.
+ */
+export type BottlebooksValidValueTitle = string | MessageDescriptor;
+
 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;
-  };
+  label: BottlebooksValidValueTitle;
+}
+
+export interface ValidValueDataDefinition {
   /**
    * Fields that are stored in the database together with each lookup value,
    * because they affect the frontend rendering.
@@ -34,5 +30,22 @@ export interface ValidValueDefinition {
    * eLabels that are marked as incompatible,
    * although there might be no user-visible changes.
    */
-  frontend?: {};
+  data: {
+    logo?: string;
+  };
+}
+
+export interface ValidValueMetadataDefinition {
+  /**
+   * 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.
+   */
+  metadata: {
+    /**
+     * A helpful description shown only when using the form.
+     */
+    tags?: string[];
+    // description?: MessageDescriptor;
+  };
 }

package/src/validValues/utils/loadLocalizedData.ts

@@ -0,0 +1,11 @@
+import { i18n } from '@lingui/core';
+import { allLocaleData, allMessages } from '../../locales/locales.js';
+
+/**
+ * Used to load localized data.
+ * Called on start.
+ */
+export default function loadLocalizedData() {
+  i18n.loadLocaleData(allLocaleData);
+  i18n.load(allMessages);
+}