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

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

@@ -2,12 +2,17 @@ import * as core from "@alloy-js/core";
 export interface ParameterProps {
     name: string;
     type: core.Children;
+    /** If the parmaeter is optional(without default value) */
+    optional?: boolean;
+    /** Default value for the parameter */
+    default?: core.Children;
     refkey?: core.Refkey;
     symbol?: core.OutputSymbol;
 }
+/** Define a parameter to be used in class or interface method. */
 export declare function Parameter(props: ParameterProps): core.Children;
 export interface ParametersProps {
-    parameters: Array<ParameterProps>;
+    parameters: ParameterProps[];
 }
 export declare function Parameters(props: ParametersProps): core.Children;
 //# sourceMappingURL=Parameters.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Parameters.d.ts","sourceRoot":"","sources":["../../../src/components/Parameters.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAMvC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;CAC5B;AAGD,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,iBAsB9C;AAED,MAAM,WAAW,eAAe;IAE9B,UAAU,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CACnC;AAGD,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,iBAMhD"}
+{"version":3,"file":"Parameters.d.ts","sourceRoot":"","sources":["../../../src/components/Parameters.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAOvC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sCAAsC;IACtC,OAAO,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;IACxB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;CAC5B;AAED,kEAAkE;AAClE,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,iBAwB9C;AAED,MAAM,WAAW,eAAe;IAE9B,UAAU,EAAE,cAAc,EAAE,CAAC;CAC9B;AAGD,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,iBAMhD"}

package/dist/src/components/Parameters.js

@@ -1,10 +1,11 @@
 import { memo as _$memo, createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
 import * as core from "@alloy-js/core";
+import { code } 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 { Name } from "./Name.js";
-// a constructor/method parameter
+/** Define a parameter to be used in class or interface method. */
 export function Parameter(props) {
   const name = useCSharpNamePolicy().getName(props.name, "parameter");
   const scope = useCSharpScope();
@@ -18,7 +19,7 @@ export function Parameter(props) {
   return _$createComponent(core.Declaration, {
     symbol: memberSymbol,
     get children() {
-      return [_$memo(() => props.type), " ", _$createComponent(Name, {})];
+      return [_$memo(() => props.type), _$memo(() => props.optional ? "?" : ""), " ", _$createComponent(Name, {}), _$memo(() => props.default ? code` = ${props.default}` : "")];
     }
   });
 }

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

@@ -1 +1 @@
-{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../../../src/components/class/property.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAKR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAM5B,yCAAyC;AACzC,MAAM,WAAW,sBAAsB;IACrC,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,qDAAqD;AACrD,MAAM,WAAW,kBACf,SAAQ,eAAe,EACrB,sBAAsB;IACxB,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;IAEnB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,YAyCtD"}
+{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../../../src/components/class/property.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAKR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAM5B,yCAAyC;AACzC,MAAM,WAAW,sBAAsB;IACrC,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,qDAAqD;AACrD,MAAM,WAAW,kBACf,SAAQ,eAAe,EACrB,sBAAsB;IACxB,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;IAEnB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,YA4CtD"}

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

@@ -24,7 +24,7 @@ const getModifiers = makeModifiers(["new", "static", "virtual", "sealed", "overr
 export function ClassProperty(props) {
   const name = useCSharpNamePolicy().getName(props.name, "class-property");
   const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "class-decl") {
+  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, {

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

@@ -108,6 +108,50 @@ it("defines params and return type", () => {
     }
   `);
 });
+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() {

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

@@ -0,0 +1,34 @@
+import * as core from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+export interface RecordModifiers {
+    readonly partial?: boolean;
+}
+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;AAKD,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"}

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

@@ -0,0 +1,90 @@
+import { createComponent as _$createComponent, createIntrinsic as _$createIntrinsic, 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";
+const getRecordModifiers = makeModifiers(["partial"]);
+
+// properties for creating a class
+
+/**
+ * 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) {
+  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;
+  if (props.typeParameters) {
+    const typeParamNames = new Array();
+    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 = _$createIntrinsic("group", {
+      get children() {
+        return ["<", _$createComponent(core.For, {
+          each: typeParamNames,
+          comma: true,
+          line: true,
+          children: name => name
+        }), ">"];
+      }
+    });
+  }
+  const modifiers = computeModifiersPrefix([getAccessModifier(props), getRecordModifiers(props)]);
+  return _$createComponent(core.Declaration, {
+    symbol: thisRecordSymbol,
+    get children() {
+      return [_$createComponent(DocWhen, {
+        get doc() {
+          return props.doc;
+        }
+      }), modifiers, "record ", _$createComponent(Name, {}), typeParams, _$memo(() => _$memo(() => !!props.children)() ? _$createComponent(core.Block, {
+        newline: true,
+        get children() {
+          return _$createComponent(core.Scope, {
+            value: thisRecordScope,
+            get children() {
+              return props.children;
+            }
+          });
+        }
+      }) : ";")];
+    }
+  });
+}

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

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

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

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

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

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

package/dist/src/name-policy.d.ts

@@ -1,5 +1,5 @@
 import * as core from "@alloy-js/core";
-export type CSharpElements = "class" | "constant" | "enum" | "enum-member" | "function" | "interface" | "class-member-private" | "class-member-public" | "class-method" | "class-property" | "parameter" | "type-parameter";
+export type CSharpElements = "class" | "constant" | "enum" | "enum-member" | "function" | "interface" | "record" | "class-member-private" | "class-member-public" | "class-method" | "class-property" | "parameter" | "type-parameter";
 export declare function createCSharpNamePolicy(): core.NamePolicy<CSharpElements>;
 export declare function useCSharpNamePolicy(): core.NamePolicy<CSharpElements>;
 //# sourceMappingURL=name-policy.d.ts.map

package/dist/src/name-policy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"name-policy.d.ts","sourceRoot":"","sources":["../../src/name-policy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAIvC,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,UAAU,GACV,MAAM,GACN,aAAa,GACb,UAAU,GACV,WAAW,GACX,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,gBAAgB,CAAC;AAGrB,wBAAgB,sBAAsB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAkBxE;AAGD,wBAAgB,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAErE"}
+{"version":3,"file":"name-policy.d.ts","sourceRoot":"","sources":["../../src/name-policy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAIvC,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,UAAU,GACV,MAAM,GACN,aAAa,GACb,UAAU,GACV,WAAW,GACX,QAAQ,GACR,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,gBAAgB,CAAC;AAGrB,wBAAgB,sBAAsB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAmBxE;AAGD,wBAAgB,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAErE"}

package/dist/src/name-policy.js

@@ -11,6 +11,7 @@ export function createCSharpNamePolicy() {
       case "enum":
       case "enum-member":
       case "interface":
+      case "record":
       case "class-member-public":
       case "class-method":
       case "type-parameter":