@pikku/core 0.12.141 → 0.12.143
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 +50 -0
- package/dist/errors/errors.d.ts +1 -1
- package/dist/errors/errors.js +1 -1
- package/dist/function/function-meta.types.d.ts +6 -6
- package/dist/function/functions.types.d.ts +2 -2
- package/dist/services/audit-service.d.ts +4 -4
- package/dist/services/feature-flag-service.d.ts +3 -3
- package/dist/services/{http-personas.d.ts → http-virtual-users.d.ts} +25 -47
- package/dist/services/{http-personas.js → http-virtual-users.js} +29 -53
- package/dist/services/in-memory-queue-service.d.ts +8 -1
- package/dist/services/in-memory-queue-service.js +67 -0
- package/dist/services/incoming-webhook-service.d.ts +2 -0
- package/dist/services/incoming-webhook-service.js +4 -0
- package/dist/services/index.d.ts +2 -2
- package/dist/services/index.js +1 -1
- package/dist/services/meta-service.d.ts +6 -6
- package/dist/services/meta-service.js +8 -8
- package/dist/{wirings/workflow → services}/scenario-cookie-jar.d.ts +2 -0
- package/dist/{wirings/workflow → services}/scenario-cookie-jar.js +18 -14
- package/dist/services/scheduler-service.d.ts +3 -0
- package/dist/services/scheduler-service.js +4 -0
- package/dist/services/system-role-guard.d.ts +1 -1
- package/dist/services/virtual-user-sign-in.d.ts +52 -0
- package/dist/services/virtual-user-sign-in.js +80 -0
- package/dist/services/virtual-user-statement.d.ts +31 -0
- package/dist/services/virtual-user-statement.js +24 -0
- package/dist/services/{personas-service.d.ts → virtual-users-service.d.ts} +25 -23
- package/dist/services/{personas-service.js → virtual-users-service.js} +3 -3
- package/dist/types/core.types.d.ts +11 -11
- package/dist/wirings/queue/index.d.ts +1 -1
- package/dist/wirings/queue/queue.types.d.ts +21 -0
- package/dist/wirings/queue/signed-queue-service.d.ts +4 -1
- package/dist/wirings/queue/signed-queue-service.js +3 -0
- package/dist/wirings/role/define-system-role.d.ts +1 -1
- package/dist/wirings/role/define-system-role.js +1 -1
- package/dist/wirings/scheduler/index.d.ts +1 -1
- package/dist/wirings/scheduler/scheduler.types.d.ts +12 -0
- package/dist/wirings/{actor-flow/actor-flow.types.d.ts → virtual-user/conversation/conversation.types.d.ts} +5 -5
- package/dist/wirings/virtual-user/conversation/index.d.ts +2 -0
- package/dist/wirings/virtual-user/conversation/run-conversation.d.ts +36 -0
- package/dist/wirings/{actor-flow → virtual-user/conversation}/run-conversation.js +30 -30
- package/dist/wirings/virtual-user/define-virtual-users.d.ts +32 -0
- package/dist/wirings/{persona/define-personas.js → virtual-user/define-virtual-users.js} +9 -9
- package/dist/wirings/virtual-user/index.d.ts +30 -7
- package/dist/wirings/virtual-user/index.js +23 -4
- package/dist/wirings/virtual-user/prepare-virtual-user-run.d.ts +8 -8
- package/dist/wirings/virtual-user/prepare-virtual-user-run.js +9 -9
- package/dist/wirings/virtual-user/run-virtual-user.d.ts +6 -6
- package/dist/wirings/virtual-user/run-virtual-user.js +10 -10
- package/dist/wirings/{persona/validate-personas.d.ts → virtual-user/validate-virtual-users.d.ts} +11 -11
- package/dist/wirings/{persona/validate-personas.js → virtual-user/validate-virtual-users.js} +24 -24
- package/dist/wirings/virtual-user/virtual-user-agents.d.ts +7 -7
- package/dist/wirings/virtual-user/virtual-user-agents.js +2 -2
- package/dist/wirings/{persona/persona-app-scopes.d.ts → virtual-user/virtual-user-app-scopes.d.ts} +10 -10
- package/dist/wirings/{persona/persona-app-scopes.js → virtual-user/virtual-user-app-scopes.js} +12 -12
- package/dist/wirings/virtual-user/virtual-user-catalogue.d.ts +3 -3
- package/dist/wirings/virtual-user/virtual-user-catalogue.js +2 -2
- package/dist/wirings/{persona/persona.types.d.ts → virtual-user/virtual-user-declaration.types.d.ts} +24 -24
- package/dist/wirings/virtual-user/virtual-user-derive.js +13 -7
- package/dist/wirings/virtual-user/virtual-user-dispositions.d.ts +1 -1
- package/dist/wirings/{persona/persona-email.d.ts → virtual-user/virtual-user-email.d.ts} +11 -11
- package/dist/wirings/{persona/persona-email.js → virtual-user/virtual-user-email.js} +19 -19
- package/dist/wirings/{persona/persona-environments.d.ts → virtual-user/virtual-user-environments.d.ts} +10 -10
- package/dist/wirings/{persona/persona-environments.js → virtual-user/virtual-user-environments.js} +21 -21
- package/dist/wirings/virtual-user/virtual-user-intents.d.ts +3 -3
- package/dist/wirings/virtual-user/virtual-user-intents.js +3 -3
- package/dist/wirings/{persona/persona-mailbox.d.ts → virtual-user/virtual-user-mailbox.d.ts} +4 -4
- package/dist/wirings/virtual-user/virtual-user-run-store.d.ts +4 -4
- package/dist/wirings/virtual-user/virtual-user-scaffold.d.ts +42 -61
- package/dist/wirings/virtual-user/virtual-user-scaffold.js +69 -117
- package/dist/wirings/virtual-user/virtual-user-schedule-store.d.ts +15 -15
- package/dist/wirings/virtual-user/virtual-user-schedule.d.ts +6 -6
- package/dist/wirings/virtual-user/virtual-user-schedule.js +11 -11
- package/dist/wirings/virtual-user/virtual-user-target.d.ts +6 -6
- package/dist/wirings/virtual-user/virtual-user-target.js +5 -5
- package/dist/wirings/virtual-user/virtual-user.types.d.ts +11 -11
- package/dist/wirings/virtual-user/virtual-user.types.js +1 -1
- package/dist/wirings/workflow/dsl/workflow-dsl.types.d.ts +9 -9
- package/dist/wirings/workflow/pikku-scenario-service.d.ts +28 -28
- package/dist/wirings/workflow/pikku-scenario-service.js +77 -77
- package/dist/wirings/workflow/pikku-workflow-service.d.ts +2 -2
- package/dist/wirings/workflow/pikku-workflow-service.js +4 -4
- package/dist/wirings/workflow/scenario-prose.d.ts +8 -8
- package/dist/wirings/workflow/scenario-prose.js +12 -8
- package/dist/wirings/workflow/scenario-run.types.d.ts +13 -13
- package/dist/wirings/workflow/scenario-step.types.d.ts +23 -23
- package/dist/wirings/workflow/workflow.types.d.ts +2 -2
- package/knowledge/decisions/index.md +0 -2
- package/knowledge/decisions/internals/a-credential-name-declared-twice-must-agree-on-schema-and-type.md +29 -0
- package/knowledge/decisions/internals/a-grant-can-name-a-scope-declared-without-its-addon.md +29 -0
- package/knowledge/decisions/internals/a-latency-budget-is-asserted-by-its-cause.md +32 -0
- package/knowledge/decisions/internals/a-scheduled-task-writes-its-caller-session-before-it-runs.md +22 -0
- package/knowledge/decisions/internals/a-secret-set-in-memory-shadows-the-variable-of-the-same-name.md +28 -0
- package/knowledge/decisions/internals/a-virtual-user-acts-through-invokeraw-so-a-refusal-is-data.md +32 -0
- package/knowledge/decisions/internals/a-virtual-user-cadence-is-a-row-not-a-timer.md +12 -12
- package/knowledge/decisions/internals/a-virtual-user-converse-signs-in-before-its-first-turn.md +24 -0
- package/knowledge/decisions/internals/a-virtual-user-email-is-computed-with-the-run-id-as-a-sub-address.md +34 -0
- package/knowledge/decisions/internals/a-virtual-user-run-is-not-a-workflow-but-it-needs-a-trigger.md +2 -2
- package/knowledge/decisions/internals/a-wall-clock-threshold-is-a-load-test-in-disguise.md +3 -0
- package/knowledge/decisions/internals/an-agent-is-offered-under-its-registry-key-and-only-within-the-virtual-users-scopes.md +27 -0
- package/knowledge/decisions/internals/an-oauth2-credential-implies-an-optional-app-secret.md +26 -0
- package/knowledge/decisions/internals/analytics-identity-resolvers-run-in-declared-order.md +22 -0
- package/knowledge/decisions/internals/feature-flag-declarations-refuse-an-empty-anyof-and-conflicting-scopes.md +22 -0
- package/knowledge/decisions/internals/feature-flags-fail-open-and-never-enforce-access.md +28 -0
- package/knowledge/decisions/internals/flag-sync-rewrites-only-the-declared-text.md +24 -0
- package/knowledge/decisions/internals/in-a-scenario-a-4xx-is-data-not-an-exception.md +3 -3
- package/knowledge/decisions/internals/index.md +47 -31
- package/knowledge/decisions/internals/one-project-shape-check-two-validators.md +10 -10
- package/knowledge/decisions/internals/role-names-cannot-contain-the-scope-separator.md +30 -0
- package/knowledge/decisions/internals/scenario-agent-calls-sign-in-on-401-only.md +23 -19
- package/knowledge/decisions/internals/scenario-steps-return-drained-response-records.md +2 -2
- package/knowledge/decisions/internals/scenarios-live-in-files-named-for-them.md +12 -12
- package/knowledge/decisions/internals/the-core-scope-validator-refuses-separator-wildcard-and-empty-segments.md +22 -0
- package/knowledge/decisions/internals/the-pikku-user-id-resolves-in-a-fixed-order.md +24 -0
- package/knowledge/decisions/internals/{the-actor-prompt-says-json-because-of-json-object-mode.md → the-virtual-user-prompt-says-json-because-of-json-object-mode.md} +4 -4
- package/knowledge/decisions/internals/{the-persona-runtime-is-exported-from-the-persona-entry-point.md → the-virtual-user-runtime-is-exported-from-the-virtual-user-entry-point.md} +8 -8
- package/knowledge/decisions/internals/validate-checks-virtual-users-through-a-shared-module.md +43 -0
- package/knowledge/decisions/internals/{actor-flow-drives-the-target-through-a-transport-seam.md → virtual-user-conversation-drives-the-target-through-a-transport-seam.md} +6 -6
- package/knowledge/decisions/internals/virtual-user-conversation-verdicts-are-llm-self-evaluations.md +25 -0
- package/knowledge/decisions/internals/virtual-user-conversations-seed-a-hidden-kickoff-message.md +23 -0
- package/knowledge/decisions/internals/virtual-users-are-declared-in-one-definevirtualusers-call-per-codebase.md +30 -0
- package/knowledge/decisions/internals/workflow-core-never-imports-a-browser-driver.md +5 -5
- package/knowledge/decisions/internals/workflow-run-capabilities-are-extensions-not-subclasses.md +2 -2
- package/knowledge/decisions/internals/workflow-scenario-assertions-never-retry-and-record-one-step.md +4 -4
- package/knowledge/decisions/internals/workflow-scenario-hooks-are-a-scenario-only-affordance.md +1 -1
- package/knowledge/decisions/internals/workflow-scenario-prose-is-rendered-from-typed-calls-not-parsed-from-english.md +2 -2
- package/knowledge/decisions/internals/workflow-scenario-step-targets-are-string-literals-for-the-inspector.md +1 -1
- package/knowledge/decisions/internals/workflow-suspended-runs-keep-their-in-process-context.md +1 -1
- package/knowledge/decisions/security/a-bearer-token-checked-against-a-secret-reads-it-per-request.md +26 -0
- package/knowledge/decisions/security/a-call-without-a-session-raises-missing-session-not-forbidden.md +20 -0
- package/knowledge/decisions/security/a-caller-cookie-wins-over-the-jar-for-the-same-name.md +23 -0
- package/knowledge/decisions/security/a-channel-lifecycle-acts-as-the-socket-upgrade-session.md +16 -0
- package/knowledge/decisions/security/a-channel-requires-a-session-unless-it-says-auth-false.md +26 -0
- package/knowledge/decisions/security/a-credential-read-path-follows-its-declared-type-not-absence.md +32 -0
- package/knowledge/decisions/security/a-credential-type-is-a-literal-the-inspector-checks-at-declaration.md +27 -0
- package/knowledge/decisions/security/a-first-party-cookie-is-written-only-after-its-purposes-consent.md +33 -0
- package/knowledge/decisions/security/a-readonly-session-reaches-only-readonly-functions.md +25 -0
- package/knowledge/decisions/security/a-scaffold-flag-says-a-surface-exists-not-who-may-call-it.md +10 -5
- package/knowledge/decisions/security/a-scheduled-virtual-user-run-needs-no-admin-at-run-time.md +27 -0
- package/knowledge/decisions/security/a-scoped-credential-view-is-limited-to-declared-names.md +26 -0
- package/knowledge/decisions/security/a-scoped-secret-view-reads-only-declared-keys-and-never-writes.md +25 -0
- package/knowledge/decisions/security/a-secret-is-sent-only-to-the-hosts-it-declares.md +29 -0
- package/knowledge/decisions/security/a-step-can-name-an-identity-no-virtual-user-holds-through-per-call-headers.md +25 -0
- package/knowledge/decisions/security/a-stopped-run-by-id-skips-the-ownership-check.md +24 -0
- package/knowledge/decisions/security/a-vault-secret-redacts-on-serialization-and-throws-on-coercion.md +29 -0
- package/knowledge/decisions/security/a-virtual-user-catalogue-entry-is-filtered-by-scope-and-approval-is-denied-by-default.md +30 -0
- package/knowledge/decisions/security/a-virtual-user-environment-fails-closed.md +38 -0
- package/knowledge/decisions/security/a-virtual-user-never-runs-against-production.md +23 -0
- package/knowledge/decisions/security/a-virtual-user-reads-its-roles-from-the-apps-own-rpc-before-better-auth.md +27 -0
- package/knowledge/decisions/security/a-virtual-user-run-treats-an-unresolved-environment-as-production.md +41 -0
- package/knowledge/decisions/security/a-virtual-user-scopes-are-expanded-from-its-roles-once-at-run-preparation.md +25 -0
- package/knowledge/decisions/security/a-virtual-user-whose-roles-drift-from-the-declaration-refuses-to-run.md +32 -0
- package/knowledge/decisions/security/addon-screen-scopes-hide-and-do-not-enforce.md +20 -0
- package/knowledge/decisions/security/an-addon-header-can-only-narrow-the-session.md +26 -0
- package/knowledge/decisions/security/an-addon-instance-reads-only-the-secrets-and-credentials-it-is-named.md +33 -0
- package/knowledge/decisions/security/an-addon-may-reach-only-itself-and-the-addons-it-uses.md +16 -0
- package/knowledge/decisions/security/an-api-key-is-jwt-decoded-into-the-session.md +26 -0
- package/knowledge/decisions/security/an-external-virtual-user-caller-presents-one-signed-statement.md +38 -0
- package/knowledge/decisions/security/an-inbound-webhook-source-dispatches-only-verified-requests.md +31 -0
- package/knowledge/decisions/security/an-mcp-call-with-no-http-request-stays-anonymous.md +18 -0
- package/knowledge/decisions/security/an-omitted-user-id-addresses-the-platform-credential.md +32 -0
- package/knowledge/decisions/security/analytics-identity-is-stamped-from-the-session-not-the-event.md +24 -0
- package/knowledge/decisions/security/app-access-is-a-scope-tree-synthesised-from-virtual-users.md +26 -0
- package/knowledge/decisions/security/approval-policy-decides-who-answers-a-tool-call.md +27 -0
- package/knowledge/decisions/security/auth-false-on-a-session-function-warns-and-still-requires-one.md +25 -0
- package/knowledge/decisions/security/bearer-token-hashes-are-unpeppered-sha256.md +18 -0
- package/knowledge/decisions/security/consent-is-read-from-a-cookie-and-a-recognised-denial-counts-as-refusal.md +29 -0
- package/knowledge/decisions/security/cors-defaults-to-any-origin-and-refuses-the-wildcard-with-credentials.md +22 -0
- package/knowledge/decisions/security/credential-backends-share-one-conformance-suite-for-per-user-isolation.md +29 -0
- package/knowledge/decisions/security/each-stage-has-one-virtual-user-key-pair.md +27 -0
- package/knowledge/decisions/security/hmac-verification-fails-closed-on-empty-inputs.md +25 -0
- package/knowledge/decisions/security/index.md +88 -24
- package/knowledge/decisions/security/local-content-refuses-private-buckets-under-the-public-segment.md +21 -0
- package/knowledge/decisions/security/mail-is-allowlisted-before-a-virtual-user-run-sees-it.md +38 -0
- package/knowledge/decisions/security/mcp-resources-tools-and-prompts-take-sessionless-functions.md +18 -0
- package/knowledge/decisions/security/origin-locked-routes-match-the-origin-exactly.md +22 -0
- package/knowledge/decisions/security/oss-auth-works-without-pikku-studio-cloud.md +26 -0
- package/knowledge/decisions/security/outbound-webhooks-use-an-allowlist-when-configured.md +24 -0
- package/knowledge/decisions/security/pikku-carries-virtual-user-scopes-as-data-and-the-app-grants-them.md +35 -0
- package/knowledge/decisions/security/scoped-content-access-is-a-root-folder-with-longest-prefix-grants.md +31 -0
- package/knowledge/decisions/security/services-without-secrets-get-a-throwing-secrets-accessor.md +22 -0
- package/knowledge/decisions/security/shared-guards-refuse-to-mutate-or-shadow-a-system-role.md +34 -0
- package/knowledge/decisions/security/signed-uploads-are-verified-by-the-same-check-as-signed-reads.md +26 -0
- package/knowledge/decisions/security/system-role-scopes-must-be-declared-with-define-scope.md +24 -0
- package/knowledge/decisions/security/system-roles-are-additive-and-immutable.md +16 -0
- package/knowledge/decisions/security/the-channel-rpc-does-not-send-the-callers-session.md +21 -0
- package/knowledge/decisions/security/the-remote-jobs-inbox-fails-closed-without-a-secret.md +24 -0
- package/knowledge/decisions/security/the-remote-rpc-gate-fails-closed-and-binds-the-token-to-its-function.md +34 -0
- package/knowledge/decisions/security/the-workflow-status-stream-rechecks-ownership-on-every-poll.md +16 -0
- package/knowledge/decisions/security/two-credentials-on-one-key-must-share-a-read-mode.md +29 -0
- package/knowledge/decisions/security/verified-bearer-claims-are-pass-through-data-that-core-never-fills.md +23 -0
- package/knowledge/decisions/security/virtual-user-catalogue-excludes-the-machinery-that-runs-virtual-users.md +25 -0
- package/knowledge/decisions/security/{actor-flow-missing-approval-decisions-default-to-denied.md → virtual-user-conversation-missing-approval-decisions-default-to-denied.md} +7 -7
- package/knowledge/decisions/security/virtual-user-run-records-are-gated-behind-a-read-scope.md +18 -0
- package/knowledge/decisions/security/virtual-user-sign-in-does-not-exist-in-production.md +25 -0
- package/knowledge/decisions/security/virtual-user-sign-in-has-one-door.md +42 -0
- package/knowledge/decisions/security/{actor-sign-in-is-proven-by-set-cookie-not-a-non-empty-jar.md → virtual-user-sign-in-is-proven-by-set-cookie-not-a-non-empty-jar.md} +10 -8
- package/knowledge/decisions/security/virtual-user-sign-in-only-works-for-virtual-user-flagged-users.md +29 -0
- package/knowledge/decisions/security/workflow-helper-functions-are-sessionless-by-declaration.md +18 -0
- package/knowledge/decisions/security/{workflow-scenario-sessions-are-isolated-per-actor-and-per-scenario.md → workflow-scenario-sessions-are-isolated-per-virtual-user-and-per-scenario.md} +6 -6
- package/knowledge/decisions/security/workflow-scenario-steps-are-never-network-invocable.md +5 -5
- package/knowledge/decisions/security/{workflow-actor-steps-always-use-the-real-transport.md → workflow-virtual-user-steps-always-use-the-real-transport.md} +11 -11
- package/knowledge/decisions/security/writing-a-virtual-user-schedule-is-gated-by-its-own-scope.md +18 -0
- package/knowledge/index.md +0 -2
- package/knowledge/questions/a-bearer-jwt-with-no-identity-becomes-a-session.md +24 -0
- package/knowledge/questions/dev-quick-login-as-impersonation.md +25 -0
- package/knowledge/questions/does-a-delayed-rpc-run-as-the-session-it-was-scheduled-with.md +26 -0
- package/knowledge/questions/does-a-user-id-with-a-colon-read-another-users-credentials.md +27 -0
- package/knowledge/questions/does-a-wirecli-command-need-a-session-by-default.md +26 -0
- package/knowledge/questions/does-an-adversarial-in-scope-success-count-as-a-finding.md +26 -0
- package/knowledge/questions/does-approve-step-need-the-run-owners-session-or-the-gates-approvers.md +34 -0
- package/knowledge/questions/does-cors-origin-true-reflect-any-origin-with-credentials.md +20 -0
- package/knowledge/questions/does-skip-user-session-do-anything-on-a-channel.md +24 -0
- package/knowledge/questions/does-the-store-session-match-the-other-two.md +19 -0
- package/knowledge/questions/index.md +25 -2
- package/knowledge/questions/is-the-agent-score-worker-reachable-without-a-session.md +21 -0
- package/knowledge/questions/live-scheduled-tests-may-write.md +19 -0
- package/knowledge/questions/provision-virtual-users-has-no-caller-in-this-repo.md +23 -0
- package/knowledge/questions/remote-secret-refuses-requests-without-a-remote-token-on-every-path.md +32 -0
- package/knowledge/questions/should-a-middleware-set-session-persist-to-the-store.md +25 -0
- package/knowledge/questions/should-a-scoped-secret-view-throw-from-has-secret-for-a-disallowed-key.md +23 -0
- package/knowledge/questions/should-a-wrong-bearer-token-be-anonymous-or-refused.md +35 -0
- package/knowledge/questions/should-an-empty-webhook-signing-secret-send-unsigned.md +23 -0
- package/knowledge/questions/should-http-virtual-user-sessions-reset-between-scenarios-in-one-run.md +27 -0
- package/knowledge/questions/should-the-cookie-jar-scope-cookies-to-the-api-origin.md +26 -0
- package/knowledge/questions/should-voice-input-fetch-audio-urls-without-a-host-allowlist.md +20 -0
- package/knowledge/questions/staging-impersonation-rules.md +27 -0
- package/knowledge/questions/virtual-user-keys-on-cloud-stages-are-pikku-studios-to-build.md +33 -0
- package/knowledge/questions/virtual-user-statement-replay-is-per-process.md +20 -0
- package/knowledge/questions/what-an-impersonated-session-carries.md +22 -0
- package/package.json +2 -3
- package/src/public-surface.json +38 -47
- package/dist/services/persona-actor-secret.d.ts +0 -38
- package/dist/services/persona-actor-secret.js +0 -39
- package/dist/services/persona-sign-in.d.ts +0 -117
- package/dist/services/persona-sign-in.js +0 -154
- package/dist/wirings/actor-flow/index.d.ts +0 -2
- package/dist/wirings/actor-flow/run-conversation.d.ts +0 -36
- package/dist/wirings/persona/define-personas.d.ts +0 -32
- package/dist/wirings/persona/index.d.ts +0 -23
- package/dist/wirings/persona/index.js +0 -19
- package/knowledge/decisions/internals/actor-flow-conversations-seed-a-hidden-kickoff-message.md +0 -23
- package/knowledge/decisions/internals/actor-flow-verdicts-are-llm-self-evaluations.md +0 -25
- package/knowledge/decisions/internals/validate-checks-personas-through-a-shared-module.md +0 -43
- package/knowledge/decisions/security/actor-sign-in-only-works-for-actor-flagged-users.md +0 -31
- package/knowledge/decisions/security/an-actor-credential-is-derived-per-persona.md +0 -42
- package/knowledge/decisions/security/pikku-carries-actor-scopes-as-data-and-the-app-grants-them.md +0 -26
- /package/dist/wirings/{actor-flow/actor-flow.types.js → virtual-user/conversation/conversation.types.js} +0 -0
- /package/dist/wirings/{actor-flow → virtual-user/conversation}/index.js +0 -0
- /package/dist/wirings/{persona/persona.types.js → virtual-user/virtual-user-declaration.types.js} +0 -0
- /package/dist/wirings/{persona/persona-mailbox.js → virtual-user/virtual-user-mailbox.js} +0 -0
package/dist/wirings/{persona/validate-personas.d.ts → virtual-user/validate-virtual-users.d.ts}
RENAMED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { VirtualUserDefinitions, VirtualUserMeta, VirtualUsersMeta } from './virtual-user-declaration.types.js';
|
|
2
2
|
/**
|
|
3
|
-
* Whether a
|
|
3
|
+
* Whether a virtual user can actually be run.
|
|
4
4
|
*
|
|
5
5
|
* A provider login cannot: driving Google's or GitHub's consent screen needs a
|
|
6
|
-
* human, so the
|
|
6
|
+
* human, so the virtual user is seedable and assertable but not runnable. Derived
|
|
7
7
|
* rather than asked for, because it is a consequence of the account rather than
|
|
8
8
|
* a separate decision — and a flag someone must remember to set is a flag that
|
|
9
9
|
* ships wrong.
|
|
@@ -11,22 +11,22 @@ import type { PersonaDefinitions, PersonaMeta, PersonasMeta } from './persona.ty
|
|
|
11
11
|
* An explicit `runnable: false` still wins: it marks the person who is only
|
|
12
12
|
* ever acted *upon*, which no account shape reveals.
|
|
13
13
|
*/
|
|
14
|
-
export declare const
|
|
14
|
+
export declare const isRunnableVirtualUser: (virtualUser: {
|
|
15
15
|
runnable?: boolean;
|
|
16
16
|
account?: {
|
|
17
17
|
provider?: string;
|
|
18
18
|
};
|
|
19
19
|
}) => boolean;
|
|
20
20
|
/**
|
|
21
|
-
* Validates declared
|
|
21
|
+
* Validates declared virtual users and keys them by id.
|
|
22
22
|
*
|
|
23
23
|
* Definitions sharing an id must be identical; a conflicting redeclaration is a
|
|
24
24
|
* hard error naming both source files, on the same terms as scopes and roles.
|
|
25
25
|
*/
|
|
26
|
-
export declare function
|
|
26
|
+
export declare function validateAndBuildVirtualUsersMeta(definitions: VirtualUserDefinitions): VirtualUsersMeta;
|
|
27
27
|
/** What a run compares against the store before its first step. */
|
|
28
28
|
export interface RoleVerification {
|
|
29
|
-
|
|
29
|
+
virtualUserId: string;
|
|
30
30
|
expected: string[];
|
|
31
31
|
actual: string[];
|
|
32
32
|
missing: string[];
|
|
@@ -34,20 +34,20 @@ export interface RoleVerification {
|
|
|
34
34
|
ok: boolean;
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* Compares a
|
|
37
|
+
* Compares a virtual user's declared roles against what the stage actually granted.
|
|
38
38
|
*
|
|
39
39
|
* Run at sign-in, before the first step. The declaration is authoritative —
|
|
40
40
|
* the generated seed applies it — but pikku cannot guarantee the seed ran on a
|
|
41
41
|
* stage it did not deploy, and virtual users are meant to run against staging
|
|
42
42
|
* and production, so that case is the normal one.
|
|
43
43
|
*
|
|
44
|
-
* Both directions matter, for opposite reasons. An under-granted
|
|
44
|
+
* Both directions matter, for opposite reasons. An under-granted virtual user
|
|
45
45
|
* reports authorization bugs that are really seed drift. An over-granted one
|
|
46
46
|
* silently stops testing the boundary it was written to test — nothing fails,
|
|
47
47
|
* the findings just quietly stop being about anything.
|
|
48
48
|
*/
|
|
49
|
-
export declare const
|
|
49
|
+
export declare const verifyVirtualUserRoles: (virtualUserId: string, expected: readonly string[], actual: readonly string[]) => RoleVerification;
|
|
50
50
|
/** The message a run stops with, or `null` when the roles line up. */
|
|
51
51
|
export declare const roleMismatchMessage: (verification: RoleVerification) => string | null;
|
|
52
52
|
/** Convenience: the meta a run needs, with `runnable` already resolved. */
|
|
53
|
-
export declare const
|
|
53
|
+
export declare const runnableVirtualUsers: (meta: VirtualUsersMeta) => VirtualUserMeta[];
|
package/dist/wirings/{persona/validate-personas.js → virtual-user/validate-virtual-users.js}
RENAMED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Whether a
|
|
2
|
+
* Whether a virtual user can actually be run.
|
|
3
3
|
*
|
|
4
4
|
* A provider login cannot: driving Google's or GitHub's consent screen needs a
|
|
5
|
-
* human, so the
|
|
5
|
+
* human, so the virtual user is seedable and assertable but not runnable. Derived
|
|
6
6
|
* rather than asked for, because it is a consequence of the account rather than
|
|
7
7
|
* a separate decision — and a flag someone must remember to set is a flag that
|
|
8
8
|
* ships wrong.
|
|
@@ -10,62 +10,62 @@
|
|
|
10
10
|
* An explicit `runnable: false` still wins: it marks the person who is only
|
|
11
11
|
* ever acted *upon*, which no account shape reveals.
|
|
12
12
|
*/
|
|
13
|
-
export const
|
|
14
|
-
if (
|
|
13
|
+
export const isRunnableVirtualUser = (virtualUser) => {
|
|
14
|
+
if (virtualUser.runnable === false) {
|
|
15
15
|
return false;
|
|
16
16
|
}
|
|
17
|
-
return
|
|
17
|
+
return virtualUser.account?.provider === undefined;
|
|
18
18
|
};
|
|
19
19
|
/**
|
|
20
|
-
* Validates declared
|
|
20
|
+
* Validates declared virtual users and keys them by id.
|
|
21
21
|
*
|
|
22
22
|
* Definitions sharing an id must be identical; a conflicting redeclaration is a
|
|
23
23
|
* hard error naming both source files, on the same terms as scopes and roles.
|
|
24
24
|
*/
|
|
25
|
-
export function
|
|
25
|
+
export function validateAndBuildVirtualUsersMeta(definitions) {
|
|
26
26
|
const meta = {};
|
|
27
|
-
for (const
|
|
28
|
-
if (!
|
|
29
|
-
throw new Error('A
|
|
27
|
+
for (const virtualUser of definitions) {
|
|
28
|
+
if (!virtualUser.id) {
|
|
29
|
+
throw new Error('A virtual user is declared with an empty id.');
|
|
30
30
|
}
|
|
31
|
-
if (!
|
|
32
|
-
throw new Error(`
|
|
31
|
+
if (!virtualUser.name) {
|
|
32
|
+
throw new Error(`VirtualUser '${virtualUser.id}' has no name. A virtual user is a person; give them one.`);
|
|
33
33
|
}
|
|
34
|
-
const existing = meta[
|
|
34
|
+
const existing = meta[virtualUser.id];
|
|
35
35
|
if (existing) {
|
|
36
36
|
const same = JSON.stringify({ ...existing, sourceFile: undefined }) ===
|
|
37
|
-
JSON.stringify({ ...
|
|
37
|
+
JSON.stringify({ ...virtualUser, sourceFile: undefined });
|
|
38
38
|
if (!same) {
|
|
39
|
-
throw new Error(`
|
|
39
|
+
throw new Error(`VirtualUser '${virtualUser.id}' is declared twice with different content.\n` +
|
|
40
40
|
` First declaration: ${existing.sourceFile ?? 'unknown'}\n` +
|
|
41
|
-
` Second declaration: ${
|
|
41
|
+
` Second declaration: ${virtualUser.sourceFile ?? 'unknown'}`);
|
|
42
42
|
}
|
|
43
43
|
continue;
|
|
44
44
|
}
|
|
45
|
-
meta[
|
|
45
|
+
meta[virtualUser.id] = virtualUser;
|
|
46
46
|
}
|
|
47
47
|
return meta;
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
|
-
* Compares a
|
|
50
|
+
* Compares a virtual user's declared roles against what the stage actually granted.
|
|
51
51
|
*
|
|
52
52
|
* Run at sign-in, before the first step. The declaration is authoritative —
|
|
53
53
|
* the generated seed applies it — but pikku cannot guarantee the seed ran on a
|
|
54
54
|
* stage it did not deploy, and virtual users are meant to run against staging
|
|
55
55
|
* and production, so that case is the normal one.
|
|
56
56
|
*
|
|
57
|
-
* Both directions matter, for opposite reasons. An under-granted
|
|
57
|
+
* Both directions matter, for opposite reasons. An under-granted virtual user
|
|
58
58
|
* reports authorization bugs that are really seed drift. An over-granted one
|
|
59
59
|
* silently stops testing the boundary it was written to test — nothing fails,
|
|
60
60
|
* the findings just quietly stop being about anything.
|
|
61
61
|
*/
|
|
62
|
-
export const
|
|
62
|
+
export const verifyVirtualUserRoles = (virtualUserId, expected, actual) => {
|
|
63
63
|
const expectedSet = new Set(expected);
|
|
64
64
|
const actualSet = new Set(actual);
|
|
65
65
|
const missing = [...expectedSet].filter((r) => !actualSet.has(r)).sort();
|
|
66
66
|
const extra = [...actualSet].filter((r) => !expectedSet.has(r)).sort();
|
|
67
67
|
return {
|
|
68
|
-
|
|
68
|
+
virtualUserId,
|
|
69
69
|
expected: [...expectedSet].sort(),
|
|
70
70
|
actual: [...actualSet].sort(),
|
|
71
71
|
missing,
|
|
@@ -85,10 +85,10 @@ export const roleMismatchMessage = (verification) => {
|
|
|
85
85
|
if (verification.extra.length) {
|
|
86
86
|
parts.push(`unexpectedly holds ${verification.extra.join(', ')}`);
|
|
87
87
|
}
|
|
88
|
-
return (`
|
|
88
|
+
return (`VirtualUser '${verification.virtualUserId}' ${parts.join(' and ')}. ` +
|
|
89
89
|
`Declared: ${verification.expected.join(', ') || 'none'}. ` +
|
|
90
90
|
`On the stage: ${verification.actual.join(', ') || 'none'}. ` +
|
|
91
|
-
`Refusing to run — findings from a
|
|
91
|
+
`Refusing to run — findings from a virtual user whose roles have drifted are about the seed, not the product.`);
|
|
92
92
|
};
|
|
93
93
|
/** Convenience: the meta a run needs, with `runnable` already resolved. */
|
|
94
|
-
export const
|
|
94
|
+
export const runnableVirtualUsers = (meta) => Object.values(meta).filter((virtualUser) => virtualUser.runnable);
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Which of the product's agents a
|
|
2
|
+
* Which of the product's agents a virtual user can actually talk to.
|
|
3
3
|
*
|
|
4
|
-
* An agent is not something a
|
|
4
|
+
* An agent is not something a virtual user declares. It is something a virtual user
|
|
5
5
|
* *reaches*, under exactly the rule an RPC is reached by: `CoreAgent.scopes`
|
|
6
|
-
* is checked against the session, so a
|
|
6
|
+
* is checked against the session, so a virtual user holding the scopes an agent
|
|
7
7
|
* requires finds it in front of them, and one that does not, does not.
|
|
8
8
|
*
|
|
9
|
-
* That is the whole reason a
|
|
9
|
+
* That is the whole reason a virtual user has no `agent:` field. Naming one would
|
|
10
10
|
* add no capability the roles do not already confer, and would narrow the
|
|
11
|
-
*
|
|
11
|
+
* virtual user to a single brain when the interesting behaviour is the choice
|
|
12
12
|
* between calling the API directly and handing the work to a specialist.
|
|
13
13
|
*/
|
|
14
14
|
/** The part of an agent's meta this needs. */
|
|
@@ -28,12 +28,12 @@ export interface ReachableAgent {
|
|
|
28
28
|
* That key is the export's own name, which is what `addAgent` stores and what
|
|
29
29
|
* `resolveAgent` looks up. The `name` an agent declares in its config is a
|
|
30
30
|
* display label and is frequently something else entirely — offering that one
|
|
31
|
-
* hands the
|
|
31
|
+
* hands the virtual user a name the server cannot resolve, and the run dies on a
|
|
32
32
|
* 500 the moment it takes the offer.
|
|
33
33
|
*
|
|
34
34
|
* Like {@link reachableCatalogue}, this narrows *what is offered* and never
|
|
35
35
|
* what is enforced: the server decides who may talk to what, and an agent
|
|
36
|
-
* answering a
|
|
36
|
+
* answering a virtual user this filter would have withheld is a finding rather than
|
|
37
37
|
* a bug here.
|
|
38
38
|
*
|
|
39
39
|
* An agent declaring no scopes is offered to everybody, on the same terms as a
|
|
@@ -5,12 +5,12 @@ import { hasScopes } from '../../scopes.js';
|
|
|
5
5
|
* That key is the export's own name, which is what `addAgent` stores and what
|
|
6
6
|
* `resolveAgent` looks up. The `name` an agent declares in its config is a
|
|
7
7
|
* display label and is frequently something else entirely — offering that one
|
|
8
|
-
* hands the
|
|
8
|
+
* hands the virtual user a name the server cannot resolve, and the run dies on a
|
|
9
9
|
* 500 the moment it takes the offer.
|
|
10
10
|
*
|
|
11
11
|
* Like {@link reachableCatalogue}, this narrows *what is offered* and never
|
|
12
12
|
* what is enforced: the server decides who may talk to what, and an agent
|
|
13
|
-
* answering a
|
|
13
|
+
* answering a virtual user this filter would have withheld is a finding rather than
|
|
14
14
|
* a bug here.
|
|
15
15
|
*
|
|
16
16
|
* An agent declaring no scopes is offered to everybody, on the same terms as a
|
package/dist/wirings/{persona/persona-app-scopes.d.ts → virtual-user/virtual-user-app-scopes.d.ts}
RENAMED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ScopeDefinitionMeta } from '../scope/scope.types.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { VirtualUserMeta } from './virtual-user-declaration.types.js';
|
|
3
3
|
/**
|
|
4
4
|
* The root every app grant hangs off. One segment, so a grant of `app` alone
|
|
5
5
|
* means "may use all of them" under the same parent-grant rule the admin tree
|
|
@@ -10,16 +10,16 @@ export declare const APP_SCOPE_ROOT = "app";
|
|
|
10
10
|
/** `app:staff` for `staff`. */
|
|
11
11
|
export declare const appScopeId: (app: string) => string;
|
|
12
12
|
/**
|
|
13
|
-
* The apps named across the declared
|
|
13
|
+
* The apps named across the declared virtual users, sorted and deduplicated.
|
|
14
14
|
*
|
|
15
|
-
* The
|
|
15
|
+
* The virtual users *are* the registry. There is no separate list of apps to keep in
|
|
16
16
|
* step, because a frontend nobody signs into is not a thing the auth layer has
|
|
17
17
|
* an opinion about — and the moment somebody does sign into it, they are a
|
|
18
|
-
*
|
|
18
|
+
* virtual user and they name it.
|
|
19
19
|
*/
|
|
20
|
-
export declare const declaredApps: (
|
|
20
|
+
export declare const declaredApps: (virtualUsers: VirtualUserMeta[]) => string[];
|
|
21
21
|
/**
|
|
22
|
-
* The `app` scope tree, synthesised from the
|
|
22
|
+
* The `app` scope tree, synthesised from the virtual users that name an app.
|
|
23
23
|
*
|
|
24
24
|
* Which frontend a person may sign into is a different question from what they
|
|
25
25
|
* may do once inside it, but it is the same *kind* of question — a grant that
|
|
@@ -31,11 +31,11 @@ export declare const declaredApps: (personas: PersonaMeta[]) => string[];
|
|
|
31
31
|
*
|
|
32
32
|
* Synthesised rather than written by hand because the declaration already
|
|
33
33
|
* exists. Asking an app to also spell out `defineScope({ app: { staff: {} } })`
|
|
34
|
-
* beside its
|
|
35
|
-
* a
|
|
34
|
+
* beside its virtual users invites the two to drift, and the failure that produces —
|
|
35
|
+
* a virtual user provisioned with a grant the vocabulary no longer declares — is one
|
|
36
36
|
* `pikku scopes prune` away from silently revoking sign-in.
|
|
37
37
|
*
|
|
38
|
-
* Null when no
|
|
38
|
+
* Null when no virtual user names an app, which is the single-frontend case: nothing
|
|
39
39
|
* to declare, and no empty root cluttering the console's grant list.
|
|
40
40
|
*/
|
|
41
|
-
export declare const buildAppScopeDefinition: (
|
|
41
|
+
export declare const buildAppScopeDefinition: (virtualUsers: VirtualUserMeta[]) => ScopeDefinitionMeta | null;
|
package/dist/wirings/{persona/persona-app-scopes.js → virtual-user/virtual-user-app-scopes.js}
RENAMED
|
@@ -8,20 +8,20 @@ export const APP_SCOPE_ROOT = 'app';
|
|
|
8
8
|
/** `app:staff` for `staff`. */
|
|
9
9
|
export const appScopeId = (app) => `${APP_SCOPE_ROOT}:${app}`;
|
|
10
10
|
/**
|
|
11
|
-
* The apps named across the declared
|
|
11
|
+
* The apps named across the declared virtual users, sorted and deduplicated.
|
|
12
12
|
*
|
|
13
|
-
* The
|
|
13
|
+
* The virtual users *are* the registry. There is no separate list of apps to keep in
|
|
14
14
|
* step, because a frontend nobody signs into is not a thing the auth layer has
|
|
15
15
|
* an opinion about — and the moment somebody does sign into it, they are a
|
|
16
|
-
*
|
|
16
|
+
* virtual user and they name it.
|
|
17
17
|
*/
|
|
18
|
-
export const declaredApps = (
|
|
19
|
-
...new Set(
|
|
20
|
-
.map((
|
|
18
|
+
export const declaredApps = (virtualUsers) => [
|
|
19
|
+
...new Set(virtualUsers
|
|
20
|
+
.map((virtualUser) => virtualUser.app)
|
|
21
21
|
.filter((app) => typeof app === 'string' && app !== '')),
|
|
22
22
|
].sort();
|
|
23
23
|
/**
|
|
24
|
-
* The `app` scope tree, synthesised from the
|
|
24
|
+
* The `app` scope tree, synthesised from the virtual users that name an app.
|
|
25
25
|
*
|
|
26
26
|
* Which frontend a person may sign into is a different question from what they
|
|
27
27
|
* may do once inside it, but it is the same *kind* of question — a grant that
|
|
@@ -33,15 +33,15 @@ export const declaredApps = (personas) => [
|
|
|
33
33
|
*
|
|
34
34
|
* Synthesised rather than written by hand because the declaration already
|
|
35
35
|
* exists. Asking an app to also spell out `defineScope({ app: { staff: {} } })`
|
|
36
|
-
* beside its
|
|
37
|
-
* a
|
|
36
|
+
* beside its virtual users invites the two to drift, and the failure that produces —
|
|
37
|
+
* a virtual user provisioned with a grant the vocabulary no longer declares — is one
|
|
38
38
|
* `pikku scopes prune` away from silently revoking sign-in.
|
|
39
39
|
*
|
|
40
|
-
* Null when no
|
|
40
|
+
* Null when no virtual user names an app, which is the single-frontend case: nothing
|
|
41
41
|
* to declare, and no empty root cluttering the console's grant list.
|
|
42
42
|
*/
|
|
43
|
-
export const buildAppScopeDefinition = (
|
|
44
|
-
const apps = declaredApps(
|
|
43
|
+
export const buildAppScopeDefinition = (virtualUsers) => {
|
|
44
|
+
const apps = declaredApps(virtualUsers);
|
|
45
45
|
if (apps.length === 0) {
|
|
46
46
|
return null;
|
|
47
47
|
}
|
|
@@ -28,7 +28,7 @@ export declare const renderCatalogue: (entries: readonly ApiCatalogueEntry[]) =>
|
|
|
28
28
|
/**
|
|
29
29
|
* The entries a given user may reach: approval-gated calls dropped unless the
|
|
30
30
|
* run opted in, mutations dropped for a read-only disposition, and anything the
|
|
31
|
-
*
|
|
31
|
+
* virtual user's tier cannot satisfy dropped when the caller supplied one.
|
|
32
32
|
*
|
|
33
33
|
* This narrows *what is offered*, never what is enforced — the server is the
|
|
34
34
|
* only thing that decides who may call what, and a call this filter would have
|
|
@@ -38,7 +38,7 @@ export declare const reachableCatalogue: (entries: readonly ApiCatalogueEntry[],
|
|
|
38
38
|
readOnly?: boolean;
|
|
39
39
|
allowApprovalRequired?: boolean;
|
|
40
40
|
/**
|
|
41
|
-
* The scopes this
|
|
41
|
+
* The scopes this virtual user holds, resolved from its roles. Omit to keep
|
|
42
42
|
* every entry.
|
|
43
43
|
*
|
|
44
44
|
* Scopes rather than permission-function names: a function's `scopes` are
|
|
@@ -49,7 +49,7 @@ export declare const reachableCatalogue: (entries: readonly ApiCatalogueEntry[],
|
|
|
49
49
|
scopes?: readonly string[];
|
|
50
50
|
}) => ApiCatalogueEntry[];
|
|
51
51
|
/**
|
|
52
|
-
* Endpoints this
|
|
52
|
+
* Endpoints this virtual user is *not* entitled to reach.
|
|
53
53
|
*
|
|
54
54
|
* The adversarial oracle. Withheld from the catalogue, so reaching one takes
|
|
55
55
|
* initiative — and a 2xx from one is the finding, because the server is the
|
|
@@ -67,7 +67,7 @@ export const renderCatalogue = (entries) => entries.map(renderEntry).join('\n');
|
|
|
67
67
|
/**
|
|
68
68
|
* The entries a given user may reach: approval-gated calls dropped unless the
|
|
69
69
|
* run opted in, mutations dropped for a read-only disposition, and anything the
|
|
70
|
-
*
|
|
70
|
+
* virtual user's tier cannot satisfy dropped when the caller supplied one.
|
|
71
71
|
*
|
|
72
72
|
* This narrows *what is offered*, never what is enforced — the server is the
|
|
73
73
|
* only thing that decides who may call what, and a call this filter would have
|
|
@@ -84,7 +84,7 @@ export const reachableCatalogue = (entries, { readOnly = false, allowApprovalReq
|
|
|
84
84
|
return true;
|
|
85
85
|
});
|
|
86
86
|
/**
|
|
87
|
-
* Endpoints this
|
|
87
|
+
* Endpoints this virtual user is *not* entitled to reach.
|
|
88
88
|
*
|
|
89
89
|
* The adversarial oracle. Withheld from the catalogue, so reaching one takes
|
|
90
90
|
* initiative — and a 2xx from one is the finding, because the server is the
|
package/dist/wirings/{persona/persona.types.d.ts → virtual-user/virtual-user-declaration.types.d.ts}
RENAMED
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
import type { VirtualUserDisposition } from '../virtual-user/virtual-user.types.js';
|
|
2
2
|
import type { VirtualUserTuning } from '../virtual-user/virtual-user-dispositions.js';
|
|
3
3
|
/**
|
|
4
|
-
* One login belonging to a
|
|
4
|
+
* One login belonging to a virtual user.
|
|
5
5
|
*
|
|
6
6
|
* Deliberately near-empty in the common case: the address is computed from the
|
|
7
|
-
*
|
|
8
|
-
*
|
|
7
|
+
* virtual user's name and the run id, and sign-in needs no password, so there is
|
|
8
|
+
* nothing left to write down. It fills up
|
|
9
9
|
* only for a provider login.
|
|
10
10
|
*
|
|
11
11
|
* Shaped after better-auth's `account` table, which is what most pikku apps are
|
|
12
12
|
* actually running: `providerId` plus the provider's own id, and no email
|
|
13
13
|
* column — the address belongs to the person, not the login.
|
|
14
14
|
*/
|
|
15
|
-
export type
|
|
15
|
+
export type CoreVirtualUserAccount = {
|
|
16
16
|
/**
|
|
17
17
|
* The identity provider, e.g. `'google'`. Omit for email and password.
|
|
18
18
|
*
|
|
19
19
|
* A provider account is declarable but not runnable: driving its consent
|
|
20
|
-
* screen needs a human, so `pikku
|
|
20
|
+
* screen needs a human, so `pikku virtual-user run` refuses rather than failing
|
|
21
21
|
* somewhere inside a browser.
|
|
22
22
|
*/
|
|
23
23
|
provider?: string;
|
|
@@ -26,12 +26,12 @@ export type CorePersonaAccount = {
|
|
|
26
26
|
* A person who uses your product: a name, a job, a temperament, and what they
|
|
27
27
|
* are trying to get done.
|
|
28
28
|
*
|
|
29
|
-
* This is Cooper's
|
|
29
|
+
* This is Cooper's virtual user — "a fictional character created to represent a user
|
|
30
30
|
* type" — with the two things a synthetic user additionally needs: the roles
|
|
31
|
-
* that say what they may do, and the account they log in with. A
|
|
31
|
+
* that say what they may do, and the account they log in with. A virtual user while
|
|
32
32
|
* running is a virtual user; there is no second declaration for that.
|
|
33
33
|
*/
|
|
34
|
-
export type
|
|
34
|
+
export type CoreVirtualUser = {
|
|
35
35
|
/** The person's name, as a person would give it. */
|
|
36
36
|
name: string;
|
|
37
37
|
jobTitle?: string;
|
|
@@ -41,14 +41,14 @@ export type CorePersona = {
|
|
|
41
41
|
* serves, an asset on a CDN, a Gravatar link.
|
|
42
42
|
*
|
|
43
43
|
* Optional because it is decoration. Omitted, the console draws a colour and
|
|
44
|
-
* an icon derived from the
|
|
44
|
+
* an icon derived from the virtual user's id, which is stable, needs no network and
|
|
45
45
|
* is more legible than the identicon a synthetic address would resolve to —
|
|
46
46
|
* which is also why nothing is derived here.
|
|
47
47
|
*/
|
|
48
48
|
avatarUrl?: string;
|
|
49
49
|
/**
|
|
50
50
|
* The roles this person holds. Only system roles may be named — a custom
|
|
51
|
-
* role can be deleted from the console, so a
|
|
51
|
+
* role can be deleted from the console, so a virtual user pinned to one silently
|
|
52
52
|
* stops testing what it claims to.
|
|
53
53
|
*
|
|
54
54
|
* These are granted, not merely recorded: the generated seed applies them,
|
|
@@ -74,15 +74,15 @@ export type CorePersona = {
|
|
|
74
74
|
/** Fixture paths this person may upload, relative to the project root. */
|
|
75
75
|
fixtures?: string[];
|
|
76
76
|
/** Their login. `{}` — email and password — is the normal case. */
|
|
77
|
-
account?:
|
|
77
|
+
account?: CoreVirtualUserAccount;
|
|
78
78
|
/**
|
|
79
79
|
* Further logins belonging to the same human, keyed by name.
|
|
80
80
|
*
|
|
81
|
-
* Rare, and shaped that way on purpose. All of them share the
|
|
81
|
+
* Rare, and shaped that way on purpose. All of them share the virtual user's one
|
|
82
82
|
* computed address: better-auth's `allowDifferentEmails` defaults to false,
|
|
83
83
|
* so distinct addresses would be refused linking by the library under test.
|
|
84
84
|
*/
|
|
85
|
-
linkedAccounts?: Record<string,
|
|
85
|
+
linkedAccounts?: Record<string, CoreVirtualUserAccount>;
|
|
86
86
|
/**
|
|
87
87
|
* The environments this person may run against, by config key.
|
|
88
88
|
*
|
|
@@ -100,7 +100,7 @@ export type CorePersona = {
|
|
|
100
100
|
*
|
|
101
101
|
* An assertion, not something inferred from the absence of a disposition:
|
|
102
102
|
* `target` *must not* run, because a run signing in as her would race the
|
|
103
|
-
* scenario banning her. "Nobody has given this
|
|
103
|
+
* scenario banning her. "Nobody has given this virtual user a disposition yet" is
|
|
104
104
|
* a different state, and collapsing the two turns a deliberate constraint
|
|
105
105
|
* into a flaky suite.
|
|
106
106
|
*/
|
|
@@ -110,20 +110,20 @@ export type CorePersona = {
|
|
|
110
110
|
*
|
|
111
111
|
* A person uses one of them — staff their app, customers theirs — and that is
|
|
112
112
|
* what decides where a browser step navigates: `/dashboard` is a different
|
|
113
|
-
* page in each, so the
|
|
113
|
+
* page in each, so the virtual user settles which one without the scenario saying.
|
|
114
114
|
* The runner takes the base url per app (`--app-url <app>=<url>`, or
|
|
115
|
-
* `appUrls` on the environment) and each
|
|
115
|
+
* `appUrls` on the environment) and each virtual user browses against its own.
|
|
116
116
|
*
|
|
117
117
|
* Omitted is the normal case: one app, one url, nothing to say.
|
|
118
118
|
*/
|
|
119
119
|
app?: string;
|
|
120
120
|
};
|
|
121
|
-
/**
|
|
122
|
-
export type
|
|
123
|
-
export type
|
|
121
|
+
/** Virtual users to declare, keyed by id. */
|
|
122
|
+
export type CoreVirtualUsers = Record<string, CoreVirtualUser>;
|
|
123
|
+
export type VirtualUserAccountMeta = {
|
|
124
124
|
provider?: string;
|
|
125
125
|
};
|
|
126
|
-
export type
|
|
126
|
+
export type VirtualUserMeta = {
|
|
127
127
|
/** The key it was declared under. */
|
|
128
128
|
id: string;
|
|
129
129
|
name: string;
|
|
@@ -137,8 +137,8 @@ export type PersonaMeta = {
|
|
|
137
137
|
disposition?: VirtualUserDisposition;
|
|
138
138
|
tuning?: VirtualUserTuning;
|
|
139
139
|
fixtures?: string[];
|
|
140
|
-
account?:
|
|
141
|
-
linkedAccounts?: Record<string,
|
|
140
|
+
account?: VirtualUserAccountMeta;
|
|
141
|
+
linkedAccounts?: Record<string, VirtualUserAccountMeta>;
|
|
142
142
|
/** Absent means "everywhere but production", which is resolved, not stored. */
|
|
143
143
|
environments?: string[];
|
|
144
144
|
runnable: boolean;
|
|
@@ -146,5 +146,5 @@ export type PersonaMeta = {
|
|
|
146
146
|
app?: string;
|
|
147
147
|
sourceFile?: string;
|
|
148
148
|
};
|
|
149
|
-
export type
|
|
150
|
-
export type
|
|
149
|
+
export type VirtualUserDefinitions = VirtualUserMeta[];
|
|
150
|
+
export type VirtualUsersMeta = Record<string, VirtualUserMeta>;
|
|
@@ -25,9 +25,9 @@ export const deriveCatalogue = (functions, schemas = {}) => {
|
|
|
25
25
|
if (meta.expose !== true)
|
|
26
26
|
continue;
|
|
27
27
|
// A virtual user is not offered the machinery that runs virtual users. A
|
|
28
|
-
//
|
|
28
|
+
// virtual user whose role carries `virtualUser:*` would otherwise be able to
|
|
29
29
|
// start further runs, read every run's findings — an adversarial run's
|
|
30
|
-
// transcript is working exploits against this same app — and put a
|
|
30
|
+
// transcript is working exploits against this same app — and put a virtual user
|
|
31
31
|
// on a schedule that outlives it. Same reasoning as the scenario-step rule
|
|
32
32
|
// above: the tool is about the run, not about the product being explored.
|
|
33
33
|
if (meta.scopes?.some((scope) => scope.split(':')[0] === 'virtualUser')) {
|
|
@@ -68,15 +68,21 @@ export const deriveCatalogue = (functions, schemas = {}) => {
|
|
|
68
68
|
const scenarioSteps = (meta) => {
|
|
69
69
|
if (meta.steps?.length) {
|
|
70
70
|
return meta.steps.flatMap((step) => step.type === 'scenarioStep'
|
|
71
|
-
? [
|
|
71
|
+
? [
|
|
72
|
+
{
|
|
73
|
+
stepFunc: step.stepFunc,
|
|
74
|
+
phase: step.phase,
|
|
75
|
+
virtualUser: step.virtualUser,
|
|
76
|
+
},
|
|
77
|
+
]
|
|
72
78
|
: []);
|
|
73
79
|
}
|
|
74
80
|
// knowledge: decisions/internals/virtual-user-step-order-comes-from-insertion-order.md
|
|
75
81
|
return Object.values(meta.nodes ?? {}).flatMap((node) => {
|
|
76
|
-
const { rpcName, scenarioStepPhase,
|
|
82
|
+
const { rpcName, scenarioStepPhase, virtualUser } = (node ?? {});
|
|
77
83
|
if (!rpcName || !scenarioStepPhase)
|
|
78
84
|
return [];
|
|
79
|
-
return [{ stepFunc: rpcName, phase: scenarioStepPhase,
|
|
85
|
+
return [{ stepFunc: rpcName, phase: scenarioStepPhase, virtualUser }];
|
|
80
86
|
});
|
|
81
87
|
};
|
|
82
88
|
/**
|
|
@@ -109,7 +115,7 @@ export const deriveIntents = (workflows, functions = {}) => {
|
|
|
109
115
|
phase: step.phase,
|
|
110
116
|
// knowledge: decisions/internals/a-scenario-step-template-is-offered-unfilled.md
|
|
111
117
|
description: template ?? description ?? '',
|
|
112
|
-
|
|
118
|
+
virtualUser: step.virtualUser,
|
|
113
119
|
}));
|
|
114
120
|
}
|
|
115
121
|
intents.push({
|
|
@@ -118,7 +124,7 @@ export const deriveIntents = (workflows, functions = {}) => {
|
|
|
118
124
|
description: meta.description,
|
|
119
125
|
steps: steps.length ? steps : undefined,
|
|
120
126
|
tags: meta.tags?.length ? meta.tags : undefined,
|
|
121
|
-
|
|
127
|
+
virtualUsers: meta.virtualUsers?.length ? meta.virtualUsers : undefined,
|
|
122
128
|
});
|
|
123
129
|
}
|
|
124
130
|
return intents;
|
|
@@ -5,7 +5,7 @@ import type { VirtualUserDisposition } from './virtual-user.types.js';
|
|
|
5
5
|
* behaviour the dials cannot express on their own.
|
|
6
6
|
*/
|
|
7
7
|
export interface DispositionProfile {
|
|
8
|
-
/** Appended to the
|
|
8
|
+
/** Appended to the virtual user instructions. Behaviour, never identity. */
|
|
9
9
|
instructions: string;
|
|
10
10
|
/**
|
|
11
11
|
* Relative weights for the scheduler's four moves. `continue` dominating is
|
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* A
|
|
2
|
+
* A virtual user's email address is computed, never declared.
|
|
3
3
|
*
|
|
4
|
-
* A
|
|
4
|
+
* A virtual user that cannot read its own email cannot complete sign-up, magic
|
|
5
5
|
* links, invites or password resets — which are most of the flows worth
|
|
6
6
|
* exercising. So addresses are real and deliverable against a domain the stage
|
|
7
7
|
* actually receives mail on, rather than a synthetic `.local` dead end.
|
|
8
8
|
*/
|
|
9
9
|
/**
|
|
10
|
-
* Lower-cases and strips a
|
|
10
|
+
* Lower-cases and strips a virtual user id down to something an address can carry.
|
|
11
11
|
*
|
|
12
|
-
*
|
|
12
|
+
* Virtual users are declared as object keys, so they are already identifier-shaped;
|
|
13
13
|
* this exists for the ones that are not (`'susan.buyer'`, `'Susan_2'`) rather
|
|
14
14
|
* than to permit arbitrary input.
|
|
15
15
|
*/
|
|
16
|
-
export declare const
|
|
16
|
+
export declare const virtualUserEmailLabel: (virtualUserId: string) => string;
|
|
17
17
|
/**
|
|
18
|
-
* The address a
|
|
18
|
+
* The address a virtual user reads mail at during a run.
|
|
19
19
|
*
|
|
20
20
|
* The `runId` suffix is not decoration. Without it two concurrent runs share an
|
|
21
21
|
* inbox *and* a user row, and run B reads run A's magic link. Sub-addressing
|
|
@@ -25,13 +25,13 @@ export declare const personaEmailLabel: (personaId: string) => string;
|
|
|
25
25
|
* Omitting `runId` gives the bare form, which is what a seeded fixture that has
|
|
26
26
|
* to stay stable across runs wants.
|
|
27
27
|
*/
|
|
28
|
-
export declare const
|
|
28
|
+
export declare const virtualUserEmail: (virtualUserId: string, domain: string, runId?: string) => string;
|
|
29
29
|
/**
|
|
30
|
-
* Every address in a run, keyed by
|
|
30
|
+
* Every address in a run, keyed by virtual user.
|
|
31
31
|
*
|
|
32
|
-
* All of a
|
|
32
|
+
* All of a virtual user's logins share one address. That is not a simplification:
|
|
33
33
|
* better-auth keeps `email` on the `user` and defaults `allowDifferentEmails`
|
|
34
34
|
* to false, so giving a linked account its own address would have the library
|
|
35
|
-
* under test refuse to link the very thing the
|
|
35
|
+
* under test refuse to link the very thing the virtual user declared as linked.
|
|
36
36
|
*/
|
|
37
|
-
export declare const
|
|
37
|
+
export declare const virtualUserEmails: (virtualUserIds: readonly string[], domain: string, runId?: string) => Record<string, string>;
|