Snapshot for @system-core/core 0.8.x. Current docs live at /.

core

Generated Reference

Unified bootstrap and runtime assembly for CMS, auth, delivery, storage, and platform primitives. This page is generated from core/index.ts against package version 0.8.1 on the 0.8 docs line.

Import

import { createSystem, CORE_VERSION } from '@system-core/core'

Entry

Field	Value
Import path	`@system-core/core`
Package export	`.`
Source entry	`core/index.ts`
Exported symbols	`222`
Runtime file	`./dist/index.js`
Types file	`./dist/index.d.ts`

Use This Surface When

Use this for full products that need one authoritative runtime object.
Bootstrap Prisma-backed CMS, auth, delivery, storage, hooks, events, and policies together.
Prefer this over createApp() when the project needs package-owned CMS or content state.

Public Surface

Functions

Export	Kind	Source
`acceptInvite`	`function`	`core/auth/onboarding.ts`
`addRolePermissions`	`function`	`core/auth/roles.ts`
`assignUserRole`	`function`	`core/auth/users.ts`
`authenticateWithMagicLink`	`function`	`core/auth/authentication.ts`
`authenticateWithPassword`	`function`	`core/auth/authentication.ts`
`buildDeliverySettingsData`	`function`	`core/delivery/schema.ts`
`buildStorageSettingsData`	`function`	`core/delivery/schema.ts`
`checkBulkPermissions`	`function`	`core/auth/authorization.ts`
`createAuditPlugin`	`function`	`core/platform/plugins.ts`
`createAuthSystem`	`function`	`core/auth/system.ts`
`createBullMqQueue`	`function`	`core/platform/queue.ts`
`createConfig`	`function`	`core/logic/core/config.ts`
`createConsoleObservability`	`function`	`core/platform/observability.ts`
`createDeliverySystem`	`function`	`core/delivery/system.ts`
`createHookRegistry`	`function`	`core/platform/hooks.ts`
`createInProcessQueue`	`function`	`core/platform/queue.ts`
`createManagedStorageSystem`	`function`	`core/storage/system.ts`
`createOtelObservability`	`function`	`core/platform/observability.ts`
`createPermission`	`function`	`core/auth/permissions.ts`
`createPgBossQueue`	`function`	`core/platform/queue.ts`
`createPluginRegistry`	`function`	`core/platform/plugins.ts`
`createPolicyRegistry`	`function`	`core/platform/policy.ts`
`createPrismaDeps`	`function`	`core/cms/glue/prisma-deps.ts`
`createPrismaMigrationStore`	`function`	`core/platform/versioning.ts`
`createRole`	`function`	`core/auth/roles.ts`
`createScheduler`	`function`	`core/platform/scheduler.ts`
`createScopedDeps`	`function`	`core/platform/tenancy.ts`
`createSearchPlugin`	`function`	`core/platform/plugins.ts`
`createSessionForUser`	`function`	`core/auth/sessions.ts`
`createSystem`	`function`	`core/index.ts`
`createTypedEventBus`	`function`	`core/platform/events.ts`
`createUser`	`function`	`core/auth/users.ts`
`deactivateUser`	`function`	`core/auth/users.ts`
`deletePermission`	`function`	`core/auth/permissions.ts`
`deleteRole`	`function`	`core/auth/roles.ts`
`deleteUser`	`function`	`core/auth/users.ts`
`getAsyncLocalStorage`	`function`	`core/platform/tenancy.ts`
`getBootstrapStatus`	`function`	`core/auth/bootstrap.ts`
`getCurrentTenant`	`function`	`core/platform/tenancy.ts`
`getDefaultRoleLevel`	`function`	`core/auth/meta.ts`
`getDeliverySettings`	`function`	`core/delivery/api.ts`
`getEffectivePermissions`	`function`	`core/auth/authorization.ts`
`getEffectiveRoles`	`function`	`core/auth/authorization.ts`
`getRolePermissions`	`function`	`core/auth/roles.ts`
`getStorageSettings`	`function`	`core/delivery/api.ts`
`getUserById`	`function`	`core/auth/users.ts`
`hasEffectivePermission`	`function`	`core/auth/authorization.ts`
`hasRoleLevel`	`function`	`core/auth/authorization.ts`
`installTenantMiddleware`	`function`	`core/platform/tenancy.ts`
`inviteUser`	`function`	`core/auth/onboarding.ts`
`isValidWebhookUrl`	`function`	`core/platform/events.ts`
`listPermissions`	`function`	`core/auth/permissions.ts`
`listRoles`	`function`	`core/auth/roles.ts`
`listUserPermissionOverrides`	`function`	`core/auth/permissions.ts`
`listUserRoles`	`function`	`core/auth/users.ts`
`listUsers`	`function`	`core/auth/users.ts`
`listUserSessions`	`function`	`core/auth/sessions.ts`
`logout`	`function`	`core/auth/sessions.ts`
`logoutAllSessions`	`function`	`core/auth/sessions.ts`
`matchesPermission`	`function`	`core/auth/authorization.ts`
`ownerOrAdmin`	`function`	`core/platform/policy.ts`
`parseDeliverySettings`	`function`	`core/delivery/schema.ts`
`parseEnv`	`function`	`core/logic/core/config.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`
`reactivateUser`	`function`	`core/auth/users.ts`
`refreshSession`	`function`	`core/auth/sessions.ts`
`registerInitialSuperAdmin`	`function`	`core/auth/bootstrap.ts`
`requestEmailVerification`	`function`	`core/auth/onboarding.ts`
`requestMagicLink`	`function`	`core/auth/authentication.ts`
`requestPasswordReset`	`function`	`core/auth/onboarding.ts`
`requirePermissionForUser`	`function`	`core/auth/authorization.ts`
`requiresPermission`	`function`	`core/platform/policy.ts`
`resetPassword`	`function`	`core/auth/onboarding.ts`
`resolveAuthGovernance`	`function`	`core/auth/config.ts`
`resolveAuthPolicy`	`function`	`core/auth/policy.ts`
`resolveRoleLevel`	`function`	`core/auth/governance.ts`
`revokeExpiredSessions`	`function`	`core/auth/sessions.ts`
`revokeRolePermissions`	`function`	`core/auth/roles.ts`
`revokeSession`	`function`	`core/auth/sessions.ts`
`rollbackMigration`	`function`	`core/platform/versioning.ts`
`runMigrations`	`function`	`core/platform/versioning.ts`
`runWithTenant`	`function`	`core/platform/tenancy.ts`
`sameTenant`	`function`	`core/platform/policy.ts`
`sendTwoFactorCode`	`function`	`core/delivery/notifications.ts`
`setRolePermissions`	`function`	`core/auth/roles.ts`
`setUserPermissionOverrides`	`function`	`core/auth/permissions.ts`
`unassignUserRole`	`function`	`core/auth/users.ts`
`updatePermission`	`function`	`core/auth/permissions.ts`
`updateRole`	`function`	`core/auth/roles.ts`
`updateUser`	`function`	`core/auth/users.ts`
`validatePrismaDeps`	`function`	`core/cms/glue/prisma-deps.ts`
`validateTenantId`	`function`	`core/platform/tenancy.ts`
`verifyEmail`	`function`	`core/auth/onboarding.ts`
`wireNotificationEvents`	`function`	`core/delivery/notifications.ts`

Consts

Export	Kind	Source
`allow`	`const`	`core/platform/policy.ts`
`CORE_VERSION`	`const`	`core/platform/versioning.ts`
`DEFAULT_AUTH_GOVERNANCE`	`const`	`core/auth/config.ts`
`DEFAULT_AUTH_POLICY`	`const`	`core/auth/policy.ts`
`DEFAULT_PERMISSION_META`	`const`	`core/auth/meta.ts`
`DEFAULT_ROLE_DEFINITIONS`	`const`	`core/auth/meta.ts`
`DEFAULT_ROLE_HIERARCHY`	`const`	`core/auth/meta.ts`
`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`
`deny`	`const`	`core/platform/policy.ts`
`globalHooks`	`const`	`core/platform/hooks.ts`
`NOTIFICATION_TRIGGER_DEFAULTS`	`const`	`core/delivery/schema.ts`
`nullObservability`	`const`	`core/platform/observability.ts`
`STORAGE_SETTINGS_DEFAULTS`	`const`	`core/delivery/schema.ts`
`TENANT_SCOPED_MODELS`	`const`	`core/platform/tenancy.ts`

Interfaces

Export	Kind	Source
`AuditPluginOptions`	`interface`	`core/platform/plugins.ts`
`AuthContext`	`interface`	`core/auth/deps.ts`
`AuthDeps`	`interface`	`core/auth/deps.ts`
`AuthenticateWithMagicLinkInput`	`interface`	`core/auth/authentication.ts`
`AuthenticateWithPasswordInput`	`interface`	`core/auth/authentication.ts`
`AuthenticationResult`	`interface`	`core/auth/authentication.ts`
`AuthGovernanceConfig`	`interface`	`core/auth/deps.ts`
`AuthPolicyConfig`	`interface`	`core/auth/policy.ts`
`AuthSystem`	`interface`	`core/auth/system.ts`
`BackgroundQueueAdapter`	`interface`	`core/platform/queue.ts`
`BullMqQueueOptions`	`interface`	`core/platform/queue.ts`
`CanChain`	`interface`	`core/platform/policy.ts`
`CheckChain`	`interface`	`core/platform/policy.ts`
`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`
`EmailVerificationRecord`	`interface`	`core/auth/types.ts`
`EventPayloads`	`interface`	`core/platform/events.ts`
`FormNotificationDefaults`	`interface`	`core/delivery/types.ts`
`FormNotificationRouting`	`interface`	`core/delivery/types.ts`
`HookEntry`	`interface`	`core/platform/hooks.ts`
`HookRegistry`	`interface`	`core/platform/hooks.ts`
`InviteRecord`	`interface`	`core/auth/types.ts`
`JobContext`	`interface`	`core/platform/queue.ts`
`JobPayload`	`interface`	`core/platform/queue.ts`
`LocalStorageSettings`	`interface`	`core/delivery/types.ts`
`LogContext`	`interface`	`core/platform/observability.ts`
`MagicLinkRecord`	`interface`	`core/auth/types.ts`
`ManagedStorageSystem`	`interface`	`core/storage/system.ts`
`ManagedStorageSystemOptions`	`interface`	`core/storage/system.ts`
`ManagedStorageUploadResult`	`interface`	`core/storage/system.ts`
`MetricOptions`	`interface`	`core/platform/observability.ts`
`Migration`	`interface`	`core/platform/versioning.ts`
`MigrationDeps`	`interface`	`core/platform/versioning.ts`
`MigrationPrismaClient`	`interface`	`core/platform/versioning.ts`
`MigrationRecord`	`interface`	`core/platform/versioning.ts`
`MigrationReport`	`interface`	`core/platform/versioning.ts`
`MigrationStoreDeps`	`interface`	`core/platform/versioning.ts`
`NotificationTriggers`	`interface`	`core/delivery/types.ts`
`NotificationTriggerSettings`	`interface`	`core/delivery/types.ts`
`NotificationWiringOptions`	`interface`	`core/delivery/notifications.ts`
`ObservabilityAdapter`	`interface`	`core/platform/observability.ts`
`OnChain`	`interface`	`core/platform/policy.ts`
`OtelDeps`	`interface`	`core/platform/observability.ts`
`PasswordResetRecord`	`interface`	`core/auth/types.ts`
`PermissionRecord`	`interface`	`core/auth/types.ts`
`PgBossQueueOptions`	`interface`	`core/platform/queue.ts`
`Plugin`	`interface`	`core/platform/plugins.ts`
`PluginContext`	`interface`	`core/platform/plugins.ts`
`PluginRegistry`	`interface`	`core/platform/plugins.ts`
`PolicyContext`	`interface`	`core/platform/policy.ts`
`PolicyDefinition`	`interface`	`core/platform/policy.ts`
`PolicyRegistry`	`interface`	`core/platform/policy.ts`
`PolicyUser`	`interface`	`core/platform/policy.ts`
`QueueAdapter`	`interface`	`core/platform/scheduler.ts`
`RequestMagicLinkInput`	`interface`	`core/auth/authentication.ts`
`RolePermissionAssignment`	`interface`	`core/auth/types.ts`
`RoleRecord`	`interface`	`core/auth/types.ts`
`S3StorageSettings`	`interface`	`core/delivery/types.ts`
`SchedulerController`	`interface`	`core/platform/scheduler.ts`
`SchedulerOptions`	`interface`	`core/platform/scheduler.ts`
`SearchPluginOptions`	`interface`	`core/platform/plugins.ts`
`SessionRecord`	`interface`	`core/auth/types.ts`
`SessionTokens`	`interface`	`core/auth/sessions.ts`
`SpanOptions`	`interface`	`core/platform/observability.ts`
`StartupReport`	`interface`	`core/index.ts`
`StorageSettings`	`interface`	`core/delivery/types.ts`
`StorageSettingsDeps`	`interface`	`core/delivery/api.ts`
`SystemConfig`	`interface`	`core/index.ts`
`SystemInstance`	`interface`	`core/index.ts`
`TenantContext`	`interface`	`core/platform/tenancy.ts`
`TypedEventBus`	`interface`	`core/platform/events.ts`
`TypedEventBusOptions`	`interface`	`core/platform/events.ts`
`UserPermissionOverride`	`interface`	`core/auth/types.ts`
`UserRecord`	`interface`	`core/auth/types.ts`
`UserRoleAssignment`	`interface`	`core/auth/types.ts`
`WebhookConfig`	`interface`	`core/platform/events.ts`

Types

Export	Kind	Source
`AuthRuntimeContext`	`type`	`core/auth/policy.ts`
`DeliveryChannel`	`type`	`core/delivery/types.ts`
`DeliveryDigestCadence`	`type`	`core/delivery/types.ts`
`DeliveryMailProvider`	`type`	`core/delivery/types.ts`
`DeliverySmsProvider`	`type`	`core/delivery/types.ts`
`EventType`	`type`	`core/platform/events.ts`
`HookFn`	`type`	`core/platform/hooks.ts`
`HookName`	`type`	`core/platform/hooks.ts`
`JobHandler`	`type`	`core/platform/queue.ts`
`LifecycleStage`	`type`	`core/platform/hooks.ts`
`LogLevel`	`type`	`core/platform/observability.ts`
`ManagedStorageProviderType`	`type`	`core/delivery/types.ts`
`PermissionEffect`	`type`	`core/auth/types.ts`
`PolicyAction`	`type`	`core/platform/policy.ts`
`PolicyHandler`	`type`	`core/platform/policy.ts`
`SchedulerMode`	`type`	`core/platform/scheduler.ts`
`TenantScopedModel`	`type`	`core/platform/tenancy.ts`
`TypedEventListener`	`type`	`core/platform/events.ts`
`UserStatus`	`type`	`core/auth/types.ts`

core ​

Import ​

Entry ​

Use This Surface When ​

Public Surface ​

Functions ​

Consts ​

Interfaces ​

Types ​

Related ​