@easy-cms/core 1.6.0 → 1.7.0

package/dist/{chunk-GBEWSAZF.js → chunk-AVUGFJ4Q.js}

@@ -2789,6 +2789,42 @@ function configSignature(config) {
 }
 var signatures = /* @__PURE__ */ new WeakMap();
 
+// src/health.ts
+var HEADERS = { "content-type": "application/json; charset=utf-8", "cache-control": "no-store" };
+var migrated = /* @__PURE__ */ new WeakSet();
+async function pendingMigrations(cms) {
+  if (migrated.has(cms)) return 0;
+  const pending = (await cms.db.migrationStatus()).filter((m) => !m.applied).length;
+  if (pending === 0) migrated.add(cms);
+  return pending;
+}
+async function healthResponse(check3, instance) {
+  const cms = instance;
+  if (check3 === "healthz") return new Response("ok", { headers: { "cache-control": "no-store" } });
+  if (!cms) {
+    return Response.json(
+      { status: "error", checks: { startup: "error" } },
+      { status: 503, headers: HEADERS }
+    );
+  }
+  const checks = {};
+  try {
+    await cms.db.count({ collection: USERS });
+    checks.database = "ok";
+    const pending = await pendingMigrations(cms);
+    checks.migrations = pending === 0 ? "ok" : `${pending} pending`;
+  } catch (error) {
+    if (checks.database) checks.migrations = "error";
+    else Object.assign(checks, { database: "error", migrations: "not checked" });
+    cms.logger.error(`Readiness check failed: ${error.message}`, { error });
+  }
+  const ok = Object.values(checks).every((value) => value === "ok");
+  return Response.json(
+    { status: ok ? "ok" : "error", checks },
+    { status: ok ? 200 : 503, headers: HEADERS }
+  );
+}
+
 // src/copy.ts
 var BATCH = 200;
 async function copyDatabase(source, target, options = {}) {
@@ -4825,7 +4861,9 @@ var RESERVED_SLUGS = /* @__PURE__ */ new Set([
   "jobs",
   "auth",
   "migrations",
-  "access"
+  "access",
+  "healthz",
+  "readyz"
 ]);
 var SYSTEM_FIELD_NAMES = /* @__PURE__ */ new Set(["id", "createdAt", "updatedAt"]);
 var SLUG_PATTERN = /^[a-z][a-z0-9_-]*$/;
@@ -5999,6 +6037,8 @@ var RESERVED_ENDPOINT_ROOTS = /* @__PURE__ */ new Set([
   "media",
   "api-keys",
   "auth",
+  "healthz",
+  "readyz",
   // Kept free for later versions.
   "system",
   "health",
@@ -6122,12 +6162,13 @@ function validateEndpoints(config, collectionSlugs, add) {
         const taken = [
           config.routes?.api ?? "/api/cms",
           `/${(config.admin?.path ?? "/admin").replace(/^\/+|\/+$/g, "")}`,
-          "/healthz"
+          "/healthz",
+          "/readyz"
         ].map((p) => p.replace(/\/+$/, "")).find((p) => route2 === p || route2.startsWith(`${p}/`) || p.startsWith(`${route2}/`));
         if (taken)
           add(
             `${path}.path`,
-            `"${route2}" is served by ${taken === "/healthz" ? "the standalone server" : `"${taken}"`}`
+            `"${route2}" is served by ${taken === "/healthz" || taken === "/readyz" ? "the standalone server" : `"${taken}"`}`
           );
       } else if (RESERVED_ENDPOINT_ROOTS.has(first) || collectionSlugs.has(first)) {
         add(
@@ -9765,7 +9806,7 @@ async function readAdminModule(cms, index) {
 }
 
 // src/version.ts
-var VERSION = true ? "1.6.0" : "0.0.0-dev";
+var VERSION = true ? "1.7.0" : "0.0.0-dev";
 
 // src/rest/handler.ts
 import { randomUUID as randomUUID4 } from "crypto";
@@ -10715,6 +10756,10 @@ function withCors(cms, handle) {
     return withHeaders(await handle(request), cors);
   };
 }
+var HEALTH_CHECKS = /* @__PURE__ */ new Map([
+  ["healthz", "healthz"],
+  ["readyz", "readyz"]
+]);
 var REQUEST_ID = /^[\w.-]{1,128}$/;
 async function respond(cms, request, url, path, root, options, production) {
   const started = performance.now();
@@ -10732,7 +10777,8 @@ async function respond(cms, request, url, path, root, options, production) {
   } catch {
     tagged = withHeaders(response, new Headers({ "x-request-id": requestId }));
   }
-  if (cms.config.logs?.requests !== false && isJsonLogger(cms.logger)) {
+  const probe = !root && (path === "/healthz" || path === "/readyz");
+  if (!probe && cms.config.logs?.requests !== false && isJsonLogger(cms.logger)) {
     auditContext.run(
       { requestId },
       () => cms.logger.info(`${request.method} ${url.pathname} ${tagged.status}`, {
@@ -10756,6 +10802,15 @@ async function respondNow(cms, request, url, path, root, options, production, re
   try {
     if (path === null) throw new HttpError("Not found", 404);
     const segments = pathSegments(path);
+    const probe = !root && segments.length === 1 ? HEALTH_CHECKS.get(segments[0]) : void 0;
+    if (probe) {
+      const method2 = request.method.toUpperCase();
+      if (method2 !== "GET" && method2 !== "HEAD") {
+        headers.set("allow", "GET, HEAD");
+        throw new HttpError("Method not allowed", 405);
+      }
+      return await healthResponse(probe, cms);
+    }
     const { token, via } = readToken(request);
     const signedIn = token ? await cms.auth.verify(token) : null;
     if (!signedIn && via === "bearer" && token?.startsWith("ecms_"))
@@ -12012,8 +12067,21 @@ function platformClientIp(headers) {
 function createApiHandler(config, options = {}) {
   const handlers = /* @__PURE__ */ new WeakMap();
   const getClientIp = options.getClientIp ?? (options.trustProxy ? (r) => forwardedClientIp(r.headers.get("x-forwarded-for")) : (r) => platformClientIp(r.headers));
+  const base = (options.basePath ?? config.routes?.api ?? "/api/cms").replace(/\/+$/, "");
   return async (request) => {
-    const cms = await sharedEasyCMS(config);
+    let cms;
+    try {
+      cms = await sharedEasyCMS(config);
+    } catch (error) {
+      const { pathname } = new URL(request.url);
+      const probe = pathname === `${base}/healthz` ? "healthz" : pathname === `${base}/readyz` ? "readyz" : null;
+      if (!probe) throw error;
+      if (probe === "readyz") {
+        const logger = logFormat(config.logs) === "json" ? jsonLogger() : consoleLogger;
+        logger.error(`Readiness check failed: ${error.message}`, { error });
+      }
+      return healthResponse(probe, null);
+    }
     let handler = handlers.get(cms);
     if (!handler) {
       handler = createRestHandler(cms, {
@@ -12111,6 +12179,7 @@ export {
   validateFields,
   consoleEmail,
   configSignature,
+  healthResponse,
   copyDatabase,
   diskStorage,
   decryptBackup,

package/dist/index.js

@@ -24,7 +24,7 @@ import {
   sharedEasyCMS,
   silentLogger,
   slugify
-} from "./chunk-GBEWSAZF.js";
+} from "./chunk-AVUGFJ4Q.js";
 import {
   matchesCondition
 } from "./chunk-U266LV4M.js";

package/dist/internal.d.ts

@@ -1,4 +1,4 @@
-import { ab as Config, al as Database, bo as NavGroup, a6 as CollectionConfig, I as ID, bH as RawDocument, aD as Field, bL as ResolvedConfig, ad as ConfigIssue } from './config-CzW6kBeb.js';
+import { ab as Config, al as Database, au as EasyCMS, bo as NavGroup, a6 as CollectionConfig, I as ID, bH as RawDocument, aD as Field, bL as ResolvedConfig, ad as ConfigIssue } from './config-CzW6kBeb.js';
 export { cL as API_KEYS, cM as API_KEY_GLOBAL_OPERATIONS, cN as API_KEY_OPERATIONS, cO as DEFAULT_MAX_VERSIONS, cP as DEFAULT_PASSWORD_EMAILS, cQ as FIELD_TYPE_BASES, cR as FOLDER_LEVELS, cS as MediaFolders, cT as SSO_COOKIE, cU as codeOfStatus, cA as hasRows, cC as isHasMany, cV as isJsonLogger, cW as keyAllows, cX as logFormat, cH as mimeAllowedBy, cI as rowFields, cK as uniqueWithinOf } from './config-CzW6kBeb.js';
 export { C as CONFIG_FILE_NAMES, g as CSRF_COOKIE, h as CSRF_HEADER, D as DEFAULT_ADMIN_PATH, i as DEFAULT_API_PATH, j as DEFAULT_MAX_FILE_SIZE, k as DEFAULT_TOKEN_EXPIRATION, m as applyDefaults, n as applyPlugins, o as createRootEndpointHandler, p as decryptBackup, q as fillMissing, t as findConfigFile, u as forwardedClientIp, v as generateSlugs, w as importConfig, x as mergeForUpdate, y as parseId, z as platformClientIp, E as readCookie, F as validateFields, G as writeBackupFile } from './handler-BsBQ-2qf.js';
 export { conditionIssues } from './conditions.js';
@@ -51,6 +51,14 @@ declare function copyDatabase(source: Database, target: Database, options?: {
     onTable?: (progress: CopyProgress) => void;
 }): Promise<CopyResult>;
 
+type HealthCheck = 'healthz' | 'readyz';
+/**
+ * `healthz`: the process answers (liveness), without touching the database. `readyz`: the CMS
+ * started, its database answers and no migration is pending (readiness); `503` otherwise, naming
+ * the check that failed, with the error in the log only. `cms` is `null` when it failed to start.
+ */
+declare function healthResponse<C extends Config>(check: HealthCheck, instance: EasyCMS<C> | null): Promise<Response>;
+
 /** File types Easy CMS recognizes from their contents (FR-UPL-03). */
 declare const EXTENSIONS: Readonly<Record<string, string>>;
 /**
@@ -133,4 +141,4 @@ declare const BUILTIN_COLLECTIONS: readonly ["users", "media"];
 /** Checks a config and returns every problem found. An empty array means it is valid. */
 declare function validateConfig(config: Config): ConfigIssue[];
 
-export { BUILTIN_COLLECTIONS, BUILTIN_NAV, type CopyProgress, type CopyResult, DEFAULT_DEPTH, EXTENSIONS, INTERNAL_COLLECTIONS, MAX_DEPTH, MEDIA, MEDIA_FOLDERS, MIME_GROUPS, MIN_PASSWORD_LENGTH, MIN_SECRET_LENGTH, SESSION_COOKIE, checkFormToken, checkRenamedOptions, configSignature, copyDatabase, expandMimeTypes, formToken, generateTypes, hashPassword, honeypotName, imageDimensions, mimeAllowed, populate, rateKeys, resolveAdminModule, singularize, sniffMimeType, validateConfig, verifyPassword, verifyTurnstile };
+export { BUILTIN_COLLECTIONS, BUILTIN_NAV, type CopyProgress, type CopyResult, DEFAULT_DEPTH, EXTENSIONS, type HealthCheck, INTERNAL_COLLECTIONS, MAX_DEPTH, MEDIA, MEDIA_FOLDERS, MIME_GROUPS, MIN_PASSWORD_LENGTH, MIN_SECRET_LENGTH, SESSION_COOKIE, checkFormToken, checkRenamedOptions, configSignature, copyDatabase, expandMimeTypes, formToken, generateTypes, hashPassword, healthResponse, honeypotName, imageDimensions, mimeAllowed, populate, rateKeys, resolveAdminModule, singularize, sniffMimeType, validateConfig, verifyPassword, verifyTurnstile };

package/dist/internal.js

@@ -38,6 +38,7 @@ import {
   forwardedClientIp,
   generateSlugs,
   hashPassword,
+  healthResponse,
   honeypotName,
   importConfig,
   isJsonLogger,
@@ -55,7 +56,7 @@ import {
   verifyPassword,
   verifyTurnstile,
   writeBackupFile
-} from "./chunk-GBEWSAZF.js";
+} from "./chunk-AVUGFJ4Q.js";
 import {
   conditionIssues
 } from "./chunk-U266LV4M.js";
@@ -288,6 +289,7 @@ export {
   generateTypes,
   hasRows,
   hashPassword,
+  healthResponse,
   honeypotName,
   imageDimensions,
   importConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/core",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Embedded, code-first headless CMS for Nuxt and Next.js",
   "license": "MIT",
   "type": "module",