@onecx/integration-interface 8.0.0-rc.1 → 8.0.0-rc.11

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 (152) hide show
  1. package/README.md +12 -7
  2. package/dist/index.cjs +1359 -0
  3. package/dist/index.mjs +1328 -0
  4. package/package.json +20 -15
  5. package/src/index.d.ts +17 -0
  6. package/src/index.js +61 -47
  7. package/src/index.js.map +1 -1
  8. package/src/lib/declarations.d.ts +5 -0
  9. package/src/lib/declarations.js +2 -0
  10. package/src/lib/declarations.js.map +1 -0
  11. package/src/lib/models/shell-capability.model.d.ts +11 -0
  12. package/src/lib/models/shell-capability.model.js +8 -0
  13. package/src/lib/models/shell-capability.model.js.map +1 -0
  14. package/src/lib/services/dynamic-translation.service.d.ts +87 -0
  15. package/src/lib/services/dynamic-translation.service.js +275 -0
  16. package/src/lib/services/dynamic-translation.service.js.map +1 -0
  17. package/src/lib/services/icon.service.d.ts +15 -0
  18. package/src/lib/services/icon.service.js +50 -0
  19. package/src/lib/services/icon.service.js.map +1 -0
  20. package/src/lib/services/image-repository.service.js +5 -9
  21. package/src/lib/services/image-repository.service.js.map +1 -1
  22. package/src/lib/services/notification.service.d.ts +7 -0
  23. package/src/lib/services/notification.service.js +15 -0
  24. package/src/lib/services/notification.service.js.map +1 -0
  25. package/src/lib/topics/configuration/v1/configuration.topic.js +2 -6
  26. package/src/lib/topics/configuration/v1/configuration.topic.js.map +1 -1
  27. package/src/lib/topics/current-location/v1/current-location.model.js +0 -2
  28. package/src/lib/topics/current-location/v1/current-location.topic.d.ts +1 -4
  29. package/src/lib/topics/current-location/v1/current-location.topic.js +2 -12
  30. package/src/lib/topics/current-location/v1/current-location.topic.js.map +1 -1
  31. package/src/lib/topics/current-mfe/v1/current-mfe.topic.js +2 -6
  32. package/src/lib/topics/current-mfe/v1/current-mfe.topic.js.map +1 -1
  33. package/src/lib/topics/current-mfe/v1/mfe-info.model.js +0 -2
  34. package/src/lib/topics/current-page/v1/current-page.topic.js +9 -11
  35. package/src/lib/topics/current-page/v1/current-page.topic.js.map +1 -1
  36. package/src/lib/topics/current-page/v1/page-info.model.js +0 -2
  37. package/src/lib/topics/current-theme/v1/current-theme.topic.js +2 -6
  38. package/src/lib/topics/current-theme/v1/current-theme.topic.js.map +1 -1
  39. package/src/lib/topics/current-theme/v1/theme-override.model.d.ts +8 -0
  40. package/src/lib/topics/current-theme/v1/theme-override.model.js +6 -0
  41. package/src/lib/topics/current-theme/v1/theme-override.model.js.map +1 -0
  42. package/src/lib/topics/current-theme/v1/theme.model.d.ts +2 -0
  43. package/src/lib/topics/current-theme/v1/theme.model.js +0 -2
  44. package/src/lib/topics/current-workspace/v1/current-workspace.topic.js +2 -6
  45. package/src/lib/topics/current-workspace/v1/current-workspace.topic.js.map +1 -1
  46. package/src/lib/topics/current-workspace/v1/endpoint.model.js +0 -2
  47. package/src/lib/topics/current-workspace/v1/mfe-portal-registration.model.js +0 -2
  48. package/src/lib/topics/current-workspace/v1/route.model.js +0 -2
  49. package/src/lib/topics/current-workspace/v1/workspace.model.js +0 -2
  50. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.model.d.ts +15 -0
  51. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.model.js +6 -0
  52. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.model.js.map +1 -0
  53. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.topic.d.ts +6 -0
  54. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.topic.js +7 -0
  55. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.topic.js.map +1 -0
  56. package/src/lib/topics/events/v1/event-type.js +2 -5
  57. package/src/lib/topics/events/v1/event-type.js.map +1 -1
  58. package/src/lib/topics/events/v1/events-topic.d.ts +1 -4
  59. package/src/lib/topics/events/v1/events-topic.js +2 -12
  60. package/src/lib/topics/events/v1/events-topic.js.map +1 -1
  61. package/src/lib/topics/events/v1/navigated-event-payload.js +0 -2
  62. package/src/lib/topics/events/v1/navigated-event-type.js +0 -2
  63. package/src/lib/topics/events/v1/topic-event-type.js +0 -2
  64. package/src/lib/topics/global-error/v1/global-error.topic.js +2 -6
  65. package/src/lib/topics/global-error/v1/global-error.topic.js.map +1 -1
  66. package/src/lib/topics/global-loading/v1/global-loading.topic.js +2 -6
  67. package/src/lib/topics/global-loading/v1/global-loading.topic.js.map +1 -1
  68. package/src/lib/topics/icons/v1/icon.model.d.ts +15 -0
  69. package/src/lib/topics/icons/v1/icon.model.js +1 -0
  70. package/src/lib/topics/icons/v1/icon.model.js.map +1 -0
  71. package/src/lib/topics/icons/v1/icon.topic.d.ts +5 -0
  72. package/src/lib/topics/icons/v1/icon.topic.js +7 -0
  73. package/src/lib/topics/icons/v1/icon.topic.js.map +1 -0
  74. package/src/lib/topics/image-repository/image-repository.model.js +0 -2
  75. package/src/lib/topics/image-repository/image-repository.topic.js +2 -6
  76. package/src/lib/topics/image-repository/image-repository.topic.js.map +1 -1
  77. package/src/lib/topics/is-authenticated/v1/isAuthenticated.topic.js +2 -6
  78. package/src/lib/topics/is-authenticated/v1/isAuthenticated.topic.js.map +1 -1
  79. package/src/lib/topics/message/v1/message.model.js +0 -2
  80. package/src/lib/topics/message/v1/message.topic.js +2 -6
  81. package/src/lib/topics/message/v1/message.topic.js.map +1 -1
  82. package/src/lib/topics/notification/v1/notification.model.d.ts +21 -0
  83. package/src/lib/topics/notification/v1/notification.model.js +1 -0
  84. package/src/lib/topics/notification/v1/notification.model.js.map +1 -0
  85. package/src/lib/topics/notification/v1/notification.topic.d.ts +5 -0
  86. package/src/lib/topics/notification/v1/notification.topic.js +7 -0
  87. package/src/lib/topics/notification/v1/notification.topic.js.map +1 -0
  88. package/src/lib/topics/parameters/v1/parameters.topic.d.ts +1 -4
  89. package/src/lib/topics/parameters/v1/parameters.topic.js +2 -12
  90. package/src/lib/topics/parameters/v1/parameters.topic.js.map +1 -1
  91. package/src/lib/topics/permissions/v1/permissions.topic.js +2 -6
  92. package/src/lib/topics/permissions/v1/permissions.topic.js.map +1 -1
  93. package/src/lib/topics/permissions-rpc/v1/permissions-rpc.model.js +0 -2
  94. package/src/lib/topics/permissions-rpc/v1/permissions-rpc.topic.js +2 -6
  95. package/src/lib/topics/permissions-rpc/v1/permissions-rpc.topic.js.map +1 -1
  96. package/src/lib/topics/remote-components/v1/remote-component.model.d.ts +1 -0
  97. package/src/lib/topics/remote-components/v1/remote-component.model.js +2 -5
  98. package/src/lib/topics/remote-components/v1/remote-component.model.js.map +1 -1
  99. package/src/lib/topics/remote-components/v1/remote-components-info.model.js +0 -2
  100. package/src/lib/topics/remote-components/v1/remote-components.topic.js +2 -6
  101. package/src/lib/topics/remote-components/v1/remote-components.topic.js.map +1 -1
  102. package/src/lib/topics/remote-components/v1/slot.model.js +0 -2
  103. package/src/lib/topics/resized-events/v1/resized-event-type.js +2 -5
  104. package/src/lib/topics/resized-events/v1/resized-event-type.js.map +1 -1
  105. package/src/lib/topics/resized-events/v1/resized-events.topic.d.ts +1 -5
  106. package/src/lib/topics/resized-events/v1/resized-events.topic.js +9 -14
  107. package/src/lib/topics/resized-events/v1/resized-events.topic.js.map +1 -1
  108. package/src/lib/topics/resized-events/v1/resized-update-requested-type.js +0 -2
  109. package/src/lib/topics/resized-events/v1/slot-groups-resized-type.js +0 -2
  110. package/src/lib/topics/resized-events/v1/slots-resized-type.js +0 -2
  111. package/src/lib/topics/resized-events/v1/topic-resized-event-type.js +0 -2
  112. package/src/lib/topics/user-profile/v1/user-profile.model.js +2 -5
  113. package/src/lib/topics/user-profile/v1/user-profile.model.js.map +1 -1
  114. package/src/lib/topics/user-profile/v1/user-profile.topic.js +2 -6
  115. package/src/lib/topics/user-profile/v1/user-profile.topic.js.map +1 -1
  116. package/src/lib/utils/configuration.utils.d.ts +41 -0
  117. package/src/lib/utils/configuration.utils.js +52 -0
  118. package/src/lib/utils/configuration.utils.js.map +1 -0
  119. package/src/lib/utils/logger.utils.d.ts +1 -0
  120. package/src/lib/utils/logger.utils.js +4 -0
  121. package/src/lib/utils/logger.utils.js.map +1 -0
  122. package/src/lib/utils/parameters.utils.d.ts +14 -0
  123. package/src/lib/utils/parameters.utils.js +15 -0
  124. package/src/lib/utils/parameters.utils.js.map +1 -0
  125. package/src/lib/utils/portal-message.utils.d.ts +54 -0
  126. package/src/lib/utils/portal-message.utils.js +49 -0
  127. package/src/lib/utils/portal-message.utils.js.map +1 -0
  128. package/src/lib/utils/shell-capability.utils.d.ts +21 -0
  129. package/src/lib/utils/shell-capability.utils.js +30 -0
  130. package/src/lib/utils/shell-capability.utils.js.map +1 -0
  131. package/src/lib/utils/user-language.utils.d.ts +30 -0
  132. package/src/lib/utils/user-language.utils.js +56 -0
  133. package/src/lib/utils/user-language.utils.js.map +1 -0
  134. package/src/lib/utils/workspace.utils.d.ts +76 -0
  135. package/src/lib/utils/workspace.utils.js +199 -0
  136. package/src/lib/utils/workspace.utils.js.map +1 -0
  137. package/src/version.d.ts +2 -0
  138. package/src/version.js +3 -0
  139. package/src/version.js.map +1 -0
  140. package/migrations/index.d.ts +0 -3
  141. package/migrations/index.js +0 -7
  142. package/migrations/index.js.map +0 -1
  143. package/migrations/v5/warn-for-events-publisher-navigated.d.ts +0 -2
  144. package/migrations/v5/warn-for-events-publisher-navigated.js +0 -33
  145. package/migrations/v5/warn-for-events-publisher-navigated.js.map +0 -1
  146. package/migrations/v5/warn-for-events-topic-navigated.d.ts +0 -2
  147. package/migrations/v5/warn-for-events-topic-navigated.js +0 -34
  148. package/migrations/v5/warn-for-events-topic-navigated.js.map +0 -1
  149. package/migrations/v6/migrate-onecx-to-v6.d.ts +0 -2
  150. package/migrations/v6/migrate-onecx-to-v6.js +0 -8
  151. package/migrations/v6/migrate-onecx-to-v6.js.map +0 -1
  152. package/migrations.json +0 -46
package/README.md CHANGED
@@ -1,11 +1,16 @@
1
- # integration-interface
1
+ # @onecx/integration-interface
2
2
 
3
- This library contains everything that is needed to communicate with the shell and that is framework independent
3
+ `@onecx/integration-interface` contains framework-agnostic interfaces and type definitions for OneCX platform integration.
4
+ More information about the library can be found [here](https://onecx.github.io/docs/documentation/current/onecx-portal-ui-libs/libraries/integration-interface.html)
4
5
 
5
- ## Building
6
+ ## Installation
6
7
 
7
- Run `nx build integration-interface` to build the library.
8
+ ```bash
9
+ npm install @onecx/integration-interface
10
+ ```
8
11
 
9
- ## Running unit tests
10
-
11
- Run `nx test integration-interface` to execute the unit tests via [Jest](https://jestjs.io).
12
+ ## Additional Commands
13
+ - `npx nx run integration-interface:build` - Builds the library and outputs the result to the `dist` folder.
14
+ - `npx nx run integration-interface:test` - Runs the unit tests for the library.
15
+ - `npx nx run integration-interface:lint` - Lints the library's codebase.
16
+ - `npx nx run integration-interface:release` - Releases a new version of the library to npm, following semantic versioning guidelines.