CardView - create .d.ts by pomahtri · Pull Request #29455 · DevExpress/DevExtreme

pomahtri · 2025-03-31T07:23:01Z

No description provided.

… dxCardViewOptions (fails on topic generator without direct parent component)

(cherry picked from commit c053465)

(cherry picked from commit 5a49b88)

…ay's 19afc7e (cherry picked from commit ec1d5f6)

(cherry picked from commit d5efe5b)

(cherry picked from commit 5d7428b)

(cherry picked from commit e813422)

(cherry picked from commit 77b4e4a)

IlyaKhD · 2025-05-06T10:03:36Z

+ * @public
+ * @namespace DevExpress.ui.dxCardView
+ */
+export type CardHeaderToolbarItem = dxToolbarItem & {


Suggested change

export type CardHeaderToolbarItem = dxToolbarItem & {

export type CardHeaderItem = dxToolbarItem & {

Since it is only used in CardHeader, the Toolbar part is unnecessary

Fixed

But one thought worried me a bit
If we would like to have some items in the Card in future -> the CardHeaderItem name will be already reserved

IlyaKhD · 2025-05-06T10:04:07Z

+};
+
+/** @public */
+export type CardHeaderPredefinedToolbarItem = 'selectionCheckBox' | 'updateButton' | 'deleteButton';


Suggested change

export type CardHeaderPredefinedToolbarItem = 'selectionCheckBox' | 'updateButton' | 'deleteButton';

export type CardHeaderPredefinedItem = 'selectionCheckBox' | 'updateButton' | 'deleteButton';

Since it is only used in CardHeader, the Toolbar part is unnecessary

Fixed

Same thoughts like about the CardHeaderToolbarItem fix
But the chance here is extremely low,I guess

IlyaKhD · 2025-05-06T10:11:37Z

+/**
+ * @docid
+ */
+type WithFieldValueInfo = {


Question
Just curious, why WithFieldValueInfo, not FieldValueInfo?

Because this type is used to add sth to existing types, I guess :)

E.g:

export type FieldValuePreparedEvent = EventInfo<dxCardView> & WithFieldValueInfo;

An event with field value info

It sounds like a name of a HOC

IlyaKhD · 2025-05-06T10:14:16Z

+ * @public
+ * @namespace DevExpress.ui.dxCardView
+ */
+export type FieldInfoType = { // TODO: rename to FieldInfo


Suggested change

export type FieldInfoType = { // TODO: rename to FieldInfo

export type FieldInfo = {

I see the TODO, just to have a conversation entry for ir

Fixed

But @pomahtri warned that the FieldInfo causes some error (I don't have more details)
So, if we will face complex issues with this name -> let's rollback my fix to the FieldInfoType with TODO

Hi, @IlyaKhD, @wdevfx. FieldInfo causes a conflict with FieldInfo from FilterBuilder, which is also used in CardView and imported in generated components directly from 'filter_builder' module. This change will lead to re-generation in CardView and other grids with import { FieldInfo } from 'filter_builder' replaced to import { FieldInfo } from 'card_view' which is totally wrong. So we can revert renaming or use WA with prefixed internal type.

IlyaKhD · 2025-05-06T12:47:31Z

+     * @docid
+     * @type object
+     */
+    value: unknown;


Not 100% sure about that, but it seems that we shouldn't use unknown for values that can be passed to consuming code. It's generallly a good practise, but all the other components currently use any.

Suggested change

value: unknown;

value: any;

Agree with u here
Let's not risk and use any for now

Btw, @IlyaKhD, what do u think about unknown in generics?
I guess it should be alright, but at night it started worried me a bit because unknown !== any

Well, I don't have a general idea for all generics, better investigate some samples. We have reasons to avoid giving unknown outside, and can leverage from marking as unknown for data going inside. Is there a gurantee that generics never given outside - hm... not sure about that, it will be hard to lint, I think. Not sure about possible covariance / contravariance issues, 2-way bindings in Angualr, etc

IlyaKhD · 2025-05-06T12:52:09Z

+     * @public
+     * @type object
+     */
+    dragging?: Pick<dxSortableOptions, 'dropFeedbackMode' | 'scrollSpeed' | 'scrollSensitivity' | 'onDragChange' | 'onDragEnd' | 'onDragMove' | 'onDragStart' | 'onRemove' | 'onReorder'>;


Suggestion
Maybe it would be useful to extract a public type for dragging:HeaderPanelDragging

Agree -> fixed

@IlyaKhD, could u please re-check that I did it right (I may have missed some jsDoc comment or sth)?
But as far as I can see, everything should be alright :)

IlyaKhD · 2025-05-06T13:01:11Z

+     * @docid
+     * @public
+     */
+    filterBuilder?: dxFilterBuilderOptions;


You can create a local public alias, so that it get into card_view_types.d.ts and aggregated exports in framework packages:

/** * @public */ type FilterBuilder = dxFilterBuilderOptions; export { FilterBuilder }

Suggested change

filterBuilder?: dxFilterBuilderOptions;

filterBuilder?: FilterBuilder;

This change leads to the following error:

System.Exception: "dxCardView.filterBuilder" has unknown type. Try adding @docid tag to the type. at DevExtreme.NgSmdGenerator.StrongType.Builder.Build(String optionName, String optionFullName, DataType[] types, Boolean hasAcceptableValues, Boolean hasNestedOptions) at DevExtreme.NgSmdGenerator.Program.BuildStrongType(Builder builder, HierarchicalMember member, String optionFullName) at DevExtreme.NgSmdGenerator.Program.<>c__DisplayClass2_0.<ToSerializable>b__5(HierarchicalMember m) at System.Linq.Enumerable.ToDictionary[TSource,TKey,TElement](IEnumerable`1 source, Func`2 keySelector, Func`2 elementSelector, IEqualityComparer`1 comparer) at System.Linq.Enumerable.ToDictionary[TSource,TKey,TElement](IEnumerable`1 source, Func`2 keySelector, Func`2 elementSelector) at DevExtreme.NgSmdGenerator.Program.ToSerializable(HierarchicalMember member, Builder typesBuilder, String name) at DevExtreme.NgSmdGenerator.Program.<>c__DisplayClass1_0.<MainCore>b__3(HierarchicalMember m) at System.Linq.Enumerable.ToDictionary[TSource,TKey,TElement](TSource[] source, Func`2 keySelector, Func`2 elementSelector, IEqualityComparer`1 comparer) at System.Linq.Enumerable.ToDictionary[TSource,TKey,TElement](IEnumerable`1 source, Func`2 keySelector, Func`2 elementSelector, IEqualityComparer`1 comparer) at DevExtreme.NgSmdGenerator.Program.MainCore(ProgramConfig programConfig) at DevExtreme.NgSmdGenerator.Program.Main(String[] args)

As logs adviced -> I added the docid:

/** * @docid * @public */ export type FilterBuilder = dxFilterBuilderOptions;

But I'm not sure that it's ok (we already have docid on the dxFilterBuilderOptions)
And get the following error on the last Angular regenerate step:

[04:00:49] TypeError: Cannot set properties of undefined (setting 'baseClass') at ComponentMetadataGenerator.generateComplexOptionByType (/Users/wdevfx/work/devextreme_prod/node_modules/.pnpm/devextreme-internal-tools@18.0.0-beta.1/node_modules/devextreme-internal-tools/ts/angular-components-generator/metadata-generator.js:444:43) at ComponentMetadataGenerator.generate (/Users/wdevfx/work/devextreme_prod/node_modules/.pnpm/devextreme-internal-tools@18.0.0-beta.1/node_modules/devextreme-internal-tools/ts/angular-components-generator/metadata-generator.js:283:47) at /Users/wdevfx/work/devextreme_prod/packages/devextreme-angular/gulpfile.js:38:13 at bound (node:domain:433:15) at runBound (node:domain:444:12) at asyncRunner (/Users/wdevfx/work/devextreme_prod/node_modules/.pnpm/async-done@1.3.2/node_modules/async-done/index.js:55:18) at process.processTicksAndRejections (node:internal/process/task_queues:77:11)

@IlyaKhD, may we temporarily leave it as is with direct dxFilterBuilderOptions type?

…s) without CardView

…ilder FieldInfo

This reverts commit 7b74d23.

Co-authored-by: Mikhail Preyskurantov <5574159+mpreyskurantov@users.noreply.github.com> Co-authored-by: wdevfx <ilya.vinogradov@devexpress.com> Co-authored-by: alexlavrov <alex.s.lavrov@gmail.com>

pomahtri added the 25_1 label Mar 31, 2025

pomahtri requested a review from a team March 31, 2025 07:23

pomahtri self-assigned this Mar 31, 2025

pomahtri requested a review from a team March 31, 2025 07:23

pomahtri mentioned this pull request Mar 31, 2025

CardView - create .d.ts (1st part) #29310

Closed

mpreyskurantov mentioned this pull request Mar 31, 2025

WIP: CardView - create .d.ts (1st part) #29465

Closed

Base automatically changed from grids/cardview/ssr to grids/cardview/main April 3, 2025 18:44

pomahtri changed the title ~~CardView - create .d.ts (1st part)~~ CardView - create .d.ts Apr 21, 2025

pomahtri force-pushed the grids/cardview/dts_1_of_3 branch 4 times, most recently from d2b541e to 364b395 Compare April 22, 2025 09:10

pomahtri force-pushed the grids/cardview/main branch from 541cfd5 to 43037ec Compare April 22, 2025 12:17

pomahtri requested review from a team as code owners April 22, 2025 12:17

pomahtri force-pushed the grids/cardview/dts_1_of_3 branch from d7db79e to 86284ed Compare April 22, 2025 12:27

pomahtri removed request for a team April 22, 2025 12:28

Base automatically changed from grids/cardview/main to 25_1 April 22, 2025 13:16

pomahtri force-pushed the grids/cardview/dts_1_of_3 branch 2 times, most recently from 27bf1f6 to 400c6fa Compare April 22, 2025 15:42

pomahtri and others added 9 commits April 22, 2025 22:48

implement

8771fd6

fix

451a5cf

fix

1e662e3

fix

72c98b1

fix

78733cb

fix "validate-declarations" + regenerate-all

ab4cf8e

move onProp / onDataErrorOccurred (+ signature - e / order) to direct…

71d310f

… dxCardViewOptions (fails on topic generator without direct parent component)

skip "injectDescriptions" (fails coz of types end with Options)

95d8383

skip "injectDescriptions" - angular

cb6f636

mpreyskurantov and others added 10 commits May 1, 2025 20:40

CardInfo -> values: red doc tag (type)

f802332

(cherry picked from commit c053465)

type HeaderPanel: ns

bfeed6f

(cherry picked from commit 5a49b88)

'WithFieldInfo' is declared but never used.ts(6196), likely after tod…

2eaa37d

…ay's 19afc7e (cherry picked from commit ec1d5f6)

ExplicitTypes public + move to end with Properties

a0f38b5

(cherry picked from commit d5efe5b)

re-exports

f08346c

(cherry picked from commit 5d7428b)

dxCardView method(s) notes

1bf3809

(cherry picked from commit e813422)

events handlers types

eb13b6e

(cherry picked from commit 77b4e4a)

Merge branch '25_1' into grids/cardview/dts_1_of_3

5a6b282

feat(Angular): regenerate-all after merge with 25_1

308094c

Editing -> dxCardViewEditing like for other grids (vs chat.d.ts Editing)

60eb9d6

IlyaKhD reviewed May 6, 2025

View reviewed changes

mpreyskurantov and others added 5 commits May 6, 2025 17:56

tools/ng-smd-cfg.json (mutations -> remove -> card_view): regenerate-all

20d27e4

Merge branch '25_1' into grids/cardview/dts_1_of_3

d0ec943

feat: regenerate-all after merge 25_1

df9d95f

fix(CardView): d.ts code review fixes

635c82f

fix(CardView): regenerate after code review fixes

7b3e716

wdevfx requested a review from IlyaKhD May 8, 2025 00:08

alexslavr and others added 4 commits May 8, 2025 11:32

Merge branch '25_1' into grids/cardview/dts_1_of_3

3a7ef6f

Restore ng-smd-cfg.json after bad merge. Regenerate NG (old component…

86114f4

…s) without CardView

Add prefixed type dxCardViewFieldInfo to avoid conflict with FilterBu…

6a7d0dc

…ilder FieldInfo

remove entire toolbar (similar to sch)

9092d60

mpreyskurantov mentioned this pull request May 8, 2025

CardView topics DevExpress/devextreme-documentation#7312

Merged

remove entire CardHeader (similar to Toolbar)

1776c02

mpreyskurantov approved these changes May 8, 2025

View reviewed changes

mpreyskurantov merged commit 7b74d23 into 25_1 May 8, 2025
300 checks passed

mpreyskurantov deleted the grids/cardview/dts_1_of_3 branch May 8, 2025 16:45

mpreyskurantov added a commit that referenced this pull request May 8, 2025

Revert "CardView - create .d.ts (#29455)"

d1464e4

This reverts commit 7b74d23.

mpreyskurantov mentioned this pull request May 8, 2025

CardView - Resolve path to @preact/signals-core in demos #29827

Merged

	export type CardHeaderToolbarItem = dxToolbarItem & {
	export type CardHeaderItem = dxToolbarItem & {

	export type CardHeaderPredefinedToolbarItem = 'selectionCheckBox' \| 'updateButton' \| 'deleteButton';
	export type CardHeaderPredefinedItem = 'selectionCheckBox' \| 'updateButton' \| 'deleteButton';

	export type FieldInfoType = { // TODO: rename to FieldInfo
	export type FieldInfo = {

	filterBuilder?: dxFilterBuilderOptions;
	filterBuilder?: FilterBuilder;

Conversation

pomahtri commented Mar 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wdevfx May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wdevfx May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexslavr May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wdevfx May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wdevfx May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

wdevfx May 7, 2025 •

edited

Loading

wdevfx May 7, 2025 •

edited

Loading

alexslavr May 8, 2025 •

edited

Loading

wdevfx May 7, 2025 •

edited

Loading

wdevfx May 7, 2025 •

edited

Loading