@etrepum/lexical-builder-core 0.0.28-nightly.20240708.0 → 0.0.28

package/dist/definePlan.d.ts

@@ -5,7 +5,7 @@ import { AnyLexicalPlan, LexicalPlan, LexicalPlanConfig, NormalizedLexicalPlanAr
  * infer Config and Name in most cases, but you may want to use
  * {@link safeCast} for config if there are default fields or varying types.
  *
- * @param plan The LexicalPlan
+ * @param plan - The LexicalPlan
  * @returns The unmodified plan argument (this is only an inference helper)
  *
  * @example Basic example
@@ -42,7 +42,7 @@ export declare function definePlan<Config extends PlanConfigBase, Name extends s
  * plan.mergeConfig(plan, config) or {@link shallowMergeConfig} if
  * this is not directly implemented by the Plan.
  *
- * @param args A plan followed by one or more config partials for that plan
+ * @param args - A plan followed by one or more config partials for that plan
  * @returns [plan, config, ...configs]
  *
  * @example
@@ -112,8 +112,8 @@ export declare const OutputTypeId: unique symbol;
  * is to avoid a direct import dependency, so you would want to use a
  * type import or the import type (shown in below examples).
  *
- * @param name The plan's name
- * @param config An optional config override
+ * @param name - The plan's name
+ * @param config - An optional config override
  * @returns NormalizedPeerDependency
  *
  * @example
@@ -125,6 +125,7 @@ export declare const OutputTypeId: unique symbol;
  *     declarePeerDependency<typeof import("bar").BarPlan>("bar", {config: "bar"}),
  *   ],
  * });
+ * ```
  */
 export declare function declarePeerDependency<Plan extends AnyLexicalPlan = never>(name: Plan["name"], config?: Partial<LexicalPlanConfig<Plan>>): NormalizedPeerDependency<Plan>;
 //# sourceMappingURL=definePlan.d.ts.map

package/dist/definePlan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definePlan.d.ts","sourceRoot":"","sources":["../src/definePlan.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,iBAAiB,EACjB,6BAA6B,EAC7B,wBAAwB,EACxB,cAAc,EACd,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,UAAU,CACxB,MAAM,SAAS,cAAc,EAC7B,IAAI,SAAS,MAAM,EACnB,MAAM,EACN,IAAI,EAEJ,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAC5C,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAEzC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,UAAU,CACxB,MAAM,SAAS,cAAc,EAC7B,IAAI,SAAS,MAAM,EACnB,MAAM,EACN,IAAI,EAEJ,GAAG,IAAI,EAAE,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GACjE,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAE3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAClC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,IAAI,GACnB,eAAe,CAAC,MAAM,CAAC,CAEzB;AAED,gBAAgB;AAChB,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAExC,CAAC;AACF,eAAO,MAAM,YAAY,EAAE,OAAO,MAEjC,CAAC;AACF,eAAO,MAAM,YAAY,EAAE,OAAO,MAEjC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,SAAS,cAAc,GAAG,KAAK,EACvE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAClB,MAAM,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,GACxC,wBAAwB,CAAC,IAAI,CAAC,CAEhC"}
+{"version":3,"file":"definePlan.d.ts","sourceRoot":"","sources":["../src/definePlan.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,iBAAiB,EACjB,6BAA6B,EAC7B,wBAAwB,EACxB,cAAc,EACd,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,UAAU,CACxB,MAAM,SAAS,cAAc,EAC7B,IAAI,SAAS,MAAM,EACnB,MAAM,EACN,IAAI,EAEJ,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAC5C,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAEzC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,UAAU,CACxB,MAAM,SAAS,cAAc,EAC7B,IAAI,SAAS,MAAM,EACnB,MAAM,EACN,IAAI,EAEJ,GAAG,IAAI,EAAE,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GACjE,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAE3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAClC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,IAAI,GACnB,eAAe,CAAC,MAAM,CAAC,CAOzB;AAED,gBAAgB;AAChB,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAExC,CAAC;AACF,eAAO,MAAM,YAAY,EAAE,OAAO,MAEjC,CAAC;AACF,eAAO,MAAM,YAAY,EAAE,OAAO,MAEjC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,SAAS,cAAc,GAAG,KAAK,EACvE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAClB,MAAM,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,GACxC,wBAAwB,CAAC,IAAI,CAAC,CAEhC"}

package/dist/index.d.ts

@@ -7,7 +7,7 @@
  */
 export declare const PACKAGE_VERSION: string;
 export { configPlan, definePlan, provideOutput, declarePeerDependency, } from './definePlan';
-export { type AnyLexicalPlan, type AnyLexicalPlanArgument, type LexicalEditorWithDispose, type InitialEditorConfig, type InitialEditorStateType, type LexicalPlan, type LexicalPlanArgument, type LexicalPlanConfig, type LexicalPlanInit, type LexicalPlanName, type LexicalPlanOutput, type OutputComponentPlan, type LexicalPlanDependency, type NormalizedLexicalPlanArgument, type PlanConfigBase, type RegisterState, type RegisterCleanup, type NormalizedPeerDependency, } from './types';
+export { type AnyLexicalPlan, type AnyLexicalPlanArgument, type LexicalEditorWithDispose, type InitialEditorConfig, type InitialEditorStateType, type LexicalPlan, type LexicalPlanArgument, type LexicalPlanConfig, type LexicalPlanInit, type LexicalPlanName, type LexicalPlanOutput, type OutputComponentPlan, type LexicalPlanDependency, type PlanRegisterState as NormalizedLexicalPlanArgument, type PlanConfigBase, type PlanInitState, type PlanRegisterState, type RegisterCleanup, type NormalizedPeerDependency, } from './types';
 export { type LexicalPlanInternal, type initTypeSymbol, type configTypeSymbol, type outputTypeSymbol, } from './internal';
 export { safeCast } from './safeCast';
 export { shallowMergeConfig } from './shallowMergeConfig';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,eAAO,MAAM,eAAe,EAAE,MAAwC,CAAC;AAEvE,OAAO,EACL,UAAU,EACV,UAAU,EACV,aAAa,EACb,qBAAqB,GACtB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAClC,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,wBAAwB,GAC9B,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,eAAO,MAAM,eAAe,EAAE,MAAwC,CAAC;AAEvE,OAAO,EACL,UAAU,EACV,UAAU,EACV,aAAa,EACb,qBAAqB,GACtB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,IAAI,6BAA6B,EACvD,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,wBAAwB,GAC9B,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -5,15 +5,20 @@ function r(...n) {
   return n;
 }
 function f(n, t) {
-  return Object.assign(() => t && t(), { output: n });
+  return Object.assign(
+    () => {
+      t && t();
+    },
+    { output: n }
+  );
 }
 function c(n, t) {
   return [n, t];
 }
-function i(n) {
+function a(n) {
   return n;
 }
-function a(n, t) {
+function i(n, t) {
   if (!t || n === t)
     return n;
   for (const u in t)
@@ -21,13 +26,13 @@ function a(n, t) {
       return { ...n, ...t };
   return n;
 }
-const o = "0.0.28-nightly.20240708.0";
+const o = "0.0.28";
 export {
   o as PACKAGE_VERSION,
   r as configPlan,
   c as declarePeerDependency,
   e as definePlan,
   f as provideOutput,
-  i as safeCast,
-  a as shallowMergeConfig
+  a as safeCast,
+  i as shallowMergeConfig
 };

package/dist/internal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,oBAAoB,EAAE,OAAO,MAAM,CAAC;AACzD,gBAAgB;AAChB,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC;AAC/D,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,gBAAgB,EAAE,OAAO,MAAM,CAAC;AACrD,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC;AACvD,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,gBAAgB,EAAE,OAAO,MAAM,CAAC;AACrD,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC;AACvD,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,cAAc,EAAE,OAAO,MAAM,CAAC;AACnD,gBAAgB;AAChB,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC;AAEnD,gBAAgB;AAChB,MAAM,WAAW,mBAAmB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACnE,gBAAgB;IAChB,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC;IACrC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC;IACrC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC;CAClC"}
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AACA,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,oBAAoB,EAAE,OAAO,MAAM,CAAC;AACzD,gBAAgB;AAChB,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC;AAC/D,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,gBAAgB,EAAE,OAAO,MAAM,CAAC;AACrD,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC;AACvD,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,gBAAgB,EAAE,OAAO,MAAM,CAAC;AACrD,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC;AACvD,gBAAgB;AAChB,MAAM,CAAC,OAAO,CAAC,MAAM,cAAc,EAAE,OAAO,MAAM,CAAC;AACnD,gBAAgB;AAChB,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC;AAEnD,gBAAgB;AAChB,MAAM,WAAW,mBAAmB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACnE,gBAAgB;IAChB,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC;IACrC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC;IACrC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC;CAClC"}

package/dist/shallowMergeConfig.d.ts

@@ -3,8 +3,8 @@ import { PlanConfigBase } from './types';
 /**
  * The default merge strategy for plan configuration is a shallow merge.
  *
- * @param config A full config
- * @param overrides A partial config of overrides
+ * @param config - A full config
+ * @param overrides - A partial config of overrides
  * @returns config if there are no overrides, otherwise `{...config, ...overrides}`
  */
 export declare function shallowMergeConfig<T extends PlanConfigBase>(config: T, overrides?: Partial<T>): T;

package/dist/types.d.ts

@@ -20,50 +20,62 @@ export type NormalizedPeerDependency<Plan extends AnyLexicalPlan> = [
     readonly [peerDependencySymbol]: Plan;
 };
 /**
- * A tuple of [plan, configOverride, ...configOverrides]
+ * A tuple of [plan, ...configOverrides]
  */
-export type NormalizedLexicalPlanArgument<in out Config extends PlanConfigBase, out Name extends string, in out Output extends unknown, in out Init extends unknown> = [
-    LexicalPlan<Config, Name, Output, Init>,
-    Partial<Config>,
-    ...Partial<Config>[]
-];
+export type NormalizedLexicalPlanArgument<in out Config extends PlanConfigBase, out Name extends string, in out Output, in out Init> = [LexicalPlan<Config, Name, Output, Init>, ...Partial<Config>[]];
 /**
  * An object that the register method can use to detect unmount and access the
  * configuration for plan dependencies
  */
-export interface RegisterState<Init> {
+export interface PlanInitState {
     /** An AbortSignal that is aborted when the LexicalEditor is disposed */
     signal: AbortSignal;
     /**
      * Get the result of a peerDependency by name, if it exists
      * (must be a peerDependency of this plan)
      */
-    getPeer<Dependency extends AnyLexicalPlan = never>(name: Dependency["name"]): undefined | LexicalPlanDependency<Dependency>;
+    getPeer: <Dependency extends AnyLexicalPlan = never>(name: Dependency["name"]) => undefined | Omit<LexicalPlanDependency<Dependency>, "output">;
     /**
      * Get the configuration of a dependency by plan
      * (must be a direct dependency of this plan)
      */
-    getDependency<Dependency extends AnyLexicalPlan>(dep: Dependency): LexicalPlanDependency<Dependency>;
+    getDependency: <Dependency extends AnyLexicalPlan>(dep: Dependency) => Omit<LexicalPlanDependency<Dependency>, "output">;
     /**
      * Get the names of any direct dependents of this
      * Plan, typically only used for error messages.
      */
-    getDirectDependentNames(): string[];
+    getDirectDependentNames: () => ReadonlySet<string>;
     /**
      * Get the names of all peer dependencies of this
      * Plan, even if they do not exist in the builder,
      * typically only used for devtools.
      */
-    getPeerNameSet(): Set<string>;
+    getPeerNameSet: () => ReadonlySet<string>;
+}
+/**
+ * An object that the register method can use to detect unmount and access the
+ * configuration for plan dependencies
+ */
+export interface PlanRegisterState<Init> extends Omit<PlanInitState, "getPeer" | "getDependency"> {
+    /**
+     * Get the result of a peerDependency by name, if it exists
+     * (must be a peerDependency of this plan)
+     */
+    getPeer: <Dependency extends AnyLexicalPlan = never>(name: Dependency["name"]) => undefined | LexicalPlanDependency<Dependency>;
+    /**
+     * Get the configuration of a dependency by plan
+     * (must be a direct dependency of this plan)
+     */
+    getDependency: <Dependency extends AnyLexicalPlan>(dep: Dependency) => LexicalPlanDependency<Dependency>;
     /**
      * The result of the init function
      */
-    getInitResult(): Init;
+    getInitResult: () => Init;
 }
 /**
  * A {@link LexicalPlan} or {@link NormalizedLexicalPlanArgument} (plan with config overrides)
  */
-export type LexicalPlanArgument<Config extends PlanConfigBase, Name extends string, Output extends unknown, Init extends unknown> = LexicalPlan<Config, Name, Output, Init> | NormalizedLexicalPlanArgument<Config, Name, Output, Init>;
+export type LexicalPlanArgument<Config extends PlanConfigBase, Name extends string, Output, Init> = LexicalPlan<Config, Name, Output, Init> | NormalizedLexicalPlanArgument<Config, Name, Output, Init>;
 export interface LexicalPlanDependency<out Dependency extends AnyLexicalPlan> {
     config: LexicalPlanConfig<Dependency>;
     output: LexicalPlanOutput<Dependency>;
@@ -81,7 +93,7 @@ export type RegisterCleanup<Output> = (() => void) & (unknown extends Output ? {
  * A Plan may depend on other Plans, and provide functionality to other
  * plans through its config.
  */
-export interface LexicalPlan<in out Config extends PlanConfigBase, out Name extends string, in out Output extends unknown, in out Init extends unknown> extends InitialEditorConfig, LexicalPlanInternal<Config, Output, Init> {
+export interface LexicalPlan<in out Config extends PlanConfigBase, out Name extends string, in out Output, in out Init> extends InitialEditorConfig, LexicalPlanInternal<Config, Output, Init> {
     /** The name of the Plan, must be unique */
     readonly name: Name;
     /** Plan names that must not be loaded with this Plan */
@@ -120,8 +132,8 @@ export interface LexicalPlan<in out Config extends PlanConfigBase, out Name exte
      * });
      * ```
      *
-     * @param config The current configuration
-     * @param overrides The partial configuration to merge
+     * @param config - The current configuration
+     * @param overrides - The partial configuration to merge
      * @returns The merged configuration
      */
     mergeConfig?: (config: Config, overrides: Partial<Config>) => Config;
@@ -131,39 +143,39 @@ export interface LexicalPlan<in out Config extends PlanConfigBase, out Name exte
      * this plan have been merged. May be used validate the editor
      * configuration.
      *
-     * @param editorConfig The in-progress editor configuration (mutable)
-     * @param config The merged configuration specific to this plan (mutable)
-     * @param state An object containing an AbortSignal that can be
+     * @param editorConfig - The in-progress editor configuration (mutable)
+     * @param config - The merged configuration specific to this plan (mutable)
+     * @param state - An object containing an AbortSignal that can be
      *   used, and methods for accessing the merged configuration of
      *   dependencies and peerDependencies
      */
-    init?: (editorConfig: InitialEditorConfig, config: Config, state: RegisterState<never>) => Init;
+    init?: (editorConfig: InitialEditorConfig, config: Config, state: PlanInitState) => Init;
     /**
      * Add behavior to the editor (register transforms, listeners, etc.) after
      * the Editor is created, but before its initial state is set.
      * The register function may also mutate the config
      * in-place to expose data to other plans that use it as a dependency.
      *
-     * @param editor The editor this Plan is being registered with
-     * @param config The merged configuration specific to this Plan
-     * @param state An object containing an AbortSignal that can be
+     * @param editor - The editor this Plan is being registered with
+     * @param config - The merged configuration specific to this Plan
+     * @param state - An object containing an AbortSignal that can be
      *   used, and methods for accessing the merged configuration of
      *   dependencies and peerDependencies
      * @returns A clean-up function
      */
-    register?: (editor: LexicalEditor, config: Config, state: RegisterState<Init>) => RegisterCleanup<Output>;
+    register?: (editor: LexicalEditor, config: Config, state: PlanRegisterState<Init>) => RegisterCleanup<Output>;
     /**
      * Run any code that must happen after initialization of the
      * editor state (which happens after all register calls).
      *
-     * @param editor The editor this Plan is being registered with
-     * @param config The merged configuration specific to this Plan
-     * @param state An object containing an AbortSignal that can be
+     * @param editor - The editor this Plan is being registered with
+     * @param config - The merged configuration specific to this Plan
+     * @param state - An object containing an AbortSignal that can be
      *   used, and methods for accessing the merged configuration of
      *   dependencies and peerDependencies
      * @returns A clean-up function
      */
-    afterInitialization?: (editor: LexicalEditor, config: Config, state: RegisterState<Init>) => () => void;
+    afterInitialization?: (editor: LexicalEditor, config: Config, state: PlanRegisterState<Init>) => () => void;
 }
 /**
  * Extract the Config type from a Plan
@@ -243,8 +255,8 @@ export interface InitialEditorConfig {
      * reconciliation and call this. It defaults to
      * `(error) => { throw error }`.
      *
-     * @param error The Error object
-     * @param editor The editor that this error came from
+     * @param error - The Error object
+     * @param editor - The editor that this error came from
      */
     onError?: (error: Error, editor: LexicalEditor) => void;
     /**

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC5E,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACf,MAAM,YAAY,CAAC;AAEpB;;GAEG;AAEH,MAAM,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAChE;;GAEG;AAEH,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAChF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAElD,MAAM,MAAM,wBAAwB,CAAC,IAAI,SAAS,cAAc,IAAI;IAClE,IAAI,CAAC,MAAM,CAAC;IACZ,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS;CAC7C,GAAG;IAAE,QAAQ,CAAC,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,6BAA6B,CACvC,EAAE,CAAC,GAAG,CAAC,MAAM,SAAS,cAAc,EACpC,GAAG,CAAC,IAAI,SAAS,MAAM,EACvB,EAAE,CAAC,GAAG,CAAC,MAAM,SAAS,OAAO,EAC7B,EAAE,CAAC,GAAG,CAAC,IAAI,SAAS,OAAO,IACzB;IACF,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC;IACvC,OAAO,CAAC,MAAM,CAAC;IACf,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,IAAI;IACjC,wEAAwE;IACxE,MAAM,EAAE,WAAW,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,UAAU,SAAS,cAAc,GAAG,KAAK,EAC/C,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,GACvB,SAAS,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACjD;;;OAGG;IACH,aAAa,CAAC,UAAU,SAAS,cAAc,EAC7C,GAAG,EAAE,UAAU,GACd,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACrC;;;OAGG;IACH,uBAAuB,IAAI,MAAM,EAAE,CAAC;IACpC;;;;OAIG;IACH,cAAc,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B;;OAEG;IACH,aAAa,IAAI,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,MAAM,SAAS,cAAc,EAC7B,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,OAAO,EACtB,IAAI,SAAS,OAAO,IAElB,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GACvC,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAE9D,MAAM,WAAW,qBAAqB,CAAC,GAAG,CAAC,UAAU,SAAS,cAAc;IAC1E,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACtC,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;CACvC;AAED,MAAM,MAAM,eAAe,CAAC,MAAM,IAAI,CAAC,MAAM,IAAI,CAAC,GAChD,CAAC,OAAO,SAAS,MAAM,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEtE;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAC1B,EAAE,CAAC,GAAG,CAAC,MAAM,SAAS,cAAc,EACpC,GAAG,CAAC,IAAI,SAAS,MAAM,EACvB,EAAE,CAAC,GAAG,CAAC,MAAM,SAAS,OAAO,EAC7B,EAAE,CAAC,GAAG,CAAC,IAAI,SAAS,OAAO,CAC3B,SAAQ,mBAAmB,EACzB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;IAC3C,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,wDAAwD;IACxD,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,gFAAgF;IAChF,YAAY,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACxC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC,cAAc,CAAC,EAAE,CAAC;IAE9D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IACrE;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,CACL,YAAY,EAAE,mBAAmB,EACjC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,KACxB,IAAI,CAAC;IACV;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,CACT,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,KACvB,eAAe,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,EAAE,CACpB,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,KACvB,MAAM,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,cAAc,IAAI,WAAW,CACtE,IAAI,CAAC,gBAAgB,CAAC,CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,cAAc,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,cAAc,IAAI,WAAW,CACtE,IAAI,CAAC,gBAAgB,CAAC,CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,cAAc,IAAI,WAAW,CACpE,IAAI,CAAC,cAAc,CAAC,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,aAAa,IAAI,WAAW,CAC1D,GAAG,EACH,GAAG,EACH;IAAE,SAAS,EAAE,aAAa,CAAA;CAAE,EAC5B,GAAG,CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,aAAa,EAAE,UAAU;IACzE;;;OAGG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAC9B,IAAI,GACJ,MAAM,GACN,WAAW,GACX,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC,CAAC;AAEtC,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAClD;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAChD;;;;OAIG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAC1C;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAClC;;;;OAIG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACxC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC;IACxD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;CAC9C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC5E,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACf,MAAM,YAAY,CAAC;AAEpB;;GAEG;AAEH,MAAM,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAChE;;GAEG;AAEH,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAChF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAElD,MAAM,MAAM,wBAAwB,CAAC,IAAI,SAAS,cAAc,IAAI;IAClE,IAAI,CAAC,MAAM,CAAC;IACZ,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS;CAC7C,GAAG;IAAE,QAAQ,CAAC,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,6BAA6B,CACvC,EAAE,CAAC,GAAG,CAAC,MAAM,SAAS,cAAc,EACpC,GAAG,CAAC,IAAI,SAAS,MAAM,EACvB,EAAE,CAAC,GAAG,CAAC,MAAM,EACb,EAAE,CAAC,GAAG,CAAC,IAAI,IACT,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,wEAAwE;IACxE,MAAM,EAAE,WAAW,CAAC;IACpB;;;OAGG;IACH,OAAO,EAAE,CAAC,UAAU,SAAS,cAAc,GAAG,KAAK,EACjD,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,KACrB,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnE;;;OAGG;IACH,aAAa,EAAE,CAAC,UAAU,SAAS,cAAc,EAC/C,GAAG,EAAE,UAAU,KACZ,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;IACvD;;;OAGG;IACH,uBAAuB,EAAE,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;IACnD;;;;OAIG;IACH,cAAc,EAAE,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,IAAI,CACrC,SAAQ,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,eAAe,CAAC;IACxD;;;OAGG;IACH,OAAO,EAAE,CAAC,UAAU,SAAS,cAAc,GAAG,KAAK,EACjD,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,KACrB,SAAS,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACnD;;;OAGG;IACH,aAAa,EAAE,CAAC,UAAU,SAAS,cAAc,EAC/C,GAAG,EAAE,UAAU,KACZ,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,MAAM,SAAS,cAAc,EAC7B,IAAI,SAAS,MAAM,EACnB,MAAM,EACN,IAAI,IAEF,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GACvC,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAE9D,MAAM,WAAW,qBAAqB,CAAC,GAAG,CAAC,UAAU,SAAS,cAAc;IAC1E,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACtC,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;CACvC;AAED,MAAM,MAAM,eAAe,CAAC,MAAM,IAAI,CAAC,MAAM,IAAI,CAAC,GAChD,CAAC,OAAO,SAAS,MAAM,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEtE;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAC1B,EAAE,CAAC,GAAG,CAAC,MAAM,SAAS,cAAc,EACpC,GAAG,CAAC,IAAI,SAAS,MAAM,EACvB,EAAE,CAAC,GAAG,CAAC,MAAM,EACb,EAAE,CAAC,GAAG,CAAC,IAAI,CACX,SAAQ,mBAAmB,EACzB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;IAC3C,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,wDAAwD;IACxD,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,gFAAgF;IAChF,YAAY,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACxC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC,cAAc,CAAC,EAAE,CAAC;IAE9D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IACrE;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,CACL,YAAY,EAAE,mBAAmB,EACjC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,aAAa,KACjB,IAAI,CAAC;IACV;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,CACT,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAC3B,eAAe,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,EAAE,CACpB,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAC3B,MAAM,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,cAAc,IAAI,WAAW,CACtE,IAAI,CAAC,gBAAgB,CAAC,CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,cAAc,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,cAAc,IAAI,WAAW,CACtE,IAAI,CAAC,gBAAgB,CAAC,CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,cAAc,IAAI,WAAW,CACpE,IAAI,CAAC,cAAc,CAAC,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,aAAa,IAAI,WAAW,CAE1D,GAAG,EAEH,GAAG,EACH;IAAE,SAAS,EAAE,aAAa,CAAA;CAAE,EAE5B,GAAG,CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,aAAa,EAAE,UAAU;IACzE;;;OAGG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAC9B,IAAI,GACJ,MAAM,GACN,WAAW,GACX,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC,CAAC;AAEtC,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAClD;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAChD;;;;OAIG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAC1C;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAClC;;;;OAIG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACxC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC;IACxD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;CAC9C"}

package/package.json

@@ -15,7 +15,7 @@
     "test": "vitest run --typecheck",
     "test:watch": "vitest"
   },
-  "version": "0.0.28-nightly.20240708.0",
+  "version": "0.0.28",
   "license": "MIT",
   "repository": {
     "type": "git",