@valbuild/shared 0.136.10 → 0.138.0

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

@@ -1496,6 +1496,28 @@ var GenericError = z.object({
   message: z.string()
 });
 
+/**
+ * What answered when one URL was opened.
+ *
+ * The one place the Studio's `ExternalUrlProbeResult` and the server's
+ * `ProbeResult` meet, so the two cannot drift without this failing to parse.
+ */
+var ExternalUrlProbeResult = z.union([z.object({
+  kind: z.literal("answered"),
+  code: z.number(),
+  finalUrl: z.string(),
+  ms: z.number()
+}), z.object({
+  kind: z.literal("unreachable"),
+  message: z.string()
+}), z.object({
+  kind: z.literal("timeout"),
+  ms: z.number()
+}), z.object({
+  kind: z.literal("skipped"),
+  message: z.string()
+})]);
+
 /**
  * Why a publish cannot happen, in a form the Studio can show.
  *
@@ -1934,6 +1956,13 @@ var Api = {
            * which is the one the Studio has always told.
            */
           sourceMode: z.union([z.literal("managed"), z.literal("connected")]).optional(),
+          /**
+           * A press of Publish is a publish JOB: every managed project,
+           * and a connected one hosted on the platform. Absent from a
+           * server that predates it: managed projects publish as jobs,
+           * connected ones by commit.
+           */
+          publishJobs: z["boolean"]().optional(),
           publishRefusal: PublishRefusal.optional()
         }), z.object({
           type: z.literal("use-websocket"),
@@ -1984,6 +2013,13 @@ var Api = {
            * content service that predates it sends nothing.
            */
           headPatchId: PatchId.nullable().optional(),
+          /**
+           * The version of the chain `headPatchId` was read at, bumped by
+           * every write and delete. `/stat` has more than one caller, so
+           * answers can land out of order; a client keeps the head with the
+           * highest version. Optional, for the same reason `headPatchId` is.
+           */
+          headVersion: z.number().optional(),
           commits: z.array(ValCommit),
           /**
            * The publishes the content service knows about.
@@ -2024,6 +2060,13 @@ var Api = {
            * which is the one the Studio has always told.
            */
           sourceMode: z.union([z.literal("managed"), z.literal("connected")]).optional(),
+          /**
+           * A press of Publish is a publish JOB: every managed project,
+           * and a connected one hosted on the platform. Absent from a
+           * server that predates it: managed projects publish as jobs,
+           * connected ones by commit.
+           */
+          publishJobs: z["boolean"]().optional(),
           publishRefusal: PublishRefusal.optional()
         })])
       })])
@@ -2137,6 +2180,42 @@ var Api = {
       })])
     }
   },
+  /**
+   * Open a batch of external URLs and report what answered.
+   *
+   * A batch rather than one URL because the client checks a list, and a POST
+   * rather than a GET because the list is the input and does not belong in a
+   * URL or a cache.
+   *
+   * The server makes outbound requests to addresses this body supplies, which
+   * is SSRF by construction - see `linkCheck/addressGuard.ts` for the deny
+   * list that makes it safe, and `docs/plans/external-page-link-checks.md` for
+   * why it is a deny list on the RESOLVED address.
+   */
+  "/external-urls/check": {
+    POST: {
+      req: {
+        body: z.object({
+          /*
+           * Capped, and the cap is the point rather than a formality: each URL
+           * is an outbound connection, and a body is not allowed to ask this
+           * server to open a thousand of them. The client sends ten at a time.
+           */
+          urls: z.array(z.string()).min(1).max(20)
+        }),
+        cookies: {
+          val_session: z.string().optional()
+        }
+      },
+      res: z.union([unauthorizedResponse, z.object({
+        status: z.literal(200),
+        json: z.object({
+          /** Keyed by the URL exactly as it was asked about. */
+          results: z.record(z.string(), ExternalUrlProbeResult)
+        })
+      })])
+    }
+  },
   "/direct-file-upload-settings": {
     POST: {
       req: {
@@ -2188,7 +2267,14 @@ var Api = {
            * groups, and a client that predates this is deleting correctly,
            * just not repairing.
            */
-          unstagePatchIds: z.array(PatchId).optional()
+          unstagePatchIds: z.array(PatchId).optional(),
+          /*
+           * Answer with `{ deleted, headVersion }` rather than the bare id
+           * array. Asked for rather than always sent, because the array is
+           * what a Studio bundle from before this parses — and a tab left
+           * open across a deploy still runs one.
+           */
+          reportHeadVersion: z.literal(true).optional()
         }).optional(),
         cookies: {
           val_session: z.string().optional()
@@ -2202,7 +2288,16 @@ var Api = {
         })
       }), z.object({
         status: z.literal(200),
-        json: z.array(PatchId)
+        json: z.union([z.array(PatchId), z.object({
+          deleted: z.array(PatchId),
+          /**
+           * The chain version this delete moved the branch to. Absent when
+           * it moved nothing, or the content service does not version its
+           * chain. Compared with `headVersion` on `/stat`: an answer read
+           * before the delete would put the deleted head back.
+           */
+          headVersion: z.number().optional()
+        })])
       })])
     },
     PUT: {
@@ -2250,7 +2345,14 @@ var Api = {
         json: z.object({
           newPatchIds: z.array(PatchId),
           parentRef: ParentRef,
-          patchGroupId: z.string().optional()
+          patchGroupId: z.string().optional(),
+          /**
+           * The chain version the last of these patches made, comparable with
+           * `headVersion` on `/stat`. A client keeps the highest version, so a
+           * stat read before this write does not put its parent back behind
+           * it. Absent in `fs` mode and from an older content service.
+           */
+          headVersion: z.number().optional()
         })
       })])
     },
@@ -2506,39 +2608,49 @@ var Api = {
       })])
     }
   },
-  /**
-   * The `.val.ts` text of every module that changed since the RUNNING build,
-   * with every commit since it applied, for a build made in the browser.
-   *
-   * A Studio build starts from the source stored with the live build. A commit
-   * whose own publish failed -- or the first commit of a project that started
-   * as a copy of a template -- is in content and in no stored source, so a build
-   * that added only its own save's files shipped without it. Only this server
-   * can render those commits back into text: content keeps a managed project's
-   * content as Source, not as files.
-   *
-   * Committed patches only. A pending one is somebody's unpublished work, and
-   * is not this build's to ship. 409 where there is nothing to answer with: a
-   * project with a repository, or a build that did not embed its source.
-   */
-  "/built-source": {
-    GET: {
+  "/publish-job-prepare": {
+    POST: {
       req: {
+        body: z.object({
+          jobId: z.string().regex(/^[A-Za-z0-9_-]{1,100}$/),
+          tab: z.string().regex(/^[A-Za-z0-9_-]{1,100}$/),
+          /** The job's changes, as content handed them to the tab. */
+          patchIds: z.array(PatchId)
+        }),
         cookies: {
           val_session: z.string().optional()
         }
       },
       res: z.union([unauthorizedResponse, z.object({
+        status: z.literal(400),
+        json: GenericError
+      }), z.object({
         status: z.literal(409),
         json: GenericError
       }), z.object({
         status: z.literal(500),
         json: GenericError
+      }), z.object({
+        status: z.literal(502),
+        json: GenericError
       }), z.object({
         status: z.literal(200),
         json: z.object({
-          /** By path, as `/save`'s `sourceFiles`. `null` is a deleted file. */
-          files: z.record(z.string(), z.string().nullable())
+          /** The job as content has it now: its next step is the build. */
+          job: z.object({
+            id: z.string(),
+            step: z["enum"](["prepare", "build", "upload"]).nullable(),
+            base: z.string().nullable(),
+            patches: z.array(z.string())
+          }).nullable(),
+          /** Every source file of the job's content, by path. `null` is deleted. */
+          sourceFiles: z.record(z.string(), z.string().nullable()),
+          /** The job's own local binary files, base64, by path. */
+          binaryFiles: z.record(z.string(), z.string()),
+          /** Binary files whose bytes could not be read back. */
+          binaryFilesUnread: z.array(z.string()),
+          /** The branch the job publishes to. */
+          branch: z.string().nullable()
         })
       })])
     }
@@ -2685,7 +2797,14 @@ var Api = {
             patchId: PatchId,
             moduleFilePath: ModuleFilePath,
             message: z.string()
-          })).optional()
+          })).optional(),
+          /**
+           * The chain version this publish moved the branch to, where the
+           * content service versions its chain and the publish applied
+           * anything. See `headVersion` on `/stat`: a `/stat` answer read
+           * before the publish would put its patches back to pending.
+           */
+          headVersion: z.number().optional()
         })
       }),
       /*
@@ -7358,6 +7477,54 @@ var projectSourceResponse = z.object({
    */
   publicPaths: z.array(z.string()).nullable().optional()
 });
+/**
+ * Whether a managed project can be updated onto its template's current seed,
+ * and -- when it is asked with `POST`, the press -- what to build against.
+ *
+ * An update rebuilds the site as it is on newer dependencies. The loader
+ * decides whether there is one; content adds whether the project is managed at
+ * all, and the branch head the rebuild is wired at, because an update
+ * publishes no content of its own.
+ *
+ * `target` is a `/build-target` answer whose project half is the SEED's
+ * dependency layer, already copied into the project so a publish can name it.
+ * Only a `POST` carries it.
+ */
+var dependencyChange = z.object({
+  name: z.string(),
+  section: z["enum"](["dependencies", "devDependencies"]),
+  /** `null` for a dependency the template added. */
+  from: z.string().nullable(),
+  /** `null` for a dependency the template dropped: it leaves `package.json`. */
+  to: z.string().nullable()
+});
+var updateTargetResponse = z.discriminatedUnion("status", [z.object({
+  status: z.literal("current"),
+  template: z.string(),
+  layerRev: z.string()
+}), z.object({
+  status: z.literal("available"),
+  template: z.string(),
+  /** Empty when only the dependency layer moved, and no version did. */
+  changes: z.array(dependencyChange),
+  layerRev: z.object({
+    from: z.string().nullable(),
+    to: z.string()
+  }),
+  /** The project's `package.json`, rewritten to the seed's versions. */
+  packageJson: z.string(),
+  /** The branch head to build at; `null` for a project with no commits. */
+  commit: z.string().nullable(),
+  branch: z.string(),
+  target: buildTargetResponse.optional()
+}), z.object({
+  status: z.literal("unavailable"),
+  reason: z.string(),
+  message: z.string()
+})]);
+var parseUpdateTarget = function parseUpdateTarget(body) {
+  return parse(updateTargetResponse, body, "/v1/update-target");
+};
 var parseBuildTarget = function parseBuildTarget(body) {
   return parse(buildTargetResponse, body, "GET /v1/build-target");
 };
@@ -7365,6 +7532,88 @@ var parseProjectSource = function parseProjectSource(body) {
   return parse(projectSourceResponse, body, "GET /v1/project-source");
 };
 
+// ------------------------------------------------------ publish jobs
+
+/*
+ * Publishing as a queued job (valbuild/home docs/app-mode.md, "Publishing is a
+ * queued job"): a press is a request, the tab builds and uploads the job it is
+ * given, and content runs verify and the seal. Each parser is typed against
+ * the copy in `contentApi.ts`, so a copy brought up to date fails to compile
+ * here until these follow it.
+ */
+
+var requestStatus = z.union([z.object({
+  kind: z.literal("queued")
+}), z.object({
+  kind: z.literal("publishing")
+}), z.object({
+  kind: z.literal("live"),
+  commit: z.string()
+}), z.object({
+  kind: z.literal("failed"),
+  message: z.string(),
+  actions: z.array(z["enum"](["try-again", "discard", "re-run-build"])),
+  job: z.string()
+}), z.object({
+  kind: z.literal("cancelled")
+}), z.object({
+  kind: z.literal("nothing-to-publish")
+})]);
+var tabJob = z.object({
+  id: z.string(),
+  step: z["enum"](["prepare", "build", "upload"]).nullable(),
+  base: z.string().nullable(),
+  patches: z.array(z.string())
+});
+var pressResponse = z.object({
+  request: requestStatus,
+  job: tabJob.nullable()
+});
+var requestStatusResponse = z.object({
+  request: requestStatus
+});
+// `/next`, `/prepare` and `/steps` all answer with the job as it now is.
+var jobResponse = z.object({
+  job: tabJob.nullable()
+});
+var renewResponse = z.object({
+  renewed: z["boolean"]()
+});
+var cancelResponse = z.object({
+  cancelled: z["boolean"]()
+});
+var discardResponse = z.object({
+  stillHeld: z.array(z.string())
+});
+var parsePress = function parsePress(body, call) {
+  return parse(pressResponse, body, call);
+};
+var parseRequestStatus = function parseRequestStatus(body) {
+  return parse(requestStatusResponse, body, "GET /v1/publish-requests/{id}");
+};
+var parseJob = function parseJob(body, call) {
+  return parse(jobResponse, body, call);
+};
+var parseRenew = function parseRenew(body) {
+  return parse(renewResponse, body, "POST /v1/publish-jobs/{id}/renew");
+};
+var parseCancel = function parseCancel(body) {
+  return parse(cancelResponse, body, "POST /v1/publish-jobs/{id}/cancel");
+};
+var parseDiscard = function parseDiscard(body) {
+  return parse(discardResponse, body, "POST /v1/publish-jobs/{id}/discard");
+};
+var newestCiRunResponse = z.object({
+  run: z.object({
+    commit: z.string(),
+    status: z["enum"](["failed", "succeeded"]),
+    url: z.string().nullable()
+  }).nullable()
+});
+var parseNewestCiRun = function parseNewestCiRun(body) {
+  return parse(newestCiRunResponse, body, "GET /v1/ci-runs/newest");
+};
+
 /**
  * The `details` of a refusal, when it carries a list of problems.
  *
@@ -7386,4 +7635,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, 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, parseDeclare, parseProblems, parseProjectSource, parsePromote, parsePublishToken, parseStatus, 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, SharedValConfig, VAL_ENABLE_COOKIE_NAME, VAL_GREEN_RAMP, VAL_SESSION_COOKIE, VAL_STATE_COOKIE, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/shared",
-  "version": "0.136.10",
+  "version": "0.138.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.136.8"
+    "@valbuild/core": "0.138.0"
   },
   "files": [
     "CHANGELOG.md",