@schemasentry/core 0.1.0 → 0.2.0

package/dist/index.cjs

@@ -23,12 +23,15 @@ __export(index_exports, {
   Article: () => Article,
   BlogPosting: () => BlogPosting,
   BreadcrumbList: () => BreadcrumbList,
+  Event: () => Event,
   FAQPage: () => FAQPage,
   HowTo: () => HowTo,
+  LocalBusiness: () => LocalBusiness,
   Location: () => Location,
   Organization: () => Organization,
   Person: () => Person,
   Product: () => Product,
+  Review: () => Review,
   SCHEMA_CONTEXT: () => SCHEMA_CONTEXT,
   WebPage: () => WebPage,
   WebSite: () => WebSite,
@@ -53,6 +56,7 @@ var withBase = (type, input) => {
 var Organization = (input) => withBase("Organization", input);
 var Person = (input) => withBase("Person", input);
 var Location = (input) => withBase("Place", input);
+var LocalBusiness = (input) => withBase("LocalBusiness", input);
 var WebSite = (input) => withBase("WebSite", input);
 var WebPage = (input) => withBase("WebPage", input);
 var Article = (input) => {
@@ -87,6 +91,59 @@ var Product = (input) => {
     } : {}
   });
 };
+var Event = (input) => {
+  const {
+    locationName,
+    locationAddress,
+    locationUrl,
+    organizerName,
+    ...rest
+  } = input;
+  return withBase("Event", {
+    ...rest,
+    ...locationName || locationAddress || locationUrl ? {
+      location: {
+        "@type": "Place",
+        ...locationName ? { name: locationName } : {},
+        ...locationAddress ? { address: locationAddress } : {},
+        ...locationUrl ? { url: locationUrl } : {}
+      }
+    } : {},
+    ...organizerName ? {
+      organizer: {
+        "@type": "Organization",
+        name: organizerName
+      }
+    } : {}
+  });
+};
+var Review = (input) => {
+  const {
+    itemName,
+    authorName,
+    ratingValue,
+    bestRating,
+    worstRating,
+    ...rest
+  } = input;
+  return withBase("Review", {
+    ...rest,
+    itemReviewed: {
+      "@type": "Thing",
+      name: itemName
+    },
+    author: {
+      "@type": "Person",
+      name: authorName
+    },
+    reviewRating: {
+      "@type": "Rating",
+      ratingValue,
+      ...bestRating !== void 0 ? { bestRating } : {},
+      ...worstRating !== void 0 ? { worstRating } : {}
+    }
+  });
+};
 var FAQPage = (input) => withBase("FAQPage", {
   mainEntity: input.questions.map((item) => ({
     "@type": "Question",
@@ -113,8 +170,9 @@ var BreadcrumbList = (input) => withBase("BreadcrumbList", {
     item: item.useItemObject ? { "@id": item.url, name: item.name } : item.url
   }))
 });
-var validateSchema = (nodes) => {
+var validateSchema = (nodes, options = {}) => {
   const issues = [];
+  const { recommended = true } = options;
   if (!nodes.length) {
     issues.push({
       path: "root",
@@ -205,6 +263,20 @@ var validateSchema = (nodes) => {
         });
       }
     }
+    if (recommended) {
+      const recommendedFields = RECOMMENDED_FIELDS[type] ?? [];
+      for (const field of recommendedFields) {
+        const value = node[field];
+        if (isEmpty(value)) {
+          issues.push({
+            path: `${pathPrefix}.${field}`,
+            message: `Recommended field '${field}' is missing`,
+            severity: "warn",
+            ruleId: `schema.recommended.${field}`
+          });
+        }
+      }
+    }
     if (type === "BreadcrumbList") {
       validateBreadcrumbList(node, pathPrefix, issues);
     }
@@ -222,15 +294,34 @@ var REQUIRED_FIELDS = {
   Organization: ["name"],
   Person: ["name"],
   Place: ["name"],
+  LocalBusiness: ["name"],
   WebSite: ["name", "url"],
   WebPage: ["name", "url"],
   Article: ["headline", "author", "datePublished", "url"],
   BlogPosting: ["headline", "author", "datePublished", "url"],
   Product: ["name", "description", "url"],
+  Event: ["name", "startDate"],
+  Review: ["itemReviewed", "reviewRating", "author"],
   FAQPage: ["mainEntity"],
   HowTo: ["name", "step"],
   BreadcrumbList: ["itemListElement"]
 };
+var RECOMMENDED_FIELDS = {
+  Organization: ["url", "logo", "sameAs"],
+  Person: ["url", "sameAs", "jobTitle"],
+  Place: ["address", "url"],
+  LocalBusiness: ["address", "telephone", "url"],
+  WebSite: ["description"],
+  WebPage: ["description", "isPartOf"],
+  Article: ["description", "image", "dateModified"],
+  BlogPosting: ["description", "image", "dateModified"],
+  Product: ["image", "brand", "sku"],
+  Event: ["description", "location", "organizer", "url"],
+  Review: ["reviewBody", "datePublished", "url"],
+  FAQPage: [],
+  HowTo: [],
+  BreadcrumbList: []
+};
 var isSchemaType = (value) => typeof value === "string" && value in REQUIRED_FIELDS;
 var isEmpty = (value) => {
   if (value === null || value === void 0) {
@@ -344,12 +435,15 @@ var stableStringify = (value) => JSON.stringify(sortKeys(value));
   Article,
   BlogPosting,
   BreadcrumbList,
+  Event,
   FAQPage,
   HowTo,
+  LocalBusiness,
   Location,
   Organization,
   Person,
   Product,
+  Review,
   SCHEMA_CONTEXT,
   WebPage,
   WebSite,

package/dist/index.d.cts

@@ -3,7 +3,7 @@ type JsonLdValue = string | number | boolean | null | JsonLdObject | JsonLdValue
 type JsonLdObject = {
     [key: string]: JsonLdValue;
 };
-type SchemaTypeName = "Organization" | "Person" | "Place" | "WebSite" | "WebPage" | "Article" | "BlogPosting" | "Product" | "FAQPage" | "HowTo" | "BreadcrumbList";
+type SchemaTypeName = "Organization" | "Person" | "Place" | "LocalBusiness" | "WebSite" | "WebPage" | "Article" | "BlogPosting" | "Product" | "Event" | "Review" | "FAQPage" | "HowTo" | "BreadcrumbList";
 type SchemaNode = JsonLdObject & {
     "@context": typeof SCHEMA_CONTEXT;
     "@type": SchemaTypeName;
@@ -33,6 +33,17 @@ type LocationInput = BaseInput & {
     url?: string;
 };
 declare const Location: (input: LocationInput) => SchemaNode;
+type LocalBusinessInput = BaseInput & {
+    name: string;
+    address?: string;
+    url?: string;
+    telephone?: string;
+    image?: string;
+    priceRange?: string;
+    sameAs?: string[];
+    description?: string;
+};
+declare const LocalBusiness: (input: LocalBusinessInput) => SchemaNode;
 type WebSiteInput = BaseInput & {
     name: string;
     url: string;
@@ -67,6 +78,29 @@ type ProductInput = BaseInput & {
     sku?: string;
 };
 declare const Product: (input: ProductInput) => SchemaNode;
+type EventInput = BaseInput & {
+    name: string;
+    startDate: string;
+    endDate?: string;
+    url?: string;
+    description?: string;
+    locationName?: string;
+    locationAddress?: string;
+    locationUrl?: string;
+    organizerName?: string;
+};
+declare const Event: (input: EventInput) => SchemaNode;
+type ReviewInput = BaseInput & {
+    itemName: string;
+    authorName: string;
+    ratingValue: number;
+    bestRating?: number;
+    worstRating?: number;
+    reviewBody?: string;
+    datePublished?: string;
+    url?: string;
+};
+declare const Review: (input: ReviewInput) => SchemaNode;
 type FAQItem = {
     question: string;
     answer: string;
@@ -103,12 +137,15 @@ type ValidationIssue = {
     severity: ValidationSeverity;
     ruleId: string;
 };
+type ValidationOptions = {
+    recommended?: boolean;
+};
 type ValidationResult = {
     ok: boolean;
     score: number;
     issues: ValidationIssue[];
 };
-declare const validateSchema: (nodes: SchemaNode[]) => ValidationResult;
+declare const validateSchema: (nodes: SchemaNode[], options?: ValidationOptions) => ValidationResult;
 declare const stableStringify: (value: JsonLdValue) => string;
 
-export { Article, type ArticleInput, BlogPosting, type BlogPostingInput, type BreadcrumbItem, BreadcrumbList, type BreadcrumbListInput, type FAQItem, FAQPage, type FAQPageInput, HowTo, type HowToInput, type HowToStep, type JsonLdObject, type JsonLdValue, Location, type LocationInput, type Manifest, Organization, type OrganizationInput, Person, type PersonInput, Product, type ProductInput, SCHEMA_CONTEXT, type SchemaNode, type SchemaTypeName, type ValidationIssue, type ValidationResult, type ValidationSeverity, WebPage, type WebPageInput, WebSite, type WebSiteInput, stableStringify, validateSchema };
+export { Article, type ArticleInput, BlogPosting, type BlogPostingInput, type BreadcrumbItem, BreadcrumbList, type BreadcrumbListInput, Event, type EventInput, type FAQItem, FAQPage, type FAQPageInput, HowTo, type HowToInput, type HowToStep, type JsonLdObject, type JsonLdValue, LocalBusiness, type LocalBusinessInput, Location, type LocationInput, type Manifest, Organization, type OrganizationInput, Person, type PersonInput, Product, type ProductInput, Review, type ReviewInput, SCHEMA_CONTEXT, type SchemaNode, type SchemaTypeName, type ValidationIssue, type ValidationOptions, type ValidationResult, type ValidationSeverity, WebPage, type WebPageInput, WebSite, type WebSiteInput, stableStringify, validateSchema };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ type JsonLdValue = string | number | boolean | null | JsonLdObject | JsonLdValue
 type JsonLdObject = {
     [key: string]: JsonLdValue;
 };
-type SchemaTypeName = "Organization" | "Person" | "Place" | "WebSite" | "WebPage" | "Article" | "BlogPosting" | "Product" | "FAQPage" | "HowTo" | "BreadcrumbList";
+type SchemaTypeName = "Organization" | "Person" | "Place" | "LocalBusiness" | "WebSite" | "WebPage" | "Article" | "BlogPosting" | "Product" | "Event" | "Review" | "FAQPage" | "HowTo" | "BreadcrumbList";
 type SchemaNode = JsonLdObject & {
     "@context": typeof SCHEMA_CONTEXT;
     "@type": SchemaTypeName;
@@ -33,6 +33,17 @@ type LocationInput = BaseInput & {
     url?: string;
 };
 declare const Location: (input: LocationInput) => SchemaNode;
+type LocalBusinessInput = BaseInput & {
+    name: string;
+    address?: string;
+    url?: string;
+    telephone?: string;
+    image?: string;
+    priceRange?: string;
+    sameAs?: string[];
+    description?: string;
+};
+declare const LocalBusiness: (input: LocalBusinessInput) => SchemaNode;
 type WebSiteInput = BaseInput & {
     name: string;
     url: string;
@@ -67,6 +78,29 @@ type ProductInput = BaseInput & {
     sku?: string;
 };
 declare const Product: (input: ProductInput) => SchemaNode;
+type EventInput = BaseInput & {
+    name: string;
+    startDate: string;
+    endDate?: string;
+    url?: string;
+    description?: string;
+    locationName?: string;
+    locationAddress?: string;
+    locationUrl?: string;
+    organizerName?: string;
+};
+declare const Event: (input: EventInput) => SchemaNode;
+type ReviewInput = BaseInput & {
+    itemName: string;
+    authorName: string;
+    ratingValue: number;
+    bestRating?: number;
+    worstRating?: number;
+    reviewBody?: string;
+    datePublished?: string;
+    url?: string;
+};
+declare const Review: (input: ReviewInput) => SchemaNode;
 type FAQItem = {
     question: string;
     answer: string;
@@ -103,12 +137,15 @@ type ValidationIssue = {
     severity: ValidationSeverity;
     ruleId: string;
 };
+type ValidationOptions = {
+    recommended?: boolean;
+};
 type ValidationResult = {
     ok: boolean;
     score: number;
     issues: ValidationIssue[];
 };
-declare const validateSchema: (nodes: SchemaNode[]) => ValidationResult;
+declare const validateSchema: (nodes: SchemaNode[], options?: ValidationOptions) => ValidationResult;
 declare const stableStringify: (value: JsonLdValue) => string;
 
-export { Article, type ArticleInput, BlogPosting, type BlogPostingInput, type BreadcrumbItem, BreadcrumbList, type BreadcrumbListInput, type FAQItem, FAQPage, type FAQPageInput, HowTo, type HowToInput, type HowToStep, type JsonLdObject, type JsonLdValue, Location, type LocationInput, type Manifest, Organization, type OrganizationInput, Person, type PersonInput, Product, type ProductInput, SCHEMA_CONTEXT, type SchemaNode, type SchemaTypeName, type ValidationIssue, type ValidationResult, type ValidationSeverity, WebPage, type WebPageInput, WebSite, type WebSiteInput, stableStringify, validateSchema };
+export { Article, type ArticleInput, BlogPosting, type BlogPostingInput, type BreadcrumbItem, BreadcrumbList, type BreadcrumbListInput, Event, type EventInput, type FAQItem, FAQPage, type FAQPageInput, HowTo, type HowToInput, type HowToStep, type JsonLdObject, type JsonLdValue, LocalBusiness, type LocalBusinessInput, Location, type LocationInput, type Manifest, Organization, type OrganizationInput, Person, type PersonInput, Product, type ProductInput, Review, type ReviewInput, SCHEMA_CONTEXT, type SchemaNode, type SchemaTypeName, type ValidationIssue, type ValidationOptions, type ValidationResult, type ValidationSeverity, WebPage, type WebPageInput, WebSite, type WebSiteInput, stableStringify, validateSchema };

package/dist/index.js

@@ -16,6 +16,7 @@ var withBase = (type, input) => {
 var Organization = (input) => withBase("Organization", input);
 var Person = (input) => withBase("Person", input);
 var Location = (input) => withBase("Place", input);
+var LocalBusiness = (input) => withBase("LocalBusiness", input);
 var WebSite = (input) => withBase("WebSite", input);
 var WebPage = (input) => withBase("WebPage", input);
 var Article = (input) => {
@@ -50,6 +51,59 @@ var Product = (input) => {
     } : {}
   });
 };
+var Event = (input) => {
+  const {
+    locationName,
+    locationAddress,
+    locationUrl,
+    organizerName,
+    ...rest
+  } = input;
+  return withBase("Event", {
+    ...rest,
+    ...locationName || locationAddress || locationUrl ? {
+      location: {
+        "@type": "Place",
+        ...locationName ? { name: locationName } : {},
+        ...locationAddress ? { address: locationAddress } : {},
+        ...locationUrl ? { url: locationUrl } : {}
+      }
+    } : {},
+    ...organizerName ? {
+      organizer: {
+        "@type": "Organization",
+        name: organizerName
+      }
+    } : {}
+  });
+};
+var Review = (input) => {
+  const {
+    itemName,
+    authorName,
+    ratingValue,
+    bestRating,
+    worstRating,
+    ...rest
+  } = input;
+  return withBase("Review", {
+    ...rest,
+    itemReviewed: {
+      "@type": "Thing",
+      name: itemName
+    },
+    author: {
+      "@type": "Person",
+      name: authorName
+    },
+    reviewRating: {
+      "@type": "Rating",
+      ratingValue,
+      ...bestRating !== void 0 ? { bestRating } : {},
+      ...worstRating !== void 0 ? { worstRating } : {}
+    }
+  });
+};
 var FAQPage = (input) => withBase("FAQPage", {
   mainEntity: input.questions.map((item) => ({
     "@type": "Question",
@@ -76,8 +130,9 @@ var BreadcrumbList = (input) => withBase("BreadcrumbList", {
     item: item.useItemObject ? { "@id": item.url, name: item.name } : item.url
   }))
 });
-var validateSchema = (nodes) => {
+var validateSchema = (nodes, options = {}) => {
   const issues = [];
+  const { recommended = true } = options;
   if (!nodes.length) {
     issues.push({
       path: "root",
@@ -168,6 +223,20 @@ var validateSchema = (nodes) => {
         });
       }
     }
+    if (recommended) {
+      const recommendedFields = RECOMMENDED_FIELDS[type] ?? [];
+      for (const field of recommendedFields) {
+        const value = node[field];
+        if (isEmpty(value)) {
+          issues.push({
+            path: `${pathPrefix}.${field}`,
+            message: `Recommended field '${field}' is missing`,
+            severity: "warn",
+            ruleId: `schema.recommended.${field}`
+          });
+        }
+      }
+    }
     if (type === "BreadcrumbList") {
       validateBreadcrumbList(node, pathPrefix, issues);
     }
@@ -185,15 +254,34 @@ var REQUIRED_FIELDS = {
   Organization: ["name"],
   Person: ["name"],
   Place: ["name"],
+  LocalBusiness: ["name"],
   WebSite: ["name", "url"],
   WebPage: ["name", "url"],
   Article: ["headline", "author", "datePublished", "url"],
   BlogPosting: ["headline", "author", "datePublished", "url"],
   Product: ["name", "description", "url"],
+  Event: ["name", "startDate"],
+  Review: ["itemReviewed", "reviewRating", "author"],
   FAQPage: ["mainEntity"],
   HowTo: ["name", "step"],
   BreadcrumbList: ["itemListElement"]
 };
+var RECOMMENDED_FIELDS = {
+  Organization: ["url", "logo", "sameAs"],
+  Person: ["url", "sameAs", "jobTitle"],
+  Place: ["address", "url"],
+  LocalBusiness: ["address", "telephone", "url"],
+  WebSite: ["description"],
+  WebPage: ["description", "isPartOf"],
+  Article: ["description", "image", "dateModified"],
+  BlogPosting: ["description", "image", "dateModified"],
+  Product: ["image", "brand", "sku"],
+  Event: ["description", "location", "organizer", "url"],
+  Review: ["reviewBody", "datePublished", "url"],
+  FAQPage: [],
+  HowTo: [],
+  BreadcrumbList: []
+};
 var isSchemaType = (value) => typeof value === "string" && value in REQUIRED_FIELDS;
 var isEmpty = (value) => {
   if (value === null || value === void 0) {
@@ -306,12 +394,15 @@ export {
   Article,
   BlogPosting,
   BreadcrumbList,
+  Event,
   FAQPage,
   HowTo,
+  LocalBusiness,
   Location,
   Organization,
   Person,
   Product,
+  Review,
   SCHEMA_CONTEXT,
   WebPage,
   WebSite,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schemasentry/core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Typed schema builders and validation primitives for Schema Sentry.",
   "license": "MIT",
   "type": "module",