@okfit/engine 0.2.0 → 0.3.0

package/config/anchor.js

@@ -15,7 +15,7 @@ const anchorForExplicit = (configPath, path) => {
 /**
 * K-12's project root, as amended by K-58 and C1-2, in order:
 *
-* 1. `pathArg`, if given. `Argument.path` has already resolved it absolute.
+* 1. `pathArg`, if given. `Argument.Path` has already resolved it absolute.
 * 2. otherwise, if `--config` was given: `anchorForExplicit` applied to that
 *    path.
 * 3. otherwise, if a config was discovered by the `"project"` resolver

package/index.d.ts

@@ -32,7 +32,7 @@ interface DiscoveredConfig {
 /**
  * K-12's project root, as amended by K-58 and C1-2, in order:
  *
- * 1. `pathArg`, if given. `Argument.path` has already resolved it absolute.
+ * 1. `pathArg`, if given. `Argument.Path` has already resolved it absolute.
  * 2. otherwise, if `--config` was given: `anchorForExplicit` applied to that
  *    path.
  * 3. otherwise, if a config was discovered by the `"project"` resolver
@@ -418,11 +418,55 @@ export declare const files: (options: ScaffoldOptions) => Effect.Effect<Readonly
 export declare const OkfitPlatform: Layer.Layer<AppDirs | Xdg | NodeServices.NodeServices, import("@effected/xdg").XdgEnvError, never>;
 //#endregion
 //#region src/render/context.d.ts
-/** One `types[]` entry (M-15). @public */
+/** One enumerated value of a `fields[]` entry. @public */
+export declare const ContextFieldValue: Schema.Struct<{
+  readonly name: Schema.String;
+  readonly description: Schema.String;
+}>;
+/** @public */
+export type ContextFieldValue = typeof ContextFieldValue.Type;
+/**
+ * One `types[].fields[]` entry: a `[types.<Name>.fields.<key>]` declaration
+ * flattened for a consumer. `values` keeps the declaration's own order (it
+ * is a vocabulary, and the config author chose the order); `kind` is
+ * `"path"` or `null`.
+ *
+ * @public
+ */
+export declare const ContextField: Schema.Struct<{
+  readonly name: Schema.String;
+  readonly description: Schema.String;
+  readonly kind: Schema.NullOr<Schema.Literal<"path">>;
+  readonly values: Schema.NullOr<Schema.$Array<Schema.Struct<{
+    readonly name: Schema.String;
+    readonly description: Schema.String;
+  }>>>;
+}>;
+/** @public */
+export type ContextField = typeof ContextField.Type;
+/**
+ * One `types[]` entry (M-15). `required`, `require_verified` and `fields`
+ * carry the constraints `validate` enforces (issue #33): without them an
+ * agent learns that `Interface` exists but not that it requires `kind`, nor
+ * which values `kind` accepts, until a lint error says so.
+ *
+ * @public
+ */
 export declare const ContextType: Schema.Struct<{
   readonly name: Schema.String;
   readonly description: Schema.NullOr<Schema.String>;
   readonly guidance: Schema.NullOr<Schema.String>;
+  readonly required: Schema.NullOr<Schema.$Array<Schema.String>>;
+  readonly require_verified: Schema.NullOr<Schema.Boolean>;
+  readonly fields: Schema.$Array<Schema.Struct<{
+    readonly name: Schema.String;
+    readonly description: Schema.String;
+    readonly kind: Schema.NullOr<Schema.Literal<"path">>;
+    readonly values: Schema.NullOr<Schema.$Array<Schema.Struct<{
+      readonly name: Schema.String;
+      readonly description: Schema.String;
+    }>>>;
+  }>>;
 }>;
 /** @public */
 export type ContextType = typeof ContextType.Type;
@@ -474,6 +518,17 @@ export declare const ContextEnvelope: Schema.Struct<{
     readonly name: Schema.String;
     readonly description: Schema.NullOr<Schema.String>;
     readonly guidance: Schema.NullOr<Schema.String>;
+    readonly required: Schema.NullOr<Schema.$Array<Schema.String>>;
+    readonly require_verified: Schema.NullOr<Schema.Boolean>;
+    readonly fields: Schema.$Array<Schema.Struct<{
+      readonly name: Schema.String;
+      readonly description: Schema.String;
+      readonly kind: Schema.NullOr<Schema.Literal<"path">>;
+      readonly values: Schema.NullOr<Schema.$Array<Schema.Struct<{
+        readonly name: Schema.String;
+        readonly description: Schema.String;
+      }>>>;
+    }>>;
   }>>;
   readonly tags: Schema.$Array<Schema.Struct<{
     readonly name: Schema.String;
@@ -869,8 +924,8 @@ interface RunOptions {
    * default severity. Tier 1 (the pure, in-memory body-digest comparison)
    * still runs regardless — that is exactly the signal edit time wants,
    * at the cost of one sha256 over text already in memory. Defaults to
-   * `false`; `run` still gates the whole lint call on `severity ===
-   * "off"`, but no longer on this flag.
+   * `false`; `run` still gates the whole lint call on
+   * `severity === "off"`, but no longer on this flag.
    */
   readonly skipProvenance?: boolean;
 }

package/index.js

@@ -5,7 +5,7 @@ import { DEFAULT_PROFILE_NAME, resolveProjectConfig } from "./config/resolve.js"
 import { runContext } from "./context/run.js";
 import { CONFIG_RELATIVE_PATH, SCHEMA_DIRECTIVE, configValue, files, targetPaths } from "./init/scaffold.js";
 import { OkfitPlatform } from "./platform.js";
-import { ContextEnvelope, ContextTag, ContextType, contextEnvelope } from "./render/context.js";
+import { ContextEnvelope, ContextField, ContextFieldValue, ContextTag, ContextType, contextEnvelope } from "./render/context.js";
 import { forDiagnostics, tally } from "./render/exit.js";
 import { collect, sort } from "./render/sort.js";
 import { JsonDiagnostic, JsonEnvelope, JsonErrorEnvelope, JsonSummary, json, jsonError } from "./render/json.js";
@@ -15,4 +15,4 @@ import { VerifyEnvelope, verifyEnvelope } from "./render/verify.js";
 import { Now, run } from "./validate/run.js";
 import { runVerify } from "./verify/run.js";
 
-export { CONFIG_RELATIVE_PATH, ConfigMalformedError, ConfigPathNotFoundError, ContextEnvelope, ContextTag, ContextType, DEFAULT_PROFILE_NAME, InitOverwriteError, JsonDiagnostic, JsonEnvelope, JsonErrorEnvelope, JsonSummary, Now, OkfitPlatform, SCHEMA_DIRECTIVE, SkipReason, SyncEnvelope, SyncModeEnvelope, VerifyConceptNotFoundError, VerifyEnvelope, VerifyUnsupportedFrontmatterError, buildConfigLayer, collect, configValue, contextEnvelope, files, forDiagnostics, json, jsonError, provideConfig, resolveBundleRoot, resolveProjectConfig, resolveProjectRoot, run, runContext, runSync, runVerify, sort, syncEnvelope, tally, targetPaths, verifyEnvelope };
+export { CONFIG_RELATIVE_PATH, ConfigMalformedError, ConfigPathNotFoundError, ContextEnvelope, ContextField, ContextFieldValue, ContextTag, ContextType, DEFAULT_PROFILE_NAME, InitOverwriteError, JsonDiagnostic, JsonEnvelope, JsonErrorEnvelope, JsonSummary, Now, OkfitPlatform, SCHEMA_DIRECTIVE, SkipReason, SyncEnvelope, SyncModeEnvelope, VerifyConceptNotFoundError, VerifyEnvelope, VerifyUnsupportedFrontmatterError, buildConfigLayer, collect, configValue, contextEnvelope, files, forDiagnostics, json, jsonError, provideConfig, resolveBundleRoot, resolveProjectConfig, resolveProjectRoot, run, runContext, runSync, runVerify, sort, syncEnvelope, tally, targetPaths, verifyEnvelope };

package/init/scaffold.js

@@ -145,10 +145,10 @@ const files = (options) => Effect.gen(function* () {
 		okfVersion: OKF_SPEC_VERSION,
 		subdirectories
 	});
-	const logText = Derive.renderLogEntry({
+	const logText = Derive.renderLog([{
 		date: today,
 		items: [`Initialized the bundle with the ${profileName} profile`]
-	});
+	}]);
 	const directoryFiles = layout.directories.map((directory) => ({
 		path: `${bundleRoot}/${directory.directory}/${layout.root.index}`,
 		contents: `# ${capitalize(directory.directory)}\n`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@okfit/engine",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"private": false,
 	"description": "The okfit engine: platform layer, config discovery, and the validate, verify, sync, init and context programs shared by the okfit CLI and MCP server.",
 	"keywords": [
@@ -34,21 +34,21 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
-		"@effect/platform-node": "4.0.0-rc.112",
-		"@effected/app": "^0.15.0",
-		"@effected/config-file": "^0.7.0",
-		"@effected/git": "^0.12.0",
-		"@effected/glob": "^0.5.0",
-		"@effected/jsonc": "^0.9.0",
-		"@effected/markdown": "^0.9.1",
-		"@effected/store": "^0.7.0",
-		"@effected/toml": "^0.6.0",
-		"@effected/walker": "^0.7.0",
-		"@effected/xdg": "^0.4.1",
-		"@effected/yaml": "^0.14.0",
-		"@okfit/core": "0.3.0",
-		"@okfit/profiles": "0.3.0",
-		"effect": "4.0.0-rc.112"
+		"@effect/platform-node": "4.0.0-rc.115",
+		"@effected/app": "^0.16.1",
+		"@effected/config-file": "^0.9.0",
+		"@effected/git": "^0.15.1",
+		"@effected/glob": "^0.6.0",
+		"@effected/jsonc": "^0.11.0",
+		"@effected/markdown": "^0.10.0",
+		"@effected/store": "^0.8.0",
+		"@effected/toml": "^0.7.0",
+		"@effected/walker": "^0.9.0",
+		"@effected/xdg": "^0.5.1",
+		"@effected/yaml": "^0.15.1",
+		"@okfit/core": "0.4.0",
+		"@okfit/profiles": "0.4.0",
+		"effect": "4.0.0-rc.115"
 	},
 	"engines": {
 		"node": ">=24.11.0"

package/render/context.js

@@ -1,11 +1,40 @@
 import { Schema } from "effect";
 
 //#region src/render/context.ts
-/** One `types[]` entry (M-15). @public */
+/** One enumerated value of a `fields[]` entry. @public */
+const ContextFieldValue = Schema.Struct({
+	name: Schema.String,
+	description: Schema.String
+});
+/**
+* One `types[].fields[]` entry: a `[types.<Name>.fields.<key>]` declaration
+* flattened for a consumer. `values` keeps the declaration's own order (it
+* is a vocabulary, and the config author chose the order); `kind` is
+* `"path"` or `null`.
+*
+* @public
+*/
+const ContextField = Schema.Struct({
+	name: Schema.String,
+	description: Schema.String,
+	kind: Schema.NullOr(Schema.Literal("path")),
+	values: Schema.NullOr(Schema.Array(ContextFieldValue))
+});
+/**
+* One `types[]` entry (M-15). `required`, `require_verified` and `fields`
+* carry the constraints `validate` enforces (issue #33): without them an
+* agent learns that `Interface` exists but not that it requires `kind`, nor
+* which values `kind` accepts, until a lint error says so.
+*
+* @public
+*/
 const ContextType = Schema.Struct({
 	name: Schema.String,
 	description: Schema.NullOr(Schema.String),
-	guidance: Schema.NullOr(Schema.String)
+	guidance: Schema.NullOr(Schema.String),
+	required: Schema.NullOr(Schema.Array(Schema.String)),
+	require_verified: Schema.NullOr(Schema.Boolean),
+	fields: Schema.Array(ContextField)
 });
 /** One `tags[]` entry (M-15). @public */
 const ContextTag = Schema.Struct({
@@ -71,7 +100,18 @@ const contextEnvelope = (input) => ({
 	types: Object.entries(input.config.types ?? {}).map(([name, decl]) => ({
 		name,
 		description: decl.description ?? null,
-		guidance: decl.guidance ?? null
+		guidance: decl.guidance ?? null,
+		required: decl.required ?? null,
+		require_verified: decl.require_verified ?? null,
+		fields: Object.entries(decl.fields ?? {}).map(([fieldName, field]) => ({
+			name: fieldName,
+			description: field.description,
+			kind: field.kind ?? null,
+			values: field.values === void 0 ? null : Object.entries(field.values).map(([valueName, description]) => ({
+				name: valueName,
+				description
+			}))
+		})).toSorted((a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0)
 	})).toSorted((a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0),
 	tags: Object.entries(input.config.tags ?? {}).map(([name, decl]) => ({
 		name,
@@ -80,4 +120,4 @@ const contextEnvelope = (input) => ({
 });
 
 //#endregion
-export { ContextEnvelope, ContextTag, ContextType, contextEnvelope };
+export { ContextEnvelope, ContextField, ContextFieldValue, ContextTag, ContextType, contextEnvelope };

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.59.0"
+      "packageVersion": "7.59.1"
     }
   ]
 }