@limetech/lime-web-components 5.0.1 → 5.2.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 (282) hide show
  1. package/README.md +9 -2
  2. package/dist/application/decorators/application.d.ts +5 -2
  3. package/dist/application/decorators/application.d.ts.map +1 -0
  4. package/dist/application/decorators/application.js +4 -2
  5. package/dist/application/decorators/index.d.ts +1 -0
  6. package/dist/application/decorators/index.d.ts.map +1 -0
  7. package/dist/application/decorators/session.d.ts +5 -2
  8. package/dist/application/decorators/session.d.ts.map +1 -0
  9. package/dist/application/decorators/session.js +4 -2
  10. package/dist/application/decorators/user.d.ts +5 -2
  11. package/dist/application/decorators/user.d.ts.map +1 -0
  12. package/dist/application/decorators/user.js +4 -2
  13. package/dist/application/index.d.ts +1 -0
  14. package/dist/application/index.d.ts.map +1 -0
  15. package/dist/application/session.d.ts +5 -0
  16. package/dist/application/session.d.ts.map +1 -0
  17. package/dist/application/types.d.ts +1 -0
  18. package/dist/application/types.d.ts.map +1 -0
  19. package/dist/application/user.d.ts +14 -2
  20. package/dist/application/user.d.ts.map +1 -0
  21. package/dist/commandbus/commandbus.d.ts +69 -25
  22. package/dist/commandbus/commandbus.d.ts.map +1 -0
  23. package/dist/commandbus/commandbus.js +13 -8
  24. package/dist/commandbus/index.d.ts +1 -0
  25. package/dist/commandbus/index.d.ts.map +1 -0
  26. package/dist/commandbus/types.d.ts +2 -1
  27. package/dist/commandbus/types.d.ts.map +1 -0
  28. package/dist/config/decorator.d.ts +7 -2
  29. package/dist/config/decorator.d.ts.map +1 -0
  30. package/dist/config/decorator.js +4 -2
  31. package/dist/config/index.d.ts +1 -0
  32. package/dist/config/index.d.ts.map +1 -0
  33. package/dist/config/repository.d.ts +7 -2
  34. package/dist/config/repository.d.ts.map +1 -0
  35. package/dist/config/types.d.ts +2 -1
  36. package/dist/config/types.d.ts.map +1 -0
  37. package/dist/core/context.d.ts +3 -0
  38. package/dist/core/context.d.ts.map +1 -0
  39. package/dist/core/decorators/factory.d.ts +13 -7
  40. package/dist/core/decorators/factory.d.ts.map +1 -0
  41. package/dist/core/decorators/factory.js +33 -32
  42. package/dist/core/decorators/factory.spec.d.ts +1 -0
  43. package/dist/core/decorators/factory.spec.d.ts.map +1 -0
  44. package/dist/core/decorators/index.d.ts +1 -0
  45. package/dist/core/decorators/index.d.ts.map +1 -0
  46. package/dist/core/index.d.ts +1 -0
  47. package/dist/core/index.d.ts.map +1 -0
  48. package/dist/core/lime-web-component.d.ts +3 -0
  49. package/dist/core/lime-web-component.d.ts.map +1 -0
  50. package/dist/core/platform.d.ts +14 -5
  51. package/dist/core/platform.d.ts.map +1 -0
  52. package/dist/core/platform.js +2 -0
  53. package/dist/core/plugin-loader.d.ts +3 -0
  54. package/dist/core/plugin-loader.d.ts.map +1 -0
  55. package/dist/core/state.d.ts +12 -3
  56. package/dist/core/state.d.ts.map +1 -0
  57. package/dist/device/decorator.d.ts +8 -5
  58. package/dist/device/decorator.d.ts.map +1 -0
  59. package/dist/device/decorator.js +4 -2
  60. package/dist/device/device.d.ts +8 -3
  61. package/dist/device/device.d.ts.map +1 -0
  62. package/dist/device/index.d.ts +1 -0
  63. package/dist/device/index.d.ts.map +1 -0
  64. package/dist/device/types.d.ts +2 -1
  65. package/dist/device/types.d.ts.map +1 -0
  66. package/dist/dialog/dialog.d.ts +23 -10
  67. package/dist/dialog/dialog.d.ts.map +1 -0
  68. package/dist/dialog/index.d.ts +1 -0
  69. package/dist/dialog/index.d.ts.map +1 -0
  70. package/dist/dialog/types.d.ts +1 -0
  71. package/dist/dialog/types.d.ts.map +1 -0
  72. package/dist/es5/index.js +1 -0
  73. package/dist/es5/userpreferences/index.js +5 -0
  74. package/dist/es5/userpreferences/repository.js +2 -0
  75. package/dist/es5/userpreferences/types.js +5 -0
  76. package/dist/eventdispatcher/eventdispatcher.d.ts +9 -6
  77. package/dist/eventdispatcher/eventdispatcher.d.ts.map +1 -0
  78. package/dist/eventdispatcher/index.d.ts +1 -0
  79. package/dist/eventdispatcher/index.d.ts.map +1 -0
  80. package/dist/eventdispatcher/types.d.ts +2 -1
  81. package/dist/eventdispatcher/types.d.ts.map +1 -0
  82. package/dist/filter/decorator.d.ts +7 -2
  83. package/dist/filter/decorator.d.ts.map +1 -0
  84. package/dist/filter/decorator.js +4 -2
  85. package/dist/filter/index.d.ts +1 -0
  86. package/dist/filter/index.d.ts.map +1 -0
  87. package/dist/filter/repository.d.ts +9 -4
  88. package/dist/filter/repository.d.ts.map +1 -0
  89. package/dist/filter/types.d.ts +2 -1
  90. package/dist/filter/types.d.ts.map +1 -0
  91. package/dist/http/http.d.ts +39 -19
  92. package/dist/http/http.d.ts.map +1 -0
  93. package/dist/http/index.d.ts +1 -0
  94. package/dist/http/index.d.ts.map +1 -0
  95. package/dist/http/types.d.ts +1 -0
  96. package/dist/http/types.d.ts.map +1 -0
  97. package/dist/index.d.ts +8 -0
  98. package/dist/index.d.ts.map +1 -0
  99. package/dist/index.js +7 -0
  100. package/dist/keybindings/index.d.ts +1 -0
  101. package/dist/keybindings/index.d.ts.map +1 -0
  102. package/dist/keybindings/registry.d.ts +15 -9
  103. package/dist/keybindings/registry.d.ts.map +1 -0
  104. package/dist/keybindings/types.d.ts +3 -2
  105. package/dist/keybindings/types.d.ts.map +1 -0
  106. package/dist/limeobject/commands/bulk-create-dialog.d.ts +3 -0
  107. package/dist/limeobject/commands/bulk-create-dialog.d.ts.map +1 -0
  108. package/dist/limeobject/commands/bulk-create-dialog.js +2 -0
  109. package/dist/limeobject/commands/create-dialog.d.ts +3 -0
  110. package/dist/limeobject/commands/create-dialog.d.ts.map +1 -0
  111. package/dist/limeobject/commands/create-dialog.js +2 -0
  112. package/dist/limeobject/commands/delete-object.d.ts +3 -0
  113. package/dist/limeobject/commands/delete-object.d.ts.map +1 -0
  114. package/dist/limeobject/commands/delete-object.js +2 -0
  115. package/dist/limeobject/commands/index.d.ts +1 -0
  116. package/dist/limeobject/commands/index.d.ts.map +1 -0
  117. package/dist/limeobject/commands/object-access.d.ts +3 -0
  118. package/dist/limeobject/commands/object-access.d.ts.map +1 -0
  119. package/dist/limeobject/commands/object-access.js +2 -0
  120. package/dist/limeobject/commands/save-object.d.ts +3 -0
  121. package/dist/limeobject/commands/save-object.d.ts.map +1 -0
  122. package/dist/limeobject/commands/save-object.js +2 -0
  123. package/dist/limeobject/decorator.d.ts +11 -4
  124. package/dist/limeobject/decorator.d.ts.map +1 -0
  125. package/dist/limeobject/decorator.js +8 -4
  126. package/dist/limeobject/error.d.ts +35 -0
  127. package/dist/limeobject/error.d.ts.map +1 -0
  128. package/dist/limeobject/index.d.ts +1 -0
  129. package/dist/limeobject/index.d.ts.map +1 -0
  130. package/dist/limeobject/limeobject.d.ts +6 -3
  131. package/dist/limeobject/limeobject.d.ts.map +1 -0
  132. package/dist/limeobject/repository.d.ts +38 -13
  133. package/dist/limeobject/repository.d.ts.map +1 -0
  134. package/dist/limeobject/types.d.ts +2 -1
  135. package/dist/limeobject/types.d.ts.map +1 -0
  136. package/dist/limetype/acl.d.ts +5 -0
  137. package/dist/limetype/acl.d.ts.map +1 -0
  138. package/dist/limetype/decorator.d.ts +11 -4
  139. package/dist/limetype/decorator.d.ts.map +1 -0
  140. package/dist/limetype/decorator.js +8 -4
  141. package/dist/limetype/index.d.ts +1 -0
  142. package/dist/limetype/index.d.ts.map +1 -0
  143. package/dist/limetype/limetype.d.ts +9 -2
  144. package/dist/limetype/limetype.d.ts.map +1 -0
  145. package/dist/limetype/property.d.ts +34 -1
  146. package/dist/limetype/property.d.ts.map +1 -0
  147. package/dist/limetype/property.js +20 -0
  148. package/dist/limetype/types.d.ts +1 -0
  149. package/dist/limetype/types.d.ts.map +1 -0
  150. package/dist/navigator/command.d.ts +3 -12
  151. package/dist/navigator/command.d.ts.map +1 -0
  152. package/dist/navigator/command.js +2 -0
  153. package/dist/navigator/decorator.d.ts +7 -3
  154. package/dist/navigator/decorator.d.ts.map +1 -0
  155. package/dist/navigator/decorator.js +4 -3
  156. package/dist/navigator/index.d.ts +1 -0
  157. package/dist/navigator/index.d.ts.map +1 -0
  158. package/dist/navigator/navigator.d.ts +48 -20
  159. package/dist/navigator/navigator.d.ts.map +1 -0
  160. package/dist/navigator/types.d.ts +3 -2
  161. package/dist/navigator/types.d.ts.map +1 -0
  162. package/dist/notifications/index.d.ts +1 -0
  163. package/dist/notifications/index.d.ts.map +1 -0
  164. package/dist/notifications/notifications.d.ts +25 -14
  165. package/dist/notifications/notifications.d.ts.map +1 -0
  166. package/dist/notifications/types.d.ts +1 -0
  167. package/dist/notifications/types.d.ts.map +1 -0
  168. package/dist/query/index.d.ts +1 -0
  169. package/dist/query/index.d.ts.map +1 -0
  170. package/dist/query/query.d.ts +21 -0
  171. package/dist/query/query.d.ts.map +1 -0
  172. package/dist/query/query.js +4 -0
  173. package/dist/query/service.d.ts +4 -1
  174. package/dist/query/service.d.ts.map +1 -0
  175. package/dist/query/types.d.ts +1 -0
  176. package/dist/query/types.d.ts.map +1 -0
  177. package/dist/routeregistry/index.d.ts +1 -0
  178. package/dist/routeregistry/index.d.ts.map +1 -0
  179. package/dist/routeregistry/registry.d.ts +20 -7
  180. package/dist/routeregistry/registry.d.ts.map +1 -0
  181. package/dist/routeregistry/types.d.ts +3 -2
  182. package/dist/routeregistry/types.d.ts.map +1 -0
  183. package/dist/task/index.d.ts +1 -0
  184. package/dist/task/index.d.ts.map +1 -0
  185. package/dist/task/repository.d.ts +34 -8
  186. package/dist/task/repository.d.ts.map +1 -0
  187. package/dist/task/repository.js +9 -5
  188. package/dist/task/types.d.ts +2 -1
  189. package/dist/task/types.d.ts.map +1 -0
  190. package/dist/testing/component-testing.d.ts +22 -9
  191. package/dist/testing/component-testing.d.ts.map +1 -0
  192. package/dist/testing/component-testing.js +31 -28
  193. package/dist/testing/component-testing.spec.d.ts +1 -0
  194. package/dist/testing/component-testing.spec.d.ts.map +1 -0
  195. package/dist/testing/index.d.ts +1 -0
  196. package/dist/testing/index.d.ts.map +1 -0
  197. package/dist/testing/limeobjects/company.d.ts +1 -0
  198. package/dist/testing/limeobjects/company.d.ts.map +1 -0
  199. package/dist/testing/limeobjects/coworker.d.ts +1 -0
  200. package/dist/testing/limeobjects/coworker.d.ts.map +1 -0
  201. package/dist/testing/limeobjects/deal.d.ts +1 -0
  202. package/dist/testing/limeobjects/deal.d.ts.map +1 -0
  203. package/dist/testing/limeobjects/document.d.ts +1 -0
  204. package/dist/testing/limeobjects/document.d.ts.map +1 -0
  205. package/dist/testing/limeobjects/index.d.ts +1 -0
  206. package/dist/testing/limeobjects/index.d.ts.map +1 -0
  207. package/dist/testing/limeobjects/person.d.ts +1 -0
  208. package/dist/testing/limeobjects/person.d.ts.map +1 -0
  209. package/dist/testing/limetypes/campaign.d.ts +1 -0
  210. package/dist/testing/limetypes/campaign.d.ts.map +1 -0
  211. package/dist/testing/limetypes/company.d.ts +1 -0
  212. package/dist/testing/limetypes/company.d.ts.map +1 -0
  213. package/dist/testing/limetypes/consent.d.ts +1 -0
  214. package/dist/testing/limetypes/consent.d.ts.map +1 -0
  215. package/dist/testing/limetypes/consenttype.d.ts +1 -0
  216. package/dist/testing/limetypes/consenttype.d.ts.map +1 -0
  217. package/dist/testing/limetypes/coworker.d.ts +1 -0
  218. package/dist/testing/limetypes/coworker.d.ts.map +1 -0
  219. package/dist/testing/limetypes/deal.d.ts +1 -0
  220. package/dist/testing/limetypes/deal.d.ts.map +1 -0
  221. package/dist/testing/limetypes/document.d.ts +1 -0
  222. package/dist/testing/limetypes/document.d.ts.map +1 -0
  223. package/dist/testing/limetypes/helpdesk.d.ts +1 -0
  224. package/dist/testing/limetypes/helpdesk.d.ts.map +1 -0
  225. package/dist/testing/limetypes/helpdesktype.d.ts +1 -0
  226. package/dist/testing/limetypes/helpdesktype.d.ts.map +1 -0
  227. package/dist/testing/limetypes/history.d.ts +1 -0
  228. package/dist/testing/limetypes/history.d.ts.map +1 -0
  229. package/dist/testing/limetypes/index.d.ts +1 -0
  230. package/dist/testing/limetypes/index.d.ts.map +1 -0
  231. package/dist/testing/limetypes/infotiles.d.ts +1 -0
  232. package/dist/testing/limetypes/infotiles.d.ts.map +1 -0
  233. package/dist/testing/limetypes/localize.d.ts +1 -0
  234. package/dist/testing/limetypes/localize.d.ts.map +1 -0
  235. package/dist/testing/limetypes/mailing.d.ts +1 -0
  236. package/dist/testing/limetypes/mailing.d.ts.map +1 -0
  237. package/dist/testing/limetypes/office.d.ts +1 -0
  238. package/dist/testing/limetypes/office.d.ts.map +1 -0
  239. package/dist/testing/limetypes/participant.d.ts +1 -0
  240. package/dist/testing/limetypes/participant.d.ts.map +1 -0
  241. package/dist/testing/limetypes/person.d.ts +1 -0
  242. package/dist/testing/limetypes/person.d.ts.map +1 -0
  243. package/dist/testing/limetypes/recipient.d.ts +1 -0
  244. package/dist/testing/limetypes/recipient.d.ts.map +1 -0
  245. package/dist/testing/limetypes/solutionimprovement.d.ts +1 -0
  246. package/dist/testing/limetypes/solutionimprovement.d.ts.map +1 -0
  247. package/dist/testing/limetypes/successplan.d.ts +1 -0
  248. package/dist/testing/limetypes/successplan.d.ts.map +1 -0
  249. package/dist/testing/limetypes/target.d.ts +1 -0
  250. package/dist/testing/limetypes/target.d.ts.map +1 -0
  251. package/dist/testing/limetypes/todo.d.ts +1 -0
  252. package/dist/testing/limetypes/todo.d.ts.map +1 -0
  253. package/dist/testing/platform/index.d.ts +2 -1
  254. package/dist/testing/platform/index.d.ts.map +1 -0
  255. package/dist/testing/platform/index.js +3 -3
  256. package/dist/testing/platform/platform.spec.d.ts +1 -0
  257. package/dist/testing/platform/platform.spec.d.ts.map +1 -0
  258. package/dist/translator/index.d.ts +1 -0
  259. package/dist/translator/index.d.ts.map +1 -0
  260. package/dist/translator/translator.d.ts +6 -3
  261. package/dist/translator/translator.d.ts.map +1 -0
  262. package/dist/translator/types.d.ts +1 -0
  263. package/dist/translator/types.d.ts.map +1 -0
  264. package/dist/userdata/decorator.d.ts +7 -2
  265. package/dist/userdata/decorator.d.ts.map +1 -0
  266. package/dist/userdata/decorator.js +4 -2
  267. package/dist/userdata/index.d.ts +1 -0
  268. package/dist/userdata/index.d.ts.map +1 -0
  269. package/dist/userdata/repository.d.ts +7 -5
  270. package/dist/userdata/repository.d.ts.map +1 -0
  271. package/dist/userdata/types.d.ts +1 -0
  272. package/dist/userdata/types.d.ts.map +1 -0
  273. package/dist/userpreferences/index.d.ts +3 -0
  274. package/dist/userpreferences/index.d.ts.map +1 -0
  275. package/dist/userpreferences/index.js +2 -0
  276. package/dist/userpreferences/repository.d.ts +27 -0
  277. package/dist/userpreferences/repository.d.ts.map +1 -0
  278. package/dist/userpreferences/repository.js +1 -0
  279. package/dist/userpreferences/types.d.ts +15 -0
  280. package/dist/userpreferences/types.d.ts.map +1 -0
  281. package/dist/userpreferences/types.js +3 -0
  282. package/package.json +25 -25
@@ -1,6 +1,8 @@
1
1
  import { StateOptions } from '../core';
2
2
  /**
3
3
  * Config for the {@link SelectFilters} state decorator
4
+ * @public
5
+ * @group Filters
4
6
  */
5
7
  export interface SelectFiltersOptions extends StateOptions {
6
8
  id?: string;
@@ -9,7 +11,10 @@ export interface SelectFiltersOptions extends StateOptions {
9
11
  /**
10
12
  * Gets a list of filters
11
13
  *
12
- * @param {StateOptions} [options] state decorator options
13
- * @returns {Function} state decorator
14
+ * @param options - state decorator options
15
+ * @returns state decorator
16
+ * @public
17
+ * @group Filters
14
18
  */
15
19
  export declare function SelectFilters(options?: SelectFiltersOptions): PropertyDecorator;
20
+ //# sourceMappingURL=decorator.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/filter/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACtD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CACzB,OAAO,GAAE,oBAAyB,GACnC,iBAAiB,CAMnB"}
@@ -3,8 +3,10 @@ import { createStateDecorator } from '../core/decorators/factory';
3
3
  /**
4
4
  * Gets a list of filters
5
5
  *
6
- * @param {StateOptions} [options] state decorator options
7
- * @returns {Function} state decorator
6
+ * @param options - state decorator options
7
+ * @returns state decorator
8
+ * @public
9
+ * @group Filters
8
10
  */
9
11
  export function SelectFilters(options = {}) {
10
12
  const config = {
@@ -1,3 +1,4 @@
1
1
  export * from './repository';
2
2
  export * from './types';
3
3
  export * from './decorator';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/filter/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}
@@ -1,18 +1,23 @@
1
1
  import { Filter } from '../query';
2
2
  import { StateRepository } from '../core';
3
+ /**
4
+ * @public
5
+ * @group Filters
6
+ */
3
7
  export interface FilterRepository extends StateRepository {
4
8
  /**
5
9
  * Saves the new filter to the database
6
10
  *
7
- * @param filter a filter to save
8
- * @returns {Promise<void>} a promise that will be resolved when the filter is saved
11
+ * @param filter - a filter to save
12
+ * @returns a promise that will be resolved when the filter is saved
9
13
  */
10
14
  save(filter: Filter): Promise<void>;
11
15
  /**
12
16
  * Deletes the filter
13
17
  *
14
- * @param id a filter id to delete
15
- * @returns {Promise<void>} a promise that will be resolved when the filter is deleted
18
+ * @param id - a filter id to delete
19
+ * @returns a promise that will be resolved when the filter is deleted
16
20
  */
17
21
  delete(filter: Filter): Promise<void>;
18
22
  }
23
+ //# sourceMappingURL=repository.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/filter/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC"}
@@ -3,7 +3,7 @@ declare const SERVICE_NAME = "state.filters";
3
3
  declare module '../core/platform' {
4
4
  interface PlatformServiceNameType {
5
5
  /**
6
- * @see {@link Service FilterRepository}
6
+ * @see {@link Service | FilterRepository}
7
7
  */
8
8
  FilterRepository: typeof SERVICE_NAME;
9
9
  }
@@ -12,3 +12,4 @@ declare module '../core/platform' {
12
12
  }
13
13
  }
14
14
  export {};
15
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/filter/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,cAAc,CAAC;AAG3D,QAAA,MAAM,YAAY,kBAAkB,CAAC;AAIrC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,gBAAgB,EAAE,OAAO,YAAY,CAAC;KACzC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC;KACnE;CACJ"}
@@ -3,52 +3,58 @@
3
3
  *
4
4
  * By default, the service will work with the JSON data format. If anything but JSON is returned from the endpoint,
5
5
  * the `responseType` property in the `options` parameter needs to be set.
6
+ * @public
7
+ * @group HTTP
6
8
  */
7
9
  export interface HttpClient {
8
10
  /**
9
11
  * Sends a get request.
10
12
  *
11
- * @param {string} url - Url to resource (for instance my_addon/endpoint).
12
- * @param {object} options - The HTTP options to send with the request.
13
- * @returns {Promise}
13
+ * @param url - Url to resource (for instance my_addon/endpoint).
14
+ * @param options - The HTTP options to send with the request.
15
+ * @returns
14
16
  */
15
17
  get(url: string, options?: HttpOptions): Promise<any>;
16
18
  /**
17
19
  * Sends a post request.
18
20
  *
19
- * @param {string} url - Url to resource (for instance my_addon/endpoint).
20
- * @param {object} data - Payload to send to the server.
21
- * @param {object} options - The HTTP options to send with the request.
22
- * @returns {Promise}
21
+ * @param url - Url to resource (for instance my_addon/endpoint).
22
+ * @param data - Payload to send to the server.
23
+ * @param options - The HTTP options to send with the request.
24
+ * @returns
23
25
  */
24
26
  post(url: string, data?: {}, options?: HttpOptions): Promise<any>;
25
27
  /**
26
28
  * Sends a patch request.
27
29
  *
28
- * @param {string} url - Url to resource (for instance my_addon/endpoint).
29
- * @param {object} data - Payload to send to the server.
30
- * @param {object} options - The HTTP options to send with the request.
31
- * @returns {Promise}
30
+ * @param url - Url to resource (for instance my_addon/endpoint).
31
+ * @param data - Payload to send to the server.
32
+ * @param options - The HTTP options to send with the request.
33
+ * @returns
32
34
  */
33
35
  patch(url: string, data?: {}, options?: HttpOptions): Promise<any>;
34
36
  /**
35
37
  * Sends a put request.
36
38
  *
37
- * @param {string} url - Url to resource (for instance my_addon/endpoint).
38
- * @param {object} data - Payload to send to the server.
39
- * @param {object} options - The HTTP options to send with the request.
40
- * @returns {Promise}
39
+ * @param url - Url to resource (for instance my_addon/endpoint).
40
+ * @param data - Payload to send to the server.
41
+ * @param options - The HTTP options to send with the request.
42
+ * @returns
41
43
  */
42
44
  put(url: string, data?: {}, options?: HttpOptions): Promise<any>;
43
45
  /**
44
46
  * Sends a delete request.
45
47
  *
46
- * @param {string} url - Url to resource (for instance my_addon/endpoint).
47
- * @param {object} options - The HTTP options to send with the request.
48
- * @returns {Promise}
48
+ * @param url - Url to resource (for instance my_addon/endpoint).
49
+ * @param options - The HTTP options to send with the request.
50
+ * @returns
49
51
  */
50
52
  delete(url: string, options?: HttpOptions): Promise<any>;
51
53
  }
54
+ /**
55
+ * @public
56
+ * @group HTTP
57
+ */
52
58
  export interface HttpOptions {
53
59
  /**
54
60
  * Query parameters to include in the request
@@ -63,16 +69,29 @@ export interface HttpOptions {
63
69
  */
64
70
  responseType?: HttpResponseType;
65
71
  }
72
+ /**
73
+ * @public
74
+ * @group HTTP
75
+ */
66
76
  export interface HttpParams {
67
77
  [param: string]: string | string[];
68
78
  }
79
+ /**
80
+ * @public
81
+ * @group HTTP
82
+ */
69
83
  export interface HttpHeaders {
70
84
  [header: string]: string | string[];
71
85
  }
72
- export declare type HttpResponseType = 'text' | 'json' | 'arraybuffer' | 'blob';
86
+ /**
87
+ * @public
88
+ * @group HTTP
89
+ */
90
+ export type HttpResponseType = 'text' | 'json' | 'arraybuffer' | 'blob';
73
91
  /**
74
92
  * Exceptiopn thrown by {@link HttpClient} when an error occurs while sending a
75
93
  * request
94
+ * @public
76
95
  */
77
96
  export interface HttpResponseError extends Error {
78
97
  name: 'HttpResponseError';
@@ -85,3 +104,4 @@ export interface HttpResponseError extends Error {
85
104
  */
86
105
  response: Response;
87
106
  }
107
+ //# sourceMappingURL=http.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/http/http.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACvB;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEnE;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEjE;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;AAExE;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,KAAK;IAC5C,IAAI,EAAE,mBAAmB,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACtB"}
@@ -1,2 +1,3 @@
1
1
  export * from './http';
2
2
  export * from './types';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}
@@ -12,3 +12,4 @@ declare module '../core/platform' {
12
12
  }
13
13
  }
14
14
  export {};
15
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/http/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAGpC,QAAA,MAAM,YAAY,SAAS,CAAC;AAI5B,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,IAAI,EAAE,OAAO,YAAY,CAAC;KAC7B;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;KAC1D;CACJ"}
package/dist/index.d.ts CHANGED
@@ -1,3 +1,9 @@
1
+ /**
2
+ * This is the public API for Lime Web Components. It contains helper functions
3
+ * and interfaces for all services available in the Lime CRM platform.
4
+ *
5
+ * @packageDocumentation
6
+ */
1
7
  export * from './core';
2
8
  export * from './limetype';
3
9
  export * from './limeobject';
@@ -17,3 +23,5 @@ export * from './device';
17
23
  export * from './filter';
18
24
  export * from './userdata';
19
25
  export * from './application';
26
+ export * from './userpreferences';
27
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC"}
package/dist/index.js CHANGED
@@ -1,3 +1,9 @@
1
+ /**
2
+ * This is the public API for Lime Web Components. It contains helper functions
3
+ * and interfaces for all services available in the Lime CRM platform.
4
+ *
5
+ * @packageDocumentation
6
+ */
1
7
  export * from './core';
2
8
  export * from './limetype';
3
9
  export * from './limeobject';
@@ -17,3 +23,4 @@ export * from './device';
17
23
  export * from './filter';
18
24
  export * from './userdata';
19
25
  export * from './application';
26
+ export * from './userpreferences';
@@ -1,2 +1,3 @@
1
1
  export * from './registry';
2
2
  export * from './types';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/keybindings/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}
@@ -18,6 +18,7 @@
18
18
  * `unbind` method.
19
19
  *
20
20
  * @example
21
+ * ```
21
22
  * // The command bus needs to have a handler registered for the command
22
23
  * // before it can be bound to a key sequence
23
24
  * const handler = new MyHandler();
@@ -29,43 +30,47 @@
29
30
  *
30
31
  * // Remove the binding when we no longer need it to trigger the command
31
32
  * keybindingRegistry.unbind('ctrl+s')
33
+ * ```
32
34
  * @note This service is work in progress
33
- * @private
35
+ * @beta
36
+ * @group Keyboard shortcuts
34
37
  */
35
38
  export interface KeybindingRegistry {
36
39
  /**
37
40
  * Bind a command to a specific key combination to add it to the registry
38
41
  *
39
- * @param {string} keys the string representation of keys
40
- * @param {Object} command the command to trigger when keys are pressed
42
+ * @param keys - the string representation of keys
43
+ * @param command - the command to trigger when keys are pressed
41
44
  * @throws Will throw an error if the command is invalid or not registered
42
45
  */
43
46
  bind: (keys: string, command: object) => void;
44
47
  /**
45
48
  * Unbind a keybinding to remove it from the registry
46
49
  *
47
- * @param {string} keys the string representation of the key combination
48
- * @param {Object} command the command connected to the key combination
50
+ * @param keys - the string representation of the key combination
51
+ * @param command - the command connected to the key combination
49
52
  */
50
53
  unbind: (keys: string, command: object) => void;
51
54
  /**
52
55
  * Get a list of the key bindings that are currently in the registry
53
56
  *
54
- * @returns {Keybinding[]} the list of command and its specific key combination
57
+ * @returns the list of command and its specific key combination
55
58
  */
56
59
  getKeybindings: () => Keybinding[];
57
60
  /**
58
61
  * Checks if a key combination or a specific keybinding is already bound
59
62
  *
60
- * @param {string} keys the string representation of a key combination
61
- * @param {Object} command the command connected to the key combination
62
- * @returns {boolean} true if key combination already exists, else false
63
+ * @param keys - the string representation of a key combination
64
+ * @param command - the command connected to the key combination
65
+ * @returns true if key combination already exists, else false
63
66
  */
64
67
  isBound: (keys: string, command?: object) => boolean;
65
68
  }
66
69
  /**
67
70
  * A key combination and its corresponding command that will be triggered when
68
71
  * the key combination is pressed
72
+ * @beta
73
+ * @group Keyboard shortcuts
69
74
  */
70
75
  export interface Keybinding {
71
76
  /**
@@ -77,3 +82,4 @@ export interface Keybinding {
77
82
  */
78
83
  command: object;
79
84
  }
85
+ //# sourceMappingURL=registry.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/keybindings/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;;OAMG;IACH,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAE9C;;;;;OAKG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,cAAc,EAAE,MAAM,UAAU,EAAE,CAAC;IAEnC;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;CACxD;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB"}
@@ -3,10 +3,10 @@ declare const SERVICE_NAME = "keybindingRegistry";
3
3
  declare module '../core/platform' {
4
4
  interface PlatformServiceNameType {
5
5
  /**
6
- * @see {@link Service KeybindingRegistry}
6
+ * @see {@link Service | KeybindingRegistry}
7
7
  *
8
8
  * @note Work in progress, do not use!
9
- * @private
9
+ * @beta
10
10
  */
11
11
  KeybindingRegistry: typeof SERVICE_NAME;
12
12
  }
@@ -15,3 +15,4 @@ declare module '../core/platform' {
15
15
  }
16
16
  }
17
17
  export {};
18
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/keybindings/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,OAAO,EAAE,MAAM,YAAY,CAAC;AAG3D,QAAA,MAAM,YAAY,uBAAuB,CAAC;AAI1C,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;;;;WAKG;QACH,kBAAkB,EAAE,OAAO,YAAY,CAAC;KAC3C;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC;KACrE;CACJ"}
@@ -31,6 +31,8 @@ import { LimeType } from '../../limetype';
31
31
  * ```
32
32
  *
33
33
  * @id `limeobject.bulk-create-dialog`
34
+ * @public
35
+ * @group Lime objects
34
36
  */
35
37
  export declare class BulkCreateDialogCommand {
36
38
  /**
@@ -47,3 +49,4 @@ export declare class BulkCreateDialogCommand {
47
49
  */
48
50
  relations: string[];
49
51
  }
52
+ //# sourceMappingURL=bulk-create-dialog.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"bulk-create-dialog.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/bulk-create-dialog.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAGa,uBAAuB;IAChC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAC;IAE1B;;;OAGG;IACI,MAAM,EAAE,UAAU,CAAC;IAE1B;;OAEG;IACI,SAAS,EAAE,MAAM,EAAE,CAAM;CACnC"}
@@ -31,6 +31,8 @@ import { Command } from '../../commandbus';
31
31
  * ```
32
32
  *
33
33
  * @id `limeobject.bulk-create-dialog`
34
+ * @public
35
+ * @group Lime objects
34
36
  */
35
37
  let BulkCreateDialogCommand = class BulkCreateDialogCommand {
36
38
  constructor() {
@@ -9,6 +9,8 @@ import { LimeType } from '../../limetype';
9
9
  * This dialog also useful to edit a limeobject that already exists
10
10
  *
11
11
  * @id `limeobject.create-dialog`
12
+ * @public
13
+ * @group Lime objects
12
14
  */
13
15
  export declare class CreateLimeobjectDialogCommand {
14
16
  /**
@@ -26,3 +28,4 @@ export declare class CreateLimeobjectDialogCommand {
26
28
  title?: string;
27
29
  context?: LimeWebComponentContext;
28
30
  }
31
+ //# sourceMappingURL=create-dialog.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"create-dialog.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/create-dialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;;;;;;GAWG;AACH,qBAGa,6BAA6B;IACtC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAC;IAE1B;;OAEG;IACI,UAAU,CAAC,EAAE,GAAG,CAAC;IAExB;;OAEG;IACI,KAAK,CAAC,EAAE,OAAO,CAAS;IAKxB,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAC5C"}
@@ -9,6 +9,8 @@ import { Command } from '../../commandbus';
9
9
  * This dialog also useful to edit a limeobject that already exists
10
10
  *
11
11
  * @id `limeobject.create-dialog`
12
+ * @public
13
+ * @group Lime objects
12
14
  */
13
15
  let CreateLimeobjectDialogCommand = class CreateLimeobjectDialogCommand {
14
16
  constructor() {
@@ -3,8 +3,11 @@ import { LimeType } from '../../limetype';
3
3
  * Deletes the object from the database
4
4
  *
5
5
  * @id `limeobject.delete-object`
6
+ * @public
7
+ * @group Lime objects
6
8
  */
7
9
  export declare class DeleteObjectCommand {
8
10
  id: number;
9
11
  limetype: LimeType;
10
12
  }
13
+ //# sourceMappingURL=delete-object.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"delete-object.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/delete-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;GAMG;AACH,qBAGa,mBAAmB;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,QAAQ,CAAC;CACtB"}
@@ -4,6 +4,8 @@ import { Command } from '../../commandbus';
4
4
  * Deletes the object from the database
5
5
  *
6
6
  * @id `limeobject.delete-object`
7
+ * @public
8
+ * @group Lime objects
7
9
  */
8
10
  let DeleteObjectCommand = class DeleteObjectCommand {
9
11
  };
@@ -3,3 +3,4 @@ export * from './create-dialog';
3
3
  export * from './delete-object';
4
4
  export * from './object-access';
5
5
  export * from './save-object';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}
@@ -3,8 +3,11 @@ import { LimeType } from '../../limetype';
3
3
  * Open a dialog to view and edit object access information
4
4
  *
5
5
  * @id `limeobject.object-access`
6
+ * @public
7
+ * @group Lime objects
6
8
  */
7
9
  export declare class OpenObjectAccessDialogCommand {
8
10
  id: number;
9
11
  limetype: LimeType;
10
12
  }
13
+ //# sourceMappingURL=object-access.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"object-access.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/object-access.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;GAMG;AACH,qBAGa,6BAA6B;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,QAAQ,CAAC;CACtB"}
@@ -4,6 +4,8 @@ import { Command } from '../../commandbus';
4
4
  * Open a dialog to view and edit object access information
5
5
  *
6
6
  * @id `limeobject.object-access`
7
+ * @public
8
+ * @group Lime objects
7
9
  */
8
10
  let OpenObjectAccessDialogCommand = class OpenObjectAccessDialogCommand {
9
11
  };
@@ -3,6 +3,8 @@ import { LimeObject } from '../../limeobject';
3
3
  * Saves the object to the database
4
4
  *
5
5
  * @id `limeobject.save-object`
6
+ * @public
7
+ * @group Lime objects
6
8
  */
7
9
  export declare class SaveLimeObjectCommand {
8
10
  /**
@@ -14,3 +16,4 @@ export declare class SaveLimeObjectCommand {
14
16
  */
15
17
  route?: boolean;
16
18
  }
19
+ //# sourceMappingURL=save-object.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"save-object.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/save-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C;;;;;;GAMG;AACH,qBAGa,qBAAqB;IAC9B;;OAEG;IACI,UAAU,EAAE,UAAU,CAAC;IAE9B;;OAEG;IACI,KAAK,CAAC,EAAE,OAAO,CAAS;CAClC"}
@@ -4,6 +4,8 @@ import { Command } from '../../commandbus';
4
4
  * Saves the object to the database
5
5
  *
6
6
  * @id `limeobject.save-object`
7
+ * @public
8
+ * @group Lime objects
7
9
  */
8
10
  let SaveLimeObjectCommand = class SaveLimeObjectCommand {
9
11
  constructor() {
@@ -1,6 +1,8 @@
1
1
  import { StateOptions, LimeWebComponent, ContextAwareStateOptions } from '../core';
2
2
  /**
3
3
  * Config for the {@link SelectLimeObjects} state decorator
4
+ * @public
5
+ * @group Lime objects
4
6
  */
5
7
  export interface SelectLimeObjectsOptions extends StateOptions {
6
8
  /**
@@ -19,14 +21,19 @@ export interface SelectLimeObjectsOptions extends StateOptions {
19
21
  /**
20
22
  * Get a list of limeobjects
21
23
  *
22
- * @param {SelectLimeObjectsOptions} [options] state decorator options
23
- * @returns {Function} state decorator
24
+ * @param options - state decorator options
25
+ * @returns state decorator
26
+ * @public
27
+ * @group Lime objects
24
28
  */
25
29
  export declare function SelectLimeObjects(options?: SelectLimeObjectsOptions): PropertyDecorator;
26
30
  /**
27
31
  * Get the limeobject for the current context
28
32
  *
29
- * @param {StateOptions} [options] state decorator options
30
- * @returns {Function} state decorator
33
+ * @param options - state decorator options
34
+ * @returns state decorator
35
+ * @public
36
+ * @group Lime objects
31
37
  */
32
38
  export declare function SelectCurrentLimeObject(options?: ContextAwareStateOptions): PropertyDecorator;
39
+ //# sourceMappingURL=decorator.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/limeobject/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEZ,gBAAgB,EAChB,wBAAwB,EAC3B,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC1D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,gBAAgB,KAAK,MAAM,CAAC;IAEtD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC7B,OAAO,GAAE,wBAA6B,GACvC,iBAAiB,CAOnB;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CACnC,OAAO,GAAE,wBAA6B,GACvC,iBAAiB,CAQnB"}
@@ -3,8 +3,10 @@ import { createStateDecorator } from '../core/decorators/factory';
3
3
  /**
4
4
  * Get a list of limeobjects
5
5
  *
6
- * @param {SelectLimeObjectsOptions} [options] state decorator options
7
- * @returns {Function} state decorator
6
+ * @param options - state decorator options
7
+ * @returns state decorator
8
+ * @public
9
+ * @group Lime objects
8
10
  */
9
11
  export function SelectLimeObjects(options = {}) {
10
12
  const config = {
@@ -16,8 +18,10 @@ export function SelectLimeObjects(options = {}) {
16
18
  /**
17
19
  * Get the limeobject for the current context
18
20
  *
19
- * @param {StateOptions} [options] state decorator options
20
- * @returns {Function} state decorator
21
+ * @param options - state decorator options
22
+ * @returns state decorator
23
+ * @public
24
+ * @group Lime objects
21
25
  */
22
26
  export function SelectCurrentLimeObject(options = {}) {
23
27
  const config = {
@@ -1,4 +1,39 @@
1
1
  import { LimeObject } from './limeobject';
2
+ /**
3
+ * @public
4
+ * @group Lime objects
5
+ */
2
6
  export interface SaveLimeObjectError extends Error {
7
+ /**
8
+ * The limeobject that could not be saved
9
+ */
3
10
  limeobject: LimeObject;
11
+ /**
12
+ * Validation error messages
13
+ */
14
+ errors?: ValidationError;
4
15
  }
16
+ /**
17
+ * Describes a hierarchy of errors after validation has failed. The error
18
+ * object will have the same structure as the object being validated, e.g. each
19
+ * key in the error will have a corresponding key in the validated object.
20
+ *
21
+ * @example
22
+ * ```json
23
+ * {
24
+ * "name": ["Length can not be more than 15", "Contains invalid characters"],
25
+ * "address": {
26
+ * "city": ["City does not exist"],
27
+ * "zipcode": ["Invalid zipcode"]
28
+ * }
29
+ * }
30
+ * ```
31
+ * @public
32
+ */
33
+ export interface ValidationError {
34
+ /**
35
+ * Name of the field the error belongs to
36
+ */
37
+ [key: string]: string[] | ValidationError;
38
+ }
39
+ //# sourceMappingURL=error.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/limeobject/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,KAAK;IAC9C;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,eAAe,CAAC;CAC7C"}
@@ -4,3 +4,4 @@ export * from './repository';
4
4
  export * from './types';
5
5
  export * from './decorator';
6
6
  export * from './commands';
7
+ //# sourceMappingURL=index.d.ts.map