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

package/README.md

@@ -737,12 +737,13 @@ There are three ways to get them there. Pick the first that fits your setup.
 
 #### Option 1: GraphQL Codegen (recommended)
 
-Add the `preprIds` document transform to your Codegen output. `_id` and
-`__typename` are added wherever your schema has them: on models and
-components, and inside each member of a dynamic content field. Collections
-like `Pages` and unions themselves never get an `_id`, so the queries stay
-valid. Your `.graphql` files stay as they are; the generated documents and
-types include the fields, at no runtime cost.
+Add the `preprIds` document transform to your Codegen output. `_id` is
+added wherever your schema has one: on models and components, and inside
+each member of a dynamic content field. Collections like `Pages` and unions
+themselves never get an `_id`, so the queries stay valid. Your `.graphql`
+files stay as they are; the generated documents and types include the field,
+at no runtime cost. Adding a field never breaks code that compiles today, so
+this is safe to turn on in an existing project.
 
 ```ts
 // codegen.ts
@@ -766,6 +767,13 @@ export default config;
 Run Codegen again after adding it. Needs `graphql` 16 or later, which a
 Codegen setup already has.
 
+To add `__typename` everywhere too, use `createPreprIds({ typename: true })`
+instead. It is off by default because a selected `__typename` changes the
+generated types: each member of a union is typed on its own, so code that
+reads a union's fields without checking `__typename` first stops compiling.
+Live preview only needs it on dynamic content entries, where you select it
+already to render them.
+
 #### Option 2: at runtime, without Codegen
 
 `addPreprIds(document, schema)` does the same to a parsed query. It needs

package/dist/astro/index.cjs

@@ -31,7 +31,7 @@ __export(astro_exports, {
 module.exports = __toCommonJS(astro_exports);
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/features.ts
 function isEnabled(config) {

package/dist/astro/index.js

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

package/dist/{chunk-KZIRM54F.js → chunk-HVS5QLWG.js}

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

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

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

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

@@ -2,7 +2,7 @@ import {
   ALL_FEATURES_ENABLED,
   VERSION,
   resolveFeatures
-} from "./chunk-WHZNCYUS.js";
+} from "./chunk-JUXP5KRX.js";
 import {
   createIframeBridge,
   isLocale,

package/dist/codegen/index.cjs

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var codegen_exports = {};
 __export(codegen_exports, {
   addPreprIds: () => addPreprIds,
+  createPreprIds: () => createPreprIds,
   preprIds: () => preprIds
 });
 module.exports = __toCommonJS(codegen_exports);
@@ -33,7 +34,8 @@ function hasResponseKey(set, key) {
     (s) => s.kind === import_graphql.Kind.FIELD && (s.alias ?? s.name).value === key
   );
 }
-function addPreprIds(document, schema) {
+function addPreprIds(document, schema, options = {}) {
+  const typename = options.typename ?? false;
   const roots = new Set(
     [
       schema.getQueryType(),
@@ -52,7 +54,7 @@ function addPreprIds(document, schema) {
         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")) {
+        if (typename && !hasResponseKey(node, "__typename")) {
           added.push(field("__typename"));
         }
         if (!added.length) return;
@@ -61,19 +63,20 @@ function addPreprIds(document, schema) {
     })
   );
 }
-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
-    );
-  }
-};
+function createPreprIds(options = {}) {
+  return {
+    transform({ documents, schema }) {
+      const built = (0, import_graphql.buildASTSchema)(schema, { assumeValidSDL: true });
+      return documents.map(
+        (file) => file.document ? { ...file, document: addPreprIds(file.document, built, options) } : file
+      );
+    }
+  };
+}
+var preprIds = createPreprIds();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addPreprIds,
+  createPreprIds,
   preprIds
 });

package/dist/codegen/index.d.cts

@@ -6,23 +6,50 @@ import { DocumentNode, GraphQLSchema } from 'graphql';
  */
 interface CodegenDocumentFile {
     document?: DocumentNode;
-    [key: string]: unknown;
+}
+interface PreprIdsOptions {
+    /**
+     * Also select `__typename` on every object, interface and union below the
+     * root. Default `false`: a selected `__typename` changes the types Codegen
+     * generates (each union member is typed separately, and objects built by
+     * hand must carry one), which can break code that compiles today. Live
+     * preview only needs it on dynamic content entries, where you select it
+     * already to render them.
+     */
+    typename?: boolean;
 }
 /**
- * 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.
+ * Select `_id` on every level of a query that has one, so live preview and
+ * click-to-edit can find each item without you selecting it 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.
+ * The schema decides where it goes: only on types that have an `_id`
+ * (models and components, not collections like `Pages` or unions; inside a
+ * union, on each member). Adding a field never breaks the types Codegen
+ * generates. With `typename: true`, `__typename` is added on every object,
+ * interface and union below the root too. Fields already selected are left
+ * as they are.
  */
-declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema): DocumentNode;
+declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema, options?: PreprIdsOptions): DocumentNode;
+/** A GraphQL Codegen document transform. */
+interface CodegenDocumentTransform {
+    transform<File extends CodegenDocumentFile>(options: {
+        documents: File[];
+        schema: DocumentNode;
+    }): File[];
+}
 /**
  * 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:
+ * document, with options:
+ *
+ * ```ts
+ * documentTransforms: [createPreprIds({ typename: true })],
+ * ```
+ */
+declare function createPreprIds(options?: PreprIdsOptions): CodegenDocumentTransform;
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, so the generated documents and types include `_id` wherever the
+ * schema has one:
  *
  * ```ts
  * // codegen.ts
@@ -35,12 +62,9 @@ declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema): Doc
  *   },
  * },
  * ```
+ *
+ * `createPreprIds({ typename: true })` adds `__typename` as well.
  */
-declare const preprIds: {
-    transform({ documents, schema, }: {
-        documents: CodegenDocumentFile[];
-        schema: DocumentNode;
-    }): CodegenDocumentFile[];
-};
+declare const preprIds: CodegenDocumentTransform;
 
-export { type CodegenDocumentFile, addPreprIds, preprIds };
+export { type CodegenDocumentFile, type CodegenDocumentTransform, type PreprIdsOptions, addPreprIds, createPreprIds, preprIds };

package/dist/codegen/index.d.ts

@@ -6,23 +6,50 @@ import { DocumentNode, GraphQLSchema } from 'graphql';
  */
 interface CodegenDocumentFile {
     document?: DocumentNode;
-    [key: string]: unknown;
+}
+interface PreprIdsOptions {
+    /**
+     * Also select `__typename` on every object, interface and union below the
+     * root. Default `false`: a selected `__typename` changes the types Codegen
+     * generates (each union member is typed separately, and objects built by
+     * hand must carry one), which can break code that compiles today. Live
+     * preview only needs it on dynamic content entries, where you select it
+     * already to render them.
+     */
+    typename?: boolean;
 }
 /**
- * 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.
+ * Select `_id` on every level of a query that has one, so live preview and
+ * click-to-edit can find each item without you selecting it 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.
+ * The schema decides where it goes: only on types that have an `_id`
+ * (models and components, not collections like `Pages` or unions; inside a
+ * union, on each member). Adding a field never breaks the types Codegen
+ * generates. With `typename: true`, `__typename` is added on every object,
+ * interface and union below the root too. Fields already selected are left
+ * as they are.
  */
-declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema): DocumentNode;
+declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema, options?: PreprIdsOptions): DocumentNode;
+/** A GraphQL Codegen document transform. */
+interface CodegenDocumentTransform {
+    transform<File extends CodegenDocumentFile>(options: {
+        documents: File[];
+        schema: DocumentNode;
+    }): File[];
+}
 /**
  * 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:
+ * document, with options:
+ *
+ * ```ts
+ * documentTransforms: [createPreprIds({ typename: true })],
+ * ```
+ */
+declare function createPreprIds(options?: PreprIdsOptions): CodegenDocumentTransform;
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, so the generated documents and types include `_id` wherever the
+ * schema has one:
  *
  * ```ts
  * // codegen.ts
@@ -35,12 +62,9 @@ declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema): Doc
  *   },
  * },
  * ```
+ *
+ * `createPreprIds({ typename: true })` adds `__typename` as well.
  */
-declare const preprIds: {
-    transform({ documents, schema, }: {
-        documents: CodegenDocumentFile[];
-        schema: DocumentNode;
-    }): CodegenDocumentFile[];
-};
+declare const preprIds: CodegenDocumentTransform;
 
-export { type CodegenDocumentFile, addPreprIds, preprIds };
+export { type CodegenDocumentFile, type CodegenDocumentTransform, type PreprIdsOptions, addPreprIds, createPreprIds, preprIds };

package/dist/codegen/index.js

@@ -17,7 +17,8 @@ function hasResponseKey(set, key) {
     (s) => s.kind === Kind.FIELD && (s.alias ?? s.name).value === key
   );
 }
-function addPreprIds(document, schema) {
+function addPreprIds(document, schema, options = {}) {
+  const typename = options.typename ?? false;
   const roots = new Set(
     [
       schema.getQueryType(),
@@ -36,7 +37,7 @@ function addPreprIds(document, schema) {
         if ((isObjectType(type) || isInterfaceType(type)) && "_id" in type.getFields() && !hasResponseKey(node, "_id")) {
           added.push(field("_id"));
         }
-        if (!hasResponseKey(node, "__typename")) {
+        if (typename && !hasResponseKey(node, "__typename")) {
           added.push(field("__typename"));
         }
         if (!added.length) return;
@@ -45,18 +46,19 @@ function addPreprIds(document, schema) {
     })
   );
 }
-var preprIds = {
-  transform({
-    documents,
-    schema
-  }) {
-    const built = buildASTSchema(schema, { assumeValidSDL: true });
-    return documents.map(
-      (file) => file.document ? { ...file, document: addPreprIds(file.document, built) } : file
-    );
-  }
-};
+function createPreprIds(options = {}) {
+  return {
+    transform({ documents, schema }) {
+      const built = buildASTSchema(schema, { assumeValidSDL: true });
+      return documents.map(
+        (file) => file.document ? { ...file, document: addPreprIds(file.document, built, options) } : file
+      );
+    }
+  };
+}
+var preprIds = createPreprIds();
 export {
   addPreprIds,
+  createPreprIds,
   preprIds
 };

package/dist/index.cjs

@@ -50,7 +50,7 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/features.ts
 function isEnabled(config) {

package/dist/index.d.cts

@@ -5,7 +5,7 @@ export { g as PreprEnvironment, h as PreprEventType, i as PreprFeatureConfig, j
  * Package version; must match package.json. Lives in its own leaf module so
  * core can import it without cycling through the barrel.
  */
-declare const VERSION = "0.5.0-rc.6";
+declare const VERSION = "0.5.0-rc.7";
 
 /**
  * Resolve a `PreprFeatures` bag to plain booleans, defaulting every omitted key

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export { g as PreprEnvironment, h as PreprEventType, i as PreprFeatureConfig, j
  * Package version; must match package.json. Lives in its own leaf module so
  * core can import it without cycling through the barrel.
  */
-declare const VERSION = "0.5.0-rc.6";
+declare const VERSION = "0.5.0-rc.7";
 
 /**
  * Resolve a `PreprFeatures` bag to plain booleans, defaulting every omitted key

package/dist/index.js

@@ -17,7 +17,7 @@ import {
   setTrackingParam,
   stegaClean,
   trackEvent
-} from "./chunk-L3SDL6MP.js";
+} from "./chunk-SUAFASBB.js";
 import {
   PreprError,
   extractAccessToken,
@@ -28,11 +28,11 @@ import {
   getPreprUUIDFromHeaders,
   getToolbarPropsFromHeaders,
   validatePreprToken
-} from "./chunk-KZIRM54F.js";
+} from "./chunk-HVS5QLWG.js";
 import {
   VERSION,
   resolveFeatures
-} from "./chunk-WHZNCYUS.js";
+} from "./chunk-JUXP5KRX.js";
 import {
   createLiveBridge,
   createLiveStore

package/dist/nextjs/components.cjs

@@ -3525,7 +3525,7 @@ function createPreprPreview(opts = {}) {
 var import_react = require("react");
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/pixel.ts
 var PIXEL_SCRIPT_URL = "https://cdn.tracking.prepr.io/js/prepr.min.js";

package/dist/nextjs/components.js

@@ -2,8 +2,8 @@
 import {
   createPreprPreview,
   loadTrackingPixel
-} from "../chunk-L3SDL6MP.js";
-import "../chunk-WHZNCYUS.js";
+} from "../chunk-SUAFASBB.js";
+import "../chunk-JUXP5KRX.js";
 import "../chunk-URXSDJOU.js";
 import "../chunk-S3VT4UWM.js";
 

package/dist/nextjs/index.cjs

@@ -49,7 +49,7 @@ module.exports = __toCommonJS(nextjs_exports);
 var import_server = require("next/server");
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";

package/dist/nextjs/index.js

@@ -2,7 +2,7 @@
 import { NextResponse } from "next/server";
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";

package/dist/nextjs/live-action.js

@@ -1,8 +1,8 @@
 "use server";
 import {
   isPreviewFromHeaders
-} from "../chunk-KZIRM54F.js";
-import "../chunk-WHZNCYUS.js";
+} from "../chunk-HVS5QLWG.js";
+import "../chunk-JUXP5KRX.js";
 import {
   parsePatchLog
 } from "../chunk-KD3GK6TO.js";

package/dist/nuxt/index.cjs

@@ -35,7 +35,7 @@ __export(nuxt_exports, {
 module.exports = __toCommonJS(nuxt_exports);
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";

package/dist/nuxt/index.js

@@ -1,5 +1,5 @@
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";

package/dist/react/components.cjs

@@ -3521,7 +3521,7 @@ function createPreprPreview(opts = {}) {
 }
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/pixel.ts
 var PIXEL_SCRIPT_URL = "https://cdn.tracking.prepr.io/js/prepr.min.js";

package/dist/react/components.js

@@ -3497,7 +3497,7 @@ function createPreprPreview(opts = {}) {
 }
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/pixel.ts
 var PIXEL_SCRIPT_URL = "https://cdn.tracking.prepr.io/js/prepr.min.js";

package/dist/sveltekit/index.cjs

@@ -35,7 +35,7 @@ __export(sveltekit_exports, {
 module.exports = __toCommonJS(sveltekit_exports);
 
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";

package/dist/sveltekit/index.js

@@ -1,5 +1,5 @@
 // src/version.ts
-var VERSION = "0.5.0-rc.6";
+var VERSION = "0.5.0-rc.7";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@preprio/toolkit",
-  "version": "0.5.0-rc.6",
+  "version": "0.5.0-rc.7",
   "description": "Prepr personalization, A/B testing and preview toolkit for React, Next.js, Nuxt, Astro, SvelteKit and Express",
   "license": "Apache-2.0",
   "author": "Prepr B.V. (https://prepr.io)",