Overview

import { defineConfig } from '@dyrected/core'
import { postgresAdapter } from '@dyrected/db-postgres'

export default defineConfig({
  db: postgresAdapter({ url: process.env.DATABASE_URL! }),
  collections: [],
  globals: [],
})

export interface AdminConfig {
  /** Custom component slots around the built-in dashboard. */
  components?: AdminDashboardComponentSlots;
  branding?: {
    /** Full logo image shown in the expanded sidebar. URL or imported image asset. */
    logo?: string;
    /** Compact logo mark used in the collapsed sidebar state. */
    logoMark?: string;
    /** Text alternative or addition to the logo image. */
    logoText?: string;
    /**
     * Brand colour used for committed, filled actions — Save, Create, Upload —
     * and active/selected states. Accepts a hex string, a named colour
     * (`amber`, `lime`, `violet`, `green`, `blue`, `red`, `purple`, `orange`),
     * or a raw HSL triplet (`"217 91% 60%"`). Applied in both light and dark mode.
     *
     * This is one half of the two-colour brand model. Use {@link accentColor}
     * for links and navigation accents. If you only set `primaryColor`, it is
     * reused for accents too, matching the single-brand-colour look.
     * @example '#6366f1'
     * @example 'blue'
     * @example 'hsl(240 50% 60%)'
     */
    primaryColor?: string;
    /**
     * Brand colour used for links, active navigation details, hover text, and
     * focus rings — the "accent" half of the two-colour brand model, mapped to
     * the admin's `--intelligence` token. Accepts the same formats as
     * {@link primaryColor} and applies in both light and dark mode.
     *
     * Set this when your brand has a distinct link/accent colour separate from
     * your primary action colour. When omitted, accents fall back to
     * `primaryColor` (if set) or the built-in default.
     * @example '#8b5cf6'
     * @example 'violet'
     */
    accentColor?: string;
    /** Browser tab favicon URL. */
    favicon?: string;
    /** Font family for body and UI text. Must be loaded separately. */
    fontSans?: string;
    /** Font family for headings. Must be loaded separately. */
    fontSerif?: string;
  };
  meta?: {
    /**
     * String appended to every Admin page's `<title>`.
     * @default '- Dyrected'
     */
    titleSuffix?: string;
  };
  /**
   * The canonical/base URL of the frontend website for links and iframe live previews.
   */
  siteUrl?: string;
}

export interface AggregateArgs {
  /** Collection slug. */
  collection: string;
  /** Named aggregate operations to compute. */
  aggregates: AggregateInput;
  /** Optional field to group the aggregates by. */
  groupBy?: string;
}

export type AggregateOperation =
  | CountOperation
  | DistinctCountOperation
  | DistinctValuesOperation
  | NumericOperation;

export type AggregateResult = Record<string, any>;

export interface DyrectedConfig<
  TUser extends AuthenticatedUser = AuthenticatedUser,
> {
  /**
   * Reusable block definitions that `blocks` fields can reference by slug via
   * `blockReferences`.
   */
  blocks?: Block[];

  /** Collection definitions. Each collection maps to a database table/collection. */
  collections: CollectionConfig<any>[];

  /** Global (singleton) definitions. Each global maps to a single document. */
  globals: GlobalConfig<any>[];

  /**
   * The database adapter. Required for all data operations.
   * @see DatabaseAdapter
   */
  db?: DatabaseAdapter;

  /**
   * The storage adapter for file uploads.
   * Required when any collection has `upload: true`.
   * @see StorageAdapter
   */
  storage?: StorageAdapter;

  /**
   * The image processing service. Required when any upload collection
   * defines `imageSizes`.
   * @see ImageService
   */
  image?: ImageService;

  /**
   * Runtime logger configuration. Accepts either logger options/destination or
   * a fully-instantiated Pino logger.
   */
  logger?: DyrectedLoggerConfig;

  /**
   * Request logging, redaction, sampling, tracing, metrics, and transport
   * configuration for the Dyrected server runtime.
   */
  observability?: DyrectedObservabilityConfig;

  /** Admin UI branding and metadata. */
  admin?: AdminConfig;

  /**
   * Deployment-level authentication strategy for the CMS dashboard (`/admin`).
   * This is separate from collection-level `auth: true`, which continues to
   * power application/customer auth independently.
   */
  adminAuth?: AdminAuthConfig;

  /**
   * Named access policies available to collection, global, and field access
   * rules via `{ policy: 'name' }`.
   *
   * A policy can be a **function** (full server logic, evaluated to a static
   * boolean when serialized for the admin panel) or a **Jexl string** (or
   * boolean). String policies are inlined when the schema is sent to the admin,
   * so the admin panel evaluates them live against the current form — the same
   * way it evaluates inline Jexl rules.
   */
  accessPolicies?: Record<
    string,
    AccessPolicyResolver<Record<string, unknown>, TUser> | string | boolean
  >;

  /**
   * Email transport configuration. Required for welcome emails, password
   * resets, and invite links.
   *
   * @example
   * email: {
   *   from: '[email protected]',
   *   send: async ({ to, subject, html }) => {
   *     await resend.emails.send({ from, to, subject, html })
   *   },
   * }
   */
  email?: {
    /** The `From` address for all outbound emails. */
    from: string;

    /** The send function. Wire in any email provider (Resend, SendGrid, SES, etc.). */
    send: (args: {
      to: string;
      subject: string;
      html: string;
    }) => Promise<void>;

    /** Override the default email templates. */
    templates?: {
      welcome?: (args: { email: string }) => { subject?: string; html: string };
      invite?: (args: { token: string; invitedByEmail?: string; url?: string }) => {
        subject?: string;
        html: string;
      };
      resetPassword?: (args: { token: string; url?: string }) => {
        subject?: string;
        html: string;
      };
      passwordChanged?: (args: { email: string }) => {
        subject?: string;
        html: string;
      };
    };
  };

  /**
   * Redis connection URL. Required for distributed caching of dynamic option
   * resolvers and other server-side caches in multi-instance deployments.
   *
   * @example
   * redis: { url: process.env.REDIS_URL }
   */
  redis?: {
    url: string;
  };

  /** Durable lifecycle-event delivery configuration. */
  events?: {
    handlers: LifecycleEventHandler[];

    /** Maximum delivery attempts before an event remains failed. Defaults to 8. */
    maxAttempts?: number;

    /** Initial exponential-backoff delay in milliseconds. Defaults to 1000. */
    retryDelayMs?: number;
  };

  /**
   * Cross-Origin Resource Sharing (CORS) configuration.
   * List all origins that are allowed to call the Dyrected API.
   *
   * @example
   * cors: { origins: ['https://myapp.com', 'https://www.myapp.com'] }
   */
  cors?: {
    origins: string[];
  };

  /**
   * App-level HTTP request rate limiting.
   *
   * Similar to Payload's `rateLimit` option, this counts requests by client IP
   * over a rolling time window and returns `429` responses once the limit is
   * exhausted.
   */
  rateLimit?: RateLimitConfig;

  /**
   * Callback to dynamically fetch additional collections and globals for a
   * given site ID at request time. Used in multi-tenant deployments where each
   * site has its own schema stored in the database.
   */
  onSchemaFetch?: (siteId: string) => Promise<{
    blocks?: Block[];
    collections?: CollectionConfig<any>[];
    globals?: GlobalConfig<any>[];
    accessPolicies?: Record<
      string,
      AccessPolicyResolver<Record<string, unknown>, TUser> | string | boolean
    >;
    admin?: AdminConfig;
    adminAuth?: AdminAuthConfig;
  }>;
}