@axinom/mosaic-messages 0.51.0-rc.3 → 0.51.0-rc.5

package/src/generated/types/payloads/localization/types/entity-field-definition.ts

@@ -1,6 +1,7 @@
-import { FieldDefinitionFieldType } from './field-definition-field-type';
-import { FieldDefinitionUiFieldType } from './field-definition-ui-field-type';
 import { FieldDefinitionValidationRule } from './field-definition-validation-rule';
+import { FieldType } from './field-type';
+import { UiFieldCustomDefinition } from './ui-field-custom-definition';
+import { UiFieldType } from './ui-field-type';
 /**
  * Definition of an entity field.
  */
@@ -12,11 +13,11 @@ export interface EntityFieldDefinition {
   /**
    * The data type of the field defined by this definition
    */
-  field_type: FieldDefinitionFieldType;
+  field_type: FieldType;
   /**
    * The type of user interface element that should be used to display this field
    */
-  ui_field_type: FieldDefinitionUiFieldType;
+  ui_field_type: UiFieldType;
   /**
    * The title of the field definition
    */
@@ -33,6 +34,10 @@ export interface EntityFieldDefinition {
    * Set to false if field definition should be deactivated, and send a separate declare command without the field after the field definition is deactivated to completely delete it.
    */
   is_active?: boolean;
+  /**
+   * Definition of custom Piral extension that should be used to display localization source value and translation editor field
+   */
+  ui_field_custom_definition?: UiFieldCustomDefinition;
   /**
    * An array of field validation rules.
    */

package/src/generated/types/payloads/localization/types/{field-definition-field-type.ts → field-type.ts}

@@ -1,4 +1,4 @@
 /**
  * The data type of the field defined by this definition
  */
-export type FieldDefinitionFieldType = "STRING";
+export type FieldType = "STRING";

package/src/generated/types/payloads/localization/types/index.ts

@@ -2,8 +2,14 @@ export * from './entity-field-definition';
 export * from './entity-localization';
 export * from './entity-localization-field';
 export * from './entity-localization-field-state';
-export * from './field-definition-field-type';
 export * from './field-definition-field-validation-rule';
-export * from './field-definition-ui-field-type';
 export * from './field-definition-validation-rule';
-export * from './field-definition-validation-severity';
+export * from './field-definition-validation-severity';
+export * from './field-type';
+export * from './ui-field-custom-definition';
+export * from './ui-field-custom-definition-edit';
+export * from './ui-field-custom-definition-edit-property-map';
+export * from './ui-field-custom-definition-fallback-type';
+export * from './ui-field-custom-definition-view';
+export * from './ui-field-custom-definition-view-property-map';
+export * from './ui-field-type';

package/src/generated/types/payloads/localization/types/ui-field-custom-definition-edit-property-map.ts

@@ -0,0 +1,17 @@
+/**
+ * Mapping of property names that will be passed from the localization form to the custom Piral extension used for editing the localized value
+ */
+export interface UiFieldCustomDefinitionEditPropertyMap {
+  /**
+   * The name of the property that contains the locale (defaults to 'locale' if not provided)
+   */
+  locale?: string;
+  /**
+   * The name of the property that contains the localized value (defaults to 'value' if not provided)
+   */
+  value?: string;
+  /**
+   * The name of the property that contains the callback function that should be called when the value is changed (defaults to 'onChange' if not provided)
+   */
+  on_change?: string;
+}

package/src/generated/types/payloads/localization/types/ui-field-custom-definition-edit.ts

@@ -0,0 +1,15 @@
+import { UiFieldCustomDefinitionEditPropertyMap } from './ui-field-custom-definition-edit-property-map';
+/**
+ * Configuration of the Piral extension used for editing the translated value
+ */
+export interface UiFieldCustomDefinitionEdit {
+  /**
+   * Custom Piral extension name that will be used for editing localization
+   */
+  component: string;
+  props?: { [name: string]: string | number | boolean | (unknown)[] | { [name: string]: unknown } };
+  /**
+   * Mapping of property names that will be passed from the localization form to the custom Piral extension used for editing the localized value
+   */
+  property_map?: UiFieldCustomDefinitionEditPropertyMap;
+}

package/src/generated/types/payloads/localization/types/ui-field-custom-definition-fallback-type.ts

@@ -0,0 +1,4 @@
+/**
+ * The fallback type to use if the custom UI field type is not available
+ */
+export type UiFieldCustomDefinitionFallbackType = "TEXTBOX" | "TEXTAREA";

package/src/generated/types/payloads/localization/types/ui-field-custom-definition-view-property-map.ts

@@ -0,0 +1,9 @@
+/**
+ * Mapping of property names that will be passed from the localization form to the custom Piral extension for viewing the source value
+ */
+export interface UiFieldCustomDefinitionViewPropertyMap {
+  /**
+   * The name of the property that contains localization source value (defaults to 'value' if not provided)
+   */
+  value?: string;
+}

package/src/generated/types/payloads/localization/types/ui-field-custom-definition-view.ts

@@ -0,0 +1,15 @@
+import { UiFieldCustomDefinitionViewPropertyMap } from './ui-field-custom-definition-view-property-map';
+/**
+ * Configuration of the Piral extension used for viewing the source value
+ */
+export interface UiFieldCustomDefinitionView {
+  /**
+   * Piral extension name that will be used for viewing source value
+   */
+  component: string;
+  props?: { [name: string]: string | number | boolean | (unknown)[] | { [name: string]: unknown } };
+  /**
+   * Mapping of property names that will be passed from the localization form to the custom Piral extension for viewing the source value
+   */
+  property_map?: UiFieldCustomDefinitionViewPropertyMap;
+}

package/src/generated/types/payloads/localization/types/ui-field-custom-definition.ts

@@ -0,0 +1,20 @@
+import { UiFieldCustomDefinitionEdit } from './ui-field-custom-definition-edit';
+import { UiFieldCustomDefinitionFallbackType } from './ui-field-custom-definition-fallback-type';
+import { UiFieldCustomDefinitionView } from './ui-field-custom-definition-view';
+/**
+ * Definition of custom Piral extension that should be used to display localization source value and translation editor field
+ */
+export interface UiFieldCustomDefinition {
+  /**
+   * The fallback type to use if the custom UI field type is not available
+   */
+  fallback_type: UiFieldCustomDefinitionFallbackType;
+  /**
+   * Configuration of the Piral extension used for viewing the source value
+   */
+  view?: UiFieldCustomDefinitionView;
+  /**
+   * Configuration of the Piral extension used for editing the translated value
+   */
+  edit?: UiFieldCustomDefinitionEdit;
+}

package/src/generated/types/payloads/localization/types/{field-definition-ui-field-type.ts → ui-field-type.ts}

@@ -1,4 +1,4 @@
 /**
  * The type of user interface element that should be used to display this field
  */
-export type FieldDefinitionUiFieldType = "TEXTBOX" | "TEXTAREA";
+export type UiFieldType = "TEXTBOX" | "TEXTAREA" | "CUSTOM";

package/dist/generated/types/payloads/localization/types/field-definition-field-type.d.ts

@@ -1,5 +0,0 @@
-/**
- * The data type of the field defined by this definition
- */
-export type FieldDefinitionFieldType = "STRING";
-//# sourceMappingURL=field-definition-field-type.d.ts.map

package/dist/generated/types/payloads/localization/types/field-definition-field-type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"field-definition-field-type.d.ts","sourceRoot":"","sources":["../../../../../../src/generated/types/payloads/localization/types/field-definition-field-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC"}

package/dist/generated/types/payloads/localization/types/field-definition-field-type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"field-definition-field-type.js","sourceRoot":"","sources":["../../../../../../src/generated/types/payloads/localization/types/field-definition-field-type.ts"],"names":[],"mappings":""}

package/dist/generated/types/payloads/localization/types/field-definition-ui-field-type.d.ts

@@ -1,5 +0,0 @@
-/**
- * The type of user interface element that should be used to display this field
- */
-export type FieldDefinitionUiFieldType = "TEXTBOX" | "TEXTAREA";
-//# sourceMappingURL=field-definition-ui-field-type.d.ts.map

package/dist/generated/types/payloads/localization/types/field-definition-ui-field-type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"field-definition-ui-field-type.d.ts","sourceRoot":"","sources":["../../../../../../src/generated/types/payloads/localization/types/field-definition-ui-field-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,SAAS,GAAG,UAAU,CAAC"}

package/dist/generated/types/payloads/localization/types/field-definition-ui-field-type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"field-definition-ui-field-type.js","sourceRoot":"","sources":["../../../../../../src/generated/types/payloads/localization/types/field-definition-ui-field-type.ts"],"names":[],"mappings":""}