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

package/README.md

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

package/dist/components/render.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The HTML renderer configuration for StudioCMS.
+ *
+ * This renderer is responsible for handling HTML content within StudioCMS,
+ * utilizing shared configuration options for sanitization and rendering.
+ *
+ * (StudioCMS can technically already render HTML out of the box,
+ * but will error without any renderer configured for HTML content types.)
+ */
+declare const renderer: {
+    name: 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;
+};
+export default renderer;

package/dist/components/render.js

@@ -0,0 +1,9 @@
+import { shared } from "../lib/shared.js";
+const renderer = {
+  name: "@studiocms/html",
+  sanitizeOpts: shared.htmlConfig?.sanitize
+};
+var render_default = renderer;
+export {
+  render_default as default
+};

package/dist/index.js

@@ -33,7 +33,7 @@ function studiocmsHTML(options) {
               identifier: "studiocms/html",
               label: "HTML",
               pageContentComponent: resolve("./components/editor.astro"),
-              rendererComponent: resolve("./components/renderer.astro")
+              rendererComponent: resolve("./components/render.js")
             }
           ]
         });

package/dist/lib/shared.d.ts

@@ -5,7 +5,7 @@ export declare const symbol: symbol;
  * initialized as a new object with a `htmlConfig` 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/html");
 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] = {
     htmlConfig: void 0
   })

package/dist/virtual.d.ts

@@ -1,3 +1,3 @@
 declare module 'virtual:studiocms/plugins/renderers' {
-	export const studiocms_html: typeof import('./components/renderer.astro').default;
+	export const studiocms_html: typeof import('./components/render.js').default;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/html",
-  "version": "0.1.0-beta.26",
+  "version": "0.1.0-beta.28",
   "description": "Add HTML Support to your StudioCMS project with ease!",
   "author": {
     "name": "withstudiocms",
@@ -53,14 +53,17 @@
       "default": "./dist/virtual.d.js"
     },
     "./editor": "./dist/components/editor.astro",
-    "./renderer": "./dist/components/renderer.astro"
+    "./renderer": {
+      "types": "./dist/components/render.d.ts",
+      "default": "./dist/components/render.js"
+    }
   },
   "type": "module",
   "dependencies": {
-    "astro-integration-kit": "^0.19.0",
+    "astro-integration-kit": "^0.19.1",
     "codemirror": "5.65.19",
-    "katex": "^0.16.22",
-    "suneditor": "^2.47.7"
+    "katex": "^0.16.25",
+    "suneditor": "^2.47.8"
   },
   "devDependencies": {
     "@types/codemirror": "5.60.16",
@@ -68,13 +71,14 @@
   },
   "peerDependencies": {
     "astro": "^5.12.9",
-    "effect": "^3.17.13",
+    "effect": "^3.18.4",
     "vite": "^6.3.4",
-    "studiocms": "0.1.0-beta.26"
+    "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/renderer.astro

@@ -1,25 +0,0 @@
----
-import { createRenderer } from 'studiocms:component-registry/runtime';
-import type { SSRResult } from 'astro';
-import type { PluginPageTypeRendererProps } from 'studiocms/types';
-import { shared } from '../lib/shared.js';
-
-// @ts-expect-error - $$result is a global variable injected by Astro during compilation and not a editor-known variable
-const ssrResult: SSRResult = $$result;
-
-// Define render function
-const render = await createRenderer(ssrResult, shared.htmlConfig?.sanitize);
-
-interface Props extends PluginPageTypeRendererProps {}
-
-// Get default content
-const { defaultContent } = Astro.props.data;
-
-// Get content to render
-const contentToRender = defaultContent?.content || '<h1>Error: No content found</h1>';
-
-// Render content
-const renderedContent = await render(contentToRender);
----
-
-<Fragment set:html={renderedContent} />