* feat(environment): serve the writes callers make without recorded form fields
- A create member a recording sent empty ("", null, false, [] or {}) is no
longer required; a call that leaves it out is applied as sending that value
(body.blank).
- List views render envelope members that list the listed entities' ids
(Paperless's `all`), so creates in such collections are confirmed.
- Updates move their entity in collections kept sorted by a field they write,
and a failed whole-collection read after an update can teach that order.
- A later create that stores an unruled field otherwise is withheld at the
create, and an item read may fill values a create's answer had not loaded.
- An unsent field respelled between null, [] and {} is unchanged.
- The skill asks for one create with every field and one with only what a
person must give.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(skill): show how to read signed-in pages before recording
Agents guessed capture keys (artifacts, dom, final) to see pages behind
sign-in, which inspect_web_page cannot reach.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): accept every empty spelling recorded creates sent
A create that fills only what a person must give sends `null` where the
full create sent a string, and `null` or `false` for the same flag. The
merged plan now accepts each recorded empty value, and a call that leaves
the member out is applied as the earliest call sent it.
Also adds the spec folder for this change.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(skill): keep the vary-fields step neutral on UI or API writes
Agents read "the form" as a cue to write through the UI, where some
applications' request bodies are not exposed; a body-unusable UI write
now re-records once with request steps.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(environment): record verification for blank members and sorted writes
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): address review of blank members and sorted writes
- Bulk updates move their entities in turn against the others' earlier
values and install the final order once, as replay does.
- A member's recorded empty values stay accepted once a later call teaches
its default; a left-out member with a default keeps the default.
- Write answers spell empty lists and maps as their recorded answers did.
- A rename can teach a sort when the creates chose one by a field the
update did not write, such as ids that ascend with titles.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* feat(environment): serve the writes that later reads explain
- An item read whose object is marked deleted (deleted, isDeleted or
is_deleted true) agrees with an absent entity, as EspoCRM answers a
deleted record; such an object never seeds or adopts an entity.
- maxSize, max_results and maxResults are page sizes, for whole-collection
list lines and the list query's limit role.
- An item view also shows the fields only reads after its type's first write
show, when no initial entity holds them (Vikunja's task subscription),
without requiring them; write answers leave such a field out for entities
without it, and it no longer withholds the write as incomplete-entities.
- The skill asks updates to change the fields a person would change, and
expects a deleted object to read back as 404 or marked deleted.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): answer sent empty members as sent, and keep a placed create's order
- A write answer spells an empty list or map the call did not send as its
recorded answer did; one the call sent is answered as sent, so a create
sending `[]` is not answered `null` because the first recorded create was.
- A read listing the whole collection that placed a create leaves the create
only the sorted inserts whose order that read follows, so a later rename
cannot teach a sort an earlier read ruled out.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): answer bulk updates without fields only later reads show
A bulk update's answer renders each entity with the same allowance a single
update's answer has: a field only reads after the type's first write showed,
which no initial entity holds, is left out for an entity without it, so a
bulk update of a seeded task is no longer refused for lacking it.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(environment): correct how the EspoCRM contact update task passes
The agent trajectories show gpt-oss passes it by creating a replacement contact
and deleting the original, since the served update refuses emailAddress; the
update itself is refused in both builds.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): answer a read of a served-deleted entity marked deleted
An application that soft-deletes still answers a deleted record by id, marked
deleted. Serving now keeps an entity a served delete removed from a type whose
recorded item reads show that, until a reset or load and within the size
data/add loads, and answers a read of it with its last fields and the flag
true, instead of refusing the read.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): keep unloaded create answers, check bulk answers with sent members, narrow inserts only on collection-order reads
- A create whose item read loaded values its answer had not records them
(`observation.read.unloaded`), and a served create's answer keeps them as
the recorded answer showed them, a zero-time owner included, while the state
holds the read's.
- Replay checks a bulk update's recorded answers with each target's sent
members, as serving answers them, so echoed `null` and `[]` no longer make
the plan body-unusable.
- A whole-collection read whose query sorts it shows the query's order, so it
no longer narrows a create's sorted insert candidates.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(environment): record the census with main's unknown-clock rule merged
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* feat(environment): serve query numbers, counted values and made objects
- A query parameter accepts a number or boolean, which serving sends as its
JSON text, as agents send page sizes and flags.
- A sequence may start at the value its first create took above every value
its type held (Vikunja's per-project task index), and a later create's
composed, template or started-sequence rule is adopted when it also spells
the first create's value.
- A made-object rule explains an object the application makes with each
created entity: members the request stamped, members holding the entity's
own id, and counts one past the held objects' values.
- A create's answer names the id of the one object a one-element array member
holds, so bulk creates link to their type.
- The skill reads each listed object by id before writing.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* feat(environment): let a linked create take path values it stores
A create linked to its type's own collection, whose path has no parameters,
accepts any path values when its plan stores each one in a field, as a Vikunja
task stores its project; replay and serving apply it alike.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): learn a sort from a rename only when moving its entities reaches it
Serving moves only the entities a write changes in a collection kept sorted,
so replay now tries a sort after a rename only when the entities no write the
read exercised changed already follow it. Seeded folders listed out of title
order no longer teach a title sort that serving would answer with another
order.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): keep unloaded create answers a sent value did not echo, and learn no sort from query-sorted reads
- A served create keeps a value its recorded answer had not loaded unless the
call sent that member and the plan stores it as sent, so a create sending
`active: false` is answered `false` as recorded while the state holds the
read's `true`.
- A rename no longer teaches a sort from a whole-collection read its query
sorts, whose ties need not follow the collection's own order.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(environment): verify query values, counted values and made objects
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): learn the soft-delete flag in the state view and serve by it
Extraction now records the member later item reads set true on a record the
application soft-deleted, and the item view carries it as `deleted_flag`.
Serving reads that fact instead of scanning recorded bodies itself, so one
owner decides what a soft delete looks like.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(environment): record the call-values checks at #7274 93821024
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): learn the soft-delete flag from item reads with a query too
A client may read a deleted record back only with a query, such as a
cache-busting parameter. Every successful read of the item tool now shows the
flag; only plain later reads still add fields.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(environment): record the call-values checks at #7274 45832406
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): learn sorts only from orders a list read confirmed
- A sort retry after a failed whole-collection read requires the entities no
write changed since a list last showed them to follow it already, rather than
excusing every entity the update's tool ever wrote: an earlier rename a list
confirmed in place stays where it was.
- An update takes its creates' sort only from a create a list read showed
placed; replay still tries a sort a create guessed from the initial order.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): drop entities read back as deleted and answer soft deletes as deleted
- A held entity a later read shows marked deleted is dropped, not adopted with
the marked object's fields.
- Bulk-update replay renders answers with the optional and later-only fields
serving uses, so a bulk update of created and seeded entities replays.
- A served delete of a soft-deleting type answers with the entity marked
deleted, single and bulk.
- A deleted flag only query reads showed is a field of the item view, so a
served tombstone keeps it where live records omit it.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): check made objects as recorded and keep their ids and clocks honest
- A made object's clock counts as a write clock, so a capture with no clock
anchor withholds the create instead of stamping 1970.
- Members holding the entity's identity follow the id written, generated or
sent, through the type's id field.
- A later create's made object is checked as recorded, before its own members
are rewritten, so one naming another entity withholds the plan.
- A later create's template is adopted only when it spells that create's value
too, not just when the first create's text holds its source value.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): move updated entities only by placed sorts and keep query-sorted reads from confirming order
Replay moved an updated entity by a sort a create only guessed, while the
update plan exported only placed sorts, so a read could confirm an update
by a move serving would not make. Both now use the placed sort. A passing
list read clears its entities from the moved set only when the state
decides the order of every entity it lists, so a read whose query sorts
it no longer hides an earlier move from a later sort check.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(environment): count six withheld plans that explain more, not seven
The bulk task create counted among them is served on this branch.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): try a learned sort by moving each pending write in turn, as serving does
#retrySort sorted the whole collection, which a list could match while
serving, moving each renamed entity in turn against the others' values
before their own writes, gave another order. The state now records the
values each write replaced, and the retry replays the writes since a
list in collection order last showed their entities.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): answer a served delete with the deleted flag its recorded answer showed
An application may answer a delete with the record as it was and mark it
deleted only on later reads. Delete answers, single and bulk, now take
the flag's value from the recorded answer; reads of a served-deleted
entity still show it marked deleted.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* chore(environment): set aside two hunks next to lines main's saved-values change rewrites
Main's #7267 changes the lines beside the blank-member docs and the
empty-spelling check in explainUpdate. Setting them aside lets that merge
apply cleanly; the commit after it puts them back on top of main's text.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* chore(environment): restore the set-aside hunks on main and bump the skill to 51
Puts the blank-member docs and the empty-spelling check back beside main's
slug and composed text and heldSlugRule. Main is at skill 50 with
different text, so this branch's skill changes take 51.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* chore(environment): bump the skill to 52 above #7260's 51
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* chore(environment): put back the call-values hunks main's merge took its side for, and bump the skill to 53
The merge of main kept main's side where it overlapped this branch, so it
could commit without a conflict. This restores this branch's side next to
main's: made-object agreement beside the & slug spellings, sequence starts
in the earlier evidence (now built by earlierOf), the combined value
imports, and recording step 2 beside main's UI-first step 3. Main is at
skill 50 and #7274 at 52, so this branch takes 53.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): keep sorts a list showed in place ruled out, and created answers' nested members as recorded
A whole list in collection order that showed a renamed entity where a
sort by the renamed field would have moved it now rules that sort out, so
a later rename of the same entity cannot teach it. A create's answer
leaves out members its item read added inside an object the answer
showed, as the recorded answer did; the state still stores them.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* feat(environment): serve writes whose calls send different members
Recordings now vary what a type's two creates and updates send, and REA
withheld writes where a later call left out what the first sent. An update
plan's required members narrow to those every call sent; a member one create
sent and another left for the application to number is a sequence that
takes the value a call sends; a PUT's left-out member the application
cleared becomes that member's default; and an update's clock is held as
the read after it spells it. The skill spaces creates (skill 54).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): keep a later create's made object only with clocks its request stamped
followsMadeObjects only checked that a made object's clocks parsed, so a
later create whose object showed an older clock still passed, while serving
stamps the write's clock. Its clocks must now be in the rule's format and
within the stamp window of that create's request.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): accept sent values either way, check defaults against every call, and store update clocks as reads spell them
A sequence that takes sent values now accepts one a later create sent
after the first left the member to be numbered. A default an update learned
must agree with every update that left its member out, else the plan is
withheld. An update plan whose read-back spells a stamped clock at a coarser
precision keeps that read as observation.read, and serving stores the
update's clocks in its spelling while answers keep the response's.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): check recorded member and sequence values
* fix(environment): compare soft-deleted read fields
* fix(environment): reject contradictory learned sequences
* fix(environment): preserve initially deleted item observations
* fix(environment): index stored deleted entities separately
* fix(environment): replay lists that include deleted records
* fix(environment): count a sequence number a create sends, as replay does
Serving now records a number a call sends for a `sequence` with `sent` in the
same count history it generates from, so after that entity is deleted the next
generated number still follows it, as replay's takeSequences does.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): make no count of a made-object member earlier creates held alike
A count only a later create shows starts at the exemplar's value, which is
right only while the exemplar is the one create accepted: creates accepted
after it showed the member unchanged, which a count would have moved. The
merge now refuses such a count, as the top-level sequence check does.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): check PUT defaults against reads, and respell update clocks by serving's rule
A default a PUT learns must also agree with what the read after an earlier or
the current call showed for the member its answer left out, so a call whose
read showed the member kept withholds a later clearing default.
Replay and serving now choose an update clock's stored spelling by one rule,
readSpellsCoarser: the read after it at a coarser precision in the same zone
and separator. A read in another zone or separator is no longer adopted by
replay, which serving could not store, and a create's plain clocks stay as
answered, as serving makes them.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): keep the largest sequence value in replay, and store update clocks by the kept read
Replay now keeps the largest value a sequence took, as serving's commitWrite
does, so a lower sent value no longer lowers the next number.
Serving stores every update's clocks in the spelling of the read the plan
keeps as observation.read; replay now does the same through
readSpelledClocks, instead of adopting each update's own read, so a later
update whose read spells its clock otherwise contradicts the plan. The plain
clock branch of restampedFields, which no caller used any more, is gone.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): keep a left-out default from numbering, a read's sub-millisecond digits, and references named by member
A member a call left out and the application stored a fixed value for is no
longer turned into a numbered sequence by a later call that left it out.
Serving shortens an update's clock to the read's precision from the answer's
own digits, keeping microseconds. A PUT that names a reference field's entity
by its member supplies that field, for the default check and in serving.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): count a reference a later PUT names toward the default an earlier one cleared
The default check now reads the reference rules the current call shows as
well as the plan's, so a PUT naming the owner by ownerId after one that
cleared it is served, as in the other order.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): number a left-out member past every sent value, and never fill it with a sent blank
A later create the application numbered at or below a value an earlier create
sent no longer turns the echo into a numbered sequence, since serving counts
past every sent value. A member a numbered sequence covers is not filled with
an empty value another call sent when a call leaves it out.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(environment): count sent values in the sequence's scope before numbering a left-out member
The largest value earlier creates sent is kept by type and by collection, and
a collection-scoped sequence adopted later checks only its own collection, so
a number sent in another collection no longer withholds a create numbered
within its own.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: morluto <76467478+morluto@users.noreply.github.com>
563 lines
20 KiB
TypeScript
563 lines
20 KiB
TypeScript
import type { JsonValue } from "../jsonValue.js";
|
|
import {
|
|
isObject,
|
|
ownMember,
|
|
same,
|
|
scalarText,
|
|
type JsonObject,
|
|
} from "./environmentStateRules.js";
|
|
import { storedKinds } from "./environmentStateWriteApply.js";
|
|
import { fittedClockFormat } from "./environmentStateWriteClockFormats.js";
|
|
import { composedValue } from "./environmentStateWriteComposed.js";
|
|
import {
|
|
alikeRules,
|
|
isBlankValue,
|
|
type FieldRule,
|
|
type WriteBody,
|
|
} from "./environmentStateWriteRules.js";
|
|
import {
|
|
containsDelimited,
|
|
replaceDelimited,
|
|
sequenceNumber,
|
|
slugOf,
|
|
type Ampersand,
|
|
} from "./environmentStateWriteValues.js";
|
|
|
|
type Default = { readonly member: string; readonly value: JsonValue };
|
|
type Blank = NonNullable<WriteBody["blank"]>[number];
|
|
|
|
/** What earlier calls showed that a merge must respect: members stored unsorted as sent, and the value showing each clock's width. */
|
|
export interface EarlierEvidence {
|
|
readonly kept: ReadonlySet<string>;
|
|
readonly clockOf: (field: string) => JsonValue | undefined;
|
|
/** The integer the exemplar showed in an unruled field above every value its type held, where a sequence may start. */
|
|
readonly startOf?: (field: string) => number | undefined;
|
|
readonly createCollections?: readonly string[];
|
|
/** The largest integer an echoed field held on the plan's accepted creates, across the type or in the later call's collection. */
|
|
readonly sentLargest?: (
|
|
field: string,
|
|
scope: "collection" | "type",
|
|
) => number | undefined;
|
|
/** How the plan's accepted calls and the type's held entities spelled `&` in each field's slug; absent where none showed one. */
|
|
readonly ampersands?: ReadonlyMap<string, AmpersandSpelling>;
|
|
}
|
|
|
|
/** How a field's slug showed `&`: dropped, as the word, or in a way neither spelling gives. */
|
|
export type AmpersandSpelling = "dropped" | Ampersand | "unknown";
|
|
|
|
/** The plan's rule for a field and a later call's agree: equal, clocks one spelling covers given what earlier calls showed, slugs that differ only in how they spell `&`, or made objects alike but in the counts only the later call could show. */
|
|
const agreeing = (
|
|
held: FieldRule,
|
|
later: FieldRule,
|
|
values: {
|
|
readonly field: string;
|
|
readonly later: JsonValue | undefined;
|
|
readonly earlier: EarlierEvidence;
|
|
readonly exemplar: JsonObject;
|
|
readonly laterEntity: JsonObject;
|
|
},
|
|
): FieldRule | undefined => {
|
|
const alike = alikeRules(held, later, values.earlier.kept);
|
|
if (alike !== undefined) return alike;
|
|
if (held.rule === "made-object" && later.rule === "made-object")
|
|
return madeAlike(
|
|
held,
|
|
later,
|
|
ownMember(values.exemplar, values.field),
|
|
values.earlier,
|
|
);
|
|
const spelled = ampersandSpelled(
|
|
held,
|
|
{ rule: later, entity: values.laterEntity },
|
|
values.earlier.ampersands?.get(values.field),
|
|
);
|
|
if (spelled !== undefined) return spelled;
|
|
if (held.rule !== "clock" || later.rule !== "clock") return undefined;
|
|
const format = fittedClockFormat(
|
|
held.format,
|
|
values.later,
|
|
values.earlier.clockOf(values.field),
|
|
);
|
|
return format === undefined ? undefined : { ...held, format };
|
|
};
|
|
|
|
type MadeObject = Extract<FieldRule, { rule: "made-object" }>;
|
|
|
|
/** Two made-object rules as one: the same clocks, format and own members, and the earlier counts among the later's; a count only the later call shows starts at the exemplar's value, which no earlier object could show past, and only while the exemplar is the one create accepted, as earlier creates held it still. */
|
|
const madeAlike = (
|
|
held: MadeObject,
|
|
later: MadeObject,
|
|
exemplar: JsonValue | undefined,
|
|
earlier: EarlierEvidence,
|
|
): MadeObject | undefined => {
|
|
if (
|
|
!same(held.clocks, later.clocks) ||
|
|
!same(held.own, later.own) ||
|
|
!same(held.format, later.format) ||
|
|
held.counts.some(
|
|
({ member }) => !later.counts.some((count) => count.member === member),
|
|
)
|
|
)
|
|
return undefined;
|
|
const counts: MadeObject["counts"] = [];
|
|
for (const { member } of later.counts) {
|
|
const kept = held.counts.find((count) => count.member === member);
|
|
// Accepted creates past the exemplar showed this member unchanged, which a count would have moved.
|
|
if (kept === undefined && (earlier.createCollections ?? []).length > 1)
|
|
return undefined;
|
|
const start =
|
|
kept?.start ??
|
|
sequenceNumber(
|
|
isObject(exemplar) ? ownMember(exemplar, member) : undefined,
|
|
);
|
|
if (start === undefined) return undefined;
|
|
counts.push({ member, start });
|
|
}
|
|
return { ...held, counts };
|
|
};
|
|
|
|
/** A rule with its slugs spelled the default way. */
|
|
const unspelled = (rule: FieldRule): FieldRule => {
|
|
if (rule.rule === "slug") {
|
|
const { ampersand: _ampersand, ...plain } = rule;
|
|
return plain;
|
|
}
|
|
if (rule.rule !== "composed") return rule;
|
|
return {
|
|
...rule,
|
|
parts: rule.parts.map((part) =>
|
|
"as" in part && part.as === "slug"
|
|
? { from: part.from, as: "slug" as const }
|
|
: part,
|
|
),
|
|
};
|
|
};
|
|
|
|
/** Whether a call's entity holds `&` in a field the rule slugs, which shows how it spells one. */
|
|
const showsAmpersand = (rule: FieldRule, entity: JsonObject): boolean =>
|
|
(rule.rule === "slug"
|
|
? [rule.from]
|
|
: rule.rule === "composed"
|
|
? rule.parts.flatMap((part) =>
|
|
"as" in part && part.as === "slug" ? [part.from] : [],
|
|
)
|
|
: []
|
|
).some((field) => {
|
|
const value = ownMember(entity, field);
|
|
return typeof value === "string" && value.includes("&");
|
|
});
|
|
|
|
/**
|
|
* Two calls' rules that differ only in how a slug spells `&`: the one that spells it as the word, when the call
|
|
* spelling it otherwise slugged no `&`, and no call the plan accepted nor entity the type held dropped one (`shown`).
|
|
*/
|
|
export const ampersandSpelled = (
|
|
held: FieldRule,
|
|
later: { readonly rule: FieldRule; readonly entity: JsonObject },
|
|
shown: AmpersandSpelling | undefined,
|
|
): FieldRule | undefined => {
|
|
const plainHeld = unspelled(held);
|
|
if (!same(plainHeld, unspelled(later.rule))) return undefined;
|
|
const heldSpells = !same(held, plainHeld);
|
|
if (heldSpells === !same(later.rule, unspelled(later.rule))) return undefined;
|
|
if (heldSpells)
|
|
return showsAmpersand(later.rule, later.entity) ? undefined : held;
|
|
return shown === "dropped" || shown === "unknown" ? undefined : later.rule;
|
|
};
|
|
|
|
/** How a rule's slug spells `&`, for a rule that slugs a field. */
|
|
const slugSpelling = (rule: FieldRule): AmpersandSpelling | undefined => {
|
|
if (rule.rule === "slug") return rule.ampersand ?? "dropped";
|
|
if (rule.rule !== "composed") return undefined;
|
|
for (const part of rule.parts)
|
|
if ("as" in part && part.as === "slug") return part.ampersand ?? "dropped";
|
|
return undefined;
|
|
};
|
|
|
|
/** Note how a call that slugged `&` spelled it in each field its own rules slug. */
|
|
export const noteAmpersands = (
|
|
ampersands: Map<string, AmpersandSpelling>,
|
|
rules: readonly FieldRule[],
|
|
entity: JsonObject,
|
|
): void => {
|
|
for (const rule of rules) {
|
|
const spelling = slugSpelling(rule);
|
|
if (spelling !== undefined && showsAmpersand(rule, entity))
|
|
ampersands.set(rule.field, spelling);
|
|
}
|
|
};
|
|
|
|
/** Exact spelling observations in held entities; absence and contradictory spellings remain distinct. */
|
|
export const heldAmpersandSpellings = (
|
|
rule: FieldRule,
|
|
held: readonly JsonObject[],
|
|
): ReadonlySet<AmpersandSpelling> => {
|
|
const observed = new Set<AmpersandSpelling>();
|
|
if (slugSpelling(rule) === undefined) return observed;
|
|
const plain = unspelled(rule);
|
|
for (const entity of held) {
|
|
if (!showsAmpersand(rule, entity)) continue;
|
|
const stored = ownMember(entity, rule.field);
|
|
if (stored === undefined) continue;
|
|
const source =
|
|
rule.rule === "slug" ? ownMember(entity, rule.from) : undefined;
|
|
const spelled = (spelling: Ampersand | undefined): string | undefined =>
|
|
rule.rule === "slug"
|
|
? typeof source === "string"
|
|
? slugOf(source, spelling)
|
|
: undefined
|
|
: plain.rule === "composed"
|
|
? composedValue(
|
|
plain.parts.map((part) =>
|
|
"as" in part && part.as === "slug" && spelling !== undefined
|
|
? { ...part, ampersand: spelling }
|
|
: part,
|
|
),
|
|
entity,
|
|
)
|
|
: undefined;
|
|
observed.add(
|
|
spelled(undefined) === stored
|
|
? "dropped"
|
|
: spelled("and") === stored
|
|
? "and"
|
|
: "unknown",
|
|
);
|
|
}
|
|
return observed;
|
|
};
|
|
|
|
/** Retain the constraints later rule refinement needs from the same owned observations. */
|
|
export const noteHeldAmpersands = (
|
|
ampersands: Map<string, AmpersandSpelling>,
|
|
rules: readonly FieldRule[],
|
|
held: readonly JsonObject[],
|
|
): void => {
|
|
for (const rule of rules) {
|
|
const observed = heldAmpersandSpellings(rule, held);
|
|
const known = ampersands.get(rule.field);
|
|
if (observed.has("dropped")) ampersands.set(rule.field, "dropped");
|
|
else if (observed.has("unknown") && known !== "dropped")
|
|
ampersands.set(rule.field, "unknown");
|
|
else if (observed.has("and") && known === undefined)
|
|
ampersands.set(rule.field, "and");
|
|
}
|
|
};
|
|
|
|
/** Defaults joined, undefined when two calls showed one member left out at different values. */
|
|
const joinedDefaults = (
|
|
held: readonly Default[],
|
|
added: readonly Default[],
|
|
): Default[] | undefined => {
|
|
const joined = new Map(held.map((entry) => [entry.member, entry.value]));
|
|
for (const { member, value } of added) {
|
|
if (joined.has(member) && !same(joined.get(member), value))
|
|
return undefined;
|
|
joined.set(member, value);
|
|
}
|
|
return [...joined].map(([member, value]) => ({ member, value }));
|
|
};
|
|
|
|
/** A later call's rule for a field the plan kept as shown, when it spells the exemplar's value too: a string composed from the exemplar's fields or holding the value it templates, or a sequence that started at its value. */
|
|
const spellsExemplar = (
|
|
field: string,
|
|
rule: FieldRule,
|
|
calls: Pick<FieldCalls, "exemplar" | "earlier" | "later">,
|
|
): FieldRule | undefined => {
|
|
const value = ownMember(calls.exemplar, field);
|
|
if (rule.rule === "composed")
|
|
return value !== undefined &&
|
|
composedValue(rule.parts, calls.exemplar) === value
|
|
? rule
|
|
: undefined;
|
|
if (rule.rule === "template") {
|
|
const token = scalarText(ownMember(calls.exemplar, rule.from));
|
|
const next = scalarText(ownMember(calls.later.entity, rule.from));
|
|
return typeof value === "string" &&
|
|
token !== undefined &&
|
|
next !== undefined &&
|
|
containsDelimited(value, token) &&
|
|
replaceDelimited(value, token, next) ===
|
|
ownMember(calls.later.entity, field)
|
|
? rule
|
|
: undefined;
|
|
}
|
|
if (rule.rule !== "sequence") return undefined;
|
|
const start = calls.earlier.startOf?.(field);
|
|
const collections = calls.earlier.createCollections ?? [];
|
|
if (
|
|
(rule.scope === "type" && collections.length > 1) ||
|
|
(rule.scope === "collection" &&
|
|
new Set(collections).size !== collections.length)
|
|
)
|
|
return undefined;
|
|
return start !== undefined && sequenceNumber(value) === start
|
|
? { ...rule, start }
|
|
: undefined;
|
|
};
|
|
|
|
/** What two calls show of one field. */
|
|
interface FieldCalls {
|
|
readonly before: FieldRule | undefined;
|
|
readonly after: FieldRule | undefined;
|
|
readonly exemplar: JsonObject;
|
|
readonly later: { readonly entity: JsonObject; readonly body: JsonObject };
|
|
readonly sentBefore: ReadonlySet<string>;
|
|
/** Members an earlier call left out and the application stored a fixed value for (`body.defaults`). */
|
|
readonly defaulted: ReadonlySet<string>;
|
|
readonly required: readonly string[];
|
|
readonly earlier: EarlierEvidence;
|
|
}
|
|
|
|
/** A reference an earlier later call added: it stays while a call leaves its member out, and agrees with this call's when it shows it. */
|
|
const addedReference = (
|
|
field: string,
|
|
added: Extract<FieldRule, { rule: "reference" }>,
|
|
calls: FieldCalls,
|
|
): { readonly rule: FieldRule } | undefined => {
|
|
const { after, later } = calls;
|
|
if (!Object.hasOwn(later.entity, field))
|
|
return Object.hasOwn(later.body, added.member)
|
|
? undefined
|
|
: { rule: added };
|
|
const rule =
|
|
after === undefined
|
|
? undefined
|
|
: agreeing(added, after, {
|
|
field,
|
|
later: later.entity[field],
|
|
earlier: calls.earlier,
|
|
exemplar: calls.exemplar,
|
|
laterEntity: later.entity,
|
|
});
|
|
return rule === undefined ? undefined : { rule };
|
|
};
|
|
|
|
/** A field one call shows alone, which must be a reference the other call did not send the member of. */
|
|
const shownAlone = (
|
|
inExemplar: boolean,
|
|
calls: FieldCalls,
|
|
): { readonly rule: FieldRule } | undefined => {
|
|
const own = inExemplar ? calls.before : calls.after;
|
|
if (own?.rule !== "reference") return undefined;
|
|
const sent = inExemplar
|
|
? Object.hasOwn(calls.later.body, own.member)
|
|
: calls.sentBefore.has(own.member);
|
|
return sent ? undefined : { rule: own };
|
|
};
|
|
|
|
/** A member one call sent and stored as sent, and another left out and the application numbered: the value a call sends, else the next number. */
|
|
const sentOrNumbered = (
|
|
before: FieldRule,
|
|
after: FieldRule,
|
|
field: string,
|
|
calls: FieldCalls,
|
|
agree: (held: FieldRule) => FieldRule | undefined,
|
|
): FieldRule | undefined => {
|
|
const laterSent = Object.hasOwn(calls.later.body, field);
|
|
if (before.rule === "echo") {
|
|
// Serving numbers past every value a call sent, so a later call numbered at or below one cannot be repeated.
|
|
const numbered = sequenceNumber(ownMember(calls.later.entity, field));
|
|
const largest =
|
|
after.rule === "sequence"
|
|
? calls.earlier.sentLargest?.(field, after.scope)
|
|
: undefined;
|
|
// An earlier call that left the member out stored a fixed value, so the application does not number it.
|
|
return after.rule === "sequence" &&
|
|
!laterSent &&
|
|
!calls.defaulted.has(field) &&
|
|
(largest === undefined || (numbered !== undefined && numbered > largest))
|
|
? { ...after, sent: true }
|
|
: undefined;
|
|
}
|
|
if (before.rule !== "sequence") return undefined;
|
|
if (after.rule === "echo")
|
|
return before.sent === true || !calls.sentBefore.has(field)
|
|
? { ...before, sent: true }
|
|
: undefined;
|
|
if (before.sent !== true || after.rule !== "sequence" || laterSent)
|
|
return undefined;
|
|
const { sent: _sent, ...numbered } = before;
|
|
const merged = agree(numbered);
|
|
return merged?.rule === "sequence" ? { ...merged, sent: true } : undefined;
|
|
};
|
|
|
|
/** One field's rule in the merged plan, and the default it gives a member; undefined when the calls disagree on it. */
|
|
const mergedField = (
|
|
field: string,
|
|
calls: FieldCalls,
|
|
): { readonly rule?: FieldRule; readonly default?: Default } | undefined => {
|
|
const { before, after, exemplar, later } = calls;
|
|
const inExemplar = Object.hasOwn(exemplar, field);
|
|
if (!inExemplar && before?.rule === "reference")
|
|
return addedReference(field, before, calls);
|
|
if (!inExemplar || !Object.hasOwn(later.entity, field))
|
|
return shownAlone(inExemplar, calls);
|
|
if (before !== undefined && after !== undefined) {
|
|
const values = {
|
|
field,
|
|
later: later.entity[field],
|
|
earlier: calls.earlier,
|
|
exemplar,
|
|
laterEntity: later.entity,
|
|
};
|
|
const rule =
|
|
agreeing(before, after, values) ??
|
|
sentOrNumbered(before, after, field, calls, (held) =>
|
|
agreeing(held, after, values),
|
|
);
|
|
return rule === undefined ? undefined : { rule };
|
|
}
|
|
// The plan echoes a member this call left out: what it stored there is the member's default.
|
|
if (before !== undefined)
|
|
return before.rule === "echo" && !Object.hasOwn(later.body, field)
|
|
? {
|
|
rule: before,
|
|
default: { member: field, value: later.entity[field]! },
|
|
}
|
|
: undefined;
|
|
if (before === undefined && after !== undefined) {
|
|
const rule = spellsExemplar(field, after, calls);
|
|
if (rule !== undefined) return { rule };
|
|
}
|
|
// This call echoes a member the plan's calls left out: what they stored there is its default.
|
|
if (after !== undefined)
|
|
return after.rule === "echo" && !calls.required.includes(field)
|
|
? {
|
|
rule: after,
|
|
default: { member: field, value: ownMember(exemplar, field)! },
|
|
}
|
|
: undefined;
|
|
return same(ownMember(exemplar, field), later.entity[field]) ? {} : undefined;
|
|
};
|
|
|
|
/**
|
|
* A create plan widened by a later call, explained on its own: both calls show the same fields, but for a reference
|
|
* whose member a call without it did not send (one an earlier call added stays), every field both rule they rule alike
|
|
* as far as earlier calls allow, a field neither rules holds one value, and where only one echoes a member the other
|
|
* left out, the member becomes optional with the value the call that left it out stored. Members either call sent are
|
|
* accepted, and only those every call sent are required. Undefined when the calls disagree otherwise, so the later call
|
|
* stays unexplained.
|
|
*/
|
|
export const mergedCreatePlan = (
|
|
plan: { readonly rules: readonly FieldRule[]; readonly body: WriteBody },
|
|
exemplar: JsonObject,
|
|
later: {
|
|
readonly entity: JsonObject;
|
|
readonly body: JsonObject;
|
|
readonly rules: readonly FieldRule[];
|
|
readonly contract: WriteBody;
|
|
},
|
|
earlier: EarlierEvidence = {
|
|
kept: new Set(),
|
|
clockOf: (field) => ownMember(exemplar, field),
|
|
},
|
|
): { readonly rules: FieldRule[]; readonly body: WriteBody } | undefined => {
|
|
const held = new Map(plan.rules.map((rule) => [rule.field, rule]));
|
|
const shown = new Map(later.rules.map((rule) => [rule.field, rule]));
|
|
const sentBefore = new Set([
|
|
...plan.body.accepted,
|
|
...plan.body.fixed.map(({ member }) => member),
|
|
...plan.body.required,
|
|
]);
|
|
const merged = new Map<string, FieldRule>();
|
|
const defaults: Default[] = [];
|
|
for (const field of new Set([
|
|
...Object.keys(exemplar),
|
|
...Object.keys(later.entity),
|
|
...held.keys(),
|
|
])) {
|
|
const outcome = mergedField(field, {
|
|
before: held.get(field),
|
|
after: shown.get(field),
|
|
exemplar,
|
|
later,
|
|
sentBefore,
|
|
defaulted: new Set(
|
|
(plan.body.defaults ?? []).map(({ member }) => member),
|
|
),
|
|
required: plan.body.required,
|
|
earlier,
|
|
});
|
|
if (outcome === undefined) return undefined;
|
|
if (outcome.rule !== undefined) merged.set(field, outcome.rule);
|
|
if (outcome.default !== undefined) defaults.push(outcome.default);
|
|
}
|
|
const body = mergedBody(plan.body, later, exemplar);
|
|
const joined =
|
|
body === undefined
|
|
? undefined
|
|
: joinedDefaults(plan.body.defaults ?? [], defaults);
|
|
if (body === undefined || joined === undefined) return undefined;
|
|
// The plan's rules keep their order; rules the later call adds follow.
|
|
return {
|
|
rules: [
|
|
...plan.rules.flatMap((rule) => {
|
|
const kept = merged.get(rule.field);
|
|
return kept === undefined ? [] : [kept];
|
|
}),
|
|
...[...merged.values()].filter((rule) => !held.has(rule.field)),
|
|
],
|
|
body: joined.length === 0 ? body : { ...body, defaults: joined },
|
|
};
|
|
};
|
|
|
|
/** Every empty value recorded calls sent a member, the earliest first. */
|
|
const joinedBlanks = (
|
|
held: readonly Blank[],
|
|
added: readonly Blank[],
|
|
): Blank[] => {
|
|
const blank = [...held];
|
|
for (const entry of added)
|
|
if (
|
|
!blank.some(
|
|
({ member, sent }) => member === entry.member && same(sent, entry.sent),
|
|
)
|
|
)
|
|
blank.push(entry);
|
|
return blank;
|
|
};
|
|
|
|
/** Two calls' body contracts joined, undefined when a member one accepts with any value the other fixes, or both fix it at different values. */
|
|
const mergedBody = (
|
|
body: WriteBody,
|
|
later: {
|
|
readonly body: JsonObject;
|
|
readonly contract: WriteBody;
|
|
readonly entity: JsonObject;
|
|
},
|
|
exemplar: JsonObject,
|
|
): WriteBody | undefined => {
|
|
const fixed = new Map(body.fixed.map((entry) => [entry.member, entry.sent]));
|
|
const { contract } = later;
|
|
if (
|
|
contract.accepted.some((member) => fixed.has(member)) ||
|
|
contract.fixed.some(
|
|
(entry) =>
|
|
body.accepted.includes(entry.member) ||
|
|
(fixed.has(entry.member) && !same(fixed.get(entry.member), entry.sent)),
|
|
) ||
|
|
contract.envelope !== body.envelope
|
|
)
|
|
return undefined;
|
|
const added = contract.accepted.filter(
|
|
(member) => !body.accepted.includes(member),
|
|
);
|
|
const blank = joinedBlanks(body.blank ?? [], contract.blank ?? []);
|
|
return {
|
|
...body,
|
|
accepted: [...body.accepted, ...added],
|
|
fixed: [
|
|
...body.fixed,
|
|
...contract.fixed.filter((entry) => !fixed.has(entry.member)),
|
|
],
|
|
required: body.required.filter(
|
|
(member) =>
|
|
Object.hasOwn(later.body, member) && !isBlankValue(later.body[member]),
|
|
),
|
|
identity: body.identity ?? contract.identity,
|
|
kinds: [...body.kinds, ...storedKinds(added, exemplar, later.entity)],
|
|
...(blank.length === 0 ? {} : { blank }),
|
|
};
|
|
};
|