@progress/kendo-typescript-api-tasks 1.1.2-dev.23 → 1.1.2-dev.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/index.js +14 -5
  2. package/lib/comment.js +14 -9
  3. package/lib/component-page.js +1 -1
  4. package/lib/generator.js +13 -10
  5. package/lib/is-constructor.js +2 -1
  6. package/lib/is-method.js +2 -1
  7. package/lib/map-constructors.js +3 -2
  8. package/lib/map-props.js +8 -7
  9. package/lib/plugins/decorators.js +43 -0
  10. package/lib/return-type.js +8 -5
  11. package/lib/type-utils.js +5 -4
  12. package/package.json +6 -5
  13. package/test/api.js +22 -15
  14. package/test/class.json +29 -9
  15. package/test/components-def.json +56 -16
  16. package/test/events-def.json +39 -8
  17. package/test/fields-def.json +62 -12
  18. package/test/fn-def.json +41 -10
  19. package/test/fn.json +62 -13
  20. package/test/inputs-def.json +27 -3
  21. package/test/interface-comments.json +84 -23
  22. package/test/intersection.json +1 -1
  23. package/test/package.json +7 -6
package/test/components-def.json CHANGED
@@ -2,11 +2,21 @@
2
2
  "directive": {
3
3
  "name": "MyDirective",
4
4
  "comment": {
5
- "shortText": "Represents the Kendo UI Grid component for Angular.",
6
- "tags": [
5
+ "summary": [
7
6
  {
8
- "tag": "example",
9
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
7
+ "kind": "text",
8
+ "text": "Represents the Kendo UI Grid component for Angular."
9
+ }
10
+ ],
11
+ "blockTags": [
12
+ {
13
+ "tag": "@example",
14
+ "content": [
15
+ {
16
+ "kind": "code",
17
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
18
+ }
19
+ ]
10
20
  }
11
21
  ]
12
22
  },
@@ -26,11 +36,21 @@
26
36
  "exportedDirective": {
27
37
  "name": "ExportedDirective",
28
38
  "comment": {
29
- "shortText": "Represents the Kendo UI Grid component for Angular.",
30
- "tags": [
39
+ "summary": [
40
+ {
41
+ "kind": "text",
42
+ "text": "Represents the Kendo UI Grid component for Angular."
43
+ }
44
+ ],
45
+ "blockTags": [
31
46
  {
32
- "tag": "example",
33
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
47
+ "tag": "@example",
48
+ "content": [
49
+ {
50
+ "kind": "code",
51
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
52
+ }
53
+ ]
34
54
  }
35
55
  ]
36
56
  },
@@ -50,11 +70,21 @@
50
70
  "component": {
51
71
  "name": "MyComponent",
52
72
  "comment": {
53
- "shortText": "Represents the Kendo UI Grid component for Angular.",
54
- "tags": [
73
+ "summary": [
55
74
  {
56
- "tag": "example",
57
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
75
+ "kind": "text",
76
+ "text": "Represents the Kendo UI Grid component for Angular."
77
+ }
78
+ ],
79
+ "blockTags": [
80
+ {
81
+ "tag": "@example",
82
+ "content": [
83
+ {
84
+ "kind": "code",
85
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
86
+ }
87
+ ]
58
88
  }
59
89
  ]
60
90
  },
@@ -74,11 +104,21 @@
74
104
  "exportedComponent": {
75
105
  "name": "ExportedComponent",
76
106
  "comment": {
77
- "shortText": "Represents the Kendo UI Grid component for Angular.",
78
- "tags": [
107
+ "summary": [
108
+ {
109
+ "kind": "text",
110
+ "text": "Represents the Kendo UI Grid component for Angular."
111
+ }
112
+ ],
113
+ "blockTags": [
79
114
  {
80
- "tag": "example",
81
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
115
+ "tag": "@example",
116
+ "content": [
117
+ {
118
+ "kind": "code",
119
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
120
+ }
121
+ ]
82
122
  }
83
123
  ]
84
124
  },
package/test/events-def.json CHANGED
@@ -5,8 +5,16 @@
5
5
  "isExported": true
6
6
  },
7
7
  "comment": {
8
- "shortText": "Short text",
9
- "text": "Long text"
8
+ "summary": [
9
+ {
10
+ "kind": "text",
11
+ "text": "Short text"
12
+ },
13
+ {
14
+ "kind": "text",
15
+ "text": "Long text"
16
+ }
17
+ ]
10
18
  },
11
19
  "decorators": [
12
20
  {
@@ -29,7 +37,12 @@
29
37
  "isPublic": true
30
38
  },
31
39
  "comment": {
32
- "shortText": "Fires each time the user selects a new value."
40
+ "summary": [
41
+ {
42
+ "kind": "text",
43
+ "text": "Fires each time the user selects a new value."
44
+ }
45
+ ]
33
46
  },
34
47
  "decorators": [
35
48
  {
@@ -85,7 +98,12 @@
85
98
  "isPublic": true
86
99
  },
87
100
  "comment": {
88
- "shortText": "Fires each time the user focuses the input element."
101
+ "summary": [
102
+ {
103
+ "kind": "text",
104
+ "text": "Fires each time the user focuses the input element."
105
+ }
106
+ ]
89
107
  },
90
108
  "decorators": [
91
109
  {
@@ -95,7 +113,7 @@
95
113
  "name": "Output"
96
114
  },
97
115
  "arguments": {
98
- "bindingPropertyName": "'focus'"
116
+ "obj": "'focus'"
99
117
  }
100
118
  }
101
119
  ],
@@ -120,8 +138,16 @@
120
138
  "isExported": true
121
139
  },
122
140
  "comment": {
123
- "shortText": "Short text",
124
- "text": "Long text"
141
+ "summary": [
142
+ {
143
+ "kind": "text",
144
+ "text": "Short text"
145
+ },
146
+ {
147
+ "kind": "text",
148
+ "text": "Long text"
149
+ }
150
+ ]
125
151
  },
126
152
  "decorators": [
127
153
  {
@@ -144,7 +170,12 @@
144
170
  "isPublic": true
145
171
  },
146
172
  "comment": {
147
- "shortText": "Fires each time the user selects a new value."
173
+ "summary": [
174
+ {
175
+ "kind": "text",
176
+ "text": "Fires each time the user selects a new value."
177
+ }
178
+ ]
148
179
  },
149
180
  "type": {
150
181
  "type": "reference",
package/test/fields-def.json CHANGED
@@ -1,12 +1,22 @@
1
1
  {
2
2
  "withoutComment": {
3
3
  "name": "AddCommandDirective",
4
+ "variant": "declaration",
5
+ "kind": 128,
4
6
  "flags": {
5
7
  "isExported": true
6
8
  },
7
9
  "comment": {
8
- "shortText": "Short text",
9
- "text": "Long text"
10
+ "summary": [
11
+ {
12
+ "kind": "text",
13
+ "text": "Short text\n"
14
+ },
15
+ {
16
+ "kind": "text",
17
+ "text": "Long text"
18
+ }
19
+ ]
10
20
  },
11
21
  "decorators": [
12
22
  {
@@ -50,8 +60,16 @@
50
60
  "isExported": true
51
61
  },
52
62
  "comment": {
53
- "shortText": "Short text",
54
- "text": "Long text"
63
+ "summary": [
64
+ {
65
+ "kind": "text",
66
+ "text": "Short text\n"
67
+ },
68
+ {
69
+ "kind": "text",
70
+ "text": "Long text"
71
+ }
72
+ ]
55
73
  },
56
74
  "decorators": [
57
75
  {
@@ -74,8 +92,16 @@
74
92
  "isPublic": true
75
93
  },
76
94
  "comment": {
77
- "shortText": "some comment",
78
- "text": "long text"
95
+ "summary": [
96
+ {
97
+ "kind": "text",
98
+ "text": "some comment\n"
99
+ },
100
+ {
101
+ "kind": "text",
102
+ "text": "long text"
103
+ }
104
+ ]
79
105
  },
80
106
  "type": {
81
107
  "type": "reference",
@@ -98,8 +124,16 @@
98
124
  "isExported": true
99
125
  },
100
126
  "comment": {
101
- "shortText": "Short text",
102
- "text": "Long text"
127
+ "summary": [
128
+ {
129
+ "kind": "text",
130
+ "text": "Short text\n"
131
+ },
132
+ {
133
+ "kind": "text",
134
+ "text": "Long text"
135
+ }
136
+ ]
103
137
  },
104
138
  "decorators": [
105
139
  {
@@ -122,8 +156,16 @@
122
156
  "isPublic": true
123
157
  },
124
158
  "comment": {
125
- "shortText": "some comment",
126
- "text": "long text"
159
+ "summary": [
160
+ {
161
+ "kind": "text",
162
+ "text": "some comment\n"
163
+ },
164
+ {
165
+ "kind": "text",
166
+ "text": "long text"
167
+ }
168
+ ]
127
169
  },
128
170
  "decorators": [
129
171
  {
@@ -157,8 +199,16 @@
157
199
  "isExported": true
158
200
  },
159
201
  "comment": {
160
- "shortText": "Short text",
161
- "text": "Long text"
202
+ "summary": [
203
+ {
204
+ "kind": "text",
205
+ "text": "Short text\n"
206
+ },
207
+ {
208
+ "kind": "text",
209
+ "text": "Long text"
210
+ }
211
+ ]
162
212
  },
163
213
  "decorators": [
164
214
  {
package/test/fn-def.json CHANGED
@@ -14,13 +14,34 @@
14
14
  "kindString": "Call signature",
15
15
  "flags": {},
16
16
  "comment": {
17
- "shortText": "SIG_DESC",
18
- "text": "SIG_TEXT",
19
- "returns": "SIG_RETURNS",
20
- "tags": [
17
+ "summary": [
21
18
  {
22
- "tag": "example",
23
- "text": "SIG_EXAMPLE"
19
+ "kind": "text",
20
+ "text": "SIG_DESC"
21
+ },
22
+ {
23
+ "kind": "text",
24
+ "text": "SIG_TEXT"
25
+ }
26
+ ],
27
+ "blockTags": [
28
+ {
29
+ "tag": "@returns",
30
+ "content": [
31
+ {
32
+ "kind": "code",
33
+ "text": "SIG_RETURN"
34
+ }
35
+ ]
36
+ },
37
+ {
38
+ "tag": "@example",
39
+ "content": [
40
+ {
41
+ "kind": "code",
42
+ "text": "SIG_EXAMPLE"
43
+ }
44
+ ]
24
45
  }
25
46
  ]
26
47
  },
@@ -38,13 +59,18 @@
38
59
  "kindString": "Parameter",
39
60
  "flags": {},
40
61
  "comment": {
41
- "text": "PARAM1_DESC"
62
+ "summary": [
63
+ {
64
+ "kind": "text",
65
+ "text": "PARAM1_DESC"
66
+ }
67
+ ]
42
68
  },
43
69
  "type": {
44
70
  "type": "reference",
45
71
  "isArray": true,
46
72
  "name": "PARAM1_TYPE",
47
- "id": 795
73
+ "target": 795
48
74
  }
49
75
  },
50
76
  {
@@ -54,12 +80,17 @@
54
80
  "kindString": "Parameter",
55
81
  "flags": {},
56
82
  "comment": {
57
- "text": "PARAM2_DESC"
83
+ "summary": [
84
+ {
85
+ "kind": "text",
86
+ "text": "PARAM1_DESC"
87
+ }
88
+ ]
58
89
  },
59
90
  "type": {
60
91
  "type": "reference",
61
92
  "name": "PARAM2_TYPE",
62
- "id": 254
93
+ "target": 254
63
94
  }
64
95
  }
65
96
  ],
package/test/fn.json CHANGED
@@ -7,13 +7,34 @@
7
7
  "isExported": true
8
8
  },
9
9
  "comment": {
10
- "shortText": "ROOT_DESC",
11
- "text": "ROOT_TEXT",
12
- "returns": "ROOT_RETURN",
13
- "tags": [
10
+ "summary": [
14
11
  {
15
- "tag": "example",
16
- "text": "ROOT_EXAMPLE"
12
+ "kind": "text",
13
+ "text": "ROOT_DESC"
14
+ },
15
+ {
16
+ "kind": "text",
17
+ "text": "ROOT_TEXT"
18
+ }
19
+ ],
20
+ "blockTags": [
21
+ {
22
+ "tag": "@returns",
23
+ "content": [
24
+ {
25
+ "kind": "code",
26
+ "text": "ROOT_RETURN"
27
+ }
28
+ ]
29
+ },
30
+ {
31
+ "tag": "@example",
32
+ "content": [
33
+ {
34
+ "kind": "code",
35
+ "text": "ROOT_EXAMPLE"
36
+ }
37
+ ]
17
38
  }
18
39
  ]
19
40
  },
@@ -25,9 +46,27 @@
25
46
  "kindString": "Call signature",
26
47
  "flags": {},
27
48
  "comment": {
28
- "shortText": "SIG_DESC",
29
- "text": "SIG_TEXT",
30
- "returns": "SIG_RETURN"
49
+ "summary": [
50
+ {
51
+ "kind": "text",
52
+ "text": "SIG_DESC"
53
+ },
54
+ {
55
+ "kind": "text",
56
+ "text": "SIG_TEXT"
57
+ }
58
+ ],
59
+ "blockTags": [
60
+ {
61
+ "tag": "@returns",
62
+ "content": [
63
+ {
64
+ "kind": "code",
65
+ "text": "SIG_RETURN"
66
+ }
67
+ ]
68
+ }
69
+ ]
31
70
  },
32
71
  "typeParameter": [
33
72
  {
@@ -46,7 +85,12 @@
46
85
  "kindString": "Parameter",
47
86
  "flags": {},
48
87
  "comment": {
49
- "shortText": "PARAM1_DESC"
88
+ "summary": [
89
+ {
90
+ "kind": "text",
91
+ "text": "PARAM1_DESC"
92
+ }
93
+ ]
50
94
  },
51
95
  "type": {
52
96
  "type": "typeParameter",
@@ -61,13 +105,18 @@
61
105
  "kindString": "Parameter",
62
106
  "flags": {},
63
107
  "comment": {
64
- "shortText": "PARAM2_DESC"
108
+ "summary": [
109
+ {
110
+ "kind": "text",
111
+ "text": "PARAM2_DESC"
112
+ }
113
+ ]
65
114
  },
66
115
  "type": {
67
116
  "type": "reference",
68
117
  "isArray": true,
69
118
  "name": "RefType",
70
- "id": 174
119
+ "target": 174
71
120
  },
72
121
  "defaultValue": " []"
73
122
  }
@@ -75,7 +124,7 @@
75
124
  "type": {
76
125
  "type": "reference",
77
126
  "name": "SIG_RETURN",
78
- "id": 110
127
+ "target": 110
79
128
  }
80
129
  }
81
130
  ],
package/test/inputs-def.json CHANGED
@@ -42,7 +42,19 @@
42
42
  "type": "instrinct",
43
43
  "name": "boolean"
44
44
  },
45
- "defaultValue": "false"
45
+ "comment": {
46
+ "blockTags": [
47
+ {
48
+ "tag": "@default",
49
+ "content": [
50
+ {
51
+ "kind": "code",
52
+ "text": "```ts\nfalse\n```"
53
+ }
54
+ ]
55
+ }
56
+ ]
57
+ }
46
58
  }
47
59
  ]
48
60
  },
@@ -83,7 +95,7 @@
83
95
  "name": "Input"
84
96
  },
85
97
  "arguments": {
86
- "bindingPropertyName": "'foo'"
98
+ "obj": "'foo'"
87
99
  }
88
100
  }
89
101
  ],
@@ -91,7 +103,19 @@
91
103
  "type": "instrinct",
92
104
  "name": "boolean"
93
105
  },
94
- "defaultValue": "false"
106
+ "comment": {
107
+ "blockTags": [
108
+ {
109
+ "tag": "@default",
110
+ "content": [
111
+ {
112
+ "kind": "code",
113
+ "text": "```ts\nfalse\n```"
114
+ }
115
+ ]
116
+ }
117
+ ]
118
+ }
95
119
  }
96
120
  ]
97
121
  }