@progress/kendo-typescript-tasks 11.2.7-dev.1 → 11.2.7-dev.15

package/src/api/generator.js

@@ -1,270 +0,0 @@
-"use strict";
-
-const fs = require('fs');
-const mkdirp = require('mkdirp');
-const path = require('path');
-const indexPage = require('./index-page.js');
-const memberPage = require('./member-page.js');
-const slug = require('./slug.js');
-const utils = require('./utils.js');
-const typeLinks = require('./type-links.json');
-if (fs.existsSync('api-type-links.json')) {
-    Object.assign(typeLinks, require(path.resolve('api-type-links.json')));
-}
-
-const moduleFilter = (module) => module.children;
-
-const kind = (member, module) => {
-    let kind = member.kindString.toLowerCase();
-    const notBaseType = kind !== 'function' && kind !== 'enumeration' && kind !== 'interface' &&
-        kind !== 'object literal' && kind !== 'module';
-
-    if (member.name.toUpperCase() === member.name) {
-        kind = 'constant';
-    } else if (module.name.match(/.component/) !== null && notBaseType) {
-        kind = 'component';
-    } else if (module.name.match(/.directive/) !== null && notBaseType) {
-        kind = 'directive';
-    } else if (member.type && member.type.type === 'union') {
-        kind = 'union';
-    } else if (notBaseType) {
-        kind = 'class';
-    }
-
-    return kind;
-};
-
-const addTypeSlug = (element, knownTypes) => {
-    if (element.type === 'reference' ||
-        (typeof element.type !== 'string' && knownTypes[element.id])) {
-        const type = knownTypes[element.id];
-        if (type) {
-            element.typeSlug = type.slug;
-        } else if (typeLinks[element.name]) {
-            element.typeLink = typeLinks[element.name];
-        }
-    } else if (element.type === 'array' && element.elementType.type === 'reference') {
-        addTypeSlug(element.elementType, knownTypes);
-    }
-};
-
-const traverseElements = (elements, callback) => {
-    if (!elements) {
-        return;
-    }
-
-    elements.forEach(element => {
-        callback(element);
-
-        for (let field in element) {
-            const value = element[field];
-            if (Array.isArray(value)) {
-                traverseElements(value, callback);
-            } else if (typeof value === 'object' && value !== null) {
-                traverseElements([ value ], callback);
-            }
-        }
-    });
-};
-
-const associateTypes = (elements, knownTypes) => {
-    traverseElements(elements, element => {
-        addTypeSlug(element, knownTypes);
-    });
-};
-
-const normalizeUnionReferences = (element, members) => {
-    if (element.kind === 'union') {
-        const types = element.type.types;
-        for (let idx = types.length - 1; idx >= 0; idx--) {
-            const type = types[idx];
-            if (type.type === 'reference') {
-                const unionReference = members.find((child) => child.name === type.name);
-
-                if (unionReference && unionReference.kind === 'union') {
-                    normalizeUnionReferences(unionReference, members);
-                    const toReplace = unionReference.type.types;
-                    types.splice.apply(types, [ idx, 1 ].concat(toReplace));
-                }
-            }
-        }
-    }
-};
-
-const normalizeMembers = (members) => {
-    traverseElements(members, (element) => {
-        normalizeUnionReferences(element, members);
-
-        if (!element.comment && element.implementationOf) {
-            const interfaceName = element.implementationOf.name.split('.')[0];
-            const interfaceOptions = members.find((child) => child.name === interfaceName);
-
-            if (interfaceOptions) {
-                const baseOption = interfaceOptions.children.find(child => child.name === element.name);
-                if (baseOption) {
-                    mergeComments(element, baseOption);
-                }
-            }
-        }
-
-        if (!element.comment && element.kindString === 'Accessor') {
-            const accessor = element.getSignature || element.setSignature || [];
-            element.comment = accessor[0].comment;
-        }
-    });
-};
-
-const mergeComments = (root, src) => {
-    if (!root.comment && src.comment) {
-        root.comment = src.comment;
-    }
-
-    Object.keys(root).forEach(key => {
-        if (typeof root[key] === 'object' && src[key]) {
-            mergeComments(root[key], src[key]);
-        }
-    });
-};
-
-const moduleRoot = (moduleName, rootModules) => (rootModules.includes(moduleName) ? moduleName :
-    rootModules.find(rootModule => moduleName.indexOf(rootModule) > -1));
-
-const moduleFullName = (moduleName, packageName, rootModules) => {
-    const rootModule = moduleRoot(moduleName, rootModules);
-    let fullName = packageName;
-    if (rootModule) {
-        fullName += '_' + rootModule;
-    }
-
-    return fullName;
-};
-
-const extractMembers = (packageName, modules, config) => {
-    const knownTypes = {};
-    const rootModules = config.modules || [];
-    const nonEmptyModules = modules.filter(moduleFilter);
-
-    const models = nonEmptyModules.map(module => module
-        .children
-        .filter(child => child.kindString !== "Reference")
-        .filter(child => child.name !== 'core')
-        .filter(child => child.sources && !child.sources[0].fileName.includes('prosemirror'))
-        .map(child => {
-            const fullName = moduleFullName(module.name, packageName, rootModules);
-
-            const model = {
-                id: child.id,
-                module: moduleRoot(module.name, rootModules),
-                name: child.name,
-                comment: child.comment,
-                children: child.children?.sort(utils.nameComparer),
-                decorators: child.decorators,
-                type: child.type,
-                kind: kind(child, module),
-                packageName: fullName,
-                url: `${child.name}`,
-                signatures: child.signatures,
-                slug: slug(fullName, child.name),
-                typeParameter: child.typeParameter
-            };
-
-            knownTypes[child.id] = model;
-
-            if (config.isPlatformSpecific && config.isPlatformSpecific(child)) {
-                config.toPlatformModel(model);
-            }
-
-            return model;
-        })
-    );
-
-    const members = utils.flatten(models)
-        .sort(utils.nameComparer)
-        .map(model => {
-            associateTypes([ model ], knownTypes);
-            return model;
-        });
-
-    normalizeMembers(members);
-
-    return members;
-};
-
-const namespacesAsModules = data => {
-    const modules = [];
-    data.filter(moduleFilter).forEach(module => module
-        .children
-        .filter(child => child.name !== 'core')
-        .forEach(child => {
-            if (child.kindString === 'Module' && child.children) {
-                modules.push(child);
-            }
-        })
-    );
-
-    return modules;
-};
-
-const writeFile = (name, content) => {
-    mkdirp.sync(path.dirname(name));
-    fs.writeFileSync(name, content);
-};
-
-const writeMember = (path, member, info) => {
-    let sub = member.module ? member.module + '/' : '';
-    writeFile(`${path}/${sub}${member.url}.md`, memberPage(member, info));
-};
-
-const groupMembers = (members) => {
-    const membersByModule = utils.groupBy(m => m.module || '', members);
-
-    Object.keys(membersByModule).forEach(module => {
-        membersByModule[module] = utils.groupBy(m => m.kind, membersByModule[module]);
-    });
-
-    return membersByModule;
-};
-
-const packagePlatform = (packageInfo) => {
-    let platform = '';
-
-    if (/-angular-/.test(packageInfo.name)) {
-        platform = 'Angular';
-    } else if (/-react-/.test(packageInfo.name)) {
-        platform = 'React';
-    } else if (/-vue-/.test(packageInfo.name)) {
-        platform = 'Vue';
-    }
-
-    return platform;
-};
-
-const generate = (done, config, packageInfo) => {
-    const meta = require(config.jsonPath);
-    const namespaces = namespacesAsModules(meta.children);
-    const members = extractMembers(packageInfo.name, [ ...meta.children, ...namespaces ], config);
-    const membersByModule = config.reorderModules ?
-        config.reorderModules(groupMembers(members)) : groupMembers(members);
-    const outPath = config.outPath;
-    const platform = packagePlatform(packageInfo);
-    const info = Object.assign({ platform }, packageInfo['@progress']);
-
-    writeFile(`${outPath}/index.md`, indexPage(packageInfo.name, membersByModule, info));
-    writeFile(`${outPath}/_meta.yml`, `---\ntitle: API\n---\n`);
-
-    members.forEach(member => writeMember(outPath, member, info));
-
-    const warnings = utils.warnings();
-    let error;
-    if (config.warningsAsErrors && warnings.length > 0) {
-        error = new Error(`API Generation failed with warnings`);
-    }
-
-    done(error);
-};
-
-module.exports = {
-    generate: generate,
-    extractMembers: extractMembers
-};
-

package/src/api/index-page.hbs

@@ -1,54 +0,0 @@
----
-title: {{friendlyName}} API
-page_title: {{platform}} {{friendlyName}} API | Kendo UI{{#if platform}} for {{platform}}{{/if}}
-description: "Learn how to build custom functionality of the {{platform}} {{friendlyName}} by Kendo UI with the help of the options available in the API."
-slug: {{slug}}
-api_reference: true
-type: index_api
-position: 1
----
-
-<span class="api-text">
-
-
-# {{friendlyName}} API
-
-
-</span>
-
-{{#each modules}}
-<h2 class="api-module-name">
-{{#if @key}}
-{{@key}}
-{{else}}
-{{../name}}
-{{/if}}
-</h2>
-
-<div class="api-index">
-
-{{#each this}}
-<div class="api-index-section">
-
-
-<span class="section-key">
-
-
-## {{{ capitalize @key }}}
-
-
-</span>
-
-
-  <ul class="api-item-list">
-  {{#each this}}
-    <li class="api-item">
-        <a href="{% slug {{slug}} %}">{{name}}</a>
-    </li>
-  {{/each}}
-  </ul>
-</div>
-{{/each}}
-
-</div>
-{{/each}}

package/src/api/index-page.js

@@ -1,15 +0,0 @@
-"use strict";
-
-const template = require('./template-utils.js');
-const slug = require('./slug.js');
-
-const indexTemplate = template.compileFrom('index-page.hbs');
-
-const index = (projectName, modules, meta) =>
-    indexTemplate(Object.assign({}, meta, {
-        name: projectName,
-        slug: slug(projectName),
-        modules: modules,
-    }));
-
-module.exports = index;

package/src/api/is-constructor.js

@@ -1,9 +0,0 @@
-"use strict";
-
-const isPublic = require('./is-public');
-
-const isConstructor = (prop) =>
-    prop.kindString && prop.kindString === 'Constructor' && isPublic(prop);
-
-module.exports = isConstructor;
-

package/src/api/is-event.js

@@ -1,7 +0,0 @@
-"use strict";
-
-const isEvent = (prop) =>
-    prop.type && prop.type.name === 'EventEmitter';
-
-module.exports = isEvent;
-

package/src/api/is-field.js

@@ -1,7 +0,0 @@
-"use strict";
-
-const isEvent = require('./is-event.js');
-const isField = prop => !(prop.decorators && prop.decorators[0].name.match(/^(input|output)$/i)) &&
-                        !isEvent(prop);
-
-module.exports = isField;

package/src/api/is-input.js

@@ -1,7 +0,0 @@
-"use strict";
-
-const isInput = (prop) =>
-    prop.decorators && prop.decorators[0].name === 'Input';
-
-module.exports = isInput;
-

package/src/api/is-method.js

@@ -1,10 +0,0 @@
-"use strict";
-
-const isPublic = require('./is-public');
-const isInput = require('./is-input');
-
-const isMethod = (prop) =>
-    prop.kindString && prop.kindString === 'Method' && isPublic(prop) && !isInput(prop);
-
-module.exports = isMethod;
-

package/src/api/is-public.js

@@ -1,8 +0,0 @@
-"use strict";
-
-const isPublic = (prop) =>
-    !/^ng[A-Z]/.test(prop.name) &&
-    !prop.flags.isPrivate && !prop.flags.isProtected;
-
-module.exports = isPublic;
-

package/src/api/map-constructors.js

@@ -1,30 +0,0 @@
-'use strict';
-
-const comment = require('./comment');
-const isPublic = require('./is-public');
-const types = require('./type-utils');
-const utils = require('./utils');
-
-const isConstructor = (prop) =>
-    prop.kindString && prop.kindString === 'Constructor' && isPublic(prop);
-
-const mapConstructors = (member) => {
-    if (member.decorators && member.decorators.find(d => d.name === 'NgModule')) {
-        // Ignore NgModule constructors
-        return [];
-    }
-
-    return utils.flatten(member.children.filter(isConstructor).map(ctr => {
-        const source = `${member.name}.constructor`;
-
-        return ctr.signatures.map((signature) => ({
-            signature: types.callSignature(signature),
-            comment: comment(signature, source),
-            name: types.fullName(member),
-            params: types.params(signature, source)
-        }));
-    }));
-};
-
-module.exports = mapConstructors;
-

package/src/api/map-methods.js

@@ -1,23 +0,0 @@
-"use strict";
-
-const comment = require('./comment.js');
-const types = require('./type-utils.js');
-const isMethod = require('./is-method.js');
-const returnType = require('./return-type');
-const utils = require('./utils');
-
-const mapMethods = (children, parentName) =>
-    utils.flatten(children.filter(isMethod).map(method => {
-        const name = method.name;
-        const source = `${parentName}.${name}`;
-
-        return method.signatures.map((signature) => ({
-            comment: comment(signature, source),
-            name: name,
-            returns: returnType(signature, source),
-            params: types.params(signature, source)
-        }));
-    }));
-
-module.exports = mapMethods;
-

package/src/api/map-props.js

@@ -1,63 +0,0 @@
-"use strict";
-
-const comment = require('./comment');
-const types = require('./type-utils');
-const isConstructor = require('./is-constructor');
-const isEvent = require('./is-event');
-const isInput = require('./is-input');
-const isMethod = require('./is-method');
-const isPublic = require('./is-public');
-
-const defaultValue = prop => {
-    const { comment: { tags = [] } = {} } = prop;
-    const { text = '' } = tags.find(t => t.tag === 'default') || {};
-
-    return text && text.trim();
-};
-
-const accessor = signature => (Array.isArray(signature) ? signature[0] : signature);
-
-const isProp = (prop) => isPublic(prop) && !isConstructor(prop) && !isMethod(prop);
-const mapProps = (children, parentName) =>
-    children.filter(isProp).map(prop => {
-        let type;
-        let commentProp = prop;
-        if (prop.type) {
-            type = types.typeString(prop);
-        } else if (prop.kindString === 'Accessor') {
-            const getter = prop.getSignature;
-            const setter = prop.setSignature;
-
-            // Fingers crossed
-            type = types.typeString(setter ?
-                accessor(setter).parameters[0] :
-                accessor(getter)
-            );
-        } else if (prop.kindString === 'Method') {
-            type = types.callType(prop.signatures[0]);
-            commentProp = prop.signatures[0];
-        }
-
-        let name = prop.name;
-        if (isInput(prop) || isEvent(prop)) {
-            const inputArgs = prop.decorators ? prop.decorators[0].arguments : {};
-            if (inputArgs.bindingPropertyName) {
-                /* eslint-disable no-eval */
-                name = eval(inputArgs.bindingPropertyName);
-            }
-        }
-
-        if (prop.flags && prop.flags.isOptional) {
-            name += '?';
-        }
-
-        return {
-            name: name,
-            type: type,
-            defaultValue: defaultValue(prop),
-            comment: comment(commentProp, parentName)
-        };
-    });
-
-module.exports = mapProps;
-

package/src/api/member-meta.hbs

@@ -1,7 +0,0 @@
----
-title: {{name}}
-description: "Learn how to build custom functionality when working with the {{platform}} {{friendlyName}} by Kendo UI with the help of the {{name}}."
-api_reference: true
-type: inner_api
-slug: {{slug}}
----

package/src/api/member-page.js

@@ -1,41 +0,0 @@
-"use strict";
-
-const path = require('path');
-const componentPage = require('./component-page');
-const constantPage = require('./constant-page');
-const classPage = require('./class-page');
-const enumPage = require('./enum-page.js');
-const fnPage = require('./fn-page');
-const unionPage = require('./union-page');
-
-const memberPage = (member, meta) => {
-    switch (member.kind) {
-    case 'component': {
-        if (member.platform) {
-            return require(path.join(__dirname, member.platform, 'component-page'))(member, meta);
-        }
-        return componentPage(member, meta);
-    }
-    case 'directive':
-        return componentPage(member, meta);
-    case 'hook':
-    case 'function':
-        return fnPage(member, meta);
-    case 'class':
-    case 'interface':
-    case 'module':
-        return classPage(member, meta);
-    case 'constant':
-    case 'object literal':
-        return constantPage(member, meta);
-    case 'union':
-        return unionPage(member, meta);
-    case 'enumeration':
-        return enumPage(member, meta);
-    default:
-        throw new Error(`Unknown member kind '${member.kind}' for ${member.name}`);
-    }
-};
-
-module.exports = memberPage;
-

package/src/api/methods.hbs

@@ -1,109 +0,0 @@
-{{#if methods}}
-
-## Methods
-
-{{#each methods}}
-<table class="api-table api-table-methods">
-<thead class="api-table-methods-head">
-<tr>
-<th>
-
-
-#### {{name}}
-
-
-</th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td>
-
-
-{{comment}}
-
-
-</td>
-</tr>
-{{#if params}}
-<tr class="nested-table">
-<td>
-<table class="api-table api-table-parameters">
-<thead class="api-table-parameters-head">
-<tr>
-<th class="th-name">Parameters</th>
-<th class="th-type"></th>
-<th class="th-desc"></th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-{{#each params}}
-<tr>
-<td>
-
-
-{{name}}
-
-
-</td>
-<td type>
-
-
-{{> code_block type }}
-
-
-</td>
-<td>
-
-
-{{comment}}
-
-
-</td>
-</tr>
-{{/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>
-<th class="th-type">Returns</th>
-<th class="th-desc"></th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td type>
-
-
-{{> code_block returns.type }}
-
-
-</td>
-<td>
-
-
-{{returns.comment}}
-
-
-</td>
-</tr>
-</tbody>
-</table>
-</td>
-</tr>
-{{/if}}
-</tbody>
-</table>
-
-{{/each}}
-
-{{/if}}
-