Skip to content

Entry points

The package exposes exactly eight supported import paths. Use the narrowest path that owns the API you need. Deep imports target build internals and are not part of the compatibility contract.

ImportMain responsibilityTypical first symbol
@sdcorejs/nestjsComposition and common cross-cutting primitivesSdCoreModule
@sdcorejs/nestjs/coreORM, request context, tenancy, auditBaseRepository
@sdcorejs/nestjs/authJWT/JWKS, permission checks, internal callsJwtModule
@sdcorejs/nestjs/servicesCache and outbound HTTPCacheModule
@sdcorejs/nestjs/validationZod v4 parsing and guardsZodValidationGuard
@sdcorejs/nestjs/queueBullMQ module and worker adapterQueueModule
@sdcorejs/nestjs/i18nCatalogs, language resolution, exception filterI18nModule
@sdcorejs/nestjs/featuresFiles, action history, distributed job leasesUploadedFileModule

Both import and require resolve to dedicated ESM/CJS output with matching declarations. Do not import paths such as @sdcorejs/nestjs/orm, /cache, /jwt, or source files below /dist.

ts
import { SdCoreModule } from '@sdcorejs/nestjs';
import { BaseEntity, BaseRepository, Scoped, WithAudit } from '@sdcorejs/nestjs/core';
import { AuthGuard, HasPermission, JwtModule } from '@sdcorejs/nestjs/auth';
import { CacheModule, HttpClientModule } from '@sdcorejs/nestjs/services';

See the API catalog for every value and type exported by each path.

Optional runtimes

Optional dependencies are installed non-fatally by npm, but an application only needs the runtime for the feature it enables:

FeatureRuntime
Redis cache / BullMQ connectionioredis
OIDC/JWKS verificationjwks-rsa and jsonwebtoken
S3 uploaded-file driver@aws-sdk/client-s3

Missing optional runtimes fail when their feature is constructed or first used; they do not change the public import path. Zod v4 is a required dependency because validation helpers are exported from both the root and /validation entry points.

Released under the MIT License.