@opendatasoft/api-client v21.5.0

Release Note: TypeScript Types Update

This update focuses on improving TypeScript types within the codebase. Below is a summary of the changes introduced:

Major Changes:

• Type Prefix Removal: All TypeScript types no longer have the Ods prefix.
• Dataset Type Update:
  • The Dataset type has been modified: keys are no longer optional.
  • New keys have been added to the Dataset type, such as attachments and alternative_exports.

New Type Introduced:

• A new DatasetFieldType has been created for handling dataset field types.

Type Renaming:

• ApiRecords has been renamed to ApiDatasetRecords.
• ApiDatasets has been renamed to ApiCatalog.

Usage Guidelines:

Use ApiDatasetRecords and ApiCatalog when querying data without the group_by parameter. If you are using the group_by parameter, use the ApiQuery type along with the generic type for ApiQuery. When using the select clause while fetching a catalog, you can pass a type to override the default generic type Dataset.

@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 the records() function instead. ⚠️ danger Response format has also changed.
• Previously deprecated, the aggregates() function has been removed. Use the records() function instead.
• Response format for the records() query has changed. links has been removed and record replaced by results.
• Response format for the datasets() query has changed. dataset has been replaced by results.
• The textSearch() clause has been renamed to textSuggest(). ⚠️ 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 to export().
• XLS export format is removed and changed to XLSX.

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() and textSuggest().
• types: Add ExportCatalogFormat and ExportDatasetFormat types.
• Warning messages are showed in the console when the response API contains an ODS-Explore-API-Deprecation header.

@opendatasoft/visualizations v0.5.1

Features

• Disable charts animations (#38)

Build

• Make svelte-check cover all .ts files (#37)

Bug Fixes

• Fix pie charts custom plugin (#35)

@opendatasoft/visualizations v0.5.0

Features

• Add charts layouts configuration
• Add KPI component