@merkur/plugin-component 0.45.0 → 0.46.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@merkur/plugin-component",
-  "version": "0.45.0",
+  "version": "0.46.0-rc.1",
   "description": "Merkur component plugin.",
   "main": "lib/index",
   "module": "lib/index",
@@ -61,10 +61,10 @@
   },
   "homepage": "https://merkur.js.org/",
   "devDependencies": {
-    "@merkur/core": "^0.45.0"
+    "@merkur/core": "0.46.0-rc.1"
   },
   "peerDependencies": {
     "@merkur/core": "*"
   },
-  "gitHead": "733c19257814dcdc584cb5e7453c28d6fd24fa82"
+  "gitHead": "a1bd899f564cab2204edd3e30edc40e1a81c3999"
 }

package/types.d.ts

@@ -1,7 +1,7 @@
-import { Widget } from '@merkur/core';
+import { type Widget, type WidgetFunction, type WidgetPartial, type WidgetPlugin } from '@merkur/core';
 
 export interface ViewType {
-  (widget: Widget): any;
+  (widget: WidgetPartial): any;
 }
 
 export type MapViewArgs = {
@@ -22,54 +22,15 @@ export type MapViewArgs = {
 
 export type SSRMountResult = {
   html: string;
-  slot: Record<string, { name: string; html: string, containerSelector?: string }>;
+  slot: Record<
+    string,
+    { name: string; html: string; containerSelector?: string }
+  >;
 };
 
 export interface WidgetState {}
 export interface WidgetProps {}
 
-declare module '@merkur/core' {
-  interface DefineWidgetArgs {
-    viewFactory: ViewFactory;
-  }
-
-  interface Widget {
-    container?: Element;
-    shouldHydrate: (viewArgs: MapViewArgs) => boolean;
-    mount: () => Promise<void | SSRMountResult>;
-    update: () => Promise<void>;
-    unmount: () => Promise<void>;
-    slot: Record<
-      string,
-      | {
-          name: string;
-          html: string;
-          containerSelector: string;
-          container?: Element;
-        }
-      | undefined
-    >;
-    state: WidgetState;
-    props: WidgetProps;
-  }
-
-  interface WidgetDefinition {
-    shouldHydrate: (widget: Widget, viewArgs: MapViewArgs) => boolean;
-    mount: (widget: Widget) => Promise<void | SSRMountResult>;
-    update: (widget: Widget) => Promise<void>;
-    unmount: (widget: Widget) => Promise<void>;
-  }
-  interface WidgetInternal {
-    component: {
-      lifeCycle: Record<string, function>;
-      isMounted: boolean;
-      isHydrated: boolean;
-      suspendedTasks: Array<function>;
-      resolvedViews: Map<ViewFactory, MapViewArgs[]>;
-    };
-  }
-}
-
 export interface SlotDefinition {
   name: string;
   View: ViewType;
@@ -91,19 +52,66 @@ export interface ViewFactoryResult {
 
 export interface ViewFactorySlotType {
   name: string;
-  containerSelector?: string, 
+  containerSelector?: string;
   View: ViewType;
 }
 
 export type ViewFactory = (widget: Widget) => Promise<ViewFactoryResult>;
-export type SlotFactory = (widget: Widget) => Promise<SlotDefinition>;
+export type SlotFactory = (widget: WidgetPartial) => Promise<SlotDefinition>;
 
 export declare function createSlotFactory(
-  creator: (widget: Widget) => SlotDefinition | Promise<SlotDefinition>,
+  creator: (widget: WidgetPartial) => SlotDefinition | Promise<SlotDefinition>,
 ): SlotFactory;
 
 export declare function createViewFactory(
-  creator: (widget: Widget) => ViewDefinition | Promise<ViewDefinition>,
+  creator: (widget: WidgetPartial) => ViewDefinition | Promise<ViewDefinition>,
 ): ViewFactory;
 
-export declare function componentPlugin();
+export declare function componentPlugin(): WidgetPlugin;
+
+
+declare module '@merkur/core' {
+  interface DefineWidgetArgs {
+    viewFactory: ViewFactory;
+  }
+
+  interface Widget {}
+
+  interface WidgetPlugin {}
+
+  interface WidgetDefinition {
+    bootstrap?: (widget: WidgetPartial) => void;
+    container?: Element;
+    info?: (widget: WidgetPartial) => Promise<void>;
+    mount?: (widget: WidgetPartial) => Promise<void | SSRMountResult>;
+    shouldHydrate?: (widget: WidgetPartial, viewArgs: MapViewArgs) => boolean;
+    update?: (widget: WidgetPartial) => Promise<void>;
+    unmount?: (widget: WidgetPartial) => Promise<void>;
+  }
+
+  interface WidgetPartial {
+    slot: Record<
+      string,
+      | {
+          name: string;
+          html: string;
+          containerSelector: string;
+          container?: Element;
+        }
+      | undefined
+    >;
+    state: WidgetState;
+    props: WidgetProps;
+    setState: (widget: WidgetPartial, newState: WidgetState) => void;
+    setProps: (widget: WidgetPartial, newProps: WidgetProps) => void;
+  }
+  interface WidgetInternal {
+    component: {
+      lifeCycle: Record<string, WidgetFunction>;
+      isMounted: boolean;
+      isHydrated: boolean;
+      suspendedTasks: Array<() => Promise<void>>;
+      resolvedViews: Map<ViewFactory, MapViewArgs[]>;
+    };
+  }
+}