@valbuild/core 0.127.0 → 0.128.0

package/dist/{index-d44deccb.cjs.prod.js → index-053ccde2.cjs.prod.js}

@@ -3528,7 +3528,7 @@ var ImageSchema = /*#__PURE__*/function (_Schema) {
      *
      * @example
      * const schema = s
-     *   .image({ accept: "image/webp", directory: "/public/val/images" })
+     *   .image({ accept: "image/webp", dir: "/public/val/images" })
      *   .remote();
      * export default c.define("/example.val.ts", schema, {
      *   path: "https://remote.val.build/file/p/my-project/b/01/v/1.0.0/h/8f2a1c/f/3b9d70/p/public/val/images/example.webp",
@@ -3707,6 +3707,10 @@ var ImageSchema = /*#__PURE__*/function (_Schema) {
     /**
      * The entries of the gallery this field points at, or null when it is a
      * standalone field.
+     *
+     * `AltSource` rather than a specific alt type: a field never reads an entry's
+     * alt — it carries its own — so it only needs the entry keys and the
+     * dimensions, and a gallery of any alt shape can back it.
      */
   }, {
     key: "galleryEntries",
@@ -5461,9 +5465,9 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
       if (this.mediaOptions) {
         var checkFix = this.mediaOptions.type === "images" ? "images:check-unique-folder" : "files:check-unique-folder";
         var uniqueCheckError = {
-          message: "Gallery directory '".concat(this.mediaOptions.directory, "' must be unique across all galleries"),
+          message: "Gallery directory '".concat(this.mediaOptions.dir, "' must be unique across all galleries"),
           value: {
-            directory: this.mediaOptions.directory,
+            dir: this.mediaOptions.dir,
             type: this.mediaOptions.type
           },
           fixes: [checkFix]
@@ -5479,9 +5483,9 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
         }
         var allFilesCheckFix = this.mediaOptions.type === "images" ? "images:check-all-files" : "files:check-all-files";
         var allFilesCheckError = {
-          message: "Directory '".concat(this.mediaOptions.directory, "' may have files not tracked by this gallery"),
+          message: "Directory '".concat(this.mediaOptions.dir, "' may have files not tracked by this gallery"),
           value: {
-            directory: this.mediaOptions.directory,
+            dir: this.mediaOptions.dir,
             type: this.mediaOptions.type
           },
           fixes: [allFilesCheckFix]
@@ -5642,13 +5646,13 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
         return false;
       }
       var _this$mediaOptions = this.mediaOptions,
-        directory = _this$mediaOptions.directory,
+        dir = _this$mediaOptions.dir,
         isRemote = _this$mediaOptions.remote,
         type = _this$mediaOptions.type;
       var mediaLabel = type === "images" ? "images" : "files";
       var checkRemoteFix = type === "images" ? "images:check-remote" : "files:check-remote";
       var isRemoteUrl = this.isRemoteUrl(key);
-      var isLocalPath = key === directory || key.startsWith(directory + "/");
+      var isLocalPath = key === dir || key.startsWith(dir + "/");
       if (isRemote) {
         // When remote is enabled, accept either remote URLs or local paths
         if (isRemoteUrl) {
@@ -5663,9 +5667,9 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
           }
           // Check that the file path in the remote URL matches our directory constraint
           var remotePath = "/" + remoteResult.filePath;
-          if (remotePath !== directory && !remotePath.startsWith(directory + "/")) {
+          if (remotePath !== dir && !remotePath.startsWith(dir + "/")) {
             return _defineProperty({}, path, [{
-              message: "Remote file path '".concat(remotePath, "' is not in expected directory '").concat(directory, "'. Use Val tooling to upload ").concat(mediaLabel, " to the correct directory."),
+              message: "Remote file path '".concat(remotePath, "' is not in expected directory '").concat(dir, "'. Use Val tooling to upload ").concat(mediaLabel, " to the correct directory."),
               value: key,
               fixes: [checkRemoteFix]
             }]);
@@ -5674,7 +5678,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
         }
         if (!isLocalPath) {
           return _defineProperty({}, path, [{
-            message: "Expected a remote URL (https://...) or a local path starting with ".concat(directory, "/. Got: ").concat(key),
+            message: "Expected a remote URL (https://...) or a local path starting with ".concat(dir, "/. Got: ").concat(key),
             value: key
           }]);
         }
@@ -5696,7 +5700,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
         }
         if (!isLocalPath) {
           return _defineProperty({}, path, [{
-            message: "File path must be within the ".concat(directory, "/ directory. Got: ").concat(key),
+            message: "File path must be within the ".concat(dir, "/ directory. Got: ").concat(key),
             value: key
           }]);
         }
@@ -5892,7 +5896,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
      * Allow the files in this gallery to be stored on Val's remote content host
      * instead of in your repository.
      *
-     * For `s.images()` and `s.files()`, which are records of media. Remote is off
+     * For `s.imageset()` and `s.fileset()`, which are records of media. Remote is off
      * until this is called.
      *
      * Each entry is then keyed by its URL on the content host rather than by a
@@ -5901,7 +5905,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
      * upload it and rewrite the key.
      *
      * @example
-     * const schema = s.images({ directory: "/public/val/images" }).remote();
+     * const schema = s.imageset({ dir: "/public/val/images" }).remote();
      * export default c.define("/content/images.val.ts", schema, {
      *   "https://remote.val.build/file/p/my-project/b/01/v/1.0.0/h/8f2a1c/f/3b9d70/p/public/val/images/hero.webp":
      *     {
@@ -5927,7 +5931,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
      * which lets the runtime, the Studio and validation work one entry at a time
      * so a record/router can scale to many thousands of entries.
      *
-     * Not supported on image/file galleries (`s.images()` / `s.files()`).
+     * Not supported on image/file galleries (`s.imageset()` / `s.fileset()`).
      *
      * Only supported on a module's ROOT record/router — a `.jsonValues()` record
      * nested inside an object/array/record is rejected at startup with a module
@@ -5952,7 +5956,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
     key: "jsonValues",
     value: function jsonValues() {
       if (this.mediaOptions) {
-        throw new Error(".jsonValues() cannot be used with image/file galleries (s.images()/s.files())");
+        throw new Error(".jsonValues() cannot be used with image/file galleries (s.imageset()/s.fileset())");
       }
       if (this.customValidateFunctions.length > 0) {
         // `.jsonValues()` changes the source shape to JsonSource entries, so a
@@ -5981,7 +5985,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
      * bucket — instead of in the module.
      *
      * Available on every record-derived schema, which is `s.record()`,
-     * `s.router()`, `s.images()` and `s.files()` alike: a router is a
+     * `s.router()`, `s.imageset()` and `s.fileset()` alike: a router is a
      * `RecordSchema` with a `ValRouter`, a gallery one with media options, so all
      * four get external storage from this one method.
      *
@@ -6136,7 +6140,7 @@ var RecordSchema = /*#__PURE__*/function (_Schema) {
       if (this.mediaOptions) {
         result.mediaType = this.mediaOptions.type;
         result.accept = this.mediaOptions.accept;
-        result.directory = this.mediaOptions.directory;
+        result.dir = this.mediaOptions.dir;
         result.remote = this.mediaOptions.remote;
         if (this.mediaOptions.encode !== undefined) {
           result.encode = this.mediaOptions.encode;
@@ -9308,7 +9312,7 @@ function file(options) {
 }
 
 /**
- * Options for s.files()
+ * Options for s.fileset()
  */
 
 /**
@@ -9322,9 +9326,9 @@ function file(options) {
  *
  * @example
  * ```typescript
- * const schema = s.files({
+ * const schema = s.fileset({
  *   accept: "application/pdf",
- *   directory: "/public/val/documents",
+ *   dir: "/public/val/documents",
  * });
  * export default c.define("/content/documents.val.ts", schema, {
  *   "/public/val/documents/report.pdf": {
@@ -9333,15 +9337,15 @@ function file(options) {
  * });
  * ```
  */
-var files = function files(options) {
-  var directory = options.directory;
+var fileset = function fileset(options) {
+  var dir = options.dir;
   var itemSchema = new ObjectSchema({
     mimeType: new StringSchema({}, false)
   }, false);
   return new RecordSchema(itemSchema, false, [], null, null, {
     type: "files",
     accept: options.accept,
-    directory: directory,
+    dir: dir,
     remote: false
   });
 };
@@ -10972,14 +10976,37 @@ function router(router, keyOrItem, maybeItem) {
  */
 
 /**
- * Options for s.images()
+ * What an entry's `alt` holds, for a given `alt` schema.
+ *
+ * This is the schema's own source type, not a second list that has to be kept
+ * in step with `AltSchema`: `s.string()` gives `string`, `s.string().nullable()`
+ * gives `string | null`, and `s.record(s.string())` gives
+ * `Record<string, string>`.
+ */
+
+/** Every `alt` value any `AltSchema` can produce. */
+
+/**
+ * Options for s.imageset()
  */
 
 /**
- * Metadata for an image entry in the images record
+ * `alt` is optional only when it is the default schema.
+ *
+ * Naming a different `Alt` and then leaving `alt` out would make the fallback
+ * in `imageset()` a lie — `Alt` would say `s.string()` while the value was a
+ * nullable one. Requiring it in that case is what makes the fallback sound:
+ * the branch that uses it is reachable only when `Alt` IS the default.
  */
 
-// Item schema types for images (alt simplified to string | null for typing)
+/**
+ * Metadata for an image entry in the images record.
+ *
+ * `alt` follows the schema's `alt` option, so it defaults to `string | null`
+ * and becomes `string` under `s.string()` or `Record<string, string>` under
+ * `s.record(s.string())`. Write `ImagesetEntryMetadata<AltSource>` where a
+ * gallery of any alt shape is acceptable.
+ */
 
 /**
  * Define a collection of images.
@@ -10990,9 +11017,9 @@ function router(router, keyOrItem, maybeItem) {
  *
  * @example
  * ```typescript
- * const schema = s.images({
+ * const schema = s.imageset({
  *   accept: "image/webp",
- *   directory: "/public/val/images",
+ *   dir: "/public/val/images",
  *   alt: s.string().minLength(4),
  * });
  * export default c.define("/content/images.val.ts", schema, {
@@ -11005,9 +11032,18 @@ function router(router, keyOrItem, maybeItem) {
  * });
  * ```
  */
-var images = function images(options) {
+var imageset = function imageset(options) {
   var _options$alt, _options$accept;
-  var directory = options.directory;
+  var dir = options.dir;
+  // `options.alt` is `Alt | undefined`, and the fallback is exactly the schema
+  // `Alt` defaults to when `alt` is omitted. TypeScript will not narrow a type
+  // parameter from the absence of a value, so it cannot see that the two agree,
+  // and the fallback is asserted here.
+  //
+  // Sound, not merely convenient: `ImagesetAltOption` makes `alt` REQUIRED
+  // unless `Alt` is the default, so this branch is unreachable for any other
+  // `Alt`. The one assertion in this file, and it replaces the wider one that
+  // used to sit on the ObjectSchema below.
   var altSchema = (_options$alt = options.alt) !== null && _options$alt !== void 0 ? _options$alt : string().nullable();
   var itemSchema = new ObjectSchema({
     width: new NumberSchema(undefined, false),
@@ -11018,7 +11054,7 @@ var images = function images(options) {
   return new RecordSchema(itemSchema, false, [], null, null, {
     type: "images",
     accept: (_options$accept = options.accept) !== null && _options$accept !== void 0 ? _options$accept : "image/*",
-    directory: directory,
+    dir: dir,
     remote: false,
     altSchema: altSchema,
     encode: options.encode
@@ -11050,7 +11086,7 @@ function initSchema() {
     keyOf: keyOf,
     record: record,
     file: file,
-    files: files,
+    fileset: fileset,
     date: date,
     datetime: datetime,
     color: color,
@@ -11058,7 +11094,7 @@ function initSchema() {
     locale: locale,
     route: route,
     router: router,
-    images: images,
+    imageset: imageset,
     settings: settings
     // i18n: i18n(locales),
   };
@@ -11900,7 +11936,7 @@ function _extractValModules() {
  * The one answer to that question. There used to be two — `hasRemoteFileSchema`
  * in the server, gating whether `/save` demands remote credentials, and
  * `findRequiredRemoteFiles` in the Studio, gating the `/remote/settings` fetch —
- * and they disagreed about `s.images({ ... }).remote()`: the Studio's version
+ * and they disagreed about `s.imageset({ ... }).remote()`: the Studio's version
  * counted a remote media record, the server's did not, because a media
  * collection serializes as a `record` of metadata rather than as an image
  * schema.
@@ -11940,7 +11976,7 @@ function hasRemoteFileSchema(schema) {
     return hasRemoteFileSchema(schema.item);
   } else if (schema.type === "record") {
     /**
-     * A media collection — `s.images()` / `s.files()` — is the case both of the
+     * A media collection — `s.imageset()` / `s.fileset()` — is the case both of the
      * old functions were written around, and the one they disagreed on.
      *
      * It has no file or image schema inside it to find: `item` is an object of
@@ -12000,8 +12036,8 @@ function hasRemoteFileSchema(schema) {
  *
  * It is a walk over the SERIALIZED schema for the reasons given above, and for
  * one more that is specific to this question: the two cases most likely to be
- * missed are invisible to a value type. A media collection (`s.images()` /
- * `s.files()`) serializes as a record of metadata with no image schema inside
+ * missed are invisible to a value type. A media collection (`s.imageset()` /
+ * `s.fileset()`) serializes as a record of metadata with no image schema inside
  * it, and a richtext inline image lives in a constructor argument. A check
  * written against the item TYPE would silently pass both — and the gallery case
  * already has a data-loss incident attached to it (see above).
@@ -12384,7 +12420,7 @@ function deserializeSchema(serialized) {
   return schema;
 }
 function deserializeSchemaImpl(serialized) {
-  var _serialized$options, _serialized$options2, _serialized$render, _serialized$multiline, _serialized$render2, _serialized$render3, _serialized$render4, _serialized$render5, _serialized$render6, _serialized$render7, _serialized$render8, _serialized$accept, _serialized$directory, _serialized$remote, _serialized$jsonValue, _serialized$render0, _serialized$external, _serialized$render1, _serialized$render12, _serialized$render13, _serialized$render14, _serialized$render15, _serialized$render16, _serialized$render17;
+  var _serialized$options, _serialized$options2, _serialized$render, _serialized$multiline, _serialized$render2, _serialized$render3, _serialized$render4, _serialized$render5, _serialized$render6, _serialized$render7, _serialized$render8, _serialized$accept, _serialized$dir, _serialized$remote, _serialized$jsonValue, _serialized$render0, _serialized$external, _serialized$render1, _serialized$render12, _serialized$render13, _serialized$render14, _serialized$render15, _serialized$render16, _serialized$render17;
   switch (serialized.type) {
     case "string":
       return new StringSchema(_objectSpread2(_objectSpread2({}, serialized.options), {}, {
@@ -12444,7 +12480,7 @@ function deserializeSchemaImpl(serialized) {
       return new RecordSchema(deserializeSchema(serialized.item), serialized.opt, [], null, serialized.key ? deserializeSchema(serialized.key) : null, serialized.mediaType ? {
         type: serialized.mediaType,
         accept: (_serialized$accept = serialized.accept) !== null && _serialized$accept !== void 0 ? _serialized$accept : "*/*",
-        directory: (_serialized$directory = serialized.directory) !== null && _serialized$directory !== void 0 ? _serialized$directory : "/public/val",
+        dir: (_serialized$dir = serialized.dir) !== null && _serialized$dir !== void 0 ? _serialized$dir : "/public/val",
         remote: (_serialized$remote = serialized.remote) !== null && _serialized$remote !== void 0 ? _serialized$remote : false,
         altSchema: serialized.alt ? deserializeSchema(serialized.alt) : undefined
       } : undefined, false, false, serialized.description, (_serialized$jsonValue = serialized.jsonValues) !== null && _serialized$jsonValue !== void 0 ? _serialized$jsonValue : false,
@@ -13147,7 +13183,7 @@ function isPageRouter(routerId) {
 
 var corePackageJson = {
 	name: "@valbuild/core",
-	version: "0.127.0",
+	version: "0.128.0",
 	"private": false,
 	description: "Val - supercharged hard-coded content",
 	repository: {