@valbuild/core 0.65.3 → 0.67.0

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

@@ -4,13 +4,11 @@ export type { InitVal, ValConfig, ValConstructor, ContentConstructor, } from "./
 export { Schema, type SerializedSchema, type SelectorOfSchema } from "./schema/index.js";
 export type { ImageMetadata } from "./schema/image.js";
 export type { FileMetadata } from "./schema/file.js";
-export type { LinkSource } from "./source/link.js";
 export type { ValModule, SerializedModule, InferValModuleType } from "./module.js";
 export type { SourceObject, SourcePrimitive, Source } from "./source/index.js";
 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 { 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";

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

@@ -19,6 +19,24 @@ export type InitSchema = {
     readonly number: typeof number;
     readonly union: typeof union;
     readonly richtext: typeof richtext;
+    /**
+     * Define a image source.
+     *
+     * Use c.image to create an image source.
+     *
+     * @example
+     * const schema = s.image();
+     * export default c.define("/example.val.ts", schema, c.image("/public/val/example.png", {
+     *  width: 100,
+     *  height: 100,
+     *  mimeType: "image/png",
+     *  hotspot: {
+     *    x: 0.5,
+     *    y: 0.5
+     *  }
+     * }));
+     *
+     */
     readonly image: typeof image;
     readonly literal: typeof literal;
     readonly keyOf: typeof keyOf;

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

@@ -2,16 +2,11 @@ import { define } from "./module.js";
 import { InitSchema } from "./initSchema.js";
 import { getValPath as getPath } from "./val/index.js";
 import { initFile } from "./source/file.js";
-import { richtext } from "./source/richtext.js";
-import { link } from "./source/link.js";
+import { initImage } from "./source/image.js";
 export type ContentConstructor = {
     define: typeof define;
     file: ReturnType<typeof initFile>;
-    rt: {
-        image: ReturnType<typeof initFile>;
-        link: typeof link;
-    };
-    richtext: typeof richtext;
+    image: ReturnType<typeof initImage>;
 };
 export type ValConstructor = {
     unstable_getPath: typeof getPath;

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

@@ -18,6 +18,7 @@ export type ImageMetadata = {
     width: number;
     height: number;
     mimeType: string;
+    alt?: string;
     hotspot?: {
         x: number;
         y: number;

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

@@ -11,10 +11,10 @@ import { Schema } from "../schema/index.js";
 import type { A } from "ts-toolbelt";
 import { FileSource } from "../source/file.js";
 import { AllRichTextOptions, RichTextSource } from "../source/richtext.js";
-import { ImageMetadata } from "../schema/image.js";
 import { ImageSelector } from "./image.js";
 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;
+import { ImageSource } from "../source/image.js";
+export type Selector<T extends Source> = Source extends T ? GenericSelector<T> : T extends ImageSource ? ImageSelector : T extends FileSource<infer M> ? 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<AllRichTextOptions> | GenericSelector<Source>;

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

@@ -1,7 +1,19 @@
+import { VAL_EXTENSION } from "./index.js";
+import { ValConfig } from "../initVal.js";
 import { ImageMetadata } from "../schema/image.js";
-import { FileSource } from "./file.js";
+import { FILE_REF_PROP, FILE_REF_SUBTYPE_TAG } from "./file.js";
 /**
  * A image source represents the path to a (local) image.
  *
  */
-export type ImageSource<Metadata extends ImageMetadata | undefined = ImageMetadata> = FileSource<Metadata>;
+export type ImageSource<Metadata extends ImageMetadata | undefined = ImageMetadata | undefined> = {
+    readonly [FILE_REF_PROP]: string;
+    readonly [VAL_EXTENSION]: "file";
+    readonly [FILE_REF_SUBTYPE_TAG]: "image";
+    readonly metadata?: Metadata;
+    readonly patch_id?: string;
+};
+export declare const initImage: (config?: ValConfig) => {
+    (ref: `${`/public/${string}`}/${string}`, metadata: ImageMetadata): ImageSource<ImageMetadata>;
+    (ref: `${`/public/${string}`}/${string}`, metadata?: undefined): ImageSource<undefined>;
+};

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

@@ -1,7 +1,4 @@
-import { LinkSource } from "./link.js";
 import { ImageSource } from "./image.js";
-import { ImageMetadata } from "../schema/image.js";
-import { FileSource } from "./file.js";
 export type RichTextOptions = Partial<{
     style: Partial<{
         bold: boolean;
@@ -103,8 +100,4 @@ export type BlockNode<O extends RichTextOptions> = HeadingNode<O> | ParagraphNod
  * RichText as defined in a ValModule
  **/
 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>;
 export {};

package/dist/{index-e38a9dcf.esm.js → index-062f9388.esm.js}

@@ -1,6 +1,4 @@
 import { _ as _unsupportedIterableToArray, a as _arrayLikeToArray, i as isErr, e as err, o as ok, b as isOk, c as _createForOfIteratorHelper } from './result-168dfc1d.esm.js';
-import * as marked from 'marked';
-import { VAL_EXTENSION as VAL_EXTENSION$1, FILE_REF_SUBTYPE_TAG as FILE_REF_SUBTYPE_TAG$1 } from '@valbuild/core';
 
 function _arrayWithHoles(r) {
   if (Array.isArray(r)) return r;
@@ -1057,7 +1055,7 @@ var ParserError = /*#__PURE__*/_createClass(function ParserError(message, span)
   this.message = message;
   this.span = span;
 });
-function parseTokens$1(inputTokens) {
+function parseTokens(inputTokens) {
   var tokens = inputTokens.slice();
   function slurpCall(first, isAnon) {
     var _tokens$, _tokens$2, _tokens$3, _tokens$7, _tokens$8, _args$slice$0$span;
@@ -1193,7 +1191,7 @@ function parse(input) {
     _tokenize2 = _slicedToArray(_tokenize, 2),
     tokens = _tokenize2[0];
     _tokenize2[1]; // TODO: we can use cursor to improve error messages / spans
-  return parseTokens$1(tokens);
+  return parseTokens(tokens);
 }
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
@@ -2260,7 +2258,7 @@ var RichTextSchema = /*#__PURE__*/function (_Schema) {
     }
   }]);
 }(Schema);
-var richtext$1 = function richtext(options) {
+var richtext = function richtext(options) {
   return new RichTextSchema(options !== null && options !== void 0 ? options : {});
 };
 
@@ -2431,7 +2429,7 @@ var ImageSchema = /*#__PURE__*/function (_Schema) {
     }
   }]);
 }(Schema);
-var image$1 = function image(options) {
+var image = function image(options) {
   return new ImageSchema(options);
 };
 
@@ -3399,8 +3397,8 @@ function initSchema() {
     number: number,
     union: union,
     // oneOf,
-    richtext: richtext$1,
-    image: image$1,
+    richtext: richtext,
+    image: image,
     literal: literal,
     keyOf: keyOf,
     record: record,
@@ -3410,257 +3408,61 @@ function initSchema() {
   };
 }
 
-var VAL_START_TAG_PREFIX = '<val value="';
-var VAL_START_TAG_SUFFIX = '">';
-var VAL_END_TAG = "</val>";
-function parseTokens(tokens, sourceNodes, cursor) {
-  var insideList = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
-  var children = [];
-  function merge(token, clazz) {
-    var parsedTokens = parseTokens(token.tokens ? token.tokens : [], sourceNodes, 0);
-    children.push({
-      tag: "span",
-      styles: [clazz].concat(parsedTokens.children.flatMap(function (child) {
-        return typeof child === "string" ? [] : child.styles;
-      })),
-      children: parsedTokens.children.flatMap(function (child) {
-        return typeof child === "string" ? child : child.children;
-      })
-    });
-  }
-  var _loop = function _loop() {
-      var token = tokens[cursor];
-      if (token.type === "heading") {
-        children.push({
-          tag: "h".concat(token.depth),
-          children: parseTokens(token.tokens ? token.tokens : [], sourceNodes, 0).children
-        });
-      } else if (token.type === "paragraph") {
-        children.push({
-          tag: "p",
-          children: parseTokens(token.tokens ? token.tokens : [], sourceNodes, 0).children
-        });
-      } else if (token.type === "strong") {
-        merge(token, "bold");
-      } else if (token.type === "em") {
-        merge(token, "italic");
-      } else if (token.type === "del") {
-        merge(token, "line-through");
-      } else if (token.type === "text") {
-        if ("tokens" in token && Array.isArray(token.tokens)) {
-          children.push.apply(children, _toConsumableArray(parseTokens(token.tokens, sourceNodes, cursor, insideList).children));
-        } else {
-          if (insideList && typeof token.raw === "string") {
-            var lines = token.raw.split("\n");
-            var tags = lines.flatMap(function (line, i) {
-              if (i === lines.length - 1) return [line];
-              if (i === lines.length - 1 && line === "") return [];
-              if (line === "") return [{
-                tag: "p",
-                children: [{
-                  tag: "br"
-                }]
-              }];
-              return [line, {
-                tag: "p",
-                children: [{
-                  tag: "br"
-                }]
-              }];
-            });
-            children.push.apply(children, _toConsumableArray(tags));
-          } else {
-            children.push(token.raw);
-          }
-        }
-      } else if (token.type === "list") {
-        children.push({
-          tag: token.ordered ? "ol" : "ul",
-          children: parseTokens(token.items, sourceNodes, 0).children
-        });
-      } else if (token.type === "list_item") {
-        children.push({
-          tag: "li",
-          children: [{
-            tag: "p",
-            children: parseTokens(token.tokens ? token.tokens : [], sourceNodes, 0, true).children
-          }]
-        });
-      } else if (token.type === "space") ; else if (token.type === "html") {
-        if (token.text === VAL_END_TAG) {
-          return {
-            v: {
-              children: children,
-              cursor: cursor
-            }
-          };
-        }
-        var suffixIndex = token.text.indexOf(VAL_START_TAG_SUFFIX);
-        if (token.text.startsWith(VAL_START_TAG_PREFIX) && suffixIndex > -1) {
-          var number = Number(token.text.slice(VAL_START_TAG_PREFIX.length, suffixIndex));
-          if (Number.isNaN(number)) {
-            throw Error("Illegal val intermediate node: ".concat(JSON.stringify(token)));
-          }
-          var _parseTokens = parseTokens(tokens.map(function (token) {
-              if (token.type === "link" || token.type === "list") {
-                return {
-                  type: "text",
-                  raw: token.raw,
-                  text: token.raw
-                };
-              }
-              return token;
-            }), sourceNodes, cursor + 1),
-            subChildren = _parseTokens.children,
-            subCursor = _parseTokens.cursor;
-          var sourceNode = sourceNodes[number];
-          if (sourceNode._type === "link") {
-            children.push({
-              tag: "a",
-              href: sourceNode.href,
-              children: subChildren
-            });
-          } else if (sourceNode._type === "file") {
-            // @ts-expect-error We are transitioning from markdown to structured objects, with structured objects we no longer want c.rt.image
-            delete sourceNode[FILE_REF_SUBTYPE_TAG$1];
-            children.push({
-              tag: "img",
-              src: sourceNode
-            });
-          }
-          cursor = subCursor;
-        }
-        var br_html_regex = /<br\s*\/?>/gi; // matches <br>, <br/>, <br />; case insensitive
-        if (token.text.trim().match(br_html_regex)) {
-          var _tokens;
-          children.push({
-            tag: "p",
-            children: [{
-              tag: "br"
-            }]
-          });
-          if (((_tokens = tokens[cursor + 1]) === null || _tokens === void 0 ? void 0 : _tokens.raw.trim()) === "") {
-            // if next token is a new line or white-spaces, skip it
-            // this typically means we have a <br> AND a new line, which, semantically, is just a <br>
-            cursor++;
-          }
-        }
-      } else if (token.type === "link") {
-        if (token.raw === token.href) {
-          // avoid auto-linking (provided by github flavoured markdown, but we want strikethrough so keep it enabled)
-          children.push(token.raw);
-        } else {
-          children.push({
-            tag: "a",
-            href: token.href,
-            children: parseTokens(token.tokens ? token.tokens : [], sourceNodes, 0).children
-          });
-        }
-      } else if (token.type === "br") {
-        children.push({
-          tag: "p",
-          children: [{
-            tag: "br"
-          }]
-        });
-      } else {
-        console.error("Could not parse markdown: unsupported token type: ".concat(token.type, ". Found: ").concat(token.raw));
-      }
-      cursor++;
-    },
-    _ret;
-  while (cursor < tokens.length) {
-    _ret = _loop();
-    if (_ret) return _ret.v;
-  }
-  return {
-    children: children,
-    cursor: cursor
-  };
-}
-function parseRichTextSource(_ref) {
-  var templateStrings = _ref.templateStrings,
-    nodes = _ref.exprs;
-  // TODO: validate that templateStrings does not contain VAL_NODE_PREFIX
-  var inputText = templateStrings.flatMap(function (templateString, i) {
-    var node = nodes[i];
-    if (node) {
-      if (node[VAL_EXTENSION$1] === "link") {
-        return templateString.concat("".concat(VAL_START_TAG_PREFIX).concat(i).concat(VAL_START_TAG_SUFFIX).concat(node.children[0]).concat(VAL_END_TAG));
-      } else {
-        return templateString.concat("".concat(VAL_START_TAG_PREFIX).concat(i).concat(VAL_START_TAG_SUFFIX).concat(VAL_END_TAG));
-      }
-    }
-    return templateString;
-  }).join("");
-  var tokenList = marked.lexer(inputText, {
-    gfm: true
-  });
-  var _parseTokens2 = parseTokens(tokenList, nodes, 0),
-    children = _parseTokens2.children,
-    cursor = _parseTokens2.cursor;
-  if (cursor !== tokenList.length) {
-    throw Error("Unexpectedly terminated markdown parsing. Possible reason: unclosed html tag?");
-  }
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  children.markdownish = true; // Markdown is an intermediate format - we are planning on replacing it with a structured object format
-  return children;
-}
-
-//#region Classes
-
-//#region Paragraph
-
-//#region Break
-
-//#region Span
-
-//#region Image
-
-//#region Link
-
-//#region List
-
-//#region Heading
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-
-// export type CustomInlineNode<O extends RichTextOptions> = NonNullable<
-//   NonNullable<O["inline"]>["custom"]
-// >[keyof NonNullable<NonNullable<O["inline"]>["custom"]>] extends Schema<
-//   infer Src
-// >
-//   ? ReplaceRawStringWithString<Src>
-//   : never;
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+/**
+ * A image source represents the path to a (local) image.
+ *
+ */
 
-//#region Block and Inline nodes:
+var initImage = function initImage(config) {
+  var _config$files$directo, _config$files;
+  (_config$files$directo = config === null || config === void 0 || (_config$files = config.files) === null || _config$files === void 0 ? void 0 : _config$files.directory) !== null && _config$files$directo !== void 0 ? _config$files$directo : "/public/val";
 
-//#region Main types
+  /**
+   * Define the source of an image file.
+   *
+   * @example
+   * c.image("/public/val/example.png", {
+   *   width: 944,
+   *   height: 944,
+   *   mimeType: "image/png",
+   *})
+   *
+   * @param ref /public/val/example.png
+   * @param metadata Image metadata: width, height, mimeType and optionally a hotspot.
+   */
 
-/**
- * RichText as defined in a ValModule
- **/
+  /**
+   * Define the source of an image file.
+   *
+   * NOTE: this will **not** validate since metadata has not been defined.
+   *
+   * Run `npx -p @valbuild/cli val validate --fix` to automatically add metadata.
+   *
+   * @example
+   * c.image("/public/val/example.png")
+   *
+   * @param ref /public/val/example.png
+   * @param metadata Image metadata: width, height, mimeType and optionally a hotspot.
+   */
 
-function richtext(templateStrings) {
-  for (var _len = arguments.length, nodes = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-    nodes[_key - 1] = arguments[_key];
+  /**
+   * Define the source of an image file.
+   *
+   * @example
+   * c.image("/public/val/example.png", {
+   *   width: 944,
+   *   height: 944,
+   *   mimeType: "image/png",
+   *})
+   *
+   * @param ref /public/val/example.png
+   * @param metadata Image metadata: width, height, mimeType and optionally a hotspot.
+   */
+  function image(ref, metadata) {
+    return _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, FILE_REF_PROP, ref), VAL_EXTENSION, "file"), FILE_REF_SUBTYPE_TAG, "image"), "metadata", metadata);
   }
-  return parseRichTextSource({
-    templateStrings: templateStrings,
-    exprs: nodes
-    // eslint-disable-next-line @typescript-eslint/ban-types
-  });
-}
-var RT_IMAGE_TAG = "rt_image";
-function image(ref, metadata) {
-  return _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, FILE_REF_PROP, ref), FILE_REF_SUBTYPE_TAG, RT_IMAGE_TAG), VAL_EXTENSION, "file"), "metadata", metadata);
-}
-
-function link(text, _ref) {
-  var href = _ref.href;
-  return _defineProperty(_defineProperty(_defineProperty({}, VAL_EXTENSION, "link"), "href", href), "children", [text]);
-}
+  return image;
+};
 
 /* eslint-disable @typescript-eslint/ban-types */
 // import { i18n, I18n } from "./source/future/i18n";
@@ -3701,11 +3503,7 @@ var initVal = function initVal(config) {
       define: define,
       // remote,
       file: initFile(config),
-      richtext: richtext,
-      rt: {
-        image: image,
-        link: link
-      }
+      image: initImage(config)
     },
     s: s,
     config: config
@@ -5187,4 +4985,4 @@ function tryJsonParse(str) {
   }
 }
 
-export { ArraySchema as A, BooleanSchema as B, Call as C, DateSchema as D, Expr as E, FATAL_ERROR_TYPES as F, GenericSelector as G, Internal as I, KeyOfSchema as K, LiteralSchema as L, ModuleFilePathSep as M, NilSym as N, ObjectSchema as O, PatchError as P, RT_IMAGE_TAG as R, StringLiteral as S, UnionSchema as U, VAL_EXTENSION as V, _typeof as _, _slicedToArray as a, _createClass as b, _classCallCheck as c, _toConsumableArray as d, StringTemplate as e, Sym as f, evaluate as g, initVal as h, index as i, Schema as j, FILE_REF_PROP as k, FILE_REF_SUBTYPE_TAG as l, modules as m, derefPatch as n, RecordSchema as o, parse as p, StringSchema as q, NumberSchema as r, splitModuleFilePathAndModulePath as s, ImageSchema as t, FileSchema as u, RichTextSchema as v, deserializeSchema as w };
+export { ArraySchema as A, BooleanSchema as B, Call as C, DateSchema as D, Expr as E, FATAL_ERROR_TYPES as F, GenericSelector as G, Internal as I, KeyOfSchema as K, LiteralSchema as L, ModuleFilePathSep as M, NilSym as N, ObjectSchema as O, PatchError as P, RecordSchema as R, StringLiteral as S, UnionSchema as U, VAL_EXTENSION as V, _typeof as _, _slicedToArray as a, _createClass as b, _classCallCheck as c, _toConsumableArray as d, StringTemplate as e, Sym as f, evaluate as g, initVal as h, index as i, Schema as j, FILE_REF_PROP as k, FILE_REF_SUBTYPE_TAG as l, modules as m, derefPatch as n, StringSchema as o, parse as p, NumberSchema as q, ImageSchema as r, splitModuleFilePathAndModulePath as s, FileSchema as t, RichTextSchema as u, deserializeSchema as v };