@valbuild/core 0.125.0 → 0.127.0

package/dist/declarations/src/schema/discriminatedUnion.d.ts

@@ -0,0 +1,170 @@
+import { CustomValidateFunction, Schema, SchemaAssertResult } from "./index.js";
+import { ItemPreviewInput, PreviewItem, ReifiedPreview, PreviewScope } from "../preview.js";
+import { FieldRender } from "../render.js";
+import { SelectorSource } from "../selector/index.js";
+import { SourceObject } from "../source/index.js";
+import { ModuleFilePath, SourcePath } from "../val/index.js";
+import { SerializedObjectSchema } from "./object.js";
+import { ValidationError, ValidationErrors } from "./validation/ValidationError.js";
+export type SerializedDiscriminatedUnionSchema = {
+    type: "discriminated-union";
+    /** Static layout config, carried whole in the serialized schema — see `render.ts`. */
+    render?: FieldRender;
+    /** Set when this schema declares a `preview`. The closure itself cannot serialize. */
+    preview?: true;
+    /** The name of the field every variant tags itself with. */
+    key: string;
+    items: SerializedObjectSchema[];
+    opt: boolean;
+    customValidate?: boolean;
+    readonly?: boolean;
+    hidden?: boolean;
+    description?: string;
+};
+/** The variant objects a discriminated union on `Key` may be built from. */
+export type DiscriminatedUnionItem<Key extends string> = Schema<SourceObject & {
+    [k in Key]: string;
+}>;
+/**
+ * At least one variant, so a union with none cannot be written.
+ *
+ * Everything downstream reads the first one where it needs any — `emptyOf`
+ * takes `items[0]` for the value a new entry starts as — and a union with
+ * nothing to select is not a thing an author means. `s.enum` says the same
+ * about its values.
+ */
+export type DiscriminatedUnionItems<Key extends string> = [
+    DiscriminatedUnionItem<Key>,
+    ...DiscriminatedUnionItem<Key>[]
+];
+/** The source type a discriminated union over `T` accepts. */
+export type DiscriminatedUnionSourceOf<Key extends string, T extends DiscriminatedUnionItem<Key>[]> = T extends Schema<infer S>[] ? S extends SelectorSource ? S : never : never;
+/**
+ * One of several object shapes, told apart by a tag field.
+ *
+ * Every variant is an object with `key` set to a distinct `s.literal(...)`, and
+ * the value of that field decides which variant a value is. Unlike
+ * {@link EnumSchema} this is a CONTAINER: the variant's fields are the fields
+ * being edited, and everything that walks the schema tree has to descend
+ * through the matching variant.
+ */
+export declare class DiscriminatedUnionSchema<Key extends string, T extends DiscriminatedUnionItem<Key>[], Src extends DiscriminatedUnionSourceOf<Key, T> | null> extends Schema<Src> {
+    private readonly key;
+    private readonly items;
+    private readonly opt;
+    private readonly customValidateFunctions;
+    private readonly isReadonly;
+    private readonly isHidden;
+    private readonly description?;
+    private readonly renderInput;
+    private readonly previewInput;
+    constructor(key: Key, items: T, opt?: boolean, customValidateFunctions?: CustomValidateFunction<Src>[], isReadonly?: boolean, isHidden?: boolean, description?: string | undefined, renderInput?: FieldRender | null, previewInput?: ItemPreviewInput<Src> | null);
+    /**
+     * Describe this field.
+     *
+     * The description is shown next to the field's label in the Val editor, so it is
+     * where you say what an editor needs to know but the field name cannot carry. It
+     * also travels in the serialized schema, which is what the AI assistant and the
+     * MCP tools read.
+     *
+     * Pass `null` to clear a description set earlier.
+     *
+     * @example
+     * const hero = s.object({ type: s.literal("hero"), title: s.string() });
+     * const text = s.object({ type: s.literal("text"), body: s.string() });
+     * const schema = s
+     *   .discriminatedUnion("type", hero, text)
+     *   .describe("What this section of the page is");
+     * export default c.define("/example.val.ts", schema, {
+     *   type: "hero",
+     *   title: "Hello",
+     * });
+     */
+    describe(description: string | null): DiscriminatedUnionSchema<Key, T, Src>;
+    /**
+     * Add a custom validation rule to this field.
+     *
+     * The function is called with the field's value and returns `false` when the
+     * value is fine, or a STRING with the message to show when it is not. Call it
+     * more than once to add more rules — they all run, and every message is
+     * reported.
+     *
+     * Validation runs in the Studio as you type, in `npx val validate` and before a
+     * publish.
+     *
+     * The function is given the whole value, whichever variant it took. A rule
+     * that only concerns one variant belongs on that variant's object schema.
+     *
+     * @example
+     * const hero = s.object({ type: s.literal("hero"), title: s.string() });
+     * const text = s.object({ type: s.literal("text"), body: s.string() });
+     * const schema = s
+     *   .discriminatedUnion("type", hero, text)
+     *   .validate((val) =>
+     *     val.type === "hero" && !val.title ? "A hero needs a title" : false,
+     *   );
+     * export default c.define("/example.val.ts", schema, {
+     *   type: "hero",
+     *   title: "Hello",
+     * });
+     */
+    validate(validationFunction: (src: Src) => false | string): DiscriminatedUnionSchema<Key, T, Src>;
+    protected executeValidate(path: SourcePath, src: Src): ValidationErrors;
+    protected executeAssert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
+    nullable(): DiscriminatedUnionSchema<Key, T, Src | null>;
+    readonly(isReadonly?: boolean): DiscriminatedUnionSchema<Key, T, Src>;
+    hidden(isHidden?: boolean): DiscriminatedUnionSchema<Key, T, Src>;
+    protected localeScopeChildren(): {
+        key: string;
+        schema: Schema<SelectorSource>;
+    }[];
+    protected executeCustomValidateAt(path: SourcePath, src: Src): ValidationError[];
+    /**
+     * The variant schema a value takes. `null` when the value matches none of
+     * them — a structural error `executeValidate` already reports.
+     */
+    private matchedVariant;
+    /**
+     * How this field is laid out in the editor when it is the item of an array
+     * or record: `{ as: "inline" }` renders the field itself inside each row,
+     * instead of a preview row that navigates to it.
+     *
+     * Static configuration, not a callback — see `render.ts`.
+     *
+     * @example
+     * // A page builder: the row draws the tag selector and the matched
+     * // variant's fields.
+     * const hero = s.object({ type: s.literal("hero"), title: s.string() });
+     * const text = s.object({ type: s.literal("text"), body: s.string() });
+     * const block = s.discriminatedUnion("type", hero, text).render({ as: "inline" });
+     * export default c.define("/example.val.ts", s.array(block), [
+     *   { type: "hero", title: "Hello" },
+     * ]);
+     */
+    render(input: FieldRender): DiscriminatedUnionSchema<Key, T, Src>;
+    /**
+     * How this VALUE is shown where a preview of it is needed — a row in a
+     * sortable list, a reference dropdown, a search hit. Never how the field
+     * itself is edited (that is `render`). See `preview.ts`.
+     *
+     * Without one of its own, a discriminated union previews as the VARIANT the
+     * value takes — declare `preview` on the member objects and the union
+     * dispatches.
+     *
+     * @example
+     * const hero = s.object({ type: s.literal("hero"), title: s.string() });
+     * const text = s.object({ type: s.literal("text"), body: s.string() });
+     * const block = s
+     *   .discriminatedUnion("type", hero, text)
+     *   .preview(({ val }) => ({ title: val.type }));
+     * export default c.define("/example.val.ts", s.array(block), [
+     *   { type: "hero", title: "Hello" },
+     * ]);
+     */
+    preview(select: ItemPreviewInput<Src>): DiscriminatedUnionSchema<Key, T, Src>;
+    protected executePreviewItem(src: NonNullable<Src>): PreviewItem | null;
+    protected declaresItemPreview(): boolean;
+    protected executeSerialize(): SerializedDiscriminatedUnionSchema;
+    protected executePreview(sourcePath: SourcePath | ModuleFilePath, src: Src, scope?: PreviewScope): ReifiedPreview;
+}
+export declare const discriminatedUnion: <Key extends string, T extends DiscriminatedUnionItems<Key>>(key: Key, ...objects: T) => DiscriminatedUnionSchema<Key, T, DiscriminatedUnionSourceOf<Key, T>>;

package/dist/declarations/src/schema/discriminatedUnionBranch.d.ts

@@ -0,0 +1,20 @@
+import { SerializedSchema } from "./index.js";
+/**
+ * The variant of a discriminated union that a value takes, by its tag.
+ *
+ * A discriminated union is a fork rather than a level: the variant IS the node,
+ * and everything a caller wants to know about that node — its fields, its
+ * `locale` field, the schema to draw it with — is on the variant and not on the
+ * union. Resolving it takes the source, so it cannot be done from the schema
+ * alone, which is why every caller that has only the union ends up needing this.
+ *
+ * `undefined` where the tag matches nothing, rather than a fallback to the first
+ * variant: a value whose tag names no variant is not a member of the union,
+ * validation is already saying so, and reading fields out of the wrong shape
+ * would answer confidently and wrongly.
+ *
+ * `s.enum()` never reaches here — it is a leaf whose values are strings, with no
+ * variants to resolve — so anything that is not a discriminated union answers
+ * `undefined` too.
+ */
+export declare function discriminatedUnionBranchOf(schema: SerializedSchema | undefined, tag: unknown): SerializedSchema | undefined;

package/dist/declarations/src/schema/enum.d.ts

@@ -0,0 +1,131 @@
+import { CustomValidateFunction, Schema, SchemaAssertResult } from "./index.js";
+import { ItemPreviewInput, PreviewItem, ReifiedPreview } from "../preview.js";
+import { FieldRender } from "../render.js";
+import { SourcePath } from "../val/index.js";
+import { ValidationError, ValidationErrors } from "./validation/ValidationError.js";
+export type SerializedEnumSchema = {
+    type: "enum";
+    /** Static layout config, carried whole in the serialized schema — see `render.ts`. */
+    render?: FieldRender;
+    /** Set when this schema declares a `preview`. The closure itself cannot serialize. */
+    preview?: true;
+    /**
+     * Every value this field may take, in declaration order — which is the order
+     * the editor's dropdown offers them in.
+     */
+    values: string[];
+    opt: boolean;
+    customValidate?: boolean;
+    readonly?: boolean;
+    hidden?: boolean;
+    description?: string;
+};
+/**
+ * One of a fixed set of strings.
+ *
+ * The values are the schema — there are no member schemas to descend into, so
+ * this is a LEAF, like `s.string()` with a closed domain. That is the whole
+ * difference from {@link DiscriminatedUnionSchema}, and the reason the two are
+ * separate: everything that walks a schema tree has to recurse into a
+ * discriminated union's variants and must not try to recurse into these.
+ */
+export declare class EnumSchema<Src extends string | null> extends Schema<Src> {
+    private readonly values;
+    private readonly opt;
+    private readonly customValidateFunctions;
+    private readonly isReadonly;
+    private readonly isHidden;
+    private readonly description?;
+    private readonly renderInput;
+    private readonly previewInput;
+    /**
+     * Type-only marker: as a record key, this declares the key set.
+     *
+     * An enum names every value it may take, so a record keyed by one holds
+     * exactly those keys — the same claim `s.literal()` and `s.locale()` make.
+     * `DiscriminatedUnionSchema` carries no marker: it discriminates objects and
+     * cannot be a record key at all. See `LocaleSchema`.
+     */
+    readonly __declaresRecordKeys: true;
+    constructor(values: readonly string[], opt?: boolean, customValidateFunctions?: CustomValidateFunction<Src>[], isReadonly?: boolean, isHidden?: boolean, description?: string | undefined, renderInput?: FieldRender | null, previewInput?: ItemPreviewInput<Src> | null);
+    /**
+     * Describe this field.
+     *
+     * The description is shown next to the field's label in the Val editor, so it is
+     * where you say what an editor needs to know but the field name cannot carry. It
+     * also travels in the serialized schema, which is what the AI assistant and the
+     * MCP tools read.
+     *
+     * Pass `null` to clear a description set earlier.
+     *
+     * @example
+     * const schema = s
+     *   .enum("draft", "published")
+     *   .describe("Only published pages are built");
+     * export default c.define("/example.val.ts", schema, "draft");
+     */
+    describe(description: string | null): EnumSchema<Src>;
+    /**
+     * Add a custom validation rule to this field.
+     *
+     * The function is called with the field's value and returns `false` when the
+     * value is fine, or a STRING with the message to show when it is not. Call it
+     * more than once to add more rules — they all run, and every message is
+     * reported.
+     *
+     * Validation runs in the Studio as you type, in `npx val validate` and before a
+     * publish.
+     *
+     * @example
+     * const schema = s
+     *   .enum("draft", "published")
+     *   .validate((val) =>
+     *     val === "published" ? "Publishing is frozen this week" : false,
+     *   );
+     * export default c.define("/example.val.ts", schema, "draft");
+     */
+    validate(validationFunction: (src: Src) => false | string): EnumSchema<Src>;
+    protected executeValidate(path: SourcePath, src: Src): ValidationErrors;
+    protected executeAssert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
+    nullable(): EnumSchema<Src | null>;
+    readonly(isReadonly?: boolean): EnumSchema<Src>;
+    hidden(isHidden?: boolean): EnumSchema<Src>;
+    protected executeCustomValidateAt(path: SourcePath, src: Src): ValidationError[];
+    /**
+     * How this field is laid out in the editor when it is the item of an array
+     * or record: `{ as: "inline" }` renders the field itself inside each row,
+     * instead of a preview row that navigates to it.
+     *
+     * Static configuration, not a callback — see `render.ts`.
+     *
+     * @example
+     * const schema = s.array(
+     *   s.enum("draft", "published").render({ as: "inline" }),
+     * );
+     * export default c.define("/example.val.ts", schema, ["draft"]);
+     */
+    render(input: FieldRender): EnumSchema<Src>;
+    /**
+     * How this VALUE is shown where a preview of it is needed — a row in a
+     * sortable list, a reference dropdown, a search hit. Never how the field
+     * itself is edited (that is `render`). See `preview.ts`.
+     *
+     * @example
+     * const schema = s.array(
+     *   s.enum("draft", "published").preview(({ val }) => ({ title: val })),
+     * );
+     * export default c.define("/example.val.ts", schema, ["draft"]);
+     */
+    preview(select: ItemPreviewInput<Src>): EnumSchema<Src>;
+    protected executePreviewItem(src: NonNullable<Src>): PreviewItem | null;
+    protected declaresItemPreview(): boolean;
+    protected executeSerialize(): SerializedEnumSchema;
+    protected executePreview(): ReifiedPreview;
+}
+/**
+ * Define a string that must be one of a fixed set of values.
+ *
+ * Named `enumSchema` rather than `enum` because `enum` is a reserved word and
+ * cannot be a binding name; it is exposed as `s.enum`.
+ */
+export declare const enumSchema: <T extends string>(...values: [T, ...T[]]) => EnumSchema<T>;

package/dist/declarations/src/schema/file.d.ts

@@ -37,8 +37,71 @@ export declare class FileSchema<Src extends FileSource | null> extends Schema<Sr
     private readonly renderInput;
     private readonly previewInput;
     constructor(options?: FileOptions | undefined, opt?: boolean, isRemote?: boolean, customValidateFunctions?: CustomValidateFunction<Src>[], moduleMetadata?: Record<ModulePath, Record<string, FilesEntryMetadata>>, isReadonly?: boolean, isHidden?: boolean, description?: string | undefined, renderInput?: FieldRender | null, previewInput?: ItemPreviewInput<Src> | null);
+    /**
+     * Describe this field.
+     *
+     * The description is shown next to the field's label in the Val editor, so
+     * it is where you say what an editor needs to know but the field name cannot
+     * carry. It also travels in the serialized schema, which is what the AI
+     * assistant and the MCP tools read.
+     *
+     * Pass `null` to clear a description set earlier.
+     *
+     * @example
+     * const schema = s.file().describe("The PDF offered for download");
+     * export default c.define("/example.val.ts", schema, {
+     *   path: "/public/val/example.pdf",
+     *   mimeType: "application/pdf",
+     * });
+     */
     describe(description: string | null): FileSchema<Src>;
+    /**
+     * Store the file on Val's remote content host instead of in your repository.
+     *
+     * The bytes still go into the patch store when the file is uploaded — the
+     * push to the remote host happens at publish. What changes is where the
+     * published file lives: `path` becomes a remote URL rather than a path under
+     * `/public`, so the repository does not grow with every upload.
+     *
+     * The `path` of a remote file is a URL on the content host, and it is not
+     * something to write by hand: upload the file in the Studio, or write a
+     * local path and let `npx val validate --fix` upload it and rewrite the
+     * `path` to the ref below.
+     *
+     * @example
+     * const schema = s.file({ accept: "application/pdf" }).remote();
+     * export default c.define("/example.val.ts", schema, {
+     *   path: "https://remote.val.build/file/p/my-project/b/01/v/1.0.0/h/8f2a1c/f/3b9d70/p/public/val/example.pdf",
+     *   mimeType: "application/pdf",
+     * });
+     */
     remote(): FileSchema<Src>;
+    /**
+     * Add a custom validation rule to this field.
+     *
+     * The function is called with the field's value and returns `false` when the
+     * value is fine, or a STRING with the message to show when it is not. Call it
+     * more than once to add more rules — they all run, and every message is
+     * reported.
+     *
+     * Write the check as a ternary, not as `ok || "message"`: that returns `true`
+     * when the value is fine, and `true` is not one of the two answers.
+     *
+     * Validation runs in the Studio as you type, in `npx val validate` and
+     * before a publish.
+     *
+     * The second argument carries the `path` of the field being validated, for
+     * when the message needs to say where the problem is.
+     *
+     * @example
+     * const schema = s.file().validate((val) =>
+     *   val.path.endsWith(".pdf") ? false : "Must be a PDF",
+     * );
+     * export default c.define("/example.val.ts", schema, {
+     *   path: "/public/val/example.pdf",
+     *   mimeType: "application/pdf",
+     * });
+     */
     validate(validationFunction: CustomValidateFunction<Src>): FileSchema<Src>;
     protected executeValidate(path: SourcePath, src: Src): ValidationErrors;
     /**
@@ -57,12 +120,26 @@ export declare class FileSchema<Src extends FileSource | null> extends Schema<Sr
      * instead of a preview row that navigates to it.
      *
      * Static configuration, not a callback — see `render.ts`.
+     *
+     * @example
+     * const schema = s.array(s.file().render({ as: "inline" }));
+     * export default c.define("/example.val.ts", schema, [
+     *   { path: "/public/val/example.pdf", mimeType: "application/pdf" },
+     * ]);
      */
     render(input: FieldRender): FileSchema<Src>;
     /**
      * How this VALUE is shown where a preview of it is needed — a row in a
      * sortable list, a reference dropdown, a search hit. Never how the field
      * itself is edited (that is `render`). See `preview.ts`.
+     *
+     * @example
+     * const schema = s.array(
+     *   s.file().preview(({ val }) => ({ title: val.path })),
+     * );
+     * export default c.define("/example.val.ts", schema, [
+     *   { path: "/public/val/example.pdf", mimeType: "application/pdf" },
+     * ]);
      */
     preview(select: ItemPreviewInput<Src>): FileSchema<Src>;
     protected executePreviewItem(src: NonNullable<Src>): PreviewItem | null;

package/dist/declarations/src/schema/image.d.ts

@@ -82,8 +82,82 @@ export declare class ImageSchema<Src extends ImageSource | null> extends Schema<
     private readonly renderInput;
     private readonly previewInput;
     constructor(options?: ImageOptions | undefined, opt?: boolean, isRemote?: boolean, customValidateFunctions?: CustomValidateFunction<Src>[], moduleMetadata?: Record<ModulePath, Record<string, ImagesEntryMetadata>>, isReadonly?: boolean, isHidden?: boolean, description?: string | undefined, renderInput?: FieldRender | null, previewInput?: ItemPreviewInput<Src> | null);
+    /**
+     * Describe this field.
+     *
+     * The description is shown next to the field's label in the Val editor, so
+     * it is where you say what an editor needs to know but the field name cannot
+     * carry. It also travels in the serialized schema, which is what the AI
+     * assistant and the MCP tools read.
+     *
+     * Pass `null` to clear a description set earlier.
+     *
+     * @example
+     * const schema = s
+     *   .image()
+     *   .describe("Shown at the top of the page, 16:9 works best");
+     * export default c.define("/example.val.ts", schema, {
+     *   path: "/public/val/example.png",
+     *   width: 100,
+     *   height: 100,
+     *   mimeType: "image/png",
+     * });
+     */
     describe(description: string | null): ImageSchema<Src>;
+    /**
+     * Store the image on Val's remote content host instead of in your repository.
+     *
+     * The bytes still go into the patch store when the image is uploaded — the
+     * push to the remote host happens at publish. What changes is where the
+     * published image lives: `path` becomes a remote URL rather than a path
+     * under `/public`, so the repository does not grow with every upload.
+     *
+     * The `path` of a remote image is a URL on the content host, and it is not
+     * something to write by hand: upload the image in the Studio, or write a
+     * local path and let `npx val validate --fix` upload it and rewrite the
+     * `path` to the ref below.
+     *
+     * @example
+     * const schema = s
+     *   .image({ accept: "image/webp", directory: "/public/val/images" })
+     *   .remote();
+     * export default c.define("/example.val.ts", schema, {
+     *   path: "https://remote.val.build/file/p/my-project/b/01/v/1.0.0/h/8f2a1c/f/3b9d70/p/public/val/images/example.webp",
+     *   width: 100,
+     *   height: 100,
+     *   mimeType: "image/webp",
+     * });
+     */
     remote(): ImageSchema<Src>;
+    /**
+     * Add a custom validation rule to this field.
+     *
+     * The function is called with the field's value and returns `false` when the
+     * value is fine, or a STRING with the message to show when it is not. Call it
+     * more than once to add more rules — they all run, and every message is
+     * reported.
+     *
+     * Write the check as a ternary, not as `ok || "message"`: that returns `true`
+     * when the value is fine, and `true` is not one of the two answers.
+     *
+     * Validation runs in the Studio as you type, in `npx val validate` and
+     * before a publish.
+     *
+     * The second argument carries the `path` of the field being validated, for
+     * when the message needs to say where the problem is.
+     *
+     * @example
+     * const schema = s.image().validate((val) =>
+     *   val.alt ? false : "Every image needs alt text",
+     * );
+     * export default c.define("/example.val.ts", schema, {
+     *   path: "/public/val/example.png",
+     *   width: 100,
+     *   height: 100,
+     *   mimeType: "image/png",
+     *   alt: "An example",
+     * });
+     */
     validate(validationFunction: CustomValidateFunction<Src>): ImageSchema<Src>;
     protected executeValidate(path: SourcePath, src: Src): ValidationErrors;
     /**
@@ -102,12 +176,40 @@ export declare class ImageSchema<Src extends ImageSource | null> extends Schema<
      * instead of a preview row that navigates to it.
      *
      * Static configuration, not a callback — see `render.ts`.
+     *
+     * @example
+     * const schema = s.array(s.image().render({ as: "inline" }));
+     * export default c.define("/example.val.ts", schema, [
+     *   {
+     *     path: "/public/val/example.png",
+     *     width: 100,
+     *     height: 100,
+     *     mimeType: "image/png",
+     *   },
+     * ]);
      */
     render(input: FieldRender): ImageSchema<Src>;
     /**
      * How this VALUE is shown where a preview of it is needed — a row in a
      * sortable list, a reference dropdown, a search hit. Never how the field
      * itself is edited (that is `render`). See `preview.ts`.
+     *
+     * @example
+     * const schema = s.array(
+     *   s.image().preview(({ val }) => ({
+     *     title: val.alt ?? "Image",
+     *     image: val,
+     *   })),
+     * );
+     * export default c.define("/example.val.ts", schema, [
+     *   {
+     *     path: "/public/val/example.png",
+     *     width: 100,
+     *     height: 100,
+     *     mimeType: "image/png",
+     *     alt: "An example",
+     *   },
+     * ]);
      */
     preview(select: ItemPreviewInput<Src>): ImageSchema<Src>;
     protected executePreviewItem(src: NonNullable<Src>): PreviewItem | null;