@valbuild/core 0.77.1 → 0.78.1

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

@@ -52,6 +52,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 ListRecordPreview, type ListArrayPreview, type ReifiedPreview, } from "./preview.js";
 export declare const FATAL_ERROR_TYPES: readonly ["no-schema", "no-source", "invalid-id", "no-module", "invalid-patch"];
 export type FatalErrorType = (typeof FATAL_ERROR_TYPES)[number];
 export declare const DEFAULT_CONTENT_HOST = "https://content.val.build";

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

@@ -47,7 +47,7 @@ export type InitSchema = {
 export declare function initSchema(): {
     string: <T extends string>(options?: Record<string, never> | undefined) => import("./schema/string.js").StringSchema<T>;
     boolean: () => import("./schema/index.js").Schema<boolean>;
-    array: <S extends import("./schema/index.js").Schema<import("./selector/index.js").SelectorSource>>(schema: S) => import("./schema/index.js").Schema<import("./schema/index.js").SelectorOfSchema<S>[]>;
+    array: <S extends import("./schema/index.js").Schema<import("./selector/index.js").SelectorSource>>(schema: S) => import("./schema/array.js").ArraySchema<S, import("./schema/index.js").SelectorOfSchema<S>[] | null>;
     object: <Props extends {
         [key: string]: import("./schema/index.js").Schema<import("./selector/index.js").SelectorSource>;
     } & {
@@ -98,7 +98,7 @@ export declare function initSchema(): {
     image: (options?: import("./schema/image.js").ImageOptions | undefined) => import("./schema/image.js").ImageSchema<import("./index.js").ImageSource>;
     literal: <T_2 extends string>(value: T_2) => import("./schema/literal.js").LiteralSchema<T_2>;
     keyOf: <Src extends import("./selector/index.js").GenericSelector<import("./source/index.js").SourceObject, undefined> & import("./module.js").ValModuleBrand>(valModule: Src) => import("./schema/index.js").Schema<Src extends import("./selector/index.js").GenericSelector<infer S_2 extends import("./source/index.js").Source, undefined> ? S_2 extends readonly import("./source/index.js").Source[] ? number : S_2 extends import("./source/index.js").SourceObject ? string extends keyof S_2 ? import("./schema/string.js").RawString : keyof S_2 : S_2 extends Record<string, import("./source/index.js").Source> ? import("./schema/string.js").RawString : never : never>;
-    record: <S_3 extends import("./schema/index.js").Schema<import("./selector/index.js").SelectorSource>>(schema: S_3) => import("./schema/index.js").Schema<Record<string, import("./schema/index.js").SelectorOfSchema<S_3>>>;
+    record: <S_3 extends import("./schema/index.js").Schema<import("./selector/index.js").SelectorSource>>(schema: S_3) => import("./schema/record.js").RecordSchema<S_3, Record<string, import("./schema/index.js").SelectorOfSchema<S_3>>>;
     file: (options?: import("./schema/file.js").FileOptions | undefined) => import("./schema/file.js").FileSchema<import("./index.js").FileSource<import("./schema/file.js").FileMetadata>>;
     date: (options?: Record<string, never> | undefined) => import("./schema/date.js").DateSchema<import("./schema/string.js").RawString>;
 };

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

@@ -0,0 +1,39 @@
+import { Schema } from "./schema/index.js";
+import { SelectorSource } from "./selector/index.js";
+import { ImageSource } from "./source/image.js";
+import { ModuleFilePath, SourcePath } from "./val/index.js";
+export type ListRecordPreview = {
+    layout: "list";
+    parent: "record";
+    items: [
+        key: string,
+        value: {
+            title: string;
+            subtitle?: string | null;
+            image?: ImageSource | null;
+        }
+    ][];
+};
+export type ListArrayPreview = {
+    layout: "list";
+    parent: "array";
+    items: {
+        title: string;
+        subtitle?: string | null;
+        image?: ImageSource | null;
+    }[];
+};
+type PreviewTypes = ListRecordPreview | ListArrayPreview;
+type WithStatus<T> = {
+    status: "error";
+    message: string;
+} | {
+    status: "loading";
+    data?: T;
+} | {
+    status: "success";
+    data: T;
+};
+export type ReifiedPreview = Record<SourcePath | ModuleFilePath, WithStatus<PreviewTypes>>;
+export type PreviewSelector<T extends Schema<SelectorSource>> = T extends Schema<infer S> ? S : never;
+export {};

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

@@ -1,6 +1,8 @@
 import { Schema, SchemaAssertResult, SelectorOfSchema, SerializedSchema } from "./index.js";
+import { PreviewSelector, ReifiedPreview } from "../preview.js";
 import { SelectorSource } from "../selector/index.js";
-import { SourcePath } from "../val/index.js";
+import { ImageSource } from "../source/image.js";
+import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 export type SerializedArraySchema = {
     type: "array";
@@ -15,5 +17,17 @@ export declare class ArraySchema<T extends Schema<SelectorSource>, Src extends S
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedArraySchema;
+    private previewInput;
+    protected executePreview(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedPreview;
+    preview(input: {
+        layout: "list";
+        prepare: (input: {
+            val: PreviewSelector<T>;
+        }) => {
+            title: string;
+            subtitle?: string | null;
+            image?: ImageSource | null;
+        };
+    }): this;
 }
-export declare const array: <S extends Schema<SelectorSource>>(schema: S) => Schema<SelectorOfSchema<S>[]>;
+export declare const array: <S extends Schema<SelectorSource>>(schema: S) => ArraySchema<S, SelectorOfSchema<S>[] | null>;

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

@@ -1,4 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 export type SerializedBooleanSchema = {
@@ -12,5 +13,6 @@ export declare class BooleanSchema<Src extends boolean | null> extends Schema<Sr
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const boolean: () => Schema<boolean>;

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

@@ -1,4 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { SourcePath } from "../val/index.js";
 import { RawString } from "./string.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
@@ -33,6 +34,7 @@ export declare class DateSchema<Src extends string | null> extends Schema<Src> {
     to(to: string): DateSchema<Src>;
     nullable(): DateSchema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const date: (options?: Record<string, never>) => DateSchema<RawString>;
 export {};

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

@@ -4,6 +4,7 @@ import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
 import { SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 import { RemoteSource } from "../index.js";
+import { ReifiedPreview } from "../preview.js";
 export type FileOptions = {
     accept?: string;
 };
@@ -26,6 +27,7 @@ export declare class FileSchema<Src extends FileSource<FileMetadata | undefined>
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const file: (options?: FileOptions) => FileSchema<FileSource<FileMetadata>>;
 export declare function convertFileSource<Metadata extends {

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

@@ -5,6 +5,7 @@ import { SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 import { FileMetadata } from "../index.js";
 import { RemoteSource } from "../source/remote.js";
+import { ReifiedPreview } from "../preview.js";
 export type ImageOptions = {
     ext?: ["jpg"] | ["webp"];
     directory?: string;
@@ -36,5 +37,6 @@ export declare class ImageSchema<Src extends FileSource<ImageMetadata | undefine
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const image: (options?: ImageOptions) => ImageSchema<ImageSource>;

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

@@ -1,5 +1,5 @@
 import { SelectorSource } from "../selector/index.js";
-import { SourcePath } from "../val/index.js";
+import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { SerializedArraySchema } from "./array.js";
 import { SerializedBooleanSchema } from "./boolean.js";
 import { SerializedFileSchema } from "./file.js";
@@ -16,6 +16,7 @@ import { SerializedDateSchema } from "./date.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 import { FileSource } from "../source/file.js";
 import { GenericRichTextSourceNode, RichTextSource } from "../source/richtext.js";
+import { ReifiedPreview } from "../preview.js";
 export type SerializedSchema = SerializedStringSchema | SerializedLiteralSchema | SerializedBooleanSchema | SerializedNumberSchema | SerializedObjectSchema | SerializedArraySchema | SerializedUnionSchema | SerializedRichTextSchema | SerializedRecordSchema | SerializedKeyOfSchema | SerializedFileSchema | SerializedDateSchema | SerializedImageSchema;
 type Primitives = number | string | boolean | null | FileSource;
 export type AssertError = {
@@ -60,6 +61,7 @@ export declare abstract class Schema<Src extends SelectorSource> {
     abstract assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     abstract nullable(): Schema<Src | null>;
     abstract serialize(): SerializedSchema;
+    protected abstract executePreview(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedPreview;
     /** MUTATES! since internal and perf sensitive */
     protected appendValidationError(current: ValidationErrors, path: SourcePath, message: string, value: unknown): ValidationErrors;
 }

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

@@ -5,6 +5,7 @@ import { Source, SourceObject } from "../source/index.js";
 import { SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 import { RawString } from "./string.js";
+import { ReifiedPreview } from "../preview.js";
 export type SerializedKeyOfSchema = {
     type: "keyOf";
     path: SourcePath;
@@ -22,6 +23,7 @@ export declare class KeyOfSchema<Sel extends GenericSelector<SourceObject>, Src
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const keyOf: <Src extends GenericSelector<SourceObject, undefined> & ValModuleBrand>(valModule: Src) => Schema<KeyOfSelector<Src>>;
 export {};

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

@@ -1,4 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 export type SerializedLiteralSchema = {
@@ -14,5 +15,6 @@ export declare class LiteralSchema<Src extends string | null> extends Schema<Src
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const literal: <T extends string>(value: T) => LiteralSchema<T>;

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

@@ -1,4 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 type NumberOptions = {
@@ -18,6 +19,7 @@ export declare class NumberSchema<Src extends number | null> extends Schema<Src>
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const number: (options?: NumberOptions) => Schema<number>;
 export {};

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

@@ -1,6 +1,7 @@
 import { Schema, SchemaAssertResult, SelectorOfSchema, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { SelectorSource } from "../selector/index.js";
-import { SourcePath } from "../val/index.js";
+import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 export type SerializedObjectSchema = {
     type: "object";
@@ -36,6 +37,7 @@ export declare class ObjectSchema<Props extends ObjectSchemaProps, Src extends O
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedPreview;
 }
 export declare const object: <Props extends ObjectSchemaProps>(schema: Props) => Schema<{ [key in keyof Props]: SelectorOfSchema<Props[key]>; }>;
 export {};

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

@@ -1,6 +1,8 @@
 import { Schema, SchemaAssertResult, SelectorOfSchema, SerializedSchema } from "./index.js";
+import { PreviewSelector, ReifiedPreview } from "../preview.js";
 import { SelectorSource } from "../selector/index.js";
-import { SourcePath } from "../val/index.js";
+import { ImageSource } from "../source/image.js";
+import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 export type SerializedRecordSchema = {
     type: "record";
@@ -15,5 +17,18 @@ export declare class RecordSchema<T extends Schema<SelectorSource>, Src extends
     assert(path: SourcePath, src: unknown): SchemaAssertResult<Src>;
     nullable(): Schema<Src | null>;
     serialize(): SerializedRecordSchema;
+    private previewInput;
+    protected executePreview(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedPreview;
+    preview(input: {
+        layout: "list";
+        prepare: (input: {
+            key: string;
+            val: PreviewSelector<T>;
+        }) => {
+            title: string;
+            subtitle?: string | null;
+            image?: ImageSource | null;
+        };
+    }): this;
 }
-export declare const record: <S extends Schema<SelectorSource>>(schema: S) => Schema<Record<string, SelectorOfSchema<S>>>;
+export declare const record: <S extends Schema<SelectorSource>>(schema: S) => RecordSchema<S, Record<string, SelectorOfSchema<S>>>;

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

@@ -1,4 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { ImageSource } from "../source/image.js";
 import { RichTextSource, RichTextOptions, SerializedRichTextOptions } from "../source/richtext.js";
 import { SourcePath } from "../val/index.js";
@@ -25,6 +26,7 @@ export declare class RichTextSchema<O extends RichTextOptions, Src extends RichT
     private recursiveAssert;
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const richtext: <O extends Partial<{
     style: Partial<{

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

@@ -1,4 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 type StringOptions = {
@@ -44,6 +45,7 @@ export declare class StringSchema<Src extends string | null> extends Schema<Src>
     nullable(): StringSchema<Src | null>;
     raw(): StringSchema<Src extends null ? RawString | null : RawString>;
     serialize(): SerializedSchema;
+    protected executePreview(): ReifiedPreview;
 }
 export declare const string: <T extends string>(options?: Record<string, never>) => StringSchema<T>;
 export {};

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

@@ -1,7 +1,8 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
+import { ReifiedPreview } from "../preview.js";
 import { SelectorSource } from "../selector/index.js";
 import { SourceObject } from "../source/index.js";
-import { SourcePath } from "../val/index.js";
+import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { SerializedLiteralSchema } from "./literal.js";
 import { SerializedObjectSchema } from "./object.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
@@ -32,6 +33,7 @@ export declare class UnionSchema<Key extends string | Schema<string>, T extends
     nullable(): Schema<Src | null>;
     serialize(): SerializedSchema;
     constructor(key: Key, items: T, opt?: boolean);
+    protected executePreview(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedPreview;
 }
 export declare const union: <Key extends string | Schema<string>, T extends Schema<Key extends string ? {
     [x: string]: import("../source/index.js").Source;