@valbuild/shared 0.138.4 → 0.139.0

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @valbuild/shared
 
+## 0.139.0
+
+### Minor Changes
+
+- [#776](https://github.com/valbuild/val/pull/776) [`3eb5031`](https://github.com/valbuild/val/commit/3eb503167ae466ee586303c95efcc14665129481) Thanks [@freekh](https://github.com/freekh)! - **Breaking:** `.render({ as: "inline" })` now goes on the list, not on its items.
+
+  You now write `s.array(item).render({ as: "inline" })` and `s.record(item).render({ as: "inline" })`. Each item is then edited in its own row instead of in a preview row you click into. The list decides. The item schema stays reusable, and a page builder made of tagged blocks needs nothing on each block:
+
+  ```ts
+  // before
+  s.array(
+    s.discriminatedUnion(
+      "type",
+      hero.render({ as: "inline" }),
+      text.render({ as: "inline" }),
+    ),
+  );
+
+  // after
+  s.array(s.discriminatedUnion("type", hero, text)).render({ as: "inline" });
+  ```
+
+  What changed:
+
+  - Only `s.array()`, `s.record()` and `s.keyOf()` have `.render(...)` now. On every other schema the method is gone, so the old placement shows up as a type error. Move the render out one level.
+  - The render only affects the list's own items. A list nested inside one of those items keeps its default unless it has its own `.render`.
+  - `s.router()`, `s.imageset()` and `s.fileset()` throw if you give them a render, because pages and media have their own editors.
+  - `s.keyOf(...).render({ as: "inline" })` means the same as before: the selected entry's content is shown below the dropdown.
+
+  **Watch for one case that still compiles:** an array or record that is itself the item of another list. `s.record(s.array(s.string()).render({ as: "inline" }))` used to show the record's arrays inline. Now it shows each array's strings inline. To keep the old layout, write `s.record(s.array(s.string())).render({ as: "inline" })`.
+
+### Patch Changes
+
+- Updated dependencies [[`3eb5031`](https://github.com/valbuild/val/commit/3eb503167ae466ee586303c95efcc14665129481)]:
+  - @valbuild/core@0.139.0
+
 ## 0.138.4
 
 ### Patch Changes

package/dist/declarations/src/internal/zod/SerializedSchema.d.ts

@@ -86,9 +86,6 @@ export declare const SerializedSettingsSchema: z.ZodType<SerializedSettingsSchem
  */
 export declare const SerializedValViewSchema: z.ZodObject<{
     type: z.ZodLiteral<"view">;
-    render: z.ZodOptional<z.ZodOptional<z.ZodObject<{
-        as: z.ZodLiteral<"inline">;
-    }, z.core.$strip>>>;
     moduleFilePath: z.ZodType<import("@valbuild/core").ModuleFilePath, unknown, z.core.$ZodTypeInternals<import("@valbuild/core").ModuleFilePath, unknown>>;
     opt: z.ZodLiteral<false>;
     readonly: z.ZodOptional<z.ZodBoolean>;

package/internal/dist/valbuild-shared-internal.cjs.dev.js

@@ -987,7 +987,8 @@ var _excluded = ["directory"];
 
 // A render is static config, so unlike a `preview` it travels WHOLE — this
 // is the field the editor reads the layout from. See `core/src/render.ts`.
-// Every field can carry `{ as: "inline" }`, and that is all a render says.
+// Only array, record and keyOf carry one, and `{ as: "inline" }` is all it
+// says. A stale `render` on any other schema is stripped here, harmlessly.
 // NB: these z.objects STRIP unknown keys, so a render variant that is not
 // declared here is silently dropped in transit — add it here when it is added
 // to `render.ts`.
@@ -1009,7 +1010,6 @@ var FieldRender = InlineRender.optional();
  * - those differ per schema, so there is nothing to share.
  */
 var commonSchemaFields = {
-  render: FieldRender,
   preview: zod.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
@@ -1068,6 +1068,7 @@ var SerializedObjectSchema = zod.z.lazy(function () {
 });
 var SerializedArraySchema = zod.z.lazy(function () {
   return zod.z.object(getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: zod.z.literal("array"),
     item: SerializedSchema,
     opt: zod.z["boolean"]()
@@ -1160,6 +1161,7 @@ var SerializedRichTextSchema = zod.z.object(getSitemapTree._objectSpread2(getSit
 }));
 var SerializedRecordSchema = zod.z.lazy(function () {
   return zod.z.preprocess(readLegacyDirectoryAsDir, zod.z.object(getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: zod.z.literal("record"),
     item: SerializedSchema,
     opt: zod.z["boolean"](),
@@ -1176,6 +1178,7 @@ var SerializedRecordSchema = zod.z.lazy(function () {
 });
 var SerializedKeyOfSchema = zod.z.lazy(function () {
   return zod.z.object(getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: zod.z.literal("keyOf"),
     path: SourcePath,
     schema: zod.z.union([zod.z.object({
@@ -1235,7 +1238,6 @@ var SerializedCodeSchema = zod.z.object(getSitemapTree._objectSpread2(getSitemap
 }));
 var SerializedLocaleSchema = zod.z.object({
   type: zod.z.literal("locale"),
-  render: FieldRender,
   preview: zod.z.literal(true).optional(),
   opt: zod.z["boolean"](),
   customValidate: zod.z["boolean"]().optional(),
@@ -1261,7 +1263,7 @@ var SerializedRouteSchema = zod.z.object(getSitemapTree._objectSpread2(getSitema
 
 // A settings module, and each section inside one, serialize as this - the
 // shape is recursive because `items` holds sections which are themselves
-// settings schemas. `s.settings()` never writes render/preview/customValidate
+// settings schemas. `s.settings()` never writes preview/customValidate
 // (see core/src/schema/settings.ts), but they are accepted here because they
 // are part of the declared type.
 var SerializedSettingsSchema = zod.z.lazy(function () {
@@ -1287,7 +1289,6 @@ var SerializedSettingsSchema = zod.z.lazy(function () {
  */
 var SerializedValViewSchema = zod.z.object({
   type: zod.z.literal("view"),
-  render: FieldRender.optional(),
   moduleFilePath: ModuleFilePath$1,
   opt: zod.z.literal(false),
   readonly: zod.z["boolean"]().optional(),

package/internal/dist/valbuild-shared-internal.cjs.prod.js

@@ -987,7 +987,8 @@ var _excluded = ["directory"];
 
 // A render is static config, so unlike a `preview` it travels WHOLE — this
 // is the field the editor reads the layout from. See `core/src/render.ts`.
-// Every field can carry `{ as: "inline" }`, and that is all a render says.
+// Only array, record and keyOf carry one, and `{ as: "inline" }` is all it
+// says. A stale `render` on any other schema is stripped here, harmlessly.
 // NB: these z.objects STRIP unknown keys, so a render variant that is not
 // declared here is silently dropped in transit — add it here when it is added
 // to `render.ts`.
@@ -1009,7 +1010,6 @@ var FieldRender = InlineRender.optional();
  * - those differ per schema, so there is nothing to share.
  */
 var commonSchemaFields = {
-  render: FieldRender,
   preview: zod.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
@@ -1068,6 +1068,7 @@ var SerializedObjectSchema = zod.z.lazy(function () {
 });
 var SerializedArraySchema = zod.z.lazy(function () {
   return zod.z.object(getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: zod.z.literal("array"),
     item: SerializedSchema,
     opt: zod.z["boolean"]()
@@ -1160,6 +1161,7 @@ var SerializedRichTextSchema = zod.z.object(getSitemapTree._objectSpread2(getSit
 }));
 var SerializedRecordSchema = zod.z.lazy(function () {
   return zod.z.preprocess(readLegacyDirectoryAsDir, zod.z.object(getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: zod.z.literal("record"),
     item: SerializedSchema,
     opt: zod.z["boolean"](),
@@ -1176,6 +1178,7 @@ var SerializedRecordSchema = zod.z.lazy(function () {
 });
 var SerializedKeyOfSchema = zod.z.lazy(function () {
   return zod.z.object(getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: zod.z.literal("keyOf"),
     path: SourcePath,
     schema: zod.z.union([zod.z.object({
@@ -1235,7 +1238,6 @@ var SerializedCodeSchema = zod.z.object(getSitemapTree._objectSpread2(getSitemap
 }));
 var SerializedLocaleSchema = zod.z.object({
   type: zod.z.literal("locale"),
-  render: FieldRender,
   preview: zod.z.literal(true).optional(),
   opt: zod.z["boolean"](),
   customValidate: zod.z["boolean"]().optional(),
@@ -1261,7 +1263,7 @@ var SerializedRouteSchema = zod.z.object(getSitemapTree._objectSpread2(getSitema
 
 // A settings module, and each section inside one, serialize as this - the
 // shape is recursive because `items` holds sections which are themselves
-// settings schemas. `s.settings()` never writes render/preview/customValidate
+// settings schemas. `s.settings()` never writes preview/customValidate
 // (see core/src/schema/settings.ts), but they are accepted here because they
 // are part of the declared type.
 var SerializedSettingsSchema = zod.z.lazy(function () {
@@ -1287,7 +1289,6 @@ var SerializedSettingsSchema = zod.z.lazy(function () {
  */
 var SerializedValViewSchema = zod.z.object({
   type: zod.z.literal("view"),
-  render: FieldRender.optional(),
   moduleFilePath: ModuleFilePath$1,
   opt: zod.z.literal(false),
   readonly: zod.z["boolean"]().optional(),

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

@@ -980,7 +980,8 @@ var _excluded = ["directory"];
 
 // A render is static config, so unlike a `preview` it travels WHOLE — this
 // is the field the editor reads the layout from. See `core/src/render.ts`.
-// Every field can carry `{ as: "inline" }`, and that is all a render says.
+// Only array, record and keyOf carry one, and `{ as: "inline" }` is all it
+// says. A stale `render` on any other schema is stripped here, harmlessly.
 // NB: these z.objects STRIP unknown keys, so a render variant that is not
 // declared here is silently dropped in transit — add it here when it is added
 // to `render.ts`.
@@ -1002,7 +1003,6 @@ var FieldRender = InlineRender.optional();
  * - 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
@@ -1061,6 +1061,7 @@ var SerializedObjectSchema = z.lazy(function () {
 });
 var SerializedArraySchema = z.lazy(function () {
   return z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: z.literal("array"),
     item: SerializedSchema,
     opt: z["boolean"]()
@@ -1153,6 +1154,7 @@ var SerializedRichTextSchema = z.object(_objectSpread2(_objectSpread2({}, common
 }));
 var SerializedRecordSchema = z.lazy(function () {
   return z.preprocess(readLegacyDirectoryAsDir, z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: z.literal("record"),
     item: SerializedSchema,
     opt: z["boolean"](),
@@ -1169,6 +1171,7 @@ var SerializedRecordSchema = z.lazy(function () {
 });
 var SerializedKeyOfSchema = z.lazy(function () {
   return z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
+    render: FieldRender,
     type: z.literal("keyOf"),
     path: SourcePath,
     schema: z.union([z.object({
@@ -1228,7 +1231,6 @@ var SerializedCodeSchema = z.object(_objectSpread2(_objectSpread2({}, commonSche
 }));
 var SerializedLocaleSchema = z.object({
   type: z.literal("locale"),
-  render: FieldRender,
   preview: z.literal(true).optional(),
   opt: z["boolean"](),
   customValidate: z["boolean"]().optional(),
@@ -1254,7 +1256,7 @@ var SerializedRouteSchema = z.object(_objectSpread2(_objectSpread2({}, commonSch
 
 // A settings module, and each section inside one, serialize as this - the
 // shape is recursive because `items` holds sections which are themselves
-// settings schemas. `s.settings()` never writes render/preview/customValidate
+// settings schemas. `s.settings()` never writes preview/customValidate
 // (see core/src/schema/settings.ts), but they are accepted here because they
 // are part of the declared type.
 var SerializedSettingsSchema = z.lazy(function () {
@@ -1280,7 +1282,6 @@ var SerializedSettingsSchema = z.lazy(function () {
  */
 var SerializedValViewSchema = z.object({
   type: z.literal("view"),
-  render: FieldRender.optional(),
   moduleFilePath: ModuleFilePath$1,
   opt: z.literal(false),
   readonly: z["boolean"]().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/shared",
-  "version": "0.138.4",
+  "version": "0.139.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.138.2"
+    "@valbuild/core": "0.139.0"
   },
   "files": [
     "CHANGELOG.md",