cleanup, but no fix :(

Author: forman

chartlets.js/packages/lib/src/actions/configureFramework.test.tsx

@@ -2,11 +2,11 @@ import type { FC } from "react";
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { configureFramework, resolvePlugin } from "./configureFramework";
 import { store } from "@/store";
-import { type ComponentRegistration, registry } from "@/components/registry";
+import { registry } from "@/components/registry";
 import type { HostStore } from "@/types/state/host";
-import type { Plugin } from "@/types/state/plugin";
+import type { RegistrableComponent, Plugin } from "@/types/state/plugin";
 
-function getComponents(): [string, ComponentRegistration][] {
+function getComponents(): [string, RegistrableComponent][] {
   interface DivProps {
     text: string;
   }

chartlets.js/packages/lib/src/components/Children.test.tsx

@@ -2,7 +2,6 @@ import type { FC } from "react";
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { render, screen } from "@testing-library/react";
 import { registry } from "@/components/registry";
-import { type ComponentProps } from "./Component";
 import { Children } from "./Children";
 
 describe("Children", () => {
@@ -33,7 +32,7 @@ describe("Children", () => {
   });
 
   it("should render all child types", () => {
-    interface DivProps extends ComponentProps {
+    interface DivProps {
       text: string;
     }
     const Div: FC<DivProps> = ({ text }) => <div>{text}</div>;

chartlets.js/packages/lib/src/components/Component.test.tsx

@@ -1,6 +1,6 @@
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { render, screen } from "@testing-library/react";
-import { Component, type ComponentProps } from "./Component";
+import { Component } from "./Component";
 import { registry } from "@/components/registry";
 import type { FC } from "react";
 
@@ -27,7 +27,7 @@ describe("Component", () => {
   });
 
   it("should render a known component", () => {
-    interface DivProps extends ComponentProps {
+    interface DivProps {
       text: string;
     }
     const Div: FC<DivProps> = ({ text }) => <div>{text}</div>;

chartlets.js/packages/lib/src/components/Component.tsx

@@ -1,12 +1,7 @@
 import { type FC } from "react";
-import { type ComponentChangeHandler } from "@/types/state/event";
 import { isString } from "@/utils/isString";
 import { registry } from "@/components/registry";
-
-export interface ComponentProps {
-  type: string;
-  onChange: ComponentChangeHandler;
-}
+import type { ComponentProps } from "@/types/state/plugin";
 
 export const Component: FC<ComponentProps> = (props: ComponentProps) => {
   const ActualComponent = isString(props.type) && registry.lookup(props.type);

chartlets.js/packages/lib/src/components/registry.ts

@@ -1,10 +1,4 @@
-import type { ComponentType } from "react";
-
-import type { ComponentProps } from "@/components/Component";
-
-export type ComponentRegistration =
-  | ComponentType<Record<string, unknown>>
-  | ComponentType<ComponentProps>;
+import type { RegistrableComponent } from "@/types/state/plugin";
 
 /**
  * A registry for Chartlets components.
@@ -29,14 +23,14 @@ export interface Registry {
    * @param type The Chartlets component's unique type name.
    * @param component A functional React component.
    */
-  register(type: string, component: ComponentRegistration): () => void;
+  register(type: string, component: RegistrableComponent): () => void;
 
   /**
    * Lookup the component of the provided type.
    *
    * @param type The Chartlets component's type name.
    */
-  lookup(type: string): ComponentRegistration | undefined;
+  lookup(type: string): RegistrableComponent | undefined;
 
   /**
    * Clears the registry.
@@ -52,9 +46,9 @@ export interface Registry {
 
 // export for testing only
 export class RegistryImpl implements Registry {
-  private components = new Map<string, ComponentRegistration>();
+  private components = new Map<string, RegistrableComponent>();
 
-  register(type: string, component: ComponentRegistration): () => void {
+  register(type: string, component: RegistrableComponent): () => void {
     const oldComponent = this.components.get(type);
     this.components.set(type, component);
     return () => {
@@ -66,7 +60,7 @@ export class RegistryImpl implements Registry {
     };
   }
 
-  lookup(type: string): ComponentRegistration | undefined {
+  lookup(type: string): RegistrableComponent | undefined {
     return this.components.get(type);
   }
 

chartlets.js/packages/lib/src/index.ts

@@ -14,7 +14,7 @@ export { handleComponentChange } from "@/actions/handleComponentChange";
 export { updateContributionContainer } from "@/actions/updateContributionContainer";
 
 // React components
-export { Component, type ComponentProps } from "@/components/Component";
+export { Component } from "@/components/Component";
 export { Children, type ChildrenProps } from "@/components/Children";
 
 // React hooks
@@ -30,5 +30,5 @@ export {
 
 // Application interface
 export type { HostStore, MutableHostStore } from "@/types/state/host";
-export type { Plugin, PluginLike } from "@/types/state/plugin";
+export type { ComponentProps, Plugin, PluginLike } from "@/types/state/plugin";
 export type { FrameworkOptions } from "@/types/state/options";

chartlets.js/packages/lib/src/types/state/plugin.ts

@@ -1,14 +1,27 @@
 import type { ComponentType } from "react";
-import type { ComponentProps } from "@/components/Component";
+
+import type { ComponentChangeHandler } from "@/types/state/event";
+
+/**
+ * Properties that custom components must support.
+ */
+export interface ComponentProps {
+  type: string;
+  onChange: ComponentChangeHandler;
+}
+
+/**
+ * A component type that is eligible for registration.
+ */
+export type RegistrableComponent =
+  | ComponentType<object>
+  | ComponentType<ComponentProps>;
 
 /**
  * A component registration - a pair comprising the component type name
  * and the React component.
  */
-export type ComponentRegistration = [
-  string,
-  ComponentType<ComponentProps> | ComponentType,
-];
+export type ComponentRegistration = [string, RegistrableComponent];
 
 /**
  * A framework plugin.