@isaijs/core 0.1.6 → 0.1.9

package/dist/{types-BgOkJy5d.d.ts → types-D5SIVeej.d.ts}

@@ -1,5 +1,5 @@
 import { a as DatabaseDriver, f as Row$1, h as Sql, o as DialectName } from "./index-Ce5p2-EB.js";
-import { E as list, G as FileType, M as IdInput, T as Shape, Y as StoredFile, ct as Sensitivity, ft as StandardProps, g as KindDefinition, h as Definable, nt as AnyKind, ot as KindTypes, q as ImageType, st as Measure, w as Output, x as Input$2 } from "./index-CYcklQ1l.js";
+import { E as list, G as FileType, M as IdInput, T as Shape, Y as StoredFile, ct as KindTypes, g as KindDefinition, h as Definable, it as AnyKind, lt as Measure, mt as StandardProps, q as ImageType, ut as Sensitivity, w as Output, x as Input$2 } from "./index-CaR3hb0i.js";
 //#region src/db/fields/slot.d.ts
 interface SlotSpec {
   /** Namespaced by module: `auth.owner`. */
@@ -296,6 +296,14 @@ declare function fieldKinds(defaults: () => SchemaDefaults): {
     readonly types?: readonly ImageType[];
     readonly storage?: string;
   }) => Field<StoredFile[], StoredFile[], false, false, {}>;
+  /** A PDF or image to print or read whole (never resized), up to 100 MB; `{ storage }` as for `file`. */
+  document: (options?: {
+    readonly storage?: string;
+  }) => Field<StoredFile, StoredFile, false, false, {}>;
+  /** Up to 100 documents: an order's files. */
+  documents: (options?: {
+    readonly storage?: string;
+  }) => Field<StoredFile[], StoredFile[], false, false, {}>;
   /** A row of another model, by its id. Restricts deletes of that row unless `.cascade()` / `.setNull()`. */
   ref: <const Model extends string, const Related extends string | undefined = undefined>(model: Model, options?: {
     readonly related?: Related;
@@ -673,6 +681,10 @@ declare class ModelRegistry {
 interface UniqueSpec {
   readonly fields: readonly string[];
 }
+/** An index the model asks for (`.index(...)`, or a trait's), by field names, in order. */
+interface IndexSpec {
+  readonly fields: readonly string[];
+}
 interface CheckSpec {
   readonly name: string;
   readonly condition: ConditionNode;
@@ -685,6 +697,8 @@ interface ModelSpec {
   /** Every field, implicit ones first, in declaration order. */
   readonly fields: Readonly<Record<string, FieldSpec>>;
   readonly uniques: readonly UniqueSpec[];
+  /** Its plain indexes: its traits' first, then `.index(...)`. Refs' indexes are added by the schema. */
+  readonly indexes: readonly IndexSpec[];
   readonly checks: readonly CheckSpec[];
   /** The traits it took (`ordered`, `singleton`…), by name. */
   readonly traits: readonly string[];
@@ -773,6 +787,15 @@ declare class Model<Name extends string = string, F extends Fields = Fields, Uni
   get name(): Name;
   /** A unique combination of two or more fields (one field: `.unique()` on the field). */
   unique<const K extends readonly [keyof F & string, keyof F & string, ...(keyof F & string)[]]>(...fields: K): Model<Name, F, Uniques | K>;
+  /**
+   * An index on these fields, in this order, for the lists the app runs: a list sorted by a field
+   * (`.index("createdAt")`), or filtered by one field then sorted by another
+   * (`.index("status", "createdAt")`). Refs index themselves, and traits bring the indexes their
+   * behaviour needs (`publishable`: `publishedAt`; `ordered`: its group, then `position`), so most
+   * models never call it. `isai check` warns when a resource sorts by a field no index leads with.
+   * Each index costs a row written on every insert, and on each update of its fields.
+   */
+  index<const K extends readonly [keyof (ImplicitFields & F) & string, ...(keyof (ImplicitFields & F) & string)[]]>(...fields: K): Model<Name, F, Uniques>;
   /**
    * The table it's stored in, when that isn't its name in snake_case: after the model was renamed,
    * so the data stays where it is (`model("Squad", {…}).table("team")`). Physical renames never happen.
@@ -941,6 +964,12 @@ interface TableSnapshot {
   readonly counts: readonly CountSnapshot[];
   readonly copies: readonly CopySnapshot[];
   readonly flows: readonly FlowSnapshot[];
+  /**
+   * Its rows live in its primary key's index (`WITHOUT ROWID`): every model's table, since the id is
+   * text, so a plain table would also keep a hidden rowid and a second index on the id, one more row
+   * written per insert and read per lookup. Absent in snapshots from before, whose tables are rebuilt.
+   */
+  readonly withoutRowid?: true;
 }
 /**
  * Something the models no longer have, kept in the database until `isai cleanup` so that an
@@ -1013,6 +1042,25 @@ type Operation = {
 {
   readonly op: "dropTable";
   readonly table: TableSnapshot;
+} |
+/**
+ * Tables made again (a new storage, a reference's `onDelete`), with every table that references
+ * one of them, so no foreign key ever points at a dropped table. Cloudflare's SQLite can't turn
+ * foreign keys off (`PRAGMA foreign_keys = OFF` is ignored), and dropping a referenced table
+ * deletes its rows first, which would cascade into the rows that reference them. So: the old
+ * tables are renamed aside, the new ones created and filled, and the old ones dropped children
+ * first, when nothing references them any more. Rules (indexes, triggers) are dropped with them,
+ * every trigger first (one naming a renamed table would stop the rename), and come back from the
+ * schema after the step.
+ */
+{
+  readonly op: "rebuild";
+  /** The tables as they become, retired columns included, in dependency order (parents first). */
+  readonly tables: readonly TableSnapshot[];
+  /** Each table's columns that hold data now, copied across. */
+  readonly copy: Readonly<Record<string, readonly string[]>>;
+  /** Every trigger the database has now, by name. */
+  readonly triggers: readonly string[];
 };
 //#endregion
 //#region src/db/dialects/dialect.d.ts
@@ -1227,6 +1275,12 @@ declare class Engine {
   private secrets;
 }
 //#endregion
+//#region src/db/orm/include.d.ts
+/** The condition a model's related rows must meet, or `false` when none may be read. */
+type IncludeRule = (model: ModelSpec) => Promise<ConditionNode | false>;
+/** How the boundary gives a query its `IncludeRule`: internal, so the app's API never shows it. */
+declare const withIncludeRule: unique symbol;
+//#endregion
 //#region src/db/orm/page.d.ts
 interface PageOptions {
   /** Rows per page. */
@@ -1312,7 +1366,10 @@ declare class Query<M extends AnyModel, R> implements PromiseLike<R[]> {
   private readonly target;
   private readonly query;
   private readonly paths;
-  constructor(engine: Engine, target: M, query?: SelectQuery, paths?: readonly string[]);
+  private readonly rule?;
+  constructor(engine: Engine, target: M, query?: SelectQuery, paths?: readonly string[], rule?: IncludeRule | undefined);
+  /** The same query, its includes held to `rule` (the boundary's; `./include`). */
+  [withIncludeRule](rule: IncludeRule): Query<M, R>;
   /** Repeated calls are ANDed. */
   where(build: (row: RowOf<M>) => Condition): Query<M, R>;
   order(...keys: readonly OrderKey<M>[]): Query<M, R>;

package/dist/validation/index.d.ts

@@ -1,3 +1,3 @@
 import { a as ValidationError, i as Result, n as IssueCode, r as Path, t as Issue } from "../issues-CKto95IW.js";
-import { $ as images, A as validate, B as money, C as ObjectShape, D as object, E as list, F as datetime, G as FileType, H as sequence, I as fakeUlid, J as SIZES_MAX, K as ImageSize, L as flag, M as IdInput, N as choice, O as serialize, P as date, Q as image, R as id, S as LIST_MAX, T as Shape, U as phone, V as quantity, W as phoneKind, X as file, Y as StoredFile, Z as files, _ as define, a as newToken, at as KindSpec, b as CarriesKind, c as slug, ct as Sensitivity, d as text, dt as StandardIssue, et as Fake, f as textKind, ft as StandardProps, g as KindDefinition, h as Definable, i as markdown, it as Kind, j as CalendarDate, k as toKind, l as slugify, lt as TypeText, m as url, mt as StandardSchemaV1, n as host, nt as AnyKind, o as personName, ot as KindTypes, p as token, pt as StandardResult, q as ImageType, r as line, rt as FileSpec, s as secret, st as Measure, t as email, tt as FakeContext, u as subdomain, ut as kind, v as json, w as Output, x as Input, y as urls, z as int } from "../index-CYcklQ1l.js";
-export { type AnyKind, type CalendarDate, type CarriesKind, type Definable, Fake, type FakeContext, type FileSpec, type FileType, type IdInput, type ImageSize, type ImageType, type Input, type Issue, type IssueCode, Kind, type KindDefinition, type KindSpec, type KindTypes, LIST_MAX, type Measure, type ObjectShape, type Output, type Path, type Result, SIZES_MAX, type Sensitivity, type Shape, type StandardIssue, type StandardProps, type StandardResult, type StandardSchemaV1, type StoredFile, type TypeText, ValidationError, choice, date, datetime, define, email, fakeUlid, file, files, flag, host, id, image, images, int, json, kind, line, list, markdown, money, newToken, object, personName, phone, phoneKind, quantity, secret, sequence, serialize, slug, slugify, subdomain, text, textKind, toKind, token, url, urls, validate };
+import { $ as files, A as validate, B as money, C as ObjectShape, D as object, E as list, F as datetime, G as FileType, H as sequence, I as fakeUlid, J as SIZES_MAX, K as ImageSize, L as flag, M as IdInput, N as choice, O as serialize, P as date, Q as file, R as id, S as LIST_MAX, T as Shape, U as phone, V as quantity, W as phoneKind, X as document, Y as StoredFile, Z as documents, _ as define, a as newToken, at as FileSpec, b as CarriesKind, c as slug, ct as KindTypes, d as text, dt as TypeText, et as image, f as textKind, ft as kind, g as KindDefinition, gt as StandardSchemaV1, h as Definable, ht as StandardResult, i as markdown, it as AnyKind, j as CalendarDate, k as toKind, l as slugify, lt as Measure, m as url, mt as StandardProps, n as host, nt as Fake, o as personName, ot as Kind, p as token, pt as StandardIssue, q as ImageType, r as line, rt as FakeContext, s as secret, st as KindSpec, t as email, tt as images, u as subdomain, ut as Sensitivity, v as json, w as Output, x as Input, y as urls, z as int } from "../index-CaR3hb0i.js";
+export { type AnyKind, type CalendarDate, type CarriesKind, type Definable, Fake, type FakeContext, type FileSpec, type FileType, type IdInput, type ImageSize, type ImageType, type Input, type Issue, type IssueCode, Kind, type KindDefinition, type KindSpec, type KindTypes, LIST_MAX, type Measure, type ObjectShape, type Output, type Path, type Result, SIZES_MAX, type Sensitivity, type Shape, type StandardIssue, type StandardProps, type StandardResult, type StandardSchemaV1, type StoredFile, type TypeText, ValidationError, choice, date, datetime, define, document, documents, email, fakeUlid, file, files, flag, host, id, image, images, int, json, kind, line, list, markdown, money, newToken, object, personName, phone, phoneKind, quantity, secret, sequence, serialize, slug, slugify, subdomain, text, textKind, toKind, token, url, urls, validate };

package/dist/validation/index.js

@@ -1 +1 @@
-export { K as Fake, U as Kind, L as LIST_MAX, i as SIZES_MAX, G as ValidationError, D as choice, O as date, k as datetime, u as define, p as email, A as fakeUlid, a as file, s as files, j as flag, m as host, M as id, c as image, l as images, N as int, d as json, W as kind, h as line, R as list, g as markdown, P as money, _ as newToken, z as object, v as personName, t as phone, n as phoneKind, F as quantity, y as secret, I as sequence, B as serialize, b as slug, x as slugify, S as subdomain, C as text, w as textKind, V as toKind, T as token, E as url, f as urls, H as validate } from "../validation-Cppmd0RV.js";
+export { J as Fake, G as Kind, z as LIST_MAX, i as SIZES_MAX, q as ValidationError, k as choice, A as date, j as datetime, f as define, a as document, o as documents, h as email, M as fakeUlid, s as file, l as files, N as flag, g as host, P as id, u as image, d as images, F as int, p as json, K as kind, _ as line, B as list, v as markdown, I as money, y as newToken, V as object, b as personName, t as phone, n as phoneKind, L as quantity, x as secret, R as sequence, H as serialize, S as slug, C as slugify, w as subdomain, T as text, E as textKind, U as toKind, D as token, O as url, m as urls, W as validate } from "../validation-C3MCRBQO.js";

package/dist/{validation-Cppmd0RV.js → validation-C3MCRBQO.js}

@@ -1105,6 +1105,10 @@ const IMAGE_TYPES = [
 const MB = 1048576;
 /** At most this many files in one field. */
 const FILES_MAX = 10;
+/** At most this many documents in one field: an order's files, all its lines'. */
+const DOCUMENTS_MAX = 100;
+/** A document's size: the Workers body limit, the most one request can carry. */
+const DOCUMENT_BYTES = 100 * MB;
 /** A file's id: `fil_` and a ULID. */
 const FILE_ID = /^fil_[0-9A-HJKMNP-TV-Z]{26}$/;
 /** A storage's name: a key of `storage` in `app.ts`. */
@@ -1244,10 +1248,27 @@ function image(options = {}) {
 		many: false
 	}));
 }
+const DOCUMENT_TYPES = [
+	"pdf",
+	"png",
+	"jpeg",
+	"webp"
+];
+/** A PDF or an image to print or read whole (never resized), up to 100 MB. */
+function document(options = {}) {
+	return fileKind("document", specOf({
+		...options,
+		types: DOCUMENT_TYPES
+	}, ALL_TYPES, {
+		image: false,
+		maxBytes: DOCUMENT_BYTES,
+		many: false
+	}));
+}
 /** A list kind of files, carrying its item's spec as a list. */
-function many(name, item) {
+function many(name, item, max = FILES_MAX) {
 	return new Kind({
-		...named(name, list(item).max(FILES_MAX)).spec,
+		...named(name, list(item).max(max)).spec,
 		file: {
 			...item.spec.file,
 			many: true
@@ -1258,6 +1279,8 @@ function many(name, item) {
 const files = (options = {}) => many("files", file(options));
 /** Up to 10 images. */
 const images = (options = {}) => many("images", image(options));
+/** Up to 100 documents (PDFs and images, each up to 100 MB). */
+const documents = (options = {}) => many("documents", document(options), DOCUMENTS_MAX);
 //#endregion
 //#region src/internal/phone.ts
 /**
@@ -1313,4 +1336,4 @@ function phone(options = {}) {
 	return phoneKind(() => region);
 }
 //#endregion
-export { fakeUlid as A, serialize as B, text as C, choice as D, url as E, quantity as F, ValidationError as G, validate as H, sequence as I, Fake as K, LIST_MAX as L, id as M, int as N, date as O, money as P, list as R, subdomain as S, token as T, Kind as U, toKind as V, kind as W, newToken as _, file as a, slug as b, image as c, json as d, urls as f, markdown as g, line as h, SIZES_MAX as i, flag as j, datetime as k, images as l, host as m, phoneKind as n, fileTypeNames as o, email as p, fakeValue as q, isPhoneRegion as r, files as s, phone as t, define as u, personName as v, textKind as w, slugify as x, secret as y, object as z };
+export { date as A, list as B, slugify as C, token as D, textKind as E, int as F, Kind as G, serialize as H, money as I, Fake as J, kind as K, quantity as L, fakeUlid as M, flag as N, url as O, id as P, sequence as R, slug as S, text as T, toKind as U, object as V, validate as W, fakeValue as Y, line as _, document as a, personName as b, fileTypeNames as c, images as d, define as f, host as g, email as h, SIZES_MAX as i, datetime as j, choice as k, files as l, urls as m, phoneKind as n, documents as o, json as p, ValidationError as q, isPhoneRegion as r, file as s, phone as t, image as u, markdown as v, subdomain as w, secret as x, newToken as y, LIST_MAX as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isaijs/core",
-  "version": "0.1.6",
+  "version": "0.1.9",
   "description": "A batteries-included, type-safe TypeScript backend framework. Cloudflare first, no lock-in.",
   "type": "module",
   "license": "MIT",