Releases: opendatasoft/ods-dataviz-sdk
@opendatasoft/api-client v21.1.0
Release notes
Features
- Add Record endpoint (3d68ea7)
// ../catalog/datasets/my-dataset/records/2ee92a48178f784a5babfc06cb42d210cab57f55/ client.get( fromCatalog() .dataset('my-dataset') .record('2ee92a48178f784a5babfc06cb42d210cab57f55') );
@opendatasoft/api-client v21.0.0
Welcome to the first stable release of @opendatasoft/api-client
!
This MAJOR release is meant to coincide with Opendatasoft's Explore API v2.1 release and includes a few new features.
New clauses: Clauses help you build ready to use ODSQL predicates.
- The
textStartWith()
function is for a search where the searched string matches text fields that contain strings beginning with the searched string. Equivalent to ODSQL startsWith. - The
textSuggest()
function is for a search where the searched string matches the text fields that contain individual terms beginning the searched string. Equivalent to ODSQL suggest. - The
textSearch()
function is for fuzzy searches that find matches even if the searched string is not an exact match. Equivalent to ODSQL search.
All theses clauses accept a second optional parameter (textFields
: string[]
) to specify the fields to search in. By default the search is done on all the fields.
Deprecation warnings: When an API response contains the ODS-Explore-API-Deprecation
header, by default, a warning message will be showed in the console.
It can be disabled by setting up the hideDeprecatedWarning
option to false
when initiating the Client.
To learn more about deprecation warnings, follow this link.
Better TS support for exports functions: ExportCatalogFormat
and ExportDatasetFormat
list available export formats for a catalog or a dataset.
🆙 Upgrade guide
- The
query()
function has been removed. Use therecords()
function instead.⚠️ danger Response format has also changed. - Previously deprecated, the
aggregates()
function has been removed. Use therecords()
function instead. - Response format for the
records()
query has changed.links
has been removed andrecord
replaced byresults
. - Response format for the
datasets()
query has changed.dataset
has been replaced byresults
. - The
textSearch()
clause has been renamed totextSuggest()
.⚠️ textSearch()
still exists but is now a clause to do a fuzzy search that finds matches even if the searched string is not an exact match. Equivalent to ODSQL search predicate. - The
exports()
function have been renamed toexport()
. XLS
export format is removed and changed toXLSX
.
About versioning
In the documentation, you can learn more about the versioning of this package and why we've chosen to release our first stable package as version 21.0.0
.
Release notes
Features
- New and updated clauses:
textStartWith()
,textSearch()
andtextSuggest()
. - types: Add
ExportCatalogFormat
andExportDatasetFormat
types. - Warning messages are showed in the console when the response API contains an
ODS-Explore-API-Deprecation
header.
@opendatasoft/visualizations v0.5.1
@opendatasoft/visualizations v0.5.0
Features
- Add charts layouts configuration
- Add KPI component