ichim-david
commented
3 months ago @JeffersonBledsoe @sneridagh take into consideration that I have close to 0 experience with typescript. I did ask claude sonnet 3.5 if it's a pattern to replace type definitions with simplified definitions. It gave me this reply:
Yes, you can define the intl property for the BlockViewProps interface without directly depending on react-intl. Here's how you can do it:
First, create a simplified version of the IntlShape interface in your @plone/types package. This will contain only the essential properties and methods that you need for your use case.
Use this simplified interface instead of the one from react-intl.
Here's an example of how you could define this:
// In @plone/types/src/intl/index.d.ts
export interface SimplifiedIntlShape {
formatMessage: (descriptor: { id: string; defaultMessage?: string }, values?: Record<string, any>) => string;
formatDate: (value: Date | number, options?: Intl.DateTimeFormatOptions) => string;
formatTime: (value: Date | number, options?: Intl.DateTimeFormatOptions) => string;
formatRelative: (value: Date | number, options?: Intl.RelativeTimeFormatOptions) => string;
formatNumber: (value: number, options?: Intl.NumberFormatOptions) => string;
formatPlural: (value: number, options?: Intl.PluralRulesOptions) => string;
// Add any other methods you need
}// In @plone/types/src/blocks/index.d.ts
import { SimplifiedIntlShape } from '../intl';
export interface BlockViewProps {
// ... other properties
intl: SimplifiedIntlShape;
// ... rest of the properties
}This approach has several advantages:
It removes the direct dependency on react-intl from @plone/types. It provides type checking for the most commonly used intl methods. It's flexible enough to be used with different internationalization libraries that provide similar methods. When using this in your actual Volto components, you can still use the full IntlShape from react-intl, as it will be compatible with this simplified version.
If you need to add more methods or properties to the SimplifiedIntlShape interface in the future, you can do so without affecting the rest of your codebase. END chat response.
With how many functions we call from intl it seems like an easy thing for us todo and provide simplified types. Performing a search gave me some replies that this is a common pattern todo in case you need it. I don't know what Victor thinks about it though so I am leaving this comment to hear his opinion on such a proposal in this case knowing that it has that old react version as peer dependency.
JeffersonBledsoe
sneridagh
react-intl@3.8.0 has a peer dependency of React 16
We can use an override for now in package.json, but it's not ideal:
It would be REALLY nice if we could just avoid bringing in anything React-related at all for this dependency and just have it provide types for services and raw content