react-lib-tools 0.0.3 → 0.0.5

package/dist/react-lib-tools.d.ts

@@ -1,18 +1,14 @@
 import { AnchorHTMLAttributes } from 'react';
 import { ClassValue } from 'clsx';
-import { ComponentMetadata } from '../types';
 import { ComponentType } from 'react';
 import { CSSProperties } from 'react';
 import { HTMLAttributes } from 'react';
-import { ImperativeHandleMetadata } from '../types';
 import { InputHTMLAttributes } from 'react';
-import { Intent } from '../types';
 import { JSX } from 'react/jsx-runtime';
 import { LazyExoticComponent } from 'react';
 import { MouseEvent as MouseEvent_2 } from 'react';
 import { PropsWithChildren } from 'react';
 import { ReactNode } from 'react';
-import { Section } from '../types';
 
 export declare function AppRoot({ hideVersions, navLinks, packageDescription, packageName, routes }: {
     hideVersions?: boolean | undefined;
@@ -69,7 +65,21 @@ export declare function Code({ className, html }: {
     html: string;
 }): JSX.Element;
 
-export { ComponentMetadata }
+export declare type ComponentMetadata = {
+    description: Section[];
+    filePath: string;
+    name: string;
+    props: {
+        [name: string]: ComponentPropMetadata;
+    };
+};
+
+declare type ComponentPropMetadata = {
+    description: Section[];
+    html: string;
+    name: string;
+    required: boolean;
+};
 
 export declare function ComponentProps({ json, section }: {
     json: ComponentMetadata;
@@ -95,7 +105,18 @@ export declare function ImperativeHandle({ json, section }: {
     section: string;
 }): JSX.Element;
 
-export { ImperativeHandleMetadata }
+export declare type ImperativeHandleMetadata = {
+    description: Section[];
+    filePath: string;
+    name: string;
+    methods: ImperativeHandleMethodMetadata[];
+};
+
+declare type ImperativeHandleMethodMetadata = {
+    description: Section[];
+    html: string;
+    name: string;
+};
 
 export declare function Input<Type extends string>({ children, className, onChange, value, ...rest }: PropsWithChildren<Omit<InputHTMLAttributes<HTMLInputElement>, "onChange"> & {
     className?: string | undefined;
@@ -103,7 +124,7 @@ export declare function Input<Type extends string>({ children, className, onChan
     value: Type;
 }>): JSX.Element;
 
-export { Intent }
+export declare type Intent = "danger" | "none" | "primary" | "success" | "warning";
 
 export declare function Link({ children, onClick, to, ...rest }: Omit<HTMLAttributes<HTMLSpanElement>, "children"> & {
     children?: ReactNode | RenderFunction;
@@ -139,7 +160,10 @@ declare type RenderFunction = (params: {
     isPending: boolean;
 }) => ReactNode;
 
-export { Section }
+export declare type Section = {
+    content: string;
+    intent?: Intent | undefined;
+};
 
 export declare function Select<Value extends string>({ className, defaultValue, onChange, options, placeholder, value }: {
     className?: string;

package/lib/types.ts

@@ -0,0 +1,35 @@
+export type Intent = "danger" | "none" | "primary" | "success" | "warning";
+
+export type Section = {
+  content: string;
+  intent?: Intent | undefined;
+};
+
+export type ComponentPropMetadata = {
+  description: Section[];
+  html: string;
+  name: string;
+  required: boolean;
+};
+
+export type ComponentMetadata = {
+  description: Section[];
+  filePath: string;
+  name: string;
+  props: {
+    [name: string]: ComponentPropMetadata;
+  };
+};
+
+export type ImperativeHandleMethodMetadata = {
+  description: Section[];
+  html: string;
+  name: string;
+};
+
+export type ImperativeHandleMetadata = {
+  description: Section[];
+  filePath: string;
+  name: string;
+  methods: ImperativeHandleMethodMetadata[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-lib-tools",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
   "author": "Brian Vaughn <brian.david.vaughn@gmail.com> (https://github.com/bvaughn/)",
   "contributors": [
@@ -16,6 +16,7 @@
   "types": "dist/react-lib-tools.d.ts",
   "files": [
     "dist",
+    "lib/types.ts",
     "scripts",
     "styles.css"
   ],

package/scripts/compile-docs.ts

@@ -8,7 +8,7 @@ export async function compileDocs({
   imperativeHandleNames,
   outputDirName = "docs"
 }: {
-  compilerOptions: Partial<CompilerOptions>;
+  compilerOptions?: Partial<CompilerOptions>;
   componentNames: string[];
   imperativeHandleNames: string[];
   outputDirName?: string | undefined;

package/scripts/utils/docs/compileComponent.ts

@@ -2,7 +2,7 @@ import { writeFile } from "node:fs/promises";
 import { join, relative } from "node:path";
 import { cwd } from "node:process";
 import { type FileParser, type PropItem } from "react-docgen-typescript";
-import type { ComponentMetadata } from "../../../types.ts";
+import type { ComponentMetadata } from "../../../lib/types.ts";
 import { assert } from "../assert.ts";
 import { syntaxHighlight } from "../syntax-highlight.ts";
 import { getPropTypeText } from "./getPropTypeText.ts";

package/scripts/utils/docs/compileImperativeHandle.ts

@@ -2,7 +2,7 @@ import type { InterfaceNode } from "@ts-ast-parser/core";
 import assert from "node:assert";
 import { writeFile } from "node:fs/promises";
 import { join } from "path";
-import type { ImperativeHandleMetadata } from "../../../types.ts";
+import type { ImperativeHandleMetadata } from "../../../lib/types.ts";
 import { syntaxHighlight } from "../syntax-highlight.ts";
 import { parseDescription } from "./parseDescription.ts";
 

package/scripts/utils/docs/parseDescription.ts

@@ -1,4 +1,4 @@
-import type { Intent, Section } from "../../../types.ts";
+import type { Intent, Section } from "../../../lib/types.ts";
 import { syntaxHighlight, type Language } from "../syntax-highlight.ts";
 import { formatDescriptionText } from "./formatDescriptionText.ts";