@kindgi/flow 0.0.0-bootstrap.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Kindgi Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,263 @@
-# @kindgi/flow
+# `@kindgi/flow`
 
-A placeholder. Releases come from https://github.com/kindgi/kindgi-sdk.
+Flow type primitives, JSON-Schema validation, edge predicate evaluator, and scheduler-tick primitive for Kindgi. Consumed by the Kindgi runtime's kernel and any tool that authors, validates, or reasons about durable task flows.
+
+## Exports
+
+- **`defineFlow(spec)`** — authoring surface. Thin wrapper over `loadFlow` that mirrors `defineTool` / `defineCheck` / `defineAgent`; the recommended entry point for pack authors declaring flows in TypeScript. Returns `Result<Flow, FlowError>`.
+- **`loadFlow(input)`** — validates against `flow.schema.json` + runs cross-cutting checks (reserved and duplicate ids, edge references, predicates, edge policy bounds, loop / fanout / subgraph rules, data-flow mappings, start edge, cycle detection, loop-body integrity). Returns `Result<Flow, FlowError>`. Kept as the wire-form entry point for JSON coming off disk / network. `GRAPH_SCHEMA_URI` is the `$id` it validates against.
+- **`evaluateExpr(expr, env)`** — deterministic boolean evaluator over the closed Expr DSL.
+- **`resolveMapping(mapping, env)`** — resolves a `Mapping` (leaf or subgraph `inputMapping`, flow `output.mapping`) against an `EvalEnv`; a path that doesn't resolve omits its key. `resolvePath(path, env)` resolves one path; `MISSING_PATH` is the marker it returns when the path doesn't resolve.
+- **`schedulerTick(flow, state)`** — pure per-tick output (`{ ready, edgeEvals, done }`) from a `SchedulerState`.
+- Type exports: `Flow`, `FlowSpec`, `FlowEdge`, `FlowNode`, `FlowOutputSpec`, `LeafNode`, `WhileLoopNode`, `ForeachLoopNode`, `LoopNode`, `LoopBody`, `LoopEdge`, `FanoutNode`, `FanoutBranch`, `ConvergenceMode`, `SubflowNode`, `SubflowRef`, `SubflowConvergence`, `Mapping`, `Expr`, `Operand`, `LiteralOperand`, `PathOperand`, `Path`, `PathRoot`, `OperatorName`, `LoopOutputSchema`, `EdgePolicy`, `RetryPolicy`, `BackoffShape`, `EvalEnv`, `SchedulerState`, `SchedulerTick`, `PendingEdgeEval`, and `FlowError` with one interface per error code.
+- Value exports: `EDGE_POLICY_PRIORITY_DEFAULT` (0), `EDGE_POLICY_PRIORITY_MIN` (-100), `EDGE_POLICY_PRIORITY_MAX` (100), `getEffectivePriority(edgesByTo, nodeId)` (resolves the effective scheduler priority for a node, applying the fan-in default rule), `OPERATORS`, `CONVERGENCE_MODES`, `SUBGRAPH_CONVERGENCE_MODES`, the sentinels `START_NODE` / `END_NODE` / `LOOP_START_NODE` / `LOOP_END_NODE` / `SENTINEL_IDS`, and the type guards `isLeafNode` / `isLoopNode` / `isFanoutNode` / `isSubflowNode`.
+
+## Authoring
+
+Two entry points for building a `Flow`, both returning the same `Result<Flow, FlowError>` after the same validation gauntlet:
+
+```ts
+import { defineFlow, loadFlow } from '@kindgi/flow';
+import type { FlowSpec } from '@kindgi/flow';
+
+// Recommended for pack authors — mirrors defineTool / defineCheck / defineAgent.
+const flow = defineFlow({
+  id: 'my.flow',
+  version: '1.0.0',
+  nodes: [{ id: 'step-a', kind: 'tool', ref: 'noop' }],
+  edges: [
+    { id: 'e1', from: '$start', to: 'step-a' },
+    { id: 'e2', from: 'step-a', to: '$end' },
+  ],
+} satisfies FlowSpec);
+
+// Same validation surface — use loadFlow when the input is untrusted wire JSON.
+const loaded = loadFlow(JSON.parse(bytesFromDisk));
+```
+
+`defineFlow` is byte-for-byte equivalent to `loadFlow` on the same input; the two share every check. Pick `defineFlow` when authoring in TypeScript to align with the other `define*` primitives; pick `loadFlow` when consuming flow JSON from disk, network, or an untrusted caller.
+
+## Retry policy (schema-version 1.3.0+)
+
+Per-edge retry is declared via `FlowEdge.policy.retry`. The kernel honors this policy only when the destination node has EXACTLY ONE incoming edge — fan-in destinations (2+ incoming edges) ignore retry policies (there is no rule for whose policy would win).
+
+```ts
+import type { FlowEdge, RetryPolicy } from '@kindgi/flow';
+
+const retry: RetryPolicy = {
+  maxAttempts: 5,           // 1..10; 1 = no retry
+  delayMs: 100,             // ≥ 0; default 0
+  backoff: 'exponential',   // 'fixed' | 'linear' | 'exponential'; default 'fixed'
+  maxDelayMs: 5_000,        // required when backoff = 'exponential'
+};
+
+const edge: FlowEdge = {
+  id: 'e1',
+  from: 'produce',
+  to: 'consume',
+  policy: { retry },
+};
+```
+
+### Valid ranges (enforced by `loadFlow`)
+
+| Field | Range | Notes |
+|---|---|---|
+| `maxAttempts` | `1..10` (integer) | Larger values are a design smell — retry-heavy control flow belongs in a supervising flow. |
+| `delayMs` | `≥ 0` (integer) | Default `0`. |
+| `backoff` | `'fixed' \| 'linear' \| 'exponential'` | Default `'fixed'`. |
+| `maxDelayMs` | `≥ 0` (integer) | REQUIRED when `backoff = 'exponential'`. Defaults to `60_000` for `linear`. |
+
+Loader errors: `invalid-edge-policy` (with `field: 'retry.maxAttempts' | 'retry.delayMs' | 'retry.backoff' | 'retry.maxDelayMs'` and a `reason` string) for semantic violations; `schema-validation-failed` for shape violations.
+
+### Delay formula
+
+For the `attempt`-th retry (1-based; `attempt = 1` is the first retry after the initial failure):
+
+| Shape | Formula |
+|---|---|
+| `fixed` | `delayMs` |
+| `linear` | `min(delayMs * attempt, maxDelayMs ?? 60_000)` |
+| `exponential` | `min(delayMs * 2^(attempt - 1), maxDelayMs)` |
+
+Kernel runtime semantics + journal shape (`step.retry-scheduled`, resume behaviour, cancellation) are implemented by the Kindgi runtime's kernel.
+
+## Timeout policy (schema-version 1.3.0+)
+
+Per-edge handler-invocation timeout is declared via `FlowEdge.policy.timeoutMs`. Same fan-in rule as retry: applies only to a destination node with EXACTLY ONE incoming edge.
+
+```ts
+const edge: FlowEdge = {
+  id: 'e1',
+  from: 'produce',
+  to: 'consume',
+  policy: { timeoutMs: 5_000 },
+};
+```
+
+### Valid ranges (enforced by `loadFlow`)
+
+| Field | Range | Notes |
+|---|---|---|
+| `timeoutMs` | `1..3_600_000` (integer) | 1 hour cap. Longer work belongs behind `ctx.waitForToken` or in a `foreach` with `concurrency`. |
+
+Loader errors: `invalid-edge-policy` with `field: 'timeoutMs'` for out-of-band values; `schema-validation-failed` for shape violations.
+
+Kernel runtime semantics (timer wiring, `AbortSignal` composition, timeout+retry interaction, cancel+timeout attribution, loop-node bounding) are implemented by the Kindgi runtime's kernel.
+
+## Concurrency policy (schema-version 1.4.0+)
+
+Per-edge kernel semaphore is declared via `FlowEdge.policy.concurrencyKey`. When set on the sole incoming edge of a destination node, the kernel serializes dispatch across every node (across every run, across every flow, within a single tenant) that shares the same key: at most one such node runs at a time.
+
+```ts
+const edge: FlowEdge = {
+  id: 'e-model',
+  from: '$start',
+  to: 'call-model',
+  policy: { concurrencyKey: 'per-tenant:model-api' },
+};
+```
+
+### Valid ranges (enforced by `loadFlow`)
+
+| Field | Range | Notes |
+|---|---|---|
+| `concurrencyKey` | 1..256 chars, printable ASCII (0x20..0x7E) | Coordination handle, not a display label. Non-printable / non-ASCII rejected. |
+
+Loader errors: `invalid-edge-policy` with `field: 'concurrencyKey'` for length / character-set violations; `schema-validation-failed` for shape violations.
+
+Kernel runtime semantics (lease acquire/release lifecycle, `step.concurrency-deferred` journal kind, waitForToken suspend-release / resume-reacquire, retry re-acquire, sweep on resume) are implemented by the Kindgi runtime's kernel.
+
+## Priority policy (schema-version 1.5.0+)
+
+Per-edge scheduler priority is declared via `FlowEdge.policy.priority`. Same fan-in rule as retry / timeoutMs / concurrencyKey: applies only to a destination node with EXACTLY ONE incoming edge. Fan-in nodes inherit the default (`0`).
+
+```ts
+const highPriority: FlowEdge = {
+  id: 'e-urgent',
+  from: '$start',
+  to: 'expedite',
+  policy: { priority: 90 },
+};
+
+const background: FlowEdge = {
+  id: 'e-lazy',
+  from: '$start',
+  to: 'cleanup',
+  policy: { priority: -20 },
+};
+```
+
+### Valid ranges (enforced by `loadFlow`)
+
+| Field | Range | Notes |
+|---|---|---|
+| `priority` | `-100..100` (integer) | Default `0`. Integer-only: floats introduce IEEE-754 comparison ambiguity in a replay-critical sort key. Bounded range because the primitive expresses tiers ("urgent" / "normal" / "background") plus finer-grained ordering — wider ranges add no expressive power. |
+
+Loader errors: `invalid-edge-policy` with `field: 'priority'` for range / integer / type violations; `schema-validation-failed` for shape violations.
+
+Kernel runtime semantics (dispatch ordering, maxParallelism interaction, concurrencyKey interaction, determinism) are implemented by the Kindgi runtime's kernel.
+
+### `EdgePolicy` is a closed surface
+
+`retry` / `timeoutMs` / `concurrencyKey` / `priority` are the complete honored set. There is no `suspend` field — declarative suspension uses `ctx.waitForToken` at handler level. The schema enforces `additionalProperties: false`, so unknown edge-policy keys are rejected at load time.
+
+## Loop primitive
+
+Loop node types + `outputSchema` well-formedness live here; the runtime lives in the Kindgi runtime's kernel.
+
+## Fanout primitive (schema-version 1.6.0+)
+
+`FanoutNode` is a first-class node kind that runs N different handler bodies in parallel from a single dispatch, converging by a declared mode. Complementary to `foreach` (N iterations of the SAME body), fanout runs N DIFFERENT bodies concurrently.
+
+Shape:
+
+```jsonc
+{
+  "id": "the-fanout",
+  "kind": "fanout",
+  "branches": [                            // >= 2, unique branchIds
+    { "branchId": "a", "handler": "h-a", "outputSchema": { /* draft 2020-12 */ } },
+    { "branchId": "b", "handler": "h-b", "outputSchema": { /* draft 2020-12 */ } }
+  ],
+  "concurrency": 2,                        // optional, default = branches.length; 1..branches.length
+  "convergence": "settle-all"              // 'all-succeed' | 'any-succeed' | 'settle-all'
+}
+```
+
+Loader-enforced guardrails (`invalid-fanout-node`):
+
+- `branches.length >= 2` (a single-branch fanout is just a leaf node).
+- `branchId` non-empty + unique within a single fanout node.
+- `handler` non-empty (opaque to the loader — the kernel resolves it against the HandlerRegistry).
+- Per-branch `outputSchema` present + compiles against the draft-2020-12 meta-schema.
+- `concurrency` (when set) integer in `[1, branches.length]`.
+- `convergence` in the closed enum `{ 'all-succeed', 'any-succeed', 'settle-all' }`.
+
+Kernel runtime semantics (dispatch, sibling cancellation, replay, fan-in shape per convergence) are implemented by the Kindgi runtime's kernel.
+
+## Subgraph primitive (schema-version 1.7.0+)
+
+`SubflowNode` is a first-class node kind that dispatches another registered flow as a full kernel sub-run. Complementary to loop + fanout: `loop.foreach` iterates the SAME body over N inputs; `fanout` runs N DIFFERENT bodies in parallel; `subgraph` runs a whole OTHER flow inline as a node.
+
+Shape:
+
+```jsonc
+{
+  "id": "the-subgraph",
+  "kind": "subgraph",
+  "flowRef": {
+    "flowId": "child.flow.id",
+    "version": "1.2.3"                      // EXACT semver (no ranges)
+  },
+  "inputMapping": {                          // Record<string, Operand>
+    "target":  { "path": "runInput.target" },
+    "hint":    { "literal": "expedite" }
+  },
+  "outputSchema": { /* draft 2020-12 */ },   // typed escape contract
+  "convergence": "settle-all"                // 'success-only' | 'settle-all'
+}
+```
+
+Loader-enforced guardrails (`invalid-subgraph-node`):
+
+- `flowRef.flowId` non-empty.
+- `flowRef.version` is EXACT semver (`^` / `~` / ranges rejected — deterministic replay requires exact resolution).
+- `inputMapping` is a plain object whose every value is a valid `Operand` (`{ path }` or `{ literal }`).
+- `outputSchema` present + compiles against the draft-2020-12 meta-schema (same discipline as loop / fanout output schemas).
+- `convergence` in the closed enum `{ 'success-only', 'settle-all' }`.
+
+Kernel runtime semantics (child-run dispatch, journal shape, replay via prior-dispatch reattach, cross-tenant guard, depth-limit enforcement) are implemented by the Kindgi runtime's kernel.
+
+## Data flow (schema-version 1.8.0+)
+
+A tool or agent node can declare an `inputMapping`, and the flow can declare an `output`. Both are `Mapping`s: each key maps to a `{ literal }` or a `{ path }` rooted at `runInput`, `state` or `nodeOutputs.<nodeId>`, resolved with `resolveMapping`. A path that doesn't resolve omits its key.
+
+```jsonc
+{
+  "nodes": [
+    { "id": "parse", "kind": "tool", "ref": "acme.parse-profile" },
+    {
+      "id": "rank",
+      "kind": "tool",
+      "ref": "acme.rank",
+      "inputMapping": {                       // absent → the single upstream node's output
+        "profile": { "path": "nodeOutputs.parse" },
+        "orgId":   { "path": "runInput.orgId" }
+      }
+    }
+  ],
+  "output": {                                 // absent → the output of the node feeding $end
+    "mapping": { "ranking": { "path": "nodeOutputs.rank" } },
+    "schema": { "type": "object" }            // optional; must compile
+  }
+}
+```
+
+Loader errors: `invalid-mapping` when a mapping names a node the flow doesn't have, maps a node's own output, or uses a loop-only root (`iterationIndex` / `iterationOutput`); `invalid-flow-output` when `output.schema` doesn't compile; `schema-validation-failed` for a path with an unknown root.
+
+A conditional branch can rejoin: `schedulerTick` treats a node whose every incoming edge is not taken, or comes from such a skipped node, as dead. A join after a skipped arm becomes ready once its taken arms resolve, and a join whose arms are all skipped is skipped too.
+
+## Schema drift
+
+`src/flow.schema.json` is bundled into the package for offline validation. It must match `@kindgi/specs/flow.schema.json` (a test compares the parsed JSON); the two change together.

package/dist/define.d.ts

@@ -0,0 +1,36 @@
+import type { Result, Unbranded } from '@kindgi/types';
+import type { FlowError } from './errors.js';
+import type { Flow } from './types.js';
+/**
+ * The author-facing spec accepted by `defineFlow`: the shape of the runtime
+ * `Flow` — an object literal conforming to `flow.schema.json` — with its
+ * ids as plain strings. An author writes `id: 'acme.review'`, a node
+ * `id: 'parse'`, an edge `from: 'parse'`, with no `as FlowId` / `as NodeId`
+ * / `as EdgeId` casts; branded ids still fit. `defineFlow` returns the
+ * validated `Flow`, branded, ready for the kernel or a registry.
+ */
+export type FlowSpec = Unbranded<Flow>;
+/**
+ * Build a validated `Flow` from a user-supplied definition.
+ *
+ * Thin wrapper over `loadFlow` — same validation gauntlet, same error
+ * surface, same `Result<Flow, FlowError>` envelope. The distinction is
+ * ergonomic: `defineFlow` is the author-facing primitive that mirrors
+ * `defineTool` / `defineCheck` / `defineAgent`, so pack authors reach for
+ * one consistent shape when declaring workspace primitives. `loadFlow`
+ * remains the wire-form entry point for JSON coming off disk / network.
+ *
+ * Validates (fail-fast, in `loadFlow` order):
+ *   1. JSON-schema conformance against `flow.schema.json`.
+ *   2. Reserved-id / duplicate-id / unknown-node-reference checks.
+ *   3. Predicate + edge-policy + loop / fanout / subgraph well-formedness,
+ *      data-flow mappings and the flow `output.schema`.
+ *   4. Start-edge check and cycle detection (outer + every loop body at
+ *      every nesting level).
+ *
+ * The returned `Flow` is byte-identical to `loadFlow(spec).value` on
+ * success; consumers can treat the two entry points as interchangeable
+ * modulo authoring intent.
+ */
+export declare function defineFlow(spec: FlowSpec): Result<Flow, FlowError>;
+//# sourceMappingURL=define.d.ts.map

package/dist/define.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define.d.ts","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAEvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAEvC;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAElE"}

package/dist/define.js

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2026 Kindgi Inc.
+import { loadFlow } from './loader.js';
+/**
+ * Build a validated `Flow` from a user-supplied definition.
+ *
+ * Thin wrapper over `loadFlow` — same validation gauntlet, same error
+ * surface, same `Result<Flow, FlowError>` envelope. The distinction is
+ * ergonomic: `defineFlow` is the author-facing primitive that mirrors
+ * `defineTool` / `defineCheck` / `defineAgent`, so pack authors reach for
+ * one consistent shape when declaring workspace primitives. `loadFlow`
+ * remains the wire-form entry point for JSON coming off disk / network.
+ *
+ * Validates (fail-fast, in `loadFlow` order):
+ *   1. JSON-schema conformance against `flow.schema.json`.
+ *   2. Reserved-id / duplicate-id / unknown-node-reference checks.
+ *   3. Predicate + edge-policy + loop / fanout / subgraph well-formedness,
+ *      data-flow mappings and the flow `output.schema`.
+ *   4. Start-edge check and cycle detection (outer + every loop body at
+ *      every nesting level).
+ *
+ * The returned `Flow` is byte-identical to `loadFlow(spec).value` on
+ * success; consumers can treat the two entry points as interchangeable
+ * modulo authoring intent.
+ */
+export function defineFlow(spec) {
+    return loadFlow(spec);
+}
+//# sourceMappingURL=define.js.map

package/dist/define.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define.js","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,iCAAiC;AAKjC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAavC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,UAAU,CAAC,IAAc;IACvC,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC"}