@valbuild/core 0.62.6 → 0.63.1

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

@@ -11,7 +11,7 @@ export type { FileSource } from "./source/file.js";
 export type { RawString } from "./schema/string.js";
 export type { ImageSource } from "./source/image.js";
 export { RT_IMAGE_TAG } from "./source/richtext.js";
-export type { AnyRichTextOptions, Bold, Classes, HeadingNode, ImageNode, Italic, LineThrough, ListItemNode, LinkNode, OrderedListNode, ParagraphNode, BrNode, RichText, RichTextNode, RichTextOptions, RichTextSource, RootNode, SpanNode, UnorderedListNode, } from "./source/richtext.js";
+export type { AllRichTextOptions, Bold, Styles, HeadingNode, ImageNode, Italic, LineThrough, ListItemNode, LinkNode, OrderedListNode, ParagraphNode, BrNode, RichTextNode, RichTextOptions, RichTextSource, BlockNode, SpanNode, UnorderedListNode, } from "./source/richtext.js";
 export { type Val, type SerializedVal, type ModuleFilePath, type PatchId, type ModulePath, type SourcePath, type JsonOfSource, } from "./val/index.js";
 export type { Json, JsonPrimitive, JsonArray, JsonObject } from "./Json.js";
 export type { ValidationError, ValidationErrors, } from "./schema/validation/ValidationError.js";

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

@@ -54,7 +54,27 @@ export declare function initSchema(): {
         val?: undefined;
         valPath?: undefined;
     } & { [k in Key]: string; } : Key extends import("./schema/index.js").Schema<string> ? string : unknown>[]>(key: Key, ...objects: T_1) => import("./schema/index.js").Schema<T_1 extends import("./schema/index.js").Schema<infer S_1 extends import("./selector/index.js").SelectorSource>[] ? S_1 extends import("./selector/index.js").SelectorSource ? S_1 | (Key extends import("./schema/index.js").Schema<infer K extends import("./selector/index.js").SelectorSource> ? K : never) : never : never>;
-    richtext: <O extends import("./index.js").RichTextOptions>(options?: O | undefined) => import("./schema/index.js").Schema<import("./index.js").RichTextSource<O>>;
+    richtext: <O extends Partial<{
+        style: Partial<{
+            bold: boolean;
+            italic: boolean;
+            lineThrough: boolean;
+        }>;
+        block: Partial<{
+            h1: boolean;
+            h2: boolean;
+            h3: boolean;
+            h4: boolean;
+            h5: boolean;
+            h6: boolean;
+            ul: boolean;
+            ol: boolean;
+        }>;
+        inline: Partial<{
+            a: boolean;
+            img: boolean;
+        }>;
+    }>>(options?: O | undefined) => import("./schema/index.js").Schema<import("./index.js").RichTextSource<O>>;
     image: (options?: import("./schema/image.js").ImageOptions | undefined) => import("./schema/index.js").Schema<import("./index.js").ImageSource>;
     literal: <T_2 extends string>(value: T_2) => import("./schema/index.js").Schema<T_2>;
     keyOf: <Src extends import("./selector/index.js").GenericSelector<import("./source/index.js").SourceObject | import("./source/index.js").SourceArray, 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>;

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

@@ -12,7 +12,7 @@ export type ValModuleBrand = {
     [brand]: "ValModule";
 };
 export type InferValModuleType<T extends ValModule<SelectorSource>> = T extends GenericSelector<infer S> ? S : never;
-type ReplaceRawStringWithString<T extends SelectorSource> = SelectorSource extends T ? T : T extends RawString ? string : T extends ImageSelector ? ImageSource : T extends {
+export type ReplaceRawStringWithString<T extends SelectorSource> = SelectorSource extends T ? T : T extends RawString ? string : T extends ImageSelector ? ImageSource : T extends {
     [key in string]: SelectorSource;
 } ? {
     [key in keyof T]: ReplaceRawStringWithString<T[key]>;

package/dist/declarations/src/patch/operation.d.ts

@@ -63,7 +63,11 @@ export type Operation = {
     value: JSONValue;
 } | {
     op: "file";
+    /** path of the top-most element where the schema of the element points to */
     path: string[];
+    /** file path relative to project (starts with /public, e.g. /public/example.png) */
     filePath: string;
+    /** files can be nested within an object (for richtext), in order to find the actual file element this path can be used (we use this to add the patch_id on files) */
+    nestedFilePath?: string[];
     value: JSONValue;
 };

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

@@ -16,4 +16,24 @@ export declare class RichTextSchema<O extends RichTextOptions, Src extends RichT
     nullable(): Schema<RichTextSource<O> | null>;
     serialize(): SerializedSchema;
 }
-export declare const richtext: <O extends RichTextOptions>(options?: O | undefined) => Schema<RichTextSource<O>>;
+export declare const richtext: <O extends Partial<{
+    style: Partial<{
+        bold: boolean;
+        italic: boolean;
+        lineThrough: boolean;
+    }>;
+    block: Partial<{
+        h1: boolean;
+        h2: boolean;
+        h3: boolean;
+        h4: boolean;
+        h5: boolean;
+        h6: boolean;
+        ul: boolean;
+        ol: boolean;
+    }>;
+    inline: Partial<{
+        a: boolean;
+        img: boolean;
+    }>;
+}>>(options?: O | undefined) => Schema<RichTextSource<O>>;

package/dist/declarations/src/schema/validation/ValidationFix.d.ts

@@ -1,2 +1,2 @@
-export declare const ValidationFix: readonly ["image:add-metadata", "image:replace-metadata", "file:add-metadata", "file:check-metadata"];
+export declare const ValidationFix: readonly ["image:add-metadata", "image:replace-metadata", "file:add-metadata", "file:check-metadata", "fix:deprecated-richtext"];
 export type ValidationFix = (typeof ValidationFix)[number];

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

@@ -15,7 +15,8 @@ import type { A } from "ts-toolbelt";
 import { I18nSource, I18nCompatibleSource } from "../../source/future/i18n.js";
 import { RemoteCompatibleSource, RemoteSource } from "../../source/future/remote.js";
 import { FileSource } from "../../source/file.js";
-import { AnyRichTextOptions, RichText, RichTextSource } from "../../source/richtext.js";
+import { AllRichTextOptions, RichTextSource } from "../../source/richtext.js";
+import { RichTextSelector } from "../richtext.js";
 /**
  * Selectors can be used to select parts of a Val module.
  * Unlike queries, joins, aggregates etc is and will not be supported.
@@ -37,10 +38,10 @@ import { AnyRichTextOptions, RichText, RichTextSource } from "../../source/richt
  * }));
  *
  */
-export type Selector<T extends Source> = Source extends T ? GenericSelector<T> : T extends I18nSource<infer L, infer S> ? I18nSelector<L, S> : T extends RemoteSource<infer S> ? S extends RemoteCompatibleSource ? RemoteSelector<S> : GenericSelector<Source, "Could not determine remote source"> : T extends FileSource ? FileSelector : T extends RichTextSource<infer O> ? RichText<O> : T extends SourceObject ? ObjectSelector<T> : T extends SourceArray ? ArraySelector<T> : T extends string ? StringSelector<T> : T extends number ? NumberSelector<T> : T extends boolean ? BooleanSelector<T> : T extends null ? PrimitiveSelector<null> : never;
+export type Selector<T extends Source> = Source extends T ? GenericSelector<T> : T extends I18nSource<infer L, infer S> ? I18nSelector<L, S> : T extends RemoteSource<infer S> ? S extends RemoteCompatibleSource ? RemoteSelector<S> : GenericSelector<Source, "Could not determine remote source"> : T extends FileSource ? FileSelector : T extends RichTextSource<infer O> ? RichTextSelector<O> : T extends SourceObject ? ObjectSelector<T> : T extends SourceArray ? ArraySelector<T> : T extends string ? StringSelector<T> : T extends number ? NumberSelector<T> : T extends boolean ? BooleanSelector<T> : T extends null ? PrimitiveSelector<null> : never;
 export type SelectorSource = SourcePrimitive | undefined | readonly SelectorSource[] | {
     [key: string]: SelectorSource;
-} | I18nSource<readonly string[], I18nCompatibleSource> | RemoteSource<RemoteCompatibleSource> | FileSource | RichTextSource<AnyRichTextOptions> | GenericSelector<Source>;
+} | I18nSource<readonly string[], I18nCompatibleSource> | RemoteSource<RemoteCompatibleSource> | FileSource | RichTextSource<AllRichTextOptions> | GenericSelector<Source>;
 /**
  * @internal
  */

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

@@ -10,13 +10,14 @@ import { Source, SourceArray, SourceObject, SourcePrimitive } from "../source/in
 import { Schema } from "../schema/index.js";
 import type { A } from "ts-toolbelt";
 import { FileSource } from "../source/file.js";
-import { RichText, RichTextOptions, RichTextSource } from "../source/richtext.js";
+import { AllRichTextOptions, RichTextSource } from "../source/richtext.js";
 import { ImageMetadata } from "../schema/image.js";
 import { ImageSelector } from "./image.js";
-export type Selector<T extends Source> = Source extends T ? GenericSelector<T> : T extends FileSource<infer M> ? M extends ImageMetadata ? ImageSelector : FileSelector<M> : T extends RichTextSource<infer O> ? RichText<O> : T extends SourceObject ? ObjectSelector<T> : T extends SourceArray ? ArraySelector<T> : T extends string ? StringSelector<T> : T extends number ? NumberSelector<T> : T extends boolean ? BooleanSelector<T> : T extends null ? PrimitiveSelector<null> : never;
+import { RichTextSelector } from "./richtext.js";
+export type Selector<T extends Source> = Source extends T ? GenericSelector<T> : T extends FileSource<infer M> ? M extends ImageMetadata ? ImageSelector : FileSelector<M> : T extends RichTextSource<infer O> ? RichTextSelector<O> : T extends SourceObject ? ObjectSelector<T> : T extends SourceArray ? ArraySelector<T> : T extends string ? StringSelector<T> : T extends number ? NumberSelector<T> : T extends boolean ? BooleanSelector<T> : T extends null ? PrimitiveSelector<null> : never;
 export type SelectorSource = SourcePrimitive | undefined | readonly SelectorSource[] | {
     [key: string]: SelectorSource;
-} | FileSource | RichTextSource<RichTextOptions> | GenericSelector<Source>;
+} | FileSource | RichTextSource<AllRichTextOptions> | GenericSelector<Source>;
 /**
  * @internal
  */

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

@@ -0,0 +1,3 @@
+import { GenericSelector } from "./index.js";
+import { RichTextOptions, RichTextSource } from "../source/richtext.js";
+export type RichTextSelector<O extends RichTextOptions> = GenericSelector<RichTextSource<O>>;

package/dist/declarations/src/source/future/remote.d.ts

@@ -1,11 +1,11 @@
 import { SourcePrimitive, VAL_EXTENSION, PhantomType } from "../index.js";
 import { FileSource } from "../file.js";
 import { I18nCompatibleSource, I18nSource } from "./i18n.js";
-import { AnyRichTextOptions, RichTextSource } from "../richtext.js";
+import { AllRichTextOptions, RichTextSource } from "../richtext.js";
 /**
  * Remote sources cannot include other remote sources.
  */
-export type RemoteCompatibleSource = SourcePrimitive | RemoteObject | RemoteArray | RichTextSource<AnyRichTextOptions> | FileSource | I18nSource<string[], I18nCompatibleSource>;
+export type RemoteCompatibleSource = SourcePrimitive | RemoteObject | RemoteArray | RichTextSource<AllRichTextOptions> | FileSource | I18nSource<string[], I18nCompatibleSource>;
 export type RemoteObject = {
     [key in string]: RemoteCompatibleSource;
 };

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

@@ -24,7 +24,7 @@ export type SourceObject = {
 export type SourceArray = readonly Source[];
 export type SourcePrimitive = string | number | boolean | null;
 export declare const VAL_EXTENSION: "_type";
-export declare function getValExtension(source: Source): false | "" | 0 | "file" | "remote" | "richtext" | "i18n" | null | undefined;
+export declare function getValExtension(source: Source): false | "" | 0 | "file" | "remote" | "i18n" | null | undefined;
 /**
  * A phantom type parameter is one that doesn't show up at runtime, but is checked statically (and only) at compile time.
  *

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

@@ -1,96 +1,102 @@
-import { VAL_EXTENSION } from "./index.js";
 import { LinkSource } from "./link.js";
 import { ImageSource } from "./image.js";
 import { ImageMetadata } from "../schema/image.js";
 import { FileSource } from "./file.js";
-export type RichTextOptions = {
-    headings?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[];
-    img?: boolean;
-    a?: boolean;
-    ul?: boolean;
-    ol?: boolean;
-    lineThrough?: boolean;
-    bold?: boolean;
-    italic?: boolean;
+export type RichTextOptions = Partial<{
+    style: Partial<{
+        bold: boolean;
+        italic: boolean;
+        lineThrough: boolean;
+    }>;
+    block: Partial<{
+        h1: boolean;
+        h2: boolean;
+        h3: boolean;
+        h4: boolean;
+        h5: boolean;
+        h6: boolean;
+        ul: boolean;
+        ol: boolean;
+    }>;
+    inline: Partial<{
+        a: boolean;
+        img: boolean;
+    }>;
+}>;
+export type AllRichTextOptions = {
+    style: {
+        bold: true;
+        italic: true;
+        lineThrough: true;
+    };
+    block: {
+        h1: true;
+        h2: true;
+        h3: true;
+        h4: true;
+        h5: true;
+        h6: true;
+        ul: true;
+        ol: true;
+    };
+    inline: {
+        a: true;
+        img: true;
+    };
 };
-export type AnyRichTextOptions = {
-    headings: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[];
-    img: true;
-    a: true;
-    ul: true;
-    ol: true;
-    lineThrough: true;
-    bold: true;
-    italic: true;
-};
-export type LineThrough<O extends RichTextOptions> = O["lineThrough"] extends true ? "line-through" : never;
-export type Italic<O extends RichTextOptions> = O["italic"] extends true ? "italic" : never;
-export type Bold<O extends RichTextOptions> = O["bold"] extends true ? "bold" : never;
-export type Classes<O extends RichTextOptions> = LineThrough<O> | Italic<O> | Bold<O>;
+export type LineThrough<O extends RichTextOptions> = NonNullable<O["style"]>["lineThrough"] extends true ? "line-through" : never;
+export type Italic<O extends RichTextOptions> = NonNullable<O["style"]>["italic"] extends true ? "italic" : never;
+export type Bold<O extends RichTextOptions> = NonNullable<O["style"]>["bold"] extends true ? "bold" : never;
+export type Styles<O extends RichTextOptions> = LineThrough<O> | Italic<O> | Bold<O>;
 export type ParagraphNode<O extends RichTextOptions> = {
     tag: "p";
-    children: (string | SpanNode<O> | BrNode | LinkNode<O> | ImageNode<O>)[];
+    children: (string | SpanNode<O> | BrNode | LinkNode<O> | ImageNode<O> | CustomInlineNode<O>)[];
 };
 export type BrNode = {
     tag: "br";
 };
 export type SpanNode<O extends RichTextOptions> = {
     tag: "span";
-    classes: Classes<O>[];
+    styles: Styles<O>[];
     children: [string];
 };
-type ImageTagNode = {
+export type ImageNode<O extends RichTextOptions> = NonNullable<O["inline"]>["img"] extends true ? {
     tag: "img";
-    src: string;
-    alt?: string;
-    height?: number;
-    width?: number;
-    mimeType?: string;
-};
-export type ImageNode<O extends RichTextOptions> = O["img"] extends true ? ImageTagNode : never;
+    src: ImageSource;
+} : never;
 type LinkTagNode<O extends RichTextOptions> = {
     tag: "a";
     href: string;
-    children: (string | SpanNode<O>)[];
+    children: (string | SpanNode<O> | ImageNode<O> | CustomInlineNode<O>)[];
 };
-export type LinkNode<O extends RichTextOptions> = O["a"] extends true ? LinkTagNode<O> : never;
-export type ListItemNode<O extends RichTextOptions> = O["ul"] | O["ol"] extends true ? {
+export type LinkNode<O extends RichTextOptions> = NonNullable<O["inline"]>["a"] extends true ? LinkTagNode<O> : never;
+type ListItemTagNode<O extends RichTextOptions> = {
     tag: "li";
-    children: (string | SpanNode<O> | LinkNode<O> | BrNode | UnorderedListNode<O> | OrderedListNode<O>)[];
-} : never;
-export type UnorderedListNode<O extends RichTextOptions> = O["ul"] extends true ? {
+    children: (ParagraphNode<O> | UnorderedListNode<O> | OrderedListNode<O>)[];
+};
+export type ListItemNode<O extends RichTextOptions> = NonNullable<O["block"]>["ul"] extends true ? ListItemTagNode<O> : never | NonNullable<O["block"]>["ol"] extends true ? ListItemTagNode<O> : never;
+export type UnorderedListNode<O extends RichTextOptions> = NonNullable<O["block"]>["ul"] extends true ? {
     tag: "ul";
-    dir?: "ltr" | "rtl";
     children: ListItemNode<O>[];
 } : never;
-export type OrderedListNode<O extends RichTextOptions> = O["ol"] extends true ? {
+export type OrderedListNode<O extends RichTextOptions> = NonNullable<O["block"]>["ol"] extends true ? {
     tag: "ol";
-    dir?: "ltr" | "rtl";
     children: ListItemNode<O>[];
 } : never;
-export type HeadingNode<O extends RichTextOptions> = O["headings"] extends ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[] ? {
-    tag: O["headings"][number];
-    children: (string | SpanNode<O>)[];
+export type HeadingTagOf<S extends keyof NonNullable<NonNullable<O["block"]>>, O extends RichTextOptions> = NonNullable<NonNullable<O["block"]>>[S] extends true ? {
+    tag: S;
+    children: (string | SpanNode<O> | CustomInlineNode<O> | LinkNode<O> | BrNode | ImageNode<O>)[];
 } : never;
-export type RichTextNode<O extends RichTextOptions> = string | RootNode<O> | ListItemNode<O> | BrNode | SpanNode<O> | LinkNode<O> | ImageNode<O>;
-export type RootNode<O extends RichTextOptions> = HeadingNode<O> | ParagraphNode<O> | BrNode | UnorderedListNode<O> | OrderedListNode<O>;
+export type HeadingNode<O extends RichTextOptions> = HeadingTagOf<"h1", O> | HeadingTagOf<"h2", O> | HeadingTagOf<"h3", O> | HeadingTagOf<"h4", O> | HeadingTagOf<"h5", O> | HeadingTagOf<"h6", O>;
+export type CustomInlineNode<O extends RichTextOptions> = never;
+export type CustomBlockNode<O extends RichTextOptions> = never;
+export type RichTextNode<O extends RichTextOptions> = string | BlockNode<O> | ListItemNode<O> | BrNode | SpanNode<O> | LinkNode<O> | ImageNode<O> | CustomInlineNode<O>;
+export type BlockNode<O extends RichTextOptions> = HeadingNode<O> | ParagraphNode<O> | UnorderedListNode<O> | OrderedListNode<O> | CustomBlockNode<O>;
 /**
- * RichTextSource is defined in ValModules
+ * RichText as defined in a ValModule
  **/
-export type RichTextSource<O extends RichTextOptions> = {
-    [VAL_EXTENSION]: "richtext";
-    templateStrings: string[];
-    exprs: ((O["img"] extends true ? ImageSource : never) | (O["a"] extends true ? LinkSource : never))[];
-};
-/**
- * RichText is accessible by users (after conversion via useVal / fetchVal)
- * Internally it is a Selector
- **/
-export type RichText<O extends RichTextOptions> = {
-    [VAL_EXTENSION]: "richtext";
-    children: RootNode<O>[];
-};
-export declare function richtext<O extends RichTextOptions>(templateStrings: TemplateStringsArray, ...nodes: (ImageSource | LinkSource)[]): RichTextSource<O>;
+export type RichTextSource<O extends RichTextOptions> = BlockNode<O>[];
+export declare function richtext<O extends RichTextOptions>(templateStrings: TemplateStringsArray, ...nodes: (ImageSource | LinkSource)[]): RichTextSource<{}>;
 export declare const RT_IMAGE_TAG = "rt_image";
 export type RTImageMetadata = ImageMetadata;
 export declare function image(ref: `/public/${string}`, metadata?: RTImageMetadata): FileSource<RTImageMetadata>;