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.3.6] - 2023-03-09

Added

• urlMask properties of bk-button and bk-url-paramters allow separate masks for pathname and search fields of current URL
• actions of type http support methods PATCH and PUT

Fixed

• headers property is forwarded from bk-layout-container into its content
• bk-layout adds injected headers in http-calls
• locales are correctly loaded on first plugin render
• actions of type file-upload correctly calls error event if http-call fails
• actions of type href correctly resolve dynamic configurations
• using bk-layout-container does not trigger extra http calls
• fields are correctly put on focus on bk-form-modal wizard mode
• form components do not discard "__STATE__" field on data creation
• bk-search-bar keeps state on layout change

[1.3.5] - 2023-02-23

Added

• new component bk-dropdown is available
• bk-form-modal with extraEndpoint property injects a triggeredBy key equal to bk-form-modal-extra-endpoint into success/error events
• bk-simple-list supports height property, setting max-height of the list body
• new Handlebars helper nFormat allows to format fields of type number and format currency, specifying number of decimal places, decimal separator, group separator
• new component bk-notification-center is available
• bk-filters-manager component allows persistent filters

Fixed

• bk-expanded-filters supports internationalized labels
• output of fields with format editor do not use custom quill classes in form components. Refer to this issue for further details

[1.3.4] - 2023-02-09

Added

• fields in form can have a description in a tooltip
• new web component for auto refresh: bk-auto-refresh
• bk-url-parameters support wildcards in urlMask, which can be ignored with property excludeWildcards
• new component bk-atlas-dashboard is available
• bk-card component supports dynamic footer and buttons using template-configMap pair
• bk-card uses visualizationOptions in dataschema
• bk-button supports Action-sdk thorugh property action. clickConfig is now deprecated and will be removed in future releases, please refer to documentation for migration instructions

Fixed

• bk-form-card resolves lookups in initial values
• lookups are correctly resolved bk-filter-drawer initial values
• Form components correctly support editorHeight property in readonly mode
• Tables inside form components render date fields correctly accordingly to dateOptions.displayFormat in nested data-schema
• bk-gallery component does not render menu icon if empty
• bk-simple-list header style is aligned with bk-card and bk-form-card

[1.3.3] - 2023-01-26

Fixed

• bk-export component emits success / error events
• date / date-time / time fields are formatted in filter names accordingly to dateOptions.displayFormat in data-schema
• table column minWidth is more fitted to the column title
• fields of format "editor" can be edited
• lookups are correctly resolved in filter names

[1.3.2] - 2023-01-18

Added

• bk-filter-manager has a new filter operator for dates: notBetween
• components support array of dates
• filters on fields having filtersOptions.hidden set to true can be edited through events - bk-calendar works after setting filtersOptions.hidden to true for startDate, endDate fields

Fixed

• $today keyword in filters works correctly with every operator
• hour in date filters works correctly
• improved style of bk-gallery component

[1.3.1] - 2023-01-10

Added

• bk-simple-list resolves lookups
• bk-form-card can have a custom card header

[1.3.0] - 2022-23-12

Added

• new component bk-gallery is available

[1.2.3] - 2022-22-12

Added

• bk-crud-client can be configured to stay on current page after successful CRUD operation
• bk-calendar allows to specify the name of default date filters

Fixed

• Form components support internationalized strings for file picker fields

[1.2.2] - 2022-21-12

Fixed

• Form and Calendar components support internationalized labels

[1.2.1] - 2022-16-12

Added

• new component bk-layout is available, allowing plugins layout customization

Fixed

• bk-tabs support between operator with complex date filters
• lookups in forms are correctly resolved with long running queries
• default values integrate with initial values in add-new payload
• buttons in bk-confirmation-modal do not hold state from previous re-renders

[1.2.0] - 2022-11-17

Added

• file download with POST requests
• configurable height of object/array editor in bk-filter-drawer, bk-form-drawer, bk-form-modal and bk-form-card
• bk-table custom actions can be configured on a per-nested-level basis
• bk-file-client forwards useOriginalName query parameter to files-service (needs files-service 2.6.4+)
• number fields support date-time, date, time formats
• sortOption is supported in lookupOptions, controlling _s parameter when fetching lookups

Fixed

• bk-card with default role doesn't show border
• nested objects are shown in bk-table component without need to include bk-pagination in page
• when the same date is used in a between filter in bk-expanded-filters component, the correct filter is created
• fixed infinite loading caused by non-existing file in download-file event
• bk-table correctly performs pushState and replaceState when browseOnRowSelect property has navigationType set to "push" or "replace"

[1.1.2] - 2022-11-02

Fixed

• bk-table correctly indexes rows if primaryKey property is not defined (fixes rendering errors with nested objects)
• drawers follow Ant standard styling

Added

• bk-button enables bulk actions
• new component bk-expanded-filter
• bk-table accepts nested object path as data source

[1.1.1] - 2022-10-19

Fixed

• bk-form-drawer and bk-form-modal show readOnly dates with correct format, specified in dateOptions
• components keep loading until lookups aren't solved
• skip parameter (_sk) is reset when fetching data (unless query was triggered by pagination update)
• bk-filter-drawer filters of type date work correctly
• bk-layout-container supports disabling its render root as shadow dom. Useful to embed bk-calendar.

Added

• enable urlMask in bk-table customActions.

[1.1.0] - 2022-10-05

Fixed

• bk-form-drawer sends events created by dataCustomActions with the correct payload
• regex operators are escaped in search queries
• bk-form-drawer fields don't enable save button when lookupDeps prop is used
• file fields are correctly updated inside nested fields
• bk-form-modal with set extraEndpoint correctly opens wizard mode
• search queries are correctly performed for number fields
• fixed filter drawer bugs: exists operator, monaco editor

Added

• added the possibility to block a column in bk-form-table
• ignoreCase field is available in filtersOptions, controlling whether equality filters should be evaluated ignoring case
• custom button icon in nested tables
• complex date manipulation on bk-tabs filters

BREAKING CHANGES

• docker image serving back-kit components moved to: nexus.mia-platform.eu/back-kit/bk-web-components:{{BACK-KIT-VERSION}}. How to fix:

  • retrieve back-kit component from nexus.mia-platform.eu/back-kit/bk-web-components:1.1.0

• component bk-calendar uses addFilter event to handle data filtering. How to fix:

  • make sure bk-filters-manager is included in the page:

  ...
  {
    "type": "element",
    "tag": "bk-filters-manager"
  }
  ...

• bk-modal is now bk-old-modal. How to fix:

  • replace bk-modal with bk-old-modal in configurations

• bk-drawer is now bk-old-drawer. How to fix:

  • replace bk-drawer with bk-old-drawer in configurations

[1.0.11] - 2022-10-05

Fixed

• bk-form-drawer sends events created by dataCustomActions with the correct payload
• bk-form-modal with set extraEndpoint correctly opens wizard mode

Added

• ignoreCase field is available in filtersOptions, controlling whether equality filters should be evaluated ignoring case

[1.0.10] - 2022-09-21

Fixed

• fixed bug format currency
• readonly object and array fields are correctly displayed in forms

[1.0.9] - 2022-09-14

Fixed

• fixed export-modal bug on columns selection
• fixed ampersand visualization bug on table cells
• equal and not equal filters of properties with format "date" will not take in consideration the whole day

Added

• new React component BulkActions
• new components bk-bulk-delete and bk-bulk-actions
• added support to exists operator in filters

[1.0.8] - 2022-09-07

Fixed

• bk-pdf-viewer opens under bk-form-modal
• when a time/date/date-time field is marked as readOnly, it doesn't display the correct date format in the form
• bk-button does not emit events after plugin is changed

Added

• confirmation dialog on form submit: bk-form-drawer, bk-form-modal
• property showArrayPopover in bk-table allows displaying a popover on hovering array cells containing the elements of the array

[1.0.7] - 2022-08-03

Fixed

• bk-filters-manager does not display filters with properties having filtersOptions.hidden equals to true
• Fixed trailing comma bug in bk-crud-client while adding MongoDB query filters in "$and" clauses

Added

• danger colors can be controlled by global CSS variables
• bk-table allows resizable columns using property resizableColumns
• title and content of confirmation modals of bk-table row actions can now use the content of the row via Handlebars
• bk-file-picker can be used to update fields of type array and format file
• new components bk-export-client and bk-export-modal
• Added Export Service frontend client to perform collection exports
• fields with type number support currency format

[1.0.6] - 2022-07-20

Fixed

• fixed border-radius issue on select component in multiselect mode
• fixed support to filters added at bootstrap time

Added

• box-shadow color can be controlled by global CSS variables
• new React component MultipleFileCell
• bk-table has custom visualization for array of files
• bk-table allows to specify download or view mode in prop navigationRowActions
• added appendTrailingSlash property on bk-crud-client
• Update Files Service interface on bk-file-client allowing for download with actual filename in Content-Disposition header field
• bk-form and bk-file-manager support file array

[1.0.5] - 2022-07-06

Fixed

• bk-table does not render empty action column
• bk-form-modal correctly solves lookups in wizard mode

Added

• bk-card display main content in a css grid structure
• bk-modal reduced top css rule to center the container
• actions are evenly spaced in actions column in bk-table
• http client supports PUT method
• bk-filter-drawer and bk-filters-manager migrated to lit components.
• bk-crud-lookup-client solves nested lookups
• bk-pagination resets pageNumber when count and current page are inconsistent
• bk-crud-client patch response can also be a 204 no-content
• bk-filters-manager supports hidden static filters

[1.0.4] - 2022-06-23

Fixed

• bk-crud-client fixed support to projections in GET / and GET /count methods

Added

• new react hook useDynamicElement for creating components dynamically
• new react components Stepper and Accordion
• react components Form supports accordion visualization
• bk-table supports danger in rowActions and navigationRowActions
• bk-button/bk-generic-button supports http delete as clickConfig
• bk-notifications api fix
• bk-crud-lookup-client supports recursive lookup resolution when properly hinted by the DataSchema
• bk-form-modal supports wizard visualization

[1.0.3] - 2022-06-08

Added

• bk-card supports date with configurable formatting
• bk-form supports map visualization for object/array fields having format "geopoint"
• bk-file-client is implemented in lit
• bk-file-manager is implemented in lit
• bk-file-picker-drawer is implemented in lit
• bk-form-card is implemented in lit
• bk-button bk-generic-button support file-download type
• bk-card supports EventBus in sub-components props + bk-button style fixes on type link
• bk-button supports danger prop

[1.0.2] - 2022-05-25

Added

• navigationType can be specified in bk-table in prop browseOnRowSelect, specifying the desired navigation method.

• bk-form-modal and bk-form-drawer are implemented in lit

• bk-card footer accepts dynamic configurations with handlebars notation

• it is allowed to search numbers

• nested objects visualization supports file upload/download

• bk-table has custom visualization for array of files

• bk-table allows to specify download or view mode in prop navigationRowActions

[1.0.1] - 2022-05-12

Added

• Table accepts (template, configMap) pairs in custom components properties.
• Table accepts onCellClickBuilder, building onClick callback for cells.
• property customActions in bk-table accepts (template, configMap) pairs for values depending on table row.
• bk-table accepts openFileInViewerRegex, determining which file cells are clickable, opening the file inside the native viewer of the browser.
• support to subsets of operators in bk-filter-drawer + support to string enum fields.
• new bk-layout-container component allows to render multiple configurations within the same plugin.
• bk-tabs migrated to lit components.
• bk-tabs can pipe custom events to the EventBus.
• date filters now support key $today as value, indicating the current date

[1.0.0] - 2022-04-22

Added

• added new component Chip
• building custom component inside Table handles undefined context in handlebars
• Pagination supports buttonsOnly modality, only displaying previous button, next button and page size menu
• property allowNavigation in bk-form-card, bk-form-drawer and bk-form-modal accepts values true, false, 'show-editor'
• bk-button accepts property navigationStrategy which allows to disable/hide the button in navigation
• key showInViewer in formOptions inside the data-schema and key showInViewer in downloadFile's meta allow to display supported files (PDFs) inside the browser, while property showPdfInBrowser in bk-file-client is no longer needed
• added new component bk-chip
• bk-crud-client can retrieve http responses and append the content to the success event payload
• bk-state-adapter allows carrying some state to another plugin + new documentation on plugin navigation
• if a negative page total count is received, bk-pagination only displays previous button, next button and page-size menu, omitting current page, page total and skip all buttons

[0.10.7] - 2022-04-08

BREAKING CHANGES

• lookupQueries require a new key propertyType that specifies the type of the property field that is queried if this is not string. How to fix: add a new key propertyType in each filter inside lookupQueries, with the type of the queried property.

Added

• added new property computeOptionKey to Form and Table that allows to compute the key to use when retrieving options for lookups and multilookups
• Table supports custom components in the actions column
• lookups and multi-lookups fields are resolved when navigating nested objects/arrays in bk-table, bk-form-drawer and bk-form-modal
• bk-table supports custom components in the actions column via the prop customActions
• lookupQueries now support queries based on fields that are not included as properties in the data-schema. Key propertyType added to lookupQueries, indicating the type of the property being filtered
• bk-tabs supports handlebars in filters with array value
• bk-crud-lookup-client supports extraLookupKeys, which specifies extra fields to retrieve data from CRUD collections
• bk-pagination is now a lit component

[0.10.6] - 2022-04-01

BREAKING CHANGES

• crud-client interacts with window.history using replaceState instead of pushState allowing plugin navigation. (very low impact)

Added

• It is now possible to specify the hiddenLabel visualization option in dataschema properties to hide the table column name.
• It is now possible to specify the sortable visualization option in dataschema properties to enable/disable the table column sort.
• Moved search-bar logic to web components
• object visualization template
• bk-crud-lookup-client now supports searchLookups event, searching lookups against a text value
• bk-crud-client now supports search queries on lookups
• removed bk-search-bar component
• bk-file-client can be configured to request in-browser PDF visualization instead of requesting download
• bk-pdf-viewer component allows to visualize PDF files in-browser
• added new bk-search-bar component that allows text search
• Add new web component bk-dynamic-title
• Add new web component bk-list
• Add new web component bk-url-parameters

[0.10.5] - 2022-03-17

Added

• Added new component Generic Button
• Added between filter
• Dynamic href are resolved for link add-ons.
• Added new components NavigationBackArrow and Breadcrumbs
• It is now possible to specify dynamic links for href in link addons.
• It is now possible to navigate and edit nested objects.
• dataSchema supports type object format localized-text and renders the object according with the browser language
• It is now possible to specify a between operator for date fields in filters.
• Form card component bk-form-card
• Subtitle for form-modal and form-drawer
• nativeDownload on bk-export enables native browser file download aliasing the export service
• Add new web component bk-generic-button - it handles configurable onCLick action.
• bk-dynamic-title component
• Add new web component bk-navigation-nack-arrow and bk-breadcrumbs to handle nested objects navigation.

[0.10.4] - 2022-02-21

Fixed

• Avoid FontAwesome's CSS collision

Added

• fetchOptions for dependent fields is run on on-blur event

[0.10.3] - 2022-01-28

Fixed

• when null object reaches a table it is correctly printed as an italic placeholder string

Added

• Table and Form now receive already resolved lookup data
• Form receives options and fetchOptions properties for dependent lookup and multilookup fields
• Options for lookup fields are now fetched live as the user is typing, instead of being retrieved all at once
• If key is turned on --> duplicate keeps the state. If state is passed as not undefined, creating drags it along as well
• Unresolved lookups can be set to display a custom error message on bk-table, bk-form-drawer and bk-form-modal
• It is now possible to specify dependencies between lookup and multilookup fields specifying lookupDeps inside lookupOptions in the dataSchema.
• It is now possible to specify lookupAddTrailingSlash in lookupOptions which controls whether or not a trailing / is added to the url when the lookup data is queried. Defaults to true.

[0.10.2] - 2022-01-14

Fixed

• It is now possible to paste content in Editor without scrolling back to the top

Added

• Form allows to visualize objects and arrays either as table or MonacoEditor, when attached to modal viewer
• allowObjectAsTable property/attribute added to bk-form-modal
• bk-add-new-button now accepts an initialValues prop that gets forwarded to the add-new event.

[0.10.1] - 2021-12-17

Fixed

• Issue-38 definitive delete sends __STATE__ to CRUD jointly with delete by id request

[0.10.0] - 2021-12-10

Fixed

• filterForm now correctly supports live search in lookup fields
• readonly form drawer doesn't overwrite configurations/data-schema
• Query builder now starts off from a fresh query every time and creates it with the current query object, any other query parameter will be removed
• bk-tabs now expects every tab to have also a key property in tab objects, objects with no key property are deprecated, this is to keep consistency with links exchanged between users with different ACL rules
• bk-form-drawer now correctly passes language to its inner components
• bk-filter-form now correctly supports live search in lookup fields

BREAKING CHANGES

• Tabs props now expect defaultActiveKey as string instead of defaultActiveIndex, tabs has to be provided as a Record<string, Tab> instead of an array of tabs
• using-drawer event is now using-form-container

Added

• Created new Editor component
• Created new format editor for the form
• Created modal as form container
• save is enabled on form drawer if entries are not touched and relative config is enabled
• readOnly and disabled properties can be configured separately on form-drawer insert or update opening mode
• Created bk-form-modal component

[0.9.0] - 2021-11-08

Changed

• form now correctly validates fileInput required prop
• date, lookup, file, and form addon properties are now automatically excluded from queries generated by free-text search
• drawer confirmation modal before close is configurable from prop requireConfirm
• drawer actions is configurable for each action from prop closeOnClick

BREAKING CHANGES

• Table maxLines has no default value

Added

• Table fill parent size if no maxLines has been specified

[0.8.1] - 2021-10-26

Fixed

• bk-file-manager now correctly sends create-data event after uploading following a create-data-with-file

Added

• table now supports defaultSortedProp and defaultSortOrder props to mark a column as already sorted when generating headers
• bk-table now supports initialSortProperty and initialSortDirection props to provide a bootstrap sorting order to table

[0.8.0] - 2021-10-22

Fixed

• bk-form-drawer should not overwrite default locales when merging user config

Changed

• Data are now refreshed after an HTTP POST triggered by a table row action

Added

• Form now supports file input fields
• bk-form-drawer can now accept a readonlyOnView prop, when true, will use a readonly form to represent the selected data
• bk-form-drawer now communicates with file manager to handle multiple file upload linked to a record while creating/updating a record

[0.7.0] - 2021-10-07

BREAKING CHANGES

• bk-file-picker-drawer, bk-form-drawer, and bk-filter-drawer locale labels are now lowercase

Added

• When creating a new event, bk-calendar can now pass a configurable payload alongside with startDate and endDate
• When creating a new event, bk-calendar can now pass a configurable payload alongside with startDate and endDate

[0.6.0] - 2021-09-29

Changed

• Changed calendar component props interfaces

Added

• Components use headers custom prop to inject headers on http clients

[0.5.0] - 2021-09-23

Fixed

• Lookup queries must involve only fields declared within the dataSchama
• Href links are limited to current page domain. no external ref allowed
• email text field validation did occur twice

Added

• Drawer component now can render custom data actions in the header
• Confirmation ConfirmationModal component
• bk-form-drawer awaits a success/error on their transaction before to close. On error it stays open
• Custom actions are available on bk-form-drawer component
• Added bk-confirm-modal Confirmation ConfirmationModal component
• Custom actions now can trigger the bk-confirm-modal by specifying requireConfirm and customize the messages in the modal if provided in the object
• bk-form-drawer uses bk-confirm-modal to ask confirmation before closing if fields are touched

[0.4.0] - 2021-09-16

Fixed

• Filters on array properties that are not multilookup are now supported
• bk-filter-drawer will now wait for lookup data if there is at least one lookup property in the data schema

BREAKING CHANGES

• bk-notification component props were modified. Three props are now available: successEventMap, errorEventMap and customEventMap event maps crud-client and crud-lookup-client changed prop name from schema to dataSchema
• Naming convention moved to bk-component-name even for clients and file-picker-drawer

Added

• Documentation automation
• Filters marked as hidden are not written in the URL

[0.3.0] - 2021-09-09

BREAKING CHANGES

• Form links now have to be declared in the properties property of the data schema. Property formLinks is no longer supported.
• Form titles and subtitles now have to be declared in the properties property of the data schema. Properties title, subtitle and subtitlePosition of data-schema's FormOptions are no longer supported.

Added

• Properties can be hidden from FiltersForm with property filtersOptions.hidden in data schema.
• Table rowActions support download-file event when a file is available in row
• Table browseOnSelectRow supports browsing away by clicking the row
• Add-new-button browseOnButtonClick supports browsing away by clicking the button
• Form web-components now support custom localized labels

[0.2.0] - 2021-09-03

[0.2.0-alpha.6] - 2021-09-02

Fixed

• Tabs now support values with | in them
• Patch now works on $set $unset

[0.2.0-alpha.5] - 2021-09-02

Fixed

• __STATE__ property has been removed from query parameters _q and moved to _st. Conflicting __STATE__ changes are defaulted in favour of the selected tab __STATE__ filter
• Fixed filters on lookup-client

Added

• Tabs support currentUser on queries

[0.2.0-alpha.4] - 2021-08-30

Fixed

• Table lookup and multilookup resolve
• Monaco now correctly load in prod build
• Required complex objects now properly validate

Changed

• The only supported format both in input and output is now only ISO8601 in every component using dates
• Only changed values are sent to patch
• Edited form output formatting for Dates

Added

• File picker now handle the download of a previously uploaded file
• On update data, null fields are used for the $unset
• From file drawer is now possible to download the previously uploaded file
• From file drawer is now possible to delete the previously uploaded file

[0.2.0-alpha.3] - 2021-08-23

Fixed

• Fixed date input formatting when format was date-time, time
• Live search in form lookup and multilookup field is now applied to label instead of value
• Fixed multiple lookup on same datasource
• Fixed scroll on top of the drawer when is visible
• Fixed filter duplication reload when there was a filter configured in DataSchema
• Fixed date input formatting when format was date-time, time
• Fixed multiple lookup on same datasource
• Standardized locale for drawer web components
• Aligned test general behavior for eventBus and subscription

Changed

• Dependencies upgrade
• Removed matchMedia mock
• Jest default testEnvironment = 'jsdom'
• Font awesome icons as peer dependency
• Removed peerDependencies from devDependencies
• Reordered scripts
• Now form accept a React.Ref object
• Dependencies upgrade
• Removed testSetup
• At boot, the table loading spinner is activated

BREAKING CHANGES

• The entry point for bk-web-components is now exposed under /{DOCKER_IMAGE_VERSION}/bk-web-components.esm.js path

Added

• React Table component supports cell visualization on type: object and format: file
• Added filter support to array types
• Added support to includeSome/includeAll/includeExactly operators in array filters
• Form localization
• Form links target property is now configurable
• Support for readonly properties in form
• File picker component
• Inserted lookupQueries in lookupOptions
• More efficient components behavior thanks to useMemo and useCallback
• CrudQueryConverter now supports includeSome/includeAll/includeExactly array operators in filter queries
• Added delete support on file-client
• Added file-manger web-component - it handles transactions between file-client and crud-client on collections having a property with format file
• Support for multiple queries in and in Tabs component.
• File picker with drawer component
• Inserted filters prop in crud-lookup-client
• The sort property in the url are managed by the table

[0.2.0-alpha.2] - 2021-08-05

Fixed

• Fix read only in date inputs.
• Aligned CRUD client format (string) with Calendar events format (date).

Added

• Support to string formats date-time and time in form.