@dialecte/core 0.7.0 → 0.8.1

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

@@ -0,0 +1,56 @@
+import { Heartbeat, ServedClient, StoreEvents } from '../../engine/host/host.types';
+import { SqliteEngine, SqliteEngineOptions } from '../engine/engine.types';
+import { SAHPoolUtil, Sqlite3Static } from '@sqlite.org/sqlite-wasm';
+/** What a SQLite engine opens with besides what every engine is told (`EngineOpenParams.settings`). */
+export type SqliteEngineSettings = {
+    /** The consumer's one SQLite wasm file. */
+    wasmUrl: string;
+    options?: Partial<SqliteEngineOptions>;
+    /** How many SQLite steps between two of its progress handler's calls (`PROGRESS_BEAT_OPS` when absent). */
+    progressBeatOps?: number;
+};
+/** An engine worker's state: the project it serves, its pool, its lock, the engine, the client ports. */
+export type EngineRuntimeState = {
+    project: string | undefined;
+    pool: SAHPoolUtil | undefined;
+    /** Releases the engine lock (held from the open until `close` or `destroy`). */
+    releaseLock: (() => void) | undefined;
+    engine: SqliteEngine | undefined;
+    /** The project's channel, open while the engine is. */
+    events: StoreEvents | undefined;
+    /** The engine's sign of life on the client ports, while it is open. */
+    heartbeat: Heartbeat | undefined;
+    clients: Map<string, ServedClient>;
+};
+/** What the pool's install is given: sqlite-wasm's options, with the one its types leave out. */
+export type PoolInstallOptions = Parameters<Sqlite3Static['installOpfsSAHPoolVfs']>[0] & {
+    /** An install that failed before in this worker tried again, not its failure answered again. */
+    forceReinitIfPreviouslyFailed?: boolean;
+};
+/** The project's lock, held: release it once the engine no longer touches the files. */
+export type HeldEngineLock = {
+    release: () => void;
+};
+/** A file of the private file system as a dedicated worker reaches it (the page's types lack this member). */
+export type SyncAccessFileHandle = FileSystemFileHandle & {
+    createSyncAccessHandle: () => Promise<PoolFileAccess>;
+};
+/** The synchronous access a worker has to a pool file, as far as the runtime uses it. */
+export type PoolFileAccess = {
+    close: () => void;
+    getSize: () => number;
+    read: (buffer: Uint8Array, options: {
+        at: number;
+    }) => number;
+};
+/** A pool file as the probe read it: its size, and its first bytes (its header's path, flags and digest). */
+export type PoolFileHead = {
+    size: number;
+    header: Uint8Array;
+};
+/**
+ * What an existing pool holds: the project's database, nothing but headers (it never held pages), or data with no
+ * database (the database's header damaged).
+ */
+export type PoolContents = 'database' | 'blank' | 'lost';
+//# sourceMappingURL=runtime.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.types.d.ts","sourceRoot":"","sources":["../../../../src/store/sqlite/runtime/runtime.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAEzE,uGAAuG;AACvG,MAAM,MAAM,oBAAoB,GAAG;IAClC,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAA;IACtC,2GAA2G;IAC3G,eAAe,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,yGAAyG;AACzG,MAAM,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,IAAI,EAAE,WAAW,GAAG,SAAS,CAAA;IAC7B,gFAAgF;IAChF,WAAW,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAA;IACrC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,uDAAuD;IACvD,MAAM,EAAE,WAAW,GAAG,SAAS,CAAA;IAC/B,uEAAuE;IACvE,SAAS,EAAE,SAAS,GAAG,SAAS,CAAA;IAChC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;CAClC,CAAA;AAED,iGAAiG;AACjG,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IACxF,gGAAgG;IAChG,6BAA6B,CAAC,EAAE,OAAO,CAAA;CACvC,CAAA;AAED,wFAAwF;AACxF,MAAM,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,MAAM,IAAI,CAAA;CACnB,CAAA;AAED,8GAA8G;AAC9G,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACzD,sBAAsB,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAA;CACrD,CAAA;AAED,yFAAyF;AACzF,MAAM,MAAM,cAAc,GAAG;IAC5B,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,OAAO,EAAE,MAAM,MAAM,CAAA;IACrB,IAAI,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;CAC7D,CAAA;AAED,6GAA6G;AAC7G,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAA;AAE/D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAA"}

package/dist/store/sqlite/runtime/serve-dialecte-engine.d.ts

@@ -0,0 +1,16 @@
+import { DialecteDeclaration } from '../../../dialecte';
+import { ExtensionModules } from '../../../document';
+import { AnyDialecteConfig } from '../../../types';
+/**
+ * Serve the dialecte's project engine from this worker, the one call of a dialecte package's engine worker file -
+ * today the SQLite engine on the origin's private file system (opfs-sahpool). The realm that spawned it (or
+ * the hub, through it) sends control messages - open the project, adopt a client's port, a client gone, close, destroy -
+ * handled one at a time and each answered once; every adopted port is served the engine's members.
+ * One project per worker.
+ *
+ * @intent serve a dialecte's engine from a worker, write a dialecte package's engine worker file, ship a dialecte's SQLite engine in its package
+ */
+export declare function serveDialecteEngine<GenericConfig extends AnyDialecteConfig, GenericModules extends ExtensionModules, GenericConfigKey extends string>(params: {
+    dialecte: DialecteDeclaration<GenericConfig, GenericModules, GenericConfigKey>;
+}): void;
+//# sourceMappingURL=serve-dialecte-engine.d.ts.map

package/dist/store/sqlite/runtime/serve-dialecte-engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve-dialecte-engine.d.ts","sourceRoot":"","sources":["../../../../src/store/sqlite/runtime/serve-dialecte-engine.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAiB,MAAM,SAAS,CAAA;AAG/D;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAClC,aAAa,SAAS,iBAAiB,EACvC,cAAc,SAAS,gBAAgB,EACvC,gBAAgB,SAAS,MAAM,EAC9B,MAAM,EAAE;IACT,QAAQ,EAAE,mBAAmB,CAAC,aAAa,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAA;CAC9E,GAAG,IAAI,CA4CP"}

package/dist/store/sqlite/sqlite-store-of.d.ts

@@ -0,0 +1,7 @@
+import { SqliteConnectorParams } from '../sqlite-storage.types';
+import { Store } from '../store.types';
+/** The store of a project on `sqlite` storage: an EngineStore whose engine runs in a worker (hub or page). */
+export declare function sqliteStoreOf(params: {
+    connector: SqliteConnectorParams;
+}): Store;
+//# sourceMappingURL=sqlite-store-of.d.ts.map

package/dist/store/sqlite/sqlite-store-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-store-of.d.ts","sourceRoot":"","sources":["../../../src/store/sqlite/sqlite-store-of.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAE3C,8GAA8G;AAC9G,wBAAgB,aAAa,CAAC,MAAM,EAAE;IAAE,SAAS,EAAE,qBAAqB,CAAA;CAAE,GAAG,KAAK,CAGjF"}

package/dist/store/sqlite/sqlite-text.d.ts

@@ -0,0 +1,20 @@
+import { Sqlite3Static } from '@sqlite.org/sqlite-wasm';
+/**
+ * Make sqlite-wasm's text codec keep well-formed text as written, once per SQLite module. Its own
+ * reads a text column with a default `TextDecoder`, which drops a leading byte order mark, and
+ * binds a string with a `TextEncoder`, which writes a lone surrogate as U+FFFD - so a key holding
+ * one would name the row whose key holds U+FFFD there. Installed: a column is decoded with the byte
+ * order mark kept, and a string that is not well-formed is bound as WTF-8 (a lone surrogate as its
+ * own three bytes, as SQLite's JSON reader decodes an escaped one), bytes UTF-8 never holds: such a
+ * key never matches text written as UTF-8 (the key holding U+FFFD in its place among them). A
+ * well-formed string is bound as before. Error messages, column names and file names go through
+ * sqlite-wasm's own decoder and allocator, unchanged.
+ */
+export declare function installLosslessText(params: {
+    sqlite3: Sqlite3Static;
+}): void;
+/** Whether `installLosslessText` ran on this SQLite module. */
+export declare function isLosslessTextInstalled(params: {
+    sqlite3: Sqlite3Static;
+}): boolean;
+//# sourceMappingURL=sqlite-text.d.ts.map

package/dist/store/sqlite/sqlite-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-text.d.ts","sourceRoot":"","sources":["../../../src/store/sqlite/sqlite-text.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAE5D;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,aAAa,CAAA;CAAE,GAAG,IAAI,CAkB5E;AAED,+DAA+D;AAC/D,wBAAgB,uBAAuB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,aAAa,CAAA;CAAE,GAAG,OAAO,CAEnF"}

package/dist/store/sqlite/sqlite-wasm-url.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The one SQLite wasm file of a consumer: a consumer's bundler emits it once, content-hashed, for
+ * every dialecte engine (each engine is handed this URL, its own bundle holds no wasm). Main-realm
+ * code only: in node it points nowhere (sqlite-wasm's node build finds its own file).
+ */
+export declare const SQLITE_WASM_URL: string;
+/** The wasm URL a realm loads SQLite from: the consumer's file in a browser, none in node. */
+export declare function realmWasmUrl(): string | undefined;
+//# sourceMappingURL=sqlite-wasm-url.d.ts.map

package/dist/store/sqlite/sqlite-wasm-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-wasm-url.d.ts","sourceRoot":"","sources":["../../../src/store/sqlite/sqlite-wasm-url.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAGtB,CAAA;AAEN,8FAA8F;AAC9F,wBAAgB,YAAY,IAAI,MAAM,GAAG,SAAS,CAGjD"}

package/dist/store/sqlite/sqlite.constants.d.ts

@@ -0,0 +1,15 @@
+import { SqliteWasmText } from './sqlite.types';
+/** The VFSes of sqlite-wasm the engine never uses: not installed (they would only warn where they cannot run). */
+export declare const SQLITE_VFS_DISABLED: {
+    readonly opfs: true;
+    readonly 'opfs-vfs': true;
+    readonly 'opfs-wl': true;
+};
+/** The members of sqlite-wasm's `wasm` utilities its text codec runs through, read by `installLosslessText`. */
+export declare const SQLITE_TEXT_MEMBERS: (keyof SqliteWasmText)[];
+/**
+ * Set on a SQLite module's `wasm` utilities once `installLosslessText` made its codec lossless (registered, so every
+ * copy of core reads the same mark; not enumerable, so a copy of the utilities does not carry it).
+ */
+export declare const LOSSLESS_TEXT_MARK: unique symbol;
+//# sourceMappingURL=sqlite.constants.d.ts.map

package/dist/store/sqlite/sqlite.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite.constants.d.ts","sourceRoot":"","sources":["../../../src/store/sqlite/sqlite.constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,kHAAkH;AAClH,eAAO,MAAM,mBAAmB;;;;CAA6D,CAAA;AAE7F,gHAAgH;AAChH,eAAO,MAAM,mBAAmB,EAMmB,CAAC,MAAM,cAAc,CAAC,EAAE,CAAA;AAE3E;;;GAGG;AACH,eAAO,MAAM,kBAAkB,eAA6C,CAAA"}

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

@@ -0,0 +1,36 @@
+import { Sqlite3Static, WasmPointer } from '@sqlite.org/sqlite-wasm';
+/** What sqlite-wasm reads from `globalThis.sqlite3ApiConfig` as it starts (the part the store sets). */
+export type SqliteApiConfig = {
+    disable?: {
+        vfs?: Record<string, boolean>;
+    };
+};
+/**
+ * sqlite-wasm's init as it runs: it takes the Emscripten module's `locateFile` (its declared type
+ * takes nothing).
+ */
+export type SqliteInit = (moduleConfig?: {
+    locateFile?: (path: string, prefix: string) => string;
+}) => Promise<Sqlite3Static>;
+/**
+ * The members of sqlite-wasm's `wasm` utilities its text codec runs through (not all in its declared
+ * types): its column reader decodes through `typedArrayToString`, its binders encode through
+ * `allocCString`, both looked up at each call; `typedArrayPart`, `alloc` and `heap8u` are what a
+ * replacement of the two needs.
+ */
+export type SqliteWasmText = {
+    typedArrayToString: (array: Uint8Array, begin?: number, end?: number) => string;
+    typedArrayPart: (array: Uint8Array, begin?: number, end?: number) => Uint8Array;
+    allocCString: (text: unknown, returnWithLength?: boolean) => SqliteCString;
+    alloc: (bytes: number) => WasmPointer;
+    heap8u: () => Uint8Array;
+};
+/** What `allocCString` answers: the string's pointer, with its length in bytes when asked, `null` for a non-string. */
+export type SqliteCString = WasmPointer | [WasmPointer, number] | null;
+/** A statement run on SQLite as a realm loads it: `bind` bound in order, `expected` its one answer. */
+export type SqliteTextCase = {
+    sql: string;
+    bind: unknown[];
+    expected: unknown;
+};
+//# sourceMappingURL=sqlite.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite.types.d.ts","sourceRoot":"","sources":["../../../src/store/sqlite/sqlite.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAEzE,wGAAwG;AACxG,MAAM,MAAM,eAAe,GAAG;IAC7B,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,YAAY,CAAC,EAAE;IACxC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAA;CACrD,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,kBAAkB,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC/E,cAAc,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,UAAU,CAAA;IAC/E,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,gBAAgB,CAAC,EAAE,OAAO,KAAK,aAAa,CAAA;IAC1E,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,WAAW,CAAA;IACrC,MAAM,EAAE,MAAM,UAAU,CAAA;CACxB,CAAA;AAED,uHAAuH;AACvH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;AAEtE,uGAAuG;AACvG,MAAM,MAAM,cAAc,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,EAAE,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAA"}

package/dist/store/sqlite-storage.constants.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The version of what copies of the library share through the registration: the `SqliteStorage` it holds and the
+ * Store contract of the stores it builds (a copy's Project calls another copy's store). Bumped with any change of
+ * either, so a copy of another version finds no kind (`PROJECT_SQLITE_NOT_IMPORTED`) instead of a store it cannot use:
+ * `shared-shapes.test.ts` fails until it is: the shape (their members, and every type of the package they reach) is
+ * recorded per version in `__shapes__/sqlite-storage-v<version>.txt`, written at the first local run of a new version.
+ */
+export declare const SQLITE_STORAGE_VERSION = 1;
+/**
+ * Where the `sqlite` storage kind is registered: on `globalThis`, so every copy of the library of the same storage
+ * version the page loads (a dialecte's own copy, a pre-bundled test entry) finds the kind the app's import registered.
+ */
+export declare const SQLITE_STORAGE_KEY: unique symbol;
+//# sourceMappingURL=sqlite-storage.constants.d.ts.map

package/dist/store/sqlite-storage.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-storage.constants.d.ts","sourceRoot":"","sources":["../../src/store/sqlite-storage.constants.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,IAAI,CAAA;AAEvC;;;GAGG;AACH,eAAO,MAAM,kBAAkB,eAE9B,CAAA"}

package/dist/store/sqlite-storage.d.ts

@@ -0,0 +1,22 @@
+import { SqliteStorage } from './sqlite-storage.types';
+/**
+ * Register the `sqlite` storage kind for every copy of the library of the same storage version in this realm (what
+ * importing `@dialecte/core/sqlite` does). A kind registered already - an earlier import, another copy of the same
+ * version - is kept: the realm's engines run in direct mode are one copy's (its open connections, its engines), so
+ * every project of the realm goes through that copy.
+ */
+export declare function registerSqliteStorage(params: {
+    storage: SqliteStorage;
+}): void;
+/** A test's kind for its case (`undefined`: none, an app that never imported the entry); answers the restore. */
+export declare function replaceSqliteStorage(params: {
+    storage: SqliteStorage | undefined;
+}): () => void;
+/**
+ * The `sqlite` storage kind registered; none - the app never imported `@dialecte/core/sqlite`, or imported it from a
+ * copy of the library of another storage version - refused `PROJECT_SQLITE_NOT_IMPORTED` for `project`.
+ */
+export declare function registeredSqliteStorage(params: {
+    project: string;
+}): SqliteStorage;
+//# sourceMappingURL=sqlite-storage.d.ts.map

package/dist/store/sqlite-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-storage.d.ts","sourceRoot":"","sources":["../../src/store/sqlite-storage.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAuB,MAAM,wBAAwB,CAAA;AAEhF;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,aAAa,CAAA;CAAE,GAAG,IAAI,CAG9E;AAED,iHAAiH;AACjH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,aAAa,GAAG,SAAS,CAAA;CAAE,GAAG,MAAM,IAAI,CAO/F;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CASlF"}

package/dist/store/sqlite-storage.types.d.ts

@@ -0,0 +1,24 @@
+import { SQLITE_STORAGE_KEY } from './sqlite-storage.constants';
+import { Store } from './store.types';
+/** A project on `sqlite` storage: its name, its dialecte and the engine its factory gives. */
+export type SqliteConnectorParams = {
+    name: string;
+    dialecteId: string;
+    dialecteVersion: string;
+    /** The address of the dialecte's engine worker. */
+    engineUrl: string;
+    /** Measure the import's and the export's stages in the engine (`dev.perf`). */
+    perf?: boolean;
+};
+/** The `sqlite` storage kind, as `@dialecte/core/sqlite` registers it. */
+export type SqliteStorage = {
+    /** The store of a project on `sqlite` storage: its engine in a worker, through the origin's hub or the page. */
+    storeOf: (params: {
+        connector: SqliteConnectorParams;
+    }) => Store;
+};
+/** `globalThis` as it holds the registered `sqlite` storage kind. */
+export type SqliteStorageHolder = {
+    [SQLITE_STORAGE_KEY]?: SqliteStorage;
+};
+//# sourceMappingURL=sqlite-storage.types.d.ts.map

package/dist/store/sqlite-storage.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-storage.types.d.ts","sourceRoot":"","sources":["../../src/store/sqlite-storage.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAE1C,8FAA8F;AAC9F,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAA;IACjB,+EAA+E;IAC/E,IAAI,CAAC,EAAE,OAAO,CAAA;CACd,CAAA;AAED,0EAA0E;AAC1E,MAAM,MAAM,aAAa,GAAG;IAC3B,gHAAgH;IAChH,OAAO,EAAE,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,qBAAqB,CAAA;KAAE,KAAK,KAAK,CAAA;CAChE,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,kBAAkB,CAAC,CAAC,EAAE,aAAa,CAAA;CAAE,CAAA"}

package/dist/store/store-errors.d.ts

@@ -0,0 +1,51 @@
+/** A document id that is already registered. */
+export declare function throwDocumentAlreadyRegistered(params: {
+    documentId: string;
+}): never;
+/** A document path refused for breaking a rule: `reason` says which, `meta.path` is the path as given. */
+export declare function throwDocumentPathInvalid(params: {
+    path: unknown;
+    reason: string;
+}): never;
+/**
+ * A document given a place another document holds: the same path, or one a folder of the other's. `takenBy` is
+ * that other document.
+ */
+export declare function throwDocumentPathTaken(params: {
+    documentId: string;
+    path: string;
+    takenBy: string;
+}): never;
+/** A write to a document that is not registered: `what` says what was to be written. */
+export declare function throwDocumentNotRegistered(params: {
+    documentId: string;
+    what: string;
+}): never;
+/** An update of a record the document does not hold. */
+export declare function throwRecordToUpdateNotFound(params: {
+    documentId: string;
+    recordId: string;
+}): never;
+/**
+ * Creates refused for their ids: `held` the ids the document already holds, `repeated` the ids the
+ * write gives more than once. `meta.recordIds` names each refused id once.
+ */
+export declare function throwDuplicateRecordIds(params: {
+    documentId: string;
+    held: string[];
+    repeated: string[];
+    cause?: Error;
+}): never;
+/**
+ * A destroy refused while another connection - of this realm, or of another tab - has the project open:
+ * nothing is removed; it can be destroyed once that connection is closed.
+ */
+export declare function throwOpenElsewhere(params: {
+    storeName: string;
+    connections?: number;
+}): never;
+/** An operation through a store closed by `close()`: refused until the store is opened again. */
+export declare function throwStoreClosed(params: {
+    storeName: string;
+}): never;
+//# sourceMappingURL=store-errors.d.ts.map

package/dist/store/store-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-errors.d.ts","sourceRoot":"","sources":["../../src/store/store-errors.ts"],"names":[],"mappings":"AAKA,gDAAgD;AAChD,wBAAgB,8BAA8B,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAMpF;AAED,0GAA0G;AAC1G,wBAAgB,wBAAwB,CAAC,MAAM,EAAE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAMzF;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE;IAC9C,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CACf,GAAG,KAAK,CAMR;AAED,wFAAwF;AACxF,wBAAgB,0BAA0B,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAM9F;AAED,wDAAwD;AACxD,wBAAgB,2BAA2B,CAAC,MAAM,EAAE;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CAChB,GAAG,KAAK,CAMR;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,CAAC,EAAE,KAAK,CAAA;CACb,GAAG,KAAK,CAWR;AAMD;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAM7F;AAED,iGAAiG;AACjG,wBAAgB,gBAAgB,CAAC,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAMrE"}

package/dist/store/store.constants.d.ts

@@ -1,4 +1,8 @@
 import { RecordSchema } from './store.types';
+/** The names a project or its dialecte's id never takes: nothing, or one a directory cannot be named after. */
+export declare const UNNAMABLE_PARTS: readonly string[];
+/** Records an export reads per call and writes per batch, unless asked otherwise. */
+export declare const EXPORT_BATCH_SIZE = 2000;
 /** System table: file registry */
 export declare const TABLE_DOCUMENTS = "_documents";
 /** System table: per-file changelog entries */
@@ -7,15 +11,23 @@ export declare const TABLE_CHANGELOG = "_changeLog";
 export declare const TABLE_META = "_meta";
 /** Prefix for per-file record tables */
 export declare const TABLE_RECORD_PREFIX = "xel_";
-/** Derive the record table name for a given documentId */
+/**
+ * The name of the store table holding the records of the document `documentId`.
+ *
+ * @intent name the store table holding a document's records, read a document's records from the local database directly
+ */
 export declare function recordTableName(documentId: string): string;
 /** System table: blob metadata registry */
 export declare const TABLE_BLOBS = "_blobs";
 /** Prefix for per-document blob data tables */
 export declare const TABLE_BLOB_PREFIX = "blob_";
-/** Derive the blob data table name for a given documentId */
+/**
+ * The name of the store table holding the blob data of the document `documentId`.
+ *
+ * @intent name the store table holding a document's blob data, store blobs in a custom store
+ */
 export declare function blobTableName(documentId: string): string;
-/** Schema for the _files registry table */
+/** Schema for the _documents registry table */
 export declare const DOCUMENTS_SCHEMA: RecordSchema;
 /** Schema for the _changeLog table */
 export declare const CHANGELOG_SCHEMA: RecordSchema;

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

@@ -1 +1 @@
-{"version":3,"file":"store.constants.d.ts","sourceRoot":"","sources":["../../src/store/store.constants.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAIjD,kCAAkC;AAClC,eAAO,MAAM,eAAe,eAAe,CAAA;AAE3C,+CAA+C;AAC/C,eAAO,MAAM,eAAe,eAAe,CAAA;AAE3C,8DAA8D;AAC9D,eAAO,MAAM,UAAU,UAAU,CAAA;AAEjC,wCAAwC;AACxC,eAAO,MAAM,mBAAmB,SAAS,CAAA;AAEzC,0DAA0D;AAC1D,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,2CAA2C;AAC3C,eAAO,MAAM,WAAW,WAAW,CAAA;AAEnC,+CAA+C;AAC/C,eAAO,MAAM,iBAAiB,UAAU,CAAA;AAExC,6DAA6D;AAC7D,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAExD;AAID,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB,EAAE,YAK9B,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,gBAAgB,EAAE,YAM9B,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,WAAW,EAAE,YAKzB,CAAA;AAED,sFAAsF;AACtF,eAAO,MAAM,YAAY,EAAE,YAK1B,CAAA;AAED,0EAA0E;AAC1E,eAAO,MAAM,gBAAgB,EAAE,YAK9B,CAAA"}
+{"version":3,"file":"store.constants.d.ts","sourceRoot":"","sources":["../../src/store/store.constants.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEjD,+GAA+G;AAC/G,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAAoB,CAAA;AAIjE,qFAAqF;AACrF,eAAO,MAAM,iBAAiB,OAAO,CAAA;AAIrC,kCAAkC;AAClC,eAAO,MAAM,eAAe,eAAe,CAAA;AAE3C,+CAA+C;AAC/C,eAAO,MAAM,eAAe,eAAe,CAAA;AAE3C,8DAA8D;AAC9D,eAAO,MAAM,UAAU,UAAU,CAAA;AAEjC,wCAAwC;AACxC,eAAO,MAAM,mBAAmB,SAAS,CAAA;AAEzC;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,2CAA2C;AAC3C,eAAO,MAAM,WAAW,WAAW,CAAA;AAEnC,+CAA+C;AAC/C,eAAO,MAAM,iBAAiB,UAAU,CAAA;AAExC;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAExD;AAID,+CAA+C;AAC/C,eAAO,MAAM,gBAAgB,EAAE,YAK9B,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,gBAAgB,EAAE,YAM9B,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,WAAW,EAAE,YAKzB,CAAA;AAED,sFAAsF;AACtF,eAAO,MAAM,YAAY,EAAE,YAK1B,CAAA;AAED,0EAA0E;AAC1E,eAAO,MAAM,gBAAgB,EAAE,YAK9B,CAAA"}