@agentshouse/mdruntime 0.1.0-cfbf80d8d4644 → 0.1.0-cfcf93be6310b

package/dist/query.js

@@ -1,17 +1,45 @@
+import { pointerFacts, } from '@agentshouse/mdmodel';
 import { referenceField } from './model.js';
 import { normalize } from './paths.js';
+import { decodedCursor } from './windows.js';
+export function bodied(shape) {
+    return shape.sections !== null || shape.preamble || shape.markdown;
+}
 export class QueryError extends Error {
+    code;
+    retryable = false;
     constructor(code, at, problem) {
         super(`${code} at ${at}: ${problem}`);
+        this.code = code;
     }
 }
 const RANGE = ['$gt', '$gte', '$lt', '$lte'];
 const SINGLE = ['$eq', '$ne', '$in', '$nin', '$all', '$size', '$exists'];
-const FILTER = ['rooms', 'types', 'where', 'pathPrefix', 'hop', 'backlinks'];
+const FILTER = [
+    'rooms',
+    'types',
+    'where',
+    'pathPrefix',
+    'folder',
+    'paths',
+    'hop',
+    'backlinks',
+    'text',
+];
 const RELATED = ['types', 'where', 'pathPrefix', 'field'];
-const PARTS = ['fields', 'sections', 'preamble', 'markdown', 'backlinks', 'change'];
+const PARTS = [
+    'fields',
+    'sections',
+    'preamble',
+    'markdown',
+    'backlinks',
+    'change',
+    'fileId',
+    'revision',
+];
 const ORDER = ['by', 'direction', 'nulls', 'stringSort', 'locale', 'localeOptions'];
 const CALENDAR_DATE = /^(\d{4})-(\d{2})-(\d{2})$/;
+const STRAY_ESCAPE = /~(?![01])/u;
 export function invalid(at, problem) {
     throw new QueryError('invalid-query', at, problem);
 }
@@ -55,6 +83,18 @@ function names(input, at) {
         invalid(at, 'expects a list of names');
     return [...new Set(listed)].sort();
 }
+function pathsOf(input) {
+    const listed = list(input, 'paths');
+    if (listed.some((item) => typeof item !== 'string' || item === '' || normalize(item) !== item)) {
+        invalid('paths', 'expects a list of Paths');
+    }
+    return [...new Set(listed)].sort();
+}
+function phrase(input) {
+    if (typeof input !== 'string' || input === '')
+        invalid('text', 'expects a phrase');
+    return input;
+}
 function directory(input, at) {
     if (typeof input !== 'string' || normalize(input) !== input) {
         invalid(at, 'expects a normalized directory');
@@ -109,23 +149,46 @@ function typing(facts, rooms, types, at) {
         types: types === null ? declared : declared.filter((type) => types.includes(type.name)),
     };
 }
-function specs(typed, field, at) {
-    const declared = typed.types.flatMap((type) => Object.hasOwn(type.fields, field) ? [type.fields[field]] : []);
+function pointer(input, at) {
+    if (typeof input !== 'string' || !input.startsWith('/') || STRAY_ESCAPE.test(input)) {
+        invalid(at, 'expects a JSON Pointer');
+    }
+    return input;
+}
+function specs(typed, input, at) {
+    const field = pointer(input, at);
+    const declared = typed.types.flatMap((type) => {
+        const spec = pointerFacts(type, field);
+        return spec === undefined ? [] : [spec];
+    });
     if (declared.length === 0 && !typed.untyped) {
         throw new QueryError('unknown-field', at, `no MD Type it reads declares ${field}`);
     }
-    return declared;
+    if (!declared.some((spec) => spec.conditional))
+        return declared;
+    return declared.map((spec) => ({
+        facts: { prose: false },
+        through: several(spec),
+        conditional: true,
+    }));
+}
+function several(spec) {
+    return spec.through || spec.facts.type === 'array';
+}
+function single(spec) {
+    return spec.facts.type !== undefined && spec.facts.type !== 'array';
+}
+function every(declared, holds) {
+    return declared.length > 0 && declared.every(holds);
 }
 function kind(declared, checked, at) {
-    if (checked === null || declared.length === 0 || declared.some((spec) => fits(spec, checked))) {
+    if (checked === null ||
+        declared.length === 0 ||
+        declared.some((spec) => fits(spec.facts, checked))) {
         return;
     }
     throw new QueryError('wrong-kind', at, `${JSON.stringify(checked)} is not of its field's kind`);
 }
-function listed(declared, list) {
-    return (declared.length > 0 &&
-        declared.every((facts) => facts.type !== undefined && (facts.type === 'array') === list));
-}
 function test(declared, input, at) {
     if (!plain(input)) {
         const equal = value(input, at);
@@ -139,8 +202,11 @@ function test(declared, input, at) {
         const stray = operators.find((operator) => !RANGE.includes(operator));
         if (stray !== undefined)
             invalid(place(at, stray), 'cannot join a range');
-        if (listed(declared, true))
+        if (every(declared, (spec) => spec.facts.type === 'array'))
             invalid(at, 'a range on a list');
+        if (every(declared, (spec) => spec.facts.type === 'boolean' || spec.facts.type === 'object')) {
+            throw new QueryError('wrong-kind', at, 'its field does not compare in order');
+        }
         return {
             op: 'range',
             bounds: RANGE.filter((operator) => operators.includes(operator)).map((operator) => {
@@ -173,7 +239,7 @@ function test(declared, input, at) {
             return { op: 'nin', values: compared };
         if (compared.includes(null))
             invalid(where, 'a list holds no null');
-        if (listed(declared, false))
+        if (every(declared, single))
             invalid(where, 'the field is not a list');
         return { op: 'all', values: compared };
     }
@@ -181,7 +247,7 @@ function test(declared, input, at) {
         if (!Number.isSafeInteger(operand) || operand < 0) {
             invalid(where, 'expects a nonnegative integer');
         }
-        if (listed(declared, false))
+        if (every(declared, single))
             invalid(where, 'the field is not a list');
         return { op: 'size', size: operand };
     }
@@ -194,7 +260,7 @@ function condition(typed, input, at) {
         invalid(at, 'expects an object of field predicates');
     const conditions = [];
     for (const name of Object.keys(input).sort()) {
-        const where = place(at, name);
+        const where = name.startsWith('/') ? `${at}${name}` : place(at, name);
         const entry = input[name];
         if (name === '$and' || name === '$or') {
             const nested = list(entry, where).map((item, index) => condition(typed, item, `${where}[${index}]`));
@@ -224,11 +290,11 @@ function scope(facts, rooms, input, at) {
     };
 }
 function referenceName(typed, field, at) {
-    if (typeof field !== 'string')
-        invalid(at, 'expects a field name');
     const declared = specs(typed, field, at);
-    if (declared.length > 0 && !declared.some(referenceField))
+    if (declared.length > 0 &&
+        !declared.some((spec) => spec.conditional || referenceField(spec.facts))) {
         invalid(at, 'not a reference field');
+    }
     return field;
 }
 function hopOf(facts, rooms, root, input) {
@@ -248,13 +314,16 @@ function backlinksOf(facts, rooms, input) {
     return { types, where, pathPrefix, field };
 }
 function keyPlan(typed, input, at, path) {
-    if (input === 'room' || input === 'type' || (path && input === 'path'))
+    if (input === 'room' || input === 'type' || input === 'folder' || (path && input === 'path')) {
         return { of: input };
-    if (plain(input) && typeof input.field === 'string' && Object.keys(input).length === 1) {
-        specs(typed, input.field, place(at, 'field'));
+    }
+    if (plain(input) && Object.hasOwn(input, 'field') && Object.keys(input).length === 1) {
+        if (specs(typed, input.field, place(at, 'field')).some(several)) {
+            invalid(place(at, 'field'), 'a path that can hold several values');
+        }
         return { of: 'field', field: input.field };
     }
-    return invalid(at, path ? 'expects room, path, type or a field' : 'expects room, type or a field');
+    return invalid(at, path ? 'expects room, path, type, folder or a field' : 'expects room, type, folder or a field');
 }
 function direction(input, at) {
     if (input === undefined)
@@ -309,14 +378,14 @@ function parts(typed, input, at, fields) {
         return 'all';
     const named = list(input, at);
     named.forEach((name, index) => {
-        if (typeof name !== 'string')
-            invalid(`${at}[${index}]`, 'expects a name');
         if (fields)
             specs(typed, name, `${at}[${index}]`);
+        else if (typeof name !== 'string')
+            invalid(`${at}[${index}]`, 'expects a name');
     });
     return named;
 }
-function flag(input, at) {
+export function flag(input, at) {
     if (input === undefined)
         return false;
     if (input !== true)
@@ -344,6 +413,8 @@ function documentShape(typed, input) {
             markdown: true,
             backlinks: true,
             change: true,
+            fileId: true,
+            revision: true,
             orderBy,
         };
     }
@@ -358,6 +429,8 @@ function documentShape(typed, input) {
         markdown: flag(select.markdown, 'select.markdown'),
         backlinks: flag(select.backlinks, 'select.backlinks'),
         change: flag(select.change, 'select.change'),
+        fileId: flag(select.fileId, 'select.fileId'),
+        revision: flag(select.revision, 'select.revision'),
         orderBy,
     };
 }
@@ -388,20 +461,37 @@ export function planOf(input, facts, reach = null) {
         invalid('select', 'a grouped query selects nothing');
     if (!grouped && input.select === undefined)
         invalid('select', 'a Document query must select');
-    known(input, [...FILTER, 'orderBy', 'limit', grouped ? 'groupBy' : 'select'], '');
+    known(input, [...FILTER, 'orderBy', 'limit', 'after', 'total', grouped ? 'groupBy' : 'select'], '');
     const limit = limitOf(input.limit);
     const rooms = input.rooms === undefined ? null : names(input.rooms, 'rooms');
     const { typed, ...root } = scope(facts, rooms, input, '');
+    const shape = grouped ? groupShape(typed, input) : documentShape(typed, input);
     return {
+        key: queryKey(input),
         rooms,
         reach,
+        locked: [],
         root,
+        folder: input.folder === undefined ? null : directory(input.folder, 'folder'),
+        paths: input.paths === undefined ? null : pathsOf(input.paths),
         hop: input.hop === undefined ? null : hopOf(facts, rooms, typed, input.hop),
         backlinks: input.backlinks === undefined ? null : backlinksOf(facts, rooms, input.backlinks),
-        shape: grouped ? groupShape(typed, input) : documentShape(typed, input),
+        text: input.text === undefined ? null : phrase(input.text),
+        shape,
         limit,
+        after: continuationOf(input.after, shape.orderBy.length + 1),
+        total: flag(input.total, 'total'),
     };
 }
+function continuationOf(input, arity) {
+    if (input === undefined)
+        return null;
+    const values = typeof input === 'string' ? decodedCursor(input) : null;
+    if (values === null || (values.length !== 0 && values.length !== arity)) {
+        invalid('after', 'expects the next an earlier result of this query returned');
+    }
+    return { text: input, values: values.length === 0 ? null : values };
+}
 export function limitOf(input) {
     if (input === undefined)
         return null;
@@ -416,6 +506,9 @@ export function filterOf(input, facts, reach = null) {
     known(input, FILTER, '');
     return planOf({ ...input, select: {} }, facts, reach);
 }
+export function queryKey(query) {
+    return canonical(query);
+}
 function canonical(value) {
     if (Array.isArray(value))
         return `[${value.map(canonical).join(',')}]`;

package/dist/reach.d.ts

@@ -1,17 +1,25 @@
-import type { MdRuntime, RuntimeTopic } from './connection.js';
+import type { AppRoom, MdRuntime, ReadinessPort, RuntimeTopic } from './connection.js';
 import type { Plan, PlanReach, QueryResult } from './query.js';
+import type { Readiness } from './readiness.js';
 import type { SearchResult } from './search.js';
 export type ReachedDocument = {
     readonly room: string;
     readonly path: string;
 };
+export type ReachedArea = {
+    readonly room: string;
+    readonly path: string;
+    readonly open: readonly string[];
+};
 export type PortReach = {
     readonly rooms: readonly string[];
     readonly documents: readonly ReachedDocument[];
+    readonly areas?: readonly ReachedArea[];
     readonly conversations: boolean;
 };
 export type Deliver = (message: unknown) => void;
-export type Watch = (topic: RuntimeTopic, input: readonly unknown[], deliver: Deliver) => () => void;
+export type Fail = (error: unknown) => void;
+export type Watch = (topic: RuntimeTopic, input: readonly unknown[], deliver: Deliver, fail: Fail) => () => void;
 export type RuntimeView = {
     md: MdRuntime;
     watch: Watch;
@@ -22,8 +30,14 @@ export type NarrowedView = RuntimeView & {
 export type Reachable = RuntimeView & {
     plan(input: unknown, reach: PortReach | null): Plan;
     query(plan: Plan): Promise<QueryResult>;
-    watchPlan(plan: Plan, deliver: (message: unknown) => void): () => void;
+    watchPlan(plan: Plan, deliver: Deliver, fail: Fail): () => void;
     search(input: unknown, reach: PortReach | null): Promise<SearchResult>;
+    watchReadiness(port: ReadinessPort, reach: PortReach | null, deliver: (readiness: Readiness) => void): () => void;
+    locked(room: string): boolean;
+    lockedRooms(): readonly string[];
+    watchLocks(notify: () => void): () => void;
+    located(room: string, path: string, destination: string): ReachedDocument | null;
+    room(locator: string): AppRoom | undefined;
 };
 export declare function holds(reach: PortReach | null, room: string): boolean;
 export declare function governs(reach: PortReach | null, room: {
@@ -36,5 +50,5 @@ export declare function governs(reach: PortReach | null, room: {
     readonly selection: boolean;
 };
 export declare function planReach(reach: PortReach | null): PlanReach | null;
-export declare function narrowed(runtime: Reachable, given: PortReach | null): NarrowedView;
+export declare function narrowed(runtime: Reachable, given: PortReach | null, port: ReadinessPort): NarrowedView;
 //# sourceMappingURL=reach.d.ts.map

package/dist/reach.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reach.d.ts","sourceRoot":"","sources":["../src/reach.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,SAAS,EAAe,YAAY,EAAc,MAAM,iBAAiB,CAAC;AAMjG,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAI/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD,MAAM,MAAM,eAAe,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE/E,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,eAAe,EAAE,CAAC;IAC/C,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAEjD,MAAM,MAAM,KAAK,GAAG,CAClB,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,SAAS,OAAO,EAAE,EACzB,OAAO,EAAE,OAAO,KACb,MAAM,IAAI,CAAC;AAEhB,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IAAE,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,CAAA;CAAE,CAAC;AAEnF,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG;IACpC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC;IACpD,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACxC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACvE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CACxE,CAAC;AA2BF,wBAAgB,KAAK,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAMpE;AAMD,wBAAgB,OAAO,CACrB,KAAK,EAAE,SAAS,GAAG,IAAI,EACvB,IAAI,EAAE;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,cAAc,EAAE;QAAE,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;KAAE,GAAG,IAAI,CAAA;CAAE,GAC/F;IAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAU/D;AAcD,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CASnE;AA8ED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,YAAY,CAgKlF"}
+{"version":3,"file":"reach.d.ts","sourceRoot":"","sources":["../src/reach.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,SAAS,EACT,aAAa,EAEb,YAAY,EAEb,MAAM,iBAAiB,CAAC;AA0BzB,OAAO,KAAK,EAAiB,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAS9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD,MAAM,MAAM,eAAe,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE/E,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,eAAe,EAAE,CAAC;IAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IACxC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAEjD,MAAM,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;AAE5C,MAAM,MAAM,KAAK,GAAG,CAClB,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,SAAS,OAAO,EAAE,EACzB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,IAAI,KACP,MAAM,IAAI,CAAC;AAEhB,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IACvC,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG;IACpC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC;IACpD,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACxC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,IAAI,CAAC;IAChE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACvE,cAAc,CACZ,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,SAAS,GAAG,IAAI,EACvB,OAAO,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,GACtC,MAAM,IAAI,CAAC;IACd,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,WAAW,IAAI,SAAS,MAAM,EAAE,CAAC;IACjC,UAAU,CAAC,MAAM,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IAC3C,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAAC;IACjF,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAC5C,CAAC;AAsCF,wBAAgB,KAAK,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAMpE;AAMD,wBAAgB,OAAO,CACrB,KAAK,EAAE,SAAS,GAAG,IAAI,EACvB,IAAI,EAAE;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,cAAc,EAAE;QAAE,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;KAAE,GAAG,IAAI,CAAA;CAAE,GAC/F;IAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAU/D;AAeD,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAcnE;AA2GD,wBAAgB,QAAQ,CACtB,OAAO,EAAE,SAAS,EAClB,KAAK,EAAE,SAAS,GAAG,IAAI,EACvB,IAAI,EAAE,aAAa,GAClB,YAAY,CAkTd"}