@crombolo/api-management 0.17.0 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crombolo/api-management",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "Umbraco-compatible Management API handlers for crombolo.",
   "license": "MIT",
   "author": "Crombolo",
@@ -28,7 +28,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@crombolo/core": "0.17.0",
-    "@crombolo/contracts": "0.17.0"
+    "@crombolo/core": "0.18.0",
+    "@crombolo/contracts": "0.18.0"
   }
 }

package/src/handlers/diagnostics.ts

@@ -1,47 +1,35 @@
 /**
  * Health checks, telemetry, profiling and the server's troubleshooting and
- * upgrade-check answers. Telemetry and profiling are fixed: nothing is
- * collected or sent, and there is no profiler. docs/diagnostics.md.
+ * upgrade-check answers. Telemetry and profiling are gone — nothing is
+ * collected or sent, and there is no profiler — so their endpoints answer 410.
+ * docs/diagnostics.md.
  */
 import { invalidSkipTake, notFound, problemDetails, problemResponse } from '@crombolo/core'
 import type { DiagnosticsPort } from '../ports-diagnostics.ts'
 import type { ManagementApiRouter } from '../router.ts'
 import { paging } from './content-type.ts'
-import { readBody } from './document.ts'
-
-const TELEMETRY_LEVEL = 'Minimal'
 
 const badRequest = (title: string, detail: string) => problemDetails({ title, detail, status: 400 })
 
+/** An operation for something this server has not got, and never will: 410, with why. */
+const gone = (title: string, detail: string) => () =>
+  problemResponse(problemDetails({ title, detail, status: 410 }))
+
+const telemetryGone = gone(
+  'Telemetry is not collected',
+  'This site collects no telemetry and sends nothing anywhere.',
+)
+const profilingGone = gone(
+  'There is no profiler',
+  'This site has no profiler to read or switch on.',
+)
+
 export function registerTelemetryAndProfilingHandlers(router: ManagementApiRouter): void {
-  router.handle('GetTelemetry', (ctx) => {
-    const page = paging(ctx)
-    if (!page) return problemResponse(invalidSkipTake())
-    const items = [{ telemetryLevel: TELEMETRY_LEVEL }]
-    return Response.json({
-      total: items.length,
-      items: items.slice(page.skip, page.skip + page.take),
-    })
-  })
-  router.handle('GetTelemetryLevel', () => Response.json({ telemetryLevel: TELEMETRY_LEVEL }))
-  router.handle('PostTelemetryLevel', async (ctx) => {
-    const { telemetryLevel } = await readBody(ctx)
-    if (telemetryLevel === TELEMETRY_LEVEL) return new Response(null, { status: 200 })
-    return problemResponse(
-      badRequest(
-        'Telemetry cannot be raised',
-        'This site collects no telemetry and sends nothing anywhere, so the level stays at Minimal.',
-      ),
-    )
-  })
-  router.handle('GetProfilingStatus', () => Response.json({ enabled: false }))
-  router.handle('PutProfilingStatus', async (ctx) => {
-    const { enabled } = await readBody(ctx)
-    if (enabled === false) return new Response(null, { status: 200 })
-    return problemResponse(
-      badRequest('Profiling is not available', 'This site has no profiler to switch on.'),
-    )
-  })
+  router.handle('GetTelemetry', telemetryGone)
+  router.handle('GetTelemetryLevel', telemetryGone)
+  router.handle('PostTelemetryLevel', telemetryGone)
+  router.handle('GetProfilingStatus', profilingGone)
+  router.handle('PutProfilingStatus', profilingGone)
 }
 
 export function registerDiagnosticsHandlers(

package/src/handlers/settings-stubs.ts

@@ -6,7 +6,7 @@
  * when its story in docs/stories/ lands. Counted
  * separately by `coverage:api`.
  */
-import { invalidSkipTake, notFound, problemResponse } from '@crombolo/core'
+import { invalidSkipTake, notFound, problemDetails, problemResponse } from '@crombolo/core'
 import type { ManagementApiRouter } from '../router.ts'
 import { paging } from './content-type.ts'
 
@@ -34,10 +34,8 @@ const SIBLINGS = [
 /** Lookups of one thing in an empty area: there is nothing to find. */
 const NOT_FOUND: string[] = []
 
-/** Fixed bodies. Umbraco's news dashboard relays umbraco.com; there is no feed to relay here. */
-const FIXED: Record<string, unknown> = {
-  GetNewsDashboard: { items: [] },
-}
+/** Fixed bodies. */
+const FIXED: Record<string, unknown> = {}
 
 export const EMPTY_SETTINGS_OPERATIONS: readonly string[] = [
   ...PAGED,
@@ -64,4 +62,15 @@ export function registerSettingsStubHandlers(router: ManagementApiRouter): void
   for (const [operation, body] of Object.entries(FIXED)) {
     router.handle(operation, () => Response.json(body))
   }
+  // Umbraco's news dashboard relays umbraco.com's feed. There is no feed here,
+  // and the dashboard is not vendored, so the operation is gone rather than empty.
+  router.handle('GetNewsDashboard', () =>
+    problemResponse(
+      problemDetails({
+        title: 'There is no news feed',
+        detail: 'This site relays no news from anywhere.',
+        status: 410,
+      }),
+    ),
+  )
 }