@abloatai/ablo 0.36.0 → 0.37.0

package/dist/core/index.js

@@ -1,48 +0,0 @@
-/**
- * The framework-extension entry point of this package. Import from here only
- * when you are building on top of the sync engine — wiring your own store and
- * provider stack, writing a sync adapter, or driving a test harness. Everyday
- * application code should use the `Ablo({ schema })` client from the package
- * root instead; the primitives exported here are lower-level building blocks.
- *
- * The surface is deliberately narrow: it exposes only the types and classes an
- * extension actually needs. Anything the engine does not export here is
- * internal and may change.
- */
-// The base store class, plus the constructor shapes that subclasses reference.
-export { BaseSyncedStore, } from '../BaseSyncedStore.js';
-// Core infrastructure classes
-export { SyncClient } from '../SyncClient.js';
-export { Database } from '../Database.js';
-export { InstanceCache, ModelScope } from '../InstanceCache.js';
-/** @deprecated `ObjectPool` was renamed to {@link InstanceCache} — the class is an
- *  identity-map cache of live model instances, not a reuse pool. This alias keeps existing
- *  imports working and will be removed in a future major version. */
-export { InstanceCache as ObjectPool } from '../InstanceCache.js';
-export { Model } from '../Model.js';
-export { LazyReferenceCollection, } from '../LazyReferenceCollection.js';
-export { ModelRegistry, getActiveRegistry, } from '../ModelRegistry.js';
-// A lower-level network read primitive. Prefer `ablo.<model>.list(...)` for
-// ordinary reads; reach for this only when writing a custom on-demand loader.
-export { postQuery } from '../query/client.js';
-// Computes a dependency-safe ordering for a set of models by walking their
-// foreign-key relationships, so writes commit parents before children. Used by
-// schema-aware test fixtures and scaffolding tools.
-export { computeFKDepthPriority } from '../client/schemaConfig.js';
-// The sync layer: the WebSocket wrapper and the delta shape it carries. Needed
-// when writing a sync adapter or a multi-participant test harness.
-export { SyncWebSocket, } from '../sync/SyncWebSocket.js';
-export { BootstrapFetcher } from '../sync/BootstrapFetcher.js';
-/** @deprecated `BootstrapHelper` was renamed to {@link BootstrapFetcher}. This alias keeps
- *  existing imports working and will be removed in a future major version. */
-export { BootstrapFetcher as BootstrapHelper } from '../sync/BootstrapFetcher.js';
-// The lower-level claim-coordination primitives behind the `ablo.<model>.claim`
-// API. `createClaimStream` builds the announce-and-await machinery on top of a
-// `SyncWebSocket`; `awaitClaimGrant` coordinates fair, first-in-first-out
-// grants. These are for extension code and test harnesses; ordinary
-// application code should use `ablo.<model>.claim`.
-export { createClaimStream, } from '../sync/createClaimStream.js';
-export { awaitClaimGrant, } from '../sync/awaitClaimGrant.js';
-// An enum naming the strategies for loading a model's data. Referenced when
-// registering models in extension code.
-export { LoadStrategy } from '../transaction/types/index.js';

package/dist/docs/catalog.d.ts

@@ -1,72 +0,0 @@
-/**
- * The catalog of documentation this package ships.
- *
- * One definition of *which docs exist*, read from the files themselves. Every
- * reader — `ablo docs`, the public `/api/docs/*` routes, the MCP docs tools —
- * resolves through here rather than keeping its own list, because a
- * hand-maintained index of a directory is a copy that drifts the moment a page
- * is added and nothing fails when it does. Before this module the public web
- * allowlist had fallen 21 pages behind the corpus, including `coordination`.
- *
- * Title and description are DERIVED from each file's own convention: an H1,
- * then a one-paragraph blockquote stating what the page is for. That blockquote
- * is the description everywhere it is needed — the site frontmatter lifts the
- * same line — so a page states its own promise exactly once, in the source that
- * ships in the npm tarball and still reads correctly as plain markdown.
- *
- * The published set mirrors the tarball's `files` globs (`docs/*.md`,
- * `docs/examples/*.md`, plus the three root files). Anything else under `docs/`
- * — `docs/internal/**` above all — is neither shipped nor catalogued, and that
- * exclusion is the only thing keeping internal notes off the public routes now
- * that they read from here.
- */
-/** Where a page sits in the corpus, and how a reader should group it. */
-export type DocKind = 'guide' | 'example' | 'package';
-/** One documentation page, as shipped. */
-export interface DocEntry {
-    /** Stable reference: `quickstart`, `examples/nextjs`, `agents`. */
-    readonly slug: string;
-    /** Human-readable title — the file's H1, or curated for the root files. */
-    readonly title: string;
-    /** One line stating what the page is for — the file's promise blockquote. */
-    readonly description: string;
-    readonly kind: DocKind;
-    /** Absolute path on disk. */
-    readonly path: string;
-    readonly mime: string;
-}
-/**
- * Read the catalog from a package root — the directory holding `docs/` and the
- * three root files.
- *
- * The root is a parameter rather than resolved here because each reader knows
- * it differently and they are genuinely different facts: the CLI resolves it
- * against its own bundle inside `node_modules`, while the web app resolves it
- * against the monorepo checkout. Nothing is cached; callers that serve many
- * requests should memoize the returned array.
- */
-export declare function readDocsCatalog(packageRoot: string): Promise<DocEntry[]>;
-/**
- * Pull a page's title and promise line out of its markdown.
- *
- * The convention every page follows: an H1, then a blockquote paragraph saying
- * what the page is for. A page missing either simply reports what it has — the
- * catalog never invents prose.
- */
-export declare function parseDocHeader(body: string): {
-    readonly title: string | null;
-    readonly description: string;
-};
-/**
- * Resolve a reference to a page. Accepts the slug (`coordination`), a curated
- * alias (`storage`), or a repo-relative path (`docs/coordination.md`,
- * `AGENTS.md`) — the three forms readers actually arrive with. Returns null
- * rather than throwing so a caller can render its own not-found.
- */
-export declare function findDoc(catalog: readonly DocEntry[], reference: string): DocEntry | null;
-/**
- * Slugs closest to a miss, for a "did you mean" line. Ranks by shared prefix,
- * then substring containment — enough to catch a typo or a half-remembered
- * name without pulling in a distance library.
- */
-export declare function suggestSlugs(catalog: readonly DocEntry[], reference: string, limit?: number): string[];

package/dist/docs/catalog.js

@@ -1,230 +0,0 @@
-/**
- * The catalog of documentation this package ships.
- *
- * One definition of *which docs exist*, read from the files themselves. Every
- * reader — `ablo docs`, the public `/api/docs/*` routes, the MCP docs tools —
- * resolves through here rather than keeping its own list, because a
- * hand-maintained index of a directory is a copy that drifts the moment a page
- * is added and nothing fails when it does. Before this module the public web
- * allowlist had fallen 21 pages behind the corpus, including `coordination`.
- *
- * Title and description are DERIVED from each file's own convention: an H1,
- * then a one-paragraph blockquote stating what the page is for. That blockquote
- * is the description everywhere it is needed — the site frontmatter lifts the
- * same line — so a page states its own promise exactly once, in the source that
- * ships in the npm tarball and still reads correctly as plain markdown.
- *
- * The published set mirrors the tarball's `files` globs (`docs/*.md`,
- * `docs/examples/*.md`, plus the three root files). Anything else under `docs/`
- * — `docs/internal/**` above all — is neither shipped nor catalogued, and that
- * exclusion is the only thing keeping internal notes off the public routes now
- * that they read from here.
- */
-import { readdir, readFile } from 'node:fs/promises';
-import { basename, join } from 'node:path';
-const MARKDOWN_MIME = 'text/markdown; charset=utf-8';
-const TEXT_MIME = 'text/plain; charset=utf-8';
-/**
- * The three files that document the package itself rather than a topic. They
- * live at the package root, not under `docs/`, and none follows the H1 +
- * blockquote convention — `llms.txt` opens with a prose paragraph and
- * `README.md` with a banner — so their titles and descriptions are curated
- * here, the one place that knows they are a different kind of artifact.
- *
- * Their slug is their filename, because the filename IS how these are referred
- * to everywhere (`AGENTS.md` is an ecosystem convention, not a topic name) and
- * because a bare word would collide: `docs/agents.md` is a published guide that
- * the docs index cross-links as `agents`, and whichever of the two won that
- * name would silently shadow the other. Friendlier spellings are aliases below.
- */
-const PACKAGE_FILES = [
-    {
-        filename: 'AGENTS.md',
-        title: 'AGENTS.md',
-        description: 'The playbook a coding agent follows to install and drive Ablo without hanging on a prompt.',
-        mime: MARKDOWN_MIME,
-    },
-    {
-        filename: 'README.md',
-        title: 'README',
-        description: 'Package overview — what Ablo is and the shape of the API.',
-        mime: MARKDOWN_MIME,
-    },
-    {
-        filename: 'llms.txt',
-        title: 'llms.txt',
-        description: 'The curated single-file index of the whole API, for machine readers.',
-        mime: TEXT_MIME,
-    },
-];
-/**
- * Curated redirects for references that are not a slug: the friendly spellings
- * of the root files, plus the renames the public URLs carried before this
- * module existed, kept so old links and any agent working from a cached page
- * still resolve. Identity mappings are NOT listed — a slug resolves to itself
- * by derivation, and restating the other 30 here would rebuild the
- * hand-maintained list this module exists to delete.
- */
-const SLUG_ALIASES = {
-    readme: 'README.md',
-    overview: 'README.md',
-    llms: 'llms.txt',
-    storage: 'data-sources',
-    'docs/storage.md': 'data-sources',
-};
-/**
- * Read the catalog from a package root — the directory holding `docs/` and the
- * three root files.
- *
- * The root is a parameter rather than resolved here because each reader knows
- * it differently and they are genuinely different facts: the CLI resolves it
- * against its own bundle inside `node_modules`, while the web app resolves it
- * against the monorepo checkout. Nothing is cached; callers that serve many
- * requests should memoize the returned array.
- */
-export async function readDocsCatalog(packageRoot) {
-    const docsDir = join(packageRoot, 'docs');
-    const entries = [];
-    entries.push(...(await readDocsDirectory(docsDir, 'guide')));
-    entries.push(...(await readDocsDirectory(join(docsDir, 'examples'), 'example')));
-    for (const file of PACKAGE_FILES) {
-        const path = join(packageRoot, file.filename);
-        const body = await readFileOrNull(path);
-        if (body === null)
-            continue;
-        entries.push({
-            slug: file.filename,
-            title: file.title,
-            description: file.description,
-            kind: 'package',
-            path,
-            mime: file.mime,
-        });
-    }
-    return entries.sort((a, b) => a.slug.localeCompare(b.slug));
-}
-/**
- * Read one flat directory of markdown. Deliberately non-recursive: the shipped
- * set is `docs/*.md` plus `docs/examples/*.md`, so descending would catalogue
- * `docs/internal/**` — notes that are not in the tarball and must not reach a
- * public route.
- */
-async function readDocsDirectory(dir, kind) {
-    let names;
-    try {
-        const found = await readdir(dir, { withFileTypes: true });
-        names = found.filter((e) => e.isFile() && e.name.endsWith('.md')).map((e) => e.name);
-    }
-    catch {
-        return [];
-    }
-    const entries = [];
-    for (const name of names) {
-        const path = join(dir, name);
-        const body = await readFileOrNull(path);
-        if (body === null)
-            continue;
-        const stem = basename(name, '.md');
-        const { title, description } = parseDocHeader(body);
-        entries.push({
-            slug: kind === 'example' ? `examples/${stem}` : stem,
-            title: title ?? stem,
-            description,
-            kind,
-            path,
-            mime: MARKDOWN_MIME,
-        });
-    }
-    return entries;
-}
-/** The H1 a page opens with, and the blockquote paragraph that follows it. */
-const H1_LINE = /^#[ \t]+(.+?)[ \t]*$/m;
-const PROMISE_BLOCKQUOTE = /^\s*\n((?:>.*\n)+)/;
-/**
- * Pull a page's title and promise line out of its markdown.
- *
- * The convention every page follows: an H1, then a blockquote paragraph saying
- * what the page is for. A page missing either simply reports what it has — the
- * catalog never invents prose.
- */
-export function parseDocHeader(body) {
-    const heading = H1_LINE.exec(body);
-    const title = heading?.[1] ?? null;
-    const afterHeading = heading === null ? body : body.slice(heading.index + heading[0].length);
-    const promise = PROMISE_BLOCKQUOTE.exec(afterHeading);
-    const description = promise?.[1]
-        ?.split('\n')
-        .filter(Boolean)
-        .map((line) => line.replace(/^>\s?/, ''))
-        .join(' ')
-        .trim() ?? '';
-    return { title, description };
-}
-/**
- * Resolve a reference to a page. Accepts the slug (`coordination`), a curated
- * alias (`storage`), or a repo-relative path (`docs/coordination.md`,
- * `AGENTS.md`) — the three forms readers actually arrive with. Returns null
- * rather than throwing so a caller can render its own not-found.
- */
-export function findDoc(catalog, reference) {
-    const trimmed = reference.trim();
-    if (trimmed === '')
-        return null;
-    const direct = matchSlug(catalog, trimmed);
-    if (direct)
-        return direct;
-    const aliased = SLUG_ALIASES[trimmed.toLowerCase()];
-    if (aliased) {
-        const target = matchSlug(catalog, aliased);
-        if (target)
-            return target;
-    }
-    // Path form: `docs/coordination.md`, `docs/examples/nextjs.md`, `llms.txt`.
-    const asSlug = trimmed
-        .replace(/^\.?\//, '')
-        .replace(/^docs\//, '')
-        .replace(/\.(md|txt)$/i, '');
-    return matchSlug(catalog, asSlug);
-}
-function matchSlug(catalog, slug) {
-    const needle = slug.toLowerCase();
-    return catalog.find((entry) => entry.slug.toLowerCase() === needle) ?? null;
-}
-/**
- * Slugs closest to a miss, for a "did you mean" line. Ranks by shared prefix,
- * then substring containment — enough to catch a typo or a half-remembered
- * name without pulling in a distance library.
- */
-export function suggestSlugs(catalog, reference, limit = 3) {
-    const needle = reference.trim().toLowerCase();
-    if (needle === '')
-        return [];
-    return catalog
-        .map((entry) => {
-        const slug = entry.slug.toLowerCase();
-        let score = 0;
-        if (slug.includes(needle) || needle.includes(slug))
-            score += 10;
-        score += sharedPrefixLength(slug, needle);
-        return { slug: entry.slug, score };
-    })
-        .filter(({ score }) => score > 2)
-        .sort((a, b) => b.score - a.score)
-        .slice(0, limit)
-        .map(({ slug }) => slug);
-}
-function sharedPrefixLength(a, b) {
-    const max = Math.min(a.length, b.length);
-    let i = 0;
-    while (i < max && a[i] === b[i])
-        i += 1;
-    return i;
-}
-async function readFileOrNull(path) {
-    try {
-        return await readFile(path, 'utf8');
-    }
-    catch {
-        return null;
-    }
-}

package/dist/docs/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * Programmatic access to the documentation this package ships.
- *
- * The docs travel in the npm tarball beside the code they describe, so a reader
- * that resolves them through here is reading the pages for the version actually
- * installed — not whatever the website is serving today. That is the whole
- * point of the subpath: a published version is frozen, its docs are frozen with
- * it, and `retrieve` never turns back into `get` behind a pinned dependency.
- */
-export { readDocsCatalog, findDoc, parseDocHeader, suggestSlugs, type DocEntry, type DocKind, } from './catalog.js';

package/dist/docs/index.js

@@ -1,10 +0,0 @@
-/**
- * Programmatic access to the documentation this package ships.
- *
- * The docs travel in the npm tarball beside the code they describe, so a reader
- * that resolves them through here is reading the pages for the version actually
- * installed — not whatever the website is serving today. That is the whole
- * point of the subpath: a published version is frozen, its docs are frozen with
- * it, and `retrieve` never turns back into `get` behind a pinned dependency.
- */
-export { readDocsCatalog, findDoc, parseDocHeader, suggestSlugs, } from './catalog.js';

package/dist/environment.d.ts

@@ -1 +0,0 @@
-export * from './transaction/environment.js';

package/dist/environment.js

@@ -1,8 +0,0 @@
-// Moved to @ablo/transaction (ADR 0013 — the settlement core extraction).
-// This shim re-exports it at the original path so in-package importers of
-// `../environment.js` keep working; rewire to `@ablo/transaction/environment`
-// and delete this shim once the core package is fully wired.
-//
-// Line comments on purpose: tsc copies a leading JSDoc block into the
-// published `.d.ts`, and this note names a package npm has never heard of.
-export * from './transaction/environment.js';