@powerlines/plugin-alloy 0.18.50 → 0.18.53

package/dist/core/components/index.cjs

@@ -0,0 +1,7 @@
+const require_core_components_output = require('./output.cjs');
+const require_core_components_single_line_comment = require('./single-line-comment.cjs');
+const require_core_components_source_file = require('./source-file.cjs');
+
+exports.Output = require_core_components_output.Output;
+exports.SingleLineComment = require_core_components_single_line_comment.SingleLineComment;
+exports.SourceFile = require_core_components_source_file.SourceFile;

package/dist/core/components/index.d.cts

@@ -0,0 +1,4 @@
+import { Output, OutputProps, __ΩOutputProps } from "./output.cjs";
+import { SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant } from "./single-line-comment.cjs";
+import { SourceFile, SourceFileProps, __ΩSourceFileProps } from "./source-file.cjs";
+export { Output, OutputProps, SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, SourceFile, SourceFileProps, __ΩOutputProps, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant, __ΩSourceFileProps };

package/dist/core/components/index.d.mts

@@ -0,0 +1,4 @@
+import { Output, OutputProps, __ΩOutputProps } from "./output.mjs";
+import { SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant } from "./single-line-comment.mjs";
+import { SourceFile, SourceFileProps, __ΩSourceFileProps } from "./source-file.mjs";
+export { Output, OutputProps, SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, SourceFile, SourceFileProps, __ΩOutputProps, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant, __ΩSourceFileProps };

package/dist/core/components/index.mjs

@@ -0,0 +1,5 @@
+import { Output } from "./output.mjs";
+import { SingleLineComment } from "./single-line-comment.mjs";
+import { SourceFile } from "./source-file.mjs";
+
+export { Output, SingleLineComment, SourceFile };

package/dist/core/components/output.cjs

@@ -1,5 +1,5 @@
 const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
-const require_context = require('../contexts/context.cjs');
+const require_core_contexts_context = require('../contexts/context.cjs');
 let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
 let __alloy_js_core = require("@alloy-js/core");
 let __stryke_path_replace = require("@stryke/path/replace");
@@ -23,7 +23,7 @@ function Output(props) {
 			return basePathRef.value;
 		},
 		get children() {
-			return (0, __alloy_js_core_jsx_runtime.createComponent)(require_context.PowerlinesContext.Provider, {
+			return (0, __alloy_js_core_jsx_runtime.createComponent)(require_core_contexts_context.PowerlinesContext.Provider, {
 				value: {
 					ref: contextRef,
 					meta: metaRef

package/dist/core/components/output.d.cts

@@ -0,0 +1,23 @@
+import { PluginContext } from "../../powerlines/src/types/context.cjs";
+import { MetaItem } from "../contexts/context.cjs";
+import * as _alloy_js_core16 from "@alloy-js/core";
+import { OutputProps as OutputProps$1 } from "@alloy-js/core";
+
+//#region src/core/components/output.d.ts
+interface OutputProps<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>> extends OutputProps$1 {
+  /**
+   * The current Powerlines process context.
+   */
+  context: TContext;
+  /**
+   * Metadata for the current render.
+   */
+  meta?: TMeta;
+}
+/**
+ * Output component for rendering the Powerlines plugin's output files via templates.
+ */
+declare function Output<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(props: OutputProps<TContext, TMeta>): _alloy_js_core16.Children;
+declare type __ΩOutputProps = any[];
+//#endregion
+export { Output, OutputProps, __ΩOutputProps };

package/dist/core/components/output.d.mts

@@ -0,0 +1,23 @@
+import { PluginContext } from "../../powerlines/src/types/context.mjs";
+import { MetaItem } from "../contexts/context.mjs";
+import * as _alloy_js_core9 from "@alloy-js/core";
+import { OutputProps as OutputProps$1 } from "@alloy-js/core";
+
+//#region src/core/components/output.d.ts
+interface OutputProps<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>> extends OutputProps$1 {
+  /**
+   * The current Powerlines process context.
+   */
+  context: TContext;
+  /**
+   * Metadata for the current render.
+   */
+  meta?: TMeta;
+}
+/**
+ * Output component for rendering the Powerlines plugin's output files via templates.
+ */
+declare function Output<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(props: OutputProps<TContext, TMeta>): _alloy_js_core9.Children;
+declare type __ΩOutputProps = any[];
+//#endregion
+export { Output, OutputProps, __ΩOutputProps };

package/dist/core/components/output.mjs

@@ -1,13 +1,13 @@
 import { PowerlinesContext } from "../contexts/context.mjs";
 import { createComponent, mergeProps } from "@alloy-js/core/jsx-runtime";
-import { Output, Show, computed, ref, splitProps } from "@alloy-js/core";
+import { Output as Output$1, Show, computed, ref, splitProps } from "@alloy-js/core";
 import { replacePath } from "@stryke/path/replace";
 
 //#region src/core/components/output.tsx
 /**
 * Output component for rendering the Powerlines plugin's output files via templates.
 */
-function Output$1(props) {
+function Output(props) {
 	const [{ children, context, meta, basePath }, rest] = splitProps(props, [
 		"children",
 		"context",
@@ -17,7 +17,7 @@ function Output$1(props) {
 	const contextRef = ref(context);
 	const metaRef = ref(meta ?? {});
 	const basePathRef = computed(() => basePath ? replacePath(basePath, contextRef.value.workspaceConfig.workspaceRoot) : contextRef.value.workspaceConfig.workspaceRoot);
-	return createComponent(Output, mergeProps(rest, {
+	return createComponent(Output$1, mergeProps(rest, {
 		get basePath() {
 			return basePathRef.value;
 		},
@@ -41,4 +41,4 @@ function Output$1(props) {
 }
 
 //#endregion
-export { Output$1 as Output };
+export { Output };

package/dist/core/components/single-line-comment.cjs

@@ -0,0 +1,22 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let __alloy_js_core = require("@alloy-js/core");
+
+//#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)(__alloy_js_core.Prose, { children }), variant === "slash-star" || variant === "slash-star-star" ? " */ " : variant === "markdown" ? " -->" : ""];
+		}
+	})];
+}
+
+//#endregion
+exports.SingleLineComment = SingleLineComment;

package/dist/core/components/single-line-comment.d.cts

@@ -0,0 +1,22 @@
+import { ComponentProps } from "../../types/components.cjs";
+import * as _alloy_js_core15 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_core15.Children;
+declare type __ΩSingleLineCommentVariant = any[];
+declare type __ΩSingleLineCommentProps = any[];
+//#endregion
+export { SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant };

package/dist/core/components/single-line-comment.d.mts

@@ -0,0 +1,22 @@
+import { ComponentProps } from "../../types/components.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 { SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant };

package/dist/core/components/single-line-comment.mjs

@@ -0,0 +1,21 @@
+import { createComponent, createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { Prose } from "@alloy-js/core";
+
+//#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 };

package/dist/core/components/source-file.cjs

@@ -0,0 +1,64 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_core_contexts_context = require('../contexts/context.cjs');
+require('../contexts/index.cjs');
+let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let __alloy_js_core = require("@alloy-js/core");
+let __stryke_path_append = require("@stryke/path/append");
+let defu = require("defu");
+defu = require_rolldown_runtime.__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, storage, filetype, reference }] = (0, __alloy_js_core.splitProps)(props, [
+		"children",
+		"meta",
+		"path",
+		"header",
+		"storage",
+		"filetype",
+		"reference"
+	]);
+	const metadata = require_core_contexts_context.useMetaSafe();
+	const parentDirectory = (0, __alloy_js_core.useContext)(__alloy_js_core.SourceDirectoryContext);
+	const sourceFile = {
+		path: (0, __stryke_path_append.appendPath)(path, parentDirectory.path),
+		filetype,
+		reference
+	};
+	parentDirectory?.addContent(sourceFile);
+	const printOptions = (0, __alloy_js_core.useFormatOptions)({
+		printWidth: props.printWidth,
+		tabWidth: props.tabWidth,
+		useTabs: props.useTabs,
+		insertFinalNewLine: props.insertFinalNewLine
+	});
+	const nodeContext = (0, __alloy_js_core.getContext)();
+	nodeContext.meta = (0, defu.default)({
+		sourceFile,
+		printOptions
+	}, meta ?? {});
+	if (metadata) metadata[sourceFile.path] = {
+		storage,
+		...meta ?? {}
+	};
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.SourceFileContext.Provider, {
+		value: sourceFile,
+		get children() {
+			return [(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+				when: header !== void 0,
+				get children() {
+					return [header, (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})];
+				}
+			}), children];
+		}
+	});
+}
+
+//#endregion
+exports.SourceFile = SourceFile;

package/dist/core/components/source-file.d.cts

@@ -0,0 +1,32 @@
+import { StoragePreset } from "../../powerlines/src/types/fs.cjs";
+import { ComponentProps } from "../../types/components.cjs";
+import * as _alloy_js_core4 from "@alloy-js/core";
+import { SourceFileProps as SourceFileProps$1 } from "@alloy-js/core";
+
+//#region src/core/components/source-file.d.ts
+type SourceFileProps = SourceFileProps$1 & ComponentProps & {
+  /**
+   * The storage preset for the output files.
+   *
+   * @remarks
+   * If not specified, the output mode will be determined by the provided `output.mode` value.
+   */
+  storage?: 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): _alloy_js_core4.Children;
+declare type __ΩSourceFileProps = any[];
+//#endregion
+export { SourceFile, SourceFileProps, __ΩSourceFileProps };

package/dist/core/components/source-file.d.mts

@@ -0,0 +1,32 @@
+import { StoragePreset } from "../../powerlines/src/types/fs.mjs";
+import { ComponentProps } from "../../types/components.mjs";
+import * as _alloy_js_core0 from "@alloy-js/core";
+import { SourceFileProps as SourceFileProps$1 } from "@alloy-js/core";
+
+//#region src/core/components/source-file.d.ts
+type SourceFileProps = SourceFileProps$1 & ComponentProps & {
+  /**
+   * The storage preset for the output files.
+   *
+   * @remarks
+   * If not specified, the output mode will be determined by the provided `output.mode` value.
+   */
+  storage?: 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): _alloy_js_core0.Children;
+declare type __ΩSourceFileProps = any[];
+//#endregion
+export { SourceFile, SourceFileProps, __ΩSourceFileProps };

package/dist/core/components/source-file.mjs

@@ -0,0 +1,62 @@
+import { useMetaSafe } from "../contexts/context.mjs";
+import "../contexts/index.mjs";
+import { createComponent, createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { Show, SourceDirectoryContext, SourceFileContext, getContext, splitProps, useContext, useFormatOptions } from "@alloy-js/core";
+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, storage, filetype, reference }] = splitProps(props, [
+		"children",
+		"meta",
+		"path",
+		"header",
+		"storage",
+		"filetype",
+		"reference"
+	]);
+	const metadata = useMetaSafe();
+	const parentDirectory = useContext(SourceDirectoryContext);
+	const sourceFile = {
+		path: appendPath(path, parentDirectory.path),
+		filetype,
+		reference
+	};
+	parentDirectory?.addContent(sourceFile);
+	const printOptions = useFormatOptions({
+		printWidth: props.printWidth,
+		tabWidth: props.tabWidth,
+		useTabs: props.useTabs,
+		insertFinalNewLine: props.insertFinalNewLine
+	});
+	const nodeContext = getContext();
+	nodeContext.meta = defu({
+		sourceFile,
+		printOptions
+	}, meta ?? {});
+	if (metadata) metadata[sourceFile.path] = {
+		storage,
+		...meta ?? {}
+	};
+	return createComponent(SourceFileContext.Provider, {
+		value: sourceFile,
+		get children() {
+			return [createComponent(Show, {
+				when: header !== void 0,
+				get children() {
+					return [header, createIntrinsic("hbr", {})];
+				}
+			}), children];
+		}
+	});
+}
+
+//#endregion
+export { SourceFile };

package/dist/core/contexts/context.cjs

@@ -6,6 +6,55 @@ let __alloy_js_core = require("@alloy-js/core");
 * The Powerlines context used in template rendering.
 */
 const PowerlinesContext = (0, __alloy_js_core.createNamedContext)("powerlines");
+/**
+* Hook to access the Powerlines Context.
+*
+* @returns The Context.
+*/
+function usePowerlinesContext() {
+	return (0, __alloy_js_core.useContext)(PowerlinesContext);
+}
+/**
+* Hook to safely access the {@link PluginContext | Powerlines context}.
+*
+* @returns The Powerlines context or undefined if not set.
+*/
+function usePowerlinesSafe() {
+	return usePowerlinesContext()?.ref?.value;
+}
+/**
+* Hook to access the {@link PluginContext | Powerlines context}.
+*
+* @returns The Powerlines context.
+*/
+function usePowerlines() {
+	const powerlines = usePowerlinesSafe();
+	if (!powerlines) throw new Error("Powerlines - 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 powerlines;
+}
+/**
+* Hook to safely access the render context's metadata.
+*
+* @returns The Powerlines context or undefined if not set.
+*/
+function useMetaSafe() {
+	return usePowerlinesContext()?.meta?.value;
+}
+/**
+* Hook to access the render context's metadata.
+*
+* @returns The Powerlines context.
+*/
+function useMeta() {
+	const meta = useMetaSafe();
+	if (!meta) throw new Error("Powerlines metadata is not available in the rendering context. Please make sure the Alloy components are being provided to an invocation of the `render` function added to plugins by `@powerlines/plugin-alloy`.");
+	return meta;
+}
 
 //#endregion
-exports.PowerlinesContext = PowerlinesContext;
+exports.PowerlinesContext = PowerlinesContext;
+exports.useMeta = useMeta;
+exports.useMetaSafe = useMetaSafe;
+exports.usePowerlines = usePowerlines;
+exports.usePowerlinesContext = usePowerlinesContext;
+exports.usePowerlinesSafe = usePowerlinesSafe;

package/dist/core/contexts/context.d.cts

@@ -0,0 +1,71 @@
+import { StoragePreset } from "../../powerlines/src/types/fs.cjs";
+import { PluginContext } from "../../powerlines/src/types/context.cjs";
+import { ComponentContext, Ref } from "@alloy-js/core";
+
+//#region src/core/contexts/context.d.ts
+interface MetaItem {
+  /**
+   * The kind of metadata item.
+   */
+  kind?: "builtin" | "entry" | string;
+  /**
+   * Whether to skip formatting for this output.
+   */
+  skipFormat?: boolean;
+  /**
+   * The storage preset or adapter name for the output files.
+   *
+   * @remarks
+   * If not specified, the output mode will be determined by the provided `output.mode` value.
+   */
+  storage?: StoragePreset | string;
+  [key: string]: any;
+}
+interface PowerlinesContextInterface<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>> {
+  /**
+   * The current Powerlines context.
+   */
+  ref: Ref<TContext>;
+  /**
+   * The current render metadata.
+   */
+  meta: Ref<TMeta>;
+}
+/**
+ * The Powerlines context used in template rendering.
+ */
+declare const PowerlinesContext: ComponentContext<PowerlinesContextInterface<any, any>>;
+/**
+ * Hook to access the Powerlines Context.
+ *
+ * @returns The Context.
+ */
+declare function usePowerlinesContext<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(): PowerlinesContextInterface<TContext, TMeta> | undefined;
+/**
+ * Hook to safely access the {@link PluginContext | Powerlines context}.
+ *
+ * @returns The Powerlines context or undefined if not set.
+ */
+declare function usePowerlinesSafe<TContext extends PluginContext = PluginContext>(): TContext | undefined;
+/**
+ * Hook to access the {@link PluginContext | Powerlines context}.
+ *
+ * @returns The Powerlines context.
+ */
+declare function usePowerlines<TContext extends PluginContext = PluginContext>(): TContext;
+/**
+ * Hook to safely access the render context's metadata.
+ *
+ * @returns The Powerlines context or undefined if not set.
+ */
+declare function useMetaSafe<TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(): TMeta | undefined;
+/**
+ * Hook to access the render context's metadata.
+ *
+ * @returns The Powerlines context.
+ */
+declare function useMeta<TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(): TMeta;
+declare type __ΩMetaItem = any[];
+declare type __ΩPowerlinesContextInterface = any[];
+//#endregion
+export { MetaItem, PowerlinesContext, PowerlinesContextInterface, __ΩMetaItem, __ΩPowerlinesContextInterface, useMeta, useMetaSafe, usePowerlines, usePowerlinesContext, usePowerlinesSafe };

package/dist/core/contexts/context.d.mts

@@ -0,0 +1,71 @@
+import { StoragePreset } from "../../powerlines/src/types/fs.mjs";
+import { PluginContext } from "../../powerlines/src/types/context.mjs";
+import { ComponentContext, Ref } from "@alloy-js/core";
+
+//#region src/core/contexts/context.d.ts
+interface MetaItem {
+  /**
+   * The kind of metadata item.
+   */
+  kind?: "builtin" | "entry" | string;
+  /**
+   * Whether to skip formatting for this output.
+   */
+  skipFormat?: boolean;
+  /**
+   * The storage preset or adapter name for the output files.
+   *
+   * @remarks
+   * If not specified, the output mode will be determined by the provided `output.mode` value.
+   */
+  storage?: StoragePreset | string;
+  [key: string]: any;
+}
+interface PowerlinesContextInterface<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>> {
+  /**
+   * The current Powerlines context.
+   */
+  ref: Ref<TContext>;
+  /**
+   * The current render metadata.
+   */
+  meta: Ref<TMeta>;
+}
+/**
+ * The Powerlines context used in template rendering.
+ */
+declare const PowerlinesContext: ComponentContext<PowerlinesContextInterface<any, any>>;
+/**
+ * Hook to access the Powerlines Context.
+ *
+ * @returns The Context.
+ */
+declare function usePowerlinesContext<TContext extends PluginContext = PluginContext, TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(): PowerlinesContextInterface<TContext, TMeta> | undefined;
+/**
+ * Hook to safely access the {@link PluginContext | Powerlines context}.
+ *
+ * @returns The Powerlines context or undefined if not set.
+ */
+declare function usePowerlinesSafe<TContext extends PluginContext = PluginContext>(): TContext | undefined;
+/**
+ * Hook to access the {@link PluginContext | Powerlines context}.
+ *
+ * @returns The Powerlines context.
+ */
+declare function usePowerlines<TContext extends PluginContext = PluginContext>(): TContext;
+/**
+ * Hook to safely access the render context's metadata.
+ *
+ * @returns The Powerlines context or undefined if not set.
+ */
+declare function useMetaSafe<TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(): TMeta | undefined;
+/**
+ * Hook to access the render context's metadata.
+ *
+ * @returns The Powerlines context.
+ */
+declare function useMeta<TMeta extends Record<string, MetaItem> = Record<string, MetaItem>>(): TMeta;
+declare type __ΩMetaItem = any[];
+declare type __ΩPowerlinesContextInterface = any[];
+//#endregion
+export { MetaItem, PowerlinesContext, PowerlinesContextInterface, __ΩMetaItem, __ΩPowerlinesContextInterface, useMeta, useMetaSafe, usePowerlines, usePowerlinesContext, usePowerlinesSafe };

package/dist/core/contexts/context.mjs

@@ -1,10 +1,54 @@
-import { createNamedContext } from "@alloy-js/core";
+import { createNamedContext, useContext } from "@alloy-js/core";
 
 //#region src/core/contexts/context.ts
 /**
 * The Powerlines context used in template rendering.
 */
 const PowerlinesContext = createNamedContext("powerlines");
+/**
+* Hook to access the Powerlines Context.
+*
+* @returns The Context.
+*/
+function usePowerlinesContext() {
+	return useContext(PowerlinesContext);
+}
+/**
+* Hook to safely access the {@link PluginContext | Powerlines context}.
+*
+* @returns The Powerlines context or undefined if not set.
+*/
+function usePowerlinesSafe() {
+	return usePowerlinesContext()?.ref?.value;
+}
+/**
+* Hook to access the {@link PluginContext | Powerlines context}.
+*
+* @returns The Powerlines context.
+*/
+function usePowerlines() {
+	const powerlines = usePowerlinesSafe();
+	if (!powerlines) throw new Error("Powerlines - 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 powerlines;
+}
+/**
+* Hook to safely access the render context's metadata.
+*
+* @returns The Powerlines context or undefined if not set.
+*/
+function useMetaSafe() {
+	return usePowerlinesContext()?.meta?.value;
+}
+/**
+* Hook to access the render context's metadata.
+*
+* @returns The Powerlines context.
+*/
+function useMeta() {
+	const meta = useMetaSafe();
+	if (!meta) throw new Error("Powerlines metadata is not available in the rendering context. Please make sure the Alloy components are being provided to an invocation of the `render` function added to plugins by `@powerlines/plugin-alloy`.");
+	return meta;
+}
 
 //#endregion
-export { PowerlinesContext };
+export { PowerlinesContext, useMeta, useMetaSafe, usePowerlines, usePowerlinesContext, usePowerlinesSafe };