@merkur/core 0.45.0 → 0.46.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@merkur/core",
-  "version": "0.45.0",
+  "version": "0.46.0-rc.0",
   "description": "Merkur is tiny and extensible library for creating front-end microservices.",
   "main": "lib/index",
   "module": "lib/index",
@@ -53,5 +53,5 @@
     "access": "public"
   },
   "homepage": "https://merkur.js.org/",
-  "gitHead": "733c19257814dcdc584cb5e7453c28d6fd24fa82"
+  "gitHead": "737814ec3ae39a32c8551196aed5be7925f1a1e1"
 }

package/types.d.ts

@@ -13,34 +13,39 @@ export interface SourceAsset extends BaseWidgetAsset {
   source: string;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface WidgetDependencies {}
 
-export interface Widget {
-  name: string;
-  version: string;
-  containerSelector?: string;
-  $in: WidgetInternal;
-  $external: WidgetExternal;
-  $dependencies: WidgetDependencies;
-  $plugins: WidgetPlugin[];
-}
-
 export interface WidgetProperties {
   name: string;
   version: string;
 }
 
+// Type for the widget config object passed to `defineWidget()`
 export interface WidgetDefinition {
-  assets: (WidgetAsset | SourceAsset)[];
+  name: string;
+  version: string;
+  containerSelector?: string;
+  assets?: (WidgetAsset | SourceAsset)[];
+  $external?: WidgetExternal;
+  $dependencies?: WidgetDependencies;
   $plugins?: Array<() => WidgetPlugin>;
-  $external: WidgetExternal;
-  $dependencies: WidgetDependencies;
   create?: WidgetFunction;
   setup?: WidgetFunction;
 }
 
+// Type used during initialization within `createMerkurWidget()`
+// it initializes some properties (= they're not optional anymore)
+
+export interface WidgetPartial extends WidgetDefinition, Required<Pick<WidgetDefinition, '$dependencies' | '$external' | 'create' | 'setup'>> {
+  $in: WidgetInternal;
+  slot: Record<any, any>; // @merkur/core knows (incorrectly?) about slot and initializes it to an empty object.
+}
+
 export interface WidgetParams {}
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface WidgetInternal {}
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface WidgetExternal {}
 
 export interface WidgetPlugin {
@@ -49,13 +54,9 @@ export interface WidgetPlugin {
 }
 
 export type WidgetFunction = (
-  widget: Partial<Widget>,
+  widget: WidgetPartial,
   ...rest: unknown[]
-) => Promise<Partial<Widget>> | Partial<Widget>;
-
-export type MerkurCreate = (
-  widgetProperties: WidgetProperties,
-) => Promise<Widget>;
+) => Promise<WidgetPartial> | WidgetPartial;
 
 export type WidgetCreate = (widgetParams: WidgetParams) => Promise<Widget>;
 
@@ -81,11 +82,26 @@ export interface Merkur {
 /**
  * Merkur API types
  */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface CreateMerkurWidgetArgs {}
 export declare function createMerkurWidget<
   T extends WidgetDefinition & CreateMerkurWidgetArgs,
 >(widgetDefinition: T): Widget;
 
+// `createMerkurWidget()` binds all WidgetFunctions to the widget instance using `bindWidgetToFunctions()`
+// This series of types replicates that for the typing. 
+type TupleTail<T extends any[]> = T extends [any, ...infer Rest] ? Rest : never;
+type FunctionLike = (...args: any[]) => any;
+type BoundWidgetFunction<T extends FunctionLike> = (...args: TupleTail<Parameters<T>>) => ReturnType<T>;
+type BoundWidget<T> = {
+  [K in keyof T]: T[K] extends FunctionLike ? BoundWidgetFunction<T[K]> : T[K];
+}
+export interface Widget extends BoundWidget<WidgetPartial> {}
+
+export type MerkurCreate = (
+  widgetProperties: WidgetProperties,
+) => Promise<Widget>;
+
 export interface DefineWidgetArgs {}
 export declare function defineWidget<
   T extends WidgetDefinition & WidgetProperties & DefineWidgetArgs,
@@ -97,3 +113,28 @@ export declare function hookMethod(
   path: string,
   handler: (widget: Widget, originalFunction: any, ...args: any[]) => any,
 ): Promise<void>;
+
+export declare function assignMissingKeys<T extends object>(
+  target: T,
+  ...sources: Partial<T>[]
+): T;
+
+export declare function setDefaultValueForUndefined<T extends object>(
+  object: T,
+  keys: (keyof T)[],
+  value?: any,
+): T;
+
+export declare function bindWidgetToFunctions(
+  widget: Widget,
+  target?: any,
+): void;
+
+export declare function isFunction(
+  value: any,
+): value is (...args: any[]) => any;
+
+export declare function isUndefined(value: any): value is undefined;
+
+export declare function getMerkur(): Merkur;
+export declare function removeMerkur(): void;