NSprites 0.1.4

NSprites

A .NET client library for the Sprites.dev API.

Features

• Full REST API Support: Create, manage, and delete sprites
• Checkpoint Management: Create and restore filesystem snapshots
• Command Execution: Run commands with streaming output
• Async/Await: Modern async API throughout
• Strongly Typed: Full type safety with records and enums
• Testable: Dependency injection friendly with mocked HTTP clients

Installation

dotnet add package NSprites

Quick Start

using NSprites;

// Create a client with your token
var client = new SpritesClient("your-sprites-token");

// Create a new sprite
var sprite = await client.CreateSpriteAsync(new CreateSpriteRequest("my-sprite"));
Console.WriteLine($"Created sprite: {sprite.Url}");

// Get an existing sprite client
var mySprite = client.Sprite("my-sprite");

// Run a command
var result = await mySprite.Exec.RunCommandAsync(
    new ExecuteRequest(new[] { "echo", "Hello, World!" }));

Console.WriteLine(result.Stdout); // "Hello, World!\n"

// Create a checkpoint
await foreach (var @event in mySprite.Checkpoints.CreateAsync("Before deployment"))
{
    Console.WriteLine($"Checkpoint: {@event.Data}");
}

// List checkpoints
var checkpoints = await mySprite.Checkpoints.ListAsync();
foreach (var cp in checkpoints)
{
    Console.WriteLine($"Checkpoint: {cp.Id} - {cp.Comment}");
}

API Overview

Sprites

// List all sprites
var sprites = await client.ListSpritesAsync();

// Create a sprite
var sprite = await client.CreateSpriteAsync(new CreateSpriteRequest("my-app"));

// Get sprite details
var details = await client.Sprite("my-app").GetAsync();

// Update URL settings
await client.Sprite("my-app").UpdateUrlSettingsAsync("public");

// Delete a sprite
await client.Sprite("my-app").DeleteAsync();

Checkpoints

var checkpoints = client.Sprite("my-app").Checkpoints;

// Create a checkpoint with streaming events
await foreach (var @event in checkpoints.CreateAsync("Backup before deploy"))
{
    Console.WriteLine($"{@event.Type}: {@event.Data}");
}

// List checkpoints
var list = await checkpoints.ListAsync();

// Get specific checkpoint
var cp = await checkpoints.GetAsync("v1");

// Restore to a checkpoint
await foreach (var @event in checkpoints.RestoreAsync("v1"))
{
    Console.WriteLine($"{@event.Type}: {@event.Data}");
}

Command Execution

var exec = client.Sprite("my-app").Exec;

// Run a simple command
var result = await exec.RunCommandAsync(
    new ExecuteRequest(new[] { "python", "-c", "print(42)" }));

Console.WriteLine($"Exit code: {result.ExitCode}");
Console.WriteLine($"Output: {result.Stdout}");

// Run with environment variables
var result = await exec.RunCommandAsync(new ExecuteRequest(
    Command: new[] { "env" },
    Env: new[] { "MY_VAR=test" },
    Dir: "/tmp"
));

// List active sessions
var sessions = await exec.ListSessionsAsync();

// Kill a session
await foreach (var @event in exec.KillSessionAsync(123))
{
    Console.WriteLine($"{@event.Type}: {@event.Message}");
}

Error Handling

All API errors are wrapped in SpritesApiException:

try
{
    var sprite = await client.Sprite("nonexistent").GetAsync();
}
catch (SpritesApiException ex)
{
    Console.WriteLine($"API Error: {ex.ErrorCode} - {ex.Message}");
    // ErrorCode: NotFound, StatusCode: 404
}

Available error codes:

• Unauthorized - Authentication required
• Forbidden - Access denied
• NotFound - Resource not found
• Conflict - Resource conflict
• ValidationError - Invalid request data
• RateLimited - Too many requests
• InternalServerError - Server error

Testing

The library is designed for easy testing with dependency injection:

// In production
var client = new SpritesClient("token");

// In tests
var mockHttp = new HttpClient(new HttpMessageHandlerMock());
var client = new SpritesClient("token", mockHttp);

See the test files for examples of mocking HTTP responses.

Requirements

• .NET 10.0+
• Sprites.dev account and API token

License

MIT