@powerlines/plugin-date 0.12.258 → 0.12.260

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

@@ -0,0 +1,364 @@
+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 __alloy_js_core = require("@alloy-js/core");
+let __stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
+let react_jsx_runtime = require("react/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 /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		"/**",
+		/* @__PURE__ */ (0, react_jsx_runtime.jsxs)("align", {
+			string: " * ",
+			children: [
+				/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
+				/* @__PURE__ */ (0, react_jsx_runtime.jsxs)(__alloy_js_core.Show, {
+					when: !(0, __stryke_type_checks_is_undefined.isUndefined)(heading),
+					children: [
+						heading,
+						/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
+						/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+							when: !(0, __stryke_type_checks_is_undefined.isUndefined)(children) && (0, __alloy_js_core.childrenArray)(() => children).length > 0,
+							children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {})
+						})
+					]
+				}),
+				/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+					when: !(0, __stryke_type_checks_is_undefined.isUndefined)(children) && (0, __alloy_js_core.childrenArray)(() => children).length > 0,
+					children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.List, { children: (0, __alloy_js_core.childrenArray)(() => children) })
+				})
+			]
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
+		` */`,
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {})
+	] });
+}
+/**
+* Create a TSDoc `@<props.tag>` tag.
+*/
+function TSDocTag(props) {
+	const [{ children, tag }] = (0, __alloy_js_core.splitProps)(props, ["children", "tag"]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		`@${tag} `,
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: Boolean(children),
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)("align", {
+				width: 2,
+				children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Prose, { children })
+			})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {})
+	] });
+}
+/**
+* Create a TSDoc `@title` tag.
+*/
+function TSDocTitle(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, {
+		...rest,
+		tag: "title",
+		children
+	});
+}
+/**
+* Create a TSDoc `@domain` tag.
+*/
+function TSDocDomain(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, {
+		...rest,
+		tag: "domain",
+		children
+	});
+}
+/**
+* Create a TSDoc `@alias` tag.
+*/
+function TSDocAlias(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, {
+		...rest,
+		tag: "alias",
+		children
+	});
+}
+/**
+* Create a TSDoc `@permission` tag.
+*/
+function TSDocPermission(props) {
+	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, {
+		...rest,
+		tag: "permission",
+		children
+	});
+}
+/**
+* Create a TSDoc `@defaultValue` tag.
+*/
+function TSDocDefaultValue(props) {
+	const [{ type, defaultValue }] = (0, __alloy_js_core.splitProps)(props, ["type", "defaultValue"]);
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		"@defaultValue ",
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: !(0, __stryke_type_checks_is_undefined.isUndefined)(defaultValue),
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)("align", {
+				width: 2,
+				children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Prose, { children: require_utilities.stringifyDefaultValue(type, defaultValue) })
+			})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {})
+	] });
+}
+/**
+* Create a TSDoc `@remarks` tag.
+*/
+function TSDocRemarks(props) {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		"@remarks ",
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.List, {
+			hardline: true,
+			children: (0, __alloy_js_core.childrenArray)(() => props.children)
+		})
+	] });
+}
+/**
+* Create a TSDoc `@see` tag.
+*/
+function TSDocLink(props) {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, {
+		...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 /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		"@example ",
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsxs)(__alloy_js_core.Show, {
+			when: fenced,
+			children: [
+				"```",
+				language || (tsx ? "tsx" : "ts"),
+				/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {})
+			]
+		}),
+		children,
+		/* @__PURE__ */ (0, react_jsx_runtime.jsxs)(__alloy_js_core.Show, {
+			when: fenced,
+			children: [/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}), "```"]
+		})
+	] });
+}
+/**
+* Create a TSDoc `@readonly` tag.
+*/
+function TSDocReadonly() {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, { tag: "readonly" });
+}
+/**
+* Create a TSDoc `@internal` tag.
+*/
+function TSDocInternal() {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, { tag: "internal" });
+}
+/**
+* Create a TSDoc `@ignore` tag.
+*/
+function TSDocIgnore() {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, { tag: "ignore" });
+}
+/**
+* Create a TSDoc `@hidden` tag.
+*/
+function TSDocHidden() {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(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 /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: (0, __stryke_type_checks_is_set_string.isSetString)(title?.trim()),
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTitle, { children: title })
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: !(0, __stryke_type_checks_is_undefined.isUndefined)(alias) && alias.length > 0 && alias.some((a) => (0, __stryke_type_checks_is_set_string.isSetString)(a?.trim())),
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.For, {
+				each: alias?.filter((a) => (0, __stryke_type_checks_is_set_string.isSetString)(a?.trim())) ?? [],
+				children: (alias$1) => /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocAlias, { children: alias$1 })
+			})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: (0, __stryke_type_checks_is_set_string.isSetString)(domain?.trim()),
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocDomain, { children: domain })
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: !(0, __stryke_type_checks_is_undefined.isUndefined)(permission) && permission.length > 0 && permission.some((p) => (0, __stryke_type_checks_is_set_string.isSetString)(p?.trim())),
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.For, {
+				each: permission?.filter((p) => (0, __stryke_type_checks_is_set_string.isSetString)(p?.trim())) ?? [],
+				children: (permission$1) => /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocPermission, { children: permission$1 })
+			})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: readonly === true,
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocReadonly, {})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: internal === true,
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocInternal, {})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: ignore === true,
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocIgnore, {})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: hidden === true,
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocHidden, {})
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: !(0, __stryke_type_checks_is_undefined.isUndefined)(type) && !(0, __stryke_type_checks_is_undefined.isUndefined)(defaultValue),
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocDefaultValue, {
+				type,
+				defaultValue
+			})
+		})
+	] });
+}
+/**
+* Create a TSDoc parameter set off with `@param`.
+*/
+function TSDocParam(props) {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		"@param ",
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocParamName, {
+			name: props.name,
+			optional: props.optional,
+			defaultValue: props.defaultValue
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocParamDescription, { children: props.children })
+	] });
+}
+function TSDocParamName(props) {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: props.optional,
+			children: "["
+		}),
+		props.name,
+		/* @__PURE__ */ (0, react_jsx_runtime.jsxs)(__alloy_js_core.Show, {
+			when: Boolean(props.defaultValue),
+			children: ["=", props.defaultValue]
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
+			when: props.optional,
+			children: "]"
+		})
+	] });
+}
+function TSDocParamDescription(props) {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(__alloy_js_core.Show, {
+		when: Boolean(props.children),
+		children: [" - ", /* @__PURE__ */ (0, react_jsx_runtime.jsx)("align", {
+			width: 2,
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Prose, { children: props.children })
+		})]
+	});
+}
+/**
+* Create a TSDoc `@returns` tag.
+*/
+function TSDocReturns(props) {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, {
+		...props,
+		tag: "returns"
+	});
+}
+/**
+* Create a TSDoc `@throws` tag.
+*/
+function TSDocThrows(props) {
+	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(TSDocTag, {
+		...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 /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [
+		"/**",
+		/* @__PURE__ */ (0, react_jsx_runtime.jsxs)("align", {
+			string: " * ",
+			children: [
+				/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
+				/* @__PURE__ */ (0, react_jsx_runtime.jsxs)(__alloy_js_core.Show, {
+					when: Boolean(children),
+					children: [
+						/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.List, {
+							hardline: true,
+							children: (0, __alloy_js_core.childrenArray)(() => children)
+						}),
+						/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
+						/* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {})
+					]
+				}),
+				"@module ",
+				prefix || context?.config?.framework || "powerlines",
+				":",
+				name
+			]
+		}),
+		/* @__PURE__ */ (0, react_jsx_runtime.jsx)("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;