Skip to content

1.0.0

Choose a tag to compare

View all tags
@Jezzatator Jezzatator released this 15 Mar 07:32
· 20 commits to main since this release
1.0.0
7f38671
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🚂 LocomoSwift 1.0.0

A major rewrite bringing GTFS Realtime support, modular imports, configurable data sources with API key authentication, and full DocC documentation.

✨ New Features

GTFS Realtime Support

  • Fetch trip updates, vehicle positions, and service alerts from GTFS-RT protobuf feeds
  • Actor-based RealtimeManager with automatic in-memory caching and configurable TTL per source
  • Protocol-based RealtimeDataSource for testability and future protocol support (SIRI SX)
  • Typed mappers: TripUpdateMapper, VehiclePositionMapper, ServiceAlertMapper
  • Rich models: RealtimeTripUpdate, RealtimeVehiclePosition, RealtimeServiceAlert, and related enums

DataSource Configuration Struct

  • Unified configuration for both GTFS Static and GTFS Realtime: URLs, refresh intervals, cache TTL
  • Built-in presets: .sncfTER, .sncfTGV, .sncfIntercites, .breizhgoTER, .tamMontpellier, .sbb
  • Fully custom sources via DataSource(identifier:displayName:...)
  • staticFeedNeedsRefresh(since:) for staleness checks
  • hasStaticFeed and availableRealtimeFeedTypes computed properties

API Key Authentication (APIAuthentication)

  • .queryParam(name:value:) — appends a query parameter to every request URL
  • .header(name:value:) — adds a custom HTTP header to every request
  • .none — default, no authentication
  • withAuthentication(_:) — create a copy of any preset with your own API key injected
  • Authentication applied automatically to both static downloads and realtime fetches

Modular Package (3 importable products)

  • LocomoSwiftGTFS — GTFS Static only (Feed, DataSource, models)
  • LocomoSwiftRT — GTFS Realtime only (RealtimeManager, mappers, models) — depends on LocomoSwiftGTFS
  • LocomoSwift — Umbrella that re-exports both via @_exported import

Feed + Realtime Integration

  • Feed(from: DataSource) — load static GTFS from a configured source
  • Feed.createRealtimeManager() — convenience to create a manager from a feed
  • Feed.applyRealtimeUpdates(...) — merge realtime data into a static feed
  • Feed.realtimeStatus(for:) — get delay/cancellation status for a trip

🔧 Improvements

  • Swift 6.2 — Package upgraded to swift-tools-version: 6.2
  • Compiler warnings fixed — removed unnecessary #available checks, defer at end of scope, await on sync functions, deprecated init(serializedData:) → init(serializedBytes:)
  • SOLID refactoring — DataSource, RealtimeError extracted into own files; FeedType renamed to RealtimeFeedType; preconditionFailure replaced with throws
  • Error handling — all error messages in English; LSError and RealtimeError conform to LocalizedError
  • URLSession.downloadTaskAsyncCompat — simplified to use native async/await API only (no legacy #available fallbacks)

📖 Documentation

  • Comprehensive DocC catalog for both LocomoSwiftGTFS and LocomoSwiftRT
    • GettingStarted.md — installation, first feed, data access
    • DataSourceConfiguration.md — presets, custom sources, API key auth, refresh intervals
    • FetchingRealtimeData.md — manager creation, fetching, caching, error handling
  • Updated README — reflects 3-module architecture, all presets, auth examples, GTFS support tables
  • GitHub Actions CI — swift-tests.yaml workflow for automated testing

⚠️ Breaking Changes

  • Minimum Swift version: 6.2 (was 5.9)
  • Module split: import LocomoSwift still works (umbrella), but internal types moved to LocomoSwiftGTFS and LocomoSwiftRT
  • DataSource replaces enum-based configuration: sources are now structs, not enum cases
  • RealtimeManager.fetch* methods: no longer have a default source parameter — you must explicitly pass a DataSource
  • FeedType renamed to RealtimeFeedType

📦 Dependencies

Dependency Version
ZIPFoundation 0.9.19
swift-protobuf 1.30.0

Full Changelog: 0.0.9...1.0.0

Assets 2
Loading