@powerlines/plugin-alloy 0.15.6 → 0.15.7

package/dist/tsdoc-97Dh6htZ.cjs

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

package/dist/tsdoc-BMyugfPn.d.mts

@@ -0,0 +1,152 @@
+import { n as ComponentProps } from "./components-cffsgxGP.mjs";
+import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
+import { Children } from "@alloy-js/core";
+
+//#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 { __ΩTSDocDefaultValueProps as A, TSDocRemarks as C, TSDocThrows as D, TSDocTagProps as E, __ΩTSDocProps as F, __ΩTSDocTagProps as I, __ΩTSDocModuleProps as M, __ΩTSDocParamProps as N, TSDocTitle as O, __ΩTSDocParamsProps as P, TSDocReadonly as S, TSDocTag as T, TSDocParamProps as _, TSDocDefaultValue as a, TSDocPermission as b, TSDocExample as c, TSDocIgnore as d, TSDocInternal as f, TSDocParam as g, TSDocModuleProps as h, TSDocAttributesTagsProps as i, __ΩTSDocExampleProps as j, __ΩTSDocAttributesTagsProps as k, TSDocExampleProps as l, TSDocModule as m, TSDocAlias as n, TSDocDefaultValueProps as o, TSDocLink as p, TSDocAttributesTags as r, TSDocDomain as s, TSDoc as t, TSDocHidden as u, TSDocParams as v, TSDocReturns as w, TSDocProps as x, TSDocParamsProps as y };