DotNet TS Generator (.NET 6, 8, & 10)

This will build a d.ts file from a .net assembly. It supports .NET 6.0, .NET 8.0, and .NET 10.0.

Simply add both TS.CodeGenerator and TS.CodeGenerator.Console Nuget packages to your project, and the built-in MSBuild target will generate a .d.ts file at the root of your project folder after the project is built. [https://www.nuget.org/packages/TS.CodeGenerator]

[https://www.nuget.org/packages/TS.CodeGenerator.Console]

Optionally, consumers can provide a serialized settings object in a file to alter generator behavior. Add a file named "TSGeneratorSettings.json" to the root of your consuming project with content similar to:

{
    "MethodReturnTypeFormatString" : "Promise<{0}>",
    "MakeMethodsOptional": false
}

Possible values are defined in the OverrideSettings class (see OverrideSettings.cs [https://github.com/maxfridbe/DotNetTSGenerator/blob/master/TS/TS.CodeGenerator.MSBuildTasks/OverrideSettings.cs])

TODO: Get the MSBuildTargets project working if an explicit MSBuild target in one "fat" NuGet package is desirable.

After adding both TS.CodeGenerator and TS.CodeGenerator.MSBuildTargets Nuget packages to your project, add this target to to your .csproj:

<Target Name="RunGenerateTypescriptTask" AfterTargets="Build">
      <GenerateTypescriptTask InputDLL="$(MSBuildThisFileDirectory)bin\debug\net10.0\aaa.dll" OutputDTS="..\out.d.ts"/>
</Target>

Be sure to modify the InputDLL and OutputDTS values to match your project's needs!

END TODO

Rationale

This is designed to run as a post build step on your *.Contracts.dll. It will take PONOs and convert them to Typescript interfaces.

Example Output

Classes and Interfaces

public class Model
{
    public string Name { get; set; }
}

public interface IModelService
{
    Model GetModelFromModel(Model aModel, string path);
}

//MYNS.Model
interface IModel{
  //properties
	Name: string; //System.String
}

//MYNS.IModelService
interface IModelService{

  //methods
	GetModelFromModel(aModel:IModel/*Model*/,path:string/*String*/):JQueryPromise<IModel>;
}

C# Record Classes

C# record classes are supported. Compiler-generated members (<Clone>$, Deconstruct, Equals, GetHashCode, ToString, PrintMembers) are automatically filtered out, producing clean interfaces with only the record's declared properties.

public record Person(string Name, int Age);

public record Employee(string Department, decimal Salary) : Person("", 0);

//MYNS.Person
interface IPerson{
  //properties
	Name: string; //System.String
	Age: number; //System.Int32
}

//MYNS.Employee
interface IEmployee extends IPerson{
  //properties
	Department: string; //System.String
	Salary: number; //System.Decimal
}