@valbuild/shared 0.150.20 → 0.151.0

package/dist/{protocol-55cfa3cf.esm.js → projectSource-7f0ee83c.esm.js}

@@ -1,7 +1,174 @@
+import { b as _asyncToGenerator, c as _regenerator, d as _objectSpread2, _ as _typeof, g as _defineProperty } from './createForOfIteratorHelper-9b80f1a2.esm.js';
 import { _ as _inherits, a as _createClass, b as _wrapNativeSuper, c as _classCallCheck, d as _callSuper } from './wrapNativeSuper-639b12b7.esm.js';
 import { z } from 'zod';
 import { fromError } from '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;
+    _classCallCheck(this, StudioPublishError);
+    _this = _callSuper(this, StudioPublishError, [message]);
+    _defineProperty(_this, "statusCode", void 0);
+    _defineProperty(_this, "body", void 0);
+    _this.name = "StudioPublishError";
+    _this.statusCode = statusCode;
+    _this.body = body;
+    return _this;
+  }
+  _inherits(StudioPublishError, _Error);
+  return _createClass(StudioPublishError);
+}(/*#__PURE__*/_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 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(fetchImpl, url, method, body) {
+    var res;
+    return _regenerator().w(function (_context) {
+      while (1) switch (_context.n) {
+        case 0:
+          _context.n = 1;
+          return fetchImpl(url, _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 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(fetchImpl, url, held, parse) {
+    var res, value, _t;
+    return _regenerator().w(function (_context2) {
+      while (1) switch (_context2.n) {
+        case 0:
+          _context2.n = 1;
+          return fetchImpl(url, _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 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(res) {
+    var text, parsed, _refusalListener, message;
+    return _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 = _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 = {};
@@ -410,4 +577,52 @@ function parse(schema, body, call) {
   return parsed.data;
 }
 
-export { PublishProtocolError as P, _objectWithoutProperties as _, parseDeclare as a, parseArtifacts as b, parseVerify as c, parsePromote as d, parseStatus as e, parseProjectSource as f, parseProblems as g, parsePress as h, parseRequestStatus as i, parseJob as j, parseRenew as k, parseCancel as l, parseDiscard as m, parseNewestCiRun as n, parsePublishToken as o, parseBuildTarget as p, parseUpdateTarget as q };
+/**
+ * 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__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
+    var answer;
+    return _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);
+  }));
+}
+
+export { PublishProtocolError as P, StudioPublishError as S, _objectWithoutProperties as _, parseBuildTarget as a, parseDeclare as b, parseArtifacts as c, parseVerify as d, parsePromote as e, parseStatus as f, callJson as g, parseProjectSource as h, parseProblems as i, parsePress as j, parseRequestStatus as k, parseJob as l, parseRenew as m, parseCancel as n, parseDiscard as o, publishApiOf as p, parseNewestCiRun as q, isTransientPublishError as r, onPublishRefusal as s, parsePublishToken as t, parseUpdateTarget as u, createProjectSourceReader as v };

package/dist/{protocol-b1055ef0.cjs.prod.js → projectSource-ed6aec39.cjs.prod.js}

@@ -1,9 +1,176 @@
 'use strict';
 
+var createForOfIteratorHelper = require('./createForOfIteratorHelper-9ca2078d.cjs.prod.js');
 var wrapNativeSuper = require('./wrapNativeSuper-8673414f.cjs.prod.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;