Skip to content

CHANGES.md

Latest commit

 

History

History
471 lines (318 loc) · 16.5 KB

CHANGES.md

File metadata and controls

471 lines (318 loc) · 16.5 KB

Release Notes

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

The format is based on Keep a Changelog.

Note: Minor version 0.X.0 update might break the API, It's recommended to pin tipg to minor version: tipg>=0.1,<0.2

unreleased

1.3.1 - 2026-02-26

  • fix: bbox filter when collection's geometry is not in EPSG:4326 CRS

1.3.0 - 2025-11-17

  • switch to official python docker image from bitnami
  • add FactoryExtension to EndpointsFactory
  • rename viewer_endpoint function to map_viewer breaking change
  • rename /viewer endpoint to /map.html breaking change
  • changed container image to use non-root user
  • update minimum python version to 3.11
  • add python 3.14 support
  • switch to UV for development

1.2.1 - 2025-08-26

  • update starlette-cramjam requirement to >=0.4,<0.6

1.2.0 - 2025-07-23

  • remove request: Request in Collection.features and Collection.get_tile abstract methods

  • pass a asyncpg.Connection to PgCollection.features and PgCollection.get_tile instead of a Request object

  • switch pg_get_collection_index input from asyncpg.BuildPgPool to asyncpg.Connection object

1.1.2 - 2025-07-02

  • fix rel values for tiling scheme links

1.1.1 - 2025-06-13

  • remove tipg_schema alias in DatabaseSettings to support env variable settings

1.1.0 - 2025-05-06

  • update geojson-pydantic requirement to >=1.0,<3.0

1.0.1 - 2025-03-17

  • fix typo when using catalog_ttl

1.0.0 - 2025-03-07

Added

  • add tilesets and viewer links in /collections and /collections/{collectionId} response links
  • add the ability to use a schema other than pg_temp for installing catalog functions (using TIPG_DB_APPLICATION_SCHEMA environment variable)
  • re-use pg connection for features_count and features
  • add tipg.collections.Collection abstract base class

Changed

  • rename tipg.collections.Collection -> tipg.collections.PgCollection breaking change

  • update Collection.get_tile() and Collection.features() signature to expect request: Request as first parameter breaking change

  • rename tipg.collections.get_collection_index to tipg.collections.pg_get_collection_index and change the function to use DatabaseSettings instance directly instead of keyword option breaking change

  • update tipg.collections.pg_get_collection_index to return a list of PgCollection instead of a Catalog breaking change

  • update tipg.collections.register_collection_catalog to pass db_settings to pg_get_collection_index function breaking change

  • remove deprecated tiles endpoint with default TileMatrixSet

  • rename tilejson endpoint from /collections/{collectionId}/{tileMatrixSetId}/tilejson.json to /collections/{collectionId}/tiles/{tileMatrixSetId}/tilejson.json breaking change

  • rename stylejson endpoint from /collections/{collectionId}/{tileMatrixSetId}/style.json to /collections/{collectionId}/tiles/{tileMatrixSetId}/style.json breaking change

  • change database.connect_to_db input order breaking change

    # Before
async def connect_to_db(
    app: FastAPI,
    settings: Optional[PostgresSettings] = None,
    schemas: Optional[List[str]] = None,
    user_sql_files: Optional[List[pathlib.Path]] = None,
    **kwargs,
) -> None:

# Now
async def connect_to_db(
    app: FastAPI,
    *,
    schemas: List[str],
    tipg_schema: str = "pg_temp",
    user_sql_files: Optional[List[pathlib.Path]] = None,
    settings: Optional[PostgresSettings] = None,
    **kwargs,
) -> None:

Fixed

  • fix URL in HTML templates when behind proxy

0.10.1 - 2025-03-04

  • remove PostgresSettings initialization from main.py

0.10.0 - 2025-02-20

  • convert tile bbox into collection's CRS for MVT where selection (author @callsumzg, #205)

0.9.0 - 2025-01-17

  • fix serialization of UUID columns (author @giorgiobasile, #199)

  • Unify Docker images (deprecate tipg-uvicorn)

  • Remove python3.8 support

  • Add python3.13 support

0.8.0 - 2024-10-17

  • update starlette-cramjam dependency and set compression-level default to 6
  • update morecantile dependency requirement to allow 6.x

0.7.3 - 2024-09-16

  • add TIPG_SORT_COLUMNS settings to enable/disable columns sorting (default to True) (author @mattdiez-at, #187)
  • fix protomaps-leaflet version in HTML template (co-author @bmcandr, #190)

0.7.2 - 2024-08-27

  • move back to fastapi dependency

0.7.1 - 2024-05-07

  • move to fastapi-slim to avoid unwanted dependencies

0.7.0 - 2024-04-01

  • update leaflet version
  • add templated=True in template URL links
  • add (Template URL) in template URL links title
  • remove deserialization in tipg.factory.create_html_response function
  • add title option to create_html_response method, in order to set the web page title
  • add **kwargs to create_html_response method to allow custom object to be passed to the template
  • fix url/path passed to the HTML template
  • fix HTML templates when passing Query Parameters
  • replace maplibre with leaflet+protomaps-leaflet to support other TMS in the HTML viewer
  • deprecate non-tilematrixset prefixed endpoints for tiles/tilejson/stylejson/viewer to better match with the OGC Spec breaking
  • re-order endpoints
  • remove Z limit to support negative values

0.6.3 - 2024-02-02

  • update pydantic's Field usage to avoid 3.0 deprecation
  • update starlette's `TemplateResponse' usage to avoid deprecation

0.6.2 - 2024-01-19

  • add root_path API settings
  • fix invalid url parsing in HTML responses

0.6.1 - 2024-01-11

  • use spatial_extent and datetime_extent configuration options in CatalogUpdateMiddleware and /refresh endpoint (author @hrodmn, #164)

0.6.0 - 2024-01-09

  • update FastAPI version lower limit to >0.107.0 and adapt for new starlette version
  • fix invalid streaming response formatting
  • refactor internal table properties handling
  • fix sub-model Table settings (#154)

0.5.8 - 2024-01-10

  • fix invalid streaming response formatting [backported from 0.6.0]

0.5.7 - 2024-01-08

  • add tags to all routes
  • fix collections and items HTML templates to keep query-parameters when changing the page size
  • update FastAPI version upper limit to <0.107.0 to avoid starlette breaking change (0.28)

0.5.6 - 2023-12-19

  • Fix collections prev links and collections html templates

0.5.5 - 2023-12-19

  • Fix prev offset value

0.5.4 - 2023-12-19

  • Fix decimal error for streaming responses (author @RemcoMeeuwissen, #148)

0.5.3 - 2023-11-29

  • add Postgres date type as valid datetime column type

0.5.2 - 2023-11-28

  • add TIPG_DB_SPATIAL_EXTENT and TIPG_DB_DATETIME_EXTENT environment options to control if tipg will scan the tables for spatio-temporal extents (author @hrodmn, #143)

0.5.1 - 2023-11-15

fixed

  • fix for using is null in CQL2 filter (#140)

0.5.0 - 2023-11-02

added

  • add py.typed file

  • add tipg.collections.ItemList and tipg.collections.CollectionList TypedDict

    class ItemList(TypedDict):
    """Items."""

    items: List[Feature]
    matched: Optional[int]
    next: Optional[int]
    prev: Optional[int]

class CollectionList(TypedDict):
    """Collections."""

    collections: List[Collection]
    matched: Optional[int]
    next: Optional[int]
    prev: Optional[int]

fixed

  • hide map element in HTML pages when collections/items do not have spatial component (#132)

  • exclude/include tables and functions (#130)

changed

  • split endpoints registration for more customization

    # before
class OGCFeaturesFactory(EndpointsFactory):

    def register_routes(self):
        @self.router.get("/collections", ...)
        @self.router.get("/collections/{collectionId}", ...)
        ...

# now
class OGCFeaturesFactory(EndpointsFactory):

    def register_routes(self):
        self._collections_route()
        self._collection_route()
        self._queryables_route()
        self._items_route()
        self._item_route()

    def _collections_route(self):
        @self.router.get("/collections", ...)

    ...

  • Collection.features() method now returns an ItemList dict

    #before
collection = Collection()
features_collection, matched = collection.features(...)

#now
collection = Collection()
items_list = collection.features(...)
print(items_list["matched"])  # Number of matched items for the query
print(items_list["next"])  # Next Offset
print(items_list["prev"])  # Previous Offset

  • rename catalog_dependency attribute to collections_dependency

  • move the collections_dependency attribute from the EndpointsFactory to OGCFeaturesFactory class

  • move /collections QueryParameters in the CollectionsParams dependency

  • rename CatalogParams to CollectionsParams

  • the CollectionsParams now returns a CollectionList object

  • move s_intersects and t_intersects functions from tipg.factory to tipg.dependencies

0.4.4 - 2023-10-03

fixed

  • replace string_to_table(...) by unnest(string_to_array(...)) to support Postgres<14

changed

  • update pydantic minimum version to >=2.4

0.4.3 - 2023-08-28

fixed

  • forward catalog_dependency in OGCFeaturesFactory and OGCTilesFactory when using Endpoints factory
  • allow Factory's prefix with path parameter
  • changed database_url type in PostgresSettings to always be of pydantic.PostgresDsn type
  • postgres_port type in PostgresSettings to be of integer type
  • remove additional / prefix for dbname when constructing the database url from individual parameters

changed

  • changed function_parameters_query and properties_filter_query from dependencies to simple callabe

0.4.2 - 2023-08-24

changed

  • replace stamen basemap by OSM in tiles viewer

fixed

  • limit option is less than or equal to to the MAX_FEATURES_PER_QUERY configuration (instead of less than)

0.4.1 - 2023-08-04

Fixed

  • set custom_sql_directory in CustomSQLSettings to None to ensure it can be properly optional

0.4.0 - 2023-08-01

Changed

  • update requirement to switch to pydantic~=2.0

    • morecantile>=5.0,<6.0
    • pydantic~=2.0
    • pydantic-settings~=2.0
    • geojson-pydantic>=1.0,<2.0
    • fastapi>=0.100

  • move ResponseType, QueryablesResponseType, ItemsResponseType, ItemResponseType, VectorResponseType, VectorType and FilterLang from tipg.enums to tipg.dependencies and use Literal instead of Enum

  • add func attribute to CatalogUpdateMiddleware to allow custom Catalog Update function

    # Before
app.add_middleware(
    CatalogUpdateMiddleware,
    ttl=300,
)

# Now
app.add_middleware(
    CatalogUpdateMiddleware,
    func=register_collection_catalog,
    ttl=300,
)

  • add global variables for conformance classes

Fixed

  • remove usage of pydantic models in /items and /items/{itemId} endpoints to increase performance

0.3.1 - 2023-07-28

Fixed

  • fixed wrong media type option for /queryables endpoint (json instead of `schemajson``)

Added

  • more endpoints in performance benchmarks

0.3.0 - 2023-07-27

Fixed

  • added python-dotenv dependency via pydantic[dotenv]
  • type query parameter to filter collections based on their type (Function or Table)
  • fixed a small bug in the tipg_properties SQL function where the bounds property was not properly transformed to 4326 (author @RemcoMeeuwissen, #87)
  • handling functions that are interpreted as collections but lack parameters (author @jackharrhy, #96)
  • fixed a bug where Numeric/Decimal postgres datatype could not get serialized by orjson. They will now be encoded as string (author @RemcoMeeuwissen, #89)

Added

  • added popups to leaflet maps on items and item page. (author @krishnaglodha & @jackharrhy, #91, #94)
  • catalog_dependency to retrieve the list of collections (defaults to tipg.dependencies.CatalogParams)

Changed

  • pin geojson-pydantic to >=0.4.3,<1.0 to avoid geojson-pydantic breaking changes
  • pin pydantic to ~=1.0

0.2.0 - 2023-06-22

Changed

  • rename tipg.db -> tipg.database

  • rename tipg.dbmodel -> tipg.collections

  • rename tipg.dbmodel.Database -> tipg.collections.Catalog

  • move register_collection_catalog from tipg.dbmodel to tipg.collections

    # before
from tipg.db import close_db_connection, connect_to_db
from tipg.db import register_collection_catalog
from tipg.dbmodel import Database, Collection

# now
from tipg.collections import Catalog, Collection
from tipg.collections import register_collection_catalog
from tipg.database import close_db_connection, connect_to_db

Removed

  • remove useless app.state.db_settings

0.1.0 - 2023-06-15

  • Initial release