@powerlines/plugin-env 0.15.121 → 0.15.122

package/dist/plugin-alloy/src/typescript/components/tsdoc.cjs

@@ -0,0 +1,451 @@
+const require_rolldown_runtime = require('../../../../_virtual/rolldown_runtime.cjs');
+const require_context = require('../../core/contexts/context.cjs');
+const require_utilities = require('../../../../deepkit/src/utilities.cjs');
+let __stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
+let __alloy_js_core = require("@alloy-js/core");
+let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let __stryke_type_checks_is_undefined = require("@stryke/type-checks/is-undefined");
+
+//#region ../plugin-alloy/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", {})
+	];
+}
+/**
+* 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) {
+	const [{ type, defaultValue }] = (0, __alloy_js_core.splitProps)(props, ["type", "defaultValue"]);
+	return [
+		"@defaultValue ",
+		(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.createIntrinsic)("align", {
+					width: 2,
+					get children() {
+						return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Prose, { get children() {
+							return require_utilities.stringifyDefaultValue(type, defaultValue);
+						} });
+					}
+				});
+			}
+		}),
+		(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 [{ type, title, alias, permission, domain, readonly, internal, ignore, hidden, defaultValue }] = (0, __alloy_js_core.splitProps)(props, [
+		"type",
+		"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?.trim());
+			},
+			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, __alloy_js_core_jsx_runtime.memo)(() => !!(!(0, __stryke_type_checks_is_undefined.isUndefined)(alias) && alias.length > 0))() && alias.some((a) => (0, __stryke_type_checks_is_set_string.isSetString)(a?.trim()));
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
+					get each() {
+						return alias?.filter((a) => (0, __stryke_type_checks_is_set_string.isSetString)(a?.trim())) ?? [];
+					},
+					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?.trim());
+			},
+			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, __alloy_js_core_jsx_runtime.memo)(() => !!(!(0, __stryke_type_checks_is_undefined.isUndefined)(permission) && permission.length > 0))() && permission.some((p) => (0, __stryke_type_checks_is_set_string.isSetString)(p?.trim()));
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
+					get each() {
+						return permission?.filter((p) => (0, __stryke_type_checks_is_set_string.isSetString)(p?.trim())) ?? [];
+					},
+					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, __alloy_js_core_jsx_runtime.memo)(() => !!!(0, __stryke_type_checks_is_undefined.isUndefined)(type))() && !(0, __stryke_type_checks_is_undefined.isUndefined)(defaultValue);
+			},
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocDefaultValue, {
+					type,
+					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_context.usePowerlinesSafe();
+	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?.framework || "powerlines"),
+					":",
+					name
+				];
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		` */`
+	];
+}
+
+//#endregion
+exports.TSDoc = TSDoc;
+exports.TSDocAttributesTags = TSDocAttributesTags;
+exports.TSDocExample = TSDocExample;
+exports.TSDocLink = TSDocLink;
+exports.TSDocModule = TSDocModule;
+exports.TSDocParam = TSDocParam;
+exports.TSDocRemarks = TSDocRemarks;
+exports.TSDocReturns = TSDocReturns;
+exports.TSDocThrows = TSDocThrows;

package/dist/{packages/plugin-alloy → plugin-alloy}/src/typescript/components/tsdoc.d.mts

@@ -1,5 +1,5 @@
 import { ComponentProps } from "../../types/components.mjs";
-import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { ReflectionKind, ReflectionParameter, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
 import { Children } from "@alloy-js/core";
 import "@alloy-js/typescript";