@tsdoctor/model 0.3.0 → 0.4.0
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/index.d.ts +1 -23
- package/index.js +1 -2
- package/package.json +2 -2
- package/StructuredData.js +0 -18
package/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { ApiClass, ApiInterface, ApiItem, ApiModel, ApiNamespace, ApiPackage, Excerpt } from "@microsoft/api-extractor-model";
|
|
2
2
|
import { Effect, Schema } from "effect";
|
|
3
3
|
import { FlowContent, MarkdownNode } from "@effected/markdown";
|
|
4
|
-
import { PackageManifest } from "@effected/package-json";
|
|
5
4
|
import { DocNode } from "@microsoft/tsdoc";
|
|
6
5
|
declare namespace EntryPoints_d_exports {
|
|
7
6
|
export { ResolvedEntryItem, entryPointName, resolve };
|
|
@@ -573,27 +572,6 @@ declare function format(excerpt: Excerpt, options?: FormatOptions): string;
|
|
|
573
572
|
* @public
|
|
574
573
|
*/
|
|
575
574
|
declare function linkReferences(text: string, excerpt: Excerpt, routesByCanonicalRef: ReadonlyMap<string, string>): string;
|
|
576
|
-
declare namespace StructuredData_d_exports {
|
|
577
|
-
export { StructuredDataGraph, derive };
|
|
578
|
-
}
|
|
579
|
-
/**
|
|
580
|
-
* A schema.org JSON-LD graph.
|
|
581
|
-
*
|
|
582
|
-
* @alpha
|
|
583
|
-
*/
|
|
584
|
-
interface StructuredDataGraph {
|
|
585
|
-
readonly "@context": "https://schema.org";
|
|
586
|
-
readonly "@graph": ReadonlyArray<Record<string, unknown>>;
|
|
587
|
-
}
|
|
588
|
-
/**
|
|
589
|
-
* Derive schema.org structured data for a documented package.
|
|
590
|
-
*
|
|
591
|
-
* @remarks
|
|
592
|
-
* Not implemented yet — this is the phase-4 seam. Calling it throws.
|
|
593
|
-
*
|
|
594
|
-
* @alpha
|
|
595
|
-
*/
|
|
596
|
-
declare function derive(_apiPackage: ApiPackage, _manifest: PackageManifest): StructuredDataGraph;
|
|
597
575
|
declare namespace SyntheticBases_d_exports {
|
|
598
576
|
export { BASE_CLASS_ANCHOR, SyntheticBase, SyntheticBaseDetection, detect };
|
|
599
577
|
}
|
|
@@ -746,5 +724,5 @@ declare function seeReferences(item: ApiItem): ReadonlyArray<{
|
|
|
746
724
|
readonly text: string;
|
|
747
725
|
}>;
|
|
748
726
|
//#endregion
|
|
749
|
-
export { type ApiItemRef, ApiItems_d_exports as ApiItems, CrossLinker, type DocMeta, EntryPoints_d_exports as EntryPoints, type FrontmatterRenderer, type ItemKindSlug, Model_d_exports as Model, Render_d_exports as Render, type RenderPackageOptions, type RenderedDoc, type RouteFormatter, Routes_d_exports as Routes, Signature_d_exports as Signature,
|
|
727
|
+
export { type ApiItemRef, ApiItems_d_exports as ApiItems, CrossLinker, type DocMeta, EntryPoints_d_exports as EntryPoints, type FrontmatterRenderer, type ItemKindSlug, Model_d_exports as Model, 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 };
|
|
750
728
|
//# sourceMappingURL=index.d.ts.map
|
package/index.js
CHANGED
|
@@ -6,7 +6,6 @@ import { EntryPoints_exports } from "./EntryPoints.js";
|
|
|
6
6
|
import { Model_exports } from "./Model.js";
|
|
7
7
|
import { Signature_exports } from "./Signature.js";
|
|
8
8
|
import { Render_exports } from "./Render.js";
|
|
9
|
-
import { StructuredData_exports } from "./StructuredData.js";
|
|
10
9
|
import { SyntheticBases_exports } from "./SyntheticBases.js";
|
|
11
10
|
|
|
12
|
-
export { ApiItems_exports as ApiItems, CrossLinker, EntryPoints_exports as EntryPoints, Model_exports as Model, Render_exports as Render, Routes_exports as Routes, Signature_exports as Signature,
|
|
11
|
+
export { ApiItems_exports as ApiItems, CrossLinker, EntryPoints_exports as EntryPoints, Model_exports as Model, Render_exports as Render, Routes_exports as Routes, Signature_exports as Signature, SyntheticBases_exports as SyntheticBases, Tsdoc_exports as Tsdoc };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tsdoctor/model",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
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": [
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
},
|
|
44
44
|
"peerDependencies": {
|
|
45
45
|
"@effected/markdown": "^0.7.0",
|
|
46
|
-
"@effected/package-json": "^0.
|
|
46
|
+
"@effected/package-json": "^0.13.0",
|
|
47
47
|
"effect": "4.0.0-rc.109"
|
|
48
48
|
},
|
|
49
49
|
"peerDependenciesMeta": {
|
package/StructuredData.js
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
2
|
-
|
|
3
|
-
//#region src/StructuredData.ts
|
|
4
|
-
var StructuredData_exports = /* @__PURE__ */ __exportAll({ derive: () => derive });
|
|
5
|
-
/**
|
|
6
|
-
* Derive schema.org structured data for a documented package.
|
|
7
|
-
*
|
|
8
|
-
* @remarks
|
|
9
|
-
* Not implemented yet — this is the phase-4 seam. Calling it throws.
|
|
10
|
-
*
|
|
11
|
-
* @alpha
|
|
12
|
-
*/
|
|
13
|
-
function derive(_apiPackage, _manifest) {
|
|
14
|
-
throw new Error("@tsdoctor/model: StructuredData.derive is a phase-4 seam and is not implemented yet");
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
//#endregion
|
|
18
|
-
export { StructuredData_exports, derive };
|