@tridion-sites/extensions 2.0.1 → 2.0.2

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 (295) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/dts/api/activitiesExplorer/hooks/index.d.ts +2 -0
  3. package/dist/dts/api/activitiesExplorer/hooks/useActivitiesExplorer.d.ts +63 -0
  4. package/dist/dts/api/activitiesExplorer/hooks/useActivitiesExplorerTable.d.ts +41 -0
  5. package/dist/dts/api/activitiesExplorer/index.d.ts +1 -0
  6. package/dist/dts/api/contentExplorer/components/index.d.ts +2 -0
  7. package/dist/dts/api/contentExplorer/components/propertiesGrid.d.ts +29 -0
  8. package/dist/dts/api/contentExplorer/components/propertiesList.d.ts +21 -0
  9. package/dist/dts/api/contentExplorer/hierarchy.d.ts +102 -0
  10. package/dist/dts/api/contentExplorer/hooks/index.d.ts +3 -0
  11. package/dist/dts/api/contentExplorer/hooks/useContentExplorer.d.ts +123 -0
  12. package/dist/dts/api/contentExplorer/hooks/useContentExplorerTable.d.ts +39 -0
  13. package/dist/dts/api/contentExplorer/hooks/useContentExplorerTree.d.ts +27 -0
  14. package/dist/dts/api/contentExplorer/index.d.ts +4 -0
  15. package/dist/dts/api/contentExplorer/utils/hierarchyUtils.d.ts +80 -0
  16. package/dist/dts/api/contentExplorer/utils/index.d.ts +1 -0
  17. package/dist/dts/api/editors/bundle/hooks/index.d.ts +1 -0
  18. package/dist/dts/api/editors/bundle/hooks/useBundleEditor.d.ts +32 -0
  19. package/dist/dts/api/editors/category/hooks/index.d.ts +1 -0
  20. package/dist/dts/api/editors/category/hooks/useCategoryEditor.d.ts +28 -0
  21. package/dist/dts/api/editors/component/hooks/index.d.ts +1 -0
  22. package/dist/dts/api/editors/component/hooks/useComponentEditor.d.ts +32 -0
  23. package/dist/dts/api/editors/folder/hooks/index.d.ts +1 -0
  24. package/dist/dts/api/editors/folder/hooks/useFolderEditor.d.ts +32 -0
  25. package/dist/dts/api/editors/hooks/index.d.ts +1 -0
  26. package/dist/dts/api/editors/hooks/useEditor.d.ts +40 -0
  27. package/dist/dts/api/editors/index.d.ts +8 -0
  28. package/dist/dts/api/editors/keyword/hooks/index.d.ts +1 -0
  29. package/dist/dts/api/editors/keyword/hooks/useKeywordEditor.d.ts +32 -0
  30. package/dist/dts/api/editors/page/hooks/index.d.ts +1 -0
  31. package/dist/dts/api/editors/page/hooks/usePageEditor.d.ts +40 -0
  32. package/dist/dts/api/editors/structureGroup/hooks/index.d.ts +1 -0
  33. package/dist/dts/api/editors/structureGroup/hooks/useStructureGroupEditor.d.ts +32 -0
  34. package/dist/dts/api/general/components/button.d.ts +33 -0
  35. package/dist/dts/api/general/components/icon.d.ts +19 -0
  36. package/dist/dts/api/general/components/index.d.ts +7 -0
  37. package/dist/dts/api/general/components/layout/block.d.ts +55 -0
  38. package/dist/dts/api/general/components/layout/center.d.ts +12 -0
  39. package/dist/dts/api/general/components/layout/flex.d.ts +50 -0
  40. package/dist/dts/api/general/components/layout/index.d.ts +4 -0
  41. package/dist/dts/api/general/components/layout/stack.d.ts +39 -0
  42. package/dist/dts/api/general/components/link.d.ts +29 -0
  43. package/dist/dts/api/general/components/modal.d.ts +61 -0
  44. package/dist/dts/api/general/components/text.d.ts +82 -0
  45. package/dist/dts/api/general/components/textLink.d.ts +16 -0
  46. package/dist/dts/api/general/globals/borderRadius.d.ts +15 -0
  47. package/dist/dts/api/general/globals/color.d.ts +41 -0
  48. package/dist/dts/api/general/globals/index.d.ts +6 -0
  49. package/dist/dts/api/general/globals/opacity.d.ts +16 -0
  50. package/dist/dts/api/general/globals/spacing.d.ts +19 -0
  51. package/dist/dts/api/general/globals/transitionDuration.d.ts +14 -0
  52. package/dist/dts/api/general/globals/zIndex.d.ts +18 -0
  53. package/dist/dts/api/general/hooks/index.d.ts +4 -0
  54. package/dist/dts/api/general/hooks/useConfirmation.d.ts +40 -0
  55. package/dist/dts/api/general/hooks/useModal.d.ts +68 -0
  56. package/dist/dts/api/general/hooks/useNotifications.d.ts +46 -0
  57. package/dist/dts/api/general/hooks/useUserProfile.d.ts +14 -0
  58. package/dist/dts/api/general/index.d.ts +6 -0
  59. package/dist/dts/api/general/mixins/accessibility.d.ts +50 -0
  60. package/dist/dts/api/general/mixins/backgroundColor.d.ts +10 -0
  61. package/dist/dts/api/general/mixins/clickable.d.ts +7 -0
  62. package/dist/dts/api/general/mixins/color.d.ts +10 -0
  63. package/dist/dts/api/general/mixins/customIcon.d.ts +10 -0
  64. package/dist/dts/api/general/mixins/focusBehavior.d.ts +13 -0
  65. package/dist/dts/api/general/mixins/index.d.ts +10 -0
  66. package/dist/dts/api/general/mixins/opacity.d.ts +11 -0
  67. package/dist/dts/api/general/mixins/sizing.d.ts +35 -0
  68. package/dist/dts/api/general/mixins/spacing.d.ts +16 -0
  69. package/dist/dts/api/general/mixins/tooltip.d.ts +9 -0
  70. package/dist/dts/api/general/mutations/batchMutationOptions.d.ts +6 -0
  71. package/dist/dts/api/general/mutations/index.d.ts +10 -0
  72. package/dist/dts/api/general/mutations/item/index.d.ts +24 -0
  73. package/dist/dts/api/general/mutations/item/useAutoClassifyItemMutation.d.ts +20 -0
  74. package/dist/dts/api/general/mutations/item/useAutoClassifyItemsMutation.d.ts +20 -0
  75. package/dist/dts/api/general/mutations/item/useCopyItemMutation.d.ts +20 -0
  76. package/dist/dts/api/general/mutations/item/useCopyItemsMutation.d.ts +20 -0
  77. package/dist/dts/api/general/mutations/item/useDeleteItemMutation.d.ts +20 -0
  78. package/dist/dts/api/general/mutations/item/useDeleteItemsMutation.d.ts +22 -0
  79. package/dist/dts/api/general/mutations/item/useDemoteItemMutation.d.ts +15 -0
  80. package/dist/dts/api/general/mutations/item/useDemoteItemsMutation.d.ts +15 -0
  81. package/dist/dts/api/general/mutations/item/useFinishEditingItemMutation.d.ts +20 -0
  82. package/dist/dts/api/general/mutations/item/useFinishEditingItemsMutation.d.ts +20 -0
  83. package/dist/dts/api/general/mutations/item/useLocalizeItemMutation.d.ts +20 -0
  84. package/dist/dts/api/general/mutations/item/useLocalizeItemsMutation.d.ts +20 -0
  85. package/dist/dts/api/general/mutations/item/useMoveItemMutation.d.ts +24 -0
  86. package/dist/dts/api/general/mutations/item/useMoveItemsMutation.d.ts +24 -0
  87. package/dist/dts/api/general/mutations/item/usePromoteItemMutation.d.ts +16 -0
  88. package/dist/dts/api/general/mutations/item/usePromoteItemsMutation.d.ts +16 -0
  89. package/dist/dts/api/general/mutations/item/usePublishItemsMutation.d.ts +62 -0
  90. package/dist/dts/api/general/mutations/item/useRevertItemMutation.d.ts +20 -0
  91. package/dist/dts/api/general/mutations/item/useRevertItemsMutation.d.ts +20 -0
  92. package/dist/dts/api/general/mutations/item/useRollbackItemMutation.d.ts +29 -0
  93. package/dist/dts/api/general/mutations/item/useUnlocalizeItemMutation.d.ts +21 -0
  94. package/dist/dts/api/general/mutations/item/useUnlocalizeItemsMutation.d.ts +20 -0
  95. package/dist/dts/api/general/mutations/item/useUnpublishItemsMutation.d.ts +46 -0
  96. package/dist/dts/api/general/mutations/item/useUpdateItemMutation.d.ts +16 -0
  97. package/dist/dts/api/general/mutations/mutationOptions.d.ts +38 -0
  98. package/dist/dts/api/general/mutations/mutationResult.d.ts +73 -0
  99. package/dist/dts/api/general/mutations/translation/index.d.ts +1 -0
  100. package/dist/dts/api/general/mutations/translation/useCreateTranslationJobMutation.d.ts +16 -0
  101. package/dist/dts/api/general/mutations/useAddToBundleMutation.d.ts +31 -0
  102. package/dist/dts/api/general/mutations/useChangeUserLanguageMutation.d.ts +20 -0
  103. package/dist/dts/api/general/mutations/useChangeUserLocaleMutation.d.ts +20 -0
  104. package/dist/dts/api/general/mutations/useRemoveFromBundleMutation.d.ts +20 -0
  105. package/dist/dts/api/general/mutations/useUploadMultimediaMutation.d.ts +52 -0
  106. package/dist/dts/api/general/mutations/workflow/index.d.ts +9 -0
  107. package/dist/dts/api/general/mutations/workflow/useAssignActivitiesMutation.d.ts +20 -0
  108. package/dist/dts/api/general/mutations/workflow/useAssignActivityMutation.d.ts +20 -0
  109. package/dist/dts/api/general/mutations/workflow/useFinishActivitiesMutation.d.ts +39 -0
  110. package/dist/dts/api/general/mutations/workflow/useFinishActivityMutation.d.ts +24 -0
  111. package/dist/dts/api/general/mutations/workflow/useRestartActivitiesMutation.d.ts +16 -0
  112. package/dist/dts/api/general/mutations/workflow/useRestartActivityMutation.d.ts +16 -0
  113. package/dist/dts/api/general/mutations/workflow/useStartActivitiesMutation.d.ts +16 -0
  114. package/dist/dts/api/general/mutations/workflow/useStartActivityMutation.d.ts +16 -0
  115. package/dist/dts/api/general/mutations/workflow/useStartWorkflowMutation.d.ts +16 -0
  116. package/dist/dts/api/general/queries/index.d.ts +10 -0
  117. package/dist/dts/api/general/queries/item/index.d.ts +14 -0
  118. package/dist/dts/api/general/queries/item/useItemBlueprintHierarchyQuery.d.ts +20 -0
  119. package/dist/dts/api/general/queries/item/useItemChildrenQuery.d.ts +20 -0
  120. package/dist/dts/api/general/queries/item/useItemClassifiedItemsQuery.d.ts +33 -0
  121. package/dist/dts/api/general/queries/item/useItemDefaultDataQuery.d.ts +26 -0
  122. package/dist/dts/api/general/queries/item/useItemHistoryQuery.d.ts +16 -0
  123. package/dist/dts/api/general/queries/item/useItemPublishUrlsQuery.d.ts +16 -0
  124. package/dist/dts/api/general/queries/item/useItemPublishedPagesQuery.d.ts +16 -0
  125. package/dist/dts/api/general/queries/item/useItemPublishedToQuery.d.ts +16 -0
  126. package/dist/dts/api/general/queries/item/useItemQuery.d.ts +20 -0
  127. package/dist/dts/api/general/queries/item/useItemTranslationInfoQuery.d.ts +16 -0
  128. package/dist/dts/api/general/queries/item/useItemUsedByQuery.d.ts +25 -0
  129. package/dist/dts/api/general/queries/item/useItemUsesQuery.d.ts +21 -0
  130. package/dist/dts/api/general/queries/item/useItemsQuery.d.ts +28 -0
  131. package/dist/dts/api/general/queries/item/usePublicationBlueprintHierarchyQuery.d.ts +20 -0
  132. package/dist/dts/api/general/queries/lists/index.d.ts +6 -0
  133. package/dist/dts/api/general/queries/lists/useContainerItems.d.ts +32 -0
  134. package/dist/dts/api/general/queries/lists/useFavoritesQuery.d.ts +7 -0
  135. package/dist/dts/api/general/queries/lists/useItemsInProgressQuery.d.ts +25 -0
  136. package/dist/dts/api/general/queries/lists/usePublicationsQuery.d.ts +7 -0
  137. package/dist/dts/api/general/queries/lists/useUserGroupsQuery.d.ts +33 -0
  138. package/dist/dts/api/general/queries/lists/useUsersQuery.d.ts +38 -0
  139. package/dist/dts/api/general/queries/loadingState.d.ts +10 -0
  140. package/dist/dts/api/general/queries/publishing/index.d.ts +5 -0
  141. package/dist/dts/api/general/queries/publishing/useItemsToPublishQuery.d.ts +8 -0
  142. package/dist/dts/api/general/queries/publishing/useItemsToUnpublishQuery.d.ts +8 -0
  143. package/dist/dts/api/general/queries/publishing/usePublishTransactionsQuery.d.ts +40 -0
  144. package/dist/dts/api/general/queries/publishing/usePublishableTargetTypesQuery.d.ts +16 -0
  145. package/dist/dts/api/general/queries/publishing/useTargetTypesQuery.d.ts +7 -0
  146. package/dist/dts/api/general/queries/queryOptions.d.ts +67 -0
  147. package/dist/dts/api/general/queries/queryResult.d.ts +93 -0
  148. package/dist/dts/api/general/queries/search/index.d.ts +2 -0
  149. package/dist/dts/api/general/queries/search/useSearchInContainerQuery.d.ts +27 -0
  150. package/dist/dts/api/general/queries/search/useSystemSearchQuery.d.ts +26 -0
  151. package/dist/dts/api/general/queries/translation/index.d.ts +1 -0
  152. package/dist/dts/api/general/queries/translation/useDefaultTranslationJobQuery.d.ts +17 -0
  153. package/dist/dts/api/general/queries/useUserProfileQuery.d.ts +7 -0
  154. package/dist/dts/api/general/queries/workflow/index.d.ts +1 -0
  155. package/dist/dts/api/general/queries/workflow/useActivityInstancesQuery.d.ts +37 -0
  156. package/dist/dts/api/index.d.ts +5 -0
  157. package/dist/dts/api/publishingQueueExplorer/hooks/index.d.ts +2 -0
  158. package/dist/dts/api/publishingQueueExplorer/hooks/usePublishingQueueExplorer.d.ts +62 -0
  159. package/dist/dts/api/publishingQueueExplorer/hooks/usePublishingQueueExplorerTable.d.ts +41 -0
  160. package/dist/dts/api/publishingQueueExplorer/index.d.ts +1 -0
  161. package/dist/dts/apiBridge/activitiesExplorerApiStorage.d.ts +16 -0
  162. package/dist/dts/apiBridge/contentExplorerApiStorage.d.ts +32 -0
  163. package/dist/dts/apiBridge/editors/bundleEditorApiStorage.d.ts +13 -0
  164. package/dist/dts/apiBridge/editors/categoryEditorApiStorage.d.ts +13 -0
  165. package/dist/dts/apiBridge/editors/componentEditorApiStorage.d.ts +13 -0
  166. package/dist/dts/apiBridge/editors/editorsApiStorage.d.ts +28 -0
  167. package/dist/dts/apiBridge/editors/folderEditorApiStorage.d.ts +13 -0
  168. package/dist/dts/apiBridge/editors/index.d.ts +8 -0
  169. package/dist/dts/apiBridge/editors/keywordEditorApiStorage.d.ts +13 -0
  170. package/dist/dts/apiBridge/editors/pageEditorApiStorage.d.ts +13 -0
  171. package/dist/dts/apiBridge/editors/structureGroupEditorApiStorage.d.ts +13 -0
  172. package/dist/dts/apiBridge/extensionApiBridge.d.ts +22 -0
  173. package/dist/dts/apiBridge/generalApiStorage.d.ts +144 -0
  174. package/dist/dts/apiBridge/index.d.ts +6 -0
  175. package/dist/dts/apiBridge/publishingQueueExplorerApiStorage.d.ts +16 -0
  176. package/dist/dts/apiWrappers/activitiesExplorer/hooks.d.ts +39 -0
  177. package/dist/dts/apiWrappers/activitiesExplorer/index.d.ts +1 -0
  178. package/dist/dts/apiWrappers/contentExplorer/components.d.ts +5 -0
  179. package/dist/dts/apiWrappers/contentExplorer/hooks.d.ts +58 -0
  180. package/dist/dts/apiWrappers/contentExplorer/index.d.ts +3 -0
  181. package/dist/dts/apiWrappers/contentExplorer/utils.d.ts +73 -0
  182. package/dist/dts/apiWrappers/editors/hooks.d.ts +63 -0
  183. package/dist/dts/apiWrappers/editors/index.d.ts +1 -0
  184. package/dist/dts/apiWrappers/general/components.d.ts +88 -0
  185. package/dist/dts/apiWrappers/general/globals.d.ts +37 -0
  186. package/dist/dts/apiWrappers/general/hooks.d.ts +25 -0
  187. package/dist/dts/apiWrappers/general/index.d.ts +5 -0
  188. package/dist/dts/apiWrappers/general/mutations/generalMutations.d.ts +30 -0
  189. package/dist/dts/apiWrappers/general/mutations/index.d.ts +4 -0
  190. package/dist/dts/apiWrappers/general/mutations/itemMutations.d.ts +137 -0
  191. package/dist/dts/apiWrappers/general/mutations/translationMutations.d.ts +5 -0
  192. package/dist/dts/apiWrappers/general/mutations/workflowMutations.d.ts +47 -0
  193. package/dist/dts/apiWrappers/general/queries/generalQueries.d.ts +7 -0
  194. package/dist/dts/apiWrappers/general/queries/index.d.ts +7 -0
  195. package/dist/dts/apiWrappers/general/queries/itemQueries.d.ts +85 -0
  196. package/dist/dts/apiWrappers/general/queries/listsQueries.d.ts +25 -0
  197. package/dist/dts/apiWrappers/general/queries/publishingQueries.d.ts +19 -0
  198. package/dist/dts/apiWrappers/general/queries/searchQueries.d.ts +13 -0
  199. package/dist/dts/apiWrappers/general/queries/translationQueries.d.ts +5 -0
  200. package/dist/dts/apiWrappers/general/queries/workflowQueries.d.ts +5 -0
  201. package/dist/dts/apiWrappers/index.d.ts +5 -0
  202. package/dist/dts/apiWrappers/publishingQueueExplorer/hooks.d.ts +39 -0
  203. package/dist/dts/apiWrappers/publishingQueueExplorer/index.d.ts +1 -0
  204. package/dist/dts/extensionPoints/actionsConfiguration/actionExtension.d.ts +43 -0
  205. package/dist/dts/extensionPoints/actionsConfiguration/actionGroup.d.ts +20 -0
  206. package/dist/dts/extensionPoints/actionsConfiguration/actionsConfigurationExtension.d.ts +10 -0
  207. package/dist/dts/extensionPoints/actionsConfiguration/actionsConfigurationExtensionsBuilder.d.ts +70 -0
  208. package/dist/dts/extensionPoints/actionsConfiguration/index.d.ts +4 -0
  209. package/dist/dts/extensionPoints/activitiesExplorer/activitiesExplorerActions.d.ts +40 -0
  210. package/dist/dts/extensionPoints/activitiesExplorer/activitiesExplorerExtensions.d.ts +11 -0
  211. package/dist/dts/extensionPoints/activitiesExplorer/activitiesExplorerExtensionsBuilder.d.ts +25 -0
  212. package/dist/dts/extensionPoints/activitiesExplorer/index.d.ts +5 -0
  213. package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/activitiesExplorerInsightsPanelsExtension.d.ts +18 -0
  214. package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/activitiesExplorerInsightsPanelsExtensions.d.ts +9 -0
  215. package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/activitiesExplorerInsightsPanelsExtensionsBuilder.d.ts +24 -0
  216. package/dist/dts/extensionPoints/activitiesExplorer/insightsPanels/index.d.ts +3 -0
  217. package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableActions.d.ts +41 -0
  218. package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableColumnExtension.d.ts +20 -0
  219. package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableExtensions.d.ts +10 -0
  220. package/dist/dts/extensionPoints/activitiesExplorer/table/activitiesExplorerTableExtensionsBuilder.d.ts +26 -0
  221. package/dist/dts/extensionPoints/activitiesExplorer/table/index.d.ts +3 -0
  222. package/dist/dts/extensionPoints/contentEditor/contentEditorExtensions.d.ts +11 -0
  223. package/dist/dts/extensionPoints/contentEditor/contentEditorExtensionsBuilder.d.ts +15 -0
  224. package/dist/dts/extensionPoints/contentEditor/contentEditorFormFieldExtension.d.ts +85 -0
  225. package/dist/dts/extensionPoints/contentEditor/contentEditorViewExtension.d.ts +69 -0
  226. package/dist/dts/extensionPoints/contentEditor/index.d.ts +5 -0
  227. package/dist/dts/extensionPoints/contentEditor/richTextField/index.d.ts +2 -0
  228. package/dist/dts/extensionPoints/contentEditor/richTextField/richTextFieldExtensions.d.ts +64 -0
  229. package/dist/dts/extensionPoints/contentEditor/richTextField/richTextFieldExtensionsBuilder.d.ts +11 -0
  230. package/dist/dts/extensionPoints/contentExplorer/contentExplorerActions.d.ts +86 -0
  231. package/dist/dts/extensionPoints/contentExplorer/contentExplorerExtensions.d.ts +13 -0
  232. package/dist/dts/extensionPoints/contentExplorer/contentExplorerExtensionsBuilder.d.ts +30 -0
  233. package/dist/dts/extensionPoints/contentExplorer/index.d.ts +6 -0
  234. package/dist/dts/extensionPoints/contentExplorer/insightsPanels/contentExplorerInsightsPanelsExtension.d.ts +18 -0
  235. package/dist/dts/extensionPoints/contentExplorer/insightsPanels/contentExplorerInsightsPanelsExtensions.d.ts +9 -0
  236. package/dist/dts/extensionPoints/contentExplorer/insightsPanels/contentExplorerInsightsPanelsExtensionsBuilder.d.ts +24 -0
  237. package/dist/dts/extensionPoints/contentExplorer/insightsPanels/index.d.ts +3 -0
  238. package/dist/dts/extensionPoints/contentExplorer/table/contentExplorerTableColumnExtension.d.ts +20 -0
  239. package/dist/dts/extensionPoints/contentExplorer/table/contentExplorerTableExtensions.d.ts +10 -0
  240. package/dist/dts/extensionPoints/contentExplorer/table/contentExplorerTableExtensionsBuilder.d.ts +26 -0
  241. package/dist/dts/extensionPoints/contentExplorer/table/index.d.ts +3 -0
  242. package/dist/dts/extensionPoints/contentExplorer/tree/contentExplorerTreeExtensions.d.ts +7 -0
  243. package/dist/dts/extensionPoints/contentExplorer/tree/contentExplorerTreeExtensionsBuilder.d.ts +13 -0
  244. package/dist/dts/extensionPoints/contentExplorer/tree/index.d.ts +2 -0
  245. package/dist/dts/extensionPoints/extensionBuilder.d.ts +37 -0
  246. package/dist/dts/extensionPoints/extensionPoints.d.ts +17 -0
  247. package/dist/dts/extensionPoints/header/headerExtensions.d.ts +7 -0
  248. package/dist/dts/extensionPoints/header/headerExtensionsBuilder.d.ts +12 -0
  249. package/dist/dts/extensionPoints/header/index.d.ts +3 -0
  250. package/dist/dts/extensionPoints/header/navigation/index.d.ts +4 -0
  251. package/dist/dts/extensionPoints/header/navigation/navigationExtensions.d.ts +9 -0
  252. package/dist/dts/extensionPoints/header/navigation/navigationExtensionsBuilder.d.ts +24 -0
  253. package/dist/dts/extensionPoints/header/navigation/navigationItem.d.ts +65 -0
  254. package/dist/dts/extensionPoints/header/navigation/navigationItems.d.ts +20 -0
  255. package/dist/dts/extensionPoints/index.d.ts +12 -0
  256. package/dist/dts/extensionPoints/insightsPanels/index.d.ts +1 -0
  257. package/dist/dts/extensionPoints/insightsPanels/insightsPanelsExtension.d.ts +39 -0
  258. package/dist/dts/extensionPoints/listBuilder/index.d.ts +3 -0
  259. package/dist/dts/extensionPoints/listBuilder/listBuilder.d.ts +12 -0
  260. package/dist/dts/extensionPoints/listBuilder/listBuilderExtension.d.ts +12 -0
  261. package/dist/dts/extensionPoints/listBuilder/utils/addItem.d.ts +14 -0
  262. package/dist/dts/extensionPoints/listBuilder/utils/findItemIndex.d.ts +13 -0
  263. package/dist/dts/extensionPoints/listBuilder/utils/index.d.ts +5 -0
  264. package/dist/dts/extensionPoints/listBuilder/utils/moveItem.d.ts +14 -0
  265. package/dist/dts/extensionPoints/listBuilder/utils/removeItem.d.ts +13 -0
  266. package/dist/dts/extensionPoints/listBuilder/utils/replaceItem.d.ts +14 -0
  267. package/dist/dts/extensionPoints/publishingQueueExplorer/index.d.ts +5 -0
  268. package/dist/dts/extensionPoints/publishingQueueExplorer/insightsPanels/index.d.ts +3 -0
  269. package/dist/dts/extensionPoints/publishingQueueExplorer/insightsPanels/publishingQueueExplorerInsightsPanelsExtension.d.ts +18 -0
  270. package/dist/dts/extensionPoints/publishingQueueExplorer/insightsPanels/publishingQueueExplorerInsightsPanelsExtensions.d.ts +9 -0
  271. package/dist/dts/extensionPoints/publishingQueueExplorer/insightsPanels/publishingQueueExplorerInsightsPanelsExtensionsBuilder.d.ts +24 -0
  272. package/dist/dts/extensionPoints/publishingQueueExplorer/publishingQueueExplorerActions.d.ts +39 -0
  273. package/dist/dts/extensionPoints/publishingQueueExplorer/publishingQueueExplorerExtensions.d.ts +11 -0
  274. package/dist/dts/extensionPoints/publishingQueueExplorer/publishingQueueExplorerExtensionsBuilder.d.ts +25 -0
  275. package/dist/dts/extensionPoints/publishingQueueExplorer/table/index.d.ts +3 -0
  276. package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableActions.d.ts +39 -0
  277. package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableColumnExtension.d.ts +20 -0
  278. package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableExtensions.d.ts +10 -0
  279. package/dist/dts/extensionPoints/publishingQueueExplorer/table/publishingQueueExplorerTableExtensionsBuilder.d.ts +26 -0
  280. package/dist/dts/extensionPoints/tableColumnConfiguration/index.d.ts +1 -0
  281. package/dist/dts/extensionPoints/tableColumnConfiguration/tableColumnExtension.d.ts +70 -0
  282. package/dist/dts/extensionPoints/translations/index.d.ts +3 -0
  283. package/dist/dts/extensionPoints/translations/translationExtensions.d.ts +7 -0
  284. package/dist/dts/extensionPoints/translations/translationExtensionsBuilder.d.ts +17 -0
  285. package/dist/dts/extensionPoints/translations/translationItem.d.ts +23 -0
  286. package/dist/dts/frameworkInfo.d.ts +7 -0
  287. package/dist/dts/index.d.ts +6 -0
  288. package/dist/dts/module/createExtensionGlobals.d.ts +11 -0
  289. package/dist/dts/module/extensionGlobals.d.ts +7 -0
  290. package/dist/dts/module/extensionModule.d.ts +11 -0
  291. package/dist/dts/module/index.d.ts +4 -0
  292. package/dist/dts/module/runtimeInformation.d.ts +7 -0
  293. package/dist/index.d.ts +529 -97
  294. package/dist/index.js +151 -27
  295. package/package.json +5 -5
@@ -0,0 +1,25 @@
1
+ import type { ApiError, ItemUri, VersionedItem } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export interface ItemsInProgressQueryProps {
8
+ /**
9
+ * Option to include items that are in progress by any user, but only in Publications where the user has Publication Administration or Lock Management Rights (unless the user has System Administration privileges).
10
+ * By default, only items locked by the current user are returned.
11
+ */
12
+ forAllUsers?: boolean;
13
+ /**
14
+ * Specifies the maximum number of results to return.
15
+ */
16
+ maxResults?: number;
17
+ /**
18
+ * Option to filter results by specified user id.
19
+ */
20
+ lockUserId?: ItemUri;
21
+ }
22
+ /**
23
+ * @public
24
+ */
25
+ export type ItemsInProgressQueryHook = (props?: ItemsInProgressQueryProps, options?: QueryOptions<ReadonlyArray<VersionedItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<VersionedItem> | undefined, ApiError>;
@@ -0,0 +1,7 @@
1
+ import type { ApiError, Publication } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export type PublicationsQueryHook = (options?: QueryOptions<ReadonlyArray<Publication> | undefined, ApiError>) => QueryResult<ReadonlyArray<Publication> | undefined, ApiError>;
@@ -0,0 +1,33 @@
1
+ import type { ApiError, ItemUri, StringSearchMode, UserGroup } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export type UserGroupsQuerySearchMode = StringSearchMode;
8
+ /**
9
+ * @public
10
+ */
11
+ export interface UserGroupsQueryProps {
12
+ /**
13
+ * If specified, return only groups which are scoped to the Publication ID.
14
+ */
15
+ inPublicationId?: ItemUri;
16
+ /**
17
+ * Specifies whether the special "Everyone" Group (representing all CM users) should be returned.
18
+ */
19
+ includeEveryone?: boolean;
20
+ /**
21
+ * If specified, return only groups with titles matching this value.
22
+ */
23
+ search?: string;
24
+ /**
25
+ * Specifies how to match on the group title.
26
+ * @defaultValue Contains
27
+ */
28
+ searchMode?: UserGroupsQuerySearchMode;
29
+ }
30
+ /**
31
+ * @public
32
+ */
33
+ export type UserGroupsQueryHook = (props?: UserGroupsQueryProps, options?: QueryOptions<ReadonlyArray<UserGroup> | undefined, ApiError>) => QueryResult<ReadonlyArray<UserGroup> | undefined, ApiError>;
@@ -0,0 +1,38 @@
1
+ import type { ApiError, StringSearchMode, User } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export type UsersQuerySearchMode = StringSearchMode;
8
+ /**
9
+ * @public
10
+ */
11
+ export interface UsersQueryProps {
12
+ /**
13
+ * If specified, return only non-predefined users or predefined users.
14
+ *
15
+ * @example
16
+ * - `undefined` - all of the users returned
17
+ * - `true` - predefined only users returned
18
+ * - `false` - non-predefined only users returned
19
+ */
20
+ predefined?: boolean;
21
+ /**
22
+ * Specifies whether to include disabled user accounts. These are excluded by default.
23
+ */
24
+ includeDisabled?: boolean;
25
+ /**
26
+ * If specified, return only users whose account name (Title) matches this value.
27
+ */
28
+ search?: string;
29
+ /**
30
+ * Specifies how to match on the account name.
31
+ * @defaultValue Contains
32
+ */
33
+ searchMode?: UsersQuerySearchMode;
34
+ }
35
+ /**
36
+ * @public
37
+ */
38
+ export type UsersQueryHook = (props?: UsersQueryProps, options?: QueryOptions<ReadonlyArray<User> | undefined, ApiError>) => QueryResult<ReadonlyArray<User> | undefined, ApiError>;
@@ -0,0 +1,10 @@
1
+ /**
2
+ * @public
3
+ */
4
+ export interface LoadingState {
5
+ isFirstTimeLoading: boolean;
6
+ isLoading: boolean;
7
+ isReloading: boolean;
8
+ isLoaded: boolean;
9
+ isError: boolean;
10
+ }
@@ -0,0 +1,5 @@
1
+ export * from './useItemsToPublishQuery';
2
+ export * from './useItemsToUnpublishQuery';
3
+ export * from './usePublishableTargetTypesQuery';
4
+ export * from './usePublishTransactionsQuery';
5
+ export * from './useTargetTypesQuery';
@@ -0,0 +1,8 @@
1
+ import type { ApiError, ResolvedItem } from '@tridion-sites/models';
2
+ import type { PublishItemsRequest } from '../../mutations/item/usePublishItemsMutation';
3
+ import type { QueryOptions } from '../queryOptions';
4
+ import type { QueryResult } from '../queryResult';
5
+ /**
6
+ * @public
7
+ */
8
+ export type ItemsToPublishQueryHook = (props: PublishItemsRequest | undefined, options?: QueryOptions<ResolvedItem[] | undefined, ApiError>) => QueryResult<ResolvedItem[] | undefined, ApiError>;
@@ -0,0 +1,8 @@
1
+ import type { ApiError, ResolvedItem } from '@tridion-sites/models';
2
+ import type { UnpublishItemsRequest } from '../../mutations/item/useUnpublishItemsMutation';
3
+ import type { QueryOptions } from '../queryOptions';
4
+ import type { QueryResult } from '../queryResult';
5
+ /**
6
+ * @public
7
+ */
8
+ export type ItemsToUnpublishQueryHook = (props: UnpublishItemsRequest | undefined, options?: QueryOptions<ResolvedItem[] | undefined, ApiError>) => QueryResult<ResolvedItem[] | undefined, ApiError>;
@@ -0,0 +1,40 @@
1
+ import type { ApiError, ListInfoDictionary, PublishPriority, PublishTransaction, PublishTransactionState, TcmUri } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export interface PublishTransactionsQueryProps {
8
+ /**
9
+ * Option to filter transactions for specific publication.
10
+ */
11
+ publicationId?: TcmUri;
12
+ /**
13
+ * Option to filter transactions for specific Target Type.
14
+ */
15
+ targetTypeId?: TcmUri;
16
+ /**
17
+ * Option to filter transaction created by specific User.
18
+ */
19
+ userId?: TcmUri;
20
+ /**
21
+ * Option to filter transactions prior to specified date.
22
+ */
23
+ endDate?: Date;
24
+ /**
25
+ * Option to filter transactions following specified date.
26
+ */
27
+ startDate?: Date;
28
+ /**
29
+ * Option to filter transactions based ot it's state.
30
+ */
31
+ state?: PublishTransactionState;
32
+ /**
33
+ * Option to filter transactions with specific priority.
34
+ */
35
+ priority?: PublishPriority;
36
+ }
37
+ /**
38
+ * @public
39
+ */
40
+ export type PublishTransactionsQueryHook = <TListInfo extends ListInfoDictionary>(props: PublishTransactionsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishTransaction<TListInfo>> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishTransaction<TListInfo>> | undefined, ApiError>;
@@ -0,0 +1,16 @@
1
+ import type { ApiError, ItemUri, TargetType } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export interface PublishableTargetTypesQueryProps {
8
+ /**
9
+ * Identifies the Business Process Type for which Target Types are being retrieved.
10
+ */
11
+ businessProcessTypeId: ItemUri;
12
+ }
13
+ /**
14
+ * @public
15
+ */
16
+ export type PublishableTargetTypesQueryHook = (props: PublishableTargetTypesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TargetType> | undefined, ApiError>) => QueryResult<ReadonlyArray<TargetType> | undefined, ApiError>;
@@ -0,0 +1,7 @@
1
+ import type { ApiError, TargetType } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export type TargetTypesQueryHook = (options?: QueryOptions<ReadonlyArray<TargetType> | undefined, ApiError>) => QueryResult<ReadonlyArray<TargetType> | undefined, ApiError>;
@@ -0,0 +1,67 @@
1
+ /**
2
+ * @public
3
+ */
4
+ export type NonFunctionGuard<T> = T extends Function ? never : T;
5
+ /**
6
+ * @public
7
+ */
8
+ export interface QueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData> {
9
+ retry?: boolean | number | ((failureCount: number, error: TError) => boolean);
10
+ retryDelay?: number | ((failureCount: number, error: TError) => number);
11
+ initialData?: TData | (() => TData | undefined);
12
+ initialDataUpdatedAt?: number | (() => number | undefined);
13
+ meta?: Record<string, unknown>;
14
+ /**
15
+ * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
16
+ * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
17
+ * Defaults to `true`.
18
+ */
19
+ enabled?: boolean;
20
+ /**
21
+ * The time in milliseconds after data is considered stale.
22
+ * If set to `Infinity`, the data will never be considered stale.
23
+ */
24
+ staleTime?: number;
25
+ /**
26
+ * If set to a number, the query will continuously refetch at this frequency in milliseconds.
27
+ * If set to a function, the function will be executed with the latest data and query to compute a frequency.
28
+ * Defaults to `false`.
29
+ */
30
+ refetchInterval?: number | false;
31
+ /**
32
+ * If set to `true`, the query will continue to refetch while their tab/window is in the background.
33
+ * Defaults to `false`.
34
+ */
35
+ refetchIntervalInBackground?: boolean;
36
+ /**
37
+ * If set to `true`, the query will refetch on window focus if the data is stale.
38
+ * If set to `false`, the query will not refetch on window focus.
39
+ * If set to `'always'`, the query will always refetch on window focus.
40
+ * Defaults to `true`.
41
+ */
42
+ refetchOnWindowFocus?: boolean | 'always';
43
+ /**
44
+ * If set to `true`, the query will refetch on reconnect if the data is stale.
45
+ * If set to `false`, the query will not refetch on reconnect.
46
+ * If set to `'always'`, the query will always refetch on reconnect.
47
+ * If set to a function, the function will be executed with the latest data and query to compute the value.
48
+ * Defaults to the value of `networkOnline` (`true`)
49
+ */
50
+ refetchOnReconnect?: boolean | 'always';
51
+ /**
52
+ * If set to `true`, the query will refetch on mount if the data is stale.
53
+ * If set to `false`, will disable additional instances of a query to trigger background refetches.
54
+ * If set to `'always'`, the query will always refetch on mount.
55
+ * Defaults to `true`.
56
+ */
57
+ refetchOnMount?: boolean | 'always';
58
+ /**
59
+ * If set to `false`, the query will not be retried on mount if it contains an error.
60
+ * Defaults to `true`.
61
+ */
62
+ retryOnMount?: boolean;
63
+ /**
64
+ * If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
65
+ */
66
+ placeholderData?: NonFunctionGuard<TQueryFnData> | ((previousData: TData | undefined) => NonFunctionGuard<TQueryFnData> | undefined);
67
+ }
@@ -0,0 +1,93 @@
1
+ /**
2
+ * @public
3
+ */
4
+ export type QueryStatus = 'pending' | 'error' | 'success';
5
+ /**
6
+ * @public
7
+ */
8
+ export type QueryFetchStatus = 'fetching' | 'paused' | 'idle';
9
+ /**
10
+ * @public
11
+ */
12
+ export interface RefetchOptions {
13
+ cancelRefetch?: boolean;
14
+ throwOnError?: boolean;
15
+ }
16
+ /**
17
+ * @public
18
+ */
19
+ export interface QueryResult<TData = unknown, TError = unknown> {
20
+ /**
21
+ * The last successfully resolved data for the query.
22
+ */
23
+ data: TData | undefined;
24
+ /**
25
+ * The timestamp for when the query most recently returned the `status` as `success`.
26
+ */
27
+ dataUpdatedAt: number;
28
+ /**
29
+ * The error object for the query, if an error was thrown.
30
+ */
31
+ error: TError | null;
32
+ /**
33
+ * The timestamp for when the query most recently returned the `status` as `error`.
34
+ */
35
+ errorUpdatedAt: number;
36
+ failureCount: number;
37
+ /**
38
+ * The failure reason for the query retry.
39
+ * Reset to null when the query succeeds.
40
+ */
41
+ failureReason: TError | null;
42
+ /**
43
+ * The sum of all errors.
44
+ */
45
+ errorUpdateCount: number;
46
+ isError: boolean;
47
+ /**
48
+ * Will be true if the query has been fetched.
49
+ */
50
+ isFetched: boolean;
51
+ /**
52
+ * Will be true if the query has been fetched after the component mounted.
53
+ * This property can be used to not show any previously cached data.
54
+ */
55
+ isFetchedAfterMount: boolean;
56
+ isFetching: boolean;
57
+ isPending: boolean;
58
+ isLoading: boolean;
59
+ isLoadingError: boolean;
60
+ isPaused: boolean;
61
+ /**
62
+ * Will be `true` if the data shown is the placeholder data.
63
+ */
64
+ isPlaceholderData: boolean;
65
+ /**
66
+ * Will be `true` if the query failed while fetching for the first time.
67
+ */
68
+ isRefetchError: boolean;
69
+ /**
70
+ * Is `true` whenever a background refetch is in-flight, which does not include initial loading.
71
+ */
72
+ isRefetching: boolean;
73
+ /**
74
+ * Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
75
+ */
76
+ isStale: boolean;
77
+ isSuccess: boolean;
78
+ refetch: (options?: RefetchOptions) => Promise<QueryResult<TData, TError>>;
79
+ /**
80
+ * - `loading` - if there's no cached data and no query attempt was finished yet.
81
+ * - `error` - if the query attempt resulted in an error. The corresponding error property has the error received from the attempted fetch.
82
+ * - `success` - if the query has received a response with no errors and is ready to display its data.
83
+ * The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false`
84
+ * and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.
85
+ */
86
+ status: QueryStatus;
87
+ /**
88
+ * - `fetching` - Is true whenever the queryFn is executing, which includes initial loading as well as background refetches.
89
+ * - `paused` - The query wanted to fetch, but has been paused.
90
+ * - `idle` - The query is not fetching.
91
+ */
92
+ fetchStatus: QueryFetchStatus;
93
+ }
@@ -0,0 +1,2 @@
1
+ export * from './useSearchInContainerQuery';
2
+ export * from './useSystemSearchQuery';
@@ -0,0 +1,27 @@
1
+ import type { ApiError, IdentifiableObject, ItemUri, RloItemType } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export interface SearchInContainerQueryProps {
8
+ /**
9
+ * URI of the container to search in.
10
+ */
11
+ containerId: ItemUri;
12
+ /**
13
+ * Input for the full-text query.
14
+ * The following characters have special meaning in the query syntax: + - &amp;&amp; || ! ( ) \{ \} [ ] ^ " ~ * ? : \\\\
15
+ * To use any of these characters without their syntactical meaning, to escape them by preceding the character with a \\\\.
16
+ */
17
+ fullTextQuery: string;
18
+ itemTypes?: ReadonlyArray<RloItemType>;
19
+ /**
20
+ * The maximum number of search results.
21
+ */
22
+ resultLimit?: number;
23
+ }
24
+ /**
25
+ * @public
26
+ */
27
+ export type SearchInContainerQueryHook = (props: SearchInContainerQueryProps | undefined, options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;
@@ -0,0 +1,26 @@
1
+ import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export interface SystemSearchQueryProps {
8
+ /**
9
+ * Input for the full-text query.
10
+ * The following characters have special meaning in the query syntax: + - &amp;&amp; || ! ( ) \{ \} [ ] ^ " ~ * ? : \\\\
11
+ * To use any of these characters without their syntactical meaning, to escape them by preceding the character with a \\\\.
12
+ */
13
+ fullTextQuery?: string;
14
+ /**
15
+ * The maximum number of search results.
16
+ */
17
+ resultLimit?: number;
18
+ /**
19
+ * Limits the search results to only items that are classified with the specified keyword IDs.
20
+ */
21
+ usedKeywordsIds?: ReadonlyArray<ItemUri>;
22
+ }
23
+ /**
24
+ * @public
25
+ */
26
+ export type SystemSearchQueryHook = (props?: SystemSearchQueryProps, options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;
@@ -0,0 +1 @@
1
+ export * from './useDefaultTranslationJobQuery';
@@ -0,0 +1,17 @@
1
+ import type { ApiError, ItemUri, TranslationJob, TranslationJobType } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export interface DefaultTranslationJobQueryProps {
8
+ /**
9
+ * IDs to get default Translation Job for.
10
+ */
11
+ itemIds: ReadonlyArray<ItemUri>;
12
+ type: TranslationJobType;
13
+ }
14
+ /**
15
+ * @public
16
+ */
17
+ export type DefaultTranslationJobQueryHook = (props: DefaultTranslationJobQueryProps | undefined, options?: QueryOptions<TranslationJob | undefined, ApiError>) => QueryResult<TranslationJob | undefined, ApiError>;
@@ -0,0 +1,7 @@
1
+ import type { ApiError, UserProfile } from '@tridion-sites/models';
2
+ import type { QueryOptions } from './queryOptions';
3
+ import type { QueryResult } from './queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export type UserProfileQueryHook = (options?: QueryOptions<UserProfile | undefined, ApiError>) => QueryResult<UserProfile | undefined, ApiError>;
@@ -0,0 +1 @@
1
+ export * from './useActivityInstancesQuery';
@@ -0,0 +1,37 @@
1
+ import type { ActivityInstance, ActivityState, ApiError, ItemUri } from '@tridion-sites/models';
2
+ import type { QueryOptions } from '../queryOptions';
3
+ import type { QueryResult } from '../queryResult';
4
+ /**
5
+ * @public
6
+ */
7
+ export interface ActivityInstancesQueryProps {
8
+ /**
9
+ * When set to `false`, the results will be filtered on Assignee or Owner depending on the activity instance state:
10
+ * - Activity Instances in Assigned State are returned if they are assigned to the Current User or any groups of the Current User.
11
+ * - Activity Instances in other Activity States are returned if they are owned by the Current User
12
+ *
13
+ * When set to `true`, the results are filtered by security instead.
14
+ * Only the Activity Instances on which the current user has Workflow Management rights (or system administration privileges) are returned.
15
+ */
16
+ forAllUsers?: boolean;
17
+ /**
18
+ * If specified, only Activity Instances which have one of the given Activity States will be returned.
19
+ */
20
+ activityStates?: ReadonlyArray<ActivityState>;
21
+ /**
22
+ * If specified, only Activity Instances based on the given Process Definition will be returned.
23
+ */
24
+ processDefinitionId?: ItemUri;
25
+ /**
26
+ * If specified, inly Activity Instances created by given User will be returned.
27
+ */
28
+ ownerId?: ItemUri;
29
+ /**
30
+ * If specified, inly Activity Instances assigned to a given User will be returned.
31
+ */
32
+ assigneeId?: ItemUri;
33
+ }
34
+ /**
35
+ * @public
36
+ */
37
+ export type ActivityInstancesQueryHook = (props?: ActivityInstancesQueryProps, options?: QueryOptions<ReadonlyArray<ActivityInstance> | undefined, ApiError>) => QueryResult<ReadonlyArray<ActivityInstance> | undefined, ApiError>;
@@ -0,0 +1,5 @@
1
+ export * from './activitiesExplorer';
2
+ export * from './contentExplorer';
3
+ export * from './publishingQueueExplorer';
4
+ export * from './editors';
5
+ export * from './general';
@@ -0,0 +1,2 @@
1
+ export * from './usePublishingQueueExplorer';
2
+ export * from './usePublishingQueueExplorerTable';
@@ -0,0 +1,62 @@
1
+ import type { LoadingState } from "../..";
2
+ import type { ValuesOfArray } from '@tridion/graphene';
3
+ import type { PublishTransaction } from '@tridion-sites/models';
4
+ /**
5
+ * List of all built-in panel IDs of the Publishing Queue Explorer.
6
+ *
7
+ * @public
8
+ */
9
+ export declare const publishingQueueExplorerPanelIds: readonly ["information", "resolvedItems"];
10
+ /**
11
+ * Type represents ID of a built-in panel of the Publishing Queue Explorer.
12
+ *
13
+ * @public
14
+ */
15
+ export type PublishingQueueExplorerPanelId = ValuesOfArray<typeof publishingQueueExplorerPanelIds>;
16
+ /**
17
+ * All available built-in Publishing Queue Explorer panel IDs.
18
+ *
19
+ * @public
20
+ */
21
+ export declare const publishingQueueExplorerPanelId: {
22
+ information: "information";
23
+ resolvedItems: "resolvedItems";
24
+ };
25
+ /**
26
+ * Data of the PublishingQueue Explorer.
27
+ *
28
+ * @public
29
+ */
30
+ export interface PublishingQueueExplorerHookResult {
31
+ /**
32
+ * List of Publish Transactions.
33
+ */
34
+ items: ReadonlyArray<PublishTransaction>;
35
+ /**
36
+ * The loading state of the Publish Transactions list.
37
+ */
38
+ itemsLoadingState: LoadingState;
39
+ /**
40
+ * Currently active PublishTransaction.
41
+ */
42
+ currentItem: PublishTransaction | undefined;
43
+ }
44
+ /**
45
+ * Hook for accessing PublishingQueue Explorer data.
46
+ *
47
+ * @remarks
48
+ * Should be used only inside PublishingQueue Explorer, otherwise throws an error.
49
+ *
50
+ * @public
51
+ */
52
+ export type PublishingQueueExplorerHook = () => PublishingQueueExplorerHookResult;
53
+ /**
54
+ * Hook for accessing PublishingQueue Explorer data when available.
55
+ *
56
+ * @remarks
57
+ * Safe to be used within or outside of the PublishingQueue Explorer.
58
+ * `undefined` is returned when used outside of PublishingQueue Explorer.
59
+ *
60
+ * @public
61
+ */
62
+ export type OptionalPublishingQueueExplorerHook = () => PublishingQueueExplorerHookResult | undefined;
@@ -0,0 +1,41 @@
1
+ import type { ItemUri, PublishTransaction, PublishTransactionListInfo } from '@tridion-sites/models';
2
+ /**
3
+ * @public
4
+ */
5
+ export interface PublishingQueueExplorerTableSelection {
6
+ ids: ReadonlySet<ItemUri>;
7
+ selectedItems: ReadonlyArray<PublishTransaction<PublishTransactionListInfo>>;
8
+ }
9
+ /**
10
+ * Methods of the PublishingQueue Explorer Table.
11
+ * @public
12
+ */
13
+ export interface PublishingQueueExplorerTableHookResult {
14
+ /**
15
+ * Refetch list of Publish Transactions.
16
+ */
17
+ refresh: () => void;
18
+ /**
19
+ * Current state of selected Publish Transactions in the Table.
20
+ */
21
+ selection: PublishingQueueExplorerTableSelection;
22
+ }
23
+ /**
24
+ * Hook for accessing PublishingQueue Explorer Table data and methods.
25
+ *
26
+ * @remarks
27
+ * Should be used only inside PublishingQueue Explorer Table, otherwise throws an error.
28
+ *
29
+ * @public
30
+ */
31
+ export type PublishingQueueExplorerTableHook = () => PublishingQueueExplorerTableHookResult;
32
+ /**
33
+ * Hook for accessing PublishingQueue Explorer Table data and methods when available.
34
+ *
35
+ * @remarks
36
+ * Safe to be used within or outside of the PublishingQueue Explorer Table.
37
+ * `undefined` is returned when used outside of the PublishingQueue Explorer Table.
38
+ *
39
+ * @public
40
+ */
41
+ export type OptionalPublishingQueueExplorerTableHook = () => PublishingQueueExplorerTableHookResult | undefined;
@@ -0,0 +1 @@
1
+ export * from './hooks';
@@ -0,0 +1,16 @@
1
+ import type { ActivitiesExplorerHook, ActivitiesExplorerTableHook, OptionalActivitiesExplorerHook, OptionalActivitiesExplorerTableHook } from "../api";
2
+ /**
3
+ * @internal
4
+ */
5
+ export interface ActivitiesExplorerHooksApiStorage {
6
+ useActivitiesExplorer: ActivitiesExplorerHook;
7
+ useActivitiesExplorerTable: ActivitiesExplorerTableHook;
8
+ useOptionalActivitiesExplorer: OptionalActivitiesExplorerHook;
9
+ useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;
10
+ }
11
+ /**
12
+ * @internal
13
+ */
14
+ export interface ActivitiesExplorerApiStorage {
15
+ hooks: ActivitiesExplorerHooksApiStorage;
16
+ }