@chili-publish/studio-sdk 1.20.0 → 1.21.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 +3 -3
- package/lib/src/controllers/BarcodeController.js.map +1 -1
- package/lib/src/controllers/ClipboardController.js.map +1 -1
- package/lib/src/controllers/ColorStyleController.js.map +1 -1
- package/lib/src/controllers/ConnectorController.js +1 -1
- package/lib/src/controllers/ConnectorController.js.map +1 -1
- package/lib/src/controllers/DataConnectorController.js +2 -2
- package/lib/src/controllers/DataConnectorController.js.map +1 -1
- package/lib/src/controllers/DocumentController.js +1 -1
- package/lib/src/controllers/DocumentController.js.map +1 -1
- package/lib/src/controllers/FontConnectorController.js +4 -4
- package/lib/src/controllers/FontConnectorController.js.map +1 -1
- package/lib/src/controllers/LayoutController.d.ts +1 -1
- package/lib/src/controllers/LayoutController.js.map +1 -1
- package/lib/src/controllers/MediaConnectorController.js +3 -3
- package/lib/src/controllers/MediaConnectorController.js.map +1 -1
- package/lib/src/controllers/PageController.d.ts +1 -1
- package/lib/src/controllers/TextStyleController.js.map +1 -1
- package/lib/src/controllers/UndoManagerController.js.map +1 -1
- package/lib/src/controllers/VariableController.d.ts +2 -2
- package/lib/src/controllers/VariableController.js.map +1 -1
- package/lib/src/interactions/Connector.js.map +1 -1
- package/lib/src/next/types/ConnectorTypes.d.ts +1 -1
- package/lib/src/sdk.js.map +1 -1
- package/lib/src/tests/__mocks__/Config.d.ts +0 -1
- package/lib/src/tests/controllers/ConnectorController.test.js +2 -2
- package/lib/src/tests/controllers/ShapeController.test.js +8 -8
- package/lib/src/tests/interactions/Connector.test.js.map +1 -1
- package/lib/src/tests/utils/EditorResponseData.test.js +1 -1
- package/lib/src/tests/utils/EditorResponseData.test.js.map +1 -1
- package/lib/src/tests/utils/Logging.test.js.map +1 -1
- package/lib/src/types/ActionTypes.d.ts +2 -2
- package/lib/src/types/AnimationTypes.d.ts +9 -9
- package/lib/src/types/BarcodeTypes.d.ts +3 -3
- package/lib/src/types/CharacterStyleTypes.d.ts +2 -2
- package/lib/src/types/ColorStyleTypes.d.ts +14 -14
- package/lib/src/types/CommonTypes.d.ts +18 -14
- package/lib/src/types/CommonTypes.js.map +1 -1
- package/lib/src/types/ConfigurationTypes.d.ts +4 -4
- package/lib/src/types/ConnectorTypes.d.ts +9 -9
- package/lib/src/types/ConnectorTypes.js.map +1 -1
- package/lib/src/types/DataConnectorTypes.d.ts +8 -8
- package/lib/src/types/DebugTypes.d.ts +3 -3
- package/lib/src/types/DocumentTypes.d.ts +14 -14
- package/lib/src/types/EngineEditModeTypes.d.ts +1 -1
- package/lib/src/types/FontConnectorTypes.d.ts +3 -3
- package/lib/src/types/FontTypes.d.ts +4 -4
- package/lib/src/types/FrameTypes.d.ts +31 -31
- package/lib/src/types/LayoutTypes.d.ts +10 -10
- package/lib/src/types/MediaConnectorTypes.d.ts +2 -2
- package/lib/src/types/PageTypes.d.ts +2 -2
- package/lib/src/types/ParagraphStyleTypes.d.ts +2 -2
- package/lib/src/types/TextStyleTypes.d.ts +2 -2
- package/lib/src/types/VariableTypes.d.ts +5 -5
- package/lib/src/types/ViewportTypes.d.ts +1 -1
- package/lib/src/utils/ConfigHelper.js.map +1 -1
- package/lib/src/utils/ConnectorCompatibilityTools.js.map +1 -1
- package/lib/src/utils/DataItemMappingTools.d.ts +2 -2
- package/lib/src/utils/EditorResponseData.js.map +1 -1
- package/lib/src/utils/EngineCallbackHandler.js.map +1 -1
- package/lib/src/utils/EngineEvent.js.map +1 -1
- package/lib/src/utils/EngineEventTrigger.js.map +1 -1
- package/lib/src/utils/LocalConfigurationDecorator.js.map +1 -1
- package/package.json +3 -3
|
@@ -5,20 +5,20 @@ export declare enum WellKnownConfigurationKeys {
|
|
|
5
5
|
GraFxStudioTemplateId = "TEMPLATE_ID",
|
|
6
6
|
GraFxStudioAuthToken = "GRAFX_AUTH_TOKEN"
|
|
7
7
|
}
|
|
8
|
-
export
|
|
8
|
+
export type StudioStyling = {
|
|
9
9
|
uiBackgroundColorHex?: string;
|
|
10
10
|
};
|
|
11
11
|
/**
|
|
12
12
|
* Studio Options that can be updated.
|
|
13
13
|
*/
|
|
14
|
-
export
|
|
14
|
+
export type StudioOptionsDeltaUpdate = {
|
|
15
15
|
/** Options for the different studio engine shortcuts */
|
|
16
16
|
shortcutOptions?: ShortcutOptionsDeltaUpdate;
|
|
17
17
|
};
|
|
18
18
|
/**
|
|
19
19
|
* Shortcut Options that can be updated.
|
|
20
20
|
*/
|
|
21
|
-
export
|
|
21
|
+
export type ShortcutOptionsDeltaUpdate = {
|
|
22
22
|
/** The debug panel shortcut. */
|
|
23
23
|
debugPanel?: ShortcutOption;
|
|
24
24
|
/** The ellipse shape shortcut. */
|
|
@@ -45,7 +45,7 @@ export declare type ShortcutOptionsDeltaUpdate = {
|
|
|
45
45
|
/**
|
|
46
46
|
* Specific shortcut options
|
|
47
47
|
*/
|
|
48
|
-
export
|
|
48
|
+
export type ShortcutOption = {
|
|
49
49
|
/** Whether the shortcut is enabled. */
|
|
50
50
|
enabled: boolean;
|
|
51
51
|
};
|
|
@@ -25,7 +25,7 @@ export declare enum SortOrder {
|
|
|
25
25
|
ascending = "asc",
|
|
26
26
|
descending = "desc"
|
|
27
27
|
}
|
|
28
|
-
export
|
|
28
|
+
export type QueryOptions = {
|
|
29
29
|
filter?: string[] | null;
|
|
30
30
|
collection?: string | null;
|
|
31
31
|
pageToken?: string | null;
|
|
@@ -56,8 +56,8 @@ export interface ConnectorGrafxRegistration extends ConnectorRegistrationBase {
|
|
|
56
56
|
export interface ConnectorLocalRegistration extends ConnectorRegistrationBase {
|
|
57
57
|
source: ConnectorRegistrationSource.local;
|
|
58
58
|
}
|
|
59
|
-
export
|
|
60
|
-
export
|
|
59
|
+
export type ConnectorRegistration = ConnectorUrlRegistration | ConnectorGrafxRegistration | ConnectorLocalRegistration;
|
|
60
|
+
export type ConnectorInstance = {
|
|
61
61
|
id: Id;
|
|
62
62
|
name: string;
|
|
63
63
|
iconUrl: string;
|
|
@@ -88,7 +88,7 @@ export interface ConnectorToEngineMapping {
|
|
|
88
88
|
value: string;
|
|
89
89
|
direction: ConnectorMappingDirection.connectorToEngine;
|
|
90
90
|
}
|
|
91
|
-
export
|
|
91
|
+
export type ConnectorMappingType = EngineToConnectorMapping | ConnectorToEngineMapping;
|
|
92
92
|
export declare class ConnectorMapping implements EngineToConnectorMapping, ConnectorToEngineMapping {
|
|
93
93
|
name: string;
|
|
94
94
|
value: any;
|
|
@@ -97,15 +97,15 @@ export declare class ConnectorMapping implements EngineToConnectorMapping, Conne
|
|
|
97
97
|
constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean, direction?: ConnectorMappingDirection.engineToConnector);
|
|
98
98
|
constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean);
|
|
99
99
|
}
|
|
100
|
-
export
|
|
100
|
+
export type ConnectorState = {
|
|
101
101
|
id: Id;
|
|
102
102
|
type: ConnectorStateType;
|
|
103
103
|
};
|
|
104
|
-
export
|
|
104
|
+
export type ConnectorEvent = {
|
|
105
105
|
id: Id;
|
|
106
106
|
type: ConnectorEventType;
|
|
107
107
|
};
|
|
108
|
-
export
|
|
108
|
+
export type QueryPage<T> = {
|
|
109
109
|
pageSize: number;
|
|
110
110
|
nextPageToken?: string;
|
|
111
111
|
data: T[];
|
|
@@ -203,7 +203,7 @@ export declare enum AuthCredentialsTypeEnum {
|
|
|
203
203
|
grafxToken = "grafxToken",
|
|
204
204
|
refreshed = "refreshed"
|
|
205
205
|
}
|
|
206
|
-
export
|
|
206
|
+
export type AuthCredentials = GrafxTokenAuthCredentials | RefreshedAuthCredendentials;
|
|
207
207
|
export declare enum AuthRefreshTypeEnum {
|
|
208
208
|
grafxToken = "grafxToken",
|
|
209
209
|
any = "any"
|
|
@@ -218,7 +218,7 @@ export declare enum AuthRefreshTypeEnum {
|
|
|
218
218
|
* Example: "Static, 1234", "OAuthClientCredentials, 5678"
|
|
219
219
|
* If the http request did not go through the proxy, headerValue is null.
|
|
220
220
|
*/
|
|
221
|
-
export
|
|
221
|
+
export type AuthRefreshRequest = {
|
|
222
222
|
connectorId: Id;
|
|
223
223
|
remoteConnectorId: Id;
|
|
224
224
|
type: AuthRefreshTypeEnum;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ConnectorTypes.js","sourceRoot":"","sources":["../../../src/types/ConnectorTypes.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,6DAAQ,CAAA;IACR,yEAAc,CAAA;AAClB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AAED,MAAM,CAAN,IAAY,oCAGX;AAHD,WAAY,oCAAoC;IAC5C,sEAA8B,CAAA;IAC9B,wEAAgC,CAAA;AACpC,CAAC,EAHW,oCAAoC,KAApC,oCAAoC,QAG/C;AAED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,0BAAa,CAAA;IACb,sCAAyB,CAAA;AAC7B,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAED,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,8BAAa,CAAA;AACjB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IACd,uBAAa,CAAA;IACb,+BAAqB,CAAA;IACrB,mBAAS,CAAA;AACb,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AAED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;AACvB,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAgDD,MAAM,CAAN,IAAY,2BAgBX;AAhBD,WAAY,2BAA2B;IACnC;;OAEG;IACH,0CAAW,CAAA;IAEX;;OAEG;IACH,8CAAe,CAAA;IAEf;;;OAGG;IACH,8CAAe,CAAA;AACnB,CAAC,EAhBW,2BAA2B,KAA3B,2BAA2B,QAgBtC;AAgBD,MAAM,OAAO,gBAAgB;IAoBzB,YACI,eAAuB,EACvB,OAA+B,EAC/B,WAA6B,EAC7B,SAAS,GAAG,yBAAyB,CAAC,iBAAiB;QApB3D,8DAA8D;QAC9D,cAAS,GAAQ,yBAAyB,CAAC,iBAAiB,CAAC;QAqBzD,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,OAAO,KAAK,sBAAsB,CAAC,QAAQ,EAAE;
|
|
1
|
+
{"version":3,"file":"ConnectorTypes.js","sourceRoot":"","sources":["../../../src/types/ConnectorTypes.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,6DAAQ,CAAA;IACR,yEAAc,CAAA;AAClB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AAED,MAAM,CAAN,IAAY,oCAGX;AAHD,WAAY,oCAAoC;IAC5C,sEAA8B,CAAA;IAC9B,wEAAgC,CAAA;AACpC,CAAC,EAHW,oCAAoC,KAApC,oCAAoC,QAG/C;AAED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,0BAAa,CAAA;IACb,sCAAyB,CAAA;AAC7B,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAED,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,8BAAa,CAAA;AACjB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAED,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IACd,uBAAa,CAAA;IACb,+BAAqB,CAAA;IACrB,mBAAS,CAAA;AACb,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AAED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;AACvB,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAgDD,MAAM,CAAN,IAAY,2BAgBX;AAhBD,WAAY,2BAA2B;IACnC;;OAEG;IACH,0CAAW,CAAA;IAEX;;OAEG;IACH,8CAAe,CAAA;IAEf;;;OAGG;IACH,8CAAe,CAAA;AACnB,CAAC,EAhBW,2BAA2B,KAA3B,2BAA2B,QAgBtC;AAgBD,MAAM,OAAO,gBAAgB;IAoBzB,YACI,eAAuB,EACvB,OAA+B,EAC/B,WAA6B,EAC7B,SAAS,GAAG,yBAAyB,CAAC,iBAAiB;QApB3D,8DAA8D;QAC9D,cAAS,GAAQ,yBAAyB,CAAC,iBAAiB,CAAC;QAqBzD,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,OAAO,KAAK,sBAAsB,CAAC,QAAQ,EAAE,CAAC;YAC9C,IAAI,CAAC,KAAK,GAAG,GAAG,OAAO,IAAI,WAAW,EAAE,CAAC;QAC7C,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC;QAC7B,CAAC;IACL,CAAC;CACJ;AAkBD,MAAM,CAAN,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAC9B,0CAAgB,CAAA;IAChB,yCAAe,CAAA;AACnB,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,QAGjC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,yBAYX;AAZD,WAAY,yBAAyB;IACjC;;;OAGG;IACH,oEAAuC,CAAA;IAEvC;;;OAGG;IACH,oEAAuC,CAAA;AAC3C,CAAC,EAZW,yBAAyB,KAAzB,yBAAyB,QAYpC;AAED,MAAM,CAAN,IAAY,kBA6BX;AA7BD,WAAY,kBAAkB;IAC1B;;;OAGG;IACH,yCAAmB,CAAA;IAEnB;;OAEG;IACH,uCAAiB,CAAA;IAEjB;;OAEG;IAEH,yCAAmB,CAAA;IAEnB;;;OAGG;IACH,qCAAe,CAAA;IAEf;;;OAGG;IACH,qCAAe,CAAA;AACnB,CAAC,EA7BW,kBAAkB,KAAlB,kBAAkB,QA6B7B;AAED,MAAM,CAAN,IAAY,kBA4BX;AA5BD,WAAY,kBAAkB;IAC1B;;;;;;;OAOG;IACH,mDAA6B,CAAA;IAE7B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;;;OAIG;IACH,uDAAiC,CAAA;IAEjC;;;OAGG;IACH,2CAAqB,CAAA;AACzB,CAAC,EA5BW,kBAAkB,KAAlB,kBAAkB,QA4B7B;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAA+B;IACvE,GAAG,EAAE,kBAAkB;IACvB,MAAM,EAAE,2BAA2B,CAAC,KAAK;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,yBAAyB;IAIlC,YAAY,KAAa;QAFzB,SAAI,GAAG,uBAAuB,CAAC,UAAU,CAAC;QAGtC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,OAAO,2BAA2B;IAAxC;QACI,SAAI,GAAG,uBAAuB,CAAC,SAAS,CAAC;IAC7C,CAAC;CAAA;AAED,MAAM,CAAN,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,oDAAyB,CAAA;IACzB,kDAAuB,CAAA;AAC3B,CAAC,EAHW,uBAAuB,KAAvB,uBAAuB,QAGlC;AAID,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,gDAAyB,CAAA;IACzB,kCAAW,CAAA;AACf,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B"}
|
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type DataConnectorCapabilities = {
|
|
2
2
|
filtering: boolean;
|
|
3
3
|
sorting: boolean;
|
|
4
4
|
model: boolean;
|
|
5
5
|
};
|
|
6
|
-
export
|
|
6
|
+
export type PageConfig = {
|
|
7
7
|
filters?: DataFilter[] | null;
|
|
8
8
|
sorting?: DataSorting[] | null;
|
|
9
9
|
continuationToken?: string | null;
|
|
10
10
|
limit: number;
|
|
11
11
|
};
|
|
12
|
-
export
|
|
12
|
+
export type DataSorting = {
|
|
13
13
|
property: string;
|
|
14
14
|
direction: 'asc' | 'desc';
|
|
15
15
|
};
|
|
16
|
-
export
|
|
16
|
+
export type DataFilter = {
|
|
17
17
|
property: string;
|
|
18
18
|
value: string;
|
|
19
19
|
type: 'contains' | 'exact';
|
|
20
20
|
};
|
|
21
|
-
export
|
|
21
|
+
export type DataPage<Item> = {
|
|
22
22
|
data: Item[];
|
|
23
23
|
continuationToken?: string | null;
|
|
24
24
|
};
|
|
25
|
-
export
|
|
25
|
+
export type DataItem = {
|
|
26
26
|
[key: string]: string | number | boolean | Date | null;
|
|
27
27
|
};
|
|
28
|
-
export
|
|
28
|
+
export type DataModel = {
|
|
29
29
|
properties: DataModelProperty[];
|
|
30
30
|
};
|
|
31
|
-
|
|
31
|
+
type DataModelProperty = {
|
|
32
32
|
name: string;
|
|
33
33
|
type: 'number' | 'boolean' | 'singleLine' | 'multiLine' | 'date';
|
|
34
34
|
};
|
|
@@ -3,17 +3,17 @@ declare enum CallStatus {
|
|
|
3
3
|
success = "success",
|
|
4
4
|
error = "error"
|
|
5
5
|
}
|
|
6
|
-
|
|
6
|
+
type DebugVar = {
|
|
7
7
|
name: string;
|
|
8
8
|
type: string;
|
|
9
9
|
};
|
|
10
|
-
|
|
10
|
+
type ApiResponse = {
|
|
11
11
|
status: number;
|
|
12
12
|
error: string;
|
|
13
13
|
data: string;
|
|
14
14
|
type: string;
|
|
15
15
|
};
|
|
16
|
-
export
|
|
16
|
+
export type DebugData = {
|
|
17
17
|
title: string;
|
|
18
18
|
vars: DebugVar[];
|
|
19
19
|
response: ApiResponse;
|
|
@@ -8,7 +8,7 @@ import { Variable } from './VariableTypes';
|
|
|
8
8
|
import { CharacterStyle } from './CharacterStyleTypes';
|
|
9
9
|
import { DocumentAction } from './ActionTypes';
|
|
10
10
|
import { ShapeProperties } from './ShapeTypes';
|
|
11
|
-
export
|
|
11
|
+
export type DocumentError = {
|
|
12
12
|
error: Record<string, unknown>;
|
|
13
13
|
code: number;
|
|
14
14
|
};
|
|
@@ -19,35 +19,35 @@ export declare enum DocumentIssueTypeEnum {
|
|
|
19
19
|
actionExecution = "actionExecution",
|
|
20
20
|
actionCircular = "actionCircular"
|
|
21
21
|
}
|
|
22
|
-
export
|
|
22
|
+
export type OverflowDocumentIssue = {
|
|
23
23
|
frameId: Id;
|
|
24
24
|
type: DocumentIssueTypeEnum.overflow;
|
|
25
25
|
};
|
|
26
|
-
export
|
|
26
|
+
export type FontLoadingDocumentIssue = {
|
|
27
27
|
fontId: string;
|
|
28
28
|
name: string;
|
|
29
29
|
type: DocumentIssueTypeEnum.fontLoading;
|
|
30
30
|
};
|
|
31
|
-
export
|
|
31
|
+
export type ActionExecutionDocumentIssue = {
|
|
32
32
|
actionId: string;
|
|
33
33
|
type: DocumentIssueTypeEnum.actionExecution;
|
|
34
34
|
};
|
|
35
|
-
export
|
|
35
|
+
export type ActionRegisterDocumentIssue = {
|
|
36
36
|
actionId: string;
|
|
37
37
|
type: DocumentIssueTypeEnum.actionRegister;
|
|
38
38
|
};
|
|
39
|
-
export
|
|
39
|
+
export type ActionCircularDocumentIssue = {
|
|
40
40
|
eventChain: ActionEventErrorData[];
|
|
41
41
|
type: DocumentIssueTypeEnum.actionCircular;
|
|
42
42
|
};
|
|
43
|
-
export
|
|
44
|
-
export
|
|
43
|
+
export type DocumentIssue = OverflowDocumentIssue | FontLoadingDocumentIssue | ActionExecutionDocumentIssue | ActionRegisterDocumentIssue | ActionCircularDocumentIssue;
|
|
44
|
+
export type UndoState = {
|
|
45
45
|
canUndo: boolean;
|
|
46
46
|
canRedo: boolean;
|
|
47
47
|
undoItemName: OperationName;
|
|
48
48
|
redoItemName: OperationName;
|
|
49
49
|
};
|
|
50
|
-
export
|
|
50
|
+
export type OperationName = {
|
|
51
51
|
translationKey: number;
|
|
52
52
|
name: string;
|
|
53
53
|
};
|
|
@@ -155,7 +155,7 @@ export interface FrameProperty {
|
|
|
155
155
|
isVisible?: boolean;
|
|
156
156
|
type: FramePropertiesType;
|
|
157
157
|
}
|
|
158
|
-
export
|
|
158
|
+
export type ChildFrameProperty = FrameProperty;
|
|
159
159
|
export interface TopFrameProperty extends FrameProperty {
|
|
160
160
|
x: number;
|
|
161
161
|
y: number;
|
|
@@ -183,8 +183,8 @@ export interface DocumentStylekit {
|
|
|
183
183
|
characterStyles: DocumentCharacterStyle[];
|
|
184
184
|
paragraphStyles: DocumentParagraphStyle[];
|
|
185
185
|
}
|
|
186
|
-
export
|
|
187
|
-
export
|
|
186
|
+
export type DocumentCharacterStyle = CharacterStyle;
|
|
187
|
+
export type DocumentParagraphStyle = ParagraphStyle;
|
|
188
188
|
export interface DocumentVariable extends Variable {
|
|
189
189
|
parentId: Id;
|
|
190
190
|
name: string;
|
|
@@ -201,10 +201,10 @@ export declare enum DocumentType {
|
|
|
201
201
|
export interface DocumentProperties {
|
|
202
202
|
type: DocumentType;
|
|
203
203
|
}
|
|
204
|
-
export
|
|
204
|
+
export type TemplateDocumentProperties = DocumentProperties;
|
|
205
205
|
export interface ProjectDocumentProperties extends DocumentProperties {
|
|
206
206
|
templateId: string;
|
|
207
207
|
}
|
|
208
|
-
export
|
|
208
|
+
export type DocumentLoadOptions = {
|
|
209
209
|
keepConnectors: boolean;
|
|
210
210
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Id } from './CommonTypes';
|
|
2
|
-
export
|
|
2
|
+
export type FontConnectorCapabilities = {
|
|
3
3
|
query: boolean;
|
|
4
4
|
detail: boolean;
|
|
5
5
|
preview: boolean;
|
|
@@ -9,13 +9,13 @@ export declare enum FontPreviewFormat {
|
|
|
9
9
|
Square = "square",
|
|
10
10
|
Line = "line"
|
|
11
11
|
}
|
|
12
|
-
export
|
|
12
|
+
export type FontFamily = {
|
|
13
13
|
id: Id;
|
|
14
14
|
name: string;
|
|
15
15
|
fontStylesCount: number;
|
|
16
16
|
extensions: string[];
|
|
17
17
|
};
|
|
18
|
-
export
|
|
18
|
+
export type FontStyle = {
|
|
19
19
|
id: Id;
|
|
20
20
|
name: string;
|
|
21
21
|
familyId: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Id } from './CommonTypes';
|
|
2
|
-
export
|
|
2
|
+
export type DocumentFontStyle = {
|
|
3
3
|
id: Id;
|
|
4
4
|
fontStyleId: string;
|
|
5
5
|
fontFamilyId: string;
|
|
@@ -7,19 +7,19 @@ export declare type DocumentFontStyle = {
|
|
|
7
7
|
name: string;
|
|
8
8
|
isDefault: boolean;
|
|
9
9
|
};
|
|
10
|
-
export
|
|
10
|
+
export type DocumentFontFamily = {
|
|
11
11
|
id: Id;
|
|
12
12
|
name: string;
|
|
13
13
|
connectorId: Id;
|
|
14
14
|
fontFamilyId: string;
|
|
15
15
|
fontStyles: DocumentFontStyle[];
|
|
16
16
|
};
|
|
17
|
-
export
|
|
17
|
+
export type AddDocumentFontStyle = {
|
|
18
18
|
name: string;
|
|
19
19
|
fontStyleId: Id;
|
|
20
20
|
fontFamilyId: Id;
|
|
21
21
|
};
|
|
22
|
-
export
|
|
22
|
+
export type AddDocumentFontFamily = {
|
|
23
23
|
name: string;
|
|
24
24
|
fontFamilyId: Id;
|
|
25
25
|
};
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { BarcodeCharacterSet, BarcodeErrorCorrectionLevel, BarcodeType, QuietZone } from './BarcodeTypes';
|
|
2
2
|
import { ColorUsage } from './ColorStyleTypes';
|
|
3
|
-
import { Id, PropertyState } from './CommonTypes';
|
|
3
|
+
import { HasOverrideState, Id, PropertyState } from './CommonTypes';
|
|
4
4
|
import { CornerRadiusAll, CornerRadiusNone, CornerRadiusOnly, ShapeType } from './ShapeTypes';
|
|
5
|
-
export
|
|
5
|
+
export type FrameLayoutType = {
|
|
6
6
|
id: Id;
|
|
7
7
|
layoutId: Id;
|
|
8
8
|
horizontal: FrameAnchor;
|
|
@@ -24,36 +24,36 @@ export declare type FrameLayoutType = {
|
|
|
24
24
|
enableCopyfitting: PropertyState<boolean>;
|
|
25
25
|
autoGrow: AutoGrowSettings;
|
|
26
26
|
} | null;
|
|
27
|
-
export
|
|
27
|
+
export type FrameType = {
|
|
28
28
|
id: Id;
|
|
29
29
|
name: string;
|
|
30
30
|
type: FrameTypeEnum;
|
|
31
31
|
imageUrl: string;
|
|
32
32
|
blendMode: string;
|
|
33
33
|
};
|
|
34
|
-
export
|
|
35
|
-
export
|
|
34
|
+
export type Frame = TextFrame | ImageFrame | ShapeFrame | BarcodeFrame;
|
|
35
|
+
export type ImageFrameVariableSource = {
|
|
36
36
|
type: ImageSourceTypeEnum.variable;
|
|
37
37
|
id: Id;
|
|
38
38
|
};
|
|
39
|
-
export
|
|
39
|
+
export type ImageFrameUrlSource = {
|
|
40
40
|
type: ImageSourceTypeEnum.url;
|
|
41
41
|
url: string;
|
|
42
42
|
};
|
|
43
|
-
export
|
|
43
|
+
export type ImageFrameConnectorSource = {
|
|
44
44
|
assetId: Id;
|
|
45
45
|
id: Id;
|
|
46
46
|
type: ImageSourceTypeEnum.connector;
|
|
47
47
|
};
|
|
48
|
-
export
|
|
49
|
-
export
|
|
48
|
+
export type ImageFrameSource = ImageFrameConnectorSource | ImageFrameVariableSource | ImageFrameUrlSource;
|
|
49
|
+
export type ImageFrame = {
|
|
50
50
|
id: Id;
|
|
51
51
|
name: string;
|
|
52
52
|
type: FrameTypeEnum.image;
|
|
53
53
|
src?: ImageFrameSource;
|
|
54
54
|
blendMode: BlendMode;
|
|
55
55
|
};
|
|
56
|
-
export
|
|
56
|
+
export type ShapeFrame = {
|
|
57
57
|
id: Id;
|
|
58
58
|
name: string;
|
|
59
59
|
type: FrameTypeEnum.shape;
|
|
@@ -72,7 +72,7 @@ export declare type ShapeFrame = {
|
|
|
72
72
|
sides?: number;
|
|
73
73
|
};
|
|
74
74
|
};
|
|
75
|
-
export
|
|
75
|
+
export type TextFrame = {
|
|
76
76
|
id: Id;
|
|
77
77
|
name: string;
|
|
78
78
|
type: FrameTypeEnum.text;
|
|
@@ -92,7 +92,7 @@ export declare type TextFrame = {
|
|
|
92
92
|
hasClippingPath: boolean;
|
|
93
93
|
blendMode: BlendMode;
|
|
94
94
|
};
|
|
95
|
-
export
|
|
95
|
+
export type BarcodeFrame = {
|
|
96
96
|
id: Id;
|
|
97
97
|
name: string;
|
|
98
98
|
type: FrameTypeEnum.barcode;
|
|
@@ -113,16 +113,16 @@ export declare type BarcodeFrame = {
|
|
|
113
113
|
src?: BarcodeSource;
|
|
114
114
|
barcodeType: BarcodeType;
|
|
115
115
|
};
|
|
116
|
-
export
|
|
117
|
-
export
|
|
116
|
+
export type BarcodeSource = BarcodeVariableSource | BarcodeTextSource;
|
|
117
|
+
export type BarcodeVariableSource = {
|
|
118
118
|
type: BarcodeSourceTypeEnum.variable;
|
|
119
119
|
id: Id;
|
|
120
120
|
};
|
|
121
|
-
export
|
|
121
|
+
export type BarcodeTextSource = {
|
|
122
122
|
type: BarcodeSourceTypeEnum.text;
|
|
123
123
|
text: string;
|
|
124
124
|
};
|
|
125
|
-
export
|
|
125
|
+
export type CropSettings = {
|
|
126
126
|
left: number;
|
|
127
127
|
top: number;
|
|
128
128
|
width: number;
|
|
@@ -130,10 +130,10 @@ export declare type CropSettings = {
|
|
|
130
130
|
rotationDegrees: number;
|
|
131
131
|
type: 'default';
|
|
132
132
|
};
|
|
133
|
-
export
|
|
133
|
+
export type NoCropSettings = {
|
|
134
134
|
type: 'noCrop';
|
|
135
135
|
};
|
|
136
|
-
export
|
|
136
|
+
export type AutoGrowSettings = {
|
|
137
137
|
enabled: PropertyState<boolean>;
|
|
138
138
|
minWidth: PropertyState<number>;
|
|
139
139
|
maxWidth: PropertyState<number>;
|
|
@@ -264,37 +264,37 @@ export declare class FrameAnchorTarget {
|
|
|
264
264
|
type: AnchorTargetType;
|
|
265
265
|
constructor(id: Id, edge: AnchorTargetEdgeType);
|
|
266
266
|
}
|
|
267
|
-
export
|
|
268
|
-
export
|
|
267
|
+
export type AnchorTarget = PageAnchorTarget | FrameAnchorTarget;
|
|
268
|
+
export type RelativeFrameAnchor = {
|
|
269
269
|
start: PropertyState<number>;
|
|
270
270
|
end: PropertyState<number>;
|
|
271
271
|
target: AnchorTarget;
|
|
272
272
|
type: FrameAnchorType.relative;
|
|
273
|
-
};
|
|
274
|
-
export
|
|
273
|
+
} & HasOverrideState;
|
|
274
|
+
export type StartFrameAnchor = {
|
|
275
275
|
offset: PropertyState<number>;
|
|
276
276
|
target: AnchorTarget;
|
|
277
277
|
type: FrameAnchorType.start;
|
|
278
|
-
};
|
|
279
|
-
export
|
|
278
|
+
} & HasOverrideState;
|
|
279
|
+
export type EndFrameAnchor = {
|
|
280
280
|
offset: PropertyState<number>;
|
|
281
281
|
target: AnchorTarget;
|
|
282
282
|
type: FrameAnchorType.end;
|
|
283
|
-
};
|
|
284
|
-
export
|
|
283
|
+
} & HasOverrideState;
|
|
284
|
+
export type StartAndEndFrameAnchor = {
|
|
285
285
|
start: PropertyState<number>;
|
|
286
286
|
startTarget: AnchorTarget;
|
|
287
287
|
end: PropertyState<number>;
|
|
288
288
|
endTarget: AnchorTarget;
|
|
289
289
|
type: FrameAnchorType.startAndEnd;
|
|
290
|
-
};
|
|
291
|
-
export
|
|
290
|
+
} & HasOverrideState;
|
|
291
|
+
export type CenterFrameAnchor = {
|
|
292
292
|
offset: PropertyState<number>;
|
|
293
293
|
target: AnchorTarget;
|
|
294
294
|
type: FrameAnchorType.center;
|
|
295
|
-
};
|
|
296
|
-
export
|
|
297
|
-
export
|
|
295
|
+
} & HasOverrideState;
|
|
296
|
+
export type FrameAnchor = RelativeFrameAnchor | StartFrameAnchor | EndFrameAnchor | StartAndEndFrameAnchor | CenterFrameAnchor;
|
|
297
|
+
export type FrameAnchorProperties = {
|
|
298
298
|
horizontal: boolean;
|
|
299
299
|
type: FrameAnchorType;
|
|
300
300
|
target: AnchorTarget;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ColorUsage } from './ColorStyleTypes';
|
|
2
2
|
import { Id, PrivateData, PropertyState } from './CommonTypes';
|
|
3
|
-
export
|
|
3
|
+
export type LayoutPropertiesType = {
|
|
4
4
|
id: Id;
|
|
5
5
|
width: {
|
|
6
6
|
value: number;
|
|
@@ -16,7 +16,7 @@ export declare type LayoutPropertiesType = {
|
|
|
16
16
|
};
|
|
17
17
|
[key: string]: number | string | Record<string, unknown>;
|
|
18
18
|
} | null;
|
|
19
|
-
export
|
|
19
|
+
export type FrameProperties = {
|
|
20
20
|
id: Id;
|
|
21
21
|
type: string;
|
|
22
22
|
height: number | null;
|
|
@@ -28,7 +28,7 @@ export declare type FrameProperties = {
|
|
|
28
28
|
x: number | null;
|
|
29
29
|
y: number | null;
|
|
30
30
|
};
|
|
31
|
-
export
|
|
31
|
+
export type LayoutWithFrameProperties = {
|
|
32
32
|
id: Id;
|
|
33
33
|
name: string;
|
|
34
34
|
parentId?: Id;
|
|
@@ -41,7 +41,7 @@ export declare type LayoutWithFrameProperties = {
|
|
|
41
41
|
children?: LayoutWithFrameProperties[];
|
|
42
42
|
intent: LayoutIntent | null;
|
|
43
43
|
};
|
|
44
|
-
export
|
|
44
|
+
export type Layout = {
|
|
45
45
|
id: Id;
|
|
46
46
|
name: string;
|
|
47
47
|
displayName?: string | null;
|
|
@@ -60,7 +60,7 @@ export declare type Layout = {
|
|
|
60
60
|
selectedByUser: boolean;
|
|
61
61
|
resizableByUser: ResizableLayoutProperties;
|
|
62
62
|
};
|
|
63
|
-
export
|
|
63
|
+
export type LayoutListItemType = {
|
|
64
64
|
id: string;
|
|
65
65
|
name: string;
|
|
66
66
|
displayName?: string | null;
|
|
@@ -70,21 +70,21 @@ export declare type LayoutListItemType = {
|
|
|
70
70
|
parentId?: Id | null;
|
|
71
71
|
childLayouts: Id[];
|
|
72
72
|
};
|
|
73
|
-
export
|
|
73
|
+
export type LayoutBleed = {
|
|
74
74
|
left: number;
|
|
75
75
|
top: number;
|
|
76
76
|
right: number;
|
|
77
77
|
bottom: number;
|
|
78
78
|
areBleedValuesCombined: boolean;
|
|
79
79
|
};
|
|
80
|
-
export
|
|
80
|
+
export type BleedDeltaUpdate = {
|
|
81
81
|
left?: string;
|
|
82
82
|
top?: string;
|
|
83
83
|
right?: string;
|
|
84
84
|
bottom?: string;
|
|
85
85
|
areBleedValuesCombined?: boolean;
|
|
86
86
|
};
|
|
87
|
-
export
|
|
87
|
+
export type LayoutPreset = {
|
|
88
88
|
name: string;
|
|
89
89
|
intent: LayoutIntent;
|
|
90
90
|
unit: MeasurementUnit;
|
|
@@ -115,14 +115,14 @@ export declare enum LayoutIntent {
|
|
|
115
115
|
digitalStatic = "digitalStatic",
|
|
116
116
|
digitalAnimated = "digitalAnimated"
|
|
117
117
|
}
|
|
118
|
-
export
|
|
118
|
+
export type ResizableLayoutProperties = {
|
|
119
119
|
enabled: boolean;
|
|
120
120
|
minWidth: number | null;
|
|
121
121
|
maxWidth: number | null;
|
|
122
122
|
minHeight: number | null;
|
|
123
123
|
maxHeight: number | null;
|
|
124
124
|
};
|
|
125
|
-
export
|
|
125
|
+
export type ResizableLayoutPropertiesUpdate = {
|
|
126
126
|
enabled?: {
|
|
127
127
|
value: boolean;
|
|
128
128
|
} | null;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Id } from './CommonTypes';
|
|
2
2
|
import { MediaType } from './ConnectorTypes';
|
|
3
|
-
export
|
|
3
|
+
export type MediaConnectorCapabilities = {
|
|
4
4
|
query: boolean;
|
|
5
5
|
detail: boolean;
|
|
6
6
|
filtering: boolean;
|
|
@@ -15,7 +15,7 @@ export declare enum MediaDownloadType {
|
|
|
15
15
|
export declare enum MediaDownloadIntent {
|
|
16
16
|
web = "web"
|
|
17
17
|
}
|
|
18
|
-
export
|
|
18
|
+
export type Media = {
|
|
19
19
|
id: Id;
|
|
20
20
|
name: string;
|
|
21
21
|
relativePath: string;
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { Id } from './CommonTypes';
|
|
2
|
-
export
|
|
2
|
+
export type Page = {
|
|
3
3
|
id: Id;
|
|
4
4
|
number: number;
|
|
5
5
|
isVisible?: boolean;
|
|
6
6
|
width?: number;
|
|
7
7
|
height?: number;
|
|
8
8
|
};
|
|
9
|
-
export
|
|
9
|
+
export type PageSize = {
|
|
10
10
|
id: Id;
|
|
11
11
|
width: number;
|
|
12
12
|
height: number;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Alignment, Case, Scripting } from './TextStyleTypes';
|
|
2
2
|
import { ColorUsage, ColorUsageUpdate } from './ColorStyleTypes';
|
|
3
3
|
import { Id } from './CommonTypes';
|
|
4
|
-
export
|
|
4
|
+
export type ParagraphStyle = {
|
|
5
5
|
id: Id;
|
|
6
6
|
name: string;
|
|
7
7
|
fontKey: string;
|
|
@@ -28,7 +28,7 @@ export declare type ParagraphStyle = {
|
|
|
28
28
|
underline: boolean;
|
|
29
29
|
lineThrough: boolean;
|
|
30
30
|
};
|
|
31
|
-
export
|
|
31
|
+
export type ParagraphStyleUpdate = {
|
|
32
32
|
fontSize: {
|
|
33
33
|
value: number;
|
|
34
34
|
};
|
|
@@ -26,7 +26,7 @@ export declare enum Scripting {
|
|
|
26
26
|
SUBSCRIPT = "subscript",
|
|
27
27
|
NORMAL = "normal"
|
|
28
28
|
}
|
|
29
|
-
export
|
|
29
|
+
export type DisplayColor = ColorUsage & {
|
|
30
30
|
isApplied: boolean;
|
|
31
31
|
};
|
|
32
32
|
export interface TextProperties {
|
|
@@ -50,7 +50,7 @@ export interface TextStyle {
|
|
|
50
50
|
character?: string;
|
|
51
51
|
[key: string]: number | string | Record<string, unknown> | null | boolean | undefined;
|
|
52
52
|
}
|
|
53
|
-
export
|
|
53
|
+
export type TextStyleUpdateType = {
|
|
54
54
|
[key in keyof typeof SelectedTextStyles]?: {
|
|
55
55
|
value: number | string | boolean;
|
|
56
56
|
};
|
|
@@ -90,9 +90,9 @@ export interface DateVariable extends Variable {
|
|
|
90
90
|
prefix?: ValueWithStyle;
|
|
91
91
|
suffix?: ValueWithStyle;
|
|
92
92
|
}
|
|
93
|
-
export
|
|
94
|
-
export
|
|
95
|
-
export
|
|
93
|
+
export type LongTextVariable = ShortTextVariable;
|
|
94
|
+
export type GroupVariable = Variable;
|
|
95
|
+
export type DateRestriction = RelativeDate | AbsoluteDate;
|
|
96
96
|
export interface ValueWithStyle {
|
|
97
97
|
value?: string;
|
|
98
98
|
style?: string;
|
|
@@ -218,7 +218,7 @@ export interface VariableVisibilityConditional extends VariableVisibilityBase {
|
|
|
218
218
|
layouts: VariableVisibilityLayout[];
|
|
219
219
|
variables: VariableWithValue[];
|
|
220
220
|
}
|
|
221
|
-
export
|
|
221
|
+
export type VariableVisibility = VariableVisibilityVisible | VariableVisibilityInvisible | VariableVisibilityConditional;
|
|
222
222
|
export interface VariableVisibilityLayout {
|
|
223
223
|
layoutId: string;
|
|
224
224
|
includeChildren: boolean;
|
|
@@ -244,4 +244,4 @@ export interface VariableVisibilityConditionValueNumber extends VariableVisibili
|
|
|
244
244
|
value: number;
|
|
245
245
|
operator: VariableVisibilityOperator;
|
|
246
246
|
}
|
|
247
|
-
export
|
|
247
|
+
export type VariableVisibilityConditionValue = VariableVisibilityConditionValueBoolean | VariableVisibilityConditionValueText | VariableVisibilityConditionValueNumber;
|