@orkestrel/scaffold 0.0.7 → 0.0.8

package/dist/src/server/index.d.cts

@@ -139,16 +139,16 @@ export declare const DEFAULT_SYNC_TIMEOUT = 10000;
  * and the name satisfies `isWorkspaceName`; every other name is a coded
  * `TARGET` failure. `src` is derived from `src/<environment>/` and `app` from
  * `app/<environment>/`; a target with no environment on either axis is also a coded
- * `TARGET` failure. `dependencies` /
+ * `TARGET` failure. The `bin`, `integration`, and `service` facts probe physical
+ * directories at `src/bin`, `tests/integration`, and `tests/service`, respectively,
+ * never the workspace name. `dependencies` /
  * `peers` are the `@orkestrel/`-prefixed entries of `manifest.dependencies` /
  * `manifest.peerDependencies` (a peer flagged `peerDependenciesMeta[name]
  * .optional === true` carries `optional: true`). `extras` is EVERY entry of
  * `manifest.devDependencies` (not only `@orkestrel/`-prefixed ones — an
- * external extra like `zod` must round-trip too), EXCLUDING the generated
- * devDependency baseline (`devDependenciesFor([])`'s keys, which already
- * cover `@orkestrel/guide` and `@orkestrel/scaffold`) every scaffolded
- * package already carries, never a package-specific extra. A devDependency
- * ALSO present in
+ * external extra like `zod` must round-trip too), EXCLUDING the complete
+ * generated dependency set `devDependenciesFor` emits for the reconstructed
+ * blueprint's actual environments and structural axes. A devDependency ALSO present in
  * `manifest.peerDependencies` or `manifest.dependencies` (e.g. a peer
  * dev-installed for local testing) is likewise excluded from `extras` — it
  * already appears as a `peer`/`dependency` above, and double-counting it as
@@ -159,6 +159,8 @@ export declare const DEFAULT_SYNC_TIMEOUT = 10000;
  * @throws `ScaffoldError('TARGET', …)` when `target`'s manifest is unreadable
  *   (via `readManifest`), is not valid JSON, its name is unsafe for its
  *   publication mode, or `target` carries no source or application environment.
+ * @throws `ScaffoldError('TARGET', …)` when `tests/service` exists without the
+ *   physical companion files `tests/setupService.ts` and `scripts/service.sh`.
  *
  * @example
  * ```ts
@@ -364,6 +366,14 @@ export declare function isPortablePath(value: unknown): value is string;
  */
 export declare function isRealDirectory(path: string): boolean;
 
+/**
+ * Whether a path is an existing physical file rather than a directory or link.
+ *
+ * @param path - The filesystem path to inspect without following links.
+ * @returns `true` only for a successful `lstat` reporting a single-link file.
+ */
+export declare function isRealFile(path: string): boolean;
+
 /** Determine whether a target-relative path addresses preserved repository metadata. */
 export declare function isReservedTargetPath(value: string): boolean;
 

package/dist/src/server/index.d.ts

@@ -139,16 +139,16 @@ export declare const DEFAULT_SYNC_TIMEOUT = 10000;
  * and the name satisfies `isWorkspaceName`; every other name is a coded
  * `TARGET` failure. `src` is derived from `src/<environment>/` and `app` from
  * `app/<environment>/`; a target with no environment on either axis is also a coded
- * `TARGET` failure. `dependencies` /
+ * `TARGET` failure. The `bin`, `integration`, and `service` facts probe physical
+ * directories at `src/bin`, `tests/integration`, and `tests/service`, respectively,
+ * never the workspace name. `dependencies` /
  * `peers` are the `@orkestrel/`-prefixed entries of `manifest.dependencies` /
  * `manifest.peerDependencies` (a peer flagged `peerDependenciesMeta[name]
  * .optional === true` carries `optional: true`). `extras` is EVERY entry of
  * `manifest.devDependencies` (not only `@orkestrel/`-prefixed ones — an
- * external extra like `zod` must round-trip too), EXCLUDING the generated
- * devDependency baseline (`devDependenciesFor([])`'s keys, which already
- * cover `@orkestrel/guide` and `@orkestrel/scaffold`) every scaffolded
- * package already carries, never a package-specific extra. A devDependency
- * ALSO present in
+ * external extra like `zod` must round-trip too), EXCLUDING the complete
+ * generated dependency set `devDependenciesFor` emits for the reconstructed
+ * blueprint's actual environments and structural axes. A devDependency ALSO present in
  * `manifest.peerDependencies` or `manifest.dependencies` (e.g. a peer
  * dev-installed for local testing) is likewise excluded from `extras` — it
  * already appears as a `peer`/`dependency` above, and double-counting it as
@@ -159,6 +159,8 @@ export declare const DEFAULT_SYNC_TIMEOUT = 10000;
  * @throws `ScaffoldError('TARGET', …)` when `target`'s manifest is unreadable
  *   (via `readManifest`), is not valid JSON, its name is unsafe for its
  *   publication mode, or `target` carries no source or application environment.
+ * @throws `ScaffoldError('TARGET', …)` when `tests/service` exists without the
+ *   physical companion files `tests/setupService.ts` and `scripts/service.sh`.
  *
  * @example
  * ```ts
@@ -364,6 +366,14 @@ export declare function isPortablePath(value: unknown): value is string;
  */
 export declare function isRealDirectory(path: string): boolean;
 
+/**
+ * Whether a path is an existing physical file rather than a directory or link.
+ *
+ * @param path - The filesystem path to inspect without following links.
+ * @returns `true` only for a successful `lstat` reporting a single-link file.
+ */
+export declare function isRealFile(path: string): boolean;
+
 /** Determine whether a target-relative path addresses preserved repository metadata. */
 export declare function isReservedTargetPath(value: string): boolean;
 

package/dist/src/server/index.js

@@ -1,4 +1,4 @@
-import { CONTROL_CHARACTER_PATTERN, DEFAULT_ENGINES, DEFAULT_VERSION, DEPENDENCY_NAME_PATTERN, ENVIRONMENTS, HEX_PATTERN, HOST_PATHS, INVALID_PATH_CHARACTER_PATTERN, MAX_ARTIFACT_BYTES, MAX_ARTIFACT_HEX_LENGTH, MAX_COLLECTION_ITEMS, MAX_MANIFEST_BYTES, MAX_PATH_LENGTH, MAX_TOTAL_ARTIFACT_BYTES, SYNC_BASELINE_PATTERN, ScaffoldError, VERSION_PATTERN, blueprint, bytesToHex, contentByteLength, devDependenciesFor, diffPlan, findFileConflict, findPathConflict, hasOnlyDataProperties, hasValidAuditBytes, hasValidSnapshotBytes, isDenseDataArray, isDependency, isEmitterErrorHandler, isPlan, isSyncReport, isWorkspaceName, manifestToDependencies, manifestToName, ownDataValue, parsePlan, parseSyncReport, rangeToFreshness, snapshotPlan, validateDependencyArray, validatePlan } from "../core/index.js";
+import { CONTROL_CHARACTER_PATTERN, DEFAULT_ENGINES, DEFAULT_VERSION, DEPENDENCY_NAME_PATTERN, ENVIRONMENTS, HEX_PATTERN, HOST_PATHS, INVALID_PATH_CHARACTER_PATTERN, MAX_ARTIFACT_BYTES, MAX_ARTIFACT_HEX_LENGTH, MAX_COLLECTION_ITEMS, MAX_MANIFEST_BYTES, MAX_PATH_LENGTH, MAX_TOTAL_ARTIFACT_BYTES, SERVICE_SCRIPT_PATH, SYNC_BASELINE_PATTERN, ScaffoldError, VERSION_PATTERN, blueprint, bytesToHex, contentByteLength, devDependenciesFor, diffPlan, findFileConflict, findPathConflict, hasOnlyDataProperties, hasValidAuditBytes, hasValidSnapshotBytes, isDenseDataArray, isDependency, isEmitterErrorHandler, isPlan, isSyncReport, isWorkspaceName, manifestToDependencies, manifestToName, ownDataValue, parsePlan, parseSyncReport, rangeToFreshness, snapshotPlan, validateDependencyArray, validatePlan } from "../core/index.js";
 import { attempt, booleanShape, createContract, integerShape, isError, isFunction, isRecord, isString, objectShape, optionalShape, parseJSON, parseJSONAs, stringShape } from "@orkestrel/contract";
 import { createHash, randomUUID } from "node:crypto";
 import { chmodSync, closeSync, constants, copyFileSync, existsSync, fstatSync, linkSync, lstatSync, mkdirSync, openSync, opendirSync, readSync, realpathSync, renameSync, rmSync, rmdirSync, writeFileSync } from "node:fs";
@@ -845,6 +845,16 @@ function isRealDirectory(path) {
 	return status.success && status.value;
 }
 /**
+* Whether a path is an existing physical file rather than a directory or link.
+*
+* @param path - The filesystem path to inspect without following links.
+* @returns `true` only for a successful `lstat` reporting a single-link file.
+*/
+function isRealFile(path) {
+	const status = attempt(() => lstatSync(path));
+	return status.success && status.value.isFile() && !status.value.isSymbolicLink() && status.value.nlink === 1;
+}
+/**
 * Compute a bounded-memory SHA-256 digest for one file.
 *
 * @param path - The file to read.
@@ -1733,16 +1743,16 @@ function selectOrkestrelEntries(value) {
 * and the name satisfies `isWorkspaceName`; every other name is a coded
 * `TARGET` failure. `src` is derived from `src/<environment>/` and `app` from
 * `app/<environment>/`; a target with no environment on either axis is also a coded
-* `TARGET` failure. `dependencies` /
+* `TARGET` failure. The `bin`, `integration`, and `service` facts probe physical
+* directories at `src/bin`, `tests/integration`, and `tests/service`, respectively,
+* never the workspace name. `dependencies` /
 * `peers` are the `@orkestrel/`-prefixed entries of `manifest.dependencies` /
 * `manifest.peerDependencies` (a peer flagged `peerDependenciesMeta[name]
 * .optional === true` carries `optional: true`). `extras` is EVERY entry of
 * `manifest.devDependencies` (not only `@orkestrel/`-prefixed ones — an
-* external extra like `zod` must round-trip too), EXCLUDING the generated
-* devDependency baseline (`devDependenciesFor([])`'s keys, which already
-* cover `@orkestrel/guide` and `@orkestrel/scaffold`) every scaffolded
-* package already carries, never a package-specific extra. A devDependency
-* ALSO present in
+* external extra like `zod` must round-trip too), EXCLUDING the complete
+* generated dependency set `devDependenciesFor` emits for the reconstructed
+* blueprint's actual environments and structural axes. A devDependency ALSO present in
 * `manifest.peerDependencies` or `manifest.dependencies` (e.g. a peer
 * dev-installed for local testing) is likewise excluded from `extras` — it
 * already appears as a `peer`/`dependency` above, and double-counting it as
@@ -1753,6 +1763,8 @@ function selectOrkestrelEntries(value) {
 * @throws `ScaffoldError('TARGET', …)` when `target`'s manifest is unreadable
 *   (via `readManifest`), is not valid JSON, its name is unsafe for its
 *   publication mode, or `target` carries no source or application environment.
+* @throws `ScaffoldError('TARGET', …)` when `tests/service` exists without the
+*   physical companion files `tests/setupService.ts` and `scripts/service.sh`.
 *
 * @example
 * ```ts
@@ -1762,11 +1774,6 @@ function selectOrkestrelEntries(value) {
 * ```
 */
 function deriveBlueprint(target) {
-	const baselineExtras = /* @__PURE__ */ new Set([
-		...Object.keys(devDependenciesFor([])),
-		"@orkestrel/guide",
-		"@orkestrel/scaffold"
-	]);
 	const parsed = parseJSON(readManifest(target));
 	if (!isRecord(parsed)) throw new ScaffoldError("TARGET", `Manifest at ${target} is not a valid JSON object`, { target });
 	const src = ENVIRONMENTS.filter((environment) => isRealDirectory(join(target, "src", environment)));
@@ -1793,7 +1800,18 @@ function deriveBlueprint(target) {
 	const version = typeof rawVersion === "string" ? rawVersion : DEFAULT_VERSION;
 	const rawNode = ownDataValue(ownDataValue(parsed, "engines"), "node");
 	const engines = typeof rawNode === "string" ? rawNode : DEFAULT_ENGINES;
-	const engine = isRealDirectory(join(target, "src", "bin"));
+	const bin = isRealDirectory(join(target, "src", "bin"));
+	const integration = isRealDirectory(join(target, "tests", "integration"));
+	const service = isRealDirectory(join(target, "tests", "service"));
+	if (service) {
+		const missing = [];
+		if (!isRealFile(join(target, "tests", "setupService.ts"))) missing.push("tests/setupService.ts");
+		if (!isRealFile(join(target, SERVICE_SCRIPT_PATH))) missing.push(SERVICE_SCRIPT_PATH);
+		if (missing.length > 0) throw new ScaffoldError("TARGET", `Service tests under ${target} are missing ${missing.join(" and ")}`, {
+			target,
+			missing
+		});
+	}
 	const rawDependencies = ownDataValue(parsed, "dependencies");
 	const rawPeerDependencies = ownDataValue(parsed, "peerDependencies");
 	const dependencies = selectOrkestrelEntries(rawDependencies).map(([depName, range]) => ({
@@ -1814,9 +1832,19 @@ function deriveBlueprint(target) {
 		};
 	});
 	const peerAndDependencyNames = /* @__PURE__ */ new Set([...selectOrkestrelEntries(rawPeerDependencies).map(([depName]) => depName), ...selectOrkestrelEntries(rawDependencies).map(([depName]) => depName)]);
+	const generatedDevDependencies = new Set(Object.keys(devDependenciesFor(blueprint(name, {
+		src,
+		app,
+		dependencies,
+		peers,
+		extras: [],
+		bin,
+		integration,
+		service
+	}))));
 	const rawDevDependencies = ownDataValue(parsed, "devDependencies");
 	const devDependencies = isRecord(rawDevDependencies) ? rawDevDependencies : {};
-	const extras = Object.entries(devDependencies).filter((entry) => typeof entry[1] === "string").filter(([depName]) => !baselineExtras.has(depName) && !peerAndDependencyNames.has(depName)).map(([depName, range]) => ({
+	const extras = Object.entries(devDependencies).filter((entry) => typeof entry[1] === "string").filter(([depName]) => !generatedDevDependencies.has(depName) && !peerAndDependencyNames.has(depName)).map(([depName, range]) => ({
 		name: depName,
 		range
 	}));
@@ -1831,7 +1859,9 @@ function deriveBlueprint(target) {
 		version,
 		engines,
 		overrides: [],
-		engine
+		bin,
+		integration,
+		service
 	});
 }
 /**
@@ -4033,6 +4063,6 @@ function createSync(options) {
 	return new Sync(options);
 }
 //#endregion
-export { DEFAULT_SYNC_BUDGET, DEFAULT_SYNC_CONCURRENCY, DEFAULT_SYNC_ITEMS, DEFAULT_SYNC_LIMIT, DEFAULT_SYNC_TIMEOUT, HOST_MANIFEST_PATH, MAX_CATALOG_DESCRIPTION_LENGTH, MAX_FILESYSTEM_DEPTH, MAX_GUIDE_BYTES, MAX_HOST_DEPTH, MAX_HOST_ENTRIES, MAX_PATH_SEGMENT_BYTES, MAX_SYNC_BASE_LENGTH, MAX_SYNC_BRANCH_LENGTH, MAX_SYNC_BUDGET, MAX_SYNC_CONCURRENCY, MAX_SYNC_ITEMS, MAX_SYNC_LIMIT, MAX_SYNC_RETRIES, MAX_SYNC_TIMEOUT, Materializer, PRUNE_DIRECTORIES, RESERVED_PATH_SEGMENT_PATTERN, RESERVED_TARGET_PATH_PATTERN, SENSITIVE_HOST_PATH_PATTERN, SYNC_BRANCH_PATTERN, Sync, WRITE_DIGEST_PATTERN, WriteTransaction, catalogPackages, commitWriteTransaction, consumeCatalogAllowance, createMaterializer, createSync, createWriteDirectory, deriveBlueprint, digestFile, digestHex, digestText, discardWriteTransaction, discoverPackages, guideStub, guideToDescription, hostRoot, hydratePlan, isCatalogAllowance, isCatalogDescription, isDependencyData, isFilesystemPath, isHostManifest, isManifestEntry, isMaterializerEventHooks, isMissingPathError, isPortablePath, isRealDirectory, isReservedTargetPath, isSensitiveHostPath, isSyncEventHooks, isTerminalText, isVacant, isWritePrecondition, listDirectories, listFiles, locateHostSource, materializerOptionsContract, materializerOptionsShape, packageShortName, parseFilesystemPaths, parseMaterializerOptions, parsePortablePaths, parseSyncBase, parseSyncBranch, parseSyncCurrent, parseSyncDependencies, parseSyncOptions, parseWritePreconditions, pruneTargets, readFileHex, readFileText, readGuideReferences, readHostManifest, readManifest, readTarget, remapArtifactPath, replaceDirectory, resolveContainedPath, resolveGuideWrites, resolvePhysicalPath, resolveRealPath, restoreFiles, selectOrkestrelEntries, stageHost, storagePath, syncGuideOptionsShape, syncOptionsContract, syncOptionsShape, syncRegistryOptionsShape, syncReportOf, validateWriteAnchor, validateWriteDirectories, validateWriteTarget, vendoredPruneSet };
+export { DEFAULT_SYNC_BUDGET, DEFAULT_SYNC_CONCURRENCY, DEFAULT_SYNC_ITEMS, DEFAULT_SYNC_LIMIT, DEFAULT_SYNC_TIMEOUT, HOST_MANIFEST_PATH, MAX_CATALOG_DESCRIPTION_LENGTH, MAX_FILESYSTEM_DEPTH, MAX_GUIDE_BYTES, MAX_HOST_DEPTH, MAX_HOST_ENTRIES, MAX_PATH_SEGMENT_BYTES, MAX_SYNC_BASE_LENGTH, MAX_SYNC_BRANCH_LENGTH, MAX_SYNC_BUDGET, MAX_SYNC_CONCURRENCY, MAX_SYNC_ITEMS, MAX_SYNC_LIMIT, MAX_SYNC_RETRIES, MAX_SYNC_TIMEOUT, Materializer, PRUNE_DIRECTORIES, RESERVED_PATH_SEGMENT_PATTERN, RESERVED_TARGET_PATH_PATTERN, SENSITIVE_HOST_PATH_PATTERN, SYNC_BRANCH_PATTERN, Sync, WRITE_DIGEST_PATTERN, WriteTransaction, catalogPackages, commitWriteTransaction, consumeCatalogAllowance, createMaterializer, createSync, createWriteDirectory, deriveBlueprint, digestFile, digestHex, digestText, discardWriteTransaction, discoverPackages, guideStub, guideToDescription, hostRoot, hydratePlan, isCatalogAllowance, isCatalogDescription, isDependencyData, isFilesystemPath, isHostManifest, isManifestEntry, isMaterializerEventHooks, isMissingPathError, isPortablePath, isRealDirectory, isRealFile, isReservedTargetPath, isSensitiveHostPath, isSyncEventHooks, isTerminalText, isVacant, isWritePrecondition, listDirectories, listFiles, locateHostSource, materializerOptionsContract, materializerOptionsShape, packageShortName, parseFilesystemPaths, parseMaterializerOptions, parsePortablePaths, parseSyncBase, parseSyncBranch, parseSyncCurrent, parseSyncDependencies, parseSyncOptions, parseWritePreconditions, pruneTargets, readFileHex, readFileText, readGuideReferences, readHostManifest, readManifest, readTarget, remapArtifactPath, replaceDirectory, resolveContainedPath, resolveGuideWrites, resolvePhysicalPath, resolveRealPath, restoreFiles, selectOrkestrelEntries, stageHost, storagePath, syncGuideOptionsShape, syncOptionsContract, syncOptionsShape, syncRegistryOptionsShape, syncReportOf, validateWriteAnchor, validateWriteDirectories, validateWriteTarget, vendoredPruneSet };
 
 //# sourceMappingURL=index.js.map