svelte-docinfo 0.2.0 → 0.3.0

package/README.md

@@ -37,15 +37,14 @@ but instead of AST-only inspection it uses the TypeScript compiler API for riche
 and also analyzes TypeScript modules.
 The docs [compare](https://svelte-docinfo.fuz.dev/docs/introduction#Compared-to-sveld) them.
 
-This is an early release --
-there are gaps to be filled and design choices to make,
-but for Svelte 5 it's mostly complete and used in production websites.
-Please open issues for bugs
+The library is mostly complete for Svelte 5 and used in production websites,
+but you may find gaps and flaws -- please open issues for bugs
 and [discussions](https://github.com/fuzdev/svelte-docinfo/discussions)
 for everything else!
 
-**AI disclosure:** the code and docs beyond the intro were written by Claude Code with uneven human guidance.
-The first release took about 5 months of intermittent work and 500 manual commits.
+**AI disclosure:** the code and docs beyond the intro
+were mostly written by Claude Code with uneven human guidance.
+The first release took 5 months of intermittent work and ~500 manual commits.
 
 ## Quick start
 
@@ -95,7 +94,8 @@ Three ways to integrate `svelte-docinfo`:
 import svelteDocinfo from 'svelte-docinfo/vite.js';
 
 export default defineConfig({plugins: [sveltekit(), svelteDocinfo()]});
-// then anywhere in your app: import {modules} from 'virtual:svelte-docinfo';
+// then anywhere in your app:
+// import {modules} from 'virtual:svelte-docinfo';
 ```
 
 2. [CLI](#cli) - quick analysis from the command line, useful for ad-hoc inspection and shell pipelines:
@@ -174,6 +174,8 @@ All three produce the same JSON shape:
 }
 ```
 
+For many more worked examples — source input paired with the exact JSON `svelte-docinfo` emits — browse the [test fixtures](https://github.com/fuzdev/svelte-docinfo/tree/main/src/test/fixtures), where each case sits beside its `expected.json`.
+
 ## Vite plugin
 
 1. Add the plugin to `vite.config.ts`:
@@ -336,7 +338,8 @@ Known gaps: standalone `namespace Foo {}` declarations and decorators are not ye
 was this project's main inspiration.
 
 Extracted from [fuz_ui](https://github.com/fuzdev/fuz_ui),
-which has example components using the data for docs websites.
+which has example components using the data for docs websites like
+[`DeclarationDetail`](https://github.com/fuzdev/fuz_ui/blob/main/src/lib/DeclarationDetail.svelte).
 
 `svelte-docinfo` is more featureful than it would be
 otherwise thanks to LLM assistance, mostly Claude Code.

package/dist/analyze-core.d.ts

@@ -2,8 +2,8 @@
  * Pure two-phase analysis orchestrator.
  *
  * Extracted from `analyze.ts` to break what would otherwise be a circular
- * import: `session.ts → analyze.ts (for the orchestrator) → session.ts (for
- * the wrappers)`. With the orchestrator here, both `session.ts` and
+ * import: `session.ts` → `analyze.ts` (for the orchestrator) → `session.ts`
+ * (for the wrappers). With the orchestrator here, both `session.ts` and
  * `analyze.ts` import downward into this module without depending on each
  * other.
  *

package/dist/analyze-core.js

@@ -2,8 +2,8 @@
  * Pure two-phase analysis orchestrator.
  *
  * Extracted from `analyze.ts` to break what would otherwise be a circular
- * import: `session.ts → analyze.ts (for the orchestrator) → session.ts (for
- * the wrappers)`. With the orchestrator here, both `session.ts` and
+ * import: `session.ts` → `analyze.ts` (for the orchestrator) → `session.ts`
+ * (for the wrappers). With the orchestrator here, both `session.ts` and
  * `analyze.ts` import downward into this module without depending on each
  * other.
  *

package/dist/exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/exports.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAMH,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAMjD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,SAAS,EAAE,OAAO,CAAC;IACnB,2GAA2G;IAC3G,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACtC;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;IACpC,oEAAoE;IACpE,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,iCAAiC;IACjC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC5B,qDAAqD;IACrD,UAAU,EAAE,OAAO,CAAC;CACpB;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,aAAa,CA+BpF,CAAC;AAiCF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC3B,UAAU,MAAM,EAChB,WAAW,MAAM,EACjB,SAAS;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,KAC3C,MAAM,GAAG,IAwCX,CAAC;AAkBF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,mBAAmB,GAC/B,SAAS,uBAAuB,KAC9B,OAAO,CAAC,sBAAsB,CA0DhC,CAAC"}
+{"version":3,"file":"exports.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/exports.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAMH,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAMjD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,SAAS,EAAE,OAAO,CAAC;IACnB,2GAA2G;IAC3G,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACtC;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;IACpC,oEAAoE;IACpE,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,iCAAiC;IACjC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC5B,qDAAqD;IACrD,UAAU,EAAE,OAAO,CAAC;CACpB;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,aAAa,CA+BpF,CAAC;AAoCF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC3B,UAAU,MAAM,EAChB,WAAW,MAAM,EACjB,SAAS;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,KAC3C,MAAM,GAAG,IAwCX,CAAC;AAkBF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,mBAAmB,GAC/B,SAAS,uBAAuB,KAC9B,OAAO,CAAC,sBAAsB,CA0DhC,CAAC"}

package/dist/exports.js

@@ -71,7 +71,10 @@ const flattenConditions = (value, prefix) => {
     }
     // Object = conditions map (possibly nested)
     if (typeof value === 'object' && !Array.isArray(value)) {
-        const result = {};
+        // Null-prototype map: condition keys come from package.json `exports` (external
+        // input) and are read back by key in `selectCondition` (`key in conditions`,
+        // `conditions[key]`); avoids prototype keys leaking into membership/lookup.
+        const result = Object.create(null);
         for (const [key, nested] of Object.entries(value)) {
             const flattened = flattenConditions(nested, key);
             if (flattened) {

package/dist/svelte.d.ts

@@ -15,7 +15,7 @@
  * There is no Svelte 4 compatibility layer.
  *
  * @see `typescript-exports.ts` for `analyzeExports`, `extractModuleComment`
- * @see `typescript-extract-shared.ts` for `parseGenericParam`, `filterIntersectionProperties`
+ * @see `typescript-extract-shared.ts` for `parseGenericParam`, `filterExternalProperties`
  * @see `typescript-program.ts` for `IsExternalFile`, `createIsExternalFile`
  * @see `tsdoc.ts` for `parseComment`, `applyToDeclaration`
  * @see `source.ts` for `SourceFileInfo`, `getComponentName`

package/dist/svelte.js

@@ -15,7 +15,7 @@
  * There is no Svelte 4 compatibility layer.
  *
  * @see `typescript-exports.ts` for `analyzeExports`, `extractModuleComment`
- * @see `typescript-extract-shared.ts` for `parseGenericParam`, `filterIntersectionProperties`
+ * @see `typescript-extract-shared.ts` for `parseGenericParam`, `filterExternalProperties`
  * @see `typescript-program.ts` for `IsExternalFile`, `createIsExternalFile`
  * @see `tsdoc.ts` for `parseComment`, `applyToDeclaration`
  * @see `source.ts` for `SourceFileInfo`, `getComponentName`
@@ -28,7 +28,7 @@ import { svelte2tsx } from 'svelte2tsx';
 import ts from 'typescript';
 import { parseComment, applyToDeclaration, hasModuleTag } from './tsdoc.js';
 import { createIsExternalFile } from './typescript-program.js';
-import { parseGenericParam, filterIntersectionProperties } from './typescript-extract-shared.js';
+import { parseGenericParam, filterExternalProperties } from './typescript-extract-shared.js';
 import { extractModuleComment, analyzeExports } from './typescript-exports.js';
 import { getComponentName, SVELTE_VIRTUAL_SUFFIX } from './source.js';
 import { extractDependencies } from './source-config.js';
@@ -638,14 +638,14 @@ const extractPropsViaChecker = (virtualSource, checker, componentName, filePath,
     // Detect `acceptsChildren` via type inference: `children` must resolve to a
     // `Snippet<...>` type. Checking the symbol name alone (the previous approach)
     // misreports a non-Snippet `children` (e.g. `children: string`) as accepting
-    // children. The lookup runs on the unfiltered intersection so inherited
+    // children. The lookup runs on the unfiltered props type so inherited
     // `children` from `SvelteHTMLElements`/`DOMAttributes` (declared as `Snippet`)
     // is honored even when its declaration lives in node_modules.
-    const allProperties = propsType.getProperties();
     const acceptsChildren = detectChildrenSnippet(propsType, propsTypeNode, checker, diagnostics, componentName, filePath);
-    // For intersection types, filter out properties from external sources (node_modules)
-    const intersectionResult = filterIntersectionProperties(propsType, propsTypeNode, checker, isExternalFile);
-    const properties = intersectionResult?.properties ?? allProperties;
+    // Drop properties contributed by external types (node_modules / svelte's
+    // element-attribute bags like `SvelteHTMLElements['li']`); those external
+    // types are summarized in `intersects` rather than enumerated as props.
+    const { properties, externalTypes } = filterExternalProperties(propsType, propsTypeNode, checker, isExternalFile);
     const props = [];
     for (const prop of properties) {
         const propDecl = prop.valueDeclaration || prop.declarations?.[0];
@@ -693,7 +693,7 @@ const extractPropsViaChecker = (virtualSource, checker, componentName, filePath,
         const propSourceFile = propDecl?.getSourceFile();
         props.push(assemblePropInfo(prop.name, typeString, optional, propDecl, propSourceFile, propsDefaults, bindableProps, snippetParams));
     }
-    return { props, intersectionTypes: intersectionResult?.intersectionTypes, acceptsChildren };
+    return { props, externalTypes, acceptsChildren };
 };
 /**
  * Analyze a Svelte module using checker-backed analysis.
@@ -813,15 +813,15 @@ export const analyzeSvelteModule = (sourceFile, modulePath, checker, options, di
     const isExternalFile = createIsExternalFile(options);
     // Extract props via checker (resolves imported types)
     const { bindableProps, propsDefaults } = extractPropsMetadata(virtualTsSource);
-    const { props, intersectionTypes, acceptsChildren: propsAcceptsChildren, } = extractPropsViaChecker(virtualTsSource, checker, componentName, modulePath, virtualFile.sourceMap, diagnostics, propsDefaults, bindableProps, isExternalFile);
+    const { props, externalTypes, acceptsChildren: propsAcceptsChildren, } = extractPropsViaChecker(virtualTsSource, checker, componentName, modulePath, virtualFile.sourceMap, diagnostics, propsDefaults, bindableProps, isExternalFile);
     if (props.length > 0) {
         componentDecl.props = props;
     }
-    if (intersectionTypes?.length) {
-        componentDecl.intersects = intersectionTypes;
+    if (externalTypes?.length) {
+        componentDecl.intersects = externalTypes;
     }
     // Determine acceptsChildren via two paths:
-    // Path A: children found in props type (from extractPropsViaChecker, before intersection filtering)
+    // Path A: children found in props type (from extractPropsViaChecker, before external-property filtering)
     // Path B: implicit children usage in template (for components without $props() children declaration)
     let acceptsChildren = propsAcceptsChildren;
     if (!acceptsChildren) {

package/dist/tsdoc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tsdoc.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/tsdoc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,KAAK,EAAC,oBAAoB,EAAE,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAElF;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAClC,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,MAAM,CAAC,EAAE,KAAK,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAC,CAAC,CAAC;IACrD,qCAAqC;IACrC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB,8CAA8C;IAC9C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sCAAsC;IACtC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uFAAuF;IACvF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,iEAAiE;IACjE,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAYD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,YAAY,GACxB,MAAM,EAAE,CAAC,IAAI,EACb,YAAY,EAAE,CAAC,UAAU,KACvB,kBAAkB,GAAG,SAoGvB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,GAC9B,aAAa,oBAAoB,GAAG,eAAe,EACnD,OAAO,kBAAkB,GAAG,SAAS,KACnC,IAgCF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,EAAE,CAAC,IAAI,KAAG,OACsB,CAAC;AAEpE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,GAAI,aAAa,MAAM,KAAG,MAAM,GAAG,SAW3D,CAAC"}
+{"version":3,"file":"tsdoc.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/tsdoc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,KAAK,EAAC,oBAAoB,EAAE,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAElF;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAClC,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,MAAM,CAAC,EAAE,KAAK,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAC,CAAC,CAAC;IACrD,qCAAqC;IACrC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB,8CAA8C;IAC9C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sCAAsC;IACtC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uFAAuF;IACvF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,iEAAiE;IACjE,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAYD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,YAAY,GACxB,MAAM,EAAE,CAAC,IAAI,EACb,YAAY,EAAE,CAAC,UAAU,KACvB,kBAAkB,GAAG,SA4GvB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,GAC9B,aAAa,oBAAoB,GAAG,eAAe,EACnD,OAAO,kBAAkB,GAAG,SAAS,KACnC,IAgCF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,EAAE,CAAC,IAAI,KAAG,OACsB,CAAC;AAEpE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,GAAI,aAAa,MAAM,KAAG,MAAM,GAAG,SAW3D,CAAC"}

package/dist/tsdoc.js

@@ -85,7 +85,12 @@ export const parseComment = (node, sourceFile) => {
     if (tsdocComments.length === 0)
         return undefined;
     let fullText = '';
-    const params = {};
+    // Null-prototype map: keys are parameter names parsed from source. Without it,
+    // a parameter named after an `Object.prototype` key (`constructor`, `toString`,
+    // `__proto__`, …) with no matching `@param` tag would read the inherited
+    // prototype value on lookup (`tsdocParams?.[param.name]`) instead of `undefined`,
+    // and writing such a key (`@param __proto__`) would pollute the prototype.
+    const params = Object.create(null);
     let returns;
     let throws;
     let examples;
@@ -161,7 +166,10 @@ export const parseComment = (node, sourceFile) => {
             if (match) {
                 const paramName = match[1];
                 const description = match[2].trim();
-                (mutates ??= {})[paramName] = description;
+                // Null-prototype map: `paramName` comes from source (`\w+` matches
+                // `__proto__`, `constructor`, …); a plain object would let such a key
+                // pollute the prototype on write and read back later by key.
+                (mutates ??= Object.create(null))[paramName] = description;
             }
         }
         else if (tagName === 'nodocs') {

package/dist/typescript-extract-shared.d.ts

@@ -86,19 +86,23 @@ export declare const isExternalIntersectionBranch: (branchNode: ts.TypeNode, che
  */
 export declare const resolveIntersectionTypeNode: (type: ts.Type, typeNode: ts.Node) => ts.IntersectionTypeNode | undefined;
 /**
- * Filter intersection type properties to exclude those from external sources,
- * and extract type names for branches whose properties are all external.
- *
- * Returns `null` for non-intersection types (caller should use unfiltered properties).
- * For intersection types, returns filtered properties and external type names.
- *
- * Per-property filtering works through utility types (Partial, Pick, Readonly)
- * because TypeScript preserves original declaration sources on mapped type properties.
+ * Partition a type's properties into local (kept) and external (dropped), and
+ * collect the external type references that contributed the dropped ones.
+ *
+ * Applies to any composition shape — intersection, union, bare reference,
+ * indexed-access — not only intersections. Membership is decided per property
+ * by declaration origin (`isExternalProperty`), which is structure-agnostic:
+ * TypeScript preserves original declaration sources on derived properties, so
+ * the test gives the right answer through utility-type wrappers (Partial, Pick,
+ * `OmitStrict`) too. A property with no declarations (synthesized) is treated as
+ * local and kept. The external-type labels for `intersects` come from an AST
+ * walk (`collectExternalTypeRefs`) — the authoritative source for the
+ * `&`/`|`/index-access shape inference would otherwise erase.
  */
-export declare const filterIntersectionProperties: (type: ts.Type, typeNode: ts.Node, checker: ts.TypeChecker, isExternalFile: IsExternalFile) => {
+export declare const filterExternalProperties: (type: ts.Type, typeNode: ts.Node, checker: ts.TypeChecker, isExternalFile: IsExternalFile) => {
     properties: Array<ts.Symbol>;
-    intersectionTypes: Array<string>;
-} | null;
+    externalTypes: Array<string>;
+};
 /**
  * Detect a Svelte 5 reactivity rune from a variable or property initializer.
  *

package/dist/typescript-extract-shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typescript-extract-shared.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/typescript-extract-shared.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,KAAK,EACX,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EAEnB,aAAa,EAEb,UAAU,EACV,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAC,oBAAoB,EAAE,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAC,KAAK,UAAU,EAA8B,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAmC,KAAK,kBAAkB,EAAC,MAAM,YAAY,CAAC;AACrF,OAAO,EAAC,KAAK,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAE5D;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,KAAG,eA0BvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B,GACtC,KAAK,EAAE,CAAC,SAAS,EACjB,SAAS,EAAE,CAAC,WAAW,EACvB,aAAa,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,KAC7C,KAAK,CAAC,aAAa,CAiDrB,CAAC;AA8JF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,sBAAsB,GAClC,QAAQ,oBAAoB,GAAG,eAAe,EAC9C,YAAY,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,EACvC,SAAS,EAAE,CAAC,WAAW,EACvB,OAAO,kBAAkB,GAAG,SAAS,EACrC,qBAAqB,EAAE,CAAC,IAAI,EAC5B,MAAM,MAAM,EACZ,aAAa,KAAK,CAAC,UAAU,CAAC,EAC9B,uBAAoB,KAClB,IAiBF,CAAC;AAYF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACxC,YAAY,EAAE,CAAC,QAAQ,EACvB,SAAS,EAAE,CAAC,WAAW,EACvB,gBAAgB,cAAc,KAC5B,OASF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GACvC,MAAM,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,CAAC,IAAI,KACf,EAAE,CAAC,oBAAoB,GAAG,SAW5B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,GACxC,MAAM,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,CAAC,IAAI,EACjB,SAAS,EAAE,CAAC,WAAW,EACvB,gBAAgB,cAAc,KAC5B;IAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAAC,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAAC,GAAG,IA4BrE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC5B,aAAa,EAAE,CAAC,UAAU,GAAG,SAAS,KACpC,UAAU,GAAG,SA+Bf,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,EAAE,CAAC,IAAI,KAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAQ1F,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,EAAE,CAAC,wBAAwB,KAAG,gBActE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC5B,WAAW,aAAa,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,SAAS,KACnD,KAAK,CAAC,mBAAmB,CAa3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,4BAA4B,GACxC,eAAe,MAAM,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,EAChD,eAAe,MAAM,GAAG,WAAW,EACnC,kBAAkB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,KAAK,EAAE,CAAC,IAAI,GAAG,SAAS,EAC5D,6BAA6B,EAAE,CAAC,IAAI,EACpC,aAAa,oBAAoB,EACjC,SAAS,EAAE,CAAC,WAAW,EACvB,aAAa,KAAK,CAAC,UAAU,CAAC,EAC9B,cAAc;IAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,KAC9C,IAmDF,CAAC"}
+{"version":3,"file":"typescript-extract-shared.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/typescript-extract-shared.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,KAAK,EACX,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EAEnB,aAAa,EAEb,UAAU,EACV,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAC,oBAAoB,EAAE,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAC,KAAK,UAAU,EAA8B,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAmC,KAAK,kBAAkB,EAAC,MAAM,YAAY,CAAC;AACrF,OAAO,EAAC,KAAK,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAE5D;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,KAAG,eA0BvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B,GACtC,KAAK,EAAE,CAAC,SAAS,EACjB,SAAS,EAAE,CAAC,WAAW,EACvB,aAAa,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,KAC7C,KAAK,CAAC,aAAa,CAoDrB,CAAC;AA8JF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,sBAAsB,GAClC,QAAQ,oBAAoB,GAAG,eAAe,EAC9C,YAAY,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,EACvC,SAAS,EAAE,CAAC,WAAW,EACvB,OAAO,kBAAkB,GAAG,SAAS,EACrC,qBAAqB,EAAE,CAAC,IAAI,EAC5B,MAAM,MAAM,EACZ,aAAa,KAAK,CAAC,UAAU,CAAC,EAC9B,uBAAoB,KAClB,IAiBF,CAAC;AAYF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACxC,YAAY,EAAE,CAAC,QAAQ,EACvB,SAAS,EAAE,CAAC,WAAW,EACvB,gBAAgB,cAAc,KAC5B,OASF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GACvC,MAAM,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,CAAC,IAAI,KACf,EAAE,CAAC,oBAAoB,GAAG,SAW5B,CAAC;AA6EF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,wBAAwB,GACpC,MAAM,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,CAAC,IAAI,EACjB,SAAS,EAAE,CAAC,WAAW,EACvB,gBAAgB,cAAc,KAC5B;IAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAU7D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC5B,aAAa,EAAE,CAAC,UAAU,GAAG,SAAS,KACpC,UAAU,GAAG,SA+Bf,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,EAAE,CAAC,IAAI,KAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAQ1F,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,EAAE,CAAC,wBAAwB,KAAG,gBActE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC5B,WAAW,aAAa,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,SAAS,KACnD,KAAK,CAAC,mBAAmB,CAa3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,4BAA4B,GACxC,eAAe,MAAM,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,EAChD,eAAe,MAAM,GAAG,WAAW,EACnC,kBAAkB,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,KAAK,EAAE,CAAC,IAAI,GAAG,SAAS,EAC5D,6BAA6B,EAAE,CAAC,IAAI,EACpC,aAAa,oBAAoB,EACjC,SAAS,EAAE,CAAC,WAAW,EACvB,aAAa,KAAK,CAAC,UAAU,CAAC,EAC9B,cAAc;IAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,KAC9C,IAmDF,CAAC"}

package/dist/typescript-extract-shared.js

@@ -103,7 +103,10 @@ export const extractSignatureParameters = (sig, checker, tsdocParams) => {
             const prefix = param.name + '.';
             for (const [key, value] of Object.entries(tsdocParams)) {
                 if (key.startsWith(prefix)) {
-                    (propertyDescriptions ??= {})[key.slice(prefix.length)] = value;
+                    // Null-prototype map: the sliced sub-path is source-derived and is
+                    // emitted as `propertyDescriptions`; a `@param obj.__proto__` key on a
+                    // plain object would pollute the prototype on write.
+                    (propertyDescriptions ??= Object.create(null))[key.slice(prefix.length)] = value;
                 }
             }
         }
@@ -347,38 +350,92 @@ export const resolveIntersectionTypeNode = (type, typeNode) => {
     return undefined;
 };
 /**
- * Filter intersection type properties to exclude those from external sources,
- * and extract type names for branches whose properties are all external.
+ * Determine whether a type-reference / indexed-access node names a type whose
+ * properties all come from external files (e.g. `SvelteHTMLElements['li']`,
+ * `HTMLAttributes<HTMLDivElement>`). Such a node is an external attribute "bag"
+ * that should be summarized in `intersects` rather than enumerated as members.
  *
- * Returns `null` for non-intersection types (caller should use unfiltered properties).
- * For intersection types, returns filtered properties and external type names.
+ * Mirrors the per-property origin test used for membership: external only when
+ * the node has at least one property and every property is external. A
+ * zero-property branch (e.g. a pure index signature) is not surfaced — there is
+ * no named member to attribute to it.
+ */
+const isExternalTypeRefNode = (node, checker, isExternalFile) => {
+    const props = checker.getTypeAtLocation(node).getProperties();
+    return props.length > 0 && props.every((p) => isExternalProperty(p, isExternalFile));
+};
+/**
+ * Walk a written type node and collect, in source order, the verbatim text of
+ * every external type reference it composes.
+ *
+ * Structure is read from the AST rather than the inferred type because
+ * inference erases it: `(A | B) & C` normalizes to a union and `X['k']`
+ * flattens to a property bag, both losing the `&`/`|`/index-access shape the
+ * author wrote. Composition nodes (intersection, union, parenthesized) recurse;
+ * leaf references (`TypeReference`, `IndexedAccessType`) are tested with
+ * `isExternalTypeRefNode` and, when external, emitted via `getText()`. Inline
+ * object literals and other local shapes contribute no entry.
+ *
+ * @mutates out - appends each external reference's source text
+ */
+const collectExternalTypeRefs = (node, checker, isExternalFile, out) => {
+    if (ts.isParenthesizedTypeNode(node)) {
+        collectExternalTypeRefs(node.type, checker, isExternalFile, out);
+    }
+    else if (ts.isIntersectionTypeNode(node) || ts.isUnionTypeNode(node)) {
+        for (const branch of node.types)
+            collectExternalTypeRefs(branch, checker, isExternalFile, out);
+    }
+    else if (ts.isTypeReferenceNode(node) || ts.isIndexedAccessTypeNode(node)) {
+        if (isExternalTypeRefNode(node, checker, isExternalFile))
+            out.push(node.getText());
+    }
+};
+/**
+ * Resolve a props/type-alias annotation node to the written type node whose
+ * structure drives `intersects` extraction.
+ *
+ * The svelte2tsx props annotation is a reference to a generated `$$ComponentProps`
+ * alias; unwrap one level of *local* type-alias reference so the underlying
+ * composition (`SvelteHTMLElements['li']`, `(A | B) & C`, …) is visible. External
+ * alias references are left intact so they read as a single named bag rather than
+ * leaking their node_modules-internal definition. Type-alias callers pass the
+ * written node directly, so for them this is a no-op.
+ */
+const resolveAnnotationTypeNode = (typeNode, checker, isExternalFile) => {
+    if (ts.isTypeReferenceNode(typeNode)) {
+        const aliasDecl = checker
+            .getSymbolAtLocation(typeNode.typeName)
+            ?.getDeclarations()
+            ?.find(ts.isTypeAliasDeclaration);
+        if (aliasDecl && !isExternalFile(aliasDecl.getSourceFile()))
+            return aliasDecl.type;
+    }
+    return ts.isTypeNode(typeNode) ? typeNode : undefined;
+};
+/**
+ * Partition a type's properties into local (kept) and external (dropped), and
+ * collect the external type references that contributed the dropped ones.
  *
- * Per-property filtering works through utility types (Partial, Pick, Readonly)
- * because TypeScript preserves original declaration sources on mapped type properties.
+ * Applies to any composition shape — intersection, union, bare reference,
+ * indexed-access — not only intersections. Membership is decided per property
+ * by declaration origin (`isExternalProperty`), which is structure-agnostic:
+ * TypeScript preserves original declaration sources on derived properties, so
+ * the test gives the right answer through utility-type wrappers (Partial, Pick,
+ * `OmitStrict`) too. A property with no declarations (synthesized) is treated as
+ * local and kept. The external-type labels for `intersects` come from an AST
+ * walk (`collectExternalTypeRefs`) — the authoritative source for the
+ * `&`/`|`/index-access shape inference would otherwise erase.
  */
-export const filterIntersectionProperties = (type, typeNode, checker, isExternalFile) => {
-    if (!type.isIntersection())
-        return null;
+export const filterExternalProperties = (type, typeNode, checker, isExternalFile) => {
     const properties = type
         .getProperties()
         .filter((prop) => !isExternalProperty(prop, isExternalFile));
-    // Resolve through type aliases (e.g., svelte2tsx $$ComponentProps) to find
-    // the IntersectionTypeNode for `intersects` extraction.
-    const intersectionNode = resolveIntersectionTypeNode(type, typeNode);
-    const intersectionTypes = [];
-    if (intersectionNode) {
-        for (const branch of intersectionNode.types) {
-            if (ts.isTypeReferenceNode(branch) || ts.isIndexedAccessTypeNode(branch)) {
-                const branchType = checker.getTypeAtLocation(branch);
-                const branchProps = branchType.getProperties();
-                if (branchProps.length > 0 &&
-                    branchProps.every((p) => isExternalProperty(p, isExternalFile))) {
-                    intersectionTypes.push(branch.getText());
-                }
-            }
-        }
-    }
-    return { properties, intersectionTypes };
+    const externalTypes = [];
+    const annotation = resolveAnnotationTypeNode(typeNode, checker, isExternalFile);
+    if (annotation)
+        collectExternalTypeRefs(annotation, checker, isExternalFile, externalTypes);
+    return { properties, externalTypes };
 };
 /**
  * Detect a Svelte 5 reactivity rune from a variable or property initializer.

package/dist/typescript-extract-type-properties.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typescript-extract-type-properties.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/typescript-extract-type-properties.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5B,OAAO,KAAK,EAAC,oBAAoB,EAAkB,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAC,KAAK,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAC,KAAK,cAAc,EAAC,MAAM,yBAAyB,CAAC;AA+J5D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,0BAA0B,GACtC,MAAM,EAAE,CAAC,oBAAoB,EAC7B,UAAU,EAAE,CAAC,IAAI,EACjB,SAAS,EAAE,CAAC,WAAW,EACvB,aAAa,oBAAoB,EACjC,aAAa,KAAK,CAAC,UAAU,CAAC,EAC9B,gBAAgB,cAAc,KAC5B,IA2IF,CAAC"}
+{"version":3,"file":"typescript-extract-type-properties.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/typescript-extract-type-properties.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5B,OAAO,KAAK,EAAC,oBAAoB,EAAkB,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAC,KAAK,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAC,KAAK,cAAc,EAAC,MAAM,yBAAyB,CAAC;AA+J5D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,0BAA0B,GACtC,MAAM,EAAE,CAAC,oBAAoB,EAC7B,UAAU,EAAE,CAAC,IAAI,EACjB,SAAS,EAAE,CAAC,WAAW,EACvB,aAAa,oBAAoB,EACjC,aAAa,KAAK,CAAC,UAAU,CAAC,EAC9B,gBAAgB,cAAc,KAC5B,IA8IF,CAAC"}

package/dist/typescript-extract-type-properties.js

@@ -18,7 +18,7 @@ import ts from 'typescript';
 import {} from './diagnostics.js';
 import { parseComment, applyToDeclaration } from './tsdoc.js';
 import {} from './typescript-program.js';
-import { emitCallOrConstructSignature, filterIntersectionProperties, getNodeLocation, isExternalIntersectionBranch, populateCallableMember, resolveIntersectionTypeNode, } from './typescript-extract-shared.js';
+import { emitCallOrConstructSignature, filterExternalProperties, getNodeLocation, isExternalIntersectionBranch, populateCallableMember, resolveIntersectionTypeNode, } from './typescript-extract-shared.js';
 /**
  * Check whether a resolved type has properties worth extracting for documentation.
  *
@@ -160,11 +160,15 @@ const isReadonlyProperty = (prop, mappedReadonly) => {
 export const extractTypeAliasProperties = (node, nodeType, checker, declaration, diagnostics, isExternalFile) => {
     if (!hasExtractableProperties(nodeType))
         return;
-    // For intersection types, filter out properties from external sources (node_modules)
-    // and extract type names for the `intersects` field
-    const intersectionResult = filterIntersectionProperties(nodeType, node.type, checker, isExternalFile);
-    if (intersectionResult?.intersectionTypes.length) {
-        declaration.intersects = intersectionResult.intersectionTypes;
+    // Drop properties contributed by external types (node_modules / declaration
+    // files) and surface those external types in the `intersects` field. Applies
+    // to the property-bearing shapes that pass `hasExtractableProperties` above —
+    // intersections, bare references, indexed-access. Unions are gated out here
+    // (the Svelte prop path calls `filterExternalProperties` directly, so unions
+    // still surface `intersects` there, just not for plain type aliases).
+    const { properties: filteredProperties, externalTypes } = filterExternalProperties(nodeType, node.type, checker, isExternalFile);
+    if (externalTypes.length) {
+        declaration.intersects = externalTypes;
     }
     // Detect mapped-type-level readonly (e.g., Readonly<T>, { readonly [K in ...]: ... })
     let mappedReadonly = false;
@@ -177,9 +181,8 @@ export const extractTypeAliasProperties = (node, nodeType, checker, declaration,
             mappedReadonly = true;
         }
     }
-    // Extract named properties (filtered for intersections, full for other types)
-    const properties = intersectionResult?.properties ?? nodeType.getProperties();
-    for (const prop of properties) {
+    // Extract named properties (external contributions already filtered out)
+    for (const prop of filteredProperties) {
         // Skip internal TypeScript symbols
         if (prop.getName().startsWith('__@'))
             continue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-docinfo",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "static analysis for TypeScript and Svelte",
   "glyph": "📜",
   "logo": "logo.svg",
@@ -58,11 +58,12 @@
     }
   },
   "devDependencies": {
+    "@fuzdev/blake3_wasm": "^0.1.1",
     "@fuzdev/fuz_code": "^0.45.1",
-    "@fuzdev/fuz_css": "^0.60.0",
-    "@fuzdev/fuz_ui": "^0.195.1",
-    "@fuzdev/fuz_util": "^0.62.0",
-    "@fuzdev/gro": "^0.199.1",
+    "@fuzdev/fuz_css": "^0.61.1",
+    "@fuzdev/fuz_ui": "^0.197.0",
+    "@fuzdev/fuz_util": "^0.63.1",
+    "@fuzdev/gro": "^0.200.0",
     "@ryanatkn/eslint-config": "^0.12.1",
     "@sveltejs/acorn-typescript": "^1.0.9",
     "@sveltejs/adapter-static": "^3.0.10",
@@ -74,14 +75,14 @@
     "@types/picomatch": "^4.0.2",
     "@webref/css": "^8.2.0",
     "eslint": "^9.39.1",
-    "eslint-plugin-svelte": "^3.13.1",
+    "eslint-plugin-svelte": "^3.19.0",
     "esm-env": "^1.2.2",
     "magic-string": "^0.30.21",
     "prettier": "^3.7.4",
     "prettier-plugin-svelte": "^3.4.1",
-    "svelte": "^5.55.10",
+    "svelte": "^5.56.0",
     "svelte-check": "^4.3.5",
-    "svelte2tsx": "^0.7.52",
+    "svelte2tsx": "^0.7.55",
     "tslib": "^2.8.1",
     "typescript-eslint": "^8.48.1",
     "vite": "^7.3.1",