Directories
¶
| Path | Synopsis |
|---|---|
|
Package accounts is the part of authentication an end user touches: registering, confirming an address, signing in and out, recovering a password, and being locked out after enough wrong guesses.
|
Package accounts is the part of authentication an end user touches: registering, confirming an address, signing in and out, recovering a password, and being locked out after enough wrong guesses. |
|
Package app provides the application configuration and bootstrap for Nucleus.
|
Package app provides the application configuration and bootstrap for Nucleus. |
|
Package auth provides authentication utilities for the Nucleus framework, including password hashing, JWT management, and session handling.
|
Package auth provides authentication utilities for the Nucleus framework, including password hashing, JWT management, and session handling. |
|
apikeys
Package apikeys is the credential a program uses to call an API: issued once, shown once, revocable, scoped, and recognisable in a log.
|
Package apikeys is the credential a program uses to call an API: issued once, shown once, revocable, scoped, and recognisable in a log. |
|
backend
Package backend is the contract a third-party authentication backend implements — and nothing else.
|
Package backend is the contract a third-party authentication backend implements — and nothing else. |
|
backend/backendtest
Package backendtest is a conformance suite for authentication backends.
|
Package backendtest is a conformance suite for authentication backends. |
|
federated
Package federated is the contract a browser-redirect identity provider implements — OIDC, SAML, anything where the user leaves for an identity provider and comes back — and nothing else.
|
Package federated is the contract a browser-redirect identity provider implements — OIDC, SAML, anything where the user leaves for an identity provider and comes back — and nothing else. |
|
federated/oidc
Package oidc is an OpenID Connect provider for the federated sign-in seam: authorization code flow with PKCE, discovery, and an id_token verified against the provider's published keys.
|
Package oidc is an OpenID Connect provider for the federated sign-in seam: authorization code flow with PKCE, discovery, and an id_token verified against the provider's published keys. |
|
secrets
Package secrets resolves opaque reference strings into raw secret bytes for the auth layer — JWT signing keys, primarily.
|
Package secrets resolves opaque reference strings into raw secret bytes for the auth layer — JWT signing keys, primarily. |
|
sessionstore
Package sessionstore is the contract a third-party session store implements — and nothing else.
|
Package sessionstore is the contract a third-party session store implements — and nothing else. |
|
Package authz provides authorization for the Nucleus framework using Casbin.
|
Package authz provides authorization for the Nucleus framework using Casbin. |
|
Package cache is the runtime counterpart of the `nucleus createcachetable` CLI command: a minimal key/value cache with TTL semantics, an in-memory backend for single-process deployments, and a SQL backend wired to the table that command creates (`nucleus_cache_entries` by default) for multi-replica deployments that share a database.
|
Package cache is the runtime counterpart of the `nucleus createcachetable` CLI command: a minimal key/value cache with TTL semantics, an in-memory backend for single-process deployments, and a SQL backend wired to the table that command creates (`nucleus_cache_entries` by default) for multi-replica deployments that share a database. |
|
Package circuit provides a small circuit-breaker primitive for wrapping calls to external dependencies (mail, storage, plugin bridges, third-party APIs) in a deterministic failure-isolation pattern.
|
Package circuit provides a small circuit-breaker primitive for wrapping calls to external dependencies (mail, storage, plugin bridges, third-party APIs) in a deterministic failure-isolation pattern. |
|
Package db provides database connectivity for the Nucleus framework.
|
Package db provides database connectivity for the Nucleus framework. |
|
driver
Package driver is the contract a database driver module implements to plug into pkg/db.
|
Package driver is the contract a database driver module implements to plug into pkg/db. |
|
driver/drivertest
Package drivertest is a conformance kit for database driver modules.
|
Package drivertest is a conformance kit for database driver modules. |
|
Package errors provides domain-specific error types for the Nucleus framework.
|
Package errors provides domain-specific error types for the Nucleus framework. |
|
Package health provides a small abstraction for dependency probes used by the /healthz handler in pkg/app.
|
Package health provides a small abstraction for dependency probes used by the /healthz handler in pkg/app. |
|
Package i18n is the runtime counterpart of the `nucleus makemessages` / `nucleus compilemessages` CLI pair.
|
Package i18n is the runtime counterpart of the `nucleus makemessages` / `nucleus compilemessages` CLI pair. |
|
Package model provides the model registry, metadata extraction, and generic CRUD operations for the Nucleus framework.
|
Package model provides the model registry, metadata extraction, and generic CRUD operations for the Nucleus framework. |
|
Package nucleus — config.go implements the configuration loader surfaced by `AppBuilder.FromConfigFile`.
|
Package nucleus — config.go implements the configuration loader surfaced by `AppBuilder.FromConfigFile`. |
|
Package nucleustest boots a nucleus application inside the test process (DX-22).
|
Package nucleustest boots a nucleus application inside the test process (DX-22). |
|
Package observability is the in-process EVENT BUS — not the logging package.
|
Package observability is the in-process EVENT BUS — not the logging package. |
|
hooks
Package hooks plugs the framework's existing instrumentation points (HTTP middleware, SQL observer, session manager) into the observability.Bus so the agent (and direct subscribers) can receive strongly typed events.
|
Package hooks plugs the framework's existing instrumentation points (HTTP middleware, SQL observer, session manager) into the observability.Bus so the agent (and direct subscribers) can receive strongly typed events. |
|
Package observe is the one you almost always want: structured logging (slog with context-aware fields), request/trace IDs and the small set of helpers the rest of the framework logs through.
|
Package observe is the one you almost always want: structured logging (slog with context-aware fields), request/trace IDs and the small set of helpers the rest of the framework logs through. |
|
exporter
Package exporter is the contract a telemetry exporter module implements to plug into pkg/observe.
|
Package exporter is the contract a telemetry exporter module implements to plug into pkg/observe. |
|
Package outbox provides a transactional outbox pattern implementation with support for external message delivery through configurable bridges.
|
Package outbox provides a transactional outbox pattern implementation with support for external message delivery through configurable bridges. |
|
Package router provides an HTTP router for the Nucleus framework, built on top of Go's standard net/http.ServeMux (Go 1.22+).
|
Package router provides an HTTP router for the Nucleus framework, built on top of Go's standard net/http.ServeMux (Go 1.22+). |
|
interceptor
Package interceptor is the contract a third-party request interceptor implements — and nothing else.
|
Package interceptor is the contract a third-party request interceptor implements — and nothing else. |
|
Package signals provides a synchronous and asynchronous event bus for the Nucleus framework.
|
Package signals provides a synchronous and asynchronous event bus for the Nucleus framework. |
|
provider
Package storage provides a durable, provider-agnostic file storage interface for Nucleus applications.
|
Package storage provides a durable, provider-agnostic file storage interface for Nucleus applications. |
|
providers/asynq
Package tasks provides background job enqueueing and worker runtime backed by Asynq.
|
Package tasks provides background job enqueueing and worker runtime backed by Asynq. |
|
Package validate provides struct validation powered by go-playground/validator, with automatic conversion of validation errors to Nucleus DomainErrors.
|
Package validate provides struct validation powered by go-playground/validator, with automatic conversion of validation errors to Nucleus DomainErrors. |
Click to show internal directories.
Click to hide internal directories.