@valbuild/shared 0.146.2 → 0.147.0

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

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var getSitemapTree = require('../../dist/getSitemapTree-c732e09a.cjs.dev.js');
+var getSitemapTree = require('../../dist/getSitemapTree-f6254b32.cjs.dev.js');
 var core = require('@valbuild/core');
 var zod = require('zod');
 var zodValidationError = require('zod-validation-error');
@@ -1196,6 +1196,8 @@ var SerializedDiscriminatedUnionSchema = zod.z.lazy(function () {
 var SerializedEnumSchema = zod.z.object(getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, commonSchemaFields), {}, {
   type: zod.z.literal("enum"),
   values: zod.z.array(zod.z.string()),
+  locales: zod.z.record(zod.z.string(), zod.z.string()).optional(),
+  nullLocale: zod.z.string().optional(),
   opt: zod.z["boolean"]()
 }));
 var ImageEncodeOption = zod.z.union([zod.z.literal(false), zod.z.object({
@@ -1275,6 +1277,7 @@ var SerializedRecordSchema = zod.z.lazy(function () {
     render: FieldRender,
     type: zod.z.literal("record"),
     item: SerializedSchema,
+    params: zod.z.record(zod.z.string(), SerializedSchema).optional(),
     opt: zod.z["boolean"](),
     // Optional gallery marker for files/images/videos
     mediaType: zod.z.union([zod.z.literal("files"), zod.z.literal("images"), zod.z.literal("videos")]).optional(),
@@ -1618,7 +1621,7 @@ var ValConfig = zod.z.object({
   gitCommit: zod.z.string().optional(),
   gitBranch: zod.z.string().optional()
 });
-var ValidationFixZ = zod.z.union([zod.z.literal("image:add-metadata"), zod.z.literal("image:check-metadata"), zod.z.literal("image:check-remote"), zod.z.literal("image:upload-remote"), zod.z.literal("image:download-remote"), zod.z.literal("images:check-remote"), zod.z.literal("images:upload-remote"), zod.z.literal("file:add-metadata"), zod.z.literal("video:add-metadata"), zod.z.literal("video:upload-remote"), zod.z.literal("video:download-remote"), zod.z.literal("videos:add-metadata"), zod.z.literal("videos:check-remote"), zod.z.literal("videos:upload-remote"), zod.z.literal("file:check-metadata"), zod.z.literal("file:check-remote"), zod.z.literal("file:upload-remote"), zod.z.literal("file:download-remote"), zod.z.literal("files:check-remote"), zod.z.literal("files:upload-remote"), zod.z.literal("keyof:check-keys"), zod.z.literal("image:check-gallery"), zod.z.literal("file:check-gallery"), zod.z.literal("video:check-gallery"), zod.z.literal("router:check-route"), zod.z.literal("locale:check-locale"), zod.z.literal("record:fill-keys"), zod.z.literal("images:check-unique-folder"), zod.z.literal("files:check-unique-folder"), zod.z.literal("images:check-all-files"), zod.z.literal("files:check-all-files"), zod.z.literal("videos:check-unique-folder"), zod.z.literal("videos:check-all-files"), zod.z.literal("jsonValues:extract-entry"), zod.z.literal("view:check-module")]);
+var ValidationFixZ = zod.z.union([zod.z.literal("image:add-metadata"), zod.z.literal("image:check-metadata"), zod.z.literal("image:check-remote"), zod.z.literal("image:upload-remote"), zod.z.literal("image:download-remote"), zod.z.literal("images:check-remote"), zod.z.literal("images:upload-remote"), zod.z.literal("file:add-metadata"), zod.z.literal("video:add-metadata"), zod.z.literal("video:upload-remote"), zod.z.literal("video:download-remote"), zod.z.literal("videos:add-metadata"), zod.z.literal("videos:check-remote"), zod.z.literal("videos:upload-remote"), zod.z.literal("file:check-metadata"), zod.z.literal("file:check-remote"), zod.z.literal("file:upload-remote"), zod.z.literal("file:download-remote"), zod.z.literal("files:check-remote"), zod.z.literal("files:upload-remote"), zod.z.literal("keyof:check-keys"), zod.z.literal("image:check-gallery"), zod.z.literal("file:check-gallery"), zod.z.literal("video:check-gallery"), zod.z.literal("router:check-route"), zod.z.literal("locale:check-locale"), zod.z.literal("router:check-locale-param"), zod.z.literal("record:fill-keys"), zod.z.literal("images:check-unique-folder"), zod.z.literal("files:check-unique-folder"), zod.z.literal("images:check-all-files"), zod.z.literal("files:check-all-files"), zod.z.literal("videos:check-unique-folder"), zod.z.literal("videos:check-all-files"), zod.z.literal("jsonValues:extract-entry"), zod.z.literal("view:check-module")]);
 var ValidationError = zod.z.object({
   message: zod.z.string(),
   value: zod.z.unknown().optional(),
@@ -3745,8 +3748,11 @@ function detailsOf(json) {
 }
 var DEFAULT_ERROR_MESSAGE = "Unknown error with unknown message from server";
 
-var createValClient = function createValClient(host, config // We want to use this in the future
-) {
+var createValClient = function createValClient(host, config, options) {
+  var _options$fetch;
+  var send = (_options$fetch = options === null || options === void 0 ? void 0 : options.fetch) !== null && _options$fetch !== void 0 ? _options$fetch : function (input, init) {
+    return fetch(input, init);
+  };
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   var anyApi = Api;
   return /*#__PURE__*/function () {
@@ -3837,7 +3843,7 @@ var createValClient = function createValClient(host, config // We want to use th
           case 2:
             _context2.p = 2;
             _context2.n = 3;
-            return fetch("".concat(host).concat(fullPath), {
+            return send("".concat(host).concat(fullPath), {
               method: method,
               headers: {
                 "Content-Type": "application/json"
@@ -3971,6 +3977,29 @@ function isRetryable(error) {
   return false;
 }
 
+/**
+ * A Val demo, as the page hands it to the Studio.
+ *
+ * In a demo the Studio talks to Val's own server running in the same tab
+ * (`@valbuild/server/browser`) instead of to an API route, and the page that
+ * starts that server is the app's (`<ValApp demo>`) while the Studio is a
+ * separate bundle loaded by a script tag. A window property is how the two
+ * meet, the same way `window.__VAL_MODULES__` hands the Studio the project's
+ * modules. See `docs/plans/demo-mode.md`.
+ */
+
+/*
+ * A global `var` rather than a `Window` member: this package is compiled
+ * without the DOM's types, and a `var` in global scope is also a property of
+ * `window` where they exist.
+ */
+
+/** The demo this page was started with, or null outside a demo. */
+function getValDemo() {
+  var _globalThis$__VAL_DEM;
+  return (_globalThis$__VAL_DEM = globalThis.__VAL_DEMO__) !== null && _globalThis$__VAL_DEM !== void 0 ? _globalThis$__VAL_DEM : null;
+}
+
 function _arrayWithHoles(r) {
   if (Array.isArray(r)) return r;
 }
@@ -4850,7 +4879,7 @@ function declaredLocales(snapshot) {
  * these has to resolve all of them, and the two that leaked did so by adding a
  * fix here and not to a condition somewhere else.
  */
-var SCHEMA_SOURCE_FIXES = ["keyof:check-keys", "image:check-gallery", "file:check-gallery", "video:check-gallery", "router:check-route", "locale:check-locale", "record:fill-keys"];
+var SCHEMA_SOURCE_FIXES = ["keyof:check-keys", "image:check-gallery", "file:check-gallery", "video:check-gallery", "router:check-route", "locale:check-locale", "router:check-locale-param", "record:fill-keys"];
 
 /** Whether an error is a marker only the whole project can answer. */
 function isSchemaSourceFixError(error) {
@@ -5040,21 +5069,51 @@ function resolveSchemaSourceFixForError(error, snapshot) {
       })
     };
   }
-  if (fixes.includes("record:fill-keys")) {
+  if (fixes.includes("router:check-locale-param")) {
     var _value = error.value;
-    if (getSitemapTree._typeof(_value) !== "object" || _value === null) {
+    var _ref7 = getSitemapTree._typeof(_value) === "object" && _value !== null ? _value : {},
+      name = _ref7.name,
+      segment = _ref7.segment;
+    if (typeof name !== "string" || typeof segment !== "string") {
       return {
         status: "remaining",
         error: getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, error), {}, {
-          message: "Expected record key validation error to have a 'value' object. Found: ".concat(getSitemapTree._typeof(_value), ". ").concat(TYPE_ERROR_MESSAGE),
+          message: "Expected route locale parameter validation error to have a 'value' with 'name' and 'segment'. ".concat(TYPE_ERROR_MESSAGE),
           typeError: true,
           fixes: undefined
         })
       };
     }
-    var _ref7 = _value,
-      present = _ref7.present,
-      declared = _ref7.declared;
+    // A project that declares no languages is not translated, and a
+    // `[locale]` segment there is the app's own business.
+    if (declaredLocales(snapshot).length === 0) {
+      return {
+        status: "resolved"
+      };
+    }
+    return {
+      status: "remaining",
+      error: getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, error), {}, {
+        message: "This route has a '".concat(name, "' segment (").concat(segment, "), but nothing says which of the project's languages it can be, so its pages are not in any language and '/xx/\u2026' validates. Give the parameter a locale schema: s.router(router, { ").concat(name, ": urlLocale, \u2026 }, item), where urlLocale is an s.enum(\u2026).locales({ \u2026 }) or s.locale(). If '").concat(name, "' is not a language here, give it a schema of its own instead, e.g. { ").concat(name, ": s.enum(\u2026) }."),
+        fixes: undefined
+      })
+    };
+  }
+  if (fixes.includes("record:fill-keys")) {
+    var _value2 = error.value;
+    if (getSitemapTree._typeof(_value2) !== "object" || _value2 === null) {
+      return {
+        status: "remaining",
+        error: getSitemapTree._objectSpread2(getSitemapTree._objectSpread2({}, error), {}, {
+          message: "Expected record key validation error to have a 'value' object. Found: ".concat(getSitemapTree._typeof(_value2), ". ").concat(TYPE_ERROR_MESSAGE),
+          typeError: true,
+          fixes: undefined
+        })
+      };
+    }
+    var _ref8 = _value2,
+      present = _ref8.present,
+      declared = _ref8.declared;
     if (!Array.isArray(present)) {
       return {
         status: "remaining",
@@ -5206,7 +5265,8 @@ function resolveSchemaSourceFixes(validationErrors, snapshot) {
  *
  * THE question the whole feature turns on. A locale scope is a subtree in one
  * language, and three things open one: a `locale` field on an object, a record
- * keyed by `s.locale()`, and a locale segment in a segmented key. Once this can
+ * keyed by `s.locale()`, and a locale parameter in a router's key
+ * (`s.router(router, { locale: … }, item)`, where the URL names the language). Once this can
  * be answered from the schema and the source alone, everything downstream falls
  * out of it — the Studio's locale filter, deep links, `<html lang>`, and knowing
  * what to translate from and into.
@@ -5235,7 +5295,79 @@ function localeAt(path, snapshot) {
     return null;
   }
   var segments = modulePath ? core.Internal.splitModulePath(modulePath) : [];
-  return walk(schema, source, segments, available);
+  return walk(schema, source, segments, available, moduleFilePath);
+}
+
+/**
+ * The language a locale schema's value MEANS, or `null` if it means none of
+ * the project's.
+ *
+ * `s.locale()` stores the tag itself. An enum with `.locales(...)` stores a
+ * value that stands for one — `nb` for `nb-NO` — and, on a router parameter,
+ * `null` for a URL that left the segment out, which `{ null: tag }` names.
+ * Anything else is not a locale and means nothing here.
+ *
+ * Callers reading a FIELD pass only strings: a field that holds `null` has no
+ * language, whatever its schema says about URLs.
+ */
+function localeMeantBy(schema, value, available) {
+  if (schema.type === "locale") {
+    return value === null ? null : core.localeOfValue(value, available);
+  }
+  if (schema.type === "enum" && schema.locales !== undefined) {
+    var tag = enumLocaleTag(schema, value);
+    return tag === undefined ? null : core.localeOfValue(tag, available);
+  }
+  return null;
+}
+
+/**
+ * The tag an enum's `.locales(...)` maps a value to, as written — `null` is
+ * the `{ null }` mapping — or `undefined` where it maps none.
+ *
+ * An own property: a plain object inherits `toString` and the rest, and an
+ * enum value is allowed to be spelled like one.
+ */
+function enumLocaleTag(schema, value) {
+  if (value === null) {
+    return schema.nullLocale;
+  }
+  return schema.locales !== undefined && Object.prototype.hasOwnProperty.call(schema.locales, value) ? schema.locales[value] : undefined;
+}
+
+/**
+ * Whether a schema is a locale: `s.locale()`, or an enum `.locales(...)` made
+ * one.
+ */
+function isLocaleSchema(schema) {
+  return schema.type === "locale" || schema.type === "enum" && schema.locales !== undefined;
+}
+
+/**
+ * The language a router's key is in, where one of its route parameters is a
+ * locale — `/nb/blog/hei` is `nb-NO` when `locale` maps `nb` to it.
+ */
+function localeOfRouteKey(schema, moduleFilePath, key, available) {
+  if (schema.params === undefined || schema.router === undefined) {
+    return null;
+  }
+  var pattern = core.routePatternOf(schema.router, moduleFilePath);
+  if (pattern === null) {
+    return null;
+  }
+  var values = core.matchRoutePattern(key, pattern);
+  if (values === null) {
+    return null;
+  }
+  for (var _i = 0, _Object$entries = Object.entries(schema.params); _i < _Object$entries.length; _i++) {
+    var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+      name = _Object$entries$_i[0],
+      param = _Object$entries$_i[1];
+    if (isLocaleSchema(param) && Object.prototype.hasOwnProperty.call(values, name)) {
+      return localeMeantBy(param, values[name], available);
+    }
+  }
+  return null;
 }
 
 /**
@@ -5250,7 +5382,7 @@ function localeAt(path, snapshot) {
  * these can fire on a well-formed path; taking the innermost is what makes the
  * answer well-defined while a project is mid-fix.
  */
-function walk(schema, source, segments, available) {
+function walk(schema, source, segments, available, moduleFilePath) {
   var entered = enter(schema, source, available);
   var locale = entered.locale;
   var currentSchema = entered.schema;
@@ -5264,14 +5396,21 @@ function walk(schema, source, segments, available) {
         return locale;
       }
       if (currentSchema.type === "record") {
-        var _currentSchema$key;
-        if (((_currentSchema$key = currentSchema.key) === null || _currentSchema$key === void 0 ? void 0 : _currentSchema$key.type) === "locale") {
+        if (currentSchema.key !== undefined && isLocaleSchema(currentSchema.key)) {
           // In a locale-keyed record the KEY is the language, so the segment we
-          // are about to take is the answer.
-          var resolved = core.localeOfValue(segment, available);
+          // are about to take is the answer — the tag itself for `s.locale()`,
+          // the tag it stands for when the key is an enum with `.locales()`.
+          var resolved = localeMeantBy(currentSchema.key, segment, available);
           if (resolved !== null) {
             locale = resolved;
           }
+        } else if (currentSchema.params !== undefined) {
+          // A router whose URL names the language: the key is a URL, and one of
+          // its parameters is the answer.
+          var _resolved = localeOfRouteKey(currentSchema, moduleFilePath, segment, available);
+          if (_resolved !== null) {
+            locale = _resolved;
+          }
         }
         currentSchema = currentSchema.item;
       } else if (currentSchema.type === "array") {
@@ -5327,18 +5466,18 @@ function localeOfObjectField(schema, source, available) {
   if (schema.type !== "object" || !isJsonObject(source)) {
     return null;
   }
-  for (var _i = 0, _Object$entries = Object.entries(schema.items); _i < _Object$entries.length; _i++) {
-    var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
-      key = _Object$entries$_i[0],
-      item = _Object$entries$_i[1];
-    if (item.type !== "locale") {
+  for (var _i2 = 0, _Object$entries2 = Object.entries(schema.items); _i2 < _Object$entries2.length; _i2++) {
+    var _Object$entries2$_i = _slicedToArray(_Object$entries2[_i2], 2),
+      key = _Object$entries2$_i[0],
+      item = _Object$entries2$_i[1];
+    if (!isLocaleSchema(item)) {
       continue;
     }
     var value = source[key];
     if (typeof value !== "string") {
       return null;
     }
-    return core.localeOfValue(value, available);
+    return localeMeantBy(item, value, available);
   }
   return null;
 }
@@ -6227,6 +6366,7 @@ function isSkippableFixCode(fix) {
     case "video:check-gallery":
     case "router:check-route":
     case "locale:check-locale":
+    case "router:check-locale-param":
     case "record:fill-keys":
     case "jsonValues:extract-entry":
       // `jsonValues:extract-entry` is an entry inlined in the `.val.ts`. The
@@ -6388,6 +6528,63 @@ function isSkippedSource(sourceMimeType, targetMimeType, needsDownscale) {
   return sourceMimeType === targetMimeType && !needsDownscale;
 }
 
+/**
+ * The types the Studio can write with WebAssembly when the canvas cannot.
+ *
+ * libwebp, compiled to WebAssembly (`@jsquash/webp`, loaded by
+ * `packages/ui/spa/utils/webpWasm.ts`). One entry because `encode` has one
+ * `type`; a second type is a second encoder to host, not a second string here.
+ */
+var WASM_ENCODED_MIME_TYPES = ["image/webp"];
+
+/**
+ * Whether to encode the canvas's pixels with WebAssembly, given what the
+ * canvas's own encoder handed back.
+ *
+ * `canvas.toBlob` answers a type it cannot write with a PNG instead of an error,
+ * and Safari -- the browser people take their photos in -- cannot write WebP.
+ * The pixels on that canvas are already decoded, oriented and scaled, so the
+ * only thing missing is the encoder, and libwebp in WebAssembly is that.
+ *
+ * Only then, and that is what keeps the WebAssembly lazy: a browser whose
+ * canvas wrote the type is never asked to download an encoder, even when its
+ * WebP then loses to the original on size -- a second encoder of the same
+ * format would lose for the same reason.
+ *
+ * `null` -- no blob at all -- is not "cannot write this type" either. It is a
+ * canvas that failed to serialize anything, under memory pressure for instance,
+ * and says nothing about WebP: a Chromium tab that hits it is still a browser
+ * that writes WebP, and must not start downloading an encoder because of it.
+ */
+function shouldEncodeWithWasm(input) {
+  return WASM_ENCODED_MIME_TYPES.includes(input.targetMimeType) && input.canvasOutputType !== null && input.canvasOutputType !== input.targetMimeType;
+}
+
+/**
+ * What to scale an image down to when nothing could write the type asked for:
+ * the source's own format, when it is one every canvas can write.
+ *
+ * The second fallback, after {@link shouldEncodeWithWasm}: it is what a browser
+ * whose canvas cannot write WebP gets when the WebAssembly encoder could not be
+ * loaded either (offline, a blocked host, a failed instantiation). Without it,
+ * `chooseEncoded` would rightly refuse the canvas's PNG and upload the original
+ * -- every photo at the camera's full size, the one case `maxWidth` exists
+ * for. Scaling it down as a JPEG keeps the half of `encode` this browser can do.
+ *
+ * Only when a downscale is needed: re-encoding a JPEG that already fits, as a
+ * JPEG, is a second generation of loss for a few percent. And never into a
+ * type `accept` refuses, for the reason `isMimeTypeAccepted` gives.
+ */
+function fallbackMimeType(sourceMimeType, needsDownscale, accept) {
+  if (!needsDownscale) {
+    return null;
+  }
+  if (sourceMimeType !== "image/jpeg" && sourceMimeType !== "image/png") {
+    return null;
+  }
+  return isMimeTypeAccepted(sourceMimeType, accept) ? sourceMimeType : null;
+}
+
 /**
  * Whether to upload what the encoder produced, or the file that was picked.
  *
@@ -8584,6 +8781,7 @@ exports.VAL_CANVAS_MESSAGE = getSitemapTree.VAL_CANVAS_MESSAGE;
 exports.VAL_CANVAS_PARAM = getSitemapTree.VAL_CANVAS_PARAM;
 exports.VAL_CONFIG_SESSION_STORAGE_KEY = getSitemapTree.VAL_CONFIG_SESSION_STORAGE_KEY;
 exports.VAL_THEME_SESSION_STORAGE_KEY = getSitemapTree.VAL_THEME_SESSION_STORAGE_KEY;
+exports.formatRoutePattern = getSitemapTree.formatRoutePattern;
 exports.getNextAppRouterSourceFolder = getSitemapTree.getNextAppRouterSourceFolder;
 exports.getPageRouterSitemapTree = getSitemapTree.getPageRouterSitemapTree;
 exports.getPageRouterSourceFolder = getSitemapTree.getPageRouterSourceFolder;
@@ -8673,6 +8871,7 @@ exports.ValCommit = ValCommit;
 exports.ValDeployment = ValDeployment;
 exports.VideoOptions = VideoOptions;
 exports.VideoStreamOption = VideoStreamOption;
+exports.WASM_ENCODED_MIME_TYPES = WASM_ENCODED_MIME_TYPES;
 exports.accentRamp = accentRamp;
 exports.buildDuplicatePatch = buildDuplicatePatch;
 exports.buildEmptyAtPathPatch = buildEmptyAtPathPatch;
@@ -8691,7 +8890,9 @@ exports.createValClient = createValClient;
 exports.declaredLocales = declaredLocales;
 exports.describeContainerAtPath = describeContainerAtPath;
 exports.emptyOf = emptyOf;
+exports.enumLocaleTag = enumLocaleTag;
 exports.explainIncompatible = explainIncompatible;
+exports.fallbackMimeType = fallbackMimeType;
 exports.filterBlockingValidationErrors = filterBlockingValidationErrors;
 exports.filterRoutesByPatterns = filterRoutesByPatterns;
 exports.findSimilar = findSimilar;
@@ -8706,8 +8907,10 @@ exports.getRefParts = getRefParts;
 exports.getRoutesOf = getRoutesOf;
 exports.getRoutesWithModulePaths = getRoutesWithModulePaths;
 exports.getSourceAt = getSourceAt;
+exports.getValDemo = getValDemo;
 exports.indexModule = indexModule;
 exports.isInsidePatchSetPath = isInsidePatchSetPath;
+exports.isLocaleSchema = isLocaleSchema;
 exports.isMimeTypeAccepted = isMimeTypeAccepted;
 exports.isRemoteSchema = isRemoteSchema;
 exports.isSchemaSourceFixError = isSchemaSourceFixError;
@@ -8716,6 +8919,7 @@ exports.joinSharedChanges = joinSharedChanges;
 exports.keyOfRecordPath = keyOfRecordPath;
 exports.levenshtein = levenshtein;
 exports.localeAt = localeAt;
+exports.localeMeantBy = localeMeantBy;
 exports.memoizePerRequest = memoizePerRequest;
 exports.newestCommitSha = newestCommitSha;
 exports.parseArtifacts = parseArtifacts;
@@ -8751,6 +8955,7 @@ exports.safeParsePatch = safeParsePatch;
 exports.schemaErrorsOf = schemaErrorsOf;
 exports.schemaTypesOfPath = schemaTypesOfPath;
 exports.selectionClosure = selectionClosure;
+exports.shouldEncodeWithWasm = shouldEncodeWithWasm;
 exports.sideFiles = sideFiles;
 exports.sideSource = sideSource;
 exports.sourcePathOfChild = sourcePathOfChild;