@getuserfeedback/protocol 0.5.12 → 0.6.1

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;AAGzB,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAEhE,eAAO,MAAM,sBAAsB;;;iBAGjC,CAAC;AAEH,KAAK,iBAAiB,GACnB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,iBAAiB,EAAE,GACnB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC;AAaxC,eAAO,MAAM,0BAA0B;;;;iBAIrC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;iBAY7B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;iBAInC,CAAC;AAQH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMhC,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;AACrE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC/D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAC"}
+{"version":3,"file":"app-event.d.ts","sourceRoot":"","sources":["../src/app-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAG9B,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAEhE,eAAO,MAAM,sBAAsB;;;iBAGjC,CAAC;AAEH,KAAK,iBAAiB,GACnB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,iBAAiB,EAAE,GACnB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC;AAaxC,eAAO,MAAM,0BAA0B;;;;iBAIrC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;iBAY7B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;iBAInC,CAAC;AAQH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMhC,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;AACrE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC/D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAC"}

package/dist/app-event.js

@@ -1,9 +1,9 @@
-import * as z from "zod";
+import * as z from "zod/mini";
 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),
+    value: z.string().check(z.trim(), z.minLength(1)),
 });
 const appEventFlagValueSchema = z.lazy(() => z.union([
     z.string(),
@@ -14,24 +14,24 @@ const appEventFlagValueSchema = z.lazy(() => z.union([
     z.record(z.string(), appEventFlagValueSchema),
 ]));
 export const appEventFlagProviderSchema = z.object({
-    name: z.string().trim().min(1),
-    project: z.optional(z.string().trim().min(1)),
-    environment: z.optional(z.string().trim().min(1)),
+    name: z.string().check(z.trim(), z.minLength(1)),
+    project: z.optional(z.string().check(z.trim(), z.minLength(1))),
+    environment: z.optional(z.string().check(z.trim(), z.minLength(1))),
 });
 export const appEventFlagSchema = z.object({
-    key: z.string().trim().min(1),
-    target: z.optional(z.string().trim().min(1)),
+    key: z.string().check(z.trim(), z.minLength(1)),
+    target: z.optional(z.string().check(z.trim(), z.minLength(1))),
     value: appEventFlagValueSchema,
-    variant: z.optional(z.string().trim().min(1)),
+    variant: z.optional(z.string().check(z.trim(), z.minLength(1))),
     origin: z.optional(z.enum(["runtime_config", "trigger_context", "provider_sync", "api"])),
     provider: z.optional(appEventFlagProviderSchema),
-    status: z.optional(z.string().trim().min(1)),
-    reason: z.optional(z.string().trim().min(1)),
-    evaluatedAt: z.optional(z.string().trim().min(1)),
+    status: z.optional(z.string().check(z.trim(), z.minLength(1))),
+    reason: z.optional(z.string().check(z.trim(), z.minLength(1))),
+    evaluatedAt: z.optional(z.string().check(z.trim(), z.minLength(1))),
 });
 export const appEventCapabilitySchema = z.object({
-    key: z.string().trim().min(1),
-    source: z.optional(z.string().trim().min(1)),
+    key: z.string().check(z.trim(), z.minLength(1)),
+    source: z.optional(z.string().check(z.trim(), z.minLength(1))),
     provider: z.optional(appEventFlagProviderSchema),
 });
 const appEventPageSchema = z.object({
@@ -56,15 +56,15 @@ export const appEventBaseSchema = z.object({
 const appEventSurveyReferenceSchema = z.object({
     surveyId: z.string(),
 });
-export const appEventSurveyViewedSchema = appEventBaseSchema.extend({
+export const appEventSurveyViewedSchema = z.extend(appEventBaseSchema, {
     event: z.literal("Flow Viewed"),
     references: appEventSurveyReferenceSchema,
 });
-export const appEventFlowDismissedSchema = appEventBaseSchema.extend({
+export const appEventFlowDismissedSchema = z.extend(appEventBaseSchema, {
     event: z.literal("Flow Dismissed"),
     references: appEventSurveyReferenceSchema,
 });
-export const appEventTrackSchema = appEventBaseSchema.extend({
+export const appEventTrackSchema = z.extend(appEventBaseSchema, {
     event: z.enum(["Flow Viewed", "Flow Dismissed"]),
     references: appEventSurveyReferenceSchema,
 });

package/dist/client-meta.d.ts

@@ -1,6 +1,6 @@
-import * as z from "zod";
-export declare const clientMetaSchema: z.ZodObject<{
-    loader: z.ZodEnum<{
+import * as z from "zod/mini";
+export declare const clientMetaSchema: z.ZodMiniObject<{
+    loader: z.ZodMiniEnum<{
         custom: "custom";
         sdk: "sdk";
         gtm: "gtm";
@@ -8,32 +8,32 @@ export declare const clientMetaSchema: z.ZodObject<{
         rudderstack: "rudderstack";
         tealium: "tealium";
     }>;
-    clientName: z.ZodOptional<z.ZodString>;
-    clientVersion: z.ZodOptional<z.ZodString>;
-    integrator: z.ZodOptional<z.ZodObject<{
-        name: z.ZodOptional<z.ZodString>;
-        version: z.ZodOptional<z.ZodString>;
+    clientName: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    clientVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    integrator: z.ZodMiniOptional<z.ZodMiniObject<{
+        name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        version: z.ZodMiniOptional<z.ZodMiniString<string>>;
     }, z.core.$strip>>;
-    transport: z.ZodOptional<z.ZodEnum<{
+    transport: z.ZodMiniOptional<z.ZodMiniEnum<{
         loader: "loader";
         "script-tag": "script-tag";
         esm: "esm";
         "tag-manager": "tag-manager";
         snippet: "snippet";
     }>>;
-    runtime: z.ZodOptional<z.ZodObject<{
-        framework: z.ZodOptional<z.ZodEnum<{
+    runtime: z.ZodMiniOptional<z.ZodMiniObject<{
+        framework: z.ZodMiniOptional<z.ZodMiniEnum<{
             next: "next";
             vite: "vite";
             webpack: "webpack";
             plain: "plain";
         }>>;
-        runtime: z.ZodOptional<z.ZodEnum<{
+        runtime: z.ZodMiniOptional<z.ZodMiniEnum<{
             browser: "browser";
             edge: "edge";
         }>>;
     }, z.core.$strip>>;
-    notes: z.ZodOptional<z.ZodString>;
+    notes: z.ZodMiniOptional<z.ZodMiniString<string>>;
 }, z.core.$strip>;
 export type ClientMeta = z.output<typeof clientMetaSchema>;
 //# sourceMappingURL=client-meta.d.ts.map

package/dist/client-meta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-meta.d.ts","sourceRoot":"","sources":["../src/client-meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoB3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAC"}
+{"version":3,"file":"client-meta.d.ts","sourceRoot":"","sources":["../src/client-meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAE9B,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoB3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/client-meta.js

@@ -1,16 +1,16 @@
-import * as z from "zod";
+import * as z from "zod/mini";
 export const clientMetaSchema = z.object({
     loader: z.enum(["sdk", "gtm", "segment", "rudderstack", "tealium", "custom"]),
-    clientName: z.optional(z.string().trim().min(1)),
-    clientVersion: z.optional(z.string().trim().min(1)),
+    clientName: z.optional(z.string().check(z.trim(), z.minLength(1))),
+    clientVersion: z.optional(z.string().check(z.trim(), z.minLength(1))),
     integrator: z.optional(z.object({
-        name: z.optional(z.string().trim().min(1)),
-        version: z.optional(z.string().trim().min(1)),
+        name: z.optional(z.string().check(z.trim(), z.minLength(1))),
+        version: z.optional(z.string().check(z.trim(), z.minLength(1))),
     })),
     transport: z.optional(z.enum(["script-tag", "esm", "loader", "tag-manager", "snippet"])),
     runtime: z.optional(z.object({
         framework: z.optional(z.enum(["next", "vite", "webpack", "plain"])),
         runtime: z.optional(z.enum(["browser", "edge"])),
     })),
-    notes: z.optional(z.string().trim().min(1)),
+    notes: z.optional(z.string().check(z.trim(), z.minLength(1))),
 });

package/dist/errors.d.ts

@@ -0,0 +1,73 @@
+import * as z from "zod/mini";
+export declare const ErrorCategory: {
+    readonly INTERNAL: "INTERNAL";
+    readonly INVALID_USAGE: "INVALID_USAGE";
+    readonly HOST: "HOST";
+};
+export type ErrorCategory = (typeof ErrorCategory)[keyof typeof ErrorCategory];
+export declare const ErrorCategorySchema: z.ZodMiniEnum<{
+    INTERNAL: "INTERNAL";
+    INVALID_USAGE: "INVALID_USAGE";
+    HOST: "HOST";
+}>;
+export declare const ErrorEventSchema: z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    message: z.ZodMiniString<string>;
+    stack: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    category: z.ZodMiniEnum<{
+        INTERNAL: "INTERNAL";
+        INVALID_USAGE: "INVALID_USAGE";
+        HOST: "HOST";
+    }>;
+    timestamp: z.ZodMiniNumber<number>;
+    probability: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    context: z.ZodMiniObject<{
+        widgetVersion: z.ZodMiniString<string>;
+        clientMeta: z.ZodMiniOptional<z.ZodMiniObject<{
+            loader: z.ZodMiniEnum<{
+                custom: "custom";
+                sdk: "sdk";
+                gtm: "gtm";
+                segment: "segment";
+                rudderstack: "rudderstack";
+                tealium: "tealium";
+            }>;
+            clientName: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            clientVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            integrator: z.ZodMiniOptional<z.ZodMiniObject<{
+                name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+                version: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            }, z.core.$strip>>;
+            transport: z.ZodMiniOptional<z.ZodMiniEnum<{
+                loader: "loader";
+                "script-tag": "script-tag";
+                esm: "esm";
+                "tag-manager": "tag-manager";
+                snippet: "snippet";
+            }>>;
+            runtime: z.ZodMiniOptional<z.ZodMiniObject<{
+                framework: z.ZodMiniOptional<z.ZodMiniEnum<{
+                    next: "next";
+                    vite: "vite";
+                    webpack: "webpack";
+                    plain: "plain";
+                }>>;
+                runtime: z.ZodMiniOptional<z.ZodMiniEnum<{
+                    browser: "browser";
+                    edge: "edge";
+                }>>;
+            }, z.core.$strip>>;
+            notes: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        }, z.core.$strip>>;
+        debug: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type ErrorEvent = z.output<typeof ErrorEventSchema>;
+export type ProtocolErrorCode = "PARSE" | "VERSION" | "UNKNOWN_TYPE";
+export declare class ProtocolError extends Error {
+    code: ProtocolErrorCode;
+    details: string;
+    constructor(code: ProtocolErrorCode, details: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAQ9B,eAAO,MAAM,aAAa;;;;CAIhB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E,eAAO,MAAM,mBAAmB;;;;EAI9B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAc3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE3D,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,CAAC;AAIrE,qBAAa,aAAc,SAAQ,KAAK;IACvC,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;gBAEJ,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM;CASpD"}

package/dist/errors.js

@@ -0,0 +1,43 @@
+import * as z from "zod/mini";
+import { clientMetaSchema } from "./client-meta.js";
+// ---------------------------------------------------------------------------
+// Error-telemetry definitions shared across widget / host.
+// ---------------------------------------------------------------------------
+export const ErrorCategory = {
+    INTERNAL: "INTERNAL",
+    INVALID_USAGE: "INVALID_USAGE",
+    HOST: "HOST",
+};
+export const ErrorCategorySchema = z.enum([
+    ErrorCategory.INTERNAL,
+    ErrorCategory.INVALID_USAGE,
+    ErrorCategory.HOST,
+]);
+export const ErrorEventSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    message: z.string(),
+    stack: z.optional(z.string()),
+    category: ErrorCategorySchema,
+    timestamp: z.number(),
+    probability: z.optional(z.number()),
+    context: z.object({
+        widgetVersion: z.string(),
+        clientMeta: z.optional(clientMetaSchema),
+        /** When true, telemetry was captured with debug mode on (affects how to interpret context). */
+        debug: z.optional(z.boolean()),
+    }),
+});
+const MAX_DETAIL_LENGTH = 80;
+export class ProtocolError extends Error {
+    code;
+    details;
+    constructor(code, details) {
+        const short = details.length > MAX_DETAIL_LENGTH
+            ? details.slice(0, MAX_DETAIL_LENGTH)
+            : details;
+        super(short);
+        this.code = code;
+        this.details = short;
+    }
+}