config.ts

// get openapi schema
import packageJson from './package.json' with { type: 'json' }
import { apiBody } from './src/utils/docs.ts'
import type { CookieOptions, ApiDocsConfig } from './types.ts'

export const YEAR = new Date().getFullYear()

// Sentry configuration for error reporting (when telemetry is enabled)
export const SENTRY_CONFIG = {
  dsn: 'https://909b085eb764c00250ad312660c2fdf1@o4506397716054016.ingest.us.sentry.io/4509492612300800',
  sendDefaultPii: true,
  environment: 'development', // Will be overridden by environment variable
  sampleRate: 1.0,
  tracesSampleRate: 0.1, // Lower sample rate for performance traces
}

export const TELEMETRY_ENABLED = true as boolean

export const DEBUG_ENABLED = false as boolean

export const API_DOCS_ENABLED = true as boolean

export const VERSION: string = packageJson.version

// Reserved route prefixes that cannot be used as upstream names
export const RESERVED_ROUTES: string[] = [
  '-',
  'user',
  'docs',
  'search',
  'tokens',
  'auth',
  'ping',
  'package',
  'v1',
  'api',
  'admin',
  '*', // Reserved for hash-based routes
]

// the time in seconds to cache the registry
export const REQUEST_TIMEOUT: number = 60 * 1000

// cookie options
export const COOKIE_OPTIONS: CookieOptions = {
  path: '/',
  httpOnly: true,
  secure: true,
  sameSite: 'strict',
}

// OpenAPI Docs
export const OPEN_API_CONFIG = {
  openapi: '3.1.0',
  info: {
    title: 'vlt serverless registry',
    version: VERSION,
    description: 'The vlt serverless registry API',
  },
  tags: [
    {
      name: 'Health Check',
      description: 'Registry health and status endpoints',
    },
    {
      name: 'Authentication',
      description: 'User authentication and token management',
    },
    {
      name: 'Packages',
      description: 'Package publishing, downloading, and management',
    },
    {
      name: 'Dist-Tags',
      description: 'Package version tagging and lifecycle management',
    },
    {
      name: 'Access Control',
      description:
        'Package access permissions and collaborator management',
    },
    {
      name: 'Search',
      description: 'Package discovery and search functionality',
    },
    {
      name: 'Security',
      description: 'Security auditing and vulnerability scanning',
    },
    {
      name: 'Dashboard',
      description: 'Registry dashboard and administration',
    },
    {
      name: 'Static Assets',
      description: 'Static file serving and web assets',
    },
    {
      name: 'NPM Compatibility',
      description: 'Legacy npm client compatibility redirects',
    },
  ],
}

// the docs configuration for the API reference
export const SCALAR_API_CONFIG: ApiDocsConfig = {
  metaData: {
    title: 'vlt serverless registry',
  },
  hideModels: false,
  hideDownloadButton: false,
  darkMode: false,
  favicon: '/public/images/favicon/favicon.svg',
  defaultHttpClient: {
    targetKey: 'curl',
    clientKey: 'fetch',
  },
  authentication: {
    http: {
      bearer: {
        token: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
      },
      basic: {
        username: 'user',
        password: 'pass',
      },
    },
  },
  hiddenClients: {
    python: true,
    c: true,
    go: true,
    java: true,
    ruby: true,
    shell: ['httpie', 'wget', 'fetch'],
    clojure: true,
    csharp: true,
    kotlin: true,
    objc: true,
    swift: true,
    r: true,
    powershell: false,
    ocaml: true,
    curl: false,
    http: true,
    php: true,
    node: ['request', 'unirest'],
    javascript: ['xhr', 'jquery'],
  },
  spec: {
    content: {
      openapi: OPEN_API_CONFIG.openapi,
      servers: [
        {
          url: URL,
          description: 'localhost',
        },
      ],
      info: {
        title: 'vlt serverless registry',
        version: VERSION,
        license: {
          identifier: 'FSL-1.1-MIT',
          name: 'Functional Source License, Version 1.1, MIT Future License',
          url: 'https://fsl.software/FSL-1.1-MIT.template.md',
        },
        description: apiBody({ YEAR }),
      },
      // Include tag ordering and descriptions
      tags: OPEN_API_CONFIG.tags,
    },
  },
  customCss: `@import '${URL}/public/styles/styles.css';`,
}