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

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

@@ -0,0 +1,56 @@
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { InterfaceDeclaration } from "./declaration.jsx";
+
+it("declares class with no members", () => {
+  expect(
+    <TestNamespace>
+      <InterfaceDeclaration name="TestInterface" />
+    </TestNamespace>,
+  ).toRenderTo(`
+      interface TestInterface;
+  `);
+});
+
+describe("modifiers", () => {
+  it.each(["public", "private", "internal"])("%s", (mod) => {
+    expect(
+      <TestNamespace>
+        <InterfaceDeclaration {...{ [mod]: true }} name="TestInterface" />
+      </TestNamespace>,
+    ).toRenderTo(`
+        ${mod} interface TestInterface;
+    `);
+  });
+
+  it.each(["partial"])("%s", (mod) => {
+    expect(
+      <TestNamespace>
+        <InterfaceDeclaration {...{ [mod]: true }} name="TestInterface" />
+      </TestNamespace>,
+    ).toRenderTo(`
+        ${mod} interface TestInterface;
+    `);
+  });
+
+  it("combines modifiers", () => {
+    expect(
+      <TestNamespace>
+        <InterfaceDeclaration public partial name="TestInterface" />
+      </TestNamespace>,
+    ).toRenderTo(`
+        public partial interface TestInterface;
+    `);
+  });
+});
+
+it("specify doc comment", () => {
+  expect(
+    <TestNamespace>
+      <InterfaceDeclaration name="TestInterface" doc="This is a test" />
+    </TestNamespace>,
+  ).toRenderTo(`
+    /// This is a test
+    interface TestInterface;
+  `);
+});

package/src/components/interface/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 InterfaceModifiers {
+  readonly partial?: boolean;
+}
+
+const getInterfaceModifiers = makeModifiers<InterfaceModifiers>(["partial"]);
+
+// properties for creating a class
+export interface InterfaceDeclarationProps
+  extends Omit<core.DeclarationProps, "nameKind">,
+    AccessModifiers,
+    InterfaceModifiers {
+  name: string;
+
+  /** Doc comment */
+  doc?: core.Children;
+  refkey?: core.Refkey;
+  typeParameters?: Record<string, core.Refkey>;
+}
+
+/**
+ * CSharp interface declaration.
+ * @example
+ * ```tsx
+ * <InterfaceDeclaration public name="IMyInterface">
+ *   <InterfaceMember public name="MyProperty" type="int" />
+ *   <InterfaceMethod public name="MyMethod" returnType="void">
+ *     <Parameter name="value" type="int" />
+ *   </InterfaceMethod>
+ * </InterfaceDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public interface MyIface
+ * {
+ *   public int MyProperty { get; set; }
+ *   public void MyMethod(int value);
+ * }
+ * ```
+ */
+export function InterfaceDeclaration(props: InterfaceDeclarationProps) {
+  const name = useCSharpNamePolicy().getName(props.name!, "interface");
+
+  const thisInterfaceSymbol = new CSharpOutputSymbol(name, {
+    refkeys: props.refkey,
+  });
+
+  // this creates a new scope for the interface definition.
+  // members will automatically "inherit" this scope so
+  // that refkeys to them will produce the fully-qualified
+  // name e.g. Foo.Bar.
+  const thisInterfaceScope = new CSharpMemberScope("interface-decl", {
+    owner: thisInterfaceSymbol,
+  });
+
+  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: thisInterfaceScope,
+        refkeys: entry[1],
+      });
+    }
+    typeParams = (
+      <group>
+        {"<"}
+        <core.For each={typeParamNames} comma line>
+          {(name) => name}
+        </core.For>
+        {">"}
+      </group>
+    );
+  }
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getInterfaceModifiers(props),
+  ]);
+  return (
+    <core.Declaration symbol={thisInterfaceSymbol}>
+      <DocWhen doc={props.doc} />
+      {modifiers}interface <Name />
+      {typeParams}
+      {props.children ?
+        <core.Block newline>
+          <core.Scope value={thisInterfaceScope}>{props.children}</core.Scope>
+        </core.Block>
+      : ";"}
+    </core.Declaration>
+  );
+}

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

@@ -0,0 +1,120 @@
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { InterfaceDeclaration } from "./declaration.jsx";
+import { InterfaceMethod } from "./method.jsx";
+
+const Wrapper = (props: { children: Children }) => (
+  <TestNamespace>
+    <InterfaceDeclaration public name="TestInterface">
+      {props.children}
+    </InterfaceDeclaration>
+  </TestNamespace>
+);
+
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"] as const)(
+      "%s",
+      (accessModifier) => {
+        expect(
+          <Wrapper>
+            <InterfaceMethod {...{ [accessModifier]: true }} name="MethodOne" />
+          </Wrapper>,
+        ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${accessModifier} void MethodOne();
+        }
+      `);
+      },
+    );
+  });
+
+  describe("method modifiers", () => {
+    it.each(["new"] as const)("%s", (methodModifier) => {
+      expect(
+        <Wrapper>
+          <InterfaceMethod {...{ [methodModifier]: true }} name="MethodOne" />
+        </Wrapper>,
+      ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${methodModifier} void MethodOne();
+        }
+      `);
+    });
+  });
+
+  it("combine modifiers", () => {
+    expect(
+      <Wrapper>
+        <InterfaceMethod returns="Task" public new name="MethodOne" />
+      </Wrapper>,
+    ).toRenderTo(`
+        public interface TestInterface
+        {
+          public new Task MethodOne();
+        }
+      `);
+  });
+});
+
+it("applies PascalCase naming policy", () => {
+  expect(
+    <Wrapper>
+      <InterfaceMethod name="method_one" />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      void MethodOne();
+    }
+`);
+});
+
+it("defines params and return type", () => {
+  const params = [
+    {
+      name: "intParam",
+      type: "int",
+    },
+    {
+      name: "stringParam",
+      type: "string",
+    },
+  ];
+  const res = (
+    <Wrapper>
+      <InterfaceMethod
+        public
+        name="MethodOne"
+        parameters={params}
+        returns="string"
+      />
+    </Wrapper>
+  );
+
+  expect(res).toRenderTo(`
+    public interface TestInterface
+    {
+      public string MethodOne(int intParam, string stringParam);
+    }
+  `);
+});
+
+it("specify doc comment", () => {
+  expect(
+    <TestNamespace>
+      <InterfaceDeclaration name="Test">
+        <InterfaceMethod name="Method" doc="This is a test" />
+      </InterfaceDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    interface Test
+    {
+      /// This is a test
+      void Method();
+    }
+  `);
+});

package/src/components/interface/method.tsx

@@ -0,0 +1,82 @@
+import {
+  Block,
+  Children,
+  MemberDeclaration,
+  refkey,
+  Refkey,
+  Scope,
+} 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, useCSharpScope } from "../../symbols/scopes.js";
+import { ParameterProps, Parameters } from "../Parameters.jsx";
+import { DocWhen } from "../doc/comment.jsx";
+
+/** Method modifiers. Can only be one. */
+export interface InterfaceMethodModifiers {
+  readonly new?: boolean;
+}
+
+const getMethodModifier = makeModifiers<InterfaceMethodModifiers>(["new"]);
+
+// properties for creating a method
+export interface InterfaceMethodProps
+  extends AccessModifiers,
+    InterfaceMethodModifiers {
+  name: string;
+  refkey?: Refkey;
+  children?: Children;
+  parameters?: Array<ParameterProps>;
+  returns?: Children;
+
+  /** Doc comment */
+  doc?: Children;
+}
+
+// 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 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 ? <Parameters parameters={props.parameters} /> : "";
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getMethodModifier(props),
+  ]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return (
+    <MemberDeclaration symbol={methodSymbol}>
+      <Scope value={methodScope}>
+        <DocWhen doc={props.doc} />
+        {modifiers}
+        {props.returns ?? "void"} {name}({params})
+        {props.children ?
+          <Block newline>{props.children}</Block>
+        : ";"}
+      </Scope>
+    </MemberDeclaration>
+  );
+}

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

@@ -0,0 +1,144 @@
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { InterfaceDeclaration } from "./declaration.jsx";
+import { InterfaceProperty } from "./property.jsx";
+
+const Wrapper = (props: { children: Children }) => (
+  <TestNamespace>
+    <InterfaceDeclaration public name="TestInterface">
+      {props.children}
+    </InterfaceDeclaration>
+  </TestNamespace>
+);
+
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"] as const)(
+      "%s",
+      (accessModifier) => {
+        expect(
+          <Wrapper>
+            <InterfaceProperty
+              {...{ [accessModifier]: true }}
+              name="TestProp"
+              type="string"
+              get
+            />
+          </Wrapper>,
+        ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${accessModifier} string TestProp { get; }
+        }
+      `);
+      },
+    );
+  });
+
+  describe("method modifiers", () => {
+    it.each(["new"] as const)("%s", (methodModifier) => {
+      expect(
+        <Wrapper>
+          <InterfaceProperty
+            {...{ [methodModifier]: true }}
+            name="TestProp"
+            type="string"
+            get
+          />
+        </Wrapper>,
+      ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${methodModifier} string TestProp { get; }
+        }
+      `);
+    });
+  });
+
+  it("combine modifiers", () => {
+    expect(
+      <Wrapper>
+        <InterfaceProperty public new name="TestProp" type="string" get />
+      </Wrapper>,
+    ).toRenderTo(`
+        public interface TestInterface
+        {
+          public new string TestProp { get; }
+        }
+      `);
+  });
+});
+
+it("applies PascalCase naming policy", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="test_prop" type="string" get />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { get; }
+    }
+`);
+});
+
+it("has getter only", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="TestProp" type="string" get />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { get; }
+    }
+  `);
+});
+
+it("has setter only", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="TestProp" type="string" set />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { set; }
+    }
+  `);
+});
+it("has getter and setter", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="TestProp" type="string" get set />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { get; set; }
+    }
+  `);
+});
+
+it("specify doc comment", () => {
+  expect(
+    <TestNamespace>
+      <InterfaceDeclaration name="Test">
+        <InterfaceProperty
+          name="Method"
+          type="string"
+          get
+          set
+          doc="This is a test"
+        />
+      </InterfaceDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    interface Test
+    {
+      /// This is a test
+      string Method { get; set; }
+    }
+  `);
+});

package/src/components/interface/property.tsx

@@ -0,0 +1,107 @@
+import {
+  Block,
+  Children,
+  List,
+  MemberDeclaration,
+  refkey,
+  Refkey,
+  Scope,
+} 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, useCSharpScope } from "../../symbols/scopes.js";
+import { DocWhen } from "../doc/comment.jsx";
+
+/** Method modifiers. Can only be one. */
+export interface InterfacePropertyModifiers {
+  readonly new?: boolean;
+}
+
+const getModifiers = makeModifiers<InterfacePropertyModifiers>(["new"]);
+
+// properties for creating a method
+export interface InterfacePropertyProps
+  extends AccessModifiers,
+    InterfacePropertyModifiers {
+  name: string;
+  refkey?: Refkey;
+
+  /** Property type */
+  type: Children;
+
+  /** If property should have a getter */
+  get?: boolean;
+
+  /** If property should have a setter */
+  set?: boolean;
+
+  /** Doc comment */
+  doc?: Children;
+
+  /**
+   * Property initializer
+   * @example `<ClassProperty name="My" get set nullable />`
+   *
+   * ```cs
+   * int? My { get; set; };
+   * ```
+   */
+  nullable?: boolean;
+}
+
+/**
+ * Render a C# interface property.
+ *
+ * @example `<InterfaceProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
+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 propertySymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name),
+  });
+
+  // scope for property declaration
+  const propertyScope = new CSharpMemberScope("property-decl", {
+    owner: propertySymbol,
+  });
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getModifiers(props),
+  ]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return (
+    <MemberDeclaration symbol={propertySymbol}>
+      <Scope value={propertyScope}>
+        <DocWhen doc={props.doc} />
+        {modifiers}
+        {props.type}
+        {props.nullable && "?"} {name}{" "}
+        <Block newline inline>
+          <List joiner=" ">
+            {props.get && "get;"}
+            {props.set && "set;"}
+          </List>
+        </Block>
+      </Scope>
+    </MemberDeclaration>
+  );
+}

package/src/components/stc/index.ts

@@ -1,11 +1,11 @@
 import * as core from "@alloy-js/core";
 import * as base from "../index.js";
 
-export const Class = core.stc(base.Class);
+export const ClassDeclaration = core.stc(base.ClassDeclaration);
 export const ClassConstructor = core.stc(base.ClassConstructor);
 export const ClassMember = core.stc(base.ClassMember);
 export const ClassMethod = core.stc(base.ClassMethod);
-export const Enum = core.stc(base.Enum);
+export const EnumDeclaration = core.stc(base.EnumDeclaration);
 export const EnumMember = core.stc(base.EnumMember);
 export const Parameter = core.stc(base.Parameter);
 export const Parameters = core.stc(base.Parameters);