@pikku/inspector 0.12.75 → 0.12.82

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 (223) hide show
  1. package/CHANGELOG.md +357 -0
  2. package/dist/add/add-analytics.d.ts +9 -0
  3. package/dist/add/add-analytics.js +178 -0
  4. package/dist/add/add-auth.js +0 -54
  5. package/dist/add/add-feature-flag.d.ts +2 -0
  6. package/dist/add/add-feature-flag.js +162 -0
  7. package/dist/add/add-middleware.js +66 -42
  8. package/dist/add/add-wire-addon.js +7 -4
  9. package/dist/add/add-wire-remote-addon.js +1 -0
  10. package/dist/error-codes.d.ts +1 -0
  11. package/dist/error-codes.js +1 -0
  12. package/dist/index.d.ts +3 -1
  13. package/dist/index.js +3 -1
  14. package/dist/inspector.js +5 -0
  15. package/dist/surface/collect-surface.d.ts +58 -0
  16. package/dist/surface/collect-surface.js +613 -0
  17. package/dist/types.d.ts +36 -12
  18. package/dist/utils/filter-inspector-state.js +14 -0
  19. package/dist/utils/load-addon-functions-meta.js +24 -11
  20. package/dist/utils/post-process.js +15 -0
  21. package/dist/utils/read-module-specifiers.d.ts +8 -0
  22. package/dist/utils/read-module-specifiers.js +23 -0
  23. package/dist/utils/read-tsconfig-out-dir.d.ts +5 -0
  24. package/dist/utils/read-tsconfig-out-dir.js +12 -0
  25. package/dist/utils/resolve-deploy-target.d.ts +7 -0
  26. package/dist/utils/resolve-deploy-target.js +15 -7
  27. package/dist/utils/serialize-inspector-state.d.ts +6 -0
  28. package/dist/utils/serialize-inspector-state.js +10 -0
  29. package/dist/visit.js +4 -0
  30. package/package.json +16 -6
  31. package/run-tests.sh +21 -6
  32. package/src/add/add-addon-bans.ts +0 -85
  33. package/src/add/add-agent-scorer.test.ts +0 -197
  34. package/src/add/add-agent-scorer.ts +0 -83
  35. package/src/add/add-agent.test.ts +0 -87
  36. package/src/add/add-agent.ts +0 -638
  37. package/src/add/add-approval-description.ts +0 -76
  38. package/src/add/add-auth.test.ts +0 -791
  39. package/src/add/add-auth.ts +0 -424
  40. package/src/add/add-channel.ts +0 -778
  41. package/src/add/add-cli-renderers.test.ts +0 -74
  42. package/src/add/add-cli.ts +0 -1006
  43. package/src/add/add-credential.ts +0 -186
  44. package/src/add/add-feature.test.ts +0 -306
  45. package/src/add/add-feature.ts +0 -253
  46. package/src/add/add-file-extends-core-type.ts +0 -66
  47. package/src/add/add-file-with-config.ts +0 -45
  48. package/src/add/add-file-with-factory.test.ts +0 -134
  49. package/src/add/add-file-with-factory.ts +0 -288
  50. package/src/add/add-functions.test.ts +0 -743
  51. package/src/add/add-functions.ts +0 -1548
  52. package/src/add/add-gateway.ts +0 -143
  53. package/src/add/add-http-route-ref.test.ts +0 -149
  54. package/src/add/add-http-route.ts +0 -530
  55. package/src/add/add-http-routes.ts +0 -471
  56. package/src/add/add-keyed-wiring.ts +0 -180
  57. package/src/add/add-mcp-prompt.ts +0 -157
  58. package/src/add/add-mcp-resource.ts +0 -175
  59. package/src/add/add-middleware.test.ts +0 -196
  60. package/src/add/add-middleware.ts +0 -879
  61. package/src/add/add-permission-auth.test.ts +0 -59
  62. package/src/add/add-permission.ts +0 -311
  63. package/src/add/add-personas.test.ts +0 -406
  64. package/src/add/add-personas.ts +0 -287
  65. package/src/add/add-queue-worker.ts +0 -117
  66. package/src/add/add-rpc-invocations.test.ts +0 -287
  67. package/src/add/add-rpc-invocations.ts +0 -221
  68. package/src/add/add-scenario-step.test.ts +0 -509
  69. package/src/add/add-schedule.ts +0 -120
  70. package/src/add/add-scope.test.ts +0 -419
  71. package/src/add/add-scope.ts +0 -221
  72. package/src/add/add-secret.ts +0 -10
  73. package/src/add/add-subject-scenario-steps.test.ts +0 -161
  74. package/src/add/add-system-role.test.ts +0 -297
  75. package/src/add/add-system-role.ts +0 -162
  76. package/src/add/add-trigger.ts +0 -165
  77. package/src/add/add-variable.ts +0 -10
  78. package/src/add/add-wire-addon.test.ts +0 -185
  79. package/src/add/add-wire-addon.ts +0 -146
  80. package/src/add/add-wire-remote-addon.ts +0 -80
  81. package/src/add/add-workflow-edge-cases.test.ts +0 -201
  82. package/src/add/add-workflow-fanout.test.ts +0 -166
  83. package/src/add/add-workflow-graph-foreach.test.ts +0 -174
  84. package/src/add/add-workflow-graph-input.test.ts +0 -94
  85. package/src/add/add-workflow-graph-notes.test.ts +0 -74
  86. package/src/add/add-workflow-graph.ts +0 -644
  87. package/src/add/add-workflow-on-error.test.ts +0 -118
  88. package/src/add/add-workflow-return-switch.test.ts +0 -121
  89. package/src/add/add-workflow-silent-drops.test.ts +0 -261
  90. package/src/add/add-workflow-sleep-expression.test.ts +0 -96
  91. package/src/add/add-workflow.test.ts +0 -155
  92. package/src/add/add-workflow.ts +0 -482
  93. package/src/add/addon-bans.test.ts +0 -121
  94. package/src/add/addon-contracts.test.ts +0 -221
  95. package/src/add/allow-escape-hatches.test.ts +0 -144
  96. package/src/add/audit-meta.test.ts +0 -75
  97. package/src/add/classified-sink-check.test.ts +0 -347
  98. package/src/add/config-value-metadata.test.ts +0 -263
  99. package/src/add/dynamic-import-check.test.ts +0 -119
  100. package/src/add/expect-eventually-scenario-only.test.ts +0 -108
  101. package/src/add/function-body-span.test.ts +0 -96
  102. package/src/add/inline-wiring-function.test.ts +0 -104
  103. package/src/add/pii-check.test.ts +0 -258
  104. package/src/add/rpc-type-cast.test.ts +0 -123
  105. package/src/add/scenario-instrumentation.test.ts +0 -89
  106. package/src/add/scenario-instrumentation.ts +0 -42
  107. package/src/add/scenario-marker.test.ts +0 -89
  108. package/src/add/scenario-not-extractable.test.ts +0 -159
  109. package/src/add/scenario-services.test.ts +0 -103
  110. package/src/add/scenario-skip.test.ts +0 -83
  111. package/src/add/validate-workflow-graph-addons.test.ts +0 -102
  112. package/src/add/wire-name-literal.test.ts +0 -117
  113. package/src/error-codes-emitted.test.ts +0 -76
  114. package/src/error-codes.ts +0 -145
  115. package/src/index.ts +0 -66
  116. package/src/inspector.ts +0 -575
  117. package/src/schema-generator.ts +0 -1
  118. package/src/source-file-cache.ts +0 -73
  119. package/src/tsconfig-paths.test.ts +0 -90
  120. package/src/types-map.ts +0 -141
  121. package/src/types.ts +0 -775
  122. package/src/utils/annotate-http-route-auth.test.ts +0 -161
  123. package/src/utils/annotate-http-route-auth.ts +0 -53
  124. package/src/utils/check-classified-sinks.ts +0 -215
  125. package/src/utils/check-pii-output.ts +0 -120
  126. package/src/utils/compute-diagnostics.test.ts +0 -106
  127. package/src/utils/compute-required-schemas.ts +0 -48
  128. package/src/utils/contract-hashes.test.ts +0 -553
  129. package/src/utils/contract-hashes.ts +0 -387
  130. package/src/utils/custom-types-generator.test.ts +0 -124
  131. package/src/utils/custom-types-generator.ts +0 -150
  132. package/src/utils/detect-schema-vendor.test.ts +0 -123
  133. package/src/utils/detect-schema-vendor.ts +0 -120
  134. package/src/utils/does-type-extend-core-type.ts +0 -53
  135. package/src/utils/ensure-function-metadata.ts +0 -385
  136. package/src/utils/extract-function-name.ts +0 -612
  137. package/src/utils/extract-function-node.ts +0 -70
  138. package/src/utils/extract-node-value.test.ts +0 -117
  139. package/src/utils/extract-node-value.ts +0 -172
  140. package/src/utils/extract-secret-usage.test.ts +0 -81
  141. package/src/utils/extract-secret-usage.ts +0 -73
  142. package/src/utils/extract-services.ts +0 -70
  143. package/src/utils/extract-surface-usage.test.ts +0 -147
  144. package/src/utils/extract-surface-usage.ts +0 -121
  145. package/src/utils/filter-inspector-state.test.ts +0 -2232
  146. package/src/utils/filter-inspector-state.ts +0 -1298
  147. package/src/utils/filter-utils.test.ts +0 -843
  148. package/src/utils/filter-utils.ts +0 -161
  149. package/src/utils/find-root-dir.ts +0 -68
  150. package/src/utils/find-zod-transform.test.ts +0 -70
  151. package/src/utils/find-zod-transform.ts +0 -103
  152. package/src/utils/get-exported-variable-name.ts +0 -48
  153. package/src/utils/get-files-and-methods.ts +0 -157
  154. package/src/utils/get-property-value.test.ts +0 -141
  155. package/src/utils/get-property-value.ts +0 -331
  156. package/src/utils/hash.ts +0 -26
  157. package/src/utils/literal-properties.ts +0 -97
  158. package/src/utils/load-addon-functions-meta.test.ts +0 -157
  159. package/src/utils/load-addon-functions-meta.ts +0 -508
  160. package/src/utils/load-addon-scopes.test.ts +0 -138
  161. package/src/utils/middleware.test.ts +0 -204
  162. package/src/utils/middleware.ts +0 -303
  163. package/src/utils/nested-project-filter.test.ts +0 -53
  164. package/src/utils/nested-project-filter.ts +0 -28
  165. package/src/utils/permissions-shorthand.test.ts +0 -79
  166. package/src/utils/permissions.test.ts +0 -125
  167. package/src/utils/permissions.ts +0 -129
  168. package/src/utils/post-process.test.ts +0 -1094
  169. package/src/utils/post-process.ts +0 -1604
  170. package/src/utils/resolve-addon-package.ts +0 -106
  171. package/src/utils/resolve-core-type.test.ts +0 -142
  172. package/src/utils/resolve-core-type.ts +0 -35
  173. package/src/utils/resolve-deploy-target.test.ts +0 -135
  174. package/src/utils/resolve-deploy-target.ts +0 -65
  175. package/src/utils/resolve-function-meta.ts +0 -25
  176. package/src/utils/resolve-function-types.ts +0 -42
  177. package/src/utils/resolve-identifier.ts +0 -46
  178. package/src/utils/resolve-ref-contract.ts +0 -71
  179. package/src/utils/resolve-versions.test.ts +0 -499
  180. package/src/utils/resolve-versions.ts +0 -228
  181. package/src/utils/schema-cache.test.ts +0 -124
  182. package/src/utils/schema-generator.test.ts +0 -272
  183. package/src/utils/schema-generator.ts +0 -780
  184. package/src/utils/secret-alias-services.test.ts +0 -146
  185. package/src/utils/secret-alias-services.ts +0 -58
  186. package/src/utils/serialize-inspector-state.ts +0 -742
  187. package/src/utils/serialize-mcp-json.ts +0 -150
  188. package/src/utils/serialize-middleware-groups-meta.ts +0 -36
  189. package/src/utils/serialize-openapi-json.ts +0 -277
  190. package/src/utils/serialize-permissions-groups-meta.ts +0 -7
  191. package/src/utils/single-declaration.ts +0 -57
  192. package/src/utils/type-utils.ts +0 -145
  193. package/src/utils/validate-auth-sessionless.ts +0 -30
  194. package/src/utils/validate-exposed-functions-gated.test.ts +0 -230
  195. package/src/utils/validate-exposed-functions-gated.ts +0 -103
  196. package/src/utils/validate-tags-resolve-to-middleware.test.ts +0 -108
  197. package/src/utils/validate-tags-resolve-to-middleware.ts +0 -48
  198. package/src/utils/workflow/derive-workflow-plan.test.ts +0 -178
  199. package/src/utils/workflow/derive-workflow-plan.ts +0 -117
  200. package/src/utils/workflow/dsl/deserialize-dsl-workflow.ts +0 -1465
  201. package/src/utils/workflow/dsl/deserialize-fanout-body.test.ts +0 -71
  202. package/src/utils/workflow/dsl/deserialize-fanout-fidelity.test.ts +0 -99
  203. package/src/utils/workflow/dsl/deserialize-graph-next.test.ts +0 -161
  204. package/src/utils/workflow/dsl/deserialize-roundtrip-bindings.test.ts +0 -121
  205. package/src/utils/workflow/dsl/deserialize-roundtrip-values.test.ts +0 -116
  206. package/src/utils/workflow/dsl/deserialize-roundtrip.test.ts +0 -145
  207. package/src/utils/workflow/dsl/extract-approval-policy.test.ts +0 -71
  208. package/src/utils/workflow/dsl/extract-dsl-workflow.ts +0 -2254
  209. package/src/utils/workflow/dsl/index.ts +0 -11
  210. package/src/utils/workflow/dsl/patterns.ts +0 -440
  211. package/src/utils/workflow/dsl/validation.ts +0 -203
  212. package/src/utils/workflow/graph/convert-dsl-to-graph-skip.test.ts +0 -35
  213. package/src/utils/workflow/graph/convert-dsl-to-graph.ts +0 -543
  214. package/src/utils/workflow/graph/fanout-node-identity.test.ts +0 -105
  215. package/src/utils/workflow/graph/finalize-workflow-wires.ts +0 -310
  216. package/src/utils/workflow/graph/finalize-workflows.test.ts +0 -50
  217. package/src/utils/workflow/graph/finalize-workflows.ts +0 -130
  218. package/src/utils/workflow/graph/index.ts +0 -28
  219. package/src/utils/workflow/graph/serialize-workflow-graph.ts +0 -240
  220. package/src/utils/workflow/graph/workflow-graph.types.ts +0 -281
  221. package/src/visit.ts +0 -181
  222. package/tsconfig.json +0 -19
  223. package/tsconfig.tsbuildinfo +0 -1
@@ -1,145 +0,0 @@
1
- import { strict as assert } from 'assert'
2
- import { describe, test } from 'node:test'
3
- import { mkdtemp, rm, writeFile } from 'node:fs/promises'
4
- import { tmpdir } from 'node:os'
5
- import { join } from 'node:path'
6
- import { inspect } from '../../../inspector.js'
7
- import type { InspectorLogger } from '../../../types.js'
8
- import { deserializeDslWorkflow } from './deserialize-dsl-workflow.js'
9
-
10
- function makeLogger(): InspectorLogger {
11
- return {
12
- debug: () => {},
13
- info: () => {},
14
- warn: () => {},
15
- error: () => {},
16
- diagnostic: () => {},
17
- critical: () => {},
18
- hasCriticalErrors: () => false,
19
- } as any
20
- }
21
-
22
- const STEP_FILE = [
23
- "import { pikkuSessionlessFunc } from '@pikku/core'",
24
- 'export const discount = pikkuSessionlessFunc({',
25
- ' func: async () => ({ amount: 1 }),',
26
- '})',
27
- 'export const notifySales = pikkuSessionlessFunc({',
28
- ' func: async () => ({ ok: true }),',
29
- '})',
30
- 'export const provision = pikkuSessionlessFunc({',
31
- ' func: async () => ({ ok: true }),',
32
- '})',
33
- 'export const auditLog = pikkuSessionlessFunc({',
34
- ' func: async () => ({ ok: true }),',
35
- '})',
36
- ].join('\n')
37
-
38
- /** Extract a workflow from source, then regenerate its code from the graph. */
39
- async function roundTrip(body: string): Promise<string> {
40
- const rootDir = await mkdtemp(join(tmpdir(), 'pikku-rt-'))
41
- const stepFile = join(rootDir, 'w.steps.ts')
42
- const wfFile = join(rootDir, 'w.workflow.ts')
43
- await writeFile(stepFile, STEP_FILE)
44
- await writeFile(
45
- wfFile,
46
- [
47
- "import { pikkuWorkflowFunc } from '@pikku/core/workflow'",
48
- 'export const wf = pikkuWorkflowFunc(async (_, data: any, { workflow }) => {',
49
- body,
50
- '})',
51
- ].join('\n')
52
- )
53
- try {
54
- const state: any = await inspect(makeLogger(), [stepFile, wfFile], {
55
- rootDir,
56
- })
57
- const gm = state.workflows.graphMeta
58
- const graph = (
59
- gm instanceof Map ? [...gm.values()] : Object.values(gm)
60
- )[0] as any
61
- assert.ok(graph, 'a graph should have been produced')
62
- return deserializeDslWorkflow(graph)
63
- } finally {
64
- await rm(rootDir, { recursive: true, force: true })
65
- }
66
- }
67
-
68
- describe('DSL round-trip — code must survive graph regeneration', () => {
69
- test('every step inside an if-branch survives', async () => {
70
- const code = await roundTrip(
71
- [
72
- ' if (data.total > 100) {',
73
- " await workflow.do('Apply discount', 'discount', {})",
74
- " await workflow.do('Notify sales', 'notifySales', {})",
75
- ' }',
76
- ' return { ok: true }',
77
- ].join('\n')
78
- )
79
-
80
- assert.ok(code.includes("'discount'"), 'first branch step should survive')
81
- assert.ok(
82
- code.includes("'notifySales'"),
83
- `second branch step must not be deleted, got:\n${code}`
84
- )
85
- })
86
-
87
- test('every step inside a switch case survives', async () => {
88
- const code = await roundTrip(
89
- [
90
- ' switch (data.kind) {',
91
- " case 'premium':",
92
- " await workflow.do('Provision premium', 'provision', {})",
93
- " await workflow.do('Audit premium', 'auditLog', {})",
94
- ' break',
95
- ' }',
96
- ' return { ok: true }',
97
- ].join('\n')
98
- )
99
-
100
- assert.ok(code.includes("'provision'"), 'first case step should survive')
101
- assert.ok(
102
- code.includes("'auditLog'"),
103
- `second case step must not be deleted, got:\n${code}`
104
- )
105
- })
106
-
107
- test('step names survive — they are the durable replay cache key', async () => {
108
- const code = await roundTrip(
109
- [
110
- " await workflow.do('Apply discount', 'discount', {})",
111
- ' return { ok: true }',
112
- ].join('\n')
113
- )
114
-
115
- assert.ok(
116
- code.includes("'Apply discount'"),
117
- `the authored step name must be preserved, got:\n${code}`
118
- )
119
- assert.ok(
120
- !code.includes("'Call discount'"),
121
- 'the step must not be renamed to the Call <rpc> fallback'
122
- )
123
- })
124
-
125
- test('a suspend does not dead-end the graph and delete the steps after it', async () => {
126
- const code = await roundTrip(
127
- [
128
- " await workflow.do('Create draft', 'discount', {})",
129
- " await workflow.suspend('await legal review')",
130
- " await workflow.do('Publish', 'notifySales', {})",
131
- ' return { ok: true }',
132
- ].join('\n')
133
- )
134
-
135
- assert.ok(code.includes("'discount'"), 'step before suspend should survive')
136
- assert.ok(
137
- code.includes("workflow.suspend('await legal review')"),
138
- `the suspend itself must be regenerated, got:\n${code}`
139
- )
140
- assert.ok(
141
- code.includes("'notifySales'"),
142
- `steps after a suspend must not be deleted, got:\n${code}`
143
- )
144
- })
145
- })
@@ -1,71 +0,0 @@
1
- import { describe, test } from 'node:test'
2
- import assert from 'node:assert/strict'
3
- import * as ts from 'typescript'
4
- import { extractDSLWorkflow } from './extract-dsl-workflow.js'
5
- import type { ApprovalStepMeta } from '@pikku/core/workflow'
6
-
7
- const checker = {
8
- getSymbolAtLocation: () => undefined,
9
- getAliasedSymbol: () => undefined,
10
- getShorthandAssignmentValueSymbol: () => undefined,
11
- getTypeAtLocation: () => undefined,
12
- } as unknown as ts.TypeChecker
13
-
14
- /** Extracts the single approval step from a workflow body. */
15
- const approvalStepFor = (options: string): ApprovalStepMeta => {
16
- const file = ts.createSourceFile(
17
- 'wf.ts',
18
- `const wf = pikkuWorkflowFunc({
19
- func: async (services, data, { workflow }) => {
20
- await workflow.approval('Release funds', ${options})
21
- },
22
- })`,
23
- ts.ScriptTarget.Latest,
24
- true
25
- )
26
-
27
- let node: ts.Node | undefined
28
- const visit = (n: ts.Node) => {
29
- if (
30
- ts.isCallExpression(n) &&
31
- n.expression.getText() === 'pikkuWorkflowFunc'
32
- ) {
33
- node = n
34
- }
35
- ts.forEachChild(n, visit)
36
- }
37
- visit(file)
38
- assert.ok(node, 'failed to find the workflow definition')
39
-
40
- const result = extractDSLWorkflow(node, checker)
41
- assert.equal(result.status, 'ok', JSON.stringify(result))
42
- const step = result.steps?.find(
43
- (s): s is ApprovalStepMeta => s.type === 'approval'
44
- )
45
- assert.ok(step, 'no approval step was extracted')
46
- return step
47
- }
48
-
49
- describe('an approval gate carries its policy into the graph', () => {
50
- test('approvers and approverScope survive extraction', () => {
51
- const step = approvalStepFor(
52
- `{ schema: DecisionSchema, approvers: 'not-initiator', approverScope: 'payments:approve' }`
53
- )
54
- assert.equal(step.approvers, 'not-initiator')
55
- assert.equal(step.approverScope, 'payments:approve')
56
- })
57
-
58
- test('expiry still survives alongside them', () => {
59
- const step = approvalStepFor(
60
- `{ schema: DecisionSchema, expiry: '3d', approvers: 'owner' }`
61
- )
62
- assert.equal(step.expiry, '3d')
63
- assert.equal(step.approvers, 'owner')
64
- })
65
-
66
- test('a gate declaring no policy records none', () => {
67
- const step = approvalStepFor(`{ schema: DecisionSchema }`)
68
- assert.equal(step.approvers, undefined)
69
- assert.equal(step.approverScope, undefined)
70
- })
71
- })