@tsdoctor/model 0.5.0 → 0.6.1

package/Render.js

@@ -31,6 +31,9 @@ const KIND_SLUG = {
 * `ApiExportedMixin`. Every other item, including any lacking the flag, is
 * kept.
 *
+* @deprecated Use `prepareWorkItems` from `@tsdoctor/pages`, which decides
+* which items receive a page (`isPageKind` for the kind, `SyntheticBases.detect`
+* for the hoisted `*_base` declarations this rule was written to drop).
 * @public
 */
 const isEmittable = (item) => item.isExported !== false;
@@ -42,6 +45,8 @@ const signatureOf = (item) => {
 * Render one API item's markdown body as flow nodes — the pre-serialization
 * form of {@link item}.
 *
+* @deprecated Use `buildPage` + `markdownTree` from `@tsdoctor/pages`, which
+* yields the same `FlowContent` nodes from a typed `Page`.
 * @alpha
 */
 function tree(apiItem, opts) {
@@ -128,6 +133,7 @@ function tree(apiItem, opts) {
 /**
 * Render one API item to a markdown body string (no frontmatter).
 *
+* @deprecated Use `buildPage` + `renderMarkdown` from `@tsdoctor/pages`.
 * @public
 */
 function item(apiItem, opts) {
@@ -139,6 +145,9 @@ function item(apiItem, opts) {
 * Walk a package's first entry point and assemble one RenderedDoc per
 * top-level member.
 *
+* @deprecated Use `prepareWorkItems` + `buildPage` + `renderMarkdown` from
+* `@tsdoctor/pages`; frontmatter is assembled by the adapter from the
+* `Page`'s facts and head tags.
 * @public
 */
 function docs(apiPackage, opts) {

package/index.d.ts

@@ -281,6 +281,8 @@ interface ApiItemRef {
 /**
  * Metadata handed to the injected frontmatter renderer for one doc.
  *
+ * @deprecated Exists only for `Render.docs`; use the `Page` facts from
+ * `@tsdoctor/pages` (`buildPage`) instead.
  * @public
  */
 interface DocMeta extends ApiItemRef {
@@ -296,12 +298,16 @@ type RouteFormatter = (ref: ApiItemRef) => string;
 /**
  * Injected: produce the frontmatter block (incl. trailing blank line) for a doc, or "".
  *
+ * @deprecated Exists only for `Render.docs`; adapters assemble frontmatter
+ * from a `@tsdoctor/pages` `Page` (see `emitFrontmatterBlock`).
  * @public
  */
 type FrontmatterRenderer = (meta: DocMeta) => string;
 /**
  * One rendered API doc = its metadata plus the assembled markdown (frontmatter + body).
  *
+ * @deprecated Exists only for `Render.docs`; use `buildPage` +
+ * `renderMarkdown` from `@tsdoctor/pages`.
  * @public
  */
 interface RenderedDoc extends DocMeta {
@@ -311,6 +317,8 @@ interface RenderedDoc extends DocMeta {
  * Options for `Render.docs`: the package name plus the optional injected
  * route, frontmatter, and filter services.
  *
+ * @deprecated Exists only for `Render.docs`; use `BuildPageInput` from
+ * `@tsdoctor/pages`.
  * @public
  */
 interface RenderPackageOptions {
@@ -529,6 +537,9 @@ declare namespace Render_d_exports {
  * `ApiExportedMixin`. Every other item, including any lacking the flag, is
  * kept.
  *
+ * @deprecated Use `prepareWorkItems` from `@tsdoctor/pages`, which decides
+ * which items receive a page (`isPageKind` for the kind, `SyntheticBases.detect`
+ * for the hoisted `*_base` declarations this rule was written to drop).
  * @public
  */
 declare const isEmittable: (item: ApiItem) => boolean;
@@ -536,6 +547,8 @@ declare const isEmittable: (item: ApiItem) => boolean;
  * Options for {@link item} and {@link tree}: the package name used in
  * fallbacks and an optional crosslinker applied to the rendered prose.
  *
+ * @deprecated Use `BuildPageInput` from `@tsdoctor/pages`, which carries the
+ * per-API `CrossLinker` as `linker`.
  * @public
  */
 interface RenderItemOptions {
@@ -547,12 +560,15 @@ interface RenderItemOptions {
  * Render one API item's markdown body as flow nodes — the pre-serialization
  * form of {@link item}.
  *
+ * @deprecated Use `buildPage` + `markdownTree` from `@tsdoctor/pages`, which
+ * yields the same `FlowContent` nodes from a typed `Page`.
  * @alpha
  */
 declare function tree(apiItem: ApiItem, opts: RenderItemOptions): ReadonlyArray<FlowContent>;
 /**
  * Render one API item to a markdown body string (no frontmatter).
  *
+ * @deprecated Use `buildPage` + `renderMarkdown` from `@tsdoctor/pages`.
  * @public
  */
 declare function item(apiItem: ApiItem, opts: RenderItemOptions): string;
@@ -560,6 +576,9 @@ declare function item(apiItem: ApiItem, opts: RenderItemOptions): string;
  * Walk a package's first entry point and assemble one RenderedDoc per
  * top-level member.
  *
+ * @deprecated Use `prepareWorkItems` + `buildPage` + `renderMarkdown` from
+ * `@tsdoctor/pages`; frontmatter is assembled by the adapter from the
+ * `Page`'s facts and head tags.
  * @public
  */
 declare function docs(apiPackage: ApiPackage, opts: RenderPackageOptions): RenderedDoc[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tsdoctor/model",
-	"version": "0.5.0",
+	"version": "0.6.1",
 	"private": false,
 	"description": "Render Microsoft API Extractor models into LLM-lean markdown. Pure model loading, TSDoc extraction, type-signature formatting, and per-item markdown rendering.",
 	"keywords": [
@@ -40,10 +40,10 @@
 	"dependencies": {
 		"@microsoft/api-extractor-model": "^7.33.11",
 		"@microsoft/tsdoc": "^0.16.0",
-		"@tsdoctor/vfs": "0.1.0"
+		"@tsdoctor/vfs": "0.2.1"
 	},
 	"peerDependencies": {
-		"@effected/markdown": "^0.7.0",
+		"@effected/markdown": "^0.8.0",
 		"@effected/yaml": "^0.12.0",
 		"effect": "4.0.0-rc.109"
 	},