1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
import {
type ForwardRefRenderFunction,
type HTMLAttributes,
forwardRef,
useCallback,
type ReactElement,
} from 'react';
import { useIntl } from 'react-intl';
import type { Maybe, ValueOf } from '../../../types';
import {
Time,
type SocialWebsite,
Link,
SocialLink,
Figure,
} from '../../atoms';
import { MetaList, type MetaItemData } from '../../molecules';
import styles from './project-overview.module.scss';
export type Repository = {
id: Extract<SocialWebsite, 'Github' | 'Gitlab'>;
label: string;
url: string;
};
export type ProjectPopularity = {
count: number;
url?: string;
};
export type ProjectMeta = {
creationDate: string;
lastUpdateDate: string;
license: string;
popularity: ProjectPopularity;
repositories: Repository[];
technologies: string[];
};
const validMeta = [
'creationDate',
'lastUpdateDate',
'license',
'popularity',
'repositories',
'technologies',
] satisfies (keyof ProjectMeta)[];
const isValidMetaKey = (key: string): key is keyof ProjectMeta =>
(validMeta as string[]).includes(key);
export type ProjectOverviewProps = Omit<
HTMLAttributes<HTMLDivElement>,
'children'
> & {
/**
* The project cover.
*/
cover?: ReactElement;
/**
* The project meta.
*/
meta: Partial<ProjectMeta>;
/**
* The project name.
*/
name: string;
};
const ProjectOverviewWithRef: ForwardRefRenderFunction<
HTMLDivElement,
ProjectOverviewProps
> = ({ className = '', cover, meta, name, ...props }, ref) => {
const wrapperClass = `${styles.wrapper} ${className}`;
const intl = useIntl();
const coverLabel = intl.formatMessage(
{
defaultMessage: 'Illustration of {projectName}',
description: 'ProjectOverview: cover accessible name',
id: '701ggm',
},
{ projectName: name }
);
const metaLabels = {
creationDate: intl.formatMessage({
defaultMessage: 'Created on:',
description: 'ProjectOverview: creation date label',
id: 'c0Oecl',
}),
lastUpdateDate: intl.formatMessage({
defaultMessage: 'Updated on:',
description: 'ProjectOverview: update date label',
id: 'JbT+fA',
}),
license: intl.formatMessage({
defaultMessage: 'License:',
description: 'ProjectOverview: license label',
id: 'QtdnFV',
}),
popularity: intl.formatMessage({
defaultMessage: 'Popularity:',
description: 'ProjectOverview: popularity label',
id: 'cIAOyy',
}),
repositories: intl.formatMessage({
defaultMessage: 'Repositories:',
description: 'ProjectOverview: repositories label',
id: '3bKzk0',
}),
technologies: intl.formatMessage({
defaultMessage: 'Technologies:',
description: 'ProjectOverview: technologies label',
id: 'OWkqXt',
}),
} satisfies Record<keyof ProjectMeta, string>;
const getMetaValue = useCallback(
(key: keyof ProjectMeta, value: ValueOf<ProjectMeta>) => {
if (typeof value === 'string') {
return key === 'license' ? value : <Time date={value} />;
}
if (
(value instanceof Object || typeof value === 'object') &&
!Array.isArray(value)
) {
const stars = intl.formatMessage(
{
defaultMessage:
'{starsCount, plural, =0 {No stars} one {# star} other {# stars}}',
description: 'ProjectOverview: stars count',
id: 'PBdVsm',
},
{ starsCount: value.count }
);
return value.url ? (
<>
⭐ <Link href={value.url}>{stars}</Link>
</>
) : (
`⭐\u00A0${stars}`
);
}
return value.map((v) => {
if (typeof v === 'string') return { id: v, value: v };
return {
id: v.id,
value: <SocialLink icon={v.id} label={v.label} url={v.url} />,
};
});
},
[intl]
);
const getMetaItems = useCallback((): MetaItemData[] => {
const keys = Object.keys(meta).filter(isValidMetaKey);
return keys
.map((key): Maybe<MetaItemData> => {
const value = meta[key];
return value
? {
id: key,
label: metaLabels[key],
value: getMetaValue(key, value),
hasBorderedValues: key === 'technologies',
hasInlinedValues:
(key === 'technologies' || key === 'repositories') &&
Array.isArray(value) &&
value.length > 1,
}
: undefined;
})
.filter((item): item is MetaItemData => typeof item !== 'undefined');
}, [getMetaValue, meta, metaLabels]);
return (
<div {...props} className={wrapperClass} ref={ref}>
{cover ? (
<Figure aria-label={coverLabel} className={styles.cover} hasBorders>
{cover}
</Figure>
) : null}
<MetaList className={styles.meta} isInline items={getMetaItems()} />
</div>
);
};
export const ProjectOverview = forwardRef(ProjectOverviewWithRef);
|
