@valbuild/shared 0.123.2 → 0.124.0

package/internal/dist/valbuild-shared-internal.esm.js

@@ -904,97 +904,96 @@ var InlineRender = z.object({
   as: z.literal("inline")
 });
 var FieldRender = InlineRender.optional();
-var SerializedStringSchema = z.object({
-  type: z.literal("string"),
+
+/**
+ * The fields EVERY serialized schema carries, in one place.
+ *
+ * Spread into each schema below rather than retyped, because retyping them is
+ * exactly how they went missing: `customValidate` and `description` were
+ * declared on six of the eighteen schemas and silently dropped by the other
+ * twelve. A field added to the base of `SerializedSchema` needs adding here and
+ * nowhere else.
+ *
+ * `type`, `opt` and whatever is particular to the schema stay at the call site
+ * - those differ per schema, so there is nothing to share.
+ */
+var commonSchemaFields = {
   render: FieldRender,
+  preview: z.literal(true).optional(),
+  // Whether the schema declares a `.validate()`. The function cannot serialize,
+  // so this flag is what tells the Studio to run the custom validators on the
+  // main thread against the real instance - dropped, and they never run at all.
+  // See `hasCustomValidate` in `ui/spa/validation/customValidate.ts`.
+  customValidate: z["boolean"]().optional(),
+  readonly: z["boolean"]().optional(),
+  hidden: z["boolean"]().optional(),
+  description: z.string().optional()
+};
+var SerializedStringSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
+  type: z.literal("string"),
   // `.multiline()`. Stripped like any undeclared key if it goes missing here,
   // which is a single-line input where the author asked for a text box.
   multiline: z["boolean"]().optional(),
-  preview: z.literal(true).optional(),
   options: z.object({
     maxLength: z.number().optional(),
     minLength: z.number().optional(),
     regexp: z.object({
+      // `.regexp(re, message)`'s message. Written by
+      // `StringSchema.executeSerialize`, so omitting it here strips the
+      // author's own wording and leaves the generic "Expected string to
+      // match reg exp: …" in its place.
+      message: z.string().optional(),
       source: z.string(),
       flags: z.string()
-    }).optional()
+    }).optional(),
+    customValidate: z["boolean"]().optional()
   }).optional(),
   opt: z["boolean"](),
-  raw: z["boolean"](),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
-var SerializedLiteralSchema = z.object({
+  raw: z["boolean"]()
+}));
+var SerializedLiteralSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("literal"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   value: z.string(),
-  opt: z["boolean"](),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
-var SerializedBooleanSchema = z.object({
+  opt: z["boolean"]()
+}));
+var SerializedBooleanSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("boolean"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
-  opt: z["boolean"](),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
-var SerializedNumberSchema = z.object({
+  opt: z["boolean"]()
+}));
+var SerializedNumberSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("number"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: z.object({
     max: z.number().optional(),
     min: z.number().optional()
   }).optional(),
-  opt: z["boolean"](),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
+  opt: z["boolean"]()
+}));
 var SerializedObjectSchema = z.lazy(function () {
-  return z.object({
+  return z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
     type: z.literal("object"),
-    render: FieldRender,
-    preview: z.literal(true).optional(),
     items: z.record(z.string(), SerializedSchema),
-    opt: z["boolean"](),
-    readonly: z["boolean"]().optional(),
-    hidden: z["boolean"]().optional()
-  });
+    opt: z["boolean"]()
+  }));
 });
 var SerializedArraySchema = z.lazy(function () {
-  return z.object({
+  return z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
     type: z.literal("array"),
-    render: FieldRender,
-    preview: z.literal(true).optional(),
     item: SerializedSchema,
-    opt: z["boolean"](),
-    readonly: z["boolean"]().optional(),
-    hidden: z["boolean"]().optional()
-  });
+    opt: z["boolean"]()
+  }));
 });
 var SerializedUnionSchema = z.lazy(function () {
-  return z.union([z.object({
+  return z.union([z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
     type: z.literal("union"),
-    render: FieldRender,
-    preview: z.literal(true).optional(),
     key: SerializedLiteralSchema,
     items: z.array(SerializedLiteralSchema),
-    opt: z["boolean"](),
-    readonly: z["boolean"]().optional(),
-    hidden: z["boolean"]().optional()
-  }), z.object({
+    opt: z["boolean"]()
+  })), z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
     type: z.literal("union"),
-    render: FieldRender,
-    preview: z.literal(true).optional(),
     key: z.string(),
     items: z.array(SerializedObjectSchema),
-    opt: z["boolean"](),
-    readonly: z["boolean"]().optional(),
-    hidden: z["boolean"]().optional()
-  })]);
+    opt: z["boolean"]()
+  }))]);
 });
 var ImageEncodeOption = z.union([z.literal(false), z.object({
   type: z.literal("webp"),
@@ -1007,15 +1006,16 @@ var ImageOptions = z.object({
   accept: z.string().optional(),
   encode: ImageEncodeOption.optional()
 });
-var SerializedImageSchema = z.object({
+var SerializedImageSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("image"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: ImageOptions.optional(),
   opt: z["boolean"](),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
+  // `.remote()`, and the gallery a gallery-backed field reads its metadata
+  // from. Neither is cosmetic: dropped, a remote field looks local and a
+  // gallery-backed one looks like it holds its own dimensions.
+  remote: z["boolean"]().optional(),
+  referencedModule: z.string().optional()
+}));
 var RichTextOptions = z.lazy(function () {
   return z.object({
     // Set by `.maxLength()` / `.minLength()`, not by the options argument.
@@ -1038,20 +1038,14 @@ var RichTextOptions = z.lazy(function () {
     img: z.union([z["boolean"](), SerializedImageSchema]).optional()
   });
 });
-var SerializedRichTextSchema = z.object({
+var SerializedRichTextSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("richtext"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: RichTextOptions.optional(),
-  opt: z["boolean"](),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
+  opt: z["boolean"]()
+}));
 var SerializedRecordSchema = z.lazy(function () {
-  return z.object({
+  return z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
     type: z.literal("record"),
-    render: FieldRender,
-    preview: z.literal(true).optional(),
     item: SerializedSchema,
     opt: z["boolean"](),
     // Optional gallery marker for files/images
@@ -1062,16 +1056,12 @@ var SerializedRecordSchema = z.lazy(function () {
     remote: z["boolean"]().optional(),
     encode: ImageEncodeOption.optional(),
     alt: SerializedSchema.optional(),
-    moduleMetadata: z.record(z.string(), z.record(z.string(), z.any())).optional(),
-    readonly: z["boolean"]().optional(),
-    hidden: z["boolean"]().optional()
-  }).passthrough();
+    moduleMetadata: z.record(z.string(), z.record(z.string(), z.any())).optional()
+  })).passthrough();
 });
 var SerializedKeyOfSchema = z.lazy(function () {
-  return z.object({
+  return z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
     type: z.literal("keyOf"),
-    render: FieldRender,
-    preview: z.literal(true).optional(),
     path: SourcePath,
     schema: z.union([z.object({
       type: z.literal("object"),
@@ -1082,82 +1072,54 @@ var SerializedKeyOfSchema = z.lazy(function () {
       opt: z["boolean"]().optional()
     })]).optional(),
     values: z.union([z.literal("string"), z.array(z.string())]),
-    opt: z["boolean"](),
-    readonly: z["boolean"]().optional(),
-    hidden: z["boolean"]().optional()
-  });
+    opt: z["boolean"]()
+  }));
 });
 var FileOptions = z.object({
   accept: z.string().optional()
 });
-var SerializedFileSchema = z.object({
+var SerializedFileSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("file"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: FileOptions.optional(),
   opt: z["boolean"](),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
+  // See `SerializedImageSchema` above: `.remote()` and the gallery a
+  // gallery-backed field reads from.
+  remote: z["boolean"]().optional(),
+  referencedModule: z.string().optional()
+}));
 var DateOptions = z.object({
   from: z.string().optional(),
   to: z.string().optional()
 });
-var SerializedDateSchema = z.object({
+var SerializedDateSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("date"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: DateOptions.optional(),
-  opt: z["boolean"](),
-  customValidate: z["boolean"]().optional(),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional(),
-  description: z.string().optional()
-});
-var SerializedDateTimeSchema = z.object({
+  opt: z["boolean"]()
+}));
+var SerializedDateTimeSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("dateTime"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: DateOptions.optional(),
-  opt: z["boolean"](),
-  customValidate: z["boolean"]().optional(),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional(),
-  description: z.string().optional()
-});
+  opt: z["boolean"]()
+}));
 var ColorOptions = z.object({
   format: z["enum"](["hex", "rgb", "hsl", "oklch"]).optional(),
   alpha: z["boolean"]().optional()
 });
-var SerializedColorSchema = z.object({
+var SerializedColorSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("color"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: ColorOptions.optional(),
-  opt: z["boolean"](),
-  customValidate: z["boolean"]().optional(),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional(),
-  description: z.string().optional()
-});
+  opt: z["boolean"]()
+}));
 var CodeOptions = z.object({
   language: z["enum"](CODE_LANGUAGES).optional()
 });
-var SerializedCodeSchema = z.object({
+var SerializedCodeSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("code"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: CodeOptions.optional(),
-  opt: z["boolean"](),
-  customValidate: z["boolean"]().optional(),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional(),
-  description: z.string().optional()
-});
-var SerializedRouteSchema = z.object({
+  opt: z["boolean"]()
+}));
+var SerializedRouteSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
   type: z.literal("route"),
-  render: FieldRender,
-  preview: z.literal(true).optional(),
   options: z.object({
     include: z.object({
       source: z.string(),
@@ -1169,11 +1131,8 @@ var SerializedRouteSchema = z.object({
     }).optional(),
     customValidate: z["boolean"]().optional()
   }).optional(),
-  opt: z["boolean"](),
-  customValidate: z["boolean"]().optional(),
-  readonly: z["boolean"]().optional(),
-  hidden: z["boolean"]().optional()
-});
+  opt: z["boolean"]()
+}));
 
 // A settings module, and each section inside one, serialize as this - the
 // shape is recursive because `items` holds sections which are themselves
@@ -1181,17 +1140,11 @@ var SerializedRouteSchema = z.object({
 // (see core/src/schema/settings.ts), but they are accepted here because they
 // are part of the declared type.
 var SerializedSettingsSchema = z.lazy(function () {
-  return z.object({
+  return z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
     type: z.literal("settings"),
-    render: FieldRender,
-    preview: z.literal(true).optional(),
     items: z.record(z.string(), SerializedSchema),
-    opt: z["boolean"](),
-    customValidate: z["boolean"]().optional(),
-    readonly: z["boolean"]().optional(),
-    hidden: z["boolean"]().optional(),
-    description: z.string().optional()
-  });
+    opt: z["boolean"]()
+  }));
 });
 var SerializedSchema = z.union([SerializedStringSchema, SerializedLiteralSchema, SerializedBooleanSchema, SerializedNumberSchema, SerializedObjectSchema, SerializedArraySchema, SerializedUnionSchema, SerializedRichTextSchema, SerializedRecordSchema, SerializedKeyOfSchema, SerializedRouteSchema, SerializedFileSchema, SerializedDateSchema, SerializedDateTimeSchema, SerializedColorSchema, SerializedCodeSchema, SerializedSettingsSchema, SerializedImageSchema]);
 
@@ -2503,6 +2456,66 @@ var Api = {
    * actually mounts. A file at a fixed commit cannot change, so the response is
    * immutable and the browser's own cache handles flipping between commits.
    */
+  /**
+   * One `.jsonValues()` entry's content, as it was at a commit.
+   *
+   * The history pane's counterpart to `/json`. A `.jsonValues()` record's
+   * source is only `{_type:"json"}` markers - the content is per entry, fetched
+   * on demand - so without this the commit pane rendered every entry as an
+   * empty field, which is a claim that the author left it blank.
+   *
+   * One entry per request, deliberately: the store fetches an entry when
+   * something reads inside it, so a batch would mean guessing which entries the
+   * pane is about to show. Authenticated for the same reasons as
+   * `/history/files` below.
+   */
+  "/history/json": {
+    GET: {
+      req: {
+        query: {
+          commit_sha: onlyOneStringQueryParam,
+          path: onlyOneStringQueryParam,
+          key: onlyOneStringQueryParam
+        },
+        cookies: {
+          val_session: z.string().optional()
+        }
+      },
+      res: z.union([unauthorizedResponse, notFoundResponse, z.object({
+        status: z.literal(400),
+        json: GenericError.and(z.object({
+          kind: z.string().optional()
+        }))
+      }), z.object({
+        status: z.literal(500),
+        json: GenericError.and(z.object({
+          kind: z.string().optional()
+        }))
+      }), z.object({
+        status: z.literal(200),
+        json: z.object({
+          path: ModuleFilePath,
+          key: z.string(),
+          content: z.unknown()
+        })
+      })])
+    }
+  },
+  /**
+   * A binary file as it was at a commit.
+   *
+   * AUTHENTICATED, unlike `/files` below - and the difference is not an
+   * oversight in either direction. See the comment on `/files`: what makes it
+   * safe to leave open is that a `patch_id` is an unguessable UUID, and what
+   * makes leaving it open NECESSARY is that a draft image is fetched by the
+   * app's own backend during Next image optimisation, with no cookies.
+   *
+   * Neither holds here. A commit sha is published - `git log`, the GitHub UI,
+   * every PR - so it is not a secret to stand in for a credential. And nothing
+   * fetches these server-side: they are read by the Studio, in a browser that
+   * has the session cookie, for the history pane and for staging a restore.
+   * So this one asks.
+   */
   "/history/files": {
     GET: {
       req: {
@@ -2510,6 +2523,9 @@ var Api = {
           commit_sha: onlyOneStringQueryParam,
           path: onlyOneStringQueryParam,
           remote: onlyOneStringQueryParam.optional()
+        },
+        cookies: {
+          val_session: z.string().optional()
         }
       },
       res: z.union([unauthorizedResponse, notFoundResponse, z.object({
@@ -5322,6 +5338,28 @@ function getRefParts(ref) {
  * them — an agent and an editor searching the same project should find the same
  * things.
  */
+/**
+ * The parts of FlexSearch's `Index` this module uses.
+ *
+ * Structural, rather than importing flexsearch's own `Index`, because
+ * {@link SearchIndex} is EXPORTED — and a `.d.ts` that names `flexsearch` pulls
+ * that package's `declare module "flexsearch"` into every consumer's TypeScript
+ * program. Ambient module declarations are global to a program, so a consumer
+ * with its own flexsearch at another version then checks its OWN calls against
+ * the copy we dragged in, whichever of the two wins.
+ *
+ * That is not hypothetical: `@valbuild/shared` gained a flexsearch dependency
+ * in 0.123.0 for `search_content`, and valbuild/web — which pins flexsearch
+ * 0.7 and calls `new flexsearch.Document({ language: "en", … })` — stopped
+ * building on 0.123.2, because 0.8's `DocumentOptions` has no `language`. Its
+ * own resolved copy was still 0.7; only the types had been replaced.
+ *
+ * Three methods is all this module calls, and none of their signatures here is
+ * a guess: `add` and `remove` are used in `indexModule`/`removeModule`, and
+ * `search`'s result is only ever `.length`-ed, `.slice`-d and mapped over as
+ * ids. `FlexSearch.Index` is still constructed with the real library in
+ * {@link createSearchIndex} — a value import, which does not reach the `.d.ts`.
+ */
 
 /** An index with nothing in it. Fill it with {@link indexModule}. */
 function createSearchIndex() {
@@ -5423,9 +5461,9 @@ function removeModule(searchIndex, moduleFilePath) {
     _step;
   try {
     for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var id = _step.value;
-      index.remove(id);
-      pathToLabel["delete"](id);
+      var _id = _step.value;
+      index.remove(_id);
+      pathToLabel["delete"](_id);
     }
   } catch (err) {
     _iterator.e(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/shared",
-  "version": "0.123.2",
+  "version": "0.124.0",
   "private": false,
   "description": "Val shared types and utilities",
   "repository": {
@@ -37,7 +37,7 @@
     "flexsearch": "^0.8.212",
     "zod": "^4.4.3",
     "zod-validation-error": "^5.0.0",
-    "@valbuild/core": "0.121.0"
+    "@valbuild/core": "0.124.0"
   },
   "files": [
     "CHANGELOG.md",