@studiocms/blog 0.1.0-beta.25 → 0.1.0-beta.27

package/README.md

@@ -1,5 +1,7 @@
 # StudioCMS - Blog Provider
 
+[![codecov](https://codecov.io/github/withstudiocms/studiocms/graph/badge.svg?token=RN8LT1O5E2&component=studiocms_blog)](https://codecov.io/github/withstudiocms/studiocms)
+
 For information and docs related to this package see [The StudioCMS Docs](https://docs.studiocms.dev/package-catalog/studiocms-plugins/studiocms-blog/)
 
 ## License

package/dist/components/BaseHead.astro

@@ -9,6 +9,7 @@ import {
 	headDefaults,
 } from 'studiocms:lib';
 import type { z } from 'astro/zod';
+import { getHeroImage } from './heroHelper.js';
 
 let htmlDefaultHead: HeadUserConfig = [];
 let favicon = '';
@@ -31,14 +32,11 @@ interface Props {
 
 const canonicalURL = Astro.url;
 
-const {
-	title,
-	description,
-	lang = 'en',
-	image = 'https://images.unsplash.com/photo-1707343843982-f8275f3994c5?q=80&w=1032&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDF8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D',
-} = Astro.props;
+const { title, description, lang = 'en', image } = Astro.props;
 
-const makeHeader = headDefaults(title, description, lang, Astro, favicon, image, canonicalURL);
+const ogImage = getHeroImage(image, Astro);
+
+const makeHeader = headDefaults(title, description, lang, Astro, favicon, ogImage, canonicalURL);
 
 const StudioCMSFrontEndHeads: z.input<ReturnType<typeof HeadConfigSchema>> = [
 	// Fonts

package/dist/components/PageList.astro

@@ -3,7 +3,8 @@ import blogConfig from 'studiocms:blog/config';
 import { FormattedDate } from 'studiocms:components';
 import { CustomImage } from 'studiocms:imageHandler/components';
 import { pathWithBase } from 'studiocms:lib';
-import type { CombinedPageData } from 'studiocms:sdk/types';
+import type { CombinedPageData } from 'studiocms/sdk/types';
+import { getHeroImage } from './heroHelper.js';
 
 const blogRouteFullPath = `${blogConfig.route}/[...slug]`;
 
@@ -26,7 +27,7 @@ const { blogPageList } = Astro.props;
        blogPageList.length > 0 && blogPageList.map(({slug, heroImage, title, description, publishedAt}) => (
            <li>
                <a href={pathWithBase(getBlogRoute(slug))}>
-                   <CustomImage src={heroImage} alt={title} width={720} height={360}/>
+                   <CustomImage src={getHeroImage(heroImage, Astro)} alt={title} width={720} height={360}/>
                    <div>
                        <span class="title">{title}</span>
                        <span class="date"> <FormattedDate date={publishedAt} /> </span>

package/dist/components/PostHeader.astro

@@ -1,21 +1,24 @@
 ---
 import { FormattedDate } from 'studiocms:components';
 import { CustomImage } from 'studiocms:imageHandler/components';
+import { getHeroImage } from './heroHelper.js';
 
 interface Props {
 	title: string;
 	publishedAt: Date;
 	updatedAt?: Date | null;
-	heroImage: string;
+	heroImage?: string;
 	description: string;
 }
 
 const { title, description, heroImage, publishedAt, updatedAt } = Astro.props;
+
+const heroImageToUse = getHeroImage(heroImage, Astro);
 ---
 <h1 class="title">{title}</h1>
 
 <div style="text-align: center;">
-	<CustomImage src={heroImage} alt={title} width={720} height={360}/>
+	<CustomImage src={heroImageToUse} alt={title} width={720} height={360}/>
 	<div>
 		<p class="date">Published: <FormattedDate date={publishedAt}/></p>
 		{updatedAt && <p class="date"> | Last Updated: <FormattedDate date={updatedAt}/></p>}

package/dist/components/consts.d.ts

@@ -0,0 +1 @@
+export declare const FALLBACK_OG_IMAGE = "https://images.unsplash.com/photo-1707343843982-f8275f3994c5?q=80&w=1032&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDF8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D";

package/dist/components/consts.js

@@ -0,0 +1,4 @@
+const FALLBACK_OG_IMAGE = "https://images.unsplash.com/photo-1707343843982-f8275f3994c5?q=80&w=1032&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDF8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D";
+export {
+  FALLBACK_OG_IMAGE
+};

package/dist/components/heroHelper.d.ts

@@ -0,0 +1,22 @@
+import type { AstroGlobal } from 'astro';
+/**
+ * Trims leading and trailing whitespace from the given input string.
+ *
+ * @param input - The string to trim. Can be `string`, `null`, or `undefined`.
+ * @returns The trimmed string, or `undefined` if the input is `null` or `undefined`.
+ */
+export declare function trimInput(input: string | null | undefined): string | undefined;
+/**
+ * Retrieves the appropriate hero image URL based on the provided `hero` string,
+ * the site's default OG image, or a fallback image.
+ *
+ * The function checks the following, in order:
+ * 1. If a valid `hero` image URL is provided, it returns that.
+ * 2. If not, it attempts to use the site's default OG image from the Astro global context.
+ * 3. If neither is available, it returns a constant fallback image URL.
+ *
+ * @param hero - The primary hero image URL, or `undefined` if not provided.
+ * @param Astro - The Astro global context, used to access site configuration.
+ * @returns The resolved hero image URL as a string.
+ */
+export declare function getHeroImage(hero: string | undefined, Astro: AstroGlobal): string;

package/dist/components/heroHelper.js

@@ -0,0 +1,17 @@
+import { FALLBACK_OG_IMAGE } from "./consts.js";
+function trimInput(input) {
+  if (input == null) return void 0;
+  const trimmed = input.trim();
+  return trimmed.length > 0 ? trimmed : void 0;
+}
+function getHeroImage(hero, Astro) {
+  const primary = trimInput(hero);
+  const siteFallback = trimInput(Astro.locals?.StudioCMS?.siteConfig?.data?.defaultOgImage);
+  if (primary) return primary;
+  if (siteFallback) return siteFallback;
+  return FALLBACK_OG_IMAGE;
+}
+export {
+  getHeroImage,
+  trimInput
+};

package/dist/index.d.ts

@@ -1,5 +1,7 @@
+import type { AstroIntegration } from 'astro';
 import { type StudioCMSPlugin } from 'studiocms/plugins';
 import { type StudioCMSBlogOptions } from './types.js';
+export declare function internalBlogIntegration(options?: StudioCMSBlogOptions): AstroIntegration;
 /**
  * Creates and configures the StudioCMS Blog plugin.
  *

package/dist/index.js

@@ -3,15 +3,75 @@ import { pathWithBase } from "studiocms/lib/pathGenerators";
 import { definePlugin } from "studiocms/plugins";
 import { FrontEndConfigSchema } from "./types.js";
 const packageIdentifier = "@studiocms/blog";
-function studioCMSBlogPlugin(options) {
+function internalBlogIntegration(options) {
   const resolvedOptions = FrontEndConfigSchema.parse(options);
   const {
     blog: { title, enableRSS, route: orgRoute },
-    sitemap,
     injectRoutes,
     ...frontendConfig
   } = resolvedOptions;
   const route = pathWithBase(orgRoute);
+  const resEntrypoint = (path) => `@studiocms/blog/routes/${path}`;
+  return {
+    name: packageIdentifier,
+    hooks: {
+      /* v8 ignore start */
+      /* this is tested indirectly via the plugin tests */
+      "astro:config:setup": async (params) => {
+        const { injectRoute } = params;
+        if (injectRoutes) {
+          injectRoute({
+            entrypoint: resEntrypoint("[...slug].astro"),
+            pattern: pathWithBase("[...slug]"),
+            prerender: false
+          });
+          injectRoute({
+            entrypoint: resEntrypoint("blog/index.astro"),
+            pattern: `${route}`,
+            prerender: false
+          });
+          injectRoute({
+            entrypoint: resEntrypoint("blog/[...slug].astro"),
+            pattern: `${route}/[...slug]`,
+            prerender: false
+          });
+          if (enableRSS) {
+            injectRoute({
+              entrypoint: resEntrypoint("rss.xml.js"),
+              pattern: pathWithBase("rss.xml"),
+              prerender: false
+            });
+          }
+        }
+        addVirtualImports(params, {
+          name: packageIdentifier,
+          imports: {
+            "studiocms:blog/config": `
+							const config = {
+								title: ${JSON.stringify(title)},
+								enableRSS: ${enableRSS},
+								route: ${JSON.stringify(route)}
+							}
+							export default config;
+						`,
+            "studiocms:blog/frontend-config": `
+							const config = ${JSON.stringify(frontendConfig)};
+							export default config;
+						`
+          }
+        });
+      }
+      /* v8 ignore stop */
+    }
+  };
+}
+function studioCMSBlogPlugin(options) {
+  const resolvedOptions = FrontEndConfigSchema.parse(options);
+  const {
+    blog: { title, route: orgRoute },
+    sitemap
+  } = resolvedOptions;
+  const route = pathWithBase(orgRoute);
   const { resolve } = createResolver(import.meta.url);
   const editor = resolve("./components/editor.astro");
   const renderer = resolve("./components/renderer.astro");
@@ -22,55 +82,7 @@ function studioCMSBlogPlugin(options) {
     requires: ["@studiocms/md"],
     hooks: {
       "studiocms:astro:config": ({ addIntegrations }) => {
-        addIntegrations({
-          name: packageIdentifier,
-          hooks: {
-            "astro:config:setup": async (params) => {
-              const { injectRoute } = params;
-              if (injectRoutes) {
-                injectRoute({
-                  entrypoint: resolve("./routes/[...slug].astro"),
-                  pattern: pathWithBase("[...slug]"),
-                  prerender: false
-                });
-                injectRoute({
-                  entrypoint: resolve("./routes/blog/index.astro"),
-                  pattern: `${route}`,
-                  prerender: false
-                });
-                injectRoute({
-                  entrypoint: resolve("./routes/blog/[...slug].astro"),
-                  pattern: `${route}/[...slug]`,
-                  prerender: false
-                });
-                if (enableRSS) {
-                  injectRoute({
-                    entrypoint: resolve("./routes/rss.xml.js"),
-                    pattern: pathWithBase("rss.xml"),
-                    prerender: false
-                  });
-                }
-              }
-              addVirtualImports(params, {
-                name: packageIdentifier,
-                imports: {
-                  "studiocms:blog/config": `
-										const config = {
-											title: ${JSON.stringify(title)},
-											enableRSS: ${enableRSS},
-											route: ${JSON.stringify(route)}
-										}
-										export default config;
-									`,
-                  "studiocms:blog/frontend-config": `
-										const config = ${JSON.stringify(frontendConfig)};
-										export default config;
-									`
-                }
-              });
-            }
-          }
-        });
+        addIntegrations(internalBlogIntegration(resolvedOptions));
       },
       "studiocms:config:setup": ({ setFrontend, setRendering, setSitemap }) => {
         setFrontend({
@@ -106,5 +118,6 @@ function studioCMSBlogPlugin(options) {
 var index_default = studioCMSBlogPlugin;
 export {
   index_default as default,
+  internalBlogIntegration,
   studioCMSBlogPlugin
 };

package/dist/routes/[...slug].astro

@@ -9,12 +9,14 @@ if (!slug) {
 	slug = 'index';
 }
 
-const { data: page } = await runSDK(SDKCoreJs.GET.page.bySlug(slug));
+const fullPageData = await runSDK(SDKCoreJs.GET.page.bySlug(slug));
 
-if (!page) {
+if (!fullPageData) {
 	return new Response(null, { status: 404 });
 }
 
+const page = fullPageData.data;
+
 const { title, description, heroImage } = page;
 ---
 

package/dist/routes/blog/[...slug].astro

@@ -14,13 +14,15 @@ if (!slug) {
 
 // Fetch the blog post content
 
-const { data: post } = await runSDK(SDKCoreJs.GET.page.bySlug(slug));
+const fullPageData = await runSDK(SDKCoreJs.GET.page.bySlug(slug));
 
 // If no content is found, redirect to 404
-if (!post) {
+if (!fullPageData) {
 	return new Response(null, { status: 404 });
 }
 
+const post = fullPageData.data;
+
 const { title, description, heroImage, publishedAt, updatedAt } = post;
 ---
 

package/dist/routes/rss.xml.js

@@ -3,13 +3,7 @@ import { pathWithBase } from "studiocms:lib";
 import { SDKCore } from "studiocms:sdk";
 import rss, {} from "@astrojs/rss";
 import { createJsonResponse, Effect, withEffectAPI } from "studiocms/effect";
-const blogRouteFullPath = `${blogConfig.route}/[...slug]`;
-function getBlogRoute(slug) {
-  if (blogRouteFullPath) {
-    return blogRouteFullPath.replace("[...slug]", slug);
-  }
-  return "#";
-}
+import { getBlogRoute } from "../utils/remapFilter.js";
 const GET = withEffectAPI(
   Effect.fn(function* ({ site: _site, locals }) {
     const sdk = yield* SDKCore;

package/dist/types.d.ts

@@ -2,6 +2,15 @@ import { z } from 'astro/zod';
 import { HeadConfigSchema } from 'studiocms/lib/head';
 export type HeadUserConfig = z.input<ReturnType<typeof HeadConfigSchema>>;
 export type HeadConfig = z.output<ReturnType<typeof HeadConfigSchema>>;
+export declare const faviconTypeMap: {
+    '.ico': string;
+    '.gif': string;
+    '.jpeg': string;
+    '.jpg': string;
+    '.png': string;
+    '.svg': string;
+};
+export declare function isFaviconExt(ext: string): ext is keyof typeof faviconTypeMap;
 /**
  * Options for configuring the StudioCMS Blog.
  */
@@ -19,13 +28,13 @@ export declare const FrontEndConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObjec
         attrs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodUndefined]>>>;
         content: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        tag: "title" | "link" | "base" | "meta" | "noscript" | "script" | "style" | "template";
-        content: string;
+        tag: "title" | "base" | "link" | "style" | "meta" | "script" | "noscript" | "template";
         attrs: Record<string, string | boolean | undefined>;
+        content: string;
     }, {
-        tag: "title" | "link" | "base" | "meta" | "noscript" | "script" | "style" | "template";
-        content?: string | undefined;
+        tag: "title" | "base" | "link" | "style" | "meta" | "script" | "noscript" | "template";
         attrs?: Record<string, string | boolean | undefined> | undefined;
+        content?: string | undefined;
     }>, "many">>;
     /**
      * Favicon Configuration - The default favicon configuration for the Frontend
@@ -71,9 +80,9 @@ export declare const FrontEndConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObjec
 }, "strip", z.ZodTypeAny, {
     htmlDefaultLanguage: string;
     htmlDefaultHead: {
-        tag: "title" | "link" | "base" | "meta" | "noscript" | "script" | "style" | "template";
-        content: string;
+        tag: "title" | "base" | "link" | "style" | "meta" | "script" | "noscript" | "template";
         attrs: Record<string, string | boolean | undefined>;
+        content: string;
     }[];
     favicon: string;
     sitemap: boolean;
@@ -86,9 +95,9 @@ export declare const FrontEndConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObjec
 }, {
     htmlDefaultLanguage?: string | undefined;
     htmlDefaultHead?: {
-        tag: "title" | "link" | "base" | "meta" | "noscript" | "script" | "style" | "template";
-        content?: string | undefined;
+        tag: "title" | "base" | "link" | "style" | "meta" | "script" | "noscript" | "template";
         attrs?: Record<string, string | boolean | undefined> | undefined;
+        content?: string | undefined;
     }[] | undefined;
     favicon?: string | undefined;
     sitemap?: boolean | undefined;

package/dist/types.js

@@ -65,5 +65,7 @@ const FrontEndConfigSchema = z.object({
   }).optional().default({})
 }).optional().default({});
 export {
-  FrontEndConfigSchema
+  FrontEndConfigSchema,
+  faviconTypeMap,
+  isFaviconExt
 };

package/dist/utils/remapFilter.d.ts

@@ -1,7 +1,8 @@
-import type { PageDataCacheObject } from 'studiocms:sdk/types';
 import type { APIContext } from 'astro';
+import type { PageDataCacheObject } from 'studiocms/sdk/types';
 export declare function getBlogRoute(slug: string): string;
 export type SiteMapTemplate = {
     location: string;
 }[];
+export type { APIContext, PageDataCacheObject };
 export declare const remapFilterSitemap: ((filter: string, context: APIContext, blog?: boolean) => (array: Array<PageDataCacheObject>) => SiteMapTemplate) & ((array: Array<PageDataCacheObject>, filter: string, context: APIContext, blog?: boolean) => SiteMapTemplate);

package/dist/utils/remapFilter.js

@@ -3,10 +3,7 @@ import { pathWithBase } from "studiocms:lib";
 import { dual } from "studiocms/effect";
 const blogRouteFullPath = `${blogConfig.route}/[...slug]`;
 function getBlogRoute(slug) {
-  if (blogRouteFullPath) {
-    return blogRouteFullPath.replace("[...slug]", slug);
-  }
-  return "#";
+  return blogRouteFullPath.replace("[...slug]", slug);
 }
 const remapFilterSitemap = dual(4, (array, filter, context, blog = false) => {
   function genLocation(slug) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/blog",
-  "version": "0.1.0-beta.25",
+  "version": "0.1.0-beta.27",
   "description": "Add a blog to your StudioCMS project with ease!",
   "author": {
     "name": "withstudiocms",
@@ -48,7 +48,8 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
-    }
+    },
+    "./routes/*": "./dist/routes/*"
   },
   "type": "module",
   "dependencies": {
@@ -60,14 +61,15 @@
   },
   "peerDependencies": {
     "astro": "^5.12.9",
-    "effect": "^3.17.9",
+    "effect": "^3.17.14",
     "vite": "^6.3.4",
-    "@studiocms/md": "0.1.0-beta.25",
-    "studiocms": "0.1.0-beta.25"
+    "@studiocms/md": "0.1.0-beta.27",
+    "studiocms": "0.1.0-beta.27"
   },
   "scripts": {
     "build": "buildkit build 'src/**/*.{ts,astro,css,json,png,d.ts}'",
     "dev": "buildkit dev 'src/**/*.{ts,astro,css,json,png,d.ts}'",
-    "typecheck": "tspc -p tsconfig.tspc.json"
+    "typecheck": "tspc -p tsconfig.tspc.json",
+    "test": "vitest"
   }
 }