@chili-publish/studio-sdk 0.121.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 (264) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +89 -0
  3. package/_bundles/main.js +3 -0
  4. package/_bundles/main.js.LICENSE.txt +14 -0
  5. package/_bundles/main.js.map +1 -0
  6. package/_bundles/report.html +38 -0
  7. package/lib/editor-engine.json +3 -0
  8. package/lib/package.json +89 -0
  9. package/lib/src/controllers/ActionController.d.ts +38 -0
  10. package/lib/src/controllers/ActionController.js +79 -0
  11. package/lib/src/controllers/ActionController.js.map +1 -0
  12. package/lib/src/controllers/AnimationController.d.ts +70 -0
  13. package/lib/src/controllers/AnimationController.js +135 -0
  14. package/lib/src/controllers/AnimationController.js.map +1 -0
  15. package/lib/src/controllers/CanvasController.d.ts +34 -0
  16. package/lib/src/controllers/CanvasController.js +71 -0
  17. package/lib/src/controllers/CanvasController.js.map +1 -0
  18. package/lib/src/controllers/CharacterStyleController.d.ts +55 -0
  19. package/lib/src/controllers/CharacterStyleController.js +107 -0
  20. package/lib/src/controllers/CharacterStyleController.js.map +1 -0
  21. package/lib/src/controllers/ColorStyleController.d.ts +62 -0
  22. package/lib/src/controllers/ColorStyleController.js +113 -0
  23. package/lib/src/controllers/ColorStyleController.js.map +1 -0
  24. package/lib/src/controllers/ConfigurationController.d.ts +27 -0
  25. package/lib/src/controllers/ConfigurationController.js +60 -0
  26. package/lib/src/controllers/ConfigurationController.js.map +1 -0
  27. package/lib/src/controllers/ConnectorController.d.ts +90 -0
  28. package/lib/src/controllers/ConnectorController.js +196 -0
  29. package/lib/src/controllers/ConnectorController.js.map +1 -0
  30. package/lib/src/controllers/DebugController.d.ts +33 -0
  31. package/lib/src/controllers/DebugController.js +72 -0
  32. package/lib/src/controllers/DebugController.js.map +1 -0
  33. package/lib/src/controllers/DocumentController.d.ts +40 -0
  34. package/lib/src/controllers/DocumentController.js +163 -0
  35. package/lib/src/controllers/DocumentController.js.map +1 -0
  36. package/lib/src/controllers/ExperimentController.d.ts +39 -0
  37. package/lib/src/controllers/ExperimentController.js +83 -0
  38. package/lib/src/controllers/ExperimentController.js.map +1 -0
  39. package/lib/src/controllers/FontConnectorController.d.ts +95 -0
  40. package/lib/src/controllers/FontConnectorController.js +168 -0
  41. package/lib/src/controllers/FontConnectorController.js.map +1 -0
  42. package/lib/src/controllers/FontController.d.ts +50 -0
  43. package/lib/src/controllers/FontController.js +95 -0
  44. package/lib/src/controllers/FontController.js.map +1 -0
  45. package/lib/src/controllers/FrameController.d.ts +369 -0
  46. package/lib/src/controllers/FrameController.js +599 -0
  47. package/lib/src/controllers/FrameController.js.map +1 -0
  48. package/lib/src/controllers/LayoutController.d.ts +103 -0
  49. package/lib/src/controllers/LayoutController.js +190 -0
  50. package/lib/src/controllers/LayoutController.js.map +1 -0
  51. package/lib/src/controllers/MediaConnectorController.d.ts +95 -0
  52. package/lib/src/controllers/MediaConnectorController.js +170 -0
  53. package/lib/src/controllers/MediaConnectorController.js.map +1 -0
  54. package/lib/src/controllers/PageController.d.ts +40 -0
  55. package/lib/src/controllers/PageController.js +92 -0
  56. package/lib/src/controllers/PageController.js.map +1 -0
  57. package/lib/src/controllers/ParagraphStyleController.d.ts +62 -0
  58. package/lib/src/controllers/ParagraphStyleController.js +117 -0
  59. package/lib/src/controllers/ParagraphStyleController.js.map +1 -0
  60. package/lib/src/controllers/ShapeController.d.ts +104 -0
  61. package/lib/src/controllers/ShapeController.js +174 -0
  62. package/lib/src/controllers/ShapeController.js.map +1 -0
  63. package/lib/src/controllers/SubscriberController.d.ts +143 -0
  64. package/lib/src/controllers/SubscriberController.js +213 -0
  65. package/lib/src/controllers/SubscriberController.js.map +1 -0
  66. package/lib/src/controllers/TextStyleController.d.ts +31 -0
  67. package/lib/src/controllers/TextStyleController.js +71 -0
  68. package/lib/src/controllers/TextStyleController.js.map +1 -0
  69. package/lib/src/controllers/ToolController.d.ts +54 -0
  70. package/lib/src/controllers/ToolController.js +104 -0
  71. package/lib/src/controllers/ToolController.js.map +1 -0
  72. package/lib/src/controllers/UndoManagerController.d.ts +22 -0
  73. package/lib/src/controllers/UndoManagerController.js +56 -0
  74. package/lib/src/controllers/UndoManagerController.js.map +1 -0
  75. package/lib/src/controllers/UtilsController.d.ts +20 -0
  76. package/lib/src/controllers/UtilsController.js +35 -0
  77. package/lib/src/controllers/UtilsController.js.map +1 -0
  78. package/lib/src/controllers/VariableController.d.ts +117 -0
  79. package/lib/src/controllers/VariableController.js +205 -0
  80. package/lib/src/controllers/VariableController.js.map +1 -0
  81. package/lib/src/index.d.ts +93 -0
  82. package/lib/src/index.js +154 -0
  83. package/lib/src/index.js.map +1 -0
  84. package/lib/src/interactions/connector.d.ts +31 -0
  85. package/lib/src/interactions/connector.js +99 -0
  86. package/lib/src/interactions/connector.js.map +1 -0
  87. package/lib/src/setupTests.d.ts +1 -0
  88. package/lib/src/setupTests.js +2 -0
  89. package/lib/src/setupTests.js.map +1 -0
  90. package/lib/src/tests/__mocks__/FrameProperties.d.ts +52 -0
  91. package/lib/src/tests/__mocks__/FrameProperties.js +20 -0
  92. package/lib/src/tests/__mocks__/FrameProperties.js.map +1 -0
  93. package/lib/src/tests/__mocks__/MockImageFrameSource.d.ts +4 -0
  94. package/lib/src/tests/__mocks__/MockImageFrameSource.js +15 -0
  95. package/lib/src/tests/__mocks__/MockImageFrameSource.js.map +1 -0
  96. package/lib/src/tests/__mocks__/animations.d.ts +2 -0
  97. package/lib/src/tests/__mocks__/animations.js +10 -0
  98. package/lib/src/tests/__mocks__/animations.js.map +1 -0
  99. package/lib/src/tests/__mocks__/config.d.ts +5 -0
  100. package/lib/src/tests/__mocks__/config.js +31 -0
  101. package/lib/src/tests/__mocks__/config.js.map +1 -0
  102. package/lib/src/tests/__mocks__/mockDocument.d.ts +1 -0
  103. package/lib/src/tests/__mocks__/mockDocument.js +2 -0
  104. package/lib/src/tests/__mocks__/mockDocument.js.map +1 -0
  105. package/lib/src/tests/controllers/ActionController.test.d.ts +1 -0
  106. package/lib/src/tests/controllers/ActionController.test.js +61 -0
  107. package/lib/src/tests/controllers/ActionController.test.js.map +1 -0
  108. package/lib/src/tests/controllers/AnimationController.test.d.ts +1 -0
  109. package/lib/src/tests/controllers/AnimationController.test.js +91 -0
  110. package/lib/src/tests/controllers/AnimationController.test.js.map +1 -0
  111. package/lib/src/tests/controllers/CanvasController.test.d.ts +1 -0
  112. package/lib/src/tests/controllers/CanvasController.test.js +50 -0
  113. package/lib/src/tests/controllers/CanvasController.test.js.map +1 -0
  114. package/lib/src/tests/controllers/CharacterStyleController.test.d.ts +1 -0
  115. package/lib/src/tests/controllers/CharacterStyleController.test.js +125 -0
  116. package/lib/src/tests/controllers/CharacterStyleController.test.js.map +1 -0
  117. package/lib/src/tests/controllers/ColorStyleController.test.d.ts +1 -0
  118. package/lib/src/tests/controllers/ColorStyleController.test.js +83 -0
  119. package/lib/src/tests/controllers/ColorStyleController.test.js.map +1 -0
  120. package/lib/src/tests/controllers/ConfigurationConnectorController.test.d.ts +1 -0
  121. package/lib/src/tests/controllers/ConfigurationConnectorController.test.js +39 -0
  122. package/lib/src/tests/controllers/ConfigurationConnectorController.test.js.map +1 -0
  123. package/lib/src/tests/controllers/ConnectorController.test.d.ts +1 -0
  124. package/lib/src/tests/controllers/ConnectorController.test.js +77 -0
  125. package/lib/src/tests/controllers/ConnectorController.test.js.map +1 -0
  126. package/lib/src/tests/controllers/DebugController.test.d.ts +1 -0
  127. package/lib/src/tests/controllers/DebugController.test.js +47 -0
  128. package/lib/src/tests/controllers/DebugController.test.js.map +1 -0
  129. package/lib/src/tests/controllers/DocumentController.test.d.ts +1 -0
  130. package/lib/src/tests/controllers/DocumentController.test.js +170 -0
  131. package/lib/src/tests/controllers/DocumentController.test.js.map +1 -0
  132. package/lib/src/tests/controllers/ExperimentController.test.d.ts +1 -0
  133. package/lib/src/tests/controllers/ExperimentController.test.js +53 -0
  134. package/lib/src/tests/controllers/ExperimentController.test.js.map +1 -0
  135. package/lib/src/tests/controllers/FontConnectorController.test.d.ts +1 -0
  136. package/lib/src/tests/controllers/FontConnectorController.test.js +109 -0
  137. package/lib/src/tests/controllers/FontConnectorController.test.js.map +1 -0
  138. package/lib/src/tests/controllers/FontController.test.d.ts +1 -0
  139. package/lib/src/tests/controllers/FontController.test.js +73 -0
  140. package/lib/src/tests/controllers/FontController.test.js.map +1 -0
  141. package/lib/src/tests/controllers/FrameController.test.d.ts +1 -0
  142. package/lib/src/tests/controllers/FrameController.test.js +408 -0
  143. package/lib/src/tests/controllers/FrameController.test.js.map +1 -0
  144. package/lib/src/tests/controllers/LayoutController.test.d.ts +1 -0
  145. package/lib/src/tests/controllers/LayoutController.test.js +144 -0
  146. package/lib/src/tests/controllers/LayoutController.test.js.map +1 -0
  147. package/lib/src/tests/controllers/MediaConnectorController.test.d.ts +1 -0
  148. package/lib/src/tests/controllers/MediaConnectorController.test.js +109 -0
  149. package/lib/src/tests/controllers/MediaConnectorController.test.js.map +1 -0
  150. package/lib/src/tests/controllers/PageController.test.d.ts +1 -0
  151. package/lib/src/tests/controllers/PageController.test.js +58 -0
  152. package/lib/src/tests/controllers/PageController.test.js.map +1 -0
  153. package/lib/src/tests/controllers/ParagraphStyleController.test.d.ts +1 -0
  154. package/lib/src/tests/controllers/ParagraphStyleController.test.js +139 -0
  155. package/lib/src/tests/controllers/ParagraphStyleController.test.js.map +1 -0
  156. package/lib/src/tests/controllers/ShapeController.test.d.ts +1 -0
  157. package/lib/src/tests/controllers/ShapeController.test.js +102 -0
  158. package/lib/src/tests/controllers/ShapeController.test.js.map +1 -0
  159. package/lib/src/tests/controllers/SubscriberContoller.test.d.ts +1 -0
  160. package/lib/src/tests/controllers/SubscriberContoller.test.js +201 -0
  161. package/lib/src/tests/controllers/SubscriberContoller.test.js.map +1 -0
  162. package/lib/src/tests/controllers/TextStyleController.test.d.ts +1 -0
  163. package/lib/src/tests/controllers/TextStyleController.test.js +43 -0
  164. package/lib/src/tests/controllers/TextStyleController.test.js.map +1 -0
  165. package/lib/src/tests/controllers/ToolController.test.d.ts +1 -0
  166. package/lib/src/tests/controllers/ToolController.test.js +72 -0
  167. package/lib/src/tests/controllers/ToolController.test.js.map +1 -0
  168. package/lib/src/tests/controllers/UndoManagerController.test.d.ts +1 -0
  169. package/lib/src/tests/controllers/UndoManagerController.test.js +35 -0
  170. package/lib/src/tests/controllers/UndoManagerController.test.js.map +1 -0
  171. package/lib/src/tests/controllers/UtilsController.test.d.ts +1 -0
  172. package/lib/src/tests/controllers/UtilsController.test.js +33 -0
  173. package/lib/src/tests/controllers/UtilsController.test.js.map +1 -0
  174. package/lib/src/tests/controllers/VariableController.test.d.ts +1 -0
  175. package/lib/src/tests/controllers/VariableController.test.js +161 -0
  176. package/lib/src/tests/controllers/VariableController.test.js.map +1 -0
  177. package/lib/src/tests/index.test.d.ts +1 -0
  178. package/lib/src/tests/index.test.js +26 -0
  179. package/lib/src/tests/index.test.js.map +1 -0
  180. package/lib/src/tests/interactions/connector.test.d.ts +1 -0
  181. package/lib/src/tests/interactions/connector.test.js +24 -0
  182. package/lib/src/tests/interactions/connector.test.js.map +1 -0
  183. package/lib/src/tests/utils/editorResponseData.test.d.ts +1 -0
  184. package/lib/src/tests/utils/editorResponseData.test.js +48 -0
  185. package/lib/src/tests/utils/editorResponseData.test.js.map +1 -0
  186. package/lib/src/tests/utils/getClaculatedValue.test.d.ts +1 -0
  187. package/lib/src/tests/utils/getClaculatedValue.test.js +78 -0
  188. package/lib/src/tests/utils/getClaculatedValue.test.js.map +1 -0
  189. package/lib/src/tests/utils/getFetchUrls.test.d.ts +1 -0
  190. package/lib/src/tests/utils/getFetchUrls.test.js +10 -0
  191. package/lib/src/tests/utils/getFetchUrls.test.js.map +1 -0
  192. package/lib/src/tests/utils/round.test.d.ts +1 -0
  193. package/lib/src/tests/utils/round.test.js +16 -0
  194. package/lib/src/tests/utils/round.test.js.map +1 -0
  195. package/lib/src/types/ActionTypes.d.ts +63 -0
  196. package/lib/src/types/ActionTypes.js +29 -0
  197. package/lib/src/types/ActionTypes.js.map +1 -0
  198. package/lib/src/types/AnimationTypes.d.ts +111 -0
  199. package/lib/src/types/AnimationTypes.js +49 -0
  200. package/lib/src/types/AnimationTypes.js.map +1 -0
  201. package/lib/src/types/CharacterStyleTypes.d.ts +65 -0
  202. package/lib/src/types/CharacterStyleTypes.js +2 -0
  203. package/lib/src/types/CharacterStyleTypes.js.map +1 -0
  204. package/lib/src/types/ColorStyleTypes.d.ts +73 -0
  205. package/lib/src/types/ColorStyleTypes.js +24 -0
  206. package/lib/src/types/ColorStyleTypes.js.map +1 -0
  207. package/lib/src/types/CommonTypes.d.ts +92 -0
  208. package/lib/src/types/CommonTypes.js +2 -0
  209. package/lib/src/types/CommonTypes.js.map +1 -0
  210. package/lib/src/types/ConfigurationTypes.d.ts +6 -0
  211. package/lib/src/types/ConfigurationTypes.js +8 -0
  212. package/lib/src/types/ConfigurationTypes.js.map +1 -0
  213. package/lib/src/types/ConnectorTypes.d.ts +115 -0
  214. package/lib/src/types/ConnectorTypes.js +94 -0
  215. package/lib/src/types/ConnectorTypes.js.map +1 -0
  216. package/lib/src/types/DebugTypes.d.ts +25 -0
  217. package/lib/src/types/DebugTypes.js +8 -0
  218. package/lib/src/types/DebugTypes.js.map +1 -0
  219. package/lib/src/types/DocumentTypes.d.ts +180 -0
  220. package/lib/src/types/DocumentTypes.js +17 -0
  221. package/lib/src/types/DocumentTypes.js.map +1 -0
  222. package/lib/src/types/FontConnectorTypes.d.ts +20 -0
  223. package/lib/src/types/FontConnectorTypes.js +6 -0
  224. package/lib/src/types/FontConnectorTypes.js.map +1 -0
  225. package/lib/src/types/FontTypes.d.ts +15 -0
  226. package/lib/src/types/FontTypes.js +2 -0
  227. package/lib/src/types/FontTypes.js.map +1 -0
  228. package/lib/src/types/FrameTypes.d.ts +156 -0
  229. package/lib/src/types/FrameTypes.js +63 -0
  230. package/lib/src/types/FrameTypes.js.map +1 -0
  231. package/lib/src/types/LayoutTypes.d.ts +61 -0
  232. package/lib/src/types/LayoutTypes.js +6 -0
  233. package/lib/src/types/LayoutTypes.js.map +1 -0
  234. package/lib/src/types/MediaConnectorTypes.d.ts +20 -0
  235. package/lib/src/types/MediaConnectorTypes.js +6 -0
  236. package/lib/src/types/MediaConnectorTypes.js.map +1 -0
  237. package/lib/src/types/PageTypes.d.ts +12 -0
  238. package/lib/src/types/PageTypes.js +2 -0
  239. package/lib/src/types/PageTypes.js.map +1 -0
  240. package/lib/src/types/ParagraphStyleTypes.d.ts +79 -0
  241. package/lib/src/types/ParagraphStyleTypes.js +2 -0
  242. package/lib/src/types/ParagraphStyleTypes.js.map +1 -0
  243. package/lib/src/types/ShapeTypes.d.ts +26 -0
  244. package/lib/src/types/ShapeTypes.js +13 -0
  245. package/lib/src/types/ShapeTypes.js.map +1 -0
  246. package/lib/src/types/TextStyleTypes.d.ts +131 -0
  247. package/lib/src/types/TextStyleTypes.js +68 -0
  248. package/lib/src/types/TextStyleTypes.js.map +1 -0
  249. package/lib/src/types/VariableTypes.d.ts +45 -0
  250. package/lib/src/types/VariableTypes.js +13 -0
  251. package/lib/src/types/VariableTypes.js.map +1 -0
  252. package/lib/src/utils/EditorResponseData.d.ts +3 -0
  253. package/lib/src/utils/EditorResponseData.js +16 -0
  254. package/lib/src/utils/EditorResponseData.js.map +1 -0
  255. package/lib/src/utils/enums.d.ts +30 -0
  256. package/lib/src/utils/enums.js +36 -0
  257. package/lib/src/utils/enums.js.map +1 -0
  258. package/lib/src/utils/getCalculatedValue.d.ts +2 -0
  259. package/lib/src/utils/getCalculatedValue.js +20 -0
  260. package/lib/src/utils/getCalculatedValue.js.map +1 -0
  261. package/lib/src/utils/getFetchUrl.d.ts +2 -0
  262. package/lib/src/utils/getFetchUrl.js +3 -0
  263. package/lib/src/utils/getFetchUrl.js.map +1 -0
  264. package/package.json +89 -0
@@ -0,0 +1,107 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
11
+ if (kind === "m") throw new TypeError("Private method is not writable");
12
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
13
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
14
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
15
+ };
16
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
17
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
18
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
19
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
20
+ };
21
+ var _CharacterStyleController_editorAPI;
22
+ import { getEditorResponseData } from '../utils/EditorResponseData';
23
+ /**
24
+ * The CharacterStyleController is responsible for all communication regarding character styles.
25
+ * Methods inside this controller can be called by `window.SDK.characterStyle.{method-name}`
26
+ */
27
+ export class CharacterStyleController {
28
+ /**
29
+ * @ignore
30
+ */
31
+ constructor(editorAPI) {
32
+ /**
33
+ * @ignore
34
+ */
35
+ _CharacterStyleController_editorAPI.set(this, void 0);
36
+ /**
37
+ * This method returns the list of character styles
38
+ * @returns
39
+ */
40
+ this.getCharacterStyles = () => __awaiter(this, void 0, void 0, function* () {
41
+ const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
42
+ return res.getCharacterStyles().then((result) => getEditorResponseData(result));
43
+ });
44
+ /**
45
+ * This method returns a character style by id
46
+ * @param characterStyleId The ID of a specific character style
47
+ * @returns
48
+ */
49
+ this.getCharacterStyleById = (characterStyleId) => __awaiter(this, void 0, void 0, function* () {
50
+ const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
51
+ return res
52
+ .getCharacterStyleById(characterStyleId)
53
+ .then((result) => getEditorResponseData(result));
54
+ });
55
+ /**
56
+ * This method creates a new character style
57
+ * @returns the new created character style id
58
+ */
59
+ this.createCharacterStyle = () => __awaiter(this, void 0, void 0, function* () {
60
+ const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
61
+ return res.createCharacterStyle().then((result) => getEditorResponseData(result));
62
+ });
63
+ /**
64
+ * This method updates a character style
65
+ * @param id The ID of a specific character style
66
+ * @param characterStyle The new character style properties
67
+ * @returns
68
+ */
69
+ this.updateCharacterStyle = (id, characterStyle) => __awaiter(this, void 0, void 0, function* () {
70
+ const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
71
+ return res
72
+ .updateCharacterStyle(id, JSON.stringify(characterStyle))
73
+ .then((result) => getEditorResponseData(result));
74
+ });
75
+ /**
76
+ * This method removes a character style
77
+ * @param id The ID of a specific character style
78
+ * @returns
79
+ */
80
+ this.removeCharacterStyle = (id) => __awaiter(this, void 0, void 0, function* () {
81
+ const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
82
+ return res.removeCharacterStyle(id).then((result) => getEditorResponseData(result));
83
+ });
84
+ /**
85
+ * This method duplicates a character style
86
+ * @param characterStyleId The ID of a specific character style
87
+ * @returns
88
+ */
89
+ this.duplicateCharacterStyle = (characterStyleId) => __awaiter(this, void 0, void 0, function* () {
90
+ const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
91
+ return res.duplicateCharacterStyle(characterStyleId).then((result) => getEditorResponseData(result));
92
+ });
93
+ /**
94
+ * This method renames a character style
95
+ * @param id The ID of a specific character style
96
+ * @param name The new name of the character style
97
+ * @returns
98
+ */
99
+ this.renameCharacterStyle = (id, name) => __awaiter(this, void 0, void 0, function* () {
100
+ const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
101
+ return res.renameCharacterStyle(id, name).then((result) => getEditorResponseData(result));
102
+ });
103
+ __classPrivateFieldSet(this, _CharacterStyleController_editorAPI, editorAPI, "f");
104
+ }
105
+ }
106
+ _CharacterStyleController_editorAPI = new WeakMap();
107
+ //# sourceMappingURL=CharacterStyleController.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CharacterStyleController.js","sourceRoot":"","sources":["../../../src/controllers/CharacterStyleController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGpE;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAMjC;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,sDAAsB;QAStB;;;WAGG;QACH,uBAAkB,GAAG,GAAS,EAAE;YAC5B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QACtG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,0BAAqB,GAAG,CAAO,gBAAoB,EAAE,EAAE;YACnD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,qBAAqB,CAAC,gBAAgB,CAAC;iBACvC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiB,MAAM,CAAC,CAAC,CAAC;QACzE,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,yBAAoB,GAAG,GAAS,EAAE;YAC9B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,yBAAoB,GAAG,CAAO,EAAM,EAAE,cAAoC,EAAE,EAAE;YAC1E,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,oBAAoB,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;iBACxD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,yBAAoB,GAAG,CAAO,EAAM,EAAE,EAAE;YACpC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,4BAAuB,GAAG,CAAO,gBAAoB,EAAE,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QACjH,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,yBAAoB,GAAG,CAAO,EAAM,EAAE,IAAY,EAAE,EAAE;YAClD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACpG,CAAC,CAAA,CAAC;QA3EE,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA2EJ"}
@@ -0,0 +1,62 @@
1
+ import { EditorAPI } from '../types/CommonTypes';
2
+ import { ColorUpdate, DocumentColor } from '../types/ColorStyleTypes';
3
+ /**
4
+ * The ColorStyleController is responsible for all communication regarding color styles.
5
+ * Methods inside this controller can be called by `window.SDK.colorStyle.{method-name}`
6
+ */
7
+ export declare class ColorStyleController {
8
+ #private;
9
+ /**
10
+ * @ignore
11
+ */
12
+ constructor(editorAPI: EditorAPI);
13
+ /**
14
+ * This method returns the list of colors
15
+ * @returns
16
+ */
17
+ getColors: () => Promise<import("../types/CommonTypes").EditorResponse<DocumentColor[]>>;
18
+ /**
19
+ * This method returns a color by id
20
+ * @param colorId The ID of a specific color
21
+ * @returns
22
+ */
23
+ getColorById: (colorId: string) => Promise<import("../types/CommonTypes").EditorResponse<DocumentColor>>;
24
+ /**
25
+ * This method create a new color
26
+ * @returns the new created color id
27
+ */
28
+ createColor: () => Promise<import("../types/CommonTypes").EditorResponse<string>>;
29
+ /**
30
+ * This method duplicates a color
31
+ * @param colorId The ID of a specific color
32
+ * @returns the new color id
33
+ */
34
+ duplicateColor: (colorId: string) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
35
+ /**
36
+ * This method changes positions of colors
37
+ * @param order The position of the colors
38
+ * @param colorIds The list of color ids
39
+ * @returns
40
+ */
41
+ moveColors: (order: number, colorIds: string[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
42
+ /**
43
+ * This method renames a color
44
+ * @param id The ID of a specific color
45
+ * @param name The new name of the color
46
+ * @returns
47
+ */
48
+ renameColor: (id: string, name: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
49
+ /**
50
+ * This method updates a color
51
+ * @param id The ID of a specific color
52
+ * @param color The new color properties
53
+ * @returns
54
+ */
55
+ updateColor: (id: string, color: ColorUpdate) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
56
+ /**
57
+ * This method removes a color
58
+ * @param id The ID of a specific color
59
+ * @returns
60
+ */
61
+ removeColor: (id: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
62
+ }
@@ -0,0 +1,113 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
11
+ if (kind === "m") throw new TypeError("Private method is not writable");
12
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
13
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
14
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
15
+ };
16
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
17
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
18
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
19
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
20
+ };
21
+ var _ColorStyleController_editorAPI;
22
+ import { getEditorResponseData } from '../utils/EditorResponseData';
23
+ /**
24
+ * The ColorStyleController is responsible for all communication regarding color styles.
25
+ * Methods inside this controller can be called by `window.SDK.colorStyle.{method-name}`
26
+ */
27
+ export class ColorStyleController {
28
+ /**
29
+ * @ignore
30
+ */
31
+ constructor(editorAPI) {
32
+ /**
33
+ * @ignore
34
+ */
35
+ _ColorStyleController_editorAPI.set(this, void 0);
36
+ /**
37
+ * This method returns the list of colors
38
+ * @returns
39
+ */
40
+ this.getColors = () => __awaiter(this, void 0, void 0, function* () {
41
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
42
+ return res.getColors().then((result) => getEditorResponseData(result));
43
+ });
44
+ /**
45
+ * This method returns a color by id
46
+ * @param colorId The ID of a specific color
47
+ * @returns
48
+ */
49
+ this.getColorById = (colorId) => __awaiter(this, void 0, void 0, function* () {
50
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
51
+ return res.getColorById(colorId).then((result) => getEditorResponseData(result));
52
+ });
53
+ /**
54
+ * This method create a new color
55
+ * @returns the new created color id
56
+ */
57
+ this.createColor = () => __awaiter(this, void 0, void 0, function* () {
58
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
59
+ return res.createColor().then((result) => getEditorResponseData(result));
60
+ });
61
+ /**
62
+ * This method duplicates a color
63
+ * @param colorId The ID of a specific color
64
+ * @returns the new color id
65
+ */
66
+ this.duplicateColor = (colorId) => __awaiter(this, void 0, void 0, function* () {
67
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
68
+ return res.duplicateColor(colorId).then((result) => getEditorResponseData(result));
69
+ });
70
+ /**
71
+ * This method changes positions of colors
72
+ * @param order The position of the colors
73
+ * @param colorIds The list of color ids
74
+ * @returns
75
+ */
76
+ this.moveColors = (order, colorIds) => __awaiter(this, void 0, void 0, function* () {
77
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
78
+ return res.moveColors(order, colorIds).then((result) => getEditorResponseData(result));
79
+ });
80
+ /**
81
+ * This method renames a color
82
+ * @param id The ID of a specific color
83
+ * @param name The new name of the color
84
+ * @returns
85
+ */
86
+ this.renameColor = (id, name) => __awaiter(this, void 0, void 0, function* () {
87
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
88
+ return res.renameColor(id, name).then((result) => getEditorResponseData(result));
89
+ });
90
+ /**
91
+ * This method updates a color
92
+ * @param id The ID of a specific color
93
+ * @param color The new color properties
94
+ * @returns
95
+ */
96
+ this.updateColor = (id, color) => __awaiter(this, void 0, void 0, function* () {
97
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
98
+ return res.updateColor(id, JSON.stringify(color)).then((result) => getEditorResponseData(result));
99
+ });
100
+ /**
101
+ * This method removes a color
102
+ * @param id The ID of a specific color
103
+ * @returns
104
+ */
105
+ this.removeColor = (id) => __awaiter(this, void 0, void 0, function* () {
106
+ const res = yield __classPrivateFieldGet(this, _ColorStyleController_editorAPI, "f");
107
+ return res.removeColor(id).then((result) => getEditorResponseData(result));
108
+ });
109
+ __classPrivateFieldSet(this, _ColorStyleController_editorAPI, editorAPI, "f");
110
+ }
111
+ }
112
+ _ColorStyleController_editorAPI = new WeakMap();
113
+ //# sourceMappingURL=ColorStyleController.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ColorStyleController.js","sourceRoot":"","sources":["../../../src/controllers/ColorStyleController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAM7B;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,kDAAsB;QAStB;;;WAGG;QACH,cAAS,GAAG,GAAS,EAAE;YACnB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAkB,MAAM,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,iBAAY,GAAG,CAAO,OAAe,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAgB,MAAM,CAAC,CAAC,CAAC;QACpG,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,gBAAW,GAAG,GAAS,EAAE;YACrB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QACrF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,mBAAc,GAAG,CAAO,OAAe,EAAE,EAAE;YACvC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC/F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,eAAU,GAAG,CAAO,KAAa,EAAE,QAAkB,EAAE,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACjG,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,gBAAW,GAAG,CAAO,EAAU,EAAE,IAAY,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,gBAAW,GAAG,CAAO,EAAU,EAAE,KAAkB,EAAE,EAAE;YACnD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC5G,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,gBAAW,GAAG,CAAO,EAAU,EAAE,EAAE;YAC/B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACrF,CAAC,CAAA,CAAC;QAlFE,uBAAA,IAAI,mCAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CAkFJ"}
@@ -0,0 +1,27 @@
1
+ import { EditorAPI } from '../types/CommonTypes';
2
+ import { WellKnownConfigurationKeys } from '../types/ConfigurationTypes';
3
+ /**
4
+ * The ConfigurationController allows setting editor session data. This data is not stored in the document and
5
+ * can only be used at runtime. Amongst others, the configuration store is available to the editor connectors and
6
+ * Javascript actions running in the editor.
7
+ * Methods inside this controller can be called by `window.SDK.configuration.{method-name}`
8
+ */
9
+ export declare class ConfigurationController {
10
+ #private;
11
+ /**
12
+ * @ignore
13
+ */
14
+ constructor(editorAPI: EditorAPI);
15
+ /**
16
+ * This method returns the value for a given configuration key. If a value was not found in the configuration store
17
+ * this method returns an error. The key cannot be null.
18
+ * @returns
19
+ */
20
+ getValue: (key: WellKnownConfigurationKeys | string) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
21
+ /**
22
+ * This method sets, or overrides the value for a given key. Null values are not allowed for both key and value,
23
+ * using them will result in an error.
24
+ * @returns
25
+ */
26
+ setValue: (key: WellKnownConfigurationKeys | string, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
27
+ }
@@ -0,0 +1,60 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
11
+ if (kind === "m") throw new TypeError("Private method is not writable");
12
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
13
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
14
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
15
+ };
16
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
17
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
18
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
19
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
20
+ };
21
+ var _ConfigurationController_editorAPI;
22
+ import { getEditorResponseData } from '../utils/EditorResponseData';
23
+ /**
24
+ * The ConfigurationController allows setting editor session data. This data is not stored in the document and
25
+ * can only be used at runtime. Amongst others, the configuration store is available to the editor connectors and
26
+ * Javascript actions running in the editor.
27
+ * Methods inside this controller can be called by `window.SDK.configuration.{method-name}`
28
+ */
29
+ export class ConfigurationController {
30
+ /**
31
+ * @ignore
32
+ */
33
+ constructor(editorAPI) {
34
+ /**
35
+ * @ignore
36
+ */
37
+ _ConfigurationController_editorAPI.set(this, void 0);
38
+ /**
39
+ * This method returns the value for a given configuration key. If a value was not found in the configuration store
40
+ * this method returns an error. The key cannot be null.
41
+ * @returns
42
+ */
43
+ this.getValue = (key) => __awaiter(this, void 0, void 0, function* () {
44
+ const res = yield __classPrivateFieldGet(this, _ConfigurationController_editorAPI, "f");
45
+ return res.getConfigValue(key).then((result) => getEditorResponseData(result));
46
+ });
47
+ /**
48
+ * This method sets, or overrides the value for a given key. Null values are not allowed for both key and value,
49
+ * using them will result in an error.
50
+ * @returns
51
+ */
52
+ this.setValue = (key, value) => __awaiter(this, void 0, void 0, function* () {
53
+ const res = yield __classPrivateFieldGet(this, _ConfigurationController_editorAPI, "f");
54
+ return res.setConfigValue(key, value).then((result) => getEditorResponseData(result));
55
+ });
56
+ __classPrivateFieldSet(this, _ConfigurationController_editorAPI, editorAPI, "f");
57
+ }
58
+ }
59
+ _ConfigurationController_editorAPI = new WeakMap();
60
+ //# sourceMappingURL=ConfigurationController.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ConfigurationController.js","sourceRoot":"","sources":["../../../src/controllers/ConfigurationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGpE;;;;;GAKG;AACH,MAAM,OAAO,uBAAuB;IAMhC;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,qDAAsB;QAStB;;;;WAIG;QACH,aAAQ,GAAG,CAAO,GAAwC,EAAE,EAAE;YAC1D,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,0CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,aAAQ,GAAG,CAAO,GAAwC,EAAE,KAAa,EAAE,EAAE;YACzE,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,0CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAChG,CAAC,CAAA,CAAC;QArBE,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CAqBJ"}
@@ -0,0 +1,90 @@
1
+ import { ConnectorOptions, EditorAPI, EditorResponse } from '../types/CommonTypes';
2
+ import { ConnectorState, ConnectorMapping, ConnectorRegistration } from '../types/ConnectorTypes';
3
+ /**
4
+ * The ConnectorController manages lifetime of all available connectors, regardless of the type, in the
5
+ * document. Use it to add/remove connectors to a template, or set specific configuration.
6
+ *
7
+ * The way CHILI Studio handles different sources of resouces is called 'Connectors'. A Connectors is an
8
+ * implementation of a set of capabilities we need to interact with a certain external resource management system.
9
+ * In essence a connector is the combination of a Javascript snippet and some metadata. The Javascript snippet
10
+ * is loaded in the studio engine using a sandboxed Javascript execution engine (QuickJs). This allows us to
11
+ * execute the media connector both on web using webassembly and on the server side during e.g. animation output
12
+ * generation.
13
+ * This controller is an interface to the running connector instance inside the studio engine. The engine will
14
+ * automatically register the 'grafx-media' and 'grafx-font' connectors. Custom connectors need to be registered
15
+ * manually.
16
+ */
17
+ export declare class ConnectorController {
18
+ #private;
19
+ /**
20
+ * @ignore
21
+ */
22
+ constructor(editorAPI: EditorAPI);
23
+ /**
24
+ * Registers a new connector in the SDK. After successful registration, depending
25
+ * on the connector type, the connector can be configured and used in the template
26
+ * Remember to add custom authentication information after registering the connector
27
+ * @param registration registration object containing all details about the connector
28
+ */
29
+ registerConnector: (registration: ConnectorRegistration) => Promise<EditorResponse<null>>;
30
+ /**
31
+ * Configures a registered connector. A configurator helper is passed as an argument
32
+ * of the callback for you to setup your connector.
33
+ * @param connectorId Id of your registered connector
34
+ * @param configurationCallback callback to setup the connector
35
+ */
36
+ configure: (connectorId: string, configurationCallback: (configurator: ConnectorConfigurator) => Promise<void>) => Promise<EditorResponse<null>>;
37
+ /**
38
+ * Gets the current state a connector is in, to wait until a connector is ready to be used, use the 'waitForConnectorReady'
39
+ * method in this controller.
40
+ * @param connectorId Id of your registered connector you want to make sure it is loaded
41
+ */
42
+ getState: (connectorId: string) => Promise<EditorResponse<ConnectorState>>;
43
+ /**
44
+ * Connectors are loaded asynchronously in the editor engine, this causes some challenges while configuring them. To make sure
45
+ * an action on the connector will be available, it's advised to await this method. After the Promise resolves we are sure
46
+ * the connector is up and running. This is used internally by the configure method to ensure correct execution. It's especially
47
+ * usefull during startup of the SDK / rigth after the loadDocument call.
48
+ * @param connectorId Id of your registered connector you want to make sure it is loaded
49
+ */
50
+ waitForConnectorReady: (connectorId: string, timeoutMilliseconds?: number) => Promise<EditorResponse<null>>;
51
+ }
52
+ /**
53
+ * Helper to setup your connector
54
+ */
55
+ declare class ConnectorConfigurator {
56
+ #private;
57
+ /**
58
+ * @ignore
59
+ */
60
+ constructor(connectorId: string, res: EditorAPI);
61
+ /**
62
+ * Allows to customize the context data a connector can work with. The options data
63
+ * will be available using the context parameter in the connector implementation code.
64
+ * @param options object containing key value data to pass to connector context
65
+ */
66
+ setOptions: (options: ConnectorOptions) => Promise<EditorResponse<null>>;
67
+ /**
68
+ * Allows to map document data (variables, selectedFrame, etc) to connector context data.
69
+ * By defining the mappings, we can trigger redownload of assets (dynamic asset provider)
70
+ * or populate filters for the query endpoint. The mapped data will be available using
71
+ * the context parameter in the connector implementation code.
72
+ * @param mappings collection of mappings to set to this connector
73
+ */
74
+ setMappings: (mappings: ConnectorMapping[]) => Promise<EditorResponse<null>>;
75
+ /**
76
+ * This method sets the CHILI GraFx Access Token in the Authentication HTTP header for the 'chili' authentication type.
77
+ * The CHILI Token will be used to authenticate every grafx connector http call.
78
+ * @param token token for the CHILI authentication
79
+ */
80
+ setChiliToken: (token: string) => Promise<EditorResponse<null>>;
81
+ /**
82
+ * This method sets the HTTP headers for the 'staticKey' authentication type.
83
+ * These additional headers will be added to all connector http calls.
84
+ * Can only be used after a connector has been registered. (if you are using a grafx connector no registration is needed)
85
+ * @param headerName name of the header
86
+ * @param headerValue value of the header
87
+ */
88
+ setHttpHeader: (headerName: string, headerValue: string) => Promise<EditorResponse<null>>;
89
+ }
90
+ export {};