@compforge/harness-common 0.3.5 → 0.3.7

package/README.md

@@ -38,6 +38,8 @@ import type { Service } from "@compforge/harness-common";
 
 const service: Service = {
   name: "chat",
+  concepts: "A Conversation contains Messages; each Message may have multiple execution Attempts.",
+  workflows: "Accept message → execute attempt → persist response. Acceptance does not imply completion.",
   component: {
     name: "api",
     repository: { forge: { name: "github" }, path: "example/app" },
@@ -50,6 +52,12 @@ const service: Service = {
 };
 ```
 
+Service and Product accept an optional description for a short introduction, plus optional
+concepts and workflows Markdown text. Concepts explain
+objects, relationships and constraints; workflows explain collaboration from trigger to completion.
+Service knowledge covers its own responsibilities, while Product knowledge covers end-to-end flows.
+Consumers maintain this offline metadata; it does not change identity, execute a workflow or prove runtime state.
+
 Environment carries identity and an optional local/SSH Host declaration, not a connection. HostEnvironment
 describes a target running directly on that host. Concrete accessible environments, such as toolbox's
 KubernetesEnvironment, additionally implement ClientProvider. A Host declaration alone does not add SSH

package/dist/product.d.ts

@@ -1,6 +1,14 @@
 /** A business identity independent of repository layout.
  * Consumers own its many-to-many associations with Components.
+ * @spec Description, concepts and workflows describe product-wide knowledge, not identity or runtime evidence.
+ * @see {@link component://docs/kernel.md}
  */
 export interface Product {
     readonly name: string;
+    /** Optional short introduction; not part of Product identity. */
+    readonly description?: string;
+    /** Optional Markdown: domain objects, relationships and constraints. */
+    readonly concepts?: string;
+    /** Optional Markdown: collaboration from trigger to completion; not an executable plan. */
+    readonly workflows?: string;
 }

package/dist/service.d.ts

@@ -5,10 +5,16 @@ import type { Workload } from "./workload.js";
  * One Component's logical runtime presence in an Environment.
  * @spec Identity is scoped by name, Component and Environment, not platform resource names.
  * @rule Workload mappings may change without changing Service identity; declarations prove no live instances.
+ * @spec Description, concepts and workflows are discovery metadata, not identity or runtime evidence.
+ * @see {@link component://docs/kernel.md}
  * Consumers extend this model with their own capabilities and execution policy.
  */
 export interface Service<E extends Environment = Environment> {
     readonly name: string;
+    /** Optional Markdown: domain objects, relationships and constraints. */
+    readonly concepts?: string;
+    /** Optional Markdown: collaboration from trigger to completion; not an executable plan. */
+    readonly workflows?: string;
     /** Human-readable discovery metadata; not part of Service identity. */
     readonly description?: string;
     readonly component: Component;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compforge/harness-common",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "Execution-neutral client lifecycle and datasource contracts for harnesses",
   "type": "module",
   "scripts": {