Update generatePreviewTypes to add translate function

Author: MendixBart

packages/pluggable-widgets-tools/CHANGELOG.md

@@ -6,8 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Added
+
+-   We added the translate function to the preview arguments. This can be used to translate texts show in the widget preview.
+
 ### Changed
 
+-   The renderMode property in the preview arguments is no longer considered optional.
+
 #### Rollup 3
 
 We upgraded the bundling setup. For most packages this meant updating to the latest minor or patch versions, but for Rollup we upgraded from major version 2 to 3. If your widget uses custom configurations you may need to perform some actions.

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/association.ts

@@ -27,7 +27,8 @@ export interface MyWidgetPreviewProps {
     style: string;
     styleObject?: CSSProperties;
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     reference: string;
     referenceSet: string;
     referenceOrSet: string;

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/atribute-linked-action.ts

@@ -14,7 +14,8 @@ export interface MyWidgetContainerProps {
 
 export interface MyWidgetPreviewProps {
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     collapsed: string;
     onToggleCollapsed: {} | null;
 }
@@ -52,7 +53,8 @@ export interface MyWidgetContainerProps {
 
 export interface MyWidgetPreviewProps {
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     onToggleCollapsed: {} | null;
     datasourceProperties: DatasourcePropertiesPreviewType[];
 }

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/containment.ts

@@ -25,7 +25,8 @@ export interface MyWidgetPreviewProps {
     style: string;
     styleObject?: CSSProperties;
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     content: { widgetCount: number; renderer: ComponentType<{ children: ReactNode; caption?: string }> };
     description: string;
     action: {} | null;

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/datasource.ts

@@ -52,7 +52,8 @@ export interface MyWidgetContainerProps {
 
 export interface MyWidgetPreviewProps {
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     contentSource: {} | { caption: string } | { type: string } | null;
     optionalSource: {} | { caption: string } | { type: string } | null;
     content: { widgetCount: number; renderer: ComponentType<{ children: ReactNode; caption?: string }> };

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/expression.ts

@@ -29,7 +29,8 @@ export interface MyWidgetPreviewProps {
     style: string;
     styleObject?: CSSProperties;
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     myDataSource: {} | { caption: string } | { type: string } | null;
     expressionReturnTypeType: string;
     expressionReturnTypeTypeDataSource: string;

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/file.ts

@@ -17,7 +17,8 @@ export interface MyWidgetContainerProps {
 
 export interface MyWidgetPreviewProps {
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     file: string;
     file2: string;
     description: string;

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/icon.ts

@@ -24,7 +24,8 @@ export interface MyWidgetContainerProps {
 
 export interface MyWidgetPreviewProps {
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     icons: IconsPreviewType[];
 }
 `;

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/index.ts

@@ -52,7 +52,8 @@ export interface MyWidgetPreviewProps {
     style: string;
     styleObject?: CSSProperties;
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     valueAttribute: string;
     mywidgetValue: string;
     valueExpression: string;
@@ -125,7 +126,8 @@ export interface MyWidgetPreviewProps {
     style: string;
     styleObject?: CSSProperties;
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     valueAttribute: string;
     mywidgetValue: string;
     valueExpression: string;
@@ -189,7 +191,8 @@ export interface MyWidgetContainerProps {
 
 export interface MyWidgetPreviewProps {
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     valueAttribute: string;
     mywidgetValue: string;
     valueExpression: string;

packages/pluggable-widgets-tools/src/typings-generator/__tests__/outputs/list-action.ts

@@ -24,7 +24,8 @@ export interface MyWidgetContainerProps {
 
 export interface MyWidgetPreviewProps {
     readOnly: boolean;
-    renderMode?: "design" | "xray" | "structure";
+    renderMode: "design" | "xray" | "structure";
+    translate: (text: string) => string;
     actions: ActionsPreviewType[];
 }
 `;