@beechcms/api 0.5.0 → 0.6.0-preview.2

package/src/shared/storage-utils.ts

@@ -1,36 +1,40 @@
-import { S3Client, ListObjectsV2Command, ListObjectsV2CommandOutput } from '@aws-sdk/client-s3'
-
-/**
- * Calcola la dimensione totale occupata in un bucket R2 (in byte).
- * Nota: esegue una scansione completa del bucket. Per bucket molto grandi 
- * andrebbe implementata una cache o usato Cloudflare Logpush/Analytics.
- */
-export async function getBucketSize(client: S3Client, bucketName: string): Promise<number> {
-  let totalSize = 0
-  let isTruncatedFlag = true
-  let continuationToken: string | undefined = undefined
-
-  try {
-    while (isTruncatedFlag) {
-      const command: ListObjectsV2Command = new ListObjectsV2Command({
-        Bucket: bucketName,
-        ContinuationToken: continuationToken,
-      })
-
-      const response: ListObjectsV2CommandOutput = await client.send(command)
-
-      if (response.Contents) {
-        for (const obj of response.Contents) {
-          totalSize += obj.Size ?? 0
-        }
-      }
-
-      isTruncatedFlag = response.IsTruncated ?? false
-      continuationToken = response.NextContinuationToken
-    }
-    return totalSize
-  } catch (err) {
-    console.error('Error calculating bucket size:', err)
-    throw new Error('Failed to calculate bucket size. Check your R2/S3 credentials and endpoint.')
-  }
-}
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import { S3Client, ListObjectsV2Command, ListObjectsV2CommandOutput } from '@aws-sdk/client-s3'
+
+/**
+ * Calcola la dimensione totale occupata in un bucket R2 (in byte).
+ * Nota: esegue una scansione completa del bucket. Per bucket molto grandi 
+ * andrebbe implementata una cache o usato Cloudflare Logpush/Analytics.
+ */
+export async function getBucketSize(client: S3Client, bucketName: string): Promise<number> {
+  let totalSize = 0
+  let isTruncatedFlag = true
+  let continuationToken: string | undefined = undefined
+
+  try {
+    while (isTruncatedFlag) {
+      const command: ListObjectsV2Command = new ListObjectsV2Command({
+        Bucket: bucketName,
+        ContinuationToken: continuationToken,
+      })
+
+      const response: ListObjectsV2CommandOutput = await client.send(command)
+
+      if (response.Contents) {
+        for (const obj of response.Contents) {
+          totalSize += obj.Size ?? 0
+        }
+      }
+
+      isTruncatedFlag = response.IsTruncated ?? false
+      continuationToken = response.NextContinuationToken
+    }
+    return totalSize
+  } catch (err) {
+    console.error('Error calculating bucket size:', err)
+    throw new Error('Failed to calculate bucket size. Check your R2/S3 credentials and endpoint.')
+  }
+}

package/src/shared/system-stats.repository.d1.test.ts

@@ -1,54 +1,58 @@
-import { describe, it, expect, vi } from 'vitest'
-import { D1SystemStatsRepository } from './system-stats.repository.d1'
-
-function makeMockDb(firstResult: unknown = null) {
-  const runMock = vi.fn().mockResolvedValue({ success: true })
-  const firstMock = vi.fn().mockResolvedValue(firstResult)
-  // bind() returns the same statement interface for chained calls.
-  // The statement also exposes first() directly for queries without bind (e.g. getStorageUsage).
-  const bindMock = vi.fn(() => ({ run: runMock, first: firstMock }))
-  const stmt = { bind: bindMock, run: runMock, first: firstMock }
-  const prepareMock = vi.fn(() => stmt)
-  return { db: { prepare: prepareMock } as any, prepareMock, bindMock, runMock, firstMock }
-}
-
-describe('D1SystemStatsRepository', () => {
-  describe('incrementStorage', () => {
-    it('calls UPDATE system_stats with the byte count', async () => {
-      const { db, prepareMock, bindMock } = makeMockDb()
-      await new D1SystemStatsRepository(db).incrementStorage(512)
-      expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('UPDATE system_stats'))
-      expect(bindMock).toHaveBeenCalledWith(512)
-    })
-  })
-
-  describe('decrementStorage', () => {
-    it('calls UPDATE system_stats with MAX(0, ...) and the byte count', async () => {
-      const { db, prepareMock, bindMock } = makeMockDb()
-      await new D1SystemStatsRepository(db).decrementStorage(256)
-      expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('MAX(0'))
-      expect(bindMock).toHaveBeenCalledWith(256)
-    })
-  })
-
-  describe('setStorage', () => {
-    it('calls UPDATE system_stats with the stringified byte count', async () => {
-      const { db, prepareMock, bindMock } = makeMockDb()
-      await new D1SystemStatsRepository(db).setStorage(1024)
-      expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('UPDATE system_stats'))
-      expect(bindMock).toHaveBeenCalledWith('1024')
-    })
-  })
-
-  describe('getStorageUsage', () => {
-    it('parses and returns the integer value from D1', async () => {
-      const { db } = makeMockDb({ value: '2048' })
-      expect(await new D1SystemStatsRepository(db).getStorageUsage()).toBe(2048)
-    })
-
-    it('returns 0 when D1 returns null (stat not initialised)', async () => {
-      const { db } = makeMockDb(null)
-      expect(await new D1SystemStatsRepository(db).getStorageUsage()).toBe(0)
-    })
-  })
-})
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import { describe, it, expect, vi } from 'vitest'
+import { D1SystemStatsRepository } from './system-stats.repository.d1'
+
+function makeMockDb(firstResult: unknown = null) {
+  const runMock = vi.fn().mockResolvedValue({ success: true })
+  const firstMock = vi.fn().mockResolvedValue(firstResult)
+  // bind() returns the same statement interface for chained calls.
+  // The statement also exposes first() directly for queries without bind (e.g. getStorageUsage).
+  const bindMock = vi.fn(() => ({ run: runMock, first: firstMock }))
+  const stmt = { bind: bindMock, run: runMock, first: firstMock }
+  const prepareMock = vi.fn(() => stmt)
+  return { db: { prepare: prepareMock } as any, prepareMock, bindMock, runMock, firstMock }
+}
+
+describe('D1SystemStatsRepository', () => {
+  describe('incrementStorage', () => {
+    it('calls UPDATE system_stats with the byte count', async () => {
+      const { db, prepareMock, bindMock } = makeMockDb()
+      await new D1SystemStatsRepository(db).incrementStorage(512)
+      expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('UPDATE system_stats'))
+      expect(bindMock).toHaveBeenCalledWith(512)
+    })
+  })
+
+  describe('decrementStorage', () => {
+    it('calls UPDATE system_stats with MAX(0, ...) and the byte count', async () => {
+      const { db, prepareMock, bindMock } = makeMockDb()
+      await new D1SystemStatsRepository(db).decrementStorage(256)
+      expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('MAX(0'))
+      expect(bindMock).toHaveBeenCalledWith(256)
+    })
+  })
+
+  describe('setStorage', () => {
+    it('calls UPDATE system_stats with the stringified byte count', async () => {
+      const { db, prepareMock, bindMock } = makeMockDb()
+      await new D1SystemStatsRepository(db).setStorage(1024)
+      expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('UPDATE system_stats'))
+      expect(bindMock).toHaveBeenCalledWith('1024')
+    })
+  })
+
+  describe('getStorageUsage', () => {
+    it('parses and returns the integer value from D1', async () => {
+      const { db } = makeMockDb({ value: '2048' })
+      expect(await new D1SystemStatsRepository(db).getStorageUsage()).toBe(2048)
+    })
+
+    it('returns 0 when D1 returns null (stat not initialised)', async () => {
+      const { db } = makeMockDb(null)
+      expect(await new D1SystemStatsRepository(db).getStorageUsage()).toBe(0)
+    })
+  })
+})

package/src/shared/system-stats.repository.d1.ts

@@ -1,44 +1,48 @@
-import { SystemStatsRepository } from '@beechcms/core'
-
-/**
- * Implementation of SystemStatsRepository using Cloudflare D1.
- * Manages global system statistics such as total storage usage.
- */
-export class D1SystemStatsRepository implements SystemStatsRepository {
-  constructor(private database: D1Database) {}
-
-  /**
-   * Increments the total storage usage count.
-   */
-  async incrementStorage(byteCount: number): Promise<void> {
-    await this.database.prepare(
-      "UPDATE system_stats SET value = CAST(value AS INTEGER) + ? WHERE id = 'total_storage_bytes'"
-    ).bind(byteCount).run()
-  }
-
-  /**
-   * Decrements the total storage usage count, ensuring it doesn't fall below zero.
-   */
-  async decrementStorage(byteCount: number): Promise<void> {
-    await this.database.prepare(
-      "UPDATE system_stats SET value = MAX(0, CAST(value AS INTEGER) - ?) WHERE id = 'total_storage_bytes'"
-    ).bind(byteCount).run()
-  }
-
-  /**
-   * Sets the total storage usage count to a specific value.
-   */
-  async setStorage(byteCount: number): Promise<void> {
-    await this.database.prepare(
-      "UPDATE system_stats SET value = ? WHERE id = 'total_storage_bytes'"
-    ).bind(String(byteCount)).run()
-  }
-
-  /**
-   * Retrieves the current total storage usage in bytes.
-   */
-  async getStorageUsage(): Promise<number> {
-    const statsRecordResult = await this.database.prepare("SELECT value FROM system_stats WHERE id = 'total_storage_bytes'").first<{ value: string }>()
-    return statsRecordResult ? parseInt(statsRecordResult.value, 10) : 0
-  }
-}
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import { SystemStatsRepository } from '@beechcms/core'
+
+/**
+ * Implementation of SystemStatsRepository using Cloudflare D1.
+ * Manages global system statistics such as total storage usage.
+ */
+export class D1SystemStatsRepository implements SystemStatsRepository {
+  constructor(private database: D1Database) {}
+
+  /**
+   * Increments the total storage usage count.
+   */
+  async incrementStorage(byteCount: number): Promise<void> {
+    await this.database.prepare(
+      "UPDATE system_stats SET value = CAST(value AS INTEGER) + ? WHERE id = 'total_storage_bytes'"
+    ).bind(byteCount).run()
+  }
+
+  /**
+   * Decrements the total storage usage count, ensuring it doesn't fall below zero.
+   */
+  async decrementStorage(byteCount: number): Promise<void> {
+    await this.database.prepare(
+      "UPDATE system_stats SET value = MAX(0, CAST(value AS INTEGER) - ?) WHERE id = 'total_storage_bytes'"
+    ).bind(byteCount).run()
+  }
+
+  /**
+   * Sets the total storage usage count to a specific value.
+   */
+  async setStorage(byteCount: number): Promise<void> {
+    await this.database.prepare(
+      "UPDATE system_stats SET value = ? WHERE id = 'total_storage_bytes'"
+    ).bind(String(byteCount)).run()
+  }
+
+  /**
+   * Retrieves the current total storage usage in bytes.
+   */
+  async getStorageUsage(): Promise<number> {
+    const statsRecordResult = await this.database.prepare("SELECT value FROM system_stats WHERE id = 'total_storage_bytes'").first<{ value: string }>()
+    return statsRecordResult ? Number.parseInt(statsRecordResult.value, 10) : 0
+  }
+}

package/src/types.ts

@@ -1,67 +1,90 @@
-/// <reference types="@cloudflare/workers-types" />
-import type { Seed, ContentRepository, IdempotencyRepository, BeechBucket, MediaRepository, SystemStatsRepository, IHashProvider, ITokenService, IUserRepository, ISessionRepository, IPasswordResetTokenRepository, IActivityLogger, IActivityLogRepository, INotificationRepository, INotificationService, IWidgetRepository, ISearchRepository, IAnalyticsRepository, IContentScanRepository, ISeedRegistry, IClock, IIdGenerator, IAutomationRunner, IAutomationRepository, IScheduler } from '@beechcms/core'
-import type { IRateLimiterRegistry } from './middleware/rate-limit.middleware'
-
-export interface Env {
-  DB: D1Database
-  JWT_SECRET: string
-  JWT_ISSUER?: string
-  JWT_AUDIENCE?: string
-  R2_ACCESS_KEY_ID?: string
-  R2_SECRET_ACCESS_KEY?: string
-  R2_ENDPOINT?: string
-  R2_BUCKET_NAME?: string
-  LOGIN_RATE_LIMITER?: RateLimit
-  REFRESH_RATE_LIMITER?: RateLimit
-  PUBLIC_READ_RATE_LIMITER?: RateLimit
-  PUBLIC_WRITE_RATE_LIMITER?: RateLimit
-  CORS_ORIGINS?: string
-  PUBLIC_READ_API_KEY?: string
-  PUBLIC_WRITE_API_KEY?: string
-  PUBLIC_PUBLISHED_ONLY?: string
-  PUBLIC_IDEMPOTENCY_TTL_SECONDS?: string
-  MEDIA_BASE_URL?: string
-  MEDIA_CDN_URL?: string
-  RESEND_API_KEY?: string
-  EMAIL_API_KEY?: string
-  APP_URL?: string
-  EMAIL_FROM?: string
-  FORGOT_PASSWORD_RATE_LIMITER?: RateLimit
-  RESET_PASSWORD_RATE_LIMITER?: RateLimit
-  ENV?: string
-  DATE_FORMAT?: string
-  ASSETS?: Fetcher
-  MEDIA_BUCKET?: R2Bucket
-}
-
-export interface Variables {
-  jwtPayload: { sub: string; email?: string; name?: string | null }
-  getSeed: (slug: string) => Seed | null
-  seedRegistry: ISeedRegistry
-  repository: ContentRepository
-  idempotencyRepository: IdempotencyRepository
-  bucket: BeechBucket
-  mediaRepository: MediaRepository
-  systemStatsRepository: SystemStatsRepository
-  hashProvider: IHashProvider
-  tokenService: ITokenService
-  userRepository: IUserRepository
-  sessionRepository: ISessionRepository
-  passwordResetTokenRepository: IPasswordResetTokenRepository
-  rateLimiters: IRateLimiterRegistry
-  activityLogger: IActivityLogger
-  activityLogRepository: IActivityLogRepository
-  notificationRepository: INotificationRepository
-  notificationService: INotificationService
-  widgetRepository: IWidgetRepository
-  searchRepository: ISearchRepository
-  analyticsRepository: IAnalyticsRepository
-  contentScanRepository: IContentScanRepository
-  clock: IClock
-  idGenerator: IIdGenerator
-  automationRepository: IAutomationRepository
-  automationRunner: IAutomationRunner
-  scheduler: IScheduler
-}
-
-export type AppEnv = { Bindings: Env; Variables: Variables }
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+/// <reference types="@cloudflare/workers-types" />
+import type { Seed, ContentRepository, IdempotencyRepository, BeechBucket, MediaRepository, SystemStatsRepository, IHashProvider, ITokenService, IUserRepository, ISessionRepository, IPasswordResetTokenRepository, IActivityLogger, IActivityLogRepository, INotificationRepository, INotificationService, IWidgetRepository, ISearchRepository, IAnalyticsRepository, IContentScanRepository, ISeedRegistry, IClock, IIdGenerator, IAutomationRunner, IAutomationRepository, IScheduler, BackrefMap, ISiteSettingsRepository, IDemoDataRepository, JwtClaims, ISeedLayoutRepository, ISeedRepository, ISchemaMutator, IDashboardLayoutRepository } from '@beechcms/core'
+import type { IRateLimiterRegistry } from './middleware/rate-limit.middleware'
+import type { ISetupChecklistRepository } from './shared/d1-setup-checklist.repository'
+
+export interface Env {
+  DB: D1Database
+  JWT_SECRET: string
+  JWT_ISSUER?: string
+  JWT_AUDIENCE?: string
+  R2_ACCESS_KEY_ID?: string
+  R2_SECRET_ACCESS_KEY?: string
+  R2_ENDPOINT?: string
+  R2_BUCKET_NAME?: string
+  LOGIN_RATE_LIMITER?: RateLimit
+  REFRESH_RATE_LIMITER?: RateLimit
+  PUBLIC_READ_RATE_LIMITER?: RateLimit
+  PUBLIC_WRITE_RATE_LIMITER?: RateLimit
+  CORS_ORIGINS?: string
+  PUBLIC_READ_API_KEY?: string
+  PUBLIC_WRITE_API_KEY?: string
+  PUBLIC_PUBLISHED_ONLY?: string
+  PUBLIC_IDEMPOTENCY_TTL_SECONDS?: string
+  MEDIA_BASE_URL?: string
+  MEDIA_CDN_URL?: string
+  MAX_UPLOAD_BYTES?: string
+  RESEND_API_KEY?: string
+  EMAIL_API_KEY?: string
+  APP_URL?: string
+  EMAIL_FROM?: string
+  EMAIL_PROVIDER?: string
+  SMTP_HOST?: string
+  SMTP_PORT?: string
+  WEBHOOK_TESTER_URL?: string
+  FORGOT_PASSWORD_RATE_LIMITER?: RateLimit
+  RESET_PASSWORD_RATE_LIMITER?: RateLimit
+  ENV?: string
+  DATE_FORMAT?: string
+  ASSETS?: Fetcher
+  QSTASH_TOKEN?: string
+  QSTASH_URL?: string
+  /** Public base URL the worker is reachable at, used by QStash to call back the webhook (e.g. an ngrok tunnel in dev). Falls back to APP_URL. */
+  QSTASH_CALLBACK_URL?: string
+  QSTASH_CURRENT_SIGNING_KEY?: string
+  QSTASH_NEXT_SIGNING_KEY?: string
+}
+
+export interface Variables {
+  jwtPayload: JwtClaims
+  getSeed: (slug: string) => Seed | null
+  seedRegistry: ISeedRegistry
+  repository: ContentRepository
+  idempotencyRepository: IdempotencyRepository
+  bucket: BeechBucket
+  mediaRepository: MediaRepository
+  systemStatsRepository: SystemStatsRepository
+  hashProvider: IHashProvider
+  tokenService: ITokenService
+  userRepository: IUserRepository
+  sessionRepository: ISessionRepository
+  passwordResetTokenRepository: IPasswordResetTokenRepository
+  rateLimiters: IRateLimiterRegistry
+  activityLogger: IActivityLogger
+  activityLogRepository: IActivityLogRepository
+  notificationRepository: INotificationRepository
+  notificationService: INotificationService
+  widgetRepository: IWidgetRepository
+  searchRepository: ISearchRepository
+  analyticsRepository: IAnalyticsRepository
+  contentScanRepository: IContentScanRepository
+  clock: IClock
+  idGenerator: IIdGenerator
+  automationRepository: IAutomationRepository
+  automationRunner: IAutomationRunner
+  scheduler: IScheduler
+  backrefMap: BackrefMap
+  siteSettingsRepository: ISiteSettingsRepository
+  demoDataRepository: IDemoDataRepository
+  setupChecklistRepository: ISetupChecklistRepository
+  seedLayoutRepository: ISeedLayoutRepository
+  seedRepository: ISeedRepository
+  schemaMutator: ISchemaMutator
+  dashboardLayoutRepository: IDashboardLayoutRepository
+}
+
+export type AppEnv = { Bindings: Env; Variables: Variables }