@preprio/toolkit 0.6.0-alpha.0 → 0.6.0-alpha.1

package/dist/graphql.cjs

@@ -23,10 +23,14 @@ __export(graphql_exports, {
   PREPR_DEFAULT_VARIANT: () => PREPR_DEFAULT_VARIANT,
   PreprError: () => PreprError,
   createPreprClient: () => createPreprClient,
+  decisionsFrom: () => decisionsFrom,
   isPersonalizedResponse: () => isPersonalizedResponse,
+  loadPreprSchema: () => loadPreprSchema,
   preprVariantProps: () => preprVariantProps,
   resolveVariants: () => resolveVariants,
-  splitStack: () => splitStack
+  splitStack: () => splitStack,
+  toDecisionQuery: () => toDecisionQuery,
+  toVariantsQuery: () => toVariantsQuery
 });
 module.exports = __toCommonJS(graphql_exports);
 
@@ -534,6 +538,63 @@ function toVariantsDocument(document2, schema) {
   };
 }
 
+// src/core/graphql/document.ts
+var import_printer = require("graphql/language/printer.js");
+var import_stripIgnoredCharacters = require("graphql/utilities/stripIgnoredCharacters.js");
+var printed = /* @__PURE__ */ new WeakMap();
+function isDocumentNode(value) {
+  return typeof value === "object" && value !== null && value.kind === "Document" && Array.isArray(value.definitions);
+}
+function invalidDocument(originalError) {
+  return new PreprError(
+    "Expected a GraphQL query string, TypedDocumentString or DocumentNode",
+    "INVALID_DOCUMENT",
+    "createPreprClient",
+    originalError
+  );
+}
+var minified = /* @__PURE__ */ new Map();
+var MINIFIED_CACHE_LIMIT = 500;
+function minify(query) {
+  const cached = minified.get(query);
+  if (cached !== void 0) return cached;
+  let result = query;
+  try {
+    result = (0, import_stripIgnoredCharacters.stripIgnoredCharacters)(query);
+  } catch {
+  }
+  if (minified.size < MINIFIED_CACHE_LIMIT) minified.set(query, result);
+  return result;
+}
+function resolveQuery(document2) {
+  if (typeof document2 === "string") return minify(document2);
+  if (document2 instanceof String) return minify(document2.toString());
+  if (!isDocumentNode(document2)) throw invalidDocument();
+  let query = printed.get(document2);
+  if (query === void 0) {
+    try {
+      query = minify((0, import_printer.print)(document2));
+    } catch (error) {
+      throw invalidDocument(error instanceof Error ? error : void 0);
+    }
+    printed.set(document2, query);
+  }
+  return query;
+}
+
+// src/core/variants/queries.ts
+function toVariantsQuery(document2, schema) {
+  return resolveQuery(toVariantsDocument(document2, schema));
+}
+function toDecisionQuery(document2, schema, options = {}) {
+  const paths = options.from === void 0 ? void 0 : personalizationPaths(options.from);
+  if (paths && paths.size === 0) return null;
+  const decision = toDecisionDocument(document2, schema, paths, {
+    topLevelOnly: !paths && options.topLevelOnly
+  });
+  return decision ? resolveQuery(decision) : null;
+}
+
 // src/core/graphql/transport.ts
 var import_stega2 = require("@vercel/stega");
 
@@ -593,50 +654,6 @@ function stegaClean(text) {
   return (0, import_stega.vercelStegaClean)(text);
 }
 
-// src/core/graphql/document.ts
-var import_printer = require("graphql/language/printer.js");
-var import_stripIgnoredCharacters = require("graphql/utilities/stripIgnoredCharacters.js");
-var printed = /* @__PURE__ */ new WeakMap();
-function isDocumentNode(value) {
-  return typeof value === "object" && value !== null && value.kind === "Document" && Array.isArray(value.definitions);
-}
-function invalidDocument(originalError) {
-  return new PreprError(
-    "Expected a GraphQL query string, TypedDocumentString or DocumentNode",
-    "INVALID_DOCUMENT",
-    "createPreprClient",
-    originalError
-  );
-}
-var minified = /* @__PURE__ */ new Map();
-var MINIFIED_CACHE_LIMIT = 500;
-function minify(query) {
-  const cached = minified.get(query);
-  if (cached !== void 0) return cached;
-  let result = query;
-  try {
-    result = (0, import_stripIgnoredCharacters.stripIgnoredCharacters)(query);
-  } catch {
-  }
-  if (minified.size < MINIFIED_CACHE_LIMIT) minified.set(query, result);
-  return result;
-}
-function resolveQuery(document2) {
-  if (typeof document2 === "string") return minify(document2);
-  if (document2 instanceof String) return minify(document2.toString());
-  if (!isDocumentNode(document2)) throw invalidDocument();
-  let query = printed.get(document2);
-  if (query === void 0) {
-    try {
-      query = minify((0, import_printer.print)(document2));
-    } catch (error) {
-      throw invalidDocument(error instanceof Error ? error : void 0);
-    }
-    printed.set(document2, query);
-  }
-  return query;
-}
-
 // src/core/graphql/transport.ts
 var OPERATION_NAME = /\b(?:query|mutation|subscription)\s+([_A-Za-z][_0-9A-Za-z]*)/;
 var STEGA_RAW = new RegExp(
@@ -816,16 +833,18 @@ function isParseableUrl(url) {
     return false;
   }
 }
-function createPreprClient(options) {
-  const { url } = options;
+function assertPreprUrl(url, source) {
   validatePreprToken(url);
   if (!isParseableUrl(url)) {
     throw new PreprError(
       "Prepr GraphQL URL is not a valid URL",
       "INVALID_TOKEN",
-      "createPreprClient"
+      source
     );
   }
+}
+function createPreprClient(options) {
+  assertPreprUrl(options.url, "createPreprClient");
   const run = createTransport(options);
   const probeVary = createVaryProbe(run, options);
   let schema;
@@ -882,13 +901,41 @@ function createPreprClient(options) {
     )
   };
 }
+
+// src/core/graphql/schema-loader.ts
+var schemas = /* @__PURE__ */ new Map();
+async function loadPreprSchema(url, options = {}) {
+  assertPreprUrl(url, "loadPreprSchema");
+  let schema = schemas.get(url);
+  if (!schema) {
+    const run = createTransport({ url, fetch: options.fetch, stega: "none" });
+    schema = run(
+      PREPR_SCHEMA_QUERY
+    ).then((result) => toSchemaInfo(result.data)).catch((error) => {
+      schemas.delete(url);
+      if (error instanceof PreprError) throw error;
+      throw new PreprError(
+        "Prepr schema response is not an introspection result",
+        "INVALID_RESPONSE",
+        "loadPreprSchema",
+        error instanceof Error ? error : void 0
+      );
+    });
+    schemas.set(url, schema);
+  }
+  return schema;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PREPR_DEFAULT_VARIANT,
   PreprError,
   createPreprClient,
+  decisionsFrom,
   isPersonalizedResponse,
+  loadPreprSchema,
   preprVariantProps,
   resolveVariants,
-  splitStack
+  splitStack,
+  toDecisionQuery,
+  toVariantsQuery
 });

package/dist/graphql.d.cts

@@ -8,6 +8,12 @@ declare const PREPR_DEFAULT_VARIANT = "ALL_OTHER_USERS";
 
 /** The variant ids Prepr chose for one visitor, per personalization group. */
 type PreprDecisions = ReadonlyMap<string, readonly string[]>;
+/**
+ * Variant ids per group from a decision response, de-duplicated and in
+ * Prepr's order. A visitor in several segments can get more than one variant
+ * of the same group, so each entry is a list.
+ */
+declare function decisionsFrom(data: unknown): PreprDecisions;
 interface ResolveVariantsOptions {
     /**
      * The visitor's per-group variants (from a decision query). Without it,
@@ -24,6 +30,24 @@ interface ResolveVariantsOptions {
  */
 declare function resolveVariants<T>(data: T, options?: ResolveVariantsOptions): T;
 
+interface FieldInfo {
+    /** Named type of the field, without list/non-null wrappers. */
+    type: string;
+    /** The field accepts Prepr's `personalize` argument (a stack). */
+    personalizable: boolean;
+}
+interface TypeInfo {
+    fields: Record<string, FieldInfo>;
+    /** Members of a union or implementations of an interface. */
+    possibleTypes: string[];
+    hasContext: boolean;
+}
+/** The slice of the schema the variant transforms need. */
+interface PreprSchemaInfo {
+    queryType: string;
+    types: Record<string, TypeInfo>;
+}
+
 /** A run of stack items that renders the same way: see {@link splitStack}. */
 interface PreprStackBlock<T> {
     key: string;
@@ -72,6 +96,39 @@ interface PreprVariantProps {
  */
 declare function preprVariantProps(item: unknown): PreprVariantProps;
 
+/**
+ * The schema facts the query rewrites need, from `loadPreprSchema`. Pass it
+ * along; its shape is not part of the public API.
+ */
+type PreprSchema = PreprSchemaInfo;
+/**
+ * Your query, asking for every personalization and A/B variant: what
+ * `query(..., { variants: true })` sends, as a string for your own GraphQL
+ * client. The result is the same for every visitor, so cache it like any
+ * other content query, and render it with `resolveVariants` or `PreprStack`.
+ *
+ * A query without personalizable fields comes back unchanged (minified).
+ */
+declare function toVariantsQuery(document: PreprDocument<unknown, unknown> | string, schema: PreprSchema): string;
+/**
+ * The per-visitor decision query for the same query: send it with the
+ * visitor's Prepr headers, never cached, and pass the response's `data` to
+ * `decisionsFrom`.
+ *
+ * Pass the variants result as `from` whenever you have it: the query then
+ * asks only about the lists that hold segment groups on this page, which is
+ * a few hundred bytes instead of the whole page and markedly faster for a
+ * visitor Prepr has not seen before. Without `from` it asks about every
+ * personalizable list. `topLevelOnly` stops at the first personalizable list
+ * on each path, for middleware that decides only the top of a stack.
+ *
+ * Null when there is nothing to decide: send no request then.
+ */
+declare function toDecisionQuery(document: PreprDocument<unknown, unknown> | string, schema: PreprSchema, options?: {
+    from?: unknown;
+    topLevelOnly?: boolean;
+}): string | null;
+
 /**
  * A GraphQL document accepted by `query`: a plain string, graphql-codegen's
  * `TypedDocumentString` (`documentMode: 'string'`), or any `DocumentNode`,
@@ -228,4 +285,21 @@ interface PreprClient {
  */
 declare function createPreprClient(options: PreprClientOptions): PreprClient;
 
-export { PREPR_DEFAULT_VARIANT, type PreprClient, type PreprClientOptions, type PreprDecideOptions, type PreprDecisions, type PreprDocument, PreprHeaders, type PreprQueryOptions, type PreprQueryResult, type PreprStackBlock, type PreprStegaMode, type PreprVariantProps, type ResolveVariantsOptions, createPreprClient, preprVariantProps, resolveVariants, splitStack };
+/**
+ * Loads what `toVariantsQuery` and `toDecisionQuery` need to know about your
+ * Prepr schema (which fields take `personalize`, which types can hold
+ * variants) with one introspection request, kept in memory per URL. For a
+ * site that uses its own GraphQL client; `createPreprClient` does this
+ * itself.
+ *
+ * Load it once at startup or lazily before the first rewrite. Schema changes
+ * in Prepr take effect after a restart or redeploy.
+ *
+ * @throws PreprError when the URL is invalid or the request fails; the URL,
+ *   which holds your access token, is never part of the message.
+ */
+declare function loadPreprSchema(url: string, options?: {
+    fetch?: typeof fetch;
+}): Promise<PreprSchemaInfo>;
+
+export { PREPR_DEFAULT_VARIANT, type PreprClient, type PreprClientOptions, type PreprDecideOptions, type PreprDecisions, type PreprDocument, PreprHeaders, type PreprQueryOptions, type PreprQueryResult, type PreprSchema, type PreprStackBlock, type PreprStegaMode, type PreprVariantProps, type ResolveVariantsOptions, createPreprClient, decisionsFrom, loadPreprSchema, preprVariantProps, resolveVariants, splitStack, toDecisionQuery, toVariantsQuery };

package/dist/graphql.d.ts

@@ -8,6 +8,12 @@ declare const PREPR_DEFAULT_VARIANT = "ALL_OTHER_USERS";
 
 /** The variant ids Prepr chose for one visitor, per personalization group. */
 type PreprDecisions = ReadonlyMap<string, readonly string[]>;
+/**
+ * Variant ids per group from a decision response, de-duplicated and in
+ * Prepr's order. A visitor in several segments can get more than one variant
+ * of the same group, so each entry is a list.
+ */
+declare function decisionsFrom(data: unknown): PreprDecisions;
 interface ResolveVariantsOptions {
     /**
      * The visitor's per-group variants (from a decision query). Without it,
@@ -24,6 +30,24 @@ interface ResolveVariantsOptions {
  */
 declare function resolveVariants<T>(data: T, options?: ResolveVariantsOptions): T;
 
+interface FieldInfo {
+    /** Named type of the field, without list/non-null wrappers. */
+    type: string;
+    /** The field accepts Prepr's `personalize` argument (a stack). */
+    personalizable: boolean;
+}
+interface TypeInfo {
+    fields: Record<string, FieldInfo>;
+    /** Members of a union or implementations of an interface. */
+    possibleTypes: string[];
+    hasContext: boolean;
+}
+/** The slice of the schema the variant transforms need. */
+interface PreprSchemaInfo {
+    queryType: string;
+    types: Record<string, TypeInfo>;
+}
+
 /** A run of stack items that renders the same way: see {@link splitStack}. */
 interface PreprStackBlock<T> {
     key: string;
@@ -72,6 +96,39 @@ interface PreprVariantProps {
  */
 declare function preprVariantProps(item: unknown): PreprVariantProps;
 
+/**
+ * The schema facts the query rewrites need, from `loadPreprSchema`. Pass it
+ * along; its shape is not part of the public API.
+ */
+type PreprSchema = PreprSchemaInfo;
+/**
+ * Your query, asking for every personalization and A/B variant: what
+ * `query(..., { variants: true })` sends, as a string for your own GraphQL
+ * client. The result is the same for every visitor, so cache it like any
+ * other content query, and render it with `resolveVariants` or `PreprStack`.
+ *
+ * A query without personalizable fields comes back unchanged (minified).
+ */
+declare function toVariantsQuery(document: PreprDocument<unknown, unknown> | string, schema: PreprSchema): string;
+/**
+ * The per-visitor decision query for the same query: send it with the
+ * visitor's Prepr headers, never cached, and pass the response's `data` to
+ * `decisionsFrom`.
+ *
+ * Pass the variants result as `from` whenever you have it: the query then
+ * asks only about the lists that hold segment groups on this page, which is
+ * a few hundred bytes instead of the whole page and markedly faster for a
+ * visitor Prepr has not seen before. Without `from` it asks about every
+ * personalizable list. `topLevelOnly` stops at the first personalizable list
+ * on each path, for middleware that decides only the top of a stack.
+ *
+ * Null when there is nothing to decide: send no request then.
+ */
+declare function toDecisionQuery(document: PreprDocument<unknown, unknown> | string, schema: PreprSchema, options?: {
+    from?: unknown;
+    topLevelOnly?: boolean;
+}): string | null;
+
 /**
  * A GraphQL document accepted by `query`: a plain string, graphql-codegen's
  * `TypedDocumentString` (`documentMode: 'string'`), or any `DocumentNode`,
@@ -228,4 +285,21 @@ interface PreprClient {
  */
 declare function createPreprClient(options: PreprClientOptions): PreprClient;
 
-export { PREPR_DEFAULT_VARIANT, type PreprClient, type PreprClientOptions, type PreprDecideOptions, type PreprDecisions, type PreprDocument, PreprHeaders, type PreprQueryOptions, type PreprQueryResult, type PreprStackBlock, type PreprStegaMode, type PreprVariantProps, type ResolveVariantsOptions, createPreprClient, preprVariantProps, resolveVariants, splitStack };
+/**
+ * Loads what `toVariantsQuery` and `toDecisionQuery` need to know about your
+ * Prepr schema (which fields take `personalize`, which types can hold
+ * variants) with one introspection request, kept in memory per URL. For a
+ * site that uses its own GraphQL client; `createPreprClient` does this
+ * itself.
+ *
+ * Load it once at startup or lazily before the first rewrite. Schema changes
+ * in Prepr take effect after a restart or redeploy.
+ *
+ * @throws PreprError when the URL is invalid or the request fails; the URL,
+ *   which holds your access token, is never part of the message.
+ */
+declare function loadPreprSchema(url: string, options?: {
+    fetch?: typeof fetch;
+}): Promise<PreprSchemaInfo>;
+
+export { PREPR_DEFAULT_VARIANT, type PreprClient, type PreprClientOptions, type PreprDecideOptions, type PreprDecisions, type PreprDocument, PreprHeaders, type PreprQueryOptions, type PreprQueryResult, type PreprSchema, type PreprStackBlock, type PreprStegaMode, type PreprVariantProps, type ResolveVariantsOptions, createPreprClient, decisionsFrom, loadPreprSchema, preprVariantProps, resolveVariants, splitStack, toDecisionQuery, toVariantsQuery };