@cosmicdrift/kumiko-framework 0.413.0 → 0.414.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +5 -2
- package/agents/api/framework-db.md +14 -3
- package/agents/api/framework-engine.md +64 -13
- package/agents/api/framework-event-store.md +14 -0
- package/agents/api/framework-ui-types.md +149 -21
- package/agents/api/renderer-web.md +93 -9
- package/agents/api/testing-helpers.md +3 -2
- package/agents/api/testing-stack.md +3 -0
- package/agents/api/types.md +205 -14
- package/agents/api.md +7 -7
- package/agents/boot-rules.md +63 -9
- package/agents/examples/api-docs.md +2 -6
- package/agents/examples/auth-mfa.md +57 -10
- package/agents/examples/chat-channels.md +2 -0
- package/agents/examples/currencies-global.md +1 -0
- package/agents/examples/env-composition.md +7 -11
- package/agents/examples/helpdesk.md +15 -8
- package/agents/examples/managed-pages.md +90 -1
- package/agents/examples/pwa-shell.md +210 -0
- package/agents/examples/rate-limiting.md +3 -3
- package/agents/examples/record-detail-layout.md +1537 -67
- package/agents/examples/workflow-engine.md +16 -12
- package/agents/examples.md +1 -0
- package/agents/features-index.md +4 -2
- package/agents/features.md +22 -7
- package/agents/widgets.md +19 -1
- package/dist/api/api-constants.d.ts +1 -0
- package/dist/api/api-constants.js +4 -0
- package/dist/api/auth-middleware.js +4 -3
- package/dist/api/auth-routes-shared.js +2 -1
- package/dist/api/entity-read-access.d.ts +1 -0
- package/dist/api/entity-read-access.js +18 -0
- package/dist/api/export/export-route.d.ts +6 -1
- package/dist/api/export/export-route.js +27 -1
- package/dist/api/export/export-rows.js +19 -3
- package/dist/api/routes.d.ts +2 -0
- package/dist/api/routes.js +9 -1
- package/dist/api/server-extra-routes.js +2 -1
- package/dist/api/server-feature-http-routes.d.ts +9 -0
- package/dist/api/server-feature-http-routes.js +109 -0
- package/dist/api/server-middleware.js +2 -19
- package/dist/api/server-pat-rate-limit-guard.d.ts +3 -0
- package/dist/api/server-pat-rate-limit-guard.js +19 -0
- package/dist/api/server-rate-limit-wiring.d.ts +10 -0
- package/dist/api/server-rate-limit-wiring.js +37 -0
- package/dist/api/server-routes.d.ts +4 -12
- package/dist/api/server-routes.js +12 -171
- package/dist/api/server-schema-route.d.ts +3 -0
- package/dist/api/server-schema-route.js +58 -0
- package/dist/api/server-wiring.js +2 -37
- package/dist/api/server.js +3 -1
- package/dist/compliance/override-schema.js +5 -5
- package/dist/compliance/sub-processors.js +10 -1
- package/dist/crypto/index.d.ts +1 -1
- package/dist/crypto/index.js +1 -1
- package/dist/crypto/pii-field-encryption.d.ts +2 -0
- package/dist/crypto/pii-field-encryption.js +16 -1
- package/dist/db/apply-entity-event.js +4 -0
- package/dist/db/bun-sql-connection-codes.d.ts +1 -0
- package/dist/db/bun-sql-connection-codes.js +7 -0
- package/dist/db/collect-table-metas.js +4 -1
- package/dist/db/config-seed.js +1 -1
- package/dist/db/derived-field-sql.js +15 -13
- package/dist/db/derived-related-sql.d.ts +2 -2
- package/dist/db/derived-related-sql.js +4 -2
- package/dist/db/dialect.d.ts +3 -0
- package/dist/db/dialect.js +1 -3
- package/dist/db/driver-row-coercion.js +2 -2
- package/dist/db/driver-value-preparation.js +1 -1
- package/dist/db/eagerload.js +15 -12
- package/dist/db/entity-table-meta.d.ts +2 -0
- package/dist/db/entity-table-meta.js +7 -0
- package/dist/db/event-store-executor-context.js +13 -8
- package/dist/db/event-store-executor-read-aggregate-currencies.js +2 -2
- package/dist/db/event-store-executor-read-aggregate.js +2 -2
- package/dist/db/event-store-executor-read-filter.d.ts +4 -0
- package/dist/db/event-store-executor-read-filter.js +28 -11
- package/dist/db/event-store-executor-read-search.d.ts +1 -0
- package/dist/db/event-store-executor-read-search.js +6 -6
- package/dist/db/event-store-executor-read-sort.js +3 -3
- package/dist/db/event-store-executor-read-where.js +14 -5
- package/dist/db/event-store-executor-read.js +7 -7
- package/dist/db/event-store-executor-write.js +50 -95
- package/dist/db/executor-managed-tables.js +4 -1
- package/dist/db/index.d.ts +4 -2
- package/dist/db/index.js +4 -2
- package/dist/db/known-table-names.d.ts +1 -0
- package/dist/db/known-table-names.js +7 -5
- package/dist/db/list-aggregate-labels.d.ts +1 -0
- package/dist/db/list-aggregate-labels.js +9 -1
- package/dist/db/migrate-generator.js +23 -4
- package/dist/db/migrate-rls-diff.d.ts +1 -0
- package/dist/db/migrate-rls-diff.js +15 -1
- package/dist/db/migrate-runner.js +2 -2
- package/dist/db/money.d.ts +1 -1
- package/dist/db/money.js +1 -4
- package/dist/db/parent-ref-clause.d.ts +6 -2
- package/dist/db/parent-ref-clause.js +76 -23
- package/dist/db/parent-ref-global-hosts.d.ts +20 -0
- package/dist/db/parent-ref-global-hosts.js +47 -0
- package/dist/db/production-schema-command-hint.d.ts +1 -0
- package/dist/db/production-schema-command-hint.js +3 -0
- package/dist/db/queries/backfill-pii.js +55 -29
- package/dist/db/queries/ddl.js +13 -2
- package/dist/db/queries/event-store-open-streams.d.ts +15 -0
- package/dist/db/queries/event-store-open-streams.js +33 -0
- package/dist/db/queries/event-store-payload-scrub.d.ts +5 -0
- package/dist/db/queries/event-store-payload-scrub.js +11 -0
- package/dist/db/queries/event-store.js +0 -1
- package/dist/db/queries/raw-sql.js +0 -1
- package/dist/db/queries/rebuild-rls-guard.d.ts +2 -1
- package/dist/db/queries/rebuild-rls-guard.js +24 -11
- package/dist/db/queries/rls-boot-catalog.d.ts +1 -0
- package/dist/db/queries/rls-boot-catalog.js +13 -8
- package/dist/db/queries/rls-shape.d.ts +2 -1
- package/dist/db/queries/rls-shape.js +10 -0
- package/dist/db/queries/session-advisory-lock.js +2 -1
- package/dist/db/queries/test-stack.js +7 -7
- package/dist/db/query.js +16 -11
- package/dist/db/rebuild-marker.js +11 -2
- package/dist/db/render-rls-ddl.d.ts +2 -0
- package/dist/db/render-rls-ddl.js +16 -11
- package/dist/db/replay-migration-sql.js +1 -1
- package/dist/db/row-level-security-boot-check.js +18 -5
- package/dist/db/row-level-security-connection.js +25 -12
- package/dist/db/row-level-security-scope.d.ts +2 -1
- package/dist/db/row-level-security-scope.js +9 -5
- package/dist/db/sql-identifier.d.ts +1 -0
- package/dist/db/sql-identifier.js +3 -0
- package/dist/db/system-tenant-read-db.d.ts +5 -0
- package/dist/db/system-tenant-read-db.js +28 -0
- package/dist/db/table-builder.d.ts +3 -1
- package/dist/db/table-builder.js +18 -8
- package/dist/db/table-info.d.ts +1 -2
- package/dist/db/table-introspection.d.ts +3 -0
- package/dist/db/table-introspection.js +6 -0
- package/dist/db/table-push.d.ts +1 -0
- package/dist/db/table-push.js +7 -1
- package/dist/db/tenant-db-runner.d.ts +3 -0
- package/dist/db/tenant-db-runner.js +19 -1
- package/dist/db/transaction-serialization.d.ts +1 -0
- package/dist/db/transaction-serialization.js +20 -3
- package/dist/db/where-clause.js +11 -2
- package/dist/db/write-ownership-failures.d.ts +25 -0
- package/dist/db/write-ownership-failures.js +82 -0
- package/dist/engine/boot-validator/boot-check.js +7 -1
- package/dist/engine/boot-validator/boot-phases-app.js +5 -5
- package/dist/engine/boot-validator/boot-phases.js +3 -2
- package/dist/engine/boot-validator/boot-rules.d.ts +293 -26
- package/dist/engine/boot-validator/boot-rules.js +4 -0
- package/dist/engine/boot-validator/bundled-lists-table.js +2 -2
- package/dist/engine/boot-validator/card-meta-overflow.js +1 -0
- package/dist/engine/boot-validator/config-deps.d.ts +0 -1
- package/dist/engine/boot-validator/config-deps.js +0 -28
- package/dist/engine/boot-validator/config-key-rules.d.ts +0 -15
- package/dist/engine/boot-validator/config-key-rules.js +0 -15
- package/dist/engine/boot-validator/dashboard-screen-target.d.ts +22 -0
- package/dist/engine/boot-validator/dashboard-screen-target.js +20 -0
- package/dist/engine/boot-validator/dashboard-stat-navigate.d.ts +1 -0
- package/dist/engine/boot-validator/dashboard-stat-navigate.js +25 -17
- package/dist/engine/boot-validator/definition-webhook-events-rules.d.ts +5 -0
- package/dist/engine/boot-validator/definition-webhook-events-rules.js +5 -0
- package/dist/engine/boot-validator/derived-sql-fields.js +1 -2
- package/dist/engine/boot-validator/entity-declaration-rules.d.ts +5 -0
- package/dist/engine/boot-validator/entity-declaration-rules.js +5 -0
- package/dist/engine/boot-validator/entity-list-screens.d.ts +1 -0
- package/dist/engine/boot-validator/entity-list-screens.js +33 -6
- package/dist/engine/boot-validator/entity-structure-rules.d.ts +5 -0
- package/dist/engine/boot-validator/entity-structure-rules.js +5 -0
- package/dist/engine/boot-validator/list-column-layout.js +10 -6
- package/dist/engine/boot-validator/list-row-guidance-rules.d.ts +67 -0
- package/dist/engine/boot-validator/list-row-guidance-rules.js +67 -0
- package/dist/engine/boot-validator/list-row-guidance.d.ts +20 -0
- package/dist/engine/boot-validator/list-row-guidance.js +129 -0
- package/dist/engine/boot-validator/list-sort-summary-rules.d.ts +42 -0
- package/dist/engine/boot-validator/list-sort-summary-rules.js +42 -0
- package/dist/engine/boot-validator/list-sort-summary.d.ts +5 -0
- package/dist/engine/boot-validator/list-sort-summary.js +149 -0
- package/dist/engine/boot-validator/list-table-options.js +15 -1
- package/dist/engine/boot-validator/list-table-rules.d.ts +10 -5
- package/dist/engine/boot-validator/list-table-rules.js +10 -5
- package/dist/engine/boot-validator/list-toolbar-options.d.ts +10 -0
- package/dist/engine/boot-validator/list-toolbar-options.js +31 -0
- package/dist/engine/boot-validator/named-filter-rules.d.ts +32 -2
- package/dist/engine/boot-validator/named-filter-rules.js +32 -2
- package/dist/engine/boot-validator/ownership.js +10 -1
- package/dist/engine/boot-validator/parent-ref.js +87 -50
- package/dist/engine/boot-validator/projection-list-screens.d.ts +1 -0
- package/dist/engine/boot-validator/projection-list-screens.js +31 -1
- package/dist/engine/boot-validator/query-output-columns.js +62 -9
- package/dist/engine/boot-validator/query-output-guidance.d.ts +7 -0
- package/dist/engine/boot-validator/query-output-guidance.js +39 -0
- package/dist/engine/boot-validator/query-refs.js +24 -1
- package/dist/engine/boot-validator/row-decoration.d.ts +11 -0
- package/dist/engine/boot-validator/row-decoration.js +16 -0
- package/dist/engine/boot-validator/screens-dashboard-links.d.ts +10 -0
- package/dist/engine/boot-validator/screens-dashboard-links.js +36 -0
- package/dist/engine/boot-validator/screens-dashboard-narrow.d.ts +4 -0
- package/dist/engine/boot-validator/screens-dashboard-narrow.js +211 -0
- package/dist/engine/boot-validator/screens-dashboard-rules.d.ts +84 -4
- package/dist/engine/boot-validator/screens-dashboard-rules.js +84 -4
- package/dist/engine/boot-validator/screens-dashboard.js +29 -7
- package/dist/engine/boot-validator/screens-kind-entity-list.js +32 -27
- package/dist/engine/boot-validator/screens-kind-projection-detail-guidance.d.ts +3 -0
- package/dist/engine/boot-validator/screens-kind-projection-detail-guidance.js +46 -0
- package/dist/engine/boot-validator/screens-kind-projection-detail-rules.d.ts +20 -0
- package/dist/engine/boot-validator/screens-kind-projection-detail-rules.js +20 -0
- package/dist/engine/boot-validator/screens-kind-projection-detail.js +2 -0
- package/dist/engine/boot-validator/screens-kind-projection-list.js +4 -0
- package/dist/engine/boot-validator/screens-kind-rules.d.ts +25 -0
- package/dist/engine/boot-validator/screens-kind-rules.js +25 -0
- package/dist/engine/boot-validator/screens-lists.d.ts +8 -2
- package/dist/engine/boot-validator/screens-lists.js +19 -3
- package/dist/engine/boot-validator/screens.js +1 -1
- package/dist/engine/boot-validator/sort-nulls.d.ts +2 -0
- package/dist/engine/boot-validator/sort-nulls.js +15 -0
- package/dist/engine/boot-validator/zod-shape.d.ts +2 -1
- package/dist/engine/boot-validator/zod-shape.js +19 -1
- package/dist/engine/build-app-schema.js +4 -0
- package/dist/engine/config-helpers.d.ts +1 -2
- package/dist/engine/config-helpers.js +6 -7
- package/dist/engine/define-feature.js +1 -0
- package/dist/engine/define-handler.d.ts +1 -0
- package/dist/engine/define-handler.js +4 -2
- package/dist/engine/definition-violations.js +2 -2
- package/dist/engine/entity-handlers.js +3 -8
- package/dist/engine/entity-list-runtime-options.js +9 -8
- package/dist/engine/factories.d.ts +2 -0
- package/dist/engine/feature-config-events-jobs.js +1 -0
- package/dist/engine/feature-entity-handlers.js +5 -2
- package/dist/engine/field-access.d.ts +1 -1
- package/dist/engine/field-access.js +7 -10
- package/dist/engine/find-entity.js +3 -3
- package/dist/engine/form-derivations.js +3 -3
- package/dist/engine/index.d.ts +3 -3
- package/dist/engine/index.js +2 -2
- package/dist/engine/named-filter-roles.d.ts +3 -0
- package/dist/engine/named-filter-roles.js +23 -0
- package/dist/engine/pipeline.js +0 -1
- package/dist/engine/project-app-schema-for-roles.js +17 -2
- package/dist/engine/qualified-name.js +0 -1
- package/dist/engine/registry-facade.js +1 -2
- package/dist/engine/registry-state.d.ts +1 -1
- package/dist/engine/registry-state.js +5 -2
- package/dist/engine/registry-validate.d.ts +1 -0
- package/dist/engine/registry-validate.js +9 -1
- package/dist/engine/registry.js +2 -1
- package/dist/engine/resolve-named-list-filters.js +5 -2
- package/dist/engine/schema-builder.js +6 -10
- package/dist/engine/screen-helpers.d.ts +12 -0
- package/dist/engine/screen-helpers.js +17 -1
- package/dist/engine/soft-delete-cleanup.js +5 -8
- package/dist/engine/state-machine.js +0 -1
- package/dist/engine/steps/_database-clock.d.ts +2 -0
- package/dist/engine/steps/_database-clock.js +6 -0
- package/dist/engine/steps/compute.js +1 -1
- package/dist/engine/steps/retry.js +5 -1
- package/dist/engine/steps/return.js +0 -1
- package/dist/engine/steps/wait-for-event.js +2 -1
- package/dist/engine/steps/wait.js +2 -1
- package/dist/engine/system-user.d.ts +2 -2
- package/dist/engine/system-user.js +2 -2
- package/dist/engine/types/handlers.d.ts +1 -1
- package/dist/engine/types/handlers.js +1 -1
- package/dist/engine/types/screen.d.ts +1 -1
- package/dist/engine/types/screen.js +1 -1
- package/dist/engine/webhook-contracts.d.ts +2 -3
- package/dist/engine/webhook-contracts.js +2 -25
- package/dist/engine/webhook-events.js +48 -29
- package/dist/engine/webhook-payload-strictness.d.ts +7 -0
- package/dist/engine/webhook-payload-strictness.js +53 -0
- package/dist/env/_zod-introspect.d.ts +1 -0
- package/dist/env/dry-run.d.ts +1 -1
- package/dist/env/dry-run.js +1 -1
- package/dist/env/field-meta.d.ts +4 -0
- package/dist/env/field-meta.js +67 -0
- package/dist/env/field-rules.d.ts +9 -0
- package/dist/env/field-rules.js +46 -0
- package/dist/env/index.d.ts +3 -3
- package/dist/env/index.js +16 -71
- package/dist/env/internals.d.ts +3 -0
- package/dist/env/internals.js +1 -2
- package/dist/env/required-env.d.ts +3 -1
- package/dist/env/required-env.js +5 -2
- package/dist/errors/serialize.js +2 -2
- package/dist/errors/write-error-info.js +0 -2
- package/dist/es-ops/operations-schema.js +18 -7
- package/dist/event-store/admin-api.js +3 -3
- package/dist/event-store/event-store.js +0 -3
- package/dist/event-store/index.d.ts +1 -0
- package/dist/event-store/index.js +1 -0
- package/dist/event-store/transfer.js +1 -1
- package/dist/files/assert-file-refs-belong-to-tenant.d.ts +2 -1
- package/dist/files/assert-file-refs-belong-to-tenant.js +15 -13
- package/dist/files/bind-pending-file-refs.d.ts +3 -1
- package/dist/files/bind-pending-file-refs.js +54 -27
- package/dist/files/copy-pending-file-refs-to-tenant.js +7 -3
- package/dist/files/create-file-ref.d.ts +4 -1
- package/dist/files/create-file-ref.js +14 -3
- package/dist/files/default-file-guard.js +4 -1
- package/dist/files/feature.js +1 -0
- package/dist/files/file-claim.d.ts +6 -0
- package/dist/files/file-claim.js +17 -0
- package/dist/files/file-field-slots.d.ts +2 -0
- package/dist/files/file-field-slots.js +28 -0
- package/dist/files/file-ref-entity.d.ts +3 -0
- package/dist/files/file-ref-entity.js +2 -0
- package/dist/files/file-ref-table.d.ts +3 -0
- package/dist/files/file-routes.d.ts +4 -1
- package/dist/files/file-routes.js +80 -16
- package/dist/files/in-memory-provider.d.ts +1 -1
- package/dist/files/in-memory-provider.js +2 -1
- package/dist/files/index.d.ts +1 -1
- package/dist/files/index.js +1 -1
- package/dist/files/invalid-file-ref-error.d.ts +2 -0
- package/dist/files/invalid-file-ref-error.js +15 -0
- package/dist/files/local-provider.js +9 -2
- package/dist/files/provider-resolver.js +1 -1
- package/dist/files/rebind-file-ref.d.ts +3 -2
- package/dist/files/rebind-file-ref.js +24 -18
- package/dist/files/resolve-file-handles.d.ts +13 -0
- package/dist/files/resolve-file-handles.js +57 -0
- package/dist/files/storage-tracking.d.ts +1 -1
- package/dist/files/storage-tracking.js +5 -2
- package/dist/files/sweep-stale-pending-file-refs.js +10 -4
- package/dist/files/types.d.ts +4 -0
- package/dist/files/types.js +10 -0
- package/dist/files/upload-field-resolution.d.ts +1 -0
- package/dist/files/upload-field-resolution.js +16 -2
- package/dist/files/upload-ledger.js +1 -1
- package/dist/i18n/required-surface-guidance-keys.d.ts +3 -0
- package/dist/i18n/required-surface-guidance-keys.js +9 -0
- package/dist/i18n/required-surface-keys.js +19 -4
- package/dist/internal/boot-rule-table-expectations.d.ts +2 -0
- package/dist/internal/boot-rule-table-expectations.js +29 -0
- package/dist/internal/row-level-security.d.ts +1 -0
- package/dist/internal/row-level-security.js +1 -0
- package/dist/internal/testing.d.ts +1 -0
- package/dist/internal/testing.js +1 -0
- package/dist/jobs/index.d.ts +1 -0
- package/dist/jobs/index.js +1 -0
- package/dist/jobs/job-load-events.d.ts +10 -0
- package/dist/jobs/job-load-events.js +12 -0
- package/dist/jobs/job-runner-context.js +6 -158
- package/dist/jobs/job-runner-dispatch.d.ts +7 -0
- package/dist/jobs/job-runner-dispatch.js +57 -0
- package/dist/jobs/job-runner-event-triggers.js +18 -9
- package/dist/jobs/job-runner-execution.js +2 -2
- package/dist/jobs/job-runner-facets.d.ts +48 -0
- package/dist/jobs/job-runner-facets.js +156 -0
- package/dist/jobs/job-runner-gates.js +24 -12
- package/dist/jobs/job-runner-helpers.d.ts +5 -1
- package/dist/jobs/job-runner-helpers.js +18 -3
- package/dist/jobs/job-runner-scope.d.ts +1 -0
- package/dist/jobs/job-runner-scope.js +2 -0
- package/dist/jobs/job-runner-tenant-cap-lock.d.ts +2 -0
- package/dist/jobs/job-runner-tenant-cap-lock.js +30 -0
- package/dist/jobs/job-runner.js +31 -70
- package/dist/jobs/obliterate-job-queues.d.ts +6 -0
- package/dist/jobs/obliterate-job-queues.js +23 -0
- package/dist/lifecycle/lifecycle.js +1 -1
- package/dist/migrations/event-header-scrub.d.ts +11 -0
- package/dist/migrations/event-header-scrub.js +33 -0
- package/dist/migrations/event-payload-scrub.d.ts +1 -1
- package/dist/migrations/event-payload-scrub.js +36 -4
- package/dist/migrations/index.d.ts +1 -0
- package/dist/migrations/index.js +2 -0
- package/dist/migrations/kumiko-drift.d.ts +5 -2
- package/dist/migrations/kumiko-drift.js +51 -14
- package/dist/migrations/pending-rebuilds.js +4 -5
- package/dist/observability/sensitive-filter.js +0 -12
- package/dist/pipeline/aggregate-type-removal.js +17 -4
- package/dist/pipeline/context-services.d.ts +2 -0
- package/dist/pipeline/context-services.js +5 -2
- package/dist/pipeline/dispatch-batch.js +4 -3
- package/dist/pipeline/dispatch-context-helpers.d.ts +11 -0
- package/dist/pipeline/dispatch-context-helpers.js +58 -0
- package/dist/pipeline/dispatch-nested-write.d.ts +7 -0
- package/dist/pipeline/dispatch-nested-write.js +119 -0
- package/dist/pipeline/dispatch-query.js +10 -3
- package/dist/pipeline/dispatch-scope.js +4 -3
- package/dist/pipeline/dispatch-shared.d.ts +2 -6
- package/dist/pipeline/dispatch-shared.js +6 -38
- package/dist/pipeline/dispatch-write.d.ts +0 -1
- package/dist/pipeline/dispatch-write.js +3 -302
- package/dist/pipeline/dispatcher-utils.js +6 -0
- package/dist/pipeline/effective-system-scope.d.ts +3 -0
- package/dist/pipeline/effective-system-scope.js +22 -0
- package/dist/pipeline/event-dispatcher-delivery.d.ts +1 -0
- package/dist/pipeline/event-dispatcher-delivery.js +17 -9
- package/dist/pipeline/event-dispatcher.d.ts +4 -1
- package/dist/pipeline/event-dispatcher.js +6 -7
- package/dist/pipeline/handler-context-auth.d.ts +3 -2
- package/dist/pipeline/handler-context-auth.js +3 -4
- package/dist/pipeline/handler-context-db.js +11 -4
- package/dist/pipeline/handler-context-dispatch.js +2 -2
- package/dist/pipeline/handler-context-events.d.ts +8 -3
- package/dist/pipeline/handler-context-events.js +20 -65
- package/dist/pipeline/handler-context-member-resolution.js +16 -8
- package/dist/pipeline/handler-context-notify.d.ts +1 -0
- package/dist/pipeline/handler-context-notify.js +2 -0
- package/dist/pipeline/handler-context-phase-denials.js +3 -2
- package/dist/pipeline/handler-context-projection.d.ts +3 -0
- package/dist/pipeline/handler-context-projection.js +39 -0
- package/dist/pipeline/handler-context-scope.d.ts +1 -1
- package/dist/pipeline/handler-context-scope.js +14 -2
- package/dist/pipeline/index.d.ts +1 -1
- package/dist/pipeline/index.js +1 -1
- package/dist/pipeline/lifecycle-pipeline.d.ts +1 -0
- package/dist/pipeline/lifecycle-pipeline.js +7 -4
- package/dist/pipeline/member-reader.js +4 -2
- package/dist/pipeline/msp-rebuild.js +1 -1
- package/dist/pipeline/nested-write-parent-guard.d.ts +5 -0
- package/dist/pipeline/nested-write-parent-guard.js +81 -0
- package/dist/pipeline/projection-rebuild.d.ts +2 -0
- package/dist/pipeline/projection-rebuild.js +16 -7
- package/dist/pipeline/projection-state.js +4 -6
- package/dist/pipeline/system-hooks.js +36 -6
- package/dist/pipeline/write-result-masking.js +31 -3
- package/dist/pipeline/write-transition-guard.d.ts +7 -0
- package/dist/pipeline/write-transition-guard.js +95 -0
- package/dist/schema-cli/shared.d.ts +2 -0
- package/dist/schema-cli/shared.js +4 -2
- package/dist/schema-cli/validate-command.js +43 -28
- package/dist/search/meilisearch-adapter.js +14 -9
- package/dist/search/reindex-entity.d.ts +2 -0
- package/dist/search/reindex-entity.js +32 -4
- package/dist/search/reindex-tenants-search.js +20 -4
- package/dist/time/tz-context.js +1 -1
- package/dist/ui-types/card-column-roles.d.ts +4 -0
- package/dist/ui-types/card-column-roles.js +6 -3
- package/dist/ui-types/index.d.ts +2 -2
- package/dist/ui-types/index.js +1 -1
- package/dist/utils/ids.js +0 -1
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.js +1 -0
- package/dist/utils/return-path-limit.d.ts +1 -0
- package/dist/utils/return-path-limit.js +1 -0
- package/package.json +5 -3
- package/presets/biome-app.json +39 -21
- package/presets/biome-plugins/admin-api.grit +10 -0
- package/presets/biome-plugins/error-reasons.grit +53 -0
- package/presets/biome-plugins/es-literal-writes-tests.grit +18 -0
- package/presets/biome-plugins/es-literal-writes.grit +22 -0
- package/presets/biome-plugins/i18n-locale-terminology-de.grit +15 -0
- package/presets/biome-plugins/i18n-locale-terminology-romance.grit +10 -0
- package/presets/biome-plugins/no-create-test-dispatcher.grit +5 -0
- package/presets/biome-plugins/no-css-properties-type.grit +7 -0
- package/presets/biome-plugins/no-date-api.grit +9 -0
- package/presets/biome-plugins/no-direct-fetch.grit +16 -0
- package/presets/biome-plugins/no-direct-fs.grit +16 -0
- package/presets/biome-plugins/no-external-font-cdn-css.grit +9 -0
- package/presets/biome-plugins/no-external-font-cdn.grit +12 -0
- package/presets/biome-plugins/no-raw-hooks.grit +10 -0
- package/presets/biome-plugins/no-same-folder-barrel-import.grit +11 -0
- package/presets/biome-plugins/no-screen-container-classes.grit +7 -0
- package/presets/biome-plugins/no-skipped-or-retried-tests.grit +34 -0
- package/presets/biome-plugins/no-temporal-polyfill-require.grit +10 -0
- package/presets/biome-plugins/raw-html-in-web.grit +40 -0
- package/presets/biome-plugins/raw-ui-in-app.grit +142 -0
- package/presets/biome-plugins/restricted-event-store-symbols.grit +18 -0
- package/presets/biome-plugins/test-title.grit +20 -0
- package/presets/biome-plugins/unsafe-json-parse.grit +6 -0
- package/presets/biome-rules.json +465 -0
- package/src/changes.json +309 -0
- package/dist/engine/minor-units.d.ts +0 -2
- package/dist/engine/minor-units.js +0 -8
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { isDeepStrictEqual } from "node:util";
|
|
2
2
|
import { toKebab } from "../qualified-name.js";
|
|
3
3
|
import { bootRuleError } from "./boot-rule.js";
|
|
4
|
+
import { declaredNamedFilterIds, resolveDashboardScreenTarget, } from "./dashboard-screen-target.js";
|
|
4
5
|
import { NAMED_FILTER_RULES } from "./named-filter-rules.js";
|
|
5
|
-
import {
|
|
6
|
+
import { DASHBOARD_RULES } from "./screens-dashboard-rules.js";
|
|
6
7
|
function entityListQueryName(feature, screen) {
|
|
7
8
|
return `${toKebab(feature.name)}:query:${toKebab(screen.entity)}:list`;
|
|
8
9
|
}
|
|
@@ -11,31 +12,38 @@ function listQueryOf(target) {
|
|
|
11
12
|
? entityListQueryName(target.feature, target.screen)
|
|
12
13
|
: target.screen.query;
|
|
13
14
|
}
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
return { qn };
|
|
24
|
-
if (screen.type !== "entityList" && screen.type !== "projectionList")
|
|
25
|
-
return { qn };
|
|
26
|
-
return { feature, screen };
|
|
15
|
+
// `where` names the option holding the params ("... stat "x" navigate", "... footerLink").
|
|
16
|
+
export function validateNavigateParams(where, params) {
|
|
17
|
+
for (const [key, value] of Object.entries(params ?? {})) {
|
|
18
|
+
if (key === "" || typeof value !== "string") {
|
|
19
|
+
throw bootRuleError(DASHBOARD_RULES.statNavigateParamsInvalid, {
|
|
20
|
+
message: `${where} params entry ${JSON.stringify(key)} must have a non-empty key and a string value (got ${JSON.stringify(value)}).`,
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
}
|
|
27
24
|
}
|
|
28
25
|
function validateStatNavigate(context, featureName, stat, featureMap) {
|
|
29
26
|
const navigate = stat.navigate;
|
|
30
27
|
// skip: stat has no navigate target to validate
|
|
31
28
|
if (navigate === undefined)
|
|
32
29
|
return;
|
|
33
|
-
|
|
34
|
-
|
|
30
|
+
validateNavigateParams(`${context} navigate`, navigate.params);
|
|
31
|
+
const resolved = resolveDashboardScreenTarget(featureName, navigate.screen, featureMap);
|
|
32
|
+
if (resolved.kind === "unresolved" || resolved.kind === "other") {
|
|
35
33
|
throw bootRuleError(NAMED_FILTER_RULES.statNavigateTarget, {
|
|
36
|
-
message: `${context} navigate.screen "${navigate.screen}" does not resolve to a registered entityList or
|
|
34
|
+
message: `${context} navigate.screen "${navigate.screen}" does not resolve to a registered entityList, projectionList or custom screen (checked "${resolved.qn}").`,
|
|
37
35
|
});
|
|
38
36
|
}
|
|
37
|
+
if (resolved.kind === "custom") {
|
|
38
|
+
// A custom screen has no list query to count with, so the tile keeps its own query.
|
|
39
|
+
if (navigate.namedFilter !== undefined) {
|
|
40
|
+
throw bootRuleError(DASHBOARD_RULES.statNavigateCustomWithFilter, {
|
|
41
|
+
message: `${context} navigate.screen "${resolved.screenId}" is a custom screen, which has no namedFilters. Remove navigate.namedFilter.`,
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
const target = resolved.target;
|
|
39
47
|
if (navigate.namedFilter !== undefined &&
|
|
40
48
|
!declaredNamedFilterIds(target).has(navigate.namedFilter)) {
|
|
41
49
|
throw bootRuleError(NAMED_FILTER_RULES.statNavigateFilterDeclared, {
|
|
@@ -14,6 +14,11 @@ export declare const DEFINITION_WEBHOOK_EVENT_RULES: {
|
|
|
14
14
|
readonly summary: "Webhook event payloads are Zod object schemas.";
|
|
15
15
|
readonly fix: "Pass z.object({ ... }) as payload.";
|
|
16
16
|
};
|
|
17
|
+
readonly payloadOpenShape: {
|
|
18
|
+
readonly id: "webhook-event/payload-open-shape";
|
|
19
|
+
readonly summary: "Webhook event payload objects are closed; undeclared keys must be stripped.";
|
|
20
|
+
readonly fix: "Replace looseObject/passthrough/catchall with z.object({ ... }) and declare every field.";
|
|
21
|
+
};
|
|
17
22
|
readonly versionInvalid: {
|
|
18
23
|
readonly id: "webhook-event/version-invalid";
|
|
19
24
|
readonly summary: "Webhook event version is a positive integer.";
|
|
@@ -14,6 +14,11 @@ export const DEFINITION_WEBHOOK_EVENT_RULES = {
|
|
|
14
14
|
summary: "Webhook event payloads are Zod object schemas.",
|
|
15
15
|
fix: "Pass z.object({ ... }) as payload.",
|
|
16
16
|
},
|
|
17
|
+
payloadOpenShape: {
|
|
18
|
+
id: "webhook-event/payload-open-shape",
|
|
19
|
+
summary: "Webhook event payload objects are closed; undeclared keys must be stripped.",
|
|
20
|
+
fix: "Replace looseObject/passthrough/catchall with z.object({ ... }) and declare every field.",
|
|
21
|
+
},
|
|
17
22
|
versionInvalid: {
|
|
18
23
|
id: "webhook-event/version-invalid",
|
|
19
24
|
summary: "Webhook event version is a positive integer.",
|
|
@@ -14,7 +14,6 @@ const VALUE_TYPE_OF_FIELD_TYPE = {
|
|
|
14
14
|
tz: "text",
|
|
15
15
|
reference: "text",
|
|
16
16
|
number: "number",
|
|
17
|
-
bigInt: "number",
|
|
18
17
|
decimal: "decimal",
|
|
19
18
|
boolean: "boolean",
|
|
20
19
|
date: "date",
|
|
@@ -34,7 +33,7 @@ function requireUsableField(site, entity, field, role) {
|
|
|
34
33
|
}
|
|
35
34
|
if (valueTypeOfField(entity, field) === undefined) {
|
|
36
35
|
throw bootRuleError(DERIVED_SQL_FIELD_RULES.unsupportedFieldType, {
|
|
37
|
-
message: `${site.where}: ${role} "${field}" has type "${entity.fields[field]?.type}", which a SQL derived field cannot read (compound types are not supported; money only as the measure of a related first).`,
|
|
36
|
+
message: `${site.where}: ${role} "${field}" has type "${entity.fields[field]?.type}", which a SQL derived field cannot read (compound types and bigInt are not supported, as a bigInt loses precision above 2^53 as a number; money only as the measure of a related first).`,
|
|
38
37
|
});
|
|
39
38
|
}
|
|
40
39
|
if (holdsCiphertextOrSecret(entity, field)) {
|
|
@@ -24,6 +24,11 @@ export declare const ENTITY_DECLARATION_RULES: {
|
|
|
24
24
|
readonly summary: "Query handlers on an entity with parentRef carry the entity-convention brand, so the parent-ref read-gate applies.";
|
|
25
25
|
readonly fix: "Register the handler via defineEntityListHandler/defineEntityDetailHandler, or pass parentVisibility to the executor.";
|
|
26
26
|
};
|
|
27
|
+
readonly parentRefHandWrittenWrite: {
|
|
28
|
+
readonly id: "parent-ref/hand-written-write-handler";
|
|
29
|
+
readonly summary: "Update/delete/restore handlers on an entity with parentRef carry the entity-convention brand, so the parent visibility gate applies.";
|
|
30
|
+
readonly fix: "Register the handler via defineEntityWriteHandler, or pass parentVisibility: parentVisibilityFor(ctx, event.user) to the executor.";
|
|
31
|
+
};
|
|
27
32
|
readonly readGateWithParentRef: {
|
|
28
33
|
readonly id: "read-gate/with-parent-ref";
|
|
29
34
|
readonly summary: "An entity with readGate does not also declare parentRef.";
|
|
@@ -24,6 +24,11 @@ export const ENTITY_DECLARATION_RULES = {
|
|
|
24
24
|
summary: "Query handlers on an entity with parentRef carry the entity-convention brand, so the parent-ref read-gate applies.",
|
|
25
25
|
fix: "Register the handler via defineEntityListHandler/defineEntityDetailHandler, or pass parentVisibility to the executor.",
|
|
26
26
|
},
|
|
27
|
+
parentRefHandWrittenWrite: {
|
|
28
|
+
id: "parent-ref/hand-written-write-handler",
|
|
29
|
+
summary: "Update/delete/restore handlers on an entity with parentRef carry the entity-convention brand, so the parent visibility gate applies.",
|
|
30
|
+
fix: "Register the handler via defineEntityWriteHandler, or pass parentVisibility: parentVisibilityFor(ctx, event.user) to the executor.",
|
|
31
|
+
},
|
|
27
32
|
readGateWithParentRef: {
|
|
28
33
|
id: "read-gate/with-parent-ref",
|
|
29
34
|
summary: "An entity with readGate does not also declare parentRef.",
|
|
@@ -2,4 +2,5 @@ import type { FeatureDefinition } from "../types/index.ts";
|
|
|
2
2
|
/** Operator lists default searchable; low-cardinality audit trails stay opt-out. */
|
|
3
3
|
export declare const SEARCHABLE_FALSE_WHITELIST: Set<string>;
|
|
4
4
|
export declare const LIST_ROW_META_COLUMN_NAMES: Set<string>;
|
|
5
|
+
export declare function hasFilterableFields(feature: FeatureDefinition, entityName: string): boolean;
|
|
5
6
|
export declare function validateEntityListScreens(features: readonly FeatureDefinition[]): void;
|
|
@@ -4,6 +4,8 @@ import { collectBootRuleViolations } from "./boot-report.js";
|
|
|
4
4
|
import { bootRuleError } from "./boot-rule.js";
|
|
5
5
|
import { isSortableSqlDerivedField } from "./derived-sql-fields.js";
|
|
6
6
|
import { ENTITY_LIST_RULES } from "./entity-list-screens-rules.js";
|
|
7
|
+
import { LIST_SORT_SUMMARY_RULES } from "./list-sort-summary-rules.js";
|
|
8
|
+
import { NAMED_FILTER_RULES } from "./named-filter-rules.js";
|
|
7
9
|
/** Operator lists default searchable; low-cardinality audit trails stay opt-out. */
|
|
8
10
|
export const SEARCHABLE_FALSE_WHITELIST = new Set(["download-attempt-list", "cap-list"]);
|
|
9
11
|
// Same set computeListViewModel (headless) can actually render — NOT
|
|
@@ -12,7 +14,7 @@ export const SEARCHABLE_FALSE_WHITELIST = new Set(["download-attempt-list", "cap
|
|
|
12
14
|
// softDelete column pass the boot gate and then throw at render-time
|
|
13
15
|
// because the renderer's LIST_ROW_META_COLUMNS doesn't know them.
|
|
14
16
|
export const LIST_ROW_META_COLUMN_NAMES = new Set(Object.keys(LIST_ROW_META_COLUMNS));
|
|
15
|
-
function hasFilterableFields(feature, entityName) {
|
|
17
|
+
export function hasFilterableFields(feature, entityName) {
|
|
16
18
|
const entities = feature.entities;
|
|
17
19
|
if (!entities)
|
|
18
20
|
return false;
|
|
@@ -47,12 +49,35 @@ function checkDefaultSortColumn(feature, screen) {
|
|
|
47
49
|
// skip: a missing defaultSort is reported by checkDefaultSortRequired
|
|
48
50
|
if (screen.defaultSort === undefined)
|
|
49
51
|
return;
|
|
52
|
+
checkSortSpecColumn(feature, screen, "defaultSort", screen.defaultSort.field, {
|
|
53
|
+
notListed: ENTITY_LIST_RULES.defaultSortNotListed,
|
|
54
|
+
notSortable: ENTITY_LIST_RULES.defaultSortNotSortable,
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
function checkNamedFilterSortColumns(feature, screen) {
|
|
58
|
+
for (const ref of screen.namedFilters ?? []) {
|
|
59
|
+
if (ref.sort === undefined)
|
|
60
|
+
continue;
|
|
61
|
+
checkSortSpecColumn(feature, screen, `namedFilters "${ref.id}" sort`, ref.sort.field, {
|
|
62
|
+
notListed: NAMED_FILTER_RULES.filterSortNotListed,
|
|
63
|
+
notSortable: NAMED_FILTER_RULES.filterSortNotSortable,
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
function checkSortOptionColumns(feature, screen) {
|
|
68
|
+
for (const option of screen.sortOptions ?? []) {
|
|
69
|
+
checkSortSpecColumn(feature, screen, `sortOptions "${option.label}"`, option.field, {
|
|
70
|
+
notListed: LIST_SORT_SUMMARY_RULES.sortOptionNotSortable,
|
|
71
|
+
notSortable: LIST_SORT_SUMMARY_RULES.sortOptionNotSortable,
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
function checkSortSpecColumn(feature, screen, label, sortField, rules) {
|
|
50
76
|
const prefix = screenPrefix(feature, screen);
|
|
51
|
-
const sortField = screen.defaultSort.field;
|
|
52
77
|
const col = screen.columns.find((c) => normalizeListColumn(c).field === sortField);
|
|
53
78
|
if (col === undefined) {
|
|
54
|
-
throw bootRuleError(
|
|
55
|
-
message: `${prefix}:
|
|
79
|
+
throw bootRuleError(rules.notListed, {
|
|
80
|
+
message: `${prefix}: ${label}.field "${sortField}" is not a listed column. Pick a field from columns or add it there.`,
|
|
56
81
|
});
|
|
57
82
|
}
|
|
58
83
|
const entityDef = feature.entities?.[screen.entity];
|
|
@@ -60,8 +85,8 @@ function checkDefaultSortColumn(feature, screen) {
|
|
|
60
85
|
const isSortable = (entityDef !== undefined && isSortableSqlDerivedField(entityDef, sortField)) ||
|
|
61
86
|
(fieldDef !== undefined && "sortable" in fieldDef && fieldDef.sortable === true);
|
|
62
87
|
if (!isSortable) {
|
|
63
|
-
throw bootRuleError(
|
|
64
|
-
message: `${prefix}:
|
|
88
|
+
throw bootRuleError(rules.notSortable, {
|
|
89
|
+
message: `${prefix}: ${label} column "${sortField}" must be sortable`,
|
|
65
90
|
});
|
|
66
91
|
}
|
|
67
92
|
}
|
|
@@ -110,6 +135,8 @@ const ENTITY_LIST_CHECKS = [
|
|
|
110
135
|
checkSearchable,
|
|
111
136
|
checkDefaultSortRequired,
|
|
112
137
|
checkDefaultSortColumn,
|
|
138
|
+
checkNamedFilterSortColumns,
|
|
139
|
+
checkSortOptionColumns,
|
|
113
140
|
checkDetailNavigate,
|
|
114
141
|
checkColumns,
|
|
115
142
|
checkNamedFilters,
|
|
@@ -49,6 +49,11 @@ export declare const ENTITY_STRUCTURE_RULES: {
|
|
|
49
49
|
readonly summary: "An encrypted text field is not sortable.";
|
|
50
50
|
readonly fix: "Drop sortable: true or remove the encryption.";
|
|
51
51
|
};
|
|
52
|
+
readonly sortNullsNeedsSortable: {
|
|
53
|
+
readonly id: "entity/sort-nulls-needs-sortable";
|
|
54
|
+
readonly summary: "A field with sortNulls is sortable.";
|
|
55
|
+
readonly fix: "Add sortable: true or drop sortNulls.";
|
|
56
|
+
};
|
|
52
57
|
readonly encryptedFilterable: {
|
|
53
58
|
readonly id: "entity/encrypted-filterable";
|
|
54
59
|
readonly summary: "An encrypted text field is not filterable.";
|
|
@@ -49,6 +49,11 @@ export const ENTITY_STRUCTURE_RULES = {
|
|
|
49
49
|
summary: "An encrypted text field is not sortable.",
|
|
50
50
|
fix: "Drop sortable: true or remove the encryption.",
|
|
51
51
|
},
|
|
52
|
+
sortNullsNeedsSortable: {
|
|
53
|
+
id: "entity/sort-nulls-needs-sortable",
|
|
54
|
+
summary: "A field with sortNulls is sortable.",
|
|
55
|
+
fix: "Add sortable: true or drop sortNulls.",
|
|
56
|
+
},
|
|
52
57
|
encryptedFilterable: {
|
|
53
58
|
id: "entity/encrypted-filterable",
|
|
54
59
|
summary: "An encrypted text field is not filterable.",
|
|
@@ -1,16 +1,20 @@
|
|
|
1
|
+
import { LIST_COLUMN_MAX_WIDTH_PX } from "@cosmicdrift/kumiko-types/screen";
|
|
1
2
|
import { isOneOf } from "@cosmicdrift/kumiko-types/type-guards";
|
|
2
3
|
import { normalizeListColumn } from "../screen-helpers.js";
|
|
3
4
|
import { LIST_COLUMN_PINS } from "../types/screen.js";
|
|
4
5
|
import { bootRuleError } from "./boot-rule.js";
|
|
5
6
|
import { LIST_TABLE_RULES } from "./list-table-rules.js";
|
|
6
|
-
function
|
|
7
|
-
return typeof value === "number" &&
|
|
7
|
+
function isPixelWidth(value) {
|
|
8
|
+
return (typeof value === "number" &&
|
|
9
|
+
Number.isFinite(value) &&
|
|
10
|
+
value > 0 &&
|
|
11
|
+
value <= LIST_COLUMN_MAX_WIDTH_PX);
|
|
8
12
|
}
|
|
9
13
|
function validatePixelWidth(where, field, key, value) {
|
|
10
|
-
if (!
|
|
14
|
+
if (!isPixelWidth(value)) {
|
|
11
15
|
throw bootRuleError(LIST_TABLE_RULES.columnWidthInvalid, {
|
|
12
16
|
message: `${where} column "${field}" has ${key} ${JSON.stringify(value)} — ` +
|
|
13
|
-
`must be a finite number of pixels greater than 0.`,
|
|
17
|
+
`must be a finite number of pixels greater than 0 and at most ${LIST_COLUMN_MAX_WIDTH_PX}.`,
|
|
14
18
|
});
|
|
15
19
|
}
|
|
16
20
|
}
|
|
@@ -36,10 +40,10 @@ export function validateColumnLayout(where, flags, columns) {
|
|
|
36
40
|
if (value === undefined)
|
|
37
41
|
continue;
|
|
38
42
|
validatePixelWidth(where, col.field, key, value);
|
|
39
|
-
if (!flags.resizing) {
|
|
43
|
+
if (!flags.resizing && col.hint === undefined) {
|
|
40
44
|
throw bootRuleError(LIST_TABLE_RULES.columnWidthWithoutResizing, {
|
|
41
45
|
message: `${where} column "${col.field}" sets ${key} but table.resizing is not enabled, ` +
|
|
42
|
-
`so it would have no effect. Set table: { resizing: true } or remove "${key}".`,
|
|
46
|
+
`so it would have no effect (only a hint column sizes itself). Set table: { resizing: true } or remove "${key}".`,
|
|
43
47
|
});
|
|
44
48
|
}
|
|
45
49
|
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
export declare const LIST_ROW_GUIDANCE_RULES: {
|
|
2
|
+
readonly hintColumnRenderer: {
|
|
3
|
+
readonly id: "list/hint-column-renderer";
|
|
4
|
+
readonly summary: "A hint column owns its cell rendering and sets no renderer.";
|
|
5
|
+
readonly fix: "Remove renderer or hint from the column.";
|
|
6
|
+
};
|
|
7
|
+
readonly hintColumnDisplay: {
|
|
8
|
+
readonly id: "list/hint-column-display";
|
|
9
|
+
readonly summary: "A hint column owns its cell rendering and sets no display.";
|
|
10
|
+
readonly fix: "Remove display or hint from the column.";
|
|
11
|
+
};
|
|
12
|
+
readonly hintColumnLink: {
|
|
13
|
+
readonly id: "list/hint-column-link";
|
|
14
|
+
readonly summary: "A hint column owns its cell rendering and sets no linkScreenField, linkParamsField, refEntity or badgeToneField.";
|
|
15
|
+
readonly fix: "Remove the link or badge option, or move the hint to its own column.";
|
|
16
|
+
};
|
|
17
|
+
readonly hintColumnEmptyPlaceholder: {
|
|
18
|
+
readonly id: "list/hint-column-empty-placeholder";
|
|
19
|
+
readonly summary: "A hint column shows hint.emptyLabel for an empty value and sets no emptyPlaceholder.";
|
|
20
|
+
readonly fix: "Remove emptyPlaceholder, or name the empty sentence with hint.emptyLabel.";
|
|
21
|
+
};
|
|
22
|
+
readonly buttonColumnWithoutLink: {
|
|
23
|
+
readonly id: "list/button-column-without-link";
|
|
24
|
+
readonly summary: 'A column with display "button" has a link (linkScreenField or refEntity) to draw as the button.';
|
|
25
|
+
readonly fix: 'Set linkScreenField or refEntity on the column, or remove display: "button".';
|
|
26
|
+
};
|
|
27
|
+
readonly buttonColumnInListTable: {
|
|
28
|
+
readonly id: "list/button-column-in-list-table";
|
|
29
|
+
readonly summary: 'display "button" is drawn only in dashboard list panels; entityList and projectionList tables (RenderList) keep a row button as a rowAction.';
|
|
30
|
+
readonly fix: 'Declare the button as a rowAction with display: "button" or remove display: "button" from the column.';
|
|
31
|
+
};
|
|
32
|
+
readonly narrowOnlyConflict: {
|
|
33
|
+
readonly id: "list/narrow-only-conflict";
|
|
34
|
+
readonly summary: "A showOnNarrowOnly column sets none of hideOnNarrow: true, hidden: true or pinned.";
|
|
35
|
+
readonly fix: "Remove the conflicting option or showOnNarrowOnly.";
|
|
36
|
+
};
|
|
37
|
+
readonly narrowDetailFieldWithoutDetailField: {
|
|
38
|
+
readonly id: "list/narrow-detail-field-without-detail-field";
|
|
39
|
+
readonly summary: "hint.narrowDetailField replaces hint.detailField below sm, so it needs detailField.";
|
|
40
|
+
readonly fix: "Set hint.detailField or remove narrowDetailField.";
|
|
41
|
+
};
|
|
42
|
+
readonly reasonOptionWithoutReasonField: {
|
|
43
|
+
readonly id: "list/reason-option-without-reason-field";
|
|
44
|
+
readonly summary: "hint.reasonOpenField and hint.reasonTitleField shape the reason text, so they need reasonField.";
|
|
45
|
+
readonly fix: "Set hint.reasonField or remove reasonOpenField and reasonTitleField.";
|
|
46
|
+
};
|
|
47
|
+
readonly linkParamsWithoutScreenField: {
|
|
48
|
+
readonly id: "list/link-params-without-screen-field";
|
|
49
|
+
readonly summary: "linkParamsField only parametrizes the linkScreenField target.";
|
|
50
|
+
readonly fix: "Set linkScreenField on the column or remove linkParamsField.";
|
|
51
|
+
};
|
|
52
|
+
readonly guidanceFieldEmpty: {
|
|
53
|
+
readonly id: "list/guidance-field-empty";
|
|
54
|
+
readonly summary: "rowToneField, linkParamsField and the hint field names are non-empty strings.";
|
|
55
|
+
readonly fix: "Name a row field or remove the option.";
|
|
56
|
+
};
|
|
57
|
+
readonly rowDecorationQueryEmpty: {
|
|
58
|
+
readonly id: "list/row-decoration-query-empty";
|
|
59
|
+
readonly summary: "rowDecoration.query is a non-empty query QN.";
|
|
60
|
+
readonly fix: "Name the decoration query or remove rowDecoration.";
|
|
61
|
+
};
|
|
62
|
+
readonly rowDecorationIdsMissing: {
|
|
63
|
+
readonly id: "list/row-decoration-ids-missing";
|
|
64
|
+
readonly summary: "The rowDecoration query's input schema declares `ids`, the row ids the list sends with every call.";
|
|
65
|
+
readonly fix: "Add `ids: z.array(z.string())` to the decoration query's schema.";
|
|
66
|
+
};
|
|
67
|
+
};
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
export const LIST_ROW_GUIDANCE_RULES = {
|
|
2
|
+
hintColumnRenderer: {
|
|
3
|
+
id: "list/hint-column-renderer",
|
|
4
|
+
summary: "A hint column owns its cell rendering and sets no renderer.",
|
|
5
|
+
fix: "Remove renderer or hint from the column.",
|
|
6
|
+
},
|
|
7
|
+
hintColumnDisplay: {
|
|
8
|
+
id: "list/hint-column-display",
|
|
9
|
+
summary: "A hint column owns its cell rendering and sets no display.",
|
|
10
|
+
fix: "Remove display or hint from the column.",
|
|
11
|
+
},
|
|
12
|
+
hintColumnLink: {
|
|
13
|
+
id: "list/hint-column-link",
|
|
14
|
+
summary: "A hint column owns its cell rendering and sets no linkScreenField, linkParamsField, refEntity or badgeToneField.",
|
|
15
|
+
fix: "Remove the link or badge option, or move the hint to its own column.",
|
|
16
|
+
},
|
|
17
|
+
hintColumnEmptyPlaceholder: {
|
|
18
|
+
id: "list/hint-column-empty-placeholder",
|
|
19
|
+
summary: "A hint column shows hint.emptyLabel for an empty value and sets no emptyPlaceholder.",
|
|
20
|
+
fix: "Remove emptyPlaceholder, or name the empty sentence with hint.emptyLabel.",
|
|
21
|
+
},
|
|
22
|
+
buttonColumnWithoutLink: {
|
|
23
|
+
id: "list/button-column-without-link",
|
|
24
|
+
summary: 'A column with display "button" has a link (linkScreenField or refEntity) to draw as the button.',
|
|
25
|
+
fix: 'Set linkScreenField or refEntity on the column, or remove display: "button".',
|
|
26
|
+
},
|
|
27
|
+
buttonColumnInListTable: {
|
|
28
|
+
id: "list/button-column-in-list-table",
|
|
29
|
+
summary: 'display "button" is drawn only in dashboard list panels; entityList and projectionList tables (RenderList) keep a row button as a rowAction.',
|
|
30
|
+
fix: 'Declare the button as a rowAction with display: "button" or remove display: "button" from the column.',
|
|
31
|
+
},
|
|
32
|
+
narrowOnlyConflict: {
|
|
33
|
+
id: "list/narrow-only-conflict",
|
|
34
|
+
summary: "A showOnNarrowOnly column sets none of hideOnNarrow: true, hidden: true or pinned.",
|
|
35
|
+
fix: "Remove the conflicting option or showOnNarrowOnly.",
|
|
36
|
+
},
|
|
37
|
+
narrowDetailFieldWithoutDetailField: {
|
|
38
|
+
id: "list/narrow-detail-field-without-detail-field",
|
|
39
|
+
summary: "hint.narrowDetailField replaces hint.detailField below sm, so it needs detailField.",
|
|
40
|
+
fix: "Set hint.detailField or remove narrowDetailField.",
|
|
41
|
+
},
|
|
42
|
+
reasonOptionWithoutReasonField: {
|
|
43
|
+
id: "list/reason-option-without-reason-field",
|
|
44
|
+
summary: "hint.reasonOpenField and hint.reasonTitleField shape the reason text, so they need reasonField.",
|
|
45
|
+
fix: "Set hint.reasonField or remove reasonOpenField and reasonTitleField.",
|
|
46
|
+
},
|
|
47
|
+
linkParamsWithoutScreenField: {
|
|
48
|
+
id: "list/link-params-without-screen-field",
|
|
49
|
+
summary: "linkParamsField only parametrizes the linkScreenField target.",
|
|
50
|
+
fix: "Set linkScreenField on the column or remove linkParamsField.",
|
|
51
|
+
},
|
|
52
|
+
guidanceFieldEmpty: {
|
|
53
|
+
id: "list/guidance-field-empty",
|
|
54
|
+
summary: "rowToneField, linkParamsField and the hint field names are non-empty strings.",
|
|
55
|
+
fix: "Name a row field or remove the option.",
|
|
56
|
+
},
|
|
57
|
+
rowDecorationQueryEmpty: {
|
|
58
|
+
id: "list/row-decoration-query-empty",
|
|
59
|
+
summary: "rowDecoration.query is a non-empty query QN.",
|
|
60
|
+
fix: "Name the decoration query or remove rowDecoration.",
|
|
61
|
+
},
|
|
62
|
+
rowDecorationIdsMissing: {
|
|
63
|
+
id: "list/row-decoration-ids-missing",
|
|
64
|
+
summary: "The rowDecoration query's input schema declares `ids`, the row ids the list sends with every call.",
|
|
65
|
+
fix: "Add `ids: z.array(z.string())` to the decoration query's schema.",
|
|
66
|
+
},
|
|
67
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { NamedFilterFacetOptions, NamedListFilterRef } from "@cosmicdrift/kumiko-types/named-list-filters";
|
|
2
|
+
import type { ListColumnSpec } from "../types/screen.ts";
|
|
3
|
+
import { type RowDecorationFields } from "./row-decoration.ts";
|
|
4
|
+
type RowGuidanceScreen = {
|
|
5
|
+
readonly columns: readonly ListColumnSpec[];
|
|
6
|
+
readonly namedFilters?: readonly NamedListFilterRef[];
|
|
7
|
+
readonly namedFilterFacet?: NamedFilterFacetOptions;
|
|
8
|
+
readonly rowToneField?: string;
|
|
9
|
+
readonly rowDecoration?: {
|
|
10
|
+
readonly query: string;
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export type EntityRowFields = {
|
|
14
|
+
readonly entityName: string;
|
|
15
|
+
readonly fieldNames: ReadonlySet<string>;
|
|
16
|
+
readonly rowDecorationFields?: RowDecorationFields | undefined;
|
|
17
|
+
};
|
|
18
|
+
type GuidanceListKind = "entityList" | "projectionList" | "dashboard" | "relatedList";
|
|
19
|
+
export declare function validateListRowGuidance(featureName: string, screenId: string, kind: GuidanceListKind, screen: RowGuidanceScreen, entityFields?: EntityRowFields, partLabel?: string): void;
|
|
20
|
+
export {};
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import { normalizeListColumn } from "../screen-helpers.js";
|
|
2
|
+
import { bootRuleError } from "./boot-rule.js";
|
|
3
|
+
import { LIST_ROW_GUIDANCE_RULES } from "./list-row-guidance-rules.js";
|
|
4
|
+
import { NAMED_FILTER_RULES } from "./named-filter-rules.js";
|
|
5
|
+
import { listGuidanceFieldRefs } from "./query-output-guidance.js";
|
|
6
|
+
import { acceptsRowDecorationField } from "./row-decoration.js";
|
|
7
|
+
import { SCREEN_KIND_RULES } from "./screens-kind-rules.js";
|
|
8
|
+
import { buildUnknownFieldMessage } from "./screens-kind-shared.js";
|
|
9
|
+
// The hint cell draws the column itself; these options would be silently ignored.
|
|
10
|
+
const HINT_CONFLICTS = [
|
|
11
|
+
{ option: "renderer", rule: LIST_ROW_GUIDANCE_RULES.hintColumnRenderer },
|
|
12
|
+
{ option: "display", rule: LIST_ROW_GUIDANCE_RULES.hintColumnDisplay },
|
|
13
|
+
{ option: "linkScreenField", rule: LIST_ROW_GUIDANCE_RULES.hintColumnLink },
|
|
14
|
+
{ option: "linkParamsField", rule: LIST_ROW_GUIDANCE_RULES.hintColumnLink },
|
|
15
|
+
{ option: "refEntity", rule: LIST_ROW_GUIDANCE_RULES.hintColumnLink },
|
|
16
|
+
{ option: "badgeToneField", rule: LIST_ROW_GUIDANCE_RULES.hintColumnLink },
|
|
17
|
+
{ option: "emptyPlaceholder", rule: LIST_ROW_GUIDANCE_RULES.hintColumnEmptyPlaceholder },
|
|
18
|
+
];
|
|
19
|
+
function validateHintColumn(where, column) {
|
|
20
|
+
if (column.hint?.narrowDetailField !== undefined && column.hint.detailField === undefined) {
|
|
21
|
+
throw bootRuleError(LIST_ROW_GUIDANCE_RULES.narrowDetailFieldWithoutDetailField, {
|
|
22
|
+
message: `${where} column "${column.field}" sets hint.narrowDetailField without hint.detailField. Set detailField or remove narrowDetailField.`,
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
const { hint } = column;
|
|
26
|
+
if (hint !== undefined &&
|
|
27
|
+
hint.reasonField === undefined &&
|
|
28
|
+
(hint.reasonOpenField !== undefined || hint.reasonTitleField !== undefined)) {
|
|
29
|
+
throw bootRuleError(LIST_ROW_GUIDANCE_RULES.reasonOptionWithoutReasonField, {
|
|
30
|
+
message: `${where} column "${column.field}" sets hint.reasonOpenField or hint.reasonTitleField without hint.reasonField. Set reasonField or remove them.`,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
const conflict = column.hint === undefined
|
|
34
|
+
? undefined
|
|
35
|
+
: HINT_CONFLICTS.find(({ option }) => column[option] !== undefined);
|
|
36
|
+
if (conflict !== undefined) {
|
|
37
|
+
throw bootRuleError(conflict.rule, {
|
|
38
|
+
message: `${where} column "${column.field}" sets both hint and ${conflict.option} — the hint cell ` +
|
|
39
|
+
`draws the column itself. Remove ${conflict.option} or hint.`,
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
// hideOnNarrow and hidden: false are legal alongside showOnNarrowOnly; a pin always conflicts.
|
|
44
|
+
function narrowOnlyConflictOf(column) {
|
|
45
|
+
if (column.hideOnNarrow === true)
|
|
46
|
+
return "hideOnNarrow";
|
|
47
|
+
if (column.hidden === true)
|
|
48
|
+
return "hidden";
|
|
49
|
+
return column.pinned !== undefined ? "pinned" : undefined;
|
|
50
|
+
}
|
|
51
|
+
function validateNarrowOnlyColumn(where, column) {
|
|
52
|
+
// skip: the column shows in the table too
|
|
53
|
+
if (column.showOnNarrowOnly === undefined)
|
|
54
|
+
return;
|
|
55
|
+
const conflict = narrowOnlyConflictOf(column);
|
|
56
|
+
if (conflict !== undefined) {
|
|
57
|
+
throw bootRuleError(LIST_ROW_GUIDANCE_RULES.narrowOnlyConflict, {
|
|
58
|
+
message: `${where} column "${column.field}" sets showOnNarrowOnly together with ${conflict}. Remove one of them.`,
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
function validateButtonColumn(where, column, kind) {
|
|
63
|
+
if (column.display === "button" && kind !== "dashboard") {
|
|
64
|
+
throw bootRuleError(LIST_ROW_GUIDANCE_RULES.buttonColumnInListTable, {
|
|
65
|
+
message: `${where} column "${column.field}" sets display "button", which only dashboard list panels draw. ` +
|
|
66
|
+
`A row button in a list table is a rowAction with display "button".`,
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
const hasLink = column.linkScreenField !== undefined || column.refEntity !== undefined;
|
|
70
|
+
if (column.display === "button" && !hasLink) {
|
|
71
|
+
throw bootRuleError(LIST_ROW_GUIDANCE_RULES.buttonColumnWithoutLink, {
|
|
72
|
+
message: `${where} column "${column.field}" sets display "button" without linkScreenField or refEntity ` +
|
|
73
|
+
`— the button is the link. Set a link option or remove display.`,
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
function validateNamedFilterOptions(where, screen) {
|
|
78
|
+
if (screen.namedFilterFacet !== undefined && (screen.namedFilters ?? []).length === 0) {
|
|
79
|
+
throw bootRuleError(NAMED_FILTER_RULES.facetWithoutFilters, {
|
|
80
|
+
message: `${where} sets namedFilterFacet without namedFilters — there is nothing to present. Declare namedFilters or remove namedFilterFacet.`,
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
for (const ref of screen.namedFilters ?? []) {
|
|
84
|
+
if (ref.emptyState !== undefined && ref.emptyState.title.trim().length === 0) {
|
|
85
|
+
throw bootRuleError(NAMED_FILTER_RULES.emptyStateTitleEmpty, {
|
|
86
|
+
message: `${where} namedFilters "${ref.id}" sets emptyState with an empty title. Name the i18n key or remove emptyState.`,
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
function guidanceLocation(featureName, screenId, kind, partLabel) {
|
|
92
|
+
if (kind === "dashboard") {
|
|
93
|
+
return `[Feature ${featureName}] Screen "${screenId}" (dashboard) list-panel "${partLabel}"`;
|
|
94
|
+
}
|
|
95
|
+
if (kind === "relatedList")
|
|
96
|
+
return `[Feature ${featureName}] ${partLabel}`;
|
|
97
|
+
return `[Feature ${featureName}] Screen "${screenId}" (${kind})`;
|
|
98
|
+
}
|
|
99
|
+
export function validateListRowGuidance(featureName, screenId, kind, screen, entityFields,
|
|
100
|
+
// dashboard: the list-panel id; relatedList: the section's full location text
|
|
101
|
+
partLabel) {
|
|
102
|
+
const where = guidanceLocation(featureName, screenId, kind, partLabel ?? "");
|
|
103
|
+
if (screen.rowDecoration !== undefined && screen.rowDecoration.query.trim().length === 0) {
|
|
104
|
+
throw bootRuleError(LIST_ROW_GUIDANCE_RULES.rowDecorationQueryEmpty, {
|
|
105
|
+
message: `${where} sets rowDecoration.query to an empty string. Name the decoration query or remove rowDecoration.`,
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
for (const col of screen.columns) {
|
|
109
|
+
const column = normalizeListColumn(col);
|
|
110
|
+
validateHintColumn(where, column);
|
|
111
|
+
validateNarrowOnlyColumn(where, column);
|
|
112
|
+
validateButtonColumn(where, column, kind);
|
|
113
|
+
}
|
|
114
|
+
validateNamedFilterOptions(where, screen);
|
|
115
|
+
for (const { option, field } of listGuidanceFieldRefs(screen)) {
|
|
116
|
+
if (field.trim().length === 0) {
|
|
117
|
+
throw bootRuleError(LIST_ROW_GUIDANCE_RULES.guidanceFieldEmpty, {
|
|
118
|
+
message: `${where} sets ${option} to an empty string. Name a row field or remove the option.`,
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
if (entityFields !== undefined &&
|
|
122
|
+
!entityFields.fieldNames.has(field) &&
|
|
123
|
+
!acceptsRowDecorationField(entityFields.rowDecorationFields, field)) {
|
|
124
|
+
throw bootRuleError(SCREEN_KIND_RULES.unknownFieldReference, {
|
|
125
|
+
message: buildUnknownFieldMessage(featureName, screenId, field, entityFields.entityName, entityFields.fieldNames),
|
|
126
|
+
});
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
export declare const LIST_SORT_SUMMARY_RULES: {
|
|
2
|
+
readonly sortOptionNotSortable: {
|
|
3
|
+
readonly id: "list/sort-option-not-sortable";
|
|
4
|
+
readonly summary: "Every sortOptions field is a listed, sortable column (entityList); a projectionList's query takes sort and sortDirection and, when sort is an enum, lists every option field.";
|
|
5
|
+
readonly fix: "Mark the field sortable and list it as a column, or give the projectionList's query sort and sortDirection parameters that accept the option fields.";
|
|
6
|
+
};
|
|
7
|
+
readonly sortOptionsInvalid: {
|
|
8
|
+
readonly id: "list/sort-options-invalid";
|
|
9
|
+
readonly summary: "sortOptions is not empty and lists each field and dir once.";
|
|
10
|
+
readonly fix: "Remove sortOptions, or list each field and dir pair once.";
|
|
11
|
+
};
|
|
12
|
+
readonly sortOptionsDefaultNotListed: {
|
|
13
|
+
readonly id: "list/sort-options-default-not-listed";
|
|
14
|
+
readonly summary: "A defaultSort is one of the sortOptions, so the select opens on an entry.";
|
|
15
|
+
readonly fix: "Add the defaultSort field and dir to sortOptions or change defaultSort.";
|
|
16
|
+
};
|
|
17
|
+
readonly summaryRowShape: {
|
|
18
|
+
readonly id: "list/summary-row-shape";
|
|
19
|
+
readonly summary: "table.summaryRow is an object with a query string and optional params object.";
|
|
20
|
+
readonly fix: 'Write table.summaryRow as { query: "feature:query:order:summary" }.';
|
|
21
|
+
};
|
|
22
|
+
readonly summaryRowQueryUnknown: {
|
|
23
|
+
readonly id: "list/summary-row-query-unknown";
|
|
24
|
+
readonly summary: "table.summaryRow.query names a registered query handler.";
|
|
25
|
+
readonly fix: "Use the qualified name of a query handler (feature:query:name) or remove summaryRow.";
|
|
26
|
+
};
|
|
27
|
+
readonly summaryRowQueryAcceptsListKeys: {
|
|
28
|
+
readonly id: "list/summary-row-query-accepts-list-keys";
|
|
29
|
+
readonly summary: "The summaryRow query's Zod schema accepts every list key the screen sends (search, namedFilter, filters).";
|
|
30
|
+
readonly fix: "Add the missing keys to the query schema (or reuse the list query's filter shape) and apply them, or drop the feature on the screen.";
|
|
31
|
+
};
|
|
32
|
+
readonly summaryRowWithTotals: {
|
|
33
|
+
readonly id: "list/summary-row-with-totals";
|
|
34
|
+
readonly summary: "A table sets summaryRow or totals, not both; two footers under one table read as two answers.";
|
|
35
|
+
readonly fix: "Drop totals and put the figures into the summary query, or drop summaryRow.";
|
|
36
|
+
};
|
|
37
|
+
readonly summaryRowOnRelatedList: {
|
|
38
|
+
readonly id: "list/summary-row-on-related-list";
|
|
39
|
+
readonly summary: "A relatedList section or expandableRow sets no table.summaryRow; only entityList and projectionList screens have a list payload to carry it.";
|
|
40
|
+
readonly fix: "Remove summaryRow from the relatedList, or put the summary on the list screen itself.";
|
|
41
|
+
};
|
|
42
|
+
};
|