@zero-transfer/mft
v0.4.7
Published
Routes, schedules, audit logs, webhooks, approval gates.
Maintainers
Readme
@zero-transfer/mft
Routes, schedules, audit logs, webhooks, approval gates.
Install
npm install @zero-transfer/mftOverview
Managed File Transfer workflow primitives: routes, schedules (interval + cron), inbox/outbox conventions, retention policies, audit logs (in-memory, JSONL, fan-out, webhook-backed), HMAC-signed webhook delivery, and approval gates that require human sign-off before a scheduled run executes.
Usage
import { MftRoute, RouteRegistry, runRoute } from "@zero-transfer/mft";Public surface
This package publishes a narrowed surface of 30 exports. These symbols are also available from @zero-transfer/sdk; the table below links into the full API reference:
| Symbol | Kind | Notes |
| ------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ |
| MftRoute | Interface | See API reference. |
| RouteRegistry | Class | See API reference. |
| runRoute | Function | See API reference. |
| MftSchedule | Interface | See API reference. |
| ScheduleRegistry | Class | See API reference. |
| MftScheduler | Class | See API reference. |
| parseCronExpression | Function | See API reference. |
| nextScheduleFireAt | Function | See API reference. |
| createInboxRoute | Function | See API reference. |
| createOutboxRoute | Function | See API reference. |
| inboxProcessedPath | Function | See API reference. |
| inboxFailedPath | Function | See API reference. |
| evaluateRetention | Function | See API reference. |
| AgeRetentionPolicy | Interface | See API reference. |
| CountRetentionPolicy | Interface | See API reference. |
| InMemoryAuditLog | Class | See API reference. |
| createJsonlAuditLog | Function | See API reference. |
| composeAuditLogs | Function | See API reference. |
| freezeReceipt | Function | See API reference. |
| summarizeError | Function | See API reference. |
| MftAuditLog | Interface | See API reference. |
| MftAuditEntry | Interface | See API reference. |
| dispatchWebhook | Function | See API reference. |
| signWebhookPayload | Function | See API reference. |
| createWebhookAuditLog | Function | See API reference. |
| WebhookTarget | Interface | See API reference. |
| WebhookRetryPolicy | Interface | See API reference. |
| ApprovalRegistry | Class | See API reference. |
| createApprovalGate | Function | See API reference. |
| ApprovalRejectedError | Class | See API reference. |
Examples
| Example | What it shows |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| examples/mft-route.ts | Declarative MFT route + cron schedule. |
| examples/approval-gated-route.ts | Approval gate for sensitive scheduled routes. |
| examples/atomic-deploy-with-rollback.ts | Atomic blue/green-style deploy with rollback over SFTP. |
Documentation
License
MIT © Tony Wiedman
