@getuserfeedback/protocol 0.5.0 → 0.5.1

package/dist/app-event.d.ts

@@ -1,23 +1,7 @@
 import * as z from "zod";
-export declare const appEventIdentityTypeSchema: z.ZodEnum<{
-    anonymousId: "anonymousId";
-    userId: "userId";
-    "traits.email": "traits.email";
-    "traits.phone": "traits.phone";
-    "context.device.id": "context.device.id";
-    "context.device.advertisingId": "context.device.advertisingId";
-    "context.device.token": "context.device.token";
-}>;
+export { appEventIdentityTypeSchema } from "./identity-type.js";
 export declare const appEventIdentitySchema: z.ZodObject<{
-    type: z.ZodEnum<{
-        anonymousId: "anonymousId";
-        userId: "userId";
-        "traits.email": "traits.email";
-        "traits.phone": "traits.phone";
-        "context.device.id": "context.device.id";
-        "context.device.advertisingId": "context.device.advertisingId";
-        "context.device.token": "context.device.token";
-    }>;
+    type: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
     value: z.ZodString;
 }, z.core.$strip>;
 export declare const appEventContextSchema: z.ZodObject<{
@@ -32,15 +16,7 @@ export declare const appEventContextSchema: z.ZodObject<{
 export declare const appEventBaseSchema: z.ZodObject<{
     traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     identities: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<{
-            anonymousId: "anonymousId";
-            userId: "userId";
-            "traits.email": "traits.email";
-            "traits.phone": "traits.phone";
-            "context.device.id": "context.device.id";
-            "context.device.advertisingId": "context.device.advertisingId";
-            "context.device.token": "context.device.token";
-        }>;
+        type: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
         value: z.ZodString;
     }, z.core.$strip>>>;
     context: z.ZodOptional<z.ZodObject<{
@@ -58,15 +34,7 @@ export declare const appEventBaseSchema: z.ZodObject<{
 export declare const appEventSurveyViewedSchema: z.ZodObject<{
     traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     identities: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<{
-            anonymousId: "anonymousId";
-            userId: "userId";
-            "traits.email": "traits.email";
-            "traits.phone": "traits.phone";
-            "context.device.id": "context.device.id";
-            "context.device.advertisingId": "context.device.advertisingId";
-            "context.device.token": "context.device.token";
-        }>;
+        type: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
         value: z.ZodString;
     }, z.core.$strip>>>;
     context: z.ZodOptional<z.ZodObject<{
@@ -88,15 +56,7 @@ export declare const appEventSurveyViewedSchema: z.ZodObject<{
 export declare const appEventFlowDismissedSchema: z.ZodObject<{
     traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     identities: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<{
-            anonymousId: "anonymousId";
-            userId: "userId";
-            "traits.email": "traits.email";
-            "traits.phone": "traits.phone";
-            "context.device.id": "context.device.id";
-            "context.device.advertisingId": "context.device.advertisingId";
-            "context.device.token": "context.device.token";
-        }>;
+        type: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
         value: z.ZodString;
     }, z.core.$strip>>>;
     context: z.ZodOptional<z.ZodObject<{
@@ -118,15 +78,7 @@ export declare const appEventFlowDismissedSchema: z.ZodObject<{
 export declare const appEventTrackSchema: z.ZodObject<{
     traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     identities: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<{
-            anonymousId: "anonymousId";
-            userId: "userId";
-            "traits.email": "traits.email";
-            "traits.phone": "traits.phone";
-            "context.device.id": "context.device.id";
-            "context.device.advertisingId": "context.device.advertisingId";
-            "context.device.token": "context.device.token";
-        }>;
+        type: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
         value: z.ZodString;
     }, z.core.$strip>>>;
     context: z.ZodOptional<z.ZodObject<{
@@ -151,15 +103,7 @@ export declare const appEventTrackSchema: z.ZodObject<{
 export declare const appEventPayloadSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     identities: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<{
-            anonymousId: "anonymousId";
-            userId: "userId";
-            "traits.email": "traits.email";
-            "traits.phone": "traits.phone";
-            "context.device.id": "context.device.id";
-            "context.device.advertisingId": "context.device.advertisingId";
-            "context.device.token": "context.device.token";
-        }>;
+        type: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
         value: z.ZodString;
     }, z.core.$strip>>>;
     context: z.ZodOptional<z.ZodObject<{
@@ -180,15 +124,7 @@ export declare const appEventPayloadSchema: z.ZodDiscriminatedUnion<[z.ZodObject
 }, z.core.$strip>, z.ZodObject<{
     traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     identities: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<{
-            anonymousId: "anonymousId";
-            userId: "userId";
-            "traits.email": "traits.email";
-            "traits.phone": "traits.phone";
-            "context.device.id": "context.device.id";
-            "context.device.advertisingId": "context.device.advertisingId";
-            "context.device.token": "context.device.token";
-        }>;
+        type: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
         value: z.ZodString;
     }, z.core.$strip>>>;
     context: z.ZodOptional<z.ZodObject<{

package/dist/app-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app-event.d.ts","sourceRoot":"","sources":["../src/app-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,0BAA0B;;;;;;;;EAQrC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;iBAGjC,CAAC;AAQH,eAAO,MAAM,qBAAqB;;;;;;;;iBAIhC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;iBAM7B,CAAC;AAMH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGrC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGtC,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG9B,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAGhC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACtE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"app-event.d.ts","sourceRoot":"","sources":["../src/app-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAEhE,eAAO,MAAM,sBAAsB;;;iBAGjC,CAAC;AAQH,eAAO,MAAM,qBAAqB;;;;;;;;iBAIhC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;iBAM7B,CAAC;AAMH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;iBAGrC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;iBAGtC,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;iBAG9B,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAGhC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACtE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/dist/app-event.js

@@ -1,13 +1,6 @@
 import * as z from "zod";
-export const appEventIdentityTypeSchema = z.enum([
-    "anonymousId",
-    "userId",
-    "traits.email",
-    "traits.phone",
-    "context.device.id",
-    "context.device.advertisingId",
-    "context.device.token",
-]);
+import { appEventIdentityTypeSchema } from "./identity-type.js";
+export { appEventIdentityTypeSchema } from "./identity-type.js";
 export const appEventIdentitySchema = z.object({
     type: appEventIdentityTypeSchema,
     value: z.string().trim().min(1),

package/dist/identity-type.d.ts

@@ -0,0 +1,8 @@
+import * as z from "zod";
+export declare const IDENTITY_TYPE_VALUES: readonly ["anonymousId", "userId", "traits.email", "traits.phone", "context.device.id", "context.device.advertisingId", "context.device.token"];
+export type IdentityTypeValue = (typeof IDENTITY_TYPE_VALUES)[number];
+export declare const isIdentityTypeValue: (value: string) => value is IdentityTypeValue;
+export declare const getIdentityTypeSuggestion: (value: string) => IdentityTypeValue | null;
+export declare const buildIdentityTypeGuidanceMessage: (value: string) => string;
+export declare const appEventIdentityTypeSchema: z.ZodPipe<z.ZodString, z.ZodTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
+//# sourceMappingURL=identity-type.d.ts.map

package/dist/identity-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity-type.d.ts","sourceRoot":"","sources":["../src/identity-type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,oBAAoB,iJAQvB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAsBtE,eAAO,MAAM,mBAAmB,GAC/B,OAAO,MAAM,KACX,KAAK,IAAI,iBACkD,CAAC;AAK/D,eAAO,MAAM,yBAAyB,GACrC,OAAO,MAAM,KACX,iBAAiB,GAAG,IACuD,CAAC;AAE/E,eAAO,MAAM,gCAAgC,GAAI,OAAO,MAAM,KAAG,MAehE,CAAC;AAEF,eAAO,MAAM,0BAA0B,4LAqBpC,CAAC"}

package/dist/identity-type.js

@@ -0,0 +1,59 @@
+import * as z from "zod";
+export const IDENTITY_TYPE_VALUES = [
+    "anonymousId",
+    "userId",
+    "traits.email",
+    "traits.phone",
+    "context.device.id",
+    "context.device.advertisingId",
+    "context.device.token",
+];
+const IDENTITY_TYPE_ALIAS_SUGGESTIONS = {
+    advertising_id: "context.device.advertisingId",
+    anonymous_id: "anonymousId",
+    device_id: "context.device.id",
+    device_token: "context.device.token",
+    email: "traits.email",
+    phone: "traits.phone",
+    phone_number: "traits.phone",
+    user_id: "userId",
+};
+const COMMON_IDENTITY_TYPE_MAPPINGS = [
+    ["email", "traits.email"],
+    ["phone", "traits.phone"],
+    ["user_id", "userId"],
+];
+const normalizeIdentityTypeAliasKey = (value) => value.trim().toLowerCase().replace(/-/g, "_");
+export const isIdentityTypeValue = (value) => IDENTITY_TYPE_VALUES.some((candidate) => candidate === value);
+const parseIdentityTypeValue = (value) => isIdentityTypeValue(value) ? value : null;
+export const getIdentityTypeSuggestion = (value) => IDENTITY_TYPE_ALIAS_SUGGESTIONS[normalizeIdentityTypeAliasKey(value)] ?? null;
+export const buildIdentityTypeGuidanceMessage = (value) => {
+    const normalizedValue = value.trim();
+    const displayValue = normalizedValue.length > 0 ? `"${normalizedValue}"` : "that value";
+    const suggestion = getIdentityTypeSuggestion(value);
+    if (suggestion) {
+        return `Unsupported identity type ${displayValue}. Use "${suggestion}" instead.`;
+    }
+    const mappingExamples = COMMON_IDENTITY_TYPE_MAPPINGS.map(([from, to]) => `${from} -> ${to}`).join(", ");
+    return `Unsupported identity type ${displayValue}. Use one of: ${IDENTITY_TYPE_VALUES.join(", ")}. Common mappings: ${mappingExamples}.`;
+};
+export const appEventIdentityTypeSchema = z
+    .string()
+    .trim()
+    .min(1, "Identity type is required.")
+    .superRefine((value, ctx) => {
+    if (!isIdentityTypeValue(value)) {
+        ctx.addIssue({
+            code: "custom",
+            fatal: true,
+            message: buildIdentityTypeGuidanceMessage(value),
+        });
+    }
+})
+    .transform((value) => {
+    const parsed = parseIdentityTypeValue(value);
+    if (parsed === null) {
+        throw new Error(`Identity type should have been validated before transform: ${value}`);
+    }
+    return parsed;
+});

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { type AppEventPayload, type AppEventTrackInput, appEventBaseSchema, appEventContextSchema, appEventFlowDismissedSchema, appEventIdentitySchema, appEventIdentityTypeSchema, appEventPayloadSchema, appEventSurveyViewedSchema, appEventTrackSchema, } from "./app-event.js";
 export { type ClientMeta, clientMetaSchema, } from "./client-meta.js";
 export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
+export { buildIdentityTypeGuidanceMessage, getIdentityTypeSuggestion, IDENTITY_TYPE_VALUES, type IdentityTypeValue, isIdentityTypeValue, } from "./identity-type.js";
 export { getScopeMeta, isScope, listScopes, SCOPE_IDS, type Scope, scopeIdSchema, } from "./scopes.js";
 export { type FlowVersionResolution, flowVersionResolutionSchema, type ThemeVersionResolution, themeVersionResolutionSchema, } from "./version-resolution.js";
 export { type PublicCommandPayload, parseConfigureOptions, parseInitOptions, parsePublicCommand, publicCommandPayloadSchema, } from "./widget-commands.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,mBAAmB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,KAAK,UAAU,EACf,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EACN,YAAY,EACZ,OAAO,EACP,UAAU,EACV,SAAS,EACT,KAAK,KAAK,EACV,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,qBAAqB,EAC1B,2BAA2B,EAC3B,KAAK,sBAAsB,EAC3B,4BAA4B,GAC5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,oBAAoB,EACzB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,0BAA0B,GAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACN,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,KAAK,WAAW,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,mBAAmB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,KAAK,UAAU,EACf,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EACN,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,YAAY,EACZ,OAAO,EACP,UAAU,EACV,SAAS,EACT,KAAK,KAAK,EACV,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,qBAAqB,EAC1B,2BAA2B,EAC3B,KAAK,sBAAsB,EAC3B,4BAA4B,GAC5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,oBAAoB,EACzB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,0BAA0B,GAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACN,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,KAAK,WAAW,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -1,6 +1,7 @@
 export { appEventBaseSchema, appEventContextSchema, appEventFlowDismissedSchema, appEventIdentitySchema, appEventIdentityTypeSchema, appEventPayloadSchema, appEventSurveyViewedSchema, appEventTrackSchema, } from "./app-event.js";
 export { clientMetaSchema, } from "./client-meta.js";
 export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
+export { buildIdentityTypeGuidanceMessage, getIdentityTypeSuggestion, IDENTITY_TYPE_VALUES, isIdentityTypeValue, } from "./identity-type.js";
 export { getScopeMeta, isScope, listScopes, SCOPE_IDS, scopeIdSchema, } from "./scopes.js";
 export { flowVersionResolutionSchema, themeVersionResolutionSchema, } from "./version-resolution.js";
 export { parseConfigureOptions, parseInitOptions, parsePublicCommand, publicCommandPayloadSchema, } from "./widget-commands.js";

package/package.json

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