readme

Author: Miguel Bernard

.vscode/launch.json

@@ -0,0 +1,26 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            // Use IntelliSense to find out which attributes exist for C# debugging
+            // Use hover for the description of the existing attributes
+            // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            // If you have changed target frameworks, make sure to update the program path.
+            "program": "${workspaceFolder}/src/MBernard.CloudEvents.StronglyTyped.Tests.Unit/bin/Debug/net5.0/MBernard.CloudEvents.StronglyTyped.Tests.Unit.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}/src/MBernard.CloudEvents.StronglyTyped.Tests.Unit",
+            // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach"
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,42 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "${workspaceFolder}/src/MBernard.CloudEvents.StronglyTyped.Tests.Unit/MBernard.CloudEvents.StronglyTyped.Tests.Unit.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "publish",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "publish",
+                "${workspaceFolder}/src/MBernard.CloudEvents.StronglyTyped.Tests.Unit/MBernard.CloudEvents.StronglyTyped.Tests.Unit.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "watch",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "watch",
+                "run",
+                "${workspaceFolder}/src/MBernard.CloudEvents.StronglyTyped.Tests.Unit/MBernard.CloudEvents.StronglyTyped.Tests.Unit.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}

README.md

@@ -1,5 +1,28 @@
-# CloudEvents.Typed
+# CloudEvents. Typed
 
 [![CI](https://github.com/mbernard/CloudEvents.Typed/actions/workflows/ci.yml/badge.svg)](https://github.com/mbernard/CloudEvents.Typed/actions/workflows/ci.yml)
 [![CodeQL](https://github.com/mbernard/CloudEvents.StronglyTyped/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/mbernard/CloudEvents.StronglyTyped/actions/workflows/codeql-analysis.yml)
-[![Publish NuGet](https://github.com/mbernard/CloudEvents.StronglyTyped/actions/workflows/Publish.yml/badge.svg)](https://github.com/mbernard/CloudEvents.StronglyTyped/actions/workflows/Publish.yml)
+[![Publish NuGet](https://github.com/mbernard/CloudEvents.StronglyTyped/actions/workflows/Publish.yml/badge.svg)](https://github.com/mbernard/CloudEvents.StronglyTyped/actions/workflows/Publish.yml)
+
+`CloudEvents. StronglyTyped` is an opinionated library that removes some friction of the `CloudNative.CloudEvents` C# SDK by providing a strongly typed implementation of the `CloudEvent<T>` class.
+The library also provides multiple utils to manipulate, transform and create CloudEvents.
+
+# Goals
+* Conventions over configuration
+* Provide good default, but make everything extensible
+* More userfriendly to use than the default C# SDK
+* Type safety to avoid run-time errors
+* Avoid confusion regarding the content of the Data property of a CloudEvent
+* Modern design using C# 9 records
+* Structural equality
+* Intended to be used and passed around in your application business domain layer (carries all the metadata you need without the serialization information)
+* Very opinionated
+# In a nutshell
+
+## TODO image here
+
+# Design choices
+
+## `dataContentType` and `dataSchema` are not present on the CloudEvent<T> object
+
+`CloudEvent<T>` is considered a deserialized version of your cloud event; thus, those properties are no longer required as the `Data` property represents an in-memory object. If the event needs to be re-serialized, those values should be included on the non-generic CloudEvent before serializing with the formatter.

src/MBernard.CloudEvents.StronglyTyped.Tests.Unit/Data/UserCreatedRecordDataContract.cs

@@ -3,7 +3,7 @@
 
 namespace MBernard.CloudEvents.StronglyTyped.Tests.Unit.Data
 {
-    [DataContract(Namespace = "https://miguelbernard.com/cloudevent.typed", Name = "user.created.v1")]
+    [DataContract(Namespace = "https://miguelbernard.com/cloudevent.stronglytyped", Name = "user.created.v1")]
     public record UserCreatedRecordDataContract
     {
         [DataMember]