Search by

crustum / viator

skiedr

CakePHP Viator generates type-safe TypeScript for routes, entities, forms, enums, Inertia data, broadcasts, and Vite env from your backend

Package info

github.com/Crustum/viator

Type:cakephp-plugin

pkg:composer/crustum/viator

Statistics

Installs: 22

Dependents: 1

Suggesters: 0

Stars: 0

Open Issues: 0

dev-main 2026-11-18 04:00 UTC

This package is not auto-updated.

Last update: 2026-11-19 02:22:45 UTC


README

The Viator plugin bridges your CakePHP backend and TypeScript frontend. It scans CakePHP routes, controller actions, entities, forms, enums, Inertia responses, broadcast definitions, and VITE_* environment variables, then generates fully-typed TypeScript from them.

Viator generates type-safe route functions with parameter validation, named-route helpers, form and entity types, enum constants and unions, Inertia page and shared-data types, broadcast channel builders and event payloads, and typed import.meta.env declarations. Generation runs through the viator routes command over a single Scrutator/Investigator walk, with per-section skip flags and an analysis cache for repeat runs.

Requirements

  • PHP 8.4+

Optional installer support is listed under Composer suggest.

See Versions.md for the supported CakePHP versions.

Documentation

For documentation, as well as tutorials, see the docs directory of this repository.

License

Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.