@chili-publish/studio-sdk 1.19.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.
Files changed (41) hide show
  1. package/_bundles/main.js +1 -1
  2. package/_bundles/main.js.map +1 -1
  3. package/_bundles/report.html +2 -2
  4. package/lib/editor-engine.json +1 -1
  5. package/lib/package.json +1 -1
  6. package/lib/src/controllers/LayoutController.d.ts +25 -1
  7. package/lib/src/controllers/LayoutController.js +35 -0
  8. package/lib/src/controllers/LayoutController.js.map +1 -1
  9. package/lib/src/controllers/PageController.d.ts +7 -3
  10. package/lib/src/controllers/PageController.js +9 -3
  11. package/lib/src/controllers/PageController.js.map +1 -1
  12. package/lib/src/controllers/UndoManagerController.d.ts +10 -0
  13. package/lib/src/controllers/UndoManagerController.js +16 -0
  14. package/lib/src/controllers/UndoManagerController.js.map +1 -1
  15. package/lib/src/controllers/VariableController.d.ts +23 -5
  16. package/lib/src/controllers/VariableController.js +38 -8
  17. package/lib/src/controllers/VariableController.js.map +1 -1
  18. package/lib/src/index.d.ts +3 -2
  19. package/lib/src/index.js +1 -1
  20. package/lib/src/index.js.map +1 -1
  21. package/lib/src/next/tests/controllers/VariableController.test.js +3 -2
  22. package/lib/src/next/tests/controllers/VariableController.test.js.map +1 -1
  23. package/lib/src/tests/controllers/CharacterStyleController.test.js +1 -0
  24. package/lib/src/tests/controllers/CharacterStyleController.test.js.map +1 -1
  25. package/lib/src/tests/controllers/LayoutController.test.js +29 -1
  26. package/lib/src/tests/controllers/LayoutController.test.js.map +1 -1
  27. package/lib/src/tests/controllers/PageController.test.js +11 -6
  28. package/lib/src/tests/controllers/PageController.test.js.map +1 -1
  29. package/lib/src/tests/controllers/UndoManagerController.test.js +12 -0
  30. package/lib/src/tests/controllers/UndoManagerController.test.js.map +1 -1
  31. package/lib/src/tests/controllers/VariableController.test.js +47 -14
  32. package/lib/src/tests/controllers/VariableController.test.js.map +1 -1
  33. package/lib/src/types/DocumentTypes.d.ts +0 -1
  34. package/lib/src/types/DocumentTypes.js.map +1 -1
  35. package/lib/src/types/LayoutTypes.d.ts +30 -0
  36. package/lib/src/types/LayoutTypes.js.map +1 -1
  37. package/lib/src/types/PageTypes.d.ts +18 -0
  38. package/lib/src/types/VariableTypes.d.ts +60 -0
  39. package/lib/src/types/VariableTypes.js +21 -0
  40. package/lib/src/types/VariableTypes.js.map +1 -1
  41. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"DocumentTypes.js","sourceRoot":"","sources":["../../../src/types/DocumentTypes.ts"],"names":[],"mappings":"AAaA,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,oDAA2B,CAAA;IAC3B,0DAAiC,CAAA;IACjC,4DAAmC,CAAA;IACnC,0DAAiC,CAAA;AACrC,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;AA+FD,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC5B,mCAAW,CAAA;IACX,uDAA+B,CAAA;IAC/B,6CAAqB,CAAA;AACzB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B;AA8CD,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,sCAAe,CAAA;AACnB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AA6DD,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;AACzB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB"}
1
+ {"version":3,"file":"DocumentTypes.js","sourceRoot":"","sources":["../../../src/types/DocumentTypes.ts"],"names":[],"mappings":"AAaA,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC7B,8CAAqB,CAAA;IACrB,oDAA2B,CAAA;IAC3B,0DAAiC,CAAA;IACjC,4DAAmC,CAAA;IACnC,0DAAiC,CAAA;AACrC,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;AA+FD,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC5B,mCAAW,CAAA;IACX,uDAA+B,CAAA;IAC/B,6CAAqB,CAAA;AACzB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B;AA8CD,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,sCAAe,CAAA;AACnB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AA4DD,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;AACzB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB"}
@@ -56,11 +56,17 @@ export declare type Layout = {
56
56
  bleed: PropertyState<LayoutBleed>;
57
57
  fillColor: PropertyState<ColorUsage>;
58
58
  fillColorEnabled: PropertyState<boolean>;
59
+ availableForUser: boolean;
60
+ selectedByUser: boolean;
61
+ resizableByUser: ResizableLayoutProperties;
59
62
  };
60
63
  export declare type LayoutListItemType = {
61
64
  id: string;
62
65
  name: string;
66
+ displayName?: string | null;
63
67
  type: LayoutType;
68
+ availableForUser: boolean;
69
+ selectedByUser: boolean;
64
70
  parentId?: Id | null;
65
71
  childLayouts: Id[];
66
72
  };
@@ -109,3 +115,27 @@ export declare enum LayoutIntent {
109
115
  digitalStatic = "digitalStatic",
110
116
  digitalAnimated = "digitalAnimated"
111
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":"AA2FA,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"}
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
+ }
@@ -38,6 +38,7 @@ export interface Variable {
38
38
  name: string;
39
39
  label?: string | null;
40
40
  isVisible: boolean;
41
+ visibility: VariableVisibility;
41
42
  isReadonly: boolean;
42
43
  isRequired: boolean;
43
44
  occurrences: number;
@@ -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":"AAyBA,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;AAyFD,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"}
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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chili-publish/studio-sdk",
3
- "version": "1.19.0",
3
+ "version": "1.20.0",
4
4
  "description": "The sdk for the chili editor",
5
5
  "repository": {
6
6
  "type": "git",