fumadocs-core 8.0.0 → 8.1.1

package/dist/mdx-plugins/index.d.ts

@@ -1,12 +1,12 @@
 export { Options as RemarkGfmOptions, default as remarkGfm } from 'remark-gfm';
 import { Root } from 'hast';
-import { RehypeShikijiOptions } from 'rehype-shikiji';
+import { RehypeShikiOptions } from '@shikijs/rehype';
 import { Processor, Transformer } from 'unified';
 import { Root as Root$1 } from 'mdast';
 export { S as StructuredData, r as remarkStructure, s as structure } from '../remark-structure-RwYPDA6M.js';
 
 declare const rehypeCodeDefaultOptions: RehypeCodeOptions;
-type RehypeCodeOptions = RehypeShikijiOptions & {
+type RehypeCodeOptions = RehypeShikiOptions & {
     /**
      * Filter meta string before processing
      */

package/dist/mdx-plugins/index.js

@@ -17,11 +17,11 @@ import {
 } from "remark-gfm";
 
 // src/mdx-plugins/rehype-code.ts
-import rehypeShikiji from "rehype-shikiji";
+import rehypeShiki from "@shikijs/rehype";
 import {
   transformerNotationHighlight,
   transformerNotationWordHighlight
-} from "shikiji-transformers";
+} from "@shikijs/transformers";
 
 // src/mdx-plugins/hast-utils.ts
 function visit2(node, tagNames, handler) {
@@ -94,7 +94,7 @@ function rehypeCode(options = {}) {
     ...codeOptions.transformers
   ];
   const prefix = "language-";
-  const transformer = rehypeShikiji.call(this, codeOptions);
+  const transformer = rehypeShiki.call(this, codeOptions);
   return (root, vfile) => __async(this, null, function* () {
     visit2(root, ["pre"], (element) => {
       var _a;

package/dist/server/index.d.ts

@@ -30,7 +30,7 @@ declare function separatePageTree(pageTree: Root): Root[];
 
 interface GetGithubLastCommitOptions {
     /**
-     * Repository name, like "next-docs"
+     * Repository name, like "fumadocs"
      */
     repo: string;
     /** Owner of repository */

package/dist/typescript.d.ts

@@ -0,0 +1,37 @@
+import * as ts from 'typescript';
+
+interface DocEntry {
+    name: string;
+    description: string;
+    type: string;
+    default?: string;
+}
+interface Context {
+    program: ts.Program;
+    checker: ts.TypeChecker;
+    options: Options;
+}
+interface EntryContext extends Context {
+    type: ts.Type;
+    symbol: ts.Symbol;
+}
+interface Options {
+    file: string;
+    name: string;
+    /**
+     * Modify output property entry
+     */
+    transform?: (this: EntryContext, entry: DocEntry, propertyType: ts.Type, propertySymbol: ts.Symbol) => void;
+    options?: Partial<{
+        files: string[];
+        tsconfigPath: string;
+        /** A root directory to resolve relative path entries in the config file to. e.g. outDir */
+        basePath: string;
+    }>;
+}
+/**
+ * Generate documentation for properties in an exported type/interface
+ */
+declare function generateDocumentation(options: Options): DocEntry[];
+
+export { type DocEntry, type Options, generateDocumentation };

package/dist/typescript.js

@@ -0,0 +1,90 @@
+import {
+  __spreadProps,
+  __spreadValues
+} from "./chunk-WEAGW6MQ.js";
+
+// src/typescript.ts
+import * as ts from "typescript";
+var cache = /* @__PURE__ */ new Map();
+function getProgram(options = {}) {
+  var _a, _b, _c;
+  const key = JSON.stringify(options);
+  const cached = cache.get(key);
+  if (cached)
+    return cached;
+  const configFile = ts.readJsonConfigFile(
+    (_a = options.tsconfigPath) != null ? _a : "./tsconfig.json",
+    (path) => ts.sys.readFile(path)
+  );
+  const parsed = ts.parseJsonSourceFileConfigFileContent(
+    configFile,
+    ts.sys,
+    (_b = options.basePath) != null ? _b : "./"
+  );
+  const program = ts.createProgram({
+    rootNames: (_c = options.files) != null ? _c : parsed.fileNames,
+    options: __spreadProps(__spreadValues({}, parsed.options), {
+      incremental: false
+    })
+  });
+  cache.set(key, program);
+  return program;
+}
+function getExportedSymbol({
+  options: { file, name },
+  checker,
+  program
+}) {
+  const sourceFile = program.getSourceFile(file);
+  if (!sourceFile)
+    return;
+  const fileSymbol = checker.getSymbolAtLocation(sourceFile);
+  if (!fileSymbol)
+    return;
+  const exports = checker.getExportsOfModule(fileSymbol);
+  return exports.find((e) => e.getEscapedName().toString() === name);
+}
+function generateDocumentation(options) {
+  const program = getProgram(options.options);
+  const checker = program.getTypeChecker();
+  const ctx = {
+    checker,
+    program,
+    options
+  };
+  const symbol = getExportedSymbol(ctx);
+  if (!symbol)
+    return [];
+  const type = checker.getDeclaredTypeOfSymbol(symbol);
+  const entryContext = __spreadProps(__spreadValues({}, ctx), {
+    type,
+    symbol
+  });
+  return type.getProperties().map(getDocEntry.bind(entryContext));
+}
+function getDocEntry(prop) {
+  var _a;
+  const subType = this.checker.getTypeOfSymbol(prop);
+  const defaultJsDocTag = prop.getJsDocTags().find((info) => ["default", "defaultValue"].includes(info.name));
+  let typeName = this.checker.typeToString(
+    subType.getNonNullableType(),
+    void 0,
+    ts.TypeFormatFlags.UseAliasDefinedOutsideCurrentScope
+  );
+  if (subType.aliasSymbol && !subType.aliasTypeArguments) {
+    typeName = subType.aliasSymbol.escapedName.toString();
+  }
+  const entry = {
+    name: prop.getName(),
+    description: ts.displayPartsToString(
+      prop.getDocumentationComment(this.checker)
+    ),
+    default: (defaultJsDocTag == null ? void 0 : defaultJsDocTag.text) ? ts.displayPartsToString(defaultJsDocTag.text) : void 0,
+    type: typeName
+  };
+  (_a = this.options.transform) == null ? void 0 : _a.call(this, entry, subType, prop);
+  return entry;
+}
+export {
+  generateDocumentation
+};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "fumadocs-core",
-  "version": "8.0.0",
+  "version": "8.1.1",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
     "Docs"
   ],
   "homepage": "https://fumadocs.vercel.app",
-  "repository": "github:fuma-nama/next-docs",
+  "repository": "github:fuma-nama/fumadocs",
   "license": "MIT",
   "author": "Fuma Nama",
   "type": "module",
@@ -44,6 +44,10 @@
       "import": "./dist/link.js",
       "types": "./dist/link.d.ts"
     },
+    "./typescript": {
+      "import": "./dist/typescript.js",
+      "types": "./dist/typescript.d.ts"
+    },
     "./middleware": {
       "import": "./dist/middleware.js",
       "types": "./dist/middleware.d.ts"
@@ -72,6 +76,9 @@
       "toc": [
         "./dist/toc.d.ts"
       ],
+      "typescript": [
+        "./dist/typescript.d.ts"
+      ],
       "search/client": [
         "./dist/search/client.d.ts"
       ],
@@ -109,17 +116,17 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.0",
+    "@shikijs/rehype": "^1.0.0-beta.0",
+    "@shikijs/transformers": "^1.0.0-beta.0",
     "flexsearch": "0.7.21",
     "github-slugger": "^2.0.0",
     "negotiator": "^0.6.3",
     "react-remove-scroll": "^2.5.6",
-    "rehype-shikiji": "^0.10.0",
     "remark": "^15.0.0",
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.0.0",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shikiji": "^0.10.0",
-    "shikiji-transformers": "^0.10.0",
+    "shiki": "^1.0.0-beta.0",
     "swr": "^2.2.2",
     "unist-util-visit": "^5.0.0"
   },
@@ -152,7 +159,6 @@
     "clean": "rimraf dist",
     "dev": "tsup --watch",
     "lint": "eslint .",
-    "test": "vitest",
     "types:check": "tsc --noEmit"
   }
 }