@vltpkg/vsr 0.0.0-27 → 0.0.0-28

package/types.ts

@@ -0,0 +1,598 @@
+// ---------------------------------------------------------
+// Consolidated TypeScript Types
+// ---------------------------------------------------------
+
+import type { Context } from 'hono'
+import type { D1Database } from '@cloudflare/workers-types'
+
+// ---------------------------------------------------------
+// Request Types
+// ---------------------------------------------------------
+
+export interface _LoginRequestBody {
+  name?: string
+  password?: string
+  email?: string
+  [key: string]: unknown
+}
+
+export interface _AuditRequestBody {
+  requires?: Record<string, string>
+  [key: string]: unknown
+}
+
+export interface _UpstreamPackageData {
+  'dist-tags'?: Record<string, string>
+  versions?: Record<string, unknown>
+  time?: Record<string, string>
+  [key: string]: unknown
+}
+
+export interface _DashboardData {
+  [key: string]: unknown
+}
+
+export interface RequestQueueMessage {
+  body: {
+    type: 'package_refresh' | 'version_refresh'
+    packageName?: string
+    spec?: string
+    upstream: string
+    options: Record<string, unknown>
+  }
+  ack(): void
+  retry(): void
+}
+
+export interface QueueBatch {
+  messages: RequestQueueMessage[]
+}
+
+// ---------------------------------------------------------
+// Database Types
+// ---------------------------------------------------------
+
+export interface Package {
+  name: string
+  tags: string // JSON string containing Record<string, string>
+  lastUpdated?: string
+  origin: 'local' | 'upstream'
+  upstream?: string
+  cachedAt?: string
+}
+
+export interface ParsedPackage {
+  name: string
+  tags: Record<string, string>
+  lastUpdated: string | null
+  origin: string | null
+  upstream: string | null
+  cachedAt: string | null
+}
+
+export interface Version {
+  spec: string
+  manifest: string // JSON string containing PackageManifest
+  publishedAt?: string
+  origin: 'local' | 'upstream'
+  upstream?: string
+  cachedAt?: string
+}
+
+export interface ParsedVersion {
+  spec: string
+  version: string
+  manifest: Record<string, any>
+  published_at: string | null
+  origin: string | null
+  upstream: string | null
+  cachedAt: string | null
+}
+
+export interface Token {
+  token: string
+  uuid: string
+  scope: string // JSON string containing TokenScope[]
+}
+
+export interface ParsedToken {
+  token: string
+  uuid: string
+  scope: TokenScope[]
+}
+
+// ---------------------------------------------------------
+// Authentication & Authorization Types
+// ---------------------------------------------------------
+
+export interface TokenScope {
+  values: string[]
+  types: {
+    pkg?: { read: boolean; write: boolean }
+    user?: { read: boolean; write: boolean }
+  }
+}
+
+export interface TokenAccess {
+  anyUser: boolean
+  specificUser: boolean
+  anyPackage: boolean
+  specificPackage: boolean
+  readAccess: boolean
+  writeAccess: boolean
+  methods: string[]
+}
+
+export interface AuthUser {
+  uuid: string | null
+  scope: TokenScope[] | null
+  token: string
+}
+
+// ---------------------------------------------------------
+// Package & Manifest Types
+// ---------------------------------------------------------
+
+export interface PackageManifest {
+  name: string
+  version: string
+  description?: string
+  main?: string
+  module?: string
+  types?: string
+  bin?: Record<string, string> | string
+  scripts?: Record<string, string>
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
+  peerDependencies?: Record<string, string>
+  optionalDependencies?: Record<string, string>
+  peerDependenciesMeta?: Record<string, { optional?: boolean }>
+  engines?: Record<string, string>
+  os?: string[]
+  cpu?: string[]
+  keywords?: string[]
+  author?: string | { name: string; email?: string; url?: string }
+  contributors?: (
+    | string
+    | { name: string; email?: string; url?: string }
+  )[]
+  license?: string
+  repository?:
+    | string
+    | { type: string; url: string; directory?: string }
+  bugs?: string | { url: string; email?: string }
+  homepage?: string
+  files?: string[]
+  publishConfig?: Record<string, any>
+  dist?: {
+    tarball: string
+    shasum?: string
+    integrity?: string
+    fileCount?: number
+    unpackedSize?: number
+  }
+  _id?: string
+  _rev?: string
+  _attachments?: Record<string, any>
+  [key: string]: any // Allow additional properties
+}
+
+export interface SlimmedManifest {
+  name: string
+  version: string
+  dependencies?: Record<string, string>
+  peerDependencies?: Record<string, string>
+  optionalDependencies?: Record<string, string>
+  peerDependenciesMeta?: Record<string, { optional?: boolean }>
+  bin?: Record<string, string> | string
+  engines?: Record<string, string>
+  dist: {
+    tarball: string
+  }
+}
+
+export interface Packument {
+  name: string
+  'dist-tags': Record<string, string>
+  versions: Record<string, SlimmedManifest>
+  time: Record<string, string> & {
+    modified: string
+  }
+}
+
+export interface PackageSpec {
+  name?: string
+  pkg?: string
+  scope?: string
+}
+
+// ---------------------------------------------------------
+// Upstream & Configuration Types
+// ---------------------------------------------------------
+
+export interface UpstreamConfig {
+  type: 'local' | 'npm' | 'vsr' | 'jsr'
+  url: string
+  allowPublish?: boolean
+}
+
+export interface OriginConfig {
+  default: string
+  upstreams: Record<string, UpstreamConfig>
+}
+
+export interface ParsedPackageInfo {
+  upstream?: string
+  packageName: string
+  version?: string
+  segments: string[]
+}
+
+// ---------------------------------------------------------
+// Cache Types
+// ---------------------------------------------------------
+
+export interface CacheOptions {
+  packumentTtlMinutes?: number
+  manifestTtlMinutes?: number
+  staleWhileRevalidateMinutes?: number
+  forceRefresh?: boolean
+  upstream?: string
+}
+
+export interface CacheResult<T> {
+  data?: T
+  package?: T // For package cache results
+  version?: T // For version cache results
+  fromCache: boolean
+  stale?: boolean
+}
+
+export interface CacheValidation {
+  valid: boolean
+  stale: boolean
+  data: any
+}
+
+export interface QueueMessage {
+  type: 'package_refresh' | 'version_refresh'
+  packageName?: string
+  spec?: string
+  upstream: string
+  timestamp: number
+  options: {
+    packumentTtlMinutes?: number
+    manifestTtlMinutes?: number
+    upstream?: string
+  }
+}
+
+// ---------------------------------------------------------
+// Request Context Types
+// ---------------------------------------------------------
+
+export interface RequestContext {
+  protocol?: string
+  host?: string
+  upstream?: string
+}
+
+export interface DatabaseOperations {
+  // Package operations
+  getPackage(name: string): Promise<ParsedPackage | null>
+  upsertPackage(
+    name: string,
+    tags: Record<string, string>,
+    lastUpdated?: string,
+  ): Promise<any>
+  upsertCachedPackage(
+    name: string,
+    tags: Record<string, string>,
+    upstream: string,
+    lastUpdated?: string,
+  ): Promise<any>
+  getCachedPackage(name: string): Promise<ParsedPackage | null>
+  isPackageCacheValid(
+    name: string,
+    ttlMinutes?: number,
+  ): Promise<boolean>
+
+  // Token operations
+  getToken(token: string): Promise<ParsedToken | null>
+  validateTokenAccess(
+    authToken: string,
+    targetUuid: string,
+  ): Promise<boolean>
+  upsertToken(
+    token: string,
+    uuid: string,
+    scope: TokenScope[],
+    authToken?: string,
+  ): Promise<any>
+  deleteToken(token: string, authToken?: string): Promise<any>
+
+  // Version operations
+  getVersion(spec: string): Promise<ParsedVersion | null>
+  upsertVersion(
+    spec: string,
+    manifest: PackageManifest,
+    publishedAt: string,
+  ): Promise<any>
+  upsertCachedVersion(
+    spec: string,
+    manifest: PackageManifest,
+    upstream: string,
+    publishedAt: string,
+  ): Promise<any>
+  getCachedVersion(spec: string): Promise<ParsedVersion | null>
+  isVersionCacheValid(
+    spec: string,
+    ttlMinutes?: number,
+  ): Promise<boolean>
+
+  // Search operations
+  searchPackages(
+    query: string,
+    scope?: string,
+  ): Promise<SearchResult[]>
+  getVersionsByPackage(packageName: string): Promise<ParsedVersion[]>
+}
+
+export type HonoContext = Context<{
+  Bindings: Environment
+  Variables: {
+    db: DatabaseOperations
+    upstream?: string
+  }
+}> & {
+  waitUntil?: (promise: Promise<any>) => void
+  executionCtx?: {
+    waitUntil: (promise: Promise<any>) => void
+  }
+}
+
+// ---------------------------------------------------------
+// API Response Types
+// ---------------------------------------------------------
+
+export interface ApiError {
+  error: string
+  message?: string
+  details?: any
+}
+
+export interface TokenCreateRequest {
+  uuid?: string
+  scope: TokenScope[]
+}
+
+export interface TokenCreateResponse {
+  token: string
+  uuid: string
+  scope: TokenScope[]
+}
+
+export interface AccessRequest {
+  username: string
+  permission: 'read-only' | 'read-write'
+}
+
+export interface AccessResponse {
+  name: string
+  collaborators: Record<string, 'read-only' | 'read-write'>
+}
+
+// ---------------------------------------------------------
+// Utility Types
+// ---------------------------------------------------------
+
+export type HttpMethod =
+  | 'GET'
+  | 'POST'
+  | 'PUT'
+  | 'DELETE'
+  | 'PATCH'
+  | 'HEAD'
+  | 'OPTIONS'
+
+export interface ValidationResult {
+  valid: boolean
+  errors?: string[]
+}
+
+export interface FileInfo {
+  path: string
+  content: Uint8Array | string
+  size: number
+}
+
+// ---------------------------------------------------------
+// Constants Types
+// ---------------------------------------------------------
+
+export interface CookieOptions {
+  path: string
+  httpOnly: boolean
+  secure: boolean
+  sameSite: 'strict' | 'lax' | 'none'
+}
+
+export interface ApiDocsConfig {
+  metaData: {
+    title: string
+  }
+  hideModels: boolean
+  hideDownloadButton: boolean
+  darkMode: boolean
+  favicon: string
+  defaultHttpClient: {
+    targetKey: string
+    clientKey: string
+  }
+  authentication: {
+    http: {
+      bearer: { token: string }
+      basic: { username: string; password: string }
+    }
+  }
+  hiddenClients: Record<string, boolean | string[]>
+  spec: {
+    content: any
+  }
+  customCss: string
+}
+
+// ---------------------------------------------------------
+// Authentication Provider Types (WorkOS)
+// ---------------------------------------------------------
+
+export interface WorkOSUser {
+  id: string
+  email: string
+  firstName?: string
+  lastName?: string
+  profilePictureUrl?: string
+  createdAt: string
+  updatedAt: string
+}
+
+export interface WorkOSAuthResponse {
+  authenticated: boolean
+  sessionId?: string
+  organizationId?: string
+  role?: string
+  permissions?: string[]
+  user?: WorkOSUser
+  reason?: string
+}
+
+export interface WorkOSAuthResult {
+  user: WorkOSUser
+  sealedSession: string
+}
+
+// ---------------------------------------------------------
+// Search Types
+// ---------------------------------------------------------
+
+export interface SearchResult {
+  name: string
+  tags: Record<string, string>
+  version?: string
+  description?: string
+  keywords?: string[]
+  lastUpdated?: string
+  homepage?: string
+  repository?: string
+  bugs?: string
+  author?: string
+  publisher?: string
+  maintainers?: string[]
+}
+
+export interface SearchResponse {
+  objects: {
+    package: {
+      name: string
+      scope: string
+      version: string
+      description: string
+      keywords: string[]
+      date: string
+      links: {
+        npm: string
+        homepage?: string
+        repository?: string
+        bugs?: string
+      }
+      author?: string
+      publisher?: string
+      maintainers: string[]
+    }
+    score: {
+      final: number
+      detail: {
+        quality: number
+        popularity: number
+        maintenance: number
+      }
+    }
+    searchScore: number
+  }[]
+  total: number
+  time: string
+}
+
+// ---------------------------------------------------------
+// Environment Types
+// ---------------------------------------------------------
+
+export interface Environment {
+  // Database
+  D1_DATABASE?: D1Database
+  DB?: D1Database
+
+  // Queue and Storage
+  CACHE_REFRESH_QUEUE?: any
+  BUCKET?: any
+  ASSETS?: any
+
+  // Authentication
+  WORKOS_API_KEY?: string
+  WORKOS_CLIENT_ID?: string
+  WORKOS_PROVIDER?: string
+  WORKOS_REDIRECT_URI?: string
+  WORKOS_COOKIE_PASSWORD?: string
+
+  // Configuration flags (enriched by configMiddleware)
+  DAEMON_ENABLED?: boolean
+  TELEMETRY_ENABLED?: boolean
+  API_DOCS_ENABLED?: boolean
+  DEBUG_ENABLED?: boolean
+
+  // Telemetry
+  SENTRY?: {
+    dsn: string
+    environment?: string
+  }
+  SENTRY_CONFIG?: {
+    dsn: string
+    environment?: string
+    sendDefaultPii?: boolean
+    sampleRate?: number
+    tracesSampleRate?: number
+  }
+
+  // Cloudflare specific
+  CF?: {
+    connecting_ip?: string
+  }
+
+  // Other config values
+  DAEMON_PORT?: number
+  DAEMON_URL?: string
+  PORT?: number
+  VERSION?: string
+  URL?: string
+
+  [key: string]: any
+}
+
+export interface Args {
+  daemon: boolean
+  telemetry: boolean
+  debug: boolean
+  help: boolean
+  port: number
+  config?: string
+  env?: string
+  'db-name'?: string
+  'bucket-name'?: string
+  'queue-name'?: string
+  'dry-run'?: boolean
+}
+
+export interface MinArgsResult {
+  args: Args
+  positionals: string[]
+}

package/vitest.config.ts

@@ -0,0 +1,25 @@
+import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config'
+
+export default defineWorkersConfig({
+  test: {
+    globals: true,
+    testTimeout: 30000, // 30 seconds timeout for upstream requests
+    hookTimeout: 10000, // 10 seconds for setup/teardown
+    setupFiles: ['./test/setup.ts'],
+    poolOptions: {
+      workers: {
+        wrangler: {
+          configPath: './wrangler.json',
+        },
+        miniflare: {
+          bindings: {
+            REAL_PLATFORM: process.platform,
+          },
+        },
+      },
+    },
+  },
+  esbuild: {
+    target: 'es2022',
+  },
+})

package/vlt.json.example

@@ -0,0 +1,56 @@
+{
+  "registry": {
+    "daemon": true,
+    "telemetry": true,
+    "debug": false,
+    "port": 1337,
+    "deploy": {
+      "sentry": {
+        "dsn": "https://your-sentry-dsn@sentry.io/project-id",
+        "sampleRate": 1.0,
+        "tracesSampleRate": 0.1
+      },
+      "environments": {
+        "dev": {
+          "databaseName": "vsr-dev-database",
+          "bucketName": "vsr-dev-bucket",
+          "queueName": "vsr-dev-cache-refresh-queue",
+          "sentry": {
+            "environment": "development"
+          },
+          "vars": {
+            "CUSTOM_VAR": "dev-value",
+            "API_BASE_URL": "https://dev-api.example.com"
+          }
+        },
+        "staging": {
+          "databaseName": "vsr-staging-database",
+          "bucketName": "vsr-staging-bucket",
+          "queueName": "vsr-staging-cache-refresh-queue",
+          "sentry": {
+            "environment": "staging"
+          },
+          "vars": {
+            "CUSTOM_VAR": "staging-value",
+            "API_BASE_URL": "https://staging-api.example.com"
+          }
+        },
+        "prod": {
+          "databaseName": "vsr-prod-database",
+          "bucketName": "vsr-prod-bucket",
+          "queueName": "vsr-prod-cache-refresh-queue",
+          "sentry": {
+            "environment": "production",
+            "dsn": "https://your-prod-sentry-dsn@sentry.io/project-id",
+            "sampleRate": 0.1,
+            "tracesSampleRate": 0.01
+          },
+          "vars": {
+            "CUSTOM_VAR": "prod-value",
+            "API_BASE_URL": "https://api.example.com"
+          }
+        }
+      }
+    }
+  }
+}