Add type generation

BOLL7708 · BOLL7708 · commit 16de5a379456 · 2024-08-17T00:51:48.000+02:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -50,6 +50,15 @@ jobs:
       - name: Restore local tools
         run: dotnet tool restore
 
+      - name: Generate TypeScript
+        run: dotnet dotnet-typegen generate -p OpenVROverlayPipe
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: Types
+          path: Types
+
   release:
     name: Upload Release
     runs-on: ubuntu-latest
@@ -69,3 +78,31 @@ jobs:
         with:
           files: |
             **/*.zip
+
+  publishNPM:
+    name: Publish NPM Package
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: Types
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install TypeScript
+        run: npm install -g typescript
+
+      - name: Build TypeScript
+        run: tsc
+
+      - run: |
+          cd ./dist
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,10 @@
 # TypeScript
 *.js.map
+Types/**/*.ts
+Types/**/*.js
+Types/**/*.js.map
+Types/**/*.d.ts
+Types/**/*.d.ts.map
 
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
diff --git a/OpenVROverlayPipe/Input/DataNotification.cs b/OpenVROverlayPipe/Input/DataNotification.cs
@@ -1,5 +1,8 @@
+using TypeGen.Core.TypeAnnotations;
+
 namespace OpenVROverlayPipe.Input;
 
+[ExportTsInterface]
 public class DataNotification
 {
     public string Title = "OpenVROverlayPipe";
diff --git a/OpenVROverlayPipe/Input/DataOverlay.cs b/OpenVROverlayPipe/Input/DataOverlay.cs
@@ -1,8 +1,10 @@
 using OpenVROverlayPipe.Notification;
+using TypeGen.Core.TypeAnnotations;
 using static EasyOpenVR.Utils.EasingUtils;
 
 namespace OpenVROverlayPipe.Input;
 
+[ExportTsInterface]
 public class DataOverlay
 {
     public string ImageData = "";
diff --git a/OpenVROverlayPipe/Input/InputMessage.cs b/OpenVROverlayPipe/Input/InputMessage.cs
@@ -1,5 +1,8 @@
+using TypeGen.Core.TypeAnnotations;
+
 namespace OpenVROverlayPipe.Input;
 
+[ExportTsInterface]
 internal class InputMessage
 {
     public InputMessageKeyEnum Key = InputMessageKeyEnum.None;
diff --git a/OpenVROverlayPipe/OpenVROverlayPipe.csproj b/OpenVROverlayPipe/OpenVROverlayPipe.csproj
@@ -37,6 +37,7 @@
     <PackageReference Include="OpenTK.GLWpfControl" Version="4.3.1" />
     <PackageReference Include="Microsoft.AspNetCore.SystemWebAdapters" Version="1.3.0" />
     <PackageReference Include="System.Configuration.ConfigurationManager" Version="8.0.0" />
+    <PackageReference Include="TypeGen" Version="5.0.1" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\EasyOpenVR\EasyOpenVR.csproj" />
diff --git a/OpenVROverlayPipe/Output/OutputDataButton.cs b/OpenVROverlayPipe/Output/OutputDataButton.cs
@@ -1,7 +1,9 @@
+using TypeGen.Core.TypeAnnotations;
 using Valve.VR;
 
 namespace OpenVROverlayPipe.Output;
 
+[ExportTsInterface]
 public class OutputDataButton(EVRMouseButton button = 0)
 {
     public EVRMouseButton Button = button;
diff --git a/OpenVROverlayPipe/Output/OutputDataPosition.cs b/OpenVROverlayPipe/Output/OutputDataPosition.cs
@@ -1,5 +1,8 @@
+using TypeGen.Core.TypeAnnotations;
+
 namespace OpenVROverlayPipe.Output;
 
+[ExportTsInterface]
 public class OutputDataPosition(float x = 0, float y = 0)
 {
     public float X = x;
diff --git a/OpenVROverlayPipe/Output/OutputMessage.cs b/OpenVROverlayPipe/Output/OutputMessage.cs
@@ -1,7 +1,9 @@
 using OpenVROverlayPipe.Input;
+using TypeGen.Core.TypeAnnotations;
 
 namespace OpenVROverlayPipe.Output;
 
+[ExportTsInterface]
 internal class OutputMessage
 {
     public OutputMessageTypeEnum Type = OutputMessageTypeEnum.Undefined;
diff --git a/OpenVROverlayPipe/Properties/Resources.resx b/OpenVROverlayPipe/Properties/Resources.resx
@@ -125,6 +125,6 @@
     <value>..\resources\logo.ico;System.Drawing.Icon, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
   <data name="Version" xml:space="preserve">
-    <value>v4.1.0</value>
+    <value>v4.1.1</value>
   </data>
 </root>
diff --git a/OpenVROverlayPipe/TypeGenSpec.cs b/OpenVROverlayPipe/TypeGenSpec.cs
@@ -0,0 +1,11 @@
+using TypeGen.Core.SpecGeneration;
+
+namespace OpenVROverlayPipe;
+
+public class TypeGenSpec : GenerationSpec
+{
+    public override void OnBeforeBarrelGeneration(OnBeforeBarrelGenerationArgs args)
+    {
+        AddBarrel(".");
+    }
+}
diff --git a/OpenVROverlayPipe/tgconfig.json b/OpenVROverlayPipe/tgconfig.json
@@ -0,0 +1,14 @@
+{
+  "outputPath": "../Types/src",
+  "propertyNameConverters": [
+    "PascalCaseToCamelCase"
+  ],
+  "generationSpecs": [
+    "TypeGenSpec"
+  ],
+  "generateFromAssemblies": true,
+  "clearOutputDirectory": true,
+  "csNullableTranslation": "null",
+  "singleQuotes": true,
+  "explicitPublicAccessor": true
+}
diff --git a/Types/dist/README.md b/Types/dist/README.md
@@ -0,0 +1,3 @@
+# OpenVR2WS Types
+
+These are automatically generated type definitions for the OpenVROverlayPipe application.
diff --git a/Types/dist/package.json b/Types/dist/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "openvroverlaypipe-types",
+  "version": "4.1.1",
+  "description": "TypeScript type definitions for the input and output of OpenVROverlayPipe.",
+  "type": "module",
+  "types": "types/index.d.ts",
+  "main": "types/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BOLL7708/OpenVROverlayPipe.git"
+  },
+  "keywords": [
+    "OpenVROverlayPipe",
+    "Types",
+    "Definitions",
+    "TypeScript",
+    "OpenVR"
+  ],
+  "author": "BOLL7708",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/BOLL7708/OpenVROverlayPipe/issues"
+  },
+  "homepage": "https://github.com/BOLL7708/OpenVROverlayPipe#readme"
+}
diff --git a/Types/tsconfig.json b/Types/tsconfig.json
@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+    "moduleDetection": "force",
+    "allowJs": true,
+    "isolatedModules": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "module": "ESNext",
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "lib": [
+      "es2022"
+    ],
+    "sourceRoot": "./src",
+    "rootDir": "./src",
+    "outDir": "./dist/types"
+  },
+  "include": [
+    "src/**/*"
+  ]
+}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
	`1`	`+using TypeGen.Core.TypeAnnotations;`
	`2`	`+`
`1`	`3`	`namespace OpenVROverlayPipe.Input;`
`2`	`4`
	`5`	`+[ExportTsInterface]`
`3`	`6`	`public class DataNotification`
`4`	`7`	`{`
`5`	`8`	`public string Title = "OpenVROverlayPipe";`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
`1`	`1`	`using OpenVROverlayPipe.Notification;`
	`2`	`+using TypeGen.Core.TypeAnnotations;`
`2`	`3`	`using static EasyOpenVR.Utils.EasingUtils;`
`3`	`4`
`4`	`5`	`namespace OpenVROverlayPipe.Input;`
`5`	`6`
	`7`	`+[ExportTsInterface]`
`6`	`8`	`public class DataOverlay`
`7`	`9`	`{`
`8`	`10`	`public string ImageData = "";`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
	`1`	`+using TypeGen.Core.TypeAnnotations;`
`1`	`2`	`using Valve.VR;`
`2`	`3`
`3`	`4`	`namespace OpenVROverlayPipe.Output;`
`4`	`5`
	`6`	`+[ExportTsInterface]`
`5`	`7`	`public class OutputDataButton(EVRMouseButton button = 0)`
`6`	`8`	`{`
`7`	`9`	`public EVRMouseButton Button = button;`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`using OpenVROverlayPipe.Input;`
	`2`	`+using TypeGen.Core.TypeAnnotations;`
`2`	`3`
`3`	`4`	`namespace OpenVROverlayPipe.Output;`
`4`	`5`
	`6`	`+[ExportTsInterface]`
`5`	`7`	`internal class OutputMessage`
`6`	`8`	`{`
`7`	`9`	`public OutputMessageTypeEnum Type = OutputMessageTypeEnum.Undefined;`