@studiocms/blog 0.2.0 → 0.3.0

package/dist/components/BaseHead.astro

@@ -1,14 +1,7 @@
 ---
 import '../styles/base.css';
 import config from 'studiocms:blog/frontend-config';
-import {
-	createHead,
-	type HeadConfig,
-	type HeadConfigSchema,
-	type HeadUserConfig,
-	headDefaults,
-} from 'studiocms:lib';
-import type { z } from 'astro/zod';
+import { createHead, type HeadConfig, type HeadUserConfig, headDefaults } from 'studiocms:lib';
 import { getHeroImage } from './heroHelper.js';
 
 let htmlDefaultHead: HeadUserConfig = [];
@@ -38,7 +31,7 @@ const ogImage = getHeroImage(image, Astro);
 
 const makeHeader = headDefaults(title, description, lang, Astro, favicon, ogImage, canonicalURL);
 
-const StudioCMSFrontEndHeads: z.input<ReturnType<typeof HeadConfigSchema>> = [
+const StudioCMSFrontEndHeads: HeadUserConfig = [
 	// Fonts
 	{ tag: 'link', attrs: { rel: 'preconnect', href: 'https://fonts.googleapis.com' } },
 	{ tag: 'link', attrs: { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' } },

package/dist/components/render.d.ts

@@ -1,15 +1,6 @@
 declare const renderer: {
     name: string;
     renderer: (content: string) => Promise<string>;
-    sanitizeOpts: {
-        allowElements?: string[] | undefined;
-        blockElements?: string[] | undefined;
-        dropElements?: string[] | undefined;
-        allowAttributes?: Record<string, string[]> | undefined;
-        dropAttributes?: Record<string, string[]> | undefined;
-        allowComponents?: boolean | undefined;
-        allowCustomElements?: boolean | undefined;
-        allowComments?: boolean | undefined;
-    } | undefined;
+    sanitizeOpts: any;
 };
 export default renderer;

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 import type { AstroIntegration } from 'astro';
-import { type StudioCMSPlugin } from 'studiocms/plugins';
+import type { StudioCMSPluginDef } from 'studiocms/schemas';
 import { type StudioCMSBlogOptions } from './types.js';
 export declare function internalBlogIntegration(options?: StudioCMSBlogOptions): AstroIntegration;
 /**
  * Creates and configures the StudioCMS Blog plugin.
  *
  * @param {StudioCMSBlogOptions} [options] - Optional configuration options for the blog plugin.
- * @returns {StudioCMSPlugin} The configured StudioCMS plugin.
+ * @returns {StudioCMSPluginDef} The configured StudioCMS plugin.
  *
  * @remarks
  * This function sets up the StudioCMS Blog plugin with the provided options or default values.
@@ -33,5 +33,5 @@ export declare function internalBlogIntegration(options?: StudioCMSBlogOptions):
  * @param {boolean} [options.sitemap] - Whether to trigger sitemap generation. Defaults to true.
  * @param {boolean} [options.injectRoutes] - Whether to inject routes for the blog. Defaults to true.
  */
-export declare function studioCMSBlogPlugin(options?: StudioCMSBlogOptions): StudioCMSPlugin;
+export declare function studioCMSBlogPlugin(options?: StudioCMSBlogOptions): StudioCMSPluginDef;
 export default studioCMSBlogPlugin;

package/dist/index.js

@@ -1,10 +1,11 @@
 import { addVirtualImports, createResolver } from "astro-integration-kit";
+import { Schema } from "effect";
 import { pathWithBase } from "studiocms/lib/pathGenerators";
 import { definePlugin } from "studiocms/plugins";
 import { FrontEndConfigSchema } from "./types.js";
 const packageIdentifier = "@studiocms/blog";
-function internalBlogIntegration(options) {
-  const resolvedOptions = FrontEndConfigSchema.parse(options);
+function internalBlogIntegration(options = {}) {
+  const resolvedOptions = Schema.decodeSync(FrontEndConfigSchema)(options);
   const {
     blog: { title, enableRSS, route: orgRoute },
     injectRoutes,
@@ -65,8 +66,8 @@ function internalBlogIntegration(options) {
     }
   };
 }
-function studioCMSBlogPlugin(options) {
-  const resolvedOptions = FrontEndConfigSchema.parse(options);
+function studioCMSBlogPlugin(options = {}) {
+  const resolvedOptions = Schema.decodeSync(FrontEndConfigSchema)(options);
   const {
     blog: { title, route: orgRoute },
     sitemap
@@ -78,18 +79,17 @@ function studioCMSBlogPlugin(options) {
   return definePlugin({
     identifier: packageIdentifier,
     name: "StudioCMS Blog",
-    studiocmsMinimumVersion: "0.1.0-beta.21",
     requires: ["@studiocms/md"],
     hooks: {
-      "studiocms:astro-config": ({ addIntegrations }) => {
+      "studiocms:astro-config": async ({ addIntegrations }) => {
         addIntegrations(internalBlogIntegration(resolvedOptions));
       },
-      "studiocms:frontend": ({ setFrontend }) => {
+      "studiocms:frontend": async ({ setFrontend }) => {
         setFrontend({
           frontendNavigationLinks: [{ label: title, href: route }]
         });
       },
-      "studiocms:rendering": ({ setRendering }) => {
+      "studiocms:rendering": async ({ setRendering }) => {
         setRendering({
           pageTypes: [
             {
@@ -101,7 +101,7 @@ function studioCMSBlogPlugin(options) {
           ]
         });
       },
-      "studiocms:sitemap": ({ setSitemap }) => {
+      "studiocms:sitemap": async ({ setSitemap }) => {
         setSitemap({
           triggerSitemap: sitemap,
           sitemaps: [

package/dist/types.d.ts

@@ -1,7 +1,6 @@
-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>>;
+import { Schema } from 'effect';
+import { type HeadConfig, type HeadUserConfig } from 'studiocms/lib/head';
+export type { HeadConfig, HeadUserConfig };
 export declare const faviconTypeMap: {
     '.ico': string;
     '.gif': string;
@@ -11,101 +10,58 @@ export declare const faviconTypeMap: {
     '.svg': string;
 };
 export declare function isFaviconExt(ext: string): ext is keyof typeof faviconTypeMap;
-/**
- * Options for configuring the StudioCMS Blog.
- */
-export declare const FrontEndConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-    /**
-     * HTML Default Language - The default language for the HTML tag
-     * @default 'en'
-     */
-    htmlDefaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    /**
-     * HTML Default Header - The default head configuration for the Frontend
-     */
-    htmlDefaultHead: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        tag: z.ZodEnum<["title", "base", "link", "style", "meta", "script", "noscript", "template"]>;
-        attrs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodUndefined]>>>;
-        content: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        tag: "style" | "title" | "base" | "link" | "meta" | "script" | "noscript" | "template";
-        attrs: Record<string, string | boolean | undefined>;
-        content: string;
-    }, {
-        tag: "style" | "title" | "base" | "link" | "meta" | "script" | "noscript" | "template";
-        attrs?: Record<string, string | boolean | undefined> | undefined;
-        content?: string | undefined;
-    }>, "many">>;
-    /**
-     * Favicon Configuration - The default favicon configuration for the Frontend
-     */
-    favicon: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
-    /**
-     * Enable sitemap generation
-     * @default true
-     */
-    sitemap: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    /**
-     * Inject routes
-     * @default true
-     */
-    injectRoutes: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    /**
-     * The configuration for the blog
-     */
-    blog: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-        /**
-         * The title of the blog
-         */
-        title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-        /**
-         * Enable RSS feed
-         */
-        enableRSS: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        /**
-         * The route for the blog
-         * @default '/blog'
-         * @example '/news'
-         */
-        route: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        title: string;
-        enableRSS: boolean;
-        route: string;
-    }, {
-        title?: string | undefined;
-        enableRSS?: boolean | undefined;
-        route?: string | undefined;
-    }>>>;
-}, "strip", z.ZodTypeAny, {
-    htmlDefaultLanguage: string;
-    htmlDefaultHead: {
-        tag: "style" | "title" | "base" | "link" | "meta" | "script" | "noscript" | "template";
-        attrs: Record<string, string | boolean | undefined>;
-        content: string;
-    }[];
-    favicon: string;
-    sitemap: boolean;
-    injectRoutes: boolean;
-    blog: {
-        title: string;
-        enableRSS: boolean;
-        route: string;
-    };
-}, {
-    htmlDefaultLanguage?: string | undefined;
-    htmlDefaultHead?: {
-        tag: "style" | "title" | "base" | "link" | "meta" | "script" | "noscript" | "template";
-        attrs?: Record<string, string | boolean | undefined> | undefined;
-        content?: string | undefined;
-    }[] | undefined;
-    favicon?: string | undefined;
-    sitemap?: boolean | undefined;
-    injectRoutes?: boolean | undefined;
-    blog?: {
-        title?: string | undefined;
-        enableRSS?: boolean | undefined;
-        route?: string | undefined;
-    } | undefined;
-}>>>;
-export type StudioCMSBlogOptions = z.infer<typeof FrontEndConfigSchema>;
+export declare const FaviconSchema: Schema.transformOrFail<typeof Schema.String, typeof Schema.String, never>;
+export declare const FrontEndBlogSchema: Schema.Struct<{
+    title: Schema.optionalWith<typeof Schema.String, {
+        default: () => string;
+    }>;
+    enableRSS: Schema.optionalWith<typeof Schema.Boolean, {
+        default: () => true;
+    }>;
+    route: Schema.optionalWith<typeof Schema.String, {
+        default: () => string;
+    }>;
+}>;
+export declare const FrontEndConfigSchema: Schema.Struct<{
+    htmlDefaultLanguage: Schema.optionalWith<typeof Schema.String, {
+        default: () => string;
+    }>;
+    htmlDefaultHead: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
+        tag: Schema.Literal<["title", "base", "link", "style", "meta", "script", "noscript", "template"]>;
+        attrs: Schema.optionalWith<Schema.Record$<typeof Schema.String, Schema.Union<[typeof Schema.String, typeof Schema.Boolean, typeof Schema.Undefined]>>, {
+            default: () => {};
+        }>;
+        content: Schema.optionalWith<typeof Schema.String, {
+            default: () => string;
+        }>;
+    }>>>>, {
+        default: () => never[];
+    }>;
+    favicon: Schema.optionalWith<Schema.transformOrFail<typeof Schema.String, typeof Schema.String, never>, {
+        default: () => string;
+    }>;
+    sitemap: Schema.optionalWith<typeof Schema.Boolean, {
+        default: () => true;
+    }>;
+    injectRoutes: Schema.optionalWith<typeof Schema.Boolean, {
+        default: () => true;
+    }>;
+    blog: Schema.optionalWith<Schema.Struct<{
+        title: Schema.optionalWith<typeof Schema.String, {
+            default: () => string;
+        }>;
+        enableRSS: Schema.optionalWith<typeof Schema.Boolean, {
+            default: () => true;
+        }>;
+        route: Schema.optionalWith<typeof Schema.String, {
+            default: () => string;
+        }>;
+    }>, {
+        default: () => {
+            readonly title: string;
+            readonly enableRSS: boolean;
+            readonly route: string;
+        };
+    }>;
+}>;
+export type StudioCMSBlogOptions = typeof FrontEndConfigSchema.Encoded;

package/dist/types.js

@@ -1,5 +1,5 @@
 import { extname } from "node:path";
-import { z } from "astro/zod";
+import { ParseResult, Schema } from "effect";
 import { HeadConfigSchema } from "studiocms/lib/head";
 const faviconTypeMap = {
   ".ico": "image/x-icon",
@@ -12,59 +12,77 @@ const faviconTypeMap = {
 function isFaviconExt(ext) {
   return ext in faviconTypeMap;
 }
-const FrontEndConfigSchema = z.object({
-  /**
-   * HTML Default Language - The default language for the HTML tag
-   * @default 'en'
-   */
-  htmlDefaultLanguage: z.string().optional().default("en"),
-  /**
-   * HTML Default Header - The default head configuration for the Frontend
-   */
-  htmlDefaultHead: HeadConfigSchema(),
-  /**
-   * Favicon Configuration - The default favicon configuration for the Frontend
-   */
-  favicon: z.string().refine(
-    (fav) => {
-      const ext = extname(fav);
-      return isFaviconExt(ext);
-    },
-    {
-      message: "favicon must be a .ico, .gif, .jpg, .png, or .svg file"
+const FaviconSchema = Schema.transformOrFail(Schema.String, Schema.String, {
+  strict: true,
+  decode: (input, _options, ast) => {
+    const ext = extname(input).toLocaleLowerCase();
+    if (!isFaviconExt(ext)) {
+      return ParseResult.fail(
+        new ParseResult.Type(ast, input, "favicon must be a .ico, .gif, .jpg, .png, or .svg file")
+      );
     }
-  ).optional().default("/favicon.svg"),
-  /**
-   * Enable sitemap generation
-   * @default true
-   */
-  sitemap: z.boolean().optional().default(true),
-  /**
-   * Inject routes
-   * @default true
-   */
-  injectRoutes: z.boolean().optional().default(true),
-  /**
-   * The configuration for the blog
-   */
-  blog: z.object({
-    /**
-     * The title of the blog
-     */
-    title: z.string().optional().default("Blog"),
-    /**
-     * Enable RSS feed
-     */
-    enableRSS: z.boolean().optional().default(true),
-    /**
-     * The route for the blog
-     * @default '/blog'
-     * @example '/news'
-     */
-    route: z.string().optional().default("/blog")
-  }).optional().default({})
-}).optional().default({});
+    return ParseResult.succeed(input);
+  },
+  encode: (input) => ParseResult.succeed(input)
+}).annotations({
+  title: "Favicon",
+  identifier: "FaviconSchema",
+  description: "The path to the favicon file. Must be a .ico, .gif, .jpg, .png, or .svg file.",
+  examples: ["/favicon.ico", "/favicon.png", "/favicon.svg"]
+});
+const FrontEndBlogSchema = Schema.Struct({
+  title: Schema.optionalWith(Schema.String, {
+    default: () => "Blog"
+  }).annotations({
+    description: "The title of the blog"
+  }),
+  enableRSS: Schema.optionalWith(Schema.Boolean, {
+    default: () => true
+  }).annotations({
+    description: "Enable RSS feed"
+  }),
+  route: Schema.optionalWith(Schema.String, {
+    default: () => "/blog"
+  }).annotations({
+    description: "The route for the blog",
+    examples: ["/blog", "/news", "/articles"]
+  })
+}).annotations({
+  description: "The configuration for the blog"
+});
+const FrontEndConfigSchema = Schema.Struct({
+  htmlDefaultLanguage: Schema.optionalWith(Schema.String, {
+    default: () => "en"
+  }).annotations({
+    description: "The default language for the HTML tag"
+  }),
+  htmlDefaultHead: HeadConfigSchema.fields.head.annotations({
+    description: "The default head configuration for the Frontend"
+  }),
+  favicon: Schema.optionalWith(FaviconSchema, {
+    default: () => "/favicon.svg"
+  }).annotations({
+    description: "The default favicon configuration for the Frontend"
+  }),
+  sitemap: Schema.optionalWith(Schema.Boolean, {
+    default: () => true
+  }).annotations({
+    description: "Enable sitemap generation"
+  }),
+  injectRoutes: Schema.optionalWith(Schema.Boolean, {
+    default: () => true
+  }).annotations({
+    description: "Inject routes"
+  }),
+  blog: Schema.optionalWith(FrontEndBlogSchema, {
+    default: () => FrontEndBlogSchema.make({})
+  }).annotations({
+    description: "The configuration for the blog"
+  })
+});
 export {
+  FaviconSchema,
+  FrontEndBlogSchema,
   FrontEndConfigSchema,
   faviconTypeMap,
   isFaviconExt

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/blog",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Add a blog to your StudioCMS project with ease!",
   "author": {
     "name": "withstudiocms",
@@ -60,11 +60,11 @@
     "@types/node": "^22.0.0",
     "astro": "^5.12.9",
     "vite": "^6.3.4",
-    "@studiocms/md": "^0.2.0",
-    "studiocms": "^0.2.0"
+    "@studiocms/md": "^0.3.0",
+    "studiocms": "^0.4.0"
   },
   "peerDependencies": {
-    "effect": "^3.19.14"
+    "effect": "^3.19.19"
   },
   "scripts": {
     "build": "buildkit build 'src/**/*.{ts,astro,css,json,png,d.ts}'",