@alloy-js/csharp 0.20.0-dev.2 → 0.20.0-dev.3

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

@@ -70,6 +70,24 @@ describe("modifiers", () => {
         public abstract partial class TestClass;
     `);
   });
+
+  it("places visibility, attributes, and modifiers in the correct order", () => {
+    expect(
+      <TestNamespace>
+        <ClassDeclaration
+          partial
+          public
+          abstract
+          sealed
+          name="TestClass"
+          attributes={[<Attribute name="Test" />]}
+        />
+      </TestNamespace>,
+    ).toRenderTo(`
+        [Test]
+        public abstract sealed partial class TestClass;
+    `);
+  });
 });
 
 describe("base", () => {
@@ -308,7 +326,7 @@ it("declares class with invalid members", () => {
   );
 
   expect(() => toSourceText(decl)).toThrow(
-    "can't define an enum member outside of an enum-decl scope",
+    "Can't define a EnumMember outside of a enum-decl scope",
   );
 });
 

package/src/components/class/declaration.tsx

@@ -33,9 +33,9 @@ export interface ClassModifiers {
 
 const getClassModifiers = makeModifiers<ClassModifiers>([
   "abstract",
-  "partial",
   "sealed",
   "static",
+  "partial",
 ]);
 
 // properties for creating a class

package/src/components/constructor/constructor.tsx

@@ -14,7 +14,10 @@ import {
 } 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 {
+  CSharpMemberScope,
+  useCSharpMemberScope,
+} from "../../symbols/scopes.js";
 import { ParameterProps, Parameters } from "../parameters/parameters.jsx";
 
 /**
@@ -32,15 +35,7 @@ export interface ConstructorProps extends AccessModifiers {
 }
 
 export function Constructor(props: ConstructorProps) {
-  const scope = useCSharpScope();
-  if (
-    scope.kind !== "member" ||
-    (scope.name !== "class-decl" && scope.name !== "struct-decl")
-  ) {
-    throw new Error(
-      "can't define a class method outside of a class or struct scope",
-    );
-  }
+  const scope = useCSharpMemberScope(["class-decl", "struct-decl"]);
 
   const name = useCSharpNamePolicy().getName(scope.owner!.name, "class-method");
   const ctorSymbol = new CSharpOutputSymbol(name, {

package/src/components/field/field.tsx

@@ -7,7 +7,7 @@ import {
 } from "../../modifiers.js";
 import { CSharpElements, useCSharpNamePolicy } from "../../name-policy.js";
 import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
-import { useCSharpScope } from "../../symbols/scopes.js";
+import { useCSharpMemberScope } from "../../symbols/scopes.js";
 import { DocWhen } from "../doc/comment.jsx";
 
 /** Field modifiers. */
@@ -40,15 +40,7 @@ export function Field(props: FieldProps) {
     nameElement = "class-member-public";
   }
   const name = useCSharpNamePolicy().getName(props.name, nameElement);
-  const scope = useCSharpScope();
-  if (
-    scope.kind !== "member" ||
-    (scope.name !== "class-decl" && scope.name !== "struct-decl")
-  ) {
-    throw new Error(
-      "can't define a class member outside of a class or struct scope",
-    );
-  }
+  const scope = useCSharpMemberScope(["class-decl", "struct-decl"]);
 
   const memberSymbol = new CSharpOutputSymbol(name, {
     scope,

package/src/components/interface/method.tsx

@@ -14,7 +14,10 @@ import {
 } 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 {
+  CSharpMemberScope,
+  useCSharpMemberScope,
+} from "../../symbols/scopes.js";
 import { AttributeList, AttributesProp } from "../attributes/attributes.jsx";
 import { DocWhen } from "../doc/comment.jsx";
 import { ParameterProps, Parameters } from "../parameters/parameters.jsx";
@@ -77,12 +80,8 @@ export interface InterfaceMethodProps
 // a C# interface method
 export function InterfaceMethod(props: InterfaceMethodProps) {
   const name = useCSharpNamePolicy().getName(props.name, "class-method");
-  const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "interface-decl") {
-    throw new Error(
-      "can't define an interface method outside of an interface scope",
-    );
-  }
+
+  const scope = useCSharpMemberScope(["interface-decl"]);
 
   const methodSymbol = new CSharpOutputSymbol(name, {
     scope,

package/src/components/interface/property.tsx

@@ -15,7 +15,10 @@ import {
 } 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 {
+  CSharpMemberScope,
+  useCSharpMemberScope,
+} from "../../symbols/scopes.js";
 import { AttributeList, AttributesProp } from "../attributes/attributes.jsx";
 import { DocWhen } from "../doc/comment.jsx";
 
@@ -85,12 +88,8 @@ export interface InterfacePropertyProps
  */
 export function InterfaceProperty(props: InterfacePropertyProps) {
   const name = useCSharpNamePolicy().getName(props.name, "class-property");
-  const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "interface-decl") {
-    throw new Error(
-      "can't define an interface method outside of an interface scope",
-    );
-  }
+
+  const scope = useCSharpMemberScope(["interface-decl"]);
 
   const propertySymbol = new CSharpOutputSymbol(name, {
     scope,

package/src/components/method/method.tsx

@@ -15,7 +15,10 @@ import {
 } 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 {
+  CSharpMemberScope,
+  useCSharpMemberScope,
+} from "../../symbols/scopes.js";
 import { AttributeList, AttributesProp } from "../attributes/attributes.jsx";
 import { DocWhen } from "../doc/comment.jsx";
 import { ParameterProps, Parameters } from "../parameters/parameters.jsx";
@@ -111,15 +114,7 @@ export interface MethodProps extends AccessModifiers, MethodModifiers {
 // a C# class method
 export function Method(props: MethodProps) {
   const name = useCSharpNamePolicy().getName(props.name, "class-method");
-  const scope = useCSharpScope();
-  if (
-    scope.kind !== "member" ||
-    (scope.name !== "class-decl" && scope.name !== "struct-decl")
-  ) {
-    throw new Error(
-      "can't define a class method outside of a class or struct scope",
-    );
-  }
+  const scope = useCSharpMemberScope(["class-decl", "struct-decl"]);
 
   const methodSymbol = new CSharpOutputSymbol(name, {
     scope,

package/src/components/parameters/parameters.tsx

@@ -10,7 +10,7 @@ import {
 } from "@alloy-js/core";
 import { useCSharpNamePolicy } from "../../name-policy.js";
 import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
-import { useCSharpScope } from "../../symbols/scopes.js";
+import { useCSharpMemberScope } from "../../symbols/scopes.js";
 import { Name } from "../Name.jsx";
 
 export interface ParameterProps {
@@ -27,17 +27,12 @@ export interface ParameterProps {
 /** Define a parameter to be used in class or interface method. */
 export function Parameter(props: ParameterProps) {
   const name = useCSharpNamePolicy().getName(props.name, "parameter");
-  const scope = useCSharpScope();
-  if (
-    scope.kind !== "member" ||
-    (scope.name !== "constructor-decl" &&
-      scope.name !== "method-decl" &&
-      scope.name !== "class-decl")
-  ) {
-    throw new Error(
-      "can't define a parameter outside of a constructor-decl or method-decl scope",
-    );
-  }
+  const scope = useCSharpMemberScope([
+    "constructor-decl",
+    "method-decl",
+    "class-decl",
+    "record-decl",
+  ]);
 
   const memberSymbol = new CSharpOutputSymbol(name, {
     scope,

package/src/components/property/property.tsx

@@ -16,7 +16,10 @@ import {
 } 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 {
+  CSharpMemberScope,
+  useCSharpMemberScope,
+} from "../../symbols/scopes.js";
 import { AttributeList, AttributesProp } from "../attributes/attributes.jsx";
 import { DocWhen } from "../doc/comment.jsx";
 
@@ -119,17 +122,11 @@ export interface PropertyProps extends AccessModifiers, PropertyModifiers {
  */
 export function Property(props: PropertyProps) {
   const name = useCSharpNamePolicy().getName(props.name, "class-property");
-  const scope = useCSharpScope();
-  if (
-    scope.kind !== "member" ||
-    (scope.name !== "class-decl" &&
-      scope.name !== "record-decl" &&
-      scope.name !== "struct-decl")
-  ) {
-    throw new Error(
-      "can't define an interface method outside of an interface scope",
-    );
-  }
+  const scope = useCSharpMemberScope([
+    "class-decl",
+    "record-decl",
+    "struct-decl",
+  ]);
 
   const propertySymbol = new CSharpOutputSymbol(name, {
     scope,

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

@@ -1,9 +1,19 @@
+import { Children, code, refkey } from "@alloy-js/core";
 import { describe, expect, it } from "vitest";
 import { TestNamespace } from "../../../test/utils.jsx";
 import { Property } from "../property/property.jsx";
+import { SourceFile } from "../SourceFile.jsx";
 import { RecordDeclaration } from "./declaration.jsx";
 
-it("declares class with no members", () => {
+function Wrapper({ children }: { children: Children }) {
+  return (
+    <TestNamespace>
+      <SourceFile path="Test.cs">{children}</SourceFile>
+    </TestNamespace>
+  );
+}
+
+it("declares record with no members", () => {
   expect(
     <TestNamespace>
       <RecordDeclaration name="TestRecord" />
@@ -56,7 +66,7 @@ it("specify doc comment", () => {
   `);
 });
 
-it("specify class property inside", () => {
+it("specify record property inside", () => {
   expect(
     <TestNamespace>
       <RecordDeclaration name="TestRecord" doc="This is a test">
@@ -71,3 +81,44 @@ it("specify class property inside", () => {
     }
   `);
 });
+
+describe("constructor", () => {
+  it("declares primary constructor with args", () => {
+    const paramNameRefkey = refkey();
+    const paramSizeRefkey = refkey();
+
+    const ctorParams = [
+      {
+        name: "name",
+        type: "string",
+        refkey: paramNameRefkey,
+      },
+      {
+        name: "size",
+        type: "int",
+        refkey: paramSizeRefkey,
+      },
+    ];
+
+    expect(
+      <Wrapper>
+        <RecordDeclaration public name="Test" primaryConstructor={ctorParams}>
+          <Property
+            name="PrettyName"
+            type="string"
+            get
+            initializer={code`$"{${paramNameRefkey}} {${paramSizeRefkey}}"`}
+          />
+        </RecordDeclaration>
+      </Wrapper>,
+    ).toRenderTo(`
+      namespace TestCode
+      {
+          public record Test(string name, int size)
+          {
+              string PrettyName { get; } = $"{name} {size}";
+          }
+      }
+  `);
+  });
+});

package/src/components/record/declaration.tsx

@@ -10,6 +10,7 @@ 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";
+import { ParameterProps, Parameters } from "../parameters/parameters.jsx";
 
 export interface RecordModifiers {
   readonly partial?: boolean;
@@ -28,6 +29,24 @@ export interface RecordDeclarationProps
   doc?: core.Children;
   refkey?: core.Refkey;
   typeParameters?: Record<string, core.Refkey>;
+
+  /**
+   * Set the primary constructor parameters
+   * @example
+   * ```tsx
+   *  <ClassDeclaration name="MyClass" primaryConstructor={[
+   *    {name: "value", type: "int"}
+   *  ]}>
+   * ```
+   * This will produce:
+   * ```csharp
+   * public class MyClass(int value)
+   * {
+   *
+   * }
+   * ```
+   */
+  primaryConstructor?: ParameterProps[];
 }
 
 /**
@@ -99,6 +118,11 @@ export function RecordDeclaration(props: RecordDeclarationProps) {
       <DocWhen doc={props.doc} />
       {modifiers}record <Name />
       {typeParams}
+      {props.primaryConstructor && (
+        <core.Scope value={thisRecordScope}>
+          <Parameters parameters={props.primaryConstructor} />
+        </core.Scope>
+      )}
       {props.children ?
         <core.Block newline>
           <core.Scope value={thisRecordScope}>{props.children}</core.Scope>

package/src/symbols/scopes.ts

@@ -39,3 +39,23 @@ export type CSharpOutputScope = CSharpMemberScope | CSharpNamespaceScope;
 export function useCSharpScope(): CSharpOutputScope {
   return core.useScope() as CSharpOutputScope;
 }
+
+export function useCSharpMemberScope<T extends unknown[]>(
+  names: T,
+): CSharpMemberScope & { name: T[number] } {
+  const scope = useCSharpScope();
+  assertMemberOfScope(scope, names);
+  return scope;
+}
+
+export function assertMemberOfScope<T extends unknown[]>(
+  scope: CSharpOutputScope,
+  names: T,
+): asserts scope is CSharpMemberScope & { name: T[number] } {
+  if (scope.kind !== "member" || !names.includes(scope.name as T[number])) {
+    const context = core.getContext();
+    throw new Error(
+      `Can't define a ${context?.componentOwner?.component.name} outside of a ${names.join(" or ")} scope`,
+    );
+  }
+}

package/temp/api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.52.8",
+    "toolVersion": "7.52.9",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -325,6 +325,107 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/csharp!assertMemberOfScope:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function assertMemberOfScope<T extends "
+            },
+            {
+              "kind": "Content",
+              "text": "unknown[]"
+            },
+            {
+              "kind": "Content",
+              "text": ">(scope: "
+            },
+            {
+              "kind": "Reference",
+              "text": "CSharpOutputScope",
+              "canonicalReference": "@alloy-js/csharp!CSharpOutputScope:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", names: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "asserts "
+            },
+            {
+              "kind": "Reference",
+              "text": "scope",
+              "canonicalReference": "@alloy-js/csharp!~scope"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "CSharpMemberScope",
+              "canonicalReference": "@alloy-js/csharp!CSharpMemberScope:class"
+            },
+            {
+              "kind": "Content",
+              "text": " & {\n    name: T[number];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/symbols/scopes.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 7,
+            "endIndex": 12
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "scope",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "names",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "assertMemberOfScope"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@alloy-js/csharp!Attribute:var",
@@ -7880,6 +7981,38 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!RecordDeclarationProps#primaryConstructor:member",
+              "docComment": "/**\n * Set the primary constructor parameters\n *\n * @example\n * ```tsx\n *  <ClassDeclaration name=\"MyClass\" primaryConstructor={[\n *    {name: \"value\", type: \"int\"}\n *  ]}>\n * ```\n *\n * This will produce:\n * ```csharp\n * public class MyClass(int value)\n * {\n *\n * }\n * ```\n *\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "primaryConstructor?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ParameterProps",
+                  "canonicalReference": "@alloy-js/csharp!ParameterProps:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "primaryConstructor",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!RecordDeclarationProps#refkey:member",
@@ -8914,6 +9047,77 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/csharp!useCSharpMemberScope:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function useCSharpMemberScope<T extends "
+            },
+            {
+              "kind": "Content",
+              "text": "unknown[]"
+            },
+            {
+              "kind": "Content",
+              "text": ">(names: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "CSharpMemberScope",
+              "canonicalReference": "@alloy-js/csharp!CSharpMemberScope:class"
+            },
+            {
+              "kind": "Content",
+              "text": " & {\n    name: T[number];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/symbols/scopes.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 7
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "names",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "useCSharpMemberScope"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/csharp!useCSharpNamePolicy:function(1)",

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.8"
+      "packageVersion": "7.52.9"
     }
   ]
 }