@omnia/tooling-vue 8.0.102-vnext → 8.0.104-vnext

package/internal-do-not-import-from-here/tasks/bundle.js

@@ -14,7 +14,7 @@ const fx_models_1 = require("@omnia/fx-models");
 const $ = tslib_1.__importStar(require("../variables"));
 const shared_1 = require("../shared");
 const tooling_1 = require("@omnia/tooling");
-const core_1 = require("@swc/core");
+const doc_1 = require("./doc");
 const MiniCssExtractPlugin = require('mini-css-extract-plugin');
 const ConcatSource = require('webpack-core/lib/ConcatSource');
 const CircularDependencyPlugin = require('circular-dependency-plugin');
@@ -202,11 +202,12 @@ function buildEntries(serve = false) {
             var componentRegistry = $.composers.ComponentRegistry;
             let componentRegistrations = componentRegistry.getRegistrations();
             const serviceInfo = $.composers.ServiceManifestRegistry.getServiceInfo();
-            if (serviceInfo.serviceType === tooling_composers_1.ServiceTypes.WebApp) {
-                await generateComponentTypingsAndDoc(componentRegistrations);
-            }
             startTime = new Date().getTime();
             $.tooling.logTime("Found [" + componentRegistrations.length + "] component registrations", startTime);
+            let componentEntries = createVueEntryFormComponentRegistrations(componentRegistrations);
+            if (serviceInfo.serviceType === tooling_composers_1.ServiceTypes.WebApp) {
+                await (0, doc_1.generateComponentTypingsAndDoc)(componentRegistrations);
+            }
             var resourceRegistry = $.composers.ResourceRegistry;
             let resourceBundlesWithBuildOptions = resourceRegistry.getRegisteredResourceBundles(shared_1.convertManifestPathToEntryPath);
             $.tooling.logTime("Found [" + resourceBundlesWithBuildOptions?.size + "] resource bundles", startTime);
@@ -222,7 +223,6 @@ function buildEntries(serve = false) {
                     console.log("debug " + res[0] + " has build options for paths " + resource.paths + " buildoptions: " + JSON.stringify(resource.buildOptions));
                 }
             }
-            let componentEntries = createVueEntryFormRegistrations(componentRegistrations);
             var entries = $.merge(componentEntries, resourceEntries);
             if (checkDuplicateWebpackEntryPoints(entries)) {
                 $.tooling.log('Build manifests metadata have error that found duplicated resource path', $.tooling.LogTypes.Error);
@@ -257,247 +257,6 @@ function buildEntries(serve = false) {
         }
     });
 }
-async function generateComponentTypingsAndDoc(componentRegistrations) {
-    tooling_1.utils.log("Generate components typings and documentation running...");
-    var startTime = new Date().getTime();
-    let DefineVueType;
-    (function (DefineVueType) {
-        DefineVueType[DefineVueType["Prop"] = 0] = "Prop";
-        DefineVueType[DefineVueType["Model"] = 1] = "Model";
-        DefineVueType[DefineVueType["Slot"] = 2] = "Slot";
-        DefineVueType[DefineVueType["Emit"] = 4] = "Emit";
-    })(DefineVueType || (DefineVueType = {}));
-    const docResult = {};
-    function getPropertyFunctionTypeAsString(type) {
-        let params = "";
-        if (type.params?.length > 0) {
-            type.params.forEach(p => {
-                params += `${p.value}:${getPropertyType(p.typeAnnotation)}, `;
-            });
-            params = params.replace(/,\s*$/, "");
-        }
-        return `(${params}) => ${getPropertyType(type.typeAnnotation)}`;
-    }
-    function getPropertyType(tsType) {
-        let result = "";
-        if (tsType.type === "TsTypeAnnotation") {
-            return getPropertyType(tsType.typeAnnotation);
-        }
-        switch (tsType.type) {
-            case "TsLiteralType":
-                result = tsType.literal.value;
-                break;
-            case "TsKeywordType":
-                result = tsType.kind;
-                break;
-            case "TsTypeReference":
-                result = tsType.typeName.value;
-                break;
-            case "TsFunctionType":
-                result = getPropertyFunctionTypeAsString(tsType);
-                break;
-            default:
-                break;
-        }
-        return result;
-    }
-    function getNameProperty(ce, result) {
-        const identifier = ce.callee?.property?.value;
-        if (identifier) {
-            switch (identifier) {
-                case "name":
-                    result.name = ce.arguments[0].expression.value;
-                    getNameProperty(ce.callee.object, result);
-                    break;
-                case "vModel":
-                    result.type = DefineVueType.Model;
-                    result.propertyTypeAsString = getPropertyType(ce.typeArguments.params[0]);
-                    result.name = result.name ? `v-model:${result.name}` : result.name;
-                    break;
-                case "slots":
-                    result.type = DefineVueType.Slot;
-                    result.propertyTypeAsObject = {};
-                    ce.typeArguments.params[0].members
-                        .forEach(m => {
-                        result.propertyTypeAsObject[m.key.value] = getPropertyType(m.typeAnnotation);
-                    });
-                    break;
-                case "prop":
-                    result.type = DefineVueType.Prop;
-                    result.propertyTypeAsString = getPropertyType(ce.typeArguments.params[0]);
-                    break;
-                case "emit":
-                    result.type = DefineVueType.Emit;
-                    result.propertyTypeAsString = getPropertyType(ce.typeArguments.params[0]);
-                    break;
-                default:
-                    getNameProperty(ce.callee.object, result);
-            }
-        }
-    }
-    async function buildDoc(wc) {
-        try {
-            const wcPath = (0, shared_1.convertManifestPathToEntryPath)(wc.manifestPath, [wc.componentOptions.entryPoint])[0];
-            const wcParseResult = await (0, core_1.parseFile)(wcPath, {
-                syntax: 'typescript',
-                target: 'es2020',
-                tsx: true,
-                decorators: true,
-                dynamicImport: true
-            });
-            wcParseResult.body.forEach(b => {
-                if (b.type === 'ExportDefaultExpression'
-                    && b.expression.callee?.value === "defineVueWebComponent") {
-                    b.expression.arguments[0].expression
-                        .properties?.filter(p => p.key.value === "props"
-                        || p.key.value === "emits")
-                        ?.forEach(propsIdentifier => {
-                        if (propsIdentifier) {
-                            propsIdentifier.value
-                                .properties?.forEach(p => {
-                                const em = p.arguments;
-                                if (em?.callee?.property?.value === "doc$") {
-                                    const PropertyResult = {
-                                        type: null,
-                                        propertyTypeAsString: "",
-                                        name: ""
-                                    };
-                                    getNameProperty(em, PropertyResult);
-                                    if (!docResult[wc.componentOptions.elementName]) {
-                                        docResult[wc.componentOptions.elementName] = {
-                                            emits: {},
-                                            models: {},
-                                            props: {},
-                                            slots: {}
-                                        };
-                                    }
-                                    switch (PropertyResult.type) {
-                                        case DefineVueType.Prop:
-                                            docResult[wc.componentOptions.elementName].props[PropertyResult.name] = {
-                                                type: PropertyResult.propertyTypeAsString,
-                                                description: em.arguments[0].expression.value
-                                            };
-                                            break;
-                                        case DefineVueType.Model:
-                                            docResult[wc.componentOptions.elementName].models[PropertyResult.name] = {
-                                                type: PropertyResult.propertyTypeAsString,
-                                                description: em.arguments[0].expression.value
-                                            };
-                                            break;
-                                        case DefineVueType.Emit:
-                                            docResult[wc.componentOptions.elementName].emits[PropertyResult.name] = {
-                                                type: PropertyResult.propertyTypeAsString,
-                                                description: em.arguments[0].expression.value
-                                            };
-                                            break;
-                                        case DefineVueType.Slot:
-                                            em.arguments[0].expression
-                                                .properties
-                                                .forEach(p => {
-                                                const slotName = p.key.value;
-                                                docResult[wc.componentOptions.elementName].slots[slotName] = {
-                                                    type: PropertyResult.propertyTypeAsObject[slotName],
-                                                    description: p.value.value
-                                                };
-                                            });
-                                            break;
-                                        default:
-                                            break;
-                                    }
-                                }
-                            });
-                        }
-                    });
-                }
-            });
-        }
-        catch (ex) {
-            tooling_1.utils.log(`Have a exception when extract doc$ for web component manifest -> ${wc.manifestPath}`, tooling_1.utils.LogTypes.Error);
-            console.error(ex);
-            throw new Error("Exit, have an exception.");
-        }
-    }
-    let docPath = $.path.resolve(__dirname, "ComponentDocRegistrations.ts");
-    ;
-    const wcNamespace = getBuildOption()?.webComponentNamespace;
-    const info = shared_1.ConfigurationManager.outputInfo.get();
-    info.wc = {
-        namespace: wcNamespace,
-        mappings: {}
-    };
-    let wcTypings = wcNamespace ? `
-//{{importWC}}
-declare global {
-    namespace JSX {
-        interface Element { }
-        interface ElementClass { }
-
-        interface IntrinsicElements {
-            //{{elementName}}
-        }
-    }
-}
-
-declare global {
-    let ${wcNamespace}: {
-        //{{nselementName}}
-    };
-}
-`
-        : `
-//{{importWC}}
-    declare global {
-    namespace JSX {
-        interface Element { }
-        interface ElementClass { }
-
-        interface IntrinsicElements {
-            //{{elementName}}
-        }
-    }
-}`;
-    if ($.isExtensionEnv) {
-        wcTypings = `import { VueComponentBaseProps } from "@omnia/fx/ux";
-        ${wcTypings}`;
-    }
-    else {
-        wcTypings = `import { VueComponentBaseProps } from "../../../../client/fx/ux/index";
-        ${wcTypings}`;
-    }
-    await tooling_1.utils.asyncForEach(componentRegistrations, async (wc) => {
-        wcTypings = generateWebComponentTypings(wc, wcTypings, info);
-        await buildDoc(wc);
-    });
-    if (Object.keys(docResult).length > 0) {
-        fsExtra.outputFileSync(docPath, `
-import { extendApi } from "@omnia/fx";
-import { ComponentDoc } from "@omnia/fx-models";
-
-extendApi(api => api.fx.docs.registrations, api => {
-
-    const registrations: { [elementName: string]: ComponentDoc } = ${JSON.stringify(docResult)}
-
-    Object.keys(registrations).forEach(elementName => {
-        api.register(elementName, registrations[elementName]);
-    });
-});
-    `);
-        // create dynamic doc manifest
-        $.composers.ManifestRegistry.setCurrentManifestPath(`${path_1.default.relative(tooling_1.utils.root(""), path_1.default.resolve(__dirname))}/`);
-        $.composers
-            .Composer
-            .registerManifest(getBuildOption().docResourceManifestId || new fx_models_1.Guid(`${tooling_1.utils.generateGuid()}`), "omnia.fx.docs.components.registraions")
-            .registerResources({
-            resourcePaths: ["./ComponentDocRegistrations.ts"]
-        })
-            .withTarget(fx_models_1.ClientManifestTargetTypes.Docs)
-            .extendApi(api => api.fx.docs.registrations);
-        $.composers.ManifestRegistry.setCurrentManifestPath();
-    }
-    shared_1.ConfigurationManager.webComponentTypings.update(wcTypings);
-    shared_1.ConfigurationManager.outputInfo.update(info);
-    tooling_1.utils.logTime('Done - Generate components typings and documentation', startTime);
-}
 function buildManifestMetadatas(entries) {
     return new Promise(function (resolve, reject) {
         try {
@@ -1561,89 +1320,18 @@ function getServiceId() {
     return serviceId;
 }
 exports.getServiceId = getServiceId;
-function extractTypingsForComponents(componentRegistrations) {
-    let foundTypes = {};
-    componentRegistrations.forEach((comp) => {
-        let defPaths = comp.componentOptions.typings;
-        if (defPaths) {
-            let isChildSpec = false;
-            defPaths.forEach((defPath) => {
-                let entryPointPath = (0, shared_1.convertManifestPathToEntryPath)(comp.manifestPath, [defPath])[0];
-                let contents = $.fs.readFileSync(entryPointPath, 'utf8');
-                let wcEl = getWcElement(contents, isChildSpec);
-                if (wcEl) {
-                    //Now lets find the interface mapped to element
-                    //example /*@WebComponentInterface("omfx-dialog")*/
-                    let interfaceToken = `/*@WebComponentInterface("${wcEl}")*/`;
-                    let interfaceIndex = contents.indexOf(interfaceToken);
-                    if (interfaceIndex > -1) {
-                        let wcProps = [];
-                        let intf = contents.substring(interfaceIndex);
-                        let nextIsDomProp = false;
-                        intf = intf
-                            .substring(intf.indexOf("{") + 1, intf.indexOf("}"))
-                            .replace(/\?/g, '')
-                            .trim()
-                            .split(/\r\n|\r|\n/g).forEach((group) => {
-                            /*@DomProperty*/
-                            let sub = group.trim();
-                            if (sub.indexOf("/*@DomProperty*/") > -1) {
-                                nextIsDomProp = true;
-                                return;
-                            }
-                            if (nextIsDomProp) {
-                                if (sub.indexOf(':')) {
-                                    sub = sub.split(':')[0];
-                                }
-                                if (sub) {
-                                    if (!foundTypes[wcEl]) {
-                                        foundTypes[wcEl] = [];
-                                    }
-                                    foundTypes[wcEl].push(sub);
-                                }
-                                nextIsDomProp = false;
-                            }
-                        });
-                    }
-                }
-                isChildSpec = true;
-            });
-        }
-    });
-    return foundTypes;
-}
-var lastWcElement = "";
-function getWcElement(contents, isChildSpec) {
-    if (isChildSpec) {
-        if (lastWcElement === "") {
-            new Error("Cant find the /*@DomProperty*/ on the parent interface for the WebComponent definition");
-        }
-        return lastWcElement;
-    }
-    else {
-        lastWcElement = "";
-    }
-    let wcElToken = "/*@WebComponent*/";
-    let wcElIndex = contents.indexOf(wcElToken);
-    let wcEl = "";
-    if (wcElIndex > -1) {
-        wcEl = contents.substring(wcElIndex);
-        wcEl = wcEl.substring(wcEl.indexOf('"') + 1);
-        wcEl = wcEl.substring(0, wcEl.indexOf('"'));
-        lastWcElement = wcEl;
-    }
-    return lastWcElement;
-}
-function createVueEntryFormRegistrations(registrations) {
+function createVueEntryFormComponentRegistrations(registrations) {
     let entryPaths = {};
     for (let r of registrations) {
-        if (r.componentOptions.entryPoint.endsWith('.jsx') || r.componentOptions.entryPoint.endsWith('.vue') || r.componentOptions.entryPoint.endsWith('.tsx') || r.componentOptions.entryPoint.endsWith('.ts')) {
+        if (r.componentOptions.entryPoint.endsWith('.tsx')
+            || r.componentOptions.entryPoint.endsWith('.vue')) {
             let entryPointPath = (0, shared_1.convertManifestPathToEntryPath)(r.manifestPath, [r.componentOptions.entryPoint]);
             let entryId = r.manifest.resourceId;
             if (r.manifest.resourceName) {
                 entryId = `${r.manifest.resourceName}_${entryId}`;
             }
-            entryPaths[entryId] = entryPointPath;
+            r.componentOptions.entryPointPath = entryPointPath[0];
+            entryPaths[entryId.toString()] = entryPointPath;
         }
         else {
             $.tooling.log('The OmniaFx build system only supports  .jsx, .vue and .tsx based components at the moment ', $.tooling.LogTypes.Error);
@@ -1963,35 +1651,3 @@ function sortString(a, b) {
     }
     return -1;
 }
-function generateWebComponentTypings(wc, template, info) {
-    // export default defineVueWebComponent
-    let wcPath = (0, shared_1.convertManifestPathToEntryPath)(wc.manifestPath, [wc.componentOptions.entryPoint])[0];
-    let content = fsExtra.readFileSync(wcPath, 'utf8');
-    if (content.indexOf("defineVueWebComponent") > -1) {
-        if (!new RegExp('export\\s+default\\s+').test(content)) {
-            throw new Error(`Missing statement 'export default a vue web component' in ${wcPath}`);
-        }
-        let friendlyManifestId = `wc${wc.manifest.resourceId.toString().replace(/-/g, '').toLowerCase()}`;
-        let importPath = wcPath.substring(0, wcPath.lastIndexOf('.tsx'));
-        if (importPath.indexOf("./") === 0) {
-            importPath = importPath.replace("./", "");
-        }
-        if ($.isExtensionEnv) {
-            importPath = `../../../../${importPath}`;
-        }
-        else {
-            importPath = `../../../../${importPath}`;
-        }
-        let elementNamePascalCase = wc.componentOptions.elementName.replace("omfx-", "").replace(/-([a-z])/g, function (g) { return g[1].toUpperCase(); });
-        elementNamePascalCase = elementNamePascalCase[0].toUpperCase() + elementNamePascalCase.substring(1, elementNamePascalCase.length);
-        info.wc.mappings[elementNamePascalCase] = wc.componentOptions.elementName;
-        return template
-            .replace(/\/\/{{importWC}}/, `import ${friendlyManifestId} from '${importPath}';
-//{{importWC}}`)
-            .replace(/\/\/{{elementName}}/, `"${wc.componentOptions.elementName}": typeof ${friendlyManifestId}.propsDefinition & Omit<VueComponentBaseProps, keyof typeof ${friendlyManifestId}.propsDefinition>
-//{{elementName}}`)
-            .replace(/\/\/{{nselementName}}/, `"${elementNamePascalCase}": { new(...args: any[]): { $props: typeof ${friendlyManifestId}.propsDefinition & Omit<VueComponentBaseProps, keyof typeof ${friendlyManifestId}.propsDefinition> } }
-            //{{nselementName}}`);
-    }
-    return template;
-}

package/internal-do-not-import-from-here/tasks/doc.d.ts

@@ -1 +1,2 @@
-export {};
+import { ComponentRegistration } from "@omnia/tooling-composers";
+export declare function generateComponentTypingsAndDoc(componentRegistrations: ComponentRegistration[]): Promise<void>;