@valbuild/core 0.13.1 → 0.13.4

package/src/schema/richtext.ts

@@ -1,7 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { Schema, SerializedSchema } from ".";
-import { content } from "../module";
-import { VAL_EXTENSION } from "../source";
+import { RichTextSource } from "../source/richtext";
 import { SourcePath } from "../val";
 
 export type SerializedRichTextSchema = {
@@ -9,89 +8,9 @@ export type SerializedRichTextSchema = {
   opt: boolean;
 };
 
-type Node = {
-  version: 1;
-};
-
-type NodeType = Node & {
-  format: FormatType;
-  direction: DirectionType;
-  indent: number;
-};
-
-type FormatType =
-  | "left"
-  | "start"
-  | "center"
-  | "right"
-  | "end"
-  | "justify"
-  | "";
-type DirectionType = "ltr" | "rtl" | null;
-
-export type TextNode = Node & {
-  format: FormatType | number;
-  detail: number;
-  mode: "normal" | "code" | "quote";
-  style: string;
-  text: string;
-  type: "text";
-  direction?: DirectionType;
-  indent?: number;
-};
-
-export type ImageNode = Node & {
-  altText: string;
-  height: number;
-  width: number;
-  maxWidth: number;
-  src: string;
-  type: "image";
-};
-
-export type ParagraphNode<VN = TextNode> = NodeType & {
-  children: (TextNode | VN)[];
-  type: "paragraph";
-};
-
-export type HeadingNode<HT extends HeadingTags = HeadingTags> = NodeType & {
-  children: TextNode[];
-  type: "heading";
-  tag: HT;
-};
-
-export type ListItemNode<VN = TextNode> = NodeType & {
-  children: (TextNode | VN)[];
-  type: "listitem";
-  value: number;
-  checked?: boolean;
-};
-
-export type ListNode<VN = TextNode> = NodeType & {
-  children: ListItemNode<VN>[];
-  type: "list";
-  tag: "ol" | "ul";
-  listType: "number" | "bullet" | "check";
-  start?: number;
-};
-
-type HeadingTags = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
-export type RootNode<HT extends HeadingTags, VN> = Node & {
-  children: (HeadingNode<HT> | ParagraphNode<VN> | ListNode<VN>)[];
-  type: "root";
-  format: FormatType;
-  direction: DirectionType;
-  indent: number;
-};
-
-type ValNode = ImageNode;
-
-export type RichText<
-  HT extends HeadingTags = HeadingTags,
-  VN extends TextNode | ValNode = TextNode
-> = RootNode<HT, VN>;
-
-export class RichTextSchema<Src extends RichText | null> extends Schema<Src> {
+export class RichTextSchema<
+  Src extends RichTextSource | null
+> extends Schema<Src> {
   validate(src: Src): false | Record<SourcePath, string[]> {
     throw new Error("Method not implemented.");
   }
@@ -100,7 +19,7 @@ export class RichTextSchema<Src extends RichText | null> extends Schema<Src> {
     return true;
   }
 
-  optional(): Schema<RichText<HeadingTags, TextNode> | null> {
+  optional(): Schema<RichTextSource | null> {
     return new RichTextSchema(true);
   }
   serialize(): SerializedSchema {
@@ -114,304 +33,6 @@ export class RichTextSchema<Src extends RichText | null> extends Schema<Src> {
   }
 }
 
-export const richtext = (): Schema<RichText> => {
+export const richtext = (): Schema<RichTextSource> => {
   return new RichTextSchema();
 };
-
-{
-  const a = content("/test/richtext1", richtext(), {
-    children: [
-      {
-        children: [
-          {
-            detail: 0,
-            format: 0,
-            mode: "normal",
-            style: "",
-            text: "Heading 1",
-            type: "text",
-            version: 1,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "heading",
-        version: 1,
-        tag: "h1",
-      },
-      {
-        children: [
-          {
-            detail: 0,
-            format: 0,
-            mode: "normal",
-            style: "",
-            text: "Heading 2",
-            type: "text",
-            version: 1,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "heading",
-        version: 1,
-        tag: "h2",
-      },
-      {
-        children: [],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [
-          {
-            detail: 0,
-            format: 0,
-            mode: "normal",
-            style: "",
-            text: "Normal",
-            type: "text",
-            version: 1,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [
-          {
-            detail: 0,
-            format: 0,
-            mode: "normal",
-            style: "font-size: 20px;",
-            text: "Normal Font size 20",
-            type: "text",
-            version: 1,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [
-          {
-            detail: 0,
-            format: 0,
-            mode: "normal",
-            style: "font-family: serif;",
-            text: "Normal font type serif",
-            type: "text",
-            version: 1,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [
-          {
-            detail: 0,
-            format: 1,
-            mode: "normal",
-            style: "font-family: serif;",
-            text: "Serif and bold",
-            type: "text",
-            version: 1,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [
-          {
-            detail: 0,
-            format: 2,
-            mode: "normal",
-            style: "",
-            text: "Arial and italic",
-            type: "text",
-            version: 1,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [],
-        direction: null,
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [
-          {
-            children: [
-              {
-                detail: 0,
-                format: 0,
-                mode: "normal",
-                style: "",
-                text: "Num list 1",
-                type: "text",
-                version: 1,
-              },
-            ],
-            direction: "ltr",
-            format: "",
-            indent: 0,
-            type: "listitem",
-            version: 1,
-            value: 1,
-          },
-          {
-            children: [
-              {
-                detail: 0,
-                format: 0,
-                mode: "normal",
-                style: "",
-                text: "Num list 2",
-                type: "text",
-                version: 1,
-              },
-              // TODO: image
-              // {
-              //   altText: "",
-              //   height: 0,
-              //   maxWidth: 0,
-              //   src: "https://picsum.photos/id/237/200/300",
-              //   type: "image",
-              //   version: 1,
-              //   width: 0,
-              // },
-            ],
-            direction: "ltr",
-            format: "",
-            indent: 0,
-            type: "listitem",
-            version: 1,
-            value: 2,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "list",
-        version: 1,
-        listType: "number",
-        start: 1,
-        tag: "ol",
-      },
-      {
-        children: [],
-        direction: null,
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [
-          {
-            children: [
-              {
-                detail: 0,
-                format: 0,
-                mode: "normal",
-                style: "",
-                text: "Bullet list 1",
-                type: "text",
-                version: 1,
-              },
-            ],
-            direction: "ltr",
-            format: "",
-            indent: 0,
-            type: "listitem",
-            version: 1,
-            value: 1,
-          },
-          {
-            children: [
-              {
-                detail: 0,
-                format: 0,
-                mode: "normal",
-                style: "",
-                text: "Bullet list 2",
-                type: "text",
-                version: 1,
-              },
-            ],
-            direction: "ltr",
-            format: "",
-            indent: 0,
-            type: "listitem",
-            version: 1,
-            value: 2,
-          },
-        ],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "list",
-        version: 1,
-        listType: "bullet",
-        start: 1,
-        tag: "ul",
-      },
-      {
-        children: [],
-        direction: null,
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [],
-        direction: "ltr",
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-      {
-        children: [],
-        direction: null,
-        format: "",
-        indent: 0,
-        type: "paragraph",
-        version: 1,
-      },
-    ],
-    direction: "ltr",
-    format: "",
-    indent: 0,
-    type: "root",
-    version: 1,
-  });
-}

package/src/selector/index.ts

@@ -16,6 +16,7 @@ import { A } from "ts-toolbelt";
 import { I18nSource, I18nCompatibleSource } from "../source/i18n";
 import { RemoteCompatibleSource, RemoteSource } from "../source/remote";
 import { FileSource } from "../source/file";
+import { RichText, RichTextSource } from "../source/richtext";
 
 /**
  * Selectors can be used to select parts of a Val module.
@@ -48,6 +49,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 SourceObject
   ? ObjectSelector<T>
   : T extends SourceArray
@@ -72,6 +75,7 @@ export type SelectorSource =
   | I18nSource<readonly string[], I18nCompatibleSource>
   | RemoteSource<RemoteCompatibleSource>
   | FileSource
+  | RichTextSource
   | GenericSelector<Source>;
 
 /**

package/src/source/index.ts

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

package/src/source/remote.ts

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

package/src/source/richtext.ts

@@ -0,0 +1,116 @@
+import { VAL_EXTENSION } from ".";
+import { SourcePath } from "../val";
+
+type Node = {
+  version?: 1;
+};
+
+type NodeType = Node & {
+  format?: FormatType;
+  direction?: DirectionType;
+  indent?: number;
+};
+
+type FormatType =
+  | "left"
+  | "start"
+  | "center"
+  | "right"
+  | "end"
+  | "justify"
+  | "";
+type DirectionType = "ltr" | "rtl" | null;
+
+export type TextNode = Node & {
+  type: "text";
+  format?: FormatType | number;
+  detail?: number;
+  mode?: "normal" | "code" | "quote";
+  style?: string;
+  text: string;
+  direction?: DirectionType;
+  indent?: number;
+};
+
+export type ParagraphNode<VN = TextNode> = NodeType & {
+  children: (TextNode | VN)[];
+  type: "paragraph";
+};
+
+export type HeadingNode<HT extends HeadingTags = HeadingTags> = NodeType & {
+  children: TextNode[];
+  type: "heading";
+  tag: HT;
+};
+
+export type ListItemNode<VN = TextNode> = NodeType & {
+  children: (TextNode | VN)[];
+  type: "listitem";
+  value: number;
+  checked?: boolean;
+};
+
+export type ListNode<VN = TextNode> = NodeType & {
+  children: ListItemNode<VN>[];
+  type: "list";
+  tag: "ol" | "ul";
+  listType: "number" | "bullet" | "check";
+  start?: number;
+};
+
+type HeadingTags = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+export type RootNode<HT extends HeadingTags, VN> = Node & {
+  children: (HeadingNode<HT> | ParagraphNode<VN> | ListNode<VN>)[];
+  type?: "root";
+  format?: FormatType;
+  direction?: DirectionType;
+  indent?: number;
+};
+
+const brand = Symbol("richtext");
+export type RichText<
+  HT extends HeadingTags = HeadingTags,
+  VN extends TextNode = TextNode
+> = RootNode<HT, VN> & {
+  [brand]: "richtext";
+  valPath: SourcePath;
+};
+
+export type RichTextSource = RichText & {
+  readonly [VAL_EXTENSION]: "richtext";
+};
+
+export function richtext(
+  data: RootNode<HeadingTags, TextNode> | string
+): RichTextSource {
+  if (typeof data === "string") {
+    return {
+      [VAL_EXTENSION]: "richtext",
+      type: "root",
+      children: [
+        {
+          type: "paragraph",
+          children: [
+            {
+              type: "text",
+              text: data,
+            },
+          ],
+        },
+      ],
+    } as RichTextSource;
+  }
+  return {
+    ...data,
+    [VAL_EXTENSION]: "richtext",
+  } as RichTextSource;
+}
+
+export function isRichText(obj: unknown): obj is RichTextSource {
+  return (
+    typeof obj === "object" &&
+    obj !== null &&
+    VAL_EXTENSION in obj &&
+    obj[VAL_EXTENSION] === "richtext"
+  );
+}

package/src/val/index.ts

@@ -52,6 +52,16 @@ export type Val<T extends Json> = Json extends T
   ? PrimitiveVal<T>
   : never;
 
+export function isVal<T extends Json>(val: unknown): val is Val<T> {
+  return (
+    typeof val === "object" &&
+    val !== null &&
+    val !== undefined &&
+    Path in val &&
+    "val" in val
+  );
+}
+
 declare const brand: unique symbol;
 /**
  * The path of the source value.