@telepath-computer/autofile 0.0.0-stage → 0.3.0

package/dist/schema.js

@@ -0,0 +1,235 @@
+/**
+ * Registers and checks Autofile's JSON Schemas with the explicitly selected
+ * 2020-12 dialect. The registry is process-global, so schemas are addressed by
+ * content and compiled once even when several store instances read them.
+ */
+import { createHash } from "node:crypto";
+import "@hyperjump/json-schema/formats";
+import { InvalidSchemaError, registerSchema, setMetaSchemaOutputFormat, setShouldValidateFormat, unregisterSchema, validate, } from "@hyperjump/json-schema/draft-2020-12";
+import { addFormat, setFormatHandler } from "@hyperjump/json-schema/experimental";
+import { annotate } from "@hyperjump/json-schema/annotations/experimental";
+import { annotatedWith, annotation, value as instanceValue, } from "@hyperjump/json-schema/annotated-instance/experimental";
+import { JSE } from "@hyperjump/json-schema-errors";
+import { isBlobInput } from "./blobs.js";
+const DIALECT = "https://json-schema.org/draft/2020-12/schema";
+const FORMAT_KEYWORD = "https://json-schema.org/keyword/draft-2020-12/format";
+const BLOB_FORMAT = "https://autofile.dev/formats/blob";
+const knownFormats = new Set([
+    "date-time",
+    "date",
+    "time",
+    "duration",
+    "email",
+    "idn-email",
+    "hostname",
+    "idn-hostname",
+    "ipv4",
+    "ipv6",
+    "uri",
+    "uri-reference",
+    "iri",
+    "iri-reference",
+    "uuid",
+    "uri-template",
+    "json-pointer",
+    "relative-json-pointer",
+    "regex",
+    "blob",
+]);
+const schemaMapKeywords = ["$defs", "properties", "patternProperties", "dependentSchemas"];
+const schemaArrayKeywords = ["allOf", "anyOf", "oneOf", "prefixItems"];
+const schemaKeywords = [
+    "items",
+    "contains",
+    "additionalProperties",
+    "unevaluatedItems",
+    "unevaluatedProperties",
+    "propertyNames",
+    "if",
+    "then",
+    "else",
+    "not",
+    "contentSchema",
+];
+const preparedSchemas = new Map();
+setShouldValidateFormat(true);
+// json-schema-errors augments the package root's TypeScript declarations, but
+// the draft-specific entry point does not expose that augmentation.
+setMetaSchemaOutputFormat(JSE);
+addFormat({
+    id: BLOB_FORMAT,
+    // JSON Schema formats ignore other instance types. Autofile's separate
+    // annotation check gives URI and blob values their stricter string rule.
+    handler: (value) => typeof value !== "string" || isBlobInput(value),
+});
+setFormatHandler(FORMAT_KEYWORD, "blob", BLOB_FORMAT);
+/** Checks that a declaration schema is safe, valid 2020-12 JSON Schema. */
+export async function prepareSchema(schema) {
+    const inspectionErrors = inspectSchema(schema);
+    if (inspectionErrors.length > 0)
+        throw new SchemaRefusal(inspectionErrors);
+    const serialized = JSON.stringify(schema);
+    const digest = createHash("sha256").update(serialized).digest("hex");
+    const schemaUri = `https://autofile.dev/schemas/${digest}`;
+    let prepared = preparedSchemas.get(schemaUri);
+    if (prepared === undefined) {
+        prepared = compileSchema(schema, schemaUri);
+        preparedSchemas.set(schemaUri, prepared);
+        prepared.catch(() => preparedSchemas.delete(schemaUri));
+    }
+    return prepared;
+}
+/** A user-correctable problem in a proposed schema declaration. */
+export class SchemaRefusal extends Error {
+    messages;
+    constructor(messages) {
+        super(messages.join("; "));
+        this.name = "SchemaRefusal";
+        this.messages = messages;
+    }
+}
+async function compileSchema(schema, schemaUri) {
+    let registered = false;
+    try {
+        registerSchema(schema, schemaUri, DIALECT);
+        registered = true;
+        const validator = await validate(schemaUri);
+        const annotator = await annotate(schemaUri);
+        return {
+            validate: (value) => validateValue(validator, annotator, value),
+            formatFields: (value, format) => findFormatFields(annotator, value, format),
+        };
+    }
+    catch (error) {
+        if (registered)
+            unregisterSchema(schemaUri);
+        if (error instanceof InvalidSchemaError) {
+            const output = error.output;
+            throw new SchemaRefusal(formatErrors(output.valid ? [] : output.errors, "schema"));
+        }
+        throw new SchemaRefusal([
+            error instanceof Error ? `schema: ${error.message}` : `schema: ${String(error)}`,
+        ]);
+    }
+}
+function findFormatFields(annotator, value, format) {
+    const fields = [];
+    const annotated = annotator(value);
+    for (const node of annotatedWith(annotated, "format", DIALECT)) {
+        if (!annotation(node, "format", DIALECT).includes(format))
+            continue;
+        const pointer = node.pointer;
+        fields.push({
+            pointer,
+            location: formatInstancePointer(pointer),
+            value: instanceValue(node),
+        });
+    }
+    return fields;
+}
+async function validateValue(validator, annotator, value) {
+    const output = validator(value, {
+        outputFormat: JSE,
+    });
+    if (!output.valid)
+        return formatErrors(output.errors, "");
+    // JSON Schema deliberately ignores `format` for non-strings. Autofile's
+    // field model is stricter: anything annotated as a URI or blob is a string.
+    const annotated = annotator(value);
+    const errors = [];
+    for (const node of annotatedWith(annotated, "format", DIALECT)) {
+        const formats = annotation(node, "format", DIALECT);
+        if (formats.some((format) => format === "uri" || format === "blob")
+            && typeof instanceValue(node) !== "string") {
+            const location = formatInstancePointer(node.pointer);
+            errors.push(location === "" ? "must be a string" : `${location}: must be a string`);
+        }
+    }
+    return errors;
+}
+function inspectSchema(schema) {
+    const errors = [];
+    inspectSubschema(schema, "schema", errors, true, new WeakSet());
+    return errors;
+}
+function inspectSubschema(schema, location, errors, isRoot, inspected) {
+    if (!isObject(schema))
+        return;
+    if (inspected.has(schema))
+        return;
+    inspected.add(schema);
+    if (schema.$schema !== undefined) {
+        if (!isRoot)
+            errors.push(`${location}.$schema: is only allowed at the schema root`);
+        else if (schema.$schema !== DIALECT) {
+            errors.push(`${location}.$schema: must name ${DIALECT}`);
+        }
+    }
+    if (typeof schema.format === "string" && !knownFormats.has(schema.format)) {
+        errors.push(`${location}.format: unknown format ${JSON.stringify(schema.format)}`);
+    }
+    for (const keyword of ["$ref", "$dynamicRef"]) {
+        const reference = schema[keyword];
+        if (typeof reference === "string"
+            && reference !== ""
+            && !reference.startsWith("#")) {
+            errors.push(`${location}.${keyword}: must point within this schema`);
+        }
+    }
+    for (const keyword of schemaMapKeywords) {
+        const schemas = schema[keyword];
+        if (!isObject(schemas))
+            continue;
+        for (const [name, subschema] of Object.entries(schemas)) {
+            inspectSubschema(subschema, `${location}.${keyword}.${name}`, errors, false, inspected);
+        }
+    }
+    for (const keyword of schemaArrayKeywords) {
+        const schemas = schema[keyword];
+        if (!Array.isArray(schemas))
+            continue;
+        schemas.forEach((subschema, index) => {
+            inspectSubschema(subschema, `${location}.${keyword}.${String(index)}`, errors, false, inspected);
+        });
+    }
+    for (const keyword of schemaKeywords) {
+        if (schema[keyword] !== undefined) {
+            inspectSubschema(schema[keyword], `${location}.${keyword}`, errors, false, inspected);
+        }
+    }
+}
+function formatErrors(errors, prefix) {
+    return errors.map((error) => {
+        const location = formatInstanceLocation(error.instanceLocation);
+        const path = [prefix, location].filter((part) => part !== "").join(".");
+        const message = error.message.length === 0
+            ? "does not match the schema"
+            : `${error.message[0]?.toLowerCase() ?? ""}${error.message.slice(1)}`;
+        return path === "" ? message : `${path}: ${message}`;
+    });
+}
+function formatInstanceLocation(location) {
+    const hash = location.indexOf("#");
+    const fragment = hash === -1 ? location : location.slice(hash + 1);
+    if (fragment === "" || fragment === "/")
+        return "";
+    const pointer = decodeURIComponent(fragment).replace(/^\//u, "");
+    return pointer
+        .split("/")
+        .map((part) => part.replaceAll("~1", "/").replaceAll("~0", "~"))
+        .join(".");
+}
+function formatInstancePointer(pointer) {
+    if (pointer === "")
+        return "";
+    const parts = pointer.slice(1).split("/");
+    if (parts.some((part) => part === ""))
+        return pointer;
+    return parts
+        .map((part) => part.replaceAll("~1", "/").replaceAll("~0", "~"))
+        .join(".");
+}
+function isObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,gCAAgC,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,uBAAuB,EACvB,gBAAgB,EAChB,QAAQ,GAET,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,QAAQ,EAAkB,MAAM,iDAAiD,CAAC;AAC3F,OAAO,EACL,aAAa,EACb,UAAU,EACV,KAAK,IAAI,aAAa,GACvB,MAAM,wDAAwD,CAAC;AAChE,OAAO,EAAE,GAAG,EAAoC,MAAM,+BAA+B,CAAC;AAEtF,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,MAAM,OAAO,GAAG,8CAA8C,CAAC;AAC/D,MAAM,cAAc,GAAG,sDAAsD,CAAC;AAC9E,MAAM,WAAW,GAAG,mCAAmC,CAAC;AACxD,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC;IAC3B,WAAW;IACX,MAAM;IACN,MAAM;IACN,UAAU;IACV,OAAO;IACP,WAAW;IACX,UAAU;IACV,cAAc;IACd,MAAM;IACN,MAAM;IACN,KAAK;IACL,eAAe;IACf,KAAK;IACL,eAAe;IACf,MAAM;IACN,cAAc;IACd,cAAc;IACd,uBAAuB;IACvB,OAAO;IACP,MAAM;CACP,CAAC,CAAC;AACH,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;AAC3F,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;AACvE,MAAM,cAAc,GAAG;IACrB,OAAO;IACP,UAAU;IACV,sBAAsB;IACtB,kBAAkB;IAClB,uBAAuB;IACvB,eAAe;IACf,IAAI;IACJ,MAAM;IACN,MAAM;IACN,KAAK;IACL,eAAe;CAChB,CAAC;AACF,MAAM,eAAe,GAAG,IAAI,GAAG,EAAmC,CAAC;AAEnE,uBAAuB,CAAC,IAAI,CAAC,CAAC;AAC9B,8EAA8E;AAC9E,oEAAoE;AACpE,yBAAyB,CAAC,GAAwB,CAAC,CAAC;AACpD,SAAS,CAAC;IACR,EAAE,EAAE,WAAW;IACf,uEAAuE;IACvE,yEAAyE;IACzE,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,WAAW,CAAC,KAAK,CAAC;CACpE,CAAC,CAAC;AACH,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;AAetD,2EAA2E;AAC3E,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAkB;IACpD,MAAM,gBAAgB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAC/C,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAE3E,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrE,MAAM,SAAS,GAAG,gCAAgC,MAAM,EAAE,CAAC;IAC3D,IAAI,QAAQ,GAAG,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,QAAQ,GAAG,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC5C,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACzC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,mEAAmE;AACnE,MAAM,OAAO,aAAc,SAAQ,KAAK;IAC7B,QAAQ,CAAW;IAE5B,YAAY,QAAkB;QAC5B,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,KAAK,UAAU,aAAa,CAAC,MAAkB,EAAE,SAAiB;IAChE,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,CAAC;QACH,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAC3C,UAAU,GAAG,IAAI,CAAC;QAClB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC5C,OAAO;YACL,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC;YAC/D,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC;SAC5E,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU;YAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,KAAK,CAAC,MAA8B,CAAC;YACpD,MAAM,IAAI,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrF,CAAC;QACD,MAAM,IAAI,aAAa,CAAC;YACtB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,WAAW,MAAM,CAAC,KAAK,CAAC,EAAE;SACjF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CACvB,SAAoB,EACpB,KAAgB,EAChB,MAAsB;IAEtB,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/D,IAAI,CAAC,UAAU,CAAS,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,SAAS;QAC5E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC;YACV,OAAO;YACP,QAAQ,EAAE,qBAAqB,CAAC,OAAO,CAAC;YACxC,KAAK,EAAE,aAAa,CAAY,IAAI,CAAC;SACtC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,SAAoB,EACpB,SAAoB,EACpB,KAAgB;IAEhB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE;QAC9B,YAAY,EAAE,GAAwB;KACvC,CAAyB,CAAC;IAC3B,IAAI,CAAC,MAAM,CAAC,KAAK;QAAE,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAE1D,wEAAwE;IACxE,4EAA4E;IAC5E,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACnC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/D,MAAM,OAAO,GAAG,UAAU,CAAS,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5D,IACE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM,CAAC;eAC5D,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,QAAQ,EAC1C,CAAC;YACD,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,QAAQ,oBAAoB,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,MAAkB;IACvC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,OAAO,EAAU,CAAC,CAAC;IACxE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAiB,EACjB,QAAgB,EAChB,MAAgB,EAChB,MAAe,EACf,SAA0B;IAE1B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO;IAC9B,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO;IAClC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEtB,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,8CAA8C,CAAC,CAAC;aAC/E,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,uBAAuB,OAAO,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1E,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,2BAA2B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACrF,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAClC,IACE,OAAO,SAAS,KAAK,QAAQ;eAC1B,SAAS,KAAK,EAAE;eAChB,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAC7B,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,OAAO,iCAAiC,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,SAAS;QACjC,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACxD,gBAAgB,CAAC,SAAS,EAAE,GAAG,QAAQ,IAAI,OAAO,IAAI,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,mBAAmB,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,SAAS;QACtC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;YACnC,gBAAgB,CACd,SAAS,EACT,GAAG,QAAQ,IAAI,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,EACzC,MAAM,EACN,KAAK,EACL,SAAS,CACV,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;QACrC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YAClC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,QAAQ,IAAI,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAqB,EAAE,MAAc;IACzD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,MAAM,QAAQ,GAAG,sBAAsB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAChE,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxE,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;YACxC,CAAC,CAAC,2BAA2B;YAC7B,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACxE,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC;IACvD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,QAAgB;IAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACnE,IAAI,QAAQ,KAAK,EAAE,IAAI,QAAQ,KAAK,GAAG;QAAE,OAAO,EAAE,CAAC;IACnD,MAAM,OAAO,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACjE,OAAO,OAAO;SACX,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SAC/D,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAe;IAC5C,IAAI,OAAO,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;QAAE,OAAO,OAAO,CAAC;IACtD,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SAC/D,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,KAA4B;IAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC"}

package/dist/server.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Builds Autofile's transport-independent MCP server. The store owns all
+ * persistence semantics; this module only describes the protocol surface and
+ * translates plain store values into MCP results.
+ */
+import { McpServer } from "@modelcontextprotocol/server";
+import { type Store } from "./store.js";
+/** Builds one MCP server around a store, without choosing its transport. */
+export declare function buildServer(store: Store): Promise<McpServer>;

package/dist/server.js

@@ -0,0 +1,237 @@
+/**
+ * Builds Autofile's transport-independent MCP server. The store owns all
+ * persistence semantics; this module only describes the protocol surface and
+ * translates plain store values into MCP results.
+ */
+import { createRequire } from "node:module";
+import { fromJsonSchema, McpServer, ProtocolError, ProtocolErrorCode, ResourceNotFoundError, } from "@modelcontextprotocol/server";
+import { isResourceUri, } from "./store.js";
+const SERVER_DESCRIPTION = "Typed records that agents file and retrieve, kept as JSON files in a folder the user owns.";
+const BASE_INSTRUCTIONS = "Autofile is where the user keeps durable information, as typed records. When information should outlive the current task, file it here. Call `list_types` to see the types and what belongs in each, and `get_type` for the schema of one. Search with `find_records` before creating a record, so the same thing is not filed twice. If no type fits, propose a new type to the user and create it only once they agree.";
+const RESOURCE_PAGE_SIZE = 100;
+const packageJson = createRequire(import.meta.url)("../package.json");
+const findRecordsSchema = fromJsonSchema({
+    type: "object",
+    properties: {
+        type: { type: "string", description: "The type to search." },
+        q: {
+            type: "string",
+            description: "Words that must all appear, ignoring case, in the string values of a record at any depth.",
+        },
+        where: {
+            type: "object",
+            description: "Fields to match by value using MongoDB query syntax. An array field matches when any item equals the value, and `null` also matches a missing field. Keys starting with `$`, and the keys `__proto__`, `constructor` and `prototype`, are not supported at any depth or in dotted paths.",
+        },
+        limit: {
+            type: "integer",
+            minimum: 1,
+            maximum: 200,
+            default: 50,
+            description: "The most results the page returns, counting records and entries in `errors`. From 1 to 200; defaults to 50.",
+        },
+        fields: {
+            type: "array",
+            items: { type: "string", minLength: 1 },
+            description: "Top-level fields to return in `value`. All fields are returned when absent; matching still uses the whole record.",
+        },
+        cursor: {
+            type: "string",
+            description: "An opaque cursor returned by the previous page. The next page starts after the last record file that page read, even if that file was deleted.",
+        },
+    },
+    required: ["type"],
+    additionalProperties: false,
+});
+const getRecordSchema = fromJsonSchema({
+    type: "object",
+    properties: { uri: { type: "string", description: "The URI of the record." } },
+    required: ["uri"],
+    additionalProperties: false,
+});
+const createRecordSchema = fromJsonSchema({
+    type: "object",
+    properties: {
+        type: { type: "string", description: "The type of the record." },
+        key: {
+            type: "string",
+            description: "The key of the new record: lowercase letters, digits and hyphens, starting with a letter or digit. Generated when absent.",
+        },
+        record: {
+            type: "object",
+            description: "The full record, which must match the schema of its type. A blob field may hold the absolute path of a local file or a `data:` URI with base64 contents; Autofile stores the file and puts its blob URI in the field.",
+        },
+    },
+    required: ["type", "record"],
+    additionalProperties: false,
+});
+const updateRecordSchema = fromJsonSchema({
+    type: "object",
+    properties: {
+        uri: { type: "string", description: "The URI of the record." },
+        patch: {
+            type: "object",
+            description: "A [JSON Merge Patch](https://www.rfc-editor.org/rfc/rfc7396): fields in the patch are set, a field set to `null` is removed, nested objects are merged, and arrays are replaced whole. A blob field may hold the absolute path of a local file or a `data:` URI with base64 contents; Autofile stores the file and puts its blob URI in the field.",
+        },
+    },
+    required: ["uri", "patch"],
+    additionalProperties: false,
+});
+const deleteRecordSchema = fromJsonSchema({
+    type: "object",
+    properties: { uri: { type: "string", description: "The URI of the record." } },
+    required: ["uri"],
+    additionalProperties: false,
+});
+const listTypesSchema = fromJsonSchema({
+    type: "object",
+    properties: {},
+    additionalProperties: false,
+});
+const getTypeSchema = fromJsonSchema({
+    type: "object",
+    properties: { type: { type: "string", description: "The name of the type." } },
+    required: ["type"],
+    additionalProperties: false,
+});
+const createTypeSchema = fromJsonSchema({
+    type: "object",
+    properties: {
+        type: { type: "string", description: "The name of the type." },
+        description: { type: "string", description: "What belongs in the folder." },
+        schema: { type: "object", description: "The JSON Schema for records of the type." },
+        titleField: {
+            type: "string",
+            description: "A top-level field of the record whose string value is shown as its title.",
+        },
+    },
+    required: ["type", "description", "schema"],
+    additionalProperties: false,
+});
+const updateTypeSchema = fromJsonSchema({
+    type: "object",
+    properties: {
+        type: { type: "string", description: "The name of the type." },
+        description: { type: "string", description: "The new description." },
+        schema: { type: "object", description: "The new JSON Schema." },
+        titleField: {
+            type: ["string", "null"],
+            description: "The new title field; `null` removes it.",
+        },
+    },
+    required: ["type"],
+    additionalProperties: false,
+});
+const deleteTypeSchema = fromJsonSchema({
+    type: "object",
+    properties: { type: { type: "string", description: "The name of the type." } },
+    required: ["type"],
+    additionalProperties: false,
+});
+/** Builds one MCP server around a store, without choosing its transport. */
+export async function buildServer(store) {
+    const { types } = await store.listTypes({});
+    const typeNames = types.map(({ type }) => type).sort();
+    const typeSummary = typeNames.length === 0 ? "none yet" : typeNames.join(", ");
+    const server = new McpServer({
+        name: "autofile",
+        version: packageJson.version,
+        description: SERVER_DESCRIPTION,
+    }, {
+        instructions: `${BASE_INSTRUCTIONS}\n\nTypes: ${typeSummary}. This list was taken when the session began; call \`list_types\` for types created since.`,
+    });
+    server.registerTool("find_records", {
+        description: "Searches the records of one type and returns matching records in URI order. It reads past nonmatching files until the page has `limit` results, reaches 64 KB of JSON, or no files remain; the size cap never prevents the first result. `fields` selects top-level fields to return, while matching uses the whole record. A schema-invalid record is listed in `errors` only when it matches the search; a file that cannot be read or parsed as JSON is always listed. Autofile is where the user keeps durable information.",
+        inputSchema: findRecordsSchema,
+    }, async (input) => toolResult(await store.findRecords(input)));
+    server.registerTool("get_record", {
+        description: "Returns one record by URI: its `uri`, `createdAt` and `updatedAt` times, and `value`. A record that does not match its type is still returned, with what must change in `error`.",
+        inputSchema: getRecordSchema,
+    }, async (input) => toolResult(await store.getRecord(input)));
+    server.registerTool("create_record", {
+        description: "Creates a record and returns its URI. `record` is the full record and must match the schema of its type, which `get_type` returns. `key` is optional and generated when absent. Autofile is where the user keeps durable information.",
+        inputSchema: createRecordSchema,
+    }, async (input, context) => toolResult(await store.createRecord(input, {
+        allowLocalPaths: context.http === undefined,
+    })));
+    server.registerTool("update_record", { description: "Changes a record and returns its URI.", inputSchema: updateRecordSchema }, async (input, context) => toolResult(await store.updateRecord(input, {
+        allowLocalPaths: context.http === undefined,
+    })));
+    server.registerTool("delete_record", {
+        description: "Deletes a record, removes the links to it from other records, and returns its URI.",
+        inputSchema: deleteRecordSchema,
+    }, async (input) => toolResult(await store.deleteRecord(input)));
+    server.registerTool("list_types", {
+        description: "Returns every type, ordered by name, with the URI of its declaration and its description.",
+        inputSchema: listTypesSchema,
+    }, async (input) => toolResult(await store.listTypes(input)));
+    server.registerTool("get_type", { description: "Returns the declaration of a type with its URI added.", inputSchema: getTypeSchema }, async (input) => toolResult(await store.getType(input)));
+    server.registerTool("create_type", { description: "Declares a type and returns the URI of its declaration.", inputSchema: createTypeSchema }, async (input) => toolResult(await store.createType(input)));
+    server.registerTool("update_type", {
+        description: "Replaces the description, schema or title field of a type, or any of them.",
+        inputSchema: updateTypeSchema,
+    }, async (input) => toolResult(await store.updateType(input)));
+    server.registerTool("delete_type", { description: "Deletes a type and returns its URI.", inputSchema: deleteTypeSchema }, async (input) => toolResult(await store.deleteType(input)));
+    // The high-level resource API returns every resource at once. These
+    // handlers stay at the low-level boundary where cursors remain explicit;
+    // the process-level watcher supplies the advertised change notices.
+    server.server.registerCapabilities({ resources: { subscribe: true, listChanged: true } });
+    server.server.setRequestHandler("resources/list", async (request) => {
+        const resources = await store.listResources();
+        const cursor = request.params?.cursor;
+        let start = 0;
+        if (cursor !== undefined) {
+            const previousUri = decodeCursor(cursor);
+            if (previousUri === undefined) {
+                throw new ProtocolError(ProtocolErrorCode.InvalidParams, "Invalid resource cursor");
+            }
+            const nextIndex = resources.findIndex(({ uri }) => uri > previousUri);
+            start = nextIndex < 0 ? resources.length : nextIndex;
+        }
+        const page = resources.slice(start, start + RESOURCE_PAGE_SIZE);
+        const last = page.at(-1);
+        return {
+            resources: page.map(({ lastModified, ...resource }) => ({
+                ...resource,
+                ...(lastModified === undefined ? {} : { annotations: { lastModified } }),
+            })),
+            ...(last !== undefined && start + page.length < resources.length
+                ? { nextCursor: encodeCursor(last.uri) }
+                : {}),
+            ttlMs: 0,
+            cacheScope: "private",
+        };
+    });
+    server.server.setRequestHandler("resources/read", async (request) => {
+        const contents = await store.readResource(request.params.uri);
+        if (contents === undefined)
+            throw new ResourceNotFoundError(request.params.uri);
+        return { contents: [contents], ttlMs: 0, cacheScope: "private" };
+    });
+    return server;
+}
+function toolResult(result) {
+    const body = result;
+    return {
+        content: [{ type: "text", text: JSON.stringify(body) }],
+        structuredContent: body,
+        ...("errors" in body && !("uri" in body) && !("records" in body) ? { isError: true } : {}),
+    };
+}
+function encodeCursor(uri) {
+    return Buffer.from(uri, "utf8").toString("base64url");
+}
+function decodeCursor(cursor) {
+    if (!/^[A-Za-z0-9_-]+$/u.test(cursor))
+        return undefined;
+    const bytes = Buffer.from(cursor, "base64url");
+    if (bytes.toString("base64url") !== cursor)
+        return undefined;
+    try {
+        const uri = new TextDecoder("utf-8", { fatal: true }).decode(bytes);
+        return isResourceUri(uri) ? uri : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EACL,cAAc,EACd,SAAS,EACT,aAAa,EACb,iBAAiB,EACjB,qBAAqB,GAItB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EACL,aAAa,GAYd,MAAM,YAAY,CAAC;AAEpB,MAAM,kBAAkB,GAAG,4FAA4F,CAAC;AACxH,MAAM,iBAAiB,GAAG,2ZAA2Z,CAAC;AACtb,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAC/B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAwB,CAAC;AAE7F,MAAM,iBAAiB,GAAG,cAAc,CAAmB;IACzD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,qBAAqB,EAAE;QAC5D,CAAC,EAAE;YACD,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2FAA2F;SACzG;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,0RAA0R;SACxS;QACD,KAAK,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,6GAA6G;SAC3H;QACD,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;YACvC,WAAW,EAAE,mHAAmH;SACjI;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gJAAgJ;SAC9J;KACF;IACD,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,eAAe,GAAG,cAAc,CAAiB;IACrD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,wBAAwB,EAAE,EAAE;IAC9E,QAAQ,EAAE,CAAC,KAAK,CAAC;IACjB,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,kBAAkB,GAAG,cAAc,CAAoB;IAC3D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,yBAAyB,EAAE;QAChE,GAAG,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2HAA2H;SACzI;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uNAAuN;SACrO;KACF;IACD,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,kBAAkB,GAAG,cAAc,CAAoB;IAC3D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,wBAAwB,EAAE;QAC9D,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oVAAoV;SAClW;KACF;IACD,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;IAC1B,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,kBAAkB,GAAG,cAAc,CAAoB;IAC3D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,wBAAwB,EAAE,EAAE;IAC9E,QAAQ,EAAE,CAAC,KAAK,CAAC;IACjB,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,eAAe,GAAG,cAAc,CAAwB;IAC5D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,EAAE;IACd,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,aAAa,GAAG,cAAc,CAAe;IACjD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE,EAAE;IAC9E,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,gBAAgB,GAAG,cAAc,CAAkB;IACvD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE;QAC9D,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,6BAA6B,EAAE;QAC3E,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,0CAA0C,EAAE;QACnF,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2EAA2E;SACzF;KACF;IACD,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,CAAC;IAC3C,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,gBAAgB,GAAG,cAAc,CAAkB;IACvD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE;QAC9D,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,sBAAsB,EAAE;QACpE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,sBAAsB,EAAE;QAC/D,UAAU,EAAE;YACV,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;YACxB,WAAW,EAAE,yCAAyC;SACvD;KACF;IACD,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AACH,MAAM,gBAAgB,GAAG,cAAc,CAAkB;IACvD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uBAAuB,EAAE,EAAE;IAC9E,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,KAAY;IAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACvD,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/E,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,WAAW,EAAE,kBAAkB;KAChC,EACD;QACE,YAAY,EAAE,GAAG,iBAAiB,cAAc,WAAW,4FAA4F;KACxJ,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,cAAc,EACd;QACE,WAAW,EAAE,igBAAigB;QAC9gB,WAAW,EAAE,iBAAiB;KAC/B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAC5D,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,WAAW,EAAE,kLAAkL;QAC/L,WAAW,EAAE,eAAe;KAC7B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,eAAe,EACf;QACE,WAAW,EAAE,uOAAuO;QACpP,WAAW,EAAE,kBAAkB;KAChC,EACD,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE;QACnE,eAAe,EAAE,OAAO,CAAC,IAAI,KAAK,SAAS;KAC5C,CAAC,CAAC,CACJ,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,eAAe,EACf,EAAE,WAAW,EAAE,uCAAuC,EAAE,WAAW,EAAE,kBAAkB,EAAE,EACzF,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE;QACnE,eAAe,EAAE,OAAO,CAAC,IAAI,KAAK,SAAS;KAC5C,CAAC,CAAC,CACJ,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,eAAe,EACf;QACE,WAAW,EAAE,oFAAoF;QACjG,WAAW,EAAE,kBAAkB;KAChC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAC7D,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,WAAW,EAAE,2FAA2F;QACxG,WAAW,EAAE,eAAe;KAC7B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,UAAU,EACV,EAAE,WAAW,EAAE,uDAAuD,EAAE,WAAW,EAAE,aAAa,EAAE,EACpG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CACxD,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,aAAa,EACb,EAAE,WAAW,EAAE,yDAAyD,EAAE,WAAW,EAAE,gBAAgB,EAAE,EACzG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAC3D,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,aAAa,EACb;QACE,WAAW,EAAE,4EAA4E;QACzF,WAAW,EAAE,gBAAgB;KAC9B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAC3D,CAAC;IACF,MAAM,CAAC,YAAY,CACjB,aAAa,EACb,EAAE,WAAW,EAAE,qCAAqC,EAAE,WAAW,EAAE,gBAAgB,EAAE,EACrF,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAC3D,CAAC;IAEF,oEAAoE;IACpE,yEAAyE;IACzE,oEAAoE;IACpE,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAC1F,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAgC,EAAE;QAChG,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;QACtC,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,MAAM,IAAI,aAAa,CAAC,iBAAiB,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;YACtF,CAAC;YACD,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC;YACtE,KAAK,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACvD,CAAC;QAED,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,kBAAkB,CAAC,CAAC;QAChE,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;gBACtD,GAAG,QAAQ;gBACX,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,YAAY,EAAE,EAAE,CAAC;aACzE,CAAC,CAAC;YACH,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM;gBAC9D,CAAC,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACxC,CAAC,CAAC,EAAE,CAAC;YACP,KAAK,EAAE,CAAC;YACR,UAAU,EAAE,SAAS;SACtB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAA+B,EAAE;QAC/F,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAI,QAAQ,KAAK,SAAS;YAAE,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChF,OAAO,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,UAAU,CAAC,MAAc;IAChC,MAAM,IAAI,GAAG,MAAoB,CAAC;IAClC,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,iBAAiB,EAAE,IAAI;QACvB,GAAG,CAAC,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3F,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,GAAW;IAC/B,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,YAAY,CAAC,MAAc;IAClC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IACxD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC/C,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,MAAM;QAAE,OAAO,SAAS,CAAC;IAC7D,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpE,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC"}

package/dist/store.d.ts

@@ -0,0 +1,132 @@
+/**
+ * Reads and writes Autofile's on-disk types and records, and exposes recognized
+ * records, declarations, and blobs as plain resource data. Each operation reads
+ * current files and keeps protocol-specific behavior outside the store.
+ */
+import type { JsonObject } from "./json.js";
+export type { JsonObject, JsonPrimitive, JsonValue } from "./json.js";
+export interface StoreError {
+    uri?: string;
+    message: string;
+}
+export interface Refusal {
+    errors: StoreError[];
+}
+export interface OpenStoreOptions {
+    dataFolder?: string;
+    writeLockPath?: string;
+}
+/** Transport-sensitive permissions for a record write. */
+export interface RecordWriteOptions {
+    allowLocalPaths?: boolean;
+}
+export interface Store {
+    findRecords(input: FindRecordsInput): Promise<FindRecordsResult | Refusal>;
+    getRecord(input: GetRecordInput): Promise<RecordResult | Refusal>;
+    createRecord(input: CreateRecordInput, options?: RecordWriteOptions): Promise<UriResult | Refusal>;
+    updateRecord(input: UpdateRecordInput, options?: RecordWriteOptions): Promise<UriResult | Refusal>;
+    deleteRecord(input: DeleteRecordInput): Promise<UriResult | Refusal>;
+    listTypes(input: Record<string, never>): Promise<ListTypesResult>;
+    getType(input: GetTypeInput): Promise<TypeResult | Refusal>;
+    createType(input: CreateTypeInput): Promise<UriResult | Refusal>;
+    updateType(input: UpdateTypeInput): Promise<UpdateTypeResult | Refusal>;
+    deleteType(input: DeleteTypeInput): Promise<UriResult | Refusal>;
+    listResources(): Promise<StoreResource[]>;
+    getResourceMetadata(uri: string): Promise<StoreResource | undefined>;
+    listResourceFolder(folder: string): Promise<StoreResource[]>;
+    listTypeResources(type: string): Promise<StoreResource[]>;
+    readResource(uri: string): Promise<StoreResourceContents | undefined>;
+}
+export interface FindRecordsInput {
+    type: string;
+    q?: string;
+    where?: JsonObject;
+    limit?: number;
+    fields?: string[];
+    cursor?: string;
+}
+export interface GetRecordInput {
+    uri: string;
+}
+export interface CreateRecordInput {
+    type: string;
+    key?: string;
+    record: JsonObject;
+}
+export interface UpdateRecordInput {
+    uri: string;
+    patch: JsonObject;
+}
+export interface DeleteRecordInput {
+    uri: string;
+}
+export interface GetTypeInput {
+    type: string;
+}
+export interface CreateTypeInput {
+    type: string;
+    description: string;
+    schema: JsonObject;
+    titleField?: string;
+}
+export interface UpdateTypeInput {
+    type: string;
+    description?: string;
+    schema?: JsonObject;
+    titleField?: string | null;
+}
+export interface DeleteTypeInput {
+    type: string;
+}
+export interface UriResult {
+    uri: string;
+}
+export interface FindRecordsResult {
+    records: RecordResult[];
+    errors: StoreError[];
+    cursor?: string;
+}
+export interface RecordResult extends UriResult {
+    createdAt: string;
+    updatedAt: string;
+    value: JsonObject;
+    error?: string;
+}
+export interface TypeSummary extends UriResult {
+    type: string;
+    description: string;
+}
+export interface ListTypesResult {
+    types: TypeSummary[];
+}
+export interface TypeResult extends UriResult {
+    description: string;
+    schema: JsonObject;
+    titleField?: string;
+}
+export interface UpdateTypeResult extends UriResult {
+    errors: StoreError[];
+}
+/** Plain metadata for one resource recognized in the data folder. */
+export interface StoreResource extends UriResult {
+    name: string;
+    mimeType: string;
+    title?: string;
+    description?: string;
+    size?: number;
+    lastModified?: string;
+}
+/** Exact contents of a recognized text or binary resource. */
+export type StoreResourceContents = {
+    uri: string;
+    mimeType: string;
+    text: string;
+} | {
+    uri: string;
+    mimeType: string;
+    blob: string;
+};
+/** Opens a store, creating its data folder when it does not exist. */
+export declare function openStore(options?: OpenStoreOptions): Promise<Store>;
+/** Returns whether a string is the canonical URI of an Autofile resource. */
+export declare function isResourceUri(uri: string): boolean;