Skip to content

feat: add standalone React audit trail viewer #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bbbbzzzzcc-afk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add standalone React audit trail viewer #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Software-only: regulated partners execute settlement. Nirium never custodies cli
| TypeScript SDK | `npm install nirium` | Client for the Nirium API, x402/MPP payments, signals, webhooks. |
| Python SDK | `pip install nirium` | Async client with the same surface. |
| CLI | `@nirium/cli` *(publishing soon)* | Scaffold and interact with Nirium from the terminal. |
| Audit Trail Viewer | `npm install @nirium/audit-trail-viewer` | Standalone React widget for IPFS- and Stellar-anchored audit receipts. |

## Quickstart (TypeScript)

Expand Down
52 changes: 52 additions & 0 deletions packages/audit-trail-viewer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# @nirium/audit-trail-viewer

Reusable React widget for displaying IPFS- and Stellar-anchored Nirium audit receipts. The published package has no bundled runtime dependencies; React is a peer dependency.

## Install

```bash
npm install @nirium/audit-trail-viewer
```

## Use

```tsx
import { AuditTrailViewer } from '@nirium/audit-trail-viewer';
import '@nirium/audit-trail-viewer/styles.css';

export function AuditPanel() {
return (
<AuditTrailViewer
app_id="my-app"
apiBaseUrl="https://api.example.com"
stellarNetwork="public"
/>
);
}
```

The widget requests `GET /api/audit/info?app_id=<value>`. `apiBaseUrl` defaults to the current origin. Use the optional `fetcher` prop when the API needs custom headers or a non-browser fetch implementation.

The shipped stylesheet contains the Tailwind utilities used by the component, so applications do not need to add this package to their Tailwind content configuration. It omits Tailwind's preflight reset to avoid changing host application styles.

## Props

| Prop | Type | Default | Description |
|---|---|---|---|
| `app_id` | `string` | required | Application identifier sent to the audit endpoint. |
| `apiBaseUrl` | `string` | `''` | Optional API origin. |
| `ipfsGateway` | `string` | `https://ipfs.io/ipfs/` | Gateway used for CID links. |
| `stellarNetwork` | `public \| testnet \| futurenet` | `public` | Stellar Expert network. |
| `fetcher` | `typeof fetch` | `globalThis.fetch` | Custom request implementation. |
| `className` | `string` | — | Additional root classes. |
| `loadingFallback` | `ReactNode` | built in | Custom loading content. |
| `emptyFallback` | `ReactNode` | built in | Custom empty content. |
| `errorFallback` | `ComponentType<{ error: Error }>` | built in | Custom error component. |
| `onLoad` | `(receipts) => void` | — | Called after a successful request. |

## Development

```bash
npm install
npm run check
```
Loading