@valbuild/core 0.18.0 → 0.20.0

package/src/schema/richtext.ts

@@ -1,98 +1,44 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { Schema, SerializedSchema } from ".";
-import { VAL_EXTENSION } from "../source";
-import { RichTextSource } from "../source/richtext";
+import { RichTextSource, RichTextOptions } from "../source/richtext";
 import { SourcePath } from "../val";
-import {
-  ValidationError,
-  ValidationErrors,
-} from "./validation/ValidationError";
+import { ValidationErrors } from "./validation/ValidationError";
 
-export type SerializedRichTextSchema = {
+export type SerializedRichTextSchema = RichTextOptions & {
   type: "richtext";
   opt: boolean;
 };
 
 export class RichTextSchema<
-  Src extends RichTextSource | null
+  O extends RichTextOptions,
+  Src extends RichTextSource<O> | null
 > extends Schema<Src> {
-  validate(path: SourcePath, src: Src): ValidationErrors {
-    if (this.opt && (src === null || src === undefined)) {
-      return false;
-    }
-    if (src === null || src === undefined) {
-      return {
-        [path]: [
-          { message: `Expected non-nullable got '${src}'` } as ValidationError,
-        ],
-      } as ValidationErrors;
-    }
-
-    if (typeof src !== "object" && !Array.isArray(src)) {
-      return {
-        [path]: [
-          {
-            message: `Expected 'object' (that is not of an array) or 'string', got '${typeof src}'`,
-            value: src,
-          } as ValidationError,
-        ],
-      } as ValidationErrors;
-    }
-
-    if (src[VAL_EXTENSION] !== "richtext") {
-      return {
-        [path]: [
-          {
-            message: `Expected _type key with value 'richtext' got '${src[VAL_EXTENSION]}'`,
-            value: src,
-          } as ValidationError,
-        ],
-      } as ValidationErrors;
-    }
-
-    if (src.type !== "root") {
-      return {
-        [path]: [
-          {
-            message: `Expected type key with value 'root' got '${src.type}'`,
-            value: src,
-          } as ValidationError,
-        ],
-      } as ValidationErrors;
-    }
-
-    if (typeof src.children !== "object" && !Array.isArray(src.children)) {
-      return {
-        [path]: [
-          {
-            message: `Expected children to be an array, but got '${src.type}'`,
-            value: src,
-          } as ValidationError,
-        ],
-      } as ValidationErrors;
-    }
+  constructor(readonly options: O, readonly opt: boolean = false) {
+    super();
+  }
 
-    return false;
+  validate(path: SourcePath, src: Src): ValidationErrors {
+    return false; //TODO
   }
+
   assert(src: Src): boolean {
-    // TODO:
-    return true;
+    return true; // TODO
   }
 
-  optional(): Schema<RichTextSource | null> {
-    return new RichTextSchema(true);
+  optional(): Schema<RichTextSource<O> | null> {
+    return new RichTextSchema(this.options, true);
   }
+
   serialize(): SerializedSchema {
     return {
       type: "richtext",
       opt: this.opt,
     };
   }
-  constructor(readonly opt: boolean = false) {
-    super();
-  }
 }
 
-export const richtext = (): Schema<RichTextSource> => {
-  return new RichTextSchema();
+export const richtext = <O extends RichTextOptions>(
+  options?: O
+): Schema<RichTextSource<O>> => {
+  return new RichTextSchema<O, RichTextSource<O>>(options ?? ({} as O));
 };

package/src/schema/string.ts

@@ -12,10 +12,15 @@ export type SerializedStringSchema = {
   type: "string";
   options?: StringOptions;
   opt: boolean;
+  raw: boolean;
 };
 
 export class StringSchema<Src extends string | null> extends Schema<Src> {
-  constructor(readonly options?: StringOptions, readonly opt: boolean = false) {
+  constructor(
+    readonly options?: StringOptions,
+    readonly opt: boolean = false,
+    private readonly isRaw: boolean = false
+  ) {
     super();
   }
 
@@ -40,8 +45,12 @@ export class StringSchema<Src extends string | null> extends Schema<Src> {
     return typeof src === "string";
   }
 
-  optional(): Schema<Src | null> {
-    return new StringSchema<Src | null>(this.options, true);
+  optional(): StringSchema<Src | null> {
+    return new StringSchema<Src | null>(this.options, true, this.isRaw);
+  }
+
+  raw(): StringSchema<Src> {
+    return new StringSchema<Src>(this.options, this.opt, true);
   }
 
   serialize(): SerializedSchema {
@@ -49,12 +58,13 @@ export class StringSchema<Src extends string | null> extends Schema<Src> {
       type: "string",
       options: this.options,
       opt: this.opt,
+      raw: this.isRaw,
     };
   }
 }
 
 export const string = <T extends string>(
   options?: StringOptions
-): Schema<T> => {
+): StringSchema<T> => {
   return new StringSchema(options);
 };

package/src/schema/validation.test.ts

@@ -254,9 +254,9 @@ const ValidationTestCases: {
   // richtext
   {
     description: "basic richtext",
-    input: richtextVal("test"),
+    input: richtextVal`test`,
     expected: false,
-    schema: richtext(),
+    schema: richtext({ bold: true }),
   },
   // TODO: more richtext cases
   // TODO: union

package/src/selector/future/index.ts

@@ -24,7 +24,11 @@ import {
   RemoteSource,
 } from "../../source/future/remote";
 import { FileSource } from "../../source/file";
-import { RichText, RichTextSource } from "../../source/richtext";
+import {
+  AnyRichTextOptions,
+  RichText,
+  RichTextSource,
+} from "../../source/richtext";
 
 /**
  * Selectors can be used to select parts of a Val module.
@@ -57,8 +61,8 @@ export type Selector<T extends Source> = Source extends T
     : GenericSelector<Source, "Could not determine remote source">
   : T extends FileSource
   ? FileSelector
-  : T extends RichTextSource
-  ? RichText
+  : T extends RichTextSource<infer O>
+  ? RichText<O>
   : T extends SourceObject
   ? ObjectSelector<T>
   : T extends SourceArray
@@ -83,7 +87,7 @@ export type SelectorSource =
   | I18nSource<readonly string[], I18nCompatibleSource>
   | RemoteSource<RemoteCompatibleSource>
   | FileSource
-  | RichTextSource
+  | RichTextSource<AnyRichTextOptions>
   | GenericSelector<Source>;
 
 /**

package/src/selector/index.ts

@@ -10,14 +10,14 @@ import { Source, SourceArray, SourceObject, SourcePrimitive } from "../source";
 import { Schema } from "../schema";
 import type { A } from "ts-toolbelt";
 import { FileSource } from "../source/file";
-import { RichText, RichTextSource } from "../source/richtext";
+import { RichText, RichTextOptions, RichTextSource } from "../source/richtext";
 
 export type Selector<T extends Source> = Source extends T
   ? GenericSelector<T>
   : T extends FileSource
   ? FileSelector
-  : T extends RichTextSource
-  ? RichText
+  : T extends RichTextSource<infer O>
+  ? RichText<O>
   : T extends SourceObject
   ? ObjectSelector<T>
   : T extends SourceArray
@@ -40,7 +40,7 @@ export type SelectorSource =
       [key: string]: SelectorSource;
     }
   | FileSource
-  | RichTextSource
+  | RichTextSource<RichTextOptions>
   | GenericSelector<Source>;
 
 /**

package/src/source/future/remote.ts

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

package/src/source/index.ts

@@ -1,7 +1,7 @@
 import { FileSource } from "./file";
 import { I18nSource, I18nCompatibleSource } from "./future/i18n";
 import { RemoteSource, RemoteCompatibleSource } from "./future/remote";
-import { RichTextSource } from "./richtext";
+import { RichTextOptions, RichTextSource } from "./richtext";
 
 export type Source =
   | SourcePrimitive
@@ -10,7 +10,7 @@ export type Source =
   | I18nSource<string[], I18nCompatibleSource>
   | RemoteSource<RemoteCompatibleSource>
   | FileSource
-  | RichTextSource;
+  | RichTextSource<RichTextOptions>;
 
 export type SourceObject = { [key in string]: Source } & {
   // TODO: update these restricted parameters:

package/src/source/richtext.test.ts

@@ -0,0 +1,178 @@
+import { file } from "../source/file";
+import { richtext } from "./richtext";
+
+//MD to HTML
+describe("richtext", () => {
+  test("basic h1", () => {
+    const r = richtext`# Title 1`;
+    expect(r.children).toStrictEqual([{ tag: "h1", children: ["Title 1"] }]);
+  });
+
+  test("basic complete", () => {
+    const r = richtext`# Title 1
+## Title 2
+
+Paragraph 1 2 3 4 5. Words *italic* **bold**
+`;
+    expect(r.children).toStrictEqual([
+      { tag: "h1", children: ["Title 1"] },
+      { tag: "h2", children: ["Title 2"] },
+      {
+        tag: "p",
+        children: [
+          "Paragraph 1 2 3 4 5. Words ",
+          { tag: "span", classes: ["italic"], children: ["italic"] },
+          " ",
+          { tag: "span", classes: ["bold"], children: ["bold"] },
+        ],
+      },
+    ]);
+  });
+
+  test.skip("strong and emphasis merged spans", () => {
+    // TODO: currently we do not merge
+    const r = richtext`Which classes?
+***All of them!***
+`;
+    expect(r.children).toStrictEqual([
+      {
+        tag: "p",
+        children: [
+          "Which classes?\n",
+          {
+            tag: "span",
+            classes: ["italic", "bold"],
+            children: ["All of them!"],
+          },
+        ],
+      },
+    ]);
+  });
+
+  test("line through", () => {
+    // TODO: currently we do not merge
+    const r = richtext`~~line through~~`;
+    expect(r.children).toStrictEqual([
+      {
+        tag: "p",
+        children: [
+          {
+            tag: "span",
+            classes: ["line-through"],
+            children: ["line through"],
+          },
+        ],
+      },
+    ]);
+  });
+
+  test("2 paragraphs", () => {
+    const r = richtext`# Title 1
+
+First paragraph
+
+Second paragraph
+`;
+    expect(r.children).toStrictEqual([
+      { tag: "h1", children: ["Title 1"] },
+      { tag: "p", children: ["First paragraph"] },
+      { tag: "p", children: ["Second paragraph"] },
+    ]);
+  });
+
+  test("lists", () => {
+    const r = richtext`# Title 1
+
+A paragraph
+
+A bullet list:
+- bullet 1
+- bullet 2
+
+A numbered list:
+1. number 1
+2. number 2
+
+A nested list:
+- bullet 1:
+    1. number 1.1
+    2. number 1.2
+- bullet 2:
+    - bullet 2.1
+    - bullet 2.2
+`;
+    expect(r.children).toStrictEqual([
+      { tag: "h1", children: ["Title 1"] },
+      { tag: "p", children: ["A paragraph"] },
+      { tag: "p", children: ["A bullet list:"] },
+      {
+        tag: "ul",
+        children: [
+          { tag: "li", children: ["bullet 1"] },
+          { tag: "li", children: ["bullet 2"] },
+        ],
+      },
+      { tag: "p", children: ["A numbered list:"] },
+      {
+        tag: "ol",
+        children: [
+          { tag: "li", children: ["number 1"] },
+          { tag: "li", children: ["number 2"] },
+        ],
+      },
+      { tag: "p", children: ["A nested list:"] },
+      {
+        tag: "ul",
+        children: [
+          {
+            tag: "li",
+            children: [
+              "bullet 1:",
+              {
+                tag: "ol",
+                children: [
+                  { tag: "li", children: ["number 1.1"] },
+                  { tag: "li", children: ["number 1.2"] },
+                ],
+              },
+            ],
+          },
+          {
+            tag: "li",
+            children: [
+              "bullet 2:",
+              {
+                tag: "ul",
+                children: [
+                  { tag: "li", children: ["bullet 2.1"] },
+                  { tag: "li", children: ["bullet 2.2"] },
+                ],
+              },
+            ],
+          },
+        ],
+      },
+    ]);
+  });
+
+  test("image", () => {
+    const r = richtext`# Title 1
+
+Below we have an image block:
+
+${file("/public/foo.png", {
+  width: 100,
+  height: 100,
+  sha256: "123",
+})}`;
+    expect(r.children).toStrictEqual([
+      { tag: "h1", children: ["Title 1"] },
+      { tag: "p", children: ["Below we have an image block:"] },
+      {
+        _ref: "/public/foo.png",
+        _type: "file",
+        metadata: { width: 100, height: 100, sha256: "123" },
+      },
+    ]);
+  });
+});