@alloy-js/csharp 0.18.0-dev.2 → 0.18.0-dev.21

package/dist/src/components/interface/declaration.js

@@ -0,0 +1,77 @@
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import * as core from "@alloy-js/core";
+import { 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.js";
+import { Name } from "../Name.js";
+import { TypeParameterConstraints } from "../type-parameters/type-parameter-constraints.js";
+import { TypeParameters } from "../type-parameters/type-parameters.js";
+const getInterfaceModifiers = makeModifiers(["partial"]);
+
+// properties for creating a class
+
+/**
+ * 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) {
+  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
+  });
+  const modifiers = computeModifiersPrefix([getAccessModifier(props), getInterfaceModifiers(props)]);
+  return _$createComponent(core.Declaration, {
+    symbol: thisInterfaceSymbol,
+    get children() {
+      return [_$createComponent(DocWhen, {
+        get doc() {
+          return props.doc;
+        }
+      }), modifiers, "interface ", _$createComponent(Name, {}), _$memo(() => _$memo(() => !!props.typeParameters)() && _$createComponent(TypeParameters, {
+        get parameters() {
+          return props.typeParameters;
+        }
+      })), _$memo(() => _$memo(() => !!props.typeParameters)() && _$createComponent(TypeParameterConstraints, {
+        get parameters() {
+          return props.typeParameters;
+        }
+      })), _$memo(() => _$memo(() => !!props.children)() ? _$createComponent(core.Block, {
+        newline: true,
+        get children() {
+          return _$createComponent(core.Scope, {
+            value: thisInterfaceScope,
+            get children() {
+              return props.children;
+            }
+          });
+        }
+      }) : ";")];
+    }
+  });
+}

package/dist/src/components/interface/declaration.test.d.ts

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

package/dist/src/components/interface/declaration.test.d.ts.map

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

package/dist/src/components/interface/declaration.test.js

@@ -0,0 +1,153 @@
+import { createComponent as _$createComponent, mergeProps as _$mergeProps } from "@alloy-js/core/jsx-runtime";
+import { List, refkey } from "@alloy-js/core";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.js";
+import { SourceFile } from "../SourceFile.js";
+import { InterfaceDeclaration } from "./declaration.js";
+import { InterfaceProperty } from "./property.js";
+it("declares class with no members", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(InterfaceDeclaration, {
+        name: "TestInterface"
+      });
+    }
+  })).toRenderTo(`
+      interface TestInterface;
+  `);
+});
+describe("modifiers", () => {
+  it.each(["public", "private", "internal"])("%s", mod => {
+    expect(_$createComponent(TestNamespace, {
+      get children() {
+        return _$createComponent(InterfaceDeclaration, _$mergeProps({
+          [mod]: true
+        }, {
+          name: "TestInterface"
+        }));
+      }
+    })).toRenderTo(`
+        ${mod} interface TestInterface;
+    `);
+  });
+  it.each(["partial"])("%s", mod => {
+    expect(_$createComponent(TestNamespace, {
+      get children() {
+        return _$createComponent(InterfaceDeclaration, _$mergeProps({
+          [mod]: true
+        }, {
+          name: "TestInterface"
+        }));
+      }
+    })).toRenderTo(`
+        ${mod} interface TestInterface;
+    `);
+  });
+  it("combines modifiers", () => {
+    expect(_$createComponent(TestNamespace, {
+      get children() {
+        return _$createComponent(InterfaceDeclaration, {
+          "public": true,
+          partial: true,
+          name: "TestInterface"
+        });
+      }
+    })).toRenderTo(`
+        public partial interface TestInterface;
+    `);
+  });
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(InterfaceDeclaration, {
+        name: "TestInterface",
+        doc: "This is a test"
+      });
+    }
+  })).toRenderTo(`
+    /// This is a test
+    interface TestInterface;
+  `);
+});
+describe("with type parameters", () => {
+  it("reference parameters", () => {
+    const typeParameters = [{
+      name: "T",
+      refkey: refkey()
+    }, {
+      name: "U",
+      refkey: refkey()
+    }];
+    expect(_$createComponent(TestNamespace, {
+      get children() {
+        return _$createComponent(SourceFile, {
+          path: "Test.cs",
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              "public": true,
+              name: "Test",
+              typeParameters: typeParameters,
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return [_$createComponent(InterfaceProperty, {
+                      name: "PropA",
+                      get type() {
+                        return typeParameters[0].refkey;
+                      },
+                      get: true,
+                      set: true
+                    }), _$createComponent(InterfaceProperty, {
+                      name: "PropB",
+                      get type() {
+                        return typeParameters[1].refkey;
+                      },
+                      get: true,
+                      set: true
+                    })];
+                  }
+                });
+              }
+            });
+          }
+        });
+      }
+    })).toRenderTo(`
+      namespace TestCode
+      {
+        public interface Test<T, U>
+        {
+          T PropA { get; set; }
+          U PropB { get; set; }
+        }
+      }
+    `);
+  });
+  it("defines with constraints", () => {
+    const typeParameters = [{
+      name: "T",
+      constraints: "IFoo"
+    }, {
+      name: "U",
+      constraints: "IBar"
+    }];
+    expect(_$createComponent(TestNamespace, {
+      get children() {
+        return _$createComponent(InterfaceDeclaration, {
+          "public": true,
+          name: "Test",
+          typeParameters: typeParameters,
+          children: "// Body"
+        });
+      }
+    })).toRenderTo(`
+      public interface Test<T, U>
+        where T : IFoo
+        where U : IBar
+      {
+        // Body
+      }
+    `);
+  });
+});

package/dist/src/components/interface/method.d.ts

@@ -0,0 +1,32 @@
+import { Children, Refkey } from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+import { ParameterProps } from "../parameters/parameters.jsx";
+import { TypeParameterProps } from "../type-parameters/type-parameter.jsx";
+/** Method modifiers. Can only be one. */
+export interface InterfaceMethodModifiers {
+    readonly new?: boolean;
+}
+export interface InterfaceMethodProps extends AccessModifiers, InterfaceMethodModifiers {
+    name: string;
+    refkey?: Refkey;
+    children?: Children;
+    parameters?: Array<ParameterProps>;
+    /**
+     * Type parameters for the method
+     *
+     * @example
+     * ```tsx
+     * <InterfaceMethod name="Test" typeParameters={["T"]} />
+     * ```
+     * This will produce:
+     * ```csharp
+     * public void Test<T>()
+     * ```
+     */
+    typeParameters?: (TypeParameterProps | string)[];
+    returns?: Children;
+    /** Doc comment */
+    doc?: Children;
+}
+export declare function InterfaceMethod(props: InterfaceMethodProps): Children;
+//# sourceMappingURL=method.d.ts.map

package/dist/src/components/interface/method.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"method.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/method.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAGR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAK5B,OAAO,EAAE,cAAc,EAAc,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAG3E,yCAAyC;AACzC,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;CACxB;AAKD,MAAM,WAAW,oBACf,SAAQ,eAAe,EACrB,wBAAwB;IAC1B,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;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,CAAC,kBAAkB,GAAG,MAAM,CAAC,EAAE,CAAC;IACjD,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB,kBAAkB;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;CAChB;AAGD,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,YA2C1D"}

package/dist/src/components/interface/method.js

@@ -0,0 +1,68 @@
+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, 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.js";
+import { Parameters } from "../parameters/parameters.js";
+import { TypeParameterConstraints } from "../type-parameters/type-parameter-constraints.js";
+import { TypeParameters } from "../type-parameters/type-parameters.js";
+
+/** Method modifiers. Can only be one. */
+
+const getMethodModifier = makeModifiers(["new"]);
+
+// properties for creating a method
+
+// a C# interface method
+export function InterfaceMethod(props) {
+  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 modifiers = computeModifiersPrefix([getAccessModifier(props), getMethodModifier(props)]);
+  // 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, _$memo(() => props.returns ?? "void"), " ", name, _$memo(() => _$memo(() => !!props.typeParameters)() && _$createComponent(TypeParameters, {
+            get parameters() {
+              return props.typeParameters;
+            }
+          })), _$createComponent(Parameters, {
+            get parameters() {
+              return props.parameters;
+            }
+          }), _$memo(() => _$memo(() => !!props.typeParameters)() && _$createComponent(TypeParameterConstraints, {
+            get parameters() {
+              return props.typeParameters;
+            }
+          })), _$memo(() => _$memo(() => !!props.children)() ? _$createComponent(Block, {
+            newline: true,
+            get children() {
+              return props.children;
+            }
+          }) : ";")];
+        }
+      });
+    }
+  });
+}

package/dist/src/components/interface/method.test.d.ts

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

package/dist/src/components/interface/method.test.d.ts.map

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

package/dist/src/components/interface/method.test.js

@@ -0,0 +1,279 @@
+import { memo as _$memo, createComponent as _$createComponent, mergeProps as _$mergeProps } from "@alloy-js/core/jsx-runtime";
+import { refkey } from "@alloy-js/core";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.js";
+import { SourceFile } from "../SourceFile.js";
+import { InterfaceDeclaration } from "./declaration.js";
+import { InterfaceMethod } from "./method.js";
+const Wrapper = props => _$createComponent(TestNamespace, {
+  get children() {
+    return _$createComponent(InterfaceDeclaration, {
+      "public": true,
+      name: "TestInterface",
+      get children() {
+        return props.children;
+      }
+    });
+  }
+});
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"])("%s", accessModifier => {
+      expect(_$createComponent(Wrapper, {
+        get children() {
+          return _$createComponent(InterfaceMethod, _$mergeProps({
+            [accessModifier]: true
+          }, {
+            name: "MethodOne"
+          }));
+        }
+      })).toRenderTo(`
+        public interface TestInterface
+        {
+          ${accessModifier} void MethodOne();
+        }
+      `);
+    });
+  });
+  describe("method modifiers", () => {
+    it.each(["new"])("%s", methodModifier => {
+      expect(_$createComponent(Wrapper, {
+        get children() {
+          return _$createComponent(InterfaceMethod, _$mergeProps({
+            [methodModifier]: true
+          }, {
+            name: "MethodOne"
+          }));
+        }
+      })).toRenderTo(`
+        public interface TestInterface
+        {
+          ${methodModifier} void MethodOne();
+        }
+      `);
+    });
+  });
+  it("combine modifiers", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(InterfaceMethod, {
+          returns: "Task",
+          "public": true,
+          "new": true,
+          name: "MethodOne"
+        });
+      }
+    })).toRenderTo(`
+        public interface TestInterface
+        {
+          public new Task MethodOne();
+        }
+      `);
+  });
+});
+it("applies PascalCase naming policy", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(InterfaceMethod, {
+        name: "method_one"
+      });
+    }
+  })).toRenderTo(`
+    public interface TestInterface
+    {
+      void MethodOne();
+    }
+`);
+});
+it("defines params and return type", () => {
+  const params = [{
+    name: "intParam",
+    type: "int"
+  }, {
+    name: "stringParam",
+    type: "string"
+  }];
+  const res = _$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(InterfaceMethod, {
+        "public": true,
+        name: "MethodOne",
+        parameters: params,
+        returns: "string"
+      });
+    }
+  });
+  expect(res).toRenderTo(`
+    public interface TestInterface
+    {
+      public string MethodOne(int intParam, string stringParam);
+    }
+  `);
+});
+it("defines optional param", () => {
+  const res = _$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(InterfaceMethod, {
+        "public": true,
+        name: "MethodOne",
+        parameters: [{
+          name: "intParam",
+          type: "int",
+          optional: true
+        }],
+        returns: "string"
+      });
+    }
+  });
+  expect(res).toRenderTo(`
+    public interface TestInterface
+    {
+      public string MethodOne(int? intParam);
+    }
+  `);
+});
+it("defines optional param with default", () => {
+  const res = _$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(InterfaceMethod, {
+        "public": true,
+        name: "MethodOne",
+        parameters: [{
+          name: "intParam",
+          type: "int",
+          default: 12
+        }],
+        returns: "string"
+      });
+    }
+  });
+  expect(res).toRenderTo(`
+    public interface TestInterface
+    {
+      public string MethodOne(int intParam = 12);
+    }
+  `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(InterfaceDeclaration, {
+        name: "Test",
+        get children() {
+          return _$createComponent(InterfaceMethod, {
+            name: "Method",
+            doc: "This is a test"
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    interface Test
+    {
+      /// This is a test
+      void Method();
+    }
+  `);
+});
+describe("with type parameters", () => {
+  it("reference parameters", () => {
+    const typeParameters = [{
+      name: "T",
+      refkey: refkey()
+    }, {
+      name: "U",
+      refkey: refkey()
+    }];
+    expect(_$createComponent(TestNamespace, {
+      get children() {
+        return _$createComponent(SourceFile, {
+          path: "TestFile.cs",
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              "public": true,
+              name: "TestInterface",
+              get children() {
+                return _$createComponent(InterfaceMethod, {
+                  name: "Test",
+                  "public": true,
+                  typeParameters: typeParameters,
+                  get parameters() {
+                    return [{
+                      name: "paramA",
+                      type: typeParameters[0].refkey
+                    }];
+                  },
+                  get returns() {
+                    return typeParameters[0].refkey;
+                  }
+                });
+              }
+            });
+          }
+        });
+      }
+    })).toRenderTo(`
+      namespace TestCode
+      {
+        public interface TestInterface
+        {
+          public T Test<T, U>(T paramA);
+        }
+      }
+    `);
+  });
+  it("defines with constraints", () => {
+    const typeParameters = [{
+      name: "T",
+      constraints: "IFoo"
+    }, {
+      name: "U",
+      constraints: "IBar"
+    }];
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(InterfaceMethod, {
+          "public": true,
+          name: "Test",
+          typeParameters: typeParameters,
+          children: "// Body"
+        });
+      }
+    })).toRenderTo(`
+      public interface TestInterface
+      {
+        public void Test<T, U>()
+          where T : IFoo
+          where U : IBar
+        {
+          // Body
+        }
+      }
+    `);
+  });
+});
+describe("formatting", () => {
+  it("Split parameters before type parameters", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(InterfaceMethod, {
+          "public": true,
+          name: "Handle",
+          parameters: [{
+            name: "message",
+            type: "Some.Quite.Long.Type.That.Will.Split"
+          }],
+          typeParameters: ["T"],
+          returns: "Some.Quite.Long.Type.That.Will.Split"
+        });
+      }
+    })).toRenderTo(`
+      public interface TestInterface
+      {
+        public Some.Quite.Long.Type.That.Will.Split Handle<T>(
+          Some.Quite.Long.Type.That.Will.Split message
+        );
+      }
+    `);
+  });
+});

package/dist/src/components/interface/property.d.ts

@@ -0,0 +1,38 @@
+import { Children, Refkey } from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+/** Method modifiers. Can only be one. */
+export interface InterfacePropertyModifiers {
+    readonly new?: boolean;
+}
+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 declare function InterfaceProperty(props: InterfacePropertyProps): Children;
+//# sourceMappingURL=property.d.ts.map

package/dist/src/components/interface/property.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/property.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAIR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAM5B,yCAAyC;AACzC,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;CACxB;AAKD,MAAM,WAAW,sBACf,SAAQ,eAAe,EACrB,0BAA0B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,oBAAoB;IACpB,IAAI,EAAE,QAAQ,CAAC;IAEf,uCAAuC;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,uCAAuC;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,kBAAkB;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;IAEf;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,YAwC9D"}