@pieceful/ravel-core 0.1.0 → 0.2.0

package/LICENSE

@@ -2,8 +2,20 @@ MIT License
 
 Copyright (c) 2026 James Taylor
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# @pieceful/ravel-core
+
+The portable composition engine behind [Ravel](https://github.com/jostylr/ravel). It parses chunk references,
+resolves the dependency graph, evaluates static composition, reports
+source-linked diagnostics, and creates provenance maps for generated output.
+
+```sh
+npm install @pieceful/ravel-core
+```
+
+Use this package when embedding Ravel in a browser, Bun, Node, or another host.
+It is native ESM and deliberately has no filesystem, process, shell, or network
+capabilities. Pair it with an adapter such as `@pieceful/ravel-markdown` and a
+host that supplies any I/O you need.
+
+`parseRavelDirectiveBlock` is the shared source-mapped parser for graph
+directive bodies. Markdown `ravel` fences and MyST `{ravel}` directives use
+this same grammar.
+
+The documented public functions include `combineMaps`, `transformGraph`, the
+generated/source provenance query helpers, and the 0.2
+`planLiveExecutions` / `executeLiveProgram` provider boundary. Core selects and
+schedules providers but does not import a language runtime. Requires Node.js 22
+or newer when used in Node.
+
+See the [Ravel documentation](https://ravel.jostylr.com/) for the public API,
+Ravel Map contract, chunk syntax, and provenance format.
+
+MIT © James Taylor

package/package.json

@@ -1,20 +1,39 @@
 {
   "name": "@pieceful/ravel-core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "description": "Ravel chunk syntax, resolution, graph evaluation, and diagnostics.",
   "license": "MIT",
   "author": "James Taylor",
-  "repository": { "type": "git", "url": "git+https://github.com/jostylr/ravel.git", "directory": "packages/core" },
-  "bugs": { "url": "https://github.com/jostylr/ravel/issues" },
-  "homepage": "https://github.com/jostylr/ravel#readme",
-  "engines": { "node": ">=22" },
-  "keywords": ["ravel", "literate-programming", "graph", "composition"],
-  "publishConfig": { "access": "public" },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jostylr/ravel.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/jostylr/ravel/issues"
+  },
+  "homepage": "https://ravel.jostylr.com/",
+  "engines": {
+    "node": ">=22"
+  },
+  "keywords": [
+    "ravel",
+    "literate-programming",
+    "graph",
+    "composition"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": "./src/index.js",
     "./directives": "./src/directives.js"
   },
   "types": "./src/index.d.ts",
-  "files": ["src", "LICENSE"]
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ]
 }

package/src/directive-syntax.js

@@ -0,0 +1,354 @@
+const diagnostic = (message, source) => ({
+  code: "RM104",
+  severity: "error",
+  message,
+  source
+});
+
+const stringValue = (value) => {
+  if (value.startsWith("\"")) {
+    try {
+      return JSON.parse(value);
+    } catch {
+      return undefined;
+    }
+  }
+  if (value.startsWith("'") && value.endsWith("'")) {
+    return value.slice(1, -1).replace(/\\'/g, "'").replace(/\\\\/g, "\\");
+  }
+  return value;
+};
+
+const tokenize = (text, sourceAt, diagnostics) => {
+  const result = [];
+  let index = 0;
+  const add = (type, value, start, end) =>
+    result.push({ type, value, start, end, source: sourceAt(start, end) });
+  const readString = (start, reference = false) => {
+    const quote = text[index];
+    index += 1;
+    let escaped = false;
+    while (index < text.length) {
+      const character = text[index];
+      if (escaped) escaped = false;
+      else if (character === "\\") escaped = true;
+      else if (character === quote) break;
+      index += 1;
+    }
+    if (index >= text.length) {
+      diagnostics.push(diagnostic(
+        "Unterminated directive string.",
+        sourceAt(start, text.length)
+      ));
+      return;
+    }
+    const raw = text.slice(start + (reference ? 1 : 0), index + 1);
+    const value = stringValue(raw);
+    if (typeof value !== "string") {
+      diagnostics.push(diagnostic(
+        "Malformed directive string.",
+        sourceAt(start, index + 1)
+      ));
+    } else {
+      add(reference ? "reference" : "string", value, start, index + 1);
+    }
+    index += 1;
+  };
+
+  while (index < text.length) {
+    const character = text[index];
+    if (/\s/.test(character)) {
+      index += 1;
+    } else if (character === "_" &&
+        (text[index + 1] === "\"" || text[index + 1] === "'")) {
+      const start = index;
+      index += 1;
+      readString(start, true);
+    } else if (character === "\"" || character === "'") {
+      const start = index;
+      readString(start);
+    } else if (/[a-z]/.test(character)) {
+      const start = index;
+      index += 1;
+      while (/[a-z0-9-]/.test(text[index] ?? "")) index += 1;
+      add("identifier", text.slice(start, index), start, index);
+    } else if (/[0-9]/.test(character)) {
+      const start = index;
+      index += 1;
+      while (/[0-9]/.test(text[index] ?? "")) index += 1;
+      add("number", Number(text.slice(start, index)), start, index);
+    } else if (character === "(" || character === ")" ||
+        character === "," || character === ";") {
+      add(character, character, index, index + 1);
+      index += 1;
+    } else {
+      diagnostics.push(diagnostic(
+        "Unexpected directive character: " + character,
+        sourceAt(index, index + 1)
+      ));
+      index += 1;
+    }
+  }
+  return result;
+};
+
+const commandsFrom = (text, sourceAt, diagnostics) => {
+  const tokens = tokenize(text, sourceAt, diagnostics);
+  let index = 0;
+  const current = () => tokens[index];
+  const take = (type) => {
+    if (current()?.type === type) return tokens[index++];
+    return null;
+  };
+  const error = (message, token = current()) => diagnostics.push(diagnostic(
+    message,
+    token?.source ?? sourceAt(text.length, text.length)
+  ));
+
+  const expression = () => {
+    const token = current();
+    if (!token) return null;
+    if (token.type === "string" || token.type === "reference" ||
+        token.type === "number") {
+      index += 1;
+      return { type: token.type, value: token.value, source: token.source };
+    }
+    if (token.type !== "identifier") {
+      error("Expected a directive value.");
+      return null;
+    }
+    index += 1;
+    const name = token.value;
+    if (!take("(")) {
+      error("Directive names must be followed by (...).", current() ?? token);
+      return null;
+    }
+    const argumentsValue = [];
+    if (!take(")")) {
+      while (true) {
+        const value = expression();
+        if (!value) return null;
+        argumentsValue.push(value);
+        if (take(")")) break;
+        if (!take(",")) {
+          error("Expected , or ) in directive call.");
+          return null;
+        }
+      }
+    }
+    const end = tokens[index - 1]?.end ?? token.end;
+    return {
+      type: "call",
+      name,
+      arguments: argumentsValue,
+      source: sourceAt(token.start, end)
+    };
+  };
+
+  const commands = [];
+  while (index < tokens.length) {
+    const command = expression();
+    if (!command) {
+      index += 1;
+      continue;
+    }
+    if (command.type !== "call") {
+      error("Top-level directive entries must be calls.", command);
+    } else {
+      commands.push(command);
+    }
+    take(";");
+  }
+  return commands;
+};
+
+const pipelineCall = (call, diagnostics) => {
+  if (call.type !== "call") {
+    diagnostics.push(diagnostic(
+      "pipe and pass accept command calls only.",
+      call.source
+    ));
+    return null;
+  }
+  if (call.name === "emit") {
+    if (call.arguments.length !== 1 ||
+        call.arguments[0].type !== "string") {
+      diagnostics.push(diagnostic(
+        "emit requires one string suffix.",
+        call.source
+      ));
+      return null;
+    }
+    return {
+      type: "emit",
+      suffix: call.arguments[0].value,
+      metadata: {},
+      source: call.source
+    };
+  }
+  if (call.arguments.some((argument) =>
+    argument.type !== "string" && argument.type !== "number"
+  )) {
+    diagnostics.push(diagnostic(
+      "Transform arguments must be strings or numbers.",
+      call.source
+    ));
+    return null;
+  }
+  return {
+    type: "transform",
+    name: call.name,
+    arguments: call.arguments.map((argument) => argument.value),
+    source: call.source
+  };
+};
+
+const composeStep = (value, diagnostics) => {
+  if (value.type === "reference") {
+    return {
+      kind: "append",
+      reference: value.value,
+      source: value.source
+    };
+  }
+  if (value.type !== "call") {
+    diagnostics.push(diagnostic(
+      "compose accepts references or directive calls.",
+      value.source
+    ));
+    return null;
+  }
+  if (value.name === "newline") {
+    if (value.arguments.length !== 1 ||
+        value.arguments[0].type !== "number" ||
+        value.arguments[0].value < 0) {
+      diagnostics.push(diagnostic(
+        "newline requires one non-negative integer.",
+        value.source
+      ));
+      return null;
+    }
+    return {
+      kind: "newline",
+      count: value.arguments[0].value,
+      source: value.source
+    };
+  }
+  if (value.name === "append") {
+    if (value.arguments.length !== 1 ||
+        value.arguments[0].type !== "reference") {
+      diagnostics.push(diagnostic(
+        "append requires one quoted reference.",
+        value.source
+      ));
+      return null;
+    }
+    return {
+      kind: "append",
+      reference: value.arguments[0].value,
+      source: value.source
+    };
+  }
+  if (value.name === "pipe" || value.name === "pass") {
+    const steps = value.arguments.map((argument) =>
+      pipelineCall(argument, diagnostics)
+    );
+    return steps.some((step) => !step)
+      ? null
+      : { kind: value.name, steps, source: value.source };
+  }
+  diagnostics.push(diagnostic(
+    "Unknown compose step: " + value.name,
+    value.source
+  ));
+  return null;
+};
+
+const directiveFrom = (command, document, diagnostics) => {
+  const args = command.arguments;
+  if (command.name === "create") {
+    if (args.length !== 2 || args[0].type !== "string" ||
+        args[1].type !== "call" || args[1].name !== "compose") {
+      diagnostics.push(diagnostic(
+        "create requires a local name and compose(...).",
+        command.source
+      ));
+      return null;
+    }
+    const steps = args[1].arguments.map((value) =>
+      composeStep(value, diagnostics)
+    );
+    return steps.some((step) => !step)
+      ? null
+      : {
+          kind: "create",
+          document,
+          name: args[0].value,
+          compose: steps,
+          source: command.source
+        };
+  }
+  if (command.name === "alias") {
+    if (args.length !== 2 || args[0].type !== "string" ||
+        args[1].type !== "reference") {
+      diagnostics.push(diagnostic(
+        "alias requires a local name and quoted reference.",
+        command.source
+      ));
+      return null;
+    }
+    return {
+      kind: "alias",
+      document,
+      name: args[0].value,
+      reference: args[1].value,
+      source: command.source
+    };
+  }
+  if (command.name === "in") {
+    if (args.length !== 1 || args[0].type !== "string") {
+      diagnostics.push(diagnostic(
+        "in requires one file path string.",
+        command.source
+      ));
+      return null;
+    }
+    return { kind: "in", target: args[0].value, source: command.source };
+  }
+  if (command.name === "out") {
+    if (args.length !== 2 || args[0].type !== "string" ||
+        args[1].type !== "reference") {
+      diagnostics.push(diagnostic(
+        "out requires a file name and quoted reference.",
+        command.source
+      ));
+      return null;
+    }
+    const from = args[1].value.includes("::")
+      ? args[1].value
+      : document + "::" + args[1].value;
+    return {
+      kind: "out",
+      name: args[0].value,
+      from,
+      source: command.source
+    };
+  }
+  diagnostics.push(diagnostic(
+    "Unknown Ravel directive: " + command.name,
+    command.source
+  ));
+  return null;
+};
+
+export const parseRavelDirectiveBlock = (
+  text,
+  { document, sourceAt }
+) => {
+  const diagnostics = [];
+  const commands = commandsFrom(text, sourceAt, diagnostics);
+  const directives = commands
+    .map((command) => directiveFrom(command, document, diagnostics))
+    .filter(Boolean);
+  return { directives, diagnostics };
+};

package/src/index.d.ts

@@ -2,7 +2,8 @@ export interface SourcePosition { line: number; column: number; offset: number;
 export interface SourceRange { start: SourcePosition; end: SourcePosition; }
 export interface SourceLocation { uri: string; range: SourceRange; }
 export interface Diagnostic { code: string; severity: "error" | "warning" | "info"; message: string; source: SourceLocation; related?: SourceLocation[]; }
-export interface ChunkIdentity { document: string | null; chunk: string | null; minor: string | null; type: string | null; explicitDocument?: boolean; }
+export type RavelValue = null | boolean | number | string | RavelValue[] | { [key: string]: RavelValue };
+export interface ChunkIdentity { document: string | null; chunk: string | null; minor: string | null; type: string | null; explicitDocument?: boolean; relativePath?: string; }
 export interface RavelMap { version: 1; document: { id: string; uri: string; format: string }; chunks: Array<Record<string, unknown>>; directives?: Array<Record<string, unknown>>; diagnostics?: Diagnostic[]; }
 export interface PretransformGraph { version: 1; documents: Array<{ id: string; uri: string; format: string }>; chunks: Array<Record<string, unknown>>; directives: Array<Record<string, unknown>>; diagnostics: Diagnostic[]; }
 export interface ProvenanceStep { kind: string; source?: SourceLocation; from?: string; to?: string; name?: string; phase?: number; value?: string; owner?: string; target?: string; }
@@ -10,15 +11,118 @@ export interface ProvenanceOrigin { source: SourceLocation | null; chunk: string
 export interface ProvenanceSegment { generated: { start: number; end: number }; source: SourceLocation | null; chunk: string; kind: string; precision: "exact" | "coarse"; via: ProvenanceStep[]; origins?: ProvenanceOrigin[]; }
 export interface DeliverableProvenanceMap { version: 1; kind: "ravel-provenance-map"; generated: { uri: string; length: number; offsetEncoding: "utf-16" }; from: string; segments: ProvenanceSegment[]; }
 export interface BuildProvenanceMap { version: 1; kind: "ravel-provenance-bundle"; maps: DeliverableProvenanceMap[]; }
-export interface ProgramChunk { id: string; identity: ChunkIdentity; value: string; segments: ProvenanceSegment[]; source: SourceLocation; dependencies: string[]; references: Array<{ chunk: string; requested: string; source: SourceLocation }>; provenance: unknown[]; generated?: boolean; }
+export interface ProgramChunk { id: string; identity: ChunkIdentity; value: string; segments: ProvenanceSegment[]; metadata: { language?: string; data?: { ravel?: { run?: boolean; provider?: string; [key: string]: unknown }; [key: string]: unknown }; [key: string]: unknown }; source: SourceLocation; dependencies: string[]; references: Array<{ chunk: string; requested: string; source: SourceLocation }>; provenance: unknown[]; generated?: boolean; }
 export interface Deliverable { name: string; from: string; value: string; segments: ProvenanceSegment[]; source: SourceLocation; dependencies: string[]; }
 export interface RavelProgram { version: 1; documents: PretransformGraph["documents"]; chunks: Record<string, ProgramChunk>; deliverables: Record<string, Deliverable>; diagnostics: Diagnostic[]; trace: { chunks: Record<string, unknown[]> }; }
 export interface TransformCall { type?: "transform"; name: string; arguments?: unknown[]; source?: SourceLocation; }
+/** Stable v0.2 execution-boundary contract. Providers must preserve this shape. */
+export type LiveContractVersion = 1;
+export type LiveExecutionStatus = "succeeded" | "failed";
+export interface LiveDependency { reference: string; source?: SourceLocation; }
+export interface LiveResourceRequest { name?: string; path?: string; source?: SourceLocation; }
+export interface LiveModuleRequest { specifier: string; source?: SourceLocation; }
+export interface LiveAnalysis {
+  version: LiveContractVersion;
+  dependencies: Array<string | LiveDependency>;
+  resources: Array<string | LiveResourceRequest>;
+  modules: Array<string | LiveModuleRequest>;
+  diagnostics: Diagnostic[];
+}
+export interface LiveAnalysisRequest {
+  id: string;
+  language: string;
+  source: string;
+  sourceLocation: SourceLocation;
+}
+export interface LiveExecutionRequest {
+  version: LiveContractVersion;
+  id: string;
+  runId: string;
+  language: string;
+  source: string;
+  sourceLocation: SourceLocation;
+  inputs: Record<string, RavelValue>;
+  resources: Record<string, RavelValue>;
+  analysis: LiveAnalysis;
+  limits: Record<string, unknown>;
+  signal?: AbortSignal;
+}
+export interface LiveExecutionOutcome {
+  version: LiveContractVersion;
+  ok: boolean;
+  status: LiveExecutionStatus;
+  hasExport: boolean;
+  value?: RavelValue;
+  serialized?: string;
+  diagnostics: Diagnostic[];
+  durationMs?: number;
+}
+export interface ExecutionProvider {
+  id: string;
+  version: string;
+  languages: readonly string[] | ReadonlySet<string>;
+  analyze(request: LiveAnalysisRequest): LiveAnalysis;
+  execute(request: LiveExecutionRequest): Promise<LiveExecutionOutcome> | LiveExecutionOutcome;
+  dispose?(): Promise<void> | void;
+}
+export interface LiveExecutionPlan {
+  version: 1;
+  nodes: Record<string, {
+    id: string;
+    language: string;
+    provider: { id: string; version: string };
+    source: SourceLocation;
+    dependencies: Array<{ reference: string; id: string; source: SourceLocation }>;
+    resources: Array<string | LiveResourceRequest>;
+    modules: Array<string | LiveModuleRequest>;
+    analysis: LiveAnalysis;
+  }>;
+  diagnostics: Diagnostic[];
+  ok: boolean;
+}
+export interface LiveProgramResult {
+  version: 1;
+  program: RavelProgram;
+  plan: LiveExecutionPlan;
+  executions: Record<string, {
+    id: string;
+    status: LiveExecutionStatus;
+    value?: RavelValue;
+    serialized?: string;
+    provider?: { id: string; version: string };
+    durationMs?: number;
+  }>;
+  diagnostics: Diagnostic[];
+  ok: boolean;
+}
 export function formatChunkId(identity: ChunkIdentity): string;
 export function parseChunkId(input: string, options?: { reference?: boolean }): ChunkIdentity | null;
-export function parseChunk(body: string, source: SourceLocation): { nodes: unknown[]; diagnostics: Diagnostic[] };
+export interface ChunkReferenceSyntaxOptions {
+  nowebReferences?: boolean;
+  nowebPlus?: boolean;
+  underscoreReferences?: boolean;
+  referenceAliases?: Record<string, string>;
+}
+export function parseChunk(body: string, source: SourceLocation, options?: ChunkReferenceSyntaxOptions): { nodes: unknown[]; diagnostics: Diagnostic[] };
+export function parseDefinitionPipeline(text: string, source: SourceLocation): { pipeline: TransformCall[]; diagnostics: Diagnostic[] };
 export function combineMaps(maps: RavelMap[]): PretransformGraph;
-export function transformGraph(graph: PretransformGraph, options?: { transforms?: Record<string, (value: string, ...argumentsValue: unknown[]) => string> | Map<string, Function> }): RavelProgram;
+export function transformGraph(graph: PretransformGraph, options?: {
+  transforms?: Record<string, (value: string, ...argumentsValue: unknown[]) => string> | Map<string, Function>;
+  deferLiveResults?: boolean;
+  liveResults?: LiveProgramResult | LiveProgramResult["executions"] | Map<string, LiveProgramResult["executions"][string]>;
+}): RavelProgram;
+export function ravelValueIssue(value: unknown, path?: string): string | null;
+export function serializeRavelValue(value: unknown): string;
+export function cloneRavelValue(value: RavelValue): RavelValue;
+export function planLiveExecutions(program: RavelProgram, options?: { providers?: ExecutionProvider[] | Map<string, ExecutionProvider> | Record<string, ExecutionProvider> }): LiveExecutionPlan;
+export interface LiveExecutionOptions {
+  providers?: ExecutionProvider[] | Map<string, ExecutionProvider> | Record<string, ExecutionProvider>;
+  resources?: Map<string, RavelValue> | Record<string, RavelValue>;
+  limits?: Record<string, unknown>;
+  runId?: string;
+  signal?: AbortSignal;
+}
+export function executeLiveProgram(program: RavelProgram, options?: LiveExecutionOptions): Promise<LiveProgramResult>;
 export const provenanceMapVersion: 1;
 export function createDeliverableProvenanceMap(deliverable: Deliverable): DeliverableProvenanceMap;
 export function createBuildProvenanceMap(program: RavelProgram): BuildProvenanceMap;
@@ -35,3 +139,7 @@ export function pipe(steps: unknown[], source: SourceLocation): unknown;
 export function pass(steps: unknown[], source: SourceLocation): unknown;
 export function createDirective(name: string, value: unknown, source: SourceLocation): unknown;
 export function aliasDirective(name: string, reference: string, source: SourceLocation): unknown;
+export function parseRavelDirectiveBlock(text: string, options: {
+  document: string;
+  sourceAt(start: number, end: number): SourceLocation;
+}): { directives: Array<Record<string, unknown>>; diagnostics: Diagnostic[] };