@onecx/integration-interface 7.6.0 → 8.0.0-rc.10

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 (121) hide show
  1. package/README.md +12 -7
  2. package/dist/index.cjs +1069 -0
  3. package/dist/index.mjs +1038 -0
  4. package/package.json +19 -22
  5. package/src/index.d.ts +5 -0
  6. package/src/index.js +53 -51
  7. package/src/index.js.map +1 -1
  8. package/src/lib/declarations.js +1 -3
  9. package/src/lib/declarations.js.map +1 -1
  10. package/src/lib/models/shell-capability.model.d.ts +11 -0
  11. package/src/lib/models/shell-capability.model.js +8 -0
  12. package/src/lib/models/shell-capability.model.js.map +1 -0
  13. package/src/lib/services/dynamic-translation.service.d.ts +87 -0
  14. package/src/lib/services/dynamic-translation.service.js +275 -0
  15. package/src/lib/services/dynamic-translation.service.js.map +1 -0
  16. package/src/lib/services/icon.service.js +12 -19
  17. package/src/lib/services/icon.service.js.map +1 -1
  18. package/src/lib/services/image-repository.service.js +5 -9
  19. package/src/lib/services/image-repository.service.js.map +1 -1
  20. package/src/lib/topics/configuration/v1/configuration.topic.js +2 -6
  21. package/src/lib/topics/configuration/v1/configuration.topic.js.map +1 -1
  22. package/src/lib/topics/current-location/v1/current-location.model.js +0 -2
  23. package/src/lib/topics/current-location/v1/current-location.topic.d.ts +1 -7
  24. package/src/lib/topics/current-location/v1/current-location.topic.js +2 -15
  25. package/src/lib/topics/current-location/v1/current-location.topic.js.map +1 -1
  26. package/src/lib/topics/current-mfe/v1/current-mfe.topic.js +2 -6
  27. package/src/lib/topics/current-mfe/v1/current-mfe.topic.js.map +1 -1
  28. package/src/lib/topics/current-mfe/v1/mfe-info.model.js +0 -2
  29. package/src/lib/topics/current-page/v1/current-page.topic.js +9 -11
  30. package/src/lib/topics/current-page/v1/current-page.topic.js.map +1 -1
  31. package/src/lib/topics/current-page/v1/page-info.model.js +0 -2
  32. package/src/lib/topics/current-theme/v1/current-theme.topic.js +2 -6
  33. package/src/lib/topics/current-theme/v1/current-theme.topic.js.map +1 -1
  34. package/src/lib/topics/current-theme/v1/theme-override.model.js +2 -5
  35. package/src/lib/topics/current-theme/v1/theme-override.model.js.map +1 -1
  36. package/src/lib/topics/current-theme/v1/theme.model.js +0 -2
  37. package/src/lib/topics/current-workspace/v1/current-workspace.topic.js +2 -6
  38. package/src/lib/topics/current-workspace/v1/current-workspace.topic.js.map +1 -1
  39. package/src/lib/topics/current-workspace/v1/endpoint.model.js +0 -2
  40. package/src/lib/topics/current-workspace/v1/mfe-portal-registration.model.js +0 -2
  41. package/src/lib/topics/current-workspace/v1/route.model.js +0 -2
  42. package/src/lib/topics/current-workspace/v1/workspace.model.d.ts +0 -5
  43. package/src/lib/topics/current-workspace/v1/workspace.model.js +0 -2
  44. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.model.d.ts +15 -0
  45. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.model.js +6 -0
  46. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.model.js.map +1 -0
  47. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.topic.d.ts +6 -0
  48. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.topic.js +7 -0
  49. package/src/lib/topics/dynamic-translations/v1/dynamic-translations.topic.js.map +1 -0
  50. package/src/lib/topics/events/v1/event-type.js +2 -5
  51. package/src/lib/topics/events/v1/event-type.js.map +1 -1
  52. package/src/lib/topics/events/v1/events-topic.d.ts +1 -7
  53. package/src/lib/topics/events/v1/events-topic.js +2 -15
  54. package/src/lib/topics/events/v1/events-topic.js.map +1 -1
  55. package/src/lib/topics/events/v1/navigated-event-payload.js +0 -2
  56. package/src/lib/topics/events/v1/navigated-event-type.js +0 -2
  57. package/src/lib/topics/events/v1/topic-event-type.js +0 -2
  58. package/src/lib/topics/global-error/v1/global-error.topic.js +2 -6
  59. package/src/lib/topics/global-error/v1/global-error.topic.js.map +1 -1
  60. package/src/lib/topics/global-loading/v1/global-loading.topic.js +2 -6
  61. package/src/lib/topics/global-loading/v1/global-loading.topic.js.map +1 -1
  62. package/src/lib/topics/icons/v1/icon.model.js +0 -2
  63. package/src/lib/topics/icons/v1/icon.topic.js +2 -6
  64. package/src/lib/topics/icons/v1/icon.topic.js.map +1 -1
  65. package/src/lib/topics/image-repository/image-repository.model.js +0 -2
  66. package/src/lib/topics/image-repository/image-repository.topic.js +2 -6
  67. package/src/lib/topics/image-repository/image-repository.topic.js.map +1 -1
  68. package/src/lib/topics/is-authenticated/v1/isAuthenticated.topic.js +2 -6
  69. package/src/lib/topics/is-authenticated/v1/isAuthenticated.topic.js.map +1 -1
  70. package/src/lib/topics/message/v1/message.model.js +0 -2
  71. package/src/lib/topics/message/v1/message.topic.js +2 -6
  72. package/src/lib/topics/message/v1/message.topic.js.map +1 -1
  73. package/src/lib/topics/parameters/v1/parameters.topic.d.ts +1 -7
  74. package/src/lib/topics/parameters/v1/parameters.topic.js +2 -15
  75. package/src/lib/topics/parameters/v1/parameters.topic.js.map +1 -1
  76. package/src/lib/topics/permissions/v1/permissions.topic.js +2 -6
  77. package/src/lib/topics/permissions/v1/permissions.topic.js.map +1 -1
  78. package/src/lib/topics/permissions-rpc/v1/permissions-rpc.model.js +0 -2
  79. package/src/lib/topics/permissions-rpc/v1/permissions-rpc.topic.js +2 -6
  80. package/src/lib/topics/permissions-rpc/v1/permissions-rpc.topic.js.map +1 -1
  81. package/src/lib/topics/remote-components/v1/remote-component.model.js +2 -5
  82. package/src/lib/topics/remote-components/v1/remote-component.model.js.map +1 -1
  83. package/src/lib/topics/remote-components/v1/remote-components-info.model.js +0 -2
  84. package/src/lib/topics/remote-components/v1/remote-components.topic.js +2 -6
  85. package/src/lib/topics/remote-components/v1/remote-components.topic.js.map +1 -1
  86. package/src/lib/topics/remote-components/v1/slot.model.js +0 -2
  87. package/src/lib/topics/resized-events/v1/resized-event-type.js +2 -5
  88. package/src/lib/topics/resized-events/v1/resized-event-type.js.map +1 -1
  89. package/src/lib/topics/resized-events/v1/resized-events.topic.d.ts +1 -8
  90. package/src/lib/topics/resized-events/v1/resized-events.topic.js +9 -17
  91. package/src/lib/topics/resized-events/v1/resized-events.topic.js.map +1 -1
  92. package/src/lib/topics/resized-events/v1/resized-update-requested-type.js +0 -2
  93. package/src/lib/topics/resized-events/v1/slot-groups-resized-type.js +0 -2
  94. package/src/lib/topics/resized-events/v1/slots-resized-type.js +0 -2
  95. package/src/lib/topics/resized-events/v1/topic-resized-event-type.js +0 -2
  96. package/src/lib/topics/user-profile/v1/user-profile.model.js +2 -5
  97. package/src/lib/topics/user-profile/v1/user-profile.model.js.map +1 -1
  98. package/src/lib/topics/user-profile/v1/user-profile.topic.js +2 -6
  99. package/src/lib/topics/user-profile/v1/user-profile.topic.js.map +1 -1
  100. package/src/lib/utils/logger.utils.d.ts +1 -0
  101. package/src/lib/utils/logger.utils.js +4 -0
  102. package/src/lib/utils/logger.utils.js.map +1 -0
  103. package/src/lib/utils/shell-capability.utils.d.ts +2 -0
  104. package/src/lib/utils/shell-capability.utils.js +4 -0
  105. package/src/lib/utils/shell-capability.utils.js.map +1 -0
  106. package/src/version.d.ts +2 -0
  107. package/src/version.js +3 -0
  108. package/src/version.js.map +1 -0
  109. package/migrations/index.d.ts +0 -3
  110. package/migrations/index.js +0 -7
  111. package/migrations/index.js.map +0 -1
  112. package/migrations/v5/warn-for-events-publisher-navigated.d.ts +0 -2
  113. package/migrations/v5/warn-for-events-publisher-navigated.js +0 -33
  114. package/migrations/v5/warn-for-events-publisher-navigated.js.map +0 -1
  115. package/migrations/v5/warn-for-events-topic-navigated.d.ts +0 -2
  116. package/migrations/v5/warn-for-events-topic-navigated.js +0 -34
  117. package/migrations/v5/warn-for-events-topic-navigated.js.map +0 -1
  118. package/migrations/v6/migrate-onecx-to-v6.d.ts +0 -2
  119. package/migrations/v6/migrate-onecx-to-v6.js +0 -8
  120. package/migrations/v6/migrate-onecx-to-v6.js.map +0 -1
  121. 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.