Data model

Every UIKit list, its key fields, relationships, and status values.

The model registry is features/keystone/models/index.ts.

AreaLists
People and rolesUser, Role
Studio identityBrandSettings
CatalogKitProduct, DesignSystem, DesignToken
ReleasesComponentRelease, ComponentFile, ComponentValidation, ReviewWorkflow, ChangelogEntry, PackageExport
Quality and docsAccessibilityAudit, CompatibilityTarget, Screenshot, UsageExample, IntegrationRecipe
CommerceOrder, OrderItem, Payment, PaymentEvent, PaymentProvider, PaymentSession, Refund
AccessKitAccess, RegistryApiKey
RecordsAuditEvent, OutboxEvent, RequestRateLimit

Catalog and releases

  • KitProduct: name, slug, code, kitKey, description, registryType, accessType, price (minor units), currencyCode, isVisible, isActive, sortOrder, metadata (tagline, audience, preview fields, dependencies, install command, license name, seats, usage). Belongs to a designSystem; has orderItems and kitAccesses.
  • ComponentRelease: name, version (semantic version), status, product, releaseNotes, publishedAt, publishedBy, fileCount, isBreaking, authoringPrompt, authoringContext, draftRevision.
  • ComponentFile: path, target, fileType (ui, block, component, hook, lib, page, file, theme, style, test, story, doc), language, content, sourceHash, sizeBytes, release. Hash and size are computed on save.
  • ComponentValidation: validationKey, release, draftRevision, status, validatorVersion, checksJson, filesJson, dependenciesJson, diffJson, screenshotsJson, resourceUsageJson, sandboxJson (isolation evidence), log, validatedBy, startedAt, completedAt.
  • ReviewWorkflow: title, release, reviewer, status, checklistJson, decisionNotes, decidedAt.
  • DesignSystem: name, slug, namespace, description, homepage, status (draft, active, archived), isDefault, with products and tokens.
  • DesignToken: code, name, tokenType (color, typography, spacing, radius, shadow, motion, breakpoint, other), mode (base, light, dark), value, description, isPublic.
  • AccessibilityAudit: title, release, status, wcagLevel, violationsCount, summary, auditedAt.
  • CompatibilityTarget: name, targetType, minimumVersion, supportStatus, release, notes.
  • UsageExample: title, slug, exampleType, code, release, product, isFeatured. IntegrationRecipe: title, slug, framework, summary, installCommand, codeSample, product.

Commerce and access

  • Order: displayId, status, email, currencyCode, subtotal, total, providerCode, user, with items, payments, paymentEvents, paymentSessions, kitAccesses.
  • Payment: status, amount, amountRefunded, currencyCode, providerCode, data, capturedAt, canceledAt, idempotencyKey, order, user.
  • Refund: idempotencyKey, status, amount, currencyCode, providerCode, providerRefundId, reason, payloadHash, requestedById, processedAt, order, payment.
  • PaymentProvider: name, code, isInstalled, credentials, and six function fields (createPaymentFunction, capturePaymentFunction, refundPaymentFunction, getPaymentStatusFunction, generatePaymentLinkFunction, handleWebhookFunction).
  • KitAccess: kitKey, status, source, grantedAt, notes, user, product, order, payment.
  • RegistryApiKey: name, prefix, tokenHash (SHA-256), status, scope, lastUsedAt, revokedAt, user.
  • AuditEvent: eventKey, action, resourceType, resourceId, outcome, actorId, actorEmail, occurredAt, metadata. OutboxEvent: eventKey, topic, aggregateType, aggregateId, status, payload, attempts, availableAt, processedAt, lastError.
  • BrandSettings: name, mark, hue, logo icon and color, tagline, description, email, website, copyright name.

Status values

FieldValues
ComponentRelease.statusdraft, review, stable, deprecated. Only draft to review, review to stable, stable to deprecated are allowed.
ReviewWorkflow.statusrequested, in_review, approved, changes_requested
Order.statuspending, awaiting_payment, paid, failed, cancelled, refunded
Payment.statuspending, authorized, captured, failed, canceled, refunded
Refund.statuspending, succeeded, failed
KitAccess.status / sourceactive, revoked / free, purchase, admin
RegistryApiKey.status / scopeactive, revoked / registry_read
OutboxEvent.statuspending, processed, failed

On this page