cloesce 0.0.5-unstable.1 → 0.0.5-unstable.2

package/dist/ui/backend.d.ts

@@ -4,10 +4,7 @@ import { CrudKind } from "../ast.js";
 /**
  * cloesce/backend
  */
-export {
-  CloesceApp,
-  DependencyContainer as DependencyInjector,
-} from "../router/router.js";
+export { CloesceApp, DependencyContainer as DependencyInjector, } from "../router/router.js";
 export type { MiddlewareFn, ResultMiddlewareFn } from "../router/router.js";
 export { HttpResult, Either, Stream } from "./common.js";
 export type { DeepPartial } from "./common.js";
@@ -178,9 +175,7 @@ export declare const DataSource: PropertyDecorator;
  * dogs: Dog[];
  * ```
  */
-export declare const OneToMany: (
-  _foreignKeyColumn: string,
-) => PropertyDecorator;
+export declare const OneToMany: (_foreignKeyColumn: string) => PropertyDecorator;
 /**
  * Declares a one-to-one relationship between models.
  *
@@ -296,14 +291,10 @@ type Primitive = string | number | boolean | bigint | symbol | null | undefined;
  * }
  * ```
  */
-export type IncludeTree<T> = (T extends Primitive
-  ? never
-  : {
-      [K in keyof T]?: T[K] extends (infer U)[]
-        ? IncludeTree<NonNullable<U>>
-        : IncludeTree<NonNullable<T[K]>>;
-    }) & {
-  __brand?: "IncludeTree";
+export type IncludeTree<T> = (T extends Primitive ? never : {
+    [K in keyof T]?: T[K] extends (infer U)[] ? IncludeTree<NonNullable<U>> : IncludeTree<NonNullable<T[K]>>;
+}) & {
+    __brand?: "IncludeTree";
 };
 /**
  * Represents the name of a `＠DataSource` available on a model type `T`,
@@ -330,11 +321,8 @@ export type IncludeTree<T> = (T extends Primitive
  * async foo(ds: "default" | "none"): Promise<void> {...}
  * ```
  */
-export type DataSourceOf<T extends object> = (
-  | KeysOfType<T, IncludeTree<T>>
-  | "none"
-) & {
-  __brand?: "DataSource";
+export type DataSourceOf<T extends object> = (KeysOfType<T, IncludeTree<T>> | "none") & {
+    __brand?: "DataSource";
 };
 /**
  * A branded `number` type indicating that the corresponding
@@ -354,203 +342,182 @@ export type DataSourceOf<T extends object> = (
  * ```
  */
 export type Integer = number & {
-  __brand?: "Integer";
+    __brand?: "Integer";
 };
 /**
  * Exposes the ORM primitives Cloesce uses to interact with D1 databases.
  */
 export declare class Orm {
-  private db;
-  private constructor();
-  /**
-   * Creates an instance of an `Orm`
-   * @param db The database to use for ORM calls.
-   */
-  static fromD1(db: D1Database): Orm;
-  /**
-   * 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<T extends object>(
-    ctor: new () => T,
-    records: Record<string, any>[],
-    includeTree?: IncludeTree<T> | null,
-  ): T[];
-  /**
-   * 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.
-   */
-  upsert<T extends object>(
-    ctor: new () => T,
-    newModel: DeepPartial<T>,
-    includeTree?: IncludeTree<T> | null,
-  ): Promise<Either<string, any>>;
-  /**
-   * 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<T extends object>(
-    ctor: new () => T,
-    opts: {
-      includeTree?: IncludeTree<T> | null;
-      from?: string;
-      tagCte?: string;
-    },
-  ): string;
-  /**
-   * 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<T extends object>(
-    ctor: new () => T,
-    includeTree?: IncludeTree<T> | null,
-  ): string;
-  /**
-   * 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 ...
-   * ```
-   *
-   */
-  list<T extends object>(
-    ctor: new () => T,
-    opts: {
-      includeTree?: IncludeTree<T> | null;
-      from?: string;
-    },
-  ): Promise<Either<string, T[]>>;
-  /**
-   * 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);
-   * ```
-   */
-  get<T extends object>(
-    ctor: new () => T,
-    id: any,
-    includeTree?: IncludeTree<T> | null,
-  ): Promise<Either<string, T | null>>;
+    private db;
+    private constructor();
+    /**
+     * Creates an instance of an `Orm`
+     * @param db The database to use for ORM calls.
+     */
+    static fromD1(db: D1Database): Orm;
+    /**
+     * 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<T extends object>(ctor: new () => T, records: Record<string, any>[], includeTree?: IncludeTree<T> | null): T[];
+    /**
+     * 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.
+     */
+    upsert<T extends object>(ctor: new () => T, newModel: DeepPartial<T>, includeTree?: IncludeTree<T> | null): Promise<Either<string, any>>;
+    /**
+     * 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<T extends object>(ctor: new () => T, opts: {
+        includeTree?: IncludeTree<T> | null;
+        from?: string;
+        tagCte?: string;
+    }): string;
+    /**
+     * 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<T extends object>(ctor: new () => T, includeTree?: IncludeTree<T> | null): string;
+    /**
+     * 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 ...
+     * ```
+     *
+     */
+    list<T extends object>(ctor: new () => T, opts: {
+        includeTree?: IncludeTree<T> | null;
+        from?: string;
+    }): Promise<Either<string, T[]>>;
+    /**
+     * 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);
+     * ```
+     */
+    get<T extends object>(ctor: new () => T, id: any, includeTree?: IncludeTree<T> | null): Promise<Either<string, T | null>>;
 }
-//# sourceMappingURL=backend.d.ts.map
+//# sourceMappingURL=backend.d.ts.map