@jskit-ai/agent-docs 0.1.299 → 0.1.300

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.
Files changed (39) hide show
  1. package/guide/agent/framework/side-effects.md +70 -0
  2. package/guide/agent/index.md +2 -0
  3. package/package.json +1 -1
  4. package/patterns/feature-package/example/booking-engine/package.json +1 -1
  5. package/patterns/minimal-foundation/example/AGENTS.md +6 -0
  6. package/patterns/minimal-foundation/example/package.json +3 -3
  7. package/patterns/shell-foundation/example/AGENTS.md +6 -0
  8. package/patterns/shell-foundation/example/package.json +4 -4
  9. package/patterns/shell-foundation/example/packages/main/package.json +1 -1
  10. package/reference/autogen/KERNEL_MAP.md +11 -0
  11. package/reference/autogen/PATTERN_INDEX.md +38 -38
  12. package/reference/autogen/packages/auth-provider-local-core.md +2 -0
  13. package/reference/autogen/packages/connectors-catalog.md +4 -0
  14. package/reference/autogen/packages/connectors-core.md +3 -2
  15. package/reference/autogen/packages/kernel.md +22 -0
  16. package/reference/autogen/packages/payments-core.md +1 -1
  17. package/reference/autogen/packages/shell-web.md +16 -0
  18. package/reference/autogen/packages/workspaces-core.md +4 -0
  19. package/skills/jskit/SKILL.md +1 -0
  20. package/skills/jskit/references/pattern-index.md +38 -38
  21. package/skills/jskit/references/patterns/app/minimal-foundation/example/AGENTS.md +6 -0
  22. package/skills/jskit/references/patterns/app/minimal-foundation/example/package.json +3 -3
  23. package/skills/jskit/references/patterns/app/shell-foundation/example/AGENTS.md +6 -0
  24. package/skills/jskit/references/patterns/app/shell-foundation/example/package.json +4 -4
  25. package/skills/jskit/references/patterns/app/shell-foundation/example/packages/main/package.json +1 -1
  26. package/skills/jskit/references/patterns/auth/accounts-hub/example/package.json +3 -3
  27. package/skills/jskit/references/patterns/auth/oidc-sign-in/example/package.json +2 -2
  28. package/skills/jskit/references/patterns/auth/supabase-auth/example/package.json +1 -1
  29. package/skills/jskit/references/patterns/connectors/api-key-connection/example/connections.js +4 -1
  30. package/skills/jskit/references/patterns/connectors/calendar-cli/example/package.json +4 -4
  31. package/skills/jskit/references/patterns/connectors/firebase-messaging/example/server/notifications.js +4 -1
  32. package/skills/jskit/references/patterns/crud/crud-feature-package/example/packages/books/package.json +3 -3
  33. package/skills/jskit/references/patterns/database/mysql-application/example/package.json +2 -2
  34. package/skills/jskit/references/patterns/database/postgres-application/example/package.json +2 -2
  35. package/skills/jskit/references/patterns/realtime/realtime-application/example/package.json +2 -2
  36. package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/package.json +1 -1
  37. package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/package.json +3 -3
  38. package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/package.json +6 -6
  39. package/skills/jskit/references/side-effects.md +65 -0
@@ -0,0 +1,70 @@
1
+ <!-- Generated by `npm run agent-docs:build` from `packages/agent-docs/site/guide/framework/side-effects.md`. Do not edit manually. -->
2
+
3
+ ---
4
+ title: Side effects and test copies
5
+ description: Follow SIDE_EFFECTS so a test copy never sends real email, messages or payments.
6
+ ---
7
+
8
+ # Side effects and test copies
9
+
10
+ An application reads one environment variable, `SIDE_EFFECTS`:
11
+
12
+ - `live`: the application acts for real.
13
+ - Anything else, including unset, means `simulate`: the copy is a **test
14
+ copy**. It sends no real email, SMS, push notification, payment or
15
+ third-party webhook. It simulates each one, writes it to the log, and every
16
+ page shows a small "Test copy" banner.
17
+
18
+ Only the copy that serves real people sets `SIDE_EFFECTS=live`. Development,
19
+ previews, tests and staging leave it unset. The name has no platform prefix on
20
+ purpose: any host can set it. The host sets it; a request never chooses it.
21
+
22
+ ## What JSKIT does
23
+
24
+ - Every HTML page the server sends, and every page the Vite development server
25
+ sends, names the setting in a `jskit-side-effects` meta tag. The shell
26
+ (`@jskit-ai/shell-web`) shows the "Test copy" banner from it, with no
27
+ application code. The banner never takes a click or a tap.
28
+ - The server logs once at startup whether it acts for real. A production server
29
+ that simulates logs a warning.
30
+ - Local-password emails (confirmation and password reset) with an installed
31
+ sender are logged, not sent.
32
+ - Workspace invitations with a provided mailer are logged. The invitation
33
+ answers `status: "simulated"`, and the inviter copies the link.
34
+ - Accounts-hub email is logged, not sent.
35
+ - Connector operations that act on the world (send an email or message, post,
36
+ book or cancel, charge, invoice, trigger another system's events) are marked
37
+ `sideEffect`. They are checked like real ones, then logged, and `invoke`
38
+ answers `{ simulated: true }`. Reads run for real. `createConnectorsFeature`
39
+ reads the setting itself; give `createConnectionService` and
40
+ `createPaymentCheckoutService` `sideEffects: resolveSideEffectsMode(env)`.
41
+ - Payment checkout and the billing portal in the live payment environment are
42
+ refused with `payment_test_copy`; the sandbox environment works either way.
43
+
44
+ Supabase sends its own authentication emails from Supabase's servers; JSKIT
45
+ cannot simulate them. Point a test copy at a separate Supabase project.
46
+
47
+ ## The application's own side effects
48
+
49
+ Code the application writes that reaches the world follows the same rule.
50
+ Decide at the point of the effect: log what would happen and answer as if it
51
+ were done.
52
+
53
+ ```js
54
+ import { sideEffectsAreLive } from "@jskit-ai/kernel/shared/support/sideEffects";
55
+ import { logSimulatedSideEffect } from "@jskit-ai/kernel/server/runtime/sideEffects";
56
+
57
+ async function sendReminder({ env, logger, mailer }, message) {
58
+ if (!sideEffectsAreLive(env)) {
59
+ logSimulatedSideEffect(logger, { kind: "email", summary: `the reminder to ${message.to}`, details: { to: message.to } });
60
+ return { simulated: true };
61
+ }
62
+ return mailer.send(message);
63
+ }
64
+ ```
65
+
66
+ - Read `env` from the `runtime.env` capability, never a request.
67
+ - A configured driver or key (`EMAIL_DRIVER=ses`, a live payment key) does not
68
+ make a test copy live; only `SIDE_EFFECTS=live` does.
69
+ - Test both modes. A test that proves a real sender against a fake transport
70
+ sets `SIDE_EFFECTS: "live"` in its environment.
@@ -40,6 +40,8 @@ apply or adapt. It does not prescribe an agent host or project orchestrator.
40
40
  - [Sanity checks](/guide/framework/sanity-checks): JSKIT's own pitfalls, and
41
41
  the JSKIT calls that check data access, tests, a refactor, a screen or a
42
42
  deployment before calling it done
43
+ - [Side effects and test copies](/guide/framework/side-effects): read before
44
+ code that sends email, messages or payments, or calls another system
43
45
  - [Translating a JSKIT app](/guide/framework/translation)
44
46
  - [Complete source pattern library](/patterns/)
45
47
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jskit-ai/agent-docs",
3
- "version": "0.1.299",
3
+ "version": "0.1.300",
4
4
  "description": "Distributed JSKIT agent references, prompts, guides, and generated reference maps.",
5
5
  "type": "module",
6
6
  "files": [
@@ -5,7 +5,7 @@
5
5
  "private": true,
6
6
  "type": "module",
7
7
  "dependencies": {
8
- "@jskit-ai/kernel": "0.2.19",
8
+ "@jskit-ai/kernel": "0.2.20",
9
9
  "json-rest-schema": "^1.0.20"
10
10
  },
11
11
  "exports": {
@@ -26,6 +26,12 @@ factory or client provider), read the client features guide at
26
26
  Simple, direct code comes first: never add a layer, wrapper, registry or tiny
27
27
  module only to satisfy a rule. `npm run lint` checks its rules too.
28
28
 
29
+ Before writing code that sends email, SMS, push notifications or payments, or
30
+ calls another system, read the side effects guide at
31
+ `https://mobily-enterprises.github.io/jskit-ai/guide/framework/side-effects`.
32
+ Unless `SIDE_EFFECTS` is exactly `live`, the app is a test copy: it simulates
33
+ them and logs them instead.
34
+
29
35
  Before implementation, read the narrow relevant source pattern completely. If
30
36
  its owner package is installed, prefer that version-matched package-owned copy.
31
37
  Do not install an unrelated runtime package only to read documentation.
@@ -34,7 +34,7 @@
34
34
  "dependencies": {
35
35
  "@local/main": "0.1.0",
36
36
  "@fastify/static": "^10.1.3",
37
- "@jskit-ai/kernel": "0.2.19",
37
+ "@jskit-ai/kernel": "0.2.20",
38
38
  "@jskit-ai/material-web": "0.1.5",
39
39
  "@tanstack/vue-query": "^5.101.0",
40
40
  "fastify": "^5.12.7",
@@ -44,13 +44,13 @@
44
44
  "vue": "^3.5.44",
45
45
  "vue-router": "^5.3.1",
46
46
  "vuetify": "^4.3.0",
47
- "@jskit-ai/http-runtime": "0.2.19",
47
+ "@jskit-ai/http-runtime": "0.2.20",
48
48
  "@fastify/fast-json-stringify-compiler": "^5.1.0",
49
49
  "@vue/devtools-api": "^8.2.1"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@jskit-ai/config-eslint": "0.1.250",
53
- "@jskit-ai/jskit-catalog": "0.2.51",
53
+ "@jskit-ai/jskit-catalog": "0.2.52",
54
54
  "@playwright/test": "1.61.1",
55
55
  "@vitejs/plugin-vue": "^6.0.7",
56
56
  "eslint": "^10.8.0",
@@ -26,6 +26,12 @@ factory or client provider), read the client features guide at
26
26
  Simple, direct code comes first: never add a layer, wrapper, registry or tiny
27
27
  module only to satisfy a rule. `npm run lint` checks its rules too.
28
28
 
29
+ Before writing code that sends email, SMS, push notifications or payments, or
30
+ calls another system, read the side effects guide at
31
+ `https://mobily-enterprises.github.io/jskit-ai/guide/framework/side-effects`.
32
+ Unless `SIDE_EFFECTS` is exactly `live`, the app is a test copy: it simulates
33
+ them and logs them instead.
34
+
29
35
  Before implementation, read the narrow relevant source pattern completely. If
30
36
  its owner package is installed, prefer that version-matched package-owned copy.
31
37
  Do not install an unrelated runtime package only to read documentation.
@@ -34,7 +34,7 @@
34
34
  "dependencies": {
35
35
  "@local/main": "0.1.0",
36
36
  "@fastify/static": "^10.1.3",
37
- "@jskit-ai/kernel": "0.2.19",
37
+ "@jskit-ai/kernel": "0.2.20",
38
38
  "@jskit-ai/material-web": "0.1.5",
39
39
  "@tanstack/vue-query": "^5.101.0",
40
40
  "fastify": "^5.12.7",
@@ -44,14 +44,14 @@
44
44
  "vue": "^3.5.44",
45
45
  "vue-router": "^5.3.1",
46
46
  "vuetify": "^4.3.0",
47
- "@jskit-ai/http-runtime": "0.2.19",
48
- "@jskit-ai/shell-web": "0.2.25",
47
+ "@jskit-ai/http-runtime": "0.2.20",
48
+ "@jskit-ai/shell-web": "0.2.26",
49
49
  "@fastify/fast-json-stringify-compiler": "^5.1.0",
50
50
  "@vue/devtools-api": "^8.2.1"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@jskit-ai/config-eslint": "0.1.250",
54
- "@jskit-ai/jskit-catalog": "0.2.51",
54
+ "@jskit-ai/jskit-catalog": "0.2.52",
55
55
  "@playwright/test": "1.61.1",
56
56
  "@vitejs/plugin-vue": "^6.0.7",
57
57
  "eslint": "^10.8.0",
@@ -9,7 +9,7 @@
9
9
  },
10
10
  "description": "App-local runtime composition and lightweight glue.",
11
11
  "dependencies": {
12
- "@jskit-ai/kernel": "0.2.19"
12
+ "@jskit-ai/kernel": "0.2.20"
13
13
  },
14
14
  "jskit": {
15
15
  "kind": "runtime",
@@ -170,6 +170,17 @@ Exports
170
170
  Local functions
171
171
  - `normalizePlacementRenderers(value = {})`
172
172
 
173
+ ### `support/sideEffects.js`
174
+ Exports
175
+ - `SIDE_EFFECTS_ENV_KEY`
176
+ - `SIDE_EFFECTS_LIVE`
177
+ - `SIDE_EFFECTS_META_NAME`
178
+ - `SIDE_EFFECTS_SIMULATE`
179
+ - `pageSideEffectsMode(documentObject = globalThis.document)`
180
+ - `resolveSideEffectsMode(env)`
181
+ - `sideEffectsAreLive(env)`
182
+ - `withSideEffectsMeta(html, mode)`
183
+
173
184
  ### `support/silentLogger.js`
174
185
  Exports
175
186
  - `silentLogger`
@@ -15,7 +15,7 @@ A concrete Fastify, Vue, and JSKIT application foundation for products that do n
15
15
 
16
16
  - Id: `app/minimal-foundation`
17
17
  - Keywords: `app`, `fastify`, `foundation`, `minimal`, `server`, `vite`, `vue`
18
- - Owner: `@jskit-ai/agent-docs@0.1.299`
18
+ - Owner: `@jskit-ai/agent-docs@0.1.300`
19
19
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/app/minimal-foundation/PATTERN.md)
20
20
  - Examples: [example/](../../skills/jskit/references/patterns/app/minimal-foundation/example/)
21
21
  - Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`
@@ -26,7 +26,7 @@ A concrete JSKIT web application foundation with responsive shell navigation, se
26
26
 
27
27
  - Id: `app/shell-foundation`
28
28
  - Keywords: `app`, `foundation`, `material`, `navigation`, `placements`, `shell`, `vite`, `vue`
29
- - Owner: `@jskit-ai/agent-docs@0.1.299`
29
+ - Owner: `@jskit-ai/agent-docs@0.1.300`
30
30
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/app/shell-foundation/PATTERN.md)
31
31
  - Examples: [example/](../../skills/jskit/references/patterns/app/shell-foundation/example/)
32
32
  - Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`, `@jskit-ai/shell-web`
@@ -37,7 +37,7 @@ Configure an assistant runtime for one application surface and expose its chat a
37
37
 
38
38
  - Id: `assistant/assistant-surface`
39
39
  - Keywords: `ai`, `assistant`, `chat`, `config`, `environment`, `page`, `placement`, `settings`, `surface`
40
- - Owner: `@jskit-ai/assistant-runtime@0.2.44`
40
+ - Owner: `@jskit-ai/assistant-runtime@0.2.45`
41
41
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/assistant/assistant-surface/PATTERN.md)
42
42
  - Examples: [example/](../../skills/jskit/references/patterns/assistant/assistant-surface/example/)
43
43
  - Requires: `@jskit-ai/assistant-runtime`, `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`, `@jskit-ai/shell-web`
@@ -48,7 +48,7 @@ Run one OpenID Connect sign-in for all of an owner's apps as its own JSKIT proje
48
48
 
49
49
  - Id: `auth/accounts-hub`
50
50
  - Keywords: `accounts hub`, `auth`, `authentication`, `issuer`, `master login`, `oidc`, `openid connect`, `single sign-on`, `sso`
51
- - Owner: `@jskit-ai/oidc-issuer-core@0.1.28`
51
+ - Owner: `@jskit-ai/oidc-issuer-core@0.1.29`
52
52
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/accounts-hub/PATTERN.md)
53
53
  - Examples: [example/](../../skills/jskit/references/patterns/auth/accounts-hub/example/)
54
54
  - Requires: `@jskit-ai/oidc-issuer-core`
@@ -59,7 +59,7 @@ Compose JSKIT authentication routes, views, profile controls, and public surface
59
59
 
60
60
  - Id: `auth/auth-surface`
61
61
  - Keywords: `account`, `auth`, `login`, `logout`, `password`, `placement`, `profile`, `reset`, `surface`
62
- - Owner: `@jskit-ai/auth-web@0.2.27`
62
+ - Owner: `@jskit-ai/auth-web@0.2.28`
63
63
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/auth-surface/PATTERN.md)
64
64
  - Examples: [example/](../../skills/jskit/references/patterns/auth/auth-surface/example/)
65
65
  - Requires: `@jskit-ai/auth-core`, `@jskit-ai/auth-web`, `@jskit-ai/shell-web`
@@ -70,7 +70,7 @@ Let people sign in with the accounts they already have in an accounts hub or ano
70
70
 
71
71
  - Id: `auth/oidc-sign-in`
72
72
  - Keywords: `accounts hub`, `auth`, `authentication`, `back-channel logout`, `dynamic client registration`, `issuer`, `master login`, `oidc`, `openid connect`, `single sign-on`, `sso`
73
- - Owner: `@jskit-ai/auth-provider-oidc-core@0.2.29`
73
+ - Owner: `@jskit-ai/auth-provider-oidc-core@0.2.30`
74
74
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/oidc-sign-in/PATTERN.md)
75
75
  - Examples: [example/](../../skills/jskit/references/patterns/auth/oidc-sign-in/example/)
76
76
  - Requires: `@jskit-ai/auth-provider-oidc-core`, `@jskit-ai/auth-web`
@@ -81,7 +81,7 @@ Add Supabase authentication through normal npm composition, explicit environment
81
81
 
82
82
  - Id: `auth/supabase-auth`
83
83
  - Keywords: `auth`, `authentication`, `oauth`, `sessions`, `supabase`
84
- - Owner: `@jskit-ai/auth-provider-supabase-core@0.2.22`
84
+ - Owner: `@jskit-ai/auth-provider-supabase-core@0.2.23`
85
85
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/supabase-auth/PATTERN.md)
86
86
  - Examples: [example/](../../skills/jskit/references/patterns/auth/supabase-auth/example/)
87
87
  - Requires: `@jskit-ai/auth-provider-supabase-core`
@@ -92,7 +92,7 @@ Resolve an administrator environment key or an individual user's grant, then use
92
92
 
93
93
  - Id: `connectors/ai-connections`
94
94
  - Keywords: `ai`, `api-key`, `cli`, `environment`, `free`, `models`, `ownership`, `zai`, `zen`
95
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
95
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
96
96
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/ai-connections/PATTERN.md)
97
97
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/ai-connections/example/)
98
98
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -103,7 +103,7 @@ Compose provider operations, authorization and encrypted file storage from a CLI
103
103
 
104
104
  - Id: `connectors/api-key-connection`
105
105
  - Keywords: `api-key`, `clay`, `cli`, `clickhouse`, `connectors`, `dbt`, `files`, `firecrawl`, `granola`, `integrations`, `metrics`, `prestashop`, `resend`, `semantic-layer`, `semrush`, `x-twitter`
106
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
106
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
107
107
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/api-key-connection/PATTERN.md)
108
108
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/api-key-connection/example/)
109
109
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -114,7 +114,7 @@ Compose token-based MCP discovery and explicitly authorized tool calls using the
114
114
 
115
115
  - Id: `connectors/assistant-mcp`
116
116
  - Keywords: `assistant`, `cli`, `connectors`, `files`, `integrations`, `mcp`, `n8n`, `sanity`
117
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
117
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
118
118
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/assistant-mcp/PATTERN.md)
119
119
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/assistant-mcp/example/)
120
120
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -125,7 +125,7 @@ Configure assistant OAuth clients, then compose existing state, encrypted file g
125
125
 
126
126
  - Id: `connectors/assistant-mcp-oauth`
127
127
  - Keywords: `amplitude`, `assistant`, `atlassian`, `canva`, `cli`, `client metadata`, `confidence`, `connectors`, `figma`, `files`, `granola`, `hex`, `mcp`, `miro`, `oauth`
128
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
128
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
129
129
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/assistant-mcp-oauth/PATTERN.md)
130
130
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/assistant-mcp-oauth/example/)
131
131
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -136,7 +136,7 @@ Compose signed AWS operations, file configuration and application authorization
136
136
 
137
137
  - Id: `connectors/aws-storage-queries`
138
138
  - Keywords: `athena`, `aws`, `cli`, `connectors`, `files`, `iam`, `queries`, `s3`, `storage`, `sts`
139
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
139
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
140
140
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/aws-storage-queries/PATTERN.md)
141
141
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/aws-storage-queries/example/)
142
142
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -147,7 +147,7 @@ Compose reusable connection libraries with portable configuration, application o
147
147
 
148
148
  - Id: `connectors/calendar-cli`
149
149
  - Keywords: `calendar`, `cli`, `connectors`, `google`, `integrations`, `oauth`, `permissions`
150
- - Owner: `@jskit-ai/connector-google-calendar@0.2.27`
150
+ - Owner: `@jskit-ai/connector-google-calendar@0.2.28`
151
151
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/calendar-cli/PATTERN.md)
152
152
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/calendar-cli/example/)
153
153
  - Requires: `@jskit-ai/connector-google-calendar`, `@jskit-ai/connectors-core`, `@jskit-ai/database-runtime-mysql`
@@ -158,7 +158,7 @@ Compose the shared connector runtime for event delivery while leaving workflow c
158
158
 
159
159
  - Id: `connectors/event-delivery`
160
160
  - Keywords: `cli`, `connectors`, `events`, `files`, `inngest`, `integrations`, `workflows`
161
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
161
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
162
162
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/event-delivery/PATTERN.md)
163
163
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/event-delivery/example/)
164
164
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -169,7 +169,7 @@ Wire service-account grants, file storage, explicit message actions and public b
169
169
 
170
170
  - Id: `connectors/firebase-messaging`
171
171
  - Keywords: `cli`, `connectors`, `fcm`, `files`, `firebase`, `integrations`, `jwt`, `notifications`, `push`, `service-account`, `vapid`
172
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
172
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
173
173
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/firebase-messaging/PATTERN.md)
174
174
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/firebase-messaging/example/)
175
175
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -180,7 +180,7 @@ Compose reviewed Search campaigns with project-owned Google OAuth and portable s
180
180
 
181
181
  - Id: `connectors/google-ads-search`
182
182
  - Keywords: `ads`, `campaigns`, `cli`, `connectors`, `conversion`, `google`, `search`
183
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
183
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
184
184
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/google-ads-search/PATTERN.md)
185
185
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/google-ads-search/example/)
186
186
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -191,7 +191,7 @@ Compose provider consent, verification and encrypted file persistence from an ap
191
191
 
192
192
  - Id: `connectors/oauth-connection`
193
193
  - Keywords: `accounting`, `assistant permissions`, `books`, `cli`, `client credentials`, `connectors`, `consent`, `crm`, `databricks`, `developer token`, `fabric`, `files`, `gaql`, `google ads`, `graphql`, `integrations`, `linkedin`, `microsoft`, `oauth`, `powerpoint`, `salesforce`, `service principal`, `shopify`, `soql`, `staffing`, `tiktok`, `twitch`, `wave`, `word`, `wordpress`, `workday`, `xero`, `zoho`
194
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
194
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
195
195
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/oauth-connection/PATTERN.md)
196
196
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/oauth-connection/example/)
197
197
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -202,7 +202,7 @@ Compose a sequential catalogue batch and preserve partial success for applicatio
202
202
 
203
203
  - Id: `connectors/paddle-catalogue`
204
204
  - Keywords: `batch`, `paddle`, `payments`, `prices`, `products`
205
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
205
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
206
206
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/paddle-catalogue/PATTERN.md)
207
207
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/paddle-catalogue/example/)
208
208
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -213,7 +213,7 @@ Resolve a publishable image key deliberately and use the shared URL library in a
213
213
 
214
214
  - Id: `connectors/public-image`
215
215
  - Keywords: `cli`, `connectors`, `files`, `images`, `integrations`, `logo-dev`, `public-key`
216
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
216
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
217
217
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/public-image/PATTERN.md)
218
218
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/public-image/example/)
219
219
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -224,7 +224,7 @@ Compose file configuration, Redshift Data API operations and application query o
224
224
 
225
225
  - Id: `connectors/redshift-queries`
226
226
  - Keywords: `aws`, `cli`, `connectors`, `files`, `iam`, `provisioned`, `redshift`, `serverless`, `sql`, `warehouse`
227
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
227
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
228
228
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/redshift-queries/PATTERN.md)
229
229
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/redshift-queries/example/)
230
230
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -235,7 +235,7 @@ Use the shared scanner runtime from a CLI or a host worker with portable configu
235
235
 
236
236
  - Id: `connectors/source-scanning`
237
237
  - Keywords: `cancellation`, `cli`, `connectors`, `integrations`, `scanning`, `security`, `source`, `wiz`, `worker`
238
- - Owner: `@jskit-ai/connectors-catalog@0.2.27`
238
+ - Owner: `@jskit-ai/connectors-catalog@0.2.28`
239
239
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/source-scanning/PATTERN.md)
240
240
  - Examples: [example/](../../skills/jskit/references/patterns/connectors/source-scanning/example/)
241
241
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -246,7 +246,7 @@ Add a protected administration surface, settings shell, and semantic navigation
246
246
 
247
247
  - Id: `console/console-surface`
248
248
  - Keywords: `admin`, `console`, `navigation`, `owner`, `placement`, `settings`, `surface`
249
- - Owner: `@jskit-ai/console-web@0.1.255`
249
+ - Owner: `@jskit-ai/console-web@0.1.256`
250
250
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/console/console-surface/PATTERN.md)
251
251
  - Examples: [example/](../../skills/jskit/references/patterns/console/console-surface/example/)
252
252
  - Requires: `@jskit-ai/console-core`, `@jskit-ai/console-web`, `@jskit-ai/shell-web`
@@ -257,7 +257,7 @@ Define an application table resource whose records belong to the current user, a
257
257
 
258
258
  - Id: `crud/crud-contract`
259
259
  - Keywords: `authenticated`, `crud`, `database`, `owner-scoped`, `resource`, `table`, `user`
260
- - Owner: `@jskit-ai/resource-crud-core@0.1.212`
260
+ - Owner: `@jskit-ai/resource-crud-core@0.1.213`
261
261
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/crud/crud-contract/PATTERN.md)
262
262
  - Examples: [example/](../../skills/jskit/references/patterns/crud/crud-contract/example/)
263
263
  - Requires: `@jskit-ai/resource-core`, `@jskit-ai/resource-crud-core`
@@ -268,7 +268,7 @@ Build a complete application-owned CRUD server package from a migration, a table
268
268
 
269
269
  - Id: `crud/crud-feature-package`
270
270
  - Keywords: `actions`, `crud`, `database`, `defineCrudFeature`, `json-api`, `migration`, `owns`, `permissions`, `repository`, `routes`, `service`, `table resource`
271
- - Owner: `@jskit-ai/crud-core@0.2.27`
271
+ - Owner: `@jskit-ai/crud-core@0.2.28`
272
272
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/crud/crud-feature-package/PATTERN.md)
273
273
  - Examples: [example/](../../skills/jskit/references/patterns/crud/crud-feature-package/example/)
274
274
  - Requires: `@jskit-ai/crud-core`, `@jskit-ai/resource-core`, `@jskit-ai/resource-crud-core`
@@ -279,7 +279,7 @@ Build a routed CRUD user interface as thin application pages over JSKIT's shared
279
279
 
280
280
  - Id: `crud/crud-screen-set`
281
281
  - Keywords: `actions`, `add`, `crud`, `delete`, `edit`, `filters`, `list`, `material`, `routes`, `view`, `vue`
282
- - Owner: `@jskit-ai/http-web@0.2.30`
282
+ - Owner: `@jskit-ai/http-web@0.2.31`
283
283
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/crud/crud-screen-set/PATTERN.md)
284
284
  - Examples: [example/](../../skills/jskit/references/patterns/crud/crud-screen-set/example/)
285
285
  - Requires: `@jskit-ai/http-web`, `@jskit-ai/resource-core`, `@jskit-ai/resource-crud-core`
@@ -290,7 +290,7 @@ Configure a JSKIT application for MySQL with a fixed driver, ordinary environmen
290
290
 
291
291
  - Id: `database/mysql-application`
292
292
  - Keywords: `database`, `knex`, `mariadb`, `migrations`, `mysql`, `mysql2`
293
- - Owner: `@jskit-ai/database-runtime-mysql@0.1.266`
293
+ - Owner: `@jskit-ai/database-runtime-mysql@0.1.267`
294
294
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/database/mysql-application/PATTERN.md)
295
295
  - Examples: [example/](../../skills/jskit/references/patterns/database/mysql-application/example/)
296
296
  - Requires: `@jskit-ai/database-runtime-mysql`
@@ -301,7 +301,7 @@ Configure a JSKIT application for PostgreSQL with a fixed driver, ordinary envir
301
301
 
302
302
  - Id: `database/postgres-application`
303
303
  - Keywords: `database`, `knex`, `migrations`, `pg`, `postgres`, `postgresql`
304
- - Owner: `@jskit-ai/database-runtime-postgres@0.1.265`
304
+ - Owner: `@jskit-ai/database-runtime-postgres@0.1.266`
305
305
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/database/postgres-application/PATTERN.md)
306
306
  - Examples: [example/](../../skills/jskit/references/patterns/database/postgres-application/example/)
307
307
  - Requires: `@jskit-ai/database-runtime-postgres`
@@ -312,7 +312,7 @@ Describe one database table once (its fields, columns, ownership, search and sor
312
312
 
313
313
  - Id: `database/table-resource`
314
314
  - Keywords: `database`, `defaultTo`, `defineTableResource`, `lockVersionField`, `lookup`, `ownership`, `owns`, `resource`, `system`, `table`, `workspace_or_shared`
315
- - Owner: `@jskit-ai/resource-core@0.1.210`
315
+ - Owner: `@jskit-ai/resource-core@0.1.211`
316
316
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/database/table-resource/PATTERN.md)
317
317
  - Examples: [example/](../../skills/jskit/references/patterns/database/table-resource/example/)
318
318
  - Requires: `@jskit-ai/resource-core`
@@ -323,7 +323,7 @@ Wrap a JSKIT web application in a Capacitor Android shell using native Capacitor
323
323
 
324
324
  - Id: `mobile/android-application`
325
325
  - Keywords: `android`, `capacitor`, `device`, `mobile`, `native`, `shell`, `webview`
326
- - Owner: `@jskit-ai/mobile-capacitor@0.2.25`
326
+ - Owner: `@jskit-ai/mobile-capacitor@0.2.26`
327
327
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/mobile/android-application/PATTERN.md)
328
328
  - Examples: [example/](../../skills/jskit/references/patterns/mobile/android-application/example/)
329
329
  - Requires: `@capacitor/android`, `@capacitor/app`, `@capacitor/cli`, `@jskit-ai/mobile-capacitor`
@@ -334,7 +334,7 @@ Add JSKIT realtime events with an optional Redis backplane and an explicit shell
334
334
 
335
335
  - Id: `realtime/realtime-application`
336
336
  - Keywords: `realtime`, `redis`, `socket.io`, `sockets`, `status`, `websocket`
337
- - Owner: `@jskit-ai/realtime@0.2.28`
337
+ - Owner: `@jskit-ai/realtime@0.2.29`
338
338
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/realtime/realtime-application/PATTERN.md)
339
339
  - Examples: [example/](../../skills/jskit/references/patterns/realtime/realtime-application/example/)
340
340
  - Requires: `@jskit-ai/realtime`, `@jskit-ai/shell-web`
@@ -345,7 +345,7 @@ Compose application-owned Google Publisher Tag delivery with the generic rewarde
345
345
 
346
346
  - Id: `rewards/google-rewarded`
347
347
  - Keywords: `ads`, `google`, `publisher tag`, `rewarded`, `unlock`
348
- - Owner: `@jskit-ai/rewarded-web@0.2.33`
348
+ - Owner: `@jskit-ai/rewarded-web@0.2.34`
349
349
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/rewards/google-rewarded/PATTERN.md)
350
350
  - Examples: [example/](../../skills/jskit/references/patterns/rewards/google-rewarded/example/)
351
351
  - Requires: `@jskit-ai/rewarded-web`
@@ -356,7 +356,7 @@ Define a server feature through explicit capabilities and first-class actions, a
356
356
 
357
357
  - Id: `server/feature-package`
358
358
  - Keywords: `actions`, `aggregate`, `feature`, `handle`, `orchestration`, `owns`, `package`, `provider`, `repository`, `routes`, `server`, `table resource`
359
- - Owner: `@jskit-ai/agent-docs@0.1.299`
359
+ - Owner: `@jskit-ai/agent-docs@0.1.300`
360
360
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/server/feature-package/PATTERN.md)
361
361
  - Examples: [example/](../../skills/jskit/references/patterns/server/feature-package/example/)
362
362
  - Requires: `@jskit-ai/kernel`
@@ -367,7 +367,7 @@ Compose the JSKIT responsive shell, semantic placements, settings navigation, an
367
367
 
368
368
  - Id: `shell/application-shell`
369
369
  - Keywords: `adaptive`, `app`, `layout`, `navigation`, `placement`, `responsive`, `settings`, `shell`
370
- - Owner: `@jskit-ai/shell-web@0.2.25`
370
+ - Owner: `@jskit-ai/shell-web@0.2.26`
371
371
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/shell/application-shell/PATTERN.md)
372
372
  - Examples: [example/](../../skills/jskit/references/patterns/shell/application-shell/example/)
373
373
  - Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
@@ -378,7 +378,7 @@ Add product routes and shell extensions through file routing, semantic placement
378
378
 
379
379
  - Id: `ui/page-and-placement`
380
380
  - Keywords: `component`, `navigation`, `outlet`, `page`, `placement`, `routes`, `section`, `shell`, `subpages`, `vue`
381
- - Owner: `@jskit-ai/shell-web@0.2.25`
381
+ - Owner: `@jskit-ai/shell-web@0.2.26`
382
382
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/ui/page-and-placement/PATTERN.md)
383
383
  - Examples: [example/](../../skills/jskit/references/patterns/ui/page-and-placement/example/)
384
384
  - Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
@@ -389,7 +389,7 @@ Compose an account settings route and profile, preference, notification, and sig
389
389
 
390
390
  - Id: `users/account-settings`
391
391
  - Keywords: `account`, `link provider`, `notifications`, `oauth`, `preferences`, `profile`, `settings`, `sign-in methods`, `user`, `vue`
392
- - Owner: `@jskit-ai/users-web@0.2.38`
392
+ - Owner: `@jskit-ai/users-web@0.2.39`
393
393
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/users/account-settings/PATTERN.md)
394
394
  - Examples: [example/](../../skills/jskit/references/patterns/users/account-settings/example/)
395
395
  - Requires: `@jskit-ai/shell-web`, `@jskit-ai/users-core`, `@jskit-ai/users-web`
@@ -400,7 +400,7 @@ Expose user administration and workspace-scoped member operations through app-ow
400
400
 
401
401
  - Id: `users/user-administration-server`
402
402
  - Keywords: `account`, `admin`, `member`, `repository`, `resource`, `routes`, `service`, `user`, `workspace`
403
- - Owner: `@jskit-ai/users-core@0.2.29`
403
+ - Owner: `@jskit-ai/users-core@0.2.30`
404
404
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/users/user-administration-server/PATTERN.md)
405
405
  - Examples: [example/](../../skills/jskit/references/patterns/users/user-administration-server/example/)
406
406
  - Requires: `@jskit-ai/crud-core`, `@jskit-ai/users-core`
@@ -411,7 +411,7 @@ Configure roles, workspace access policy, invitations, and app-owned invitation
411
411
 
412
412
  - Id: `workspaces/workspace-server`
413
413
  - Keywords: `access`, `invite`, `membership`, `multitenancy`, `policy`, `role`, `tenancy`, `workspace`
414
- - Owner: `@jskit-ai/workspaces-core@0.2.29`
414
+ - Owner: `@jskit-ai/workspaces-core@0.2.30`
415
415
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/workspaces/workspace-server/PATTERN.md)
416
416
  - Examples: [example/](../../skills/jskit/references/patterns/workspaces/workspace-server/example/)
417
417
  - Requires: `@jskit-ai/users-core`, `@jskit-ai/workspaces-core`
@@ -422,7 +422,7 @@ Compose workspace selection, invitation, member administration, settings, and re
422
422
 
423
423
  - Id: `workspaces/workspace-surfaces`
424
424
  - Keywords: `admin`, `invite`, `member`, `navigation`, `settings`, `surface`, `switcher`, `workspace`
425
- - Owner: `@jskit-ai/workspaces-web@0.2.38`
425
+ - Owner: `@jskit-ai/workspaces-web@0.2.39`
426
426
  - Read: [PATTERN.md](../../skills/jskit/references/patterns/workspaces/workspace-surfaces/PATTERN.md)
427
427
  - Examples: [example/](../../skills/jskit/references/patterns/workspaces/workspace-surfaces/example/)
428
428
  - Requires: `@jskit-ai/shell-web`, `@jskit-ai/workspaces-core`, `@jskit-ai/workspaces-web`
@@ -61,6 +61,7 @@ Exports
61
61
  - `CONFIRMATION_TOKEN_TTL_SECONDS`
62
62
  - `createLocalEmailConfirmation({ backend, config, confirmationSender, firstAccountSetup, invitationContextResolver, passwords, profileProjector, sessions })`
63
63
  - `createLoggedConfirmationSender(logger)`
64
+ - `createSimulatedConfirmationSender(logger)`
64
65
  Local functions
65
66
  - `emailTakenError()`
66
67
  - `confirmationInvalidError()`
@@ -154,6 +155,7 @@ Exports
154
155
  Exports
155
156
  - `createLocalPasswordFlows({ backend, config, passwords, profileProjector, recoverySender, sessions })`
156
157
  - `createLoggedRecoverySender(logger)`
158
+ - `createSimulatedRecoverySender(logger)`
157
159
 
158
160
  ### `src/server/lib/passwords.js`
159
161
  Exports
@@ -696,6 +696,10 @@ Local functions
696
696
  - `emptyUserErrors(payload)`
697
697
  - `productMutation(name, fields)`
698
698
 
699
+ ### `src/server/sideEffect.js`
700
+ Exports
701
+ - `sideEffect(operation)`
702
+
699
703
  ### `src/server/slack.js`
700
704
  Exports
701
705
  - `slackProvider`
@@ -22,7 +22,7 @@ Local functions
22
22
 
23
23
  ### `src/server/connectionService.js`
24
24
  Exports
25
- - `createConnectionService({ configuration, providers, resolveReference, store, authorize, executionMode = "application", fetchImpl = globalThis.fetch, now = Date.now })`
25
+ - `createConnectionService({ configuration, providers, resolveReference, store, authorize, executionMode = "application", fetchImpl = globalThis.fetch, now = Date.now, sideEffects = "simulate", logger = console })`
26
26
  Local functions
27
27
  - `publicConnection(connection)`
28
28
  - `connectionMatches(connection, integration, providerId, registration)`
@@ -92,8 +92,9 @@ Exports
92
92
 
93
93
  ### `src/server/providerRequests.js`
94
94
  Exports
95
+ - `SIMULATED_RESULT`
95
96
  - `connectionProvider(definition, integration)`
96
- - `createProviderRequests({ fetchImpl, now, resolveReference })`
97
+ - `createProviderRequests({ fetchImpl, now, resolveReference, sideEffects = "simulate", logger = console })`
97
98
  - `operationRequest(operation, input, settings, providerData)`
98
99
  - `requireOperationScope(operation, scopes, message, { messageCode })`
99
100
  - `tokenResponse(provider, response, details)`
@@ -213,6 +213,17 @@ Exports
213
213
  Local functions
214
214
  - `normalizePlacementRenderers(value = {})`
215
215
 
216
+ ### `shared/support/sideEffects.js`
217
+ Exports
218
+ - `SIDE_EFFECTS_ENV_KEY`
219
+ - `SIDE_EFFECTS_LIVE`
220
+ - `SIDE_EFFECTS_META_NAME`
221
+ - `SIDE_EFFECTS_SIMULATE`
222
+ - `pageSideEffectsMode(documentObject = globalThis.document)`
223
+ - `resolveSideEffectsMode(env)`
224
+ - `sideEffectsAreLive(env)`
225
+ - `withSideEffectsMeta(html, mode)`
226
+
216
227
  ### `shared/support/silentLogger.js`
217
228
  Exports
218
229
  - `silentLogger`
@@ -928,6 +939,12 @@ Local functions
928
939
  - `resolveContentSecurityPolicyHeaders(settings)`
929
940
  - `resolveSecurityHeaders({ config, env })`
930
941
 
942
+ ### `server/http/sideEffectsPage.js`
943
+ Exports
944
+ - `registerSideEffectsPage(fastify, { env })`
945
+ - `type RuntimeEnv`
946
+ - `type RuntimeFastify`
947
+
931
948
  ### `server/http/trustedProxies.js`
932
949
  Exports
933
950
  - `DEFAULT_TRUSTED_PROXIES`
@@ -1085,6 +1102,11 @@ Local functions
1085
1102
  - `normalizeRequireAuthOptions(options = {})`
1086
1103
  - `requireAuthenticatedActor(context = {}, options = {})`
1087
1104
 
1105
+ ### `server/runtime/sideEffects.js`
1106
+ Exports
1107
+ - `logSideEffectsMode(logger, env)`
1108
+ - `logSimulatedSideEffect(logger, { kind, summary, details = {} })`
1109
+
1088
1110
  ### `server/support/appConfig.js`
1089
1111
  Exports
1090
1112
  - `resolveMobileConfig(appConfig)`