@agentshouse/mdmodel 0.1.0-alpha.8 → 0.1.0-c04c0d681d2d4

package/dist/condition.js

@@ -0,0 +1,616 @@
+import { ARRAY_INDEX, escapePointer, fieldFacts, itemFacts, memberFacts, pointerFacts, pointerSegments, } from './definition.js';
+import { roomPath, target } from './paths.js';
+import { plain } from './yaml.js';
+export const CONDITION_OPERATORS = [
+    'eq',
+    'in',
+    'exists',
+    'contains',
+    'gt',
+    'gte',
+    'lt',
+    'lte',
+    'prefix',
+];
+export const WRITE_DOORS = ['browser', 'agent', 'client'];
+const PROSE = { kind: 'prose' };
+const NULL = { kind: 'null' };
+const UNREADABLE = { kind: 'unreadable' };
+const UNREAD = { present: undefined, values: [undefined], items: [undefined] };
+const NO_ITEM = { present: false, values: [], items: [] };
+const DATE = /^\d{4}-\d{2}-\d{2}$/u;
+const HEADER = /^\/headers\/[!#$%&'*+.^_`|~0-9a-z-]+$/u;
+const DATE_TIME = /^(\d{4})-(\d{2})-(\d{2})[Tt](\d{2}):(\d{2}):(\d{2})(?:\.(\d+))?(?:[Zz]|([+-])(\d{2}):(\d{2}))$/u;
+export function factKind(facts) {
+    if (facts.reference !== undefined)
+        return 'reference';
+    if (facts.values !== undefined)
+        return 'enum';
+    if (facts.type === 'number' || facts.type === 'integer')
+        return 'number';
+    if (facts.type === 'boolean')
+        return 'boolean';
+    if (facts.type !== 'string')
+        return null;
+    if (facts.format === 'date')
+        return 'date';
+    if (facts.format === 'date-time')
+        return 'time';
+    return 'string';
+}
+function fits(kind, facts, value) {
+    if (!scalar(value))
+        return false;
+    if (kind === 'enum')
+        return (facts.values ?? []).includes(value);
+    if (kind === 'number')
+        return typeof value === 'number';
+    if (kind === 'boolean')
+        return typeof value === 'boolean';
+    if (typeof value !== 'string')
+        return false;
+    if (kind === 'date')
+        return dated(value);
+    if (kind === 'time')
+        return instant(value) !== undefined;
+    return true;
+}
+function factOf(value, declared, place) {
+    if (value === null)
+        return NULL;
+    if (Array.isArray(value)) {
+        if (declared?.type !== undefined && declared.type !== 'array')
+            return UNREADABLE;
+        return {
+            kind: 'list',
+            items: value.map((item, index) => factOf(item, declared === undefined ? undefined : itemFacts(declared, index), place)),
+        };
+    }
+    if (plain(value)) {
+        if (declared?.type !== undefined && declared.type !== 'object')
+            return UNREADABLE;
+        const fields = Object.create(null);
+        for (const [key, held] of Object.entries(value))
+            fields[key] = factOf(held, declared === undefined ? undefined : memberFacts(declared, key), place);
+        return { kind: 'object', fields };
+    }
+    if (declared?.type === 'array' || declared?.type === 'object')
+        return UNREADABLE;
+    const kind = declared === undefined || declared.prose ? null : factKind(declared);
+    if (kind === null)
+        return PROSE;
+    if (!fits(kind, declared, value))
+        return UNREADABLE;
+    if (kind !== 'reference')
+        return { kind, value };
+    const reached = target(place.path, value) ?? roomPath(value);
+    const resolved = reached === null ? undefined : place.resolve(reached);
+    if (resolved === undefined)
+        return UNREADABLE;
+    return resolved.member === undefined
+        ? { kind, value: resolved.id }
+        : { kind, value: resolved.id, member: resolved.member };
+}
+export function facts(document, at, model, resolve) {
+    const type = document.type ?? null;
+    const definition = type !== null && Object.hasOwn(model.types, type) ? model.types[type] : null;
+    const fields = Object.create(null);
+    const place = { path: at.path, resolve };
+    for (const [name, value] of Object.entries(document.fields)) {
+        const declared = definition === null ? undefined : fieldFacts(definition, name);
+        if (declared !== undefined)
+            fields[name] = factOf(value, declared, place);
+    }
+    return {
+        id: at.id,
+        path: `/${at.path}`,
+        type,
+        fields,
+        sections: Object.keys(document.sections).sort(),
+    };
+}
+function rootOf(facts, prefix) {
+    return { pointer: prefix, fact: { kind: 'object', fields: facts.fields } };
+}
+export function prosePaths(facts) {
+    const paths = facts.sections.map((heading) => `/sections/${heading}`);
+    const visit = ({ pointer, fact }) => {
+        if (fact.kind === 'prose')
+            paths.push(pointer);
+        if (fact.kind === 'list')
+            fact.items.forEach((item, index) => visit({ pointer: `${pointer}/${index}`, fact: item }));
+        if (fact.kind === 'object')
+            for (const [key, held] of Object.entries(fact.fields))
+                visit({ pointer: `${pointer}/${escapePointer(key)}`, fact: held });
+    };
+    visit(rootOf(facts, '/fields'));
+    return paths.sort();
+}
+function walked(start, pointer) {
+    let reached = [start];
+    let several = false;
+    let missing = false;
+    const each = (from, next) => from.flatMap((one) => {
+        const found = next(one);
+        if (found === null)
+            missing = true;
+        return found ?? [];
+    });
+    for (const token of pointerSegments(pointer)) {
+        const step = ({ pointer: at, fact }) => {
+            if (fact.kind === 'unreadable')
+                return [{ pointer: at, fact }];
+            if (fact.kind === 'object')
+                return Object.hasOwn(fact.fields, token)
+                    ? [{ pointer: `${at}/${escapePointer(token)}`, fact: fact.fields[token] }]
+                    : null;
+            if (fact.kind !== 'list')
+                return null;
+            if (ARRAY_INDEX.test(token)) {
+                const item = fact.items[Number(token)];
+                return item === undefined ? null : [{ pointer: `${at}/${token}`, fact: item }];
+            }
+            several = true;
+            return each(fact.items.map((item, index) => ({ pointer: `${at}/${index}`, fact: item })), step);
+        };
+        reached = each(reached, step);
+    }
+    return { reached, several, missing };
+}
+function expand(fact) {
+    return fact.kind === 'list' ? fact.items.flatMap(expand) : [fact];
+}
+function fieldHeld(fact) {
+    if (fact.kind === 'unreadable')
+        return undefined;
+    if (fact.kind === 'null')
+        return { kind: 'null' };
+    return 'value' in fact ? { kind: fact.kind, value: fact.value } : { kind: 'prose' };
+}
+function memberHeld(fact) {
+    if (fact.kind === 'unreadable')
+        return undefined;
+    return fact.kind === 'reference' && fact.member !== undefined
+        ? { kind: 'member', value: fact.member }
+        : null;
+}
+function single(held) {
+    return { present: true, values: [held], items: null };
+}
+function documentRead({ reached, several, missing }, held) {
+    if (reached.length === 0)
+        return missing ? undefined : NO_ITEM;
+    const facts = reached.map(({ fact }) => fact);
+    const kept = (all) => all.map(held).filter((value) => value !== null);
+    const unknown = missing ? [undefined] : [];
+    const values = kept(facts.filter((fact) => fact.kind !== 'list'));
+    const listed = several || facts.some((fact) => fact.kind === 'list');
+    const present = facts.some((fact) => fact.kind === 'list') || values.some(Boolean);
+    return {
+        present: present ? true : values.length > 0 ? undefined : false,
+        values: [...values, ...unknown],
+        items: listed ? [...kept(facts.flatMap(expand)), ...unknown] : null,
+    };
+}
+function readDocument(facts, path) {
+    const own = tested(DOCUMENT_TESTS, path);
+    if (own !== undefined)
+        return own.read(facts, path);
+    if (path.startsWith('/sections/'))
+        return facts.sections.includes(path.slice('/sections/'.length))
+            ? single({ kind: 'prose' })
+            : undefined;
+    if (path.startsWith('/fields/'))
+        return documentRead(walked(rootOf(facts, '/fields'), path.slice('/fields'.length)), fieldHeld);
+    if (path.startsWith('/members/'))
+        return documentRead(walked(rootOf(facts, '/members'), path.slice('/members'.length)), memberHeld);
+    return undefined;
+}
+export function datePointers(fields) {
+    return Object.entries(fields)
+        .filter(([, facts]) => facts.type === 'string' && facts.format === 'date')
+        .map(([name]) => `/fields/${escapePointer(name)}`)
+        .sort();
+}
+export function valuedChange(definition, field) {
+    if (!field.startsWith('/fields/'))
+        return false;
+    const reached = pointerFacts(definition, field.slice('/fields'.length));
+    return (reached !== undefined &&
+        !reached.through &&
+        reached.facts.type !== 'array' &&
+        !reached.facts.prose &&
+        factKind(reached.facts) !== null);
+}
+export function changeFields(definition) {
+    return [
+        ...Object.keys(definition.fields).map((name) => `/fields/${escapePointer(name)}`),
+        ...Object.keys(definition.sections).map((heading) => `/sections/${heading}`),
+    ];
+}
+export function memberPointers(definition, memberType) {
+    return Object.entries(definition.fields)
+        .filter(([, facts]) => (facts.type === 'array' ? facts.items : facts)?.reference?.includes(memberType) === true)
+        .map(([name]) => `/members/${escapePointer(name)}`);
+}
+function kindOperators(kind) {
+    switch (kind) {
+        case 'string':
+            return ['eq', 'in', 'prefix', 'exists'];
+        case 'boolean':
+            return ['eq', 'exists'];
+        case 'number':
+        case 'date':
+        case 'time':
+            return ['eq', 'in', 'gt', 'gte', 'lt', 'lte', 'exists'];
+        default:
+            return ['eq', 'in', 'exists'];
+    }
+}
+function pointerOperators({ facts, through }) {
+    const scalar = facts.type === 'array' ? facts.items : facts;
+    const kind = scalar === undefined || scalar.prose ? null : factKind(scalar);
+    if (kind === null)
+        return ['exists'];
+    if (facts.type === 'array')
+        return ['contains', 'exists'];
+    const own = kindOperators(kind);
+    return through ? [...own.filter((operator) => operator !== 'exists'), 'contains', 'exists'] : own;
+}
+function typeOperators(definition, path, memberType) {
+    if (path.startsWith('/sections/'))
+        return Object.hasOwn(definition.sections, path.slice('/sections/'.length)) ? ['exists'] : [];
+    const pointer = path.startsWith('/fields/')
+        ? path.slice('/fields'.length)
+        : memberType !== null && memberPointers(definition, memberType).includes(path)
+            ? path.slice('/members'.length)
+            : undefined;
+    const reached = pointer === undefined ? undefined : pointerFacts(definition, pointer);
+    return reached === undefined ? [] : pointerOperators(reached);
+}
+function envelope(path, kind, value) {
+    return {
+        path,
+        names: (named) => named === path,
+        kind,
+        operators: kindOperators(kind),
+        read: (facts) => {
+            const held = value(facts);
+            return held === null || held === undefined ? undefined : single({ kind, value: held });
+        },
+    };
+}
+function tested(tests, path) {
+    return tests.find(({ names }) => names(path));
+}
+function reader(tests, facts) {
+    return (path) => tested(tests, path)?.read(facts, path);
+}
+const DOCUMENT_TESTS = [
+    {
+        path: '/path',
+        names: (named) => named === '/path',
+        kind: 'string',
+        operators: ['eq', 'in', 'prefix'],
+        read: (facts) => single({ kind: 'string', value: facts.path }),
+    },
+    envelope('/type', 'enum', (facts) => facts.type),
+];
+const ACTOR_TESTS = [
+    envelope('/user', 'enum', (actor) => actor.user),
+    envelope('/site', 'enum', (actor) => actor.site),
+    envelope('/door', 'enum', (actor) => actor.door),
+];
+const ITEM_TESTS = [
+    envelope('/delivery', 'enum', (item) => item.delivery),
+    envelope('/source', 'enum', (item) => item.source),
+    envelope('/has_attachment', 'boolean', (item) => item.has_attachment),
+    envelope('/container', 'string', (item) => item.container),
+    envelope('/author', 'string', (item) => item.author),
+    {
+        path: '/headers/<lowercase name>',
+        names: (named) => HEADER.test(named),
+        kind: 'string',
+        operators: kindOperators('string'),
+        read: (item, path) => {
+            const name = path.slice('/headers/'.length);
+            return Object.hasOwn(item.headers, name)
+                ? single({ kind: 'string', value: item.headers[name] })
+                : undefined;
+        },
+    },
+    {
+        path: '/json/<JSON Pointer>',
+        names: (named) => named.startsWith('/json/'),
+        kind: null,
+        operators: CONDITION_OPERATORS,
+        read: (item, path) => item.json === null ? UNREAD : jsonRead(pointed(item.json.value, path.slice('/json'.length))),
+    },
+];
+export const DOCUMENT_PATHS = DOCUMENT_TESTS.map(({ path }) => path);
+export const ACTOR_PATHS = ACTOR_TESTS.map(({ path }) => path);
+export const ITEM_PATHS = ITEM_TESTS.map(({ path }) => path);
+export function testOperators(definitions, path, memberType) {
+    const own = tested(DOCUMENT_TESTS, path);
+    if (own !== undefined)
+        return own.operators;
+    return [
+        ...new Set(definitions.flatMap((definition) => typeOperators(definition, path, memberType))),
+    ];
+}
+export function actorOperators(path) {
+    return tested(ACTOR_TESTS, path)?.operators ?? [];
+}
+export function itemOperators(path) {
+    return tested(ITEM_TESTS, path)?.operators ?? [];
+}
+export function itemKind(path) {
+    return tested(ITEM_TESTS, path)?.kind ?? null;
+}
+export function dated(value) {
+    return (typeof value === 'string' && DATE.test(value) && instant(`${value}T00:00:00Z`) !== undefined);
+}
+export function instant(value) {
+    if (typeof value !== 'string')
+        return undefined;
+    const parts = DATE_TIME.exec(value);
+    if (parts === null)
+        return undefined;
+    const [year, month, day, hour, minute, second, offsetHours, offsetMinutes] = [
+        1, 2, 3, 4, 5, 6, 9, 10,
+    ].map((at) => Number(parts[at] ?? 0));
+    const at = new Date(0);
+    at.setUTCFullYear(year, month - 1, day);
+    at.setUTCHours(hour, minute, second);
+    if (at.getUTCFullYear() !== year ||
+        at.getUTCMonth() !== month - 1 ||
+        at.getUTCDate() !== day ||
+        at.getUTCHours() !== hour ||
+        at.getUTCMinutes() !== minute ||
+        offsetHours > 23 ||
+        offsetMinutes > 59)
+        return undefined;
+    const offset = (parts[8] === '-' ? -1 : 1) * (offsetHours * 60 + offsetMinutes);
+    const fraction = (parts[7] ?? '').padEnd(9, '0').slice(0, 9);
+    return (BigInt(at.getTime()) - BigInt(offset) * 60000n) * 1000000n + BigInt(fraction);
+}
+export function pointed(value, pointer) {
+    let reached = value;
+    for (const token of pointerSegments(pointer)) {
+        if (Array.isArray(reached)) {
+            if (!ARRAY_INDEX.test(token))
+                return undefined;
+            reached = reached[Number(token)];
+        }
+        else if (plain(reached) && Object.hasOwn(reached, token)) {
+            reached = reached[token];
+        }
+        else {
+            return undefined;
+        }
+    }
+    return reached;
+}
+function scalar(value) {
+    return (typeof value === 'string' ||
+        typeof value === 'boolean' ||
+        (typeof value === 'number' && Number.isFinite(value)));
+}
+function jsonHeld(value) {
+    if (typeof value === 'string')
+        return {
+            kind: dated(value) ? 'date' : instant(value) === undefined ? 'string' : 'time',
+            value,
+        };
+    if (typeof value === 'boolean')
+        return { kind: 'boolean', value };
+    return { kind: 'number', value };
+}
+function jsonRead(value) {
+    if (value === undefined)
+        return undefined;
+    if (scalar(value))
+        return single(jsonHeld(value));
+    if (!Array.isArray(value))
+        return single({ kind: 'prose' });
+    return { present: true, values: [], items: value.filter(scalar).map(jsonHeld), loose: true };
+}
+function equal(held, value) {
+    if (!('value' in held))
+        return undefined;
+    if (typeof value !== typeof held.value)
+        return undefined;
+    if (held.kind !== 'time')
+        return value === held.value;
+    const left = instant(held.value);
+    const right = instant(value);
+    return left === undefined || right === undefined ? undefined : left === right;
+}
+function sign(left, right) {
+    return left < right ? -1 : left > right ? 1 : 0;
+}
+function ordered(held, value, compare) {
+    if (!('value' in held))
+        return undefined;
+    if (held.kind === 'number') {
+        if (typeof value !== 'number' || typeof held.value !== 'number')
+            return undefined;
+        return compare(Math.sign(held.value - value));
+    }
+    if (held.kind === 'date') {
+        if (!dated(value) || !dated(held.value))
+            return undefined;
+        return compare(sign(held.value, value));
+    }
+    if (held.kind !== 'time')
+        return undefined;
+    const at = instant(held.value);
+    const wanted = instant(value);
+    if (at === undefined || wanted === undefined)
+        return undefined;
+    return compare(sign(at, wanted));
+}
+function anyOf(truths) {
+    if (truths.some((truth) => truth === true))
+        return true;
+    return truths.some((truth) => truth === undefined) ? undefined : false;
+}
+function allOf(truths) {
+    if (truths.some((truth) => truth === false))
+        return false;
+    return truths.some((truth) => truth === undefined) ? undefined : true;
+}
+function compared(test, held) {
+    if ('eq' in test)
+        return equal(held, test.eq);
+    if ('in' in test)
+        return anyOf(test.in.map((value) => equal(held, value)));
+    if ('prefix' in test) {
+        if (!('value' in held) || typeof held.value !== 'string')
+            return undefined;
+        if (held.kind === 'number' || held.kind === 'reference' || held.kind === 'member')
+            return undefined;
+        return held.value.startsWith(test.prefix);
+    }
+    if ('gt' in test)
+        return ordered(held, test.gt, (sign) => sign > 0);
+    if ('gte' in test)
+        return ordered(held, test.gte, (sign) => sign >= 0);
+    if ('lt' in test)
+        return ordered(held, test.lt, (sign) => sign < 0);
+    return ordered(held, test.lte, (sign) => sign <= 0);
+}
+function leaf(test, read) {
+    if ('exists' in test) {
+        const present = read === undefined ? false : read.present;
+        return present === undefined ? undefined : present === test.exists;
+    }
+    if (read === undefined)
+        return undefined;
+    if ('contains' in test) {
+        if (read.items === null)
+            return undefined;
+        const truths = read.items.map((item) => item === undefined ? undefined : equal(item, test.contains));
+        return read.loose === true && !truths.includes(true) ? false : anyOf(truths);
+    }
+    if (read.values.length === 0)
+        return read === NO_ITEM ? false : undefined;
+    return anyOf(read.values.map((value) => (value === undefined ? undefined : compared(test, value))));
+}
+function evaluated(test, read) {
+    if ('all' in test)
+        return allOf(test.all.map((part) => evaluated(part, read)));
+    if ('any' in test)
+        return anyOf(test.any.map((part) => evaluated(part, read)));
+    if ('not' in test) {
+        const truth = evaluated(test.not, read);
+        return truth === undefined ? undefined : !truth;
+    }
+    return leaf(test, read(test.path));
+}
+export function members(document, path) {
+    if (!path.startsWith('/members/'))
+        return [];
+    const read = readDocument(document, path);
+    const values = read === undefined ? [] : [...read.values, ...(read.items ?? [])];
+    return [
+        ...new Set(values.flatMap((value) => value !== undefined && value.kind === 'member' && 'value' in value
+            ? [String(value.value)]
+            : [])),
+    ].sort();
+}
+export function holds(test, document) {
+    return evaluated(test, (path) => readDocument(document, path));
+}
+function inScope(scope, document) {
+    if (document === null)
+        return false;
+    if ('type' in scope)
+        return document.type === scope.type;
+    if ('document' in scope)
+        return document.id === scope.document;
+    return scope.folder === '/' || document.path.startsWith(`${scope.folder}/`);
+}
+function matched(condition, test, document) {
+    if (!inScope(condition.scope, document))
+        return false;
+    return test === undefined || holds(test, document) === true;
+}
+function reachedAt(document, field) {
+    if (document === null)
+        return [];
+    if (field.startsWith('/sections/'))
+        return document.sections.includes(field.slice('/sections/'.length))
+            ? [{ pointer: field, fact: PROSE }]
+            : [];
+    if (!field.startsWith('/fields/'))
+        return [];
+    return walked(rootOf(document, '/fields'), field.slice('/fields'.length)).reached;
+}
+function valueOf(fact) {
+    if (fact.kind === 'list')
+        return { kind: fact.kind, items: fact.items.map(valueOf) };
+    if (fact.kind === 'object')
+        return {
+            kind: fact.kind,
+            fields: Object.keys(fact.fields)
+                .sort()
+                .map((key) => [key, valueOf(fact.fields[key])]),
+        };
+    if (fact.kind === 'time') {
+        const at = instant(fact.value);
+        if (at !== undefined)
+            return { kind: fact.kind, at: String(at) };
+    }
+    return 'value' in fact ? { kind: fact.kind, value: fact.value } : fact;
+}
+function signature(reached) {
+    return JSON.stringify(reached.map(({ fact }) => valueOf(fact)));
+}
+function among(values, document, field) {
+    return holds({ path: field, in: values }, document) === true;
+}
+function fieldChanged(condition, event) {
+    const { field, from, to } = condition;
+    const before = reachedAt(event.before, field);
+    const after = reachedAt(event.after, field);
+    const pointers = [field, ...[...before, ...after].map(({ pointer }) => pointer)];
+    const prose = event.changed.some((changed) => pointers.some((pointer) => changed === pointer || changed.startsWith(`${pointer}/`)));
+    if (from === undefined && to === undefined && prose)
+        return true;
+    if (before.length === 0 && after.length === 0)
+        return false;
+    if (event.before !== null && event.after !== null && signature(before) === signature(after))
+        return false;
+    if (from === 'new'
+        ? event.before !== null
+        : from !== undefined && (event.before === null || !among(from, event.before, field)))
+        return false;
+    if (to === 'deleted'
+        ? event.after !== null
+        : to !== undefined && (event.after === null || !among(to, event.after, field)))
+        return false;
+    return true;
+}
+export function fires(condition, event) {
+    if (condition.moved_between_rooms !== undefined &&
+        condition.moved_between_rooms !== event.moved_between_rooms)
+        return false;
+    if (condition.by !== undefined && evaluated(condition.by, reader(ACTOR_TESTS, event.by)) !== true)
+        return false;
+    if (condition.mode === 'starts_matching') {
+        if (event.before === null && !condition.new_documents)
+            return false;
+        return (matched(condition, condition.match, event.after) &&
+            !matched(condition, condition.match, event.before));
+    }
+    const side = event.after ?? event.before;
+    return matched(condition, condition.match, side) && fieldChanged(condition, event);
+}
+export function itemFires(condition, item) {
+    if (condition.source !== undefined && item.source !== condition.source)
+        return false;
+    if (condition.address !== undefined && item.address !== condition.address)
+        return false;
+    return (condition.match === undefined || evaluated(condition.match, reader(ITEM_TESTS, item)) === true);
+}