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

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

@@ -0,0 +1,67 @@
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { Block, List, 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";
+
+/** Method modifiers. Can only be one. */
+
+const getModifiers = makeModifiers(["new"]);
+
+// properties for creating a method
+
+/**
+ * Render a C# interface property.
+ *
+ * @example `<InterfaceProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
+export function InterfaceProperty(props) {
+  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 _$createComponent(MemberDeclaration, {
+    symbol: propertySymbol,
+    get children() {
+      return _$createComponent(Scope, {
+        value: propertyScope,
+        get children() {
+          return [_$createComponent(DocWhen, {
+            get doc() {
+              return props.doc;
+            }
+          }), modifiers, _$memo(() => props.type), _$memo(() => props.nullable && "?"), " ", name, " ", _$createComponent(Block, {
+            newline: true,
+            inline: true,
+            get children() {
+              return _$createComponent(List, {
+                joiner: " ",
+                get children() {
+                  return [_$memo(() => props.get && "get;"), _$memo(() => props.set && "set;")];
+                }
+              });
+            }
+          })];
+        }
+      });
+    }
+  });
+}

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

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

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

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

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

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

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

@@ -0,0 +1,57 @@
+import { Children, Refkey } from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+/** Property modifiers. */
+export interface PropertyModifiers {
+    readonly new?: boolean;
+    readonly static?: boolean;
+    readonly virtual?: boolean;
+    readonly sealed?: boolean;
+    readonly override?: boolean;
+    readonly abstract?: boolean;
+    readonly extern?: boolean;
+    readonly readonly?: boolean;
+}
+/** Properties for {@link Property} component */
+export interface PropertyProps extends AccessModifiers, PropertyModifiers {
+    name: string;
+    refkey?: Refkey;
+    /** Property type */
+    type: Children;
+    /** If property should have a getter */
+    get?: boolean;
+    /** If property should have a setter */
+    set?: boolean;
+    /** If property should only be set on the type creation */
+    init?: boolean;
+    /** Doc comment */
+    doc?: Children;
+    /**
+     * Property initializer
+     * @example `<ClassProperty name="My" get set nullable />`
+     *
+     * ```cs
+     * int? My { get; set; };
+     * ```
+     */
+    nullable?: boolean;
+    /**
+     * Property initializer
+     * @example `<ClassProperty name="My" get set init={42} />`
+     *
+     * ```cs
+     * int My { get; set; } = 42;
+     * ```
+     */
+    initializer?: Children;
+}
+/**
+ * Render a C# class property.
+ *
+ * @example `<ClassProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
+export declare function Property(props: PropertyProps): Children;
+//# sourceMappingURL=property.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../../../src/components/property/property.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAKR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAM5B,0BAA0B;AAC1B,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAaD,gDAAgD;AAChD,MAAM,WAAW,aAAc,SAAQ,eAAe,EAAE,iBAAiB;IACvE,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,0DAA0D;IAC1D,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,kBAAkB;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;IAEf;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC;CACxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,YAmD5C"}

package/dist/src/components/property/property.js

@@ -0,0 +1,70 @@
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { Block, code, List, 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";
+
+/** Property modifiers. */
+
+const getModifiers = makeModifiers(["new", "static", "virtual", "sealed", "override", "abstract", "extern", "readonly"]);
+
+/** Properties for {@link Property} component */
+
+/**
+ * Render a C# class property.
+ *
+ * @example `<ClassProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
+export function Property(props) {
+  const name = useCSharpNamePolicy().getName(props.name, "class-property");
+  const scope = useCSharpScope();
+  if (scope.kind !== "member" || scope.name !== "class-decl" && scope.name !== "record-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)]);
+  if (props.init && props.set) {
+    throw new Error(`Cannot use 'init' and 'set' together on property '${name}'`);
+  }
+  // note that scope wraps the method decl so that the params get the correct scope
+  return _$createComponent(MemberDeclaration, {
+    symbol: propertySymbol,
+    get children() {
+      return _$createComponent(Scope, {
+        value: propertyScope,
+        get children() {
+          return [_$createComponent(DocWhen, {
+            get doc() {
+              return props.doc;
+            }
+          }), modifiers, _$memo(() => props.type), _$memo(() => props.nullable && "?"), " ", name, " ", _$createComponent(Block, {
+            newline: true,
+            inline: true,
+            get children() {
+              return _$createComponent(List, {
+                joiner: " ",
+                get children() {
+                  return [_$memo(() => props.get && "get;"), _$memo(() => props.set && "set;"), _$memo(() => props.init && "init;")];
+                }
+              });
+            }
+          }), _$memo(() => props.initializer && code` = ${props.initializer};`)];
+        }
+      });
+    }
+  });
+}

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

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

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

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

package/dist/src/components/property/property.test.js

@@ -0,0 +1,218 @@
+import { memo as _$memo, createComponent as _$createComponent, mergeProps as _$mergeProps } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.js";
+import { ClassDeclaration } from "../ClassDeclaration.js";
+import { Property } from "./property.js";
+const Wrapper = props => _$createComponent(TestNamespace, {
+  get children() {
+    return _$createComponent(ClassDeclaration, {
+      "public": true,
+      name: "TestClass",
+      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(Property, _$mergeProps({
+            [accessModifier]: true
+          }, {
+            name: "TestProp",
+            type: "string",
+            get: true
+          }));
+        }
+      })).toRenderTo(`
+        public class TestClass
+        {
+          ${accessModifier} string TestProp { get; }
+        }
+      `);
+    });
+  });
+  describe("property modifiers", () => {
+    it.each(["new", "static", "virtual", "sealed", "override", "abstract", "extern", "readonly"])("%s", methodModifier => {
+      expect(_$createComponent(Wrapper, {
+        get children() {
+          return _$createComponent(Property, _$mergeProps({
+            [methodModifier]: true
+          }, {
+            name: "TestProp",
+            type: "string",
+            get: true
+          }));
+        }
+      })).toRenderTo(`
+        public class TestClass
+        {
+          ${methodModifier} string TestProp { get; }
+        }
+      `);
+    });
+  });
+  it("combine modifiers", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(Property, {
+          "public": true,
+          "new": true,
+          name: "TestProp",
+          type: "string",
+          get: true
+        });
+      }
+    })).toRenderTo(`
+        public class TestClass
+        {
+          public new string TestProp { get; }
+        }
+      `);
+  });
+});
+it("applies PascalCase naming policy", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(Property, {
+        name: "test_prop",
+        type: "string",
+        get: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; }
+    }
+`);
+});
+it("has getter only", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(Property, {
+        name: "TestProp",
+        type: "string",
+        get: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; }
+    }
+  `);
+});
+it("has setter only", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(Property, {
+        name: "TestProp",
+        type: "string",
+        set: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { set; }
+    }
+  `);
+});
+it("has getter and setter", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(Property, {
+        name: "TestProp",
+        type: "string",
+        get: true,
+        set: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; set; }
+    }
+  `);
+});
+it("has getter and init", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(Property, {
+        name: "TestProp",
+        type: "string",
+        get: true,
+        init: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; init; }
+    }
+  `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(ClassDeclaration, {
+        name: "Test",
+        get children() {
+          return _$createComponent(Property, {
+            name: "Method",
+            type: "string",
+            get: true,
+            set: true,
+            doc: "This is a test"
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    class Test
+    {
+      /// This is a test
+      string Method { get; set; }
+    }
+  `);
+});
+it("specify nullable property", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(Property, {
+        name: "TestProp",
+        type: "string",
+        nullable: true,
+        get: true,
+        set: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string? TestProp { get; set; }
+    }
+  `);
+});
+it("specify initializer", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(Property, {
+        name: "TestProp",
+        type: "string",
+        get: true,
+        set: true,
+        initializer: `"abc"`
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; set; } = "abc";
+    }
+  `);
+});

package/dist/src/components/record/declaration.d.ts

@@ -0,0 +1,35 @@
+import * as core from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+export interface RecordModifiers {
+    readonly partial?: boolean;
+}
+/** Props to use the {@link RecordDeclaration} component */
+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 declare function RecordDeclaration(props: RecordDeclarationProps): core.Children;
+//# sourceMappingURL=declaration.d.ts.map

package/dist/src/components/record/declaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"declaration.d.ts","sourceRoot":"","sources":["../../../../src/components/record/declaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAO5B,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAID,2DAA2D;AAC3D,MAAM,WAAW,sBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,eAAe;IACjB,IAAI,EAAE,MAAM,CAAC;IAEb,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;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,iBAwD9D"}