@studiocms/markdoc 0.1.0-beta.26 → 0.1.0-beta.28

package/README.md

@@ -1,5 +1,7 @@
 # @StudioCMS/MarkDoc Plugin
 
+[![codecov](https://codecov.io/github/withstudiocms/studiocms/graph/badge.svg?token=RN8LT1O5E2&component=studiocms_markdoc)](https://codecov.io/github/withstudiocms/studiocms)
+
 Add MarkDoc support to StudioCMS
 
 ## Usage

package/dist/components/render.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The Markdoc renderer configuration for StudioCMS.
+ *
+ * This renderer is responsible for handling Markdoc content within StudioCMS,
+ * utilizing shared configuration options for sanitization and rendering.
+ */
+declare const renderer: {
+    name: string;
+    renderer: typeof import("../lib/render").renderMarkDoc;
+};
+export default renderer;

package/dist/components/render.js

@@ -0,0 +1,9 @@
+import renderMarkDoc from "studiocms:markdoc/renderer";
+const renderer = {
+  name: "@studiocms/markdoc",
+  renderer: renderMarkDoc
+};
+var render_default = renderer;
+export {
+  render_default as default
+};

package/dist/index.d.ts

@@ -4,7 +4,17 @@
  * directives must be first at the top of the file and can only be preceded by this comment.
  */
 /// <reference types="./virtual.d.ts" preserve="true" />
+import type { AstroIntegration } from 'astro';
 import { type StudioCMSPlugin } from 'studiocms/plugins';
 import type { MarkDocPluginOptions } from './types.js';
+/**
+ * Creates an internal Astro integration for MarkDoc rendering.
+ * This is used for testing and internal purposes.
+ *
+ * @param {string} packageIdentifier - The package identifier for the integration.
+ * @param {MarkDocPluginOptions} [options] - Optional configuration options for the MarkDoc plugin.
+ * @returns {AstroIntegration} The configured Astro integration.
+ */
+export declare function internalMarkDocIntegration(packageIdentifier: string, options?: MarkDocPluginOptions): AstroIntegration;
 export declare function studiocmsMarkDoc(options?: MarkDocPluginOptions): StudioCMSPlugin;
 export default studiocmsMarkDoc;

package/dist/index.js

@@ -1,12 +1,41 @@
 import { addVirtualImports, createResolver } from "astro-integration-kit";
 import { definePlugin } from "studiocms/plugins";
 import { shared } from "./lib/shared.js";
+function internalMarkDocIntegration(packageIdentifier, options) {
+  const { resolve } = createResolver(import.meta.url);
+  const internalRenderer = resolve("./lib/render.js");
+  const resolvedOptions = {
+    type: options?.type || "html",
+    argParse: options?.argParse,
+    transformConfig: options?.transformConfig
+  };
+  return {
+    name: packageIdentifier,
+    hooks: {
+      "astro:config:setup": (params) => {
+        addVirtualImports(params, {
+          name: packageIdentifier,
+          imports: {
+            "studiocms:markdoc/renderer": `
+							import { renderMarkDoc as _render } from '${internalRenderer}';
+		
+							export const renderMarkDoc = _render;
+							export default renderMarkDoc;
+						`
+          }
+        });
+      },
+      "astro:config:done": () => {
+        shared.markDocConfig = resolvedOptions;
+      }
+    }
+  };
+}
 function studiocmsMarkDoc(options) {
   const { resolve } = createResolver(import.meta.url);
   const packageIdentifier = "@studiocms/markdoc";
-  const renderer = resolve("./components/MarkDocRenderer.astro");
+  const renderer = resolve("./components/render.js");
   const editor = resolve("./components/editor.astro");
-  const internalRenderer = resolve("./lib/render.js");
   const resolvedOptions = {
     type: options?.type || "html",
     argParse: options?.argParse,
@@ -19,26 +48,7 @@ function studiocmsMarkDoc(options) {
     requires: ["@studiocms/md"],
     hooks: {
       "studiocms:astro:config": ({ addIntegrations }) => {
-        addIntegrations({
-          name: packageIdentifier,
-          hooks: {
-            "astro:config:setup": (params) => {
-              addVirtualImports(params, {
-                name: packageIdentifier,
-                imports: {
-                  "studiocms:markdoc/renderer": `
-										import { renderMarkDoc as _render } from '${internalRenderer}';
-										export const renderMarkDoc = _render;
-										export default renderMarkDoc;
-									`
-                }
-              });
-            },
-            "astro:config:done": () => {
-              shared.markDocConfig = resolvedOptions;
-            }
-          }
-        });
+        addIntegrations(internalMarkDocIntegration(packageIdentifier, resolvedOptions));
       },
       "studiocms:config:setup": ({ setRendering }) => {
         setRendering({
@@ -59,5 +69,6 @@ function studiocmsMarkDoc(options) {
 var index_default = studiocmsMarkDoc;
 export {
   index_default as default,
+  internalMarkDocIntegration,
   studiocmsMarkDoc
 };

package/dist/lib/render.js

@@ -1,6 +1,5 @@
 import Markdoc from "@markdoc/markdoc";
 import { shared } from "./shared.js";
-const { argParse, transformConfig, type } = shared.markDocConfig;
 const renderHTML = {
   name: "html",
   render: async (content) => {
@@ -14,27 +13,17 @@ const renderReactStatic = {
   }
 };
 async function renderMarkDoc(content) {
+  const { argParse, transformConfig, type } = shared.markDocConfig;
   const ast = Markdoc.parse(content, argParse);
   const MarkDocContent = Markdoc.transform(ast, transformConfig);
   switch (type) {
-    case "html": {
-      const data = await renderHTML.render(MarkDocContent);
-      return data;
-    }
     case "react-static": {
       const data = await renderReactStatic.render(MarkDocContent);
       return data;
     }
     default: {
-      if (!type) {
-        throw new Error("Error in MarkDoc config, renderer not found.");
-      }
-      try {
-        const data = await type.render(MarkDocContent);
-        return data;
-      } catch {
-        throw new Error(`Error in MarkDoc renderer, Unable to render with ${type.name}`);
-      }
+      const data = await renderHTML.render(MarkDocContent);
+      return data;
     }
   }
 }

package/dist/lib/shared.d.ts

@@ -5,7 +5,7 @@ export declare const symbol: symbol;
  * initialized as a new object with a `markDocConfig` property.
  *
  * @remarks
- * The `@ts-ignore` comments are used to suppress TypeScript errors related to the use of
+ * The `@ts-expect-error` comments are used to suppress TypeScript errors related to the use of
  * the global scope and assignment within expressions. The `biome-ignore` comment is used
  * to suppress linting errors for the same reason.
  */

package/dist/lib/shared.js

@@ -1,8 +1,7 @@
 const symbol = Symbol.for("@studiocms/markdoc");
 const shared = (
-  // @ts-ignore
-  globalThis[symbol] || // @ts-ignore
-  // biome-ignore lint/suspicious/noAssignInExpressions: This is a valid use case for assignment in expressions.
+  // @ts-expect-error
+  globalThis[symbol] || // @ts-expect-error
   (globalThis[symbol] = {
     markDocConfig: {}
   })

package/dist/types.d.ts

@@ -4,7 +4,7 @@ export interface MarkDocRenderer {
     render: (content: RenderableTreeNode) => Promise<string>;
 }
 export interface MarkDocPluginOptions {
-    type?: 'html' | 'react-static' | MarkDocRenderer;
+    type?: 'html' | 'react-static';
     argParse?: ParserArgs | undefined;
     transformConfig?: ConfigType | undefined;
 }

package/dist/virtual.d.ts

@@ -4,5 +4,5 @@ declare module 'studiocms:markdoc/renderer' {
 }
 
 declare module 'virtual:studiocms/plugins/renderers' {
-	export const studiocms_markdoc: typeof import('./components/MarkDocRenderer.astro').default;
+	export const studiocms_markdoc: typeof import('./components/render.js').default;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/markdoc",
-  "version": "0.1.0-beta.26",
+  "version": "0.1.0-beta.28",
   "description": "Add MarkDoc Support to your StudioCMS project with ease!",
   "author": {
     "name": "withstudiocms",
@@ -51,40 +51,31 @@
     "./v/types": {
       "types": "./dist/virtual.d.ts",
       "default": "./dist/virtual.d.js"
-    },
-    "./react": {
-      "types": "./dist/react-renderer/renderReact.d.ts",
-      "default": "./dist/react-renderer/renderReact.js"
     }
   },
   "type": "module",
   "dependencies": {
     "@markdoc/markdoc": "^0.5.4",
-    "astro-integration-kit": "^0.19.0",
-    "react": "^19.1.1",
-    "react-dom": "^19.1.1"
+    "astro-integration-kit": "^0.19.1",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
-    "@types/react": "^19.1.12",
-    "@types/react-dom": "^19.1.9"
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2"
   },
   "peerDependencies": {
-    "@astrojs/react": "^4.3.0",
     "astro": "^5.12.9",
-    "effect": "^3.17.13",
+    "effect": "^3.18.4",
     "vite": "^6.3.4",
-    "@studiocms/md": "0.1.0-beta.26",
-    "studiocms": "0.1.0-beta.26"
-  },
-  "peerDependenciesMeta": {
-    "@astrojs/react": {
-      "optional": true
-    }
+    "@studiocms/md": "0.1.0-beta.28",
+    "studiocms": "0.1.0-beta.28"
   },
   "scripts": {
     "build": "buildkit build 'src/**/*.{ts,astro,css,json,png,d.ts}'",
     "dev": "buildkit dev 'src/**/*.{ts,astro,css,json,png,d.ts}'",
+    "test": "vitest",
     "typecheck": "tspc -p tsconfig.tspc.json"
   }
 }

package/dist/components/MarkDocRenderer.astro

@@ -1,15 +0,0 @@
----
-import renderMarkDoc from 'studiocms:markdoc/renderer';
-import type { PluginPageTypeRendererProps } from 'studiocms/types';
-
-interface Props extends PluginPageTypeRendererProps {}
-
-// Get default content
-const { defaultContent } = Astro.props.data;
-
-// Get content to render
-const contentToRender = defaultContent?.content || '# Error: No content found';
-
-const renderedContent = await renderMarkDoc(contentToRender);
----
-<Fragment set:html={renderedContent} />

package/dist/react-renderer/MarkDocReactRenderer.d.ts

@@ -1,8 +0,0 @@
-import type React from 'react';
-/**
- * React component for rendering generated MarkDoc React content within StudioCMS using the Astro Container API
- */
-export declare function MarkDocReactRenderer({ children }: {
-    children: React.ReactNode;
-}): React.JSX.Element;
-export default MarkDocReactRenderer;

package/dist/react-renderer/ReactWrapper.astro

@@ -1,13 +0,0 @@
----
-import React from 'react';
-import { MarkDocReactRenderer } from './MarkDocReactRenderer.jsx';
-
-interface Props {
-	content: React.ReactNode;
-}
-
-const { content } = Astro.props;
----
-<MarkDocReactRenderer client:load>
-	{content}
-</MarkDocReactRenderer>

package/dist/react-renderer/renderReact.d.ts

@@ -1,10 +0,0 @@
-import type { MarkDocRenderer } from '../types.js';
-/**
- * MarkDoc React Components
- *
- * The React components to use for rendering the content
- *
- * @type {Object} - The React components to use for rendering the content
- */
-export type markdocReactComponents = {} | undefined;
-export declare const renderReact: (components?: markdocReactComponents) => MarkDocRenderer;

package/dist/react-renderer/renderReact.js

@@ -1,30 +0,0 @@
-import reactRenderer from "@astrojs/react/server.js";
-import Markdoc from "@markdoc/markdoc";
-import { experimental_AstroContainer } from "astro/container";
-import * as React from "react";
-import ReactWrapper from "./ReactWrapper.astro";
-const renderReact = (components) => ({
-  name: "react",
-  render: async (content) => {
-    const container = await experimental_AstroContainer.create();
-    container.addServerRenderer({
-      name: "@astrojs/react",
-      renderer: reactRenderer
-    });
-    container.addClientRenderer({
-      name: "@astrojs/react",
-      entrypoint: "@astrojs/react/client.js"
-    });
-    const renderedContent = await container.renderToString(ReactWrapper, {
-      props: {
-        content: Markdoc.renderers.react(content, React, {
-          components
-        })
-      }
-    });
-    return renderedContent;
-  }
-});
-export {
-  renderReact
-};