Snapshot for
@system-core/core0.8.x. Current docs live at /.
delivery
Generated Reference
Transactional delivery, notification wiring, mail adapters, and delivery metadata exposed through the root package. This page is generated from core/delivery/index.ts against package version 0.8.1 on the 0.8 docs line.
Import
ts
import { createDeliverySystem, getDeliverySettings, patchDeliverySettings } from '@system-core/core'Entry
| Field | Value |
|---|---|
| Import path | @system-core/core |
| Package export | . |
| Source entry | core/delivery/index.ts |
| Exported symbols | 47 |
| Runtime file | ./dist/index.js |
| Types file | ./dist/index.d.ts |
Use This Surface When
- Use this surface for package-owned mail, SMS, and delivery configuration flows.
- Keep form notifications and auth notification delivery inside this boundary.
- Treat delivery as infrastructure owned by system-core rather than app-local ad hoc helpers.
Public Surface
Functions
| Export | Kind | Source |
|---|---|---|
buildDeliverySettingsData | function | core/delivery/schema.ts |
buildStorageSettingsData | function | core/delivery/schema.ts |
createDeliverySystem | function | core/delivery/system.ts |
getDeliverySettings | function | core/delivery/api.ts |
getStorageSettings | function | core/delivery/api.ts |
parseDeliverySettings | function | core/delivery/schema.ts |
parseStorageSettings | function | core/delivery/schema.ts |
patchDeliverySettings | function | core/delivery/api.ts |
patchStorageSettings | function | core/delivery/api.ts |
putDeliverySettings | function | core/delivery/api.ts |
putStorageSettings | function | core/delivery/api.ts |
sendTwoFactorCode | function | core/delivery/notifications.ts |
wireNotificationEvents | function | core/delivery/notifications.ts |
Consts
| Export | Kind | Source |
|---|---|---|
DELIVERY_CHANNEL_DEFAULTS | const | core/delivery/schema.ts |
DELIVERY_FIELD_LABELS | const | core/delivery/meta.ts |
DELIVERY_MAIL_PROVIDER_META | const | core/delivery/meta.ts |
DELIVERY_NOTIFICATION_TRIGGER_META | const | core/delivery/meta.ts |
DELIVERY_SETTINGS_DEFAULTS | const | core/delivery/schema.ts |
DELIVERY_SETTINGS_GROUP_META | const | core/delivery/meta.ts |
DELIVERY_SMS_DEFAULTS | const | core/delivery/schema.ts |
DELIVERY_SMS_PROVIDER_META | const | core/delivery/meta.ts |
DELIVERY_STORAGE_PROVIDER_META | const | core/delivery/meta.ts |
DELIVERY_VALIDATION_HINTS | const | core/delivery/meta.ts |
NOTIFICATION_TRIGGER_DEFAULTS | const | core/delivery/schema.ts |
STORAGE_SETTINGS_DEFAULTS | const | core/delivery/schema.ts |
Interfaces
| Export | Kind | Source |
|---|---|---|
DeliveryChannelSettings | interface | core/delivery/types.ts |
DeliveryDeps | interface | core/delivery/api.ts |
DeliveryDigestRule | interface | core/delivery/types.ts |
DeliveryLogEntry | interface | core/delivery/types.ts |
DeliveryMailSettings | interface | core/delivery/types.ts |
DeliverySettings | interface | core/delivery/types.ts |
DeliverySmsSettings | interface | core/delivery/types.ts |
DeliverySystem | interface | core/delivery/system.ts |
FormNotificationDefaults | interface | core/delivery/types.ts |
FormNotificationRouting | interface | core/delivery/types.ts |
LocalStorageSettings | interface | core/delivery/types.ts |
NotificationTriggers | interface | core/delivery/types.ts |
NotificationTriggerSettings | interface | core/delivery/types.ts |
NotificationWiringOptions | interface | core/delivery/notifications.ts |
S3StorageSettings | interface | core/delivery/types.ts |
StorageSettings | interface | core/delivery/types.ts |
StorageSettingsDeps | interface | core/delivery/api.ts |
Types
| Export | Kind | Source |
|---|---|---|
DeliveryChannel | type | core/delivery/types.ts |
DeliveryDigestCadence | type | core/delivery/types.ts |
DeliveryMailProvider | type | core/delivery/types.ts |
DeliverySmsProvider | type | core/delivery/types.ts |
ManagedStorageProviderType | type | core/delivery/types.ts |