Contracts and edge cases

Platform spec article

Contracts and edge cases

Back to Template packages ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (3)

1. 0001-explicit-package-kind Explicit packageKind Accepted

   Explicit packageKind

   Context

   Registry taxonomy.

   Decision

   Explicit packageKind on beskid.package.v1.

   Consequences

   pckg validators.

   Verification anchors

   Validator tests.

   Open full ADR page

2. 0002-template-registry-ui-mode Template UI mode Accepted

   Template UI mode

   Context

   Registry taxonomy.

   Decision

   Template pages hide API docs.

   Consequences

   pckg validators.

   Verification anchors

   Validator tests.

   Open full ADR page

3. 0003-no-api-json-for-templates No api.json Accepted

   No api.json

   Context

   Registry taxonomy.

   Decision

   template kind must not require api.json.

   Consequences

   pckg validators.

   Verification anchors

   Validator tests.

   Open full ADR page

Articles

• Contracts and edge cases Publish-time and UI rules for template packages on pckg. article Standard Reviewed Thu May 21
• Design model `packageKind`, `.bpk` layout, and pckg registry presentation for template packages. article Standard Reviewed Thu May 21
• Verification and traceability Server and CLI tests for template package profile. article Standard Reviewed Thu May 21

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 10 SpecSection(s) · 0 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  Template packages

  Parent feature hub

Purpose and scope

Registry validator and UI MUST rules.

Publish validation

ID	Rule
PK-T01	When packageKind is template, validator must not require .beskid/docs/api.json.
PK-T02	Validator must require .beskid/template.json with schema: beskid.template.v1.
PK-T03	Project.proj must be present and should declare type: Template for author packages.
PK-T04	package.json id must match Project.proj name (same rule as libraries).
PK-T05	Versioning, checksum, forbidden paths, and yank semantics must match library packages.

Registry UI

ID	Rule
PK-U01	Package detail for template must not render API documentation components.
PK-U02	Search and catalog may filter by packageKind.
PK-U03	Dashboard publish flows must allow selecting template projects for pack.

Edge cases

• Upload library .bpk to template-only route — reject if packageKind mismatch when enforced server-side.
• Template package with documentation.apiJson in package.json — strip at publish or reject as invalid for template profile.
• Yanked template: catalog shows yank; beskid new warns per project templates contracts.