@valbuild/core 0.111.0 → 0.120.0

package/CHANGELOG.md

@@ -0,0 +1,97 @@
+# @valbuild/core
+
+## 0.120.0
+
+### Minor Changes
+
+- [#589](https://github.com/valbuild/val/pull/589) [`c2d3c0e`](https://github.com/valbuild/val/commit/c2d3c0e6c2010c0a94c725d9dbaa618998773e8a) Thanks [@freekh](https://github.com/freekh)! - **Breaking:** `s.richtext()` options are flat.
+
+  The `style`, `block` and `inline` groups are gone — every option is a key of its
+  own. The names are unchanged, so updating a schema is only a matter of removing
+  the wrappers:
+
+  ```ts
+  // before
+  s.richtext({
+    style: { bold: true, italic: true },
+    block: { h1: true, ul: true },
+    inline: { a: true, img: s.image() },
+  });
+
+  // after
+  s.richtext({
+    bold: true,
+    italic: true,
+    h1: true,
+    ul: true,
+    a: true,
+    img: s.image(),
+  });
+  ```
+
+  The groups never carried any meaning the option names did not already have, and
+  they cost something real: an option name and its `ValRichText` theme key were
+  spelled differently (`block.h1` vs `theme.h1`), so the type that keeps a theme
+  exhaustive had to restate all thirteen options by hand. It is now a mapped type
+  over the options themselves — which also fixes an inconsistency in it: enabling
+  links with a schema (`a: s.route()`) rather than `a: true` now requires an `a`
+  key in the theme, the way `img` always has.
+
+  `ValRichText` themes were already flat and are unchanged. The serialized schema
+  that the server sends the Studio is flat too, so a project must not mix
+  `@valbuild/*` versions across this release.
+
+## 0.117.0
+
+### Patch Changes
+
+- [#581](https://github.com/valbuild/val/pull/581) [`d94a40f`](https://github.com/valbuild/val/commit/d94a40f8bd11027636d183e293aced820b6f341f) Thanks [@freekh](https://github.com/freekh)! - Images no longer show a validation warning in the editor when nothing is wrong
+  with them.
+
+  Every `s.image()` carrying width, height or a mime type used to be marked in VS
+  Code with "Found image metadata, but it could not be validated", whether or not
+  the metadata was correct — so the warning sat on every image in the project and
+  never went away, not even after applying its own quick fix.
+
+  That message was never a finding. `@valbuild/core` cannot read files, so it
+  cannot answer whether stored dimensions match the image, and it hands the
+  question on as an `image:check-metadata` fix instead. `val validate` has always
+  resolved that by reading the file and comparing; the language server now does
+  the same, and reports only what actually disagrees:
+
+  ```
+  Image width is incorrect! Found: 800. Expected: 944
+  ```
+
+  An image whose metadata is right gets nothing. A missing `width`, `height` or
+  `mimeType` is reported, as is a stale one, with the quick fix still offered. A
+  file that is not on disk is still reported as a missing file rather than as a
+  metadata problem.
+
+  The four messages involved say what they mean now, in the editor and in
+  `val validate` alike:
+
+  - "Image metadata has not been checked against the file." (was "Found image
+    metadata, but it could not be validated. An image must have a width (positive
+    number), a height (positive number) and a mime type." — which described a
+    check that never ran)
+  - "Image metadata is missing: width, height and mimeType." (was "Could not
+    validate Image metadata.")
+  - "File mimeType has not been checked against the file." (was "Found mimeType,
+    but it could not be validated.")
+  - "File metadata is missing: mimeType." (was "Missing File mimeType.")
+
+  Also fixes an `s.file()` whose `mimeType` is missing: it reported "Mime type and
+  file extension not matching. Mime type is 'undefined'" with no fix attached, so
+  no quick fix was offered and the `file:add-metadata` case was unreachable. It
+  now reports the missing mime type and offers to add it.
+
+- [#579](https://github.com/valbuild/val/pull/579) [`b2812ae`](https://github.com/valbuild/val/commit/b2812ae4ee03e005ecead3365f49c625e536f94d) Thanks [@freekh](https://github.com/freekh)! - Every release now ships a changelog. Each package's `CHANGELOG.md` records what
+  changed under the version that shipped it — with a link to the pull request, the
+  commit and the author — and the same entry becomes the body of the GitHub
+  Release for the tag. The file is included in the npm tarball, so it is also
+  readable from an installed copy.
+
+  Up to now those changelogs were generated empty, and the GitHub Releases with
+  them, so there was no record of what any given version contained. Releases from
+  this one on have one; earlier versions stay blank.

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

@@ -31,7 +31,7 @@ import { ModulePath, SourcePath, getValPath, isVal } from "./val/index.js";
 import { createValPathOfItem } from "./selector/SelectorProxy.js";
 import { Operation } from "./patch/index.js";
 import { initSchema } from "./initSchema.js";
-import { getMimeType, mimeTypeToFileExt, filenameToMimeType } from "./mimeType/index.js";
+import { getMimeType, mimeTypeToFileExt, filenameToMimeType, mimeTypeMatchesAccept } from "./mimeType/index.js";
 import { type ImageMetadata } from "./schema/image.js";
 import { type FileMetadata } from "./schema/file.js";
 import { isJson, getJsonImport, resolveJsonValues } from "./source/json.js";
@@ -114,6 +114,7 @@ declare const Internal: {
     getMimeType: typeof getMimeType;
     mimeTypeToFileExt: typeof mimeTypeToFileExt;
     filenameToMimeType: typeof filenameToMimeType;
+    mimeTypeMatchesAccept: typeof mimeTypeMatchesAccept;
     EXT_TO_MIME_TYPES: Record<string, string>;
     MIME_TYPES_TO_EXT: {
         [k: string]: string;

package/dist/declarations/src/mimeType/convertMimeType.d.ts

@@ -1,3 +1,17 @@
 export declare function getMimeType(base64Url: string): string | undefined;
 export declare function mimeTypeToFileExt(mimeType: string): string;
 export declare function filenameToMimeType(filename: string): string | undefined;
+/**
+ * Whether `mimeType` satisfies an `accept` string.
+ *
+ * `accept` is the HTML file-input syntax: a comma-separated list of exact mime
+ * types (`image/png`), type wildcards (`image` followed by `/` and a star) or
+ * the catch-all star-slash-star.
+ *
+ * This lived in three places - `ImageSchema`, `FileSchema` and the media
+ * branch of `RecordSchema` - which is how the third copy grew a redundant
+ * `image` wildcard case that the general wildcard branch already covered.
+ * Anything that has to decide whether an `accept` is satisfied, validation and
+ * editor tooling alike, should call this.
+ */
+export declare function mimeTypeMatchesAccept(mimeType: string, accept: string): boolean;

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

@@ -15,7 +15,7 @@ export type SerializedRichTextSchema = {
     /** Set when this schema declares a `preview`. The closure itself cannot serialize. */
     preview?: true;
     opt: boolean;
-    options?: SerializedRichTextOptions & ValidationOptions;
+    options?: SerializedRichTextOptions;
     customValidate?: boolean;
     readonly?: boolean;
     hidden?: boolean;

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

@@ -3,71 +3,60 @@ import { RouteSchema, SerializedRouteSchema } from "../schema/route.js";
 import { StringSchema, SerializedStringSchema } from "../schema/string.js";
 import { ImageSource } from "./media.js";
 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 | RouteSchema<string> | StringSchema<string>;
-        img: boolean | ImageSchema<ImageSource>;
-    }>;
+    bold: boolean;
+    italic: boolean;
+    lineThrough: boolean;
+    h1: boolean;
+    h2: boolean;
+    h3: boolean;
+    h4: boolean;
+    h5: boolean;
+    h6: boolean;
+    ul: boolean;
+    ol: boolean;
+    a: boolean | RouteSchema<string> | StringSchema<string>;
+    img: boolean | ImageSchema<ImageSource>;
 }>;
 export type SerializedRichTextOptions = 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 | SerializedRouteSchema | SerializedStringSchema;
-        img: boolean | SerializedImageSchema;
-    }>;
+    /**
+     * `.maxLength()` / `.minLength()` are not authored in the options argument,
+     * but they serialize into the same object - so the wire type has to name
+     * them, or a parser that strips unknown keys drops them in transit.
+     */
+    maxLength: number;
+    minLength: number;
+    bold: boolean;
+    italic: boolean;
+    lineThrough: boolean;
+    h1: boolean;
+    h2: boolean;
+    h3: boolean;
+    h4: boolean;
+    h5: boolean;
+    h6: boolean;
+    ul: boolean;
+    ol: boolean;
+    a: boolean | SerializedRouteSchema | SerializedStringSchema;
+    img: boolean | SerializedImageSchema;
 }>;
 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;
-    };
+    bold: true;
+    italic: true;
+    lineThrough: true;
+    h1: true;
+    h2: true;
+    h3: true;
+    h4: true;
+    h5: true;
+    h6: true;
+    ul: true;
+    ol: true;
+    a: true;
+    img: true;
 };
-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 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 Styles<O extends RichTextOptions> = LineThrough<O> | Italic<O> | Bold<O>;
 export type GenericRichTextSourceNode = {
     tag: string;
@@ -88,10 +77,10 @@ export type SpanNode<O extends RichTextOptions> = {
     styles: Styles<O>[];
     children: [string];
 };
-export type ImageNode<O extends RichTextOptions> = NonNullable<O["inline"]>["img"] extends true ? {
+export type ImageNode<O extends RichTextOptions> = O["img"] extends true ? {
     tag: "img";
     src: ImageSource;
-} : NonNullable<O["inline"]>["img"] extends ImageSchema<infer Src> ? Src extends ImageSource ? {
+} : O["img"] extends ImageSchema<infer Src> ? Src extends ImageSource ? {
     tag: "img";
     src: Src;
 } : never : never;
@@ -100,21 +89,22 @@ type LinkTagNode<O extends RichTextOptions> = {
     href: string;
     children: (string | SpanNode<O> | ImageNode<O> | CustomInlineNode<O>)[];
 };
-export type LinkNode<O extends RichTextOptions> = NonNullable<O["inline"]>["a"] extends true ? LinkTagNode<O> : NonNullable<O["inline"]>["a"] extends RouteSchema<string> | StringSchema<string> ? LinkTagNode<O> : never;
+export type LinkNode<O extends RichTextOptions> = O["a"] extends true ? LinkTagNode<O> : O["a"] extends RouteSchema<string> | StringSchema<string> ? LinkTagNode<O> : never;
 type ListItemTagNode<O extends RichTextOptions> = {
     tag: "li";
     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 ? {
+export type ListItemNode<O extends RichTextOptions> = O["ul"] extends true ? ListItemTagNode<O> : O["ol"] extends true ? ListItemTagNode<O> : never;
+export type UnorderedListNode<O extends RichTextOptions> = O["ul"] extends true ? {
     tag: "ul";
     children: ListItemNode<O>[];
 } : never;
-export type OrderedListNode<O extends RichTextOptions> = NonNullable<O["block"]>["ol"] extends true ? {
+export type OrderedListNode<O extends RichTextOptions> = O["ol"] extends true ? {
     tag: "ol";
     children: ListItemNode<O>[];
 } : never;
-export type HeadingTagOf<S extends keyof NonNullable<NonNullable<O["block"]>>, O extends RichTextOptions> = NonNullable<NonNullable<O["block"]>>[S] extends true ? {
+export type HeadingTag = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+export type HeadingTagOf<S extends HeadingTag, O extends RichTextOptions> = O[S] extends true ? {
     tag: S;
     children: (string | SpanNode<O> | CustomInlineNode<O> | LinkNode<O> | BrNode | ImageNode<O>)[];
 } : never;