@powerlines/plugin-alloy 0.16.0 → 0.16.2

package/dist/reflection-srixNcX2.mjs

@@ -0,0 +1,60 @@
+import { createContext, createNamedContext, useContext } from "@powerlines/plugin-alloy/vendor";
+
+//#region src/core/contexts/reflection.ts
+/**
+* The reflection class context used in template rendering.
+*/
+const ReflectionClassContext = createContext();
+/**
+* Hook to access the Reflection context.
+*
+* @returns A reactive version of the current reflection.
+*/
+function useReflectionClass() {
+	const context = useContext(ReflectionClassContext);
+	if (!context) throw new Error("Powerlines - ReflectionClass Context is not set. Please make sure the Alloy components are being provided to an invocation of the `render` function added to plugins by `@powerlines/plugin-alloy`.");
+	return context;
+}
+/**
+* The reflection property context used in template rendering.
+*/
+const ReflectionPropertyContext = createNamedContext("reflection-property");
+/**
+* Hook to access the Reflection Property context.
+*
+* @returns A reactive version of the current reflection.
+*/
+function useReflectionProperty() {
+	const context = useContext(ReflectionPropertyContext);
+	if (!context) throw new Error("Powerlines - Reflection Property Context is not set. Please make sure the Alloy components are being provided to an invocation of the `render` function added to plugins by `@powerlines/plugin-alloy`.");
+	return context;
+}
+/**
+* The reflection method context used in template rendering.
+*/
+const ReflectionMethodContext = createNamedContext("reflection-method");
+/**
+* Hook to access the Reflection Method context.
+*
+* @returns A reactive version of the current reflection.
+*/
+function useReflectionMethod() {
+	const context = useContext(ReflectionMethodContext);
+	if (!context) throw new Error("Powerlines - Reflection Method Context is not set. Please make sure the Alloy components are being provided to an invocation of the `render` function added to plugins by `@powerlines/plugin-alloy`.");
+	return context;
+}
+/**
+* The reflection parameter context used in template rendering.
+*/
+const ReflectionParameterContext = createNamedContext("reflection-parameter");
+/**
+* Hook to access the Reflection Parameter context.
+*
+* @returns A reactive version of the current reflection.
+*/
+function useReflectionParameter() {
+	return useContext(ReflectionParameterContext);
+}
+
+//#endregion
+export { useReflectionClass as a, useReflectionProperty as c, ReflectionPropertyContext as i, ReflectionMethodContext as n, useReflectionMethod as o, ReflectionParameterContext as r, useReflectionParameter as s, ReflectionClassContext as t };

package/dist/single-line-comment-C9Fz5mkM.mjs

@@ -0,0 +1,21 @@
+import { createComponent, createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { Prose } from "@powerlines/plugin-alloy/vendor";
+
+//#region src/core/components/single-line-comment.tsx
+/**
+* A single line comment block. The children are rendered as a prose element, which means that they
+* are broken into multiple lines
+*/
+function SingleLineComment(props) {
+	const { variant = "double-slash", children } = props;
+	const commentStart = variant === "slash-star" ? "/* " : variant === "slash-star-star" ? "/** " : variant === "triple-slash" ? "/// " : variant === "markdown" ? "<!-- " : "// ";
+	return [commentStart, createIntrinsic("align", {
+		string: commentStart,
+		get children() {
+			return [createComponent(Prose, { children }), variant === "slash-star" || variant === "slash-star-star" ? " */ " : variant === "markdown" ? " -->" : ""];
+		}
+	})];
+}
+
+//#endregion
+export { SingleLineComment as t };

package/dist/single-line-comment-DSAVQ0tl.d.cts

@@ -0,0 +1,22 @@
+import { n as ComponentProps } from "./components-DkVeQ5Yn.cjs";
+import * as _alloy_js_core1 from "@alloy-js/core";
+
+//#region src/core/components/single-line-comment.d.ts
+type SingleLineCommentVariant = "double-slash" | "triple-slash" | "slash-star" | "slash-star-star" | "markdown";
+interface SingleLineCommentProps extends ComponentProps {
+  /**
+   * The variant of the single line comment.
+   *
+   * @defaultValue "double-slash"
+   */
+  variant?: SingleLineCommentVariant;
+}
+/**
+ * A single line comment block. The children are rendered as a prose element, which means that they
+ * are broken into multiple lines
+ */
+declare function SingleLineComment(props: SingleLineCommentProps): _alloy_js_core1.Children;
+declare type __ΩSingleLineCommentVariant = any[];
+declare type __ΩSingleLineCommentProps = any[];
+//#endregion
+export { __ΩSingleLineCommentVariant as a, __ΩSingleLineCommentProps as i, SingleLineCommentProps as n, SingleLineCommentVariant as r, SingleLineComment as t };

package/dist/single-line-comment-DSz_BbMx.d.mts

@@ -0,0 +1,22 @@
+import { n as ComponentProps } from "./components-BrkXdHq-.mjs";
+import * as _alloy_js_core0 from "@alloy-js/core";
+
+//#region src/core/components/single-line-comment.d.ts
+type SingleLineCommentVariant = "double-slash" | "triple-slash" | "slash-star" | "slash-star-star" | "markdown";
+interface SingleLineCommentProps extends ComponentProps {
+  /**
+   * The variant of the single line comment.
+   *
+   * @defaultValue "double-slash"
+   */
+  variant?: SingleLineCommentVariant;
+}
+/**
+ * A single line comment block. The children are rendered as a prose element, which means that they
+ * are broken into multiple lines
+ */
+declare function SingleLineComment(props: SingleLineCommentProps): _alloy_js_core0.Children;
+declare type __ΩSingleLineCommentVariant = any[];
+declare type __ΩSingleLineCommentProps = any[];
+//#endregion
+export { __ΩSingleLineCommentVariant as a, __ΩSingleLineCommentProps as i, SingleLineCommentProps as n, SingleLineCommentVariant as r, SingleLineComment as t };

package/dist/single-line-comment-_ZglDv1k.cjs

@@ -0,0 +1,27 @@
+const require_chunk = require('./chunk-BwyOHTjC.cjs');
+let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let __powerlines_plugin_alloy_vendor = require("@powerlines/plugin-alloy/vendor");
+
+//#region src/core/components/single-line-comment.tsx
+/**
+* A single line comment block. The children are rendered as a prose element, which means that they
+* are broken into multiple lines
+*/
+function SingleLineComment(props) {
+	const { variant = "double-slash", children } = props;
+	const commentStart = variant === "slash-star" ? "/* " : variant === "slash-star-star" ? "/** " : variant === "triple-slash" ? "/// " : variant === "markdown" ? "<!-- " : "// ";
+	return [commentStart, (0, __alloy_js_core_jsx_runtime.createIntrinsic)("align", {
+		string: commentStart,
+		get children() {
+			return [(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Prose, { children }), variant === "slash-star" || variant === "slash-star-star" ? " */ " : variant === "markdown" ? " -->" : ""];
+		}
+	})];
+}
+
+//#endregion
+Object.defineProperty(exports, 'SingleLineComment', {
+  enumerable: true,
+  get: function () {
+    return SingleLineComment;
+  }
+});

package/dist/source-file-B8OyOWg8.d.mts

@@ -0,0 +1,31 @@
+import { s as StoragePreset } from "./context-BwQLwanm.mjs";
+import { n as ComponentProps } from "./components-BrkXdHq-.mjs";
+import { SourceFileProps } from "@powerlines/plugin-alloy/vendor";
+import * as _alloy_js_core0 from "@alloy-js/core";
+
+//#region src/core/components/source-file.d.ts
+type SourceFileProps$1 = SourceFileProps & ComponentProps & {
+  /**
+   * If true, indicates that the file is virtual and should not be written to disk.
+   *
+   * @defaultValue false
+   */
+  preset?: StoragePreset;
+  /**
+   * The metadata associated with the source file.
+   *
+   * @remarks
+   * The values stored in the metadata will be available in the rendering context.
+   */
+  meta?: Record<string, any>;
+};
+/**
+ * A base component representing a Powerlines generated source file.
+ *
+ * @param props - The properties for the source file.
+ * @returns The rendered source file component.
+ */
+declare function SourceFile(props: SourceFileProps$1): _alloy_js_core0.Children;
+declare type __ΩSourceFileProps = any[];
+//#endregion
+export { SourceFileProps$1 as n, __ΩSourceFileProps as r, SourceFile as t };

package/dist/source-file-DKnFKRGJ.cjs

@@ -0,0 +1,63 @@
+const require_chunk = require('./chunk-BwyOHTjC.cjs');
+let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let __powerlines_plugin_alloy_vendor = require("@powerlines/plugin-alloy/vendor");
+let __stryke_path_append = require("@stryke/path/append");
+let defu = require("defu");
+defu = require_chunk.__toESM(defu);
+
+//#region src/core/components/source-file.tsx
+/**
+* A base component representing a Powerlines generated source file.
+*
+* @param props - The properties for the source file.
+* @returns The rendered source file component.
+*/
+function SourceFile(props) {
+	const [{ children, meta, path, header, preset, filetype, reference }] = (0, __powerlines_plugin_alloy_vendor.splitProps)(props, [
+		"children",
+		"meta",
+		"path",
+		"header",
+		"preset",
+		"filetype",
+		"reference"
+	]);
+	const parentDirectory = (0, __powerlines_plugin_alloy_vendor.useContext)(__powerlines_plugin_alloy_vendor.SourceDirectoryContext);
+	const context = {
+		path: (0, __stryke_path_append.appendPath)(path, parentDirectory.path),
+		filetype,
+		reference
+	};
+	parentDirectory?.addContent(context);
+	const printOptions = (0, __powerlines_plugin_alloy_vendor.useFormatOptions)({
+		printWidth: props.printWidth,
+		tabWidth: props.tabWidth,
+		useTabs: props.useTabs,
+		insertFinalNewLine: props.insertFinalNewLine
+	});
+	const nodeContext = (0, __powerlines_plugin_alloy_vendor.getContext)();
+	nodeContext.meta = (0, defu.default)({
+		sourceFile: context,
+		printOptions,
+		output: { preset }
+	}, meta ?? {});
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.SourceFileContext.Provider, {
+		value: context,
+		get children() {
+			return [(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_vendor.Show, {
+				when: header !== void 0,
+				get children() {
+					return [header, (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})];
+				}
+			}), children];
+		}
+	});
+}
+
+//#endregion
+Object.defineProperty(exports, 'SourceFile', {
+  enumerable: true,
+  get: function () {
+    return SourceFile;
+  }
+});

package/dist/source-file-Db1Wu_yq.mjs

@@ -0,0 +1,56 @@
+import { createComponent, createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { Show, SourceDirectoryContext, SourceFileContext, getContext, splitProps, useContext, useFormatOptions } from "@powerlines/plugin-alloy/vendor";
+import { appendPath } from "@stryke/path/append";
+import defu from "defu";
+
+//#region src/core/components/source-file.tsx
+/**
+* A base component representing a Powerlines generated source file.
+*
+* @param props - The properties for the source file.
+* @returns The rendered source file component.
+*/
+function SourceFile(props) {
+	const [{ children, meta, path, header, preset, filetype, reference }] = splitProps(props, [
+		"children",
+		"meta",
+		"path",
+		"header",
+		"preset",
+		"filetype",
+		"reference"
+	]);
+	const parentDirectory = useContext(SourceDirectoryContext);
+	const context = {
+		path: appendPath(path, parentDirectory.path),
+		filetype,
+		reference
+	};
+	parentDirectory?.addContent(context);
+	const printOptions = useFormatOptions({
+		printWidth: props.printWidth,
+		tabWidth: props.tabWidth,
+		useTabs: props.useTabs,
+		insertFinalNewLine: props.insertFinalNewLine
+	});
+	const nodeContext = getContext();
+	nodeContext.meta = defu({
+		sourceFile: context,
+		printOptions,
+		output: { preset }
+	}, meta ?? {});
+	return createComponent(SourceFileContext.Provider, {
+		value: context,
+		get children() {
+			return [createComponent(Show, {
+				when: header !== void 0,
+				get children() {
+					return [header, createIntrinsic("hbr", {})];
+				}
+			}), children];
+		}
+	});
+}
+
+//#endregion
+export { SourceFile as t };

package/dist/source-file-Dr2h8MVw.d.cts

@@ -0,0 +1,31 @@
+import { s as StoragePreset } from "./context-CWt70HA3.cjs";
+import { n as ComponentProps } from "./components-DkVeQ5Yn.cjs";
+import * as _alloy_js_core0 from "@alloy-js/core";
+import { SourceFileProps } from "@powerlines/plugin-alloy/vendor";
+
+//#region src/core/components/source-file.d.ts
+type SourceFileProps$1 = SourceFileProps & ComponentProps & {
+  /**
+   * If true, indicates that the file is virtual and should not be written to disk.
+   *
+   * @defaultValue false
+   */
+  preset?: StoragePreset;
+  /**
+   * The metadata associated with the source file.
+   *
+   * @remarks
+   * The values stored in the metadata will be available in the rendering context.
+   */
+  meta?: Record<string, any>;
+};
+/**
+ * A base component representing a Powerlines generated source file.
+ *
+ * @param props - The properties for the source file.
+ * @returns The rendered source file component.
+ */
+declare function SourceFile(props: SourceFileProps$1): _alloy_js_core0.Children;
+declare type __ΩSourceFileProps = any[];
+//#endregion
+export { SourceFileProps$1 as n, __ΩSourceFileProps as r, SourceFile as t };

package/dist/tsdoc-BT-2pTD3.d.mts

@@ -0,0 +1,152 @@
+import { n as ComponentProps } from "./components-BrkXdHq-.mjs";
+import { Children } from "@powerlines/plugin-alloy/vendor";
+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 { __Ω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 };