@valbuild/core 0.101.0 → 0.102.0

package/dist/declarations/src/extractValModules.d.ts

@@ -21,7 +21,7 @@ export type ExtractedValModules = {
  * Extracts schemas and sources from a ValModules registry and computes the
  * deterministic SHAs that the server and client both use to detect changes.
  *
- * Used by ValOps on the server and by ValSyncEngine on the client so the
+ * Used by ValOps on the server and by `HostStore` on the client so the
  * hash algorithm has a single source of truth.
  */
 export declare function extractValModules(valModules: ValModules): Promise<ExtractedValModules>;

package/dist/declarations/src/index.d.ts

@@ -3,6 +3,7 @@ export { modules, type ValModules } from "./modules.js";
 export { extractValModules, type ExtractedValModules, type ExtractedModuleError, } from "./extractValModules.js";
 export type { InitVal, ValConfig, ValConstructor, ContentConstructor, } from "./initVal.js";
 export { Schema, type SerializedSchema, type SelectorOfSchema } from "./schema/index.js";
+export { hasRemoteFileSchema } from "./schema/hasRemoteFileSchema.js";
 export type { ImageMetadata } from "./schema/image.js";
 export type { FileMetadata } from "./schema/file.js";
 export type { ValModule, SerializedModule, InferValModuleType } from "./module.js";
@@ -60,7 +61,7 @@ export { type SerializedRichTextSchema, RichTextSchema, } from "./schema/richtex
 export { type SerializedUnionSchema, UnionSchema, type SerializedStringUnionSchema, type SerializedObjectUnionSchema, } from "./schema/union.js";
 export { type SerializedLiteralSchema, LiteralSchema } from "./schema/literal.js";
 export { deserializeSchema } from "./schema/deserialize.js";
-export { type ListRecordRender, type ListArrayRender, type ReifiedRender, type CodeLanguage, type CodeRender, } from "./render.js";
+export { type ListRecordRender, type ListArrayRender, type ReifiedRender, type RenderScope, type CodeLanguage, type CodeRender, renderScope, } from "./render.js";
 export type { ValRouter, RouteValidationError } from "./router.js";
 export { getSourcePathFromRoute } from "./getSourcePathFromRoute.js";
 export declare const FATAL_ERROR_TYPES: readonly ["no-schema", "no-source", "invalid-id", "no-module", "invalid-patch"];

package/dist/declarations/src/initSchema.d.ts

@@ -306,7 +306,7 @@ export declare function initSchema(): {
     color: (options?: import("./schema/color.js").ColorOptions) => import("./schema/color.js").ColorSchema<import("./schema/string.js").RawString>;
     route: <T extends string>(options?: Record<string, never>) => import("./schema/route.js").RouteSchema<T>;
     router: typeof router;
-    images: <Accept extends `image/${string}`>(options?: import("./schema/images.js").ImagesOptions<Accept>) => import("./schema/record.js").RecordSchema<import("./schema/object.js").ObjectSchema<{
+    images: <Accept extends `image/${string}`>(options: import("./schema/images.js").ImagesOptions<Accept>) => import("./schema/record.js").RecordSchema<import("./schema/object.js").ObjectSchema<{
         width: import("./schema/number.js").NumberSchema<number>;
         height: import("./schema/number.js").NumberSchema<number>;
         mimeType: import("./schema/string.js").StringSchema<string>;

package/dist/declarations/src/render.d.ts

@@ -19,11 +19,25 @@ export type ListRecordRender = {
 export type ListArrayRender = {
     layout: "list";
     parent: "array";
-    items: {
-        title: string;
-        subtitle?: string | null;
-        image?: ImageSource | RemoteSource<ImageMetadata> | null;
-    }[];
+    /**
+     * The rendered items, each PAIRED WITH ITS INDEX — the same
+     * `[key, value][]` shape {@link ListRecordRender} uses.
+     *
+     * Not a positionally-indexed array, and the reason is
+     * {@link RenderScope}: a render computed for a subset of paths carries only
+     * those items, so `items[i]` would silently read the wrong row. Carrying the
+     * index makes a windowed render impossible to misread — a consumer looks its
+     * index up rather than trusting a position — and makes the array and record
+     * shapes symmetric.
+     */
+    items: [
+        index: number,
+        value: {
+            title: string;
+            subtitle?: string | null;
+            image?: ImageSource | RemoteSource<ImageMetadata> | null;
+        }
+    ][];
 };
 export type TextareaRender = {
     layout: "textarea";
@@ -45,5 +59,42 @@ type WithStatus<T> = {
     data: T;
 };
 export type ReifiedRender = Record<SourcePath | ModuleFilePath, WithStatus<RenderTypes>>;
+/**
+ * Which paths a render is being computed FOR.
+ *
+ * `executeRender` takes a whole module, so one request has always walked every
+ * node in it and run every `select` closure — for `handboka`, with `select` at
+ * two nested array levels, that is every chapter and every section to serve one
+ * visible row. A scope is what makes the walk proportional to what is being
+ * looked at instead of to the project.
+ *
+ * Two questions, because a container and its items need different answers:
+ *
+ * - {@link RenderScope.wants} — is a render AT this exact path wanted? A
+ *   container answers `true` here when the whole of it is being shown, and its
+ *   list render is then computed in full.
+ * - {@link RenderScope.wantsUnder} — could anything at or below this path be
+ *   wanted? Recursion is pruned where this is `false`, and a container whose own
+ *   path is not wanted but which has wanted descendants renders a WINDOW: only
+ *   the items that were asked for. That is the case a single visible row is, and
+ *   it is why {@link ListArrayRender} carries indices.
+ *
+ * Absent scope means the whole module, which is what every existing caller
+ * passes and what every existing caller got.
+ */
+export type RenderScope = {
+    wants(path: SourcePath | ModuleFilePath): boolean;
+    wantsUnder(path: SourcePath | ModuleFilePath): boolean;
+};
+/**
+ * A scope covering exactly `paths` and their subtrees.
+ *
+ * Compares SEGMENTS rather than string prefixes. A source path's module path is
+ * a quoted, dot-joined encoding (`?p="a".1."b"`), so `startsWith` gets the
+ * ancestor test wrong wherever a key is a prefix of a sibling key or contains a
+ * dot or a quote — `"title"` against `"titles"` being the cheapest example.
+ * Segments are parsed once here, not per comparison.
+ */
+export declare function renderScope(paths: readonly SourcePath[]): RenderScope;
 export type RenderSelector<T extends Schema<SelectorSource>> = T extends Schema<infer S> ? S : never;
 export {};

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

@@ -1,5 +1,5 @@
 import { Schema, SchemaAssertResult, SelectorOfSchema, SerializedSchema } from "./index.js";
-import { RenderSelector, ReifiedRender } from "../render.js";
+import { RenderSelector, ReifiedRender, RenderScope } from "../render.js";
 import { SelectorSource } from "../selector/index.js";
 import { ImageSource } from "../source/image.js";
 import { ModuleFilePath, SourcePath } from "../val/index.js";
@@ -8,6 +8,16 @@ export type SerializedArraySchema = {
     type: "array";
     item: SerializedSchema;
     opt: boolean;
+    /**
+     * Set when this schema declares a `render`.
+     *
+     * The render itself cannot be serialized — `select` is a user closure — but
+     * whether one EXISTS can be, and that is worth carrying: it lets the non-host
+     * side skip asking the host to render a module that cannot produce one.
+     * Measured in a browser: mounting 260 fields across 141 modules spent ~2.3ms
+     * of 3.1ms calling `executeRender` on modules that returned nothing.
+     */
+    render?: true;
     customValidate?: boolean;
     readonly?: boolean;
     hidden?: boolean;
@@ -41,7 +51,7 @@ export declare class ArraySchema<T extends Schema<SelectorSource>, Src extends S
     hidden(): ArraySchema<T, Src>;
     protected executeCustomValidateAt(path: SourcePath, src: Src): ValidationError[];
     protected executeSerialize(): SerializedArraySchema;
-    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedRender;
+    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src, scope?: RenderScope): ReifiedRender;
     render(input: ArrayRenderInput<T>): ArraySchema<T, Src>;
 }
 export declare const array: <S extends Schema<SelectorSource>>(schema: S) => ArraySchema<S, SelectorOfSchema<S>[]>;

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

@@ -14,9 +14,13 @@ export type FilesOptions = {
     /**
      * The directory where files should be stored.
      * Must start with "/public" (e.g., "/public/val/files")
-     * @default "/public/val"
+     *
+     * Required, and deliberately so: it decides where every uploaded file in this
+     * collection lands, and it used to default to "/public/val" — which meant a
+     * collection that had simply not said where it wanted its files silently shared
+     * a directory with every other one.
      */
-    directory?: "/public" | `/public/${string}`;
+    directory: "/public" | `/public/${string}`;
     /**
      * Whether remote files are allowed
      * @default false

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

@@ -0,0 +1,34 @@
+import type { SerializedSchema } from "./index.js";
+/**
+ * Does this schema store any file remotely?
+ *
+ * The one answer to that question. There used to be two — `hasRemoteFileSchema`
+ * in the server, gating whether `/save` demands remote credentials, and
+ * `findRequiredRemoteFiles` in the Studio, gating the `/remote/settings` fetch —
+ * and they disagreed about `s.images({ remote: true })`: the Studio's counted a
+ * remote media record, the server's did not, because a media collection
+ * serializes as a `record` of metadata rather than as an image schema.
+ *
+ * The server's answer was the wrong one, and silently so. With it false,
+ * `/save` runs `saveOrUploadFiles` in `skip-remote` mode, and that mode does not
+ * merely skip the upload — it drops every remote descriptor without an error. The
+ * commit then lands a remote ref with no bytes behind it: a broken image, in the
+ * repository, with nothing anywhere saying why.
+ *
+ * ## Why it stays a walk over the SERIALIZED schema
+ *
+ * Both callers have a `SerializedSchema` and not a `Schema`: the server reads
+ * them out of `getSchemas()`, and the Studio is handed them by `host.receive`.
+ * Asking the schema classes directly would mean a method on every one of them,
+ * and the two places that need the answer cannot call it.
+ *
+ * ## Throwing
+ *
+ * The `never` assignment at the end is the point of the default branch: adding a
+ * schema type without teaching this function about it must not compile. The throw
+ * is what happens if one arrives anyway — which for a caller reading schemas out
+ * of its own process should be impossible. A caller that cannot afford to throw
+ * (the Studio, whose whole UI is downstream of this) catches it; returning `false`
+ * instead would reintroduce exactly the silent skip described above.
+ */
+export declare function hasRemoteFileSchema(schema: SerializedSchema): boolean;

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

@@ -20,9 +20,13 @@ export type ImagesOptions<Accept extends `image/${string}`> = {
     /**
      * The directory where images should be stored.
      * Must start with "/public" (e.g., "/public/val/images")
-     * @default "/public/val"
+     *
+     * Required, and deliberately so: it decides where every uploaded file in this
+     * collection lands, and it used to default to "/public/val" — which meant a
+     * gallery that had simply not said where it wanted its files silently shared a
+     * directory with every other one.
      */
-    directory?: "/public" | `/public/${string}`;
+    directory: "/public" | `/public/${string}`;
     /**
      * Alt text schema. Can be:
      * - s.string() for required alt text
@@ -65,8 +69,9 @@ type ImagesItemSrc = {
 /**
  * Define a collection of images.
  *
- * All options are optional: `s.images()` accepts any image type (`"image/*"`) in
- * the default `/public/val` directory, with nullable alt text and remote disabled.
+ * `directory` is required — it decides where uploads land, so it is not something
+ * to be inferred. The rest defaults: any image type (`"image/*"`), nullable alt
+ * text, remote disabled.
  *
  * @example
  * ```typescript
@@ -85,5 +90,5 @@ type ImagesItemSrc = {
  * });
  * ```
  */
-export declare const images: <Accept extends `image/${string}`>(options?: ImagesOptions<Accept>) => RecordSchema<ObjectSchema<ImagesItemProps, ImagesItemSrc>, Schema<string>, Record<string, ImagesEntryMetadata>>;
+export declare const images: <Accept extends `image/${string}`>(options: ImagesOptions<Accept>) => RecordSchema<ObjectSchema<ImagesItemProps, ImagesItemSrc>, Schema<string>, Record<string, ImagesEntryMetadata>>;
 export {};

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

@@ -19,7 +19,7 @@ import { SerializedRouteSchema } from "./route.js";
 import { ValidationError, ValidationErrors } from "./validation/ValidationError.js";
 import { FileSource } from "../source/file.js";
 import { GenericRichTextSourceNode, RichTextSource } from "../source/richtext.js";
-import { ReifiedRender } from "../render.js";
+import { ReifiedRender, RenderScope } from "../render.js";
 export type SerializedSchema = SerializedStringSchema | SerializedLiteralSchema | SerializedBooleanSchema | SerializedNumberSchema | SerializedObjectSchema | SerializedArraySchema | SerializedUnionSchema | SerializedRichTextSchema | SerializedRecordSchema | SerializedKeyOfSchema | SerializedFileSchema | SerializedDateSchema | SerializedDateTimeSchema | SerializedColorSchema | SerializedRouteSchema | SerializedImageSchema;
 type Primitives = number | string | boolean | null | FileSource;
 export type AssertError = {
@@ -106,7 +106,14 @@ export declare abstract class Schema<Src extends SelectorSource> {
      */
     abstract hidden(): Schema<Src>;
     protected abstract executeSerialize(): SerializedSchema;
-    protected abstract executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedRender;
+    /**
+     * @param scope Which paths the caller needs a render for. Absent means the
+     * whole module, which is what every caller passed before scoping existed.
+     * See {@link RenderScope}: a container prunes recursion where nothing is
+     * wanted, and renders a WINDOW when its own path is not wanted but some of its
+     * items are — which is the single-visible-row case.
+     */
+    protected abstract executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src, scope?: RenderScope): ReifiedRender;
     /** MUTATES! since internal and perf sensitive */
     protected appendValidationError(current: ValidationErrors, path: SourcePath, message: string, value: unknown, schemaError?: boolean): ValidationErrors;
     /**

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

@@ -1,5 +1,5 @@
 import { CustomValidateFunction, Schema, SchemaAssertResult, SelectorOfSchema, SerializedSchema } from "./index.js";
-import { ReifiedRender } from "../render.js";
+import { ReifiedRender, RenderScope } from "../render.js";
 import { SelectorSource } from "../selector/index.js";
 import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { ValidationError, ValidationErrors } from "./validation/ValidationError.js";
@@ -52,7 +52,7 @@ export declare class ObjectSchema<Props extends ObjectSchemaProps, Src extends O
     hidden(): ObjectSchema<Props, Src>;
     protected executeCustomValidateAt(path: SourcePath, src: Src): ValidationError[];
     protected executeSerialize(): SerializedSchema;
-    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedRender;
+    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src, scope?: RenderScope): ReifiedRender;
 }
 export declare const object: <Props extends ObjectSchemaProps>(schema: Props) => ObjectSchema<Props, ObjectSchemaSrcOf<Props>>;
 export {};

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

@@ -1,5 +1,5 @@
 import { CustomValidateFunction, Schema, SchemaAssertResult, SelectorOfSchema, SerializedSchema } from "./index.js";
-import { RenderSelector, ReifiedRender } from "../render.js";
+import { RenderSelector, ReifiedRender, RenderScope } from "../render.js";
 import { ValRouter } from "../router.js";
 import { SelectorSource } from "../selector/index.js";
 import { ImageSource } from "../source/image.js";
@@ -20,6 +20,8 @@ export type SerializedRecordSchema = {
     item: SerializedSchema;
     key?: SerializedSchema;
     opt: boolean;
+    /** Set when this schema declares a `render`. See `SerializedArraySchema`. */
+    render?: true;
     router?: string;
     customValidate?: boolean;
     mediaType?: "files" | "images";
@@ -113,7 +115,7 @@ export declare class RecordSchema<T extends Schema<SelectorSource>, K extends Sc
      * defers).
      */
     validateJsonEntryContent(path: SourcePath, content: SelectorSource): ValidationErrors;
-    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedRender;
+    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src, scope?: RenderScope): ReifiedRender;
     render(input: {
         as: "list";
         select: (input: {

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

@@ -1,5 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
-import { CodeLanguage, ReifiedRender } from "../render.js";
+import { CodeLanguage, ReifiedRender, RenderScope } from "../render.js";
 import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { ValidationError, ValidationErrors } from "./validation/ValidationError.js";
 type StringOptions = {
@@ -10,6 +10,8 @@ type StringOptions = {
 };
 export type SerializedStringSchema = {
     type: "string";
+    /** Set when this schema declares a `render`. See `SerializedArraySchema`. */
+    render?: true;
     options?: {
         maxLength?: number;
         minLength?: number;
@@ -73,7 +75,7 @@ export declare class StringSchema<Src extends string | null> extends Schema<Src>
         as: "code";
         language: CodeLanguage;
     }): StringSchema<Src>;
-    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedRender;
+    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src, _scope?: RenderScope): ReifiedRender;
 }
 export declare const string: <T extends string>(options?: Record<string, never>) => StringSchema<T>;
 export {};

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

@@ -1,5 +1,5 @@
 import { CustomValidateFunction, Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
-import { ReifiedRender } from "../render.js";
+import { ReifiedRender, RenderScope } from "../render.js";
 import { SelectorSource } from "../selector/index.js";
 import { SourceObject } from "../source/index.js";
 import { ModuleFilePath, SourcePath } from "../val/index.js";
@@ -57,7 +57,7 @@ export declare class UnionSchema<Key extends string | Schema<string>, T extends
     private matchedVariant;
     protected executeSerialize(): SerializedSchema;
     constructor(key: Key, items: T, opt?: boolean, customValidateFunctions?: CustomValidateFunction<Src>[], isReadonly?: boolean, isHidden?: boolean, description?: string | undefined);
-    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedRender;
+    protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src, scope?: RenderScope): ReifiedRender;
 }
 export declare const union: <Key extends string | Schema<string>, T extends Schema<Key extends string ? SourceObject & { [k in Key]: string; } : Key extends Schema<string> ? string : unknown>[]>(key: Key, ...objects: T) => UnionSchema<Key, T, SourceOf<Key, T>>;
 export {};