@alloy-js/csharp 0.18.0-dev.12 → 0.18.0-dev.14

package/src/components/interface/method.test.tsx

@@ -103,6 +103,58 @@ it("defines params and return type", () => {
   `);
 });
 
+it("defines optional param", () => {
+  const res = (
+    <Wrapper>
+      <InterfaceMethod
+        public
+        name="MethodOne"
+        parameters={[
+          {
+            name: "intParam",
+            type: "int",
+            optional: true,
+          },
+        ]}
+        returns="string"
+      />
+    </Wrapper>
+  );
+
+  expect(res).toRenderTo(`
+    public interface TestInterface
+    {
+      public string MethodOne(int? intParam);
+    }
+  `);
+});
+
+it("defines optional param with default", () => {
+  const res = (
+    <Wrapper>
+      <InterfaceMethod
+        public
+        name="MethodOne"
+        parameters={[
+          {
+            name: "intParam",
+            type: "int",
+            default: 12,
+          },
+        ]}
+        returns="string"
+      />
+    </Wrapper>
+  );
+
+  expect(res).toRenderTo(`
+    public interface TestInterface
+    {
+      public string MethodOne(int intParam = 12);
+    }
+  `);
+});
+
 it("specify doc comment", () => {
   expect(
     <TestNamespace>

package/src/components/record/declaration.test.tsx

@@ -0,0 +1,73 @@
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { ClassProperty } from "../class/property.jsx";
+import { RecordDeclaration } from "./declaration.jsx";
+
+it("declares class with no members", () => {
+  expect(
+    <TestNamespace>
+      <RecordDeclaration name="TestRecord" />
+    </TestNamespace>,
+  ).toRenderTo(`
+      record TestRecord;
+  `);
+});
+
+describe("modifiers", () => {
+  it.each(["public", "private", "internal"])("%s", (mod) => {
+    expect(
+      <TestNamespace>
+        <RecordDeclaration {...{ [mod]: true }} name="TestRecord" />
+      </TestNamespace>,
+    ).toRenderTo(`
+        ${mod} record TestRecord;
+    `);
+  });
+
+  it.each(["partial"])("%s", (mod) => {
+    expect(
+      <TestNamespace>
+        <RecordDeclaration {...{ [mod]: true }} name="TestRecord" />
+      </TestNamespace>,
+    ).toRenderTo(`
+        ${mod} record TestRecord;
+    `);
+  });
+
+  it("combines modifiers", () => {
+    expect(
+      <TestNamespace>
+        <RecordDeclaration public partial name="TestRecord" />
+      </TestNamespace>,
+    ).toRenderTo(`
+        public partial record TestRecord;
+    `);
+  });
+});
+
+it("specify doc comment", () => {
+  expect(
+    <TestNamespace>
+      <RecordDeclaration name="TestRecord" doc="This is a test" />
+    </TestNamespace>,
+  ).toRenderTo(`
+    /// This is a test
+    record TestRecord;
+  `);
+});
+
+it("specify class property inside", () => {
+  expect(
+    <TestNamespace>
+      <RecordDeclaration name="TestRecord" doc="This is a test">
+        <ClassProperty name="Prop" get set type="string" />
+      </RecordDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    /// This is a test
+    record TestRecord
+    {
+      string Prop { get; set; }
+    }
+  `);
+});

package/src/components/record/declaration.tsx

@@ -0,0 +1,109 @@
+import * as core from "@alloy-js/core";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+  makeModifiers,
+} from "../../modifiers.js";
+import { useCSharpNamePolicy } from "../../name-policy.js";
+import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
+import { CSharpMemberScope } from "../../symbols/scopes.js";
+import { DocWhen } from "../doc/comment.jsx";
+import { Name } from "../Name.jsx";
+
+export interface RecordModifiers {
+  readonly partial?: boolean;
+}
+
+const getRecordModifiers = makeModifiers<RecordModifiers>(["partial"]);
+
+// properties for creating a class
+export interface RecordDeclarationProps
+  extends Omit<core.DeclarationProps, "nameKind">,
+    AccessModifiers,
+    RecordModifiers {
+  name: string;
+
+  /** Doc comment */
+  doc?: core.Children;
+  refkey?: core.Refkey;
+  typeParameters?: Record<string, core.Refkey>;
+}
+
+/**
+ * CSharp record declaration.
+ * @example
+ * ```tsx
+ * <RecordDeclaration public name="IMyRecord">
+ *   <RecordMember public name="MyProperty" type="int" />
+ *   <RecordMethod public name="MyMethod" returnType="void">
+ *     <Parameter name="value" type="int" />
+ *   </RecordMethod>
+ * </RecordDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public record MyIface
+ * {
+ *   public int MyProperty { get; set; }
+ *   public void MyMethod(int value);
+ * }
+ * ```
+ */
+export function RecordDeclaration(props: RecordDeclarationProps) {
+  const name = useCSharpNamePolicy().getName(props.name!, "record");
+
+  const thisRecordSymbol = new CSharpOutputSymbol(name, {
+    refkeys: props.refkey,
+  });
+
+  // this creates a new scope for the record definition.
+  // members will automatically "inherit" this scope so
+  // that refkeys to them will produce the fully-qualified
+  // name e.g. Foo.Bar.
+  const thisRecordScope = new CSharpMemberScope("record-decl", {
+    owner: thisRecordSymbol,
+  });
+
+  let typeParams: core.Children;
+  if (props.typeParameters) {
+    const typeParamNames = new Array<string>();
+    for (const entry of Object.entries(props.typeParameters)) {
+      typeParamNames.push(
+        useCSharpNamePolicy().getName(entry[0], "type-parameter"),
+      );
+      // create a symbol for each type param so its
+      // refkey resolves to the type param's name
+      new CSharpOutputSymbol(entry[0], {
+        scope: thisRecordScope,
+        refkeys: entry[1],
+      });
+    }
+    typeParams = (
+      <group>
+        {"<"}
+        <core.For each={typeParamNames} comma line>
+          {(name) => name}
+        </core.For>
+        {">"}
+      </group>
+    );
+  }
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getRecordModifiers(props),
+  ]);
+  return (
+    <core.Declaration symbol={thisRecordSymbol}>
+      <DocWhen doc={props.doc} />
+      {modifiers}record <Name />
+      {typeParams}
+      {props.children ?
+        <core.Block newline>
+          <core.Scope value={thisRecordScope}>{props.children}</core.Scope>
+        </core.Block>
+      : ";"}
+    </core.Declaration>
+  );
+}

package/src/name-policy.ts

@@ -9,6 +9,7 @@ export type CSharpElements =
   | "enum-member"
   | "function"
   | "interface"
+  | "record"
   | "class-member-private"
   | "class-member-public"
   | "class-method"
@@ -24,6 +25,7 @@ export function createCSharpNamePolicy(): core.NamePolicy<CSharpElements> {
       case "enum":
       case "enum-member":
       case "interface":
+      case "record":
       case "class-member-public":
       case "class-method":
       case "type-parameter":

package/temp/api.json

@@ -2221,7 +2221,7 @@
             },
             {
               "kind": "Content",
-              "text": "\"class\" | \"constant\" | \"enum\" | \"enum-member\" | \"function\" | \"interface\" | \"class-member-private\" | \"class-member-public\" | \"class-method\" | \"class-property\" | \"parameter\" | \"type-parameter\""
+              "text": "\"class\" | \"constant\" | \"enum\" | \"enum-member\" | \"function\" | \"interface\" | \"record\" | \"class-member-private\" | \"class-member-public\" | \"class-method\" | \"class-property\" | \"parameter\" | \"type-parameter\""
             },
             {
               "kind": "Content",
@@ -6189,7 +6189,7 @@
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/csharp!Parameter:function(1)",
-          "docComment": "",
+          "docComment": "/**\n * Define a parameter to be used in class or interface method.\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -6248,6 +6248,34 @@
           "name": "ParameterProps",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!ParameterProps#default:member",
+              "docComment": "/**\n * Default value for the parameter\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "default?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "core.Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "default",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!ParameterProps#name:member",
@@ -6275,6 +6303,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!ParameterProps#optional:member",
+              "docComment": "/**\n * If the parmaeter is optional(without default value)\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "optional?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "optional",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!ParameterProps#refkey:member",
@@ -6433,15 +6488,6 @@
                   "kind": "Content",
                   "text": "parameters: "
                 },
-                {
-                  "kind": "Reference",
-                  "text": "Array",
-                  "canonicalReference": "!Array:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
                 {
                   "kind": "Reference",
                   "text": "ParameterProps",
@@ -6449,7 +6495,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ">"
+                  "text": "[]"
                 },
                 {
                   "kind": "Content",
@@ -6462,7 +6508,7 @@
               "name": "parameters",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 5
+                "endIndex": 3
               }
             }
           ],