Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/novuhq/novu-dotnet
.NET SDK for Novu - The open-source notification infrastructure for engineers. 🚀
https://github.com/novuhq/novu-dotnet
dotnet-core hacktoberfest novu novu-api
Last synced: about 1 month ago
JSON representation
.NET SDK for Novu - The open-source notification infrastructure for engineers. 🚀
- Host: GitHub
- URL: https://github.com/novuhq/novu-dotnet
- Owner: novuhq
- License: mit
- Created: 2023-03-21T22:53:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T20:14:32.000Z (10 months ago)
- Last Synced: 2024-02-29T21:30:18.592Z (10 months ago)
- Topics: dotnet-core, hacktoberfest, novu, novu-api
- Language: C#
- Homepage:
- Size: 247 KB
- Stars: 24
- Watchers: 10
- Forks: 12
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# novu-dotnet
[](https://www.nuget.org/packages/Novu/)
[](https://www.nuget.org/packages/Novu/)
[](https://github.com/novuhq/novu-dotnet/actions/workflows/dotnet-deploy.yaml)
.NET SDK for Novu - The open-source notification infrastructure for engineers. 🚀
novu-dotnet targets .NET Standard 2.0 and is compatible with .NET Core 2.0+ and .NET Framework 4.6.1+.
## Features
- Bindings against most [API endpoints](https://docs.novu.co/api/overview/)
- Events, subscribers, notifications, integrations, layouts, topics, workflows, workflow groups, messages, execution details
- Not Implemented: [environments](https://docs.novu.co/api/get-current-environment/), [inbound parse](https://docs.novu.co/api/validate-the-mx-record-setup-for-the-inbound-parse-functionality/), [changes](https://docs.novu.co/api/get-changes/)
- Bootstrap each services as part of services provider or directly as a singleton class (setting injectable)
- A Sync service that will mirror an environment based a set of templates (layouts, integrations, workflow groups, workflows)
**WARNING**: 0.3.0 has breaking changes and the tests should be relied on for understanding the client libraries
## Dependencies
| dotnet novu | novu api [package](https://github.com/novuhq/novu/pkgs/container/novu%2Fapi) | Notes |
| ----------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 0.2.2 | <= 0.17 | Singleton client with Refit's use of RestService |
| 0.3.0 | >= 0.18 | 0.3.0 is not compatible with 0.2.2 and requires upgrade to code. Also 0.18 introduced a breaking change only found in 0.3.0. All 0.2.2 must be upgraded if used against the production system. HttpClient can now be used and injected. |
| 0.3.1 | >= 0.18 | Failed release. You will not find this release on Nuget. |
| 0.3.2 | >= 0.18 | [BREAKING} Obsolete Notification Templates has been removed. Service registration separation of single client and each client. Novu.Extension and Novu.Sync released as packages. |
## Installation
```bash
dotnet add package Novu
```
## Configuration
### Direct instantiation
```csharp
using Novu.DTO;
using Novu.Models;
using Novu;
var novuConfiguration = new NovuClientConfiguration
{
// Defaults to https://api.novu.co/v1
Url = "https://novu-api.my-domain.com/v1",
ApiKey = "12345",
};
var novu = new NovuClient(novuConfiguration);
// Note: this client exposes all endpoints as methods but uses RestService
var subscribers = await novu.Subscriber.Get();
```
### Dependency Injection
Configure via settings
```appsettings.json
{
"Novu": {
"Url": "http://localhost:3000/v1",
"ApiKey": "e36b820fcc9a68a83db6c79c30f1a461"
}
}
```
Setup Injection via extension methods
```csharp
public static IServiceCollection RegisterNotificationSetupServices(
this IServiceCollection services,
IConfiguration configuration)
{
// registers all clients with novu config from appsetting.json
// the services inject HttpClient
return services
.RegisterNovuClients(configuration)
// here as an example that the registered services are injected into local service
.AddTransient();
}
```
Write your consuming code with the injected clients
```csharp
// then instantiate via injection
public class NovuNotificationService
{
private readonly IEventClient _event;
public NovuSyncService(IEventClient @event)
{
_event = @event;
}
public async Task Trigger(string subscriberId){
var trigger = await Event.Trigger(
new EventCreateData
{
EventName = 'event-name',
To = { SubscriberId =subscriberId },
Payload = new Payload("Bogus payload"),
});
}
public record Payload(string Message)
{
[JsonProperty("message")] public string Message { get; set; }
}
}
```
## Examples
Usage of the library is best understood by looking at the tests.
- [Integration Tests](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu.Tests/IntegrationTests): these show the minimal dependencies required to do one primary request (create, update, delete)
- [Acceptance Tests](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu.Tests/AcceptanceTests): these show a sequence of actions to complete a business process in an environment
## Repository Overview
[Novu](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu) is the main SDK with [Novu.Tests](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu.Tests) housing all unit tests. [Novu.Extensions](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu.Extensions) is required for DI and [Novu.Sync](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu.Sync)
if your are looking for mirroring environments.
### novu-dotnet
The key folders to look into:
- [DTO](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu/DTO) directory holds all objects needed to use the clients
- [Interfaces](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu/Interfaces) directory holds all interfaces that are intended to outline how a class should be structured
- [Models](https://github.com/novuhq/novu-dotnet/tree/main/src/Novu/Models) directory holds various models that are sub-resources inside the DTOs
### Major changes
Github issues closed
#### 0.3.1
- #57
- #58
- #59
- #60
- #55
#### 0.3.0
- #19
- #20
- #21
- #34
- #48
- #49
- #50
- #47
- #45