@cms-lab/core 1.0.3 → 1.0.5

package/README.md

@@ -11,9 +11,13 @@ typed config files, tests, and adapter/report integrations.
 
 `scanDocuments` understands the shared `CMSDocument` contract plus provider
 field shapes from the bundled adapters. SEO checks recognize common Prismic,
-Strapi, Directus, and WordPress SEO fields, while image checks recognize native
-alt fields such as Strapi `alternativeText`, Directus file `description`, and
-WordPress `alt_text`.
+Strapi, Directus, WordPress, Contentful, and Sanity SEO fields, while image
+checks recognize native alt fields such as Strapi `alternativeText`, Directus
+file `description`, WordPress `alt_text`, Contentful asset descriptions, and
+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.
 
 ## Open Source
 

package/dist/index.d.ts

@@ -45,10 +45,14 @@ type PrismicCmsProviderConfig = {
     accessToken?: string;
     endpoint?: string;
 };
+type CmsFieldMappingConfig = {
+    uidField?: string;
+    urlField?: string;
+};
 type StrapiCollectionConfig = {
     type: string;
     endpoint: string;
-};
+} & CmsFieldMappingConfig;
 type StrapiCmsProviderConfig = {
     provider: "strapi";
     url: string;
@@ -58,7 +62,7 @@ type StrapiCmsProviderConfig = {
 type DirectusCollectionConfig = {
     type: string;
     collection: string;
-};
+} & CmsFieldMappingConfig;
 type DirectusCmsProviderConfig = {
     provider: "directus";
     url: string;
@@ -68,13 +72,39 @@ type DirectusCmsProviderConfig = {
 type WordPressContentTypeConfig = {
     type: string;
     endpoint: string;
-};
+} & CmsFieldMappingConfig;
 type WordPressCmsProviderConfig = {
     provider: "wordpress";
     url: string;
     contentTypes?: WordPressContentTypeConfig[];
 };
-type CmsProviderConfig = PrismicCmsProviderConfig | StrapiCmsProviderConfig | DirectusCmsProviderConfig | WordPressCmsProviderConfig;
+type ContentfulContentTypeConfig = {
+    type: string;
+    contentType: string;
+} & CmsFieldMappingConfig;
+type ContentfulCmsProviderConfig = {
+    provider: "contentful";
+    spaceId: string;
+    accessToken: string;
+    environment?: string;
+    apiUrl?: string;
+    contentTypes: ContentfulContentTypeConfig[];
+};
+type SanityContentTypeConfig = {
+    type: string;
+    documentType: string;
+} & CmsFieldMappingConfig;
+type SanityCmsProviderConfig = {
+    provider: "sanity";
+    projectId: string;
+    dataset: string;
+    apiVersion?: string;
+    token?: string;
+    useCdn?: boolean;
+    perspective?: "published" | "drafts" | "raw";
+    contentTypes: SanityContentTypeConfig[];
+};
+type CmsProviderConfig = PrismicCmsProviderConfig | StrapiCmsProviderConfig | DirectusCmsProviderConfig | WordPressCmsProviderConfig | ContentfulCmsProviderConfig | SanityCmsProviderConfig;
 type CmsLabConfig = {
     site: {
         url: string;
@@ -130,6 +160,8 @@ declare function loadCmsLabConfig(options: {
     configPath?: string;
 }): Promise<LoadedCmsLabConfig>;
 
+declare function readCmsDataPath(data: unknown, path: string): unknown;
+
 declare function createDiagnostic(input: Diagnostic): Diagnostic;
 declare function summarizeDiagnostics(diagnostics: Diagnostic[]): ScanSummary;
 declare function explainDiagnostic(code: string): DiagnosticExplanation | undefined;
@@ -161,4 +193,4 @@ type ScanDocumentsOptions = {
 };
 declare function scanDocuments(options: ScanDocumentsOptions): Promise<ScanResult>;
 
-export { type CMSDocument, type CMSDocumentStatus, type CheckGroup, CmsFetchError, type CmsLabConfig, CmsLabError, type CmsProviderConfig, ConfigLoadError, type Diagnostic, type DiagnosticExplanation, type DiagnosticSeverity, type DirectusCmsProviderConfig, type DirectusCollectionConfig, type FetchLike, type LoadedCmsLabConfig, type PrismicCmsProviderConfig, type ProjectInfo, type RequiredFieldRule, type RouteDefinition, type ScanDocumentsOptions, type ScanFilters, type ScanResult, type ScanSummary, SiteUnreachableError, type StrapiCmsProviderConfig, type StrapiCollectionConfig, type WordPressCmsProviderConfig, type WordPressContentTypeConfig, createDiagnostic, defineConfig, explainDiagnostic, listDiagnosticExplanations, loadCmsLabConfig, 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 WordPressCmsProviderConfig, type WordPressContentTypeConfig, createDiagnostic, defineConfig, explainDiagnostic, listDiagnosticExplanations, loadCmsLabConfig, readCmsDataPath, scanDocuments, summarizeDiagnostics, validateConfig };

package/dist/index.js

@@ -49,6 +49,10 @@ var prismicConfigSchema = z.object({
   accessToken: z.string().optional(),
   endpoint: z.string().url().optional()
 }).strict();
+var cmsFieldMappingShape = {
+  uidField: z.string().min(1).optional(),
+  urlField: z.string().min(1).optional()
+};
 var strapiConfigSchema = z.object({
   provider: z.literal("strapi"),
   url: z.string().url(),
@@ -56,7 +60,8 @@ var strapiConfigSchema = z.object({
   collections: z.array(
     z.object({
       type: z.string().min(1),
-      endpoint: z.string().min(1)
+      endpoint: z.string().min(1),
+      ...cmsFieldMappingShape
     }).strict()
   ).min(1)
 }).strict();
@@ -67,7 +72,8 @@ var directusConfigSchema = z.object({
   collections: z.array(
     z.object({
       type: z.string().min(1),
-      collection: z.string().min(1)
+      collection: z.string().min(1),
+      ...cmsFieldMappingShape
     }).strict()
   ).min(1)
 }).strict();
@@ -77,15 +83,48 @@ var wordpressConfigSchema = z.object({
   contentTypes: z.array(
     z.object({
       type: z.string().min(1),
-      endpoint: z.string().min(1)
+      endpoint: z.string().min(1),
+      ...cmsFieldMappingShape
     }).strict()
   ).optional()
 }).strict();
+var contentfulConfigSchema = z.object({
+  provider: z.literal("contentful"),
+  spaceId: z.string().min(1),
+  accessToken: z.string().min(1),
+  environment: z.string().min(1).optional(),
+  apiUrl: z.string().url().optional(),
+  contentTypes: z.array(
+    z.object({
+      type: z.string().min(1),
+      contentType: z.string().min(1),
+      ...cmsFieldMappingShape
+    }).strict()
+  ).min(1)
+}).strict();
+var sanityConfigSchema = z.object({
+  provider: z.literal("sanity"),
+  projectId: z.string().min(1),
+  dataset: z.string().min(1),
+  apiVersion: z.string().min(1).optional(),
+  token: z.string().optional(),
+  useCdn: z.boolean().optional(),
+  perspective: z.enum(["published", "drafts", "raw"]).optional(),
+  contentTypes: z.array(
+    z.object({
+      type: z.string().min(1),
+      documentType: z.string().min(1),
+      ...cmsFieldMappingShape
+    }).strict()
+  ).min(1)
+}).strict();
 var cmsConfigSchema = z.discriminatedUnion("provider", [
   prismicConfigSchema,
   strapiConfigSchema,
   directusConfigSchema,
-  wordpressConfigSchema
+  wordpressConfigSchema,
+  contentfulConfigSchema,
+  sanityConfigSchema
 ]);
 var requiredFieldRuleSchema = z.object({
   type: z.string().min(1),
@@ -168,6 +207,28 @@ function selfEntryPath() {
   return join(dirname(currentFile), `index.${extension}`);
 }
 
+// src/data-path.ts
+function readCmsDataPath(data, path) {
+  let current = data;
+  for (const segment of path.split(".")) {
+    if (!segment) {
+      return void 0;
+    }
+    const record = asRecord(current);
+    if (!record || !(segment in record)) {
+      return void 0;
+    }
+    current = record[segment];
+  }
+  return current;
+}
+function asRecord(value) {
+  if (value && typeof value === "object" && !Array.isArray(value)) {
+    return value;
+  }
+  return void 0;
+}
+
 // src/diagnostics.ts
 function createDiagnostic(input) {
   return input;
@@ -236,14 +297,14 @@ var explanations = [
     code: "SEO-META-MISSING",
     severity: "warning",
     title: "SEO metadata is missing",
-    meaning: "A document is missing one or more configured SEO fields. cms-lab checks common provider fields such as Prismic meta fields, Strapi/Directus seo objects, and WordPress SEO plugin JSON.",
+    meaning: "A document is missing one or more configured SEO fields. cms-lab checks common provider fields such as Prismic meta fields, Strapi/Directus seo objects, WordPress SEO plugin JSON, and Contentful/Sanity SEO fields.",
     fix: "Fill the missing CMS fields or disable the SEO check if this content type intentionally does not use metadata."
   },
   {
     code: "A11Y-IMG-ALT",
     severity: "warning",
     title: "Image alt text is missing",
-    meaning: "An image-like CMS field has no useful alt text, or uses a placeholder such as image, photo, or picture. Native fields such as Prismic alt, Strapi alternativeText, Directus file description, and WordPress alt_text are checked.",
+    meaning: "An image-like CMS field has no useful alt text, or uses a placeholder such as image, photo, or picture. Native fields such as Prismic alt, Strapi alternativeText, Directus file description, WordPress alt_text, Contentful asset descriptions, and Sanity image alt fields are checked.",
     fix: "Add meaningful alt text in the CMS, or leave decorative images out of content fields that require editorial alt text."
   },
   {
@@ -372,7 +433,7 @@ async function checkRouteReachability(config, candidates, fetchImpl, timeoutMs,
   const results = await mapLimit(candidates, concurrency, async (candidate) => {
     const diagnostics = [];
     const siteUrl = new URL(config.site.url);
-    const url = new URL(candidate.path, siteUrl);
+    const url = resolveSiteRouteUrl(siteUrl, candidate.path);
     const diagnosticPath = pathForDiagnostic(candidate.path);
     let response;
     if (url.origin !== siteUrl.origin) {
@@ -441,6 +502,13 @@ async function checkRouteReachability(config, candidates, fetchImpl, timeoutMs,
   });
   return results.flat();
 }
+function resolveSiteRouteUrl(siteUrl, path) {
+  const url = new URL(path, siteUrl);
+  if (!url.search && siteUrl.search) {
+    url.search = siteUrl.search;
+  }
+  return url;
+}
 async function assertSiteReachable(siteUrl, fetchImpl, timeoutMs, retries) {
   try {
     const response = await fetchWithRetries(
@@ -496,7 +564,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 = asRecord(document.data);
+    const data = asRecord2(document.data);
     if (!data) {
       continue;
     }
@@ -552,7 +620,7 @@ function checkRequiredFields(config, documents) {
         continue;
       }
       const fullPath = `data.${rule.path}`;
-      if (!isMissingFieldValue(readDataPath(document.data, rule.path))) {
+      if (!isMissingFieldValue(readCmsDataPath(document.data, rule.path))) {
         continue;
       }
       diagnostics.push(
@@ -577,7 +645,7 @@ function requiredFieldRules(config) {
 }
 function hasSeoValue(config, data, kind) {
   return seoFieldPaths(config.cms.provider, kind).some(
-    (path) => !isBlank(readDataPath(data, path))
+    (path) => !isBlank(readCmsDataPath(data, path))
   );
 }
 function seoFieldPaths(provider, kind) {
@@ -624,7 +692,7 @@ function collectImagesMissingAlt(value, provider, path = "data") {
       (item, index) => collectImagesMissingAlt(item, provider, `${path}[${index}]`)
     );
   }
-  const record = asRecord(value);
+  const record = asRecord2(value);
   if (!record) {
     return [];
   }
@@ -649,6 +717,12 @@ function imageAltCandidate(provider, record) {
   if (provider === "directus" && isDirectusImageRecord(record)) {
     return { isImage: true, value: record.description };
   }
+  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)) {
+    return { isImage: true, value: record.alt };
+  }
   return { isImage: false, value: void 0 };
 }
 function isDirectusImageRecord(record) {
@@ -657,6 +731,18 @@ function isDirectusImageRecord(record) {
 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);
+  return typeof file?.url === "string" && (isContentfulImageHost(file.url) || hasImageExtension(file.url)) || hasImageExtension(file?.fileName);
+}
+function isContentfulImageHost(value) {
+  const normalized = value.startsWith("//") ? `https:${value}` : value;
+  try {
+    return new URL(normalized).hostname === "images.ctfassets.net";
+  } catch {
+    return false;
+  }
+}
 function isCheckEnabled(value, defaultValue) {
   if (typeof value === "boolean") {
     return value;
@@ -794,24 +880,10 @@ function isMissingFieldValue(value) {
   }
   return false;
 }
-function readDataPath(data, path) {
-  let current = data;
-  for (const segment of path.split(".")) {
-    if (!segment) {
-      return void 0;
-    }
-    const record = asRecord(current);
-    if (!record || !(segment in record)) {
-      return void 0;
-    }
-    current = record[segment];
-  }
-  return current;
-}
 function isBlankOrPlaceholderAlt(value) {
   return isBlank(value) || typeof value === "string" && ["image", "photo", "picture"].includes(value.trim().toLowerCase());
 }
-function asRecord(value) {
+function asRecord2(value) {
   if (value && typeof value === "object" && !Array.isArray(value)) {
     return value;
   }
@@ -838,6 +910,7 @@ export {
   explainDiagnostic,
   listDiagnosticExplanations,
   loadCmsLabConfig,
+  readCmsDataPath,
   scanDocuments,
   summarizeDiagnostics,
   validateConfig

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cms-lab/core",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "type": "module",
   "description": "Core config, scan, diagnostics, and checks for cms-lab.",
   "license": "MIT",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/i-afaqrashid/cms-lab.git",
     "directory": "packages/core"
   },
-  "homepage": "https://cms-lab.dev",
+  "homepage": "https://cmslab.afaqrashid.com",
   "bugs": {
     "url": "https://github.com/i-afaqrashid/cms-lab/issues"
   },