@chili-publish/studio-sdk 1.18.0 → 1.20.0
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/_bundles/main.js +1 -1
- package/_bundles/main.js.map +1 -1
- package/_bundles/report.html +2 -2
- package/lib/editor-engine.json +1 -1
- package/lib/package.json +1 -1
- package/lib/src/controllers/FrameController.d.ts +30 -9
- package/lib/src/controllers/FrameController.js +52 -10
- package/lib/src/controllers/FrameController.js.map +1 -1
- package/lib/src/controllers/LayoutController.d.ts +58 -2
- package/lib/src/controllers/LayoutController.js +84 -0
- package/lib/src/controllers/LayoutController.js.map +1 -1
- package/lib/src/controllers/PageController.d.ts +7 -3
- package/lib/src/controllers/PageController.js +9 -3
- package/lib/src/controllers/PageController.js.map +1 -1
- package/lib/src/controllers/SubscriberController.d.ts +13 -2
- package/lib/src/controllers/SubscriberController.js +53 -85
- package/lib/src/controllers/SubscriberController.js.map +1 -1
- package/lib/src/controllers/ToolController.d.ts +1 -1
- package/lib/src/controllers/ToolController.js +1 -1
- package/lib/src/controllers/UndoManagerController.d.ts +19 -0
- package/lib/src/controllers/UndoManagerController.js +28 -0
- package/lib/src/controllers/UndoManagerController.js.map +1 -1
- package/lib/src/controllers/UtilsController.d.ts +1 -1
- package/lib/src/controllers/UtilsController.js +1 -1
- package/lib/src/controllers/VariableController.d.ts +24 -6
- package/lib/src/controllers/VariableController.js +38 -8
- package/lib/src/controllers/VariableController.js.map +1 -1
- package/lib/src/index.d.ts +23 -21
- package/lib/src/index.js +11 -10
- package/lib/src/index.js.map +1 -1
- package/lib/src/interactions/{connector.d.ts → Connector.d.ts} +2 -0
- package/lib/src/interactions/{connector.js → Connector.js} +3 -1
- package/lib/src/interactions/{connector.js.map → Connector.js.map} +1 -1
- package/lib/src/next/NextInitiator.d.ts +2 -2
- package/lib/src/next/NextInitiator.js.map +1 -1
- package/lib/src/next/controllers/SubscriberController.d.ts +2 -2
- package/lib/src/next/controllers/SubscriberController.js +2 -4
- package/lib/src/next/controllers/SubscriberController.js.map +1 -1
- package/lib/src/next/tests/controllers/ConnectorController.test.js +1 -1
- package/lib/src/next/tests/controllers/ConnectorController.test.js.map +1 -1
- package/lib/src/next/tests/controllers/SubscriberContoller.test.js +5 -4
- package/lib/src/next/tests/controllers/SubscriberContoller.test.js.map +1 -1
- package/lib/src/next/tests/controllers/VariableController.test.js +3 -2
- package/lib/src/next/tests/controllers/VariableController.test.js.map +1 -1
- package/lib/src/next/types/NextSubscribers.d.ts +2 -1
- package/lib/src/sdk.d.ts +10 -10
- package/lib/src/sdk.js +24 -13
- package/lib/src/sdk.js.map +1 -1
- package/lib/src/tests/__mocks__/{animations.js → Animations.js} +1 -1
- package/lib/src/tests/__mocks__/Animations.js.map +1 -0
- package/lib/src/tests/__mocks__/{config.d.ts → Config.d.ts} +2 -2
- package/lib/src/tests/__mocks__/{config.js → Config.js} +5 -3
- package/lib/src/tests/__mocks__/Config.js.map +1 -0
- package/lib/src/tests/controllers/AnimationController.test.js +1 -1
- package/lib/src/tests/controllers/CharacterStyleController.test.js +1 -0
- package/lib/src/tests/controllers/CharacterStyleController.test.js.map +1 -1
- package/lib/src/tests/controllers/FrameController.test.js +29 -8
- package/lib/src/tests/controllers/FrameController.test.js.map +1 -1
- package/lib/src/tests/controllers/LayoutController.test.js +64 -1
- package/lib/src/tests/controllers/LayoutController.test.js.map +1 -1
- package/lib/src/tests/controllers/PageController.test.js +11 -6
- package/lib/src/tests/controllers/PageController.test.js.map +1 -1
- package/lib/src/tests/controllers/SubscriberContoller.test.js +46 -33
- package/lib/src/tests/controllers/SubscriberContoller.test.js.map +1 -1
- package/lib/src/tests/controllers/UndoManagerController.test.js +22 -1
- package/lib/src/tests/controllers/UndoManagerController.test.js.map +1 -1
- package/lib/src/tests/controllers/UtilsController.test.js +1 -1
- package/lib/src/tests/controllers/VariableController.test.js +47 -14
- package/lib/src/tests/controllers/VariableController.test.js.map +1 -1
- package/lib/src/tests/index.test.js +1 -1
- package/lib/src/tests/interactions/{connector.test.js → Connector.test.js} +2 -2
- package/lib/src/tests/interactions/{connector.test.js.map → Connector.test.js.map} +1 -1
- package/lib/src/tests/utils/{editorResponseData.test.js → EditorResponseData.test.js} +1 -1
- package/lib/src/tests/utils/{editorResponseData.test.js.map → EditorResponseData.test.js.map} +1 -1
- package/lib/src/tests/utils/EventSubscription.test.js +238 -0
- package/lib/src/tests/utils/EventSubscription.test.js.map +1 -0
- package/lib/src/tests/utils/Logging.test.d.ts +1 -0
- package/lib/src/tests/utils/Logging.test.js +99 -0
- package/lib/src/tests/utils/Logging.test.js.map +1 -0
- package/lib/src/tests/utils/Round.test.d.ts +1 -0
- package/lib/src/tests/utils/{round.test.js → Round.test.js} +1 -1
- package/lib/src/tests/utils/{round.test.js.map → Round.test.js.map} +1 -1
- package/lib/src/types/CommonTypes.d.ts +226 -21
- package/lib/src/types/CommonTypes.js +27 -0
- package/lib/src/types/CommonTypes.js.map +1 -1
- package/lib/src/types/DocumentTypes.d.ts +0 -1
- package/lib/src/types/DocumentTypes.js.map +1 -1
- package/lib/src/types/EngineEditModeTypes.d.ts +11 -0
- package/lib/src/types/EngineEditModeTypes.js +8 -0
- package/lib/src/types/EngineEditModeTypes.js.map +1 -0
- package/lib/src/types/FrameTypes.d.ts +16 -2
- package/lib/src/types/FrameTypes.js +15 -1
- package/lib/src/types/FrameTypes.js.map +1 -1
- package/lib/src/types/LayoutTypes.d.ts +33 -1
- package/lib/src/types/LayoutTypes.js.map +1 -1
- package/lib/src/types/PageTypes.d.ts +18 -0
- package/lib/src/types/VariableTypes.d.ts +61 -1
- package/lib/src/types/VariableTypes.js +21 -0
- package/lib/src/types/VariableTypes.js.map +1 -1
- package/lib/src/utils/ConfigHelper.d.ts +11 -0
- package/lib/src/utils/ConfigHelper.js +90 -0
- package/lib/src/utils/ConfigHelper.js.map +1 -0
- package/lib/src/utils/EngineCallbackHandler.d.ts +13 -0
- package/lib/src/utils/EngineCallbackHandler.js +23 -0
- package/lib/src/utils/EngineCallbackHandler.js.map +1 -0
- package/lib/src/utils/EngineEvent.d.ts +29 -0
- package/lib/src/utils/EngineEvent.js +44 -0
- package/lib/src/utils/EngineEvent.js.map +1 -0
- package/lib/src/utils/EngineEventTrigger.d.ts +8 -0
- package/lib/src/utils/EngineEventTrigger.js +33 -0
- package/lib/src/utils/EngineEventTrigger.js.map +1 -0
- package/lib/src/utils/{enums.js → Enums.js} +1 -1
- package/lib/src/utils/{enums.js.map → Enums.js.map} +1 -1
- package/package.json +1 -1
- package/lib/src/tests/__mocks__/animations.js.map +0 -1
- package/lib/src/tests/__mocks__/config.js.map +0 -1
- /package/lib/src/tests/__mocks__/{animations.d.ts → Animations.d.ts} +0 -0
- /package/lib/src/tests/interactions/{connector.test.d.ts → Connector.test.d.ts} +0 -0
- /package/lib/src/tests/utils/{editorResponseData.test.d.ts → EditorResponseData.test.d.ts} +0 -0
- /package/lib/src/tests/utils/{round.test.d.ts → EventSubscription.test.d.ts} +0 -0
- /package/lib/src/utils/{enums.d.ts → Enums.d.ts} +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ColorUsage } from './ColorStyleTypes';
|
|
2
|
-
import { Id, PropertyState } from './CommonTypes';
|
|
2
|
+
import { Id, PrivateData, PropertyState } from './CommonTypes';
|
|
3
3
|
export declare type LayoutPropertiesType = {
|
|
4
4
|
id: Id;
|
|
5
5
|
width: {
|
|
@@ -44,6 +44,8 @@ export declare type LayoutWithFrameProperties = {
|
|
|
44
44
|
export declare type Layout = {
|
|
45
45
|
id: Id;
|
|
46
46
|
name: string;
|
|
47
|
+
displayName?: string | null;
|
|
48
|
+
privateData: PrivateData;
|
|
47
49
|
parentId?: Id;
|
|
48
50
|
width: PropertyState<number>;
|
|
49
51
|
height: PropertyState<number>;
|
|
@@ -54,11 +56,17 @@ export declare type Layout = {
|
|
|
54
56
|
bleed: PropertyState<LayoutBleed>;
|
|
55
57
|
fillColor: PropertyState<ColorUsage>;
|
|
56
58
|
fillColorEnabled: PropertyState<boolean>;
|
|
59
|
+
availableForUser: boolean;
|
|
60
|
+
selectedByUser: boolean;
|
|
61
|
+
resizableByUser: ResizableLayoutProperties;
|
|
57
62
|
};
|
|
58
63
|
export declare type LayoutListItemType = {
|
|
59
64
|
id: string;
|
|
60
65
|
name: string;
|
|
66
|
+
displayName?: string | null;
|
|
61
67
|
type: LayoutType;
|
|
68
|
+
availableForUser: boolean;
|
|
69
|
+
selectedByUser: boolean;
|
|
62
70
|
parentId?: Id | null;
|
|
63
71
|
childLayouts: Id[];
|
|
64
72
|
};
|
|
@@ -107,3 +115,27 @@ export declare enum LayoutIntent {
|
|
|
107
115
|
digitalStatic = "digitalStatic",
|
|
108
116
|
digitalAnimated = "digitalAnimated"
|
|
109
117
|
}
|
|
118
|
+
export declare type ResizableLayoutProperties = {
|
|
119
|
+
enabled: boolean;
|
|
120
|
+
minWidth: number | null;
|
|
121
|
+
maxWidth: number | null;
|
|
122
|
+
minHeight: number | null;
|
|
123
|
+
maxHeight: number | null;
|
|
124
|
+
};
|
|
125
|
+
export declare type ResizableLayoutPropertiesUpdate = {
|
|
126
|
+
enabled?: {
|
|
127
|
+
value: boolean;
|
|
128
|
+
} | null;
|
|
129
|
+
minWidth?: {
|
|
130
|
+
value: string | null;
|
|
131
|
+
} | null;
|
|
132
|
+
maxWidth?: {
|
|
133
|
+
value: string | null;
|
|
134
|
+
} | null;
|
|
135
|
+
minHeight?: {
|
|
136
|
+
value: string | null;
|
|
137
|
+
} | null;
|
|
138
|
+
maxHeight?: {
|
|
139
|
+
value: string | null;
|
|
140
|
+
} | null;
|
|
141
|
+
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"LayoutTypes.js","sourceRoot":"","sources":["../../../src/types/LayoutTypes.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"LayoutTypes.js","sourceRoot":"","sources":["../../../src/types/LayoutTypes.ts"],"names":[],"mappings":"AAiGA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,2BAAW,CAAA;IACX,+BAAe,CAAA;IACf,iCAAiB,CAAA;IACjB,6BAAa,CAAA;AACjB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IAClB,yBAAW,CAAA;IACX,6BAAe,CAAA;AACnB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,gCAAa,CAAA;IACb,4BAAS,CAAA;AACb,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B;AAED,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,+BAAe,CAAA;IACf,+CAA+B,CAAA;IAC/B,mDAAmC,CAAA;AACvC,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB"}
|
|
@@ -11,3 +11,21 @@ export declare type PageSize = {
|
|
|
11
11
|
width: number;
|
|
12
12
|
height: number;
|
|
13
13
|
};
|
|
14
|
+
export interface SnapshotSettings {
|
|
15
|
+
/**
|
|
16
|
+
* The maximum size of the snapshot's longest dimension in pixels.
|
|
17
|
+
* - If set to a number (e.g., 100), the longest side of the snapshot will be limited to that value.
|
|
18
|
+
* - In case when layout size is smaller than the specified value, the snapshot will be upscaled.
|
|
19
|
+
* - If set to `null` or ignored, the snapshot will use the full page dimensions.
|
|
20
|
+
* - The maximum allowed value is 1000 pixels.
|
|
21
|
+
*/
|
|
22
|
+
largestAxisSize?: number | null;
|
|
23
|
+
/**
|
|
24
|
+
* The maximum time to wait in milliseconds for the assets to load before the snapshot is taken.
|
|
25
|
+
*
|
|
26
|
+
* When the time is exceeded, the snapshot will be taken even if not all assets are loaded yet.
|
|
27
|
+
*
|
|
28
|
+
* When not defined, the default value is 10000 ms.
|
|
29
|
+
*/
|
|
30
|
+
maxWaitTimeMs?: number | null;
|
|
31
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { PrivateData } from './CommonTypes';
|
|
1
2
|
export interface ConnectorImageVariableSource {
|
|
2
3
|
connectorId: string;
|
|
3
4
|
/**
|
|
@@ -37,6 +38,7 @@ export interface Variable {
|
|
|
37
38
|
name: string;
|
|
38
39
|
label?: string | null;
|
|
39
40
|
isVisible: boolean;
|
|
41
|
+
visibility: VariableVisibility;
|
|
40
42
|
isReadonly: boolean;
|
|
41
43
|
isRequired: boolean;
|
|
42
44
|
occurrences: number;
|
|
@@ -44,7 +46,6 @@ export interface Variable {
|
|
|
44
46
|
helpText?: string | null;
|
|
45
47
|
privateData: PrivateData;
|
|
46
48
|
}
|
|
47
|
-
export declare type PrivateData = Record<string, string>;
|
|
48
49
|
export interface ImageVariable extends Variable {
|
|
49
50
|
value?: ConnectorImageVariableSource;
|
|
50
51
|
}
|
|
@@ -185,3 +186,62 @@ export interface PrefixSuffixDeltaUpdate {
|
|
|
185
186
|
value: string | null;
|
|
186
187
|
};
|
|
187
188
|
}
|
|
189
|
+
export declare enum VariableVisibilityType {
|
|
190
|
+
visible = "visible",
|
|
191
|
+
invisible = "invisible",
|
|
192
|
+
conditional = "conditional"
|
|
193
|
+
}
|
|
194
|
+
export declare enum VariableVisibilityTargetType {
|
|
195
|
+
boolean = "boolean",
|
|
196
|
+
text = "text",
|
|
197
|
+
number = "number"
|
|
198
|
+
}
|
|
199
|
+
export declare enum VariableVisibilityOperator {
|
|
200
|
+
equals = "=",
|
|
201
|
+
notEquals = "!=",
|
|
202
|
+
greaterThan = ">",
|
|
203
|
+
greaterThanOrEquals = ">=",
|
|
204
|
+
lessThan = "<",
|
|
205
|
+
lessThanOrEquals = "<="
|
|
206
|
+
}
|
|
207
|
+
export interface VariableVisibilityBase {
|
|
208
|
+
type: VariableVisibilityType;
|
|
209
|
+
}
|
|
210
|
+
export interface VariableVisibilityVisible extends VariableVisibilityBase {
|
|
211
|
+
type: VariableVisibilityType.visible;
|
|
212
|
+
}
|
|
213
|
+
export interface VariableVisibilityInvisible extends VariableVisibilityBase {
|
|
214
|
+
type: VariableVisibilityType.invisible;
|
|
215
|
+
}
|
|
216
|
+
export interface VariableVisibilityConditional extends VariableVisibilityBase {
|
|
217
|
+
type: VariableVisibilityType.conditional;
|
|
218
|
+
layouts: VariableVisibilityLayout[];
|
|
219
|
+
variables: VariableWithValue[];
|
|
220
|
+
}
|
|
221
|
+
export declare type VariableVisibility = VariableVisibilityVisible | VariableVisibilityInvisible | VariableVisibilityConditional;
|
|
222
|
+
export interface VariableVisibilityLayout {
|
|
223
|
+
layoutId: string;
|
|
224
|
+
includeChildren: boolean;
|
|
225
|
+
}
|
|
226
|
+
export interface VariableWithValue {
|
|
227
|
+
id: string;
|
|
228
|
+
value: VariableVisibilityConditionValue;
|
|
229
|
+
}
|
|
230
|
+
export interface VariableVisibilityConditionValueBase {
|
|
231
|
+
type: VariableVisibilityTargetType;
|
|
232
|
+
}
|
|
233
|
+
export interface VariableVisibilityConditionValueBoolean extends VariableVisibilityConditionValueBase {
|
|
234
|
+
type: VariableVisibilityTargetType.boolean;
|
|
235
|
+
value: boolean;
|
|
236
|
+
}
|
|
237
|
+
export interface VariableVisibilityConditionValueText extends VariableVisibilityConditionValueBase {
|
|
238
|
+
type: VariableVisibilityTargetType.text;
|
|
239
|
+
value: string;
|
|
240
|
+
operator: VariableVisibilityOperator;
|
|
241
|
+
}
|
|
242
|
+
export interface VariableVisibilityConditionValueNumber extends VariableVisibilityConditionValueBase {
|
|
243
|
+
type: VariableVisibilityTargetType.number;
|
|
244
|
+
value: number;
|
|
245
|
+
operator: VariableVisibilityOperator;
|
|
246
|
+
}
|
|
247
|
+
export declare type VariableVisibilityConditionValue = VariableVisibilityConditionValueBoolean | VariableVisibilityConditionValueText | VariableVisibilityConditionValueNumber;
|
|
@@ -35,4 +35,25 @@ export var Locale;
|
|
|
35
35
|
Locale["es_ES"] = "es_ES";
|
|
36
36
|
Locale["sv"] = "sv";
|
|
37
37
|
})(Locale || (Locale = {}));
|
|
38
|
+
export var VariableVisibilityType;
|
|
39
|
+
(function (VariableVisibilityType) {
|
|
40
|
+
VariableVisibilityType["visible"] = "visible";
|
|
41
|
+
VariableVisibilityType["invisible"] = "invisible";
|
|
42
|
+
VariableVisibilityType["conditional"] = "conditional";
|
|
43
|
+
})(VariableVisibilityType || (VariableVisibilityType = {}));
|
|
44
|
+
export var VariableVisibilityTargetType;
|
|
45
|
+
(function (VariableVisibilityTargetType) {
|
|
46
|
+
VariableVisibilityTargetType["boolean"] = "boolean";
|
|
47
|
+
VariableVisibilityTargetType["text"] = "text";
|
|
48
|
+
VariableVisibilityTargetType["number"] = "number";
|
|
49
|
+
})(VariableVisibilityTargetType || (VariableVisibilityTargetType = {}));
|
|
50
|
+
export var VariableVisibilityOperator;
|
|
51
|
+
(function (VariableVisibilityOperator) {
|
|
52
|
+
VariableVisibilityOperator["equals"] = "=";
|
|
53
|
+
VariableVisibilityOperator["notEquals"] = "!=";
|
|
54
|
+
VariableVisibilityOperator["greaterThan"] = ">";
|
|
55
|
+
VariableVisibilityOperator["greaterThanOrEquals"] = ">=";
|
|
56
|
+
VariableVisibilityOperator["lessThan"] = "<";
|
|
57
|
+
VariableVisibilityOperator["lessThanOrEquals"] = "<=";
|
|
58
|
+
})(VariableVisibilityOperator || (VariableVisibilityOperator = {}));
|
|
38
59
|
//# sourceMappingURL=VariableTypes.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VariableTypes.js","sourceRoot":"","sources":["../../../src/types/VariableTypes.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"VariableTypes.js","sourceRoot":"","sources":["../../../src/types/VariableTypes.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACpB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,+BAAe,CAAA;IACf,6BAAa,CAAA;IACb,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,iCAAiB,CAAA;IACjB,6BAAa,CAAA;AACjB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AA0FD,MAAM,CAAN,IAAY,GAQX;AARD,WAAY,GAAG;IACX,wBAAiB,CAAA;IACjB,0BAAmB,CAAA;IACnB,8BAAuB,CAAA;IACvB,4BAAqB,CAAA;IACrB,wBAAiB,CAAA;IACjB,4BAAqB,CAAA;IACrB,wBAAiB,CAAA;AACrB,CAAC,EARW,GAAG,KAAH,GAAG,QAQd;AAED,MAAM,CAAN,IAAY,MAcX;AAdD,WAAY,MAAM;IACd,yBAAe,CAAA;IACf,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,mBAAS,CAAA;IACT,yBAAe,CAAA;IACf,yBAAe,CAAA;IACf,mBAAS,CAAA;AACb,CAAC,EAdW,MAAM,KAAN,MAAM,QAcjB;AA8DD,MAAM,CAAN,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAC9B,6CAAmB,CAAA;IACnB,iDAAuB,CAAA;IACvB,qDAA2B,CAAA;AAC/B,CAAC,EAJW,sBAAsB,KAAtB,sBAAsB,QAIjC;AAED,MAAM,CAAN,IAAY,4BAIX;AAJD,WAAY,4BAA4B;IACpC,mDAAmB,CAAA;IACnB,6CAAa,CAAA;IACb,iDAAiB,CAAA;AACrB,CAAC,EAJW,4BAA4B,KAA5B,4BAA4B,QAIvC;AAED,MAAM,CAAN,IAAY,0BAOX;AAPD,WAAY,0BAA0B;IAClC,0CAAY,CAAA;IACZ,8CAAgB,CAAA;IAChB,+CAAiB,CAAA;IACjB,wDAA0B,CAAA;IAC1B,4CAAc,CAAA;IACd,qDAAuB,CAAA;AAC3B,CAAC,EAPW,0BAA0B,KAA1B,0BAA0B,QAOrC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ConfigType, RuntimeConfigType } from '../types/CommonTypes';
|
|
2
|
+
export declare class ConfigHelper {
|
|
3
|
+
/**
|
|
4
|
+
* Creates a runtime configuration object from the provided configuration object.
|
|
5
|
+
*
|
|
6
|
+
* @param config The configuration object to create the runtime configuration object from.
|
|
7
|
+
* @returns The runtime configuration object.
|
|
8
|
+
*/
|
|
9
|
+
static createRuntimeConfig(config: ConfigType): RuntimeConfigType;
|
|
10
|
+
private static isLoggingEnabled;
|
|
11
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { LogLevel, } from '../types/CommonTypes';
|
|
2
|
+
import { EngineCallbackHandler } from './EngineCallbackHandler';
|
|
3
|
+
import { EngineEvent } from './EngineEvent';
|
|
4
|
+
export class ConfigHelper {
|
|
5
|
+
/**
|
|
6
|
+
* Creates a runtime configuration object from the provided configuration object.
|
|
7
|
+
*
|
|
8
|
+
* @param config The configuration object to create the runtime configuration object from.
|
|
9
|
+
* @returns The runtime configuration object.
|
|
10
|
+
*/
|
|
11
|
+
static createRuntimeConfig(config) {
|
|
12
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9;
|
|
13
|
+
// we need a reference to the clone object in the engineEvent, so we need to create the object in 2 steps
|
|
14
|
+
const clone = Object.assign({}, config);
|
|
15
|
+
clone.logging = {
|
|
16
|
+
logLevel: ((_a = config.logging) === null || _a === void 0 ? void 0 : _a.logLevel) || LogLevel.error,
|
|
17
|
+
logger: ((_b = config.logging) === null || _b === void 0 ? void 0 : _b.logger) ||
|
|
18
|
+
((level, cat, msg) => {
|
|
19
|
+
var _a, _b;
|
|
20
|
+
if (!ConfigHelper.isLoggingEnabled(level, (_b = (_a = clone.logging) === null || _a === void 0 ? void 0 : _a.logLevel) !== null && _b !== void 0 ? _b : LogLevel.error)) {
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
switch (level) {
|
|
24
|
+
case LogLevel.error:
|
|
25
|
+
console.error(`[${cat}] [${level}] ${msg}`);
|
|
26
|
+
break;
|
|
27
|
+
case LogLevel.warn:
|
|
28
|
+
console.warn(`[${cat}] [${level}] ${msg}`);
|
|
29
|
+
break;
|
|
30
|
+
default:
|
|
31
|
+
console.log(`[${cat}] [${level}] ${msg}`);
|
|
32
|
+
}
|
|
33
|
+
}),
|
|
34
|
+
};
|
|
35
|
+
clone.handlers = {
|
|
36
|
+
onAuthExpired: new EngineCallbackHandler(() => clone.onAuthExpired, (_c = clone.logging) === null || _c === void 0 ? void 0 : _c.logger),
|
|
37
|
+
onViewportRequested: new EngineCallbackHandler(() => clone.onViewportRequested, (_d = clone.logging) === null || _d === void 0 ? void 0 : _d.logger),
|
|
38
|
+
};
|
|
39
|
+
clone.events = {
|
|
40
|
+
onActionsChanged: new EngineEvent(() => clone.onActionsChanged, (_e = clone.logging) === null || _e === void 0 ? void 0 : _e.logger),
|
|
41
|
+
onStateChanged: new EngineEvent(() => clone.onStateChanged, (_f = clone.logging) === null || _f === void 0 ? void 0 : _f.logger),
|
|
42
|
+
onDocumentLoaded: new EngineEvent(() => clone.onDocumentLoaded, (_g = clone.logging) === null || _g === void 0 ? void 0 : _g.logger),
|
|
43
|
+
onSelectedFramesLayoutChanged: new EngineEvent(() => clone.onSelectedFramesLayoutChanged, (_h = clone.logging) === null || _h === void 0 ? void 0 : _h.logger),
|
|
44
|
+
onSelectedFramesContentChanged: new EngineEvent(() => clone.onSelectedFramesContentChanged, (_j = clone.logging) === null || _j === void 0 ? void 0 : _j.logger),
|
|
45
|
+
onPageSelectionChanged: new EngineEvent(() => clone.onPageSelectionChanged, (_k = clone.logging) === null || _k === void 0 ? void 0 : _k.logger),
|
|
46
|
+
onSelectedLayoutPropertiesChanged: new EngineEvent(() => clone.onSelectedLayoutPropertiesChanged, (_l = clone.logging) === null || _l === void 0 ? void 0 : _l.logger),
|
|
47
|
+
onSelectedLayoutUnitChanged: new EngineEvent(() => clone.onSelectedLayoutUnitChanged, (_m = clone.logging) === null || _m === void 0 ? void 0 : _m.logger),
|
|
48
|
+
onScrubberPositionChanged: new EngineEvent(() => clone.onScrubberPositionChanged, (_o = clone.logging) === null || _o === void 0 ? void 0 : _o.logger),
|
|
49
|
+
onFrameAnimationsChanged: new EngineEvent(() => clone.onFrameAnimationsChanged, (_p = clone.logging) === null || _p === void 0 ? void 0 : _p.logger),
|
|
50
|
+
onVariableListChanged: new EngineEvent(() => clone.onVariableListChanged, (_q = clone.logging) === null || _q === void 0 ? void 0 : _q.logger),
|
|
51
|
+
onSelectedToolChanged: new EngineEvent(() => clone.onSelectedToolChanged, (_r = clone.logging) === null || _r === void 0 ? void 0 : _r.logger),
|
|
52
|
+
onUndoStackStateChanged: new EngineEvent(() => clone.onUndoStackStateChanged, (_s = clone.logging) === null || _s === void 0 ? void 0 : _s.logger),
|
|
53
|
+
onSelectedLayoutFramesChanged: new EngineEvent(() => clone.onSelectedLayoutFramesChanged, (_t = clone.logging) === null || _t === void 0 ? void 0 : _t.logger),
|
|
54
|
+
onSelectedTextStyleChanged: new EngineEvent(() => clone.onSelectedTextStyleChanged, (_u = clone.logging) === null || _u === void 0 ? void 0 : _u.logger),
|
|
55
|
+
onColorsChanged: new EngineEvent(() => clone.onColorsChanged, (_v = clone.logging) === null || _v === void 0 ? void 0 : _v.logger),
|
|
56
|
+
onParagraphStylesChanged: new EngineEvent(() => clone.onParagraphStylesChanged, (_w = clone.logging) === null || _w === void 0 ? void 0 : _w.logger),
|
|
57
|
+
onCharacterStylesChanged: new EngineEvent(() => clone.onCharacterStylesChanged, (_x = clone.logging) === null || _x === void 0 ? void 0 : _x.logger),
|
|
58
|
+
onFontFamiliesChanged: new EngineEvent(() => clone.onFontFamiliesChanged, (_y = clone.logging) === null || _y === void 0 ? void 0 : _y.logger),
|
|
59
|
+
onSelectedLayoutIdChanged: new EngineEvent(() => clone.onSelectedLayoutIdChanged, (_z = clone.logging) === null || _z === void 0 ? void 0 : _z.logger),
|
|
60
|
+
onLayoutsChanged: new EngineEvent(() => clone.onLayoutsChanged, (_0 = clone.logging) === null || _0 === void 0 ? void 0 : _0.logger),
|
|
61
|
+
onConnectorEvent: new EngineEvent(() => clone.onConnectorEvent, (_1 = clone.logging) === null || _1 === void 0 ? void 0 : _1.logger),
|
|
62
|
+
onConnectorsChanged: new EngineEvent(() => clone.onConnectorsChanged, (_2 = clone.logging) === null || _2 === void 0 ? void 0 : _2.logger),
|
|
63
|
+
onZoomChanged: new EngineEvent(() => clone.onZoomChanged, (_3 = clone.logging) === null || _3 === void 0 ? void 0 : _3.logger),
|
|
64
|
+
onSelectedPageIdChanged: new EngineEvent(() => clone.onSelectedPageIdChanged, clone.logging.logger),
|
|
65
|
+
onPagesChanged: new EngineEvent(() => clone.onPagesChanged, clone.logging.logger),
|
|
66
|
+
onPageSnapshotInvalidated: new EngineEvent(() => clone.onPageSnapshotInvalidated, clone.logging.logger),
|
|
67
|
+
onPageSizeChanged: new EngineEvent(() => clone.onPageSizeChanged, (_4 = clone.logging) === null || _4 === void 0 ? void 0 : _4.logger),
|
|
68
|
+
onShapeCornerRadiusChanged: new EngineEvent(() => clone.onShapeCornerRadiusChanged, (_5 = clone.logging) === null || _5 === void 0 ? void 0 : _5.logger),
|
|
69
|
+
onCropActiveFrameIdChanged: new EngineEvent(() => clone.onCropActiveFrameIdChanged, (_6 = clone.logging) === null || _6 === void 0 ? void 0 : _6.logger),
|
|
70
|
+
onAsyncError: new EngineEvent(() => clone.onAsyncError, (_7 = clone.logging) === null || _7 === void 0 ? void 0 : _7.logger),
|
|
71
|
+
onViewModeChanged: new EngineEvent(() => clone.onViewModeChanged, (_8 = clone.logging) === null || _8 === void 0 ? void 0 : _8.logger),
|
|
72
|
+
onBarcodeValidationChanged: new EngineEvent(() => clone.onBarcodeValidationChanged, (_9 = clone.logging) === null || _9 === void 0 ? void 0 : _9.logger),
|
|
73
|
+
onDataSourceIdChanged: new EngineEvent(() => clone.onDataSourceIdChanged, clone.logging.logger),
|
|
74
|
+
onDocumentIssueListChanged: new EngineEvent(() => clone.onDocumentIssueListChanged, clone.logging.logger),
|
|
75
|
+
onCustomUndoDataChanged: new EngineEvent(() => clone.onCustomUndoDataChanged, clone.logging.logger),
|
|
76
|
+
onEngineEditModeChanged: new EngineEvent(() => clone.onEngineEditModeChanged, clone.logging.logger),
|
|
77
|
+
};
|
|
78
|
+
return clone;
|
|
79
|
+
}
|
|
80
|
+
static isLoggingEnabled(level, logLevel) {
|
|
81
|
+
if (logLevel == LogLevel.info) {
|
|
82
|
+
return true;
|
|
83
|
+
}
|
|
84
|
+
if (logLevel == LogLevel.warn && (level == LogLevel.warn || level == LogLevel.error)) {
|
|
85
|
+
return true;
|
|
86
|
+
}
|
|
87
|
+
return logLevel == LogLevel.error && level == LogLevel.error;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
//# sourceMappingURL=ConfigHelper.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ConfigHelper.js","sourceRoot":"","sources":["../../../src/utils/ConfigHelper.ts"],"names":[],"mappings":"AAKA,OAAO,EAIH,QAAQ,GAIX,MAAM,sBAAsB,CAAC;AAc9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,MAAM,OAAO,YAAY;IACrB;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAkB;;QACzC,yGAAyG;QACzG,MAAM,KAAK,GAAsB,kBAAK,MAAM,CAAuB,CAAC;QACpE,KAAK,CAAC,OAAO,GAAG;YACZ,QAAQ,EAAE,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,QAAQ,KAAI,QAAQ,CAAC,KAAK;YACpD,MAAM,EACF,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,MAAM;gBACtB,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;;oBACjB,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAA,MAAA,KAAK,CAAC,OAAO,0CAAE,QAAQ,mCAAI,QAAQ,CAAC,KAAK,CAAC,EAAE;wBAClF,OAAO;qBACV;oBAED,QAAQ,KAAK,EAAE;wBACX,KAAK,QAAQ,CAAC,KAAK;4BACf,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC;4BAC5C,MAAM;wBACV,KAAK,QAAQ,CAAC,IAAI;4BACd,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,MAAM,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC;4BAC3C,MAAM;wBACV;4BACI,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,MAAM,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC;qBACjD;gBACL,CAAC,CAAC;SACT,CAAC;QACF,KAAK,CAAC,QAAQ,GAAG;YACb,aAAa,EAAE,IAAI,qBAAqB,CAEtC,GAAG,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CAAC;YACnD,mBAAmB,EAAE,IAAI,qBAAqB,CAC1C,GAAG,EAAE,CAAC,KAAK,CAAC,mBAAmB,EAC/B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;SACJ,CAAC;QACF,KAAK,CAAC,MAAM,GAAG;YACX,gBAAgB,EAAE,IAAI,WAAW,CAC7B,GAAG,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAC5B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,cAAc,EAAE,IAAI,WAAW,CAC3B,GAAG,EAAE,CAAC,KAAK,CAAC,cAAc,EAC1B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YAED,gBAAgB,EAAE,IAAI,WAAW,CAC7B,GAAG,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAC5B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,6BAA6B,EAAE,IAAI,WAAW,CAC1C,GAAG,EAAE,CAAC,KAAK,CAAC,6BAA6B,EACzC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,8BAA8B,EAAE,IAAI,WAAW,CAC3C,GAAG,EAAE,CAAC,KAAK,CAAC,8BAA8B,EAC1C,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,sBAAsB,EAAE,IAAI,WAAW,CACnC,GAAG,EAAE,CAAC,KAAK,CAAC,sBAAsB,EAClC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,iCAAiC,EAAE,IAAI,WAAW,CAC9C,GAAG,EAAE,CAAC,KAAK,CAAC,iCAAiC,EAC7C,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,2BAA2B,EAAE,IAAI,WAAW,CACxC,GAAG,EAAE,CAAC,KAAK,CAAC,2BAA2B,EACvC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,yBAAyB,EAAE,IAAI,WAAW,CACtC,GAAG,EAAE,CAAC,KAAK,CAAC,yBAAyB,EACrC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,wBAAwB,EAAE,IAAI,WAAW,CACrC,GAAG,EAAE,CAAC,KAAK,CAAC,wBAAwB,EACpC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,qBAAqB,EAAE,IAAI,WAAW,CAClC,GAAG,EAAE,CAAC,KAAK,CAAC,qBAAqB,EACjC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,qBAAqB,EAAE,IAAI,WAAW,CAClC,GAAG,EAAE,CAAC,KAAK,CAAC,qBAAqB,EACjC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,uBAAuB,EAAE,IAAI,WAAW,CACpC,GAAG,EAAE,CAAC,KAAK,CAAC,uBAAuB,EACnC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,6BAA6B,EAAE,IAAI,WAAW,CAC1C,GAAG,EAAE,CAAC,KAAK,CAAC,6BAA6B,EACzC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,0BAA0B,EAAE,IAAI,WAAW,CACvC,GAAG,EAAE,CAAC,KAAK,CAAC,0BAA0B,EACtC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,eAAe,EAAE,IAAI,WAAW,CAC5B,GAAG,EAAE,CAAC,KAAK,CAAC,eAAe,EAC3B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,wBAAwB,EAAE,IAAI,WAAW,CACrC,GAAG,EAAE,CAAC,KAAK,CAAC,wBAAwB,EACpC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,wBAAwB,EAAE,IAAI,WAAW,CACrC,GAAG,EAAE,CAAC,KAAK,CAAC,wBAAwB,EACpC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,qBAAqB,EAAE,IAAI,WAAW,CAClC,GAAG,EAAE,CAAC,KAAK,CAAC,qBAAqB,EACjC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,yBAAyB,EAAE,IAAI,WAAW,CACtC,GAAG,EAAE,CAAC,KAAK,CAAC,yBAAyB,EACrC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,gBAAgB,EAAE,IAAI,WAAW,CAC7B,GAAG,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAC5B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,gBAAgB,EAAE,IAAI,WAAW,CAC7B,GAAG,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAC5B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,mBAAmB,EAAE,IAAI,WAAW,CAChC,GAAG,EAAE,CAAC,KAAK,CAAC,mBAAmB,EAC/B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,aAAa,EAAE,IAAI,WAAW,CAC1B,GAAG,EAAE,CAAC,KAAK,CAAC,aAAa,EACzB,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,uBAAuB,EAAE,IAAI,WAAW,CACpC,GAAG,EAAE,CAAC,KAAK,CAAC,uBAAuB,EACnC,KAAK,CAAC,OAAO,CAAC,MAAM,CACvB;YACD,cAAc,EAAE,IAAI,WAAW,CAC3B,GAAG,EAAE,CAAC,KAAK,CAAC,cAAc,EAC1B,KAAK,CAAC,OAAO,CAAC,MAAM,CACvB;YACD,yBAAyB,EAAE,IAAI,WAAW,CACtC,GAAG,EAAE,CAAC,KAAK,CAAC,yBAAyB,EACrC,KAAK,CAAC,OAAO,CAAC,MAAM,CACvB;YACD,iBAAiB,EAAE,IAAI,WAAW,CAC9B,GAAG,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAC7B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,0BAA0B,EAAE,IAAI,WAAW,CACvC,GAAG,EAAE,CAAC,KAAK,CAAC,0BAA0B,EACtC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,0BAA0B,EAAE,IAAI,WAAW,CACvC,GAAG,EAAE,CAAC,KAAK,CAAC,0BAA0B,EACtC,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,YAAY,EAAE,IAAI,WAAW,CACzB,GAAG,EAAE,CAAC,KAAK,CAAC,YAAY,EACxB,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,iBAAiB,EAAE,IAAI,WAAW,CAC9B,GAAG,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAC7B,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CACxB;YACD,0BAA0B,EAAE,IAAI,WAAW,CAEzC,GAAG,EAAE,CAAC,KAAK,CAAC,0BAA0B,EAAE,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM,CAAC;YAChE,qBAAqB,EAAE,IAAI,WAAW,CAClC,GAAG,EAAE,CAAC,KAAK,CAAC,qBAAqB,EACjC,KAAK,CAAC,OAAO,CAAC,MAAM,CACvB;YACD,0BAA0B,EAAE,IAAI,WAAW,CACvC,GAAG,EAAE,CAAC,KAAK,CAAC,0BAA0B,EACtC,KAAK,CAAC,OAAO,CAAC,MAAM,CACvB;YACD,uBAAuB,EAAE,IAAI,WAAW,CACpC,GAAG,EAAE,CAAC,KAAK,CAAC,uBAAuB,EACnC,KAAK,CAAC,OAAO,CAAC,MAAM,CACvB;YACD,uBAAuB,EAAE,IAAI,WAAW,CACpC,GAAG,EAAE,CAAC,KAAK,CAAC,uBAAuB,EACnC,KAAK,CAAC,OAAO,CAAC,MAAM,CACvB;SACJ,CAAC;QACF,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,KAAe,EAAE,QAAkB;QAC/D,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE;YAC3B,OAAO,IAAI,CAAC;SACf;QACD,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,IAAI,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE;YAClF,OAAO,IAAI,CAAC;SACf;QACD,OAAO,QAAQ,IAAI,QAAQ,CAAC,KAAK,IAAI,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;IACjE,CAAC;CACJ"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { LoggerFunction } from '../types/CommonTypes';
|
|
2
|
+
import { EngineEventTrigger } from './EngineEventTrigger';
|
|
3
|
+
export declare class EngineCallbackHandler<T extends (...args: any[]) => any> extends EngineEventTrigger<T> {
|
|
4
|
+
private handler;
|
|
5
|
+
constructor(handler: () => T | undefined, logger?: LoggerFunction);
|
|
6
|
+
/**
|
|
7
|
+
* Executes the defined handler with the provided arguments.
|
|
8
|
+
*
|
|
9
|
+
* @param args The arguments to pass to the callbacks.
|
|
10
|
+
* @returns The result of executing the callbacks.
|
|
11
|
+
*/
|
|
12
|
+
trigger(...args: Parameters<T>): ReturnType<T>;
|
|
13
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
2
|
+
import { CallbackErrorBehavior } from '../types/CommonTypes';
|
|
3
|
+
import { EngineEventTrigger } from './EngineEventTrigger';
|
|
4
|
+
export class EngineCallbackHandler extends EngineEventTrigger {
|
|
5
|
+
constructor(handler, logger) {
|
|
6
|
+
super(logger);
|
|
7
|
+
this.handler = handler;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Executes the defined handler with the provided arguments.
|
|
11
|
+
*
|
|
12
|
+
* @param args The arguments to pass to the callbacks.
|
|
13
|
+
* @returns The result of executing the callbacks.
|
|
14
|
+
*/
|
|
15
|
+
trigger(...args) {
|
|
16
|
+
const handler = this.handler();
|
|
17
|
+
if (handler) {
|
|
18
|
+
return this.createEventHandlerFn(handler, CallbackErrorBehavior.throw)(...args);
|
|
19
|
+
}
|
|
20
|
+
return undefined;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=EngineCallbackHandler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EngineCallbackHandler.js","sourceRoot":"","sources":["../../../src/utils/EngineCallbackHandler.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,EAAE,qBAAqB,EAAkB,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,OAAO,qBAAyD,SAAQ,kBAAqB;IAC/F,YAAoB,OAA4B,EAAE,MAAuB;QACrE,KAAK,CAAC,MAAM,CAAC,CAAC;QADE,YAAO,GAAP,OAAO,CAAqB;IAEhD,CAAC;IACD;;;;;OAKG;IACH,OAAO,CAAC,GAAG,IAAmB;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,OAAO,EAAE;YACT,OAAO,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SACnF;QACD,OAAO,SAA0B,CAAC;IACtC,CAAC;CACJ"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { CallbackErrorBehavior, LoggerFunction } from '../types/CommonTypes';
|
|
2
|
+
import { EngineEventTrigger } from './EngineEventTrigger';
|
|
3
|
+
interface Unsubscriber {
|
|
4
|
+
(): void;
|
|
5
|
+
}
|
|
6
|
+
export declare class EngineEvent<T extends (...args: any[]) => void> extends EngineEventTrigger<T> {
|
|
7
|
+
private legacyHandler;
|
|
8
|
+
private subscriptions;
|
|
9
|
+
constructor(legacyHandler: () => T | undefined, logger?: LoggerFunction);
|
|
10
|
+
/**
|
|
11
|
+
* Executes the registered callbacks with provided arguments
|
|
12
|
+
*
|
|
13
|
+
* @param args The arguments to pass to the callbacks.
|
|
14
|
+
* @returns The result of executing the callbacks.
|
|
15
|
+
*/
|
|
16
|
+
trigger(...args: Parameters<T>): ReturnType<T>;
|
|
17
|
+
/**
|
|
18
|
+
* Registers a callback function.
|
|
19
|
+
*
|
|
20
|
+
* @param callback - The callback function to register. This function will be invoked when the event occurs.
|
|
21
|
+
* @param errorBehavior - An optional parameter to define how to handle errors that appear in the callback function.
|
|
22
|
+
* Accepted values are:
|
|
23
|
+
* - "log": Logs the error to the console (default behavior)
|
|
24
|
+
* - "throw": Throws an error. Keep in mind that throwing of error in one of the callback will prevent calling of others
|
|
25
|
+
* @returns A function to unsubscribe the callback, preventing it from being invoked in the future.
|
|
26
|
+
*/
|
|
27
|
+
registerCallback(callback: T, errorBehavior?: CallbackErrorBehavior): Unsubscriber;
|
|
28
|
+
}
|
|
29
|
+
export {};
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
2
|
+
import { CallbackErrorBehavior } from '../types/CommonTypes';
|
|
3
|
+
import { EngineEventTrigger } from './EngineEventTrigger';
|
|
4
|
+
export class EngineEvent extends EngineEventTrigger {
|
|
5
|
+
constructor(legacyHandler, logger) {
|
|
6
|
+
super(logger);
|
|
7
|
+
this.legacyHandler = legacyHandler;
|
|
8
|
+
this.subscriptions = new Set();
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Executes the registered callbacks with provided arguments
|
|
12
|
+
*
|
|
13
|
+
* @param args The arguments to pass to the callbacks.
|
|
14
|
+
* @returns The result of executing the callbacks.
|
|
15
|
+
*/
|
|
16
|
+
trigger(...args) {
|
|
17
|
+
const handler = this.legacyHandler();
|
|
18
|
+
if (handler) {
|
|
19
|
+
this.createEventHandlerFn(handler, CallbackErrorBehavior.log)(...args);
|
|
20
|
+
}
|
|
21
|
+
for (const callback of this.subscriptions) {
|
|
22
|
+
callback(...args);
|
|
23
|
+
}
|
|
24
|
+
return undefined;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Registers a callback function.
|
|
28
|
+
*
|
|
29
|
+
* @param callback - The callback function to register. This function will be invoked when the event occurs.
|
|
30
|
+
* @param errorBehavior - An optional parameter to define how to handle errors that appear in the callback function.
|
|
31
|
+
* Accepted values are:
|
|
32
|
+
* - "log": Logs the error to the console (default behavior)
|
|
33
|
+
* - "throw": Throws an error. Keep in mind that throwing of error in one of the callback will prevent calling of others
|
|
34
|
+
* @returns A function to unsubscribe the callback, preventing it from being invoked in the future.
|
|
35
|
+
*/
|
|
36
|
+
registerCallback(callback, errorBehavior = CallbackErrorBehavior.log) {
|
|
37
|
+
const callbackFn = this.createEventHandlerFn(callback, errorBehavior);
|
|
38
|
+
this.subscriptions.add(callbackFn);
|
|
39
|
+
return () => {
|
|
40
|
+
this.subscriptions.delete(callbackFn);
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=EngineEvent.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EngineEvent.js","sourceRoot":"","sources":["../../../src/utils/EngineEvent.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,EAAE,qBAAqB,EAAkB,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAM1D,MAAM,OAAO,WAAgD,SAAQ,kBAAqB;IAGtF,YAAoB,aAAkC,EAAE,MAAuB;QAC3E,KAAK,CAAC,MAAM,CAAC,CAAC;QADE,kBAAa,GAAb,aAAa,CAAqB;QAF9C,kBAAa,GAAW,IAAI,GAAG,EAAE,CAAC;IAI1C,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,GAAG,IAAmB;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE;YACT,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SAC1E;QACD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;YACvC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;SACrB;QACD,OAAO,SAA0B,CAAC;IACtC,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,QAAW,EAAE,gBAAuC,qBAAqB,CAAC,GAAG;QAC1F,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACtE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEnC,OAAO,GAAG,EAAE;YACR,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC;IACN,CAAC;CACJ"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { CallbackErrorBehavior, LoggerFunction } from '../types/CommonTypes';
|
|
2
|
+
export declare abstract class EngineEventTrigger<T extends (...args: any[]) => any> {
|
|
3
|
+
protected logger?: LoggerFunction | undefined;
|
|
4
|
+
constructor(logger?: LoggerFunction | undefined);
|
|
5
|
+
abstract trigger(...args: Parameters<T>): ReturnType<T>;
|
|
6
|
+
protected createEventHandlerFn(callbackFn: T, errorBehavior: CallbackErrorBehavior): T;
|
|
7
|
+
private handleError;
|
|
8
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
2
|
+
import { CallbackErrorBehavior, LogCategory, LogLevel } from '../types/CommonTypes';
|
|
3
|
+
export class EngineEventTrigger {
|
|
4
|
+
constructor(logger) {
|
|
5
|
+
this.logger = logger;
|
|
6
|
+
}
|
|
7
|
+
createEventHandlerFn(callbackFn, errorBehavior) {
|
|
8
|
+
const wrapper = (...args) => {
|
|
9
|
+
try {
|
|
10
|
+
const result = callbackFn(...args);
|
|
11
|
+
// If the callback returns a promise, we need to await it
|
|
12
|
+
if (result instanceof Promise) {
|
|
13
|
+
return result.catch((error) => this.handleError(error, errorBehavior, callbackFn.name));
|
|
14
|
+
}
|
|
15
|
+
return result;
|
|
16
|
+
}
|
|
17
|
+
catch (error) {
|
|
18
|
+
this.handleError(error, errorBehavior, callbackFn.name);
|
|
19
|
+
}
|
|
20
|
+
};
|
|
21
|
+
return wrapper;
|
|
22
|
+
}
|
|
23
|
+
handleError(error, errorBehavior, fnName) {
|
|
24
|
+
var _a;
|
|
25
|
+
if (errorBehavior === CallbackErrorBehavior.log) {
|
|
26
|
+
(_a = this.logger) === null || _a === void 0 ? void 0 : _a.call(this, LogLevel.error, LogCategory.event, `Error in callback ${fnName}: ${error}`);
|
|
27
|
+
}
|
|
28
|
+
else {
|
|
29
|
+
throw error;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=EngineEventTrigger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EngineEventTrigger.js","sourceRoot":"","sources":["../../../src/utils/EngineEventTrigger.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAkB,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACpG,MAAM,OAAgB,kBAAkB;IACpC,YAAsB,MAAuB;QAAvB,WAAM,GAAN,MAAM,CAAiB;IAAG,CAAC;IAIvC,oBAAoB,CAAC,UAAa,EAAE,aAAoC;QAC9E,MAAM,OAAO,GAAQ,CAAC,GAAG,IAAmB,EAAE,EAAE;YAC5C,IAAI;gBACA,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;gBACnC,yDAAyD;gBACzD,IAAI,MAAM,YAAY,OAAO,EAAE;oBAC3B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,aAAa,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC3F;gBACD,OAAO,MAAM,CAAC;aACjB;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,aAAa,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;aAC3D;QACL,CAAC,CAAC;QACF,OAAO,OAAO,CAAC;IACnB,CAAC;IAEO,WAAW,CAAC,KAAc,EAAE,aAAoC,EAAE,MAAc;;QACpF,IAAI,aAAa,KAAK,qBAAqB,CAAC,GAAG,EAAE;YAC7C,MAAA,IAAI,CAAC,MAAM,qDAAG,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,qBAAqB,MAAM,KAAK,KAAK,EAAE,CAAC,CAAC;SAC7F;aAAM;YACH,MAAM,KAAK,CAAC;SACf;IACL,CAAC;CACJ"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"
|
|
1
|
+
{"version":3,"file":"Enums.js","sourceRoot":"","sources":["../../../src/utils/Enums.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC1B,wCAAkB,CAAA;IAClB,wCAAkB,CAAA;IAClB,qCAAe,CAAA;IACf,uCAAiB,CAAA;IACjB,sDAAgC,CAAA;AACpC,CAAC,EANW,kBAAkB,KAAlB,kBAAkB,QAM7B;AACD,MAAM,CAAN,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC3B,qDAA8B,CAAA;IAC9B,mDAA4B,CAAA;IAC5B,6CAAsB,CAAA;IACtB,mDAA4B,CAAA;IAC5B,+CAAwB,CAAA;IACxB,iDAA0B,CAAA;IAC1B,uEAAgD,CAAA;AACpD,CAAC,EARW,mBAAmB,KAAnB,mBAAmB,QAQ9B;AAED,MAAM,CAAN,IAAY,QASX;AATD,WAAY,QAAQ;IAChB,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,sCAA0B,CAAA;IAC1B,oCAAwB,CAAA;IACxB,+BAAmB,CAAA;IACnB,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;AAC7B,CAAC,EATW,QAAQ,KAAR,QAAQ,QASnB;AACD,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;AACf,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B;AAED,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,sCAAmB,CAAA;IACnB,wCAAqB,CAAA;AACzB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B"}
|
package/package.json
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"animations.js","sourceRoot":"","sources":["../../../../src/tests/__mocks__/animations.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kBAAkB,GAAuB;IAClD,SAAS,EAAE;QACP,EAAE,EAAE,GAAG;QACP,IAAI,EAAE,CAAC;QACP,EAAE,EAAE,CAAC;QACL,eAAe,EAAE,EAAE;KACtB;IACD,UAAU,EAAE,IAAI;CACnB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../src/tests/__mocks__/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;AAE3F,MAAM,UAAU,GAAe;IAC3B,gBAAgB,EAAE,iBAAiB;IACnC,cAAc,EAAE,iBAAiB;IACjC,aAAa,EAAE,iBAAiB;IAChC,mBAAmB,EAAE,iBAAiB;IACtC,gBAAgB,EAAE,iBAAiB;IACnC,4BAA4B,EAAE,iBAAiB;IAC/C,6BAA6B,EAAE,iBAAiB;IAChD,6BAA6B,EAAE,iBAAiB;IAChD,8BAA8B,EAAE,iBAAiB;IACjD,UAAU,EAAE,6CAA6C;IACzD,YAAY,EAAE,YAAY,CAAC,QAAQ;IACnC,sBAAsB,EAAE,iBAAiB;IACzC,iCAAiC,EAAE,iBAAiB;IACpD,yBAAyB,EAAE,iBAAiB;IAC5C,wBAAwB,EAAE,iBAAiB;IAC3C,qBAAqB,EAAE,iBAAiB;IACxC,qBAAqB,EAAE,iBAAiB;IACxC,uBAAuB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAClF,6BAA6B,EAAE,iBAAiB;IAChD,0BAA0B,EAAE,iBAAiB;IAC7C,eAAe,EAAE,iBAAiB;IAClC,wBAAwB,EAAE,iBAAiB;IAC3C,wBAAwB,EAAE,iBAAiB;IAC3C,qBAAqB,EAAE,iBAAiB;IACxC,yBAAyB,EAAE,iBAAiB;IAC5C,gBAAgB,EAAE,iBAAiB;IACnC,gBAAgB,EAAE,iBAAiB;IACnC,aAAa,EAAE,iBAAiB;IAChC,uBAAuB,EAAE,iBAAiB;IAC1C,cAAc,EAAE,iBAAiB;IACjC,iBAAiB,EAAE,iBAAiB;IACpC,iBAAiB,EAAE,iBAAiB;CACvC,CAAC;AACF,eAAe,UAAU,CAAC"}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|