@progress/kendo-typescript-tasks 11.1.1-dev.9 → 11.2.1-dev.1

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [11.2.0](https://github.com/telerik/kendo-build-tasks/compare/@progress/kendo-typescript-tasks@11.1.0...@progress/kendo-typescript-tasks@11.2.0) (2022-06-06)
+
+
+### Bug Fixes
+
+* move return table inside param table ([#348](https://github.com/telerik/kendo-build-tasks/issues/348)) ([206f034](https://github.com/telerik/kendo-build-tasks/commit/206f034268b87abd606ca970d33a8fe905994586))
+* pin typedoc version ([9ec980c](https://github.com/telerik/kendo-build-tasks/commit/9ec980c7763018ac5b5e0194f1df2266c507b04d))
+* react api with ts version ~4.3 ([376d2dd](https://github.com/telerik/kendo-build-tasks/commit/376d2dd85fb94383b89f66578f43ffd9badb38eb))
+* **typescript-tasks:** item names should be headers ([#353](https://github.com/telerik/kendo-build-tasks/issues/353)) ([a576c65](https://github.com/telerik/kendo-build-tasks/commit/a576c65f791053c5e9948d941ef61d9487024203))
+* various handlebars templates issues ([#352](https://github.com/telerik/kendo-build-tasks/issues/352)) ([b5276e3](https://github.com/telerik/kendo-build-tasks/commit/b5276e35afc11bf1511c83c2b3bd4ff014d33f40))
+
+
+### Features
+
+* index and inner API section redesign ([#341](https://github.com/telerik/kendo-build-tasks/issues/341)) ([36da1a2](https://github.com/telerik/kendo-build-tasks/commit/36da1a23f5e89edeb92a6672e790c725baa3b86a))
+
+
+
+
+
 # [11.1.0](https://github.com/telerik/kendo-build-tasks/compare/@progress/kendo-typescript-tasks@11.0.0...@progress/kendo-typescript-tasks@11.1.0) (2022-04-29)
 
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@progress/kendo-typescript-tasks",
   "description": "Kendo UI TypeScript package gulp tasks",
   "main": "gulp-tasks.js",
-  "version": "11.1.1-dev.9+b5276e3",
+  "version": "11.2.1-dev.1+8e54770",
   "author": "Telerik",
   "license": "Apache-2.0",
   "scripts": {
@@ -18,7 +18,7 @@
     "typescript": "^4.3.4"
   },
   "dependencies": {
-    "@progress/kendo-common-tasks": "8.0.1-dev.11+b5276e3",
+    "@progress/kendo-common-tasks": "8.0.2-dev.1+8e54770",
     "@typescript-eslint/eslint-plugin": "4.28.2",
     "@typescript-eslint/parser": "4.28.2",
     "core-js": "^3.18.0",
@@ -35,7 +35,7 @@
     "mkdirp": "^0.5.0",
     "source-map-loader": "^0.1.5",
     "ts-loader": "4.1.0",
-    "typedoc": "~0.22.5"
+    "typedoc": "0.22.15"
   },
   "devDependencies": {
     "gulp-jasmine": "^2.4.2",
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b5276e35afc11bf1511c83c2b3bd4ff014d33f40"
+  "gitHead": "8e54770ff3a0deda652b7bc837fd1b0590cacea1"
 }

package/src/api/component-page.hbs

@@ -69,11 +69,11 @@ Accessible in templates as `#{{exportName}}="{{exportAs}}"`
 </thead>
 <tbody class="api-table-body">
 {{#each events}}
-<tr id="toc-{{lowercase name}}">
+<tr>
 <td class="table-cell-name">
 
 
-{{name}}
+#### {{name}}
 
 
 </td>

package/src/api/map-props.js

@@ -12,7 +12,7 @@ const defaultValue = prop => {
     const { comment: { tags = [] } = {} } = prop;
     const { text = '' } = tags.find(t => t.tag === 'default') || {};
 
-    return text && ` (default: ${text.trim()})`;
+    return text && text.trim();
 };
 
 const accessor = signature => (Array.isArray(signature) ? signature[0] : signature);

package/src/api/methods.hbs

@@ -5,11 +5,11 @@
 {{#each methods}}
 <table class="api-table api-table-methods">
 <thead class="api-table-methods-head">
-<tr id="toc-{{lowercase name}}">
+<tr>
 <th>
 
 
-{{name}}
+#### {{name}}
 
 
 </th>
@@ -26,6 +26,8 @@
 </td>
 </tr>
 {{#if params}}
+<tr class="nested-table">
+<td>
 <table class="api-table api-table-parameters">
 <thead class="api-table-parameters-head">
 <tr>
@@ -36,7 +38,7 @@
 </thead>
 <tbody class="api-table-body">
 {{#each params}}
-<tr id="toc-{{lowercase name}}">
+<tr>
 <td>
 
 
@@ -62,9 +64,13 @@
 {{/each}}
 </tbody>
 </table>
+</td>
+</tr>
 {{/if}}
 
 {{#if returns}}
+<tr class="nested-table">
+<td>
 <table class="api-table api-table-returns">
 <thead class="api-table-returns-head">
 <tr>
@@ -91,6 +97,8 @@
 </tr>
 </tbody>
 </table>
+</td>
+</tr>
 {{/if}}
 </tbody>
 </table>

package/src/api/property.hbs

@@ -1,8 +1,8 @@
-<tr id="toc-{{lowercase name}}">
+<tr>
 <td class="table-cell-name">
 
 
-{{name}}
+#### {{name}}
 
 
 </td>

package/test/api.js

@@ -107,7 +107,7 @@ describe('API generation', () => {
         });
 
         it('adds methods', () => {
-            const pageContent = `## Methods\n\n<table class="api-table api-table-methods">\n<thead class="api-table-methods-head">\n<tr id="toc-get">\n<th>\n\n\nget\n\n\n</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td>\n\n\nGets the value of the specified option.\n\n\n</td>\n</tr>\n\n<table class="api-table api-table-returns">\n<thead class="api-table-returns-head">\n<tr>\n<th class="th-type">Returns</th>\n<th class="th-desc"></th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td type>\n\n\n<code>\n\n\nany\n\n\n</code>\n\n\n</td>\n<td>\n\n\nThe current option value.\n\n\n</td>\n</tr>\n</tbody>\n</table>\n</tbody>\n</table>`;
+            const pageContent = `## Methods\n\n<table class="api-table api-table-methods">\n<thead class="api-table-methods-head">\n<tr>\n<th>\n\n\n#### get\n\n\n</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td>\n\n\nGets the value of the specified option.\n\n\n</td>\n</tr>\n\n<tr class="nested-table">\n<td>\n<table class="api-table api-table-returns">\n<thead class="api-table-returns-head">\n<tr>\n<th class="th-type">Returns</th>\n<th class="th-desc"></th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td type>\n\n\n<code>\n\n\nany\n\n\n</code>\n\n\n</td>\n<td>\n\n\nThe current option value.\n\n\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>`;
             expect(page).toContain(pageContent);
         });
 
@@ -124,7 +124,7 @@ describe('API generation', () => {
                             "tags": [
                                 {
                                     "tag": "default",
-                                    "text": "true\n"
+                                    "text": "42\n"
                                 }
                             ]
                         }
@@ -134,25 +134,7 @@ describe('API generation', () => {
 
             const page = classPage(meta);
 
-            expect(page).toContain('(default: true)');
-        });
-
-        it('does not render default value', () => {
-            const meta = {
-                "name": "Component",
-                "children": [
-                    {
-                        "name": "foo",
-                        "flags": {
-                            "isPublic": true
-                        }
-                    }
-                ]
-            };
-
-            const page = classPage(meta);
-
-            expect(page).not.toContain('(default: true)');
+            expect(page).toContain('42');
         });
     });
 
@@ -224,7 +206,7 @@ describe('API generation', () => {
                             "tags": [
                                 {
                                     "tag": "default",
-                                    "text": "true\n"
+                                    "text": "42\n"
                                 }
                             ]
                         }
@@ -234,25 +216,7 @@ describe('API generation', () => {
 
             const page = componentPage(component, packageInfo);
 
-            expect(page).toContain('(default: true)');
-        });
-
-        it('does not render default value', () => {
-            const component = {
-                "name": "Component",
-                "children": [
-                    {
-                        "name": "foo",
-                        "flags": {
-                            "isPublic": true
-                        }
-                    }
-                ]
-            };
-
-            const page = componentPage(component, packageInfo);
-
-            expect(page).not.toContain('(default: true)');
+            expect(page).toContain('42');
         });
     });
 
@@ -269,14 +233,14 @@ describe('API generation', () => {
         it('render fields without decorators, but with comment', () => {
 
             const page = componentPage(fieldsData.withComment, packageInfo);
-            const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr id="toc-bar">\n<td class="table-cell-name">\n\n\nbar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
+            const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
             expect(page).toContain(pageContent);
         });
 
         it('render fields with decorators and comment', () => {
 
             const page = componentPage(fieldsData.withCommentAndDecorator, packageInfo);
-            const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr id="toc-bar">\n<td class="table-cell-name">\n\n\nbar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
+            const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
             expect(page).toContain(pageContent);
         });
     });
@@ -287,14 +251,14 @@ describe('API generation', () => {
         it('render inputs name and type', () => {
 
             const page = componentPage(inputsData.withoutNameMapping, packageInfo);
-            const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr id="toc-bar">\n<td class="table-cell-name">\n\n\nbar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
+            const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
             expect(page).toContain(pageContent);
         });
 
         it('render fields with mapped name', () => {
 
             const page = componentPage(inputsData.withNameMapping, packageInfo);
-            const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr id="toc-foo">\n<td class="table-cell-name">\n\n\nfoo\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
+            const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### foo\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
             expect(page).toContain(pageContent);
         });
     });
@@ -311,13 +275,13 @@ describe('API generation', () => {
 
         it('render event with type', () => {
             const page = componentPage(eventsData.withoutNameMapping, packageInfo);
-            const pageContent = `## Events\n\n<table class="api-table api-table-events">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr id="toc-valuechange">\n<td class="table-cell-name">\n\n\nvalueChange\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nEventEmitter&lt;any&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\nFires each time the user selects a new value.\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
+            const pageContent = `## Events\n\n<table class="api-table api-table-events">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### valueChange\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nEventEmitter&lt;any&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\nFires each time the user selects a new value.\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
             expect(page).toContain(pageContent);
         });
 
         it('render event binding name if available', () => {
             const page = componentPage(eventsData.withNameMapping, packageInfo);
-            const pageContent = `## Events\n\n<table class="api-table api-table-events">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr id="toc-focus">\n<td class="table-cell-name">\n\n\nfocus\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nEventEmitter&lt;any&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\nFires each time the user focuses the input element.\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
+            const pageContent = `## Events\n\n<table class="api-table api-table-events">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### focus\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nEventEmitter&lt;any&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\nFires each time the user focuses the input element.\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
             expect(page).toContain(pageContent);
         });