@valbuild/shared 0.140.2 → 0.142.0

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

@@ -1158,13 +1158,16 @@ var SerializedRecordSchema = z.lazy(function () {
     type: z.literal("record"),
     item: SerializedSchema,
     opt: z["boolean"](),
-    // Optional gallery marker for files/images
-    mediaType: z.union([z.literal("files"), z.literal("images")]).optional(),
+    // Optional gallery marker for files/images/videos
+    mediaType: z.union([z.literal("files"), z.literal("images"), z.literal("videos")]).optional(),
     // Optional legacy gallery metadata
     accept: z.string().optional(),
     dir: z.string().optional(),
     remote: z["boolean"]().optional(),
     encode: ImageEncodeOption.optional(),
+    // A videoset's: see `VideoStreamOption` below for why it is spelled
+    // out rather than passed through.
+    stream: VideoStreamOption.optional(),
     alt: SerializedSchema.optional(),
     moduleMetadata: z.record(z.string(), z.record(z.string(), z.any())).optional()
   })).passthrough());
@@ -1198,6 +1201,29 @@ var SerializedFileSchema = z.object(_objectSpread2(_objectSpread2({}, commonSche
   remote: z["boolean"]().optional(),
   referencedModule: z.string().optional()
 }));
+
+// `stream` is the one option that changes what an upload BECOMES, so it is
+// declared field by field: these z.objects strip unknown keys, and a stream
+// dropped in transit is a Studio that uploads a 2 GB mp4 where an HLS stream
+// was asked for.
+var VideoStreamOption = z.union([z.literal(false), z.object({
+  type: z.literal("hls"),
+  renditions: z.array(z.number()).optional(),
+  segmentDuration: z.number().optional()
+})]);
+var VideoOptions = z.object({
+  dir: z.string().optional(),
+  accept: z.string().optional(),
+  stream: VideoStreamOption.optional()
+});
+var SerializedVideoSchema = z.object(_objectSpread2(_objectSpread2({}, commonSchemaFields), {}, {
+  type: z.literal("video"),
+  options: VideoOptions.optional(),
+  opt: z["boolean"](),
+  remote: z["boolean"]().optional(),
+  // The `s.videoset()` a set-backed field picks from.
+  referencedModule: z.string().optional()
+}));
 var DateOptions = z.object({
   from: z.string().optional(),
   to: z.string().optional()
@@ -1288,7 +1314,7 @@ var SerializedValViewSchema = z.object({
   hidden: z["boolean"]().optional(),
   description: z.string().optional()
 });
-var SerializedSchema = z.union([SerializedStringSchema, SerializedLiteralSchema, SerializedBooleanSchema, SerializedNumberSchema, SerializedObjectSchema, SerializedArraySchema, SerializedDiscriminatedUnionSchema, SerializedEnumSchema, SerializedRichTextSchema, SerializedRecordSchema, SerializedKeyOfSchema, SerializedRouteSchema, SerializedLocaleSchema, SerializedFileSchema, SerializedDateSchema, SerializedDateTimeSchema, SerializedColorSchema, SerializedCodeSchema, SerializedSettingsSchema, SerializedImageSchema, SerializedValViewSchema]);
+var SerializedSchema = z.union([SerializedStringSchema, SerializedLiteralSchema, SerializedBooleanSchema, SerializedNumberSchema, SerializedObjectSchema, SerializedArraySchema, SerializedDiscriminatedUnionSchema, SerializedEnumSchema, SerializedRichTextSchema, SerializedRecordSchema, SerializedKeyOfSchema, SerializedRouteSchema, SerializedLocaleSchema, SerializedFileSchema, SerializedDateSchema, SerializedDateTimeSchema, SerializedColorSchema, SerializedCodeSchema, SerializedSettingsSchema, SerializedImageSchema, SerializedVideoSchema, SerializedValViewSchema]);
 
 var ValCommit = z.object({
   commitSha: z.string(),
@@ -1469,12 +1495,12 @@ var ValConfig = z.object({
   project: z.string().optional(),
   root: z.string().optional(),
   files: z.object({
-    directory: z.string() // TODO: validate that it is prefixed by /public/
+    remote: z["boolean"]().optional()
   }).optional(),
   gitCommit: z.string().optional(),
   gitBranch: z.string().optional()
 });
-var ValidationFixZ = z.union([z.literal("image:add-metadata"), z.literal("image:check-metadata"), z.literal("image:check-remote"), z.literal("image:upload-remote"), z.literal("image:download-remote"), z.literal("images:check-remote"), z.literal("images:upload-remote"), z.literal("file:add-metadata"), z.literal("file:check-metadata"), z.literal("file:check-remote"), z.literal("file:upload-remote"), z.literal("file:download-remote"), z.literal("files:check-remote"), z.literal("files:upload-remote"), z.literal("keyof:check-keys"), z.literal("router:check-route"), z.literal("locale:check-locale"), z.literal("record:fill-keys"), z.literal("images:check-unique-folder"), z.literal("files:check-unique-folder"), z.literal("images:check-all-files"), z.literal("files:check-all-files"), z.literal("jsonValues:extract-entry"), z.literal("view:check-module")]);
+var ValidationFixZ = z.union([z.literal("image:add-metadata"), z.literal("image:check-metadata"), z.literal("image:check-remote"), z.literal("image:upload-remote"), z.literal("image:download-remote"), z.literal("images:check-remote"), z.literal("images:upload-remote"), z.literal("file:add-metadata"), z.literal("video:add-metadata"), z.literal("video:upload-remote"), z.literal("video:download-remote"), z.literal("videos:add-metadata"), z.literal("videos:check-remote"), z.literal("videos:upload-remote"), z.literal("file:check-metadata"), z.literal("file:check-remote"), z.literal("file:upload-remote"), z.literal("file:download-remote"), z.literal("files:check-remote"), z.literal("files:upload-remote"), z.literal("keyof:check-keys"), z.literal("router:check-route"), z.literal("locale:check-locale"), z.literal("record:fill-keys"), z.literal("images:check-unique-folder"), z.literal("files:check-unique-folder"), z.literal("images:check-all-files"), z.literal("files:check-all-files"), z.literal("videos:check-unique-folder"), z.literal("videos:check-all-files"), z.literal("jsonValues:extract-entry"), z.literal("view:check-module")]);
 var ValidationError = z.object({
   message: z.string(),
   value: z.unknown().optional(),
@@ -1569,6 +1595,14 @@ var PublishRefusal = z.object({
   message: z.string()
 });
 
+/** See `proposal` on `/stat`. */
+var StatProposal = z.object({
+  /** Twenty hex characters, the hash of what it was made from. */
+  name: z.string(),
+  /** `val/p/<name>`. */
+  branch: z.string()
+});
+
 /**
  * A patch group: the set of patches one user has chosen to publish.
  *
@@ -1999,7 +2033,13 @@ var Api = {
            * connected ones by commit.
            */
           publishJobs: z["boolean"]().optional(),
-          publishRefusal: PublishRefusal.optional()
+          publishRefusal: PublishRefusal.optional(),
+          /**
+           * The proposal this server runs at the address of, or absent
+           * on the site. What the Studio's switcher says it is in, and
+           * where its Save goes (valbuild/home `docs/proposals.md`).
+           */
+          proposal: StatProposal.optional()
         }), z.object({
           type: z.literal("use-websocket"),
           url: z.string(),
@@ -2117,7 +2157,13 @@ var Api = {
            * connected ones by commit.
            */
           publishJobs: z["boolean"]().optional(),
-          publishRefusal: PublishRefusal.optional()
+          publishRefusal: PublishRefusal.optional(),
+          /**
+           * The proposal this server runs at the address of, or absent
+           * on the site. What the Studio's switcher says it is in, and
+           * where its Save goes (valbuild/home `docs/proposals.md`).
+           */
+          proposal: StatProposal.optional()
         })])
       })])
     }
@@ -2203,6 +2249,60 @@ var Api = {
       })
     }
   },
+  /**
+   * The content service's proposals API, reached through this deployment:
+   * list, open, read, rename, close, reopen and retry a setup
+   * (valbuild/home `docs/proposals.md`, Flow B).
+   *
+   * The same arrangement as `/publish-api`, for the same reasons: the browser
+   * holds a session for this origin and no credential content accepts, so
+   * this server checks the session, sends the project's key with the person's
+   * profile id beside it -- a proposal is opened, renamed and closed by
+   * somebody -- and carries content's status and body back unread. The sub-path
+   * is content's, after `/proposals`; `ValOpsHttp.proposalsApi` holds the
+   * allow list. A save is not here: it is `/save`, which a proposal's server
+   * sends to the proposal's own route.
+   */
+  "/proposals-api": {
+    GET: {
+      req: {
+        path: z.string().optional(),
+        cookies: {
+          val_session: z.string().optional()
+        }
+      },
+      res: z.object({
+        status: z.number(),
+        json: z.unknown()
+      })
+    },
+    POST: {
+      req: {
+        path: z.string().optional(),
+        body: z.unknown().optional(),
+        cookies: {
+          val_session: z.string().optional()
+        }
+      },
+      res: z.object({
+        status: z.number(),
+        json: z.unknown()
+      })
+    },
+    PATCH: {
+      req: {
+        path: z.string().optional(),
+        body: z.unknown().optional(),
+        cookies: {
+          val_session: z.string().optional()
+        }
+      },
+      res: z.object({
+        status: z.number(),
+        json: z.unknown()
+      })
+    }
+  },
   "/upload/patches": {
     POST: {
       req: {
@@ -2732,6 +2832,32 @@ var Api = {
       })])
     }
   },
+  /**
+   * In a proposal: the SITE's Source for every module the proposal has saved,
+   * as the build it is based on has it. What Compare with the site diffs the
+   * proposal against -- saved and unsaved alike -- because the Studio's own
+   * base Source there is the proposal's last save. 404 anywhere that is not a
+   * proposal's address. valbuild/home `docs/proposals.md`.
+   */
+  "/proposal-site-sources": {
+    GET: {
+      req: {
+        cookies: {
+          val_session: z.string().optional()
+        }
+      },
+      res: z.union([unauthorizedResponse, z.object({
+        status: z.literal(404),
+        json: GenericError
+      }), z.object({
+        status: z.literal(200),
+        json: z.object({
+          /** By module file path. A module absent here is the same in both. */
+          modules: z.record(z.string(), z.unknown())
+        })
+      })])
+    }
+  },
   "/profiles": {
     GET: {
       req: {
@@ -3187,11 +3313,23 @@ var Api = {
             return arg[0];
           }).optional(),
           remote: onlyOneStringQueryParam.optional()
+        },
+        // A `<video>` seeks with byte ranges, Safari will not play one from a
+        // server that ignores them, and HLS segments that are byte ranges of
+        // one file are fetched no other way.
+        headers: {
+          range: z.string().optional()
         }
       },
       res: z.union([unauthorizedResponse, notFoundResponse, z.object({
         status: z.literal(200),
         body: z["instanceof"](ReadableStream)
+      }), z.object({
+        status: z.literal(206),
+        body: z["instanceof"](ReadableStream)
+      }), z.object({
+        status: z.literal(416),
+        json: GenericError
       })])
     }
   },
@@ -5315,7 +5453,7 @@ function emptyOf(schema, context) {
     // language nobody chose, which is the thing this whole feature exists to
     // make visible.
     return (_context$selectedLoca = context === null || context === void 0 ? void 0 : context.selectedLocale) !== null && _context$selectedLoca !== void 0 ? _context$selectedLoca : "";
-  } else if (schema.type === "file" || schema.type === "image") {
+  } else if (schema.type === "file" || schema.type === "image" || schema.type === "video") {
     return null; // returning null is the only thing we can do, however, it means that the patches cannot be applied yet since that might fail
   } else if (schema.type === "literal") {
     return schema.value;
@@ -5525,6 +5663,14 @@ function checkGallerySchema(moduleSchema) {
   if (moduleSchema.type === "record" && moduleSchema.mediaType === "images") {
     return null;
   }
+  if (moduleSchema.type === "record" && moduleSchema.mediaType === "videos") {
+    // Said outright rather than as "not an images gallery": a set of videos
+    // looks like a gallery from here, and the tool can do nothing with one.
+    return {
+      kind: "error",
+      message: "Module is a video set (s.videoset()), not an images gallery. Videos cannot be added or removed by this tool: upload them in Val Studio."
+    };
+  }
   if (moduleSchema.type === "image") {
     return {
       kind: "wrong-tool",
@@ -5619,17 +5765,32 @@ var GALLERY_REDIRECT = {
   reason: "Destination is a media gallery (s.imageset() / s.fileset()). Gallery entries are keyed by file path and carry a file on disk, so they cannot be created with a plain patch. Use add_session_image_to_gallery."
 };
 
-/** An `s.imageset()` / `s.fileset()` record: a gallery, not an ordinary record. */
+/**
+ * A video set's entries are keyed by a file too, and a stream's by a
+ * directory of them — and there is no tool to send them to: a video is
+ * uploaded (and, for a stream, transcoded) in the Studio.
+ */
+var VIDEOSET_REFUSAL = {
+  kind: "error",
+  message: "Destination is a video set (s.videoset()). Its entries are keyed by file path and carry video files, so they cannot be created with a plain patch, and no tool here uploads a video: add it in Val Studio."
+};
+
+/** An `s.imageset()` / `s.fileset()` / `s.videoset()` record: a gallery, not an ordinary record. */
 function isGallery(schema) {
   return schema.type === "record" && schema.mediaType !== undefined;
 }
+
+/** Where to send someone whose destination is (in) the gallery `schema`. */
+function galleryRedirect(schema) {
+  return schema.type === "record" && schema.mediaType === "videos" ? VIDEOSET_REFUSAL : GALLERY_REDIRECT;
+}
 function decideOp(moduleSchema, destinationPath) {
   // The DESTINATION itself, checked before its parent: `["gallery"]` resolves
   // its parent to the enclosing object and would otherwise look like an
   // ordinary `replace` that overwrites a whole gallery.
   var destination = resolveSerializedSchemaAtPath(moduleSchema, destinationPath);
   if (destination.kind === "gallery-traversed") {
-    return GALLERY_REDIRECT;
+    return galleryRedirect(destination.schema);
   }
   if (destination.kind === "richtext") {
     return {
@@ -5640,7 +5801,7 @@ function decideOp(moduleSchema, destinationPath) {
   }
   if (destination.kind === "leaf") {
     if (isGallery(destination.schema)) {
-      return GALLERY_REDIRECT;
+      return galleryRedirect(destination.schema);
     }
     // A richtext value the path lands exactly ON resolves as a leaf, not as
     // `kind: "richtext"` (which only fires when the walk continues INTO it).
@@ -5677,7 +5838,7 @@ function decideOp(moduleSchema, destinationPath) {
   // destination is a gallery entry; `isGallery` catches the case where the
   // parent IS the gallery and the destination is a new entry key in it.
   if (parent.kind === "gallery-traversed" || isGallery(parent.schema)) {
-    return GALLERY_REDIRECT;
+    return galleryRedirect(parent.schema);
   }
   var schema = parent.schema;
   if (schema.type === "array" || schema.type === "record") {
@@ -5998,6 +6159,14 @@ function isSkippableFixCode(fix) {
     case "file:check-remote":
     case "files:check-remote":
     case "files:upload-remote":
+    case "video:add-metadata": // the Studio writes it on upload; --fix for the rest
+    case "video:upload-remote":
+    case "video:download-remote":
+    case "videos:add-metadata": // as `video:add-metadata`, for a set's entry
+    case "videos:check-remote":
+    case "videos:upload-remote":
+    case "videos:check-unique-folder":
+    case "videos:check-all-files":
     case "images:check-unique-folder":
     case "files:check-unique-folder":
     case "images:check-all-files":
@@ -6322,8 +6491,8 @@ function traverseSchemaSource(source, schema, path, callback) {
     return;
   }
 
-  // Handle file/image
-  if (schema.type === "file" || schema.type === "image") {
+  // Handle file/image/video
+  if (schema.type === "file" || schema.type === "image" || schema.type === "video") {
     if (source && _typeof(source) === "object" && "path" in source && typeof source.path === "string") {
       callback({
         source: source,
@@ -6670,8 +6839,8 @@ function indexModule(searchIndex, moduleFilePath, source, schema) {
       // Use first 50 chars as label
       label = searchText.substring(0, 50) || "richtext";
     }
-    // Handle file/image
-    else if (schema.type === "file" || schema.type === "image") {
+    // Handle file/image/video
+    else if (schema.type === "file" || schema.type === "image" || schema.type === "video") {
       if (source !== null && _typeof(source) === "object" && "path" in source && typeof source.path === "string") {
         // The label is the bare filename - the folder is shown separately in
         // the UI - but both are searchable.
@@ -7761,4 +7930,4 @@ function parse(schema, body, call) {
   return parsed.data;
 }
 
-export { AA_LARGE, AA_TEXT, Api, BRAND_CONTRAST_PAIRS, BinaryFileRef, CodeOptions, ColorOptions, DEFAULT_ERROR_MESSAGE, DateOptions, ENCODE_DEFAULTS, ENCODE_MIME_TYPE_OF, FileOptions, HistoricalCommit, HistoricalModule, HistoricalPatchSet, HistoryError, ImageEncodeOption, ImageOptions, JSONValue, JSON_ENTRIES_BATCH_MAX, ModuleComparison, NEVER_ENCODED, ParentRef$1 as ParentRef, Patch, PatchBlock, PatchGroup, PatchId, PatchJSON, PublishProtocolError, RAMP_STEPS, RemirrorBr, RemirrorBulletList, RemirrorHeading, RemirrorImage, RemirrorJSON, RemirrorLinkMark, RemirrorListItem, RemirrorOrderedList, RemirrorParagraph, RemirrorText, RemirrorTextMark, RestoreVerdict, RichTextOptions, SCHEMA_SOURCE_FIXES, SerializedArraySchema, SerializedBooleanSchema, SerializedCodeSchema, SerializedColorSchema, SerializedDateSchema, SerializedDateTimeSchema, SerializedDiscriminatedUnionSchema, SerializedEnumSchema, SerializedFileSchema, SerializedImageSchema, SerializedKeyOfSchema, SerializedLiteralSchema, SerializedLocaleSchema, SerializedNumberSchema, SerializedObjectSchema, SerializedRecordSchema, SerializedRichTextSchema, SerializedRouteSchema, SerializedSchema, SerializedSettingsSchema, SerializedStringSchema, SerializedValViewSchema, SharedValConfig, VAL_ENABLE_COOKIE_NAME, VAL_GREEN_RAMP, VAL_SESSION_COOKIE, VAL_STATE_COOKIE, VAL_STUDIO_HEADER, ValCommit, ValDeployment, accentRamp, buildDuplicatePatch, buildEmptyAtPathPatch, buildFileRefValue, buildImageGalleryPatch, buildRemoveImageGalleryEntryPatch, buildSearchIndex, chainHeadOf, checkCompatibility, chooseEncoded, concatModulePath, contrastRatio, createRegExpFromPattern, createSearchIndex, createValClient, declaredLocales, describeContainerAtPath, emptyOf, explainIncompatible, filterBlockingValidationErrors, filterRoutesByPatterns, findSimilar, fitWithin, flattenRichText, getErrorMessageFromUnknownJson, getFilenameFromRef, getInlineImgInfo, getKeyOfRecordAt, getRefParts, getRoutesOf, getRoutesWithModulePaths, getSourceAt, indexModule, isMimeTypeAccepted, isRemoteSchema, isSchemaSourceFixError, isSkippedSource, keyOfRecordPath, levenshtein, localeAt, memoizePerRequest, newestCommitSha, parseArtifacts, parseBuildTarget, parseCancel, parseDeclare, parseDiscard, parseJob, parseNewestCiRun, parsePress, parseProblems, parseProjectSource, parsePromote, parsePublishToken, parseRenew, parseRequestStatus, parseStatus, parseUpdateTarget, parseVerify, partitionValidationErrors, performSearch, relativeLuminance, remirrorToRichTextSource, removeModule, resolveEncodeSettings, resolvePairGround, resolveSchemaSourceFixForError, resolveSchemaSourceFixes, resolveSerializedSchemaAtPath, richTextToRemirror, safeParsePatch, sourcePathOfChild, themeCustomProperties, toolNames, traverseSchemaSource, urlOf, validateRoutePatterns, withExtension };
+export { AA_LARGE, AA_TEXT, Api, BRAND_CONTRAST_PAIRS, BinaryFileRef, CodeOptions, ColorOptions, DEFAULT_ERROR_MESSAGE, DateOptions, ENCODE_DEFAULTS, ENCODE_MIME_TYPE_OF, FileOptions, HistoricalCommit, HistoricalModule, HistoricalPatchSet, HistoryError, ImageEncodeOption, ImageOptions, JSONValue, JSON_ENTRIES_BATCH_MAX, ModuleComparison, NEVER_ENCODED, ParentRef$1 as ParentRef, Patch, PatchBlock, PatchGroup, PatchId, PatchJSON, PublishProtocolError, RAMP_STEPS, RemirrorBr, RemirrorBulletList, RemirrorHeading, RemirrorImage, RemirrorJSON, RemirrorLinkMark, RemirrorListItem, RemirrorOrderedList, RemirrorParagraph, RemirrorText, RemirrorTextMark, RestoreVerdict, RichTextOptions, SCHEMA_SOURCE_FIXES, SerializedArraySchema, SerializedBooleanSchema, SerializedCodeSchema, SerializedColorSchema, SerializedDateSchema, SerializedDateTimeSchema, SerializedDiscriminatedUnionSchema, SerializedEnumSchema, SerializedFileSchema, SerializedImageSchema, SerializedKeyOfSchema, SerializedLiteralSchema, SerializedLocaleSchema, SerializedNumberSchema, SerializedObjectSchema, SerializedRecordSchema, SerializedRichTextSchema, SerializedRouteSchema, SerializedSchema, SerializedSettingsSchema, SerializedStringSchema, SerializedValViewSchema, SerializedVideoSchema, SharedValConfig, VAL_ENABLE_COOKIE_NAME, VAL_GREEN_RAMP, VAL_SESSION_COOKIE, VAL_STATE_COOKIE, VAL_STUDIO_HEADER, ValCommit, ValDeployment, VideoOptions, VideoStreamOption, accentRamp, buildDuplicatePatch, buildEmptyAtPathPatch, buildFileRefValue, buildImageGalleryPatch, buildRemoveImageGalleryEntryPatch, buildSearchIndex, chainHeadOf, checkCompatibility, chooseEncoded, concatModulePath, contrastRatio, createRegExpFromPattern, createSearchIndex, createValClient, declaredLocales, describeContainerAtPath, emptyOf, explainIncompatible, filterBlockingValidationErrors, filterRoutesByPatterns, findSimilar, fitWithin, flattenRichText, getErrorMessageFromUnknownJson, getFilenameFromRef, getInlineImgInfo, getKeyOfRecordAt, getRefParts, getRoutesOf, getRoutesWithModulePaths, getSourceAt, indexModule, isMimeTypeAccepted, isRemoteSchema, isSchemaSourceFixError, isSkippedSource, keyOfRecordPath, levenshtein, localeAt, memoizePerRequest, newestCommitSha, parseArtifacts, parseBuildTarget, parseCancel, parseDeclare, parseDiscard, parseJob, parseNewestCiRun, parsePress, parseProblems, parseProjectSource, parsePromote, parsePublishToken, parseRenew, parseRequestStatus, parseStatus, parseUpdateTarget, parseVerify, partitionValidationErrors, performSearch, relativeLuminance, remirrorToRichTextSource, removeModule, resolveEncodeSettings, resolvePairGround, resolveSchemaSourceFixForError, resolveSchemaSourceFixes, resolveSerializedSchemaAtPath, richTextToRemirror, safeParsePatch, sourcePathOfChild, themeCustomProperties, toolNames, traverseSchemaSource, urlOf, validateRoutePatterns, withExtension };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/shared",
-  "version": "0.140.2",
+  "version": "0.142.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.139.1"
+    "@valbuild/core": "0.141.0"
   },
   "files": [
     "CHANGELOG.md",