@pieceful/ravel-core 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+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:
+
+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.

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@pieceful/ravel-core",
+  "version": "0.1.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" },
+  "exports": {
+    ".": "./src/index.js",
+    "./directives": "./src/directives.js"
+  },
+  "types": "./src/index.d.ts",
+  "files": ["src", "LICENSE"]
+}

package/src/.gitkeep

@@ -0,0 +1 @@
+

package/src/directives.d.ts

@@ -0,0 +1,9 @@
+import type { SourceLocation } from "./index.js";
+export const directiveKinds: Set<string>;
+export function compose(steps: unknown[], source: SourceLocation): unknown;
+export function append(reference: string, source: SourceLocation): unknown;
+export function newline(count: number, source: SourceLocation): unknown;
+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;

package/src/directives.js

@@ -0,0 +1,16 @@
+// Portable directive IR. Adapters only construct these values; core owns their meaning.
+export const directiveKinds = new Set(["create", "alias", "in", "out"]);
+
+export const compose = (steps, source) => ({ kind: "compose", steps, source });
+export const append = (reference, source) => ({ kind: "append", reference, source });
+export const newline = (count, source) => ({ kind: "newline", count, source });
+export const pipe = (steps, source) => ({ kind: "pipe", steps, source });
+export const pass = (steps, source) => ({ kind: "pass", steps, source });
+
+/**
+ * A create name is document-local: `program:cool.js` becomes the surrounding
+ * document's canonical chunk identity. Alias is intentionally the only
+ * directive that may introduce an alternate graph name for an existing node.
+ */
+export const createDirective = (name, value, source) => ({ kind: "create", name, value, source });
+export const aliasDirective = (name, reference, source) => ({ kind: "alias", name, reference, source });

package/src/index.d.ts

@@ -0,0 +1,37 @@
+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 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; }
+export interface ProvenanceOrigin { source: SourceLocation | null; chunk: string; kind: string; precision: "exact" | "coarse"; via: ProvenanceStep[]; }
+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 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; }
+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 function combineMaps(maps: RavelMap[]): PretransformGraph;
+export function transformGraph(graph: PretransformGraph, options?: { transforms?: Record<string, (value: string, ...argumentsValue: unknown[]) => string> | Map<string, Function> }): RavelProgram;
+export const provenanceMapVersion: 1;
+export function createDeliverableProvenanceMap(deliverable: Deliverable): DeliverableProvenanceMap;
+export function createBuildProvenanceMap(program: RavelProgram): BuildProvenanceMap;
+export function sourceAtGeneratedOffset(map: DeliverableProvenanceMap, offset: number): (ProvenanceSegment & { sourceOffset?: number }) | null;
+export interface GeneratedSourceMatch { generated: { start: number; end: number }; generatedOffset?: number; source?: { start: number; end: number }; precision: "exact" | "coarse"; chunk: string; kind: string; via: ProvenanceStep[]; through?: "transform-origin"; }
+export function generatedRangesForSource(map: DeliverableProvenanceMap, uri: string, offset: number): GeneratedSourceMatch[];
+export function generatedRangesForSourceRange(map: DeliverableProvenanceMap, uri: string, range: { start: number | SourcePosition; end: number | SourcePosition }): GeneratedSourceMatch[];
+export function explainGeneratedOffset(program: RavelProgram, deliverableName: string, offset: number): { deliverable: { name: string; from: string }; generatedOffset: number; segment: ProvenanceSegment & { sourceOffset?: number }; definition: { id: string; identity: ChunkIdentity; metadata: unknown; generated?: boolean } | null; references: ProvenanceStep[]; dependencyPath: string[] } | null;
+export const directiveKinds: Set<string>;
+export function compose(steps: unknown[], source: SourceLocation): unknown;
+export function append(reference: string, source: SourceLocation): unknown;
+export function newline(count: number, source: SourceLocation): unknown;
+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;