@etrepum/lexical-builder-core 0.0.25-nightly.20240624.0 → 0.0.26-nightly.20240625.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/types.d.ts +19 -8
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
*/
|
|
8
8
|
export declare const PACKAGE_VERSION: string;
|
|
9
9
|
export { configPlan, definePlan, provideOutput, declarePeerDependency, } from './definePlan';
|
|
10
|
-
export { type AnyLexicalPlan, type AnyLexicalPlanArgument, type
|
|
10
|
+
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';
|
|
11
11
|
export { type LexicalPlanInternal, type initTypeSymbol, type configTypeSymbol, type outputTypeSymbol, } from './internal';
|
|
12
12
|
export { safeCast } from './safeCast';
|
|
13
13
|
export { shallowMergeConfig } from './shallowMergeConfig';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +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,
|
|
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"}
|
package/dist/index.js
CHANGED
package/dist/types.d.ts
CHANGED
|
@@ -32,7 +32,7 @@ export type NormalizedLexicalPlanArgument<in out Config extends PlanConfigBase,
|
|
|
32
32
|
* configuration for plan dependencies
|
|
33
33
|
*/
|
|
34
34
|
export interface RegisterState<Init> {
|
|
35
|
-
/** An AbortSignal that is aborted when the
|
|
35
|
+
/** An AbortSignal that is aborted when the LexicalEditor is disposed */
|
|
36
36
|
signal: AbortSignal;
|
|
37
37
|
/**
|
|
38
38
|
* Get the result of a peerDependency by name, if it exists
|
|
@@ -81,7 +81,7 @@ export type RegisterCleanup<Output> = (() => void) & (unknown extends Output ? {
|
|
|
81
81
|
* A Plan may depend on other Plans, and provide functionality to other
|
|
82
82
|
* plans through its config.
|
|
83
83
|
*/
|
|
84
|
-
export interface LexicalPlan<in out Config extends PlanConfigBase
|
|
84
|
+
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> {
|
|
85
85
|
/** The name of the Plan, must be unique */
|
|
86
86
|
readonly name: Name;
|
|
87
87
|
/** Plan names that must not be loaded with this Plan */
|
|
@@ -137,10 +137,11 @@ export interface LexicalPlan<in out Config extends PlanConfigBase = PlanConfigBa
|
|
|
137
137
|
* used, and methods for accessing the merged configuration of
|
|
138
138
|
* dependencies and peerDependencies
|
|
139
139
|
*/
|
|
140
|
-
init?: (editorConfig: InitialEditorConfig, config: Config, state: RegisterState<
|
|
140
|
+
init?: (editorConfig: InitialEditorConfig, config: Config, state: RegisterState<never>) => Init;
|
|
141
141
|
/**
|
|
142
142
|
* Add behavior to the editor (register transforms, listeners, etc.) after
|
|
143
|
-
* the Editor is created
|
|
143
|
+
* the Editor is created, but before its initial state is set.
|
|
144
|
+
* The register function may also mutate the config
|
|
144
145
|
* in-place to expose data to other plans that use it as a dependency.
|
|
145
146
|
*
|
|
146
147
|
* @param editor The editor this Plan is being registered with
|
|
@@ -151,6 +152,18 @@ export interface LexicalPlan<in out Config extends PlanConfigBase = PlanConfigBa
|
|
|
151
152
|
* @returns A clean-up function
|
|
152
153
|
*/
|
|
153
154
|
register?: (editor: LexicalEditor, config: Config, state: RegisterState<Init>) => RegisterCleanup<Output>;
|
|
155
|
+
/**
|
|
156
|
+
* Run any code that must happen after initialization of the
|
|
157
|
+
* editor state (which happens after all register calls).
|
|
158
|
+
*
|
|
159
|
+
* @param editor The editor this Plan is being registered with
|
|
160
|
+
* @param config The merged configuration specific to this Plan
|
|
161
|
+
* @param state An object containing an AbortSignal that can be
|
|
162
|
+
* used, and methods for accessing the merged configuration of
|
|
163
|
+
* dependencies and peerDependencies
|
|
164
|
+
* @returns A clean-up function
|
|
165
|
+
*/
|
|
166
|
+
afterInitialization?: (editor: LexicalEditor, config: Config, state: RegisterState<Init>) => () => void;
|
|
154
167
|
}
|
|
155
168
|
/**
|
|
156
169
|
* Extract the Config type from a Plan
|
|
@@ -175,11 +188,9 @@ export type OutputComponentPlan<ComponentType> = LexicalPlan<any, any, {
|
|
|
175
188
|
Component: ComponentType;
|
|
176
189
|
}, any>;
|
|
177
190
|
/**
|
|
178
|
-
* A handle to the editor
|
|
191
|
+
* A handle to the editor with an attached dispose function
|
|
179
192
|
*/
|
|
180
|
-
export interface
|
|
181
|
-
/** The created editor */
|
|
182
|
-
editor: LexicalEditor;
|
|
193
|
+
export interface LexicalEditorWithDispose extends LexicalEditor, Disposable {
|
|
183
194
|
/**
|
|
184
195
|
* Dispose the editor and perform all clean-up
|
|
185
196
|
* (also available as Symbol.dispose via Disposable)
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +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,
|
|
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"}
|