@beechcms/api 0.5.0 → 0.6.0-preview.2

package/src/shared/d1-activity-log.repository.test.ts

@@ -1,136 +1,140 @@
-import { describe, it, expect, vi } from 'vitest'
-import { D1ActivityLogRepository } from './d1-activity-log.repository'
-
-function makeMockDb(allResults: unknown[], firstResult: unknown = null) {
-  const allMock = vi.fn().mockResolvedValue({ results: allResults })
-  const firstMock = vi.fn().mockResolvedValue(firstResult)
-  const bindMock = vi.fn(() => ({ all: allMock, first: firstMock }))
-  const prepareMock = vi.fn(() => ({ bind: bindMock }))
-  return { db: { prepare: prepareMock } as any, prepareMock, bindMock, allMock, firstMock }
-}
-
-describe('D1ActivityLogRepository', () => {
-  it('maps snake_case rows to camelCase records and parses the details JSON', async () => {
-    const row = {
-      id: 'log-1',
-      user_id: 'u1',
-      user_email: 'a@b.com',
-      user_name: 'Admin',
-      action: 'create',
-      entity_type: 'content',
-      entity_id: 'e1',
-      entity_slug: 'posts',
-      details: '{"title":"Hello"}',
-      created_at: 1234,
-    }
-    const { db } = makeMockDb([row])
-    const result = await new D1ActivityLogRepository(db).list({ limit: 10 })
-    expect(result).toEqual([
-      {
-        id: 'log-1',
-        userId: 'u1',
-        userEmail: 'a@b.com',
-        userName: 'Admin',
-        action: 'create',
-        entityType: 'content',
-        entityId: 'e1',
-        entitySlug: 'posts',
-        details: { title: 'Hello' },
-        createdAt: 1234,
-      },
-    ])
-  })
-
-  it('returns null details when the column is null', async () => {
-    const { db } = makeMockDb([
-      {
-        id: 'l',
-        user_id: 'u',
-        user_email: 'a',
-        user_name: null,
-        action: 'delete',
-        entity_type: 'content',
-        entity_id: 'e',
-        entity_slug: null,
-        details: null,
-        created_at: 1,
-      },
-    ])
-    const [record] = await new D1ActivityLogRepository(db).list({ limit: 1 })
-    expect(record.details).toBeNull()
-    expect(record.userName).toBeNull()
-    expect(record.entitySlug).toBeNull()
-  })
-
-  it('omits the WHERE clause when no filters are provided', async () => {
-    const { db, prepareMock, bindMock } = makeMockDb([])
-    await new D1ActivityLogRepository(db).list({ limit: 5 })
-    expect(prepareMock.mock.calls[0][0]).not.toMatch(/WHERE/)
-    expect(bindMock).toHaveBeenCalledWith(5)
-  })
-
-  it('builds a userId WHERE clause when the option is set', async () => {
-    const { db, prepareMock, bindMock } = makeMockDb([])
-    await new D1ActivityLogRepository(db).list({ userId: 'u-9', limit: 3 })
-    expect(prepareMock.mock.calls[0][0]).toMatch(/WHERE user_id = \?/)
-    expect(bindMock).toHaveBeenCalledWith('u-9', 3)
-  })
-
-  it('builds a combined userId + entitySlug WHERE clause with AND', async () => {
-    const { db, prepareMock, bindMock } = makeMockDb([])
-    await new D1ActivityLogRepository(db).list({ userId: 'u', entitySlug: 'posts', limit: 7 })
-    expect(prepareMock.mock.calls[0][0]).toMatch(/WHERE user_id = \? AND entity_slug = \?/)
-    expect(bindMock).toHaveBeenCalledWith('u', 'posts', 7)
-  })
-
-  it('always orders by created_at DESC and applies LIMIT', async () => {
-    const { db, prepareMock } = makeMockDb([])
-    await new D1ActivityLogRepository(db).list({ limit: 1 })
-    expect(prepareMock.mock.calls[0][0]).toMatch(/ORDER BY created_at DESC/)
-    expect(prepareMock.mock.calls[0][0]).toMatch(/LIMIT \?/)
-  })
-
-  describe('countSince', () => {
-    it('binds action, entityType and sinceTimestamp and returns the count', async () => {
-      const { db, prepareMock, bindMock } = makeMockDb([], { count: 42 })
-      const result = await new D1ActivityLogRepository(db).countSince({
-        action: 'create',
-        entityType: 'content',
-        sinceTimestamp: 1000,
-      })
-      expect(result).toBe(42)
-      expect(prepareMock.mock.calls[0][0]).toMatch(/COUNT\(\*\)/)
-      expect(prepareMock.mock.calls[0][0]).toMatch(/WHERE action = \?\s+AND entity_type = \?\s+AND created_at >= \?/)
-      expect(bindMock).toHaveBeenCalledWith('create', 'content', 1000)
-    })
-
-    it('returns 0 when no rows match', async () => {
-      const { db } = makeMockDb([], null)
-      const result = await new D1ActivityLogRepository(db).countSince({
-        action: 'delete',
-        entityType: 'media',
-        sinceTimestamp: 0,
-      })
-      expect(result).toBe(0)
-    })
-  })
-
-  it('returns null details when the JSON payload cannot be parsed', async () => {
-    const { db } = makeMockDb([
-      {
-        id: 'l',
-        user_id: 'u',
-        user_email: 'a',
-        user_name: null,
-        action: 'create',
-        entity_type: 'content',
-        entity_id: 'e',
-        entity_slug: null,
-        details: 'not-json',
-        created_at: 1,
-      },
-    ])
-    const [record] = await new D1ActivityLogRepository(db).list({ limit: 1 })
-    expect(record.details).toBeNull()
-  })
-})
+// 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 { D1ActivityLogRepository } from './d1-activity-log.repository'
+
+function makeMockDb(allResults: unknown[], firstResult: unknown = null) {
+  const allMock = vi.fn().mockResolvedValue({ results: allResults })
+  const firstMock = vi.fn().mockResolvedValue(firstResult)
+  const bindMock = vi.fn(() => ({ all: allMock, first: firstMock }))
+  const prepareMock = vi.fn(() => ({ bind: bindMock }))
+  return { db: { prepare: prepareMock } as any, prepareMock, bindMock, allMock, firstMock }
+}
+
+describe('D1ActivityLogRepository', () => {
+  it('maps snake_case rows to camelCase records and parses the details JSON', async () => {
+    const row = {
+      id: 'log-1',
+      user_id: 'u1',
+      user_email: 'a@b.com',
+      user_name: 'Admin',
+      action: 'create',
+      entity_type: 'content',
+      entity_id: 'e1',
+      entity_slug: 'posts',
+      details: '{"title":"Hello"}',
+      created_at: 1234,
+    }
+    const { db } = makeMockDb([row])
+    const result = await new D1ActivityLogRepository(db).list({ limit: 10 })
+    expect(result).toEqual([
+      {
+        id: 'log-1',
+        userId: 'u1',
+        userEmail: 'a@b.com',
+        userName: 'Admin',
+        action: 'create',
+        entityType: 'content',
+        entityId: 'e1',
+        entitySlug: 'posts',
+        details: { title: 'Hello' },
+        createdAt: 1234,
+      },
+    ])
+  })
+
+  it('returns null details when the column is null', async () => {
+    const { db } = makeMockDb([
+      {
+        id: 'l',
+        user_id: 'u',
+        user_email: 'a',
+        user_name: null,
+        action: 'delete',
+        entity_type: 'content',
+        entity_id: 'e',
+        entity_slug: null,
+        details: null,
+        created_at: 1,
+      },
+    ])
+    const [record] = await new D1ActivityLogRepository(db).list({ limit: 1 })
+    expect(record.details).toBeNull()
+    expect(record.userName).toBeNull()
+    expect(record.entitySlug).toBeNull()
+  })
+
+  it('omits the WHERE clause when no filters are provided', async () => {
+    const { db, prepareMock, bindMock } = makeMockDb([])
+    await new D1ActivityLogRepository(db).list({ limit: 5 })
+    expect(prepareMock.mock.calls[0][0]).not.toMatch(/WHERE/)
+    expect(bindMock).toHaveBeenCalledWith(5)
+  })
+
+  it('builds a userId WHERE clause when the option is set', async () => {
+    const { db, prepareMock, bindMock } = makeMockDb([])
+    await new D1ActivityLogRepository(db).list({ userId: 'u-9', limit: 3 })
+    expect(prepareMock.mock.calls[0][0]).toMatch(/WHERE user_id = \?/)
+    expect(bindMock).toHaveBeenCalledWith('u-9', 3)
+  })
+
+  it('builds a combined userId + entitySlug WHERE clause with AND', async () => {
+    const { db, prepareMock, bindMock } = makeMockDb([])
+    await new D1ActivityLogRepository(db).list({ userId: 'u', entitySlug: 'posts', limit: 7 })
+    expect(prepareMock.mock.calls[0][0]).toMatch(/WHERE user_id = \? AND entity_slug = \?/)
+    expect(bindMock).toHaveBeenCalledWith('u', 'posts', 7)
+  })
+
+  it('always orders by created_at DESC and applies LIMIT', async () => {
+    const { db, prepareMock } = makeMockDb([])
+    await new D1ActivityLogRepository(db).list({ limit: 1 })
+    expect(prepareMock.mock.calls[0][0]).toMatch(/ORDER BY created_at DESC/)
+    expect(prepareMock.mock.calls[0][0]).toMatch(/LIMIT \?/)
+  })
+
+  describe('countSince', () => {
+    it('binds action, entityType and sinceTimestamp and returns the count', async () => {
+      const { db, prepareMock, bindMock } = makeMockDb([], { count: 42 })
+      const result = await new D1ActivityLogRepository(db).countSince({
+        action: 'create',
+        entityType: 'content',
+        sinceTimestamp: 1000,
+      })
+      expect(result).toBe(42)
+      expect(prepareMock.mock.calls[0][0]).toMatch(/COUNT\(\*\)/)
+      expect(prepareMock.mock.calls[0][0]).toMatch(/WHERE action = \?\s+AND entity_type = \?\s+AND created_at >= \?/)
+      expect(bindMock).toHaveBeenCalledWith('create', 'content', 1000)
+    })
+
+    it('returns 0 when no rows match', async () => {
+      const { db } = makeMockDb([], null)
+      const result = await new D1ActivityLogRepository(db).countSince({
+        action: 'delete',
+        entityType: 'media',
+        sinceTimestamp: 0,
+      })
+      expect(result).toBe(0)
+    })
+  })
+
+  it('returns null details when the JSON payload cannot be parsed', async () => {
+    const { db } = makeMockDb([
+      {
+        id: 'l',
+        user_id: 'u',
+        user_email: 'a',
+        user_name: null,
+        action: 'create',
+        entity_type: 'content',
+        entity_id: 'e',
+        entity_slug: null,
+        details: 'not-json',
+        created_at: 1,
+      },
+    ])
+    const [record] = await new D1ActivityLogRepository(db).list({ limit: 1 })
+    expect(record.details).toBeNull()
+  })
+})

package/src/shared/d1-activity-log.repository.ts

@@ -1,101 +1,105 @@
-/// <reference types="@cloudflare/workers-types" />
-import type {
-  IActivityLogRepository,
-  ActivityLogRecord,
-  ActivityLogListOptions,
-  ActivityAction,
-  EntityType,
-  CountSinceOptions,
-} from '@beechcms/core'
-
-interface ActivityLogRow {
-  id: string
-  user_id: string
-  user_email: string
-  user_name: string | null
-  action: string
-  entity_type: string
-  entity_id: string
-  entity_slug: string | null
-  details: string | null
-  created_at: number
-}
-
-/**
- * D1-backed implementation of {@link IActivityLogRepository}.
- *
- * Builds parameterised queries with optional WHERE clauses without nesting
- * conditionals — guard clauses keep the body flat and the SQL deterministic.
- */
-export class D1ActivityLogRepository implements IActivityLogRepository {
-  constructor(private readonly database: D1Database) {}
-
-  async list(options: ActivityLogListOptions): Promise<ActivityLogRecord[]> {
-    const whereClauses: string[] = []
-    const bindings: unknown[] = []
-
-    if (options.userId) {
-      whereClauses.push('user_id = ?')
-      bindings.push(options.userId)
-    }
-
-    if (options.entitySlug) {
-      whereClauses.push('entity_slug = ?')
-      bindings.push(options.entitySlug)
-    }
-
-    const whereSql = whereClauses.length > 0 ? `WHERE ${whereClauses.join(' AND ')}` : ''
-
-    const sql =
-      `SELECT id, user_id, user_email, user_name, action, entity_type,
-              entity_id, entity_slug, details, created_at
-         FROM activity_logs
-         ${whereSql}
-         ORDER BY created_at DESC
-         LIMIT ?`
-
-    bindings.push(options.limit)
-
-    const queryResult = await this.database.prepare(sql).bind(...bindings).all<ActivityLogRow>()
-    return (queryResult.results ?? []).map(mapRowToRecord)
-  }
-
-  async countSince(options: CountSinceOptions): Promise<number> {
-    const row = await this.database
-      .prepare(
-        `SELECT COUNT(*) as count
-           FROM activity_logs
-          WHERE action = ?
-            AND entity_type = ?
-            AND created_at >= ?`
-      )
-      .bind(options.action, options.entityType, options.sinceTimestamp)
-      .first<{ count: number }>()
-    return row?.count ?? 0
-  }
-}
-
-function mapRowToRecord(row: ActivityLogRow): ActivityLogRecord {
-  return {
-    id: row.id,
-    userId: row.user_id,
-    userEmail: row.user_email,
-    userName: row.user_name,
-    action: row.action as ActivityAction,
-    entityType: row.entity_type as EntityType,
-    entityId: row.entity_id,
-    entitySlug: row.entity_slug,
-    details: parseDetails(row.details),
-    createdAt: row.created_at,
-  }
-}
-
-function parseDetails(raw: string | null): Record<string, unknown> | null {
-  if (raw === null) return null
-  try {
-    const parsed = JSON.parse(raw)
-    return parsed && typeof parsed === 'object' ? (parsed as Record<string, unknown>) : null
-  } catch {
-    return null
-  }
-}
+// 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 {
+  IActivityLogRepository,
+  ActivityLogRecord,
+  ActivityLogListOptions,
+  ActivityAction,
+  EntityType,
+  CountSinceOptions,
+} from '@beechcms/core'
+
+interface ActivityLogRow {
+  id: string
+  user_id: string
+  user_email: string
+  user_name: string | null
+  action: string
+  entity_type: string
+  entity_id: string
+  entity_slug: string | null
+  details: string | null
+  created_at: number
+}
+
+/**
+ * D1-backed implementation of {@link IActivityLogRepository}.
+ *
+ * Builds parameterised queries with optional WHERE clauses without nesting
+ * conditionals — guard clauses keep the body flat and the SQL deterministic.
+ */
+export class D1ActivityLogRepository implements IActivityLogRepository {
+  constructor(private readonly database: D1Database) {}
+
+  async list(options: ActivityLogListOptions): Promise<ActivityLogRecord[]> {
+    const whereClauses: string[] = []
+    const bindings: unknown[] = []
+
+    if (options.userId) {
+      whereClauses.push('user_id = ?')
+      bindings.push(options.userId)
+    }
+
+    if (options.entitySlug) {
+      whereClauses.push('entity_slug = ?')
+      bindings.push(options.entitySlug)
+    }
+
+    const whereSql = whereClauses.length > 0 ? `WHERE ${whereClauses.join(' AND ')}` : ''
+
+    const sql =
+      `SELECT id, user_id, user_email, user_name, action, entity_type,
+              entity_id, entity_slug, details, created_at
+         FROM activity_logs
+         ${whereSql}
+         ORDER BY created_at DESC
+         LIMIT ?`
+
+    bindings.push(options.limit)
+
+    const queryResult = await this.database.prepare(sql).bind(...bindings).all<ActivityLogRow>()
+    return (queryResult.results ?? []).map(mapRowToRecord)
+  }
+
+  async countSince(options: CountSinceOptions): Promise<number> {
+    const row = await this.database
+      .prepare(
+        `SELECT COUNT(*) as count
+           FROM activity_logs
+          WHERE action = ?
+            AND entity_type = ?
+            AND created_at >= ?`
+      )
+      .bind(options.action, options.entityType, options.sinceTimestamp)
+      .first<{ count: number }>()
+    return row?.count ?? 0
+  }
+}
+
+function mapRowToRecord(row: ActivityLogRow): ActivityLogRecord {
+  return {
+    id: row.id,
+    userId: row.user_id,
+    userEmail: row.user_email,
+    userName: row.user_name,
+    action: row.action as ActivityAction,
+    entityType: row.entity_type as EntityType,
+    entityId: row.entity_id,
+    entitySlug: row.entity_slug,
+    details: parseDetails(row.details),
+    createdAt: row.created_at,
+  }
+}
+
+function parseDetails(raw: string | null): Record<string, unknown> | null {
+  if (raw === null) return null
+  try {
+    const parsed = JSON.parse(raw)
+    return parsed && typeof parsed === 'object' ? (parsed as Record<string, unknown>) : null
+  } catch {
+    return null
+  }
+}