@valbuild/shared 0.152.0 → 0.153.0

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

@@ -10,7 +10,7 @@ var wrapNativeSuper = require('../../dist/wrapNativeSuper-8673414f.cjs.prod.js')
 var zodValidationError = require('zod-validation-error');
 var fp = require('@valbuild/core/fp');
 var patch = require('@valbuild/core/patch');
-var getSitemapTree = require('../../dist/getSitemapTree-6b9024d1.cjs.prod.js');
+var getSitemapTree = require('../../dist/getSitemapTree-a4738117.cjs.prod.js');
 var FlexSearch = require('flexsearch');
 var utils = require('../../dist/utils-32bcaca2.cjs.prod.js');
 
@@ -1879,6 +1879,70 @@ var SketchErrorZ = zod.z.object({
 });
 /** The most text a sketchpad holds, in UTF-8 bytes: a page, not a site. */
 var SKETCHPAD_MAX_TEXT_LENGTH = 256 * 1024;
+
+/**
+ * A manifest as the server answers it: what each module IS on the server
+ * (`GET /manifest`, and the same answer on `/stat` when the Studio asks for it
+ * there -- one function on the server answers both, `manifestAnswer`).
+ */
+var ManifestJson = zod.z.object({
+  project: ProjectVersionSchema,
+  modules: zod.z.record(ModuleFilePath, ModuleVersionSchema),
+  /** This answer's ETag, as the header has it. */
+  tag: zod.z.string().optional(),
+  /**
+   * Present on a delta only: the `seq` of the manifest it is
+   * relative to, whose modules that are not named here did not
+   * move. Absent: every module is named.
+   */
+  since: zod.z.number().optional(),
+  /**
+   * The build that answered is a previous build still answering
+   * (http mode: the content service counted a newer one live).
+   * Its versions are right for its own bases, which the site does
+   * not serve any more: a Studio does not move to them, and asks
+   * again. Optional: absent from a live build and a server of the
+   * release before.
+   */
+  superseded: zod.z["boolean"]().optional(),
+  /**
+   * The answering build's `val.modules` registry, as an entry a
+   * Studio can import (`valModulesEntryPath`), and the Val it
+   * runs: where a Studio opened on another build takes this
+   * build's code in without reloading the page. Only a build the
+   * platform made and names (`publishBuild`) has one. Optional
+   * both ways: absent from any other server (local development,
+   * where HMR brings the code; a self-hosted deploy) and from a
+   * server of the release before, and ignored by a Studio of the
+   * release before.
+   */
+  registry: zod.z.object({
+    entry: zod.z.string(),
+    core: zod.z.string()
+  }).optional()
+});
+/**
+ * The manifest a `/stat` answer carries, when the request said which one the
+ * Studio holds (`manifest` on the request): what `GET /manifest` would have
+ * answered for it, so another editor's keystroke costs no manifest request.
+ *
+ * - A manifest, whole or a delta. A delta names the ETag it is relative to
+ *   (`sinceTag`): a Studio uses it only while it holds exactly that one.
+ * - `unchanged`: the manifest the request named, at `seq`, is still the
+ *   one for this answer's `seq`. Decided by `seq` alone, and not read: a
+ *   Studio reads a manifest only for a stat whose `seq` moved. It keeps the
+ *   next request naming the same manifest.
+ *
+ * Optional: absent from a server of the release before, and from an answer
+ * to a request that did not ask, and then the Studio reads `GET /manifest`.
+ */
+var StatManifest = zod.z.union([ManifestJson.extend({
+  sinceTag: zod.z.string().optional()
+}), zod.z.object({
+  unchanged: zod.z.literal(true),
+  tag: zod.z.string(),
+  seq: zod.z.number()
+})]);
 var Api = {
   "/draft/enable": {
     GET: {
@@ -2265,42 +2329,7 @@ var Api = {
         json: GenericError
       }), zod.z.object({
         status: zod.z.literal(200),
-        json: zod.z.object({
-          project: ProjectVersionSchema,
-          modules: zod.z.record(ModuleFilePath, ModuleVersionSchema),
-          /** This answer's ETag, as the header has it. */
-          tag: zod.z.string().optional(),
-          /**
-           * Present on a delta only: the `seq` of the manifest it is
-           * relative to, whose modules that are not named here did not
-           * move. Absent: every module is named.
-           */
-          since: zod.z.number().optional(),
-          /**
-           * The build that answered is a previous build still answering
-           * (http mode: the content service counted a newer one live).
-           * Its versions are right for its own bases, which the site does
-           * not serve any more: a Studio does not move to them, and asks
-           * again. Optional: absent from a live build and a server of the
-           * release before.
-           */
-          superseded: zod.z["boolean"]().optional(),
-          /**
-           * The answering build's `val.modules` registry, as an entry a
-           * Studio can import (`valModulesEntryPath`), and the Val it
-           * runs: where a Studio opened on another build takes this
-           * build's code in without reloading the page. Only a build the
-           * platform made and names (`publishBuild`) has one. Optional
-           * both ways: absent from any other server (local development,
-           * where HMR brings the code; a self-hosted deploy) and from a
-           * server of the release before, and ignored by a Studio of the
-           * release before.
-           */
-          registry: zod.z.object({
-            entry: zod.z.string(),
-            core: zod.z.string()
-          }).optional()
-        })
+        json: ManifestJson
       }),
       /*
        * Nothing moved since the ETag the client sent. No body on the wire;
@@ -2317,23 +2346,24 @@ var Api = {
       req: {
         body: zod.z.object({
           /**
-           * @deprecated Echoed by the Studio, and compared by the fs and
-           * memory long poll to see that another build answers. This
-           * release's Studio reads each module's version from
-           * `GET /manifest`; goes once the long poll compares the echoed
-           * version instead (see "Release-delayed deletions" in
+           * @deprecated Echoed by a Studio of the release that shipped the
+           * one content model, whose fs and memory long poll compared it to
+           * see another build; a Studio of the release after echoes
+           * {@link version} instead, and this only when it was sent. The
+           * request field goes once no Studio sends it (see
+           * "Release-delayed deletions" in
            * `docs/plans/one-content-model.md`).
            */
-          sourcesSha: zod.z.string(),
+          sourcesSha: zod.z.string().optional(),
+          /** @deprecated As `sourcesSha`. */
+          schemaSha: zod.z.string().optional(),
           /**
-           * @deprecated Echoed by the Studio, and compared by the fs and
-           * memory long poll to see that another build answers. This
-           * release's Studio reads each module's version from
-           * `GET /manifest`; goes once the long poll compares the echoed
-           * version instead (see "Release-delayed deletions" in
-           * `docs/plans/one-content-model.md`).
+           * The `version` the last answer carried: what the fs and memory
+           * long poll compare to see another build (the build the chain is
+           * relative to, `ValOps.chainBuild`). Optional: a Studio of the
+           * release before echoes the shas.
            */
-          schemaSha: zod.z.string(),
+          version: ProjectVersionSchema.optional(),
           baseSha: zod.z.string(),
           patches: zod.z.array(zod.z.string()).optional(),
           /**
@@ -2342,7 +2372,17 @@ var Api = {
            * jsonValues module's source is markers and the content sits behind a
            * thunk that `JSON.stringify` drops.
            */
-          jsonEntriesSha: zod.z.string().optional()
+          jsonEntriesSha: zod.z.string().optional(),
+          /**
+           * The manifest the Studio holds, by its ETag and `seq`, so the
+           * answer can carry what moved since (`manifest` on the answer):
+           * `null` when it holds none and can take one. Absent from a
+           * Studio of the release before, which reads `GET /manifest`.
+           */
+          manifest: zod.z.object({
+            tag: zod.z.string(),
+            seq: zod.z.number()
+          }).nullable().optional()
         }).nullable(),
         cookies: {
           val_session: zod.z.string().optional()
@@ -2363,21 +2403,16 @@ var Api = {
           type: zod.z.union([zod.z.literal("request-again"), zod.z.literal("no-change"), zod.z.literal("did-change")]),
           baseSha: zod.z.string(),
           /**
-           * @deprecated Read by a Studio of the release before
-           * (`BaseAlignment`, `SchemaFreshnessWatch`); this release's
-           * only echoes it, and reads each module's version from
-           * `GET /manifest`. Goes in two steps (see "Release-delayed
-           * deletions" in `docs/plans/one-content-model.md`).
-           */
-          schemaSha: zod.z.string(),
-          /**
-           * @deprecated Read by a Studio of the release before
-           * (`BaseAlignment`, `SchemaFreshnessWatch`); this release's
-           * only echoes it, and reads each module's version from
-           * `GET /manifest`. Goes in two steps (see "Release-delayed
-           * deletions" in `docs/plans/one-content-model.md`).
+           * @deprecated Still sent, for a Studio of the release that
+           * shipped the one content model, which echoes it; a Studio of
+           * the release after reads it as optional and echoes `version`.
+           * The server stops sending it in the release after that (see
+           * "Release-delayed deletions" in
+           * `docs/plans/one-content-model.md`).
            */
-          sourcesSha: zod.z.string(),
+          schemaSha: zod.z.string().optional(),
+          /** @deprecated As `schemaSha`. */
+          sourcesSha: zod.z.string().optional(),
           patches: zod.z.array(PatchId),
           /**
            * Of `patches`, the ones that have already SHIPPED.
@@ -2481,28 +2516,25 @@ var Api = {
            * answers, the higher `seq` is the newer. Optional: a server
            * that predates versions sends none.
            */
-          version: ProjectVersionSchema.optional()
+          version: ProjectVersionSchema.optional(),
+          /** See {@link StatManifest}. */
+          manifest: StatManifest.optional()
         }), zod.z.object({
           type: zod.z.literal("use-websocket"),
           url: zod.z.string(),
           nonce: zod.z.string(),
           baseSha: zod.z.string(),
           /**
-           * @deprecated Read by a Studio of the release before
-           * (`BaseAlignment`, `SchemaFreshnessWatch`); this release's
-           * only echoes it, and reads each module's version from
-           * `GET /manifest`. Goes in two steps (see "Release-delayed
-           * deletions" in `docs/plans/one-content-model.md`).
-           */
-          schemaSha: zod.z.string(),
-          /**
-           * @deprecated Read by a Studio of the release before
-           * (`BaseAlignment`, `SchemaFreshnessWatch`); this release's
-           * only echoes it, and reads each module's version from
-           * `GET /manifest`. Goes in two steps (see "Release-delayed
-           * deletions" in `docs/plans/one-content-model.md`).
+           * @deprecated Still sent, for a Studio of the release that
+           * shipped the one content model, which echoes it; a Studio of
+           * the release after reads it as optional and echoes `version`.
+           * The server stops sending it in the release after that (see
+           * "Release-delayed deletions" in
+           * `docs/plans/one-content-model.md`).
            */
-          sourcesSha: zod.z.string(),
+          schemaSha: zod.z.string().optional(),
+          /** @deprecated As `schemaSha`. */
+          sourcesSha: zod.z.string().optional(),
           /**
            * The commit this deployment was built from.
            *
@@ -2630,7 +2662,9 @@ var Api = {
            * answers, the higher `seq` is the newer. Optional: a server
            * that predates versions sends none.
            */
-          version: ProjectVersionSchema.optional()
+          version: ProjectVersionSchema.optional(),
+          /** See {@link StatManifest}. */
+          manifest: StatManifest.optional()
         })])
       })])
     }
@@ -3195,81 +3229,6 @@ var Api = {
       })])
     }
   },
-  /**
-   * @deprecated The whole tree. Nothing of this release asks it: the Studio
-   * reads modules by version (`GET /manifest`, `GET /modules/~`), the draft
-   * readers and MCP read the head in-process. Kept, with `exclude_patches`
-   * (`BaseAlignment`'s fetch) and the ignored `validate_sources` and
-   * `validate_binary_files`, for a Studio of the release before; goes in the
-   * release after the one that ships this (see "Release-delayed deletions"
-   * in `docs/plans/one-content-model.md`).
-   */
-  "/sources/~": {
-    PUT: {
-      req: {
-        path: zod.z.string().optional(),
-        query: {
-          validate_sources: onlyOneBooleanQueryParam.optional(),
-          validate_binary_files: onlyOneBooleanQueryParam.optional(),
-          exclude_patches: onlyOneBooleanQueryParam.optional(),
-          apply_patches: onlyOneBooleanQueryParam.optional()
-        },
-        cookies: {
-          val_session: zod.z.string().optional()
-        }
-      },
-      res: zod.z.union([unauthorizedResponse, zod.z.object({
-        status: zod.z.literal(401),
-        json: GenericError
-      }), zod.z.object({
-        status: zod.z.literal(500),
-        json: zod.z.object({
-          message: zod.z.string(),
-          details: zod.z.union([zod.z.array(ModulesError), GenericError])
-        })
-      }), zod.z.object({
-        status: zod.z.literal(409),
-        json: zod.z.object({
-          message: zod.z.string()
-        })
-      }), zod.z.object({
-        status: zod.z.literal(400),
-        json: zod.z.object({
-          message: zod.z.string(),
-          details: zod.z.array(ModulesError)
-        })
-      }), zod.z.object({
-        status: zod.z.literal(200),
-        json: zod.z.object({
-          schemaSha: zod.z.string(),
-          sourcesSha: zod.z.string(),
-          modules: zod.z.record(ModuleFilePath, zod.z.object({
-            preview: zod.z.any().optional(),
-            // TODO: improve this type
-            source: zod.z.any().optional(),
-            //.optional(), // TODO: Json zod type
-            baseSource: zod.z.any().optional(),
-            // pre-patch source for compare view; only set when the server applies patches (apply_patches=true) and the module has pending patches
-            patches: zod.z.object({
-              applied: zod.z.array(PatchId),
-              skipped: zod.z.array(PatchId).optional(),
-              errors: zod.z.record(PatchId, GenericError).optional()
-            }).optional(),
-            validationErrors: zod.z.record(zod.z.string(), zod.z.array(ValidationError)).optional(),
-            /**
-             * The version of `source` as answered: with the chain the
-             * server applied, or the empty chain when it applied none
-             * (`apply_patches=false`). Optional: an older server sends
-             * none.
-             */
-            version: ModuleVersionSchema.optional()
-          })),
-          /** The project version this tree was read at. See `/stat`. */
-          project: ProjectVersionSchema.optional()
-        })
-      })])
-    }
-  },
   /**
    * One module by version: phase 6 of `docs/plans/one-content-model.md`
    * ("The Studio loads everything from one place"). `GET /modules/~<path>`,
@@ -11885,7 +11844,7 @@ exports.getPageRouterSitemapTree = getSitemapTree.getPageRouterSitemapTree;
 exports.getPageRouterSourceFolder = getSitemapTree.getPageRouterSourceFolder;
 exports.getPatternFromModuleFilePath = getSitemapTree.getPatternFromModuleFilePath;
 exports.getTanStackRouterSourceFolder = getSitemapTree.getTanStackRouterSourceFolder;
-exports.isDesignTabOrigin = getSitemapTree.isDesignTabOrigin;
+exports.isCanvasSelectionColor = getSitemapTree.isCanvasSelectionColor;
 exports.isQuickPreviewFiles = getSitemapTree.isQuickPreviewFiles;
 exports.isTanStackRoutesFolder = getSitemapTree.isTanStackRoutesFolder;
 exports.isValCanvasFrame = getSitemapTree.isValCanvasFrame;
@@ -11894,7 +11853,6 @@ exports.isValCanvasStudioMessage = getSitemapTree.isValCanvasStudioMessage;
 exports.modifierLabel = getSitemapTree.modifierLabel;
 exports.pageLocationOf = getSitemapTree.pageLocationOf;
 exports.parseRoutePattern = getSitemapTree.parseRoutePattern;
-exports.quickPreviewSiteOrigin = getSitemapTree.quickPreviewSiteOrigin;
 exports.readPageSnapshot = getSitemapTree.readPageSnapshot;
 exports.restoreScroll = getSitemapTree.restoreScroll;
 exports.screenshotPage = getSitemapTree.screenshotPage;
@@ -11930,6 +11888,7 @@ exports.JSONValue = JSONValue;
 exports.JSON_ENTRIES_BATCH_MAX = JSON_ENTRIES_BATCH_MAX;
 exports.LOCAL_FILE_IN_REMOTE_PROJECT_HINT = LOCAL_FILE_IN_REMOTE_PROJECT_HINT;
 exports.LOCAL_FILE_IN_REMOTE_PROJECT_WARNING = LOCAL_FILE_IN_REMOTE_PROJECT_WARNING;
+exports.ManifestJson = ManifestJson;
 exports.ModuleComparison = ModuleComparison;
 exports.ModuleVersionSchema = ModuleVersionSchema;
 exports.NEVER_ENCODED = NEVER_ENCODED;
@@ -11987,6 +11946,7 @@ exports.SerializedVideoSchema = SerializedVideoSchema;
 exports.SharedValConfig = SharedValConfig;
 exports.Sketchpad = Sketchpad;
 exports.SketchpadSummary = SketchpadSummary;
+exports.StatManifest = StatManifest;
 exports.VAL_CLIENT_HEADER = VAL_CLIENT_HEADER;
 exports.VAL_ENABLE_COOKIE_NAME = VAL_ENABLE_COOKIE_NAME;
 exports.VAL_GREEN_RAMP = VAL_GREEN_RAMP;