@powerlines/plugin-alloy 0.15.2 → 0.15.4

package/dist/typescript/components/tsdoc.cjs

@@ -1,24 +1,476 @@
-require('../../utilities-llRqOC4l.cjs');
-require('../../context-BIduC1bB.cjs');
-const require_tsdoc = require('../../tsdoc-B0TNs3dK.cjs');
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_core_contexts_context = require('../../core/contexts/context.cjs');
+let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let __alloy_js_core = require("@alloy-js/core");
+let __powerlines_deepkit_utilities = require("@powerlines/deepkit/utilities");
+let __stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
+let __stryke_type_checks_is_undefined = require("@stryke/type-checks/is-undefined");
 
-exports.TSDoc = require_tsdoc.TSDoc;
-exports.TSDocAlias = require_tsdoc.TSDocAlias;
-exports.TSDocAttributesTags = require_tsdoc.TSDocAttributesTags;
-exports.TSDocDefaultValue = require_tsdoc.TSDocDefaultValue;
-exports.TSDocDomain = require_tsdoc.TSDocDomain;
-exports.TSDocExample = require_tsdoc.TSDocExample;
-exports.TSDocHidden = require_tsdoc.TSDocHidden;
-exports.TSDocIgnore = require_tsdoc.TSDocIgnore;
-exports.TSDocInternal = require_tsdoc.TSDocInternal;
-exports.TSDocLink = require_tsdoc.TSDocLink;
-exports.TSDocModule = require_tsdoc.TSDocModule;
-exports.TSDocParam = require_tsdoc.TSDocParam;
-exports.TSDocParams = require_tsdoc.TSDocParams;
-exports.TSDocPermission = require_tsdoc.TSDocPermission;
-exports.TSDocReadonly = require_tsdoc.TSDocReadonly;
-exports.TSDocRemarks = require_tsdoc.TSDocRemarks;
-exports.TSDocReturns = require_tsdoc.TSDocReturns;
-exports.TSDocTag = require_tsdoc.TSDocTag;
-exports.TSDocThrows = require_tsdoc.TSDocThrows;
-exports.TSDocTitle = require_tsdoc.TSDocTitle;
+//#region src/typescript/components/tsdoc.tsx
+/**
+* Generates a TypeScript interface for the given reflection class.
+*/
+function TSDoc(props) {
+	const [{ children, heading }] = (0, __alloy_js_core.splitProps)(props, ["children", "heading"]);
+	return [
+		"/**",
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
+			string: " * ",
+			get children() {
+				return [
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+						get when() {
+							return !(0, __stryke_type_checks_is_undefined.isUndefined)(heading);
+						},
+						get children() {
+							return [
+								heading,
+								(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+								(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+									get when() {
+										return (0, __alloy_js_core_jsx_runtime.memo)(() => !!!(0, __stryke_type_checks_is_undefined.isUndefined)(children))() && (0, __alloy_js_core.childrenArray)(() => children).length > 0;
+									},
+									get children() {
+										return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {});
+									}
+								})
+							];
+						}
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+						get when() {
+							return (0, __alloy_js_core_jsx_runtime.memo)(() => !!!(0, __stryke_type_checks_is_undefined.isUndefined)(children))() && (0, __alloy_js_core.childrenArray)(() => children).length > 0;
+						},
+						get children() {
+							return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.List, { get children() {
+								return (0, __alloy_js_core.childrenArray)(() => children);
+							} });
+						}
+					})
+				];
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		` */`,
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+	];
+}
+/**
+* Create a TSDoc `@<props.tag>` tag.
+*/
+function TSDocTag(props) {
+	const [{ children, tag }] = (0, __alloy_js_core.splitProps)(props, ["children", "tag"]);
+	return [
+		`@${tag} `,
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return Boolean(children);
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
+					width: 2,
+					get children() {
+						return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Prose, { children });
+					}
+				});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+	];
+}
+/**
+* A component that creates a TSDoc block with `@param` tags for each parameter.
+*/
+function TSDocParams(props) {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
+		each: normalizeParametersForDoc(props.parameters),
+		children: (param) => (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocParam, {
+			get name() {
+				return param.name;
+			},
+			get optional() {
+				return param.optional;
+			},
+			get children() {
+				return param.doc;
+			}
+		})
+	});
+}
+function normalizeParametersForDoc(parameters) {
+	if (parameters.some((p) => typeof p === "string")) return [];
+	return parameters;
+}
+/**
+* Create a TSDoc `@title` tag.
+*/
+function TSDocTitle(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
+		tag: "title",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@domain` tag.
+*/
+function TSDocDomain(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
+		tag: "domain",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@alias` tag.
+*/
+function TSDocAlias(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
+		tag: "alias",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@permission` tag.
+*/
+function TSDocPermission(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
+		tag: "permission",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@defaultValue` tag.
+*/
+function TSDocDefaultValue(props) {
+	return [
+		"@defaultValue ",
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return !(0, __stryke_type_checks_is_undefined.isUndefined)(props.value);
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
+					width: 2,
+					get children() {
+						return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Prose, { get children() {
+							return (0, __powerlines_deepkit_utilities.stringifyDefaultValue)(props.value);
+						} });
+					}
+				});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+	];
+}
+/**
+* Create a TSDoc `@remarks` tag.
+*/
+function TSDocRemarks(props) {
+	return [
+		"@remarks ",
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.List, {
+			hardline: true,
+			get children() {
+				return (0, __alloy_js_core.childrenArray)(() => props.children);
+			}
+		})
+	];
+}
+/**
+* Create a TSDoc `@see` tag.
+*/
+function TSDocLink(props) {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { tag: "see" }));
+}
+/**
+* Create a TSDoc `@example` tag.
+*/
+function TSDocExample(props) {
+	const [{ tsx, fenced = true, language, children }] = (0, __alloy_js_core.splitProps)(props, [
+		"tsx",
+		"fenced",
+		"language",
+		"children"
+	]);
+	return [
+		"@example ",
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			when: fenced,
+			get children() {
+				return [
+					"```",
+					language || (tsx ? "tsx" : "ts"),
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+				];
+			}
+		}),
+		children,
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			when: fenced,
+			get children() {
+				return [(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}), "```"];
+			}
+		})
+	];
+}
+/**
+* Create a TSDoc `@readonly` tag.
+*/
+function TSDocReadonly() {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "readonly" });
+}
+/**
+* Create a TSDoc `@internal` tag.
+*/
+function TSDocInternal() {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "internal" });
+}
+/**
+* Create a TSDoc `@ignore` tag.
+*/
+function TSDocIgnore() {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "ignore" });
+}
+/**
+* Create a TSDoc `@hidden` tag.
+*/
+function TSDocHidden() {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, { tag: "hidden" });
+}
+/**
+* Generates a TypeScript interface property for the given reflection class.
+*/
+function TSDocAttributesTags(props) {
+	const [{ title, alias, permission, domain, readonly, internal, ignore, hidden, defaultValue }] = (0, __alloy_js_core.splitProps)(props, [
+		"title",
+		"alias",
+		"permission",
+		"domain",
+		"readonly",
+		"internal",
+		"ignore",
+		"hidden",
+		"defaultValue"
+	]);
+	return [
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return (0, __stryke_type_checks_is_set_string.isSetString)(title);
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTitle, { children: title });
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return !(0, __stryke_type_checks_is_undefined.isUndefined)(alias) && alias.length > 0;
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
+					each: alias ?? [],
+					children: (alias$1) => (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocAlias, { children: alias$1 })
+				});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return (0, __stryke_type_checks_is_set_string.isSetString)(domain);
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocDomain, { children: domain });
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return !(0, __stryke_type_checks_is_undefined.isUndefined)(permission) && permission.length > 0;
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
+					each: permission ?? [],
+					children: (permission$1) => (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocPermission, { children: permission$1 })
+				});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			when: readonly === true,
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocReadonly, {});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			when: internal === true,
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocInternal, {});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			when: ignore === true,
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocIgnore, {});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			when: hidden === true,
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocHidden, {});
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return !(0, __stryke_type_checks_is_undefined.isUndefined)(defaultValue);
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocDefaultValue, { value: defaultValue });
+			}
+		})
+	];
+}
+/**
+* Create a TSDoc parameter set off with `@param`.
+*/
+function TSDocParam(props) {
+	return [
+		"@param ",
+		(0, __alloy_js_core_jsx_runtime.createComponent)(TSDocParamName, {
+			get name() {
+				return props.name;
+			},
+			get optional() {
+				return props.optional;
+			},
+			get defaultValue() {
+				return props.defaultValue;
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(TSDocParamDescription, { get children() {
+			return props.children;
+		} })
+	];
+}
+function TSDocParamName(props) {
+	return [
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return props.optional;
+			},
+			children: "["
+		}),
+		(0, __alloy_js_core_jsx_runtime.memo)(() => props.name),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return Boolean(props.defaultValue);
+			},
+			get children() {
+				return ["=", (0, __alloy_js_core_jsx_runtime.memo)(() => props.defaultValue)];
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return props.optional;
+			},
+			children: "]"
+		})
+	];
+}
+function TSDocParamDescription(props) {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+		get when() {
+			return Boolean(props.children);
+		},
+		get children() {
+			return [" - ", (0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
+				width: 2,
+				get children() {
+					return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Prose, { get children() {
+						return props.children;
+					} });
+				}
+			})];
+		}
+	});
+}
+/**
+* Create a TSDoc `@returns` tag.
+*/
+function TSDocReturns(props) {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { tag: "returns" }));
+}
+/**
+* Create a TSDoc `@throws` tag.
+*/
+function TSDocThrows(props) {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocTag, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { tag: "throws" }));
+}
+/**
+* Generates a TSDoc `@module` tag for the given module name.
+*/
+function TSDocModule(props) {
+	const [{ children, name, prefix }] = (0, __alloy_js_core.splitProps)(props, [
+		"children",
+		"name",
+		"prefix"
+	]);
+	const context = require_core_contexts_context.usePowerlines();
+	return [
+		"/**",
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
+			string: " * ",
+			get children() {
+				return [
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+						get when() {
+							return Boolean(children);
+						},
+						get children() {
+							return [
+								(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.List, {
+									hardline: true,
+									get children() {
+										return (0, __alloy_js_core.childrenArray)(() => children);
+									}
+								}),
+								(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+								(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+							];
+						}
+					}),
+					"@module ",
+					(0, __alloy_js_core_jsx_runtime.memo)(() => prefix || context?.config.output.builtinPrefix),
+					":",
+					name
+				];
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		` */`
+	];
+}
+
+//#endregion
+exports.TSDoc = TSDoc;
+exports.TSDocAlias = TSDocAlias;
+exports.TSDocAttributesTags = TSDocAttributesTags;
+exports.TSDocDefaultValue = TSDocDefaultValue;
+exports.TSDocDomain = TSDocDomain;
+exports.TSDocExample = TSDocExample;
+exports.TSDocHidden = TSDocHidden;
+exports.TSDocIgnore = TSDocIgnore;
+exports.TSDocInternal = TSDocInternal;
+exports.TSDocLink = TSDocLink;
+exports.TSDocModule = TSDocModule;
+exports.TSDocParam = TSDocParam;
+exports.TSDocParams = TSDocParams;
+exports.TSDocPermission = TSDocPermission;
+exports.TSDocReadonly = TSDocReadonly;
+exports.TSDocRemarks = TSDocRemarks;
+exports.TSDocReturns = TSDocReturns;
+exports.TSDocTag = TSDocTag;
+exports.TSDocThrows = TSDocThrows;
+exports.TSDocTitle = TSDocTitle;

package/dist/typescript/components/tsdoc.d.cts

@@ -1,4 +1,152 @@
-import "../../context-BsDdxy5g.cjs";
-import "../../components-C8Qs2PB0.cjs";
-import { A as __ΩTSDocDefaultValueProps, C as TSDocRemarks, D as TSDocThrows, E as TSDocTagProps, F as __ΩTSDocProps, I as __ΩTSDocTagProps, M as __ΩTSDocModuleProps, N as __ΩTSDocParamProps, O as TSDocTitle, P as __ΩTSDocParamsProps, S as TSDocReadonly, T as TSDocTag, _ as TSDocParamProps, a as TSDocDefaultValue, b as TSDocPermission, c as TSDocExample, d as TSDocIgnore, f as TSDocInternal, g as TSDocParam, h as TSDocModuleProps, i as TSDocAttributesTagsProps, j as __ΩTSDocExampleProps, k as __ΩTSDocAttributesTagsProps, l as TSDocExampleProps, m as TSDocModule, n as TSDocAlias, o as TSDocDefaultValueProps, p as TSDocLink, r as TSDocAttributesTags, s as TSDocDomain, t as TSDoc, u as TSDocHidden, v as TSDocParams, w as TSDocReturns, x as TSDocProps, y as TSDocParamsProps } from "../../tsdoc-CK6J_ap5.cjs";
+import { ComponentProps } from "../../types/components.cjs";
+import { Children } from "@alloy-js/core";
+import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
+
+//#region src/typescript/components/tsdoc.d.ts
+interface TSDocProps extends ComponentProps {
+  heading?: Children;
+}
+/**
+ * Generates a TypeScript interface for the given reflection class.
+ */
+declare function TSDoc(props: TSDocProps): Children;
+interface TSDocTagProps extends ComponentProps {
+  tag: string;
+}
+/**
+ * Create a TSDoc `@<props.tag>` tag.
+ */
+declare function TSDocTag(props: TSDocTagProps): Children;
+interface TSDocParamsProps {
+  parameters: ParameterDescriptor[] | string[];
+}
+/**
+ * A component that creates a TSDoc block with `@param` tags for each parameter.
+ */
+declare function TSDocParams(props: TSDocParamsProps): Children;
+/**
+ * Create a TSDoc `@title` tag.
+ */
+declare function TSDocTitle(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@domain` tag.
+ */
+declare function TSDocDomain(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@alias` tag.
+ */
+declare function TSDocAlias(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@permission` tag.
+ */
+declare function TSDocPermission(props: ComponentProps): Children;
+interface TSDocDefaultValueProps extends ComponentProps {
+  value: any;
+}
+/**
+ * Create a TSDoc `@defaultValue` tag.
+ */
+declare function TSDocDefaultValue(props: TSDocDefaultValueProps): Children;
+/**
+ * Create a TSDoc `@remarks` tag.
+ */
+declare function TSDocRemarks(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@see` tag.
+ */
+declare function TSDocLink(props: ComponentProps): Children;
+interface TSDocExampleProps extends JSDocExampleProps {
+  /**
+   * Whether the file is a TSX file.
+   *
+   * @defaultValue false
+   */
+  tsx?: boolean;
+}
+/**
+ * Create a TSDoc `@example` tag.
+ */
+declare function TSDocExample(props: TSDocExampleProps): Children;
+/**
+ * Create a TSDoc `@readonly` tag.
+ */
+declare function TSDocReadonly(): Children;
+/**
+ * Create a TSDoc `@internal` tag.
+ */
+declare function TSDocInternal(): Children;
+/**
+ * Create a TSDoc `@ignore` tag.
+ */
+declare function TSDocIgnore(): Children;
+/**
+ * Create a TSDoc `@hidden` tag.
+ */
+declare function TSDocHidden(): Children;
+interface TSDocAttributesTagsProps {
+  title?: string;
+  alias?: string[];
+  permission?: string[];
+  domain?: string;
+  readonly?: boolean;
+  internal?: boolean;
+  ignore?: boolean;
+  hidden?: boolean;
+  defaultValue?: any;
+}
+/**
+ * Generates a TypeScript interface property for the given reflection class.
+ */
+declare function TSDocAttributesTags(props: TSDocAttributesTagsProps): Children;
+interface TSDocParamProps {
+  name: Children;
+  children?: Children;
+  optional?: boolean;
+  defaultValue?: Children;
+}
+/**
+ * Create a TSDoc parameter set off with `@param`.
+ */
+declare function TSDocParam(props: TSDocParamProps): Children;
+/**
+ * Create a TSDoc `@returns` tag.
+ */
+declare function TSDocReturns(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@throws` tag.
+ */
+declare function TSDocThrows(props: ComponentProps): Children;
+interface TSDocModuleProps extends ComponentProps {
+  /**
+   * the prefix for the builtin module name
+   *
+   * @defaultValue "storm"
+   */
+  prefix?: string;
+  /**
+   * The name of the module
+   *
+   * @remarks
+   * This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.
+   *
+   * @example
+   * ```ts
+   * import { MyModule } from "storm:my-module";
+   * ```
+   */
+  name: Children;
+}
+/**
+ * Generates a TSDoc `@module` tag for the given module name.
+ */
+declare function TSDocModule(props: TSDocModuleProps): Children;
+declare type __ΩTSDocProps = any[];
+declare type __ΩTSDocTagProps = any[];
+declare type __ΩTSDocParamsProps = any[];
+declare type __ΩTSDocDefaultValueProps = any[];
+declare type __ΩTSDocExampleProps = any[];
+declare type __ΩTSDocAttributesTagsProps = any[];
+declare type __ΩTSDocParamProps = any[];
+declare type __ΩTSDocModuleProps = any[];
+//#endregion
 export { TSDoc, TSDocAlias, TSDocAttributesTags, TSDocAttributesTagsProps, TSDocDefaultValue, TSDocDefaultValueProps, TSDocDomain, TSDocExample, TSDocExampleProps, TSDocHidden, TSDocIgnore, TSDocInternal, TSDocLink, TSDocModule, TSDocModuleProps, TSDocParam, TSDocParamProps, TSDocParams, TSDocParamsProps, TSDocPermission, TSDocProps, TSDocReadonly, TSDocRemarks, TSDocReturns, TSDocTag, TSDocTagProps, TSDocThrows, TSDocTitle, __ΩTSDocAttributesTagsProps, __ΩTSDocDefaultValueProps, __ΩTSDocExampleProps, __ΩTSDocModuleProps, __ΩTSDocParamProps, __ΩTSDocParamsProps, __ΩTSDocProps, __ΩTSDocTagProps };