@cms-lab/core 1.0.10 → 1.2.0

package/README.md

@@ -3,7 +3,7 @@
 Core config, types, diagnostics, route resolution, and scan orchestration for cms-lab.
 
 ```ts
-import { defineConfig, scanDocuments } from "@cms-lab/core";
+import { defineConfig, scanDocuments, strapiRelationSlug } from "@cms-lab/core";
 ```
 
 Most users should install `cms-lab` and use the CLI. This package is public for
@@ -19,6 +19,27 @@ Sanity image `alt` fields.
 `readCmsDataPath` is exported for adapters that need to read dotted paths from
 normalized CMS payloads, for example custom `uidField` and `urlField` mapping.
 
+`strapiRelationSlug` and `strapiRelationValue` help Strapi route mappings read
+relation values from both Strapi v4 `data.attributes` payloads and newer flat
+REST payloads:
+
+```ts
+routes: [
+  {
+    type: "article",
+    pattern: "/blog/:topic/:slug",
+    getPath: (doc) => {
+      const topic = strapiRelationSlug(doc.data, "topic") ?? "uncategorized";
+      return `/blog/${topic}/${doc.uid}`;
+    },
+  },
+];
+```
+
+`site.healthPath` and `site.healthUrl` let `doctor` and the initial scan health
+probe hit a known-good page or endpoint while normal route probes still use
+`site.url`.
+
 ## Release History
 
 See the repository [changelog](https://github.com/i-afaqrashid/cms-lab/blob/main/CHANGELOG.md)

package/dist/index.d.ts

@@ -4,6 +4,8 @@ type CMSDocument = {
     type: string;
     uid?: string;
     url?: string;
+    routable?: boolean;
+    entryKind?: "collection" | "single";
     status: CMSDocumentStatus;
     data: unknown;
 };
@@ -49,15 +51,24 @@ type CmsFieldMappingConfig = {
     uidField?: string;
     urlField?: string;
 };
+type StrapiLocaleConfig = {
+    locale?: string;
+};
 type StrapiCollectionConfig = {
     type: string;
     endpoint: string;
-} & CmsFieldMappingConfig;
+} & CmsFieldMappingConfig & StrapiLocaleConfig;
+type StrapiSingleTypeConfig = {
+    type: string;
+    endpoint: string;
+} & CmsFieldMappingConfig & StrapiLocaleConfig;
 type StrapiCmsProviderConfig = {
     provider: "strapi";
     url: string;
     token?: string;
-    collections: StrapiCollectionConfig[];
+    locale?: string;
+    collections?: StrapiCollectionConfig[];
+    singleTypes?: StrapiSingleTypeConfig[];
 };
 type DirectusCollectionConfig = {
     type: string;
@@ -108,6 +119,8 @@ type CmsProviderConfig = PrismicCmsProviderConfig | StrapiCmsProviderConfig | Di
 type CmsLabConfig = {
     site: {
         url: string;
+        healthPath?: string;
+        healthUrl?: string;
     };
     framework: {
         type: "next";
@@ -181,6 +194,9 @@ declare class SiteUnreachableError extends CmsLabError {
     constructor(message: string);
 }
 
+declare function strapiRelationSlug(data: unknown, path: string): string | undefined;
+declare function strapiRelationValue(data: unknown, path: string, field: string): string | undefined;
+
 type ScanDocumentsOptions = {
     config: CmsLabConfig;
     project: ProjectInfo;
@@ -192,5 +208,6 @@ type ScanDocumentsOptions = {
     filters?: ScanFilters;
 };
 declare function scanDocuments(options: ScanDocumentsOptions): Promise<ScanResult>;
+declare function resolveSiteHealthUrl(site: CmsLabConfig["site"]): URL;
 
-export { type CMSDocument, type CMSDocumentStatus, type CheckGroup, CmsFetchError, type CmsFieldMappingConfig, type CmsLabConfig, CmsLabError, type CmsProviderConfig, ConfigLoadError, type ContentfulCmsProviderConfig, type ContentfulContentTypeConfig, type Diagnostic, type DiagnosticExplanation, type DiagnosticSeverity, type DirectusCmsProviderConfig, type DirectusCollectionConfig, type FetchLike, type LoadedCmsLabConfig, type PrismicCmsProviderConfig, type ProjectInfo, type RequiredFieldRule, type RouteDefinition, type SanityCmsProviderConfig, type SanityContentTypeConfig, type ScanDocumentsOptions, type ScanFilters, type ScanResult, type ScanSummary, SiteUnreachableError, type StrapiCmsProviderConfig, type StrapiCollectionConfig, type WordPressCmsProviderConfig, type WordPressContentTypeConfig, createDiagnostic, defineConfig, explainDiagnostic, listDiagnosticExplanations, loadCmsLabConfig, readCmsDataPath, scanDocuments, summarizeDiagnostics, validateConfig };
+export { type CMSDocument, type CMSDocumentStatus, type CheckGroup, CmsFetchError, type CmsFieldMappingConfig, type CmsLabConfig, CmsLabError, type CmsProviderConfig, ConfigLoadError, type ContentfulCmsProviderConfig, type ContentfulContentTypeConfig, type Diagnostic, type DiagnosticExplanation, type DiagnosticSeverity, type DirectusCmsProviderConfig, type DirectusCollectionConfig, type FetchLike, type LoadedCmsLabConfig, type PrismicCmsProviderConfig, type ProjectInfo, type RequiredFieldRule, type RouteDefinition, type SanityCmsProviderConfig, type SanityContentTypeConfig, type ScanDocumentsOptions, type ScanFilters, type ScanResult, type ScanSummary, SiteUnreachableError, type StrapiCmsProviderConfig, type StrapiCollectionConfig, type StrapiLocaleConfig, type StrapiSingleTypeConfig, type WordPressCmsProviderConfig, type WordPressContentTypeConfig, createDiagnostic, defineConfig, explainDiagnostic, listDiagnosticExplanations, loadCmsLabConfig, readCmsDataPath, resolveSiteHealthUrl, scanDocuments, strapiRelationSlug, strapiRelationValue, summarizeDiagnostics, validateConfig };

package/dist/index.js

@@ -53,18 +53,29 @@ var cmsFieldMappingShape = {
   uidField: z.string().min(1).optional(),
   urlField: z.string().min(1).optional()
 };
+var strapiLocaleShape = {
+  locale: z.string().min(1).optional()
+};
+var strapiContentShape = z.object({
+  type: z.string().min(1),
+  endpoint: z.string().min(1),
+  ...cmsFieldMappingShape,
+  ...strapiLocaleShape
+}).strict();
 var strapiConfigSchema = z.object({
   provider: z.literal("strapi"),
   url: z.string().url(),
   token: z.string().optional(),
-  collections: z.array(
-    z.object({
-      type: z.string().min(1),
-      endpoint: z.string().min(1),
-      ...cmsFieldMappingShape
-    }).strict()
-  ).min(1)
-}).strict();
+  ...strapiLocaleShape,
+  collections: z.array(strapiContentShape).min(1).optional(),
+  singleTypes: z.array(strapiContentShape).min(1).optional()
+}).refine(
+  (config) => (config.collections?.length ?? 0) > 0 || (config.singleTypes?.length ?? 0) > 0,
+  {
+    message: "Strapi config must include collections or singleTypes",
+    path: ["collections"]
+  }
+).strict();
 var directusConfigSchema = z.object({
   provider: z.literal("directus"),
   url: z.string().url(),
@@ -154,7 +165,12 @@ var checksSchema = z.object({
 }).strict().optional();
 var configSchema = z.object({
   site: z.object({
-    url: z.string().url()
+    url: z.string().url(),
+    healthPath: z.string().min(1).refine(
+      (path) => path.startsWith("/") && !path.startsWith("//"),
+      "healthPath must be a same-origin path starting with a single /"
+    ).optional(),
+    healthUrl: z.string().url().optional()
   }).strict(),
   framework: z.object({
     type: z.literal("next"),
@@ -324,6 +340,42 @@ function listDiagnosticExplanations() {
   return [...explanations];
 }
 
+// src/route-helpers.ts
+function strapiRelationSlug(data, path) {
+  return strapiRelationValue(data, path, "slug");
+}
+function strapiRelationValue(data, path, field) {
+  const relation = unwrapStrapiRelation(readCmsDataPath(data, path));
+  const value = readCmsDataPath(relation, field);
+  if (typeof value === "string" && value.length > 0) {
+    return value;
+  }
+  if (typeof value === "number" && Number.isFinite(value)) {
+    return String(value);
+  }
+  return void 0;
+}
+function unwrapStrapiRelation(value) {
+  const record = asRecord2(value);
+  if (record && "data" in record) {
+    return unwrapStrapiRelation(record.data);
+  }
+  if (Array.isArray(value)) {
+    return unwrapStrapiRelation(value[0]);
+  }
+  if (record && "attributes" in record) {
+    const attributes = asRecord2(record.attributes);
+    return attributes ? { id: record.id, ...attributes } : record;
+  }
+  return value;
+}
+function asRecord2(value) {
+  if (value && typeof value === "object" && !Array.isArray(value)) {
+    return value;
+  }
+  return void 0;
+}
+
 // src/scan.ts
 async function scanDocuments(options) {
   const fetchImpl = options.fetch ?? fetch;
@@ -333,7 +385,7 @@ async function scanDocuments(options) {
   const documents = filterDocuments(options.documents, options.filters);
   const diagnostics = [];
   await assertSiteReachable(
-    options.config.site.url,
+    resolveSiteHealthUrl(options.config.site).toString(),
     fetchImpl,
     timeoutMs,
     retries
@@ -379,6 +431,9 @@ function resolveRouteCandidates(config, documents, diagnostics) {
       (candidate) => candidate.type === document.type
     );
     if (!route) {
+      if (document.routable === false) {
+        continue;
+      }
       diagnostics.push(
         createDiagnostic({
           severity: "info",
@@ -502,6 +557,16 @@ async function checkRouteReachability(config, candidates, fetchImpl, timeoutMs,
   });
   return results.flat();
 }
+function resolveSiteHealthUrl(site) {
+  if (site.healthUrl) {
+    return new URL(site.healthUrl);
+  }
+  const siteUrl = new URL(site.url);
+  if (site.healthPath) {
+    return resolveSiteRouteUrl(siteUrl, site.healthPath);
+  }
+  return siteUrl;
+}
 function resolveSiteRouteUrl(siteUrl, path) {
   const url = new URL(path, siteUrl);
   if (!url.search && siteUrl.search) {
@@ -564,7 +629,7 @@ function checkSeoFields(config, documents) {
   const checkMetaTitle = typeof seo === "object" ? seo.metaTitle !== false : true;
   const checkMetaDescription = typeof seo === "object" ? seo.metaDescription !== false : true;
   for (const document of documents) {
-    const data = asRecord2(document.data);
+    const data = asRecord3(document.data);
     if (!data) {
       continue;
     }
@@ -692,7 +757,7 @@ function collectImagesMissingAlt(value, provider, path = "data") {
       (item, index) => collectImagesMissingAlt(item, provider, `${path}[${index}]`)
     );
   }
-  const record = asRecord2(value);
+  const record = asRecord3(value);
   if (!record) {
     return [];
   }
@@ -720,7 +785,7 @@ function imageAltCandidate(provider, record) {
   if (provider === "contentful" && isContentfulImageRecord(record)) {
     return { isImage: true, value: record.description ?? record.title };
   }
-  if (provider === "sanity" && "asset" in record && (asRecord2(record.asset)?._ref || asRecord2(record.asset)?._id)) {
+  if (provider === "sanity" && "asset" in record && (asRecord3(record.asset)?._ref || asRecord3(record.asset)?._id)) {
     return { isImage: true, value: record.alt };
   }
   return { isImage: false, value: void 0 };
@@ -732,7 +797,7 @@ function hasImageExtension(value) {
   return typeof value === "string" && /\.(?:avif|gif|jpe?g|png|svg|webp)$/i.test(value);
 }
 function isContentfulImageRecord(record) {
-  const file = asRecord2(record.file);
+  const file = asRecord3(record.file);
   return typeof file?.url === "string" && (isContentfulImageHost(file.url) || hasImageExtension(file.url)) || hasImageExtension(file?.fileName);
 }
 function isContentfulImageHost(value) {
@@ -883,7 +948,7 @@ function isMissingFieldValue(value) {
 function isBlankOrPlaceholderAlt(value) {
   return isBlank(value) || typeof value === "string" && ["image", "photo", "picture"].includes(value.trim().toLowerCase());
 }
-function asRecord2(value) {
+function asRecord3(value) {
   if (value && typeof value === "object" && !Array.isArray(value)) {
     return value;
   }
@@ -911,7 +976,10 @@ export {
   listDiagnosticExplanations,
   loadCmsLabConfig,
   readCmsDataPath,
+  resolveSiteHealthUrl,
   scanDocuments,
+  strapiRelationSlug,
+  strapiRelationValue,
   summarizeDiagnostics,
   validateConfig
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cms-lab/core",
-  "version": "1.0.10",
+  "version": "1.2.0",
   "type": "module",
   "description": "Core config, scan, diagnostics, and checks for cms-lab.",
   "license": "MIT",