@inditextech/weave-store-websockets 0.3.0 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.cjs CHANGED
@@ -23,7 +23,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
23
23
 
24
24
  //#endregion
25
25
  const __inditextech_weave_sdk = __toESM(require("@inditextech/weave-sdk"));
26
- require("@inditextech/weave-types");
26
+ require("konva");
27
27
  require("yjs");
28
28
  require("http");
29
29
  const y_websocket = __toESM(require("y-websocket"));
package/dist/client.d.cts CHANGED
@@ -1,463 +1,12 @@
1
- import Konva from "konva";
2
- import { Vector2d } from "konva/lib/types";
3
- import * as Y$1 from "yjs";
1
+ import { WeaveStore } from "@inditextech/weave-sdk";
2
+ import "konva";
4
3
  import * as Y from "yjs";
5
- import { Doc } from "yjs";
6
- import Emittery from "emittery";
7
- import pino, { Logger } from "pino";
8
- import { StageConfig } from "konva/lib/Stage";
4
+ import "konva/lib/types";
9
5
  import { IncomingMessage } from "http";
10
6
  import { WebsocketProvider } from "y-websocket";
11
7
 
12
- //#region ../sdk/dist/sdk.d.ts
13
8
  //#region ../types/dist/types.d.ts
14
- declare const WEAVE_INSTANCE_STATUS: {
15
- readonly "IDLE": "idle";
16
- readonly "STARTING": "starting";
17
- readonly "LOADING_FONTS": "loadingFonts";
18
- readonly "RUNNING": "running";
19
- };
20
- declare const WEAVE_NODE_POSITION: {
21
- readonly "UP": "up";
22
- readonly "DOWN": "down";
23
- readonly "FRONT": "front";
24
- readonly "BACK": "back";
25
- };
26
- declare const WEAVE_EXPORT_FORMATS: {
27
- readonly "PNG": "image/png";
28
- readonly "JPEG": "image/jpeg";
29
- };
30
- //#endregion
31
- //#region src/base/action.d.ts
32
- interface WeaveActionBase {
33
- onInit?(): void;
34
- trigger(cancelAction: () => void, params?: unknown): unknown;
35
- internalUpdate?(): void;
36
- cleanup?(): void;
37
- }
38
-
39
- //#endregion
40
- //#region src/base/plugin.d.ts
41
- interface WeavePluginBase {
42
- onInit?(): void;
43
- onRender?(): void;
44
- enable(): void;
45
- disable(): void;
46
- isEnabled(): boolean;
47
- }
48
9
 
49
- //#endregion
50
- //#region src/base/store.d.ts
51
- type WeaveStoreOptions$1 = {
52
- getUser: () => WeaveUser$1;
53
- undoManagerOptions?: WeaveUndoManagerOptions$1;
54
- };
55
- interface WeaveStoreBase {
56
- connect(): void;
57
- disconnect(): void;
58
- onAwarenessChange<K extends string, T>(callback: (changes: WeaveAwarenessChange$1<K, T>[]) => void): void;
59
- setAwarenessInfo(field: string, value: unknown): void;
60
- }
61
-
62
- //#endregion
63
- //#region src/types.d.ts
64
- type WeaveConfig = {
65
- store: WeaveStoreBase;
66
- nodes?: WeaveNodeBase[];
67
- actions?: WeaveActionBase[];
68
- plugins?: WeavePluginBase[];
69
- fonts?: WeaveFont[];
70
- callbacks?: WeaveCallbacks;
71
- logger?: WeaveLoggerConfig;
72
- };
73
- type WeaveStatusKeys = keyof typeof WEAVE_INSTANCE_STATUS;
74
- type WeaveStatus = (typeof WEAVE_INSTANCE_STATUS)[WeaveStatusKeys];
75
- type WeaveElementAttributes = {
76
- [key: string]: any;
77
- id?: string;
78
- nodeType?: string;
79
- children?: WeaveStateElement[];
80
- };
81
- type WeaveStateElement = {
82
- key: string;
83
- type: string;
84
- props: WeaveElementAttributes;
85
- };
86
- type WeaveState = {
87
- weave: {
88
- key: "stage";
89
- type: "stage";
90
- props: {
91
- [key: string]: unknown;
92
- id: "stage";
93
- children: WeaveStateElement[];
94
- };
95
- } | Record<string, WeaveStateElement>;
96
- };
97
- type WeaveSelection = {
98
- instance: Konva.Shape | Konva.Group;
99
- node: WeaveStateElement;
100
- };
101
- type WeaveMousePointInfoSimple = {
102
- mousePoint: Vector2d;
103
- container: Konva.Layer | Konva.Group | undefined;
104
- };
105
- type WeaveMousePointInfo = WeaveMousePointInfoSimple & {
106
- measureContainer: Konva.Layer | Konva.Group | undefined;
107
- };
108
- type WeaveSerializedGroup = {
109
- serializedNodes: WeaveStateElement[];
110
- minPoint: Vector2d;
111
- } | undefined;
112
- type WeaveNodeFound = {
113
- node: WeaveStateElement | null;
114
- parent: WeaveStateElement | null;
115
- index: number;
116
- };
117
- type WeaveAwarenessChange$1<K extends string, T> = { [key in K]: T };
118
- type WeaveElementInstance = Konva.Layer | Konva.Group | Konva.Shape;
119
- type WeaveLoggerConfig = {
120
- disabled?: boolean;
121
- level?: "debug" | "info" | "warn" | "error";
122
- };
123
- type WeavePositionKeys = keyof typeof WEAVE_NODE_POSITION;
124
- type WeavePosition = (typeof WEAVE_NODE_POSITION)[WeavePositionKeys];
125
- type WeaveExportNodeOptions = {
126
- format?: typeof WEAVE_EXPORT_FORMATS.PNG;
127
- padding?: number;
128
- pixelRatio?: number;
129
- backgroundColor?: string;
130
- quality?: number;
131
- };
132
- type WeaveUser$1 = {
133
- name: string;
134
- email: string;
135
- };
136
- type WeaveFont = {
137
- id: string;
138
- name: string;
139
- };
140
- type WeaveUndoManagerOptions$1 = {
141
- captureTimeout?: number;
142
- trackedOrigins?: Set<any>;
143
- };
144
- type WeaveUndoRedoChange = {
145
- canRedo: boolean;
146
- canUndo: boolean;
147
- redoStackLength: number;
148
- undoStackLength: number;
149
- };
150
- type WeaveCallbacks = {
151
- onRender?: () => void;
152
- onRoomLoaded?: (loaded: boolean) => void;
153
- onInstanceStatus?: (status: WeaveStatus) => void;
154
- onActiveActionChange?: (actionName: string | undefined) => void;
155
- onStateChange?: (state: WeaveState) => void;
156
- onUndoManagerStatusChange?: (undoManagerStatus: WeaveUndoRedoChange) => void;
157
- };
158
- declare type docElementTypeDescription = "xml" | "text" | Array<any> | object;
159
- declare type DocTypeDescription = {
160
- [key: string]: docElementTypeDescription;
161
- };
162
- declare type MappedTypeDescription<T extends DocTypeDescription> = { readonly [P in keyof T]: T[P] extends "xml" ? Y$1.XmlFragment : T[P] extends "text" ? Y$1.Text : T[P] extends Array<any> ? T[P] : T[P] extends object ? Partial<T[P]> : never };
163
- //#endregion
164
- //#region src/base/node.d.ts
165
- interface WeaveNodeBase {
166
- create(id: string, props: WeaveElementAttributes): WeaveStateElement;
167
- onRender(props: WeaveElementAttributes): WeaveElementInstance;
168
- onUpdate(instance: WeaveElementInstance, nextProps: WeaveElementAttributes): void;
169
- onDestroy(instance: WeaveElementInstance): void;
170
- serialize(instance: WeaveElementInstance): WeaveStateElement;
171
- } //#endregion
172
- //#region src/stores/store.d.ts
173
-
174
- //#endregion
175
- declare abstract class WeaveStore implements WeaveStoreBase {
176
- protected instance: Weave;
177
- protected name: string;
178
- protected supportsUndoManager: boolean;
179
- protected config: WeaveStoreOptions$1;
180
- private state;
181
- private latestState;
182
- private document;
183
- private logger;
184
- private undoManager;
185
- private isRoomLoaded;
186
- constructor(config: WeaveStoreOptions$1);
187
- getName(): string;
188
- getLogger(): Logger;
189
- register(instance: Weave): WeaveStore;
190
- getUser(): WeaveUser$1;
191
- setState(state: WeaveState): void;
192
- setLatestState(newState: WeaveState): void;
193
- getLatestState(): WeaveState;
194
- getDocument(): Doc;
195
- getState(): MappedTypeDescription<WeaveState>;
196
- getStateJson(): WeaveState;
197
- setup(): void;
198
- canUndoStateStep(): boolean;
199
- canRedoStateStep(): boolean;
200
- undoStateStep(): void;
201
- redoStateStep(): void;
202
- abstract connect(): void;
203
- abstract disconnect(): void;
204
- abstract onAwarenessChange<K extends string, T>(callback: (changes: WeaveAwarenessChange$1<K, T>[]) => void): void;
205
- abstract setAwarenessInfo(field: string, value: unknown): void;
206
- }
207
-
208
- //#endregion
209
- //#region src/plugins/plugin.d.ts
210
- declare abstract class WeavePlugin implements WeavePluginBase {
211
- protected instance: Weave;
212
- protected name: string;
213
- protected enabled: boolean;
214
- private logger;
215
- register(instance: Weave): WeavePlugin;
216
- getName(): string;
217
- getLogger(): Logger;
218
- isEnabled(): boolean;
219
- abstract onInit?(): void;
220
- abstract onRender?(): void;
221
- abstract enable(): void;
222
- abstract disable(): void;
223
- }
224
-
225
- //#endregion
226
- //#region src/plugins/nodes-selection/types.d.ts
227
- type WeaveNodesSelectionChangeCallback = (nodes: WeaveSelection[]) => void;
228
- type WeaveNodesSelectionStageSelectionCallback = () => void;
229
- type WeaveNodesSelectionPluginCallbacks = {
230
- onNodesChange: WeaveNodesSelectionChangeCallback;
231
- onStageSelection?: WeaveNodesSelectionStageSelectionCallback;
232
- };
233
-
234
- //#endregion
235
- //#region src/plugins/nodes-selection/nodes-selection.d.ts
236
- declare class WeaveNodesSelectionPlugin extends WeavePlugin {
237
- private tr;
238
- private selectionRectangle;
239
- private active;
240
- private cameFromSelectingMultiple;
241
- private selecting;
242
- private initialized;
243
- private callbacks;
244
- onRender: undefined;
245
- constructor(callbacks: WeaveNodesSelectionPluginCallbacks);
246
- getName(): string;
247
- getLayerName(): string;
248
- initLayer(): void;
249
- onInit(): void;
250
- private getLayer;
251
- private triggerSelectedNodesEvent;
252
- private initEvents;
253
- getTransformer(): Konva.Transformer;
254
- setSelectedNodes(nodes: Konva.Node[]): void;
255
- getSelectedNodes(): (Konva.Group | Konva.Shape)[];
256
- removeSelectedNodes(): void;
257
- selectAll(): void;
258
- selectNone(): void;
259
- enable(): void;
260
- disable(): void;
261
- }
262
-
263
- //#endregion
264
- //#region src/nodes/node.d.ts
265
- declare abstract class WeaveNode implements WeaveNodeBase {
266
- protected instance: Weave;
267
- protected nodeType: string;
268
- private logger;
269
- protected previousPointer: string | null;
270
- register(instance: Weave): WeaveNode;
271
- getNodeType(): string;
272
- getLogger(): Logger;
273
- getSelectionPlugin(): WeaveNodesSelectionPlugin;
274
- isSelecting(): boolean;
275
- isPasting(): boolean;
276
- isNodeSelected(ele: Konva.Node): boolean;
277
- setupDefaultNodeEvents(node: Konva.Node): void;
278
- create(key: string, props: WeaveElementAttributes): WeaveStateElement;
279
- abstract onRender(props: WeaveElementAttributes): WeaveElementInstance;
280
- abstract onUpdate(instance: WeaveElementInstance, nextProps: WeaveElementAttributes): void;
281
- onDestroy(nodeInstance: WeaveElementInstance): void;
282
- serialize(instance: WeaveElementInstance): WeaveStateElement;
283
- }
284
-
285
- //#endregion
286
- //#region src/actions/types.d.ts
287
- type WeaveActionPropsChangeCallback = (props: WeaveElementAttributes) => void;
288
- type WeaveActionCallbacks = {
289
- onPropsChange?: WeaveActionPropsChangeCallback;
290
- };
291
-
292
- //#endregion
293
- //#region src/actions/action.d.ts
294
- declare abstract class WeaveAction {
295
- protected instance: Weave;
296
- protected name: string;
297
- props: WeaveElementAttributes;
298
- protected callbacks: WeaveActionCallbacks | undefined;
299
- private logger;
300
- constructor(callbacks?: WeaveActionCallbacks);
301
- getName(): string;
302
- getLogger(): Logger;
303
- register(instance: Weave): WeaveAction;
304
- updateProps(props: WeaveElementAttributes): void;
305
- getProps(): WeaveElementAttributes;
306
- abstract onInit?(): void;
307
- abstract trigger(cancelAction: () => void, params?: unknown): unknown;
308
- abstract internalUpdate?(): void;
309
- abstract cleanup?(): void;
310
- }
311
-
312
- //#endregion
313
- //#region src/logger/logger.d.ts
314
- declare class WeaveLogger {
315
- private config;
316
- private disabled;
317
- private logger;
318
- constructor(config: WeaveLoggerConfig);
319
- private log;
320
- getDisabled(): boolean;
321
- getLevel(): pino.LevelWithSilentOrString;
322
- getLogger(): Logger;
323
- getChildLogger(name: string): pino.Logger<never, boolean>;
324
- }
325
-
326
- //#endregion
327
- //#region src/managers/register.d.ts
328
- declare class WeaveRegisterManager {
329
- private instance;
330
- private nodesHandlers;
331
- private actionsHandlers;
332
- private plugins;
333
- private logger;
334
- constructor(instance: Weave);
335
- getPlugins(): Record<string, WeavePlugin>;
336
- getNodesHandlers(): Record<string, WeaveNode>;
337
- getActionsHandlers(): Record<string, WeaveAction>;
338
- getPlugin<T extends WeavePlugin>(pluginName: string): T;
339
- getActionHandler<T extends WeaveAction>(actionName: string): T;
340
- getNodeHandler(nodeType: string): WeaveNode;
341
- registerPlugins(): void;
342
- registerPlugin(plugin: WeavePlugin): void;
343
- registerNodesHandlers(): void;
344
- registerNodeHandler(node: WeaveNode): void;
345
- registerActionsHandlers(): void;
346
- registerActionHandler(action: WeaveAction): void;
347
- }
348
-
349
- //#endregion
350
- //#region src/managers/stage.d.ts
351
- declare class WeaveStageManager {
352
- private instance;
353
- private logger;
354
- private stage;
355
- private config;
356
- constructor(instance: Weave, config: Konva.StageConfig);
357
- getConfiguration(): StageConfig;
358
- setStage(stage: Konva.Stage): void;
359
- getStage(): Konva.Stage;
360
- getMainLayer(): Konva.Layer | undefined;
361
- getInstanceRecursive(instance: Konva.Node, filterInstanceType?: string[]): Konva.Node;
362
- initStage(): void;
363
- }
364
-
365
- //#endregion
366
- //#region src/weave.d.ts
367
- declare class Weave extends Emittery {
368
- private id;
369
- private config;
370
- private logger;
371
- private moduleLogger;
372
- private reconciler;
373
- private stateSerializer;
374
- private renderer;
375
- private status;
376
- private setupManager;
377
- private registerManager;
378
- private stateManager;
379
- private storeManager;
380
- private stageManager;
381
- private groupsManager;
382
- private targetingManager;
383
- private cloningManager;
384
- private fontsManager;
385
- private zIndexManager;
386
- private pluginsManager;
387
- private actionsManager;
388
- private exportManager;
389
- constructor(weaveConfig: WeaveConfig, stageConfig: Konva.StageConfig);
390
- setupRenderer(): void;
391
- setStatus(status: WeaveStatus): void;
392
- getStatus(): WeaveStatus;
393
- setStore(store: WeaveStore): void;
394
- start(): Promise<void>;
395
- getId(): string;
396
- getConfiguration(): WeaveConfig;
397
- emitEvent<T>(event: string, payload: T): void;
398
- addEventListener<T>(event: string, callback: (payload: T) => void): void;
399
- removeEventListener<T>(event: string, callback: (payload: T) => void): void;
400
- getLogger(): WeaveLogger;
401
- getMainLogger(): Logger;
402
- getChildLogger(name: string): pino.Logger<never, boolean>;
403
- getStageManager(): WeaveStageManager;
404
- getStage(): Konva.Stage;
405
- getMainLayer(): Konva.Layer | undefined;
406
- setStage(stage: Konva.Stage): void;
407
- getStageConfiguration(): StageConfig;
408
- getInstanceRecursive(instance: Konva.Node, filterInstanceType?: string[]): Konva.Node;
409
- getRegisterManager(): WeaveRegisterManager;
410
- getPlugins(): Record<string, WeavePlugin>;
411
- getPlugin<T extends WeavePlugin>(pluginName: string): T;
412
- getNodesHandlers(): Record<string, WeaveNode>;
413
- getNodeHandler<T extends WeaveNode>(nodeType: string): T;
414
- getActionsHandlers(): Record<string, WeaveAction>;
415
- getActionHandler<T extends WeaveAction>(actionName: string): T;
416
- getStore<T extends WeaveStore>(): T;
417
- registerPlugin(plugin: WeavePlugin): void;
418
- registerNodeHandler(node: WeaveNode): void;
419
- registerActionHandler(action: WeaveAction): void;
420
- registerStore(store: WeaveStore): void;
421
- isPluginEnabled(pluginName: string): boolean;
422
- enablePlugin(pluginName: string): void;
423
- disablePlugin(pluginName: string): void;
424
- getActiveAction(): string | undefined;
425
- triggerAction<T>(actionName: string, params?: T): unknown;
426
- getPropsAction(actionName: string): WeaveElementAttributes;
427
- updatePropsAction(actionName: string, params: WeaveElementAttributes): void;
428
- cancelAction(actionName: string): void;
429
- update(newState: WeaveState): void;
430
- render(): void;
431
- findNodeById(tree: WeaveStateElement, key: string, parent?: WeaveStateElement | null, index?: number): WeaveNodeFound;
432
- findNodesByType(tree: WeaveStateElement, nodeType: string): WeaveStateElement[];
433
- getNode(nodeKey: string): {
434
- node: WeaveStateElement | null;
435
- parent: WeaveStateElement | null;
436
- index: number;
437
- };
438
- addNode(node: WeaveStateElement, parentId?: string, index?: number | undefined, doRender?: boolean): void;
439
- updateNode(node: WeaveStateElement, doRender?: boolean): void;
440
- removeNode(node: WeaveStateElement, doRender?: boolean): void;
441
- removeNodes(nodes: WeaveStateElement[], doRender?: boolean): void;
442
- moveNode(node: WeaveStateElement, position: WeavePosition, doRender?: boolean): void;
443
- moveUp(node: WeaveElementInstance): void;
444
- moveDown(node: WeaveElementInstance): void;
445
- sendToBack(node: WeaveElementInstance): void;
446
- bringToFront(node: WeaveElementInstance): void;
447
- group(nodes: WeaveStateElement[]): void;
448
- unGroup(group: WeaveStateElement): void;
449
- getMousePointer(point?: Vector2d): WeaveMousePointInfo;
450
- getMousePointerRelativeToContainer(container: Konva.Group | Konva.Layer): WeaveMousePointInfoSimple;
451
- nodesToGroupSerialized(instancesToClone: Konva.Node[]): WeaveSerializedGroup;
452
- cloneNodes(instancesToClone: Konva.Node[], targetContainer: Konva.Layer | Konva.Group | undefined, onPoint: Vector2d): void;
453
- getFonts(): WeaveFont[];
454
- exportStage(options: WeaveExportNodeOptions): Promise<HTMLImageElement>;
455
- exportNode(node: WeaveElementInstance, options: WeaveExportNodeOptions): Promise<HTMLImageElement>;
456
- } //#endregion
457
- //#region ../types/dist/types.d.ts
458
-
459
- //#endregion
460
- //#region src/utils.d.ts
461
10
  //#endregion
462
11
  //#region src/base/store.d.ts
463
12
  type WeaveStoreOptions = {
@@ -472,9 +21,7 @@ type WeaveUser = {
472
21
  type WeaveUndoManagerOptions = {
473
22
  captureTimeout?: number;
474
23
  trackedOrigins?: Set<any>;
475
- };
476
-
477
- //#endregion
24
+ }; //#endregion
478
25
  //#region src/constants.d.ts
479
26
  declare const WEAVE_STORE_WEBSOCKETS = "store-websockets";
480
27
  declare const WEAVE_STORE_WEBSOCKETS_CONNECTION_STATUS: {
package/dist/client.d.ts CHANGED
@@ -1,463 +1,12 @@
1
- import * as Y$1 from "yjs";
1
+ import { WeaveStore } from "@inditextech/weave-sdk";
2
+ import "konva";
2
3
  import * as Y from "yjs";
3
- import { Doc } from "yjs";
4
4
  import { IncomingMessage } from "http";
5
5
  import { WebsocketProvider } from "y-websocket";
6
- import Konva from "konva";
7
- import { Vector2d } from "konva/lib/types";
8
- import Emittery from "emittery";
9
- import pino, { Logger } from "pino";
10
- import { StageConfig } from "konva/lib/Stage";
6
+ import "konva/lib/types";
11
7
 
12
- //#region ../sdk/dist/sdk.d.ts
13
8
  //#region ../types/dist/types.d.ts
14
- declare const WEAVE_INSTANCE_STATUS: {
15
- readonly "IDLE": "idle";
16
- readonly "STARTING": "starting";
17
- readonly "LOADING_FONTS": "loadingFonts";
18
- readonly "RUNNING": "running";
19
- };
20
- declare const WEAVE_NODE_POSITION: {
21
- readonly "UP": "up";
22
- readonly "DOWN": "down";
23
- readonly "FRONT": "front";
24
- readonly "BACK": "back";
25
- };
26
- declare const WEAVE_EXPORT_FORMATS: {
27
- readonly "PNG": "image/png";
28
- readonly "JPEG": "image/jpeg";
29
- };
30
- //#endregion
31
- //#region src/base/action.d.ts
32
- interface WeaveActionBase {
33
- onInit?(): void;
34
- trigger(cancelAction: () => void, params?: unknown): unknown;
35
- internalUpdate?(): void;
36
- cleanup?(): void;
37
- }
38
-
39
- //#endregion
40
- //#region src/base/plugin.d.ts
41
- interface WeavePluginBase {
42
- onInit?(): void;
43
- onRender?(): void;
44
- enable(): void;
45
- disable(): void;
46
- isEnabled(): boolean;
47
- }
48
9
 
49
- //#endregion
50
- //#region src/base/store.d.ts
51
- type WeaveStoreOptions$1 = {
52
- getUser: () => WeaveUser$1;
53
- undoManagerOptions?: WeaveUndoManagerOptions$1;
54
- };
55
- interface WeaveStoreBase {
56
- connect(): void;
57
- disconnect(): void;
58
- onAwarenessChange<K extends string, T>(callback: (changes: WeaveAwarenessChange$1<K, T>[]) => void): void;
59
- setAwarenessInfo(field: string, value: unknown): void;
60
- }
61
-
62
- //#endregion
63
- //#region src/types.d.ts
64
- type WeaveConfig = {
65
- store: WeaveStoreBase;
66
- nodes?: WeaveNodeBase[];
67
- actions?: WeaveActionBase[];
68
- plugins?: WeavePluginBase[];
69
- fonts?: WeaveFont[];
70
- callbacks?: WeaveCallbacks;
71
- logger?: WeaveLoggerConfig;
72
- };
73
- type WeaveStatusKeys = keyof typeof WEAVE_INSTANCE_STATUS;
74
- type WeaveStatus = (typeof WEAVE_INSTANCE_STATUS)[WeaveStatusKeys];
75
- type WeaveElementAttributes = {
76
- [key: string]: any;
77
- id?: string;
78
- nodeType?: string;
79
- children?: WeaveStateElement[];
80
- };
81
- type WeaveStateElement = {
82
- key: string;
83
- type: string;
84
- props: WeaveElementAttributes;
85
- };
86
- type WeaveState = {
87
- weave: {
88
- key: "stage";
89
- type: "stage";
90
- props: {
91
- [key: string]: unknown;
92
- id: "stage";
93
- children: WeaveStateElement[];
94
- };
95
- } | Record<string, WeaveStateElement>;
96
- };
97
- type WeaveSelection = {
98
- instance: Konva.Shape | Konva.Group;
99
- node: WeaveStateElement;
100
- };
101
- type WeaveMousePointInfoSimple = {
102
- mousePoint: Vector2d;
103
- container: Konva.Layer | Konva.Group | undefined;
104
- };
105
- type WeaveMousePointInfo = WeaveMousePointInfoSimple & {
106
- measureContainer: Konva.Layer | Konva.Group | undefined;
107
- };
108
- type WeaveSerializedGroup = {
109
- serializedNodes: WeaveStateElement[];
110
- minPoint: Vector2d;
111
- } | undefined;
112
- type WeaveNodeFound = {
113
- node: WeaveStateElement | null;
114
- parent: WeaveStateElement | null;
115
- index: number;
116
- };
117
- type WeaveAwarenessChange$1<K extends string, T> = { [key in K]: T };
118
- type WeaveElementInstance = Konva.Layer | Konva.Group | Konva.Shape;
119
- type WeaveLoggerConfig = {
120
- disabled?: boolean;
121
- level?: "debug" | "info" | "warn" | "error";
122
- };
123
- type WeavePositionKeys = keyof typeof WEAVE_NODE_POSITION;
124
- type WeavePosition = (typeof WEAVE_NODE_POSITION)[WeavePositionKeys];
125
- type WeaveExportNodeOptions = {
126
- format?: typeof WEAVE_EXPORT_FORMATS.PNG;
127
- padding?: number;
128
- pixelRatio?: number;
129
- backgroundColor?: string;
130
- quality?: number;
131
- };
132
- type WeaveUser$1 = {
133
- name: string;
134
- email: string;
135
- };
136
- type WeaveFont = {
137
- id: string;
138
- name: string;
139
- };
140
- type WeaveUndoManagerOptions$1 = {
141
- captureTimeout?: number;
142
- trackedOrigins?: Set<any>;
143
- };
144
- type WeaveUndoRedoChange = {
145
- canRedo: boolean;
146
- canUndo: boolean;
147
- redoStackLength: number;
148
- undoStackLength: number;
149
- };
150
- type WeaveCallbacks = {
151
- onRender?: () => void;
152
- onRoomLoaded?: (loaded: boolean) => void;
153
- onInstanceStatus?: (status: WeaveStatus) => void;
154
- onActiveActionChange?: (actionName: string | undefined) => void;
155
- onStateChange?: (state: WeaveState) => void;
156
- onUndoManagerStatusChange?: (undoManagerStatus: WeaveUndoRedoChange) => void;
157
- };
158
- declare type docElementTypeDescription = "xml" | "text" | Array<any> | object;
159
- declare type DocTypeDescription = {
160
- [key: string]: docElementTypeDescription;
161
- };
162
- declare type MappedTypeDescription<T extends DocTypeDescription> = { readonly [P in keyof T]: T[P] extends "xml" ? Y$1.XmlFragment : T[P] extends "text" ? Y$1.Text : T[P] extends Array<any> ? T[P] : T[P] extends object ? Partial<T[P]> : never };
163
- //#endregion
164
- //#region src/base/node.d.ts
165
- interface WeaveNodeBase {
166
- create(id: string, props: WeaveElementAttributes): WeaveStateElement;
167
- onRender(props: WeaveElementAttributes): WeaveElementInstance;
168
- onUpdate(instance: WeaveElementInstance, nextProps: WeaveElementAttributes): void;
169
- onDestroy(instance: WeaveElementInstance): void;
170
- serialize(instance: WeaveElementInstance): WeaveStateElement;
171
- } //#endregion
172
- //#region src/stores/store.d.ts
173
-
174
- //#endregion
175
- declare abstract class WeaveStore implements WeaveStoreBase {
176
- protected instance: Weave;
177
- protected name: string;
178
- protected supportsUndoManager: boolean;
179
- protected config: WeaveStoreOptions$1;
180
- private state;
181
- private latestState;
182
- private document;
183
- private logger;
184
- private undoManager;
185
- private isRoomLoaded;
186
- constructor(config: WeaveStoreOptions$1);
187
- getName(): string;
188
- getLogger(): Logger;
189
- register(instance: Weave): WeaveStore;
190
- getUser(): WeaveUser$1;
191
- setState(state: WeaveState): void;
192
- setLatestState(newState: WeaveState): void;
193
- getLatestState(): WeaveState;
194
- getDocument(): Doc;
195
- getState(): MappedTypeDescription<WeaveState>;
196
- getStateJson(): WeaveState;
197
- setup(): void;
198
- canUndoStateStep(): boolean;
199
- canRedoStateStep(): boolean;
200
- undoStateStep(): void;
201
- redoStateStep(): void;
202
- abstract connect(): void;
203
- abstract disconnect(): void;
204
- abstract onAwarenessChange<K extends string, T>(callback: (changes: WeaveAwarenessChange$1<K, T>[]) => void): void;
205
- abstract setAwarenessInfo(field: string, value: unknown): void;
206
- }
207
-
208
- //#endregion
209
- //#region src/plugins/plugin.d.ts
210
- declare abstract class WeavePlugin implements WeavePluginBase {
211
- protected instance: Weave;
212
- protected name: string;
213
- protected enabled: boolean;
214
- private logger;
215
- register(instance: Weave): WeavePlugin;
216
- getName(): string;
217
- getLogger(): Logger;
218
- isEnabled(): boolean;
219
- abstract onInit?(): void;
220
- abstract onRender?(): void;
221
- abstract enable(): void;
222
- abstract disable(): void;
223
- }
224
-
225
- //#endregion
226
- //#region src/plugins/nodes-selection/types.d.ts
227
- type WeaveNodesSelectionChangeCallback = (nodes: WeaveSelection[]) => void;
228
- type WeaveNodesSelectionStageSelectionCallback = () => void;
229
- type WeaveNodesSelectionPluginCallbacks = {
230
- onNodesChange: WeaveNodesSelectionChangeCallback;
231
- onStageSelection?: WeaveNodesSelectionStageSelectionCallback;
232
- };
233
-
234
- //#endregion
235
- //#region src/plugins/nodes-selection/nodes-selection.d.ts
236
- declare class WeaveNodesSelectionPlugin extends WeavePlugin {
237
- private tr;
238
- private selectionRectangle;
239
- private active;
240
- private cameFromSelectingMultiple;
241
- private selecting;
242
- private initialized;
243
- private callbacks;
244
- onRender: undefined;
245
- constructor(callbacks: WeaveNodesSelectionPluginCallbacks);
246
- getName(): string;
247
- getLayerName(): string;
248
- initLayer(): void;
249
- onInit(): void;
250
- private getLayer;
251
- private triggerSelectedNodesEvent;
252
- private initEvents;
253
- getTransformer(): Konva.Transformer;
254
- setSelectedNodes(nodes: Konva.Node[]): void;
255
- getSelectedNodes(): (Konva.Group | Konva.Shape)[];
256
- removeSelectedNodes(): void;
257
- selectAll(): void;
258
- selectNone(): void;
259
- enable(): void;
260
- disable(): void;
261
- }
262
-
263
- //#endregion
264
- //#region src/nodes/node.d.ts
265
- declare abstract class WeaveNode implements WeaveNodeBase {
266
- protected instance: Weave;
267
- protected nodeType: string;
268
- private logger;
269
- protected previousPointer: string | null;
270
- register(instance: Weave): WeaveNode;
271
- getNodeType(): string;
272
- getLogger(): Logger;
273
- getSelectionPlugin(): WeaveNodesSelectionPlugin;
274
- isSelecting(): boolean;
275
- isPasting(): boolean;
276
- isNodeSelected(ele: Konva.Node): boolean;
277
- setupDefaultNodeEvents(node: Konva.Node): void;
278
- create(key: string, props: WeaveElementAttributes): WeaveStateElement;
279
- abstract onRender(props: WeaveElementAttributes): WeaveElementInstance;
280
- abstract onUpdate(instance: WeaveElementInstance, nextProps: WeaveElementAttributes): void;
281
- onDestroy(nodeInstance: WeaveElementInstance): void;
282
- serialize(instance: WeaveElementInstance): WeaveStateElement;
283
- }
284
-
285
- //#endregion
286
- //#region src/actions/types.d.ts
287
- type WeaveActionPropsChangeCallback = (props: WeaveElementAttributes) => void;
288
- type WeaveActionCallbacks = {
289
- onPropsChange?: WeaveActionPropsChangeCallback;
290
- };
291
-
292
- //#endregion
293
- //#region src/actions/action.d.ts
294
- declare abstract class WeaveAction {
295
- protected instance: Weave;
296
- protected name: string;
297
- props: WeaveElementAttributes;
298
- protected callbacks: WeaveActionCallbacks | undefined;
299
- private logger;
300
- constructor(callbacks?: WeaveActionCallbacks);
301
- getName(): string;
302
- getLogger(): Logger;
303
- register(instance: Weave): WeaveAction;
304
- updateProps(props: WeaveElementAttributes): void;
305
- getProps(): WeaveElementAttributes;
306
- abstract onInit?(): void;
307
- abstract trigger(cancelAction: () => void, params?: unknown): unknown;
308
- abstract internalUpdate?(): void;
309
- abstract cleanup?(): void;
310
- }
311
-
312
- //#endregion
313
- //#region src/logger/logger.d.ts
314
- declare class WeaveLogger {
315
- private config;
316
- private disabled;
317
- private logger;
318
- constructor(config: WeaveLoggerConfig);
319
- private log;
320
- getDisabled(): boolean;
321
- getLevel(): pino.LevelWithSilentOrString;
322
- getLogger(): Logger;
323
- getChildLogger(name: string): pino.Logger<never, boolean>;
324
- }
325
-
326
- //#endregion
327
- //#region src/managers/register.d.ts
328
- declare class WeaveRegisterManager {
329
- private instance;
330
- private nodesHandlers;
331
- private actionsHandlers;
332
- private plugins;
333
- private logger;
334
- constructor(instance: Weave);
335
- getPlugins(): Record<string, WeavePlugin>;
336
- getNodesHandlers(): Record<string, WeaveNode>;
337
- getActionsHandlers(): Record<string, WeaveAction>;
338
- getPlugin<T extends WeavePlugin>(pluginName: string): T;
339
- getActionHandler<T extends WeaveAction>(actionName: string): T;
340
- getNodeHandler(nodeType: string): WeaveNode;
341
- registerPlugins(): void;
342
- registerPlugin(plugin: WeavePlugin): void;
343
- registerNodesHandlers(): void;
344
- registerNodeHandler(node: WeaveNode): void;
345
- registerActionsHandlers(): void;
346
- registerActionHandler(action: WeaveAction): void;
347
- }
348
-
349
- //#endregion
350
- //#region src/managers/stage.d.ts
351
- declare class WeaveStageManager {
352
- private instance;
353
- private logger;
354
- private stage;
355
- private config;
356
- constructor(instance: Weave, config: Konva.StageConfig);
357
- getConfiguration(): StageConfig;
358
- setStage(stage: Konva.Stage): void;
359
- getStage(): Konva.Stage;
360
- getMainLayer(): Konva.Layer | undefined;
361
- getInstanceRecursive(instance: Konva.Node, filterInstanceType?: string[]): Konva.Node;
362
- initStage(): void;
363
- }
364
-
365
- //#endregion
366
- //#region src/weave.d.ts
367
- declare class Weave extends Emittery {
368
- private id;
369
- private config;
370
- private logger;
371
- private moduleLogger;
372
- private reconciler;
373
- private stateSerializer;
374
- private renderer;
375
- private status;
376
- private setupManager;
377
- private registerManager;
378
- private stateManager;
379
- private storeManager;
380
- private stageManager;
381
- private groupsManager;
382
- private targetingManager;
383
- private cloningManager;
384
- private fontsManager;
385
- private zIndexManager;
386
- private pluginsManager;
387
- private actionsManager;
388
- private exportManager;
389
- constructor(weaveConfig: WeaveConfig, stageConfig: Konva.StageConfig);
390
- setupRenderer(): void;
391
- setStatus(status: WeaveStatus): void;
392
- getStatus(): WeaveStatus;
393
- setStore(store: WeaveStore): void;
394
- start(): Promise<void>;
395
- getId(): string;
396
- getConfiguration(): WeaveConfig;
397
- emitEvent<T>(event: string, payload: T): void;
398
- addEventListener<T>(event: string, callback: (payload: T) => void): void;
399
- removeEventListener<T>(event: string, callback: (payload: T) => void): void;
400
- getLogger(): WeaveLogger;
401
- getMainLogger(): Logger;
402
- getChildLogger(name: string): pino.Logger<never, boolean>;
403
- getStageManager(): WeaveStageManager;
404
- getStage(): Konva.Stage;
405
- getMainLayer(): Konva.Layer | undefined;
406
- setStage(stage: Konva.Stage): void;
407
- getStageConfiguration(): StageConfig;
408
- getInstanceRecursive(instance: Konva.Node, filterInstanceType?: string[]): Konva.Node;
409
- getRegisterManager(): WeaveRegisterManager;
410
- getPlugins(): Record<string, WeavePlugin>;
411
- getPlugin<T extends WeavePlugin>(pluginName: string): T;
412
- getNodesHandlers(): Record<string, WeaveNode>;
413
- getNodeHandler<T extends WeaveNode>(nodeType: string): T;
414
- getActionsHandlers(): Record<string, WeaveAction>;
415
- getActionHandler<T extends WeaveAction>(actionName: string): T;
416
- getStore<T extends WeaveStore>(): T;
417
- registerPlugin(plugin: WeavePlugin): void;
418
- registerNodeHandler(node: WeaveNode): void;
419
- registerActionHandler(action: WeaveAction): void;
420
- registerStore(store: WeaveStore): void;
421
- isPluginEnabled(pluginName: string): boolean;
422
- enablePlugin(pluginName: string): void;
423
- disablePlugin(pluginName: string): void;
424
- getActiveAction(): string | undefined;
425
- triggerAction<T>(actionName: string, params?: T): unknown;
426
- getPropsAction(actionName: string): WeaveElementAttributes;
427
- updatePropsAction(actionName: string, params: WeaveElementAttributes): void;
428
- cancelAction(actionName: string): void;
429
- update(newState: WeaveState): void;
430
- render(): void;
431
- findNodeById(tree: WeaveStateElement, key: string, parent?: WeaveStateElement | null, index?: number): WeaveNodeFound;
432
- findNodesByType(tree: WeaveStateElement, nodeType: string): WeaveStateElement[];
433
- getNode(nodeKey: string): {
434
- node: WeaveStateElement | null;
435
- parent: WeaveStateElement | null;
436
- index: number;
437
- };
438
- addNode(node: WeaveStateElement, parentId?: string, index?: number | undefined, doRender?: boolean): void;
439
- updateNode(node: WeaveStateElement, doRender?: boolean): void;
440
- removeNode(node: WeaveStateElement, doRender?: boolean): void;
441
- removeNodes(nodes: WeaveStateElement[], doRender?: boolean): void;
442
- moveNode(node: WeaveStateElement, position: WeavePosition, doRender?: boolean): void;
443
- moveUp(node: WeaveElementInstance): void;
444
- moveDown(node: WeaveElementInstance): void;
445
- sendToBack(node: WeaveElementInstance): void;
446
- bringToFront(node: WeaveElementInstance): void;
447
- group(nodes: WeaveStateElement[]): void;
448
- unGroup(group: WeaveStateElement): void;
449
- getMousePointer(point?: Vector2d): WeaveMousePointInfo;
450
- getMousePointerRelativeToContainer(container: Konva.Group | Konva.Layer): WeaveMousePointInfoSimple;
451
- nodesToGroupSerialized(instancesToClone: Konva.Node[]): WeaveSerializedGroup;
452
- cloneNodes(instancesToClone: Konva.Node[], targetContainer: Konva.Layer | Konva.Group | undefined, onPoint: Vector2d): void;
453
- getFonts(): WeaveFont[];
454
- exportStage(options: WeaveExportNodeOptions): Promise<HTMLImageElement>;
455
- exportNode(node: WeaveElementInstance, options: WeaveExportNodeOptions): Promise<HTMLImageElement>;
456
- } //#endregion
457
- //#region ../types/dist/types.d.ts
458
-
459
- //#endregion
460
- //#region src/utils.d.ts
461
10
  //#endregion
462
11
  //#region src/base/store.d.ts
463
12
  type WeaveStoreOptions = {
@@ -472,9 +21,7 @@ type WeaveUser = {
472
21
  type WeaveUndoManagerOptions = {
473
22
  captureTimeout?: number;
474
23
  trackedOrigins?: Set<any>;
475
- };
476
-
477
- //#endregion
24
+ }; //#endregion
478
25
  //#region src/constants.d.ts
479
26
  declare const WEAVE_STORE_WEBSOCKETS = "store-websockets";
480
27
  declare const WEAVE_STORE_WEBSOCKETS_CONNECTION_STATUS: {
package/dist/client.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { WeaveStore } from "@inditextech/weave-sdk";
2
- import "@inditextech/weave-types";
2
+ import "konva";
3
3
  import "yjs";
4
4
  import { IncomingMessage } from "http";
5
5
  import { WebsocketProvider } from "y-websocket";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inditextech/weave-store-websockets",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
4
4
  "type": "module",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Jesus Manuel Piñeiro Cid <jesusmpc@inditex.com>",
@@ -49,8 +49,6 @@
49
49
  "version:release": "npm version $RELEASE_VERSION -m \"[npm-scripts] prepare release $RELEASE_VERSION\" --tag-version-prefix \"\""
50
50
  },
51
51
  "dependencies": {
52
- "@inditextech/weave-sdk": "0.3.0",
53
- "@inditextech/weave-types": "0.3.0",
54
52
  "@syncedstore/core": "0.6.0",
55
53
  "konva": "9.3.20",
56
54
  "ws": "8.18.1",
@@ -58,6 +56,7 @@
58
56
  "yjs": "13.6.26"
59
57
  },
60
58
  "devDependencies": {
59
+ "@inditextech/weave-sdk": "0.3.2",
61
60
  "@types/express": "^5.0.1",
62
61
  "@types/lodash.debounce": "^4.0.9",
63
62
  "@types/node": "^22.15.3",
@@ -77,6 +76,9 @@
77
76
  "vitest": "1.6.0",
78
77
  "vitest-sonar-reporter": "2.0.0"
79
78
  },
79
+ "peerDependencies": {
80
+ "@inditextech/weave-sdk": "0.4.0-SNAPSHOT"
81
+ },
80
82
  "engines": {
81
83
  "node": "^18.12 || ^20.11 || ^22.11",
82
84
  "npm": ">= 8.19.x"