npm - @powerlines/plugin-alloy - Versions diffs - 0.23.40 → 0.24.0 - Mend

@powerlines/plugin-alloy 0.23.40 → 0.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

package/dist/typescript/components/interface-declaration.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"interface-declaration.mjs","names":["Block","childrenArray","computed","createSymbol","createSymbolSlot","effect","emitSymbol","findUnkeyedChildren","For","MemberDeclaration","Name","Show","splitProps","takeSymbols","Declaration","ensureTypeRefContext","TSOutputSymbol","TSSymbolFlags","useTSLexicalScope","useTSMemberScope","useTSNamePolicy","stringifyType","pascalCase","isString","ReflectionClassContext","ReflectionPropertyContext","MemberScope","PropertyName","TSDoc","TSDocReflectionClass","TSDocReflectionProperty","TypeParameters","InterfaceExpression","props","scope","symbol","undefined","transient","binder","_$createIntrinsic","children","_$createComponent","ownerSymbol","InterfaceMember","type","readonly","when","Boolean","doc","heading","_$memo","indexer","optionality","optional","sym","name","staticMembers","refkeys","refkey","tsFlags","TypeSymbol","nullish","Nullish","None","namePolicy","for","taken","size","Array","from","isTransient","moveMembersTo","BaseInterfaceDeclaration","InterfaceDeclaration","ExprSlot","extendsPart","extends","filteredChildren","currentScope","types","default","export","metadata","ref","value","takenSymbols","_$mergeProps","nameKind","kind","typeParameters","parameters","reflection","rest","interfaceName","toString","getName","properties","getProperties","filter","item","isIgnored","sort","a","b","isReadonly","getNameAsString","localeCompare","length","fallback","Provider","each","doubleHardline","semicolon","prop","InterfaceDeclarationProperty","property","isOptional","isNullable","getType"],"sources":["../../../src/typescript/components/interface-declaration.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- /\n\nimport {\n Block,\n Children,\n childrenArray,\n computed,\n createSymbol,\n createSymbolSlot,\n effect,\n emitSymbol,\n findUnkeyedChildren,\n For,\n MemberDeclaration,\n Name,\n Namekey,\n Refkey,\n Show,\n splitProps,\n takeSymbols\n} from \"@alloy-js/core\";\nimport {\n CommonDeclarationProps,\n Declaration,\n ensureTypeRefContext,\n TSOutputSymbol,\n TSSymbolFlags,\n TypeParameterDescriptor,\n useTSLexicalScope,\n useTSMemberScope,\n useTSNamePolicy\n} from \"@alloy-js/typescript\";\nimport {\n ReflectionClass,\n ReflectionProperty,\n stringifyType\n} from \"@powerlines/deepkit/vendor/type\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport { isString } from \"@stryke/type-checks/is-string\";\nimport {\n ReflectionClassContext,\n ReflectionPropertyContext\n} from \"../../core/contexts/reflection\";\nimport { ComponentProps } from \"../../types/components\";\nimport { MemberScope } from \"../contexts/member-scope\";\nimport { PropertyName } from \"./property-name\";\nimport { TSDoc } from \"./tsdoc\";\nimport {\n TSDocReflectionClass,\n TSDocReflectionProperty\n} from \"./tsdoc-reflection\";\nimport { TypeParameters } from \"./type-parameters\";\n\nexport interface InterfaceDeclarationProps<\n T extends Record<string, any> = Record<string, any>\n>\n extends CommonDeclarationProps, ComponentProps {\n /\n A base type that this interface extends. This can be used to represent inheritance\n /\n extends?: Children;\n\n /\n The generic type parameters of the interface.\n /\n typeParameters?: TypeParameterDescriptor[] \| string[];\n\n /\n The reflection class that describes the properties of this interface.\n \n @remarks\n * This is used to generate the members of the interface based on the properties of the reflection class.\n /\n reflection?: ReflectionClass<T>;\n\n /\n A default value for this interface.\n \n @remarks\n * This is used when the interface is used as a type for a variable declaration, to provide an initial value for the variable.\n /\n defaultValue?: Partial<T>;\n}\n\nexport interface InterfaceDeclarationPropertyProps\n extends Omit<InterfaceMemberProps, \"name\">, ComponentProps {\n property: ReflectionProperty;\n}\n\nexport interface InterfaceExpressionProps {\n children?: Children;\n}\n\nexport const InterfaceExpression = ensureTypeRefContext(\n function InterfaceExpression(props: InterfaceExpressionProps) {\n const scope = useTSLexicalScope();\n const symbol = createSymbol(TSOutputSymbol, \"\", undefined, {\n transient: true,\n binder: scope?.binder\n });\n\n emitSymbol(symbol);\n\n return (\n <group>\n <MemberScope ownerSymbol={symbol}>\n <Block>{props.children}</Block>\n </MemberScope>\n </group>\n );\n }\n);\n\nexport interface InterfaceMemberPropsBase {\n type?: Children;\n children?: Children;\n readonly?: boolean;\n doc?: Children;\n refkey?: Refkey \| Refkey[];\n}\nexport interface InterfacePropertyMemberProps extends InterfaceMemberPropsBase {\n name: string \| Namekey;\n optional?: boolean;\n nullish?: boolean;\n}\n\nexport interface InterfaceIndexerMemberProps extends InterfaceMemberPropsBase {\n indexer: Children;\n}\n\nexport type InterfaceMemberProps =\n \| InterfacePropertyMemberProps\n \| InterfaceIndexerMemberProps;\n\n/\n Create a TypeScript interface member.\n \n An interface member can either provide a `name` prop to create a named\n * property, or an `indexer` prop to define an indexer for the interface.\n \n The type of the member can be provided either as the `type` prop or as the\n * children of the component.\n /\nexport function InterfaceMember(props: InterfaceMemberProps) {\n const type = props.type ?? props.children;\n const readonly = props.readonly ? \"readonly \" : \"\";\n\n if (\"indexer\" in props) {\n return (\n <>\n <Show when={Boolean(props.doc)}>\n <TSDoc heading={props.doc} />\n </Show>\n {readonly}[{props.indexer}]: {type}\n </>\n );\n }\n\n const optionality = props.optional ? \"?\" : \"\";\n const scope = useTSMemberScope();\n const sym = createSymbol(\n TSOutputSymbol,\n props.name,\n scope.ownerSymbol.staticMembers,\n {\n refkeys: props.refkey,\n tsFlags:\n TSSymbolFlags.TypeSymbol \|\n ((props.nullish ?? props.optional)\n ? TSSymbolFlags.Nullish\n : TSSymbolFlags.None),\n namePolicy: useTSNamePolicy().for(\"interface-member\"),\n binder: scope.binder\n }\n );\n\n const taken = takeSymbols();\n\n effect(() => {\n if (taken.size > 1) return;\n const symbol = Array.from(taken)[0];\n if (symbol?.isTransient) {\n symbol.moveMembersTo(sym);\n }\n });\n\n return (\n <MemberDeclaration symbol={sym}>\n <Show when={Boolean(props.doc)}>\n <TSDoc heading={props.doc} />\n </Show>\n {readonly}\n <PropertyName />\n {optionality}: {type}\n </MemberDeclaration>\n );\n}\n\nconst BaseInterfaceDeclaration = ensureTypeRefContext(\n function InterfaceDeclaration(props: InterfaceDeclarationProps) {\n const ExprSlot = createSymbolSlot();\n\n const children = childrenArray(() => props.children);\n\n const extendsPart = props.extends ? <> extends {props.extends}</> : \"\";\n const filteredChildren = findUnkeyedChildren(children);\n const currentScope = useTSLexicalScope();\n\n const binder = currentScope?.binder;\n const sym = createSymbol(TSOutputSymbol, props.name, currentScope.types, {\n refkeys: props.refkey,\n default: props.default,\n export: props.export,\n metadata: props.metadata,\n tsFlags: TSSymbolFlags.TypeSymbol,\n namePolicy: useTSNamePolicy().for(\"interface\"),\n binder\n });\n\n effect(() => {\n if (ExprSlot.ref.value) {\n const takenSymbols = ExprSlot.ref.value;\n for (const symbol of takenSymbols) {\n // ignore non-transient symbols (likely not the result of an expression).\n if (symbol.isTransient) {\n symbol.moveMembersTo(sym);\n }\n }\n }\n });\n\n return (\n <>\n <Show when={Boolean(props.doc)}>\n <TSDoc heading={props.doc} />\n </Show>\n <Declaration {...props} nameKind=\"interface\" kind=\"type\" symbol={sym}>\n interface <Name />\n {props.typeParameters && (\n <TypeParameters parameters={props.typeParameters} />\n )}\n {extendsPart}{\" \"}\n <ExprSlot>\n <InterfaceExpression>{filteredChildren}</InterfaceExpression>\n </ExprSlot>\n </Declaration>\n </>\n );\n }\n);\n\n/\n Generates a TypeScript interface for the given reflection class.\n /\nexport function InterfaceDeclaration<\n T extends Record<string, any> = Record<string, any>\n>(props: InterfaceDeclarationProps<T>) {\n const [{ name, reflection, doc }, rest] = splitProps(props, [\n \"name\",\n \"reflection\",\n \"doc\"\n ]);\n\n const interfaceName = computed(() =>\n pascalCase(\n (isString(name) ? name : name.toString()) \|\| reflection?.getName()\n )\n );\n\n const properties = computed(() =>\n reflection\n ? reflection\n .getProperties()\n .filter(item => !item.isIgnored())\n .sort((a, b) =>\n (a.isReadonly() && b.isReadonly()) \|\|\n (!a.isReadonly() && !b.isReadonly())\n ? a.getNameAsString().localeCompare(b.getNameAsString())\n : a.isReadonly()\n ? 1\n : -1\n )\n : []\n );\n\n return (\n <Show\n when={properties.value.length > 0}\n fallback={\n <BaseInterfaceDeclaration {...props} name={interfaceName.value} />\n }>\n <ReflectionClassContext.Provider\n value={{\n reflection: reflection!\n }}>\n <TSDocReflectionClass heading={doc} />\n <BaseInterfaceDeclaration\n export={true}\n name={interfaceName.value}\n {...rest}>\n <For each={properties} doubleHardline={true} semicolon={true}>\n {prop => <InterfaceDeclarationProperty property={prop} />}\n </For>\n </BaseInterfaceDeclaration>\n </ReflectionClassContext.Provider>\n </Show>\n );\n}\n\n/\n Generates a TypeScript interface property for the given reflection class.\n */\nexport function InterfaceDeclarationProperty(\n props: InterfaceDeclarationPropertyProps\n) {\n const [{ property }, rest] = splitProps(props, [\"property\"]);\n\n return (\n <ReflectionPropertyContext.Provider value={property}>\n <TSDocReflectionProperty />\n <InterfaceMember\n name={property.getNameAsString()}\n readonly={property.isReadonly()}\n optional={property.isOptional()}\n nullish={property.isNullable()}\n type={stringifyType(property.getType())}\n {...rest}\n />\n </ReflectionPropertyContext.Provider>\n );\n}\n"],"mappings":""}
1	+ {"version":3,"file":"interface-declaration.mjs","names":["Block","childrenArray","computed","createSymbol","createSymbolSlot","effect","emitSymbol","findUnkeyedChildren","For","MemberDeclaration","Name","Show","splitProps","takeSymbols","Declaration","ensureTypeRefContext","TSOutputSymbol","TSSymbolFlags","useTSLexicalScope","useTSMemberScope","useTSNamePolicy","stringifyType","pascalCase","isString","ReflectionClassContext","ReflectionPropertyContext","MemberScope","PropertyName","TSDoc","TSDocContextProperty","TSDocReflectionClass","TypeParameters","InterfaceExpression","props","scope","symbol","undefined","transient","binder","_$createIntrinsic","children","_$createComponent","ownerSymbol","InterfaceMember","type","readonly","when","Boolean","doc","heading","_$memo","indexer","optionality","optional","sym","name","staticMembers","refkeys","refkey","tsFlags","TypeSymbol","nullish","Nullish","None","namePolicy","for","taken","size","Array","from","isTransient","moveMembersTo","BaseInterfaceDeclaration","InterfaceDeclaration","ExprSlot","extendsPart","extends","filteredChildren","currentScope","types","default","export","metadata","ref","value","takenSymbols","_$mergeProps","nameKind","kind","typeParameters","parameters","reflection","rest","interfaceName","toString","getName","properties","getProperties","filter","item","isIgnored","sort","a","b","isReadonly","getNameAsString","localeCompare","length","fallback","Provider","each","doubleHardline","semicolon","prop","InterfaceDeclarationProperty","property","isOptional","isNullable","getType"],"sources":["../../../src/typescript/components/interface-declaration.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- /\n\nimport {\n Block,\n Children,\n childrenArray,\n computed,\n createSymbol,\n createSymbolSlot,\n effect,\n emitSymbol,\n findUnkeyedChildren,\n For,\n MemberDeclaration,\n Name,\n Namekey,\n Refkey,\n Show,\n splitProps,\n takeSymbols\n} from \"@alloy-js/core\";\nimport {\n CommonDeclarationProps,\n Declaration,\n ensureTypeRefContext,\n TSOutputSymbol,\n TSSymbolFlags,\n TypeParameterDescriptor,\n useTSLexicalScope,\n useTSMemberScope,\n useTSNamePolicy\n} from \"@alloy-js/typescript\";\nimport {\n ReflectionClass,\n ReflectionProperty,\n stringifyType\n} from \"@powerlines/deepkit/vendor/type\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport { isString } from \"@stryke/type-checks/is-string\";\nimport {\n ReflectionClassContext,\n ReflectionPropertyContext\n} from \"../../core/contexts/reflection\";\nimport { ComponentProps } from \"../../types/components\";\nimport { MemberScope } from \"../contexts/member-scope\";\nimport { PropertyName } from \"./property-name\";\nimport { TSDoc } from \"./tsdoc\";\nimport { TSDocContextProperty, TSDocReflectionClass } from \"./tsdoc-reflection\";\nimport { TypeParameters } from \"./type-parameters\";\n\nexport interface InterfaceDeclarationProps<\n T extends Record<string, any> = Record<string, any>\n>\n extends CommonDeclarationProps, ComponentProps {\n /\n A base type that this interface extends. This can be used to represent inheritance\n /\n extends?: Children;\n\n /\n The generic type parameters of the interface.\n /\n typeParameters?: TypeParameterDescriptor[] \| string[];\n\n /\n The reflection class that describes the properties of this interface.\n \n @remarks\n * This is used to generate the members of the interface based on the properties of the reflection class.\n /\n reflection?: ReflectionClass<T>;\n\n /\n A default value for this interface.\n \n @remarks\n * This is used when the interface is used as a type for a variable declaration, to provide an initial value for the variable.\n /\n defaultValue?: Partial<T>;\n\n /\n Documentation for the interface. This can be a string or any Alloy component that renders documentation content (such as `TSDoc`).\n /\n doc?: Children;\n}\n\nexport interface InterfaceDeclarationPropertyProps\n extends Omit<InterfaceMemberProps, \"name\">, ComponentProps {\n property: ReflectionProperty;\n}\n\nexport interface InterfaceExpressionProps {\n children?: Children;\n}\n\nexport const InterfaceExpression = ensureTypeRefContext(\n function InterfaceExpression(props: InterfaceExpressionProps) {\n const scope = useTSLexicalScope();\n const symbol = createSymbol(TSOutputSymbol, \"\", undefined, {\n transient: true,\n binder: scope?.binder\n });\n\n emitSymbol(symbol);\n\n return (\n <group>\n <MemberScope ownerSymbol={symbol}>\n <Block>{props.children}</Block>\n </MemberScope>\n </group>\n );\n }\n);\n\nexport interface InterfaceMemberPropsBase {\n type?: Children;\n children?: Children;\n readonly?: boolean;\n doc?: Children;\n refkey?: Refkey \| Refkey[];\n}\nexport interface InterfacePropertyMemberProps extends InterfaceMemberPropsBase {\n name: string \| Namekey;\n optional?: boolean;\n nullish?: boolean;\n}\n\nexport interface InterfaceIndexerMemberProps extends InterfaceMemberPropsBase {\n indexer: Children;\n}\n\nexport type InterfaceMemberProps =\n \| InterfacePropertyMemberProps\n \| InterfaceIndexerMemberProps;\n\n/\n Create a TypeScript interface member.\n \n An interface member can either provide a `name` prop to create a named\n * property, or an `indexer` prop to define an indexer for the interface.\n \n The type of the member can be provided either as the `type` prop or as the\n * children of the component.\n /\nexport function InterfaceMember(props: InterfaceMemberProps) {\n const type = props.type ?? props.children;\n const readonly = props.readonly ? \"readonly \" : \"\";\n\n if (\"indexer\" in props) {\n return (\n <>\n <Show when={Boolean(props.doc)}>\n <TSDoc heading={props.doc} />\n </Show>\n {readonly}[{props.indexer}]: {type}\n </>\n );\n }\n\n const optionality = props.optional ? \"?\" : \"\";\n const scope = useTSMemberScope();\n const sym = createSymbol(\n TSOutputSymbol,\n props.name,\n scope.ownerSymbol.staticMembers,\n {\n refkeys: props.refkey,\n tsFlags:\n TSSymbolFlags.TypeSymbol \|\n ((props.nullish ?? props.optional)\n ? TSSymbolFlags.Nullish\n : TSSymbolFlags.None),\n namePolicy: useTSNamePolicy().for(\"interface-member\"),\n binder: scope.binder\n }\n );\n\n const taken = takeSymbols();\n\n effect(() => {\n if (taken.size > 1) return;\n const symbol = Array.from(taken)[0];\n if (symbol?.isTransient) {\n symbol.moveMembersTo(sym);\n }\n });\n\n return (\n <MemberDeclaration symbol={sym}>\n <Show when={Boolean(props.doc)}>\n <TSDoc heading={props.doc} />\n </Show>\n {readonly}\n <PropertyName />\n {optionality}: {type}\n </MemberDeclaration>\n );\n}\n\nconst BaseInterfaceDeclaration = ensureTypeRefContext(\n function InterfaceDeclaration(props: InterfaceDeclarationProps) {\n const ExprSlot = createSymbolSlot();\n\n const children = childrenArray(() => props.children);\n\n const extendsPart = props.extends ? <> extends {props.extends}</> : \"\";\n const filteredChildren = findUnkeyedChildren(children);\n const currentScope = useTSLexicalScope();\n\n const binder = currentScope?.binder;\n const sym = createSymbol(TSOutputSymbol, props.name, currentScope.types, {\n refkeys: props.refkey,\n default: props.default,\n export: props.export,\n metadata: props.metadata,\n tsFlags: TSSymbolFlags.TypeSymbol,\n namePolicy: useTSNamePolicy().for(\"interface\"),\n binder\n });\n\n effect(() => {\n if (ExprSlot.ref.value) {\n const takenSymbols = ExprSlot.ref.value;\n for (const symbol of takenSymbols) {\n // ignore non-transient symbols (likely not the result of an expression).\n if (symbol.isTransient) {\n symbol.moveMembersTo(sym);\n }\n }\n }\n });\n\n return (\n <>\n <Show when={Boolean(props.doc)}>\n <TSDoc heading={props.doc} />\n </Show>\n <Declaration {...props} nameKind=\"interface\" kind=\"type\" symbol={sym}>\n interface <Name />\n {props.typeParameters && (\n <TypeParameters parameters={props.typeParameters} />\n )}\n {extendsPart}{\" \"}\n <ExprSlot>\n <InterfaceExpression>{filteredChildren}</InterfaceExpression>\n </ExprSlot>\n </Declaration>\n </>\n );\n }\n);\n\n/\n Generates a TypeScript interface for the given reflection class.\n /\nexport function InterfaceDeclaration<\n T extends Record<string, any> = Record<string, any>\n>(props: InterfaceDeclarationProps<T>) {\n const [{ name, reflection, doc }, rest] = splitProps(props, [\n \"name\",\n \"reflection\",\n \"doc\"\n ]);\n\n const interfaceName = computed(() =>\n pascalCase(\n (isString(name) ? name : name.toString()) \|\| reflection?.getName()\n )\n );\n\n const properties = computed(() =>\n reflection\n ? reflection\n .getProperties()\n .filter(item => !item.isIgnored())\n .sort((a, b) =>\n (a.isReadonly() && b.isReadonly()) \|\|\n (!a.isReadonly() && !b.isReadonly())\n ? a.getNameAsString().localeCompare(b.getNameAsString())\n : a.isReadonly()\n ? 1\n : -1\n )\n : []\n );\n\n return (\n <Show\n when={reflection && properties.value.length > 0}\n fallback={\n <BaseInterfaceDeclaration {...props} name={interfaceName.value} />\n }>\n <ReflectionClassContext.Provider\n value={{\n reflection: reflection!\n }}>\n <TSDocReflectionClass<T> heading={doc} reflection={reflection!} />\n <BaseInterfaceDeclaration\n export={true}\n name={interfaceName.value}\n {...rest}>\n <For each={properties} doubleHardline={true} semicolon={true}>\n {prop => <InterfaceDeclarationProperty property={prop} />}\n </For>\n </BaseInterfaceDeclaration>\n </ReflectionClassContext.Provider>\n </Show>\n );\n}\n\n/\n Generates a TypeScript interface property for the given reflection class.\n */\nexport function InterfaceDeclarationProperty(\n props: InterfaceDeclarationPropertyProps\n) {\n const [{ property }, rest] = splitProps(props, [\"property\"]);\n\n return (\n <ReflectionPropertyContext.Provider value={property}>\n <TSDocContextProperty />\n <InterfaceMember\n name={property.getNameAsString()}\n readonly={property.isReadonly()}\n optional={property.isOptional()}\n nullish={property.isNullable()}\n type={stringifyType(property.getType())}\n {...rest}\n />\n </ReflectionPropertyContext.Provider>\n );\n}\n"],"mappings":""}

package/dist/typescript/components/object-declaration.d.cts CHANGED Viewed

@@ -1,5 +1,5 @@
 import { ComponentProps } from "../../types/components.cjs";
-import * as _alloy_js_core18 from "@alloy-js/core";
+import * as _alloy_js_core17 from "@alloy-js/core";
 import { ReflectionClass, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
 import { VarDeclarationProps } from "@alloy-js/typescript";
@@ -17,11 +17,11 @@ interface ObjectDeclarationPropertyProps extends ComponentProps {
 /**
  * Generates a TypeScript object for the given reflection class.
  */
-declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>): _alloy_js_core18.Children;
+declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>): _alloy_js_core17.Children;
 /**
  * Generates a TypeScript object property for the given reflection class.
  */
-declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps): _alloy_js_core18.Children;
+declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps): _alloy_js_core17.Children;
 declare type __ΩComputedRef = any[];
 declare type __ΩObjectDeclarationProps = any[];
 declare type __ΩObjectDeclarationPropertyProps = any[];

package/dist/typescript/components/object-declaration.d.mts CHANGED Viewed

@@ -1,5 +1,5 @@
 import { ComponentProps } from "../../types/components.mjs";
-import * as _alloy_js_core9 from "@alloy-js/core";
+import * as _alloy_js_core18 from "@alloy-js/core";
 import { ReflectionClass, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
 import { VarDeclarationProps } from "@alloy-js/typescript";
@@ -17,11 +17,11 @@ interface ObjectDeclarationPropertyProps extends ComponentProps {
 /**
  * Generates a TypeScript object for the given reflection class.
  */
-declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>): _alloy_js_core9.Children;
+declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>): _alloy_js_core18.Children;
 /**
  * Generates a TypeScript object property for the given reflection class.
  */
-declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps): _alloy_js_core9.Children;
+declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps): _alloy_js_core18.Children;
 declare type __ΩComputedRef = any[];
 declare type __ΩObjectDeclarationProps = any[];
 declare type __ΩObjectDeclarationPropertyProps = any[];

package/dist/typescript/components/object-declaration.d.mts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"object-declaration.d.mts","names":[],"sources":["../../../src/typescript/components/object-declaration.tsx"],"sourcesContent":[],"mappings":";;;;;;UAuDiB;kBACC;;AADD,UAIA,sBAHE,CAAA,UAIP,MAJO,CAAA,MAAA,EAAA,GAAA,CAAA,GAIe,MAJf,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,SAKT,mBALS,CAAA;EAGF,UAAA,CAAA,EAGF,WAHE,CAGU,eAHY,CAGI,CAHJ,CAAA,CAAA;EAC3B,YAAA,CAAA,EAGK,WAHL,CAGiB,OAHjB,CAGyB,CAHzB,CAAA,GAAA,SAAA,CAAA;;AAE+B,UAI1B,8BAAA,SAAuC,cAJb,CAAA;EAAhB,QAAA,EAKf,kBALe;;;;;AADjB,iBAYM,iBAZN,CAAA,UAaE,MAbF,CAAA,MAAA,EAAA,GAAA,CAAA,GAawB,MAbxB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAcD,sBAdC,CAcsB,CAdtB,CAAA,CAAA,EAcqB,~~eAAA~~,CAAG,QAdxB;;AAKV;AAOA;AACY,iBAkHI,yBAAA,CAlHJ,KAAA,EAmHH,8BAnHG,CAAA,EAmH2B,~~eAAA~~,CAAA,QAnH3B;AAAsB,8BAAA,GAAA,EAAA;AACF,yCAAA,GAAA,EAAA;AAAvB,iDAAA,GAAA,EAAA"}
1	+ {"version":3,"file":"object-declaration.d.mts","names":[],"sources":["../../../src/typescript/components/object-declaration.tsx"],"sourcesContent":[],"mappings":";;;;;;UAuDiB;kBACC;;AADD,UAIA,sBAHE,CAAA,UAIP,MAJO,CAAA,MAAA,EAAA,GAAA,CAAA,GAIe,MAJf,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,SAKT,mBALS,CAAA;EAGF,UAAA,CAAA,EAGF,WAHE,CAGU,eAHY,CAGI,CAHJ,CAAA,CAAA;EAC3B,YAAA,CAAA,EAGK,WAHL,CAGiB,OAHjB,CAGyB,CAHzB,CAAA,GAAA,SAAA,CAAA;;AAE+B,UAI1B,8BAAA,SAAuC,cAJb,CAAA;EAAhB,QAAA,EAKf,kBALe;;;;;AADjB,iBAYM,iBAZN,CAAA,UAaE,MAbF,CAAA,MAAA,EAAA,GAAA,CAAA,GAawB,MAbxB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAcD,sBAdC,CAcsB,CAdtB,CAAA,CAAA,EAcqB,gBAAA,CAAG,QAdxB;;AAKV;AAOA;AACY,iBAkHI,yBAAA,CAlHJ,KAAA,EAmHH,8BAnHG,CAAA,EAmH2B,gBAAA,CAAA,QAnH3B;AAAsB,8BAAA,GAAA,EAAA;AACF,yCAAA,GAAA,EAAA;AAAvB,iDAAA,GAAA,EAAA"}

package/dist/typescript/components/property-name.d.cts CHANGED Viewed

@@ -1,4 +1,4 @@
-import * as _alloy_js_core16 from "@alloy-js/core";
+import * as _alloy_js_core15 from "@alloy-js/core";
 //#region src/typescript/components/property-name.d.ts
 interface PropertyNameProps {
@@ -17,7 +17,7 @@ interface PropertyNameProps {
  * @remarks
  * If the name is not a valid JavaScript identifier, it will be quoted. If a `name` prop is provided, it will be used as the property name. Otherwise, the name will be taken from the {@link (MemberDeclarationContext:variable)}.
  */
-declare function PropertyName(props: PropertyNameProps): _alloy_js_core16.Children;
+declare function PropertyName(props: PropertyNameProps): _alloy_js_core15.Children;
 declare type __ΩPropertyNameProps = any[];
 //#endregion
 export { PropertyName, PropertyNameProps, __ΩPropertyNameProps };

package/dist/typescript/components/property-name.d.mts CHANGED Viewed

@@ -1,4 +1,4 @@
-import * as _alloy_js_core18 from "@alloy-js/core";
+import * as _alloy_js_core16 from "@alloy-js/core";
 //#region src/typescript/components/property-name.d.ts
 interface PropertyNameProps {
@@ -17,7 +17,7 @@ interface PropertyNameProps {
  * @remarks
  * If the name is not a valid JavaScript identifier, it will be quoted. If a `name` prop is provided, it will be used as the property name. Otherwise, the name will be taken from the {@link (MemberDeclarationContext:variable)}.
  */
-declare function PropertyName(props: PropertyNameProps): _alloy_js_core18.Children;
+declare function PropertyName(props: PropertyNameProps): _alloy_js_core16.Children;
 declare type __ΩPropertyNameProps = any[];
 //#endregion
 export { PropertyName, PropertyNameProps, __ΩPropertyNameProps };

package/dist/typescript/components/tsdoc-reflection.cjs CHANGED Viewed

@@ -1,30 +1,36 @@
 const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
 const require_core_contexts_reflection = require('../../core/contexts/reflection.cjs');
+const require_core_components_spacing = require('../../core/components/spacing.cjs');
 const require_typescript_components_tsdoc = require('./tsdoc.cjs');
 let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
 let __alloy_js_core = require("@alloy-js/core");
 let __stryke_string_format_title_case = require("@stryke/string-format/title-case");
 let __stryke_type_checks_is_undefined = require("@stryke/type-checks/is-undefined");
+let __powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
 let __stryke_type_checks_is_string = require("@stryke/type-checks/is-string");
 let __stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
 //#region src/typescript/components/tsdoc-reflection.tsx
 /**
-* Generates a TypeScript interface property for the given reflection class.
+* Generates a TSDoc documentation block for the given reflection class. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about properties or methods of a class.
 */
 function TSDocReflectionClass(props) {
-	const [{ children, heading }, rest] = (0, __alloy_js_core.splitProps)(props, ["heading", "children"]);
-	const reflectionClass = require_core_contexts_reflection.useReflectionClass();
-	const title = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.getTitle() || (0, __stryke_string_format_title_case.titleCase)(reflectionClass.reflection.getName()));
-	const computedHeading = (0, __alloy_js_core.computed)(() => heading || reflectionClass.reflection.getDescription() || title.value);
-	const alias = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.getAlias());
-	const domain = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.getDomain());
-	const permission = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.getPermission());
-	const readonly = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.isReadonly());
-	const internal = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.isInternal());
-	const ignore = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.isIgnored());
-	const hidden = (0, __alloy_js_core.computed)(() => reflectionClass.reflection.isHidden());
+	const [{ children, heading, reflection }, rest] = (0, __alloy_js_core.splitProps)(props, [
+		"heading",
+		"children",
+		"reflection"
+	]);
+	const title = (0, __alloy_js_core.computed)(() => reflection.getTitle() || (0, __stryke_string_format_title_case.titleCase)(reflection.getName()));
+	const computedHeading = (0, __alloy_js_core.computed)(() => heading || reflection.getDescription() || title.value);
+	const alias = (0, __alloy_js_core.computed)(() => reflection.getAlias());
+	const domain = (0, __alloy_js_core.computed)(() => reflection.getDomain());
+	const permission = (0, __alloy_js_core.computed)(() => reflection.getPermission());
+	const readonly = (0, __alloy_js_core.computed)(() => reflection.isReadonly());
+	const internal = (0, __alloy_js_core.computed)(() => reflection.isInternal());
+	const ignore = (0, __alloy_js_core.computed)(() => reflection.isIgnored());
+	const hidden = (0, __alloy_js_core.computed)(() => reflection.isHidden());
 	if (!computedHeading.value || (0, __stryke_type_checks_is_set_string.isSetString)(computedHeading.value) && computedHeading.value.trim() === "") return null;
+	const hasAttributes = (0, __alloy_js_core.computed)(() => (0, __stryke_type_checks_is_set_string.isSetString)(title.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(alias.value) && alias.value.length > 0 || !(0, __stryke_type_checks_is_undefined.isUndefined)(permission.value) && permission.value.length > 0 || (0, __stryke_type_checks_is_set_string.isSetString)(domain.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(readonly.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(internal.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(ignore.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(hidden.value));
 	return (0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDoc, (0, __alloy_js_core_jsx_runtime.mergeProps)(rest, {
 		get heading() {
 			return (0, __alloy_js_core_jsx_runtime.memo)(() => !!(0, __stryke_type_checks_is_set_string.isSetString)(computedHeading.value))() ? computedHeading.value.trim() : computedHeading.value;
@@ -32,7 +38,7 @@ function TSDocReflectionClass(props) {
 		get children() {
 			return [(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
 				get when() {
-					return (0, __stryke_type_checks_is_set_string.isSetString)(title.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(alias.value) && alias.value.length > 0 || !(0, __stryke_type_checks_is_undefined.isUndefined)(permission.value) && permission.value.length > 0 || (0, __stryke_type_checks_is_set_string.isSetString)(domain.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(readonly.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(internal.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(ignore.value) || !(0, __stryke_type_checks_is_undefined.isUndefined)(hidden.value);
+					return hasAttributes.value;
 				},
 				get children() {
 					return (0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDocAttributesTags, {
@@ -64,115 +70,212 @@ function TSDocReflectionClass(props) {
 				}
 			}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
 				get when() {
-					return (0, __alloy_js_core_jsx_runtime.memo)(() => !!Boolean(children))() && (0, __alloy_js_core.childrenArray)(() => children).length > 0;
+					return (0, __alloy_js_core_jsx_runtime.memo)(() => !!!(0, __stryke_type_checks_is_undefined.isUndefined)(children))() && (0, __alloy_js_core.childrenArray)(() => children).filter(Boolean).length > 0;
 				},
 				get children() {
-					return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.List, { get children() {
+					return [(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+						get when() {
+							return hasAttributes.value;
+						},
+						get children() {
+							return (0, __alloy_js_core_jsx_runtime.createComponent)(require_core_components_spacing.Spacing, {});
+						}
+					}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.List, { get children() {
 						return (0, __alloy_js_core.childrenArray)(() => children);
-					} });
+					} })];
 				}
 			})];
 		}
 	}));
 }
 /**
-* Generates a TypeScript interface property for the given reflection class.
+* Uses the `useReflectionClass` hook to retrieve the reflection class from the context, and then renders a `TSDocReflectionClass` component with the retrieved reflection class. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection class without having to manually retrieve the reflection class from the context.
+*/
+function TSDocContextClass(props) {
+	const reflectionClass = require_core_contexts_reflection.useReflectionClass();
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocReflectionClass, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { get reflection() {
+		return reflectionClass.reflection;
+	} }));
+}
+/**
+* Generates a TSDoc documentation block for the given reflection property. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about parameters of a method or properties of a class.
 */
 function TSDocReflectionProperty(props) {
-	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
-	const context = require_core_contexts_reflection.useReflectionProperty();
+	const [{ children, reflection }, rest] = (0, __alloy_js_core.splitProps)(props, ["children", "reflection"]);
+	const hasAttributes = (0, __alloy_js_core.computed)(() => (0, __stryke_type_checks_is_set_string.isSetString)(reflection.getTitle()) || !(0, __stryke_type_checks_is_undefined.isUndefined)(reflection.getAlias()) && reflection.getAlias().length > 0 || !(0, __stryke_type_checks_is_undefined.isUndefined)(reflection.getPermission()) && reflection.getPermission().length > 0 || (0, __stryke_type_checks_is_set_string.isSetString)(reflection.getDomain()) || !(0, __stryke_type_checks_is_undefined.isUndefined)(reflection.isReadonly()) || !(0, __stryke_type_checks_is_undefined.isUndefined)(reflection.isInternal()) || !(0, __stryke_type_checks_is_undefined.isUndefined)(reflection.isIgnored()) || !(0, __stryke_type_checks_is_undefined.isUndefined)(reflection.isHidden()) || reflection.hasDefault() && !(0, __stryke_type_checks_is_undefined.isUndefined)(reflection.getDefaultValue()));
 	return (0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDoc, (0, __alloy_js_core_jsx_runtime.mergeProps)({ get heading() {
-		return context.getDescription();
+		return reflection.getDescription();
 	} }, rest, { get children() {
-		return [(0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDocAttributesTags, {
-			type: context,
-			get title() {
-				return context.getTitle();
-			},
-			get alias() {
-				return context.getAlias();
-			},
-			get domain() {
-				return context.getDomain();
-			},
-			get permission() {
-				return context.getPermission();
-			},
-			get readonly() {
-				return context.isReadonly();
-			},
-			get internal() {
-				return context.isInternal();
-			},
-			get ignore() {
-				return context.isIgnored();
-			},
-			get hidden() {
-				return context.isHidden();
+		return [(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return hasAttributes.value;
 			},
-			get defaultValue() {
-				return context.getDefaultValue();
+			get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDocAttributesTags, {
+					type: reflection,
+					get title() {
+						return reflection.getTitle();
+					},
+					get alias() {
+						return reflection.getAlias();
+					},
+					get domain() {
+						return reflection.getDomain();
+					},
+					get permission() {
+						return reflection.getPermission();
+					},
+					get readonly() {
+						return reflection.isReadonly();
+					},
+					get internal() {
+						return reflection.isInternal();
+					},
+					get ignore() {
+						return reflection.isIgnored();
+					},
+					get hidden() {
+						return reflection.isHidden();
+					},
+					get defaultValue() {
+						return reflection.getDefaultValue();
+					}
+				});
 			}
 		}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
 			get when() {
-				return (0, __alloy_js_core_jsx_runtime.memo)(() => !!Boolean(children))() && (0, __alloy_js_core.childrenArray)(() => children).length > 0;
+				return (0, __alloy_js_core_jsx_runtime.memo)(() => !!!(0, __stryke_type_checks_is_undefined.isUndefined)(children))() && (0, __alloy_js_core.childrenArray)(() => children).filter(Boolean).length > 0;
 			},
 			get children() {
-				return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.List, { get children() {
+				return [(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+					get when() {
+						return hasAttributes.value;
+					},
+					get children() {
+						return (0, __alloy_js_core_jsx_runtime.createComponent)(require_core_components_spacing.Spacing, {});
+					}
+				}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.List, { get children() {
 					return (0, __alloy_js_core.childrenArray)(() => children);
-				} });
+				} })];
 			}
 		})];
 	} }));
 }
 /**
-* Generates a TypeScript interface property for the given reflection class.
+* Uses the `useReflectionProperty` hook to retrieve the reflection property from the context, and then renders a `TSDocReflectionProperty` component with the retrieved reflection property. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection property without having to manually retrieve the reflection property from the context.
+*/
+function TSDocContextProperty(props) {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocReflectionProperty, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { reflection: require_core_contexts_reflection.useReflectionProperty() }));
+}
+/**
+* Generates a TSDoc documentation block for the given reflection method. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. Additionally, this component will render information about the parameters and return type of the method, if available.
 */
 function TSDocReflectionMethod(props) {
-	const [{ children }, rest] = (0, __alloy_js_core.splitProps)(props, ["children"]);
-	const context = require_core_contexts_reflection.useReflectionMethod();
+	const [{ children, reflection }, rest] = (0, __alloy_js_core.splitProps)(props, ["children", "reflection"]);
 	return (0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDoc, (0, __alloy_js_core_jsx_runtime.mergeProps)({ get heading() {
-		return context.getDescription() || ((0, __stryke_type_checks_is_string.isString)(context.getName()) ? __alloy_js_core.code`${String(context.getName())} method definition` : void 0);
+		return reflection.getDescription() || ((0, __stryke_type_checks_is_string.isString)(reflection.getName()) ? __alloy_js_core.code`${String(reflection.getName())} method definition` : void 0);
 	} }, rest, { get children() {
-		return [(0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDocAttributesTags, {
-			get title() {
-				return context.getTitle();
-			},
-			get alias() {
-				return context.getAlias();
-			},
-			get domain() {
-				return context.getDomain();
-			},
-			get permission() {
-				return context.getPermission();
-			},
-			get readonly() {
-				return context.isReadonly();
-			},
-			get internal() {
-				return context.isInternal();
-			},
-			get ignore() {
-				return context.isIgnored();
-			},
-			get hidden() {
-				return context.isHidden();
-			}
-		}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-			get when() {
-				return (0, __alloy_js_core_jsx_runtime.memo)(() => !!Boolean(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);
-				} });
-			}
-		})];
+		return [
+			(0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDocAttributesTags, {
+				get title() {
+					return reflection.getTitle();
+				},
+				get alias() {
+					return reflection.getAlias();
+				},
+				get domain() {
+					return reflection.getDomain();
+				},
+				get permission() {
+					return reflection.getPermission();
+				},
+				get readonly() {
+					return reflection.isReadonly();
+				},
+				get internal() {
+					return reflection.isInternal();
+				},
+				get ignore() {
+					return reflection.isIgnored();
+				},
+				get hidden() {
+					return reflection.isHidden();
+				}
+			}),
+			(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+				get when() {
+					return (0, __alloy_js_core_jsx_runtime.memo)(() => !!Boolean(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.createComponent)(__alloy_js_core.Show, {
+				get when() {
+					return reflection.getParameters().length > 0;
+				},
+				get children() {
+					return [(0, __alloy_js_core_jsx_runtime.createComponent)(require_core_components_spacing.Spacing, {}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
+						get each() {
+							return reflection.getParameters();
+						},
+						hardline: true,
+						get ender() {
+							return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {});
+						},
+						children: (param) => (0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDocParam, {
+							get name() {
+								return param.getName();
+							},
+							get optional() {
+								return param.isOptional();
+							},
+							get defaultValue() {
+								return (0, __alloy_js_core_jsx_runtime.memo)(() => !!param.hasDefault())() ? param.getDefaultValue() : void 0;
+							},
+							get children() {
+								return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+									get when() {
+										return Boolean(param.parameter.description);
+									},
+									get fallback() {
+										return __alloy_js_core.code`A parameter to provide a ${param.getName()} value to the function.`;
+									},
+									get children() {
+										return param.parameter.description;
+									}
+								});
+							}
+						})
+					})];
+				}
+			}),
+			(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+				get when() {
+					return reflection.getReturnType().kind !== __powerlines_deepkit_vendor_type.ReflectionKind.void;
+				},
+				get children() {
+					return [(0, __alloy_js_core_jsx_runtime.createComponent)(require_core_components_spacing.Spacing, {}), (0, __alloy_js_core_jsx_runtime.createComponent)(require_typescript_components_tsdoc.TSDocReturns, { get children() {
+						return __alloy_js_core.code`The return value of the function, which is of type ${(0, __powerlines_deepkit_vendor_type.stringifyType)(reflection.getReturnType())}.`;
+					} })];
+				}
+			})
+		];
 	} }));
 }
+/**
+* Uses the `useReflectionMethod` hook to retrieve the reflection method from the context, and then renders a `TSDocReflectionMethod` component with the retrieved reflection method. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection method without having to manually retrieve the reflection method from the context.
+*/
+function TSDocContextMethod(props) {
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(TSDocReflectionMethod, (0, __alloy_js_core_jsx_runtime.mergeProps)(props, { reflection: require_core_contexts_reflection.useReflectionMethod() }));
+}
 //#endregion
+exports.TSDocContextClass = TSDocContextClass;
+exports.TSDocContextMethod = TSDocContextMethod;
+exports.TSDocContextProperty = TSDocContextProperty;
 exports.TSDocReflectionClass = TSDocReflectionClass;
 exports.TSDocReflectionMethod = TSDocReflectionMethod;
 exports.TSDocReflectionProperty = TSDocReflectionProperty;

package/dist/typescript/components/tsdoc-reflection.d.cts CHANGED Viewed

@@ -1,19 +1,44 @@
 import { TSDocProps } from "./tsdoc.cjs";
-import * as _alloy_js_core0 from "@alloy-js/core";
+import * as _alloy_js_core2 from "@alloy-js/core";
+import { ReflectionClass, ReflectionMethod, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
 //#region src/typescript/components/tsdoc-reflection.d.ts
+interface TSDocReflectionClassProps<T extends Record<string, any> = Record<string, any>> extends TSDocProps {
+  reflection: ReflectionClass<T>;
+}
 /**
- * Generates a TypeScript interface property for the given reflection class.
+ * Generates a TSDoc documentation block for the given reflection class. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about properties or methods of a class.
  */
-declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps): _alloy_js_core0.Children;
+declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocReflectionClassProps<T>): _alloy_js_core2.Children;
 /**
- * Generates a TypeScript interface property for the given reflection class.
+ * Uses the `useReflectionClass` hook to retrieve the reflection class from the context, and then renders a `TSDocReflectionClass` component with the retrieved reflection class. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection class without having to manually retrieve the reflection class from the context.
  */
-declare function TSDocReflectionProperty(props: TSDocProps): _alloy_js_core0.Children;
+declare function TSDocContextClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps): _alloy_js_core2.Children;
+interface TSDocReflectionPropertyProps extends TSDocProps {
+  reflection: ReflectionProperty;
+}
 /**
- * Generates a TypeScript interface property for the given reflection class.
+ * Generates a TSDoc documentation block for the given reflection property. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about parameters of a method or properties of a class.
  */
-declare function TSDocReflectionMethod(props: TSDocProps): _alloy_js_core0.Children;
+declare function TSDocReflectionProperty(props: TSDocReflectionPropertyProps): _alloy_js_core2.Children;
+/**
+ * Uses the `useReflectionProperty` hook to retrieve the reflection property from the context, and then renders a `TSDocReflectionProperty` component with the retrieved reflection property. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection property without having to manually retrieve the reflection property from the context.
+ */
+declare function TSDocContextProperty(props: TSDocProps): _alloy_js_core2.Children;
+interface TSDocReflectionMethodProps extends TSDocProps {
+  reflection: ReflectionMethod;
+}
+/**
+ * Generates a TSDoc documentation block for the given reflection method. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. Additionally, this component will render information about the parameters and return type of the method, if available.
+ */
+declare function TSDocReflectionMethod(props: TSDocReflectionMethodProps): _alloy_js_core2.Children;
+/**
+ * Uses the `useReflectionMethod` hook to retrieve the reflection method from the context, and then renders a `TSDocReflectionMethod` component with the retrieved reflection method. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection method without having to manually retrieve the reflection method from the context.
+ */
+declare function TSDocContextMethod(props: TSDocProps): _alloy_js_core2.Children;
+declare type __ΩTSDocReflectionClassProps = any[];
+declare type __ΩTSDocReflectionPropertyProps = any[];
+declare type __ΩTSDocReflectionMethodProps = any[];
 //#endregion
-export { TSDocReflectionClass, TSDocReflectionMethod, TSDocReflectionProperty };
+export { TSDocContextClass, TSDocContextMethod, TSDocContextProperty, TSDocReflectionClass, TSDocReflectionClassProps, TSDocReflectionMethod, TSDocReflectionMethodProps, TSDocReflectionProperty, TSDocReflectionPropertyProps, __ΩTSDocReflectionClassProps, __ΩTSDocReflectionMethodProps, __ΩTSDocReflectionPropertyProps };
 //# sourceMappingURL=tsdoc-reflection.d.cts.map

package/dist/typescript/components/tsdoc-reflection.d.cts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"tsdoc-reflection.d.cts","names":[],"sources":["../../../src/typescript/components/tsdoc-reflection.tsx"],"sourcesContent":[],"mappings":"~~;;;;;;;AAwCgB~~,~~iBAAA~~,~~oBAAoB~~,CAAA,~~UACxB~~,~~MADwB~~,CAAA,MAAA,EAAA,GAAA,CAAA,~~GACF~~,~~MADE~~,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,~~EAE3B~~,~~UAF2B~~,CAAA,~~EAEjB~~,eAAA,~~CAAA~~,~~QAFiB~~;;;;~~AAEjB~~,~~iBAyEH~~,uBAAA,~~CAzEG~~,KAAA,~~EAyE4B~~,~~UAzE5B~~,CAAA,~~EAyEsC~~,eAAA,CAAA,~~QAzEtC;;AAyEnB~~;~~AA8BA~~;~~iBAAgB~~,qBAAA,~~QAA6B~~,aAAU,eAAA,CAAA"}
1	+ {"version":3,"file":"tsdoc-reflection.d.cts","names":[],"sources":["../../../src/typescript/components/tsdoc-reflection.tsx"],"sourcesContent":[],"mappings":";;;;;UAoDiB,oCACL,sBAAsB,6BACxB;cACI,gBAAgB;;AAH9B;;;AAG8B,iBAMd,oBANc,CAAA,UAOlB,MAPkB,CAAA,MAAA,EAAA,GAAA,CAAA,GAOI,MAPJ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAQrB,yBARqB,CAQK,CARL,CAAA,CAAA,EAQI,eAAA,CAAG,QARP;;;;AAMd,iBAgFA,iBAhFoB,CAAA,UAiFxB,MAjFwB,CAAA,MAAA,EAAA,GAAA,CAAA,GAiFF,MAjFE,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,KAAA,EAkF3B,UAlF2B,CAAA,EAkFjB,eAAA,CAAA,QAlFiB;AACxB,UAyFK,4BAAA,SAAqC,UAzF1C,CAAA;EAAsB,UAAA,EA0FpB,kBA1FoB;;;;;AA+ElB,iBAiBA,uBAAA,CAjBiB,KAAA,EAiBc,4BAjBd,CAAA,EAiB0C,eAAA,CAAA,QAjB1C;;;;AAEd,iBAqEH,oBAAA,CArEG,KAAA,EAqEyB,UArEzB,CAAA,EAqEmC,eAAA,CAAA,QArEnC;AAAA,UA2EF,0BAAA,SAAmC,UA3EjC,CAAA;EAQF,UAAA,EAoEH,gBApEG;AAOjB;AAsDA;AAMA;AAOA;AA+DgB,iBA/DA,qBAAA,CA+D0B,KAAU,EA/DP,0BA+DO,CAAA,EA/DmB,eAAA,CAAA,QA+DnB;;;;iBAApC,kBAAA,QAA0B,aAAU,eAAA,CAAA"}

package/dist/typescript/components/tsdoc-reflection.d.mts CHANGED Viewed

@@ -1,19 +1,44 @@
 import { TSDocProps } from "./tsdoc.mjs";
-import * as _alloy_js_core11 from "@alloy-js/core";
+import * as _alloy_js_core10 from "@alloy-js/core";
+import { ReflectionClass, ReflectionMethod, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
 //#region src/typescript/components/tsdoc-reflection.d.ts
+interface TSDocReflectionClassProps<T extends Record<string, any> = Record<string, any>> extends TSDocProps {
+  reflection: ReflectionClass<T>;
+}
 /**
- * Generates a TypeScript interface property for the given reflection class.
+ * Generates a TSDoc documentation block for the given reflection class. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about properties or methods of a class.
  */
-declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps): _alloy_js_core11.Children;
+declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocReflectionClassProps<T>): _alloy_js_core10.Children;
 /**
- * Generates a TypeScript interface property for the given reflection class.
+ * Uses the `useReflectionClass` hook to retrieve the reflection class from the context, and then renders a `TSDocReflectionClass` component with the retrieved reflection class. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection class without having to manually retrieve the reflection class from the context.
  */
-declare function TSDocReflectionProperty(props: TSDocProps): _alloy_js_core11.Children;
+declare function TSDocContextClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps): _alloy_js_core10.Children;
+interface TSDocReflectionPropertyProps extends TSDocProps {
+  reflection: ReflectionProperty;
+}
 /**
- * Generates a TypeScript interface property for the given reflection class.
+ * Generates a TSDoc documentation block for the given reflection property. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. This is useful for rendering additional details about the reflection that may not be included in the description, such as information about parameters of a method or properties of a class.
  */
-declare function TSDocReflectionMethod(props: TSDocProps): _alloy_js_core11.Children;
+declare function TSDocReflectionProperty(props: TSDocReflectionPropertyProps): _alloy_js_core10.Children;
+/**
+ * Uses the `useReflectionProperty` hook to retrieve the reflection property from the context, and then renders a `TSDocReflectionProperty` component with the retrieved reflection property. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection property without having to manually retrieve the reflection property from the context.
+ */
+declare function TSDocContextProperty(props: TSDocProps): _alloy_js_core10.Children;
+interface TSDocReflectionMethodProps extends TSDocProps {
+  reflection: ReflectionMethod;
+}
+/**
+ * Generates a TSDoc documentation block for the given reflection method. This component will render the description of the reflection as the main content of the documentation block, and will render any additional attributes (such as title, alias, domain, permission, etc.) as tags in the documentation block. If there are child elements provided, they will be rendered as a list below the main content of the documentation block. Additionally, this component will render information about the parameters and return type of the method, if available.
+ */
+declare function TSDocReflectionMethod(props: TSDocReflectionMethodProps): _alloy_js_core10.Children;
+/**
+ * Uses the `useReflectionMethod` hook to retrieve the reflection method from the context, and then renders a `TSDocReflectionMethod` component with the retrieved reflection method. This is a convenience component that allows you to easily render a TSDoc documentation block for the current reflection method without having to manually retrieve the reflection method from the context.
+ */
+declare function TSDocContextMethod(props: TSDocProps): _alloy_js_core10.Children;
+declare type __ΩTSDocReflectionClassProps = any[];
+declare type __ΩTSDocReflectionPropertyProps = any[];
+declare type __ΩTSDocReflectionMethodProps = any[];
 //#endregion
-export { TSDocReflectionClass, TSDocReflectionMethod, TSDocReflectionProperty };
+export { TSDocContextClass, TSDocContextMethod, TSDocContextProperty, TSDocReflectionClass, TSDocReflectionClassProps, TSDocReflectionMethod, TSDocReflectionMethodProps, TSDocReflectionProperty, TSDocReflectionPropertyProps, __ΩTSDocReflectionClassProps, __ΩTSDocReflectionMethodProps, __ΩTSDocReflectionPropertyProps };
 //# sourceMappingURL=tsdoc-reflection.d.mts.map