Skip to content
Capell CMS

Capell Extension Cookbook

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

FieldValue
Composer packagecapell-app/extension-cookbook
Package slugextension-cookbook
Product groupCapell Foundation
Tierfree
Bundlefoundation
Runtime contextsadmin, frontend, shared
Capell version^1.0
Catalogue roleextension
Release channelBeta
Source repositorycapell-app/packages
Source pathpackages/extension-cookbook
Docs sourcepackages/extension-cookbook/docs
Manifestcapell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Capell Extension Cookbook is an Available, Schema-owning Capell package in the Capell Foundation product group. It ships as capell-app/extension-cookbook and extends these surfaces: admin, frontend, shared.

Extension Cookbook is a free, runnable package of small examples for Capell’s released Core, Admin, Frontend, lifecycle, data, health, and content-graph contracts; experimental seams are called out as follow-up gaps.

Package authors can install one maintained example, follow each contribution from manifest to provider, and copy the focused test that proves its behaviour.

Status details:

  • Status: Available
  • Tier: free
  • Bundle: foundation
  • Composer package: capell-app/extension-cookbook
  • Namespace: Capell\ExtensionCookbook
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: The contribution map traces each demonstrated seam to its owning class, registration path and focused regression test; deliberately inactive seams are labelled instead of being implied.

For teams: The cookbook is MIT-licensed and free to install, so teams can evaluate extension patterns without adopting a commercial feature package or copying undocumented internals.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Capell Extension Cookbook developer reference package card

  • Capell Extension Cookbook in the admin extension catalogue (admin, supplementary evidence).
  • Extension Cookbook widget in Layout Builder (admin, supplementary evidence).
  • Public Capell Extension Cookbook route (frontend, supplementary evidence).

Technical Shape

Section titled “Technical Shape”

Service providers

Section titled “Service providers”
  • Capell\ExtensionCookbook\Providers\ExtensionCookbookServiceProvider
  • Capell\ExtensionCookbook\Providers\AdminServiceProvider
  • Capell\ExtensionCookbook\Providers\FrontendServiceProvider

Config files

Section titled “Config files”
  • packages/extension-cookbook/config/extension-cookbook.php

Migrations

Section titled “Migrations”
  • packages/extension-cookbook/database/migrations/2026_08_29_000001_create_extension_cookbook_entries.php
  • packages/extension-cookbook/database/migrations/2026_08_29_000002_scope_extension_cookbook_entry_slugs.php

Settings migrations

Section titled “Settings migrations”
  • packages/extension-cookbook/database/settings/2026_08_29_000001_add_extension_cookbook_settings.php

Settings classes

Section titled “Settings classes”
  • ExtensionCookbookSettings

Models

Section titled “Models”
  • ReferenceEntry

Filament classes

Section titled “Filament classes”
  • ExtensionCookbookConfigurator
  • ExtensionCookbookAdminActionExtender
  • ExtensionCookbookPageSchemaExtender
  • ExtensionCookbookPage
  • ListReferenceEntries
  • ReferenceEntryResource
  • ExtensionCookbookSettingsSchema
  • ExtensionCookbookDashboardWidget
  • ExtensionCookbookOverviewStat

Route files

Section titled “Route files”
  • packages/extension-cookbook/routes/web.php

Policies

Section titled “Policies”
  • ReferenceEntryPolicy

Events

Section titled “Events”
  • ReferenceEntryPublished

Listeners

Section titled “Listeners”
  • ReferenceEntrySubscriber

Actions

Section titled “Actions”
  • AfterInstallExtensionCookbookPackageAction
  • CreateReferenceEntryAction
  • EnsureExtensionCookbookExampleAction
  • InstallExtensionCookbookPackageAction
  • ReadReferenceEntriesAction
  • SetupExtensionCookbookPackageAction
  • UninstallExtensionCookbookPackageAction

Data objects

Section titled “Data objects”
  • ReferenceEntryData
  • ReferenceEntryPublishedPayloadData

Jobs

Section titled “Jobs”
  • AuditExtensionCookbookHealthJob

Command signatures

Section titled “Command signatures”
  • capell:extension-cookbook-doctor

Manifest action API

Section titled “Manifest action API”
  • afterInstall: Capell\ExtensionCookbook\Actions\AfterInstallExtensionCookbookPackageAction
  • install: Capell\ExtensionCookbook\Actions\InstallExtensionCookbookPackageAction
  • setup: Capell\ExtensionCookbook\Actions\SetupExtensionCookbookPackageAction
  • uninstall: Capell\ExtensionCookbook\Actions\UninstallExtensionCookbookPackageAction

Scheduled commands

Section titled “Scheduled commands”
  • Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookScheduledJobContribution (manifest declared)

Console command classes

Section titled “Console command classes”
  • ExtensionCookbookDoctorCommand

Manifest contributions

Section titled “Manifest contributions”
  • admin-action-extender: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookAdminActionExtenderContribution
  • admin-page: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookAdminPageContribution
  • admin-resource: Capell\ExtensionCookbook\Manifest\Admin\ReferenceEntryResourceContribution
  • agent-capability: Capell\ExtensionCookbook\Manifest\Core\ExtensionCookbookAgentCapabilityContribution
  • asset: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookAssetContribution
  • blueprint-subject: Capell\ExtensionCookbook\Manifest\Core\ExtensionCookbookBlueprintSubjectContribution
  • configurator: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookConfiguratorContribution
  • console-command: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookConsoleCommandsContribution
  • content-graph: Capell\ExtensionCookbook\ContentGraph\ReferenceEntryContentGraphExtractor
  • content-widget: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookContentWidgetContribution
  • dashboard-widget: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookDashboardWidgetContribution
  • dashboard-widget: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookOverviewStatContribution
  • frontend-component: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookFrontendComponentContribution
  • health-check: Capell\ExtensionCookbook\Health\ExtensionCookbookHealthCheck
  • migration: Capell\ExtensionCookbook\Manifest\Core\ExtensionCookbookMigrationContribution
  • model: Capell\ExtensionCookbook\Manifest\Core\ReferenceEntryModelContribution
  • outbound-event: Capell\ExtensionCookbook\Manifest\Core\ExtensionCookbookOutboundEventContribution
  • page-type: Capell\ExtensionCookbook\Manifest\Core\ExtensionCookbookPageTypeContribution
  • page-variation: Capell\ExtensionCookbook\Manifest\Core\ExtensionCookbookPageVariationContribution
  • permission: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookPermissionsContribution
  • render-hook: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookRenderHookContribution
  • route: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookRoutesContribution
  • scheduled-job: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookScheduledJobContribution
  • schema-extender: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookSchemaExtenderContribution
  • section: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookSectionContribution
  • setting: Capell\ExtensionCookbook\Manifest\Core\ExtensionCookbookSettingContribution
  • workflow-attention: Capell\ExtensionCookbook\Admin\Workflow\ExtensionCookbookWorkflowAttentionContribution

Health checks

Section titled “Health checks”
  • Capell\ExtensionCookbook\Health\ExtensionCookbookHealthCheck

Blade views

Section titled “Blade views”
  • packages/extension-cookbook/resources/views/filament/pages/extension-cookbook.blade.php
  • packages/extension-cookbook/resources/views/filament/widgets/dashboard.blade.php
  • packages/extension-cookbook/resources/views/frontend/index.blade.php
  • packages/extension-cookbook/resources/views/widget/extension-cookbook.blade.php

Cache tags

Section titled “Cache tags”
  • extension-cookbook

Data Model

Section titled “Data Model”
  • Required tables: extension_cookbook_entries.
  • Models: ReferenceEntry.
  • Core record references in migrations: sites via site_id.
  • Migration files: 2026_08_29_000001_create_extension_cookbook_entries.php, 2026_08_29_000002_scope_extension_cookbook_entry_slugs.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/frontend, capell-app/layout-builder.
  • Admin navigation: declares admin-page: ExtensionCookbookAdminPageContribution, admin-resource: ReferenceEntryResourceContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: admin-action-extender: ExtensionCookbookAdminActionExtenderContribution, configurator: ExtensionCookbookConfiguratorContribution, content-widget: ExtensionCookbookContentWidgetContribution, dashboard-widget: ExtensionCookbookDashboardWidgetContribution, dashboard-widget: ExtensionCookbookOverviewStatContribution, schema-extender: ExtensionCookbookSchemaExtenderContribution, workflow-attention: ExtensionCookbookWorkflowAttentionContribution.
  • Permissions: View:ExtensionCookbook, Manage:ExtensionCookbook; permission contributions: Capell\ExtensionCookbook\Manifest\Admin\ExtensionCookbookPermissionsContribution; access also governed by package policies: ReferenceEntryPolicy.
  • Public routes: loads routes/web.php; registers ExtensionCookbookRoutesContribution.
  • Database changes: package migrations are declared.
  • Config: config/extension-cookbook.php.
  • Settings: Capell\ExtensionCookbook\Settings\ExtensionCookbookSettings.
  • Queues or schedules: scheduled commands Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookScheduledJobContribution (manifest declared); queue jobs AuditExtensionCookbookHealthJob.
  • Cache tags: extension-cookbook.
  • Commands: capell:extension-cookbook-doctor.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend, capell-app/layout-builder.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/extension-cookbook.php, Capell\ExtensionCookbook\Settings\ExtensionCookbookSettings.
  • Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
  • Keep the host Laravel scheduler running so package-registered schedules can execute: Capell\ExtensionCookbook\Manifest\Frontend\ExtensionCookbookScheduledJobContribution (manifest declared).
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
  • Custom write integrations must preserve invalidation for extension-cookbook cache tags.

Troubleshooting

Section titled “Troubleshooting”
SymptomLikely causeCheckFix
Package health check reports a problemPackage configuration or runtime dependencies are not readyRun php artisan capell:extension-cookbook-doctorFollow the reported checks, then rerun the doctor command
Package surface is missing after installProvider or manifest is not loadedConfirm capell.json, package composer.json, and provider registrationReinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing tablePackage migrations have not runCheck the tables listed in Data ModelRun host migrations and rerun the focused package test
Route returns unexpected outputRoute cache, middleware, or signed URL setup does not match the package route fileCheck the route files listed in Technical ShapeClear route cache and verify middleware before exposing public routes
Background work does not runQueue worker or declared schedule is not activeCheck the jobs and scheduled commands listed in Technical ShapeStart the queue worker or host scheduler, then run the focused command or package test
Public output leaks unexpected stateRender data, cache variation, or authoring boundary has regressedCheck public Blade, cache tags, and public-output safety testsMove data loading out of Blade and rerun the package public-output tests

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/extension-cookbook.
  2. Open the package admin page or resource and verify Capell Extension Cookbook is available.

Upgrading

Section titled “Upgrading”

No manual steps between minor versions.

Read CHANGELOG.md before upgrading.

Next Steps

Section titled “Next Steps”