@dialecte/core 0.7.0 → 0.8.0

package/dist/store/store.types.d.ts

@@ -1,5 +1,7 @@
-import { DocumentRecord } from '../project/types';
-import { AnyRawRecord, BlobAttachment, BlobRecord, RecordPatch } from '../types';
+import { Diagnostic } from '../diagnostics';
+import { PerfSnapshot } from '../perf';
+import { DocumentRecord, DocumentUpdates, ProjectChannelMessage } from '../project/types';
+import { AnyRawRecord, BlobAttachment, BlobRecord, ChunkOptions, RecordPatch } from '../types';
 /**
  * RecordSchema — backend-agnostic index declaration for record tables.
  *
@@ -27,16 +29,71 @@ export type RecordSchema = {
  * All record operations are document-scoped via documentId.
  * Not generic on Config — stores raw records as-is.
  * Type narrowing lives in Document/Transaction, not here.
+ *
+ * What every store answers to, whichever its backend (the store contract suite checks it): a name is
+ * one state for every store of that name in its scope - a store built again under the name finds
+ * what was written, until a store of that name is destroyed. The scope is the backend's: an IndexedDB
+ * database is the origin's, an in-memory state the realm's. Records are values: once a write or a read
+ * returns, the caller's objects and the store are apart - changing one never changes the other
+ * (documents, records, changelog entries, blob entries; Blob data is immutable). List reads answer in
+ * id order - `getDocuments`, `getByDocumentId`, `getByTagNameInDocument`, the blob lists - ids compared
+ * by UTF-16 code unit, as an IndexedDB key range orders them; `getMany` answers in the order asked,
+ * `getChangeLog` in sequence order.
+ *
+ * A store holds JSON values only, in records, in document metadata and in blob entries (an added
+ * entry, an attached reference): well-formed strings, finite numbers, booleans, null, and arrays
+ * and plain objects of them under well-formed keys, nested at most 512 levels counted from what a
+ * write hands (its list of records or patches, or the document; a record's attribute value may then
+ * nest 508 levels, a metadata field's 510). A record is kept as its type has it: a field it carries
+ * beyond the type's - at its top, in its namespace or in its parent - is dropped. A field holding
+ * `undefined` is dropped: a record or a document created with one reads back without it, and an
+ * update leaves that field as it was. Any other value - a string or an object key holding a lone
+ * surrogate (SQLite would read it back changed), a Date, a Map, a Set, NaN or Infinity, a BigInt, a
+ * function, a symbol, an instance of a class, a raw JSON value, an object with a `toJSON` method,
+ * `undefined` in an array, a cycle, a value nested deeper - refuses the write whole with
+ * `STORE_VALUE_NOT_JSON`, nothing of it written; each write says where that comes in its order.
+ * Every store keeps well-formed text as written, code unit for code unit; an id or a tag name a
+ * call looks up that holds a lone surrogate names nothing (no store holds one). Hand values that
+ * read the same each time: one that does not (a getter answering something new) is kept as it read
+ * for one store and may be read again by another.
  */
 export interface Store {
-    /** Unique identifier for this store — used to scope the BroadcastChannel */
+    /** The name of the state this store reads and writes; also scopes the BroadcastChannel */
     readonly name: string;
-    /** Open the connection (if not already open) */
+    /**
+     * Open the connection (if not already open), once the operations still running have completed;
+     * refused with `STORE_CLOSED` when a `close()` was called after it (the close wins)
+     */
     open(): Promise<void>;
-    /** Close the connection */
-    close(): void;
-    /** Delete the database entirely (not just clear — remove from browser) */
+    /**
+     * Close this connection: every operation started through it from now on is refused with
+     * `STORE_CLOSED` until `open()` again (`destroy()` excepted); an operation already running
+     * completes. Settled once the connection counts no more - its running operations ended, and a
+     * destroy of the name asked after it, from this page or another tab, is not refused for it. The
+     * state of the name stays for the next store of that name and its other connections. Never await it
+     * inside an operation of the store (a hook, a transaction callback): it waits for that operation.
+     */
+    close(): Promise<void>;
+    /**
+     * Delete the state of the name entirely (the database, not just its content), once the operations
+     * still running have completed - this store's, and those of a store of the name closed while they
+     * ran: every store of the name then reads empty, until something is registered again. Refused
+     * `PROJECT_OPEN_ELSEWHERE`, nothing removed, while another connection - a store of the name in this
+     * page or in another tab - has it open. A store closed counts open no more (a store of another tab
+     * only once the operations it still runs have ended), and neither does one destroyed, until its
+     * next operation.
+     */
     destroy(): Promise<void>;
+    /**
+     * Tell `listener` every change of the project, made by this connection or another one, in this page or
+     * another tab: a store several connections share announces their changes itself (a project on it posts what the
+     * store tells, nothing else). A call that changed nothing announces nothing. The change a call of this connection
+     * made is told before that call settles - a store that implements this must keep that order. `resync`: changes
+     * may have been missed (the connection reached another engine): read the project again. A closed store is told
+     * nothing until opened again. Answers the unsubscribe. A store without it (IndexedDB, a custom one) leaves the
+     * announcing to the project's BroadcastChannel.
+     */
+    subscribe?(listener: (notice: StoreNotice) => void): () => void;
     /**
      * Bring this connection in sync with the shared persisted state (document
      * registry + schema) so a subsequent read sees documents imported/removed by
@@ -54,18 +111,36 @@ export interface Store {
      * connection.
      */
     isDocumentReadable(documentId: string): Promise<boolean>;
-    /** Register a new document — creates its backing storage partition */
+    /**
+     * Register a new document — creates its backing storage partition. An id already registered is
+     * refused with `STORE_DUPLICATE_ID`, the registered document left as it was; then a value that is
+     * not JSON with `STORE_VALUE_NOT_JSON`; then a `path` that is not valid or does not end with the
+     * document's file name (`name` + `extension`) with `DOCUMENT_PATH_INVALID`; then a place another
+     * document holds - the same path, or one a folder of the other's - with `DOCUMENT_PATH_TAKEN`. A
+     * document registered `importing` stays so (no update makes it ready): a store of the project opening
+     * again removes it, as what an import left.
+     */
     registerDocument(file: DocumentRecord): Promise<void>;
     /** Get a document record by id */
     getDocument(documentId: string): Promise<DocumentRecord | undefined>;
     /** Get all registered documents */
     getDocuments(): Promise<DocumentRecord[]>;
-    /** Update document metadata (name, metadata, import status and heartbeat) */
-    updateDocument(documentId: string, updates: Partial<Pick<DocumentRecord, 'name' | 'metadata' | 'status' | 'importingAt'>>): Promise<void>;
-    /** Remove a document and all its records (O(1) table clear) */
+    /**
+     * Update a document's name, path or metadata (not its status: only its import marks it ready, through
+     * `ImportTarget.markReady`; a `status` given is ignored): a value that is not JSON is refused
+     * first (`STORE_VALUE_NOT_JSON`); a field given as `undefined` is left as it was; a document that is
+     * not registered is then left alone. Its file name and its path stay one fact: a `path` moves and
+     * renames it (the name follows the file name, which must end with the document's extension), a
+     * `name` on a document with a path renames the file name in it; a result breaking a path rule, or
+     * a `name` and a `path` that disagree, is refused with `DOCUMENT_PATH_INVALID`, then a place another
+     * document holds with `DOCUMENT_PATH_TAKEN` - nothing changed (`applyDocumentUpdates`,
+     * `assertDocumentPlace`).
+     */
+    updateDocument(documentId: string, updates: DocumentUpdates): Promise<void>;
+    /** Remove a document, all its records, its history entries and the blobs it owns (O(1) table clear) */
     removeDocument(documentId: string): Promise<void>;
-    /** Get a single record by primary key. documentId optimizes lookup when known. */
-    get(id: string, documentId?: string): Promise<AnyRawRecord | undefined>;
+    /** Get a single record of a document by primary key. */
+    get(id: string, documentId: string): Promise<AnyRawRecord | undefined>;
     /** Get all records belonging to a document */
     getByDocumentId(documentId: string): Promise<AnyRawRecord[]>;
     /**
@@ -78,15 +153,61 @@ export interface Store {
     getByTagNameInDocument(tagName: string, documentId: string): Promise<AnyRawRecord[]>;
     /** Get many records by id in one call, ordered like `ids`; a missing id yields `undefined`. */
     getMany(ids: string[], documentId: string): Promise<(AnyRawRecord | undefined)[]>;
-    /** Bulk write - atomic creates/updates/deletes bypassing changelog. For import pipeline. */
+    /**
+     * Import one file next to the data: register the document `importing`, parse it with the
+     * dialecte's import session, store its records batch by batch, apply the session's writes, mark
+     * it `ready`. Answers the document, its record count and its diagnostics. Whatever fails, or an
+     * abort, leaves nothing of the file and throws the structured error (`PARSE_ERROR`,
+     * `IMPORT_ABORTED`, a store's refusal as it is - `STORE_VALUE_NOT_JSON` for a file, a `writeId`
+     * or `metadata` holding a value a store does not keep - `IMPORT_FAILED` wrapping anything else).
+     * `onProgress` is never awaited; `writeId` is generated when absent. A store that opens finds no
+     * import of a previous run: an unfinished import is removed when the store opens.
+     */
+    importFile(params: ImportFileParams): Promise<ImportFileResult>;
+    /**
+     * Export one document next to the data: its records read in batches, written as formatted XML (or compact with `indent: false`), answered as one UTF-8 `Blob` and its filename.
+     * Never reads the whole document in one call. A write on the document while it is exported restarts
+     * the export once from the start; a second one fails it with `EXPORT_CONFLICT`. An abort fails it with
+     * `EXPORT_ABORTED`; nothing is left either way. A document that is not registered, or still
+     * `importing`, is refused with `DOCUMENT_NOT_REGISTERED`. `onProgress` is never awaited.
+     */
+    exportFile(params: ExportFileParams): Promise<ExportFileResult>;
+    /**
+     * What became of a write - an import or a commit - asked by its id, after a lost connection, before
+     * reading again: `running` (an import still under way), `applied` (an import whose document is
+     * ready; a commit once committed - also after its undo, and after a later commit discarded it) or
+     * `not-applied` (it was refused, failed, was aborted or never started; or its document was removed
+     * since).
+     */
+    getWriteOutcome(params: {
+        writeId: string;
+    }): Promise<WriteOutcome>;
+    /**
+     * Bulk write - atomic creates/updates/deletes bypassing changelog. For import pipeline. Refused
+     * whole, in this order: a document not registered (`DOCUMENT_NOT_REGISTERED`), a create that is
+     * not JSON (`STORE_VALUE_NOT_JSON`), a create of an id the document holds or the batch holds twice
+     * (`STORE_DUPLICATE_ID`, `meta.recordIds`), an update patch that is not JSON. An update patch of an
+     * absent record (whatever it holds) and a delete of an absent id are ignored.
+     */
     bulkWrite(documentId: string, ops: {
         creates?: AnyRawRecord[];
         updates?: RecordPatch[];
         deletes?: string[];
     }): Promise<void>;
-    /** Atomic commit — all-or-nothing write scoped to a document */
+    /**
+     * Atomic commit — all-or-nothing write scoped to a document, one undoable history entry holding
+     * the whole records before and after. Refused whole, nothing written and no entry kept: a document
+     * not registered or still importing (`DOCUMENT_NOT_REGISTERED`), then a `writeId` that is not
+     * well-formed text (`STORE_VALUE_NOT_JSON`), then an update of a record the document does not hold
+     * (`STORE_RECORD_NOT_FOUND`, `meta.recordId`), then a create that is not JSON
+     * (`STORE_VALUE_NOT_JSON`), then a create of an id the document holds or the commit holds twice
+     * (`STORE_DUPLICATE_ID`, `meta.recordIds`), then an update that is not JSON. A delete of an absent
+     * id is ignored. `writeId` is the caller's id for the commit, kept on its history entry and asked by
+     * `getWriteOutcome`; generated when absent.
+     */
     commit(params: {
         documentId: string;
+        writeId?: string;
         creates: AnyRawRecord[];
         updates: AnyRawRecord[];
         deletes: string[];
@@ -135,12 +256,109 @@ export interface Store {
      */
     getDatabaseInstance(): unknown;
 }
+/** What a file's import is asked to do: plain data, it crosses a worker boundary as is. */
+export type ImportFileOptions = {
+    /** Key into the dialecte's configs. Defaults to its default key. */
+    configKey?: string;
+    /** Extensible per-file metadata */
+    metadata?: Record<string, unknown>;
+    /** Override chunking defaults for SAX streaming */
+    chunkOptions?: Partial<ChunkOptions>;
+    /** Use custom record IDs from XML attributes instead of generating UUIDs */
+    useCustomRecordsIds?: boolean;
+    /**
+     * Where the document sits in the project (`substations/north.scd`): it takes its name and its extension from the
+     * path's file name, not from the file's, and the extension must be one its config reads (`.xml` always read besides
+     * its list). Refused before anything is registered: `DOCUMENT_PATH_INVALID` for a path breaking a rule or of another
+     * extension, `DOCUMENT_PATH_TAKEN` for a place another document holds.
+     */
+    path?: string;
+};
+/**
+ * What an import is doing: `storing` while it reads the file and stores it (the edits of other views
+ * are served between its transactions), `indexing` while it builds an index of the document (they
+ * wait until it is built). A store that builds no index only ever says `storing`.
+ */
+export type ImportPhase = 'storing' | 'indexing';
+/** How far an import is: what it is doing, and the bytes of the file parsed so far, out of its size. */
+export type ImportProgress = {
+    phase: ImportPhase;
+    bytesRead: number;
+    totalBytes: number;
+};
+/**
+ * What a caller holds over an import that runs: kept apart from the import's data, as a worker call
+ * carries the listener as an argument of its own and the abort as a call of its own.
+ */
+export type ImportControl = {
+    /** Told after each stored batch; never awaited, its failure ignored. */
+    onProgress?: (progress: ImportProgress) => void;
+    /** Aborts the import at the next batch: nothing of the file remains, `IMPORT_ABORTED` thrown. */
+    signal?: AbortSignal;
+};
+export type ImportFileParams = ImportControl & {
+    file: File;
+    options?: ImportFileOptions;
+    /** The caller's id for this import, asked by `getWriteOutcome`; generated when absent. */
+    writeId?: string;
+};
+/** A file the store imported. */
+export type ImportFileResult = {
+    /** The document, `ready` */
+    record: DocumentRecord;
+    recordCount: number;
+    /** What the import session had to say about the file; `[]` when nothing */
+    diagnostics: Diagnostic[];
+    /** The timings of the import's stages, on the clock of the realm that ran it; with perf on only */
+    perf?: PerfSnapshot;
+};
+/** How a document is written: plain data, it crosses a worker boundary as is. */
+export type ExportFileOptions = {
+    /** Formatted (4 spaces, CRLF, a text value on its element's line); `false` = compact. Default `true`. */
+    indent?: boolean;
+    /** The record id as `_temp-idb-id` on every element. Default `false`. */
+    withDatabaseIds?: boolean;
+    /** Records read per call and written per batch. Default `EXPORT_BATCH_SIZE`. */
+    batchSize?: number;
+};
+/** How far an export is: the records written so far, out of the document's. */
+export type ExportProgress = {
+    recordsWritten: number;
+    totalRecords: number;
+};
+/** What a caller holds over an export that runs, kept apart from its data as for an import. */
+export type ExportControl = {
+    /**
+     * Told after each written batch; never awaited, its failure ignored. An export restarted by a write on its
+     * document tells its progress from the start again.
+     */
+    onProgress?: (progress: ExportProgress) => void;
+    /** Aborts the export at the next batch: `EXPORT_ABORTED`, nothing answered. */
+    signal?: AbortSignal;
+};
+export type ExportFileParams = ExportControl & {
+    documentId: string;
+    options?: ExportFileOptions;
+};
+/** A document the store exported. */
+export type ExportFileResult = {
+    /** The document as UTF-8 XML (`application/xml`) */
+    file: Blob;
+    /** The document's name and extension */
+    filename: string;
+    /** The timings of the export's stages, on the clock of the realm that ran it; with perf on only */
+    perf?: PerfSnapshot;
+};
+/** What became of a write asked by its id. */
+export type WriteOutcome = 'applied' | 'running' | 'not-applied';
 export type ChangeLogEntry = {
-    /** Auto-increment primary key (assigned by Dexie) */
+    /** Auto-increment primary key, assigned by the store */
     id: number;
     documentId: string;
     sequenceNumber: number;
     timestamp: number;
+    /** The id of the commit that wrote the entry */
+    writeId: string;
     operations: {
         creates: AnyRawRecord[];
         updates: {
@@ -155,4 +373,50 @@ export type ChangeLogMeta = {
     key: string;
     value: number;
 };
+/**
+ * What an import writes through: the store operations `runImport` calls, the ones the parser writes through
+ * (`ParseTarget`) among them. A store runs
+ * its own import against a target of its own, which a `close()` after the import started does not
+ * refuse - the import is one operation and completes.
+ */
+export type ImportTarget = Pick<Store, 'registerDocument' | 'getDocument' | 'removeDocument' | 'bulkWrite'> & {
+    /**
+     * The imported document ready, once every record and write of its session is stored: the one way a document
+     * becomes ready (`updateDocument` takes no `status`). Refused `DOCUMENT_NOT_REGISTERED` when the document is no
+     * longer there `importing` (removed meanwhile, or another one registered since under its id).
+     */
+    markReady(documentId: string): Promise<void>;
+    /**
+     * The writes of the import's session, once every record of the file is stored (`bulkWrite` takes the file's):
+     * checked as `bulkWrite` checks them, a create of an id the file gave refused `STORE_DUPLICATE_ID` as one the
+     * document holds. A store whose import keeps no list of the ids it made looks them up here.
+     */
+    writeSession(documentId: string, ops: {
+        creates?: AnyRawRecord[];
+        updates?: RecordPatch[];
+        deletes?: string[];
+    }): Promise<void>;
+};
+/**
+ * What an export reads through: the store's reads, and the version of a document - how many writes it
+ * has taken, `undefined` once it is not registered or not `ready`. A store runs its own export against a
+ * source of its own, which a `close()` after the export started does not refuse.
+ */
+export type ExportSource = Pick<Store, 'getDocument' | 'count' | 'getMany' | 'getByTagNameInDocument'> & {
+    getExportVersion(params: {
+        documentId: string;
+    }): Promise<number | undefined>;
+};
+/** A change of the project, told to a connection: the project event, and whether this connection made it. */
+export type StoreChange = {
+    type: 'change';
+    message: ProjectChannelMessage;
+    own: boolean;
+};
+/** Changes may have been missed (the connection reached another engine): read the project again. */
+export type StoreResync = {
+    type: 'resync';
+};
+/** What a store that announces tells its connections. */
+export type StoreNotice = StoreChange | StoreResync;
 //# sourceMappingURL=store.types.d.ts.map

package/dist/store/store.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.types.d.ts","sourceRoot":"","sources":["../../src/store/store.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAEpF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,sEAAsE;IACtE,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,0DAA0D;IAC1D,eAAe,EAAE,MAAM,EAAE,EAAE,CAAA;IAC3B,oGAAoG;IACpG,YAAY,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAK;IACrB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAIrB,gDAAgD;IAChD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB,2BAA2B;IAC3B,KAAK,IAAI,IAAI,CAAA;IAEb,0EAA0E;IAC1E,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAIxB;;;;;;;;;OASG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAIxD,sEAAsE;IACtE,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErD,kCAAkC;IAClC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAA;IAEpE,mCAAmC;IACnC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAEzC,6EAA6E;IAC7E,cAAc,CACb,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAC,CAAC,GACpF,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,+DAA+D;IAC/D,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAIjD,kFAAkF;IAClF,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAA;IAEvE,8CAA8C;IAC9C,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE5D;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE1C,gEAAgE;IAChE,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAEpF,+FAA+F;IAC/F,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,YAAY,GAAG,SAAS,CAAC,EAAE,CAAC,CAAA;IAIjF,4FAA4F;IAC5F,SAAS,CACR,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE;QAAE,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAC5E,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,gEAAgE;IAChE,MAAM,CAAC,MAAM,EAAE;QACd,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,EAAE,YAAY,EAAE,CAAA;QACvB,OAAO,EAAE,YAAY,EAAE,CAAA;QACvB,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;KACpD,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAIjB,oFAAoF;IACpF,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC,oEAAoE;IACpE,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC,+DAA+D;IAC/D,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;IAErF,gFAAgF;IAChF,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAI3D;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErD,iDAAiD;IACjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,GAAG,SAAS,CAAC,CAAA;IAE/E,6FAA6F;IAC7F,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE7D,6EAA6E;IAC7E,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE9E,qFAAqF;IACrF,kBAAkB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE3C,iFAAiF;IACjF,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE9D,oFAAoF;IACpF,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzF,+EAA+E;IAC/E,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC;;;;OAIG;IACH,mBAAmB,IAAI,OAAO,CAAA;CAC9B;AAED,MAAM,MAAM,cAAc,GAAG;IAC5B,qDAAqD;IACrD,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE;QACX,OAAO,EAAE,YAAY,EAAE,CAAA;QACvB,OAAO,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,KAAK,EAAE,YAAY,CAAA;SAAE,EAAE,CAAA;QACxD,OAAO,EAAE,YAAY,EAAE,CAAA;KACvB,CAAA;CACD,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,aAAa,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACb,CAAA"}
+{"version":3,"file":"store.types.d.ts","sourceRoot":"","sources":["../../src/store/store.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAA;AAC7F,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAElG;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,sEAAsE;IACtE,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,0DAA0D;IAC1D,eAAe,EAAE,MAAM,EAAE,EAAE,CAAA;IAC3B,oGAAoG;IACpG,YAAY,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,WAAW,KAAK;IACrB,0FAA0F;IAC1F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAIrB;;;OAGG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;;;;;;OAOG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;;;;;;;OAQG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAIxB;;;;;;;;OAQG;IACH,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,GAAG,MAAM,IAAI,CAAA;IAI/D;;;;;;;;;OASG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAIxD;;;;;;;;OAQG;IACH,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErD,kCAAkC;IAClC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAA;IAEpE,mCAAmC;IACnC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAEzC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3E,uGAAuG;IACvG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAMjD,wDAAwD;IACxD,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAA;IAEtE,8CAA8C;IAC9C,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE5D;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE1C,gEAAgE;IAChE,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAEpF,+FAA+F;IAC/F,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,YAAY,GAAG,SAAS,CAAC,EAAE,CAAC,CAAA;IAIjF;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAI/D;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE/D;;;;;;OAMG;IACH,eAAe,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAInE;;;;;;OAMG;IACH,SAAS,CACR,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE;QAAE,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAC5E,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE;QACd,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,YAAY,EAAE,CAAA;QACvB,OAAO,EAAE,YAAY,EAAE,CAAA;QACvB,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;KACpD,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAIjB,oFAAoF;IACpF,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC,oEAAoE;IACpE,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC,+DAA+D;IAC/D,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;IAErF,gFAAgF;IAChF,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAI3D;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErD,iDAAiD;IACjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,GAAG,SAAS,CAAC,CAAA;IAE/E,6FAA6F;IAC7F,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE7D,6EAA6E;IAC7E,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE9E,qFAAqF;IACrF,kBAAkB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE3C,iFAAiF;IACjF,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE9D,oFAAoF;IACpF,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzF,+EAA+E;IAC/E,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC;;;;OAIG;IACH,mBAAmB,IAAI,OAAO,CAAA;CAC9B;AAED,2FAA2F;AAC3F,MAAM,MAAM,iBAAiB,GAAG;IAC/B,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,mDAAmD;IACnD,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;IACpC,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,UAAU,CAAA;AAEhD,wGAAwG;AACxG,MAAM,MAAM,cAAc,GAAG;IAC5B,KAAK,EAAE,WAAW,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,wEAAwE;IACxE,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,iGAAiG;IACjG,MAAM,CAAC,EAAE,WAAW,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC9C,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,CAAC,EAAE,iBAAiB,CAAA;IAC3B,0FAA0F;IAC1F,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,iCAAiC;AACjC,MAAM,MAAM,gBAAgB,GAAG;IAC9B,4BAA4B;IAC5B,MAAM,EAAE,cAAc,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,2EAA2E;IAC3E,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,mGAAmG;IACnG,IAAI,CAAC,EAAE,YAAY,CAAA;CACnB,CAAA;AAED,iFAAiF;AACjF,MAAM,MAAM,iBAAiB,GAAG;IAC/B,yGAAyG;IACzG,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,yEAAyE;IACzE,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,+EAA+E;AAC/E,MAAM,MAAM,cAAc,GAAG;IAC5B,cAAc,EAAE,MAAM,CAAA;IACtB,YAAY,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,aAAa,GAAG;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,+EAA+E;IAC/E,MAAM,CAAC,EAAE,WAAW,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC9C,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,gBAAgB,GAAG;IAC9B,oDAAoD;IACpD,IAAI,EAAE,IAAI,CAAA;IACV,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,mGAAmG;IACnG,IAAI,CAAC,EAAE,YAAY,CAAA;CACnB,CAAA;AAED,8CAA8C;AAC9C,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,CAAA;AAEhE,MAAM,MAAM,cAAc,GAAG;IAC5B,wDAAwD;IACxD,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE;QACX,OAAO,EAAE,YAAY,EAAE,CAAA;QACvB,OAAO,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,KAAK,EAAE,YAAY,CAAA;SAAE,EAAE,CAAA;QACxD,OAAO,EAAE,YAAY,EAAE,CAAA;KACvB,CAAA;CACD,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,aAAa,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAC9B,KAAK,EACL,kBAAkB,GAAG,aAAa,GAAG,gBAAgB,GAAG,WAAW,CACnE,GAAG;IACH;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5C;;;;OAIG;IACH,YAAY,CACX,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE;QAAE,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAC5E,OAAO,CAAC,IAAI,CAAC,CAAA;CAChB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAC9B,KAAK,EACL,aAAa,GAAG,OAAO,GAAG,SAAS,GAAG,wBAAwB,CAC9D,GAAG;IACH,gBAAgB,CAAC,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CAC7E,CAAA;AAED,6GAA6G;AAC7G,MAAM,MAAM,WAAW,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,qBAAqB,CAAC;IAAC,GAAG,EAAE,OAAO,CAAA;CAAE,CAAA;AAE1F,oGAAoG;AACpG,MAAM,MAAM,WAAW,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAA;AAE5C,yDAAyD;AACzD,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,WAAW,CAAA"}

package/dist/store/stored-record.d.ts

@@ -0,0 +1,16 @@
+import { AnyRawRecord } from '../types';
+/**
+ * A record as every store keeps it: the fields of the record type - its id, tag name, namespace (prefix
+ * and uri), attributes, value, parent (id and tag name, or none) and children - and nothing else the
+ * object carries, at its top, in its namespace or in its parent (attributes and children are kept as
+ * given). A store checks the whole record as JSON first, so a value that is not JSON is refused even
+ * in a field it then drops.
+ */
+export declare function storedRecordOf(params: {
+    record: AnyRawRecord;
+}): AnyRawRecord;
+/** A store's own copies of records a write hands it: checked whole as JSON values, kept as the record type has them. */
+export declare function toStoredRecords(params: {
+    records: AnyRawRecord[];
+}): AnyRawRecord[];
+//# sourceMappingURL=stored-record.d.ts.map

package/dist/store/stored-record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stored-record.d.ts","sourceRoot":"","sources":["../../src/store/stored-record.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAE3C;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,YAAY,CAAA;CAAE,GAAG,YAAY,CAY7E;AAED,wHAAwH;AACxH,wBAAgB,eAAe,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,YAAY,EAAE,CAEnF"}

package/dist/store/unfinished-imports.d.ts

@@ -0,0 +1,15 @@
+import { Store } from './store.types';
+import { DocumentRecord } from '../project/types';
+/**
+ * Remove every document an import left `importing`: an import never outlives the store that ran
+ * it, so what a store finds `importing` when it opens is a leftover - a closed tab, a crash. A store
+ * shared by several connections names the imports still running (`isRunning`): they are kept. A row
+ * is read again before it goes, so an import that ended since the registry was listed stays.
+ *
+ * @intent clean up the imports a closed tab or a crash left behind, clean up leftover imports when a custom store opens
+ */
+export declare function removeUnfinishedImports(params: {
+    store: Pick<Store, 'getDocuments' | 'getDocument' | 'removeDocument'>;
+    isRunning?: (document: DocumentRecord) => boolean | Promise<boolean>;
+}): Promise<void>;
+//# sourceMappingURL=unfinished-imports.d.ts.map

package/dist/store/unfinished-imports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unfinished-imports.d.ts","sourceRoot":"","sources":["../../src/store/unfinished-imports.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAErD;;;;;;;GAOG;AACH,wBAAsB,uBAAuB,CAAC,MAAM,EAAE;IACrD,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,cAAc,GAAG,aAAa,GAAG,gBAAgB,CAAC,CAAA;IACrE,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACpE,GAAG,OAAO,CAAC,IAAI,CAAC,CAShB"}

package/dist/store/write-outcome.d.ts

@@ -0,0 +1,34 @@
+import { WriteOutcome } from './store.types';
+import { DocumentRecord } from '../project/types';
+/**
+ * What became of an import, read from the registry: the document its `writeId` is on is `running`
+ * while `importing`, `applied` once `ready`; no document carries it after a failure, an abort or a
+ * removal - `not-applied`. A store that knows which imports run says so (`isRunning`): a document
+ * `importing` whose import does not run is what a failed import left when its removal failed too -
+ * `not-applied`, removed when a store of the project next opens.
+ *
+ * @intent tell whether an import is running, applied or not applied, recover after a connection lost during an import
+ */
+export declare function importOutcomeOf(params: {
+    documents: readonly DocumentRecord[];
+    writeId: string;
+    isRunning?: (params: {
+        writeId: string;
+    }) => boolean;
+}): WriteOutcome;
+/**
+ * What became of a write - an import or a commit - read from the registry first, then from the
+ * history: `committed` says whether a history entry carries the id (a commit is applied whole or not
+ * at all, never running).
+ *
+ * @intent tell whether an import or a commit was applied, recover after a connection lost during a write
+ */
+export declare function writeOutcomeOf(params: {
+    documents: readonly DocumentRecord[];
+    writeId: string;
+    committed: boolean;
+    isRunning?: (params: {
+        writeId: string;
+    }) => boolean;
+}): WriteOutcome;
+//# sourceMappingURL=write-outcome.d.ts.map

package/dist/store/write-outcome.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-outcome.d.ts","sourceRoot":"","sources":["../../src/store/write-outcome.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAErD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE;IACvC,SAAS,EAAE,SAAS,cAAc,EAAE,CAAA;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAA;CACpD,GAAG,YAAY,CAMf;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE;IACtC,SAAS,EAAE,SAAS,cAAc,EAAE,CAAA;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAA;CACpD,GAAG,YAAY,CAKf"}

package/dist/test/assert-valid-xml/assert-valid-xml.constants.d.ts

@@ -0,0 +1,7 @@
+/** Attributes any element may carry: namespace declarations, `xsi:*`, and the test record id. */
+export declare const ALWAYS_ALLOWED_NAMESPACE_URIS: readonly string[];
+/** The local name of `xsi:type`, in the XSI namespace. */
+export declare const XSI_TYPE_ATTRIBUTE_NAME = "type";
+/** What an XML declaration begins with. */
+export declare const XML_DECLARATION_START = "<?xml";
+//# sourceMappingURL=assert-valid-xml.constants.d.ts.map

package/dist/test/assert-valid-xml/assert-valid-xml.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-valid-xml.constants.d.ts","sourceRoot":"","sources":["../../../src/test/assert-valid-xml/assert-valid-xml.constants.ts"],"names":[],"mappings":"AAEA,iGAAiG;AACjG,eAAO,MAAM,6BAA6B,EAAE,SAAS,MAAM,EAI1D,CAAA;AAED,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB,SAAS,CAAA;AAE7C,2CAA2C;AAC3C,eAAO,MAAM,qBAAqB,UAAU,CAAA"}

package/dist/test/assert-valid-xml/assert-valid-xml.d.ts

@@ -1,26 +1,27 @@
-import { AssertValidXmlOptions, AssertValidXmlTestCasesParams, CreateXmlSchemaAssertionsParams } from './assert-valid-xml.types';
+import { AssertValidXmlParams, AssertValidXmlTestCasesParams, CreateXmlSchemaAssertionsParams } from './assert-valid-xml.types';
 /**
- * Create structural XML assertions bound to a dialecte's generated `definition`
- * and declared `namespaces`. Instantiate once per dialecte (e.g. in scl test) and
- * re-export alongside createTestProject, like createXmlAssertions.
+ * Structural schema assertions for tests, bound to a dialecte's generated `definition` and declared `namespaces`:
+ * `assertValidXml` (and its table form `assertValidXmlTestCases`) fails when an XML text holds an element in the
+ * wrong namespace, an element its parent may not hold, an unknown attribute or, with `requireComplete`, a missing
+ * required attribute. It is not a full XSD validation: it does not check the order of children, how many times a
+ * child occurs (min/max, a missing required child), attribute values (patterns, enumerations, datatypes) nor
+ * constraints across elements (unique keys, key references). Made once per dialecte (e.g. in scl's
+ * test entry) and offered beside `createTestProject`, like `createXmlAssertions`.
  *
- * `assertValidXml` asserts, structurally: every element's namespace matches its
- * parent context, every element is an allowed child of its parent, and every
- * attribute is a known attribute of its element - in whatever namespace: declared by the element (a dialecte
- * namespace under any prefix the document binds), or allowed by its attribute wildcard. Namespace declarations,
- * `xsi:*` and the test record id are always allowed. Elements unknown to the schema are
- * skipped (bespoke content under a transparent `Private`), and so is any element in
- * a namespace the dialecte does not declare — even when its local name collides with
- * a schema element. An element in NO namespace is not foreign — it is a schema
- * element the snippet forgot to put in its namespace, and stays validated.
+ * What it checks: every element's namespace matches its parent context, every element is an allowed child of its
+ * parent, and every attribute is a known attribute of its element - in whatever namespace: declared by the element
+ * (a dialecte namespace under any prefix the document binds), or allowed by its attribute wildcard. Namespace
+ * declarations, `xsi:*` and the test record id are always allowed. Elements unknown to the schema are skipped
+ * (bespoke content under a transparent `Private`), and so is any element in a namespace the dialecte does not
+ * declare - even when its local name collides with a schema element. An element in NO namespace is not foreign - it
+ * is a schema element the snippet forgot to put in its namespace, and stays validated.
  *
- * `requireComplete` (default `true`) additionally requires every schema-required
- * attribute to be present. NOT yet enforced (planned with the validation feature):
- * attribute VALUE facets (uuid pattern, enums, datatypes) and cross-element
- * constraints (unique keys, keyref resolution).
+ * `requireComplete` (default `true`) additionally requires every schema-required attribute to be present.
+ *
+ * @intent validate an exported XML file against the schema in a test, check exported XML against the XSD structure (namespaces, allowed children, known and required attributes), assert in a test that a document is structurally valid for its schema
  */
 export declare function createXmlSchemaAssertions(params: CreateXmlSchemaAssertionsParams): {
-    assertValidXml: (xml: string, label?: string, options?: AssertValidXmlOptions) => void;
+    assertValidXml: (params: AssertValidXmlParams) => void;
     assertValidXmlTestCases: (params: AssertValidXmlTestCasesParams) => void;
 };
 //# sourceMappingURL=assert-valid-xml.d.ts.map

package/dist/test/assert-valid-xml/assert-valid-xml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assert-valid-xml.d.ts","sourceRoot":"","sources":["../../../src/test/assert-valid-xml/assert-valid-xml.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACX,qBAAqB,EACrB,6BAA6B,EAG7B,+BAA+B,EAE/B,MAAM,0BAA0B,CAAA;AAUjC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,+BAA+B;0BAgO1E,MAAM,4BAEF,qBAAqB,KAC5B,IAAI;sCAWkC,6BAA6B,KAAG,IAAI;EAqB7E"}
+{"version":3,"file":"assert-valid-xml.d.ts","sourceRoot":"","sources":["../../../src/test/assert-valid-xml/assert-valid-xml.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACX,oBAAoB,EACpB,6BAA6B,EAG7B,+BAA+B,EAE/B,MAAM,0BAA0B,CAAA;AAGjC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,+BAA+B;6BAoPhD,oBAAoB,KAAG,IAAI;sCAWlB,6BAA6B,KAAG,IAAI;EAqB7E"}

package/dist/test/assert-valid-xml/assert-valid-xml.types.d.ts

@@ -1,6 +1,10 @@
+import { XmlElement } from '../xml';
 import { AnyDefinition, AnyDialecteConfig, AnyTypes, ResolvedDefinition } from '../../types';
-/** Options controlling how strict a single-document validation is. */
-export type AssertValidXmlOptions = {
+/** One XML string to validate, how it is named in the messages and how strict the validation is. */
+export type AssertValidXmlParams = {
+    xml: string;
+    /** Names the XML in the messages. Default `'test XML'`. */
+    label?: string;
     /**
      * Also require every schema-required attribute to be present. Default `true`;
      * minimal fixtures legitimately omit required attributes (a bare `<SCL>` without
@@ -19,7 +23,7 @@ export type CreateXmlSchemaAssertionsParams = {
     schemaName?: string;
 };
 export type CollectElementViolationsParams = {
-    element: Element;
+    element: XmlElement;
     /** The parent element's definition as it applies there; `undefined` at the root or under a foreign element. */
     parent: {
         localName: string;
@@ -28,7 +32,7 @@ export type CollectElementViolationsParams = {
     requireComplete: boolean;
 };
 export type CollectAttributeViolationsParams = {
-    element: Element;
+    element: XmlElement;
     elementDefinition: ResolvedDefinition;
     requireComplete: boolean;
 };

package/dist/test/assert-valid-xml/assert-valid-xml.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assert-valid-xml.types.d.ts","sourceRoot":"","sources":["../../../src/test/assert-valid-xml/assert-valid-xml.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE7F,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG;IACnC;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC7C,yEAAyE;IACzE,UAAU,EAAE,aAAa,CAAA;IACzB,kGAAkG;IAClG,KAAK,EAAE,QAAQ,CAAA;IACf,2EAA2E;IAC3E,UAAU,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAA;IAC3C,iFAAiF;IACjF,UAAU,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC5C,OAAO,EAAE,OAAO,CAAA;IAChB,+GAA+G;IAC/G,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,kBAAkB,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAA;IACrF,eAAe,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC9C,OAAO,EAAE,OAAO,CAAA;IAChB,iBAAiB,EAAE,kBAAkB,CAAA;IACrC,eAAe,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAEzE,MAAM,MAAM,6BAA6B,GAAG;IAC3C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC5C,CAAA"}
+{"version":3,"file":"assert-valid-xml.types.d.ts","sourceRoot":"","sources":["../../../src/test/assert-valid-xml/assert-valid-xml.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE7F,oGAAoG;AACpG,MAAM,MAAM,oBAAoB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAA;IACX,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC7C,yEAAyE;IACzE,UAAU,EAAE,aAAa,CAAA;IACzB,kGAAkG;IAClG,KAAK,EAAE,QAAQ,CAAA;IACf,2EAA2E;IAC3E,UAAU,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAA;IAC3C,iFAAiF;IACjF,UAAU,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC5C,OAAO,EAAE,UAAU,CAAA;IACnB,+GAA+G;IAC/G,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,kBAAkB,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAA;IACrF,eAAe,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC9C,OAAO,EAAE,UAAU,CAAA;IACnB,iBAAiB,EAAE,kBAAkB,CAAA;IACrC,eAAe,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAEzE,MAAM,MAAM,6BAA6B,GAAG;IAC3C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC5C,CAAA"}

package/dist/test/assert-xml/assert-xml.constants.d.ts

@@ -0,0 +1,25 @@
+/** The label of the queried text in a malformed-XML message. */
+export declare const QUERIED_XML_LABEL = "queried XML";
+/** How many lines of context a failure message prints. */
+export declare const FAILURE_CONTEXT_MAX_LINES = 200;
+/** How many candidates the `nearby` line lists. */
+export declare const NEARBY_CANDIDATE_LIMIT = 10;
+/** The width of a message line's label column. */
+export declare const MESSAGE_LABEL_WIDTH = 9;
+/** The indentation of a message line, and of the XML printed under `context` or `element`. */
+export declare const MESSAGE_LINE_INDENT = "  ";
+export declare const MESSAGE_XML_INDENT = "    ";
+/** The first line of each failure message. */
+export declare const FAILURE_HEADERS: {
+    readonly expectedNotFound: "Expected element not found";
+    readonly unexpectedFound: "Unexpected element found";
+    readonly refused: "Query refused";
+    readonly unreliable: "Unexpected element check unreliable";
+};
+/** The last line the engine keeps for a node: a node on a later line reads as this one. */
+export declare const LAST_KEPT_LINE = 65535;
+/** The axis an abbreviated step separator stands for. */
+export declare const ABBREVIATED_AXES: Record<string, string>;
+/** The XPath union operator. */
+export declare const UNION_OPERATOR = "|";
+//# sourceMappingURL=assert-xml.constants.d.ts.map

package/dist/test/assert-xml/assert-xml.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-xml.constants.d.ts","sourceRoot":"","sources":["../../../src/test/assert-xml/assert-xml.constants.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,eAAO,MAAM,iBAAiB,gBAAgB,CAAA;AAE9C,0DAA0D;AAC1D,eAAO,MAAM,yBAAyB,MAAM,CAAA;AAE5C,mDAAmD;AACnD,eAAO,MAAM,sBAAsB,KAAK,CAAA;AAExC,kDAAkD;AAClD,eAAO,MAAM,mBAAmB,IAAI,CAAA;AAEpC,8FAA8F;AAC9F,eAAO,MAAM,mBAAmB,OAAO,CAAA;AACvC,eAAO,MAAM,kBAAkB,SAAS,CAAA;AAExC,8CAA8C;AAC9C,eAAO,MAAM,eAAe;;;;;CAKlB,CAAA;AAEV,2FAA2F;AAC3F,eAAO,MAAM,cAAc,QAAQ,CAAA;AAEnC,yDAAyD;AACzD,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAGnD,CAAA;AAED,gCAAgC;AAChC,eAAO,MAAM,cAAc,MAAM,CAAA"}