pk-shared

module
v0.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2026 License: Apache-2.0

README

pk-shared

Small shared contract package for the OSS PlatformKit repos.

This repo should stay deliberately small. It owns only cross-repo vocabulary that cannot clearly belong to pk-core, pk-design, pk-modules, or pk-apps. If a contract has a natural owner, it should live there instead of becoming ambient shared state.

Current Surface

  • pkg/composition: application, overlay, and topology-cell descriptors used to compose modules, surfaces, catalogs, and infrastructure blueprints
  • pkg/contract: stable identifiers and semantic version vocabulary
  • pkg/flowdef: neutral reusable flow definitions for UI/API coverage, authoring, and E2E/testkit bridges
  • pkg/statemachine: declarative lifecycle definitions, structural validation, traversal helpers, and Mermaid rendering

Verify

make verify
make staticcheck

Directories

Path Synopsis
pkg
composition
Package composition defines provider-neutral PlatformKit application composition descriptors.
Package composition defines provider-neutral PlatformKit application composition descriptors.
contract
Package contract contains tiny shared vocabulary used across PlatformKit OSS repos.
Package contract contains tiny shared vocabulary used across PlatformKit OSS repos.
flowdef
Package flowdef defines neutral, reusable flow contracts.
Package flowdef defines neutral, reusable flow contracts.
statemachine
Package statemachine declares a portable, declarative state machine model.
Package statemachine declares a portable, declarative state machine model.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL