@valbuild/shared 0.150.20 → 0.152.0

package/dist/declarations/src/internal/valClientHeader.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Which Val package, at which version, sent a request to Val Build.
+ *
+ * Sent on every request a Val package makes to Val's own services from a
+ * server or a CLI -- the content host, `/api/login`, the analytics ingest --
+ * so Val Build can tell which versions are still out there and which old
+ * endpoints they still call. Without it an endpoint can never be retired with
+ * any confidence: a request from a site nobody has upgraded in a year looks
+ * exactly like one from yesterday's release.
+ *
+ * The value is a product token, `@valbuild/server@0.152.0`: the package whose
+ * code built the request, because that is what decides which endpoints are
+ * called. Not the framework binding or the app: those do not choose URLs.
+ *
+ * NOT sent from the browser. A custom header on a cross-origin request makes
+ * the browser send a CORS preflight, and a host that does not list the header
+ * in `Access-Control-Allow-Headers` refuses the request outright -- so adding
+ * it there is a change to every such host first.
+ *
+ * It identifies the code, not the caller: anyone can send any value, so it is
+ * for counting, never for deciding what a request may do.
+ */
+export declare const VAL_CLIENT_HEADER = "x-val-client";
+/** Packages that send {@link VAL_CLIENT_HEADER}. */
+export type ValClientPackage = "@valbuild/server" | "@valbuild/cli";
+/**
+ * `{ "x-val-client": "@valbuild/server@0.152.0" }`, to spread into a
+ * request's headers.
+ *
+ * A version that could not be read is sent as `unknown` rather than leaving
+ * the header out: "a server too broken to know its version" is still a thing
+ * worth counting, and it is not the same as "a version older than the header".
+ */
+export declare function valClientHeaders(pkg: ValClientPackage, version: string | null | undefined): {
+    [VAL_CLIENT_HEADER]: string;
+};

package/dist/declarations/src/publish/callJson.d.ts

@@ -19,3 +19,18 @@ export declare function isTransientPublishError(error: unknown): boolean;
  * `StudioPublishError` carrying the answer's own message.
  */
 export declare function callJson(fetchImpl: typeof fetch, url: string, method: "GET" | "POST", body?: unknown): Promise<unknown>;
+/**
+ * One JSON READ through this origin, BY VERSION: `held` is the answer the
+ * caller holds, with its `ETag`, which goes as `If-None-Match`. While the
+ * answer is still that one (a 304, with no body) it is `held` again;
+ * otherwise the new body, `parse`d, with its `ETag` -- `null` when the answer
+ * named none, so there is nothing to hold it by. Errors as {@link callJson}
+ * throws them.
+ */
+export declare function readJsonByVersion<T>(fetchImpl: typeof fetch, url: string, held: {
+    etag: string;
+    value: T;
+} | null, parse: (body: unknown) => T): Promise<{
+    etag: string | null;
+    value: T;
+}>;

package/dist/declarations/src/publish/jobClient.d.ts

@@ -24,7 +24,13 @@ export type StudioJobClient = {
      * failed: `types`, an upgrade's new type errors (Publish anyway on home's
      * upgrade page). Content refuses it over anything else.
      */
-    anyway?: "types"[]): Promise<PressResponse>;
+    anyway?: "types"[], 
+    /**
+     * The message of the commit Publish makes first, in a project connected
+     * to git (the proposal's branch, before it merges): from the project's
+     * `studio.commitMessage` setting. Absent: content's default.
+     */
+    commitMessage?: string): Promise<PressResponse>;
     /** Try again: resume a paused queue and press anew. */
     tryAgain(requestId: string, tab: string): Promise<PressResponse>;
     /** Where a press is. */

package/dist/declarations/src/publish/publishClient.d.ts

@@ -22,8 +22,9 @@
  *   own authorisation and a cookie sent to a storage host is a cookie leaked to
  *   one.
  */
-import { ArtifactsResponse, BuildTargetResponse, DeclareBody, DeclareResponse, PromoteResponse, StatusResponse, UploadSlot, VerifyResponse } from "../internal/index.js";
+import { ArtifactsResponse, BuildTargetResponse, DeclareBody, DeclareResponse, PromoteResponse, StatusResponse, UploadSlot, VerifyResponse, publishApiOf, type PublishApiAt } from "../internal/index.js";
 export { StudioPublishError, callJson, isTransientPublishError, } from "./callJson.js";
+export { publishApiOf, type PublishApiAt };
 /** An artifact the live build has and this publish re-declares by hash. */
 export type CarriedArtifact = {
     key: string;
@@ -77,19 +78,6 @@ export type StudioPublishClient = {
  * short of the finish.
  */
 export declare function isExpiredSlot(error: unknown): boolean;
-/**
- * Where content's publish API is reached: through Val's proxy on this origin
- * (`api`, the Studio), or directly (`publishApi`, `<content>/v1`: home's
- * upgrade page, whose `fetchImpl` adds the project token).
- */
-export type PublishApiAt = {
-    /** Val's API root on this origin, e.g. `/api/val`. */
-    api: string;
-} | {
-    /** Content's publish API itself, e.g. `https://content.val.build/v1`. */
-    publishApi: string;
-};
-export declare function publishApiOf(at: PublishApiAt): string;
 export declare function createStudioPublishClient(options: PublishApiAt & {
     fetchImpl?: typeof fetch;
 }): StudioPublishClient;

package/dist/{getSitemapTree-fef55872.esm.js → getSitemapTree-3c1b9e57.esm.js}

@@ -339,7 +339,23 @@ function isValCanvasPageMessage(data) {
   if (_typeof(data) !== "object" || data === null) return false;
   var message = data;
   if (message.val !== VAL_CANVAS_MESSAGE) return false;
-  return message.type === "ready" || message.type === "elements" || message.type === "clicked" || message.type === "pinch" || message.type === "zoom" || message.type === "refreshing" || message.type === "elementPickingStopped" || message.type === "elementPicked" && isPickedElement(data.element) || message.type === "location" && isPageLocation(data) || message.type === "pageRead" && typeof data.requestId === "string" || message.type === "pageScreenshot" && typeof data.requestId === "string" || message.type === "quickPreviewStored" && typeof data.id === "string";
+  return message.type === "ready" && isModulePathList(data.holds) && isHeldVersions(data.holdsVersions) || message.type === "elements" || message.type === "clicked" || message.type === "pinch" || message.type === "zoom" || message.type === "refreshing" || message.type === "elementPickingStopped" || message.type === "elementPicked" && isPickedElement(data.element) || message.type === "location" && isPageLocation(data) || message.type === "pageRead" && typeof data.requestId === "string" || message.type === "pageScreenshot" && typeof data.requestId === "string" || message.type === "quickPreviewStored" && typeof data.id === "string";
+}
+
+/** `holdsVersions` on `ready`: absent, or a version per module path. */
+function isHeldVersions(value) {
+  if (value === undefined) return true;
+  if (_typeof(value) !== "object" || value === null) return false;
+  return Object.values(value).every(function (version) {
+    return _typeof(version) === "object" && version !== null && typeof version.schema === "string" && typeof version.base === "string" && typeof version.chain === "string";
+  });
+}
+
+/** `holds` on `ready`: absent, or a list of module paths. */
+function isModulePathList(value) {
+  return value === undefined || Array.isArray(value) && value.every(function (path) {
+    return typeof path === "string";
+  });
 }
 function isPageLocation(value) {
   var location = value;
@@ -404,7 +420,7 @@ function isValCanvasStudioMessage(data) {
     var read = data;
     return typeof read.requestId === "string" && (read.selector === undefined || typeof read.selector === "string") && (read.maxItems === undefined || typeof read.maxItems === "number");
   }
-  return message.type === "rescan" || message.type === "highlight" || message.type === "setPicking" || message.type === "sourceUpdate" || message.type === "sourcesSynced";
+  return message.type === "rescan" || message.type === "highlight" || message.type === "setPicking" || message.type === "sourceUpdate" || message.type === "sourcesSynced" || message.type === "confirmed" && (data.seq === null || typeof data.seq === "number");
 }
 
 /**

package/dist/{getSitemapTree-6dfa2f4e.cjs.dev.js → getSitemapTree-59c5ed5d.cjs.dev.js}

@@ -359,7 +359,23 @@ function isValCanvasPageMessage(data) {
   if (createForOfIteratorHelper._typeof(data) !== "object" || data === null) return false;
   var message = data;
   if (message.val !== VAL_CANVAS_MESSAGE) return false;
-  return message.type === "ready" || message.type === "elements" || message.type === "clicked" || message.type === "pinch" || message.type === "zoom" || message.type === "refreshing" || message.type === "elementPickingStopped" || message.type === "elementPicked" && isPickedElement(data.element) || message.type === "location" && isPageLocation(data) || message.type === "pageRead" && typeof data.requestId === "string" || message.type === "pageScreenshot" && typeof data.requestId === "string" || message.type === "quickPreviewStored" && typeof data.id === "string";
+  return message.type === "ready" && isModulePathList(data.holds) && isHeldVersions(data.holdsVersions) || message.type === "elements" || message.type === "clicked" || message.type === "pinch" || message.type === "zoom" || message.type === "refreshing" || message.type === "elementPickingStopped" || message.type === "elementPicked" && isPickedElement(data.element) || message.type === "location" && isPageLocation(data) || message.type === "pageRead" && typeof data.requestId === "string" || message.type === "pageScreenshot" && typeof data.requestId === "string" || message.type === "quickPreviewStored" && typeof data.id === "string";
+}
+
+/** `holdsVersions` on `ready`: absent, or a version per module path. */
+function isHeldVersions(value) {
+  if (value === undefined) return true;
+  if (createForOfIteratorHelper._typeof(value) !== "object" || value === null) return false;
+  return Object.values(value).every(function (version) {
+    return createForOfIteratorHelper._typeof(version) === "object" && version !== null && typeof version.schema === "string" && typeof version.base === "string" && typeof version.chain === "string";
+  });
+}
+
+/** `holds` on `ready`: absent, or a list of module paths. */
+function isModulePathList(value) {
+  return value === undefined || Array.isArray(value) && value.every(function (path) {
+    return typeof path === "string";
+  });
 }
 function isPageLocation(value) {
   var location = value;
@@ -424,7 +440,7 @@ function isValCanvasStudioMessage(data) {
     var read = data;
     return typeof read.requestId === "string" && (read.selector === undefined || typeof read.selector === "string") && (read.maxItems === undefined || typeof read.maxItems === "number");
   }
-  return message.type === "rescan" || message.type === "highlight" || message.type === "setPicking" || message.type === "sourceUpdate" || message.type === "sourcesSynced";
+  return message.type === "rescan" || message.type === "highlight" || message.type === "setPicking" || message.type === "sourceUpdate" || message.type === "sourcesSynced" || message.type === "confirmed" && (data.seq === null || typeof data.seq === "number");
 }
 
 /**

package/dist/{getSitemapTree-8a04f3cf.cjs.prod.js → getSitemapTree-6b9024d1.cjs.prod.js}

@@ -359,7 +359,23 @@ function isValCanvasPageMessage(data) {
   if (createForOfIteratorHelper._typeof(data) !== "object" || data === null) return false;
   var message = data;
   if (message.val !== VAL_CANVAS_MESSAGE) return false;
-  return message.type === "ready" || message.type === "elements" || message.type === "clicked" || message.type === "pinch" || message.type === "zoom" || message.type === "refreshing" || message.type === "elementPickingStopped" || message.type === "elementPicked" && isPickedElement(data.element) || message.type === "location" && isPageLocation(data) || message.type === "pageRead" && typeof data.requestId === "string" || message.type === "pageScreenshot" && typeof data.requestId === "string" || message.type === "quickPreviewStored" && typeof data.id === "string";
+  return message.type === "ready" && isModulePathList(data.holds) && isHeldVersions(data.holdsVersions) || message.type === "elements" || message.type === "clicked" || message.type === "pinch" || message.type === "zoom" || message.type === "refreshing" || message.type === "elementPickingStopped" || message.type === "elementPicked" && isPickedElement(data.element) || message.type === "location" && isPageLocation(data) || message.type === "pageRead" && typeof data.requestId === "string" || message.type === "pageScreenshot" && typeof data.requestId === "string" || message.type === "quickPreviewStored" && typeof data.id === "string";
+}
+
+/** `holdsVersions` on `ready`: absent, or a version per module path. */
+function isHeldVersions(value) {
+  if (value === undefined) return true;
+  if (createForOfIteratorHelper._typeof(value) !== "object" || value === null) return false;
+  return Object.values(value).every(function (version) {
+    return createForOfIteratorHelper._typeof(version) === "object" && version !== null && typeof version.schema === "string" && typeof version.base === "string" && typeof version.chain === "string";
+  });
+}
+
+/** `holds` on `ready`: absent, or a list of module paths. */
+function isModulePathList(value) {
+  return value === undefined || Array.isArray(value) && value.every(function (path) {
+    return typeof path === "string";
+  });
 }
 function isPageLocation(value) {
   var location = value;
@@ -424,7 +440,7 @@ function isValCanvasStudioMessage(data) {
     var read = data;
     return typeof read.requestId === "string" && (read.selector === undefined || typeof read.selector === "string") && (read.maxItems === undefined || typeof read.maxItems === "number");
   }
-  return message.type === "rescan" || message.type === "highlight" || message.type === "setPicking" || message.type === "sourceUpdate" || message.type === "sourcesSynced";
+  return message.type === "rescan" || message.type === "highlight" || message.type === "setPicking" || message.type === "sourceUpdate" || message.type === "sourcesSynced" || message.type === "confirmed" && (data.seq === null || typeof data.seq === "number");
 }
 
 /**

package/dist/{protocol-d0efb8cd.cjs.dev.js → projectSource-2a58ef15.cjs.dev.js}

@@ -1,9 +1,176 @@
 'use strict';
 
+var createForOfIteratorHelper = require('./createForOfIteratorHelper-f2d7ac6d.cjs.dev.js');
 var wrapNativeSuper = require('./wrapNativeSuper-933f991e.cjs.dev.js');
 var zod = require('zod');
 var zodValidationError = require('zod-validation-error');
 
+/*
+ * The one JSON call the Studio makes through its own origin's publish proxy,
+ * and the errors it throws. Apart from `publishClient.ts` (which re-exports
+ * all three) so that a worker can make the same call without importing the
+ * publish client's parsers, and `@valbuild/shared` with them.
+ */
+
+/**
+ * Who hears of a refusal's body before it is thrown: the Studio's shell, which
+ * says a refusal of the project's plan with the next step (`planRefusal.ts` in
+ * `@valbuild/ui`). One listener; setting it again replaces it.
+ */
+var refusalListener = null;
+function onPublishRefusal(listener) {
+  refusalListener = listener;
+}
+
+/** The publish API refused, and said why. */
+var StudioPublishError = /*#__PURE__*/function (_Error) {
+  function StudioPublishError(statusCode, message, body) {
+    var _this;
+    wrapNativeSuper._classCallCheck(this, StudioPublishError);
+    _this = wrapNativeSuper._callSuper(this, StudioPublishError, [message]);
+    createForOfIteratorHelper._defineProperty(_this, "statusCode", void 0);
+    createForOfIteratorHelper._defineProperty(_this, "body", void 0);
+    _this.name = "StudioPublishError";
+    _this.statusCode = statusCode;
+    _this.body = body;
+    return _this;
+  }
+  wrapNativeSuper._inherits(StudioPublishError, _Error);
+  return wrapNativeSuper._createClass(StudioPublishError);
+}(/*#__PURE__*/wrapNativeSuper._wrapNativeSuper(Error));
+
+/**
+ * Was this a failure that asking again could get past?
+ *
+ * No answer at all (the request never got through) and the answers that mean
+ * "not now" -- a timeout, too many requests, a server or gateway error. Every
+ * other status is content answering, and the same request gets the same
+ * answer.
+ */
+function isTransientPublishError(error) {
+  if (!(error instanceof StudioPublishError)) return true;
+  return error.statusCode >= 500 || error.statusCode === 408 || error.statusCode === 429;
+}
+
+/**
+ * One JSON call through this origin, with the session cookie: its body, or a
+ * `StudioPublishError` carrying the answer's own message.
+ */
+function callJson(_x, _x2, _x3, _x4) {
+  return _callJson.apply(this, arguments);
+}
+
+/**
+ * One JSON READ through this origin, BY VERSION: `held` is the answer the
+ * caller holds, with its `ETag`, which goes as `If-None-Match`. While the
+ * answer is still that one (a 304, with no body) it is `held` again;
+ * otherwise the new body, `parse`d, with its `ETag` -- `null` when the answer
+ * named none, so there is nothing to hold it by. Errors as {@link callJson}
+ * throws them.
+ */
+function _callJson() {
+  _callJson = createForOfIteratorHelper._asyncToGenerator(/*#__PURE__*/createForOfIteratorHelper._regenerator().m(function _callee(fetchImpl, url, method, body) {
+    var res;
+    return createForOfIteratorHelper._regenerator().w(function (_context) {
+      while (1) switch (_context.n) {
+        case 0:
+          _context.n = 1;
+          return fetchImpl(url, createForOfIteratorHelper._objectSpread2({
+            method: method,
+            // The session cookie is the whole credential this end has.
+            credentials: "same-origin"
+          }, body === undefined ? {} : {
+            headers: {
+              "Content-Type": "application/json"
+            },
+            body: JSON.stringify(body)
+          }));
+        case 1:
+          res = _context.v;
+          return _context.a(2, answerOf(res));
+      }
+    }, _callee);
+  }));
+  return _callJson.apply(this, arguments);
+}
+function readJsonByVersion(_x5, _x6, _x7, _x8) {
+  return _readJsonByVersion.apply(this, arguments);
+}
+
+/** An answer's JSON body, or a `StudioPublishError` with its own message. */
+function _readJsonByVersion() {
+  _readJsonByVersion = createForOfIteratorHelper._asyncToGenerator(/*#__PURE__*/createForOfIteratorHelper._regenerator().m(function _callee2(fetchImpl, url, held, parse) {
+    var res, value, _t;
+    return createForOfIteratorHelper._regenerator().w(function (_context2) {
+      while (1) switch (_context2.n) {
+        case 0:
+          _context2.n = 1;
+          return fetchImpl(url, createForOfIteratorHelper._objectSpread2({
+            method: "GET",
+            // The session cookie is the whole credential this end has.
+            credentials: "same-origin"
+          }, held !== null ? {
+            headers: {
+              "If-None-Match": held.etag
+            }
+          } : {}));
+        case 1:
+          res = _context2.v;
+          if (!(res.status === 304 && held !== null)) {
+            _context2.n = 2;
+            break;
+          }
+          return _context2.a(2, held);
+        case 2:
+          _t = parse;
+          _context2.n = 3;
+          return answerOf(res);
+        case 3:
+          value = _t(_context2.v);
+          return _context2.a(2, {
+            etag: res.headers.get("etag"),
+            value: value
+          });
+      }
+    }, _callee2);
+  }));
+  return _readJsonByVersion.apply(this, arguments);
+}
+function answerOf(_x9) {
+  return _answerOf.apply(this, arguments);
+}
+function _answerOf() {
+  _answerOf = createForOfIteratorHelper._asyncToGenerator(/*#__PURE__*/createForOfIteratorHelper._regenerator().m(function _callee3(res) {
+    var text, parsed, _refusalListener, message;
+    return createForOfIteratorHelper._regenerator().w(function (_context3) {
+      while (1) switch (_context3.n) {
+        case 0:
+          _context3.n = 1;
+          return res.text();
+        case 1:
+          text = _context3.v;
+          try {
+            parsed = text === "" ? undefined : JSON.parse(text);
+          } catch (_unused) {
+            parsed = undefined;
+          }
+          if (res.ok) {
+            _context3.n = 2;
+            break;
+          }
+          // A publish the plan does not allow (a trial's 3 publishes, a trial that
+          // ended): the shell says it, with the next step. See `planRefusal`.
+          (_refusalListener = refusalListener) === null || _refusalListener === void 0 || _refusalListener(parsed);
+          message = createForOfIteratorHelper._typeof(parsed) === "object" && parsed !== null && "message" in parsed && typeof parsed.message === "string" ? parsed.message : "The publish API answered ".concat(res.status, ".");
+          throw new StudioPublishError(res.status, message, parsed);
+        case 2:
+          return _context3.a(2, parsed);
+      }
+    }, _callee3);
+  }));
+  return _answerOf.apply(this, arguments);
+}
+
 function _objectWithoutPropertiesLoose(r, e) {
   if (null == r) return {};
   var t = {};
@@ -412,8 +579,61 @@ function parse(schema, body, call) {
   return parsed.data;
 }
 
+/**
+ * Where content's publish API is reached: through Val's proxy on this origin
+ * (`api`, the Studio), or directly (`publishApi`, `<content>/v1`: home's
+ * upgrade page, whose `fetchImpl` adds the project token).
+ */
+
+function publishApiOf(at) {
+  return "publishApi" in at ? at.publishApi.replace(/\/+$/, "") : "".concat(at.api.replace(/\/+$/, ""), "/publish-api");
+}
+
+/**
+ * The site's live source, BY VERSION: for a reader that asks again and again
+ * over a long life -- the Studio's code tools, on every tool call -- rather
+ * than once per deploy, as {@link createStudioPublishClient}'s memo does.
+ *
+ * Each call asks `/project-source` with the `ETag` of the answer it holds
+ * (`If-None-Match`), and content answers 304 while it is still that one
+ * (valbuild/home sends the tag: the sha256 of its answer). So a publish in
+ * between is seen on the next call, and the whole source is sent only when
+ * it changed. An answer without a tag (an older content service) is not
+ * held: every call reads it again, which is right, if dearer.
+ */
+function createProjectSourceReader(options) {
+  var _options$fetchImpl;
+  var fetchImpl = (_options$fetchImpl = options.fetchImpl) !== null && _options$fetchImpl !== void 0 ? _options$fetchImpl : fetch;
+  var url = "".concat(publishApiOf(options), "/project-source");
+  var held = null;
+  return /*#__PURE__*/createForOfIteratorHelper._asyncToGenerator(/*#__PURE__*/createForOfIteratorHelper._regenerator().m(function _callee() {
+    var answer;
+    return createForOfIteratorHelper._regenerator().w(function (_context) {
+      while (1) switch (_context.n) {
+        case 0:
+          _context.n = 1;
+          return readJsonByVersion(fetchImpl, url, held, function (body) {
+            return parseProjectSource(body).files;
+          });
+        case 1:
+          answer = _context.v;
+          held = answer.etag !== null ? {
+            etag: answer.etag,
+            value: answer.value
+          } : null;
+          return _context.a(2, answer.value);
+      }
+    }, _callee);
+  }));
+}
+
 exports.PublishProtocolError = PublishProtocolError;
+exports.StudioPublishError = StudioPublishError;
 exports._objectWithoutProperties = _objectWithoutProperties;
+exports.callJson = callJson;
+exports.createProjectSourceReader = createProjectSourceReader;
+exports.isTransientPublishError = isTransientPublishError;
+exports.onPublishRefusal = onPublishRefusal;
 exports.parseArtifacts = parseArtifacts;
 exports.parseBuildTarget = parseBuildTarget;
 exports.parseCancel = parseCancel;
@@ -431,3 +651,4 @@ exports.parseRequestStatus = parseRequestStatus;
 exports.parseStatus = parseStatus;
 exports.parseUpdateTarget = parseUpdateTarget;
 exports.parseVerify = parseVerify;
+exports.publishApiOf = publishApiOf;