This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works
DatabaseAdapter, StorageAdapter and AuthProvider are in packages/cms-core
Holds
A caller that read the document at revision N can pass expectedRevision: N to updateDocDraft/publishDoc/unpublishDoc (and VersionService.restoreVersion);
VersionService has restoreVersion
Holds
Email System: Ports & adapters pattern — cms-core defines the EmailAdapter interface (send(), optional sendBatch()), with Nodemailer and Resend implementations in separate packages.
EmailAdapter is a contract
Holds
Running it — one seam, three modes.runJobsBatch(services, opts) (jobs/run-batch.ts) is the single place the handler map is assembled (core built-ins → plugin aphex/event/consumer deliveries → plugin aphex/job/handler → app config.jobs.handlers, last wins) and one tick runs: relay first, then execute (so a just-published doc's consumers can fire the same tick).
runJobsBatch is in packages/cms-core/src/lib/jobs
Holds
Emitting & subscribing. Events are typed via defineEvent(type, zodSchema) (events/catalog.ts);
defineEvent is in packages/cms-core/src/lib/events
Holds
Built-in document.published is emitted by the shared emitDocumentPublished helper (events/emit.ts) on every publish path — versioned or not, from the admin UI, Local API, REST, GraphQL, MCP, or a scheduled job — because all publishes bottom out at collection-api.
emitDocumentPublished is in packages/cms-core/src/lib/events
Reserved field names — the boot-time trap. A document already has its own columns, and a schema field that shadows one is rejected when the engine initializes (validateSchemaReferences, packages/cms-core/src/lib/schema-utils/validator.ts): id, type, status, organizationId, createdBy, updatedBy, createdAt, updatedAt, publishedAt, draftData, publishedData, publishedHash.
validateSchemaReferences is in packages/cms-core/src/lib/schema-utils
Holds
Email System: Ports & adapters pattern — cms-core defines the EmailAdapter interface (send(), optional sendBatch()), with Nodemailer and Resend implementations in separate packages.
3 rules from this sentence
EmailAdapter is a contract
checks “EmailAdapter interface”
Holds
EmailAdapter has a send method
checks “cms-core defines the EmailAdapter interface (send(), optional sendBatch()), with Nodemailer and Resend implementations in separate packages.”
Holds
EmailAdapter has a sendBatch method
checks “cms-core defines the EmailAdapter interface (send(), optional sendBatch()), with Nodemailer and Resend implementations in separate packages.”
Holds
BaseField.access narrows reads and writes at the individual field level.
BaseField has access
Holds
Before running the handler, the route (or PermissionChecker) calls hasCapability(auth, '…') for the operation it's about to perform. On failure → 403.
PermissionChecker depends on hasCapability
Holdslocal-api → types
AIProviderAdapter is a port, exactly like DatabaseAdapter and StorageAdapter: cms-core owns the provider-neutral contract, and the concrete client (credentials, wire format, streaming parse) lives in its own package.
2 rules from this sentence
AIProviderAdapter is in packages/cms-core
checks “cms-core owns the provider-neutral contract”
Holds
AIProviderAdapter is a contract
checks “AIProviderAdapter is a port”
Holds
Option href, Type string, Default —, Description Target path Rendered as a real anchor, so cmd-click and middle-click work
SidebarNavItem has href
Holds
Option label, Type string, Default —, Description Item text, and its tooltip when the sidebar is collapsed
SidebarNavItem has label
Holds
Option icon, Type Component<IconProps>, Default —, Description Any Lucide icon component
SidebarNavItem has icon
Holds
Option newTab, Type boolean, Default false, Description Open in a new tab, and never mark the item active
SidebarNavItem has newTab
Holds
AIProviderAdapter is a port, same as database and storage.
AIProviderAdapter is a contract
Holds
Initializes the AssetService with the storage adapter.
AssetService depends on StorageAdapter
Holdsservices → storage
The full set of options for find: Option where, Type Where, Default -, Description Filter conditions
FindOptions has where
Holds
Option limit, Type number, Default 50, Description Max results per page
FindOptions has limit
Holds
Option offset, Type number, Default 0, Description Number of results to skip
FindOptions has offset
Holds
Option sort, Type string , Default string[], Description -
FindOptions has sort
Holds
Option depth, Type number, Default 0, Description Reference resolution depth
FindOptions has depth
Holds
Property name, Type string, Required Yes, Description Field identifier
SlugField has a name field
Holds
Property title, Type string, Required Yes, Description Label shown in the admin UI
SlugField has title
Holds
Property description, Type string, Required No, Description Help text shown below the label
SlugField has description
Holds
Property source, Type string, Required No, Description Name of the field to generate the slug from Defaults to 'title'
Property validation, Type (Rule) => Rule, Required No, Description Validation rules
SlugField has validation
Holds
The type definition also includes a maxLength property.
SlugField has maxLength
Holds
getPreviewPerspective(locals.auth, url) is still exported if you'd rather resolve it inline in a one-off load.
getPreviewPerspective is exported
Holds
The adapter implements the optional parts of StorageAdapter that make the two heavier paths work: getSignedUploadUrl — lets large uploads go browser-to-bucket, skipping the request-size ceiling on your platform.
S3StorageAdapter has getSignedUploadUrl
Holds
For exact TypeScript signatures, read SchemaType and Field from @aphexcms/cms-core.
2 rules from this sentence
SchemaType is in packages/cms-core
Holds
Field is in packages/cms-core
Holds
For exact TypeScript signatures, read SchemaType and Field from @aphexcms/cms-core.