fix: export missing TS types

mdx-editor · May 19, 2024 · 1e30685 · 1e30685
1 parent 1bab51b
commit 1e30685
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 13 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -115,3 +115,5 @@ export * from './utils/uuid4'
 export * from './utils/voidEmitter'
 
 export * from './RealmWithPlugins'
+
+export * from './FormatConstants'
diff --git a/src/plugins/image/index.ts b/src/plugins/image/index.ts
@@ -53,10 +53,17 @@ interface BaseImageParameters {
   title?: string
 }
 
-interface FileImageParameters extends BaseImageParameters {
+/**
+ * @group Image
+ */
+export interface FileImageParameters extends BaseImageParameters {
   file: File
 }
-interface SrcImageParameters extends BaseImageParameters {
+
+/**
+ * @group Image
+ */
+export interface SrcImageParameters extends BaseImageParameters {
   src: string
 }
 /**

diff --git a/src/plugins/jsx/index.ts b/src/plugins/jsx/index.ts
@@ -107,7 +107,10 @@ export function isMdastJsxNode(node: Mdast.Nodes): node is MdastJsx {
   return node.type === 'mdxJsxFlowElement' || node.type === 'mdxJsxTextElement'
 }
 
-interface ExpressionValue {
+/**
+ * @group JSX
+ */
+export interface ExpressionValue {
   type: 'expression'
   value: string
 }
@@ -120,7 +123,7 @@ const isExpressionValue = (value: string | ExpressionValue | null): value is Exp
   return false
 }
 
-type JsxProperties = Record<string, string | ExpressionValue>
+export type JsxProperties = Record<string, string | ExpressionValue>
 
 const toMdastJsxAttributes = (attributes: JsxProperties) =>
   Object.entries(attributes).map(
@@ -179,7 +182,10 @@ export const insertJsx$ = Signal<
   )
 })
 
-interface JsxPluginParams {
+/**
+ * @group JSX
+ */
+export interface JsxPluginParams {
   /**
    * A set of descriptors that document the JSX elements used in the document.
    */

diff --git a/src/plugins/toolbar/primitives/toolbar.tsx b/src/plugins/toolbar/primitives/toolbar.tsx
@@ -149,7 +149,7 @@ export const SingleChoiceToggleGroup = <T extends string>({
     contents: React.ReactNode
   }[]
   onChange: (value: T | '') => void
-  value: T
+  value: T | ''
   className?: string
 }) => {
   return (

diff --git a/typedoc.json b/typedoc.json
@@ -1,12 +1,8 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": [
-    "./src/index.ts",
-  ],
+  "entryPoints": ["./src/index.ts"],
   "out": "docs/api",
-  "plugin": [
-    "typedoc-plugin-markdown"
-  ],
+  "plugin": ["typedoc-plugin-markdown"],
   "watch": false,
   "excludeExternals": true,
   "excludePrivate": true,
@@ -15,6 +11,9 @@
   "categorizeByGroup": true,
   "disableSources": true,
   "cleanOutputDir": true,
+  "hidePageHeader": true,
+  "propertiesFormat": "table",
+  "parametersFormat": "table",
   "navigation": {
     "includeGroups": true,
     "includeCategories": true
@@ -24,7 +23,6 @@
     "invalidLink": true,
     "notDocumented": false
   },
-  "allReflectionsHaveOwnDocument": true,
   "hideBreadcrumbs": true,
   "groupOrder": [
     "MDXEditor",