@getvitops/astro 0.1.1 → 0.2.0

package/src/schemas/Recipe.astro

@@ -0,0 +1,178 @@
+---
+export interface Props {
+  name: string;
+  description?: string;
+  image?: string | string[];
+  author?: {
+    name: string;
+    url?: string;
+  };
+  datePublished?: string;
+  prepTime?: string;
+  cookTime?: string;
+  totalTime?: string;
+  recipeYield?: string | number;
+  recipeCategory?: string;
+  recipeCuisine?: string;
+  keywords?: string[];
+  nutrition?: {
+    calories?: string;
+    fatContent?: string;
+    saturatedFatContent?: string;
+    cholesterolContent?: string;
+    sodiumContent?: string;
+    carbohydrateContent?: string;
+    fiberContent?: string;
+    sugarContent?: string;
+    proteinContent?: string;
+    servingSize?: string;
+  };
+  recipeIngredient: string[];
+  recipeInstructions: (string | { name?: string; text: string; image?: string; url?: string })[];
+  video?: {
+    name: string;
+    description: string;
+    thumbnailUrl: string | string[];
+    contentUrl?: string;
+    embedUrl?: string;
+    uploadDate: string;
+    duration?: string;
+    expires?: string;
+  };
+  aggregateRating?: {
+    ratingValue: number;
+    ratingCount?: number;
+    reviewCount?: number;
+    bestRating?: number;
+    worstRating?: number;
+  };
+  review?: {
+    author: string;
+    datePublished: string;
+    reviewBody?: string;
+    reviewRating?: {
+      ratingValue: number;
+      bestRating?: number;
+      worstRating?: number;
+    };
+  }[];
+  suitableForDiet?: ('DiabeticDiet' | 'GlutenFreeDiet' | 'HalalDiet' | 'HinduDiet' | 'KosherDiet' | 'LowCalorieDiet' | 'LowFatDiet' | 'LowLactoseDiet' | 'LowSaltDiet' | 'VeganDiet' | 'VegetarianDiet')[];
+}
+
+const {
+  name,
+  description,
+  image,
+  author,
+  datePublished,
+  prepTime,
+  cookTime,
+  totalTime,
+  recipeYield,
+  recipeCategory,
+  recipeCuisine,
+  keywords,
+  nutrition,
+  recipeIngredient,
+  recipeInstructions,
+  video,
+  aggregateRating,
+  review,
+  suitableForDiet,
+} = Astro.props;
+
+const jsonLd = {
+  '@context': 'https://schema.org',
+  '@type': 'Recipe',
+  name,
+  ...(description && { description }),
+  ...(image && { image: Array.isArray(image) ? image : [image] }),
+  ...(author && {
+    author: {
+      '@type': 'Person',
+      name: author.name,
+      ...(author.url && { url: author.url }),
+    },
+  }),
+  ...(datePublished && { datePublished }),
+  ...(prepTime && { prepTime }),
+  ...(cookTime && { cookTime }),
+  ...(totalTime && { totalTime }),
+  ...(recipeYield && { recipeYield: String(recipeYield) }),
+  ...(recipeCategory && { recipeCategory }),
+  ...(recipeCuisine && { recipeCuisine }),
+  ...(keywords && { keywords: keywords.join(', ') }),
+  ...(nutrition && {
+    nutrition: {
+      '@type': 'NutritionInformation',
+      ...(nutrition.calories && { calories: nutrition.calories }),
+      ...(nutrition.fatContent && { fatContent: nutrition.fatContent }),
+      ...(nutrition.saturatedFatContent && { saturatedFatContent: nutrition.saturatedFatContent }),
+      ...(nutrition.cholesterolContent && { cholesterolContent: nutrition.cholesterolContent }),
+      ...(nutrition.sodiumContent && { sodiumContent: nutrition.sodiumContent }),
+      ...(nutrition.carbohydrateContent && { carbohydrateContent: nutrition.carbohydrateContent }),
+      ...(nutrition.fiberContent && { fiberContent: nutrition.fiberContent }),
+      ...(nutrition.sugarContent && { sugarContent: nutrition.sugarContent }),
+      ...(nutrition.proteinContent && { proteinContent: nutrition.proteinContent }),
+      ...(nutrition.servingSize && { servingSize: nutrition.servingSize }),
+    },
+  }),
+  recipeIngredient,
+  recipeInstructions: recipeInstructions.map((step, index) =>
+    typeof step === 'string'
+      ? { '@type': 'HowToStep', text: step }
+      : {
+          '@type': 'HowToStep',
+          ...(step.name && { name: step.name }),
+          text: step.text,
+          ...(step.image && { image: step.image }),
+          ...(step.url && { url: step.url }),
+        }
+  ),
+  ...(video && {
+    video: {
+      '@type': 'VideoObject',
+      name: video.name,
+      description: video.description,
+      thumbnailUrl: video.thumbnailUrl,
+      ...(video.contentUrl && { contentUrl: video.contentUrl }),
+      ...(video.embedUrl && { embedUrl: video.embedUrl }),
+      uploadDate: video.uploadDate,
+      ...(video.duration && { duration: video.duration }),
+      ...(video.expires && { expires: video.expires }),
+    },
+  }),
+  ...(aggregateRating && {
+    aggregateRating: {
+      '@type': 'AggregateRating',
+      ratingValue: aggregateRating.ratingValue,
+      ...(aggregateRating.ratingCount && { ratingCount: aggregateRating.ratingCount }),
+      ...(aggregateRating.reviewCount && { reviewCount: aggregateRating.reviewCount }),
+      bestRating: aggregateRating.bestRating ?? 5,
+      worstRating: aggregateRating.worstRating ?? 1,
+    },
+  }),
+  ...(review && {
+    review: review.map(r => ({
+      '@type': 'Review',
+      author: { '@type': 'Person', name: r.author },
+      datePublished: r.datePublished,
+      ...(r.reviewBody && { reviewBody: r.reviewBody }),
+      ...(r.reviewRating && {
+        reviewRating: {
+          '@type': 'Rating',
+          ratingValue: r.reviewRating.ratingValue,
+          bestRating: r.reviewRating.bestRating ?? 5,
+          worstRating: r.reviewRating.worstRating ?? 1,
+        },
+      }),
+    })),
+  }),
+  ...(suitableForDiet && {
+    suitableForDiet: suitableForDiet.map(diet => `https://schema.org/${diet}`),
+  }),
+};
+---
+
+<script is:inline type="application/ld+json" set:html={JSON.stringify(jsonLd)} />
+<slot />

package/src/schemas/Review.astro

@@ -0,0 +1,138 @@
+---
+export interface Props {
+  itemReviewed: {
+    type: 'Product' | 'LocalBusiness' | 'Organization' | 'Book' | 'Movie' | 'Restaurant' | 'Event' | 'CreativeWork' | 'SoftwareApplication' | 'MusicRecording' | 'Recipe';
+    name: string;
+    image?: string;
+    url?: string;
+    sameAs?: string;
+    author?: string;
+    isbn?: string;
+    director?: string;
+    datePublished?: string;
+    address?: {
+      streetAddress?: string;
+      addressLocality?: string;
+      addressRegion?: string;
+      postalCode?: string;
+      addressCountry?: string;
+    };
+    priceRange?: string;
+    telephone?: string;
+  };
+  reviewRating: {
+    ratingValue: number;
+    bestRating?: number;
+    worstRating?: number;
+  };
+  author: {
+    name: string;
+    type?: 'Person' | 'Organization';
+  };
+  datePublished?: string;
+  reviewBody?: string;
+  publisher?: {
+    name: string;
+    type?: 'Person' | 'Organization';
+  };
+  positiveNotes?: string | string[];
+  negativeNotes?: string | string[];
+}
+
+const {
+  itemReviewed,
+  reviewRating,
+  author,
+  datePublished,
+  reviewBody,
+  publisher,
+  positiveNotes,
+  negativeNotes,
+} = Astro.props;
+
+const buildItemReviewed = () => {
+  const base = {
+    '@type': itemReviewed.type,
+    name: itemReviewed.name,
+    ...(itemReviewed.image && { image: itemReviewed.image }),
+    ...(itemReviewed.url && { url: itemReviewed.url }),
+    ...(itemReviewed.sameAs && { sameAs: itemReviewed.sameAs }),
+  };
+
+  switch (itemReviewed.type) {
+    case 'Book':
+      return {
+        ...base,
+        ...(itemReviewed.author && { author: { '@type': 'Person', name: itemReviewed.author } }),
+        ...(itemReviewed.isbn && { isbn: itemReviewed.isbn }),
+      };
+    case 'Movie':
+      return {
+        ...base,
+        ...(itemReviewed.director && { director: { '@type': 'Person', name: itemReviewed.director } }),
+        ...(itemReviewed.datePublished && { datePublished: itemReviewed.datePublished }),
+      };
+    case 'LocalBusiness':
+    case 'Restaurant':
+      return {
+        ...base,
+        ...(itemReviewed.address && {
+          address: {
+            '@type': 'PostalAddress',
+            ...(itemReviewed.address.streetAddress && { streetAddress: itemReviewed.address.streetAddress }),
+            ...(itemReviewed.address.addressLocality && { addressLocality: itemReviewed.address.addressLocality }),
+            ...(itemReviewed.address.addressRegion && { addressRegion: itemReviewed.address.addressRegion }),
+            ...(itemReviewed.address.postalCode && { postalCode: itemReviewed.address.postalCode }),
+            ...(itemReviewed.address.addressCountry && { addressCountry: itemReviewed.address.addressCountry }),
+          },
+        }),
+        ...(itemReviewed.priceRange && { priceRange: itemReviewed.priceRange }),
+        ...(itemReviewed.telephone && { telephone: itemReviewed.telephone }),
+      };
+    default:
+      return base;
+  }
+};
+
+const formatNotes = (notes: string | string[] | undefined, type: 'Positive' | 'Negative') => {
+  if (!notes) return undefined;
+  const noteArray = Array.isArray(notes) ? notes : [notes];
+  return {
+    '@type': 'ItemList',
+    itemListElement: noteArray.map((note, index) => ({
+      '@type': 'ListItem',
+      position: index + 1,
+      name: note,
+    })),
+  };
+};
+
+const jsonLd = {
+  '@context': 'https://schema.org',
+  '@type': 'Review',
+  itemReviewed: buildItemReviewed(),
+  reviewRating: {
+    '@type': 'Rating',
+    ratingValue: reviewRating.ratingValue,
+    bestRating: reviewRating.bestRating ?? 5,
+    worstRating: reviewRating.worstRating ?? 1,
+  },
+  author: {
+    '@type': author.type || 'Person',
+    name: author.name,
+  },
+  ...(datePublished && { datePublished }),
+  ...(reviewBody && { reviewBody }),
+  ...(publisher && {
+    publisher: {
+      '@type': publisher.type || 'Organization',
+      name: publisher.name,
+    },
+  }),
+  ...(positiveNotes && { positiveNotes: formatNotes(positiveNotes, 'Positive') }),
+  ...(negativeNotes && { negativeNotes: formatNotes(negativeNotes, 'Negative') }),
+};
+---
+
+<script is:inline type="application/ld+json" set:html={JSON.stringify(jsonLd)} />
+<slot />

package/src/schemas/SoftwareApp.astro

@@ -0,0 +1,172 @@
+---
+export interface Props {
+  name: string;
+  description?: string;
+  applicationCategory?: 'GameApplication' | 'SocialNetworkingApplication' | 'TravelApplication' | 'ShoppingApplication' | 'SportsApplication' | 'LifestyleApplication' | 'BusinessApplication' | 'DesignApplication' | 'DeveloperApplication' | 'DriverApplication' | 'EducationalApplication' | 'HealthApplication' | 'FinanceApplication' | 'SecurityApplication' | 'BrowserApplication' | 'CommunicationApplication' | 'DesktopEnhancementApplication' | 'EntertainmentApplication' | 'MultimediaApplication' | 'HomeApplication' | 'UtilitiesApplication' | 'ReferenceApplication';
+  operatingSystem?: string;
+  url?: string;
+  image?: string;
+  screenshot?: string | string[];
+  offers?: {
+    price: number | string;
+    priceCurrency: string;
+    availability?: 'InStock' | 'OutOfStock' | 'PreOrder';
+  };
+  aggregateRating?: {
+    ratingValue: number;
+    ratingCount?: number;
+    reviewCount?: number;
+    bestRating?: number;
+    worstRating?: number;
+  };
+  review?: {
+    author: string;
+    datePublished: string;
+    reviewBody?: string;
+    reviewRating?: {
+      ratingValue: number;
+      bestRating?: number;
+      worstRating?: number;
+    };
+  }[];
+  softwareVersion?: string;
+  releaseNotes?: string;
+  datePublished?: string;
+  downloadUrl?: string;
+  installUrl?: string;
+  featureList?: string | string[];
+  requirements?: string;
+  memoryRequirements?: string;
+  storageRequirements?: string;
+  permissions?: string;
+  author?: {
+    name: string;
+    type?: 'Person' | 'Organization';
+    url?: string;
+  };
+  publisher?: {
+    name: string;
+    type?: 'Person' | 'Organization';
+    url?: string;
+  };
+  inLanguage?: string | string[];
+  isAccessibleForFree?: boolean;
+  countriesSupported?: string[];
+  supportingData?: {
+    name: string;
+    url: string;
+  };
+}
+
+const {
+  name,
+  description,
+  applicationCategory,
+  operatingSystem,
+  url,
+  image,
+  screenshot,
+  offers,
+  aggregateRating,
+  review,
+  softwareVersion,
+  releaseNotes,
+  datePublished,
+  downloadUrl,
+  installUrl,
+  featureList,
+  requirements,
+  memoryRequirements,
+  storageRequirements,
+  permissions,
+  author,
+  publisher,
+  inLanguage,
+  isAccessibleForFree,
+  countriesSupported,
+  supportingData,
+} = Astro.props;
+
+const jsonLd = {
+  '@context': 'https://schema.org',
+  '@type': 'SoftwareApplication',
+  name,
+  ...(description && { description }),
+  ...(applicationCategory && { applicationCategory }),
+  ...(operatingSystem && { operatingSystem }),
+  ...(url && { url }),
+  ...(image && { image }),
+  ...(screenshot && { screenshot: Array.isArray(screenshot) ? screenshot : [screenshot] }),
+  ...(offers && {
+    offers: {
+      '@type': 'Offer',
+      price: offers.price,
+      priceCurrency: offers.priceCurrency,
+      ...(offers.availability && { availability: `https://schema.org/${offers.availability}` }),
+    },
+  }),
+  ...(aggregateRating && {
+    aggregateRating: {
+      '@type': 'AggregateRating',
+      ratingValue: aggregateRating.ratingValue,
+      ...(aggregateRating.ratingCount && { ratingCount: aggregateRating.ratingCount }),
+      ...(aggregateRating.reviewCount && { reviewCount: aggregateRating.reviewCount }),
+      bestRating: aggregateRating.bestRating ?? 5,
+      worstRating: aggregateRating.worstRating ?? 1,
+    },
+  }),
+  ...(review && {
+    review: review.map(r => ({
+      '@type': 'Review',
+      author: { '@type': 'Person', name: r.author },
+      datePublished: r.datePublished,
+      ...(r.reviewBody && { reviewBody: r.reviewBody }),
+      ...(r.reviewRating && {
+        reviewRating: {
+          '@type': 'Rating',
+          ratingValue: r.reviewRating.ratingValue,
+          bestRating: r.reviewRating.bestRating ?? 5,
+          worstRating: r.reviewRating.worstRating ?? 1,
+        },
+      }),
+    })),
+  }),
+  ...(softwareVersion && { softwareVersion }),
+  ...(releaseNotes && { releaseNotes }),
+  ...(datePublished && { datePublished }),
+  ...(downloadUrl && { downloadUrl }),
+  ...(installUrl && { installUrl }),
+  ...(featureList && { featureList: Array.isArray(featureList) ? featureList.join(', ') : featureList }),
+  ...(requirements && { requirements }),
+  ...(memoryRequirements && { memoryRequirements }),
+  ...(storageRequirements && { storageRequirements }),
+  ...(permissions && { permissions }),
+  ...(author && {
+    author: {
+      '@type': author.type || 'Person',
+      name: author.name,
+      ...(author.url && { url: author.url }),
+    },
+  }),
+  ...(publisher && {
+    publisher: {
+      '@type': publisher.type || 'Organization',
+      name: publisher.name,
+      ...(publisher.url && { url: publisher.url }),
+    },
+  }),
+  ...(inLanguage && { inLanguage }),
+  ...(isAccessibleForFree !== undefined && { isAccessibleForFree }),
+  ...(countriesSupported && { countriesSupported }),
+  ...(supportingData && {
+    supportingData: {
+      '@type': 'DataFeed',
+      name: supportingData.name,
+      url: supportingData.url,
+    },
+  }),
+};
+---
+
+<script is:inline type="application/ld+json" set:html={JSON.stringify(jsonLd)} />
+<slot />