@deftai/directive-types 0.63.0 → 0.65.0

package/dist/constants.d.ts

@@ -0,0 +1,16 @@
+/** Canonical vBRIEF schema version exported for downstream contract imports. */
+export declare const VBRIEF_VERSION: "0.6";
+export type VBriefVersion = typeof VBRIEF_VERSION;
+/** npm package identity constant (stable across releases). */
+export declare const TYPES_PACKAGE: "@deftai/directive-types";
+/**
+ * vBRIEF#12 extension namespace — keys matching this pattern round-trip preserve-verbatim.
+ * Namespaced form: `x-<namespace>/<rest>` (e.g. `x-directive/trace`, `x-vbrief/context`).
+ * @see https://github.com/deftai/vBRIEF/issues/12
+ */
+export declare const EXTENSION_KEY_PATTERN: RegExp;
+/** Prefix for schema-conformant vBRIEF reference `type` values. */
+export declare const VBRIEF_REFERENCE_PREFIX: "x-vbrief/";
+/** JSON Schema `$id` for the v0.6 core document (published npm artifact). */
+export declare const VBRIEF_CORE_SCHEMA_ID: "https://vbrief.dev/schemas/vbrief-core-0.6.schema.json";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -0,0 +1,15 @@
+/** Canonical vBRIEF schema version exported for downstream contract imports. */
+export const VBRIEF_VERSION = "0.6";
+/** npm package identity constant (stable across releases). */
+export const TYPES_PACKAGE = "@deftai/directive-types";
+/**
+ * vBRIEF#12 extension namespace — keys matching this pattern round-trip preserve-verbatim.
+ * Namespaced form: `x-<namespace>/<rest>` (e.g. `x-directive/trace`, `x-vbrief/context`).
+ * @see https://github.com/deftai/vBRIEF/issues/12
+ */
+export const EXTENSION_KEY_PATTERN = /^x-[a-z0-9-]+\//;
+/** Prefix for schema-conformant vBRIEF reference `type` values. */
+export const VBRIEF_REFERENCE_PREFIX = "x-vbrief/";
+/** JSON Schema `$id` for the v0.6 core document (published npm artifact). */
+export const VBRIEF_CORE_SCHEMA_ID = "https://vbrief.dev/schemas/vbrief-core-0.6.schema.json";
+//# sourceMappingURL=constants.js.map

package/dist/document.d.ts

@@ -0,0 +1,66 @@
+import type { VBriefVersion } from "./constants.js";
+import type { PlanPolicy } from "./policy.js";
+import type { VBriefReference } from "./reference.js";
+import type { Status } from "./status.js";
+/** Top-level `vBRIEFInfo` block (v0.6). */
+export interface VBriefInfo {
+    readonly version: VBriefVersion;
+    readonly author?: string;
+    readonly description?: string;
+    readonly metadata?: Record<string, unknown>;
+    readonly created?: string;
+    readonly updated?: string;
+    readonly timezone?: string;
+    readonly [key: `x-${string}`]: unknown;
+}
+/** Nested plan item (`PlanItem` in vbrief-core.schema.json). */
+export interface PlanItem {
+    readonly id?: string;
+    readonly uid?: string;
+    readonly title: string;
+    readonly status: Status;
+    readonly narrative?: Readonly<Record<string, string>>;
+    readonly items?: readonly PlanItem[];
+    /** @deprecated Prefer `items`. Retained for schema compatibility. */
+    readonly subItems?: readonly PlanItem[];
+    readonly planRef?: string;
+    readonly tags?: readonly string[];
+    readonly metadata?: Record<string, unknown>;
+    readonly created?: string;
+    readonly updated?: string;
+    readonly completed?: string;
+    readonly [key: `x-${string}`]: unknown;
+}
+/** Authored architecture metadata on `plan.architecture`. */
+export interface PlanArchitecture {
+    readonly codeStructure?: Record<string, unknown>;
+    readonly [key: string]: unknown;
+}
+/** Root `plan` object for scope and project-definition vBRIEFs. */
+export interface Plan {
+    readonly id?: string;
+    readonly uid?: string;
+    readonly title: string;
+    readonly status: Status;
+    readonly items: readonly PlanItem[];
+    readonly policy?: PlanPolicy;
+    readonly architecture?: PlanArchitecture;
+    readonly narratives?: Readonly<Record<string, string>>;
+    readonly references?: readonly VBriefReference[];
+    readonly metadata?: Record<string, unknown>;
+    readonly planRef?: string;
+    readonly updated?: string;
+    readonly [key: `x-${string}`]: unknown;
+}
+/** Canonical v0.6 vBRIEF document shape. */
+export interface VBriefDocument {
+    readonly vBRIEFInfo: VBriefInfo;
+    readonly plan: Plan;
+    readonly [key: `x-${string}`]: unknown;
+}
+/** Identifying metadata for a deft engine package (retained from Wave-1). */
+export interface EngineInfo {
+    readonly name: string;
+    readonly version: string;
+}
+//# sourceMappingURL=document.d.ts.map

package/dist/document.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=document.js.map

package/dist/extension.d.ts

@@ -0,0 +1,10 @@
+/** Brand for vBRIEF#12 extension property keys (`x-*`). */
+export type ExtensionKey = `x-${string}`;
+/** Return true when `key` matches the vBRIEF#12 extension namespace. */
+export declare function isExtensionKey(key: string): key is ExtensionKey;
+/**
+ * Preserve-verbatim round-trip helper: copy extension keys without transformation.
+ * Core document keys are untouched; only `x-*` entries are collected.
+ */
+export declare function collectExtensionProperties(source: Record<string, unknown>): Record<ExtensionKey, unknown>;
+//# sourceMappingURL=extension.d.ts.map

package/dist/extension.js

@@ -0,0 +1,19 @@
+import { EXTENSION_KEY_PATTERN } from "./constants.js";
+/** Return true when `key` matches the vBRIEF#12 extension namespace. */
+export function isExtensionKey(key) {
+    return EXTENSION_KEY_PATTERN.test(key);
+}
+/**
+ * Preserve-verbatim round-trip helper: copy extension keys without transformation.
+ * Core document keys are untouched; only `x-*` entries are collected.
+ */
+export function collectExtensionProperties(source) {
+    const out = {};
+    for (const [key, value] of Object.entries(source)) {
+        if (isExtensionKey(key)) {
+            out[key] = value;
+        }
+    }
+    return out;
+}
+//# sourceMappingURL=extension.js.map

package/dist/gate.d.ts

@@ -0,0 +1,11 @@
+/** Three-state exit codes used by deterministic deft gates. */
+export type GateExitCode = 0 | 1 | 2;
+export declare const GATE_EXIT_OK: 0;
+export declare const GATE_EXIT_VIOLATION: 1;
+export declare const GATE_EXIT_CONFIG_ERROR: 2;
+/** Minimal gate result envelope for downstream tooling. */
+export interface GateResult {
+    readonly code: GateExitCode;
+    readonly message: string;
+}
+//# sourceMappingURL=gate.d.ts.map

package/dist/gate.js

@@ -0,0 +1,4 @@
+export const GATE_EXIT_OK = 0;
+export const GATE_EXIT_VIOLATION = 1;
+export const GATE_EXIT_CONFIG_ERROR = 2;
+//# sourceMappingURL=gate.js.map

package/dist/index.d.ts

@@ -1,15 +1,18 @@
 /**
- * `@deftai/directive-types` — shared types for the deft directive TypeScript engine.
+ * `@deftai/directive-types` — canonical vBRIEF/policy contract for downstream consumers (#1799).
  *
- * Wave-1 skeleton (#1717): carries only the identity constant and a
- * placeholder metadata shape needed to prove the cross-package dependency
- * graph (types → core → cli). The real ported domain types arrive with the
- * `verify:encoding` tracer bullet and parity harness (#1718).
+ * Supported public API: this package and its published JSON Schema subpaths.
+ * Behavior access remains via the `deft` / `directive` CLI — not `@deftai/directive-core`.
  */
-export declare const TYPES_PACKAGE: "@deftai/directive-types";
-/** Identifying metadata for a deft engine package. */
-export interface EngineInfo {
-    readonly name: string;
-    readonly version: string;
-}
+export { EXTENSION_KEY_PATTERN, TYPES_PACKAGE, VBRIEF_CORE_SCHEMA_ID, VBRIEF_REFERENCE_PREFIX, VBRIEF_VERSION, type VBriefVersion, } from "./constants.js";
+export type { EngineInfo, Plan, PlanArchitecture, PlanItem, VBriefDocument, VBriefInfo, } from "./document.js";
+export { collectExtensionProperties, type ExtensionKey, isExtensionKey, } from "./extension.js";
+export { GATE_EXIT_CONFIG_ERROR, GATE_EXIT_OK, GATE_EXIT_VIOLATION, type GateExitCode, type GateResult, } from "./gate.js";
+export { type PlanPolicy, type ProjectionProviderExpectation, type ProjectionProviderPolicy, REGISTERED_POLICY_FIELD_NAMES, type TriageScopeRule, } from "./policy.js";
+export { isVBriefReferenceType, KNOWN_REFERENCE_TYPES, type KnownReferenceType, type TrustLevel, type VBriefReference, } from "./reference.js";
+export { FOLDER_ALLOWED_STATUSES, type Status, VALID_STATUSES, } from "./status.js";
+/** Relative path to the published v0.6 core JSON Schema inside the npm package. */
+export declare const PUBLISHED_VBRIEF_CORE_SCHEMA_PATH: "schemas/vbrief-core-0.6.schema.json";
+/** npm subpath export for the v0.6 core JSON Schema artifact. */
+export declare const VBRIEF_CORE_SCHEMA_EXPORT: "./schemas/vbrief-core-0.6.schema.json";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,10 +1,17 @@
 /**
- * `@deftai/directive-types` — shared types for the deft directive TypeScript engine.
+ * `@deftai/directive-types` — canonical vBRIEF/policy contract for downstream consumers (#1799).
  *
- * Wave-1 skeleton (#1717): carries only the identity constant and a
- * placeholder metadata shape needed to prove the cross-package dependency
- * graph (types → core → cli). The real ported domain types arrive with the
- * `verify:encoding` tracer bullet and parity harness (#1718).
+ * Supported public API: this package and its published JSON Schema subpaths.
+ * Behavior access remains via the `deft` / `directive` CLI — not `@deftai/directive-core`.
  */
-export const TYPES_PACKAGE = "@deftai/directive-types";
+export { EXTENSION_KEY_PATTERN, TYPES_PACKAGE, VBRIEF_CORE_SCHEMA_ID, VBRIEF_REFERENCE_PREFIX, VBRIEF_VERSION, } from "./constants.js";
+export { collectExtensionProperties, isExtensionKey, } from "./extension.js";
+export { GATE_EXIT_CONFIG_ERROR, GATE_EXIT_OK, GATE_EXIT_VIOLATION, } from "./gate.js";
+export { REGISTERED_POLICY_FIELD_NAMES, } from "./policy.js";
+export { isVBriefReferenceType, KNOWN_REFERENCE_TYPES, } from "./reference.js";
+export { FOLDER_ALLOWED_STATUSES, VALID_STATUSES, } from "./status.js";
+/** Relative path to the published v0.6 core JSON Schema inside the npm package. */
+export const PUBLISHED_VBRIEF_CORE_SCHEMA_PATH = "schemas/vbrief-core-0.6.schema.json";
+/** npm subpath export for the v0.6 core JSON Schema artifact. */
+export const VBRIEF_CORE_SCHEMA_EXPORT = "./schemas/vbrief-core-0.6.schema.json";
 //# sourceMappingURL=index.js.map

package/dist/policy.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Typed `plan.policy` surface — known fields mirror directive engine inspectors (#746 / #1148).
+ * Additional keys use the vBRIEF#12 extension namespace (`x-*`).
+ */
+export interface TriageScopeRule {
+    readonly rule: string;
+    readonly [key: string]: unknown;
+}
+export interface PlanPolicy {
+    readonly allowDirectCommitsToMaster?: boolean;
+    readonly wipCap?: number;
+    readonly sessionRitualStalenessHours?: number | null;
+    readonly triageScope?: readonly TriageScopeRule[];
+    readonly triageScopeIgnores?: readonly unknown[];
+    readonly triageRankingLabels?: readonly string[];
+    readonly triageAutoClassify?: readonly unknown[];
+    readonly triageHoldMarkers?: readonly string[];
+    readonly swarmSubagentBackend?: string | null;
+    readonly projectionProviders?: Record<string, ProjectionProviderPolicy>;
+    readonly [key: `x-${string}`]: unknown;
+}
+export interface ProjectionProviderExpectation {
+    readonly provider?: string | Record<string, unknown>;
+    readonly name?: string;
+    readonly version?: string;
+    readonly providerVersion?: string;
+    readonly [key: `x-${string}`]: unknown;
+}
+export interface ProjectionProviderPolicy {
+    readonly artifactPath: string;
+    readonly expect?: ProjectionProviderExpectation;
+    readonly [key: `x-${string}`]: unknown;
+}
+/** Canonical dotted policy field names registered by the directive engine. */
+export declare const REGISTERED_POLICY_FIELD_NAMES: readonly ["plan.policy.allowDirectCommitsToMaster", "plan.policy.wipCap", "plan.policy.sessionRitualStalenessHours", "plan.policy.triageScope", "plan.policy.triageScopeIgnores", "plan.policy.triageRankingLabels", "plan.policy.triageAutoClassify", "plan.policy.triageHoldMarkers", "plan.policy.swarmSubagentBackend"];
+//# sourceMappingURL=policy.d.ts.map

package/dist/policy.js

@@ -0,0 +1,13 @@
+/** Canonical dotted policy field names registered by the directive engine. */
+export const REGISTERED_POLICY_FIELD_NAMES = [
+    "plan.policy.allowDirectCommitsToMaster",
+    "plan.policy.wipCap",
+    "plan.policy.sessionRitualStalenessHours",
+    "plan.policy.triageScope",
+    "plan.policy.triageScopeIgnores",
+    "plan.policy.triageRankingLabels",
+    "plan.policy.triageAutoClassify",
+    "plan.policy.triageHoldMarkers",
+    "plan.policy.swarmSubagentBackend",
+];
+//# sourceMappingURL=policy.js.map

package/dist/reference.d.ts

@@ -0,0 +1,19 @@
+import { VBRIEF_REFERENCE_PREFIX } from "./constants.js";
+/** Canonical reference types from conventions/references.md (non-exhaustive). */
+export declare const KNOWN_REFERENCE_TYPES: readonly ["x-vbrief/plan", "x-vbrief/github-issue", "x-vbrief/github-pr", "x-vbrief/jira-ticket", "x-vbrief/user-request", "x-vbrief/spec-section", "x-vbrief/context", "x-vbrief/research"];
+export type KnownReferenceType = (typeof KNOWN_REFERENCE_TYPES)[number];
+export type TrustLevel = "internal" | "external";
+/** Schema-conformant vBRIEF reference (`VBriefReference` in vbrief-core.schema.json). */
+export interface VBriefReference {
+    readonly uri: string;
+    readonly type: `${typeof VBRIEF_REFERENCE_PREFIX}${string}` | KnownReferenceType;
+    readonly title?: string;
+    readonly description?: string;
+    readonly tags?: readonly string[];
+    /** Canonical JSON key per vbrief.md TrustLevel (#480); not camelCase `trustLevel`. */
+    readonly TrustLevel?: TrustLevel;
+    readonly [key: `x-${string}`]: unknown;
+}
+/** Return true when `type` is a schema-conformant `x-vbrief/*` reference type. */
+export declare function isVBriefReferenceType(type: string): boolean;
+//# sourceMappingURL=reference.d.ts.map

package/dist/reference.js

@@ -0,0 +1,17 @@
+import { VBRIEF_REFERENCE_PREFIX } from "./constants.js";
+/** Canonical reference types from conventions/references.md (non-exhaustive). */
+export const KNOWN_REFERENCE_TYPES = [
+    "x-vbrief/plan",
+    "x-vbrief/github-issue",
+    "x-vbrief/github-pr",
+    "x-vbrief/jira-ticket",
+    "x-vbrief/user-request",
+    "x-vbrief/spec-section",
+    "x-vbrief/context",
+    "x-vbrief/research",
+];
+/** Return true when `type` is a schema-conformant `x-vbrief/*` reference type. */
+export function isVBriefReferenceType(type) {
+    return type.startsWith(VBRIEF_REFERENCE_PREFIX);
+}
+//# sourceMappingURL=reference.js.map

package/dist/status.d.ts

@@ -0,0 +1,6 @@
+/** v0.6 lifecycle status enum — mirrors `Status` in vbrief-core.schema.json. */
+export declare const VALID_STATUSES: readonly ["draft", "proposed", "approved", "pending", "running", "completed", "blocked", "failed", "cancelled"];
+export type Status = (typeof VALID_STATUSES)[number];
+/** Folder mapping used by lifecycle validators (informational for consumers). */
+export declare const FOLDER_ALLOWED_STATUSES: Readonly<Record<string, readonly Status[]>>;
+//# sourceMappingURL=status.d.ts.map

package/dist/status.js

@@ -0,0 +1,21 @@
+/** v0.6 lifecycle status enum — mirrors `Status` in vbrief-core.schema.json. */
+export const VALID_STATUSES = [
+    "draft",
+    "proposed",
+    "approved",
+    "pending",
+    "running",
+    "completed",
+    "blocked",
+    "failed",
+    "cancelled",
+];
+/** Folder mapping used by lifecycle validators (informational for consumers). */
+export const FOLDER_ALLOWED_STATUSES = {
+    proposed: ["draft", "proposed"],
+    pending: ["approved", "pending"],
+    active: ["running", "blocked"],
+    completed: ["completed", "failed"],
+    cancelled: ["cancelled"],
+};
+//# sourceMappingURL=status.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deftai/directive-types",
-  "version": "0.63.0",
+  "version": "0.65.0",
   "description": "Shared TypeScript types for the Directive framework engine.",
   "type": "module",
   "main": "./dist/index.js",
@@ -9,11 +9,13 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
-    }
+    },
+    "./schemas/vbrief-core-0.6.schema.json": "./schemas/vbrief-core-0.6.schema.json"
   },
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "schemas/**/*.json"
   ],
   "repository": {
     "type": "git",
@@ -25,6 +27,7 @@
     "provenance": true
   },
   "scripts": {
+    "prebuild": "node ./scripts/sync-schema.mjs",
     "build": "tsc -b"
   }
 }