@gettersethya/mira-client 0.1.0-alpha.10

package/dist/src/collection/auth.js

@@ -0,0 +1,50 @@
+import { makeRuleBuilder } from "../rule/builder.js";
+import { Index } from "./index-builder.js";
+import { toJSONSchema } from "./serialize.js";
+const AUTH_SYSTEM_PROPERTIES = {
+    email: { type: "string", format: "email", "x-system": true },
+    password: { type: "string", "x-system": true, "x-hidden": true },
+    emailVerified: { type: "boolean", "x-system": true, default: false }
+};
+const AUTH_SYSTEM_INDEXES = [{ fields: ["email"], unique: true }];
+function makeAuthBuilder(name, extraFields, indexesCb, rulesCb) {
+    const indexes = indexesCb?.(Index);
+    const authRuleBuilder = {
+        ...makeRuleBuilder(),
+        selfId() { return { kind: "authId", collection: name }; }
+    };
+    const rules = rulesCb?.(authRuleBuilder);
+    const schema = toJSONSchema("auth", name, extraFields, {
+        indexes: [...AUTH_SYSTEM_INDEXES, ...(indexes ?? [])],
+        systemFields: AUTH_SYSTEM_PROPERTIES,
+        ...(rules !== undefined ? { rules } : {})
+    });
+    return {
+        name,
+        fields: extraFields,
+        schema,
+        indexes: (cb) => makeAuthBuilder(name, extraFields, cb, rulesCb),
+        rules: (cb) => makeAuthBuilder(name, extraFields, indexesCb, cb)
+    };
+}
+/**
+ * Defines an auth collection for user authentication.
+ * Includes system-managed fields: `id`, `email`, `password`, `emailVerified`, `created`, `updated`, `seqId`.
+ * Only `extraFields` are user-defined; system field names are forbidden in `extraFields`.
+ *
+ * @example
+ * const Users = AuthCollection.define("users", {
+ *   name: Field.text(),
+ *   avatar: Field.file({ maxSize: Bytes.fromMB(2) })
+ * })
+ * .rules((R) => ({
+ *   list: R.field("id").eq(R.selfId()),
+ *   create: R.public()
+ * }))
+ */
+export const AuthCollection = {
+    define(name, extraFields) {
+        return makeAuthBuilder(name, extraFields);
+    }
+};
+//# sourceMappingURL=auth.js.map

package/dist/src/collection/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/collection/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAInD,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAqD7C,MAAM,sBAAsB,GAAuC;IACjE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE;IAC5D,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE;IAChE,aAAa,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE;CACrE,CAAA;AAED,MAAM,mBAAmB,GAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;AAElF,SAAS,eAAe,CACtB,IAAY,EACZ,WAAc,EACd,SAAsB,EACtB,OAAmB;IAGnB,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC,KAAyB,CAAC,CAAA;IACtD,MAAM,eAAe,GAA6C;QAChE,GAAG,eAAe,EAA2B;QAC7C,MAAM,KAA+B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA,CAAC,CAAC;KACnF,CAAA;IACD,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC,eAAe,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE;QACrD,OAAO,EAAE,CAAC,GAAG,mBAAmB,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QACrD,YAAY,EAAE,sBAAsB;QACpC,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAC,CAAA;IACF,OAAO;QACL,IAAI;QACJ,MAAM,EAAE,WAAW;QACnB,MAAM;QACN,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC;QAChE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,CAAC;KACjE,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM,CACJ,IAAY,EACZ,WAAc;QAEd,OAAO,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IAC3C,CAAC;CACF,CAAA"}

package/dist/src/collection/base.d.ts

@@ -0,0 +1,64 @@
+import type { RuleBuilder } from "../rule/builder.js";
+import type { RuleMap } from "../rule/types.js";
+import type { IndexBuilder, IndexEntry } from "./index-builder.js";
+import type { CollectionSchema, FieldDef, FieldsMap } from "./types.js";
+type BaseForbiddenField = "id" | "seqId";
+type BaseSystemField = "id" | "seqId" | "created" | "updated";
+type BaseSystemFieldDefs = {
+    id: FieldDef & {
+        kind: "text";
+    };
+    created: FieldDef & {
+        kind: "date";
+    };
+    updated: FieldDef & {
+        kind: "date";
+    };
+    seqId: FieldDef & {
+        kind: "seqId";
+    };
+};
+type IndexCb<F extends FieldsMap> = (I: IndexBuilder<(keyof F & string) | BaseSystemField>) => Array<IndexEntry<(keyof F & string) | BaseSystemField>>;
+type RuleCb<F extends FieldsMap> = (R: RuleBuilder<F & BaseSystemFieldDefs>) => RuleMap;
+/**
+ * Builder returned by `BaseCollection.define()`.
+ * Immediately satisfies `AnyCollectionDef` — no terminal `.build()` needed.
+ * Chain `.indexes()` and/or `.rules()` to add optional concerns.
+ * Each chained method returns a new builder; the original is unchanged.
+ */
+export type BaseCollectionBuilder<F extends FieldsMap> = {
+    name: string;
+    fields: F;
+    schema: CollectionSchema;
+    /**
+     * Add collection-level indexes (in addition to field-level `unique`/`indexed` flags).
+     * Pass a callback to get a typed index builder with auto-completion over field names.
+     */
+    indexes(cb: IndexCb<F>): BaseCollectionBuilder<F>;
+    /**
+     * Add per-action access rules. No rule means deny all.
+     * Pass a callback to get a typed rule builder with auto-completion over field names.
+     */
+    rules(cb: RuleCb<F>): BaseCollectionBuilder<F>;
+};
+/**
+ * Defines a standard data collection.
+ * Base collections are the primary storage type with full CRUD support.
+ *
+ * @example
+ * const Tasks = BaseCollection.define("tasks", {
+ *   title: Field.text({ maxLength: 200 }),
+ *   completed: Field.boolean({ default: false }),
+ *   ownerId: Field.text()
+ * })
+ * .indexes((I) => [I.on("ownerId")])
+ * .rules((R) => ({
+ *   list: Rule.public(),
+ *   view: R.field("ownerId").eq(R.authId(Users))
+ * }))
+ */
+export declare const BaseCollection: {
+    define<F extends FieldsMap & { [K in keyof F & BaseForbiddenField]?: never; }>(name: string, fields: F): BaseCollectionBuilder<F>;
+};
+export {};
+//# sourceMappingURL=base.d.ts.map

package/dist/src/collection/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/collection/base.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAElE,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEvE,KAAK,kBAAkB,GAAG,IAAI,GAAG,OAAO,CAAA;AACxC,KAAK,eAAe,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;AAE7D,KAAK,mBAAmB,GAAG;IACzB,EAAE,EAAO,QAAQ,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACpC,OAAO,EAAE,QAAQ,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACpC,OAAO,EAAE,QAAQ,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACpC,KAAK,EAAI,QAAQ,GAAG;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,CAAA;CACtC,CAAA;AAED,KAAK,OAAO,CAAC,CAAC,SAAS,SAAS,IAAI,CAClC,CAAC,EAAE,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,eAAe,CAAC,KAClD,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAA;AAE5D,KAAK,MAAM,CAAC,CAAC,SAAS,SAAS,IAAI,CACjC,CAAC,EAAE,WAAW,CAAC,CAAC,GAAG,mBAAmB,CAAC,KACpC,OAAO,CAAA;AAEZ;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,SAAS,IAAI;IACvD,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,CAAA;IACT,MAAM,EAAE,gBAAgB,CAAA;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;IACjD;;;OAGG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CAC/C,CAAA;AAwBD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,cAAc;WAClB,CAAC,SAAS,SAAS,GAAG,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,kBAAkB,CAAC,CAAC,EAAE,KAAK,GAAE,QACpE,MAAM,UACJ,CAAC,GACR,qBAAqB,CAAC,CAAC,CAAC;CAG5B,CAAA"}

package/dist/src/collection/base.js

@@ -0,0 +1,40 @@
+import { makeRuleBuilder } from "../rule/builder.js";
+import { Index } from "./index-builder.js";
+import { toJSONSchema } from "./serialize.js";
+function makeBaseBuilder(name, fields, indexesCb, rulesCb) {
+    const indexes = indexesCb?.(Index);
+    const rules = rulesCb?.(makeRuleBuilder());
+    const schema = toJSONSchema("base", name, fields, {
+        ...(indexes !== undefined ? { indexes } : {}),
+        ...(rules !== undefined ? { rules } : {})
+    });
+    return {
+        name,
+        fields,
+        schema,
+        indexes: (cb) => makeBaseBuilder(name, fields, cb, rulesCb),
+        rules: (cb) => makeBaseBuilder(name, fields, indexesCb, cb)
+    };
+}
+/**
+ * Defines a standard data collection.
+ * Base collections are the primary storage type with full CRUD support.
+ *
+ * @example
+ * const Tasks = BaseCollection.define("tasks", {
+ *   title: Field.text({ maxLength: 200 }),
+ *   completed: Field.boolean({ default: false }),
+ *   ownerId: Field.text()
+ * })
+ * .indexes((I) => [I.on("ownerId")])
+ * .rules((R) => ({
+ *   list: Rule.public(),
+ *   view: R.field("ownerId").eq(R.authId(Users))
+ * }))
+ */
+export const BaseCollection = {
+    define(name, fields) {
+        return makeBaseBuilder(name, fields);
+    }
+};
+//# sourceMappingURL=base.js.map

package/dist/src/collection/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/collection/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGnD,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AA2C7C,SAAS,eAAe,CACtB,IAAY,EACZ,MAAS,EACT,SAAsB,EACtB,OAAmB;IAGnB,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC,KAAyB,CAAC,CAAA;IACtD,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC,eAAe,EAA2B,CAAC,CAAA;IACnE,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;QAChD,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAC,CAAA;IACF,OAAO;QACL,IAAI;QACJ,MAAM;QACN,MAAM;QACN,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC;QAC3D,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;KAC5D,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM,CACJ,IAAY,EACZ,MAAS;QAET,OAAO,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACtC,CAAC;CACF,CAAA"}

package/dist/src/collection/bytes.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Human-readable byte size helpers.
+ * Use instead of raw byte values in `Field.file({ maxSize })`.
+ *
+ * @example
+ * Field.file({ maxSize: Bytes.fromMB(5) })
+ * Bytes.fromGB(2) // => 2 * 1024^3
+ */
+export declare const Bytes: {
+    /**
+     * Convert kilobytes to bytes.
+     *
+     * @param n - Size in kilobytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromKB(500)  // 512000
+     */
+    fromKB: (n: number) => number;
+    /**
+     * Convert megabytes to bytes.
+     *
+     * @param n - Size in megabytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromMB(5)  // 5242880
+     */
+    fromMB: (n: number) => number;
+    /**
+     * Convert gigabytes to bytes.
+     *
+     * @param n - Size in gigabytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromGB(2)  // 2147483648
+     */
+    fromGB: (n: number) => number;
+    /**
+     * Convert terabytes to bytes.
+     *
+     * @param n - Size in terabytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromTB(1)  // 1099511627776
+     */
+    fromTB: (n: number) => number;
+};
+//# sourceMappingURL=bytes.d.ts.map

package/dist/src/collection/bytes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.d.ts","sourceRoot":"","sources":["../../../src/collection/bytes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;;;OAQG;gBACS,MAAM;IAElB;;;;;;;;OAQG;gBACS,MAAM;IAElB;;;;;;;;OAQG;gBACS,MAAM;IAElB;;;;;;;;OAQG;gBACS,MAAM;CACnB,CAAA"}

package/dist/src/collection/bytes.js

@@ -0,0 +1,51 @@
+/**
+ * Human-readable byte size helpers.
+ * Use instead of raw byte values in `Field.file({ maxSize })`.
+ *
+ * @example
+ * Field.file({ maxSize: Bytes.fromMB(5) })
+ * Bytes.fromGB(2) // => 2 * 1024^3
+ */
+export const Bytes = {
+    /**
+     * Convert kilobytes to bytes.
+     *
+     * @param n - Size in kilobytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromKB(500)  // 512000
+     */
+    fromKB: (n) => n * 1024,
+    /**
+     * Convert megabytes to bytes.
+     *
+     * @param n - Size in megabytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromMB(5)  // 5242880
+     */
+    fromMB: (n) => n * 1024 ** 2,
+    /**
+     * Convert gigabytes to bytes.
+     *
+     * @param n - Size in gigabytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromGB(2)  // 2147483648
+     */
+    fromGB: (n) => n * 1024 ** 3,
+    /**
+     * Convert terabytes to bytes.
+     *
+     * @param n - Size in terabytes
+     * @returns Size in bytes
+     *
+     * @example
+     * Bytes.fromTB(1)  // 1099511627776
+     */
+    fromTB: (n) => n * 1024 ** 4
+};
+//# sourceMappingURL=bytes.js.map

package/dist/src/collection/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../../src/collection/bytes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI;IAE/B;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC;IAEpC;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC;IAEpC;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC;CACrC,CAAA"}

package/dist/src/collection/errors.d.ts

@@ -0,0 +1,29 @@
+declare const ValidationError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "ValidationError";
+} & Readonly<A>;
+/**
+ * Error raised when collection field validation fails.
+ * Contains the collection name and a list of human-readable issue descriptions.
+ *
+ * Raised by:
+ * - `filterNodeToWhereClause()` — when a filter references an unknown field
+ * - `CollectionService` — when field-level constraints (type, required, min/max length, etc.)
+ *   fail validation on create or update
+ * - Effect Schema validation — when input fails schema decoding
+ *
+ * @example
+ * new ValidationError({
+ *   collection: "posts",
+ *   issues: ['Field "title" is required']
+ * })
+ *
+ * @see CollectionService — service that raises ValidationError
+ * @see filterNodeToWhereClause — raises ValidationError for unknown filter fields
+ */
+export declare class ValidationError extends ValidationError_base<{
+    collection: string;
+    issues: ReadonlyArray<string>;
+}> {
+}
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/dist/src/collection/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/collection/errors.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,eAAgB,SAAQ,qBAAoC;IACvE,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CAC9B,CAAC;CAAG"}

package/dist/src/collection/errors.js

@@ -0,0 +1,23 @@
+import { Data } from "effect";
+/**
+ * Error raised when collection field validation fails.
+ * Contains the collection name and a list of human-readable issue descriptions.
+ *
+ * Raised by:
+ * - `filterNodeToWhereClause()` — when a filter references an unknown field
+ * - `CollectionService` — when field-level constraints (type, required, min/max length, etc.)
+ *   fail validation on create or update
+ * - Effect Schema validation — when input fails schema decoding
+ *
+ * @example
+ * new ValidationError({
+ *   collection: "posts",
+ *   issues: ['Field "title" is required']
+ * })
+ *
+ * @see CollectionService — service that raises ValidationError
+ * @see filterNodeToWhereClause — raises ValidationError for unknown filter fields
+ */
+export class ValidationError extends Data.TaggedError("ValidationError") {
+}
+//# sourceMappingURL=errors.js.map

package/dist/src/collection/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/collection/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,eAAgB,SAAQ,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAGrE;CAAG"}

package/dist/src/collection/field.d.ts

@@ -0,0 +1,300 @@
+import type { AnyCollectionDef, EmailConstraintKind, FieldDef, IntegerConstraintKind, NumberConstraintKind, SimpleConstraintKind, TextConstraintKind } from "./types.js";
+/** Common options shared by all field types. */
+type BaseFieldOptions = {
+    /** Alternative field name in the database (defaults to the key in the fields map). */
+    name?: string;
+    /** Whether the field is required (defaults to `true` if no default is set). */
+    required?: boolean;
+    /** Creates a unique index on this field. */
+    unique?: boolean;
+    /** Creates a non-unique index on this field. */
+    indexed?: boolean;
+    /** Default value for the field when creating a record. */
+    default?: unknown;
+};
+/**
+ * Field builder API.
+ * Every method returns a typed `FieldDef` with `.view()` for use in `ViewCollection`.
+ *
+ * @example
+ * const Posts = BaseCollection.define("posts", {
+ *   title: Field.text({ maxLength: 200 }),
+ *   body: Field.text({ required: false }),
+ *   published: Field.boolean({ default: false }),
+ *   author: Field.relation(Users)
+ * })
+ */
+export declare const Field: {
+    /**
+     * A UTF-8 text/string field with optional min/max length constraints.
+     * Stored as `TEXT` in SQLite.
+     *
+     * @param opts.required - Whether the field is required (default: true, unless `default` is set)
+     * @param opts.default - Default value for new records
+     * @param opts.unique - Create a unique index on this field
+     * @param opts.indexed - Create a non-unique index on this field
+     * @param opts.name - Alternative column name in the database
+     * @param opts.minLength - Minimum string length (validated on create and update)
+     * @param opts.maxLength - Maximum string length (validated on create and update)
+     * @param opts.error - Callback for custom validation error messages, keyed by constraint kind
+     * @returns A text-type FieldDef with `.view()` method
+     *
+     * @example
+     * Field.text({ maxLength: 500, required: true })
+     * Field.text({ minLength: 3, maxLength: 100, default: "untitled" })
+     */
+    text: <O extends BaseFieldOptions & {
+        minLength?: number;
+        maxLength?: number;
+    }>(opts?: O & {
+        error?: (kind: TextConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "text";
+    } & O & {
+        error?: (kind: TextConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "text";
+        } & O & {
+            error?: (kind: TextConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * A floating-point number field with optional min/max constraints.
+     * Stored as `REAL` in SQLite.
+     *
+     * @param opts.min - Minimum allowed value (inclusive)
+     * @param opts.max - Maximum allowed value (inclusive)
+     *
+     * @example
+     * Field.number({ min: 0, max: 100 })
+     * Field.number({ required: false })
+     */
+    number: <O extends BaseFieldOptions & {
+        min?: number;
+        max?: number;
+    }>(opts?: O & {
+        error?: (kind: NumberConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "number";
+    } & O & {
+        error?: (kind: NumberConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "number";
+        } & O & {
+            error?: (kind: NumberConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * An integer field with optional min/max constraints.
+     * Stored as `INTEGER` in SQLite. Values are validated to be whole numbers.
+     *
+     * @param opts.min - Minimum allowed value (inclusive)
+     * @param opts.max - Maximum allowed value (inclusive)
+     *
+     * @example
+     * Field.integer({ min: 1, max: 5 })
+     */
+    integer: <O extends BaseFieldOptions & {
+        min?: number;
+        max?: number;
+    }>(opts?: O & {
+        error?: (kind: IntegerConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "integer";
+    } & O & {
+        error?: (kind: IntegerConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "integer";
+        } & O & {
+            error?: (kind: IntegerConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * A boolean (true/false) field.
+     * Stored as `INTEGER` (0/1) in SQLite.
+     * Typically paired with a `default` value since new records default to false.
+     *
+     * @param opts.default - Default value (recommended to always set this)
+     *
+     * @example
+     * Field.boolean({ default: false })
+     */
+    boolean: <O extends Omit<BaseFieldOptions, "default"> & {
+        default?: boolean;
+    }>(opts?: O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "boolean";
+    } & O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "boolean";
+        } & O & {
+            error?: (kind: SimpleConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * A date/time field stored as an ISO 8601 string.
+     * Stored as `TEXT` in SQLite. Values should be ISO 8601 strings.
+     * The server does not parse or transform date values — they are stored verbatim.
+     *
+     * @example
+     * Field.date({ required: true })
+     */
+    date: <O extends BaseFieldOptions>(opts?: O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "date";
+    } & O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "date";
+        } & O & {
+            error?: (kind: SimpleConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * An email address field with built-in format validation.
+     * Stored as `TEXT` in SQLite. The server validates the email format
+     * on both create and update operations.
+     *
+     * @example
+     * Field.email({ required: false })
+     */
+    email: <O extends BaseFieldOptions>(opts?: O & {
+        error?: (kind: EmailConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "email";
+    } & O & {
+        error?: (kind: EmailConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "email";
+        } & O & {
+            error?: (kind: EmailConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * A JSON field for storing arbitrary structured data.
+     * Stored as `TEXT` (JSON string) in SQLite. The server serializes/deserializes
+     * values automatically. Can be used for dynamic metadata, nested objects, arrays, etc.
+     *
+     * @example
+     * Field.json({ required: false })
+     */
+    json: <O extends BaseFieldOptions>(opts?: O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "json";
+    } & O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "json";
+        } & O & {
+            error?: (kind: SimpleConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * Auto-incrementing sequence ID (system-managed, hidden from API responses).
+     * Stored as `INTEGER` in SQLite with `AUTOINCREMENT`.
+     * This field is always present on base and auth collections and does NOT expose
+     * `.view()` — it is always a physical column.
+     *
+     * @example
+     * // seqId is automatically included in base/auth collections — typically
+     * // only used in ViewCollection where you map a query column to seqId.
+     * Field.seqId()
+     */
+    seqId: (opts?: BaseFieldOptions) => FieldDef;
+    /**
+     * A file/attachment field referencing an uploaded file.
+     * Stored as `TEXT` (filename string) in SQLite. The actual file content is
+     * stored in the file storage backend (local disk or S3).
+     *
+     * When `protected: true`, the file requires a short-lived JWT token to access.
+     * Protected files are served via the async token endpoint.
+     *
+     * @param opts.maxSize - Maximum file size in bytes (use `Bytes.*` helpers)
+     * @param opts.mimeTypes - Allowed MIME types (e.g., ["image/jpeg", "image/png"])
+     * @param opts.protected - Whether the file requires auth token to access
+     *
+     * @example
+     * Field.file({ maxSize: Bytes.fromMB(5), mimeTypes: ["image/jpeg"] })
+     * Field.file({ protected: true, maxSize: Bytes.fromMB(10) })
+     *
+     * @see Bytes — byte size helpers for maxSize
+     */
+    file: <O extends BaseFieldOptions & {
+        maxSize?: number;
+        mimeTypes?: Array<string>;
+        protected?: boolean;
+    }>(opts?: O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "file";
+    } & O & {
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    } & {
+        view(): FieldDef & {
+            kind: "file";
+        } & O & {
+            error?: (kind: SimpleConstraintKind) => string | undefined;
+        } & {
+            viewOnly: true;
+        };
+    };
+    /**
+     * A relation field referencing another collection's record.
+     * Stores the target record's field value (defaults to `"id"`).
+     * Resolves collection names at definition time — only the name string survives
+     * into the serialized JSON Schema.
+     *
+     * The `_target` phantom property carries the collection definition at compile time
+     * for type inference in `WithExpand`.
+     *
+     * @param collection - The target collection definition (AnyCollectionDef)
+     * @param opts.field - The target field to reference (defaults to `"id"`)
+     *
+     * @example
+     * Field.relation(Users)
+     * Field.relation(Users, { field: "email" })
+     *
+     * @see WithExpand — uses _target to type expanded related records
+     */
+    relation: <C extends AnyCollectionDef, O extends BaseFieldOptions>(collection: C, opts?: O & {
+        field?: (keyof C["fields"] & string) | "id" | "created" | "updated";
+        error?: (kind: SimpleConstraintKind) => string | undefined;
+    }) => FieldDef & {
+        kind: "relation";
+        _target: C;
+    } & O & {
+        view(): FieldDef & {
+            kind: "relation";
+            _target: C;
+        } & O & {
+            viewOnly: true;
+        };
+    };
+};
+export {};
+//# sourceMappingURL=field.d.ts.map

package/dist/src/collection/field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../../src/collection/field.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,QAAQ,EAER,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,YAAY,CAAA;AAEnB,gDAAgD;AAChD,KAAK,gBAAgB,GAAG;IACtB,sFAAsF;IACtF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,4CAA4C;IAC5C,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,gDAAgD;IAChD,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAqBD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;;;;;;;;;;;;OAiBG;WACI,CAAC,SAAS,gBAAgB,GAAG;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,SACrE,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAAlD,CAAC,IAAI,EAAE,kBAAkB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAhD,CAAC,IAAI,EAAE,kBAAkB,KAAK,MAAM,GAAG,SAAS;;sBArCU,IAAI;;;IAwCrF;;;;;;;;;;OAUG;aACM,CAAC,SAAS,gBAAgB,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,SAC3D,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAApD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAlD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;sBApDQ,IAAI;;;IAuDrF;;;;;;;;;OASG;cACO,CAAC,SAAS,gBAAgB,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,SAC5D,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAArD,CAAC,IAAI,EAAE,qBAAqB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAnD,CAAC,IAAI,EAAE,qBAAqB,KAAK,MAAM,GAAG,SAAS;;sBAlEO,IAAI;;;IAqErF;;;;;;;;;OASG;cACO,CAAC,SAAS,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,SACpE,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAApD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAlD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;sBAhFQ,IAAI;;;IAmFrF;;;;;;;OAOG;WACI,CAAC,SAAS,gBAAgB,SACxB,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAApD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAlD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;sBA5FQ,IAAI;;;IA+FrF;;;;;;;OAOG;YACK,CAAC,SAAS,gBAAgB,SACzB,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAAnD,CAAC,IAAI,EAAE,mBAAmB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAjD,CAAC,IAAI,EAAE,mBAAmB,KAAK,MAAM,GAAG,SAAS;;sBAxGS,IAAI;;;IA2GrF;;;;;;;OAOG;WACI,CAAC,SAAS,gBAAgB,SACxB,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAApD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAlD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;sBApHQ,IAAI;;;IAuHrF;;;;;;;;;;OAUG;mBACY,gBAAgB,KAAG,QAAQ;IAM1C;;;;;;;;;;;;;;;;;OAiBG;WACI,CAAC,SAAS,gBAAgB,GAAG;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,SAC/F,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;;;gBAApD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;;;;oBAAlD,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS;;sBA3JQ,IAAI;;;IA8JrF;;;;;;;;;;;;;;;;;OAiBG;eACQ,CAAC,SAAS,gBAAgB,EAAE,CAAC,SAAS,gBAAgB,cACnD,CAAC,SACN,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAA;KAAE;cAWtH,UAAU;iBAAW,CAAC;;;kBAAtB,UAAU;qBAAW,CAAC;;sBAzM2B,IAAI;;;CA4MhF,CAAA"}