pushinbr/pam-core-api

Stable PHP contracts for the Pam persistent runtime.

Maintainers

Package info

github.com/push-in/pam-core-api

Homepage

Issues

pkg:composer/pushinbr/pam-core-api

Transparency log

Statistics

Installs: 98

Dependents: 4

Suggesters: 0

Stars: 0

Security

Advisories: 0

Aikido package health analysis

v1.0.2 2026-08-10 23:21 UTC

Requires

  • php: ^8.4

Apache-2.0 67de4c55b9c0ca6f14c1f61dbd1a575b0b68f48a

phpruntimecontractspam

Published on Packagist.org on 2026-08-11 00:51 UTC

This package is auto-updated.

Last update: 2026-08-11 14:15:22 UTC

README

Small, versioned contracts for packages that extend Pam. It contains the HTTP application and middleware contracts, service providers, stability values and native runtime compatibility checks. It does not contain a router or server.

pam composer require pushinbr/pam-core-api

See PAM's package model.

License

Free and open-source under the Apache License 2.0. You may use, modify, and distribute this package for any purpose, including commercially.

Recommended PAM workflow

Most applications receive this contract package transitively. Extension authors can install it explicitly with pam composer require pushinbr/pam-core-api.

Run pam doctor after dependency changes and before creating a release. The project remains a normal Composer project with a standard manifest, lockfile, PSR-4 autoloading, and vendor/autoload.php.

API guide

Surface Use it for
ApplicationInterface Minimal route, middleware, error, and in-memory handling contract.
MiddlewareInterface Process a request and delegate to the next handler.
RequestHandlerInterface Handle PAM request/response values.
ServiceProviderInterface Register and boot package integrations.
RuntimeCompatibility Discover ABI/capabilities and assert required runtime features.
Stability Represent the documented contract maturity.

This package intentionally contains no router, server, or application implementation. Depend on it when publishing reusable PAM extensions that need stable contracts without forcing pushinbr/pam-api on consumers.

Production checklist

  • Keep request data and mutable state scoped to the current request.
  • Test success, validation failure, exception, cancellation, and timeout paths.
  • Configure explicit limits and avoid unbounded payloads, queues, or retained collections.
  • Run pam doctor, pam test, and the relevant integration suite before release.
  • Validate real dependencies and workload behavior; compatibility is not inferred from package installation alone.

Troubleshooting

  • Class not found: run pam composer install, verify PSR-4 configuration, and rerun pam doctor.
  • Behavior differs over the network: reproduce with PAM's transport integration tests; in-memory execution does not model the socket boundary.
  • A dependency blocks a worker: use PAM-native I/O, a compatible event loop, a process pool, or additional isolated workers.

Documentation and support

Report security vulnerabilities through GitHub private vulnerability reporting or the PAM security policy, not a public issue.