@krishnadobhal/rewind-core 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 reasonable and customary use in 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 Krishna Dobhal
+
+   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/dist/hash.d.ts

@@ -0,0 +1,16 @@
+import type { RewindRequest } from './types/request.ts';
+export declare const HASH_VERSION = 3;
+/** Every string in the request passes through here. HASHING.md §3, steps 1, 2 and 4. */
+export declare function normalizeText(input: string): string;
+/** The canonical form of a request: exactly the fields that make up its identity. */
+export declare function canonical(req: RewindRequest): Record<string, unknown>;
+/** req_hash = sha256(HASH_VERSION ‖ "\x00" ‖ jcs(canonical(request))) */
+export declare function reqHash(req: RewindRequest): string;
+/**
+ * Canonical digest of any JSON value — the same normalization a request gets.
+ *
+ * This is what `final_state_hash` should be. `JSON.stringify` would make key order look
+ * like a changed outcome, and would put every random message id straight into the
+ * digest, so an identical replay would report a mismatch that never happened.
+ */
+export declare function stateHash(value: unknown): string;

package/dist/hash.js

@@ -0,0 +1,163 @@
+import { createHash } from 'node:crypto';
+import canonicalize from 'canonicalize';
+export const HASH_VERSION = 3;
+// Random per call, but repetition is meaningful — it pairs a tool call with its result.
+const ID_KEYS = new Set([
+    'id',
+    'message_id',
+    'tool_call_id',
+    'tool_use_id',
+    'call_id',
+    'correlation_id',
+]);
+// Never identity. Auth headers included — a rotated key must not invalidate a corpus.
+const DROP_KEYS = new Set([
+    'request_id',
+    'idempotency_key',
+    'timestamp',
+    'created',
+    'created_at',
+    'latency_ms',
+    'traceparent',
+    'tracestate',
+    'trace_id',
+    'span_id',
+    'user-agent',
+    'user_agent',
+    'retry_count',
+    'sdk_version',
+    'x-api-key',
+    'api_key',
+    'apikey',
+    'authorization',
+    'stream',
+]);
+/* length threshold, not a decoder probe. Prose is not valid base64. */
+const BASE64_MIN = 1024;
+const BASE64_RE = /^[A-Za-z0-9+/\s]+={0,2}$/;
+const DATA_URL_RE = /^data:[^;,]*;base64,([A-Za-z0-9+/=\s]+)$/;
+/* Renames volatile ids to call_0, call_1 … by first appearance within one request. */
+class Ordinals {
+    #seen = new Map(); // original id → its ordinal
+    /** Returns this id's ordinal, memoized so cross-references hold. */
+    of(id) {
+        let ordinal = this.#seen.get(id); // seen already? reuse it
+        if (ordinal === undefined) {
+            // Map size is the counter; a repeat hits the get above and never advances it.
+            ordinal = `call_${this.#seen.size}`;
+            this.#seen.set(id, ordinal);
+        }
+        return ordinal;
+    }
+}
+/** Replaces a blob with the digest of its decoded bytes. */
+function digestBase64(b64) {
+    return `sha256:${createHash('sha256').update(Buffer.from(b64, 'base64')).digest('hex')}`;
+}
+/** Every string in the request passes through here. HASHING.md §3, steps 1, 2 and 4. */
+export function normalizeText(input) {
+    const dataUrl = DATA_URL_RE.exec(input); // data: URL carries its own marker
+    if (dataUrl)
+        return digestBase64(dataUrl[1]);
+    if (input.length >= BASE64_MIN && BASE64_RE.test(input))
+        return digestBase64(input); // bare blob
+    const nfc = input.normalize('NFC').replace(/\r\n?/g, '\n');
+    // Odd indices are fenced blocks; leave them byte-for-byte — indentation changes behaviour.
+    const parts = nfc.split(/(```[\s\S]*?(?:```|$))/g);
+    const lines = parts
+        .map((part, i) => (i % 2 === 1 ? part : collapseHorizontal(part)))
+        .join('')
+        .split('\n');
+    // Leading and trailing blank lines carry no meaning; interior ones do.
+    while (lines.length > 0 && lines[0].trim() === '')
+        lines.shift();
+    while (lines.length > 0 && lines[lines.length - 1].trim() === '')
+        lines.pop();
+    return lines.join('\n');
+}
+/** Collapses runs of spaces and tabs, strips trailing space. */
+function collapseHorizontal(chunk) {
+    return chunk
+        .split('\n')
+        .map((line) => line.replace(/[^\S\n]+/g, ' ').replace(/[^\S\n]+$/, ''))
+        .join('\n');
+}
+/** Rebuilds `value` as a new tree; never mutates the caller's request. */
+function normalizeValue(value, ids) {
+    if (typeof value === 'string')
+        return normalizeText(value);
+    if (Array.isArray(value))
+        return value.map((v) => normalizeValue(v, ids));
+    if (value !== null && typeof value === 'object') {
+        const out = {};
+        for (const [key, raw] of Object.entries(value)) {
+            const lower = key.toLowerCase();
+            // undefined, null and omitted all collapse to omitted; "" and [] are meaningful.
+            if (raw === undefined || raw === null)
+                continue;
+            if (DROP_KEYS.has(lower))
+                continue;
+            // 'id' is generic — domain ids get renumbered too, and two distinct ids reaching
+            // the same slot in two requests both become call_N and collide.
+            if (ID_KEYS.has(lower) && typeof raw === 'string') {
+                out[key] = ids.of(raw);
+                continue;
+            }
+            out[key] = normalizeValue(raw, ids);
+        }
+        return out;
+    }
+    return value;
+}
+/** The canonical form of a request: exactly the fields that make up its identity. */
+export function canonical(req) {
+    const ids = new Ordinals(); // per request — numbering restarts at call_0 every time
+    if (req.kind === 'tool') {
+        return { kind: 'tool', tool_name: req.tool_name, args: normalizeValue(req.args, ids) };
+    }
+    if (req.kind !== 'model') {
+        return { kind: req.kind, counter: req.counter };
+    }
+    const out = {
+        kind: 'model',
+        provider: req.provider,
+        model_id: req.model_id,
+        // Ordinals are assigned in message order, so scrub messages before anything else.
+        messages: normalizeValue(req.messages, ids),
+    };
+    if (req.system_prompt_sha !== undefined)
+        out['system_prompt_sha'] = req.system_prompt_sha;
+    if (req.tool_schemas !== undefined) {
+        // Sorted: the same tool set declared in a different order is the same call.
+        const sorted = [...req.tool_schemas].sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0));
+        out['tool_schemas'] = normalizeValue(sorted, ids);
+    }
+    for (const field of ['response_format', 'temperature', 'top_p', 'top_k', 'seed', 'max_tokens', 'tool_choice']) {
+        const v = req[field];
+        if (v !== undefined && v !== null)
+            out[field] = normalizeValue(v, ids);
+    }
+    return out;
+}
+/** req_hash = sha256(HASH_VERSION ‖ "\x00" ‖ jcs(canonical(request))) */
+export function reqHash(req) {
+    const canonicalJson = canonicalize(canonical(req)); // RFC 8785, sorts and formats
+    if (canonicalJson === undefined)
+        throw new Error('canonicalize returned undefined — non-JSON value in request');
+    // Version prefix means a v3 hash can never equal a v4 hash of the same request.
+    return createHash('sha256').update(`${HASH_VERSION}\x00${canonicalJson}`).digest('hex');
+}
+/**
+ * Canonical digest of any JSON value — the same normalization a request gets.
+ *
+ * This is what `final_state_hash` should be. `JSON.stringify` would make key order look
+ * like a changed outcome, and would put every random message id straight into the
+ * digest, so an identical replay would report a mismatch that never happened.
+ */
+export function stateHash(value) {
+    // normalizeValue scrubs volatile ids to ordinals, so a regenerated UUID is invisible.
+    const canonicalJson = canonicalize(normalizeValue(value, new Ordinals()));
+    if (canonicalJson === undefined)
+        throw new Error('stateHash: value is not JSON');
+    return `sha256:${createHash('sha256').update(`${HASH_VERSION}\x00${canonicalJson}`).digest('hex')}`;
+}

package/dist/types/request.d.ts

@@ -0,0 +1,40 @@
+/**
+ * The shape of a boundary crossing as the SDK observes it, before canonicalization.
+ * `hash.ts` decides which of these fields are identity and which are volatile;
+ * docs/HASHING.md §2 is the authority on that split.
+ */
+export type Message = {
+    role: string;
+    content: unknown;
+    [k: string]: unknown;
+};
+export type ModelRequest = {
+    kind: 'model';
+    provider: string;
+    model_id: string;
+    messages: Message[];
+    /** Hashed separately by the caller so a prompt change is legible in a diff. */
+    system_prompt_sha?: string;
+    tool_schemas?: {
+        name: string;
+        [k: string]: unknown;
+    }[];
+    response_format?: unknown;
+    temperature?: number;
+    top_p?: number;
+    top_k?: number;
+    seed?: number;
+    max_tokens?: number;
+    tool_choice?: unknown;
+};
+export type ToolRequest = {
+    kind: 'tool';
+    tool_name: string;
+    args: unknown;
+};
+/** Clock and RNG hash their logical counter, never the observed value (B3, B4). */
+export type ShimRequest = {
+    kind: 'clock' | 'rng';
+    counter: number;
+};
+export type RewindRequest = ModelRequest | ToolRequest | ShimRequest;

package/dist/types/request.js

@@ -0,0 +1,6 @@
+/**
+ * The shape of a boundary crossing as the SDK observes it, before canonicalization.
+ * `hash.ts` decides which of these fields are identity and which are volatile;
+ * docs/HASHING.md §2 is the authority on that split.
+ */
+export {};

package/dist/types/schema.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Authoritative vocabulary. Names follow docs/DATA_MODEL.md exactly.
+ * No I/O, no network, no filesystem in this package.
+ */
+export declare const STEP_KINDS: readonly ['model', 'tool', 'clock', 'rng', 'human', 'env'];
+export type StepKind = (typeof STEP_KINDS)[number];
+export declare const MATCH_TIERS: readonly ['exact', 'miss', 'recorded'];
+export type MatchTier = (typeof MATCH_TIERS)[number];
+export type RunStatus = 'complete' | 'partial' | 'error';
+/** One execution of one graph, entry to terminal state. */
+export type Run = {
+    run_id: string;
+    thread_id: string;
+    graph_sha: string;
+    code_sha: string;
+    prompt_sha: string;
+    model_cfg: Record<string, unknown>;
+    /** Bigint in the DDL, number here — generate seeds below 2^53 or this lies. */
+    seed: number;
+    flags_snapshot: Record<string, string>;
+    hash_version: number;
+    started_at: string;
+    ended_at: string | null;
+    status: RunStatus;
+    outcome: {
+        final_state_hash: string;
+        [k: string]: unknown;
+    } | null;
+    tokens: number;
+    cost_usd: number;
+    latency_ms: number;
+};
+/** One boundary crossing. Append-only, ordered by `seq` within a run. */
+export type Step = {
+    run_id: string;
+    /** Assigned by the deterministic scheduler, not by arrival order (B6). */
+    seq: number;
+    node: string;
+    kind: StepKind;
+    req_hash: string;
+    /** = req_hash for recorded steps; null for replayed-from-shim. */
+    cassette_ref: string | null;
+    /** Never inferred, never omitted, never defaulted. */
+    match_tier: MatchTier;
+    latency_ms: number;
+    tokens: number | null;
+    cost_usd: number | null;
+    error: unknown | null;
+};
+/** The recorded observation. Immutable, content-addressed, refcounted. */
+export type Cassette = {
+    hash: string;
+    hash_version: number;
+    kind: StepKind;
+    request: string;
+    response: string;
+    chunks: string | null;
+    provider: string | null;
+    model_version: string | null;
+    /** Written in the user's process, before the event leaves it. */
+    redaction_map: Record<string, string>;
+    refcount: number;
+    recorded_at: string;
+};

package/dist/types/schema.js

@@ -0,0 +1,6 @@
+/**
+ * Authoritative vocabulary. Names follow docs/DATA_MODEL.md exactly.
+ * No I/O, no network, no filesystem in this package.
+ */
+export const STEP_KINDS = ['model', 'tool', 'clock', 'rng', 'human', 'env'];
+export const MATCH_TIERS = ['exact', 'miss', 'recorded'];

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@krishnadobhal/rewind-core",
+  "version": "0.1.0",
+  "description": "Content-addressed request hashing and the Run/Step/Cassette schema for Rewind.",
+  "license": "Apache-2.0",
+  "author": "Krishna Dobhal",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/krishnadobhal/Rewind.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/krishnadobhal/Rewind#readme",
+  "bugs": "https://github.com/krishnadobhal/Rewind/issues",
+  "keywords": [
+    "rewind",
+    "hashing",
+    "canonicalization",
+    "jcs",
+    "agents"
+  ],
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./schema": "./dist/types/schema.js",
+    "./request": "./dist/types/request.js",
+    "./hash": "./dist/hash.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "canonicalize": "^2.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.13.3"
+  }
+}