@orkestrel/scaffold 0.0.118 → 0.0.120
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 +15 -15
- package/dist/bin/main.js.map +1 -1
- package/dist/host/agents/platforms/windows.md +2 -1
- package/dist/host/agents/skills/orkestrel-journey/references/layer.md +10 -10
- package/dist/host/agents/skills/orkestrel-journey/references/statechart.md +1 -1
- package/dist/host/agents/skills/orkestrel-journey/references/styles.md +3 -3
- package/dist/host/agents/skills/orkestrel-publish/references/release.md +1 -0
- package/dist/host/agents/skills/orkestrel-publish/references/wave.md +2 -1
- package/dist/host/claude/agents/orkestrel.md +27 -26
- package/dist/host/claude/rules/names.md +3 -2
- package/dist/host/claude/rules/tests.md +4 -2
- package/dist/host/claude/rules/typescript.md +2 -3
- package/dist/host/claude/rules/workspace.md +2 -1
- package/dist/host/guides/abort.md +0 -4
- package/dist/host/guides/budget.md +1 -5
- package/dist/host/guides/codec.md +18 -3
- package/dist/host/guides/contract.md +23 -44
- package/dist/host/guides/csv.md +86 -93
- package/dist/host/guides/database.md +0 -4
- package/dist/host/guides/emitter.md +0 -2
- package/dist/host/guides/form.md +26 -47
- package/dist/host/guides/html.md +3 -7
- package/dist/host/guides/indexeddb.md +28 -32
- package/dist/host/guides/jsonrpc.md +187 -0
- package/dist/host/guides/markdown.md +132 -141
- package/dist/host/guides/msg.md +47 -63
- package/dist/host/guides/ndjson.md +0 -4
- package/dist/host/guides/pool.md +0 -4
- package/dist/host/guides/process.md +71 -79
- package/dist/host/guides/reason.md +30 -36
- package/dist/host/guides/router.md +11 -18
- package/dist/host/guides/scaffold.md +147 -137
- package/dist/host/guides/sqlite.md +0 -4
- package/dist/host/guides/sse.md +6 -10
- package/dist/host/guides/table.md +481 -493
- package/dist/host/guides/template.md +0 -4
- package/dist/host/guides/test.md +46 -66
- package/dist/host/guides/timeout.md +0 -6
- package/dist/host/guides/tool.md +2 -6
- package/dist/host/guides/websocket.md +0 -4
- package/dist/host/manifest.json +100 -428
- package/dist/host/tests/setupPolicy.ts +18 -6
- package/dist/src/core/index.cjs +171 -122
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +236 -213
- package/dist/src/core/index.d.ts +236 -213
- package/dist/src/core/index.js +159 -111
- package/dist/src/core/index.js.map +1 -1
- package/dist/src/server/index.cjs +62 -39
- package/dist/src/server/index.cjs.map +1 -1
- package/dist/src/server/index.d.cts +59 -54
- package/dist/src/server/index.d.ts +59 -54
- package/dist/src/server/index.js +63 -40
- package/dist/src/server/index.js.map +1 -1
- package/package.json +9 -9
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
import type { ArtifactGroup } from '@orkestrel/scaffold';
|
|
1
2
|
import type { Audit } from '@orkestrel/scaffold';
|
|
2
3
|
import type { CatalogEntry } from '@orkestrel/scaffold';
|
|
3
4
|
import type { Dependency } from '@orkestrel/scaffold';
|
|
4
5
|
import type { EmitterErrorHandler } from '@orkestrel/emitter';
|
|
5
6
|
import type { EmitterHooks } from '@orkestrel/emitter';
|
|
6
7
|
import type { EmitterInterface } from '@orkestrel/emitter';
|
|
7
|
-
import type { Group } from '@orkestrel/scaffold';
|
|
8
8
|
import type { Guard } from '@orkestrel/contract';
|
|
9
9
|
import type { HostFile } from '@orkestrel/scaffold';
|
|
10
10
|
import type { Lookup } from '@orkestrel/scaffold';
|
|
@@ -165,7 +165,7 @@ export declare function computeFileDigest(path: string): string | undefined;
|
|
|
165
165
|
* computeManifestDigest([], [], []) // the digest of the empty membership
|
|
166
166
|
* ```
|
|
167
167
|
*/
|
|
168
|
-
export declare function computeManifestDigest(entries: readonly
|
|
168
|
+
export declare function computeManifestDigest(entries: readonly HostManifestEntry[], roots: readonly string[], surface: readonly SurfaceCollision[]): string;
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
171
|
* Decodes exact bytes stated in hexadecimal as strict UTF-8 text.
|
|
@@ -348,19 +348,35 @@ export declare interface HostInventory {
|
|
|
348
348
|
* @remarks
|
|
349
349
|
* `roots` is the sorted directory inventory, which is what distinguishes a
|
|
350
350
|
* declared empty directory. `surface` records only names claimed by distinct
|
|
351
|
-
* guides
|
|
351
|
+
* guides or admitted to a keeper by `SURFACE_TRANSFERS`, sorted by name with each
|
|
352
|
+
* owner list sorted. `digest` is the SHA-256
|
|
352
353
|
* of the exact entries, roots, and surface, so an edit without its digest is
|
|
353
354
|
* detected. A self-consistent replacement manifest defines its own smaller
|
|
354
355
|
* membership; authenticating omitted membership is outside a checksum's
|
|
355
356
|
* contract.
|
|
356
357
|
*/
|
|
357
358
|
export declare interface HostManifest {
|
|
358
|
-
readonly entries: readonly
|
|
359
|
+
readonly entries: readonly HostManifestEntry[];
|
|
359
360
|
readonly roots: readonly string[];
|
|
360
361
|
readonly surface: readonly SurfaceCollision[];
|
|
361
362
|
readonly digest: string;
|
|
362
363
|
}
|
|
363
364
|
|
|
365
|
+
/**
|
|
366
|
+
* Represents one file record of the vendored host's manifest.
|
|
367
|
+
*
|
|
368
|
+
* @remarks
|
|
369
|
+
* `digest` is the SHA-256 of the file's exact bytes. A live read compares it
|
|
370
|
+
* against the target's copy, and verifies host-supplied bytes against it before
|
|
371
|
+
* treating them as that entry.
|
|
372
|
+
*/
|
|
373
|
+
export declare interface HostManifestEntry {
|
|
374
|
+
readonly storage: string;
|
|
375
|
+
readonly destination: string;
|
|
376
|
+
readonly executable: boolean;
|
|
377
|
+
readonly digest: string;
|
|
378
|
+
}
|
|
379
|
+
|
|
364
380
|
/**
|
|
365
381
|
* Configures the committed inventory baseline and staging reports.
|
|
366
382
|
*
|
|
@@ -556,6 +572,29 @@ export declare const isHost: Guard<Host>;
|
|
|
556
572
|
*/
|
|
557
573
|
export declare const isHostManifest: Guard<HostManifest>;
|
|
558
574
|
|
|
575
|
+
/**
|
|
576
|
+
* Narrows a value to one {@link HostManifestEntry}.
|
|
577
|
+
*
|
|
578
|
+
* @remarks
|
|
579
|
+
* Both paths are measured by the core path law, because a vendored host's
|
|
580
|
+
* storage name and the destination it maps to are each a path inside a
|
|
581
|
+
* workspace. That is what stops a hand-edited manifest from mapping a vendored
|
|
582
|
+
* file to a destination outside the target.
|
|
583
|
+
*
|
|
584
|
+
* @example
|
|
585
|
+
* ```ts
|
|
586
|
+
* import { isHostManifestEntry } from '@orkestrel/scaffold/server'
|
|
587
|
+
*
|
|
588
|
+
* isHostManifestEntry({
|
|
589
|
+
* storage: 'AGENTS.md',
|
|
590
|
+
* destination: 'AGENTS.md',
|
|
591
|
+
* executable: false,
|
|
592
|
+
* digest: 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
|
|
593
|
+
* }) // true
|
|
594
|
+
* ```
|
|
595
|
+
*/
|
|
596
|
+
export declare const isHostManifestEntry: Guard<HostManifestEntry>;
|
|
597
|
+
|
|
559
598
|
/**
|
|
560
599
|
* Narrows a value to a working-tree inventory within the limit one target may report.
|
|
561
600
|
*
|
|
@@ -581,29 +620,6 @@ export declare const isHostManifest: Guard<HostManifest>;
|
|
|
581
620
|
*/
|
|
582
621
|
export declare function isInventory(value: unknown): value is readonly unknown[];
|
|
583
622
|
|
|
584
|
-
/**
|
|
585
|
-
* Narrows a value to one {@link ManifestEntry}.
|
|
586
|
-
*
|
|
587
|
-
* @remarks
|
|
588
|
-
* Both paths are measured by the core path law, because a vendored host's
|
|
589
|
-
* storage name and the destination it maps to are each a path inside a
|
|
590
|
-
* workspace. That is what stops a hand-edited manifest from mapping a vendored
|
|
591
|
-
* file to a destination outside the target.
|
|
592
|
-
*
|
|
593
|
-
* @example
|
|
594
|
-
* ```ts
|
|
595
|
-
* import { isManifestEntry } from '@orkestrel/scaffold/server'
|
|
596
|
-
*
|
|
597
|
-
* isManifestEntry({
|
|
598
|
-
* storage: 'AGENTS.md',
|
|
599
|
-
* destination: 'AGENTS.md',
|
|
600
|
-
* executable: false,
|
|
601
|
-
* digest: 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
|
|
602
|
-
* }) // true
|
|
603
|
-
* ```
|
|
604
|
-
*/
|
|
605
|
-
export declare const isManifestEntry: Guard<ManifestEntry>;
|
|
606
|
-
|
|
607
623
|
/**
|
|
608
624
|
* Narrows a value to one {@link ManifestRegionSet}.
|
|
609
625
|
*
|
|
@@ -870,7 +886,7 @@ export declare function listAncestors(path: string, limit?: number): readonly st
|
|
|
870
886
|
* listCanonPaths('vacant', ['orchestration']) // []
|
|
871
887
|
* ```
|
|
872
888
|
*/
|
|
873
|
-
export declare function listCanonPaths(target: string, groups: readonly
|
|
889
|
+
export declare function listCanonPaths(target: string, groups: readonly ArtifactGroup[]): readonly string[];
|
|
874
890
|
|
|
875
891
|
/**
|
|
876
892
|
* Lists a directory's descendant directories as sorted root-relative paths.
|
|
@@ -944,21 +960,6 @@ export declare function listFiles(root: string): readonly string[];
|
|
|
944
960
|
*/
|
|
945
961
|
export declare const MANIFEST_NAME = "manifest.json";
|
|
946
962
|
|
|
947
|
-
/**
|
|
948
|
-
* Represents one file record of the vendored host's manifest.
|
|
949
|
-
*
|
|
950
|
-
* @remarks
|
|
951
|
-
* `digest` is the SHA-256 of the file's exact bytes. A live read compares it
|
|
952
|
-
* against the target's copy, and verifies host-supplied bytes against it before
|
|
953
|
-
* treating them as that entry.
|
|
954
|
-
*/
|
|
955
|
-
export declare interface ManifestEntry {
|
|
956
|
-
readonly storage: string;
|
|
957
|
-
readonly destination: string;
|
|
958
|
-
readonly executable: boolean;
|
|
959
|
-
readonly digest: string;
|
|
960
|
-
}
|
|
961
|
-
|
|
962
963
|
/**
|
|
963
964
|
* Tests whether a path still holds the captured directory identity.
|
|
964
965
|
*
|
|
@@ -1295,7 +1296,7 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
1295
1296
|
* match the ones the audit carried for every path the plan owns; anything else
|
|
1296
1297
|
* means the target moved, and the whole call is refused. The audit is checked
|
|
1297
1298
|
* for agreement rather than for plausibility, so a verdict the comparison could
|
|
1298
|
-
* not have produced — a birth-owned path reported stale, which the `
|
|
1299
|
+
* not have produced — a birth-owned path reported stale, which the `ArtifactFinding`
|
|
1299
1300
|
* shape admits — disagrees with the derived one and is refused. A missing
|
|
1300
1301
|
* destination is restored whatever its ownership; a stale one is replaced only
|
|
1301
1302
|
* where the artifact claims its bytes, which is what leaves a presence-owned
|
|
@@ -1490,7 +1491,7 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
1490
1491
|
* @remarks
|
|
1491
1492
|
* The audit is checked for agreement rather than for plausibility, so a verdict
|
|
1492
1493
|
* the comparison could not have produced — a birth-owned path reported stale,
|
|
1493
|
-
* which the `
|
|
1494
|
+
* which the `ArtifactFinding` shape admits — disagrees with the derived one and is
|
|
1494
1495
|
* refused.
|
|
1495
1496
|
*
|
|
1496
1497
|
* The whole audit is guarded before any of it is read, so an audit produced by
|
|
@@ -1973,13 +1974,13 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
1973
1974
|
*
|
|
1974
1975
|
* @example
|
|
1975
1976
|
* ```ts
|
|
1976
|
-
* import {
|
|
1977
|
+
* import { readHostManifestEntry } from '@orkestrel/scaffold/server'
|
|
1977
1978
|
*
|
|
1978
|
-
*
|
|
1979
|
+
* readHostManifestEntry('.gitignore', '/tmp/checkout/.gitignore')
|
|
1979
1980
|
* // { storage: 'dotfiles/gitignore', destination: '.gitignore', executable: false, digest: '...' }
|
|
1980
1981
|
* ```
|
|
1981
1982
|
*/
|
|
1982
|
-
export declare function
|
|
1983
|
+
export declare function readHostManifestEntry(destination: string, source: string): HostManifestEntry | undefined;
|
|
1983
1984
|
|
|
1984
1985
|
/**
|
|
1985
1986
|
* Reads a target's current bytes at the paths a plan claims.
|
|
@@ -2314,7 +2315,7 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2314
2315
|
* // [{ storage: 'scripts/codex.sh', destination: 'scripts/codex.sh', executable: true, digest: '…' }]
|
|
2315
2316
|
* ```
|
|
2316
2317
|
*/
|
|
2317
|
-
export declare function stageBytes(host: Host, root: string, destinations: readonly string[]): readonly
|
|
2318
|
+
export declare function stageBytes(host: Host, root: string, destinations: readonly string[]): readonly HostManifestEntry[];
|
|
2318
2319
|
|
|
2319
2320
|
/**
|
|
2320
2321
|
* Stages a vendored host root from a real checkout.
|
|
@@ -2330,8 +2331,9 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2330
2331
|
* host root is not vacant, the checkout does not carry every vendored path, two
|
|
2331
2332
|
* vendored files claim one storage name, a vendored file is not a plain file
|
|
2332
2333
|
* within the artifact ceiling, published guides are unreadable, a staged
|
|
2333
|
-
* collision's owner set is not a subset of its published owner set,
|
|
2334
|
-
* `
|
|
2334
|
+
* collision's owner set is not a subset of its published owner set, a
|
|
2335
|
+
* `SURFACE_TRANSFERS` entry is spent because its keeper alone claims the name, the
|
|
2336
|
+
* inventory is absent without `establish: true`, or the staged manifest does not read back.
|
|
2335
2337
|
* @throws `ScaffoldError('WRITE', …)` when a staged file or the manifest cannot
|
|
2336
2338
|
* be written.
|
|
2337
2339
|
*
|
|
@@ -2367,7 +2369,10 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2367
2369
|
* the canon and reference files for reading. Every catalog package must have a
|
|
2368
2370
|
* guide in the discovered membership before the host is written.
|
|
2369
2371
|
* Copied guides must carry no collision whose name and exact owner set the
|
|
2370
|
-
* committed inventory lacks.
|
|
2372
|
+
* committed inventory lacks. A `SURFACE_TRANSFERS` entry that another guide claims
|
|
2373
|
+
* admits its keeper beside the recorded owners, or beside the one owner of a name
|
|
2374
|
+
* the inventory lacks, and the staged surface records that keeper whether or not
|
|
2375
|
+
* its guide is mirrored. An absent inventory requires `establish: true`;
|
|
2371
2376
|
* an inventory without a valid recorded Surface is refused.
|
|
2372
2377
|
* Everything downstream — the missing-path refusal, the
|
|
2373
2378
|
* storage collision guard, the sort, the digests, and the root inventory — reads
|
|
@@ -2382,10 +2387,10 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2382
2387
|
* ```ts
|
|
2383
2388
|
* import { stageHost } from '@orkestrel/scaffold/server'
|
|
2384
2389
|
*
|
|
2385
|
-
* stageHost(process.cwd(), 'dist/host') // one
|
|
2390
|
+
* stageHost(process.cwd(), 'dist/host') // one HostManifestEntry per file staged
|
|
2386
2391
|
* ```
|
|
2387
2392
|
*/
|
|
2388
|
-
export declare function stageHost(checkout: string, host: string, options?: HostStageOptions): readonly
|
|
2393
|
+
export declare function stageHost(checkout: string, host: string, options?: HostStageOptions): readonly HostManifestEntry[];
|
|
2389
2394
|
|
|
2390
2395
|
/**
|
|
2391
2396
|
* Stages the committed inventory of the files a vendored host carries.
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
import type { ArtifactGroup } from '@orkestrel/scaffold';
|
|
1
2
|
import type { Audit } from '@orkestrel/scaffold';
|
|
2
3
|
import type { CatalogEntry } from '@orkestrel/scaffold';
|
|
3
4
|
import type { Dependency } from '@orkestrel/scaffold';
|
|
4
5
|
import type { EmitterErrorHandler } from '@orkestrel/emitter';
|
|
5
6
|
import type { EmitterHooks } from '@orkestrel/emitter';
|
|
6
7
|
import type { EmitterInterface } from '@orkestrel/emitter';
|
|
7
|
-
import type { Group } from '@orkestrel/scaffold';
|
|
8
8
|
import type { Guard } from '@orkestrel/contract';
|
|
9
9
|
import type { HostFile } from '@orkestrel/scaffold';
|
|
10
10
|
import type { Lookup } from '@orkestrel/scaffold';
|
|
@@ -165,7 +165,7 @@ export declare function computeFileDigest(path: string): string | undefined;
|
|
|
165
165
|
* computeManifestDigest([], [], []) // the digest of the empty membership
|
|
166
166
|
* ```
|
|
167
167
|
*/
|
|
168
|
-
export declare function computeManifestDigest(entries: readonly
|
|
168
|
+
export declare function computeManifestDigest(entries: readonly HostManifestEntry[], roots: readonly string[], surface: readonly SurfaceCollision[]): string;
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
171
|
* Decodes exact bytes stated in hexadecimal as strict UTF-8 text.
|
|
@@ -348,19 +348,35 @@ export declare interface HostInventory {
|
|
|
348
348
|
* @remarks
|
|
349
349
|
* `roots` is the sorted directory inventory, which is what distinguishes a
|
|
350
350
|
* declared empty directory. `surface` records only names claimed by distinct
|
|
351
|
-
* guides
|
|
351
|
+
* guides or admitted to a keeper by `SURFACE_TRANSFERS`, sorted by name with each
|
|
352
|
+
* owner list sorted. `digest` is the SHA-256
|
|
352
353
|
* of the exact entries, roots, and surface, so an edit without its digest is
|
|
353
354
|
* detected. A self-consistent replacement manifest defines its own smaller
|
|
354
355
|
* membership; authenticating omitted membership is outside a checksum's
|
|
355
356
|
* contract.
|
|
356
357
|
*/
|
|
357
358
|
export declare interface HostManifest {
|
|
358
|
-
readonly entries: readonly
|
|
359
|
+
readonly entries: readonly HostManifestEntry[];
|
|
359
360
|
readonly roots: readonly string[];
|
|
360
361
|
readonly surface: readonly SurfaceCollision[];
|
|
361
362
|
readonly digest: string;
|
|
362
363
|
}
|
|
363
364
|
|
|
365
|
+
/**
|
|
366
|
+
* Represents one file record of the vendored host's manifest.
|
|
367
|
+
*
|
|
368
|
+
* @remarks
|
|
369
|
+
* `digest` is the SHA-256 of the file's exact bytes. A live read compares it
|
|
370
|
+
* against the target's copy, and verifies host-supplied bytes against it before
|
|
371
|
+
* treating them as that entry.
|
|
372
|
+
*/
|
|
373
|
+
export declare interface HostManifestEntry {
|
|
374
|
+
readonly storage: string;
|
|
375
|
+
readonly destination: string;
|
|
376
|
+
readonly executable: boolean;
|
|
377
|
+
readonly digest: string;
|
|
378
|
+
}
|
|
379
|
+
|
|
364
380
|
/**
|
|
365
381
|
* Configures the committed inventory baseline and staging reports.
|
|
366
382
|
*
|
|
@@ -556,6 +572,29 @@ export declare const isHost: Guard<Host>;
|
|
|
556
572
|
*/
|
|
557
573
|
export declare const isHostManifest: Guard<HostManifest>;
|
|
558
574
|
|
|
575
|
+
/**
|
|
576
|
+
* Narrows a value to one {@link HostManifestEntry}.
|
|
577
|
+
*
|
|
578
|
+
* @remarks
|
|
579
|
+
* Both paths are measured by the core path law, because a vendored host's
|
|
580
|
+
* storage name and the destination it maps to are each a path inside a
|
|
581
|
+
* workspace. That is what stops a hand-edited manifest from mapping a vendored
|
|
582
|
+
* file to a destination outside the target.
|
|
583
|
+
*
|
|
584
|
+
* @example
|
|
585
|
+
* ```ts
|
|
586
|
+
* import { isHostManifestEntry } from '@orkestrel/scaffold/server'
|
|
587
|
+
*
|
|
588
|
+
* isHostManifestEntry({
|
|
589
|
+
* storage: 'AGENTS.md',
|
|
590
|
+
* destination: 'AGENTS.md',
|
|
591
|
+
* executable: false,
|
|
592
|
+
* digest: 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
|
|
593
|
+
* }) // true
|
|
594
|
+
* ```
|
|
595
|
+
*/
|
|
596
|
+
export declare const isHostManifestEntry: Guard<HostManifestEntry>;
|
|
597
|
+
|
|
559
598
|
/**
|
|
560
599
|
* Narrows a value to a working-tree inventory within the limit one target may report.
|
|
561
600
|
*
|
|
@@ -581,29 +620,6 @@ export declare const isHostManifest: Guard<HostManifest>;
|
|
|
581
620
|
*/
|
|
582
621
|
export declare function isInventory(value: unknown): value is readonly unknown[];
|
|
583
622
|
|
|
584
|
-
/**
|
|
585
|
-
* Narrows a value to one {@link ManifestEntry}.
|
|
586
|
-
*
|
|
587
|
-
* @remarks
|
|
588
|
-
* Both paths are measured by the core path law, because a vendored host's
|
|
589
|
-
* storage name and the destination it maps to are each a path inside a
|
|
590
|
-
* workspace. That is what stops a hand-edited manifest from mapping a vendored
|
|
591
|
-
* file to a destination outside the target.
|
|
592
|
-
*
|
|
593
|
-
* @example
|
|
594
|
-
* ```ts
|
|
595
|
-
* import { isManifestEntry } from '@orkestrel/scaffold/server'
|
|
596
|
-
*
|
|
597
|
-
* isManifestEntry({
|
|
598
|
-
* storage: 'AGENTS.md',
|
|
599
|
-
* destination: 'AGENTS.md',
|
|
600
|
-
* executable: false,
|
|
601
|
-
* digest: 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
|
|
602
|
-
* }) // true
|
|
603
|
-
* ```
|
|
604
|
-
*/
|
|
605
|
-
export declare const isManifestEntry: Guard<ManifestEntry>;
|
|
606
|
-
|
|
607
623
|
/**
|
|
608
624
|
* Narrows a value to one {@link ManifestRegionSet}.
|
|
609
625
|
*
|
|
@@ -870,7 +886,7 @@ export declare function listAncestors(path: string, limit?: number): readonly st
|
|
|
870
886
|
* listCanonPaths('vacant', ['orchestration']) // []
|
|
871
887
|
* ```
|
|
872
888
|
*/
|
|
873
|
-
export declare function listCanonPaths(target: string, groups: readonly
|
|
889
|
+
export declare function listCanonPaths(target: string, groups: readonly ArtifactGroup[]): readonly string[];
|
|
874
890
|
|
|
875
891
|
/**
|
|
876
892
|
* Lists a directory's descendant directories as sorted root-relative paths.
|
|
@@ -944,21 +960,6 @@ export declare function listFiles(root: string): readonly string[];
|
|
|
944
960
|
*/
|
|
945
961
|
export declare const MANIFEST_NAME = "manifest.json";
|
|
946
962
|
|
|
947
|
-
/**
|
|
948
|
-
* Represents one file record of the vendored host's manifest.
|
|
949
|
-
*
|
|
950
|
-
* @remarks
|
|
951
|
-
* `digest` is the SHA-256 of the file's exact bytes. A live read compares it
|
|
952
|
-
* against the target's copy, and verifies host-supplied bytes against it before
|
|
953
|
-
* treating them as that entry.
|
|
954
|
-
*/
|
|
955
|
-
export declare interface ManifestEntry {
|
|
956
|
-
readonly storage: string;
|
|
957
|
-
readonly destination: string;
|
|
958
|
-
readonly executable: boolean;
|
|
959
|
-
readonly digest: string;
|
|
960
|
-
}
|
|
961
|
-
|
|
962
963
|
/**
|
|
963
964
|
* Tests whether a path still holds the captured directory identity.
|
|
964
965
|
*
|
|
@@ -1295,7 +1296,7 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
1295
1296
|
* match the ones the audit carried for every path the plan owns; anything else
|
|
1296
1297
|
* means the target moved, and the whole call is refused. The audit is checked
|
|
1297
1298
|
* for agreement rather than for plausibility, so a verdict the comparison could
|
|
1298
|
-
* not have produced — a birth-owned path reported stale, which the `
|
|
1299
|
+
* not have produced — a birth-owned path reported stale, which the `ArtifactFinding`
|
|
1299
1300
|
* shape admits — disagrees with the derived one and is refused. A missing
|
|
1300
1301
|
* destination is restored whatever its ownership; a stale one is replaced only
|
|
1301
1302
|
* where the artifact claims its bytes, which is what leaves a presence-owned
|
|
@@ -1490,7 +1491,7 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
1490
1491
|
* @remarks
|
|
1491
1492
|
* The audit is checked for agreement rather than for plausibility, so a verdict
|
|
1492
1493
|
* the comparison could not have produced — a birth-owned path reported stale,
|
|
1493
|
-
* which the `
|
|
1494
|
+
* which the `ArtifactFinding` shape admits — disagrees with the derived one and is
|
|
1494
1495
|
* refused.
|
|
1495
1496
|
*
|
|
1496
1497
|
* The whole audit is guarded before any of it is read, so an audit produced by
|
|
@@ -1973,13 +1974,13 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
1973
1974
|
*
|
|
1974
1975
|
* @example
|
|
1975
1976
|
* ```ts
|
|
1976
|
-
* import {
|
|
1977
|
+
* import { readHostManifestEntry } from '@orkestrel/scaffold/server'
|
|
1977
1978
|
*
|
|
1978
|
-
*
|
|
1979
|
+
* readHostManifestEntry('.gitignore', '/tmp/checkout/.gitignore')
|
|
1979
1980
|
* // { storage: 'dotfiles/gitignore', destination: '.gitignore', executable: false, digest: '...' }
|
|
1980
1981
|
* ```
|
|
1981
1982
|
*/
|
|
1982
|
-
export declare function
|
|
1983
|
+
export declare function readHostManifestEntry(destination: string, source: string): HostManifestEntry | undefined;
|
|
1983
1984
|
|
|
1984
1985
|
/**
|
|
1985
1986
|
* Reads a target's current bytes at the paths a plan claims.
|
|
@@ -2314,7 +2315,7 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2314
2315
|
* // [{ storage: 'scripts/codex.sh', destination: 'scripts/codex.sh', executable: true, digest: '…' }]
|
|
2315
2316
|
* ```
|
|
2316
2317
|
*/
|
|
2317
|
-
export declare function stageBytes(host: Host, root: string, destinations: readonly string[]): readonly
|
|
2318
|
+
export declare function stageBytes(host: Host, root: string, destinations: readonly string[]): readonly HostManifestEntry[];
|
|
2318
2319
|
|
|
2319
2320
|
/**
|
|
2320
2321
|
* Stages a vendored host root from a real checkout.
|
|
@@ -2330,8 +2331,9 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2330
2331
|
* host root is not vacant, the checkout does not carry every vendored path, two
|
|
2331
2332
|
* vendored files claim one storage name, a vendored file is not a plain file
|
|
2332
2333
|
* within the artifact ceiling, published guides are unreadable, a staged
|
|
2333
|
-
* collision's owner set is not a subset of its published owner set,
|
|
2334
|
-
* `
|
|
2334
|
+
* collision's owner set is not a subset of its published owner set, a
|
|
2335
|
+
* `SURFACE_TRANSFERS` entry is spent because its keeper alone claims the name, the
|
|
2336
|
+
* inventory is absent without `establish: true`, or the staged manifest does not read back.
|
|
2335
2337
|
* @throws `ScaffoldError('WRITE', …)` when a staged file or the manifest cannot
|
|
2336
2338
|
* be written.
|
|
2337
2339
|
*
|
|
@@ -2367,7 +2369,10 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2367
2369
|
* the canon and reference files for reading. Every catalog package must have a
|
|
2368
2370
|
* guide in the discovered membership before the host is written.
|
|
2369
2371
|
* Copied guides must carry no collision whose name and exact owner set the
|
|
2370
|
-
* committed inventory lacks.
|
|
2372
|
+
* committed inventory lacks. A `SURFACE_TRANSFERS` entry that another guide claims
|
|
2373
|
+
* admits its keeper beside the recorded owners, or beside the one owner of a name
|
|
2374
|
+
* the inventory lacks, and the staged surface records that keeper whether or not
|
|
2375
|
+
* its guide is mirrored. An absent inventory requires `establish: true`;
|
|
2371
2376
|
* an inventory without a valid recorded Surface is refused.
|
|
2372
2377
|
* Everything downstream — the missing-path refusal, the
|
|
2373
2378
|
* storage collision guard, the sort, the digests, and the root inventory — reads
|
|
@@ -2382,10 +2387,10 @@ export declare class Materializer implements MaterializerInterface {
|
|
|
2382
2387
|
* ```ts
|
|
2383
2388
|
* import { stageHost } from '@orkestrel/scaffold/server'
|
|
2384
2389
|
*
|
|
2385
|
-
* stageHost(process.cwd(), 'dist/host') // one
|
|
2390
|
+
* stageHost(process.cwd(), 'dist/host') // one HostManifestEntry per file staged
|
|
2386
2391
|
* ```
|
|
2387
2392
|
*/
|
|
2388
|
-
export declare function stageHost(checkout: string, host: string, options?: HostStageOptions): readonly
|
|
2393
|
+
export declare function stageHost(checkout: string, host: string, options?: HostStageOptions): readonly HostManifestEntry[];
|
|
2389
2394
|
|
|
2390
2395
|
/**
|
|
2391
2396
|
* Stages the committed inventory of the files a vendored host carries.
|