Skip to content

CHANGELOG.md

Latest commit

 

History

History
385 lines (204 loc) · 8.19 KB

CHANGELOG.md

File metadata and controls

385 lines (204 loc) · 8.19 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.24.0] - 2026-03-23

Added

  • Add trace tracking to SDK messages for debugging and analytics
  • Added TraceEntry interface for the tracing information model

[1.23.0] - 2026-03-13

Added

  • Define and "publish" new model SettingsRequest
  • Enhance getSettingsRequest_v1_schema to support multiple keys as well as nested keys

[1.22.0] - 2026-03-11

Added

  • Add optional sandboxPolicies property to ModalOpenRequestV2 model and schema

[1.21.1] - 2026-03-04

Changed

  • Make models GetFeatureFlagRequest and GetFeatureFlagResponse public by adding them to the index file
  • Create and "publish" new model GetFeatureFlagsRequest to have an interface for an array request payload
  • Update docs by enhancing description for GET_FEATURE_FLAG event and fixing some typos

[1.21.0] - 2026-03-03

Changed

  • Fix schema outletsRequestDynamicContextResponse_v1_schema to apply draft-06 and draft-07 JSON validation standards
  • Enhance schema getFeatureFlagRequest_v1_schema to support array next to object as correct request payload
  • Add unit test to make sure that all schemas are valid and follow draft-04, draft-06 and draft-07 JSON validation standards (besides outletsRequestDynamicContextResponse_v1_schema)
    • outletsRequestDynamicContextResponse_v1_schema has an optional array property called "plugins", which contains objects with an optional array property called "sandboxPolicies". Draft-04 does not support this "optional array" inside "optional array", while draft-06 and draft-07 do.
  • Enhance model OutletsRequestContextResponse and OutletsRequestDynamicContextResponse by defining property plugin(s) better
  • Update typescript version to avoid warnings during execution of unit tests

[1.20.0] - 2024-10-10

Added

  • Context with deploymentId for extensions only works in case the respective outlet has a target extension-assignment-id. Execute logic to retrieve deploymentId only in case respective outlet has a target.

[1.19.0] - 2023-09-04

Added

  • Implement internal V2.REQUIRE_PERMISSIONS

[1.18.0] - 2023-08-29

Added

  • Implement V3.GET_PERMISSIONS

[1.17.1] - 2023-05-08

Fixed

  • readd V1.CLOSE Event, since it is still used internally

[1.17.0] - 2023-04-19

Added

  • added V2.MODAL.OPEN

Updated

  • updated V1.MODAL.OPEN modal name to specify it is V1

[1.16.1] - 2022-03-30

Added

  • added 'INVALID_EXTENSION' to ErrorType enum
  • added 'isPreviewMode' property to OutletsRequestContextResponse type
  • added 'isPreviewMode' property to OutletsRequestDynamicContextResponse type

[1.16.0] - 2022-06-09

Added

  • added 'data' property to ModalOpenRequest type

Removed

  • removed unused Version1.CLOSE event

[1.15.7] - 2022-08-24

Fixed

  • isInsideShellModal() method always returning false

[1.15.6] - 2022-03-08

Updated

  • Make property areDynamicOutletsEnabled from OutletsRequestDynamicContextResponse optional. It will be first removed from outlets package and later from Shell as multi-extension outlets are going to be always enabled.

[1.15.5] - 2022-05-24

Added

  • Add isScrollbarHidden field as part of modalSettings in payload for MODAL.OPEN event

[1.15.4] - 2022-05-18

Added

  • Add backdropClickCloseable field as part of modalSettings in payload for MODAL.OPEN event

[1.15.3] - 2022-01-11

Fixed

  • Validate max depth for OUTLETS.REQUEST_DYNAMIC_CONTEXT event

[1.15.2] - 2021-12-07

Added

  • outletSettings field in payload for OUTLETS.REQUEST_DYNAMIC_CONTEXT event

[1.15.1] - 2021-11-19

Added

  • outletSettings field in payload for OUTLETS.REQUEST_CONTEXT event

[1.15.0] - 2021-11-17

Added

  • Enhance fsm-shell to support dynamic outlets

[1.14.0] - 2021-10-21

Added

  • Json schemas for event payload validation
  • Logic for event payload validation against json schemas

[1.13.2] - 2021-09-24

Updated

  • Documentation updated to include event versioning guide.

[1.13.1] - 2021-09-10

Fixed

  • Fixed unit tests

[1.13.0] - 2021-08-27

Added

  • Messages to handle MODAL open and close event
  • Add isInsideShellModal() method to know if app is running inside Shell Modal

[1.12.1] - 2021-08-11

Fixed

  • Context with deploymentId for extensions only works in case the respective outlet has a target (name), which is optional. Execute logic to retrieve deploymentId only in case respective outlet has a target.

[1.12.0] - 2021-08-02

Added

  • Support context with deploymentId for extensions

[1.11.2] - 2021-07-23

Fixed

  • Make fsm-shell repository reuse compliant

[1.11.1] - 2021-06-28

Fixed

  • Update karma to newest version to fix security issue

[1.11.0] - 2021-06-22

Added

  • Add the possibility to ignore messages from a specific origin

[1.10.1] - 2021-04-15

Added

  • V1.RESTORE_TITLE event support

[1.10.0] - 2021-04-15

Added

  • V1.SET_TITLE event support

[1.9.2] - 2021-02-25

Fixed

  • Update dependencies to fix vulnerabilities

[1.9.1] - 2021-02-03

Update

  • Dependencies to fix security vulnerability

[1.9.0] - 2021-01-28

Update

  • REQUIRE_CONTEXT event enhanced to support extension authenticatiopn

Added

  • REQUIRE_AUTHENTICATION event for extension authentication support

[1.8.0] - 2021-01-19

Update

  • Validate iFrame origing against postMessage event origin when proxing events from outlets
  • Added ability to dynamically add/remove allowed origins

[1.7.3] - 2020-12-11

Update

  • Update dependencies to fix potential security vulnerabilities

[1.7.2] - 2020-11-24

Update

  • Downgrade fsm-shell dependency typescript to make it compatible with the current outlet package

[1.7.1] - 2020-10-14

Fixed

  • Replace error message for the usage of V1.SET_VIEW_STATE event to a warning

[1.7.0] - 2020-09-02

Added

  • Support V1.GET_FEATURE_FLAG event

[1.6.2] - 2020-09-02

Fixed

  • Cypress compatibility issue for isInsideShell method

[1.6.1] - 2020-08-06

Fixed

  • Update dependencies to fix security breach

[1.6.0] - 2020-08-04

Added

  • Allow OutletsRequestContextRequest message to show/hide mocks on V1.OUTLET.ADD_PLUGIN event

[1.5.1] - 2020-06-17

Added

  • getTarget() method to access ShellSdk target object
  • Nested page within fsm-shell documentation

[1.5.0] - 2020-06-05

Added

  • Implement V2.GET_PERMISSIONS

[1.4.0] - 2020-05-15

Added

  • Implement V2.GET_STORAGE_ITEM
  • Restore V1.GET_STORAGE_ITEM as cockpit use none shellSdk interface and need same syntax

[1.3.2] - 2020-05-15

Bugfix

  • Fix .join crash on GET_STORAGE_ITEM event. from shell-host

[1.3.1] - 2020-05-11

Added

  • Special rule to expose key value on GET_STORAGE_ITEM event, with legacy support.

[1.3.0] - 2020-05-06

Added

  • setAllowedOrigins() method now allows to filter events based on its origin.

[1.2.8] - 2020-04-22

Added

  • New ErrorType OUTLET_HTTPS_ERROR.
  • Add isRootNodeHttps in OutletsRequestContextResponse interface.

[1.2.7] - 2020-04-21

Added

  • Return SHELL_EVENTS.Version1.OUTLET.LOADING_FAIL if reached maximum depth

[1.2.6] - 2020-04-21

Added

  • Add ShellSdk.isInsideShell() to verified if an application is running with or without Shell

[1.2.5] - 2020-04-17

Added

  • New OutletsDeleteAssignmentRequest and OutletsDeleteAssignmentResponse models for messages
  • Propagate SHELL_EVENTS.Version1.OUTLET.REQUEST_CONTEXT to all outlets if only update configurationmode state

[1.2.4] - 2020-04-09

Added

  • Implement CI with travis, badges, and coveralls

[1.2.3] - 2020-04-07

Fixed

  • Specify typescript version as dependency to avoid fix conflict

[1.2.2] - 2020-04-07

Fixed

  • Remove alert security by updating all dependencies

[1.2.1] - 2020-04-03

Added

  • Block setViewState from plugins

[1.0.0] - 2020-03-16

Added

  • Outlet feature
  • setViewState and onViewState methods
  • TO_APP and REQUIRE_CONTEXT_DONE events
  • Changelog file

Removed

  • FLOW APIs have been removed