@alloy-js/csharp 0.17.0 → 0.18.0-dev.10

package/dist/src/components/ClassDeclaration.d.ts

@@ -0,0 +1,57 @@
+import * as core from "@alloy-js/core";
+import { AccessModifiers } from "../modifiers.js";
+import { ParameterProps } from "./Parameters.jsx";
+export interface ClassModifiers {
+    readonly abstract?: boolean;
+    readonly partial?: boolean;
+    readonly sealed?: boolean;
+    readonly static?: boolean;
+}
+export interface ClassDeclarationProps extends Omit<core.DeclarationProps, "nameKind">, AccessModifiers, ClassModifiers {
+    name: string;
+    /** Doc comment */
+    doc?: core.Children;
+    refkey?: core.Refkey;
+    typeParameters?: Record<string, core.Refkey>;
+}
+/**
+ * CSharp class declaration.
+ * @example
+ * ```tsx
+ * <ClassDeclaration public name="MyClass">
+ *   <ClassMember public name="MyField" type="int" />
+ *   <ClassConstructor>
+ *     <Parameter name="value" type="int" />
+ *     this.MyField = value;
+ *   </ClassConstructor>
+ * </ClassDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public class MyClass
+ * {
+ *   public int MyField;
+ *   public MyClass(int value)
+ *   {
+ *     this.MyField = value;
+ *   }
+ * }
+ * ```
+ */
+export declare function ClassDeclaration(props: ClassDeclarationProps): core.Children;
+export interface ClassConstructorProps extends AccessModifiers {
+    parameters?: Array<ParameterProps>;
+    refkey?: core.Refkey;
+    symbol?: core.OutputSymbol;
+    children?: core.Children;
+}
+export declare function ClassConstructor(props: ClassConstructorProps): core.Children;
+export interface ClassMemberProps extends AccessModifiers {
+    name: string;
+    type: core.Children;
+    refkey?: core.Refkey;
+    /** Doc comment */
+    doc?: core.Children;
+}
+export declare function ClassMember(props: ClassMemberProps): core.Children;
+//# sourceMappingURL=ClassDeclaration.d.ts.map

package/dist/src/components/ClassDeclaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassDeclaration.d.ts","sourceRoot":"","sources":["../../../src/components/ClassDeclaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,iBAAiB,CAAC;AAKzB,OAAO,EAAE,cAAc,EAAc,MAAM,kBAAkB,CAAC;AAG9D,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B;AAUD,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,cAAc;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,iBAyD5D;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IAC3B,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;CAC1B;AAGD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,iBAkC5D;AAGD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,kBAAkB;IAClB,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;CACrB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,iBA0BlD"}

package/dist/src/components/{Class.js → ClassDeclaration.js}

@@ -1,16 +1,41 @@
 import { createComponent as _$createComponent, createIntrinsic as _$createIntrinsic, memo as _$memo } from "@alloy-js/core/jsx-runtime";
 import * as core from "@alloy-js/core";
-import { getAccessModifier, getMethodModifier } from "../modifiers.js";
+import { computeModifiersPrefix, getAccessModifier, makeModifiers } from "../modifiers.js";
 import { useCSharpNamePolicy } from "../name-policy.js";
 import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
 import { Name } from "./Name.js";
 import { Parameters } from "./Parameters.js";
+import { DocWhen } from "./doc/comment.js";
+const getClassModifiers = makeModifiers(["abstract", "partial", "sealed", "static"]);
 
 // properties for creating a class
 
-// a C# class declaration
-export function Class(props) {
+/**
+ * CSharp class declaration.
+ * @example
+ * ```tsx
+ * <ClassDeclaration public name="MyClass">
+ *   <ClassMember public name="MyField" type="int" />
+ *   <ClassConstructor>
+ *     <Parameter name="value" type="int" />
+ *     this.MyField = value;
+ *   </ClassConstructor>
+ * </ClassDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public class MyClass
+ * {
+ *   public int MyField;
+ *   public MyClass(int value)
+ *   {
+ *     this.MyField = value;
+ *   }
+ * }
+ * ```
+ */
+export function ClassDeclaration(props) {
   const name = useCSharpNamePolicy().getName(props.name, "class");
   const thisClassSymbol = new CSharpOutputSymbol(name, {
     refkeys: props.refkey
@@ -46,10 +71,15 @@ export function Class(props) {
       }
     });
   }
+  const modifiers = computeModifiersPrefix([getAccessModifier(props), getClassModifiers(props)]);
   return _$createComponent(core.Declaration, {
     symbol: thisClassSymbol,
     get children() {
-      return [_$memo(() => getAccessModifier(props.accessModifier)), "class ", _$createComponent(Name, {}), typeParams, _$memo(() => !props.children && ";"), _$memo(() => _$memo(() => !!props.children)() && _$createComponent(core.Block, {
+      return [_$createComponent(DocWhen, {
+        get doc() {
+          return props.doc;
+        }
+      }), modifiers, "class ", _$createComponent(Name, {}), typeParams, _$memo(() => !props.children && ";"), _$memo(() => _$memo(() => !!props.children)() && _$createComponent(core.Block, {
         newline: true,
         get children() {
           return _$createComponent(core.Scope, {
@@ -81,7 +111,7 @@ export function ClassConstructor(props) {
   const ctorDeclScope = new CSharpMemberScope("constructor-decl", {
     owner: ctorSymbol
   });
-  const accessModifier = getAccessModifier(props.accessModifier);
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
   const params = props.parameters ? _$createComponent(Parameters, {
     get parameters() {
       return props.parameters;
@@ -95,7 +125,7 @@ export function ClassConstructor(props) {
       return _$createComponent(core.Scope, {
         value: ctorDeclScope,
         get children() {
-          return [accessModifier, _$createComponent(Name, {}), "(", params, ")", _$createComponent(core.Block, {
+          return [modifiers, _$createComponent(Name, {}), "(", params, ")", _$createComponent(core.Block, {
             newline: true,
             get children() {
               return props.children;
@@ -112,7 +142,7 @@ export function ClassConstructor(props) {
 // a C# class member (i.e. a field within a class like "private int count")
 export function ClassMember(props) {
   let nameElement = "class-member-private";
-  if (props.accessModifier === "public") {
+  if (props.public) {
     nameElement = "class-member-public";
   }
   const name = useCSharpNamePolicy().getName(props.name, nameElement);
@@ -124,56 +154,15 @@ export function ClassMember(props) {
     scope,
     refkeys: props.refkey ?? core.refkey(props.name)
   });
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
   return _$createComponent(core.Declaration, {
     symbol: memberSymbol,
     get children() {
-      return [_$memo(() => getAccessModifier(props.accessModifier)), _$memo(() => props.type), " ", _$createComponent(Name, {})];
-    }
-  });
-}
-
-// properties for creating a method
-
-// a C# class method
-export function ClassMethod(props) {
-  const name = useCSharpNamePolicy().getName(props.name, "class-method");
-  const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "class-decl") {
-    throw new Error("can't define a class method outside of a class scope");
-  }
-  const methodSymbol = new CSharpOutputSymbol(name, {
-    scope,
-    refkeys: props.refkey ?? core.refkey(props.name)
-  });
-
-  // scope for method declaration
-  const methodScope = new CSharpMemberScope("method-decl", {
-    owner: methodSymbol
-  });
-  const accessModifier = getAccessModifier(props.accessModifier);
-  const methodModifier = getMethodModifier(props.methodModifier);
-  const params = props.parameters ? _$createComponent(Parameters, {
-    get parameters() {
-      return props.parameters;
-    }
-  }) : "";
-  const returns = props.returns ?? "void";
-
-  // note that scope wraps the method decl so that the params get the correct scope
-  return _$createComponent(core.Declaration, {
-    symbol: methodSymbol,
-    get children() {
-      return _$createComponent(core.Scope, {
-        value: methodScope,
-        get children() {
-          return [accessModifier, methodModifier, returns, " ", _$createComponent(Name, {}), "(", params, ")", _$createComponent(core.Block, {
-            newline: true,
-            get children() {
-              return props.children;
-            }
-          })];
+      return [_$createComponent(DocWhen, {
+        get doc() {
+          return props.doc;
         }
-      });
+      }), modifiers, _$memo(() => props.type), " ", _$createComponent(Name, {})];
     }
   });
 }

package/dist/src/components/ClassMethod.d.ts

@@ -0,0 +1,25 @@
+import { Children, Refkey } from "@alloy-js/core";
+import { AccessModifiers } from "../modifiers.js";
+import { ParameterProps } from "./Parameters.jsx";
+/** Method modifiers. Can only be one. */
+export interface ClassMethodModifiers {
+    readonly abstract?: boolean;
+    readonly sealed?: boolean;
+    readonly static?: boolean;
+    readonly virtual?: boolean;
+}
+export interface ClassMethodProps extends AccessModifiers, ClassMethodModifiers {
+    name: string;
+    refkey?: Refkey;
+    children?: Children;
+    parameters?: Array<ParameterProps>;
+    returns?: Children;
+    /**
+     * If true, the method will be declared as an async method.
+     */
+    async?: boolean;
+    /** Doc comment */
+    doc?: Children;
+}
+export declare function ClassMethod(props: ClassMethodProps): Children;
+//# sourceMappingURL=ClassMethod.d.ts.map

package/dist/src/components/ClassMethod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassMethod.d.ts","sourceRoot":"","sources":["../../../src/components/ClassMethod.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAGR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAKhB,MAAM,iBAAiB,CAAC;AAIzB,OAAO,EAAE,cAAc,EAAc,MAAM,kBAAkB,CAAC;AAG9D,yCAAyC;AACzC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAUD,MAAM,WAAW,gBACf,SAAQ,eAAe,EACrB,oBAAoB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,kBAAkB;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;CAChB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,YAqClD"}

package/dist/src/components/ClassMethod.js

@@ -0,0 +1,60 @@
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { Block, MemberDeclaration, refkey, Scope } from "@alloy-js/core";
+import { computeModifiersPrefix, getAccessModifier, getAsyncModifier, makeModifiers } from "../modifiers.js";
+import { useCSharpNamePolicy } from "../name-policy.js";
+import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
+import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
+import { Parameters } from "./Parameters.js";
+import { DocWhen } from "./doc/comment.js";
+
+/** Method modifiers. Can only be one. */
+
+const getMethodModifier = makeModifiers(["abstract", "sealed", "static", "virtual"]);
+
+// properties for creating a method
+
+// a C# class method
+export function ClassMethod(props) {
+  const name = useCSharpNamePolicy().getName(props.name, "class-method");
+  const scope = useCSharpScope();
+  if (scope.kind !== "member" || scope.name !== "class-decl") {
+    throw new Error("can't define a class method outside of a class scope");
+  }
+  const methodSymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name)
+  });
+
+  // scope for method declaration
+  const methodScope = new CSharpMemberScope("method-decl", {
+    owner: methodSymbol
+  });
+  const params = props.parameters ? _$createComponent(Parameters, {
+    get parameters() {
+      return props.parameters;
+    }
+  }) : "";
+  const returns = props.returns ?? (props.async ? "Task" : "void");
+  const modifiers = computeModifiersPrefix([getAccessModifier(props), getMethodModifier(props), getAsyncModifier(props.async)]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return _$createComponent(MemberDeclaration, {
+    symbol: methodSymbol,
+    get children() {
+      return _$createComponent(Scope, {
+        value: methodScope,
+        get children() {
+          return [_$createComponent(DocWhen, {
+            get doc() {
+              return props.doc;
+            }
+          }), modifiers, returns, " ", name, "(", params, ")", _$memo(() => _$memo(() => !!props.abstract)() ? ";" : _$createComponent(Block, {
+            newline: true,
+            get children() {
+              return props.children;
+            }
+          }))];
+        }
+      });
+    }
+  });
+}

package/dist/src/components/EnumDeclaration.d.ts

@@ -0,0 +1,34 @@
+import * as core from "@alloy-js/core";
+import { AccessModifiers } from "../modifiers.js";
+export interface EnumDeclarationProps extends AccessModifiers {
+    name: string;
+    refkey?: core.Refkey;
+    children?: core.Children;
+}
+/**
+ * A C# enum declaration
+ * @example
+ * ```tsx
+ * <EnumDeclaration public name="Color">
+ *   <EnumMember name="Red" />
+ *   <EnumMember name="Green" />
+ *   <EnumMember name="Blue" />
+ * </EnumDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public enum Color
+ * {
+ *   Red,
+ *   Green,
+ *   Blue
+ * }
+ * ```
+ */
+export declare function EnumDeclaration(props: EnumDeclarationProps): core.Children;
+export interface EnumMemberProps {
+    name: string;
+    refkey?: core.Refkey;
+}
+export declare function EnumMember(props: EnumMemberProps): core.Children;
+//# sourceMappingURL=EnumDeclaration.d.ts.map

package/dist/src/components/EnumDeclaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnumDeclaration.d.ts","sourceRoot":"","sources":["../../../src/components/EnumDeclaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAGhB,MAAM,iBAAiB,CAAC;AAOzB,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,iBAgC1D;AAGD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;CACtB;AAGD,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,iBAmBhD"}

package/dist/src/components/{Enum.js → EnumDeclaration.js}

@@ -1,6 +1,6 @@
-import { memo as _$memo, createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
 import * as core from "@alloy-js/core";
-import { getAccessModifier } from "../modifiers.js";
+import { computeModifiersPrefix, getAccessModifier } from "../modifiers.js";
 import { useCSharpNamePolicy } from "../name-policy.js";
 import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
@@ -8,8 +8,27 @@ import { Name } from "./Name.js";
 
 // properties for creating an enum
 
-// a C# enum declaration
-export function Enum(props) {
+/**
+ * A C# enum declaration
+ * @example
+ * ```tsx
+ * <EnumDeclaration public name="Color">
+ *   <EnumMember name="Red" />
+ *   <EnumMember name="Green" />
+ *   <EnumMember name="Blue" />
+ * </EnumDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public enum Color
+ * {
+ *   Red,
+ *   Green,
+ *   Blue
+ * }
+ * ```
+ */
+export function EnumDeclaration(props) {
   const name = useCSharpNamePolicy().getName(props.name, "enum");
   const scope = useCSharpScope();
   const thisEnumSymbol = new CSharpOutputSymbol(name, {
@@ -25,10 +44,11 @@ export function Enum(props) {
     parent: scope,
     owner: thisEnumSymbol
   });
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
   if (thisEnumScope.owner) return _$createComponent(core.Declaration, {
     symbol: thisEnumSymbol,
     get children() {
-      return [_$memo(() => getAccessModifier(props.accessModifier)), "enum ", _$createComponent(Name, {}), _$memo(() => !props.children && ";"), _$memo(() => _$memo(() => !!props.children)() && _$createComponent(core.Scope, {
+      return [modifiers, "enum ", _$createComponent(Name, {}), _$memo(() => !props.children && ";"), _$memo(() => _$memo(() => !!props.children)() && _$createComponent(core.Scope, {
         value: thisEnumScope,
         get children() {
           return _$createComponent(core.Block, {

package/dist/src/components/doc/comment.d.ts

@@ -0,0 +1,70 @@
+import { Children } from "@alloy-js/core";
+export interface DocCommentProps {
+    children: Children;
+}
+export declare function DocComment(props: DocCommentProps): Children;
+export interface DocWhenProps {
+    doc: Children | undefined;
+}
+/** Conditionally render the given doc in a <DocComment /> component and tail with a line */
+export declare function DocWhen(props: DocWhenProps): Children;
+export interface DocCommentTagProps {
+    children: Children;
+}
+export declare function makeDocCommentTag(name: string): (props: DocCommentProps) => Children;
+export declare function makeInlineDocCommentTag(name: string): (props: DocCommentProps) => string;
+export declare const DocSummary: (props: DocCommentProps) => Children;
+export declare const DocCode: (props: DocCommentProps) => Children;
+export declare const DocC: (props: DocCommentProps) => string;
+export declare const DocExample: (props: DocCommentProps) => Children;
+export declare const DocException: (props: DocCommentProps) => Children;
+export interface DocIncludeProps {
+    /**  is the file name of an external XML file. The file name is interpreted relative to the file that contains the include tag. */
+    file: string;
+    /** is an XPath expression that selects some of the XML in the external XML file. */
+    path?: string;
+}
+export declare const DocInclude: (props: DocIncludeProps) => string;
+export interface DocParamProps {
+    name: string;
+    children: Children;
+}
+export declare const DocParam: (props: DocParamProps) => Children;
+export interface DocTypeParamProps {
+    name: string;
+    children: Children;
+}
+export declare const DocTypeParam: (props: DocTypeParamProps) => Children;
+export declare const DocReturns: (props: DocCommentProps) => Children;
+export declare const DocRemarks: (props: DocCommentProps) => Children;
+export declare const DocValue: (props: DocCommentProps) => Children;
+export declare const DocPermission: (props: DocCommentProps) => Children;
+export declare const DocDescription: (props: DocCommentProps) => Children;
+export declare const DocPara: (props: DocCommentProps) => Children;
+export interface DocSeeProps {
+    cref?: string;
+    href?: string;
+    langword?: string;
+    children?: Children;
+}
+export declare const DocSee: (props: DocSeeProps) => Children;
+export interface DocSeeAlsoProps {
+    cref?: string;
+    href?: string;
+    children?: Children;
+}
+export declare const DocSeeAlso: (props: DocSeeAlsoProps) => Children;
+export interface DocParamRefProps {
+    name: string;
+}
+export declare const DocParamRef: (props: DocParamRefProps) => string;
+export interface DocTypeParamRefProps {
+    name: string;
+}
+export declare const DocTypeParamRef: (props: DocTypeParamRefProps) => string;
+export interface DocListProps {
+    type?: "bullet" | "number";
+    items: Children[];
+}
+export declare function DocList(props: DocListProps): Children;
+//# sourceMappingURL=comment.d.ts.map

package/dist/src/components/doc/comment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../../../../src/components/doc/comment.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAwC,MAAM,gBAAgB,CAAC;AAEhF,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,YAShD;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC3B;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,YAO1C;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,IACd,OAAO,eAAe,cAUrD;AACD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,IACpB,OAAO,eAAe,YAGrD;AAED,eAAO,MAAM,UAAU,UAjBgB,eAAe,aAiBA,CAAC;AACvD,eAAO,MAAM,OAAO,UAlBmB,eAAe,aAkBN,CAAC;AACjD,eAAO,MAAM,IAAI,UAPsB,eAAe,WAON,CAAC;AACjD,eAAO,MAAM,UAAU,UApBgB,eAAe,aAoBA,CAAC;AACvD,eAAO,MAAM,YAAY,UArBc,eAAe,aAqBI,CAAC;AAE3D,MAAM,WAAW,eAAe;IAC9B,kIAAkI;IAClI,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,eAAO,MAAM,UAAU,GAAI,OAAO,eAAe,WAEhD,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;CACpB;AACD,eAAO,MAAM,QAAQ,GAAI,OAAO,aAAa,aACgB,CAAC;AAE9D,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;CACpB;AACD,eAAO,MAAM,YAAY,GAAI,OAAO,iBAAiB,aACgB,CAAC;AAEtE,eAAO,MAAM,UAAU,UA/CgB,eAAe,aA+CA,CAAC;AACvD,eAAO,MAAM,UAAU,UAhDgB,eAAe,aAgDA,CAAC;AACvD,eAAO,MAAM,QAAQ,UAjDkB,eAAe,aAiDJ,CAAC;AACnD,eAAO,MAAM,aAAa,UAlDa,eAAe,aAkDM,CAAC;AAC7D,eAAO,MAAM,cAAc,UAnDY,eAAe,aAmDQ,CAAC;AAC/D,eAAO,MAAM,OAAO,UApDmB,eAAe,aAoDN,CAAC;AAEjD,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AACD,eAAO,MAAM,MAAM,GAAI,OAAO,WAAW,aASxC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AACD,eAAO,MAAM,UAAU,GAAI,OAAO,eAAe,aAQhD,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AACD,eAAO,MAAM,WAAW,GAAI,OAAO,gBAAgB,WACd,CAAC;AAEtC,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;CACd;AACD,eAAO,MAAM,eAAe,GAAI,OAAO,oBAAoB,WAClB,CAAC;AAE1C,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AACD,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,YAa1C"}

package/dist/src/components/doc/comment.js

@@ -0,0 +1,88 @@
+import { createComponent as _$createComponent, createIntrinsic as _$createIntrinsic, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { code, For, Indent, List, Prose, Show } from "@alloy-js/core";
+export function DocComment(props) {
+  return ["/// ", _$createIntrinsic("align", {
+    string: "/// ",
+    get children() {
+      return _$createComponent(List, {
+        get children() {
+          return props.children;
+        }
+      });
+    }
+  })];
+}
+/** Conditionally render the given doc in a <DocComment /> component and tail with a line */
+export function DocWhen(props) {
+  return _$createComponent(Show, {
+    get when() {
+      return Boolean(props.doc);
+    },
+    get children() {
+      return [_$createComponent(DocComment, {
+        get children() {
+          return props.doc;
+        }
+      }), _$createIntrinsic("hbr", {})];
+    }
+  });
+}
+export function makeDocCommentTag(name) {
+  return function DocCommentTag(props) {
+    return _$createComponent(Prose, {
+      get children() {
+        return code`
+        <${name}>
+        ${props.children}
+        </${name}>`;
+      }
+    });
+  };
+}
+export function makeInlineDocCommentTag(name) {
+  return function DocCommentTag(props) {
+    return `<${name}>${props.children}</${name}>`;
+  };
+}
+export const DocSummary = makeDocCommentTag("summary");
+export const DocCode = makeDocCommentTag("code");
+export const DocC = makeInlineDocCommentTag("c");
+export const DocExample = makeDocCommentTag("example");
+export const DocException = makeDocCommentTag("exception");
+export const DocInclude = props => {
+  return `<include file="${props.file}" path="${props.path}" />`;
+};
+export const DocParam = props => code`<param name="${props.name}">${props.children}</param>`;
+export const DocTypeParam = props => code`<typeparam name="${props.name}">${props.children}</typeparam>`;
+export const DocReturns = makeDocCommentTag("returns");
+export const DocRemarks = makeDocCommentTag("remarks");
+export const DocValue = makeDocCommentTag("value");
+export const DocPermission = makeDocCommentTag("permission");
+export const DocDescription = makeDocCommentTag("description");
+export const DocPara = makeDocCommentTag("para");
+export const DocSee = props => {
+  const attributes = [props.cref ? `cref="${props.cref}"` : undefined, props.href ? `href="${props.href}"` : undefined, props.langword ? `langword="${props.langword}"` : undefined].filter(Boolean).join(" ");
+  return code`<see ${attributes}${props.children ? code`>${props.children}</see>` : " />"}`;
+};
+export const DocSeeAlso = props => {
+  const attributes = [props.cref ? `cref="${props.cref}"` : undefined, props.href ? `href="${props.href}"` : undefined].filter(Boolean).join(" ");
+  return code`<seealso ${attributes}${props.children ? code`>${props.children}</seealso>` : " />"}`;
+};
+export const DocParamRef = props => `<paramref name="${props.name}" />`;
+export const DocTypeParamRef = props => `<typeparamref name="${props.name}" />`;
+export function DocList(props) {
+  return _$createComponent(Prose, {
+    get children() {
+      return [_$memo(() => `<list type="${props.type ?? "bullet"}">`), _$createComponent(Indent, {
+        get children() {
+          return _$createComponent(For, {
+            get each() {
+              return props.items;
+            },
+            children: item => code`<item><description>${item}</description></item>`
+          });
+        }
+      }), _$createIntrinsic("hbr", {}), `</list>`];
+    }
+  });
+}

package/dist/src/components/doc/comment.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=comment.test.d.ts.map

package/dist/src/components/doc/comment.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.test.d.ts","sourceRoot":"","sources":["../../../../src/components/doc/comment.test.tsx"],"names":[],"mappings":""}