@getuserfeedback/protocol 0.5.11 → 0.6.0

package/dist/widget-config.js

@@ -1,61 +1,51 @@
-import * as z from "zod";
+import * as z from "zod/mini";
 import { appEventCapabilitySchema, appEventFlagSchema } from "./app-event.js";
 import { clientMetaSchema } from "./client-meta.js";
 import { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
 import { runtimeEndpointsSchema } from "./runtime-endpoints.js";
+import { scopeIdSchema } from "./scopes.js";
 const colorSchemeValueSchema = z.enum(["light", "dark", "system"]);
 const autoDetectColorSchemeArraySchema = z
-    .array(z.string().trim().min(1))
-    .min(1);
-const publicGrantScopeIds = [
-    "analytics.storage",
-    "analytics.measurement",
-    "personalization.storage",
-    "ads.storage",
-    "ads.user_data",
-    "ads.personalization",
-];
-export const publicGrantScopeIdSchema = z.enum(publicGrantScopeIds);
-export function isPublicGrantScope(value) {
-    return publicGrantScopeIdSchema.safeParse(value).success;
-}
+    .array(z.string().check(z.trim(), z.minLength(1)))
+    .check(z.minLength(1));
 export const colorSchemeConfigInputSchema = z.union([
-    z
-        .object({
+    z.strictObject({
         autoDetectColorScheme: autoDetectColorSchemeArraySchema,
-    })
-        .strict(),
+    }),
     colorSchemeValueSchema,
 ]);
+export const telemetryConfigInputSchema = z.object({
+    enabled: z.optional(z.boolean()),
+});
 export const consentConfigInputSchema = z.union([
     z.enum(["granted", "denied", "pending", "revoked"]),
-    z.array(publicGrantScopeIdSchema),
+    z.array(scopeIdSchema),
 ]);
 export const debugInputSchema = z.union([
     z.boolean(),
     z.string(),
     z.array(z.string()),
 ]);
+export const authJwtConfigInputSchema = z.object({
+    token: z.string().check(z.trim(), z.minLength(1)),
+});
 export const authConfigInputSchema = z.object({
-    jwt: z.optional(z.union([
-        z.object({
-            token: z.string().trim().min(1),
-        }),
-        z.null(),
-    ])),
+    jwt: z.optional(z.union([authJwtConfigInputSchema, z.null()])),
+});
+export const identityConfigInputSchema = z.object({
+    anonymousId: z.optional(z.string().check(z.trim(), z.minLength(1))),
+    userId: z.optional(z.string().check(z.trim(), z.minLength(1))),
+    traits: z.optional(z.record(z.string(), z.unknown())),
 });
 export const flagsConfigInputSchema = z.array(appEventFlagSchema);
 export const hostCapabilitiesConfigInputSchema = z.array(appEventCapabilitySchema);
-export const configureOptionsSchema = z
-    .object({
+export const configureOptionsSchema = z.strictObject({
     colorScheme: z.optional(colorSchemeConfigInputSchema),
     consent: z.optional(consentConfigInputSchema),
     auth: z.optional(authConfigInputSchema),
-})
-    .strict();
-export const initOptionsSchema = z
-    .object({
-    apiKey: z.string().trim().min(1),
+});
+export const initOptionsSchema = z.strictObject({
+    apiKey: z.string().check(z.trim(), z.minLength(1)),
     colorScheme: z.optional(colorSchemeConfigInputSchema),
     disableTelemetry: z.optional(z.boolean()),
     enableDebug: z.optional(debugInputSchema),
@@ -65,8 +55,48 @@ export const initOptionsSchema = z
     flags: z.optional(flagsConfigInputSchema),
     hostCapabilities: z.optional(hostCapabilitiesConfigInputSchema),
     runtimeEndpoints: z.optional(runtimeEndpointsSchema),
-})
-    .strict();
+});
 export const DEFAULT_COLOR_SCHEME_CONFIG = {
     autoDetectColorScheme: [...DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS],
 };
+/**
+ * Schema for the subset of instance config that can be updated via merge (any source).
+ * Telemetry, enableDebug, clientMeta, SDK protocol capabilities, customer
+ * flags, and customer host capabilities are set at registration only.
+ */
+export const instanceUpdateableConfigSchema = z.strictObject({
+    colorScheme: z.optional(colorSchemeConfigInputSchema),
+    consent: z.optional(consentConfigInputSchema),
+    auth: z.optional(authConfigInputSchema),
+    identity: z.optional(identityConfigInputSchema),
+});
+/** Keys that may be merged into instance config (updatable subset). */
+export const INSTANCE_CONFIG_UPDATE_KEYS = [
+    "colorScheme",
+    "consent",
+    "auth",
+    "identity",
+];
+/**
+ * Schema for resolved instance config state. Used when producing or validating
+ * stored config (e.g. after register or merge). Defaults are applied here so
+ * state always has a full shape; parse partial input with this schema to get
+ * resolved state. For update shape use InstanceUpdateableConfig. Configure
+ * command opts are in widget-commands (widgetConfigUpdateSchema).
+ */
+export const coreInstanceConfigSchema = z.strictObject({
+    colorScheme: z._default(z.optional(colorSchemeConfigInputSchema), {
+        autoDetectColorScheme: [...DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS],
+    }),
+    disableTelemetry: z._default(z.optional(z.boolean()), false),
+    enableDebug: z._default(z.optional(debugInputSchema), false),
+    consent: z.optional(consentConfigInputSchema),
+    auth: z.optional(authConfigInputSchema),
+    identity: z.optional(identityConfigInputSchema),
+    apiKey: z.string().check(z.trim(), z.minLength(1)),
+    clientMeta: z.optional(clientMetaSchema),
+    capabilities: z.optional(z.array(z.string())),
+    flags: z.optional(flagsConfigInputSchema),
+    hostCapabilities: z.optional(hostCapabilitiesConfigInputSchema),
+    runtimeEndpoints: z.optional(runtimeEndpointsSchema),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@getuserfeedback/protocol",
-	"version": "0.5.11",
+	"version": "0.6.0",
 	"description": "getuserfeedback widget protocol — host surface and (later) wire protocol",
 	"keywords": [
 		"getuserfeedback",