@evolu/common 8.10.0 → 8.11.0

package/dist/src/Sqlite.d.ts

@@ -15,6 +15,8 @@ import { type ArrayType, type InferType, type Name, type ObjectType, type Record
  * API is synchronous because it provides
  * {@link https://github.com/WiseLibs/better-sqlite3/issues/262 | better concurrency}
  * for SQLite.
+ *
+ * @group Core
  */
 export interface Sqlite extends AsyncDisposable {
     readonly exec: <R extends SqliteRow = SqliteRow>(query: SqliteQuery) => SqliteExecResult<R>;
@@ -37,22 +39,44 @@ export interface Sqlite extends AsyncDisposable {
      */
     readonly export: () => Uint8Array<ArrayBuffer>;
 }
+/**
+ * Dependency wrapper for {@link Sqlite}.
+ *
+ * @group Core
+ */
 export interface SqliteDep {
     readonly sqlite: Sqlite;
 }
+/**
+ * Runs a callback inside a SQLite transaction.
+ *
+ * @group Core
+ */
 export interface SqliteTransaction {
     <T, E>(callback: () => Result<T, E>): Result<T, E>;
     (callback: () => void): void;
 }
-/** Represents a SQL query to be executed on a {@link Sqlite} database. */
+/**
+ * Represents a SQL query to be executed on a {@link Sqlite} database.
+ *
+ * @group Queries
+ */
 export interface SqliteQuery {
     readonly sql: SafeSql;
     readonly parameters: SqliteQueryParameters;
     readonly options?: SqliteQueryOptions;
 }
-/** Serialized {@link SqliteQuery} used as a stable string key. */
+/**
+ * Serialized {@link SqliteQuery} used as a stable string key.
+ *
+ * @group Queries
+ */
 export type SqliteQueryString = string & Brand<"SqliteQueryString">;
-/** A sanitized SQL string for {@link SqliteQuery}. */
+/**
+ * A sanitized SQL string for {@link SqliteQuery}.
+ *
+ * @group Queries
+ */
 export type SafeSql = string & Brand<"SafeSql">;
 /**
  * A value that can be stored in {@link Sqlite}.
@@ -64,10 +88,16 @@ export type SafeSql = string & Brand<"SafeSql">;
  *
  * Note that Evolu can't support Int64 because expo-sqlite (and some others) do
  * not support it.
+ *
+ * @group Values
  */
 export declare const SqliteValue: import("./Type.ts").UnionType<readonly [import("./Type.ts").BrandType<import("./Type.ts").BrandType<import("./Type.ts").Type<"Number", number, number, import("./Type.ts").TypeOfError<"Number">, null, import("./Type.ts").TypeOfError<"Number">, never, number, true>, "NonNaN", import("./Type.ts").NonNaNError>, "Finite", import("./Type.ts").FiniteError>, import("./Type.ts").LiteralType<null>, import("./Type.ts").Type<"String", string, string, import("./Type.ts").TypeOfError<"String">, null, import("./Type.ts").TypeOfError<"String">, never, string, true>, import("./Type.ts").Type<"Uint8Array", Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>, import("./Type.ts").ObjectTagError<"Uint8Array">, null, import("./Type.ts").ObjectTagError<"Uint8Array">, never, Uint8Array<ArrayBufferLike>, true>]>;
 export type SqliteValue = typeof SqliteValue.Output;
-/** Parameters of a {@link SqliteQuery}. */
+/**
+ * Parameters of a {@link SqliteQuery}.
+ *
+ * @group Queries
+ */
 export declare const SqliteQueryParameters: ArrayType<import("./Type.ts").UnionType<readonly [import("./Type.ts").BrandType<import("./Type.ts").BrandType<import("./Type.ts").Type<"Number", number, number, import("./Type.ts").TypeOfError<"Number">, null, import("./Type.ts").TypeOfError<"Number">, never, number, true>, "NonNaN", import("./Type.ts").NonNaNError>, "Finite", import("./Type.ts").FiniteError>, import("./Type.ts").LiteralType<null>, import("./Type.ts").Type<"String", string, string, import("./Type.ts").TypeOfError<"String">, null, import("./Type.ts").TypeOfError<"String">, never, string, true>, import("./Type.ts").Type<"Uint8Array", Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>, import("./Type.ts").ObjectTagError<"Uint8Array">, null, import("./Type.ts").ObjectTagError<"Uint8Array">, never, Uint8Array<ArrayBufferLike>, true>]>>;
 export type SqliteQueryParameters = typeof SqliteQueryParameters.Output;
 /**
@@ -76,11 +106,21 @@ export type SqliteQueryParameters = typeof SqliteQueryParameters.Output;
  *
  * It differs from {@link SqliteValue} only by using `number` instead of
  * {@link FiniteNumber}.
+ *
+ * @group Values
  */
 export type SqliteValueInput = typeof SqliteValue.Input;
-/** Equality comparison for {@link SqliteValueInput}. */
+/**
+ * Equality comparison for {@link SqliteValueInput}.
+ *
+ * @group Values
+ */
 export declare const eqSqliteValue: Eq<SqliteValueInput>;
-/** Options for configuring {@link SqliteQuery} execution behavior. */
+/**
+ * Options for configuring {@link SqliteQuery} execution behavior.
+ *
+ * @group Queries
+ */
 export interface SqliteQueryOptions {
     /**
      * If set to `true`, logs the time taken to execute the SQL query. Useful for
@@ -104,24 +144,41 @@ export interface SqliteQueryOptions {
      */
     readonly prepare?: boolean;
 }
-/** Converts a {@link SqliteQuery} into a stable {@link SqliteQueryString}. */
+/**
+ * Converts a {@link SqliteQuery} into a stable {@link SqliteQueryString}.
+ *
+ * @group Queries
+ */
 export declare const sqliteQueryToSqliteQueryString: (query: SqliteQuery) => SqliteQueryString;
-/** Converts a {@link SqliteQueryString} back into a {@link SqliteQuery}. */
+/**
+ * Converts a {@link SqliteQueryString} back into a {@link SqliteQuery}.
+ *
+ * @group Queries
+ */
 export declare const sqliteQueryStringToSqliteQuery: (query: SqliteQueryString) => SqliteQuery;
-/** Result of executing a SQLite query. */
+/**
+ * Result of executing a SQLite query.
+ *
+ * @group Queries
+ */
 export interface SqliteExecResult<R extends SqliteRow = SqliteRow> {
     readonly rows: ReadonlyArray<R>;
+    /** The number of rows an insert, update, or delete statement changed. */
     readonly changes: number;
 }
 /**
  * A row returned from a {@link Sqlite} query, mapping column names to
  * {@link SqliteValueInput}.
+ *
+ * @group Values
  */
 export type SqliteRow = Record<string, SqliteValueInput>;
 /**
  * SQLite driver interface.
  *
  * Platform-specific drivers must implement this interface.
+ *
+ * @group Core
  */
 export interface SqliteDriver extends Disposable {
     readonly exec: (query: SqliteQuery) => SqliteExecResult;
@@ -135,8 +192,17 @@ export interface SqliteDriver extends Disposable {
      */
     readonly export: () => Uint8Array<ArrayBuffer>;
 }
-/** Creates a {@link SqliteDriver}. */
+/**
+ * Creates a {@link SqliteDriver}.
+ *
+ * @group Core
+ */
 export type CreateSqliteDriver = (name: Name, options?: SqliteDriverOptions) => Task<SqliteDriver>;
+/**
+ * Dependency wrapper for {@link CreateSqliteDriver}.
+ *
+ * @group Core
+ */
 export interface CreateSqliteDriverDep {
     createSqliteDriver: CreateSqliteDriver;
 }
@@ -145,6 +211,8 @@ export interface CreateSqliteDriverDep {
  *
  * Three mutually exclusive modes: in-memory (for testing), encrypted persistent
  * (OPFS/file with encryption key), or persistent (default when omitted).
+ *
+ * @group Core
  */
 export type SqliteDriverOptions = {
     readonly mode: "memory";
@@ -157,15 +225,23 @@ export type SqliteDriverOptions = {
  *
  * The driver is created via {@link CreateSqliteDriver} and wrapped with logging,
  * error handling, and transaction helpers.
+ *
+ * @group Core
  */
 export declare const createSqlite: (name: Name, options?: SqliteDriverOptions) => Task<Sqlite, never, CreateSqliteDriverDep>;
-/** Creates a test setup with a in-memory {@link Sqlite}. */
+/**
+ * Creates a test setup with a in-memory {@link Sqlite}.
+ *
+ * @group Testing
+ */
 export declare const testSetupSqlite: (deps: CreateSqliteDriverDep) => Promise<AsyncDisposable & SqliteDep & TestRunDep<CreateSqliteDriverDep & SqliteDep>>;
 /**
  * Cache for compiled prepared statements.
  *
  * Statements are created on first access and reused for subsequent calls with
  * the same SQL. Disposing the cache finalizes all cached statements.
+ *
+ * @group Core
  */
 export interface PreparedStatements<P> extends Disposable {
     readonly get: <T extends boolean>(query: SqliteQuery, alwaysPrepare?: T) => T extends true ? P : P | null;
@@ -173,9 +249,15 @@ export interface PreparedStatements<P> extends Disposable {
 /**
  * Creates a {@link PreparedStatements} cache backed by the given factory and
  * dispose function.
+ *
+ * @group Core
  */
 export declare const createPreparedStatementsCache: <P>(factory: (sql: SafeSql) => P, disposeFn: (statement: P) => void) => PreparedStatements<P>;
-/** A double-quoted SQL identifier for safe column or table name interpolation. */
+/**
+ * A double-quoted SQL identifier for safe column or table name interpolation.
+ *
+ * @group Queries
+ */
 export interface SqlIdentifier extends Typed<"SqlIdentifier"> {
     readonly sql: SafeSql;
 }
@@ -183,11 +265,17 @@ export interface SqlIdentifier extends Typed<"SqlIdentifier"> {
  * An unescaped SQL fragment inserted verbatim into a query.
  *
  * **Warning**: Use only with trusted, constant strings to avoid SQL injection.
+ *
+ * @group Queries
  */
 export interface RawSql extends Typed<"RawSql"> {
     readonly sql: string;
 }
-/** A parameter accepted by the {@link sql} tagged template. */
+/**
+ * A parameter accepted by the {@link sql} tagged template.
+ *
+ * @group Queries
+ */
 export type SqlTemplateParam = SqliteValueInput | SqlIdentifier | RawSql;
 export declare function sql(strings: TemplateStringsArray, ...parameters: Array<SqlTemplateParam>): SqliteQuery;
 export declare namespace sql {
@@ -195,19 +283,29 @@ export declare namespace sql {
     var raw: (raw: string) => RawSql;
     var prepared: (strings: TemplateStringsArray, ...parameters: Array<SqlTemplateParam>) => SqliteQuery;
 }
-/** Index metadata stored in `sqlite_master` for a {@link Sqlite} database. */
+/**
+ * Index metadata stored in `sqlite_master` for a {@link Sqlite} database.
+ *
+ * @group Schema
+ */
 export declare const SqliteIndex: ObjectType<{
     readonly name: typeof String;
     readonly sql: typeof String;
 }>;
 export interface SqliteIndex extends InferType<typeof SqliteIndex> {
 }
-/** {@link Eq} instance for {@link SqliteIndex}. */
+/**
+ * {@link Eq} instance for {@link SqliteIndex}.
+ *
+ * @group Schema
+ */
 export declare const eqSqliteIndex: Eq<SqliteIndex>;
 /**
  * Full schema metadata for a {@link Sqlite} database.
  *
  * Includes table-column mappings and user-visible indexes.
+ *
+ * @group Schema
  */
 export declare const SqliteSchema: ObjectType<{
     readonly tables: RecordType<typeof String, SetType<typeof String>>;
@@ -215,7 +313,11 @@ export declare const SqliteSchema: ObjectType<{
 }>;
 export interface SqliteSchema extends InferType<typeof SqliteSchema> {
 }
-/** Get the current SQLite schema by reading SQLite metadata. */
+/**
+ * Get the current SQLite schema by reading SQLite metadata.
+ *
+ * @group Schema
+ */
 export declare const getSqliteSchema: (deps: SqliteDep) => ({ excludeIndexNamePrefix, }?: {
     /**
      * If provided, indexes with names starting with this prefix are excluded in
@@ -226,6 +328,8 @@ export declare const getSqliteSchema: (deps: SqliteDep) => ({ excludeIndexNamePr
 /**
  * Returns {@link SqliteSchema} and full {@link SqliteRow} table contents for
  * inspection and testing.
+ *
+ * @group Schema
  */
 export interface SqliteSnapshot {
     readonly schema: SqliteSchema;
@@ -239,6 +343,8 @@ export interface SqliteSnapshot {
  *
  * The snapshot includes current {@link SqliteSchema} and all rows from every
  * discovered table. Table order follows `schema.tables` iteration order.
+ *
+ * @group Schema
  */
 export declare const getSqliteSnapshot: (deps: SqliteDep) => SqliteSnapshot;
 /**
@@ -251,6 +357,8 @@ export declare const getSqliteSnapshot: (deps: SqliteDep) => SqliteSnapshot;
  *   readability.
  * - Use {@link booleanToSqliteBoolean} and {@link sqliteBooleanToBoolean} for
  *   converting between JavaScript booleans and SQLite boolean values.
+ *
+ * @group Values
  */
 export declare const SqliteBoolean: import("./Type.ts").UnionType<readonly [import("./Type.ts").LiteralType<0>, import("./Type.ts").LiteralType<1>]>;
 export type SqliteBoolean = typeof SqliteBoolean.Output;
@@ -258,12 +366,16 @@ export type SqliteBoolean = typeof SqliteBoolean.Output;
  * Represents the {@link SqliteBoolean} value for `true`.
  *
  * See {@link SqliteBoolean}.
+ *
+ * @group Values
  */
 export declare const sqliteTrue = 1;
 /**
  * Represents the {@link SqliteBoolean} value for `false`.
  *
  * See {@link SqliteBoolean}.
+ *
+ * @group Values
  */
 export declare const sqliteFalse = 0;
 /**
@@ -276,6 +388,8 @@ export declare const sqliteFalse = 0;
  *
  * assertEqual(booleanToSqliteBoolean(true), 1);
  * ```
+ *
+ * @group Values
  */
 export declare const booleanToSqliteBoolean: (value: boolean) => SqliteBoolean;
 /**
@@ -288,6 +402,8 @@ export declare const booleanToSqliteBoolean: (value: boolean) => SqliteBoolean;
  *
  * assertTrue(sqliteBooleanToBoolean(1));
  * ```
+ *
+ * @group Values
  */
 export declare const sqliteBooleanToBoolean: (value: SqliteBoolean) => boolean;
 //# sourceMappingURL=Sqlite.d.ts.map

package/dist/src/Sqlite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sqlite.d.ts","sourceRoot":"","sources":["../../src/Sqlite.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAIlC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,KAAK,IAAI,EAAiB,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAEL,KAAK,SAAS,EAEd,KAAK,SAAS,EACd,KAAK,IAAI,EAGT,KAAK,UAAU,EAEf,KAAK,UAAU,EAEf,KAAK,OAAO,EACZ,MAAM,EAEN,KAAK,KAAK,EAGX,MAAM,WAAW,CAAC;AAEnB;;;;;;GAMG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe;IAC7C,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAC7C,KAAK,EAAE,WAAW,KACf,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEzB;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAC9B;AAED,0EAA0E;AAC1E,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;IAC3C,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CACvC;AAED,kEAAkE;AAClE,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEpE,sDAAsD;AACtD,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAEhD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,qyBAKvB,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,MAAM,CAAC;AAEpD,2CAA2C;AAC3C,eAAO,MAAM,qBAAqB,gzBAAmC,CAAC;AACtE,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAC,MAAM,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,WAAW,CAAC,KAAK,CAAC;AAExD,wDAAwD;AACxD,eAAO,MAAM,aAAa,EAAE,EAAE,CAAC,gBAAgB,CACsB,CAAC;AAEtE,sEAAsE;AACtE,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEzC;;;;;;OAMG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAEvC;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,8EAA8E;AAC9E,eAAO,MAAM,8BAA8B,UAClC,WAAW,KACjB,iBAYF,CAAC;AAEF,4EAA4E;AAC5E,eAAO,MAAM,8BAA8B,UAClC,iBAAiB,KACvB,WAsBF,CAAC;AAEF,0CAA0C;AAC1C,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC/D,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,gBAAgB,CAAC;IAExD,uEAAuE;IACvE,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;CAChD;AAED,sCAAsC;AACtC,MAAM,MAAM,kBAAkB,GAAG,CAC/B,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE,mBAAmB,KAC1B,IAAI,CAAC,YAAY,CAAC,CAAC;AAExB,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAA;CAAE,CAAC;AAE1E;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAEf,IAAI,YACA,mBAAmB,KAC5B,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,qBAAqB,CAsE3C,CAAC;AAEJ,4DAA4D;AAC5D,eAAO,MAAM,eAAe,SACpB,qBAAqB,KAC1B,OAAO,CACR,eAAe,GAAG,SAAS,GAAG,UAAU,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAe5E,CAAC;AA2BF;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,UAAU;IACvD,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,OAAO,EAC9B,KAAK,EAAE,WAAW,EAClB,aAAa,CAAC,EAAE,CAAC,KACd,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,eAAO,MAAM,6BAA6B,GAAI,CAAC,WACpC,CAAC,GAAG,EAAE,OAAO,KAAK,CAAC,aACjB,CAAC,SAAS,EAAE,CAAC,KAAK,IAAI,KAChC,kBAAkB,CAAC,CAAC,CA8BtB,CAAC;AAEF,kFAAkF;AAClF,MAAM,WAAW,aAAc,SAAQ,KAAK,CAAC,eAAe,CAAC;IAC3D,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAO,SAAQ,KAAK,CAAC,QAAQ,CAAC;IAC7C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED,+DAA+D;AAC/D,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,aAAa,GAAG,MAAM,CAAC;4BA+CvE,OAAO,EAAE,oBAAoB,EAC7B,GAAG,UAAU,EAAE,KAAK,CAAC,gBAAgB,CAAC,GACrC,WAAW;;iCAoBgB,MAAM,KAAG,aAAa;mBAYpC,MAAM,KAAG,MAAM;4BAIpB,oBAAoB,iBACd,KAAK,CAAC,gBAAgB,CAAC,KACrC,WAAW;;AAKd,8EAA8E;AAC9E,eAAO,MAAM,WAAW,EAAE,UAAU,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,MAAM,CAAC;IAC7B,QAAQ,CAAC,GAAG,EAAE,OAAO,MAAM,CAAC;CAC7B,CAAuD,CAAC;AACzD,MAAM,WAAW,WAAY,SAAQ,SAAS,CAAC,OAAO,WAAW,CAAC;CAAG;AAErE,mDAAmD;AACnD,eAAO,MAAM,aAAa,EAAE,EAAE,CAAC,WAAW,CAGxC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,MAAM,EAAE,OAAO,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC;IACnE,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,CAAC;CACjD,CAGC,CAAC;AACH,MAAM,WAAW,YAAa,SAAQ,SAAS,CAAC,OAAO,YAAY,CAAC;CAAG;AAEvE,gEAAgE;AAChE,eAAO,MAAM,eAAe,SACnB,SAAS,oCAGb;IACD;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,KAAQ,YAiDR,CAAC;AAEJ;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC;QACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;KACzC,CAAC,CAAC;CACJ;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,SAAU,SAAS,KAAG,cAiBnD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,kHAA4B,CAAC;AACvD,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,UAAU,IAAI,CAAC;AAE5B;;;;GAIG;AACH,eAAO,MAAM,WAAW,IAAI,CAAC;AAE7B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,UAAW,OAAO,KAAG,aACtB,CAAC;AAEnC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,UAAW,aAAa,KAAG,OACxC,CAAC"}
+{"version":3,"file":"Sqlite.d.ts","sourceRoot":"","sources":["../../src/Sqlite.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAIlC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,KAAK,IAAI,EAAiB,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAEL,KAAK,SAAS,EAEd,KAAK,SAAS,EACd,KAAK,IAAI,EAGT,KAAK,UAAU,EAEf,KAAK,UAAU,EAEf,KAAK,OAAO,EACZ,MAAM,EAEN,KAAK,KAAK,EAGX,MAAM,WAAW,CAAC;AAEnB;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe;IAC7C,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAC7C,KAAK,EAAE,WAAW,KACf,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEzB;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;IAC3C,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAEhD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,qyBAKvB,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,MAAM,CAAC;AAEpD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,gzBAAmC,CAAC;AACtE,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAC,MAAM,CAAC;AAExE;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,WAAW,CAAC,KAAK,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,EAAE,CAAC,gBAAgB,CACsB,CAAC;AAEtE;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEzC;;;;;;OAMG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAEvC;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,UAClC,WAAW,KACjB,iBAYF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,UAClC,iBAAiB,KACvB,WAsBF,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC/D,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAChC,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAEzD;;;;;;GAMG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,gBAAgB,CAAC;IAExD,uEAAuE;IACvE,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;CAChD;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE,mBAAmB,KAC1B,IAAI,CAAC,YAAY,CAAC,CAAC;AAExB;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAA;CAAE,CAAC;AAE1E;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,SAEf,IAAI,YACA,mBAAmB,KAC5B,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,qBAAqB,CAsE3C,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,eAAe,SACpB,qBAAqB,KAC1B,OAAO,CACR,eAAe,GAAG,SAAS,GAAG,UAAU,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAe5E,CAAC;AA2BF;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,UAAU;IACvD,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,OAAO,EAC9B,KAAK,EAAE,WAAW,EAClB,aAAa,CAAC,EAAE,CAAC,KACd,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;CACpC;AAED;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,GAAI,CAAC,WACpC,CAAC,GAAG,EAAE,OAAO,KAAK,CAAC,aACjB,CAAC,SAAS,EAAE,CAAC,KAAK,IAAI,KAChC,kBAAkB,CAAC,CAAC,CA8BtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,KAAK,CAAC,eAAe,CAAC;IAC3D,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,MAAO,SAAQ,KAAK,CAAC,QAAQ,CAAC;IAC7C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,aAAa,GAAG,MAAM,CAAC;4BAiDvE,OAAO,EAAE,oBAAoB,EAC7B,GAAG,UAAU,EAAE,KAAK,CAAC,gBAAgB,CAAC,GACrC,WAAW;;iCAsBgB,MAAM,KAAG,aAAa;mBAYpC,MAAM,KAAG,MAAM;4BAIpB,oBAAoB,iBACd,KAAK,CAAC,gBAAgB,CAAC,KACrC,WAAW;;AAKd;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,UAAU,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,MAAM,CAAC;IAC7B,QAAQ,CAAC,GAAG,EAAE,OAAO,MAAM,CAAC;CAC7B,CAAuD,CAAC;AACzD,MAAM,WAAW,WAAY,SAAQ,SAAS,CAAC,OAAO,WAAW,CAAC;CAAG;AAErE;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,EAAE,CAAC,WAAW,CAGxC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,MAAM,EAAE,OAAO,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC;IACnE,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,WAAW,CAAC,CAAC;CACjD,CAGC,CAAC;AACH,MAAM,WAAW,YAAa,SAAQ,SAAS,CAAC,OAAO,YAAY,CAAC;CAAG;AAEvE;;;;GAIG;AACH,eAAO,MAAM,eAAe,SACnB,SAAS,oCAGb;IACD;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,KAAQ,YAiDR,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC;QACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;KACzC,CAAC,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,SAAU,SAAS,KAAG,cAiBnD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,kHAA4B,CAAC;AACvD,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,CAAC;AAExD;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,IAAI,CAAC;AAE5B;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,IAAI,CAAC;AAE7B;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB,UAAW,OAAO,KAAG,aACtB,CAAC;AAEnC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB,UAAW,aAAa,KAAG,OACxC,CAAC"}

package/dist/src/Sqlite.js

@@ -72,13 +72,27 @@ import { array, FiniteNumber, Null, object, record, set, String, testName, Uint8
  *
  * Note that Evolu can't support Int64 because expo-sqlite (and some others) do
  * not support it.
+ *
+ * @group Values
  */
 export const SqliteValue = /*#__PURE__*/ union(FiniteNumber, Null, String, Uint8Array);
-/** Parameters of a {@link SqliteQuery}. */
+/**
+ * Parameters of a {@link SqliteQuery}.
+ *
+ * @group Queries
+ */
 export const SqliteQueryParameters = /*#__PURE__*/ array(SqliteValue);
-/** Equality comparison for {@link SqliteValueInput}. */
+/**
+ * Equality comparison for {@link SqliteValueInput}.
+ *
+ * @group Values
+ */
 export const eqSqliteValue = (x, y) => Uint8Array.is(x) && Uint8Array.is(y) ? eqUint8Array(x, y) : x === y;
-/** Converts a {@link SqliteQuery} into a stable {@link SqliteQueryString}. */
+/**
+ * Converts a {@link SqliteQuery} into a stable {@link SqliteQueryString}.
+ *
+ * @group Queries
+ */
 export const sqliteQueryToSqliteQueryString = (query) => {
     const params = query.parameters.map((value) => Uint8Array.is(value)
         ? ["b", bytesToHex(value)]
@@ -88,7 +102,11 @@ export const sqliteQueryToSqliteQueryString = (query) => {
         : [];
     return JSON.stringify([query.sql, params, options]);
 };
-/** Converts a {@link SqliteQueryString} back into a {@link SqliteQuery}. */
+/**
+ * Converts a {@link SqliteQueryString} back into a {@link SqliteQuery}.
+ *
+ * @group Queries
+ */
 export const sqliteQueryStringToSqliteQuery = (query) => {
     const [sql, paramsArr, optionsArr] = JSON.parse(query);
     const parameters = paramsArr.map(([type, value]) => type === "b" ? hexToBytes(value) : value);
@@ -106,6 +124,8 @@ export const sqliteQueryStringToSqliteQuery = (query) => {
  *
  * The driver is created via {@link CreateSqliteDriver} and wrapped with logging,
  * error handling, and transaction helpers.
+ *
+ * @group Core
  */
 export const createSqlite = (name, options) => async (run) => {
     const env_1 = { stack: [], error: void 0, hasError: false };
@@ -179,7 +199,11 @@ export const createSqlite = (name, options) => async (run) => {
             await result_1;
     }
 };
-/** Creates a test setup with a in-memory {@link Sqlite}. */
+/**
+ * Creates a test setup with a in-memory {@link Sqlite}.
+ *
+ * @group Testing
+ */
 export const testSetupSqlite = async (deps) => {
     const env_3 = { stack: [], error: void 0, hasError: false };
     try {
@@ -223,6 +247,8 @@ const drawSqliteQueryPlan = (rows) => rows
 /**
  * Creates a {@link PreparedStatements} cache backed by the given factory and
  * dispose function.
+ *
+ * @group Core
  */
 export const createPreparedStatementsCache = (factory, disposeFn) => {
     const env_4 = { stack: [], error: void 0, hasError: false };
@@ -312,6 +338,8 @@ export const createPreparedStatementsCache = (factory, disposeFn) => {
  * Use `prettier-plugin-sql-cst` for SQL formatting. Like Prettier for
  * JavaScript, this plugin formats SQL expressions differently depending on
  * their length.
+ *
+ * @group Queries
  */
 export const sql = (strings, ...parameters) => {
     let sql = "";
@@ -325,7 +353,7 @@ export const sql = (strings, ...parameters) => {
             }
             else {
                 sql += "?";
-                values.push(SqliteValue.orThrow(param));
+                values.push(typeof param === "number" ? FiniteNumber.orThrow(param) : param);
             }
         }
     }
@@ -348,9 +376,17 @@ sql.prepared = (strings, ...parameters) => {
     const query = sql(strings, ...parameters);
     return { ...query, options: { prepare: true } };
 };
-/** Index metadata stored in `sqlite_master` for a {@link Sqlite} database. */
+/**
+ * Index metadata stored in `sqlite_master` for a {@link Sqlite} database.
+ *
+ * @group Schema
+ */
 export const SqliteIndex = /*#__PURE__*/ object({ name: String, sql: String });
-/** {@link Eq} instance for {@link SqliteIndex}. */
+/**
+ * {@link Eq} instance for {@link SqliteIndex}.
+ *
+ * @group Schema
+ */
 export const eqSqliteIndex = /*#__PURE__*/ createEqObject({
     name: eqString,
     sql: eqString,
@@ -359,12 +395,18 @@ export const eqSqliteIndex = /*#__PURE__*/ createEqObject({
  * Full schema metadata for a {@link Sqlite} database.
  *
  * Includes table-column mappings and user-visible indexes.
+ *
+ * @group Schema
  */
 export const SqliteSchema = /*#__PURE__*/ object({
     tables: /*#__PURE__*/ record(String, /*#__PURE__*/ set(String)),
     indexes: /*#__PURE__*/ array(SqliteIndex),
 });
-/** Get the current SQLite schema by reading SQLite metadata. */
+/**
+ * Get the current SQLite schema by reading SQLite metadata.
+ *
+ * @group Schema
+ */
 export const getSqliteSchema = (deps) => ({ excludeIndexNamePrefix, } = {}) => {
     const tables = createMutableRecord();
     const tableAndColumnInfoRows = deps.sqlite.exec(sql `
@@ -408,6 +450,8 @@ export const getSqliteSchema = (deps) => ({ excludeIndexNamePrefix, } = {}) => {
  *
  * The snapshot includes current {@link SqliteSchema} and all rows from every
  * discovered table. Table order follows `schema.tables` iteration order.
+ *
+ * @group Schema
  */
 export const getSqliteSnapshot = (deps) => {
     const schema = getSqliteSchema(deps)();
@@ -433,18 +477,24 @@ export const getSqliteSnapshot = (deps) => {
  *   readability.
  * - Use {@link booleanToSqliteBoolean} and {@link sqliteBooleanToBoolean} for
  *   converting between JavaScript booleans and SQLite boolean values.
+ *
+ * @group Values
  */
 export const SqliteBoolean = /*#__PURE__*/ union(0, 1);
 /**
  * Represents the {@link SqliteBoolean} value for `true`.
  *
  * See {@link SqliteBoolean}.
+ *
+ * @group Values
  */
 export const sqliteTrue = 1;
 /**
  * Represents the {@link SqliteBoolean} value for `false`.
  *
  * See {@link SqliteBoolean}.
+ *
+ * @group Values
  */
 export const sqliteFalse = 0;
 /**
@@ -457,6 +507,8 @@ export const sqliteFalse = 0;
  *
  * assertEqual(booleanToSqliteBoolean(true), 1);
  * ```
+ *
+ * @group Values
  */
 export const booleanToSqliteBoolean = (value) => value ? sqliteTrue : sqliteFalse;
 /**
@@ -469,5 +521,7 @@ export const booleanToSqliteBoolean = (value) => value ? sqliteTrue : sqliteFals
  *
  * assertTrue(sqliteBooleanToBoolean(1));
  * ```
+ *
+ * @group Values
  */
 export const sqliteBooleanToBoolean = (value) => value === sqliteTrue;

package/dist/src/Task.d.ts

@@ -1314,9 +1314,19 @@ export interface Run<D = unknown> {
      * ```
      */
     readonly onAbort: (callback: (abortError: AbortError) => void) => Disposable | null;
-    /** Returns the current {@link RunState} of this {@link Run}. */
+    /**
+     * Returns the current {@link RunState} of this {@link Run}.
+     *
+     * Abort requests are recorded before propagating to descendants. Observed
+     * aborts are recorded before this Run's abort callbacks execute.
+     */
     readonly getState: () => RunState;
-    /** Creates a memoized recursive {@link RunSnapshot} of the current Run tree. */
+    /**
+     * Creates a memoized recursive {@link RunSnapshot} of the current Run tree.
+     *
+     * Reflects abort requests and observations with the same timing as
+     * {@link Run.getState}.
+     */
     readonly snapshot: () => RunSnapshot;
     /**
      * Callback for monitoring Run events emitted by this Run or descendants.
@@ -1867,8 +1877,9 @@ export interface ReportDefectDep {
  * platforms without native global error reporting. Browser adapters use the
  * native
  * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/reportError | reportError}
- * API; other platform adapters can use platform-specific reporting and preserve
- * nested panic defects as cause or detail data.
+ * API, and other platform adapters can use platform-specific reporting.
+ * Adapters report an `Error` from {@link defectToError}, which such reporting
+ * shows readably.
  *
  * @group Run
  */