vue-component-meta 1.3.14 → 1.3.16

package/out/index.d.ts

@@ -25,7 +25,7 @@ export declare function createComponentMetaChecker(tsconfigPath: string, checker
         tsLs: ts.LanguageService;
     };
 };
-export declare function baseCreate(_host: vue.VueLanguageServiceHost, checkerOptions: MetaCheckerOptions, globalComponentName: string, ts: typeof import('typescript/lib/tsserverlibrary')): {
+export declare function baseCreate(_host: vue.VueLanguageServiceHost, checkerOptions: MetaCheckerOptions, globalComponentName: string, ts: typeof import('typescript/lib/tsserverlibrary'), embeddedTypes: boolean): {
     getExportNames: (componentPath: string) => string[];
     getComponentMeta: (componentPath: string, exportName?: string) => ComponentMeta;
     __internal__: {

package/out/index.js

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.baseCreate = exports.createComponentMetaChecker = exports.createComponentMetaCheckerByJsonConfig = void 0;
 const vue = require("@volar/vue-language-core");
-const embedded = require("@volar/language-core");
+const language_core_1 = require("@volar/language-core");
 const path = require("typesafe-path/posix");
 __exportStar(require("./types"), exports);
 const extraFileExtensions = [{
@@ -59,11 +59,10 @@ function createComponentMetaCheckerWorker(loadParsedCommandLine, checkerOptions,
             }
             return scriptSnapshots.get(fileName);
         },
-        getTypeScriptModule: () => ts,
         getVueCompilationSettings: () => parsedCommandLine.vueOptions,
     };
     return {
-        ...baseCreate(_host, checkerOptions, globalComponentName, ts),
+        ...baseCreate(_host, checkerOptions, globalComponentName, ts, false),
         updateFile(fileName, text) {
             fileName = fileName.replace(/\\/g, '/');
             scriptSnapshots.set(fileName, ts.ScriptSnapshot.fromString(text));
@@ -87,7 +86,7 @@ function createComponentMetaCheckerWorker(loadParsedCommandLine, checkerOptions,
         },
     };
 }
-function baseCreate(_host, checkerOptions, globalComponentName, ts) {
+function baseCreate(_host, checkerOptions, globalComponentName, ts, embeddedTypes) {
     const globalComponentSnapshot = ts.ScriptSnapshot.fromString('<script setup lang="ts"></script>');
     const metaSnapshots = {};
     const host = new Proxy({
@@ -103,7 +102,7 @@ function baseCreate(_host, checkerOptions, globalComponentName, ts) {
         getScriptSnapshot: fileName => {
             if (isMetaFileName(fileName)) {
                 if (!metaSnapshots[fileName]) {
-                    metaSnapshots[fileName] = ts.ScriptSnapshot.fromString(getMetaScriptContent(fileName));
+                    metaSnapshots[fileName] = ts.ScriptSnapshot.fromString(getMetaScriptContent(fileName, embeddedTypes));
                 }
                 return metaSnapshots[fileName];
             }
@@ -124,7 +123,7 @@ function baseCreate(_host, checkerOptions, globalComponentName, ts) {
     });
     const vueCompilerOptions = vue.resolveVueCompilerOptions(host.getVueCompilationSettings());
     const vueLanguageModules = ts ? vue.createLanguageModules(ts, host.getCompilationSettings(), vueCompilerOptions) : [];
-    const core = embedded.createLanguageContext(host, vueLanguageModules);
+    const core = (0, language_core_1.createLanguageContext)(host, { typescript: ts }, vueLanguageModules);
     const proxyApis = checkerOptions.forceUseTs ? {
         getScriptKind: (fileName) => {
             if (fileName.endsWith('.vue.js')) {
@@ -159,18 +158,50 @@ function baseCreate(_host, checkerOptions, globalComponentName, ts) {
     function getMetaFileName(fileName) {
         return (fileName.endsWith('.vue') ? fileName : fileName.substring(0, fileName.lastIndexOf('.'))) + '.meta.ts';
     }
-    function getMetaScriptContent(fileName) {
-        return `
+    function getMetaScriptContent(fileName, embeddedTypes) {
+        const importCode = embeddedTypes ? '' : `import('vue-component-type-helpers').`;
+        let code = `
 import * as Components from '${fileName.substring(0, fileName.length - '.meta.ts'.length)}';
 export default {} as { [K in keyof typeof Components]: ComponentMeta<typeof Components[K]>; };
 
 interface ComponentMeta<T> {
-	props: import('vue-component-type-helpers').ComponentProps<T>;
-	emit: import('vue-component-type-helpers').ComponentEmit<T>;
-	slots: import('vue-component-type-helpers').${vueCompilerOptions.target < 3 ? 'Vue2ComponentSlots' : 'ComponentSlots'}<T>;
-	exposed: import('vue-component-type-helpers').ComponentExposed<T>;
-};
-		`.trim();
+	props: ${importCode}ComponentProps<T>;
+	emit: ${importCode}ComponentEmit<T>;
+	slots: ${importCode}${vueCompilerOptions.target < 3 ? 'Vue2ComponentSlots' : 'ComponentSlots'}<T>;
+	exposed: ${importCode}ComponentExposed<T>;
+};`.trim();
+        if (embeddedTypes) {
+            code += `
+type ComponentProps<T> =
+T extends (props: infer P, ...args: any) => any ? P :
+T extends new () => { $props: infer P } ? NonNullable<P> :
+{};
+
+type ComponentSlots<T> =
+T extends (props: any, ctx: { slots: infer S }, ...args: any) => any ? NonNullable<S> :
+T extends new () => { $slots: infer S } ? NonNullable<S> :
+{};
+
+type ComponentEmit<T> =
+T extends (props: any, ctx: { emit: infer E }, ...args: any) => any ? NonNullable<E> :
+T extends new () => { $emit: infer E } ? NonNullable<E> :
+{};
+
+type ComponentExposed<T> =
+T extends (props: any, ctx: { expose(exposed: infer E): any }, ...args: any) => any ? NonNullable<E> :
+T extends new () => infer E ? E :
+{};
+
+/**
+* Vue 2.x
+*/
+
+type Vue2ComponentSlots<T> =
+T extends (props: any, ctx: { slots: infer S }, ...args: any) => any ? NonNullable<S> :
+T extends new () => { $scopedSlots: infer S } ? NonNullable<S> :
+{};`;
+        }
+        return code;
     }
     function getExportNames(componentPath) {
         const program = tsLs.getProgram();
@@ -214,7 +245,7 @@ interface ComponentMeta<T> {
                 const properties = type.getProperties();
                 result = properties
                     .map((prop) => {
-                    const { resolveNestedProperties, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts);
+                    const { resolveNestedProperties, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts, core);
                     return resolveNestedProperties(prop);
                 })
                     .filter((prop) => !prop.name.match(propEventRegex));
@@ -258,7 +289,7 @@ interface ComponentMeta<T> {
                 const type = typeChecker.getTypeOfSymbolAtLocation($emit, symbolNode);
                 const calls = type.getCallSignatures();
                 return calls.map((call) => {
-                    const { resolveEventSignature, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts);
+                    const { resolveEventSignature, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts, core);
                     return resolveEventSignature(call);
                 }).filter(event => event.name);
             }
@@ -270,7 +301,7 @@ interface ComponentMeta<T> {
                 const type = typeChecker.getTypeOfSymbolAtLocation($slots, symbolNode);
                 const properties = type.getProperties();
                 return properties.map((prop) => {
-                    const { resolveSlotProperties, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts);
+                    const { resolveSlotProperties, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts, core);
                     return resolveSlotProperties(prop);
                 });
             }
@@ -284,7 +315,7 @@ interface ComponentMeta<T> {
                 // only exposed props will not have a valueDeclaration
                 !prop.valueDeclaration);
                 return properties.map((prop) => {
-                    const { resolveExposedProperties, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts);
+                    const { resolveExposedProperties, } = createSchemaResolvers(typeChecker, symbolNode, checkerOptions, ts, core);
                     return resolveExposedProperties(prop);
                 });
             }
@@ -320,7 +351,7 @@ interface ComponentMeta<T> {
     }
 }
 exports.baseCreate = baseCreate;
-function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: options }, ts) {
+function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: options, noDeclarations }, ts, core) {
     const visited = new Set();
     ;
     function shouldIgnore(subtype) {
@@ -352,6 +383,7 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
     function resolveNestedProperties(prop) {
         const subtype = typeChecker.getTypeOfSymbolAtLocation(prop, symbolNode);
         let schema;
+        let declarations;
         return {
             name: prop.getEscapedName().toString(),
             global: false,
@@ -363,6 +395,9 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
             required: !(prop.flags & ts.SymbolFlags.Optional),
             type: typeChecker.typeToString(subtype),
             rawType: rawType ? subtype : undefined,
+            get declarations() {
+                return declarations ??= getDeclarations(prop.declarations ?? []);
+            },
             get schema() {
                 return schema ??= resolveSchema(subtype);
             },
@@ -374,11 +409,15 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
         const paramType = signatures[0].parameters[0];
         const subtype = typeChecker.getTypeOfSymbolAtLocation(paramType, symbolNode);
         let schema;
+        let declarations;
         return {
             name: prop.getName(),
             type: typeChecker.typeToString(subtype),
             rawType: rawType ? subtype : undefined,
             description: ts.displayPartsToString(prop.getDocumentationComment(typeChecker)),
+            get declarations() {
+                return declarations ??= getDeclarations(prop.declarations ?? []);
+            },
             get schema() {
                 return schema ??= resolveSchema(subtype);
             },
@@ -387,11 +426,15 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
     function resolveExposedProperties(expose) {
         const subtype = typeChecker.getTypeOfSymbolAtLocation(expose, symbolNode);
         let schema;
+        let declarations;
         return {
             name: expose.getName(),
             type: typeChecker.typeToString(subtype),
             rawType: rawType ? subtype : undefined,
             description: ts.displayPartsToString(expose.getDocumentationComment(typeChecker)),
+            get declarations() {
+                return declarations ??= getDeclarations(expose.declarations ?? []);
+            },
             get schema() {
                 return schema ??= resolveSchema(subtype);
             },
@@ -400,11 +443,15 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
     function resolveEventSignature(call) {
         const subtype = typeChecker.getTypeOfSymbolAtLocation(call.parameters[1], symbolNode);
         let schema;
+        let declarations;
         return {
             name: typeChecker.getTypeOfSymbolAtLocation(call.parameters[0], symbolNode).value,
             type: typeChecker.typeToString(subtype),
             rawType: rawType ? subtype : undefined,
             signature: typeChecker.signatureToString(call),
+            get declarations() {
+                return declarations ??= call.declaration ? getDeclarations([call.declaration]) : [];
+            },
             get schema() {
                 return schema ??= typeChecker.getTypeArguments(subtype).map(resolveSchema);
             },
@@ -467,6 +514,35 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
         }
         return type;
     }
+    function getDeclarations(declaration) {
+        if (noDeclarations) {
+            return [];
+        }
+        return declaration.map(getDeclaration).filter(d => !!d);
+    }
+    function getDeclaration(declaration) {
+        const fileName = declaration.getSourceFile().fileName;
+        const [virtualFile] = core.virtualFiles.getVirtualFile(fileName);
+        if (virtualFile) {
+            const maps = core.virtualFiles.getMaps(virtualFile);
+            for (const [source, map] of maps) {
+                const start = map.toSourceOffset(declaration.getStart());
+                const end = map.toSourceOffset(declaration.getEnd());
+                if (start && end) {
+                    return {
+                        file: source,
+                        range: [start[0], end[0]],
+                    };
+                }
+                ;
+            }
+            return undefined;
+        }
+        return {
+            file: declaration.getSourceFile().fileName,
+            range: [declaration.getStart(), declaration.getEnd()],
+        };
+    }
     return {
         resolveNestedProperties,
         resolveSlotProperties,

package/out/types.d.ts

@@ -1,4 +1,8 @@
 import type * as ts from 'typescript/lib/tsserverlibrary';
+export interface Declaration {
+    file: string;
+    range: [number, number];
+}
 export interface ComponentMeta {
     props: PropertyMeta[];
     events: EventMeta[];
@@ -17,6 +21,7 @@ export interface PropertyMeta {
         name: string;
         text?: string;
     }[];
+    declarations: Declaration[];
     schema: PropertyMetaSchema;
 }
 export interface EventMeta {
@@ -24,6 +29,7 @@ export interface EventMeta {
     type: string;
     rawType?: ts.Type;
     signature: string;
+    declarations: Declaration[];
     schema: PropertyMetaSchema[];
 }
 export interface SlotMeta {
@@ -31,6 +37,7 @@ export interface SlotMeta {
     type: string;
     rawType?: ts.Type;
     description: string;
+    declarations: Declaration[];
     schema: PropertyMetaSchema;
 }
 export interface ExposeMeta {
@@ -38,6 +45,7 @@ export interface ExposeMeta {
     description: string;
     type: string;
     rawType?: ts.Type;
+    declarations: Declaration[];
     schema: PropertyMetaSchema;
 }
 export type PropertyMetaSchema = string | {
@@ -69,4 +77,5 @@ export interface MetaCheckerOptions {
     forceUseTs?: boolean;
     printer?: ts.PrinterOptions;
     rawType?: boolean;
+    noDeclarations?: boolean;
 }

package/out/types.js

@@ -1,4 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-;
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vue-component-meta",
-	"version": "1.3.14",
+	"version": "1.3.16",
 	"main": "out/index.js",
 	"license": "MIT",
 	"files": [
@@ -13,13 +13,13 @@
 		"directory": "packages/vue-component-meta"
 	},
 	"dependencies": {
-		"@volar/language-core": "1.4.0-alpha.7",
-		"@volar/vue-language-core": "1.3.14",
+		"@volar/language-core": "1.4.0-alpha.9",
+		"@volar/vue-language-core": "1.3.16",
 		"typesafe-path": "^0.2.2"
 	},
 	"peerDependencies": {
 		"typescript": "*",
 		"vue-component-type-helpers": "1.3.12"
 	},
-	"gitHead": "551efbac980e96b9ef7f1657c94a504f47e39e9d"
+	"gitHead": "40066617609780f891a60eea1fc3c7c84cbc5505"
 }