packages/modeldb: add modeldb-sqlite-wasm composite key support

packages/modeldb-durable-objects/src/api.ts

@@ -20,7 +20,13 @@ import {
 	PropertyValue,
 } from "@canvas-js/modeldb"
 
-import { decodePrimitiveValue, decodeReferenceValue, encodePrimitiveValue, encodeReferenceValue } from "./encoding.js"
+import {
+	SqlitePrimitiveValue,
+	decodePrimitiveValue,
+	decodeReferenceValue,
+	encodePrimitiveValue,
+	encodeReferenceValue,
+} from "./encoding.js"
 
 import { Method, Query } from "./utils.js"
 
@@ -68,8 +74,8 @@ export class ModelAPI {
 		string,
 		{
 			columns: string[]
-			encode: (value: PropertyValue) => SqlStorageValue[]
-			decode: (record: Record<string, SqlStorageValue>) => PropertyValue
+			encode: (value: PropertyValue) => SqlitePrimitiveValue[]
+			decode: (record: Record<string, SqlitePrimitiveValue>) => PropertyValue
 		}
 	> = {}
 
@@ -275,8 +281,8 @@ export class ModelAPI {
 		}
 	}
 
-	private encodeProperties(properties: Property[], value: ModelValue): SqlStorageValue[] {
-		const result: SqlStorageValue[] = []
+	private encodeProperties(properties: Property[], value: ModelValue): SqlitePrimitiveValue[] {
+		const result: SqlitePrimitiveValue[] = []
 		for (const property of properties) {
 			if (property.kind === "primitive") {
 				const { name, type, nullable } = property
@@ -320,7 +326,7 @@ export class ModelAPI {
 
 	public count(where?: WhereCondition): number {
 		const sql: string[] = []
-		const params: SqlStorageValue[] = []
+		const params: SqlitePrimitiveValue[] = []
 
 		// SELECT
 		sql.push(`SELECT COUNT(*) AS count FROM "${this.#table}"`)
@@ -357,7 +363,11 @@ export class ModelAPI {
 		}
 	}
 
-	private parseRecord(row: Record<string, SqlStorageValue>, properties: string[], relations: Relation[]): ModelValue {
+	private parseRecord(
+		row: Record<string, SqlitePrimitiveValue>,
+		properties: string[],
+		relations: Relation[],
+	): ModelValue {
 		const record: ModelValue = {}
 		for (const name of properties) {
 			record[name] = this.codecs[name].decode(row)
@@ -381,10 +391,10 @@ export class ModelAPI {
 
 	private parseQuery(
 		query: QueryParams,
-	): [sql: string, properties: string[], relations: Relation[], params: SqlStorageValue[]] {
+	): [sql: string, properties: string[], relations: Relation[], params: SqlitePrimitiveValue[]] {
 		// See https://www.sqlite.org/lang_select.html for railroad diagram
 		const sql: string[] = []
-		const params: SqlStorageValue[] = []
+		const params: SqlitePrimitiveValue[] = []
 
 		// SELECT
 		const select = query.select ?? mapValues(this.#properties, () => true)
@@ -471,8 +481,8 @@ export class ModelAPI {
 		return [columns.join(", "), properties, relations]
 	}
 
-	private getWhereExpression(where: WhereCondition = {}): [where: string | null, params: SqlStorageValue[]] {
-		const params: SqlStorageValue[] = []
+	private getWhereExpression(where: WhereCondition = {}): [where: string | null, params: SqlitePrimitiveValue[]] {
+		const params: SqlitePrimitiveValue[] = []
 
 		const filters: string[] = []
 		for (const [name, expression] of Object.entries(where)) {
@@ -671,18 +681,18 @@ export class RelationAPI {
 		this.#select = new Query(this.db, `SELECT ${targetColumns} FROM "${this.table}" WHERE ${selectBySource}`)
 	}
 
-	public get(sourceKey: SqlStorageValue[]): SqlStorageValue[][] {
+	public get(sourceKey: SqlitePrimitiveValue[]): SqlitePrimitiveValue[][] {
 		const targets = this.#select.all(sourceKey)
 		return targets.map((record) => this.sourceColumnNames.map((name) => record[name]))
 	}
 
-	public add(sourceKey: SqlStorageValue[], targetKeys: SqlStorageValue[][]) {
+	public add(sourceKey: SqlitePrimitiveValue[], targetKeys: SqlitePrimitiveValue[][]) {
 		for (const targetKey of targetKeys) {
 			this.#insert.run([...sourceKey, ...targetKey])
 		}
 	}
 
-	public delete(sourceKey: SqlStorageValue[]) {
+	public delete(sourceKey: SqlitePrimitiveValue[]) {
 		this.#delete.run(sourceKey)
 	}
 

packages/modeldb-durable-objects/src/encoding.ts

@@ -6,6 +6,8 @@ import { PrimaryKeyValue, PrimitiveProperty, PrimitiveType, PrimitiveValue, Prop
 
 import { assert, signalInvalidType } from "@canvas-js/utils"
 
+export type SqlitePrimitiveValue = SqlStorageValue
+
 export function toArrayBuffer(data: Uint8Array): ArrayBuffer {
 	if (data.byteOffset === 0 && data.byteLength === data.buffer.byteLength) {
 		return data.buffer
@@ -25,7 +27,7 @@ export function encodePrimitiveValue(
 	type: PrimitiveType,
 	nullable: boolean,
 	value: PropertyValue,
-): SqlStorageValue {
+): SqlitePrimitiveValue {
 	if (value === null) {
 		if (nullable) {
 			return null
@@ -80,7 +82,7 @@ export function encodeReferenceValue(
 	target: PrimitiveProperty[],
 	nullable: boolean,
 	value: PropertyValue,
-): SqlStorageValue[] {
+): SqlitePrimitiveValue[] {
 	if (value === null) {
 		if (nullable) {
 			return Array.from<null>({ length: target.length }).fill(null)
@@ -101,7 +103,7 @@ export function decodePrimitiveValue(
 	propertyName: string,
 	type: PrimitiveType,
 	nullable: boolean,
-	value: SqlStorageValue,
+	value: SqlitePrimitiveValue,
 ): PrimitiveValue {
 	if (value === null) {
 		if (nullable) {
@@ -161,7 +163,7 @@ export function decodeReferenceValue(
 	propertyName: string,
 	nullable: boolean,
 	target: PrimitiveProperty[],
-	values: SqlStorageValue[],
+	values: SqlitePrimitiveValue[],
 ): PrimaryKeyValue | PrimaryKeyValue[] | null {
 	if (values.every((value) => value === null)) {
 		if (nullable) {

packages/modeldb-sqlite-expo/src/ModelDB.ts

@@ -6,12 +6,12 @@ import { assert, signalInvalidType } from "@canvas-js/utils"
 import {
 	AbstractModelDB,
 	ModelDBBackend,
-	parseConfig,
 	Effect,
 	ModelValue,
 	ModelSchema,
 	QueryParams,
 	WhereCondition,
+	Config,
 } from "@canvas-js/modeldb"
 
 import { ModelAPI } from "./api.js"
@@ -28,7 +28,7 @@ export class ModelDB extends AbstractModelDB {
 	#transaction: (effects: Effect[]) => void
 
 	constructor({ path, models, clear }: { clear?: boolean } & ModelDBOptions) {
-		super(parseConfig(models))
+		super(Config.parse(models))
 
 		this.db = SQLite.openDatabaseSync(path ?? ":memory:")
 

packages/modeldb-sqlite-expo/src/api.ts

@@ -1,4 +1,4 @@
-import { SQLiteDatabase, SQLiteBindValue } from "expo-sqlite"
+import { SQLiteDatabase } from "expo-sqlite"
 
 import { assert, signalInvalidType, mapValues } from "@canvas-js/utils"
 
@@ -20,9 +20,13 @@ import {
 	PropertyValue,
 } from "@canvas-js/modeldb"
 
-import { zip } from "@canvas-js/utils"
-
-import { decodePrimitiveValue, decodeReferenceValue, encodePrimitiveValue, encodeReferenceValue } from "./encoding.js"
+import {
+	SqlitePrimitiveValue,
+	decodePrimitiveValue,
+	decodeReferenceValue,
+	encodePrimitiveValue,
+	encodeReferenceValue,
+} from "./encoding.js"
 
 import { Method, Query } from "./utils.js"
 
@@ -70,8 +74,8 @@ export class ModelAPI {
 		string,
 		{
 			columns: string[]
-			encode: (value: PropertyValue) => SQLiteBindValue[]
-			decode: (record: Record<string, SQLiteBindValue>) => PropertyValue
+			encode: (value: PropertyValue) => SqlitePrimitiveValue[]
+			decode: (record: Record<string, SqlitePrimitiveValue>) => PropertyValue
 		}
 	> = {}
 
@@ -276,8 +280,8 @@ export class ModelAPI {
 		}
 	}
 
-	private encodeProperties(properties: Property[], value: ModelValue): SQLiteBindValue[] {
-		const result: SQLiteBindValue[] = []
+	private encodeProperties(properties: Property[], value: ModelValue): SqlitePrimitiveValue[] {
+		const result: SqlitePrimitiveValue[] = []
 		for (const property of properties) {
 			if (property.kind === "primitive") {
 				const { name, type, nullable } = property
@@ -358,7 +362,11 @@ export class ModelAPI {
 		}
 	}
 
-	private parseRecord(row: Record<string, SQLiteBindValue>, properties: string[], relations: Relation[]): ModelValue {
+	private parseRecord(
+		row: Record<string, SqlitePrimitiveValue>,
+		properties: string[],
+		relations: Relation[],
+	): ModelValue {
 		const record: ModelValue = {}
 		for (const name of properties) {
 			record[name] = this.codecs[name].decode(row)
@@ -382,10 +390,10 @@ export class ModelAPI {
 
 	private parseQuery(
 		query: QueryParams,
-	): [sql: string, properties: string[], relations: Relation[], params: SQLiteBindValue[]] {
+	): [sql: string, properties: string[], relations: Relation[], params: SqlitePrimitiveValue[]] {
 		// See https://www.sqlite.org/lang_select.html for railroad diagram
 		const sql: string[] = []
-		const params: SQLiteBindValue[] = []
+		const params: SqlitePrimitiveValue[] = []
 
 		// SELECT
 		const select = query.select ?? mapValues(this.#properties, () => true)
@@ -672,18 +680,18 @@ export class RelationAPI {
 		this.#select = new Query(this.db, `SELECT ${targetColumns} FROM "${this.table}" WHERE ${selectBySource}`)
 	}
 
-	public get(sourceKey: SQLiteBindValue[]): SQLiteBindValue[][] {
+	public get(sourceKey: SqlitePrimitiveValue[]): SqlitePrimitiveValue[][] {
 		const targets = this.#select.all(sourceKey)
 		return targets.map((record) => this.sourceColumnNames.map((name) => record[name]))
 	}
 
-	public add(sourceKey: SQLiteBindValue[], targetKeys: SQLiteBindValue[][]) {
+	public add(sourceKey: SqlitePrimitiveValue[], targetKeys: SqlitePrimitiveValue[][]) {
 		for (const targetKey of targetKeys) {
 			this.#insert.run([...sourceKey, ...targetKey])
 		}
 	}
 
-	public delete(sourceKey: SQLiteBindValue[]) {
+	public delete(sourceKey: SqlitePrimitiveValue[]) {
 		this.#delete.run(sourceKey)
 	}
 

packages/modeldb-sqlite-expo/src/encoding.ts

@@ -12,12 +12,14 @@ import type {
 
 import { assert, signalInvalidType } from "@canvas-js/utils"
 
+export type SqlitePrimitiveValue = SQLiteBindValue
+
 export function encodePrimitiveValue(
 	propertyName: string,
 	type: PrimitiveType,
 	nullable: boolean,
 	value: PropertyValue,
-): SQLiteBindValue {
+): SqlitePrimitiveValue {
 	if (value === null) {
 		if (nullable) {
 			return null
@@ -72,7 +74,7 @@ export function encodeReferenceValue(
 	target: PrimitiveProperty[],
 	nullable: boolean,
 	value: PropertyValue,
-): SQLiteBindValue[] {
+): SqlitePrimitiveValue[] {
 	if (value === null) {
 		if (nullable) {
 			return Array.from<null>({ length: target.length }).fill(null)
@@ -93,7 +95,7 @@ export function decodePrimitiveValue(
 	propertyName: string,
 	type: PrimitiveType,
 	nullable: boolean,
-	value: SQLiteBindValue,
+	value: SqlitePrimitiveValue,
 ): PrimitiveValue {
 	if (value === null) {
 		if (nullable) {
@@ -153,7 +155,7 @@ export function decodeReferenceValue(
 	propertyName: string,
 	nullable: boolean,
 	target: PrimitiveProperty[],
-	values: SQLiteBindValue[],
+	values: SqlitePrimitiveValue[],
 ): PrimaryKeyValue | PrimaryKeyValue[] | null {
 	if (values.every((value) => value === null)) {
 		if (nullable) {

packages/modeldb-sqlite-expo/src/utils.ts

@@ -1,6 +1,9 @@
 import { SQLiteBindValue, SQLiteDatabase, SQLiteStatement } from "expo-sqlite"
 
-export class Query<P extends SQLiteBindValue[] = SQLiteBindValue[], R = Record<string, SQLiteBindValue>> {
+export class Query<
+	P extends SQLiteBindValue[] = SQLiteBindValue[],
+	R extends Record<string, SQLiteBindValue> = Record<string, SQLiteBindValue>,
+> {
 	private readonly statement: SQLiteStatement
 
 	constructor(db: SQLiteDatabase, private readonly sql: string) {

packages/modeldb-sqlite-wasm/src/InnerModelDB.ts

@@ -53,8 +53,29 @@ export class InnerModelDB {
 
 	public iterate(modelName: string, query: QueryParams = {}): AsyncIterable<ModelValue> {
 		const api = this.#models[modelName]
-		assert(api !== undefined, `model ${modelName} not found`)
-		return Comlink.proxy(api.iterate(query))
+		if (api === undefined) {
+			throw new Error(`model ${modelName} not found`)
+		}
+
+		return Comlink.proxy({
+			[Symbol.asyncIterator]() {
+				const iter = api.iterate(query)
+
+				return {
+					async next() {
+						return iter.next()
+					},
+
+					async return(value) {
+						return iter.return?.(value) ?? { done: true, value: undefined }
+					},
+
+					async throw(err) {
+						return iter.throw?.(err) ?? { done: true, value: undefined }
+					},
+				}
+			},
+		})
 	}
 
 	public count(modelName: string, where?: WhereCondition): number {