@getuserfeedback/protocol 0.2.1 → 0.3.0

package/dist/host/command-dispatch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"command-dispatch.d.ts","sourceRoot":"","sources":["../../src/host/command-dispatch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,SAAS,MAAM,CAAC,GAC5D,CAAC,SAAS,oBAAoB,GAC7B,CAAC,GACD,KAAK,GACN,KAAK,CAAC;AAET,KAAK,eAAe,GAAG;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,GACjC,MAAM,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,KACvC,CAAC,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAgBpE,CAAC"}
+{"version":3,"file":"command-dispatch.d.ts","sourceRoot":"","sources":["../../src/host/command-dispatch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,SAAS,MAAM,CAAC,GAC5D,CAAC,SAAS,oBAAoB,GAC7B,CAAC,GACD,KAAK,GACN,KAAK,CAAC;AAET,KAAK,eAAe,GAAG;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,GACjC,MAAM,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,KACvC,CAAC,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAapE,CAAC"}

package/dist/host/command-dispatch.js

@@ -1,5 +1,5 @@
+import { createCommandEnvelope } from "./command-envelope.js";
 import { waitForCommandSettlement } from "./command-settlement.js";
-import { createCommandRequestId } from "./request-id.js";
 /**
  * Creates a dispatch function that wraps a command payload in an envelope,
  * pushes it into the queue, and returns a promise that settles when the
@@ -15,16 +15,12 @@ import { createCommandRequestId } from "./request-id.js";
  */
 export const createCommandDispatch = (push) => {
     return async (input, options) => {
-        const requestId = createCommandRequestId();
-        const idempotencyKey = resolveIdempotencyKey(options?.idempotencyKey);
-        const envelope = {
-            version: "1",
-            requestId,
-            idempotencyKey: idempotencyKey ?? requestId,
+        const envelope = createCommandEnvelope({
             command: input,
-        };
+            idempotencyKey: resolveIdempotencyKey(options?.idempotencyKey) ?? undefined,
+        });
         push(envelope);
-        await waitForCommandSettlement({ requestId });
+        await waitForCommandSettlement({ requestId: envelope.requestId });
     };
 };
 const resolveIdempotencyKey = (value) => {

package/dist/host/command-envelope.d.ts

@@ -0,0 +1,10 @@
+import type { ClientMeta, CommandEnvelope, PublicCommandPayload } from "./sdk-types.js";
+export type CreateCommandEnvelopeInput = {
+    command: PublicCommandPayload;
+    requestId?: string | undefined;
+    idempotencyKey?: string | undefined;
+    instanceId?: string | undefined;
+    clientMeta?: ClientMeta | undefined;
+};
+export declare const createCommandEnvelope: (input: CreateCommandEnvelopeInput) => CommandEnvelope;
+//# sourceMappingURL=command-envelope.d.ts.map

package/dist/host/command-envelope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-envelope.d.ts","sourceRoot":"","sources":["../../src/host/command-envelope.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,0BAA0B,GAAG;IACxC,OAAO,EAAE,oBAAoB,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CACpC,CAAC;AAUF,eAAO,MAAM,qBAAqB,GACjC,OAAO,0BAA0B,KAC/B,eAeF,CAAC"}

package/dist/host/command-envelope.js

@@ -0,0 +1,21 @@
+import { createCommandRequestId } from "./request-id.js";
+const normalizeOptionalString = (value) => {
+    if (value === undefined) {
+        return undefined;
+    }
+    const normalized = value.trim();
+    return normalized.length > 0 ? normalized : undefined;
+};
+export const createCommandEnvelope = (input) => {
+    const requestId = normalizeOptionalString(input.requestId) ?? createCommandRequestId();
+    const idempotencyKey = normalizeOptionalString(input.idempotencyKey) ?? requestId;
+    const instanceId = normalizeOptionalString(input.instanceId);
+    return {
+        version: "1",
+        command: input.command,
+        requestId,
+        idempotencyKey,
+        ...(instanceId !== undefined ? { instanceId } : {}),
+        ...(input.clientMeta !== undefined ? { clientMeta: input.clientMeta } : {}),
+    };
+};

package/dist/host/index.d.ts

@@ -2,6 +2,7 @@
  * Host-page / npm SDK protocol surface (Zod-free).
  */
 export * from "./command-dispatch.js";
+export * from "./command-envelope.js";
 export * from "./command-settlement.js";
 export * from "./constants.js";
 export * from "./host-event-contract.js";

package/dist/host/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/host/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACzD,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/host/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACzD,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/host/index.js

@@ -2,6 +2,7 @@
  * Host-page / npm SDK protocol surface (Zod-free).
  */
 export * from "./command-dispatch.js";
+export * from "./command-envelope.js";
 export * from "./command-settlement.js";
 export * from "./constants.js";
 export * from "./host-event-contract.js";

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
 export { getScopeMeta, 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";
 export { type ConfigureOptions, colorSchemeConfigInputSchema, configureOptionsSchema, consentConfigInputSchema, type InitOptions, initOptionsSchema, } from "./widget-config.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EACN,YAAY,EACZ,UAAU,EACV,SAAS,EACT,KAAK,KAAK,EACV,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,oBAAoB,EACzB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,0BAA0B,GAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACN,KAAK,gBAAgB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,KAAK,WAAW,EAChB,iBAAiB,GACjB,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EACN,YAAY,EACZ,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,gBAAgB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,KAAK,WAAW,EAChB,iBAAiB,GACjB,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -1,4 +1,5 @@
 export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
 export { getScopeMeta, listScopes, SCOPE_IDS, scopeIdSchema, } from "./scopes.js";
+export { flowVersionResolutionSchema, themeVersionResolutionSchema, } from "./version-resolution.js";
 export { parseConfigureOptions, parseInitOptions, parsePublicCommand, publicCommandPayloadSchema, } from "./widget-commands.js";
 export { colorSchemeConfigInputSchema, configureOptionsSchema, consentConfigInputSchema, initOptionsSchema, } from "./widget-config.js";

package/dist/version-resolution.d.ts

@@ -0,0 +1,10 @@
+import * as z from "zod";
+export declare const flowVersionResolutionSchema: z.ZodObject<{
+    flowVersionId: z.ZodString;
+}, z.core.$strip>;
+export declare const themeVersionResolutionSchema: z.ZodObject<{
+    themeVersionId: z.ZodString;
+}, z.core.$strip>;
+export type FlowVersionResolution = z.output<typeof flowVersionResolutionSchema>;
+export type ThemeVersionResolution = z.output<typeof themeVersionResolutionSchema>;
+//# sourceMappingURL=version-resolution.d.ts.map

package/dist/version-resolution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version-resolution.d.ts","sourceRoot":"","sources":["../src/version-resolution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,eAAO,MAAM,2BAA2B;;iBAEtC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAC3C,OAAO,2BAA2B,CAClC,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAC5C,OAAO,4BAA4B,CACnC,CAAC"}

package/dist/version-resolution.js

@@ -0,0 +1,8 @@
+import * as z from "zod";
+const versionIdSchema = z.string().trim().min(1);
+export const flowVersionResolutionSchema = z.object({
+    flowVersionId: versionIdSchema,
+});
+export const themeVersionResolutionSchema = z.object({
+    themeVersionId: versionIdSchema,
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@getuserfeedback/protocol",
-	"version": "0.2.1",
+	"version": "0.3.0",
 	"description": "getuserfeedback widget protocol — host surface and (later) wire protocol",
 	"keywords": [
 		"getuserfeedback",
@@ -60,6 +60,10 @@
 		"./host/lazy-handle-client": {
 			"types": "./dist/host/lazy-handle-client.d.ts",
 			"import": "./dist/host/lazy-handle-client.js"
+		},
+		"./version-resolution": {
+			"types": "./dist/version-resolution.d.ts",
+			"import": "./dist/version-resolution.js"
 		}
 	},
 	"scripts": {