Snapshot for
@system-core/core0.14.x. Current docs live at /.
logic
Generated Reference
Framework-agnostic backend primitives for logic-only services that do not need the full CMS runtime. This page is generated from core/logic/index.ts against package version 0.14.0 on the 0.14 docs line.
Import
ts
import { createApp, createConfig, createPaymentRegistry } from '@system-core/core/logic'Entry
| Field | Value |
|---|---|
| Import path | @system-core/core/logic |
| Package export | ./logic |
| Source entry | core/logic/index.ts |
| Exported symbols | 229 |
| Runtime file | ./dist/logic.js |
| Types file | ./dist/logic.d.ts |
Use This Surface When
- Use this for reusable backend primitives or logic-only apps bootstrapped with
createApp(). - Adopt it when the project needs auth, API, DB, permissions, ecommerce, or storage helpers without the CMS layer.
- Keep optional framework adapters on their dedicated integration subpaths.
Public Surface
Functions
| Export | Kind | Source |
|---|---|---|
adapterTestSuite | function | core/logic/adapters/node/index.ts |
addMemberToGroup | function | core/logic/modules/user-management/groups.ts |
anonymizeUserData | function | core/logic/modules/gdpr/data-deletion.ts |
buildSecurityHeaders | function | core/logic/api/security-headers.ts |
calculateBackoffDelay | function | core/logic/core/retry.ts |
cancelDeletionRequest | function | core/logic/modules/gdpr/consent.ts |
canCreateRole | function | core/logic/modules/user-management/index.ts |
canDeleteUser | function | core/logic/modules/user-management/index.ts |
canModifyUserRole | function | core/logic/modules/user-management/index.ts |
canWithdrawConsent | function | core/logic/modules/gdpr/consent.ts |
captureError | function | core/logic/core/error-tracking.ts |
captureMessage | function | core/logic/core/error-tracking.ts |
checkBulkPermissions | function | core/logic/modules/permissions/index.ts |
composeGuards | function | core/logic/auth/guards.ts |
copyFile | function | core/logic/modules/storage/index.ts |
createAnonymizedUserData | function | core/logic/modules/gdpr/data-deletion.ts |
createApp | function | core/logic/app.ts |
createAuditLog | function | core/logic/db/audit.ts |
createConfig | function | core/logic/core/config.ts |
createCsrfValidator | function | core/logic/api/csrf.ts |
createDataProcessingRecord | function | core/logic/modules/gdpr/consent.ts |
createEventBus | function | core/logic/modules/events/index.ts |
createGroup | function | core/logic/modules/user-management/groups.ts |
createPrefixedLogger | function | core/logic/core/logger.ts |
createPrivacyPolicyVersion | function | core/logic/modules/gdpr/consent.ts |
createRateLimiter | function | core/logic/core/rate-limit.ts |
createRateLimitMiddleware | function | core/logic/api/rate-limit-middleware.ts |
createRefreshTokenWithSession | function | core/logic/auth/session.ts |
createSecurityHeadersMiddleware | function | core/logic/api/security-headers.ts |
deleteFromStorage | function | core/logic/modules/storage/index.ts |
deleteGroup | function | core/logic/modules/user-management/groups.ts |
deleteUserData | function | core/logic/modules/gdpr/data-deletion.ts |
disable2FA | function | core/logic/auth/2fa-api.ts |
exportUserData | function | core/logic/modules/gdpr/consent.ts |
extendSession | function | core/logic/auth/session.ts |
formatExportData | function | core/logic/modules/gdpr/data-export.ts |
formatRecoveryCode | function | core/logic/core/recovery-code.ts |
generateAccessToken | function | core/logic/auth/jwt.ts |
generateBackupCodes | function | core/logic/auth/2fa-api.ts |
generateConsentBannerText | function | core/logic/modules/gdpr/consent.ts |
generateCsrfToken | function | core/logic/api/csrf.ts |
generateDeletionConfirmationEmail | function | core/logic/modules/gdpr/data-deletion.ts |
generateRecoveryCode | function | core/logic/core/recovery-code.ts |
generateRefreshToken | function | core/logic/auth/jwt.ts |
generateSecret | function | core/logic/auth/2fa-api.ts |
generateTOTP | function | core/logic/auth/2fa-api.ts |
generateUniqueNumber | function | core/logic/db/counters.ts |
generateUserDataExport | function | core/logic/modules/gdpr/data-export.ts |
get2FAStatus | function | core/logic/auth/2fa-api.ts |
getConsentStatus | function | core/logic/modules/gdpr/consent.ts |
getCsrfCookieName | function | core/logic/api/csrf.ts |
getCsrfHeaderName | function | core/logic/api/csrf.ts |
getCurrentPrivacyPolicy | function | core/logic/modules/gdpr/consent.ts |
getGroupMembers | function | core/logic/modules/user-management/groups.ts |
getGroupPermissions | function | core/logic/modules/user-management/groups.ts |
getGroupUsers | function | core/logic/modules/user-management/groups.ts |
getNextDocumentNumber | function | core/logic/db/counters.ts |
getPresignedUrl | function | core/logic/modules/storage/index.ts |
getRetentionCompliance | function | core/logic/modules/gdpr/data-deletion.ts |
getRoleLevel | function | core/logic/modules/permissions/index.ts |
getStorageUrl | function | core/logic/modules/storage/index.ts |
getUserGroups | function | core/logic/modules/user-management/groups.ts |
getUserPermissions | function | core/logic/modules/permissions/index.ts |
getUserStats | function | core/logic/modules/user-management/index.ts |
giveConsent | function | core/logic/modules/gdpr/consent.ts |
hasAllPermissions | function | core/logic/modules/permissions/index.ts |
hasAnyPermission | function | core/logic/modules/permissions/index.ts |
hasConsent | function | core/logic/modules/gdpr/consent.ts |
hashIp | function | core/logic/auth/session.ts |
hashRecoveryCode | function | core/logic/core/recovery-code.ts |
hasPermission | function | core/logic/modules/permissions/index.ts |
initErrorTracking | function | core/logic/core/error-tracking.ts |
initStorage | function | core/logic/modules/storage/index.ts |
isBaseError | function | core/logic/core/errors.ts |
isConsentExpired | function | core/logic/modules/gdpr/consent.ts |
isExportExpired | function | core/logic/modules/gdpr/data-export.ts |
isRetryableError | function | core/logic/core/retry.ts |
isRoleAtLeast | function | core/logic/modules/permissions/index.ts |
isSessionValid | function | core/logic/auth/session.ts |
listObjects | function | core/logic/modules/storage/index.ts |
listUserSessions | function | core/logic/auth/session.ts |
obsToLogger | function | core/logic/core/logger.ts |
okList | function | core/logic/core/api-response.ts |
okMutation | function | core/logic/core/api-response.ts |
paginationMeta | function | core/logic/core/api-response.ts |
parseDeviceInfo | function | core/logic/auth/session.ts |
parseEnv | function | core/logic/core/config.ts |
processDataDeletion | function | core/logic/modules/gdpr/consent.ts |
processDataExport | function | core/logic/modules/gdpr/consent.ts |
publishPrivacyPolicy | function | core/logic/modules/gdpr/consent.ts |
regenerateBackupCodes | function | core/logic/auth/2fa-api.ts |
removeMemberFromGroup | function | core/logic/modules/user-management/groups.ts |
renderTemplate | function | core/logic/core/template.ts |
requestDataDeletion | function | core/logic/modules/gdpr/consent.ts |
requireAuth | function | core/logic/auth/guards.ts |
requireEmailVerified | function | core/logic/auth/guards.ts |
requireOwnership | function | core/logic/auth/guards.ts |
requirePermission | function | core/logic/modules/permissions/index.ts |
requireRole | function | core/logic/auth/guards.ts |
resetStorageClient | function | core/logic/modules/storage/index.ts |
retryWithBackoff | function | core/logic/core/retry.ts |
revokeAllSessions | function | core/logic/auth/session.ts |
revokeOtherSessions | function | core/logic/auth/session.ts |
revokeSession | function | core/logic/auth/session.ts |
rotateRefreshToken | function | core/logic/auth/session.ts |
serializeCsp | function | core/logic/api/security-headers.ts |
setCsrfCookie | function | core/logic/api/csrf.ts |
setupTOTP | function | core/logic/auth/2fa-api.ts |
shouldRetainData | function | core/logic/modules/gdpr/data-deletion.ts |
signWebhookPayload | function | core/logic/modules/events/index.ts |
sleep | function | core/logic/core/retry.ts |
toBaseError | function | core/logic/core/errors.ts |
updateGroup | function | core/logic/modules/user-management/groups.ts |
updateMemberRole | function | core/logic/modules/user-management/groups.ts |
uploadExportFile | function | core/logic/modules/gdpr/data-export.ts |
uploadToStorage | function | core/logic/modules/storage/index.ts |
validateBackupCodes | function | core/logic/auth/2fa-api.ts |
validateConsentInput | function | core/logic/modules/gdpr/consent.ts |
validateOrThrow | function | core/logic/api/validation.ts |
verifyAccessToken | function | core/logic/auth/jwt.ts |
verifyAuthToken | function | core/logic/auth/guards.ts |
verifyBackupCode | function | core/logic/auth/2fa-api.ts |
verifyRecoveryCode | function | core/logic/core/recovery-code.ts |
verifyRefreshToken | function | core/logic/auth/jwt.ts |
verifyTOTP | function | core/logic/auth/2fa-api.ts |
verifyTOTPLogin | function | core/logic/auth/2fa-api.ts |
verifyTOTPSetup | function | core/logic/auth/2fa-api.ts |
verifyWebhookSignature | function | core/logic/modules/events/index.ts |
withdrawConsent | function | core/logic/modules/gdpr/consent.ts |
withdrawConsentByType | function | core/logic/modules/gdpr/consent.ts |
Classs
| Export | Kind | Source |
|---|---|---|
BaseError | class | core/logic/core/errors.ts |
ConfigurationError | class | core/logic/core/errors.ts |
ConflictError | class | core/logic/core/errors.ts |
CsrfError | class | core/logic/core/errors.ts |
ForbiddenError | class | core/logic/core/errors.ts |
NotFoundError | class | core/logic/core/errors.ts |
RateLimitError | class | core/logic/core/errors.ts |
RetryableOperation | class | core/logic/core/retry.ts |
TokenExpiredError | class | core/logic/core/errors.ts |
UnauthorizedError | class | core/logic/core/errors.ts |
UpstreamError | class | core/logic/core/errors.ts |
ValidationError | class | core/logic/core/errors.ts |
Consts
| Export | Kind | Source |
|---|---|---|
CONSENT_TYPES | const | core/logic/modules/gdpr/types.ts |
consoleLogger | const | core/logic/core/logger.ts |
DEFAULT_CONSENT_VERSION | const | core/logic/modules/gdpr/types.ts |
DEFAULT_RETENTION_PERIODS | const | core/logic/modules/gdpr/types.ts |
DEFAULT_RETENTION_POLICY | const | core/logic/modules/gdpr/data-deletion.ts |
DEFAULT_ROLES | const | core/logic/modules/permissions/index.ts |
LEGAL_BASES | const | core/logic/modules/gdpr/types.ts |
nullLogger | const | core/logic/core/logger.ts |
resetTransporter | const | core/logic/modules/email/index.ts |
schemas | const | core/logic/api/validation.ts |
sendEmail | const | core/logic/modules/email/index.ts |
validateEnv | const | core/logic/core/config.ts |
Interfaces
| Export | Kind | Source |
|---|---|---|
AppConfig | interface | core/logic/types/index.ts |
AppCsrf | interface | core/logic/app.ts |
AppDeps | interface | core/logic/app.ts |
AppInstance | interface | core/logic/app.ts |
AuditEntry | interface | core/logic/db/audit.ts |
AuditLogAdapter | interface | core/logic/modules/events/index.ts |
AuthSessionInfo | interface | core/logic/auth/session.ts |
BackupCode | interface | core/logic/auth/2fa-types.ts |
ConsentInput | interface | core/logic/modules/gdpr/types.ts |
ConsentPreferences | interface | core/logic/modules/gdpr/types.ts |
ConsentRecord | interface | core/logic/modules/gdpr/types.ts |
CookieOptions | interface | core/logic/types/index.ts |
CreateDeletionRequestInput | interface | core/logic/modules/gdpr/types.ts |
CreateExportRequestInput | interface | core/logic/modules/gdpr/types.ts |
CreateGroupInput | interface | core/logic/modules/user-management/groups.ts |
DataDeletionRequest | interface | core/logic/modules/gdpr/types.ts |
DataExportRequest | interface | core/logic/modules/gdpr/types.ts |
DataProcessingRecord | interface | core/logic/modules/gdpr/types.ts |
DeletionError | interface | core/logic/modules/gdpr/data-deletion.ts |
DeletionItem | interface | core/logic/modules/gdpr/data-deletion.ts |
DeletionReport | interface | core/logic/modules/gdpr/data-deletion.ts |
DomainEvent | interface | core/logic/types/index.ts |
EmailConfig | interface | core/logic/auth/2fa-types.ts |
EmailDeps | interface | core/logic/modules/email/index.ts |
EmailOptions | interface | core/logic/types/index.ts |
EmailProviderConfig | interface | core/logic/types/index.ts |
EmailResult | interface | core/logic/types/index.ts |
EventBus | interface | core/logic/modules/events/index.ts |
ExportableData | interface | core/logic/modules/gdpr/data-export.ts |
GDPRDeps | interface | core/logic/modules/gdpr/types.ts |
GuardDeps | interface | core/logic/auth/guards.ts |
HttpAdapter | interface | core/logic/types/index.ts |
JwtConfig | interface | core/logic/types/index.ts |
Logger | interface | core/logic/core/logger.ts |
PermissionDeps | interface | core/logic/modules/permissions/index.ts |
PrivacyPolicyVersion | interface | core/logic/modules/gdpr/types.ts |
RateLimitConfig | interface | core/logic/types/index.ts |
RateLimiter | interface | core/logic/core/rate-limit.ts |
RateLimitMiddlewareOptions | interface | core/logic/api/rate-limit-middleware.ts |
RoleConfig | interface | core/logic/modules/user-management/index.ts |
SecurityHeadersOptions | interface | core/logic/api/security-headers.ts |
SessionDeps | interface | core/logic/auth/session.ts |
SessionInfo | interface | core/logic/auth/session.ts |
StorageConfig | interface | core/logic/types/index.ts |
StorageProvider | interface | core/logic/types/index.ts |
TotpConfig | interface | core/logic/auth/2fa-types.ts |
TotpSetupResult | interface | core/logic/auth/2fa-types.ts |
TotpVerifyResult | interface | core/logic/auth/2fa-types.ts |
TwoFactorChallenge | interface | core/logic/auth/2fa-types.ts |
TwoFactorConfig | interface | core/logic/auth/2fa-types.ts |
TwoFactorDeps | interface | core/logic/auth/2fa-types.ts |
UpdateGroupInput | interface | core/logic/modules/user-management/groups.ts |
UserGroup | interface | core/logic/modules/user-management/groups.ts |
UserGroupDeps | interface | core/logic/modules/user-management/groups.ts |
UserGroupMember | interface | core/logic/modules/user-management/groups.ts |
UserManagementDeps | interface | core/logic/modules/user-management/index.ts |
WebhookOptions | interface | core/logic/modules/events/index.ts |
Types
| Export | Kind | Source |
|---|---|---|
Config | type | core/logic/core/config.ts |
ConsentCategory | type | core/logic/modules/gdpr/types.ts |
ConsentType | type | core/logic/modules/gdpr/types.ts |
ContactInput | type | core/logic/api/validation.ts |
ContentCreateInput | type | core/logic/api/validation.ts |
CspDirectiveName | type | core/logic/api/security-headers.ts |
CspDirectives | type | core/logic/api/security-headers.ts |
DataExportStatus | type | core/logic/modules/gdpr/types.ts |
DeletionStatus | type | core/logic/modules/gdpr/types.ts |
DeletionType | type | core/logic/modules/gdpr/types.ts |
DeviceType | type | core/logic/types/index.ts |
EnvSchema | type | core/logic/core/config.ts |
Guard | type | core/logic/auth/guards.ts |
LegalBasis | type | core/logic/modules/gdpr/types.ts |
LoginInput | type | core/logic/api/validation.ts |
RegisterInput | type | core/logic/api/validation.ts |
StorageConfigResolver | type | core/logic/modules/storage/index.ts |
UserCreateInput | type | core/logic/api/validation.ts |