@tsdoctor/model 0.8.11 → 0.8.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ApiExtractedPackage.js +1 -2
- package/ApiItems.js +1 -2
- package/CrossLinker.js +1 -2
- package/EntryPoints.js +1 -2
- package/Frontmatter.js +1 -2
- package/Model.js +1 -2
- package/Render.js +1 -2
- package/Routes.js +1 -2
- package/Signature.js +1 -2
- package/SyntheticBases.js +1 -2
- package/Tsdoc.js +1 -2
- package/TypeReferenceExtractor.js +1 -2
- package/_virtual/_rolldown/runtime.js +1 -2
- package/index.d.ts +0 -11
- package/internal/prose.js +1 -2
- package/internal/text.js +1 -2
- package/package.json +6 -6
package/ApiExtractedPackage.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ApiItemKind, ApiModel, ExcerptTokenKind } from "@microsoft/api-extractor-model";
|
|
2
2
|
import { VirtualPackage } from "@tsdoctor/vfs";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/ApiExtractedPackage.ts
|
|
5
5
|
/**
|
|
6
6
|
* Reconstructs TypeScript declaration files from an API Extractor model.
|
|
7
7
|
*
|
|
@@ -483,5 +483,4 @@ function trimTrailing(text, char) {
|
|
|
483
483
|
return text.slice(0, end);
|
|
484
484
|
}
|
|
485
485
|
|
|
486
|
-
//#endregion
|
|
487
486
|
export { ApiExtractedPackage };
|
package/ApiItems.js
CHANGED
|
@@ -3,7 +3,7 @@ import { memberAnchors as memberAnchors$1, memberRouteKeys as memberRouteKeys$1
|
|
|
3
3
|
import { hasModifier } from "./Tsdoc.js";
|
|
4
4
|
import { ApiItemKind } from "@microsoft/api-extractor-model";
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
// src/ApiItems.ts
|
|
7
7
|
var ApiItems_exports = /* @__PURE__ */ __exportAll({
|
|
8
8
|
categorize: () => categorize,
|
|
9
9
|
inheritance: () => inheritance,
|
|
@@ -164,5 +164,4 @@ function memberRouteKeys(item) {
|
|
|
164
164
|
return memberRouteKeys$1(item.displayName, memberRefs(item));
|
|
165
165
|
}
|
|
166
166
|
|
|
167
|
-
//#endregion
|
|
168
167
|
export { ApiItems_exports, categorize, inheritance, memberAnchors, memberRouteKeys, namespaceMembers, sourceLink };
|
package/CrossLinker.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { escapeRegExp } from "./internal/text.js";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/CrossLinker.ts
|
|
4
4
|
/**
|
|
5
5
|
* Link known API item names in prose to their docs. Immutable: construct one
|
|
6
6
|
* per build from either a precomputed name → route map ({@link CrossLinker.fromRoutes})
|
|
@@ -95,5 +95,4 @@ var CrossLinker = class CrossLinker {
|
|
|
95
95
|
}
|
|
96
96
|
};
|
|
97
97
|
|
|
98
|
-
//#endregion
|
|
99
98
|
export { CrossLinker };
|
package/EntryPoints.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/EntryPoints.ts
|
|
4
4
|
var EntryPoints_exports = /* @__PURE__ */ __exportAll({
|
|
5
5
|
entryPointName: () => entryPointName,
|
|
6
6
|
resolve: () => resolve
|
|
@@ -72,5 +72,4 @@ function resolve(apiPackage) {
|
|
|
72
72
|
return resolved;
|
|
73
73
|
}
|
|
74
74
|
|
|
75
|
-
//#endregion
|
|
76
75
|
export { EntryPoints_exports, entryPointName, resolve };
|
package/Frontmatter.js
CHANGED
|
@@ -2,7 +2,7 @@ import { Effect } from "effect";
|
|
|
2
2
|
import { FrontmatterSource, FrontmatterSourceBlock, FrontmatterSourceSplit } from "@effected/markdown";
|
|
3
3
|
import { Yaml, YamlStringifyOptions } from "@effected/yaml";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
// src/Frontmatter.ts
|
|
6
6
|
/**
|
|
7
7
|
* Stringify options shared by both emit sites.
|
|
8
8
|
*
|
|
@@ -148,5 +148,4 @@ function emitFrontmatterBlock(data) {
|
|
|
148
148
|
}));
|
|
149
149
|
}
|
|
150
150
|
|
|
151
|
-
//#endregion
|
|
152
151
|
export { emitFrontmatterBlock, parseFrontmatter, stringifyFrontmatter };
|
package/Model.js
CHANGED
|
@@ -4,7 +4,7 @@ import { Effect, Schema } from "effect";
|
|
|
4
4
|
import { existsSync } from "node:fs";
|
|
5
5
|
import { resolve } from "node:path";
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
// src/Model.ts
|
|
8
8
|
/**
|
|
9
9
|
* Effect-typed loading of Microsoft API Extractor `.api.json` models.
|
|
10
10
|
*
|
|
@@ -86,5 +86,4 @@ const firstPackage = (model) => {
|
|
|
86
86
|
return pkg !== void 0 ? Effect.succeed(pkg) : Effect.fail(new EmptyModelError({ reason: "API model contains no packages" }));
|
|
87
87
|
};
|
|
88
88
|
|
|
89
|
-
//#endregion
|
|
90
89
|
export { EmptyModelError, ModelNotFoundError, ModelParseError, Model_exports, firstPackage, load };
|
package/Render.js
CHANGED
|
@@ -7,7 +7,7 @@ import { ApiItemContainerMixin } from "@microsoft/api-extractor-model";
|
|
|
7
7
|
import { Result } from "effect";
|
|
8
8
|
import { Blockquote, Code, Heading, InlineCode, List, ListItem, Markdown, Paragraph, Root, Strong, Text } from "@effected/markdown";
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
// src/Render.ts
|
|
11
11
|
var Render_exports = /* @__PURE__ */ __exportAll({
|
|
12
12
|
docs: () => docs,
|
|
13
13
|
isEmittable: () => isEmittable,
|
|
@@ -187,5 +187,4 @@ function docs(apiPackage, opts) {
|
|
|
187
187
|
});
|
|
188
188
|
}
|
|
189
189
|
|
|
190
|
-
//#endregion
|
|
191
190
|
export { Render_exports, docs, isEmittable, item, tree };
|
package/Routes.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
2
2
|
import { Schema } from "effect";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/Routes.ts
|
|
5
5
|
/**
|
|
6
6
|
* Output-route computation: collision detection over route candidates and the
|
|
7
7
|
* canonical anchor-id sanitizer. Detection is pure; the typed
|
|
@@ -261,5 +261,4 @@ function memberRouteKeys(className, members) {
|
|
|
261
261
|
return keys;
|
|
262
262
|
}
|
|
263
263
|
|
|
264
|
-
//#endregion
|
|
265
264
|
export { RouteCandidate, RouteCollisionError, Routes_exports, detectCollisions, memberAnchor, memberAnchors, memberRouteKeys, sanitizeId };
|
package/Signature.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
2
2
|
import { escapeRegExp } from "./internal/text.js";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/Signature.ts
|
|
5
5
|
var Signature_exports = /* @__PURE__ */ __exportAll({
|
|
6
6
|
format: () => format,
|
|
7
7
|
linkReferences: () => linkReferences,
|
|
@@ -96,5 +96,4 @@ function linkReferences(text, excerpt, routesByCanonicalRef) {
|
|
|
96
96
|
return result;
|
|
97
97
|
}
|
|
98
98
|
|
|
99
|
-
//#endregion
|
|
100
99
|
export { Signature_exports, format, linkReferences, stripExportDeclare };
|
package/SyntheticBases.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
2
2
|
import { ApiExportedMixin, ApiItemKind, ExcerptTokenKind } from "@microsoft/api-extractor-model";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/SyntheticBases.ts
|
|
5
5
|
var SyntheticBases_exports = /* @__PURE__ */ __exportAll({
|
|
6
6
|
BASE_CLASS_ANCHOR: () => BASE_CLASS_ANCHOR,
|
|
7
7
|
detect: () => detect
|
|
@@ -79,5 +79,4 @@ function detect(items) {
|
|
|
79
79
|
};
|
|
80
80
|
}
|
|
81
81
|
|
|
82
|
-
//#endregion
|
|
83
82
|
export { BASE_CLASS_ANCHOR, SyntheticBases_exports, detect };
|
package/Tsdoc.js
CHANGED
|
@@ -2,7 +2,7 @@ import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
|
2
2
|
import { ApiDocumentedItem, ApiReleaseTagMixin, ReleaseTag } from "@microsoft/api-extractor-model";
|
|
3
3
|
import { Code, InlineCode, Link, Paragraph, Text } from "@effected/markdown";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
// src/Tsdoc.ts
|
|
6
6
|
var Tsdoc_exports = /* @__PURE__ */ __exportAll({
|
|
7
7
|
deprecation: () => deprecation,
|
|
8
8
|
examples: () => examples,
|
|
@@ -246,5 +246,4 @@ function seeReferences(item) {
|
|
|
246
246
|
return [];
|
|
247
247
|
}
|
|
248
248
|
|
|
249
|
-
//#endregion
|
|
250
249
|
export { Tsdoc_exports, deprecation, examples, hasModifier, params, plainText, releaseTag, returns, seeReferences, summary, toMarkdown };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ApiItemKind } from "@microsoft/api-extractor-model";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/TypeReferenceExtractor.ts
|
|
4
4
|
/**
|
|
5
5
|
* Extracts type references from API Extractor models to generate import statements.
|
|
6
6
|
*
|
|
@@ -197,5 +197,4 @@ var TypeReferenceExtractor = class {
|
|
|
197
197
|
}
|
|
198
198
|
};
|
|
199
199
|
|
|
200
|
-
//#endregion
|
|
201
200
|
export { TypeReferenceExtractor };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// \0rolldown/runtime.js
|
|
2
2
|
var __defProp = Object.defineProperty;
|
|
3
3
|
var __exportAll = (all, no_symbols) => {
|
|
4
4
|
let target = {};
|
|
@@ -14,5 +14,4 @@ var __exportAll = (all, no_symbols) => {
|
|
|
14
14
|
return target;
|
|
15
15
|
};
|
|
16
16
|
|
|
17
|
-
//#endregion
|
|
18
17
|
export { __exportAll };
|
package/index.d.ts
CHANGED
|
@@ -3,8 +3,6 @@ import { VirtualPackage } from "@tsdoctor/vfs";
|
|
|
3
3
|
import { Effect, Schema } from "effect";
|
|
4
4
|
import { FlowContent, MarkdownNode } from "@effected/markdown";
|
|
5
5
|
import { DocNode } from "@microsoft/tsdoc";
|
|
6
|
-
//#endregion
|
|
7
|
-
//#region src/ApiExtractedPackage.d.ts
|
|
8
6
|
/**
|
|
9
7
|
* Reconstructs TypeScript declaration files from an API Extractor model.
|
|
10
8
|
*
|
|
@@ -259,8 +257,6 @@ declare function memberAnchors$1(item: ApiClass | ApiInterface): ReadonlyMap<str
|
|
|
259
257
|
* @public
|
|
260
258
|
*/
|
|
261
259
|
declare function memberRouteKeys$1(item: ApiClass | ApiInterface): ReadonlyMap<string, string>;
|
|
262
|
-
//#endregion
|
|
263
|
-
//#region src/types.d.ts
|
|
264
260
|
/**
|
|
265
261
|
* URL-stable slug for an item kind, used in routes and generated doc paths.
|
|
266
262
|
*
|
|
@@ -337,8 +333,6 @@ interface RenderPackageOptions {
|
|
|
337
333
|
*/
|
|
338
334
|
readonly filter?: (item: ApiItem) => boolean;
|
|
339
335
|
}
|
|
340
|
-
//#endregion
|
|
341
|
-
//#region src/CrossLinker.d.ts
|
|
342
336
|
/**
|
|
343
337
|
* Links known API item names in prose to their documentation routes. Matching
|
|
344
338
|
* is longest-name-first with word boundaries, skipping code spans and existing
|
|
@@ -372,8 +366,6 @@ export declare class CrossLinker {
|
|
|
372
366
|
*/
|
|
373
367
|
linkHtml(text: string): string;
|
|
374
368
|
}
|
|
375
|
-
//#endregion
|
|
376
|
-
//#region src/Frontmatter.d.ts
|
|
377
369
|
/**
|
|
378
370
|
* A parsed frontmatter document: the decoded frontmatter data and the body
|
|
379
371
|
* content that followed the closing delimiter.
|
|
@@ -944,8 +936,6 @@ declare function hasModifier(item: ApiItem, tagName: string): boolean;
|
|
|
944
936
|
declare function seeReferences(item: ApiItem): ReadonlyArray<{
|
|
945
937
|
readonly text: string;
|
|
946
938
|
}>;
|
|
947
|
-
//#endregion
|
|
948
|
-
//#region src/TypeReferenceExtractor.d.ts
|
|
949
939
|
/**
|
|
950
940
|
* Represents a type reference extracted from an API item.
|
|
951
941
|
* Contains information about where the type comes from and how to import it.
|
|
@@ -1106,6 +1096,5 @@ export declare class TypeReferenceExtractor {
|
|
|
1106
1096
|
*/
|
|
1107
1097
|
private parseCanonicalReference;
|
|
1108
1098
|
}
|
|
1109
|
-
//#endregion
|
|
1110
1099
|
export { type ApiItemRef, ApiItems_d_exports as ApiItems, type DocMeta, EntryPoints_d_exports as EntryPoints, type FrontmatterRenderer, type ImportStatement, type ItemKindSlug, Model_d_exports as Model, type ParsedFrontmatter, Render_d_exports as Render, type RenderPackageOptions, type RenderedDoc, type RouteFormatter, Routes_d_exports as Routes, Signature_d_exports as Signature, SyntheticBases_d_exports as SyntheticBases, Tsdoc_d_exports as Tsdoc, type TypeReference };
|
|
1111
1100
|
//# sourceMappingURL=index.d.ts.map
|
package/internal/prose.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Result } from "effect";
|
|
2
2
|
import { Markdown, Text } from "@effected/markdown";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/internal/prose.ts
|
|
5
5
|
/**
|
|
6
6
|
* Parse a single-line markdown prose string into phrasing nodes. The whole
|
|
7
7
|
* input is treated as one paragraph's inline content (prose from TSDoc
|
|
@@ -14,5 +14,4 @@ const phrasingFromMarkdown = (prose) => {
|
|
|
14
14
|
return parsed.success.length > 0 ? parsed.success : [new Text({ value: prose })];
|
|
15
15
|
};
|
|
16
16
|
|
|
17
|
-
//#endregion
|
|
18
17
|
export { phrasingFromMarkdown };
|
package/internal/text.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/internal/text.ts
|
|
2
2
|
/**
|
|
3
3
|
* Shared private text helpers.
|
|
4
4
|
*
|
|
@@ -7,5 +7,4 @@
|
|
|
7
7
|
/** Escape a literal string for embedding in a RegExp pattern. */
|
|
8
8
|
const escapeRegExp = (s) => s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
9
9
|
|
|
10
|
-
//#endregion
|
|
11
10
|
export { escapeRegExp };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tsdoctor/model",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.12",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Render Microsoft API Extractor models into LLM-lean markdown. Pure model loading, TSDoc extraction, type-signature formatting, and per-item markdown rendering.",
|
|
6
6
|
"keywords": [
|
|
@@ -38,15 +38,15 @@
|
|
|
38
38
|
"./package.json": "./package.json"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@effected/yaml": "^0.
|
|
41
|
+
"@effected/yaml": "^0.23.0",
|
|
42
42
|
"@microsoft/api-extractor-model": "7.33.12",
|
|
43
43
|
"@microsoft/tsdoc": "~0.16.0",
|
|
44
|
-
"@tsdoctor/vfs": "0.4.
|
|
44
|
+
"@tsdoctor/vfs": "0.4.8"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
|
-
"@effected/markdown": "^0.
|
|
48
|
-
"@effected/tsconfig-json": "^0.
|
|
49
|
-
"effect": "^4.0.
|
|
47
|
+
"@effected/markdown": "^0.20.0",
|
|
48
|
+
"@effected/tsconfig-json": "^0.17.0",
|
|
49
|
+
"effect": "^4.0.6"
|
|
50
50
|
},
|
|
51
51
|
"engines": {
|
|
52
52
|
"node": ">=24.11.0"
|