Skip to content

Consistently using PathInput and Path in both APIs#34

Merged
forman merged 3 commits into
forman/v0.3.0from
forman/v0.3.0-path_like_also_in_py
Jun 21, 2026
Merged

Consistently using PathInput and Path in both APIs#34
forman merged 3 commits into
forman/v0.3.0from
forman/v0.3.0-path_like_also_in_py

Conversation

@forman

@forman forman commented Jun 20, 2026

Copy link
Copy Markdown
Member

Summary

Renames the public TypeScript path input type from PathLike to PathInput, adds PathSegmentInput, and mirrors the same input-type vocabulary in Python.

Also moves Python path normalization into remotestate.path as public helpers:

  • normalize_path(path: PathInput) -> Path
  • normalize_path_segment(segment: PathSegmentInput) -> PathSegment

Store now uses these public path normalization helpers instead of private PathKey aliases.

Changes

  • Added Python PathInput and PathSegmentInput aliases.
  • Added Python normalize_path() and normalize_path_segment().
  • Replaced Python Store’s private PathKey / PathKeySegment typing with PathInput.
  • Renamed TypeScript PathLike to PathInput.
  • Added TypeScript PathSegmentInput.
  • Updated React hook type annotations and exports.
  • Updated README and CHANGES.md in both packages.
  • Added focused tests for the new public path input names.

Checklists

Python package

  • pixi run format
  • pixi run lint
  • pixi run mypy
  • pixi run tests
  • Updated remotestate-py/CHANGES.md

TypeScript library

  • npm run format
  • npm run checks
  • npm run tests
  • npm run build
  • Updated remotestate-ts/CHANGES.md

Demo app

  • npm run checks
  • npm run build
  • Updated remotestate-demo/CHANGES.md

@forman forman marked this pull request as ready for review June 20, 2026 16:03

@forman forman left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@forman forman merged commit e6c5ce6 into forman/v0.3.0 Jun 21, 2026
6 checks passed
@forman forman deleted the forman/v0.3.0-path_like_also_in_py branch June 21, 2026 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant