@preprio/toolkit 0.5.0-rc.5 → 0.5.0-rc.6

package/dist/astro/index.js

@@ -1,5 +1,5 @@
 // src/version.ts
-var VERSION = "0.5.0-rc.5";
+var VERSION = "0.5.0-rc.6";
 
 // src/core/features.ts
 function isEnabled(config) {
@@ -402,14 +402,14 @@ function indexSnapshot(data) {
   const index = /* @__PURE__ */ new Map();
   const visited = /* @__PURE__ */ new WeakSet();
   const path = [];
-  function walk(node) {
+  function walk2(node) {
     if (node === null || typeof node !== "object") return;
     if (visited.has(node)) return;
     visited.add(node);
     if (Array.isArray(node)) {
       for (let i = 0; i < node.length; i++) {
         path.push(i);
-        walk(node[i]);
+        walk2(node[i]);
         path.pop();
       }
       return;
@@ -427,11 +427,11 @@ function indexSnapshot(data) {
     for (const key in record) {
       if (!Object.prototype.hasOwnProperty.call(record, key)) continue;
       path.push(key);
-      walk(record[key]);
+      walk2(record[key]);
       path.pop();
     }
   }
-  walk(data);
+  walk2(data);
   return index;
 }
 
@@ -888,12 +888,12 @@ function resolveFields(selections, typename, doc, options) {
     }
   };
   const applies = (on, list) => conditionMatches(on, typename) || typename !== void 0 && typeConditions(list, doc).includes(typename);
-  const walk = (list, matched) => {
+  const walk2 = (list, matched) => {
     for (const s of list) {
       if (s.kind === "field") {
         add(matched ? exact : loose, s);
       } else if (s.kind === "inline") {
-        walk(s.selections, matched && applies(s.on, s.selections));
+        walk2(s.selections, matched && applies(s.on, s.selections));
       } else {
         const fragment = doc.fragments.get(s.name);
         if (!fragment) continue;
@@ -901,11 +901,11 @@ function resolveFields(selections, typename, doc, options) {
         if (walkedMatched.has(fragment)) continue;
         if (!asMatched && walkedLoose.has(fragment)) continue;
         (asMatched ? walkedMatched : walkedLoose).add(fragment);
-        walk(fragment.selections, asMatched);
+        walk2(fragment.selections, asMatched);
       }
     }
   };
-  walk(selections, true);
+  walk2(selections, true);
   if (!options.strict) {
     for (const [key, field] of loose) {
       if (!exact.has(key)) exact.set(key, field);
@@ -922,21 +922,21 @@ function typeConditions(selections, doc) {
   if (hit) return hit;
   const names = /* @__PURE__ */ new Set();
   const seen = /* @__PURE__ */ new Set();
-  const walk = (list) => {
+  const walk2 = (list) => {
     for (const s of list) {
       if (s.kind === "inline") {
         if (s.on) names.add(s.on);
-        walk(s.selections);
+        walk2(s.selections);
       } else if (s.kind === "spread") {
         const fragment = doc.fragments.get(s.name);
         if (!fragment || seen.has(fragment)) continue;
         seen.add(fragment);
         names.add(fragment.on);
-        walk(fragment.selections);
+        walk2(fragment.selections);
       }
     }
   };
-  walk(selections);
+  walk2(selections);
   const conditions = [...names];
   conditionsCache.set(selections, conditions);
   return conditions;
@@ -1231,7 +1231,7 @@ function resolveTargets(root, doc, ownerPath, segments) {
   let current = root;
   const out = [];
   const plain = /* @__PURE__ */ new Set();
-  const walk = (node, sel, i, path) => {
+  const walk2 = (node, sel, i, path) => {
     if (i === segments.length) {
       out.push(path);
       return;
@@ -1241,10 +1241,10 @@ function resolveTargets(root, doc, ownerPath, segments) {
       if (INDEX_SEGMENT.test(segment)) {
         const position = Number(segment);
         if (position < node.length) {
-          walk(node[position], sel, i + 1, [...path, position]);
+          walk2(node[position], sel, i + 1, [...path, position]);
         }
       } else if (segment === "items") {
-        walk(node, sel, i + 1, path);
+        walk2(node, sel, i + 1, path);
       }
       return;
     }
@@ -1277,11 +1277,11 @@ function resolveTargets(root, doc, ownerPath, segments) {
           current = writeAtPath(current, fieldPath, value);
         }
       }
-      walk(value, field.selections, i + 1, fieldPath);
+      walk2(value, field.selections, i + 1, fieldPath);
     }
-    if (!matched && segment === "items") walk(node, sel, i + 1, path);
+    if (!matched && segment === "items") walk2(node, sel, i + 1, path);
   };
-  walk(owner, selections, 0, ownerPath);
+  walk2(owner, selections, 0, ownerPath);
   return { root: current, targets: out, plain };
 }
 var NON_ALPHANUMERIC = /[^a-z0-9]/gi;
@@ -1404,11 +1404,11 @@ function listKeysIn(result) {
     if (!byType) {
       byType = /* @__PURE__ */ new Map();
       const seen = /* @__PURE__ */ new WeakSet();
-      const walk = (node) => {
+      const walk2 = (node) => {
         if (node === null || typeof node !== "object" || seen.has(node)) return;
         seen.add(node);
         if (Array.isArray(node)) {
-          node.forEach(walk);
+          node.forEach(walk2);
           return;
         }
         const record = node;
@@ -1419,10 +1419,10 @@ function listKeysIn(result) {
             if (!keys) byType.set(type, keys = /* @__PURE__ */ new Set());
             keys.add(key);
           }
-          walk(value);
+          walk2(value);
         }
       };
-      walk(result);
+      walk2(result);
       listKeysCache.set(result, byType);
     }
     return byType.get(typename) ?? NO_KEYS;
@@ -1464,7 +1464,7 @@ function findEditLink(root) {
   if (linkCache.has(root)) return linkCache.get(root) ?? null;
   let found = null;
   const seen = /* @__PURE__ */ new WeakSet();
-  const walk = (node) => {
+  const walk2 = (node) => {
     if (found) return;
     if (typeof node === "string") {
       if (!vercelStegaSplit2(node).encoded) return;
@@ -1479,9 +1479,9 @@ function findEditLink(root) {
     }
     if (node === null || typeof node !== "object" || seen.has(node)) return;
     seen.add(node);
-    for (const value of Object.values(node)) walk(value);
+    for (const value of Object.values(node)) walk2(value);
   };
-  walk(root);
+  walk2(root);
   linkCache.set(root, found);
   return found;
 }
@@ -1507,6 +1507,105 @@ async function readLiveLogFromRequest(request) {
   }
 }
 
+// src/core/live-preview/edit-links.ts
+import {
+  vercelStegaCombine as vercelStegaCombine2,
+  vercelStegaDecode as vercelStegaDecode2,
+  vercelStegaSplit as vercelStegaSplit3
+} from "@vercel/stega";
+var ENTRY_PARAM = "entry";
+var TOP_LEVEL_ENTRY = /^[A-Za-z0-9_]+\.\d+$/;
+function entryIdOf(element) {
+  if (!isRecord(element)) return void 0;
+  if (typeof element._id === "string") return element._id;
+  if (element.__typename !== "Assets" || !Array.isArray(element.items)) {
+    return void 0;
+  }
+  const first = element.items[0];
+  return isRecord(first) && typeof first._id === "string" ? first._id : void 0;
+}
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function annotate(value, ctx) {
+  if (!ctx.entryId) return value;
+  const { cleaned, encoded } = vercelStegaSplit3(value);
+  if (!encoded) return value;
+  let payload;
+  try {
+    payload = vercelStegaDecode2(encoded);
+  } catch {
+    return value;
+  }
+  if (typeof payload?.href !== "string") return value;
+  let url;
+  try {
+    url = new URL(payload.href);
+  } catch {
+    return value;
+  }
+  if (url.searchParams.has(ENTRY_PARAM)) return value;
+  url.searchParams.set(ENTRY_PARAM, ctx.entryId);
+  const itemId = decodeURIComponent(url.pathname.split("/").pop() ?? "");
+  if (!url.searchParams.has("field") && ctx.entryField && TOP_LEVEL_ENTRY.test(ctx.entryField) && itemId === ctx.entryOwnerId) {
+    url.searchParams.set("field", ctx.entryField);
+  }
+  return vercelStegaCombine2(
+    cleaned,
+    { ...payload, href: url.toString() },
+    false
+  );
+}
+function walk(value, selections, ctx) {
+  if (typeof value === "string") return annotate(value, ctx);
+  if (Array.isArray(value)) {
+    let changed2 = false;
+    const next2 = value.map((element, index) => {
+      const path = [...ctx.path, String(index)];
+      const entryId = ctx.inAssets ? void 0 : entryIdOf(element);
+      const entry = entryId ? {
+        entryId,
+        entryField: ctx.ownerId ? path.join(".") : void 0,
+        entryOwnerId: ctx.ownerId,
+        inAssets: isRecord(element) && element._id === void 0
+      } : {};
+      const out = walk(element, selections, { ...ctx, ...entry, path });
+      if (out !== element) changed2 = true;
+      return out;
+    });
+    return changed2 ? next2 : value;
+  }
+  if (!isRecord(value)) return value;
+  const id = typeof value._id === "string" ? value._id : void 0;
+  const typename = typeof value.__typename === "string" ? value.__typename : void 0;
+  const fields = ctx.doc && selections ? collectFields(selections, typename, ctx.doc) : null;
+  let changed = false;
+  const next = {};
+  for (const [key, child] of Object.entries(value)) {
+    const field = fields?.get(key);
+    const name = field?.name ?? key;
+    const out = walk(child, field?.selections ?? null, {
+      ...ctx,
+      ownerId: id ?? ctx.ownerId,
+      path: id ? [name] : [...ctx.path, name]
+    });
+    if (out !== child) changed = true;
+    next[key] = out;
+  }
+  return changed ? next : value;
+}
+function annotateEditLinks(result, query, operationName) {
+  let doc = null;
+  if (query !== void 0) {
+    try {
+      doc = readQueryDocument(query, operationName);
+    } catch {
+      doc = null;
+    }
+  }
+  return walk(result, doc?.operation ?? null, { doc, path: [] });
+}
+
 // src/astro/index.ts
 var LIVE_LOG = /* @__PURE__ */ Symbol.for("@preprio/toolkit/astro-live-log");
 async function onPreprRequest(context, next, options) {
@@ -1547,10 +1646,11 @@ async function getToolbarProps(headers, token, features) {
   return getToolbarPropsFromHeaders(headers, token, features);
 }
 function normalizeQuery2(query, result, options = {}) {
-  if (!options.enabled || !options.locals) return result;
-  const log = options.locals[LIVE_LOG];
-  if (!log?.length) return result;
-  return normalizeQuery(query, result, {
+  if (!options.enabled) return result;
+  const annotated = annotateEditLinks(result, query, options.operationName);
+  const log = options.locals?.[LIVE_LOG];
+  if (!log?.length) return annotated;
+  return normalizeQuery(query, annotated, {
     log,
     operationName: options.operationName
   });

package/dist/{chunk-TG6N3C22.js → chunk-IPMB32AZ.js}

@@ -8,7 +8,7 @@ import {
   parseListEntries,
   patchSnapshot,
   syncListSnapshot
-} from "./chunk-74KY5EAM.js";
+} from "./chunk-KD3GK6TO.js";
 import {
   createScopedLogger,
   getTrustedParentOrigin,

package/dist/{chunk-74KY5EAM.js → chunk-KD3GK6TO.js}

@@ -1210,6 +1210,8 @@ export {
   indexSnapshot,
   patchSnapshot,
   syncListSnapshot,
+  readQueryDocument,
+  collectFields,
   isLiveFieldChange,
   parseListEntries,
   parseEditTarget,

package/dist/{chunk-3X55JL52.js → chunk-KZIRM54F.js}

@@ -1,7 +1,7 @@
 import {
   VERSION,
   resolveFeatures
-} from "./chunk-CMUFTCG3.js";
+} from "./chunk-WHZNCYUS.js";
 
 // src/core/server.ts
 var PreprError = class extends Error {

package/dist/{chunk-SBLZANL5.js → chunk-L3SDL6MP.js}

@@ -2,7 +2,7 @@ import {
   ALL_FEATURES_ENABLED,
   VERSION,
   resolveFeatures
-} from "./chunk-CMUFTCG3.js";
+} from "./chunk-WHZNCYUS.js";
 import {
   createIframeBridge,
   isLocale,
@@ -480,6 +480,7 @@ function findFieldElement(lookup) {
 
 // src/core/stega/dom.ts
 var IGNORED_ANCESTORS = "script, style, noscript";
+var AUTO_ENTRY_ATTR = "data-prepr-entry-auto";
 function isIgnoredTextNode(node) {
   if (node.parentElement?.closest(IGNORED_ANCESTORS)) return true;
   return !node.textContent?.trim();
@@ -513,7 +514,9 @@ function parseEditHref(href) {
     return {
       id: url.pathname.split("/").pop() || void 0,
       field: url.searchParams.get("field") || void 0,
-      locale: url.searchParams.get("locale") || void 0
+      locale: url.searchParams.get("locale") || void 0,
+      // Added by the toolkit's `annotateEditLinks`, not by Prepr.
+      entry: url.searchParams.get("entry") || void 0
     };
   } catch {
     return {};
@@ -530,11 +533,16 @@ function tagEncodedElement(element, decoded) {
   element.setAttribute("data-prepr-encoded", "");
   element.setAttribute("data-prepr-href", decoded.href);
   element.setAttribute("data-prepr-origin", decoded.origin);
-  const { id, field, locale } = parseEditHref(decoded.href);
+  const { id, field, locale, entry } = parseEditHref(decoded.href);
   setOrRemove(element, "data-prepr-id", id);
   const fieldHint = element.getAttribute("data-prepr-edit-target")?.trim() || void 0;
   setOrRemove(element, "data-prepr-field", field ?? fieldHint);
   setOrRemove(element, "data-prepr-locale", locale);
+  const siteEntry = element.hasAttribute("data-prepr-entry-id") && !element.hasAttribute(AUTO_ENTRY_ATTR);
+  if (!siteEntry) {
+    setOrRemove(element, "data-prepr-entry-id", entry);
+    setOrRemove(element, AUTO_ENTRY_ATTR, entry && "true");
+  }
 }
 function readEditPayload(element) {
   return {

package/dist/{chunk-CMUFTCG3.js → chunk-WHZNCYUS.js}

@@ -1,5 +1,5 @@
 // src/version.ts
-var VERSION = "0.5.0-rc.5";
+var VERSION = "0.5.0-rc.6";
 
 // src/core/features.ts
 function isEnabled(config) {

package/dist/codegen/index.cjs

@@ -0,0 +1,79 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/codegen/index.ts
+var codegen_exports = {};
+__export(codegen_exports, {
+  addPreprIds: () => addPreprIds,
+  preprIds: () => preprIds
+});
+module.exports = __toCommonJS(codegen_exports);
+var import_graphql = require("graphql");
+function field(name) {
+  return { kind: import_graphql.Kind.FIELD, name: { kind: import_graphql.Kind.NAME, value: name } };
+}
+function hasResponseKey(set, key) {
+  return set.selections.some(
+    (s) => s.kind === import_graphql.Kind.FIELD && (s.alias ?? s.name).value === key
+  );
+}
+function addPreprIds(document, schema) {
+  const roots = new Set(
+    [
+      schema.getQueryType(),
+      schema.getMutationType(),
+      schema.getSubscriptionType()
+    ].filter(Boolean)
+  );
+  const typeInfo = new import_graphql.TypeInfo(schema);
+  return (0, import_graphql.visit)(
+    document,
+    (0, import_graphql.visitWithTypeInfo)(typeInfo, {
+      SelectionSet(node) {
+        const type = typeInfo.getParentType();
+        if (!type || !(0, import_graphql.isCompositeType)(type) || roots.has(type)) return;
+        const added = [];
+        if (((0, import_graphql.isObjectType)(type) || (0, import_graphql.isInterfaceType)(type)) && "_id" in type.getFields() && !hasResponseKey(node, "_id")) {
+          added.push(field("_id"));
+        }
+        if (!hasResponseKey(node, "__typename")) {
+          added.push(field("__typename"));
+        }
+        if (!added.length) return;
+        return { ...node, selections: [...added, ...node.selections] };
+      }
+    })
+  );
+}
+var preprIds = {
+  transform({
+    documents,
+    schema
+  }) {
+    const built = (0, import_graphql.buildASTSchema)(schema, { assumeValidSDL: true });
+    return documents.map(
+      (file) => file.document ? { ...file, document: addPreprIds(file.document, built) } : file
+    );
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  addPreprIds,
+  preprIds
+});

package/dist/codegen/index.d.cts

@@ -0,0 +1,46 @@
+import { DocumentNode, GraphQLSchema } from 'graphql';
+
+/**
+ * The slice of a GraphQL Codegen `DocumentFile` this transform touches,
+ * written out so the package needs no dependency on `@graphql-codegen/*`.
+ */
+interface CodegenDocumentFile {
+    document?: DocumentNode;
+    [key: string]: unknown;
+}
+/**
+ * Select `_id` and `__typename` on every level of a query that has them, so
+ * live preview and click-to-edit can find each item without you selecting
+ * them by hand.
+ *
+ * The schema decides where they go: `_id` only on types that have one
+ * (models and components, not collections like `Pages` or unions), and
+ * `__typename` on every object, interface and union below the root.
+ * Fields already selected are left as they are.
+ */
+declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema): DocumentNode;
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, so the generated documents and types include `_id` and
+ * `__typename` wherever the schema has them:
+ *
+ * ```ts
+ * // codegen.ts
+ * import { preprIds } from '@preprio/toolkit/codegen';
+ *
+ * generates: {
+ *   'src/gql/': {
+ *     preset: 'client',
+ *     documentTransforms: [preprIds],
+ *   },
+ * },
+ * ```
+ */
+declare const preprIds: {
+    transform({ documents, schema, }: {
+        documents: CodegenDocumentFile[];
+        schema: DocumentNode;
+    }): CodegenDocumentFile[];
+};
+
+export { type CodegenDocumentFile, addPreprIds, preprIds };

package/dist/codegen/index.d.ts

@@ -0,0 +1,46 @@
+import { DocumentNode, GraphQLSchema } from 'graphql';
+
+/**
+ * The slice of a GraphQL Codegen `DocumentFile` this transform touches,
+ * written out so the package needs no dependency on `@graphql-codegen/*`.
+ */
+interface CodegenDocumentFile {
+    document?: DocumentNode;
+    [key: string]: unknown;
+}
+/**
+ * Select `_id` and `__typename` on every level of a query that has them, so
+ * live preview and click-to-edit can find each item without you selecting
+ * them by hand.
+ *
+ * The schema decides where they go: `_id` only on types that have one
+ * (models and components, not collections like `Pages` or unions), and
+ * `__typename` on every object, interface and union below the root.
+ * Fields already selected are left as they are.
+ */
+declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema): DocumentNode;
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, so the generated documents and types include `_id` and
+ * `__typename` wherever the schema has them:
+ *
+ * ```ts
+ * // codegen.ts
+ * import { preprIds } from '@preprio/toolkit/codegen';
+ *
+ * generates: {
+ *   'src/gql/': {
+ *     preset: 'client',
+ *     documentTransforms: [preprIds],
+ *   },
+ * },
+ * ```
+ */
+declare const preprIds: {
+    transform({ documents, schema, }: {
+        documents: CodegenDocumentFile[];
+        schema: DocumentNode;
+    }): CodegenDocumentFile[];
+};
+
+export { type CodegenDocumentFile, addPreprIds, preprIds };

package/dist/codegen/index.js

@@ -0,0 +1,62 @@
+// src/codegen/index.ts
+import {
+  buildASTSchema,
+  isCompositeType,
+  isInterfaceType,
+  isObjectType,
+  Kind,
+  TypeInfo,
+  visit,
+  visitWithTypeInfo
+} from "graphql";
+function field(name) {
+  return { kind: Kind.FIELD, name: { kind: Kind.NAME, value: name } };
+}
+function hasResponseKey(set, key) {
+  return set.selections.some(
+    (s) => s.kind === Kind.FIELD && (s.alias ?? s.name).value === key
+  );
+}
+function addPreprIds(document, schema) {
+  const roots = new Set(
+    [
+      schema.getQueryType(),
+      schema.getMutationType(),
+      schema.getSubscriptionType()
+    ].filter(Boolean)
+  );
+  const typeInfo = new TypeInfo(schema);
+  return visit(
+    document,
+    visitWithTypeInfo(typeInfo, {
+      SelectionSet(node) {
+        const type = typeInfo.getParentType();
+        if (!type || !isCompositeType(type) || roots.has(type)) return;
+        const added = [];
+        if ((isObjectType(type) || isInterfaceType(type)) && "_id" in type.getFields() && !hasResponseKey(node, "_id")) {
+          added.push(field("_id"));
+        }
+        if (!hasResponseKey(node, "__typename")) {
+          added.push(field("__typename"));
+        }
+        if (!added.length) return;
+        return { ...node, selections: [...added, ...node.selections] };
+      }
+    })
+  );
+}
+var preprIds = {
+  transform({
+    documents,
+    schema
+  }) {
+    const built = buildASTSchema(schema, { assumeValidSDL: true });
+    return documents.map(
+      (file) => file.document ? { ...file, document: addPreprIds(file.document, built) } : file
+    );
+  }
+};
+export {
+  addPreprIds,
+  preprIds
+};