@withstudiocms/component-registry 0.1.0-beta.6 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @withstudiocms/component-registry
 
+## 0.1.0
+
+### Patch Changes
+
+- [#1157](https://github.com/withstudiocms/studiocms/pull/1157) [`f8a2d34`](https://github.com/withstudiocms/studiocms/commit/f8a2d342cc3c35bf4478bb523bf28d78dd2d0404) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Add effect-language-service diagnostics scripts to all workspace packages
+
+- [#1165](https://github.com/withstudiocms/studiocms/pull/1165) [`9007ca5`](https://github.com/withstudiocms/studiocms/commit/9007ca5d8d6c471ee25f07bd2f0a101ba195440c) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Tweaks `transformHTML` sanitization so StudioCMS components and custom elements are always passed through (caller-provided `sanitizeOpts` cannot disable `allowComponents`/`allowCustomElements`).
+
+- [#1101](https://github.com/withstudiocms/studiocms/pull/1101) [`8f53993`](https://github.com/withstudiocms/studiocms/commit/8f539933716b9d3335a13c180e3c607e44a63f8a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Introduces new transformer option in component registry and creates new StorageAPI transformer to allow Storage API automatic url swapping
+
+- [#1160](https://github.com/withstudiocms/studiocms/pull/1160) [`30de271`](https://github.com/withstudiocms/studiocms/commit/30de271f347a3a997669c8118006143148efb33a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Refactors code to handle Effect LSP diagnostic warnings and errors
+
+- Updated dependencies [[`87d36ba`](https://github.com/withstudiocms/studiocms/commit/87d36ba83d24d83c7b2b17daa47231a63c225fa2), [`f8a2d34`](https://github.com/withstudiocms/studiocms/commit/f8a2d342cc3c35bf4478bb523bf28d78dd2d0404), [`cb8ffda`](https://github.com/withstudiocms/studiocms/commit/cb8ffda2d6fb31e3a754996b3e938a5c1b643af1), [`30de271`](https://github.com/withstudiocms/studiocms/commit/30de271f347a3a997669c8118006143148efb33a)]:
+  - @withstudiocms/effect@0.1.0
+
+## 0.1.0-beta.8
+
+### Patch Changes
+
+- [#1157](https://github.com/withstudiocms/studiocms/pull/1157) [`f8a2d34`](https://github.com/withstudiocms/studiocms/commit/f8a2d342cc3c35bf4478bb523bf28d78dd2d0404) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Add effect-language-service diagnostics scripts to all workspace packages
+
+- [#1101](https://github.com/withstudiocms/studiocms/pull/1101) [`8f53993`](https://github.com/withstudiocms/studiocms/commit/8f539933716b9d3335a13c180e3c607e44a63f8a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Introduces new transformer option in component registry and creates new StorageAPI transformer to allow Storage API automatic url swapping
+
+- [#1160](https://github.com/withstudiocms/studiocms/pull/1160) [`30de271`](https://github.com/withstudiocms/studiocms/commit/30de271f347a3a997669c8118006143148efb33a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Refactors code to handle Effect LSP diagnostic warnings and errors
+
+- Updated dependencies [[`8e50cd0`](https://github.com/withstudiocms/studiocms/commit/8e50cd0885fa1e4664d457ff3fe4fa77b344ecc4), [`87d36ba`](https://github.com/withstudiocms/studiocms/commit/87d36ba83d24d83c7b2b17daa47231a63c225fa2), [`f8a2d34`](https://github.com/withstudiocms/studiocms/commit/f8a2d342cc3c35bf4478bb523bf28d78dd2d0404), [`cb8ffda`](https://github.com/withstudiocms/studiocms/commit/cb8ffda2d6fb31e3a754996b3e938a5c1b643af1), [`30de271`](https://github.com/withstudiocms/studiocms/commit/30de271f347a3a997669c8118006143148efb33a)]:
+  - @withstudiocms/effect@0.1.0-beta.8
+
+## 0.1.0-beta.7
+
+### Patch Changes
+
+- [#1029](https://github.com/withstudiocms/studiocms/pull/1029) [`da369c7`](https://github.com/withstudiocms/studiocms/commit/da369c7bd8f40670cb56821d74686c79840f06e4) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Integrates new Kysely based SDK into StudioCMS
+
+- Updated dependencies [[`ee90810`](https://github.com/withstudiocms/studiocms/commit/ee9081053f808d4366a9c95e13539a5198b27bb5), [`a5b84c5`](https://github.com/withstudiocms/studiocms/commit/a5b84c52383bf299aa70c04b064850c7883b59b1), [`9a8bfed`](https://github.com/withstudiocms/studiocms/commit/9a8bfeda461dbc7e3188222db3adeffca1c29f6a), [`ba79740`](https://github.com/withstudiocms/studiocms/commit/ba797403563b8fbd381e0fc28f4ccba0ec6432a6), [`3c54788`](https://github.com/withstudiocms/studiocms/commit/3c54788df0bd548f1e3489b7c7334279ee85d5cb), [`1e1e6a1`](https://github.com/withstudiocms/studiocms/commit/1e1e6a1038de31bfe73070b4feb7163a3e7385a0), [`97c7847`](https://github.com/withstudiocms/studiocms/commit/97c7847c0cdd41998e0a6d8c61ab6f3c4ac4474e), [`675b7d5`](https://github.com/withstudiocms/studiocms/commit/675b7d5bbb2c40e6a204d3c7227812923e37289f)]:
+  - @withstudiocms/effect@0.1.0-beta.7
+
 ## 0.1.0-beta.6
 
 ### Patch Changes

package/dist/registry/Registry.js

@@ -33,7 +33,7 @@ class ComponentRegistry extends Effect.Service()("ComponentRegistry", {
     const _getComponentProps = Effect.fn(function* (componentName) {
       const component = components.get(componentName);
       if (!component) {
-        return yield* Effect.fail(new ComponentNotFoundError({ componentName }));
+        return yield* new ComponentNotFoundError({ componentName });
       }
       return component;
     });

package/dist/runtime.d.ts

@@ -1,5 +1,6 @@
 import { componentProps } from 'virtual:component-registry-internal-proxy';
 import type { SSRResult } from 'astro';
+import type { Transformer } from 'ultrahtml';
 import type { SanitizeOptions } from 'ultrahtml/transformers/sanitize';
 import type { ComponentRegistryEntry } from './types.js';
 export * from './utils.js';
@@ -31,4 +32,4 @@ export declare function setupRendererComponentProxy(result: SSRResult): Promise<
  * @param preRenderer - An optional function to preprocess the HTML content before rendering.
  * @returns A function that takes HTML content as input and returns the transformed HTML.
  */
-export declare function createRenderer(result: SSRResult, sanitizeOpts?: SanitizeOptions, preRenderer?: (content: string) => Promise<string>): Promise<(content: string) => Promise<string>>;
+export declare function createRenderer(result: SSRResult, sanitizeOpts?: SanitizeOptions, preRenderer?: (content: string) => Promise<string>, transformers?: Transformer[]): Promise<(content: string) => Promise<string>>;

package/dist/runtime.js

@@ -28,7 +28,7 @@ async function setupRendererComponentProxy(result) {
   const components = await getRendererComponents();
   return createComponentProxy(result, components);
 }
-async function createRenderer(result, sanitizeOpts, preRenderer) {
+async function createRenderer(result, sanitizeOpts, preRenderer, transformers) {
   const components = await setupRendererComponentProxy(result);
   return async (content) => {
     let html;
@@ -37,7 +37,7 @@ async function createRenderer(result, sanitizeOpts, preRenderer) {
     } else {
       html = content;
     }
-    return await transformHTML(html, components, sanitizeOpts);
+    return await transformHTML(html, components, sanitizeOpts, transformers);
   };
 }
 export {

package/dist/transform-html.d.ts

@@ -1,3 +1,4 @@
+import { type Transformer } from 'ultrahtml';
 import type { SanitizeOptions } from 'ultrahtml/transformers/sanitize';
 import type { ComponentType } from './types.js';
 /**
@@ -8,4 +9,4 @@ import type { ComponentType } from './types.js';
  * @param sanitizeOpts - Optional sanitization options to be applied to the HTML.
  * @returns A promise that resolves to the transformed HTML string.
  */
-export declare function transformHTML(html: string, components: ComponentType, sanitizeOpts?: SanitizeOptions): Promise<string>;
+export declare function transformHTML(html: string, components: ComponentType, sanitizeOpts?: SanitizeOptions, transformers?: Transformer[]): Promise<string>;

package/dist/transform-html.js

@@ -2,8 +2,16 @@ import { transform } from "ultrahtml";
 import sanitize from "ultrahtml/transformers/sanitize";
 import swap from "ultrahtml/transformers/swap";
 import { dedent } from "./utils.js";
-async function transformHTML(html, components, sanitizeOpts) {
-  return await transform(dedent(html), [sanitize(sanitizeOpts), swap(components)]);
+async function transformHTML(html, components, sanitizeOpts = {}, transformers) {
+  const allTransformers = [
+    // We enable allowComponents and allowCustomElements to ensure that custom components are not stripped out during sanitization.
+    // This is important because the swap transformer relies on these elements being present to perform the component swapping.
+    // Users can still control other aspects of sanitization via the sanitizeOpts parameter.
+    sanitize({ ...sanitizeOpts, allowComponents: true, allowCustomElements: true }),
+    swap(components),
+    ...transformers ?? []
+  ];
+  return await transform(dedent(html), allTransformers);
 }
 export {
   transformHTML

package/dist/utils.d.ts

@@ -1,5 +1,6 @@
 import { Effect } from '@withstudiocms/effect';
 import type { AstroIntegrationLogger } from 'astro';
+import { ComponentRegistryError } from './errors.js';
 /**
  * Options for configuring the logger.
  *
@@ -63,4 +64,4 @@ export declare function dedent(str: string): string;
  * const resolveEffect = resolver('/components');
  * const result = yield* resolveEffect((resolve) => resolve('Button'));
  */
-export declare const resolver: (base: string) => Effect.Effect<(fn: (resolve: (...path: Array<string>) => string) => string) => Effect.Effect<string, Error, never>, never, never>;
+export declare const resolver: (base: string) => Effect.Effect<(fn: (resolve: (...path: Array<string>) => string) => string) => Effect.Effect<string, ComponentRegistryError, never>, never, never>;

package/dist/utils.js

@@ -1,5 +1,6 @@
 import { Effect } from "@withstudiocms/effect";
 import { createResolver } from "astro-integration-kit";
+import { ComponentRegistryError } from "./errors.js";
 const integrationLogger = async (opts, message) => {
   const { logLevel, logger, verbose = false } = opts;
   switch (verbose) {
@@ -41,7 +42,7 @@ const resolver = Effect.fn(function* (base) {
       try: () => fn(_resolve),
       catch: (error) => {
         console.error("Error occurred while resolving component:", error);
-        return new Error("Failed to resolve component", { cause: error });
+        return new ComponentRegistryError({ message: "Failed to resolve component", cause: error });
       }
     })
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@withstudiocms/component-registry",
-  "version": "0.1.0-beta.6",
+  "version": "0.1.0",
   "description": "Component Registry Utilities for Astro",
   "license": "MIT",
   "author": {
@@ -72,7 +72,7 @@
     "astro-integration-kit": "^0.19.1",
     "ts-morph": "^27.0.2",
     "ultrahtml": "1.6.0",
-    "@withstudiocms/effect": "0.1.0-beta.6"
+    "@withstudiocms/effect": "0.1.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
@@ -85,6 +85,8 @@
     "build": "buildkit build 'src/**/*.{ts,d.ts}'",
     "dev": "buildkit dev 'src/**/*.{ts,d.ts}'",
     "test": "vitest",
+    "effect-check": "pnpm effect-language-service diagnostics --project tsconfig.tspc.json",
+    "ci:effect-check": "pnpm effect-check --format github-actions",
     "typecheck": "tspc -p tsconfig.tspc.json"
   }
 }