@orkestrel/scaffold 0.0.115 → 0.0.117
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/dist/bin/main.js +138 -16
- package/dist/bin/main.js.map +1 -1
- package/dist/host/agents/skills/orkestrel-publish/references/wave.md +1 -1
- package/dist/host/claude/agents/orkestrel.md +2 -2
- package/dist/host/claude/rules/names.md +3 -1
- package/dist/host/guides/abort.md +17 -17
- package/dist/host/guides/agent.md +445 -445
- package/dist/host/guides/brief.md +143 -143
- package/dist/host/guides/browser.md +731 -731
- package/dist/host/guides/budget.md +39 -39
- package/dist/host/guides/capture.md +298 -298
- package/dist/host/guides/console.md +109 -109
- package/dist/host/guides/contract.md +335 -335
- package/dist/host/guides/csv.md +30 -30
- package/dist/host/guides/database.md +163 -163
- package/dist/host/guides/emitter.md +17 -17
- package/dist/host/guides/form.md +99 -99
- package/dist/host/guides/guide.md +368 -183
- package/dist/host/guides/html.md +49 -49
- package/dist/host/guides/indexeddb.md +40 -40
- package/dist/host/guides/interpret.md +139 -139
- package/dist/host/guides/lsp.md +114 -114
- package/dist/host/guides/markdown.md +68 -68
- package/dist/host/guides/mcp.md +3745 -3745
- package/dist/host/guides/middleware.md +170 -170
- package/dist/host/guides/msg.md +95 -95
- package/dist/host/guides/ndjson.md +8 -8
- package/dist/host/guides/ollama.md +56 -56
- package/dist/host/guides/pool.md +21 -21
- package/dist/host/guides/probe.md +82 -82
- package/dist/host/guides/process.md +99 -99
- package/dist/host/guides/program.md +98 -96
- package/dist/host/guides/qualifier.md +70 -70
- package/dist/host/guides/queue.md +37 -37
- package/dist/host/guides/rater.md +38 -38
- package/dist/host/guides/reason.md +308 -308
- package/dist/host/guides/relation.md +50 -50
- package/dist/host/guides/router.md +58 -58
- package/dist/host/guides/scaffold.md +558 -419
- package/dist/host/guides/sea.md +128 -128
- package/dist/host/guides/server.md +100 -100
- package/dist/host/guides/sqlite.md +28 -28
- package/dist/host/guides/sse.md +20 -20
- package/dist/host/guides/study.md +444 -444
- package/dist/host/guides/table.md +82 -82
- package/dist/host/guides/template.md +41 -41
- package/dist/host/guides/terminal.md +121 -121
- package/dist/host/guides/test.md +273 -273
- package/dist/host/guides/timeout.md +18 -18
- package/dist/host/guides/tool.md +27 -27
- package/dist/host/guides/toolbox.md +166 -166
- package/dist/host/guides/websocket.md +54 -54
- package/dist/host/guides/worker.md +24 -24
- package/dist/host/guides/workflow.md +187 -187
- package/dist/host/guides/workspace.md +55 -55
- package/dist/host/manifest.json +55 -55
- package/dist/host/tests/setupPolicy.ts +5 -3
- package/dist/src/core/index.cjs +90 -4
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +229 -144
- package/dist/src/core/index.d.ts +229 -144
- package/dist/src/core/index.js +88 -5
- package/dist/src/core/index.js.map +1 -1
- package/dist/src/server/index.cjs +295 -66
- package/dist/src/server/index.cjs.map +1 -1
- package/dist/src/server/index.d.cts +193 -6
- package/dist/src/server/index.d.ts +193 -6
- package/dist/src/server/index.js +290 -69
- package/dist/src/server/index.js.map +1 -1
- package/package.json +5 -4
|
@@ -167,7 +167,7 @@ registry copy over any staged tip, so every consumer stays red until that tip is
|
|
|
167
167
|
|
|
168
168
|
## Prepare a layer
|
|
169
169
|
|
|
170
|
-
-
|
|
170
|
+
- After the re-pin and before `prepublishOnly`, run `scaffold surface` live over every candidate checkout of the layer, never with `--offline`. Stop the upload on any exit but `0`, and resolve every name it reports under `.claude/rules/names.md` § Fleet name ownership. In scaffold's own layer, run `scaffold catalog` and then `scaffold surface --from .`.
|
|
171
171
|
- Begin each release chain plan with the clean reinstall and the clean, whether it runs in a clone or the checkout.
|
|
172
172
|
- When a writer owns a script the preparation needs, run its installed built twin and record the executable's identity.
|
|
173
173
|
- Derive each release row's ruling from the measured distribution comparison and final runtime-range result under § Rule on the bump.
|
|
@@ -56,7 +56,7 @@ Treat generated package identifiers, versions, layers, and dependency ranges as
|
|
|
56
56
|
| `@orkestrel/database` | `0.0.19` | L2 | `@orkestrel/sqlite` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/indexeddb` `^0.0.15` | |
|
|
57
57
|
| `@orkestrel/emitter` | `0.0.13` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
58
58
|
| `@orkestrel/form` | `0.0.14` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
59
|
-
| `@orkestrel/guide` | `0.0.
|
|
59
|
+
| `@orkestrel/guide` | `0.0.28` | L3 | `@orkestrel/contract` `^0.0.20`, `@orkestrel/markdown` `^0.0.18` | |
|
|
60
60
|
| `@orkestrel/html` | `0.0.13` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
61
61
|
| `@orkestrel/indexeddb` | `0.0.15` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
62
62
|
| `@orkestrel/interpret` | `0.0.18` | L3 | `@orkestrel/reason` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/template` `^0.0.11` | |
|
|
@@ -77,7 +77,7 @@ Treat generated package identifiers, versions, layers, and dependency ranges as
|
|
|
77
77
|
| `@orkestrel/reason` | `0.0.15` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
78
78
|
| `@orkestrel/relation` | `0.0.17` | L3 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19` | |
|
|
79
79
|
| `@orkestrel/router` | `0.0.18` | L2 | `@orkestrel/abort` `^0.0.14`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
80
|
-
| `@orkestrel/scaffold` | `0.0.
|
|
80
|
+
| `@orkestrel/scaffold` | `0.0.116` | L3 | `@orkestrel/console` `^0.0.17`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/markdown` `^0.0.18`, `@orkestrel/template` `^0.0.11` | |
|
|
81
81
|
| `@orkestrel/sea` | `0.0.20` | L3 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/contract` `^0.0.20` | |
|
|
82
82
|
| `@orkestrel/server` | `0.0.24` | L3 | `@orkestrel/abort` `^0.0.14`, `@orkestrel/codec` `^0.0.7`, `@orkestrel/router` `^0.0.18`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20` | |
|
|
83
83
|
| `@orkestrel/sqlite` | `0.0.15` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
@@ -130,7 +130,9 @@ The root design laws in `AGENTS.md` — one term per concept, boolean behavior s
|
|
|
130
130
|
|
|
131
131
|
Give every bare exported name one owning package across the `@orkestrel` fleet. A bare name is the identifier alone, case included: the same identifier in another environment, or on another kind of declaration, is the same name, and the same word in another case is a different name.
|
|
132
132
|
|
|
133
|
-
|
|
133
|
+
Export a bare name from one environment of its package. When two environments of one package export one name, resolve that conflict inside the package: put logic that can run in both environments once in `src/core`; where their internals differ, share what they can in `src/core` and give each environment's export a distinct name built on it; where they share nothing, give each environment's export a distinct name. No collision record holds a conflict, and the following rules resolve a collision between packages.
|
|
134
|
+
|
|
135
|
+
Before adding a public name, check it against the fleet with `scaffold surface`. `.claude/rules/workspace.md` § Policy instruments owns the `surface` policy rule.
|
|
134
136
|
|
|
135
137
|
The rule grandfathers a source name the target's own hosted guide claims, because that guide is the target's own claim to it. It grandfathers no root `tests/setup*.ts` export. A vendored `tests/setup*.ts` module a scaffold release stages sits outside the inspected population.
|
|
136
138
|
|
|
@@ -32,39 +32,39 @@ Construction is a strict JavaScript boundary. `validateAbortOptions` normalizes
|
|
|
32
32
|
|
|
33
33
|
### Factories
|
|
34
34
|
|
|
35
|
-
|
|
|
36
|
-
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
37
|
-
| `createAbort` | function | Creates a cancellation handle from validated options and returns it as an `AbortInterface` — a resolved trace `id` and a `signal` already linked to any parent given, so a caller holds the published contract rather than the `Abort` class. |
|
|
35
|
+
| Name | Kind | Signature | Summary |
|
|
36
|
+
| ------------- | -------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
37
|
+
| `createAbort` | function | `(options?: AbortOptions) => AbortInterface` | Creates a cancellation handle from validated options and returns it as an `AbortInterface` — a resolved trace `id` and a `signal` already linked to any parent given, so a caller holds the published contract rather than the `Abort` class. |
|
|
38
38
|
|
|
39
39
|
### Helpers
|
|
40
40
|
|
|
41
|
-
|
|
|
42
|
-
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
43
|
-
| `validateAbortOptions` | function | Validates once-read abort construction options and returns a fresh normalized copy omitting absent optional keys. |
|
|
44
|
-
| `linkSignal` | function | Links an own `AbortSignal` to an optional parent signal, returning `AbortSignal.any([own, parent])` when a parent is given. |
|
|
41
|
+
| Name | Kind | Signature | Summary |
|
|
42
|
+
| ---------------------- | -------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
43
|
+
| `validateAbortOptions` | function | `(options?: AbortOptions) => AbortOptions` | Validates once-read abort construction options and returns a fresh normalized copy omitting absent optional keys. |
|
|
44
|
+
| `linkSignal` | function | `(own: AbortSignal, parent: AbortSignal \| undefined) => AbortSignal` | Links an own `AbortSignal` to an optional parent signal, returning `AbortSignal.any([own, parent])` when a parent is given. |
|
|
45
45
|
|
|
46
46
|
### Validators
|
|
47
47
|
|
|
48
48
|
In a guard table a `Shape` cell holds the type the guard narrows to.
|
|
49
49
|
|
|
50
|
-
|
|
|
51
|
-
| --------------- | -------- |
|
|
52
|
-
| `isAbortSignal` | function | `AbortSignal` | Determines whether a value is a native `AbortSignal`, staying total for structural spoofs and for hostile or revoked proxies. |
|
|
50
|
+
| Name | Kind | Signature | Summary |
|
|
51
|
+
| --------------- | -------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
52
|
+
| `isAbortSignal` | function | `(value: unknown) => value is AbortSignal` | Determines whether a value is a native `AbortSignal`, staying total for structural spoofs and for hostile or revoked proxies. |
|
|
53
53
|
|
|
54
54
|
### Classes
|
|
55
55
|
|
|
56
|
-
|
|
|
57
|
-
| ------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
58
|
-
| `Abort` | class | Implements `AbortInterface` over a private `AbortController` the instance owns, resolving the trace `id` at construction and exposing either that controller's own `signal` or one linked to a parent. |
|
|
56
|
+
| Name | Kind | Signature | Summary |
|
|
57
|
+
| ------- | ----- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
58
|
+
| `Abort` | class | `new (options?: AbortOptions) => AbortInterface` | Implements `AbortInterface` over a private `AbortController` the instance owns, resolving the trace `id` at construction and exposing either that controller's own `signal` or one linked to a parent. |
|
|
59
59
|
|
|
60
60
|
### Types
|
|
61
61
|
|
|
62
62
|
A `Shape` cell holds an interface's data members as bare names in braces, `?` marking an optional member and `plus` introducing its call-signature members, and a type alias's own type literal with a union's arms escaped as `\|`.
|
|
63
63
|
|
|
64
|
-
|
|
|
65
|
-
| ---------------- | --------- |
|
|
66
|
-
| `AbortOptions` | interface | `{ id?, signal? }`
|
|
67
|
-
| `AbortInterface` | interface | `{ id, signal, aborted }
|
|
64
|
+
| Name | Kind | Signature | Summary |
|
|
65
|
+
| ---------------- | --------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
66
|
+
| `AbortOptions` | interface | `{ id?, signal? }` | Represents the options for `createAbort` and `Abort` construction. |
|
|
67
|
+
| `AbortInterface` | interface | `{ id, signal, aborted, abort() }` | Represents the cancellation contract a consumer holds — a traceable `id`, the exposed `AbortSignal`, an `aborted` reading of it, and an idempotent `abort` that cancels the work bound to that signal. |
|
|
68
68
|
|
|
69
69
|
The `id`, `signal`, and `aborted` members of `AbortInterface` are `readonly` data members (Surface rows, earlier) — its call-signature method is documented under [Methods](#methods).
|
|
70
70
|
|