@revturbine/sdk 0.11.10 → 0.11.11

package/dist/optimizely.d.ts

@@ -212,10 +212,73 @@ declare const UserPlanContextSchema: z.ZodObject<{
         none: "none";
     }>>;
 }, z.core.$strip>;
+/**
+ * Server-evaluated built-in segment dimension values for the user (plan 279
+ * PD-3). `buildTargetingState` stamps each present, in-vocabulary leaf onto
+ * the reserved `rt_<dimension>` segment trait; nothing else may set an `rt_*`
+ * trait (PD-1). An ABSENT leaf means "not evaluated" and stamps nothing, so
+ * every built-in of that dimension fails closed (PD-4, unknown is absence);
+ * when the control plane evaluated a dimension and found no classification it
+ * delivers the dimension's explicit fallback value instead.
+ *
+ * Assembled at retrieval — never persisted as a blob; the sources keep their
+ * own columns.
+ */
+declare const UserBuiltinDimensionsSchema: z.ZodObject<{
+    activity_level: z.ZodOptional<z.ZodEnum<{
+        inactive: "inactive";
+        new: "new";
+        high: "high";
+        medium: "medium";
+        low: "low";
+    }>>;
+    subscription_state: z.ZodOptional<z.ZodEnum<{
+        trial: "trial";
+        none: "none";
+        paid: "paid";
+        cancelled: "cancelled";
+    }>>;
+    trial_type: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        free_trial: "free_trial";
+        reverse_trial: "reverse_trial";
+    }>>;
+    seat_type: z.ZodOptional<z.ZodString>;
+    buyer_role: z.ZodOptional<z.ZodEnum<{
+        buyer: "buyer";
+        non_buyer: "non_buyer";
+    }>>;
+    email_type: z.ZodOptional<z.ZodEnum<{
+        unknown: "unknown";
+        business: "business";
+        personal: "personal";
+    }>>;
+    billing_health: z.ZodOptional<z.ZodEnum<{
+        payment_failed: "payment_failed";
+        payment_method_missing: "payment_method_missing";
+        cancelled: "cancelled";
+        no_billing: "no_billing";
+        good_standing: "good_standing";
+        trial_payment_method_attached: "trial_payment_method_attached";
+        payment_overdue: "payment_overdue";
+    }>>;
+    region: z.ZodOptional<z.ZodEnum<{
+        us_canada: "us_canada";
+        europe: "europe";
+        rest_of_world: "rest_of_world";
+    }>>;
+    device_type: z.ZodOptional<z.ZodEnum<{
+        unknown: "unknown";
+        desktop: "desktop";
+        mobile: "mobile";
+        tablet: "tablet";
+    }>>;
+}, z.core.$strip>;
 
 // AUTO-GENERATED by scripts/generate-zod-outputs.ts - do not edit.
 
 
+type UserBuiltinDimensions = z.infer<typeof UserBuiltinDimensionsSchema>;
 type UserPlanContext = z.infer<typeof UserPlanContextSchema>;
 type UserUsageEntry = z.infer<typeof UserUsageEntrySchema>;
 
@@ -257,6 +320,15 @@ interface UserContextSnapshot {
     personalization?: Record<string, JsonValue>;
     /** Canonical experiment-handle to variant-handle assignments. */
     experiments?: Record<string, string>;
+    /**
+     * Built-in segment dimension values (plan 279 PD-3; targeting-studio-ui.md
+     * §4.1 "Built-in segment resolution contract"). The ONLY source of the
+     * reserved `rt_<dimension>` segment traits: `buildTargetingState` stamps
+     * each present, in-vocabulary value and ignores the rest. Delivered by the
+     * control plane's client context, or set by the app itself in `local_only`
+     * mode and on the server ports — a server-delivered value wins.
+     */
+    builtin_dimensions?: UserBuiltinDimensions;
 }
 
 /**

package/dist/types/server-node/client.d.ts

@@ -1,14 +1,14 @@
 /**
  * RevTurbine Server-Side SDK Client.
  *
- * Performs server-to-server evaluation calls against the RevTurbine decision
- * engine and returns a serializable `ServerEvaluationPayload` that the
- * client-side SDK can hydrate.
+ * Holds the customer's **server key** and mints short-lived, browser-safe
+ * `rt_client_` session keys for one end user at a time. Evaluation does not
+ * happen here (plan 192) — it runs in the customer SDKs.
  *
  * Designed for:
- * - Next.js `getServerSideProps` / RSC / API routes
+ * - Next.js RSC / route handlers / `getServerSideProps`
  * - Express / Fastify middleware
- * - Any Node.js server-side rendering pipeline
+ * - Any Node.js backend
  *
  * @example
  * ```ts
@@ -16,27 +16,19 @@
  *
  * const server = new RevTurbineServer({
  *   tenantId: 'tenant_abc',
- *   apiKey: process.env.REVTURBINE_SECRET_KEY!,
+ *   apiKey: process.env.REVTURBINE_API_KEY!, // the server key (rtk_…, type server)
  *   endpoint: 'https://edge.example.com',
  * });
  *
- * // In getServerSideProps:
- * const payload = await server.evaluate({
- *   userId: session.user.id,
- *   traits: { plan: 'pro' },
- *   placements: [{ slotId: 'hero_banner' }],
- *   entitlementHandles: ['advanced_analytics'],
- *   includeTheme: true,
- * });
- *
- * return { props: { rtPayload: payload } };
+ * // Mint a session key for the signed-in user and hand it to the browser.
+ * const { client_token } = await server.createClientSession({ subject: session.user.id });
  * ```
  */
 import type { ClientSessionResult, CreateClientSessionInput, RevTurbineServerOptions } from './types';
 /**
  * Error thrown when a client-session mint request is rejected by the control
  * plane. Carries only the HTTP status and a correlation id — deliberately never
- * the mint secret, request headers, or response body — so the secret cannot leak
+ * the server key, request headers, or response body — so the key cannot leak
  * through error logs (plan 157 AC-8).
  */
 export declare class RevTurbineClientSessionError extends Error {
@@ -73,7 +65,8 @@ export declare class RevTurbineServer {
         create: (input: CreateClientSessionInput) => Promise<ClientSessionResult>;
     };
     /**
-     * Mint a short-lived, opaque per-user client-session token (plan 157).
+     * Mint a short-lived, opaque per-user client-session token (plan 157; the
+     * server key is the minting authority, plan 256).
      *
      * The customer backend — which holds the server key (passed as
      * {@link RevTurbineServerOptions.apiKey}) — calls this to obtain a browser-safe
@@ -82,11 +75,11 @@ export declare class RevTurbineServer {
      * it to read the user's client-safe context.
      *
      * This is a **server-only** capability: the browser SDK never mints tokens (it
-     * only consumes them). Tenant / application / environment are derived
-     * server-side from the mint secret, never from this call.
+     * only consumes them). The tenant is derived server-side from the server key,
+     * never from this call.
      *
      * @throws {RevTurbineClientSessionError} if the control plane rejects the mint.
-     *   The error carries only the HTTP status + request id — never the secret.
+     *   The error carries only the HTTP status + request id — never the key.
      */
     createClientSession(input: CreateClientSessionInput): Promise<ClientSessionResult>;
     private apiCall;

package/dist/types/server-node/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../server-node/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EAExB,uBAAuB,EAQxB,MAAM,SAAS,CAAC;AASjB;;;;;GAKG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;IAEnD,iDAAiD;IACjD,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,6CAA6C;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM;;IAH1B,iDAAiD;IACxC,MAAM,EAAE,MAAM;IACvB,6CAA6C;IACpC,SAAS,EAAE,MAAM;CAK7B;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;gBAEtC,OAAO,EAAE,uBAAuB;IAQ5C;;;;;;;;;;;OAWG;IACH,IAAI,cAAc,IAAI;QACpB,MAAM,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;KAC3E,CAEA;IAED;;;;;;;;;;;;;;;OAeG;IACG,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAqB1E,OAAO;YAaP,MAAM;CAWrB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../server-node/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EAExB,uBAAuB,EAQxB,MAAM,SAAS,CAAC;AASjB;;;;;GAKG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;IAEnD,iDAAiD;IACjD,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,6CAA6C;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM;;IAH1B,iDAAiD;IACxC,MAAM,EAAE,MAAM;IACvB,6CAA6C;IACpC,SAAS,EAAE,MAAM;CAK7B;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;gBAEtC,OAAO,EAAE,uBAAuB;IAQ5C;;;;;;;;;;;OAWG;IACH,IAAI,cAAc,IAAI;QACpB,MAAM,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;KAC3E,CAEA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAqB1E,OAAO;YAaP,MAAM;CAWrB"}

package/dist/types/server-node/index.d.ts

@@ -24,12 +24,12 @@
  *
  * const server = new RevTurbineServer({
  *   tenantId: 'tenant_abc',
- *   apiKey: process.env.REVTURBINE_SECRET_KEY!,
+ *   apiKey: process.env.REVTURBINE_API_KEY!, // the server key (rtk_…, type server)
  *   endpoint: 'https://edge.example.com',
  * });
  *
  * // Hand this to the browser; the client SDK re-mints on expiry.
- * const { token } = await server.createClientSession({ userId: 'user_123' });
+ * const { client_token } = await server.createClientSession({ subject: 'user_123' });
  * ```
  */
 export { RevTurbineServer, RevTurbineClientSessionError } from './client';

package/dist/types/server-node/types.d.ts

@@ -56,8 +56,8 @@ export interface ServerEvaluationRequest {
  * Input for minting a short-lived, per-user client-session token.
  *
  * The customer backend attests the end user, then mints a browser-safe token
- * scoped to exactly that subject. Tenant / application / environment are derived
- * server-side from the mint secret — never from this input.
+ * scoped to exactly that subject. The tenant is derived server-side from the
+ * server key ({@link RevTurbineServerOptions.apiKey}) — never from this input.
  */
 export interface CreateClientSessionInput {
     /** The end-user subject the token is minted for (opaque to RevTurbine). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revturbine/sdk",
-  "version": "0.11.10",
+  "version": "0.11.11",
   "description": "RevTurbine customer-facing SDK — placement decisioning, entitlement checks, and usage tracking.",
   "type": "module",
   "packageManager": "pnpm@11.12.0",
@@ -56,9 +56,9 @@
   "devDependencies": {
     "@growthbook/growthbook": "^1.7.0",
     "@optimizely/optimizely-sdk": "^6.5.0",
-    "@revt-eng/core": "0.1.352",
-    "@revt-eng/schema": "0.1.352",
-    "@revt-eng/schema-external": "0.1.352",
+    "@revt-eng/core": "0.1.359",
+    "@revt-eng/schema": "0.1.359",
+    "@revt-eng/schema-external": "0.1.359",
     "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
     "openapi-fetch": "^0.17.0",