cloesce 0.0.4-unstable.9 → 0.0.5-unstable.0

package/dist/ui/backend.js

@@ -1,7 +1,11 @@
-import { Either } from "../common.js";
+import { Either, u8ToB64 } from "./common.js";
 import { RuntimeContainer } from "../router/router.js";
-import { WasmResource, mapSql as mapSql, invokeOrmWasm, } from "../router/wasm.js";
-export { CloesceApp, } from "../router/router.js";
+import { WasmResource, mapSql, invokeOrmWasm } from "../router/wasm.js";
+/**
+ * cloesce/backend
+ */
+export { CloesceApp } from "../router/router.js";
+export { HttpResult, Either } from "./common.js";
 /**
  * Marks a class as a D1-backed SQL model.
  *
@@ -22,7 +26,8 @@ export { CloesceApp, } from "../router/router.js";
  *  }
  * ```
  */
-export const D1 = () => { };
+export const D1 = () => {};
+export const Service = () => {};
 /**
  * Marks a class as a plain serializable object.
  *
@@ -49,7 +54,7 @@ export const D1 = () => { };
  * async function foo(): Promise<HttpResult<CatStuff>> { ... }
  * ```
  */
-export const PlainOldObject = () => { };
+export const PlainOldObject = () => {};
 /**
  * Declares a Wrangler environment definition.
  *
@@ -71,7 +76,7 @@ export const PlainOldObject = () => { };
  * foo(＠Inject env: WranglerEnv) {...}
  * ```
  */
-export const WranglerEnv = () => { };
+export const WranglerEnv = () => {};
 /**
  * Marks a property as the SQL primary key for a model.
  *
@@ -88,32 +93,32 @@ export const WranglerEnv = () => { };
  * }
  * ```
  */
-export const PrimaryKey = () => { };
+export const PrimaryKey = () => {};
 /**
  * Exposes a class method as an HTTP GET endpoint.
  * The method will appear in both backend and generated client APIs.
  */
-export const GET = () => { };
+export const GET = () => {};
 /**
  * Exposes a class method as an HTTP POST endpoint.
  * The method will appear in both backend and generated client APIs.
  */
-export const POST = () => { };
+export const POST = () => {};
 /**
  * Exposes a class method as an HTTP PUT endpoint.
  * The method will appear in both backend and generated client APIs.
  */
-export const PUT = () => { };
+export const PUT = () => {};
 /**
  * Exposes a class method as an HTTP PATCH endpoint.
  * The method will appear in both backend and generated client APIs.
  */
-export const PATCH = () => { };
+export const PATCH = () => {};
 /**
  * Exposes a class method as an HTTP DEL endpoint.
  * The method will appear in both backend and generated client APIs.
  */
-export const DELETE = () => { };
+export const DELETE = () => {};
 /**
  * Declares a static property as a data source.
  *
@@ -154,7 +159,7 @@ export const DELETE = () => { };
  * // => Person { id: 1, dogId: 2, dog: { id: 2, name: "Fido" } }[]
  * ```
  */
-export const DataSource = () => { };
+export const DataSource = () => {};
 /**
  * Declares a one-to-many relationship between models.
  *
@@ -167,7 +172,7 @@ export const DataSource = () => { };
  * dogs: Dog[];
  * ```
  */
-export const OneToMany = (_foreignKeyColumn) => () => { };
+export const OneToMany = (_foreignKeyColumn) => () => {};
 /**
  * Declares a one-to-one relationship between models.
  *
@@ -180,7 +185,7 @@ export const OneToMany = (_foreignKeyColumn) => () => { };
  * dog: Dog | undefined;
  * ```
  */
-export const OneToOne = (_foreignKeyColumn) => () => { };
+export const OneToOne = (_foreignKeyColumn) => () => {};
 /**
  * Declares a many-to-many relationship between models.
  *
@@ -193,7 +198,7 @@ export const OneToOne = (_foreignKeyColumn) => () => { };
  * courses: Course[];
  * ```
  */
-export const ManyToMany = (_uniqueId) => () => { };
+export const ManyToMany = (_uniqueId) => () => {};
 /**
  * Declares a foreign key relationship between models.
  * Directly translates to a SQLite foreign key.
@@ -208,7 +213,7 @@ export const ManyToMany = (_uniqueId) => () => { };
  * dogId: number;
  * ```
  */
-export const ForeignKey = (_Model) => () => { };
+export const ForeignKey = (_Model) => () => {};
 /**
  * Marks a method parameter for dependency injection.
  *
@@ -226,7 +231,7 @@ export const ForeignKey = (_Model) => () => { };
  * }
  * ```
  */
-export const Inject = () => { };
+export const Inject = () => {};
 /**
  * Enables automatic CRUD method generation for a model.
  *
@@ -255,247 +260,256 @@ export const Inject = () => { };
  * }
  * ```
  */
-export const CRUD = (_kinds) => () => { };
+export const CRUD = (_kinds) => () => {};
 /**
  * Exposes the ORM primitives Cloesce uses to interact with D1 databases.
  */
 export class Orm {
-    db;
-    constructor(db) {
-        this.db = db;
-    }
-    /**
-     * Creates an instance of an `Orm`
-     * @param db The database to use for ORM calls.
-     */
-    static fromD1(db) {
-        return new Orm(db);
+  db;
+  constructor(db) {
+    this.db = db;
+  }
+  /**
+   * Creates an instance of an `Orm`
+   * @param db The database to use for ORM calls.
+   */
+  static fromD1(db) {
+    return new Orm(db);
+  }
+  /**
+   * Maps SQL records to an instantiated Model. The records must be flat
+   * (e.g., of the form "id, name, address") or derive from a Cloesce data source view
+   * (e.g., of the form "Horse.id, Horse.name, Horse.address")
+   *
+   * Assumes the data is formatted correctly, throwing an error otherwise.
+   *
+   * @param ctor The model constructor
+   * @param records D1 Result records
+   * @param includeTree Include tree to define the relationships to join.
+   */
+  static mapSql(ctor, records, includeTree = null) {
+    return mapSql(ctor, records, includeTree).unwrap();
+  }
+  /**
+   * Executes an "upsert" query, adding or augmenting a model in the database.
+   *
+   * If a model's primary key is not defined in `newModel`, the query is assumed to be an insert.
+   *
+   * If a model's primary key _is_ defined, but some attributes are missing, the query is assumed to be an update.
+   *
+   * Finally, if the primary key is defined, but all attributes are included, a SQLite upsert will be performed.
+   *
+   * In any other case, an error string will be returned.
+   *
+   * ### Inserting a new Model
+   * ```ts
+   * const model = {name: "julio", lastname: "pumpkin"};
+   * const idRes = await orm.upsert(Person, model, null);
+   * ```
+   *
+   * ### Updating an existing model
+   * ```ts
+   * const model =  {id: 1, name: "timothy"};
+   * const idRes = await orm.upsert(Person, model, null);
+   * // (in db)=> {id: 1, name: "timothy", lastname: "pumpkin"}
+   * ```
+   *
+   * ### Upserting a model
+   * ```ts
+   * // (assume a Person already exists)
+   * const model = {
+   *  id: 1,
+   *  lastname: "burger", // updates last name
+   *  dog: {
+   *    name: "fido" // insert dog relationship
+   *  }
+   * };
+   * const idRes = await orm.upsert(Person, model, null);
+   * // (in db)=> Person: {id: 1, dogId: 1 ...}  ; Dog: {id: 1, name: "fido"}
+   * ```
+   *
+   * @param ctor A model constructor.
+   * @param newModel The new or augmented model.
+   * @param includeTree An include tree describing which foreign keys to join.
+   * @returns An error string, or the primary key of the inserted model.
+   */
+  async upsert(ctor, newModel, includeTree = null) {
+    const { wasm } = RuntimeContainer.get();
+    const args = [
+      WasmResource.fromString(ctor.name, wasm),
+      WasmResource.fromString(
+        JSON.stringify(newModel, (k, v) =>
+          v instanceof Uint8Array ? u8ToB64(v) : v,
+        ),
+        wasm,
+      ),
+      WasmResource.fromString(JSON.stringify(includeTree), wasm),
+    ];
+    const upsertQueryRes = invokeOrmWasm(wasm.upsert_model, args, wasm);
+    if (upsertQueryRes.isLeft()) {
+      return upsertQueryRes;
     }
-    /**
-     * Maps SQL records to an instantiated Model. The records must be flat
-     * (e.g., of the form "id, name, address") or derive from a Cloesce data source view
-     * (e.g., of the form "Horse.id, Horse.name, Horse.address")
-     * @param ctor The model constructor
-     * @param records D1 Result records
-     * @param includeTree Include tree to define the relationships to join.
-     */
-    static mapSql(ctor, records, includeTree = null) {
-        return mapSql(ctor, records, includeTree);
+    const statements = JSON.parse(upsertQueryRes.unwrap());
+    // One of these statements is a "SELECT", which is the root model id stmt.
+    let selectIndex;
+    for (let i = statements.length - 1; i >= 0; i--) {
+      if (/^SELECT/i.test(statements[i].query)) {
+        selectIndex = i;
+        break;
+      }
     }
-    /**
-     * Executes an "upsert" query, adding or augmenting a model in the database.
-     *
-     * If a model's primary key is not defined in `newModel`, the query is assumed to be an insert.
-     *
-     * If a model's primary key _is_ defined, but some attributes are missing, the query is assumed to be an update.
-     *
-     * Finally, if the primary key is defined, but all attributes are included, a SQLite upsert will be performed.
-     *
-     * In any other case, an error string will be returned.
-     *
-     * ### Inserting a new Model
-     * ```ts
-     * const model = {name: "julio", lastname: "pumpkin"};
-     * const idRes = await orm.upsert(Person, model, null);
-     * ```
-     *
-     * ### Updating an existing model
-     * ```ts
-     * const model =  {id: 1, name: "timothy"};
-     * const idRes = await orm.upsert(Person, model, null);
-     * // (in db)=> {id: 1, name: "timothy", lastname: "pumpkin"}
-     * ```
-     *
-     * ### Upserting a model
-     * ```ts
-     * // (assume a Person already exists)
-     * const model = {
-     *  id: 1,
-     *  lastname: "burger", // updates last name
-     *  dog: {
-     *    name: "fido" // insert dog relationship
-     *  }
-     * };
-     * const idRes = await orm.upsert(Person, model, null);
-     * // (in db)=> Person: {id: 1, dogId: 1 ...}  ; Dog: {id: 1, name: "fido"}
-     * ```
-     *
-     * @param ctor A model constructor.
-     * @param newModel The new or augmented model.
-     * @param includeTree An include tree describing which foreign keys to join.
-     * @returns An error string, or the primary key of the inserted model.
-     */
-    async upsert(ctor, newModel, includeTree = null) {
-        const { wasm } = RuntimeContainer.get();
-        const args = [
-            WasmResource.fromString(ctor.name, wasm),
-            WasmResource.fromString(JSON.stringify(newModel), wasm),
-            WasmResource.fromString(JSON.stringify(includeTree), wasm),
-        ];
-        const upsertQueryRes = invokeOrmWasm(wasm.upsert_model, args, wasm);
-        if (upsertQueryRes.isLeft()) {
-            return upsertQueryRes;
-        }
-        const statements = JSON.parse(upsertQueryRes.unwrap());
-        // One of these statements is a "SELECT", which is the root model id stmt.
-        let selectIndex;
-        for (let i = statements.length - 1; i >= 0; i--) {
-            if (/^SELECT/i.test(statements[i].query)) {
-                selectIndex = i;
-                break;
-            }
-        }
-        // Execute all statements in a batch.
-        const batchRes = await this.db.batch(statements.map((s) => this.db.prepare(s.query).bind(...s.values)));
-        if (!batchRes.every((r) => r.success)) {
-            const failed = batchRes.find((r) => !r.success);
-            return Either.left(failed?.error ?? "D1 batch failed, but no error was returned.");
-        }
-        // Return the result of the SELECT statement
-        const selectResult = batchRes[selectIndex].results[0];
-        return Either.right(selectResult.id);
+    // Execute all statements in a batch.
+    const batchRes = await this.db.batch(
+      statements.map((s) => this.db.prepare(s.query).bind(...s.values)),
+    );
+    if (!batchRes.every((r) => r.success)) {
+      const failed = batchRes.find((r) => !r.success);
+      return Either.left(
+        failed?.error ?? "D1 batch failed, but no error was returned.",
+      );
     }
-    /**
-     * Returns a select query, creating a CTE view for the model using the provided include tree.
-     *
-     * @param ctor The model constructor.
-     * @param includeTree An include tree describing which related models to join.
-     * @param from An optional custom `FROM` clause to use instead of the base table.
-     * @param tagCte An optional CTE name to tag the query with. Defaults to "Model.view".
-     *
-     * ### Example:
-     * ```ts
-     * // Using a data source
-     * const query = Orm.listQuery(Person, "default");
-     *
-     * // Using a custom from statement
-     * const query = Orm.listQuery(Person, null, "SELECT * FROM Person WHERE age > 18");
-     * ```
-     *
-     * ### Example SQL output:
-     * ```sql
-     * WITH Person_view AS (
-     * SELECT
-     * "Person"."id" AS "id",
-     * ...
-     * FROM "Person"
-     * LEFT JOIN ...
-     * )
-     * SELECT * FROM Person_view
-     * ```
-     */
-    static listQuery(ctor, opts) {
-        const { wasm } = RuntimeContainer.get();
-        const args = [
-            WasmResource.fromString(ctor.name, wasm),
-            WasmResource.fromString(JSON.stringify(opts.includeTree ?? null), wasm),
-            WasmResource.fromString(JSON.stringify(opts.tagCte ?? null), wasm),
-            WasmResource.fromString(JSON.stringify(opts.from ?? null), wasm),
-        ];
-        const res = invokeOrmWasm(wasm.list_models, args, wasm);
-        if (res.isLeft()) {
-            throw new Error(`Error invoking the Cloesce WASM Binary: ${res.value}`);
-        }
-        return res.unwrap();
+    const rootModelId = batchRes[selectIndex].results[0];
+    return Either.right(rootModelId.id);
+  }
+  /**
+   * Returns a select query, creating a CTE view for the model using the provided include tree.
+   *
+   * @param ctor The model constructor.
+   * @param includeTree An include tree describing which related models to join.
+   * @param from An optional custom `FROM` clause to use instead of the base table.
+   * @param tagCte An optional CTE name to tag the query with. Defaults to "Model.view".
+   *
+   * ### Example:
+   * ```ts
+   * // Using a data source
+   * const query = Orm.listQuery(Person, "default");
+   *
+   * // Using a custom from statement
+   * const query = Orm.listQuery(Person, null, "SELECT * FROM Person WHERE age > 18");
+   * ```
+   *
+   * ### Example SQL output:
+   * ```sql
+   * WITH Person_view AS (
+   * SELECT
+   * "Person"."id" AS "id",
+   * ...
+   * FROM "Person"
+   * LEFT JOIN ...
+   * )
+   * SELECT * FROM Person_view
+   * ```
+   */
+  static listQuery(ctor, opts) {
+    const { wasm } = RuntimeContainer.get();
+    const args = [
+      WasmResource.fromString(ctor.name, wasm),
+      WasmResource.fromString(JSON.stringify(opts.includeTree ?? null), wasm),
+      WasmResource.fromString(JSON.stringify(opts.tagCte ?? null), wasm),
+      WasmResource.fromString(JSON.stringify(opts.from ?? null), wasm),
+    ];
+    const res = invokeOrmWasm(wasm.list_models, args, wasm);
+    if (res.isLeft()) {
+      throw new Error(`Error invoking the Cloesce WASM Binary: ${res.value}`);
     }
-    /**
-     * Returns a select query for a single model by primary key, creating a CTE view using the provided include tree.
-     *
-     * @param ctor The model constructor.
-     * @param includeTree An include tree describing which related models to join.
-     *
-     * ### Example:
-     * ```ts
-     * // Using a data source
-     * const query = Orm.getQuery(Person, "default");
-     * ```
-     *
-     * ### Example SQL output:
-     *
-     * ```sql
-     * WITH Person_view AS (
-     * SELECT
-     * "Person"."id" AS "id",
-     * ...
-     * FROM "Person"
-     * LEFT JOIN ...
-     * )
-     * SELECT * FROM Person_view WHERE [Person].[id] = ?
-     * ```
-     */
-    static getQuery(ctor, includeTree) {
-        const { ast } = RuntimeContainer.get();
-        return `${this.listQuery(ctor, { includeTree })} WHERE [${ast.models[ctor.name].primary_key.name}] = ?`;
+    return res.unwrap();
+  }
+  /**
+   * Returns a select query for a single model by primary key, creating a CTE view using the provided include tree.
+   *
+   * @param ctor The model constructor.
+   * @param includeTree An include tree describing which related models to join.
+   *
+   * ### Example:
+   * ```ts
+   * // Using a data source
+   * const query = Orm.getQuery(Person, "default");
+   * ```
+   *
+   * ### Example SQL output:
+   *
+   * ```sql
+   * WITH Person_view AS (
+   * SELECT
+   * "Person"."id" AS "id",
+   * ...
+   * FROM "Person"
+   * LEFT JOIN ...
+   * )
+   * SELECT * FROM Person_view WHERE [Person].[id] = ?
+   * ```
+   */
+  static getQuery(ctor, includeTree) {
+    const { ast } = RuntimeContainer.get();
+    return `${this.listQuery(ctor, { includeTree })} WHERE [${ast.models[ctor.name].primary_key.name}] = ?`;
+  }
+  /**
+   * Retrieves all instances of a model from the database.
+   * @param ctor The model constructor.
+   * @param includeTree An include tree describing which related models to join.
+   * @param from An optional custom `FROM` clause to use instead of the base table.
+   * @returns Either an error string, or an array of model instances.
+   *
+   * ### Example:
+   * ```ts
+   * const orm = Orm.fromD1(env.db);
+   * const horses = await orm.list(Horse, Horse.default);
+   * ```
+   *
+   * ### Example with custom from:
+   * ```ts
+   * const orm = Orm.fromD1(env.db);
+   * const adultHorses = await orm.list(Horse, Horse.default, "SELECT * FROM Horse ORDER BY age DESC LIMIT 10");
+   * ```
+   *
+   * =>
+   *
+   * ```sql
+   * SELECT
+   *  "Horse"."id" AS "id",
+   * ...
+   * FROM (SELECT * FROM Horse ORDER BY age DESC LIMIT 10)
+   * LEFT JOIN ...
+   * ```
+   *
+   */
+  async list(ctor, opts) {
+    const sql = Orm.listQuery(ctor, opts);
+    const stmt = this.db.prepare(sql);
+    const records = await stmt.all();
+    if (!records.success) {
+      return Either.left(
+        records.error ?? "D1 query failed, but no error was returned.",
+      );
     }
-    /**
-     * Retrieves all instances of a model from the database.
-     * @param ctor The model constructor.
-     * @param includeTree An include tree describing which related models to join.
-     * @param from An optional custom `FROM` clause to use instead of the base table.
-     * @returns Either an error string, or an array of model instances.
-     *
-     * ### Example:
-     * ```ts
-     * const orm = Orm.fromD1(env.db);
-     * const horses = await orm.list(Horse, Horse.default);
-     * ```
-     *
-     * ### Example with custom from:
-     * ```ts
-     * const orm = Orm.fromD1(env.db);
-     * const adultHorses = await orm.list(Horse, Horse.default, "SELECT * FROM Horse ORDER BY age DESC LIMIT 10");
-     * ```
-     *
-     * =>
-     *
-     * ```sql
-     * SELECT
-     *  "Horse"."id" AS "id",
-     * ...
-     * FROM (SELECT * FROM Horse ORDER BY age DESC LIMIT 10)
-     * LEFT JOIN ...
-     * ```
-     *
-     */
-    async list(ctor, opts) {
-        const sql = Orm.listQuery(ctor, opts);
-        const stmt = this.db.prepare(sql);
-        const records = await stmt.all();
-        if (!records.success) {
-            return Either.left(records.error ?? "D1 query failed, but no error was returned.");
-        }
-        const mapRes = Orm.mapSql(ctor, records.results, opts.includeTree ?? null);
-        if (mapRes.isLeft()) {
-            return Either.left(mapRes.value);
-        }
-        return Either.right(mapRes.value);
+    const mapped = Orm.mapSql(ctor, records.results, opts.includeTree ?? null);
+    return Either.right(mapped);
+  }
+  /**
+   * Retrieves a single model by primary key.
+   * @param ctor The model constructor.
+   * @param id The primary key value.
+   * @param includeTree An include tree describing which related models to join.
+   * @returns Either an error string, or the model instance (null if not found).
+   *
+   * ### Example:
+   * ```ts
+   * const orm = Orm.fromD1(env.db);
+   * const horse = await orm.get(Horse, 1, Horse.default);
+   * ```
+   */
+  async get(ctor, id, includeTree) {
+    const sql = Orm.getQuery(ctor, includeTree);
+    const record = await this.db.prepare(sql).bind(id).run();
+    if (!record.success) {
+      return Either.left(
+        record.error ?? "D1 query failed, but no error was returned.",
+      );
     }
-    /**
-     * Retrieves a single model by primary key.
-     * @param ctor The model constructor.
-     * @param id The primary key value.
-     * @param includeTree An include tree describing which related models to join.
-     * @returns Either an error string, or the model instance (null if not found).
-     *
-     * ### Example:
-     * ```ts
-     * const orm = Orm.fromD1(env.db);
-     * const horse = await orm.get(Horse, 1, Horse.default);
-     * ```
-     */
-    async get(ctor, id, includeTree) {
-        const sql = Orm.getQuery(ctor, includeTree);
-        const record = await this.db.prepare(sql).bind(id).run();
-        if (!record.success) {
-            return Either.left(record.error ?? "D1 query failed, but no error was returned.");
-        }
-        if (record.results.length === 0) {
-            return Either.right(null);
-        }
-        const mapRes = Orm.mapSql(ctor, record.results, includeTree);
-        if (mapRes.isLeft()) {
-            return Either.left(mapRes.value);
-        }
-        return Either.right(mapRes.value[0]);
+    if (record.results.length === 0) {
+      return Either.right(null);
     }
+    const mapped = Orm.mapSql(ctor, record.results, includeTree);
+    return Either.right(mapped[0]);
+  }
 }

package/dist/ui/client.d.ts

@@ -1,5 +1,7 @@
-export type { HttpResult, Either, DeepPartial } from "../common.js";
-export declare function instantiateObjectArray<T extends object>(data: any, ctor: {
-    new (): T;
-}): T[];
-//# sourceMappingURL=client.d.ts.map
+/**
+ * cloesce/client
+ */
+export type { DeepPartial, Stream } from "./common.js";
+export { HttpResult, Either, requestBody, b64ToU8 } from "./common.js";
+export { MediaType } from "../ast.js";
+//# sourceMappingURL=client.d.ts.map

package/dist/ui/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/ui/client.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGpE,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,MAAM,EACrD,IAAI,EAAE,GAAG,EACT,IAAI,EAAE;IAAE,QAAQ,CAAC,CAAA;CAAE,GAClB,CAAC,EAAE,CAKL"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/ui/client.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC"}

package/dist/ui/client.js

@@ -1,7 +1,2 @@
-// Helpers
-export function instantiateObjectArray(data, ctor) {
-    if (Array.isArray(data)) {
-        return data.map((x) => instantiateObjectArray(x, ctor)).flat();
-    }
-    return [Object.assign(new ctor(), data)];
-}
+export { HttpResult, Either, requestBody, b64ToU8 } from "./common.js";
+export { MediaType } from "../ast.js";