@starci/hfs 4.3.0 → 4.4.1
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/CHANGELOG.md +14 -0
- package/README.md +1 -1
- package/db/migrate.mjs +361 -0
- package/db/post-cutover.mjs +136 -0
- package/emit/contracts.mjs +2 -2
- package/emit/db-types.mjs +12 -3
- package/lint/run.mjs +3 -3
- package/package.json +4 -1
- package/release/gate.mjs +298 -0
- package/release/index.mjs +103 -0
- package/release/push.mjs +110 -0
- package/report/sonar.mjs +1 -1
- package/runtime/config.example.yaml +7 -6
- package/runtime/engine/config.mjs +10 -18
- package/runtime/engine/removed-vocabulary.mjs +0 -2
- package/runtime/knowledge/hfs/canon-pins.yaml +11 -11
- package/runtime/knowledge/hfs/fe-stack.yaml +22 -1
- package/runtime/knowledge/hfs/rules.yaml +2855 -163
- package/runtime/knowledge/hfs/slots.yaml +333 -62
- package/runtime/knowledge/patterns/be/api.yaml +32 -5
- package/runtime/knowledge/patterns/be/cli.yaml +14 -4
- package/runtime/knowledge/patterns/be/event-bus.yaml +3 -3
- package/runtime/knowledge/patterns/be/jobs.yaml +20 -2
- package/runtime/knowledge/patterns/be/projections.yaml +4 -2
- package/runtime/knowledge/patterns/be/queues.yaml +11 -3
- package/runtime/knowledge/patterns/be/reactors.yaml +20 -1
- package/runtime/knowledge/patterns/be/realtime.yaml +25 -3
- package/runtime/knowledge/patterns/be/saga.yaml +20 -3
- package/runtime/knowledge/patterns/be/webhooks.yaml +23 -4
- package/runtime/knowledge/patterns/fe/folder.yaml +1 -0
- package/runtime/knowledge/sonar-gate.yaml +1 -1
- package/runtime/modules/kernel/failure-codes.yaml +3091 -43
- package/runtime/modules/kernel/removed-vocabulary.yaml +30 -0
- package/runtime/modules/models/runtimes.yaml +5 -7
- package/runtime/modules/schemas/application-stacks.schema.yaml +663 -0
- package/runtime/packages/cli/src/catalog.generated.mjs +13769 -0
- package/runtime/packages/cli/src/validate-args.mjs +213 -0
- package/runtime/scripts/api/git/add.mjs +5 -0
- package/runtime/scripts/api/git/init.mjs +7 -0
- package/runtime/scripts/api/git/lib.mjs +4 -1
- package/runtime/scripts/api/git/tag.mjs +5 -0
- package/runtime/scripts/api/node/lib.mjs +20 -0
- package/runtime/scripts/api/node/run-node.mjs +6 -0
- package/runtime/scripts/api/sops/lib.mjs +42 -1
- package/runtime/scripts/api/sops/selected-age-recipient.mjs +7 -0
- package/runtime/scripts/api/supabase/database-dump.mjs +5 -0
- package/runtime/scripts/api/supabase/database-query.mjs +5 -0
- package/runtime/scripts/api/supabase/lib.mjs +44 -0
- package/runtime/scripts/api/supabase/migration-repair.mjs +5 -0
- package/runtime/scripts/hfs/app-wiring.mjs +201 -0
- package/runtime/scripts/hfs/architecture/backend-app-files.mjs +1 -8
- package/runtime/scripts/hfs/architecture/backend.mjs +2 -7
- package/runtime/scripts/hfs/architecture/client-reaches-server.mjs +6 -3
- package/runtime/scripts/hfs/architecture/config.mjs +1 -1
- package/runtime/scripts/hfs/architecture/dead-exports-bindings.mjs +149 -0
- package/runtime/scripts/hfs/architecture/dead-exports.mjs +9 -41
- package/runtime/scripts/hfs/architecture/default-deny.mjs +8 -6
- package/runtime/scripts/hfs/architecture/frontend-world.mjs +1 -1
- package/runtime/scripts/hfs/architecture/function-spec-providers.mjs +153 -0
- package/runtime/scripts/hfs/architecture/hfs.mjs +3 -3
- package/runtime/scripts/hfs/architecture/index.mjs +1 -1
- package/runtime/scripts/hfs/architecture/module-per-transport.mjs +28 -13
- package/runtime/scripts/hfs/architecture/next-data-inference.mjs +176 -0
- package/runtime/scripts/hfs/architecture/next-data-symbols.mjs +26 -0
- package/runtime/scripts/hfs/architecture/next-data.mjs +31 -23
- package/runtime/scripts/hfs/architecture/reachability.mjs +14 -0
- package/runtime/scripts/hfs/architecture/register-once.mjs +2 -2
- package/runtime/scripts/hfs/architecture/source-names.mjs +48 -3
- package/runtime/scripts/hfs/architecture/supabase-ast.mjs +211 -11
- package/runtime/scripts/hfs/architecture/supabase-be.mjs +1 -1
- package/runtime/scripts/hfs/architecture/supabase.mjs +59 -21
- package/runtime/scripts/hfs/architecture/surface.mjs +2 -1
- package/runtime/scripts/hfs/architecture/tiers.mjs +4 -4
- package/runtime/scripts/hfs/architecture/unit-spec-providers.mjs +8 -2
- package/runtime/scripts/hfs/architecture.mjs +1 -1
- package/runtime/scripts/hfs/check-results.mjs +28 -0
- package/runtime/scripts/hfs/check.mjs +46 -47
- package/runtime/scripts/hfs/coverage-from.mjs +70 -0
- package/runtime/scripts/hfs/coverage-scope.mjs +1 -1
- package/runtime/scripts/hfs/db-baseline-verb.mjs +276 -0
- package/runtime/scripts/hfs/db-plan-verb.mjs +254 -0
- package/runtime/scripts/hfs/db-restamp-verb.mjs +60 -0
- package/runtime/scripts/hfs/declaration-shape.mjs +39 -3
- package/runtime/scripts/hfs/doc-commands.mjs +367 -0
- package/runtime/scripts/hfs/edition-slots.mjs +2 -2
- package/runtime/scripts/hfs/example-secrets.mjs +158 -0
- package/runtime/scripts/hfs/manifest-shape.mjs +69 -9
- package/runtime/scripts/hfs/param-names.mjs +1 -1
- package/runtime/scripts/hfs/refusal-codes.mjs +6 -0
- package/runtime/scripts/hfs/rule-catalog.mjs +158 -11
- package/runtime/scripts/hfs/rule-params-shape.mjs +22 -10
- package/runtime/scripts/hfs/rules/a15-findings.mjs +88 -0
- package/runtime/scripts/hfs/rules/app-env-required.mjs +20 -0
- package/runtime/scripts/hfs/rules/app-root.mjs +2 -2
- package/runtime/scripts/hfs/rules/assets.mjs +79 -0
- package/runtime/scripts/hfs/rules/boot-proof.mjs +16 -0
- package/runtime/scripts/hfs/rules/canon-copy-drift.mjs +59 -0
- package/runtime/scripts/hfs/rules/cli.mjs +1 -1
- package/runtime/scripts/hfs/rules/contract-compat.mjs +1 -1
- package/runtime/scripts/hfs/rules/contract.mjs +67 -6
- package/runtime/scripts/hfs/rules/coverage-below.mjs +230 -0
- package/runtime/scripts/hfs/rules/database-access.mjs +343 -0
- package/runtime/scripts/hfs/rules/database-baseline.mjs +142 -0
- package/runtime/scripts/hfs/rules/database-config.mjs +250 -2
- package/runtime/scripts/hfs/rules/database-constants.mjs +9 -0
- package/runtime/scripts/hfs/rules/database-migrations.mjs +286 -7
- package/runtime/scripts/hfs/rules/database-plpgsql.mjs +119 -9
- package/runtime/scripts/hfs/rules/database-queue-sources.mjs +176 -0
- package/runtime/scripts/hfs/rules/database-queues.mjs +361 -0
- package/runtime/scripts/hfs/rules/database-sql.mjs +91 -9
- package/runtime/scripts/hfs/rules/database.mjs +9 -0
- package/runtime/scripts/hfs/rules/deploy-scan.mjs +192 -0
- package/runtime/scripts/hfs/rules/deploy-workflow.mjs +219 -0
- package/runtime/scripts/hfs/rules/doc-fresh.mjs +286 -0
- package/runtime/scripts/hfs/rules/docker-health.mjs +249 -0
- package/runtime/scripts/hfs/rules/docker.mjs +24 -7
- package/runtime/scripts/hfs/rules/edition.mjs +9 -8
- package/runtime/scripts/hfs/rules/env-parity.mjs +373 -0
- package/runtime/scripts/hfs/rules/env-value-shape.mjs +113 -0
- package/runtime/scripts/hfs/rules/event-bus.mjs +3 -2
- package/runtime/scripts/hfs/rules/event-tables.mjs +100 -0
- package/runtime/scripts/hfs/rules/fe-contract-documents.mjs +115 -15
- package/runtime/scripts/hfs/rules/fe-stack.mjs +57 -0
- package/runtime/scripts/hfs/rules/feature-files.mjs +28 -0
- package/runtime/scripts/hfs/rules/frontend-tree.mjs +54 -35
- package/runtime/scripts/hfs/rules/integration-specs.mjs +3 -2
- package/runtime/scripts/hfs/rules/lexicon.mjs +62 -0
- package/runtime/scripts/hfs/rules/lite-proof-lane.mjs +89 -0
- package/runtime/scripts/hfs/rules/monorepo.mjs +14 -1
- package/runtime/scripts/hfs/rules/pipeline.mjs +8 -1
- package/runtime/scripts/hfs/rules/release-provenance.mjs +211 -0
- package/runtime/scripts/hfs/rules/saga-delivery.mjs +66 -0
- package/runtime/scripts/hfs/rules/saga.mjs +8 -16
- package/runtime/scripts/hfs/rules/script-hygiene.mjs +151 -0
- package/runtime/scripts/hfs/rules/secret-custody-only.mjs +65 -0
- package/runtime/scripts/hfs/rules/secrets.mjs +13 -0
- package/runtime/scripts/hfs/rules/services.mjs +4 -4
- package/runtime/scripts/hfs/rules/stack-tooling.mjs +93 -0
- package/runtime/scripts/hfs/rules/stacks-deploy.mjs +76 -0
- package/runtime/scripts/hfs/rules/stacks-ingress.mjs +87 -0
- package/runtime/scripts/hfs/rules/stacks-lite-backing.mjs +111 -0
- package/runtime/scripts/hfs/rules/stacks-release.mjs +366 -0
- package/runtime/scripts/hfs/rules/stacks-runtime.mjs +41 -1
- package/runtime/scripts/hfs/rules/stacks-swarm.mjs +417 -0
- package/runtime/scripts/hfs/rules/supabase-secrets.mjs +2 -2
- package/runtime/scripts/hfs/rules/supply-chain.mjs +167 -0
- package/runtime/scripts/hfs/rules/unused-symbol-flow.mjs +101 -0
- package/runtime/scripts/hfs/rules/unused-symbol-ledger.mjs +77 -0
- package/runtime/scripts/hfs/rules/unused-symbol-translators.mjs +165 -0
- package/runtime/scripts/hfs/rules/unused-symbol-values.mjs +103 -0
- package/runtime/scripts/hfs/rules/unused-symbol.mjs +320 -0
- package/runtime/scripts/hfs/runtime-rules/source-ast.mjs +185 -0
- package/runtime/scripts/hfs/runtime-rules/workflow-source.mjs +19 -0
- package/runtime/scripts/hfs/sealed-members.mjs +101 -0
- package/runtime/scripts/hfs/secret-bootstrap-crypto.mjs +200 -0
- package/runtime/scripts/hfs/secret-edit.mjs +170 -0
- package/runtime/scripts/hfs/secret-init.mjs +127 -19
- package/runtime/scripts/hfs/secret-sops.mjs +38 -6
- package/runtime/scripts/hfs/secret-store.mjs +56 -54
- package/runtime/scripts/hfs/secret.mjs +34 -5
- package/runtime/scripts/hfs/slot-imports.mjs +18 -5
- package/runtime/scripts/hfs/slots.mjs +3 -2
- package/runtime/scripts/hfs/stack-config-kit.mjs +34 -0
- package/runtime/scripts/hfs/stack-deploy-config.mjs +313 -0
- package/runtime/scripts/hfs/stack-ingress-config.mjs +237 -0
- package/runtime/scripts/hfs/stacks-gate.mjs +414 -0
- package/runtime/scripts/hfs/starcistacks-runtime.mjs +61 -0
- package/runtime/scripts/hfs/typescript-programs.mjs +0 -8
- package/runtime/scripts/lib/command-tokens.mjs +126 -0
- package/runtime/scripts/lib/compose-values.mjs +11 -0
- package/runtime/scripts/lib/deployment-findings.mjs +7 -0
- package/runtime/scripts/lib/env.mjs +2 -2
- package/runtime/scripts/lib/git.mjs +1 -1
- package/runtime/scripts/lib/i18n.mjs +0 -2
- package/runtime/scripts/lib/json-clone.mjs +61 -0
- package/runtime/scripts/lib/language.mjs +1 -1
- package/runtime/scripts/lib/list.mjs +4 -0
- package/runtime/scripts/lib/roots.mjs +2 -4
- package/runtime/scripts/lib/runtime-example.mjs +13 -0
- package/runtime/scripts/lib/secret-patterns.mjs +60 -5
- package/runtime/scripts/lib/sql-ast.mjs +32 -0
- package/runtime/scripts/lib/stack-services.mjs +1 -1
- package/runtime/scripts/lib/swarm-stack.mjs +5 -18
- package/runtime/scripts/lib/trim-end.mjs +8 -0
- package/runtime/scripts/lib/ts-analysis.mjs +5 -2
- package/runtime/scripts/lib/ts-ast.mjs +27 -2
- package/runtime/scripts/lib/workflow-events.mjs +8 -0
- package/scaffold/add-app.mjs +77 -59
- package/scaffold/add-cli-lite.mjs +14 -6
- package/scaffold/add-compose.mjs +79 -0
- package/scaffold/add-database-lite.mjs +14 -0
- package/scaffold/add-fe-overlay.mjs +1 -0
- package/scaffold/add-fe-page.mjs +1 -0
- package/scaffold/add-inbox-lite.mjs +74 -42
- package/scaffold/add-table.mjs +110 -87
- package/scaffold/add.mjs +159 -44
- package/scaffold/app.mjs +124 -39
- package/scaffold/edition-gate.mjs +3 -3
- package/scaffold/lite-exports.mjs +2 -1
- package/scaffold/service.mjs +2 -2
- package/scaffold/supabase-ports.mjs +1 -1
- package/src/main.mjs +229 -116
- package/stack/age-install.mjs +37 -0
- package/stack/backup.mjs +100 -0
- package/stack/build-args.mjs +42 -0
- package/stack/build.mjs +173 -0
- package/stack/cli.mjs +130 -0
- package/stack/config.mjs +57 -0
- package/stack/context.mjs +57 -0
- package/stack/converge.mjs +107 -0
- package/stack/deploy.mjs +301 -0
- package/stack/digest.mjs +16 -0
- package/stack/docker-transport.mjs +53 -0
- package/stack/edge-alias.mjs +118 -0
- package/stack/errors.mjs +21 -0
- package/stack/image-scan.mjs +152 -0
- package/stack/ingress-create.mjs +114 -0
- package/stack/ingress-publish.mjs +273 -0
- package/stack/ingress.mjs +706 -0
- package/stack/jobs.mjs +51 -0
- package/stack/live-restore.mjs +177 -0
- package/stack/prepare.mjs +266 -0
- package/stack/private-file.mjs +22 -0
- package/stack/provision.mjs +90 -0
- package/stack/prune.mjs +46 -0
- package/stack/release-store.mjs +87 -0
- package/stack/remote.mjs +205 -0
- package/stack/render.mjs +149 -0
- package/stack/retire.mjs +47 -0
- package/stack/sealed.mjs +149 -0
- package/stack/task.mjs +42 -0
- package/stack/verify.mjs +99 -0
- package/sync/ci-commands.mjs +13 -0
- package/sync/format.mjs +1 -1
- package/sync/hygiene.mjs +1 -1
- package/sync/index.mjs +110 -54
- package/sync/stack-images.mjs +127 -0
- package/templates/app/ci-workflows/github/workflows/ci.yml +5 -1
- package/templates/app/ci-workflows/github/workflows/images.yml +15 -3
- package/templates/app/ci-workflows/github/workflows/stack-deploy.yml +148 -0
- package/templates/app/ci-workflows-lite/github/workflows/ci.yml +7 -3
- package/templates/app/ci-workflows-lite/github/workflows/db-deploy.yml +38 -6
- package/templates/app/ci-workflows-lite/github/workflows/images.yml +14 -2
- package/templates/app/ci-workflows-lite/github/workflows/stack-deploy.yml +148 -0
- package/templates/app/codegen-graphql.mjs.partial +13 -2
- package/templates/app/codegen-lite/scripts/codegen.mjs +6 -1
- package/templates/app/codegen-prelude.mjs.partial +8 -0
- package/templates/app/gitignore +3 -0
- package/templates/app/gitignore-lite +3 -0
- package/templates/app/package-scripts/package.json +1 -0
- package/templates/app/package-scripts/supabase.json +7 -0
- package/templates/app/package-scripts-lite/package.json +1 -7
- package/templates/app/skeleton/.editorconfig +1 -0
- package/templates/app/skeleton/.gitattributes +7 -1
- package/templates/app/skeleton/.github/dependabot.yml +17 -0
- package/templates/app/skeleton/.nvmrc +1 -1
- package/templates/app/skeleton/.starcistacks/application-stacks.yaml +134 -1
- package/templates/app/skeleton/.starcistacks/dev/README.md +16 -0
- package/templates/app/skeleton/.starcistacks/dev/environment.json +5 -0
- package/templates/app/skeleton/.starcistacks/dev/infra/compose/stack.yaml +71 -0
- package/templates/app/skeleton/.starcistacks/dev/runtime/env/KEYS.md +14 -0
- package/templates/app/skeleton/.starcistacks/production/README.md +37 -0
- package/templates/app/skeleton/.starcistacks/production/environment.json +5 -0
- package/templates/app/skeleton/.starcistacks/production/infra/swarm/Caddyfile +15 -0
- package/templates/app/skeleton/.starcistacks/production/infra/swarm/owner-actions.md +11 -0
- package/templates/app/skeleton/.starcistacks/production/infra/swarm/recovery/restore-proof.md +7 -0
- package/templates/app/skeleton/.starcistacks/production/infra/swarm/releases/current.yaml +6 -0
- package/templates/app/skeleton/.starcistacks/production/infra/swarm/releases/images.lock.yaml +9 -0
- package/templates/app/skeleton/.starcistacks/production/infra/swarm/releases/previous.yaml +6 -0
- package/templates/app/skeleton/.starcistacks/production/infra/swarm/stack.yaml +142 -0
- package/templates/app/skeleton/.starcistacks/production/runtime/env/KEYS.md +14 -0
- package/templates/app/skeleton/README.md +6 -6
- package/templates/app/skeleton/scripts/codegen.mjs +1 -2
- package/templates/app/skeleton-lite/.editorconfig +16 -0
- package/templates/app/skeleton-lite/.gitattributes +8 -0
- package/templates/app/skeleton-lite/.github/dependabot.yml +17 -0
- package/templates/app/skeleton-lite/.nvmrc +1 -0
- package/templates/app/skeleton-lite/.sops.yaml +3 -2
- package/templates/app/skeleton-lite/.starcistacks/application-stacks.yaml +178 -1
- package/templates/app/skeleton-lite/.starcistacks/dev/README.md +20 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/environment.json +2 -1
- package/templates/app/skeleton-lite/.starcistacks/dev/infra/swarm/Caddyfile +16 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/infra/swarm/owner-actions.md +11 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/infra/swarm/recovery/restore-proof.md +7 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/infra/swarm/releases/current.yaml +6 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/infra/swarm/releases/images.lock.yaml +8 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/infra/swarm/releases/previous.yaml +6 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/infra/swarm/stack.yaml +120 -0
- package/templates/app/skeleton-lite/.starcistacks/dev/runtime/env/KEYS.md +18 -0
- package/templates/app/skeleton-lite/.starcistacks/production/README.md +38 -0
- package/templates/app/skeleton-lite/.starcistacks/production/environment.json +6 -0
- package/templates/app/skeleton-lite/.starcistacks/production/infra/swarm/Caddyfile +11 -0
- package/templates/app/skeleton-lite/.starcistacks/production/infra/swarm/owner-actions.md +11 -0
- package/templates/app/skeleton-lite/.starcistacks/production/infra/swarm/recovery/restore-proof.md +7 -0
- package/templates/app/skeleton-lite/.starcistacks/production/infra/swarm/releases/current.yaml +6 -0
- package/templates/app/skeleton-lite/.starcistacks/production/infra/swarm/releases/images.lock.yaml +8 -0
- package/templates/app/skeleton-lite/.starcistacks/production/infra/swarm/releases/previous.yaml +6 -0
- package/templates/app/skeleton-lite/.starcistacks/production/infra/swarm/stack.yaml +121 -0
- package/templates/app/skeleton-lite/.starcistacks/production/runtime/env/KEYS.md +21 -0
- package/templates/app/skeleton-lite/.starciwork/brand/index.yaml +12 -0
- package/templates/app/skeleton-lite/README.md +5 -3
- package/templates/app/skeleton-lite/supabase/config.toml +8 -1
- package/templates/app/skeleton-lite/supabase/migrations/__timestamp___baseline.sql +15 -6
- package/templates/app/upgrade-full/.starcistacks/dev/README.md +13 -7
- package/templates/be/image/worker/Dockerfile +1 -1
- package/templates/be/inbox/database-client.spec.ts.tpl +17 -18
- package/templates/be/inbox/database-client.ts.tpl +12 -11
- package/templates/be/inbox/delivery-recorded.event.ts.tpl +36 -0
- package/templates/be/inbox/event-index.ts.tpl +1 -0
- package/templates/be/inbox/events.json.tpl +10 -0
- package/templates/be/inbox/migration.sql.tpl +1 -0
- package/templates/be/inbox/platform/event-bus/event-bus.contracts.ts.tpl +42 -0
- package/templates/be/inbox/platform/event-bus/event-bus.decorators.ts.tpl +9 -0
- package/templates/be/inbox/platform/event-bus/event-bus.module-definition.ts.tpl +6 -0
- package/templates/be/inbox/platform/event-bus/event-bus.module.ts.tpl +19 -0
- package/templates/be/inbox/platform/event-bus/event-bus.options.ts.tpl +2 -0
- package/templates/be/inbox/platform/event-bus/event-bus.port.ts.tpl +16 -0
- package/templates/be/inbox/platform/event-bus/event-bus.service.spec.ts.tpl +45 -0
- package/templates/be/inbox/platform/event-bus/event-bus.service.ts.tpl +15 -0
- package/templates/be/inbox/platform/event-bus/index.ts.tpl +5 -0
- package/templates/be/inbox/platform/event-bus/persistence/event-bus.sql.ts.tpl +5 -0
- package/templates/be/inbox/platform/inbox/inbox.decorators.ts.tpl +9 -0
- package/templates/be/inbox/platform/inbox/inbox.module-definition.ts.tpl +6 -0
- package/templates/be/inbox/platform/inbox/inbox.module.ts.tpl +19 -0
- package/templates/be/inbox/platform/inbox/inbox.options.ts.tpl +2 -0
- package/templates/be/inbox/platform/inbox/inbox.port.ts.tpl +10 -0
- package/templates/be/inbox/platform/inbox/inbox.service.spec.ts.tpl +41 -0
- package/templates/be/inbox/platform/inbox/inbox.service.ts.tpl +19 -0
- package/templates/be/inbox/platform/inbox/index.ts.tpl +3 -0
- package/templates/be/inbox/platform/inbox/persistence/inbox.sql.ts.tpl +7 -0
- package/templates/be/inbox/platform/migration.sql.tpl +48 -0
- package/templates/be/inbox/service.spec.ts.tpl +42 -9
- package/templates/be/inbox/service.ts.tpl +23 -8
- package/templates/be/inbox/webhook-door.spec.ts.tpl +1 -1
- package/templates/be/inbox/webhook-door.ts.tpl +2 -2
- package/templates/be/patterns/api/feature.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/api/feature.module.ts.tpl +2 -1
- package/templates/be/patterns/api/feature.options.ts.tpl +2 -0
- package/templates/be/patterns/api/graphql.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/api/graphql.module.ts.tpl +3 -2
- package/templates/be/patterns/api/graphql.options.ts.tpl +2 -0
- package/templates/be/patterns/cli/group.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/cli/group.module.ts.tpl +2 -1
- package/templates/be/patterns/cli/group.options.ts.tpl +2 -0
- package/templates/be/patterns/event-bus/platform/errors/event-bus.error.ts.tpl +0 -3
- package/templates/be/patterns/event-bus/platform/messages/event-bus.messages.ts.tpl +0 -2
- package/templates/be/patterns/jobs/job.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/jobs/job.module.ts.tpl +2 -1
- package/templates/be/patterns/jobs/job.options.ts.tpl +2 -0
- package/templates/be/patterns/jobs/job.queue.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/jobs/job.queue.module.ts.tpl +6 -3
- package/templates/be/patterns/jobs/job.queue.options.ts.tpl +2 -0
- package/templates/be/patterns/jobs/platform/fenced.processor.spec.ts.tpl +3 -1
- package/templates/be/patterns/outbox/platform/outbox-relay.policy.spec.ts.tpl +25 -9
- package/templates/be/patterns/queues/platform/queue.config.ts.tpl +1 -1
- package/templates/be/patterns/queues/platform/queue.index.ts.tpl +1 -1
- package/templates/be/patterns/queues/platform/queue.module-definition.ts.tpl +2 -2
- package/templates/be/patterns/queues/platform/queue.module.ts.tpl +11 -0
- package/templates/be/patterns/queues/platform/queue.options.ts.tpl +10 -0
- package/templates/be/patterns/queues/queue.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/queues/queue.module.ts.tpl +2 -1
- package/templates/be/patterns/queues/queue.options.ts.tpl +2 -0
- package/templates/be/patterns/reactors/message.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/reactors/message.module.ts.tpl +6 -3
- package/templates/be/patterns/reactors/message.options.ts.tpl +2 -0
- package/templates/be/patterns/reactors/reactor.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/reactors/reactor.module.ts.tpl +2 -1
- package/templates/be/patterns/reactors/reactor.options.ts.tpl +2 -0
- package/templates/be/patterns/realtime/channel.gateway.spec.ts.tpl +188 -0
- package/templates/be/patterns/realtime/channel.gateway.ts.tpl +22 -0
- package/templates/be/patterns/realtime/channel.graphql.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/realtime/channel.graphql.module.ts.tpl +2 -1
- package/templates/be/patterns/realtime/channel.graphql.options.ts.tpl +2 -0
- package/templates/be/patterns/realtime/channel.websocket.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/realtime/channel.websocket.module.ts.tpl +110 -0
- package/templates/be/patterns/realtime/channel.websocket.options.ts.tpl +7 -0
- package/templates/be/patterns/saga/saga.message.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/saga/saga.message.module.ts.tpl +6 -3
- package/templates/be/patterns/saga/saga.message.options.ts.tpl +2 -0
- package/templates/be/patterns/saga/saga.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/saga/saga.module.ts.tpl +2 -1
- package/templates/be/patterns/saga/saga.options.ts.tpl +2 -0
- package/templates/be/patterns/webhooks/webhook.http.module-definition.ts.tpl +6 -0
- package/templates/be/patterns/webhooks/webhook.http.module.ts.tpl +2 -1
- package/templates/be/patterns/webhooks/webhook.http.options.ts.tpl +2 -0
- package/templates/be/platform/graphql/localize-errors.mapper.spec.ts +80 -26
- package/templates/be/platform/graphql/localize-errors.mapper.ts +2 -5
- package/templates/be/skeleton/apps/__app__/src/app.module.ts +11 -9
- package/templates/be/skeleton/apps/__app__/src/compose/api.ts +4 -0
- package/templates/be/skeleton/apps/__app__/src/compose/domain.ts +11 -0
- package/templates/be/skeleton/apps/__app__/src/compose/platform.ts +2 -0
- package/templates/be/skeleton/apps/__app__/src/compose/system.ts +5 -0
- package/templates/be/skeleton/apps/__app__/src/compose/webhooks.ts +4 -0
- package/templates/be/skeleton/apps/__app__/src/main.ts +15 -1
- package/templates/be/skeleton/apps/cli/src/app.module.ts +3 -13
- package/templates/be/skeleton/apps/cli/src/cli.options.ts +6 -14
- package/templates/be/skeleton/apps/cli/src/compose/cli.ts +5 -0
- package/templates/be/skeleton/apps/cli/src/compose/platform.ts +24 -0
- package/templates/be/skeleton/src/features/api/system-health/application/check-readiness.contracts.ts +2 -0
- package/templates/be/skeleton/src/features/api/system-health/application/check-readiness.handler.ts +22 -0
- package/templates/be/skeleton/src/features/api/system-health/application/check-readiness.query.ts +11 -0
- package/templates/be/skeleton/src/features/api/system-health/system-health.module-definition.ts +6 -0
- package/templates/be/skeleton/src/features/api/system-health/system-health.module.ts +5 -3
- package/templates/be/skeleton/src/features/api/system-health/system-health.options.ts +2 -0
- package/templates/be/skeleton/src/features/api/system-health/transport/http/ready.controller.ts +19 -0
- package/templates/be/skeleton/src/features/api/system-health/transport/http/system-health-http.module-definition.ts +6 -0
- package/templates/be/skeleton/src/features/api/system-health/transport/http/system-health-http.module.ts +8 -3
- package/templates/be/skeleton/src/features/api/system-health/transport/http/system-health-http.options.ts +2 -0
- package/templates/be/skeleton/src/features/cli/cli.module-definition.ts +6 -0
- package/templates/be/skeleton/src/features/cli/cli.module.ts +3 -2
- package/templates/be/skeleton/src/features/cli/cli.options.ts +2 -0
- package/templates/be/skeleton/src/features/cli/migrate/migrate.module-definition.ts +6 -0
- package/templates/be/skeleton/src/features/cli/migrate/migrate.module.ts +2 -1
- package/templates/be/skeleton/src/features/cli/migrate/migrate.options.ts +2 -0
- package/templates/be/skeleton/src/features/cli/seed/seed.module-definition.ts +6 -0
- package/templates/be/skeleton/src/features/cli/seed/seed.module.ts +2 -1
- package/templates/be/skeleton/src/features/cli/seed/seed.options.ts +2 -0
- package/templates/be/skeleton/src/features/cli/seed/subs/run.cli.spec.ts +5 -6
- package/templates/be/skeleton/src/modules/domain/identity/admission.policy.spec.ts +56 -4
- package/templates/be/skeleton/src/modules/domain/identity/admission.policy.ts +36 -5
- package/templates/be/skeleton/src/modules/domain/identity/auth.guard.spec.ts +39 -8
- package/templates/be/skeleton/src/modules/domain/identity/auth.guard.ts +14 -8
- package/templates/be/skeleton/src/modules/domain/identity/credential.contracts.ts +26 -0
- package/templates/be/skeleton/src/modules/domain/identity/credential.guard.spec.ts +119 -0
- package/templates/be/skeleton/src/modules/domain/identity/credential.guard.ts +43 -0
- package/templates/be/skeleton/src/modules/domain/identity/identity.contracts.ts +16 -0
- package/templates/be/skeleton/src/modules/domain/identity/identity.decorators.ts +18 -1
- package/templates/be/skeleton/src/modules/domain/identity/identity.module.ts +22 -4
- package/templates/be/skeleton/src/modules/domain/identity/identity.options.ts +8 -2
- package/templates/be/skeleton/src/modules/domain/identity/index.ts +1 -0
- package/templates/be/skeleton/src/modules/platform/database/connection-source.client.spec.ts +11 -4
- package/templates/be/skeleton/src/modules/platform/database/database-probe.service.spec.ts +32 -0
- package/templates/be/skeleton/src/modules/platform/database/database-probe.service.ts +14 -0
- package/templates/be/skeleton/src/modules/platform/database/database.module.ts +7 -1
- package/templates/be/skeleton/src/modules/platform/database/index.ts +2 -0
- package/templates/be/skeleton/src/modules/platform/database/primary.decorators.ts +8 -0
- package/templates/be/skeleton/src/modules/platform/database/seed-connections.client.spec.ts +25 -6
- package/templates/be/skeleton/src/modules/platform/errors/errors.filter.spec.ts +16 -6
- package/templates/be/skeleton/src/modules/platform/http-security/edge-security.service.spec.ts +130 -0
- package/templates/be/skeleton/src/modules/platform/http-security/edge-security.service.ts +58 -0
- package/templates/be/skeleton/src/modules/platform/http-security/errors/http-security.error.ts +3 -0
- package/templates/be/skeleton/src/modules/platform/http-security/execution-request.mapper.spec.ts +16 -4
- package/templates/be/skeleton/src/modules/platform/http-security/http-security.config.ts +16 -10
- package/templates/be/skeleton/src/modules/platform/http-security/http-security.module.ts +3 -1
- package/templates/be/skeleton/src/modules/platform/http-security/http-security.options.ts +2 -0
- package/templates/be/skeleton/src/modules/platform/http-security/index.ts +5 -0
- package/templates/be/skeleton/src/modules/platform/http-security/messages/http-security.messages.ts +12 -5
- package/templates/be/skeleton/src/modules/platform/http-security/rate-limit.guard.spec.ts +13 -8
- package/templates/be/skeleton/src/modules/platform/http-security/readiness.contracts.ts +5 -0
- package/templates/be/skeleton/src/modules/platform/http-security/readiness.decorators.ts +7 -0
- package/templates/be/skeleton/src/modules/platform/http-security/readiness.service.spec.ts +86 -0
- package/templates/be/skeleton/src/modules/platform/http-security/readiness.service.ts +39 -0
- package/templates/be/skeleton/src/modules/platform/http-security/webhook-signature.service.spec.ts +139 -131
- package/templates/be/skeleton/src/modules/platform/i18n/index.ts +1 -1
- package/templates/be/skeleton/src/modules/platform/logging/json-logger.service.spec.ts +91 -67
- package/templates/be/skeleton/src/modules/platform/logging/json-logger.service.ts +5 -4
- package/templates/be/skeleton/src/modules/platform/logging/logging.log-events.ts +0 -2
- package/templates/be/skeleton/src/modules/platform/primitives/outcome.mapper.spec.ts +20 -6
- package/templates/be/skeleton/src/modules/platform/primitives/sequence.policy.spec.ts +16 -4
- package/templates/be/skeleton/src/modules/platform/retry/index.ts +3 -0
- package/templates/be/skeleton/src/modules/platform/retry/retry.decorators.ts +9 -0
- package/templates/be/skeleton/src/modules/platform/retry/retry.module-definition.ts +7 -0
- package/templates/be/skeleton/src/modules/platform/retry/retry.module.ts +19 -0
- package/templates/be/skeleton/src/modules/platform/retry/retry.options.ts +2 -0
- package/templates/be/skeleton/src/modules/platform/retry/retry.port.ts +11 -0
- package/templates/be/skeleton/src/modules/platform/retry/system-timer.service.spec.ts +36 -0
- package/templates/be/skeleton/src/modules/platform/retry/system-timer.service.ts +10 -0
- package/templates/be/skeleton/src/tests/contract/http-security/http-security.contract-spec.ts +54 -0
- package/templates/be/skeleton-lite/apps/api/src/app.module.ts +14 -18
- package/templates/be/skeleton-lite/apps/api/src/compose/api.ts +4 -0
- package/templates/be/skeleton-lite/apps/api/src/compose/domain.ts +10 -0
- package/templates/be/skeleton-lite/apps/api/src/compose/integrations.ts +16 -0
- package/templates/be/skeleton-lite/apps/api/src/compose/platform.ts +2 -0
- package/templates/be/skeleton-lite/apps/api/src/compose/system.ts +5 -0
- package/templates/be/skeleton-lite/apps/api/src/compose/webhooks.ts +4 -0
- package/templates/be/skeleton-lite/apps/api/src/main.ts +2 -3
- package/templates/be/skeleton-lite/apps/cli/src/compose/platform.ts +12 -0
- package/templates/be/skeleton-lite/src/modules/domain/identity/admission.policy.spec.ts +71 -5
- package/templates/be/skeleton-lite/src/modules/domain/identity/admission.policy.ts +29 -2
- package/templates/be/skeleton-lite/src/modules/domain/identity/auth.guard.spec.ts +68 -15
- package/templates/be/skeleton-lite/src/modules/domain/identity/auth.guard.ts +14 -9
- package/templates/be/skeleton-lite/src/modules/domain/identity/identity.contracts.ts +9 -2
- package/templates/be/skeleton-lite/src/modules/domain/identity/identity.decorators.ts +16 -1
- package/templates/be/skeleton-lite/src/modules/domain/identity/identity.module.ts +19 -4
- package/templates/be/skeleton-lite/src/modules/domain/identity/identity.options.ts +5 -1
- package/templates/be/skeleton-lite/src/modules/domain/identity/index.ts +2 -1
- package/templates/be/skeleton-lite/src/modules/integrations/supabase/errors/supabase.error.ts +0 -3
- package/templates/be/skeleton-lite/src/modules/integrations/supabase/supabase.client.spec.ts +17 -5
- package/templates/be/skeleton-lite/src/modules/platform/database/database.module.ts +24 -13
- package/templates/be/skeleton-lite/src/modules/platform/database/database.port.ts +5 -0
- package/templates/be/skeleton-lite/src/modules/platform/database/errors/database.error.ts +16 -0
- package/templates/be/skeleton-lite/src/modules/platform/database/index.ts +3 -0
- package/templates/be/skeleton-lite/src/modules/platform/http-security/http-security.module.ts +5 -2
- package/templates/be/skeleton-lite/src/modules/platform/http-security/index.ts +4 -1
- package/templates/be/skeleton-lite/src/modules/platform/i18n/index.ts +1 -1
- package/templates/be/skeleton-lite/src/modules/platform/logging/logging.log-events.ts +7 -0
- package/templates/be/skeleton-lite/src/tests/fixtures/builders/api.builder.ts +29 -0
- package/templates/be/skeleton-lite/src/tests/fixtures/builders/cli.builder.ts +16 -0
- package/templates/be/table/api/feature.module-definition.ts.tpl +6 -0
- package/templates/be/table/api/feature.module.ts.tpl +2 -1
- package/templates/be/table/api/feature.options.ts.tpl +2 -0
- package/templates/be/table/api/graphql.module-definition.ts.tpl +6 -0
- package/templates/be/table/api/graphql.module.ts.tpl +3 -2
- package/templates/be/table/api/graphql.options.ts.tpl +2 -0
- package/templates/be/table/migration.sql.tpl +1 -0
- package/templates/be/upgrade-full/apps/cli/src/app.module.ts +4 -6
- package/templates/be/upgrade-full/apps/cli/src/cli.env.ts +7 -0
- package/templates/be/upgrade-full/apps/cli/src/compose/cli.ts +5 -0
- package/templates/be/upgrade-full/apps/cli/src/compose/platform.ts +9 -0
- package/templates/be/upgrade-full/apps/cli/src/main.ts +3 -0
- package/templates/be/upgrade-full/src/features/cli/cli.module.ts +3 -2
- package/templates/fe/auth/supabase-client.ts.tpl +34 -0
- package/templates/fe/skeleton/apps/__app__/src/app/auth/callback/route.ts +11 -0
- package/templates/fe/skeleton/apps/__app__/src/components/blocks/SignInForm/index.tsx +6 -1
- package/templates/fe/skeleton/apps/__app__/src/components/leaves/Icon/index.tsx +4 -0
- package/templates/fe/skeleton/apps/__app__/src/features/overlays/AppGuideOverlay/component.tsx +31 -0
- package/templates/fe/skeleton/apps/__app__/src/features/overlays/AppGuideOverlay/index.tsx +24 -0
- package/templates/fe/skeleton/apps/__app__/src/hooks/auth/useSession.ts +6 -1
- package/templates/fe/skeleton/apps/__app__/src/hooks/auth/useSignOut.ts +3 -4
- package/templates/fe/skeleton/apps/__app__/src/hooks/zustand/appGuide/index.ts +1 -0
- package/templates/fe/skeleton/apps/__app__/src/hooks/zustand/appGuide/store.ts +15 -0
- package/templates/fe/skeleton/apps/__app__/src/modules/auth/pkce-client.ts +18 -0
- package/templates/fe/skeleton/apps/__app__/src/modules/auth/server.ts +19 -0
- package/templates/fe/skeleton/apps/app/src/features/pages/AppHomePage/index.tsx +7 -1
- package/templates/fe/skeleton/apps/app/src/modules/i18n/messages/en.json +57 -0
- package/templates/fe/skeleton/apps/app/src/modules/i18n/messages/vi.json +6 -0
- package/templates/fe/skeleton/apps/landing/src/modules/i18n/messages/en.json +31 -0
- package/templates/fe/skeleton/packages/__project__-i18n/src/routing.ts +1 -1
- package/templates/fe/skeleton/packages/__project__-ui/src/index.ts +1 -0
- package/templates/fe/skeleton-lite/apps/__app__/src/modules/auth/client.ts +1 -34
- package/templates/fe/skeleton-lite/apps/web/src/features/pages/AppHomePage/index.tsx +7 -1
- package/templates/fe/skeleton-lite/apps/web/src/modules/i18n/messages/en.json +57 -0
- package/templates/fe/skeleton-lite/apps/web/src/modules/i18n/messages/vi.json +30 -24
- package/templates/fe/skeleton-lite/apps/web/src/modules/i18n/routing.ts +1 -1
- package/templates/fe/transport/graphql/clients/clients/auth.ts +1 -1
- package/templates/fe/transport/graphql/clients/links/locale.ts +2 -2
- package/upgrade/check.mjs +3 -1
- package/upgrade/index.mjs +54 -41
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Test } from "@nestjs/testing"
|
|
1
2
|
import { DomainError } from "@modules/platform/errors"
|
|
2
3
|
import { ok, refused, unwrapOutcome } from "./outcome.mapper"
|
|
3
4
|
|
|
@@ -5,18 +6,31 @@ type CapabilityErrorCode = "CAPABILITY_REFUSED"
|
|
|
5
6
|
|
|
6
7
|
class CapabilityError extends DomainError<CapabilityErrorCode> {}
|
|
7
8
|
|
|
9
|
+
const OUTCOME_MAPPERS: unique symbol = Symbol("primitives.outcome")
|
|
10
|
+
|
|
11
|
+
type OutcomeMappers = { ok: typeof ok; refused: typeof refused; unwrapOutcome: typeof unwrapOutcome }
|
|
12
|
+
|
|
8
13
|
describe("outcome mappers", () => {
|
|
14
|
+
let subject: OutcomeMappers
|
|
15
|
+
|
|
16
|
+
beforeEach(async () => {
|
|
17
|
+
const moduleRef = await Test.createTestingModule({
|
|
18
|
+
providers: [{ provide: OUTCOME_MAPPERS, useFactory: () => ({ ok, refused, unwrapOutcome }) }],
|
|
19
|
+
}).compile()
|
|
20
|
+
subject = moduleRef.get<OutcomeMappers>(OUTCOME_MAPPERS)
|
|
21
|
+
})
|
|
22
|
+
|
|
9
23
|
describe("ok", () => {
|
|
10
24
|
it("wraps the produced value as a success", () => {
|
|
11
25
|
const value = { id: "value-1" }
|
|
12
26
|
|
|
13
|
-
expect(ok(value)).toEqual({ kind: "ok", value })
|
|
27
|
+
expect(subject.ok(value)).toEqual({ kind: "ok", value })
|
|
14
28
|
})
|
|
15
29
|
})
|
|
16
30
|
|
|
17
31
|
describe("refused", () => {
|
|
18
32
|
it("wraps the capability code and display parameters as a refusal", () => {
|
|
19
|
-
expect(refused("CAPABILITY_REFUSED", { resource: "value-1" })).toEqual({
|
|
33
|
+
expect(subject.refused("CAPABILITY_REFUSED", { resource: "value-1" })).toEqual({
|
|
20
34
|
kind: "refused",
|
|
21
35
|
code: "CAPABILITY_REFUSED",
|
|
22
36
|
params: { resource: "value-1" },
|
|
@@ -24,7 +38,7 @@ describe("outcome mappers", () => {
|
|
|
24
38
|
})
|
|
25
39
|
|
|
26
40
|
it("keeps display parameters optional", () => {
|
|
27
|
-
expect(refused("CAPABILITY_REFUSED")).toEqual({
|
|
41
|
+
expect(subject.refused("CAPABILITY_REFUSED")).toEqual({
|
|
28
42
|
kind: "refused",
|
|
29
43
|
code: "CAPABILITY_REFUSED",
|
|
30
44
|
params: undefined,
|
|
@@ -34,13 +48,13 @@ describe("outcome mappers", () => {
|
|
|
34
48
|
|
|
35
49
|
describe("unwrapOutcome", () => {
|
|
36
50
|
it("returns the value of a successful outcome", () => {
|
|
37
|
-
expect(unwrapOutcome(ok("value-1"), CapabilityError)).toBe("value-1")
|
|
51
|
+
expect(subject.unwrapOutcome(subject.ok("value-1"), CapabilityError)).toBe("value-1")
|
|
38
52
|
})
|
|
39
53
|
|
|
40
54
|
it("turns a refusal into the capability error with its parameters", () => {
|
|
41
|
-
const outcome = refused<CapabilityErrorCode>("CAPABILITY_REFUSED", { resource: "value-1" })
|
|
55
|
+
const outcome = subject.refused<CapabilityErrorCode>("CAPABILITY_REFUSED", { resource: "value-1" })
|
|
42
56
|
|
|
43
|
-
expect(() => unwrapOutcome(outcome, CapabilityError)).toThrow(
|
|
57
|
+
expect(() => subject.unwrapOutcome(outcome, CapabilityError)).toThrow(
|
|
44
58
|
expect.objectContaining({
|
|
45
59
|
name: "CapabilityError",
|
|
46
60
|
code: "CAPABILITY_REFUSED",
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Test } from "@nestjs/testing"
|
|
1
2
|
import { DomainError } from "@modules/platform/errors"
|
|
2
3
|
import { eachInOrder } from "./sequence.policy"
|
|
3
4
|
|
|
@@ -5,13 +6,24 @@ type SequenceErrorCode = "STEP_FAILED"
|
|
|
5
6
|
|
|
6
7
|
class SequenceError extends DomainError<SequenceErrorCode> {}
|
|
7
8
|
|
|
9
|
+
const SEQUENCE: unique symbol = Symbol("primitives.sequence")
|
|
10
|
+
|
|
8
11
|
const pause = (): Promise<void> => new Promise((resolve) => setImmediate(resolve))
|
|
9
12
|
|
|
10
13
|
describe("eachInOrder", () => {
|
|
14
|
+
let subject: typeof eachInOrder
|
|
15
|
+
|
|
16
|
+
beforeEach(async () => {
|
|
17
|
+
const moduleRef = await Test.createTestingModule({
|
|
18
|
+
providers: [{ provide: SEQUENCE, useFactory: () => eachInOrder }],
|
|
19
|
+
}).compile()
|
|
20
|
+
subject = moduleRef.get<typeof eachInOrder>(SEQUENCE)
|
|
21
|
+
})
|
|
22
|
+
|
|
11
23
|
it("starts an item only after the one before it settled, in item order", async () => {
|
|
12
24
|
const events: Array<string> = []
|
|
13
25
|
|
|
14
|
-
await
|
|
26
|
+
await subject(new Set(["a", "b", "c"]), async (item, index) => {
|
|
15
27
|
events.push(`start ${item} ${index}`)
|
|
16
28
|
await pause()
|
|
17
29
|
events.push(`end ${item}`)
|
|
@@ -21,13 +33,13 @@ describe("eachInOrder", () => {
|
|
|
21
33
|
})
|
|
22
34
|
|
|
23
35
|
it("answers nothing for an empty list", async () => {
|
|
24
|
-
await expect(
|
|
36
|
+
await expect(subject([], () => Promise.resolve())).resolves.toBeUndefined()
|
|
25
37
|
})
|
|
26
38
|
|
|
27
39
|
it("rejects with the first failure and never starts the items after it", async () => {
|
|
28
40
|
const started: Array<number> = []
|
|
29
41
|
|
|
30
|
-
const run =
|
|
42
|
+
const run = subject([1, 2, 3], async (item) => {
|
|
31
43
|
started.push(item)
|
|
32
44
|
await pause()
|
|
33
45
|
if (item === 2) throw new SequenceError({ code: "STEP_FAILED" })
|
|
@@ -38,7 +50,7 @@ describe("eachInOrder", () => {
|
|
|
38
50
|
})
|
|
39
51
|
|
|
40
52
|
it("rejects when a step throws before it returns a promise", async () => {
|
|
41
|
-
const run =
|
|
53
|
+
const run = subject([1], (): Promise<void> => {
|
|
42
54
|
throw new SequenceError({ code: "STEP_FAILED" })
|
|
43
55
|
})
|
|
44
56
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { injector } from "@modules/platform/composition"
|
|
2
|
+
import type { TypedParameterDecorator } from "@modules/platform/composition"
|
|
3
|
+
import type { Timer } from "./retry.port"
|
|
4
|
+
|
|
5
|
+
/** The cancellable host timer provided by the retry capability. */
|
|
6
|
+
export const TIMER: unique symbol = Symbol("platform.retry.timer")
|
|
7
|
+
|
|
8
|
+
/** Injects the cancellable timer. Parameter type: Timer. */
|
|
9
|
+
export const InjectTimer = (): TypedParameterDecorator<Timer> => injector<Timer>(TIMER)
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ConfigurableModuleBuilder } from "@nestjs/common"
|
|
2
|
+
import type { RetryOptions } from "./retry.options"
|
|
3
|
+
|
|
4
|
+
/** The configurable-module base of the retry capability; the app root decides its global scope. */
|
|
5
|
+
export const { ConfigurableModuleClass, OPTIONS_TYPE } = new ConfigurableModuleBuilder<RetryOptions>()
|
|
6
|
+
.setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
|
|
7
|
+
.build()
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Module } from "@nestjs/common"
|
|
2
|
+
import type { DynamicModule } from "@nestjs/common"
|
|
3
|
+
import { TIMER } from "./retry.decorators"
|
|
4
|
+
import { ConfigurableModuleClass, OPTIONS_TYPE } from "./retry.module-definition"
|
|
5
|
+
import { SystemTimerService } from "./system-timer.service"
|
|
6
|
+
|
|
7
|
+
@Module({})
|
|
8
|
+
/** Provides the cancellable Timer port backed by the host timer API. */
|
|
9
|
+
export class RetryModule extends ConfigurableModuleClass {
|
|
10
|
+
/** Registers the capability once per app. */
|
|
11
|
+
static register(options: typeof OPTIONS_TYPE): DynamicModule {
|
|
12
|
+
const base = super.register(options)
|
|
13
|
+
return {
|
|
14
|
+
...base,
|
|
15
|
+
providers: [...(base.providers ?? []), { provide: TIMER, useClass: SystemTimerService }],
|
|
16
|
+
exports: [TIMER],
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/** The work to run when a scheduled timer expires. */
|
|
2
|
+
export type TimerCallback = () => void
|
|
3
|
+
|
|
4
|
+
/** Cancels a callback that has not run yet. */
|
|
5
|
+
export type CancelTimer = () => void
|
|
6
|
+
|
|
7
|
+
/** Schedules bounded work without exposing the ambient host timers to consumers. */
|
|
8
|
+
export interface Timer {
|
|
9
|
+
/** Schedules a callback and returns the function that cancels it. */
|
|
10
|
+
schedule(callback: TimerCallback, delayMs: number): CancelTimer
|
|
11
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Test } from "@nestjs/testing"
|
|
2
|
+
import { SystemTimerService } from "./system-timer.service"
|
|
3
|
+
|
|
4
|
+
const build = async () => {
|
|
5
|
+
const moduleRef = await Test.createTestingModule({ providers: [SystemTimerService] }).compile()
|
|
6
|
+
return moduleRef.get(SystemTimerService)
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
describe("SystemTimerService", () => {
|
|
10
|
+
beforeEach(() => jest.useFakeTimers())
|
|
11
|
+
afterEach(() => jest.useRealTimers())
|
|
12
|
+
|
|
13
|
+
it("runs a callback when its delay expires", async () => {
|
|
14
|
+
const service = await build()
|
|
15
|
+
const callback = jest.fn()
|
|
16
|
+
|
|
17
|
+
service.schedule(callback, 1000)
|
|
18
|
+
await jest.advanceTimersByTimeAsync(999)
|
|
19
|
+
expect(callback).not.toHaveBeenCalled()
|
|
20
|
+
await jest.advanceTimersByTimeAsync(1)
|
|
21
|
+
expect(callback).toHaveBeenCalledTimes(1)
|
|
22
|
+
expect(jest.getTimerCount()).toBe(0)
|
|
23
|
+
})
|
|
24
|
+
|
|
25
|
+
it("cancels a scheduled callback", async () => {
|
|
26
|
+
const service = await build()
|
|
27
|
+
const callback = jest.fn()
|
|
28
|
+
const cancel = service.schedule(callback, 1000)
|
|
29
|
+
|
|
30
|
+
cancel()
|
|
31
|
+
await jest.advanceTimersByTimeAsync(1000)
|
|
32
|
+
|
|
33
|
+
expect(callback).not.toHaveBeenCalled()
|
|
34
|
+
expect(jest.getTimerCount()).toBe(0)
|
|
35
|
+
})
|
|
36
|
+
})
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { CancelTimer, Timer, TimerCallback } from "./retry.port"
|
|
2
|
+
|
|
3
|
+
/** The production timer: owns scheduling and cancellation through the host timer API. */
|
|
4
|
+
export class SystemTimerService implements Timer {
|
|
5
|
+
/** Runs the callback after its delay unless the returned function cancels it. */
|
|
6
|
+
schedule(callback: TimerCallback, delayMs: number): CancelTimer {
|
|
7
|
+
const handle = setTimeout(callback, delayMs)
|
|
8
|
+
return () => clearTimeout(handle)
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { EnvSource } from "@modules/platform/config"
|
|
2
|
+
import { parseHttpSecurityConfig } from "@modules/platform/http-security"
|
|
3
|
+
|
|
4
|
+
describe("HTTP security environment contract", () => {
|
|
5
|
+
it("defaults to development and permits a local HTTP origin", () => {
|
|
6
|
+
const config = parseHttpSecurityConfig(
|
|
7
|
+
new EnvSource({ HTTP_SECURITY_ALLOWED_ORIGINS: "http://localhost:3000" }),
|
|
8
|
+
)
|
|
9
|
+
expect(config.allowedOrigins).toEqual(["http://localhost:3000"])
|
|
10
|
+
expect(config.allowHttpOrigins).toBe(true)
|
|
11
|
+
expect(config.rateLimit).toEqual({ windowMs: 60_000, defaultLimit: 600, strictLimit: 30 })
|
|
12
|
+
expect(config.webhooks).toEqual({})
|
|
13
|
+
})
|
|
14
|
+
|
|
15
|
+
it.each(["development", "test"])("permits HTTP origins in %s", (mode) => {
|
|
16
|
+
const config = parseHttpSecurityConfig(
|
|
17
|
+
new EnvSource({ NODE_ENV: mode, HTTP_SECURITY_ALLOWED_ORIGINS: "http://localhost:3000" }),
|
|
18
|
+
)
|
|
19
|
+
expect(config.allowedOrigins).toEqual(["http://localhost:3000"])
|
|
20
|
+
expect(config.allowHttpOrigins).toBe(true)
|
|
21
|
+
})
|
|
22
|
+
|
|
23
|
+
it("trims production HTTPS origins and reads declared rate tunables", () => {
|
|
24
|
+
const config = parseHttpSecurityConfig(
|
|
25
|
+
new EnvSource({
|
|
26
|
+
NODE_ENV: "production",
|
|
27
|
+
HTTP_SECURITY_ALLOWED_ORIGINS: " https://web.example , https://admin.example:8443 ",
|
|
28
|
+
HTTP_SECURITY_RATE_WINDOW: "2s",
|
|
29
|
+
HTTP_SECURITY_RATE_DEFAULT_LIMIT: "100",
|
|
30
|
+
HTTP_SECURITY_RATE_STRICT_LIMIT: "10",
|
|
31
|
+
}),
|
|
32
|
+
)
|
|
33
|
+
expect(config.allowedOrigins).toEqual(["https://web.example", "https://admin.example:8443"])
|
|
34
|
+
expect(config.allowHttpOrigins).toBe(false)
|
|
35
|
+
expect(config.rateLimit).toEqual({ windowMs: 2_000, defaultLimit: 100, strictLimit: 10 })
|
|
36
|
+
})
|
|
37
|
+
|
|
38
|
+
it.each(["production", "staging"])("rejects HTTP origins in %s", (mode) => {
|
|
39
|
+
expect(() =>
|
|
40
|
+
parseHttpSecurityConfig(
|
|
41
|
+
new EnvSource({
|
|
42
|
+
NODE_ENV: mode,
|
|
43
|
+
HTTP_SECURITY_ALLOWED_ORIGINS: "http://web.example",
|
|
44
|
+
}),
|
|
45
|
+
),
|
|
46
|
+
).toThrow(expect.objectContaining({ code: "HTTP_SECURITY_REQUEST_INVALID" }))
|
|
47
|
+
})
|
|
48
|
+
|
|
49
|
+
it("rejects an empty allowlist entry after a comma", () => {
|
|
50
|
+
expect(() =>
|
|
51
|
+
parseHttpSecurityConfig(new EnvSource({ HTTP_SECURITY_ALLOWED_ORIGINS: "https://web.example," })),
|
|
52
|
+
).toThrow(expect.objectContaining({ code: "HTTP_SECURITY_REQUEST_INVALID" }))
|
|
53
|
+
})
|
|
54
|
+
})
|
|
@@ -1,22 +1,20 @@
|
|
|
1
1
|
import { Module } from "@nestjs/common"
|
|
2
2
|
import type { DynamicModule } from "@nestjs/common"
|
|
3
3
|
import { APP_FILTER, APP_GUARD } from "@nestjs/core"
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
SUPABASE_ACCESS_TOKEN_VERIFIER,
|
|
8
|
-
SUPABASE_ADMIN_CLIENT,
|
|
9
|
-
createSupabaseAccessTokenVerifier,
|
|
10
|
-
createSupabaseAdminClient,
|
|
11
|
-
} from "@modules/integrations/supabase"
|
|
12
|
-
import { LivenessModule } from "@modules/domain/liveness"
|
|
4
|
+
import { AuthGuard, CredentialGuard } from "@modules/domain/identity"
|
|
5
|
+
import { createSupabaseAccessTokenVerifier } from "@modules/integrations/supabase"
|
|
13
6
|
import { ErrorsFilter } from "@modules/platform/errors"
|
|
14
7
|
import { OriginGuard, RateLimitGuard } from "@modules/platform/http-security"
|
|
15
8
|
import { platformModules } from "./compose/platform"
|
|
9
|
+
import { domainModules } from "./compose/domain"
|
|
10
|
+
import { systemModules } from "./compose/system"
|
|
11
|
+
import { apiModules } from "./compose/api"
|
|
12
|
+
import { webhooksModules } from "./compose/webhooks"
|
|
13
|
+
import { integrationProviders } from "./compose/integrations"
|
|
16
14
|
import type { ApiOptions } from "./api.options"
|
|
17
15
|
|
|
18
16
|
@Module({})
|
|
19
|
-
/** Composition root of the API: it spreads the composition groups of `compose/`, and the
|
|
17
|
+
/** Composition root of the API: it spreads the composition groups of `compose/`, and the four guards run in a fixed order. */
|
|
20
18
|
export class AppModule {
|
|
21
19
|
/** Builds the module from options parsed once at boot; nothing here reads the environment. */
|
|
22
20
|
static register(options: ApiOptions): DynamicModule {
|
|
@@ -25,19 +23,17 @@ export class AppModule {
|
|
|
25
23
|
module: AppModule,
|
|
26
24
|
imports: [
|
|
27
25
|
...platformModules(options),
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
26
|
+
...domainModules(verifyAccessToken),
|
|
27
|
+
...systemModules(),
|
|
28
|
+
...apiModules(),
|
|
29
|
+
...webhooksModules(),
|
|
31
30
|
],
|
|
32
31
|
providers: [
|
|
33
|
-
|
|
34
|
-
provide: SUPABASE_ADMIN_CLIENT,
|
|
35
|
-
useValue: createSupabaseAdminClient(options.supabase),
|
|
36
|
-
},
|
|
37
|
-
{ provide: SUPABASE_ACCESS_TOKEN_VERIFIER, useValue: verifyAccessToken },
|
|
32
|
+
...integrationProviders(options.supabase, verifyAccessToken),
|
|
38
33
|
{ provide: APP_FILTER, useClass: ErrorsFilter },
|
|
39
34
|
{ provide: APP_GUARD, useClass: RateLimitGuard },
|
|
40
35
|
{ provide: APP_GUARD, useClass: OriginGuard },
|
|
36
|
+
{ provide: APP_GUARD, useClass: CredentialGuard },
|
|
41
37
|
{ provide: APP_GUARD, useClass: AuthGuard },
|
|
42
38
|
],
|
|
43
39
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { DynamicModule, Type } from "@nestjs/common"
|
|
2
|
+
import { IdentityModule } from "@modules/domain/identity"
|
|
3
|
+
import { LivenessModule } from "@modules/domain/liveness"
|
|
4
|
+
import type { VerifySupabaseAccessToken } from "@modules/integrations/supabase"
|
|
5
|
+
|
|
6
|
+
/** The domain capabilities of the API, with the app's verified Supabase identity adapter. */
|
|
7
|
+
export const domainModules = (verifyAccessToken: VerifySupabaseAccessToken): Array<Type<unknown> | DynamicModule> => [
|
|
8
|
+
IdentityModule.register({ isGlobal: true, verifyAccessToken }),
|
|
9
|
+
LivenessModule.register({ isGlobal: true }),
|
|
10
|
+
]
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { Provider } from "@nestjs/common"
|
|
2
|
+
import {
|
|
3
|
+
SUPABASE_ACCESS_TOKEN_VERIFIER,
|
|
4
|
+
SUPABASE_ADMIN_CLIENT,
|
|
5
|
+
createSupabaseAdminClient,
|
|
6
|
+
} from "@modules/integrations/supabase"
|
|
7
|
+
import type { SupabaseOptions, VerifySupabaseAccessToken } from "@modules/integrations/supabase"
|
|
8
|
+
|
|
9
|
+
/** The Supabase integration ports bound once for this app. */
|
|
10
|
+
export const integrationProviders = (
|
|
11
|
+
options: SupabaseOptions,
|
|
12
|
+
verifyAccessToken: VerifySupabaseAccessToken,
|
|
13
|
+
): Array<Provider> => [
|
|
14
|
+
{ provide: SUPABASE_ADMIN_CLIENT, useValue: createSupabaseAdminClient(options) },
|
|
15
|
+
{ provide: SUPABASE_ACCESS_TOKEN_VERIFIER, useValue: verifyAccessToken },
|
|
16
|
+
]
|
|
@@ -9,6 +9,7 @@ import { ERRORS_MESSAGES, ErrorsModule } from "@modules/platform/errors"
|
|
|
9
9
|
import { HTTP_SECURITY_ERROR_KINDS, HTTP_SECURITY_MESSAGES, HttpSecurityModule } from "@modules/platform/http-security"
|
|
10
10
|
import { I18nModule } from "@modules/platform/i18n"
|
|
11
11
|
import { LoggingModule } from "@modules/platform/logging"
|
|
12
|
+
import { RetryModule } from "@modules/platform/retry"
|
|
12
13
|
import type { ApiOptions } from "../api.options"
|
|
13
14
|
|
|
14
15
|
/**
|
|
@@ -18,6 +19,7 @@ import type { ApiOptions } from "../api.options"
|
|
|
18
19
|
*/
|
|
19
20
|
export const platformModules = (options: ApiOptions): Array<DynamicModule> => [
|
|
20
21
|
ClockModule.register({ isGlobal: true }),
|
|
22
|
+
RetryModule.register({ isGlobal: true }),
|
|
21
23
|
LoggingModule.register({ isGlobal: true }),
|
|
22
24
|
I18nModule.register({
|
|
23
25
|
isGlobal: true,
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DynamicModule, Type } from "@nestjs/common"
|
|
2
|
+
import { SystemHealthHttpModule } from "@features/api/system-health"
|
|
3
|
+
|
|
4
|
+
/** The system probes of the app, registered independently of product API doors. */
|
|
5
|
+
export const systemModules = (): Array<Type<unknown> | DynamicModule> => [SystemHealthHttpModule.register({})]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { NestFactory } from "@nestjs/core"
|
|
2
2
|
import { SystemClockService } from "@modules/platform/clock"
|
|
3
3
|
import { EnvSource } from "@modules/platform/config"
|
|
4
|
-
import {
|
|
4
|
+
import { applyHttpSecurity } from "@modules/platform/http-security"
|
|
5
5
|
import { createJsonLogger, LoggingLogEvent } from "@modules/platform/logging"
|
|
6
6
|
import { readApiEnv } from "./api.env"
|
|
7
7
|
import { AppModule } from "./app.module"
|
|
@@ -11,9 +11,8 @@ const bootstrap = async (): Promise<void> => {
|
|
|
11
11
|
const env = EnvSource.fromProcess()
|
|
12
12
|
const options = readApiEnv(env)
|
|
13
13
|
const app = await NestFactory.create(AppModule.register(options), { rawBody: true })
|
|
14
|
-
app.
|
|
14
|
+
applyHttpSecurity(app, options.httpSecurity, { trustProxy: 1 })
|
|
15
15
|
app.enableShutdownHooks()
|
|
16
|
-
app.useGlobalPipes(app.get(RequestValidationService))
|
|
17
16
|
await app.listen(options.server.port)
|
|
18
17
|
createJsonLogger(new SystemClockService()).info(LoggingLogEvent.ServerStarted, {
|
|
19
18
|
service: "api",
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { DynamicModule } from "@nestjs/common"
|
|
2
|
+
import { ClockModule } from "@modules/platform/clock"
|
|
3
|
+
import { DatabaseModule } from "@modules/platform/database"
|
|
4
|
+
import { LoggingModule } from "@modules/platform/logging"
|
|
5
|
+
import type { CliAppOptions } from "../cli.options"
|
|
6
|
+
|
|
7
|
+
/** The shared clock, logger and least-privilege connection used by Supabase CLI commands. */
|
|
8
|
+
export const platformModules = (options: CliAppOptions): Array<DynamicModule> => [
|
|
9
|
+
ClockModule.register({ isGlobal: true }),
|
|
10
|
+
LoggingModule.register({ isGlobal: true }),
|
|
11
|
+
DatabaseModule.register({ isGlobal: true, connections: options.connections }),
|
|
12
|
+
]
|
|
@@ -1,21 +1,87 @@
|
|
|
1
|
+
import { Test } from "@nestjs/testing"
|
|
1
2
|
import type { Principal } from "@modules/platform/cqrs"
|
|
2
3
|
import { admit } from "./admission.policy"
|
|
3
|
-
import { IdentityErrorCode } from "./errors/identity.error"
|
|
4
|
+
import { IdentityError, IdentityErrorCode } from "./errors/identity.error"
|
|
5
|
+
import type { PublicMetadata } from "./identity.contracts"
|
|
4
6
|
import { PublicReason } from "./identity.contracts"
|
|
5
7
|
|
|
6
8
|
const principal: Principal = { id: "user-1", role: "authenticated" }
|
|
7
9
|
|
|
10
|
+
const ADMISSION: unique symbol = Symbol("identity.admission")
|
|
11
|
+
|
|
12
|
+
const runtimeMetadata = (source: string): PublicMetadata => {
|
|
13
|
+
try {
|
|
14
|
+
const metadata: PublicMetadata = JSON.parse(source)
|
|
15
|
+
return metadata
|
|
16
|
+
} catch (cause) {
|
|
17
|
+
throw new IdentityError({ code: IdentityErrorCode.Unauthenticated, cause })
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
|
|
8
21
|
describe("admit", () => {
|
|
22
|
+
let subject: typeof admit
|
|
23
|
+
|
|
24
|
+
beforeEach(async () => {
|
|
25
|
+
const moduleRef = await Test.createTestingModule({
|
|
26
|
+
providers: [{ provide: ADMISSION, useFactory: () => admit }],
|
|
27
|
+
}).compile()
|
|
28
|
+
subject = moduleRef.get<typeof admit>(ADMISSION)
|
|
29
|
+
})
|
|
30
|
+
|
|
9
31
|
it("admits a door that states why it is public, with or without a caller", () => {
|
|
10
|
-
expect(
|
|
11
|
-
expect(
|
|
32
|
+
expect(subject({ reason: PublicReason.Health }, undefined)).toSucceedWith(PublicReason.Health)
|
|
33
|
+
expect(subject({ reason: PublicReason.SignedWebhook }, principal)).toSucceedWith(PublicReason.SignedWebhook)
|
|
34
|
+
expect(subject({ reason: PublicReason.AuthHandshake }, undefined)).toSucceedWith(PublicReason.AuthHandshake)
|
|
35
|
+
expect(subject({ reason: PublicReason.CatalogRead }, undefined)).toSucceedWith(PublicReason.CatalogRead)
|
|
36
|
+
})
|
|
37
|
+
|
|
38
|
+
it("does not trust a reason outside the closed vocabulary", () => {
|
|
39
|
+
const outside = runtimeMetadata('{"reason":"anything"}')
|
|
40
|
+
expect(subject(outside, undefined)).toBeRefused(IdentityErrorCode.Unauthenticated)
|
|
41
|
+
expect(subject(outside, principal)).toSucceedWith(principal)
|
|
42
|
+
})
|
|
43
|
+
|
|
44
|
+
it("does not treat runtime metadata without a public reason as public", () => {
|
|
45
|
+
const metadata = runtimeMetadata("{}")
|
|
46
|
+
expect(subject(metadata, undefined)).toBeRefused(IdentityErrorCode.Unauthenticated)
|
|
47
|
+
expect(subject(metadata, principal)).toSucceedWith(principal)
|
|
12
48
|
})
|
|
13
49
|
|
|
14
50
|
it("admits the verified principal of a door that is not public", () => {
|
|
15
|
-
expect(
|
|
51
|
+
expect(subject(undefined, principal)).toSucceedWith(principal)
|
|
52
|
+
})
|
|
53
|
+
|
|
54
|
+
it("admits a credential door whose principal has the required kind", () => {
|
|
55
|
+
const credentialPrincipal = { kind: "api-key", subject: "key-1", workspaceId: "ws-1" } as const
|
|
56
|
+
const credential = { required: { kind: "api-key" }, principal: credentialPrincipal } as const
|
|
57
|
+
|
|
58
|
+
expect(subject(undefined, undefined, credential)).toSucceedWith(credentialPrincipal)
|
|
59
|
+
expect(subject(undefined, principal, credential)).toSucceedWith(credentialPrincipal)
|
|
60
|
+
expect(subject({ reason: PublicReason.Health }, principal, credential)).toSucceedWith(credentialPrincipal)
|
|
61
|
+
})
|
|
62
|
+
|
|
63
|
+
it("refuses a credential door without a credential principal, even with a session or public metadata", () => {
|
|
64
|
+
const credential = { required: { kind: "api-key" }, principal: undefined } as const
|
|
65
|
+
|
|
66
|
+
expect(subject(undefined, undefined, credential)).toBeRefused(IdentityErrorCode.Unauthenticated)
|
|
67
|
+
expect(subject(undefined, principal, credential)).toBeRefused(IdentityErrorCode.Unauthenticated)
|
|
68
|
+
expect(subject({ reason: PublicReason.Health }, principal, credential)).toBeRefused(
|
|
69
|
+
IdentityErrorCode.Unauthenticated,
|
|
70
|
+
)
|
|
71
|
+
})
|
|
72
|
+
|
|
73
|
+
it("refuses a credential principal of another kind, even with a session or public metadata", () => {
|
|
74
|
+
const credentialPrincipal = { kind: "tool-token", subject: "tool-1", workspaceId: "ws-1" } as const
|
|
75
|
+
const credential = { required: { kind: "api-key" }, principal: credentialPrincipal } as const
|
|
76
|
+
|
|
77
|
+
expect(subject(undefined, undefined, credential)).toBeRefused(IdentityErrorCode.Unauthenticated)
|
|
78
|
+
expect(subject(undefined, principal, credential)).toBeRefused(IdentityErrorCode.Unauthenticated)
|
|
79
|
+
expect(subject({ reason: PublicReason.Health }, principal, credential)).toBeRefused(
|
|
80
|
+
IdentityErrorCode.Unauthenticated,
|
|
81
|
+
)
|
|
16
82
|
})
|
|
17
83
|
|
|
18
84
|
it("refuses a door that is not public when no principal was verified", () => {
|
|
19
|
-
expect(
|
|
85
|
+
expect(subject(undefined, undefined)).toBeRefused(IdentityErrorCode.Unauthenticated)
|
|
20
86
|
})
|
|
21
87
|
})
|
|
@@ -1,14 +1,41 @@
|
|
|
1
1
|
import { ok, refused } from "@modules/platform/primitives"
|
|
2
2
|
import type { Outcome } from "@modules/platform/primitives"
|
|
3
|
+
import type { CredentialMetadata, CredentialPrincipal } from "./credential.contracts"
|
|
3
4
|
import { IdentityErrorCode } from "./errors/identity.error"
|
|
4
5
|
import type { Principal } from "@modules/platform/cqrs"
|
|
5
6
|
import type { IdentityAdmission, PublicMetadata } from "./identity.contracts"
|
|
7
|
+
import { PublicReason } from "./identity.contracts"
|
|
6
8
|
|
|
7
|
-
/**
|
|
9
|
+
/** What a credential-marked door requires and what `CredentialGuard` established for it. */
|
|
10
|
+
export interface CredentialAdmission {
|
|
11
|
+
/** The `@Credential` metadata of the door. */
|
|
12
|
+
readonly required: CredentialMetadata
|
|
13
|
+
/** The principal `CredentialGuard` set on the request, when the credential authenticated. */
|
|
14
|
+
readonly principal: CredentialPrincipal | undefined
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const admitCredential = ({
|
|
18
|
+
required,
|
|
19
|
+
principal,
|
|
20
|
+
}: CredentialAdmission): Outcome<CredentialPrincipal, IdentityErrorCode> =>
|
|
21
|
+
principal?.kind === required.kind ? ok(principal) : refused(IdentityErrorCode.Unauthenticated)
|
|
22
|
+
|
|
23
|
+
/** Admits a matching credential principal, an explicitly public door or a verified session; everything else is refused. */
|
|
8
24
|
export const admit = (
|
|
9
25
|
metadata: PublicMetadata | undefined,
|
|
10
26
|
principal: Principal | undefined,
|
|
27
|
+
credential?: CredentialAdmission,
|
|
11
28
|
): Outcome<IdentityAdmission, IdentityErrorCode> => {
|
|
12
|
-
if (
|
|
29
|
+
if (credential !== undefined) return admitCredential(credential)
|
|
30
|
+
switch (metadata?.reason) {
|
|
31
|
+
case PublicReason.Health:
|
|
32
|
+
case PublicReason.AuthHandshake:
|
|
33
|
+
case PublicReason.SignedWebhook:
|
|
34
|
+
case PublicReason.CatalogRead:
|
|
35
|
+
return ok(metadata.reason)
|
|
36
|
+
case undefined:
|
|
37
|
+
default:
|
|
38
|
+
break
|
|
39
|
+
}
|
|
13
40
|
return principal === undefined ? refused(IdentityErrorCode.Unauthenticated) : ok(principal)
|
|
14
41
|
}
|