@getuserfeedback/protocol 0.7.2 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/app-event.d.ts +147 -20
- package/dist/app-event.d.ts.map +1 -1
- package/dist/app-event.js +10 -0
- package/dist/flow-assignments.d.ts +7 -4
- package/dist/flow-assignments.d.ts.map +1 -1
- package/dist/flow-assignments.js +15 -5
- package/dist/host/external-id-argument-guards.d.ts +10 -0
- package/dist/host/external-id-argument-guards.d.ts.map +1 -0
- package/dist/host/external-id-argument-guards.js +27 -0
- package/dist/host/index.d.ts +1 -0
- package/dist/host/index.d.ts.map +1 -1
- package/dist/host/index.js +1 -0
- package/dist/host/sdk-types.d.ts +48 -6
- package/dist/host/sdk-types.d.ts.map +1 -1
- package/dist/identity-type.d.ts +2 -3
- package/dist/identity-type.d.ts.map +1 -1
- package/dist/identity-type.js +2 -4
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/version-resolution.d.ts +1 -0
- package/dist/version-resolution.d.ts.map +1 -1
- package/dist/version-resolution.js +1 -0
- package/dist/widget-commands.d.ts +23 -1
- package/dist/widget-commands.d.ts.map +1 -1
- package/dist/widget-commands.js +6 -1
- package/dist/widget-config.d.ts +18 -0
- package/dist/widget-config.d.ts.map +1 -1
- package/dist/widget-config.js +2 -1
- package/package.json +1 -1
- package/src/app-event.ts +24 -0
- package/src/flow-assignments.test.ts +19 -0
- package/src/flow-assignments.ts +31 -5
- package/src/host/external-id-argument-guards.ts +57 -0
- package/src/host/index.ts +1 -0
- package/src/host/sdk-types.ts +51 -7
- package/src/identity-type.ts +3 -9
- package/src/index.ts +4 -1
- package/src/protocol-root.test.ts +121 -3
- package/src/version-resolution.ts +1 -0
- package/src/widget-commands.ts +11 -1
- package/src/widget-config.ts +8 -1
package/dist/host/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ export * from "./command-dispatch.js";
|
|
|
5
5
|
export * from "./command-envelope.js";
|
|
6
6
|
export * from "./command-settlement.js";
|
|
7
7
|
export * from "./constants.js";
|
|
8
|
+
export * from "./external-id-argument-guards.js";
|
|
8
9
|
export * from "./host-event-contract.js";
|
|
9
10
|
export * from "./lazy-handle-client.js";
|
|
10
11
|
export { createCommandRequestId } from "./request-id.js";
|
package/dist/host/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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"}
|
|
1
|
+
{"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,kCAAkC,CAAC;AACjD,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
CHANGED
|
@@ -5,6 +5,7 @@ export * from "./command-dispatch.js";
|
|
|
5
5
|
export * from "./command-envelope.js";
|
|
6
6
|
export * from "./command-settlement.js";
|
|
7
7
|
export * from "./constants.js";
|
|
8
|
+
export * from "./external-id-argument-guards.js";
|
|
8
9
|
export * from "./host-event-contract.js";
|
|
9
10
|
export * from "./lazy-handle-client.js";
|
|
10
11
|
export { createCommandRequestId } from "./request-id.js";
|
package/dist/host/sdk-types.d.ts
CHANGED
|
@@ -7,17 +7,31 @@ import type { Scope } from "../scopes.js";
|
|
|
7
7
|
/**
|
|
8
8
|
* Identifier types supported by event tracking and identity resolution.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
* `
|
|
10
|
+
* Business-specific identifiers are sent as Segment-compatible
|
|
11
|
+
* `context.externalIds` entries on app events or identify options.
|
|
12
12
|
*
|
|
13
13
|
* @see https://getuserfeedback.com/docs/guides/identity-resolution
|
|
14
14
|
*/
|
|
15
|
-
export type AppEventIdentityType = "anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token"
|
|
16
|
-
/** A single identifier, such as a user ID, anonymous ID, email, or
|
|
15
|
+
export type AppEventIdentityType = "anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token";
|
|
16
|
+
/** A single standard identifier, such as a user ID, anonymous ID, email, or device ID. */
|
|
17
17
|
export type AppEventIdentity = {
|
|
18
18
|
type: AppEventIdentityType;
|
|
19
19
|
value: string;
|
|
20
20
|
};
|
|
21
|
+
/**
|
|
22
|
+
* Segment-compatible external identifier.
|
|
23
|
+
*
|
|
24
|
+
* Only `collection: "users"` participates in person identity resolution today.
|
|
25
|
+
* External IDs help match profiles, but they are not traits by themselves.
|
|
26
|
+
*
|
|
27
|
+
* @see https://getuserfeedback.com/docs/guides/identity-resolution
|
|
28
|
+
*/
|
|
29
|
+
export type AppEventExternalId = {
|
|
30
|
+
id: string;
|
|
31
|
+
type: string;
|
|
32
|
+
collection: "users";
|
|
33
|
+
encoding: "none";
|
|
34
|
+
};
|
|
21
35
|
/** Page, feature flag, and capability context attached to an event. */
|
|
22
36
|
export type AppEventContext = {
|
|
23
37
|
page?: {
|
|
@@ -27,6 +41,7 @@ export type AppEventContext = {
|
|
|
27
41
|
};
|
|
28
42
|
locale?: string;
|
|
29
43
|
userAgent?: string;
|
|
44
|
+
externalIds?: AppEventExternalId[] | undefined;
|
|
30
45
|
flags?: AppEventFlag[] | undefined;
|
|
31
46
|
capabilities?: AppEventCapability[] | undefined;
|
|
32
47
|
};
|
|
@@ -287,19 +302,46 @@ export type PrerenderCommandPayload = {
|
|
|
287
302
|
*/
|
|
288
303
|
hideCloseButton?: boolean | undefined;
|
|
289
304
|
};
|
|
290
|
-
/** Identify with traits only (`client.identify(traits)`). */
|
|
305
|
+
/** Identify with traits only (`client.identify(traits)` or `client.identify(traits, options)`). */
|
|
291
306
|
export type IdentifyTraitsOnlyCommandPayload = {
|
|
292
307
|
kind: "identify";
|
|
293
308
|
traits: Record<string, unknown>;
|
|
309
|
+
options?: IdentifyOptions | undefined;
|
|
294
310
|
};
|
|
295
|
-
/** Identify with userId and optional
|
|
311
|
+
/** Identify with userId, optional traits, and optional external IDs (`client.identify(userId, traits?, options?)`). */
|
|
296
312
|
export type IdentifyUserCommandPayload = {
|
|
297
313
|
kind: "identify";
|
|
298
314
|
userId: string;
|
|
299
315
|
traits?: Record<string, unknown> | undefined;
|
|
316
|
+
options?: IdentifyOptions | undefined;
|
|
300
317
|
};
|
|
301
318
|
/** Identify command payload: either traits-only or userId+traits shape. */
|
|
302
319
|
export type IdentifyCommandPayload = IdentifyTraitsOnlyCommandPayload | IdentifyUserCommandPayload;
|
|
320
|
+
/**
|
|
321
|
+
* Optional identity context accepted by `client.identify()`.
|
|
322
|
+
*
|
|
323
|
+
* Use `externalIds` for Segment-compatible identifiers from another system,
|
|
324
|
+
* such as Shopify customer IDs or Salesforce contact IDs. Without a user ID,
|
|
325
|
+
* pass options as `client.identify(traits, options)`, or use
|
|
326
|
+
* `client.identify(traits, undefined, options)` when your call site needs the
|
|
327
|
+
* explicit three-argument form.
|
|
328
|
+
*
|
|
329
|
+
* @see https://getuserfeedback.com/docs/guides/identity-resolution
|
|
330
|
+
*/
|
|
331
|
+
export type IdentifyOptions = {
|
|
332
|
+
externalIds?: AppEventExternalId[] | undefined;
|
|
333
|
+
};
|
|
334
|
+
/**
|
|
335
|
+
* Optional context accepted by `client.track()`.
|
|
336
|
+
*
|
|
337
|
+
* Use `externalIds` when the event carries a Segment-compatible identifier
|
|
338
|
+
* from another system.
|
|
339
|
+
*
|
|
340
|
+
* @see https://getuserfeedback.com/docs/reference/events
|
|
341
|
+
*/
|
|
342
|
+
export type TrackOptions = {
|
|
343
|
+
externalIds?: AppEventExternalId[] | undefined;
|
|
344
|
+
};
|
|
303
345
|
/**
|
|
304
346
|
* Command payload for `client.track()`.
|
|
305
347
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk-types.d.ts","sourceRoot":"","sources":["../../src/host/sdk-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAI1C;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAC7B,aAAa,GACb,QAAQ,GACR,cAAc,GACd,cAAc,GACd,mBAAmB,GACnB,8BAA8B,GAC9B,sBAAsB,
|
|
1
|
+
{"version":3,"file":"sdk-types.d.ts","sourceRoot":"","sources":["../../src/host/sdk-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAI1C;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAC7B,aAAa,GACb,QAAQ,GACR,cAAc,GACd,cAAc,GACd,mBAAmB,GACnB,8BAA8B,GAC9B,sBAAsB,CAAC;AAE1B,0FAA0F;AAC1F,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,oBAAoB,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,eAAe,GAAG;IAC7B,IAAI,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAC;IAC/C,KAAK,CAAC,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;IACnC,YAAY,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAC;CAChD,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GAC1B,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,iBAAiB,EAAE,GACnB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAElD,sCAAsC;AACtC,MAAM,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,mFAAmF;AACnF,MAAM,MAAM,YAAY,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,EAAE,iBAAiB,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,MAAM,CAAC,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,eAAe,GAAG,KAAK,CAAC;IACxE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC5C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,2EAA2E;AAC3E,MAAM,MAAM,kBAAkB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,+DAA+D;AAC/D,MAAM,MAAM,UAAU,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAE5E,wDAAwD;AACxD,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,MAAM,GAAG,kBAAkB,CAAC,CAAC;AAEnE,gDAAgD;AAChD,MAAM,MAAM,YAAY,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC7C,UAAU,CAAC,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAC;IAC5C,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,uBAAuB,GAAG;IACrC,QAAQ,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,kDAAkD;AAClD,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG;IAC9C,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC9B,KAAK,EAAE,aAAa,CAAC;IACrB,UAAU,EAAE,uBAAuB,CAAC;CACpC,CAAC;AAEF,0DAA0D;AAC1D,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG;IACjD,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC9B,KAAK,EAAE,gBAAgB,CAAC;IACxB,UAAU,EAAE,uBAAuB,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG;IACjD,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GACxB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,CAAC;AAIxB,gFAAgF;AAChF,MAAM,MAAM,gBAAgB,GACzB,KAAK,GACL,KAAK,GACL,SAAS,GACT,aAAa,GACb,SAAS,GACT,QAAQ,CAAC;AAEZ,6CAA6C;AAC7C,MAAM,MAAM,mBAAmB,GAC5B,YAAY,GACZ,KAAK,GACL,QAAQ,GACR,aAAa,GACb,SAAS,CAAC;AAEb,kDAAkD;AAClD,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;AAE/E,6CAA6C;AAC7C,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtD,+EAA+E;AAC/E,MAAM,MAAM,UAAU,GAAG;IACxB,MAAM,EAAE,gBAAgB,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,UAAU,CAAC,EACR;QACA,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC5B,GACD,SAAS,CAAC;IACb,SAAS,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAC5C,OAAO,CAAC,EACL;QACA,SAAS,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;QACnD,OAAO,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;KAC1C,GACD,SAAS,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,gFAAgF;AAChF,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAEzD,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,GAAG,SAAS,CAAC;CAC5D,CAAC;AAIF;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,EAAE,CAAC;CAChC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAC1B,qBAAqB,GACrB,OAAO,GACP,MAAM,GACN,QAAQ,CAAC;AAEZ,oCAAoC;AACpC,MAAM,MAAM,eAAe,GAAG;IAC7B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,yIAAyI;AACzI,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAEtD,wEAAwE;AACxE,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC;AAE/B,wHAAwH;AACxH,MAAM,MAAM,aAAa,GAAG,aAAa,GAAG,KAAK,EAAE,CAAC;AAEpD,iEAAiE;AACjE,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC9B,WAAW,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC5C,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACpC,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,+KAA+K;AAC/K,MAAM,MAAM,WAAW,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC5C,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACtC,cAAc,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC3C,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACpC,KAAK,CAAC,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;IACnC,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAC;IACpD,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,WAAW,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC5C;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC3C;OACG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACtC,0GAA0G;IAC1G,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,qEAAqE;IACrE,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC/B,8DAA8D;IAC9D,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC7C,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAIF,0GAA0G;AAC1G,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,SAAS,CAAC,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,CAAC;IAC3C,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;IAC7C;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,4FAA4F;AAC5F,MAAM,MAAM,sBAAsB,GAAG;IACpC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,8FAA8F;AAC9F,MAAM,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,mGAAmG;AACnG,MAAM,MAAM,gCAAgC,GAAG;IAC9C,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,uHAAuH;AACvH,MAAM,MAAM,0BAA0B,GAAG;IACxC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC7C,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,2EAA2E;AAC3E,MAAM,MAAM,sBAAsB,GAC/B,gCAAgC,GAChC,0BAA0B,CAAC;AAE9B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,WAAW,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,WAAW,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG;IAChD,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEF,qEAAqE;AACrE,MAAM,MAAM,0BAA0B,GAAG;IACxC,IAAI,EAAE,cAAc,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF,2DAA2D;AAC3D,MAAM,MAAM,eAAe,GACxB;IACA,IAAI,EAAE,UAAU,CAAC;CAChB,GACD;IACA,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,QAAQ,GAAG,YAAY,CAAC;CAChC,CAAC;AAEL,uDAAuD;AACvD,MAAM,MAAM,uCAAuC,GAAG;IACrD,IAAI,EAAE,2BAA2B,CAAC;IAClC,MAAM,EAAE,eAAe,CAAC;CACxB,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,gBAAgB,CAAC;CACvB,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,WAAW,CAAC;CAClB,CAAC;AAEF,oBAAoB;AACpB,MAAM,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,0BAA0B;AAC1B,MAAM,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;CACd,CAAC;AAEF,8FAA8F;AAC9F,MAAM,MAAM,oBAAoB,GAC7B,kBAAkB,GAClB,sBAAsB,GACtB,uBAAuB,GACvB,sBAAsB,GACtB,0BAA0B,GAC1B,uCAAuC,GACvC,uBAAuB,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,CAAC;AAEvB,oFAAoF;AACpF,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC;AAE3C,4HAA4H;AAC5H,MAAM,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACpC,OAAO,EAAE,oBAAoB,CAAC;CAC9B,CAAC;AAIF,gFAAgF;AAChF,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAEzD;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,+GAA+G;IAC/G,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,qBAAqB,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAClE,OAAO,EAAE;QACR,IAAI,EAAE;YACL,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;YACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;YACrC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;YACnC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;KACpC,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CACjD,CAAC"}
|
package/dist/identity-type.d.ts
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import * as z from "zod/mini";
|
|
2
2
|
export declare const IDENTITY_TYPE_VALUES: readonly ["anonymousId", "userId", "traits.email", "traits.phone", "context.device.id", "context.device.advertisingId", "context.device.token"];
|
|
3
3
|
export type StandardIdentityTypeValue = (typeof IDENTITY_TYPE_VALUES)[number];
|
|
4
|
-
export type
|
|
5
|
-
export type IdentityTypeValue = StandardIdentityTypeValue | CustomIdentityTypeValue;
|
|
4
|
+
export type IdentityTypeValue = StandardIdentityTypeValue;
|
|
6
5
|
export declare const isIdentityTypeValue: (value: string) => value is IdentityTypeValue;
|
|
7
6
|
export declare const getIdentityTypeSuggestion: (value: string) => IdentityTypeValue | null;
|
|
8
7
|
export declare const buildIdentityTypeGuidanceMessage: (value: string) => string;
|
|
9
|
-
export declare const appEventIdentityTypeSchema: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<
|
|
8
|
+
export declare const appEventIdentityTypeSchema: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
|
|
10
9
|
//# sourceMappingURL=identity-type.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"identity-type.d.ts","sourceRoot":"","sources":["../src/identity-type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAE9B,eAAO,MAAM,oBAAoB,iJAQvB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9E,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"identity-type.d.ts","sourceRoot":"","sources":["../src/identity-type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAE9B,eAAO,MAAM,oBAAoB,iJAQvB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9E,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;AAyB1D,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;AAkBF,eAAO,MAAM,0BAA0B,gNAWtC,CAAC"}
|
package/dist/identity-type.js
CHANGED
|
@@ -8,7 +8,6 @@ export const IDENTITY_TYPE_VALUES = [
|
|
|
8
8
|
"context.device.advertisingId",
|
|
9
9
|
"context.device.token",
|
|
10
10
|
];
|
|
11
|
-
const CUSTOM_IDENTITY_TYPE_PATTERN = /^custom\.[a-zA-Z0-9][a-zA-Z0-9_.-]*$/;
|
|
12
11
|
const IDENTITY_TYPE_ALIAS_SUGGESTIONS = {
|
|
13
12
|
advertising_id: "context.device.advertisingId",
|
|
14
13
|
anonymous_id: "anonymousId",
|
|
@@ -25,8 +24,7 @@ const COMMON_IDENTITY_TYPE_MAPPINGS = [
|
|
|
25
24
|
["user_id", "userId"],
|
|
26
25
|
];
|
|
27
26
|
const normalizeIdentityTypeAliasKey = (value) => value.trim().toLowerCase().replace(/-/g, "_");
|
|
28
|
-
export const isIdentityTypeValue = (value) => IDENTITY_TYPE_VALUES.some((candidate) => candidate === value)
|
|
29
|
-
CUSTOM_IDENTITY_TYPE_PATTERN.test(value);
|
|
27
|
+
export const isIdentityTypeValue = (value) => IDENTITY_TYPE_VALUES.some((candidate) => candidate === value);
|
|
30
28
|
const parseIdentityTypeValue = (value) => isIdentityTypeValue(value) ? value : null;
|
|
31
29
|
export const getIdentityTypeSuggestion = (value) => IDENTITY_TYPE_ALIAS_SUGGESTIONS[normalizeIdentityTypeAliasKey(value)] ?? null;
|
|
32
30
|
export const buildIdentityTypeGuidanceMessage = (value) => {
|
|
@@ -37,7 +35,7 @@ export const buildIdentityTypeGuidanceMessage = (value) => {
|
|
|
37
35
|
return `Unsupported identity type ${displayValue}. Use "${suggestion}" instead.`;
|
|
38
36
|
}
|
|
39
37
|
const mappingExamples = COMMON_IDENTITY_TYPE_MAPPINGS.map(([from, to]) => `${from} -> ${to}`).join(", ");
|
|
40
|
-
return `Unsupported identity type ${displayValue}. Use one of: ${IDENTITY_TYPE_VALUES.join(", ")}
|
|
38
|
+
return `Unsupported identity type ${displayValue}. Use one of: ${IDENTITY_TYPE_VALUES.join(", ")}. For external IDs, send Segment-compatible context.externalIds entries instead. Common mappings: ${mappingExamples}.`;
|
|
41
39
|
};
|
|
42
40
|
const identityTypeInputSchema = z.string().check(z.trim(), z.minLength(1, { error: "Identity type is required." }), z.check((ctx) => {
|
|
43
41
|
if (isIdentityTypeValue(ctx.value)) {
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
export { type AppEventCapability, type AppEventFlag, type AppEventJsonValue, type AppEventPayload, type AppEventTrackInput, appEventBaseSchema, appEventCapabilitySchema, appEventContextSchema, appEventCustomerTrackSchema, appEventFlagProviderSchema, appEventFlagSchema, appEventFlowDismissedSchema, appEventIdentitySchema, appEventIdentityTypeSchema, appEventPayloadSchema, appEventSurveyViewedSchema, appEventSystemBaseSchema, appEventSystemTrackSchema, appEventTrackSchema, reservedSystemAppEventNames, } from "./app-event.js";
|
|
1
|
+
export { type AppEventCapability, type AppEventExternalId, type AppEventFlag, type AppEventJsonValue, type AppEventPayload, type AppEventTrackInput, appEventBaseSchema, appEventCapabilitySchema, appEventContextSchema, appEventCustomerTrackSchema, appEventExternalIdSchema, appEventFlagProviderSchema, appEventFlagSchema, appEventFlowDismissedSchema, appEventIdentitySchema, appEventIdentityTypeSchema, appEventPayloadSchema, appEventSurveyViewedSchema, appEventSystemBaseSchema, appEventSystemTrackSchema, appEventTrackSchema, reservedSystemAppEventNames, } from "./app-event.js";
|
|
2
2
|
export { type ClientMeta, clientMetaSchema, } from "./client-meta.js";
|
|
3
3
|
export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
|
|
4
4
|
export type { ErrorEvent, ProtocolErrorCode } from "./errors.js";
|
|
5
5
|
export { ErrorCategory, ErrorCategorySchema, ErrorEventSchema, ProtocolError, } from "./errors.js";
|
|
6
|
-
export { type ClaimPendingFlowAssignmentsRequest, type ClaimPendingFlowAssignmentsResponse, claimPendingFlowAssignmentsRequestSchema, claimPendingFlowAssignmentsResponseSchema, type FlowAssignmentRecipientRequest, type FlowAssignmentRecord, type FlowAssignmentStatus, type FlowAssignmentTargetingContext, flowAssignmentRecipientRequestSchema, flowAssignmentRecordSchema, flowAssignmentStatusSchema, flowAssignmentTargetingContextSchema, type ListPendingFlowAssignmentsResponse, listPendingFlowAssignmentsResponseSchema, nullableUpdateFlowAssignmentLifecycleResponseSchema, type ReleaseFlowAssignmentClaimRequest, type ReleaseFlowAssignmentClaimResponse, releaseFlowAssignmentClaimRequestSchema, releaseFlowAssignmentClaimResponseSchema, type UpdateFlowAssignmentLifecycleRequest, type UpdateFlowAssignmentLifecycleResponse, updateFlowAssignmentLifecycleRequestSchema, updateFlowAssignmentLifecycleResponseSchema, } from "./flow-assignments.js";
|
|
7
|
-
export { buildIdentityTypeGuidanceMessage,
|
|
6
|
+
export { type ClaimPendingFlowAssignmentsRequest, type ClaimPendingFlowAssignmentsResponse, claimPendingFlowAssignmentsRequestSchema, claimPendingFlowAssignmentsResponseSchema, type FlowAssignmentExternalIdIdentityTypeValue, type FlowAssignmentIdentityTypeValue, type FlowAssignmentRecipientRequest, type FlowAssignmentRecord, type FlowAssignmentStatus, type FlowAssignmentTargetingContext, flowAssignmentRecipientRequestSchema, flowAssignmentRecordSchema, flowAssignmentStatusSchema, flowAssignmentTargetingContextSchema, type ListPendingFlowAssignmentsResponse, listPendingFlowAssignmentsResponseSchema, nullableUpdateFlowAssignmentLifecycleResponseSchema, type ReleaseFlowAssignmentClaimRequest, type ReleaseFlowAssignmentClaimResponse, releaseFlowAssignmentClaimRequestSchema, releaseFlowAssignmentClaimResponseSchema, type UpdateFlowAssignmentLifecycleRequest, type UpdateFlowAssignmentLifecycleResponse, updateFlowAssignmentLifecycleRequestSchema, updateFlowAssignmentLifecycleResponseSchema, } from "./flow-assignments.js";
|
|
7
|
+
export { buildIdentityTypeGuidanceMessage, getIdentityTypeSuggestion, IDENTITY_TYPE_VALUES, type IdentityTypeValue, isIdentityTypeValue, type StandardIdentityTypeValue, } from "./identity-type.js";
|
|
8
8
|
export { isPublicGrantScope, type PublicGrantScope, publicGrantScopeIdSchema, } from "./public-grant-scope.js";
|
|
9
9
|
export { type RuntimeEndpoints, resolveApiBaseUrl, resolveCoreUrl, resolveTrpcBaseUrl, runtimeEndpointsSchema, } from "./runtime-endpoints.js";
|
|
10
10
|
export { getScopeMeta, isScope, listScopes, SCOPE_IDS, type Scope, scopeIdSchema, } from "./scopes.js";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,2BAA2B,GAC3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,KAAK,UAAU,EACf,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,YAAY,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EACN,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,kCAAkC,EACvC,KAAK,mCAAmC,EACxC,wCAAwC,EACxC,yCAAyC,EACzC,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,EACnC,oCAAoC,EACpC,0BAA0B,EAC1B,0BAA0B,EAC1B,oCAAoC,EACpC,KAAK,kCAAkC,EACvC,wCAAwC,EACxC,mDAAmD,EACnD,KAAK,iCAAiC,EACtC,KAAK,kCAAkC,EACvC,uCAAuC,EACvC,wCAAwC,EACxC,KAAK,oCAAoC,EACzC,KAAK,qCAAqC,EAC1C,0CAA0C,EAC1C,2CAA2C,GAC3C,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,gCAAgC,EAChC,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,2BAA2B,EAC3B,wBAAwB,EACxB,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,2BAA2B,GAC3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,KAAK,UAAU,EACf,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,YAAY,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EACN,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,kCAAkC,EACvC,KAAK,mCAAmC,EACxC,wCAAwC,EACxC,yCAAyC,EACzC,KAAK,yCAAyC,EAC9C,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,EACnC,oCAAoC,EACpC,0BAA0B,EAC1B,0BAA0B,EAC1B,oCAAoC,EACpC,KAAK,kCAAkC,EACvC,wCAAwC,EACxC,mDAAmD,EACnD,KAAK,iCAAiC,EACtC,KAAK,kCAAkC,EACvC,uCAAuC,EACvC,wCAAwC,EACxC,KAAK,oCAAoC,EACzC,KAAK,qCAAqC,EAC1C,0CAA0C,EAC1C,2CAA2C,GAC3C,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,mBAAmB,EACnB,KAAK,yBAAyB,GAC9B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,gBAAgB,EACrB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,GACtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,YAAY,EACZ,OAAO,EACP,UAAU,EACV,SAAS,EACT,KAAK,KAAK,EACV,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,mBAAmB,EACxB,yBAAyB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,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,EAC1B,6BAA6B,GAC7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,KAAK,gBAAgB,EACrB,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,sBAAsB,EACtB,KAAK,2BAA2B,EAChC,iCAAiC,EACjC,KAAK,mBAAmB,EACxB,2BAA2B,EAC3B,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,yBAAyB,EACzB,iBAAiB,EACjB,8BAA8B,EAC9B,KAAK,oBAAoB,EACzB,0BAA0B,GAC1B,MAAM,oBAAoB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { appEventBaseSchema, appEventCapabilitySchema, appEventContextSchema, appEventCustomerTrackSchema, appEventFlagProviderSchema, appEventFlagSchema, appEventFlowDismissedSchema, appEventIdentitySchema, appEventIdentityTypeSchema, appEventPayloadSchema, appEventSurveyViewedSchema, appEventSystemBaseSchema, appEventSystemTrackSchema, appEventTrackSchema, reservedSystemAppEventNames, } from "./app-event.js";
|
|
1
|
+
export { appEventBaseSchema, appEventCapabilitySchema, appEventContextSchema, appEventCustomerTrackSchema, appEventExternalIdSchema, appEventFlagProviderSchema, appEventFlagSchema, appEventFlowDismissedSchema, appEventIdentitySchema, appEventIdentityTypeSchema, appEventPayloadSchema, appEventSurveyViewedSchema, appEventSystemBaseSchema, appEventSystemTrackSchema, appEventTrackSchema, reservedSystemAppEventNames, } from "./app-event.js";
|
|
2
2
|
export { clientMetaSchema, } from "./client-meta.js";
|
|
3
3
|
export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
|
|
4
4
|
export { ErrorCategory, ErrorCategorySchema, ErrorEventSchema, ProtocolError, } from "./errors.js";
|
|
@@ -3,6 +3,7 @@ export declare const flowVersionResolutionSchema: z.ZodMiniObject<{
|
|
|
3
3
|
flowVersionId: z.ZodMiniString<string>;
|
|
4
4
|
}, z.core.$strip>;
|
|
5
5
|
export declare const themeVersionResolutionSchema: z.ZodMiniObject<{
|
|
6
|
+
themeRuntimeArtifactId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6
7
|
themeVersionId: z.ZodMiniString<string>;
|
|
7
8
|
}, z.core.$strip>;
|
|
8
9
|
export type FlowVersionResolution = z.output<typeof flowVersionResolutionSchema>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version-resolution.d.ts","sourceRoot":"","sources":["../src/version-resolution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAI9B,eAAO,MAAM,2BAA2B;;iBAEtC,CAAC;AAEH,eAAO,MAAM,4BAA4B
|
|
1
|
+
{"version":3,"file":"version-resolution.d.ts","sourceRoot":"","sources":["../src/version-resolution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAI9B,eAAO,MAAM,2BAA2B;;iBAEtC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;iBAGvC,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"}
|
|
@@ -257,7 +257,7 @@ export declare const publicCommandPayloadSchema: z.ZodMiniUnion<readonly [z.ZodM
|
|
|
257
257
|
}, z.core.$strict>, z.ZodMiniObject<{
|
|
258
258
|
traits: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>>;
|
|
259
259
|
identities: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
260
|
-
type: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<
|
|
260
|
+
type: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<"anonymousId" | "userId" | "traits.email" | "traits.phone" | "context.device.id" | "context.device.advertisingId" | "context.device.token", string>>;
|
|
261
261
|
value: z.ZodMiniString<string>;
|
|
262
262
|
}, z.core.$strip>>>;
|
|
263
263
|
context: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
@@ -268,6 +268,12 @@ export declare const publicCommandPayloadSchema: z.ZodMiniUnion<readonly [z.ZodM
|
|
|
268
268
|
}, z.core.$strip>>;
|
|
269
269
|
locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
270
270
|
userAgent: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
271
|
+
externalIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
272
|
+
id: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string, string>>;
|
|
273
|
+
type: z.ZodMiniString<string>;
|
|
274
|
+
collection: z.ZodMiniLiteral<"users">;
|
|
275
|
+
encoding: z.ZodMiniLiteral<"none">;
|
|
276
|
+
}, z.core.$strip>>>;
|
|
271
277
|
flags: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
272
278
|
key: z.ZodMiniString<string>;
|
|
273
279
|
target: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
@@ -355,10 +361,26 @@ export declare const publicCommandPayloadSchema: z.ZodMiniUnion<readonly [z.ZodM
|
|
|
355
361
|
}, z.core.$strip>], "kind">, z.ZodMiniUnion<readonly [z.ZodMiniObject<{
|
|
356
362
|
kind: z.ZodMiniLiteral<"identify">;
|
|
357
363
|
traits: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
|
|
364
|
+
options: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
365
|
+
externalIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
366
|
+
id: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string, string>>;
|
|
367
|
+
type: z.ZodMiniString<string>;
|
|
368
|
+
collection: z.ZodMiniLiteral<"users">;
|
|
369
|
+
encoding: z.ZodMiniLiteral<"none">;
|
|
370
|
+
}, z.core.$strip>>>;
|
|
371
|
+
}, z.core.$strict>>;
|
|
358
372
|
}, z.core.$strict>, z.ZodMiniObject<{
|
|
359
373
|
kind: z.ZodMiniLiteral<"identify">;
|
|
360
374
|
userId: z.ZodMiniString<string>;
|
|
361
375
|
traits: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>>;
|
|
376
|
+
options: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
377
|
+
externalIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
378
|
+
id: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string, string>>;
|
|
379
|
+
type: z.ZodMiniString<string>;
|
|
380
|
+
collection: z.ZodMiniLiteral<"users">;
|
|
381
|
+
encoding: z.ZodMiniLiteral<"none">;
|
|
382
|
+
}, z.core.$strip>>>;
|
|
383
|
+
}, z.core.$strict>>;
|
|
362
384
|
}, z.core.$strict>]>]>;
|
|
363
385
|
export type PublicCommandPayload = z.output<typeof publicCommandPayloadSchema>;
|
|
364
386
|
export type ContainerPolicy = z.output<typeof containerPolicySchema>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"widget-commands.d.ts","sourceRoot":"","sources":["../src/widget-commands.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"widget-commands.d.ts","sourceRoot":"","sources":["../src/widget-commands.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAK9B,OAAO,EACN,KAAK,gBAAgB,EAErB,KAAK,WAAW,EAEhB,MAAM,oBAAoB,CAAC;AAoB5B,eAAO,MAAM,6BAA6B;;;;;;;;;;;;EAAmC,CAAC;AAgD9E,eAAO,MAAM,qBAAqB;;;;;;;;;4BAShC,CAAC;AAeH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBA2CrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE/E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAErE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAE5D;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAEtE;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,oBAAoB,CAEvE"}
|
package/dist/widget-commands.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as z from "zod/mini";
|
|
2
|
-
import { appEventCustomerTrackSchema } from "./app-event.js";
|
|
2
|
+
import { appEventCustomerTrackSchema, appEventExternalIdSchema, } from "./app-event.js";
|
|
3
3
|
import { configureOptionsSchema, initOptionsSchema, } from "./widget-config.js";
|
|
4
4
|
const flowHandleIdSchema = z.string().check(z.trim(), z.minLength(1));
|
|
5
5
|
const flowIdSchema = z.string().check(z.trim(), z.minLength(1));
|
|
@@ -36,15 +36,20 @@ const htmlElementOrNullSchema = z.custom((value) => value === null || isHTMLElem
|
|
|
36
36
|
message: "Container must be null or an HTMLElement with nodeType=1",
|
|
37
37
|
});
|
|
38
38
|
const identifyTraitsSchema = z.record(z.string(), z.unknown());
|
|
39
|
+
const identifyOptionsSchema = z.strictObject({
|
|
40
|
+
externalIds: z.optional(z.array(appEventExternalIdSchema).check(z.maxLength(20))),
|
|
41
|
+
});
|
|
39
42
|
const identifyPayloadSchema = z.union([
|
|
40
43
|
z.strictObject({
|
|
41
44
|
kind: z.literal("identify"),
|
|
42
45
|
traits: identifyTraitsSchema,
|
|
46
|
+
options: z.optional(identifyOptionsSchema),
|
|
43
47
|
}),
|
|
44
48
|
z.strictObject({
|
|
45
49
|
kind: z.literal("identify"),
|
|
46
50
|
userId: z.string().check(z.trim(), z.minLength(1)),
|
|
47
51
|
traits: z.optional(identifyTraitsSchema),
|
|
52
|
+
options: z.optional(identifyOptionsSchema),
|
|
48
53
|
}),
|
|
49
54
|
]);
|
|
50
55
|
// TODO(migration): After telemetry confirms no remaining `open.containerRequirement` in host command queues, remove the optional field and transform so unknown keys fail under `.strict()` again.
|
package/dist/widget-config.d.ts
CHANGED
|
@@ -43,6 +43,12 @@ export declare const identityConfigInputSchema: z.ZodMiniObject<{
|
|
|
43
43
|
anonymousId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
44
44
|
userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
45
45
|
traits: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>>;
|
|
46
|
+
externalIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
47
|
+
id: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string, string>>;
|
|
48
|
+
type: z.ZodMiniString<string>;
|
|
49
|
+
collection: z.ZodMiniLiteral<"users">;
|
|
50
|
+
encoding: z.ZodMiniLiteral<"none">;
|
|
51
|
+
}, z.core.$strip>>>;
|
|
46
52
|
}, z.core.$strip>;
|
|
47
53
|
export type IdentityConfigInput = z.output<typeof identityConfigInputSchema>;
|
|
48
54
|
export declare const flagsConfigInputSchema: z.ZodMiniArray<z.ZodMiniObject<{
|
|
@@ -338,6 +344,12 @@ export declare const instanceUpdateableConfigSchema: z.ZodMiniObject<{
|
|
|
338
344
|
anonymousId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
339
345
|
userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
340
346
|
traits: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>>;
|
|
347
|
+
externalIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
348
|
+
id: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string, string>>;
|
|
349
|
+
type: z.ZodMiniString<string>;
|
|
350
|
+
collection: z.ZodMiniLiteral<"users">;
|
|
351
|
+
encoding: z.ZodMiniLiteral<"none">;
|
|
352
|
+
}, z.core.$strip>>>;
|
|
341
353
|
}, z.core.$strip>>;
|
|
342
354
|
}, z.core.$strict>;
|
|
343
355
|
export type InstanceUpdateableConfig = z.output<typeof instanceUpdateableConfigSchema>;
|
|
@@ -384,6 +396,12 @@ export declare const coreInstanceConfigSchema: z.ZodMiniObject<{
|
|
|
384
396
|
anonymousId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
385
397
|
userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
386
398
|
traits: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>>;
|
|
399
|
+
externalIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
400
|
+
id: z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<string, string>>;
|
|
401
|
+
type: z.ZodMiniString<string>;
|
|
402
|
+
collection: z.ZodMiniLiteral<"users">;
|
|
403
|
+
encoding: z.ZodMiniLiteral<"none">;
|
|
404
|
+
}, z.core.$strip>>>;
|
|
387
405
|
}, z.core.$strip>>;
|
|
388
406
|
apiKey: z.ZodMiniString<string>;
|
|
389
407
|
clientMeta: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"widget-config.d.ts","sourceRoot":"","sources":["../src/widget-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"widget-config.d.ts","sourceRoot":"","sources":["../src/widget-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAiB9B,eAAO,MAAM,4BAA4B;;;;;;IAKvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAC5C,OAAO,4BAA4B,CACnC,CAAC;AAEF,eAAO,MAAM,0BAA0B;;iBAErC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE/E,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;KAGnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE3E,eAAO,MAAM,gBAAgB,wHAI3B,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEjE,eAAO,MAAM,wBAAwB;;iBAEnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE3E,eAAO,MAAM,qBAAqB;;;;iBAEhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,yBAAyB;;;;;;;;;;iBAOpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE7E,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAA8B,CAAC;AAElE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEvE,eAAO,MAAM,iCAAiC;;;;;;;;kBAE7C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CACjD,OAAO,iCAAiC,CACxC,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAIjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEvE,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAW5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE7D,eAAO,MAAM,2BAA2B,EAAE,sBAEzC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAKzC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAC9C,OAAO,8BAA8B,CACrC,CAAC;AAEF,uEAAuE;AACvE,eAAO,MAAM,2BAA2B,EAAE,CAAC,MAAM,wBAAwB,CAAC,EAKzE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAenC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE/E,yDAAyD;AACzD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAC"}
|
package/dist/widget-config.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as z from "zod/mini";
|
|
2
|
-
import { appEventCapabilitySchema, appEventFlagSchema } from "./app-event.js";
|
|
2
|
+
import { appEventCapabilitySchema, appEventExternalIdSchema, appEventFlagSchema, } from "./app-event.js";
|
|
3
3
|
import { clientMetaSchema } from "./client-meta.js";
|
|
4
4
|
import { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
|
|
5
5
|
import { runtimeEndpointsSchema } from "./runtime-endpoints.js";
|
|
@@ -36,6 +36,7 @@ export const identityConfigInputSchema = z.object({
|
|
|
36
36
|
anonymousId: z.optional(z.string().check(z.trim(), z.minLength(1))),
|
|
37
37
|
userId: z.optional(z.string().check(z.trim(), z.minLength(1))),
|
|
38
38
|
traits: z.optional(z.record(z.string(), z.unknown())),
|
|
39
|
+
externalIds: z.optional(z.array(appEventExternalIdSchema).check(z.maxLength(20))),
|
|
39
40
|
});
|
|
40
41
|
export const flagsConfigInputSchema = z.array(appEventFlagSchema);
|
|
41
42
|
export const hostCapabilitiesConfigInputSchema = z.array(appEventCapabilitySchema);
|
package/package.json
CHANGED
package/src/app-event.ts
CHANGED
|
@@ -86,10 +86,34 @@ const appEventPageSchema = z.object({
|
|
|
86
86
|
search: z.optional(z.string()),
|
|
87
87
|
});
|
|
88
88
|
|
|
89
|
+
const externalIdTypeSchema = z.string().check(
|
|
90
|
+
z.trim(),
|
|
91
|
+
z.minLength(1),
|
|
92
|
+
z.regex(/^[a-z0-9][a-z0-9_.-]*$/, {
|
|
93
|
+
message:
|
|
94
|
+
"External ID type must start with a lowercase letter or number and may contain lowercase letters, numbers, underscores, dots, or hyphens.",
|
|
95
|
+
}),
|
|
96
|
+
);
|
|
97
|
+
|
|
98
|
+
export const appEventExternalIdSchema = z.object({
|
|
99
|
+
id: z.pipe(
|
|
100
|
+
z.string().check(z.trim(), z.minLength(1)),
|
|
101
|
+
z.transform((value) => value.trim()),
|
|
102
|
+
),
|
|
103
|
+
type: externalIdTypeSchema,
|
|
104
|
+
collection: z.literal("users"),
|
|
105
|
+
encoding: z.literal("none"),
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
export type AppEventExternalId = z.output<typeof appEventExternalIdSchema>;
|
|
109
|
+
|
|
89
110
|
export const appEventContextSchema = z.object({
|
|
90
111
|
page: z.optional(appEventPageSchema),
|
|
91
112
|
locale: z.optional(z.string()),
|
|
92
113
|
userAgent: z.optional(z.string()),
|
|
114
|
+
externalIds: z.optional(
|
|
115
|
+
z.array(appEventExternalIdSchema).check(z.maxLength(20)),
|
|
116
|
+
),
|
|
93
117
|
flags: z.optional(z.array(appEventFlagSchema)),
|
|
94
118
|
capabilities: z.optional(z.array(appEventCapabilitySchema)),
|
|
95
119
|
});
|
|
@@ -39,6 +39,25 @@ describe("flow assignment request contracts", () => {
|
|
|
39
39
|
expect(result.context?.capabilities?.[0]?.key).toBe("billing.portal");
|
|
40
40
|
});
|
|
41
41
|
|
|
42
|
+
it("accepts external ID identities for recipient continuity", () => {
|
|
43
|
+
const result = claimPendingFlowAssignmentsRequestSchema.parse({
|
|
44
|
+
holdOwnerKey: "inst_1",
|
|
45
|
+
identities: [
|
|
46
|
+
{
|
|
47
|
+
type: "externalId.shopify_customer_id",
|
|
48
|
+
value: "gid://shopify/Customer/123",
|
|
49
|
+
},
|
|
50
|
+
],
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
expect(result.identities).toEqual([
|
|
54
|
+
{
|
|
55
|
+
type: "externalId.shopify_customer_id",
|
|
56
|
+
value: "gid://shopify/Customer/123",
|
|
57
|
+
},
|
|
58
|
+
]);
|
|
59
|
+
});
|
|
60
|
+
|
|
42
61
|
it("accepts runtime targeting context for lifecycle updates", () => {
|
|
43
62
|
const result = updateFlowAssignmentLifecycleRequestSchema.parse({
|
|
44
63
|
identities: [{ type: "userId", value: "user_1" }],
|
package/src/flow-assignments.ts
CHANGED
|
@@ -3,8 +3,34 @@ import * as z from "zod/mini";
|
|
|
3
3
|
import {
|
|
4
4
|
appEventCapabilitySchema,
|
|
5
5
|
appEventFlagSchema,
|
|
6
|
-
|
|
6
|
+
appEventIdentityTypeSchema,
|
|
7
7
|
} from "./app-event.js";
|
|
8
|
+
import type { IdentityTypeValue } from "./identity-type.js";
|
|
9
|
+
|
|
10
|
+
export type FlowAssignmentExternalIdIdentityTypeValue = `externalId.${string}`;
|
|
11
|
+
export type FlowAssignmentIdentityTypeValue =
|
|
12
|
+
| IdentityTypeValue
|
|
13
|
+
| FlowAssignmentExternalIdIdentityTypeValue;
|
|
14
|
+
|
|
15
|
+
const flowAssignmentExternalIdIdentityTypeSchema = z.string().check(
|
|
16
|
+
z.trim(),
|
|
17
|
+
z.minLength(1),
|
|
18
|
+
z.regex(/^externalId\.[a-z0-9][a-z0-9_.-]*$/, {
|
|
19
|
+
message:
|
|
20
|
+
"External ID identity type must use externalId.<type> with a lowercase Segment external ID type.",
|
|
21
|
+
}),
|
|
22
|
+
) as z.ZodMiniType<
|
|
23
|
+
FlowAssignmentExternalIdIdentityTypeValue,
|
|
24
|
+
FlowAssignmentExternalIdIdentityTypeValue
|
|
25
|
+
>;
|
|
26
|
+
|
|
27
|
+
const flowAssignmentIdentitySchema = z.object({
|
|
28
|
+
type: z.union([
|
|
29
|
+
appEventIdentityTypeSchema,
|
|
30
|
+
flowAssignmentExternalIdIdentityTypeSchema,
|
|
31
|
+
]),
|
|
32
|
+
value: z.string().check(z.trim(), z.minLength(1)),
|
|
33
|
+
});
|
|
8
34
|
|
|
9
35
|
export const flowAssignmentStatusSchema = z.enum([
|
|
10
36
|
"pending",
|
|
@@ -24,7 +50,7 @@ export const flowAssignmentTargetingContextSchema = z.object({
|
|
|
24
50
|
});
|
|
25
51
|
|
|
26
52
|
export const flowAssignmentRecipientRequestSchema = z.object({
|
|
27
|
-
identities: z._default(z.array(
|
|
53
|
+
identities: z._default(z.array(flowAssignmentIdentitySchema), []),
|
|
28
54
|
context: z.optional(flowAssignmentTargetingContextSchema),
|
|
29
55
|
at: z.optional(z.number()),
|
|
30
56
|
});
|
|
@@ -56,7 +82,7 @@ export const listPendingFlowAssignmentsResponseSchema = z.object({
|
|
|
56
82
|
});
|
|
57
83
|
|
|
58
84
|
export const claimPendingFlowAssignmentsRequestSchema = z.object({
|
|
59
|
-
identities: z._default(z.array(
|
|
85
|
+
identities: z._default(z.array(flowAssignmentIdentitySchema), []),
|
|
60
86
|
context: z.optional(flowAssignmentTargetingContextSchema),
|
|
61
87
|
holdOwnerKey: z.string().check(z.trim(), z.minLength(1)),
|
|
62
88
|
at: z.optional(z.number()),
|
|
@@ -69,7 +95,7 @@ export const claimPendingFlowAssignmentsResponseSchema = z.object({
|
|
|
69
95
|
});
|
|
70
96
|
|
|
71
97
|
export const updateFlowAssignmentLifecycleRequestSchema = z.object({
|
|
72
|
-
identities: z._default(z.array(
|
|
98
|
+
identities: z._default(z.array(flowAssignmentIdentitySchema), []),
|
|
73
99
|
context: z.optional(flowAssignmentTargetingContextSchema),
|
|
74
100
|
flowAssignmentId: z.string().check(z.trim(), z.minLength(1)),
|
|
75
101
|
flowVersionId: z.optional(z.string().check(z.trim(), z.minLength(1))),
|
|
@@ -78,7 +104,7 @@ export const updateFlowAssignmentLifecycleRequestSchema = z.object({
|
|
|
78
104
|
});
|
|
79
105
|
|
|
80
106
|
export const releaseFlowAssignmentClaimRequestSchema = z.object({
|
|
81
|
-
identities: z._default(z.array(
|
|
107
|
+
identities: z._default(z.array(flowAssignmentIdentitySchema), []),
|
|
82
108
|
holdGroupToken: z.string().check(z.trim(), z.minLength(1)),
|
|
83
109
|
holdOwnerKey: z.optional(z.string().check(z.trim(), z.minLength(1))),
|
|
84
110
|
at: z.optional(z.number()),
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
type ExternalIdArgumentCommandName = "identify" | "track";
|
|
2
|
+
type ExternalIdArgumentValueName = "traits" | "properties";
|
|
3
|
+
|
|
4
|
+
const isAmbiguousExternalIdsArgument = (value: unknown): boolean => {
|
|
5
|
+
if (value === null || typeof value !== "object" || Array.isArray(value)) {
|
|
6
|
+
return false;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
const entries = Object.entries(value);
|
|
10
|
+
const externalIds = entries[0]?.[1];
|
|
11
|
+
return (
|
|
12
|
+
entries.length === 1 &&
|
|
13
|
+
entries[0]?.[0] === "externalIds" &&
|
|
14
|
+
Array.isArray(externalIds) &&
|
|
15
|
+
externalIds.length > 0 &&
|
|
16
|
+
externalIds.every(isSegmentExternalIdLike)
|
|
17
|
+
);
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
const isSegmentExternalIdLike = (
|
|
21
|
+
value: unknown,
|
|
22
|
+
): value is {
|
|
23
|
+
id: string;
|
|
24
|
+
type: string;
|
|
25
|
+
collection: "users";
|
|
26
|
+
encoding: "none";
|
|
27
|
+
} => {
|
|
28
|
+
if (value === null || typeof value !== "object" || Array.isArray(value)) {
|
|
29
|
+
return false;
|
|
30
|
+
}
|
|
31
|
+
return (
|
|
32
|
+
typeof Reflect.get(value, "id") === "string" &&
|
|
33
|
+
typeof Reflect.get(value, "type") === "string" &&
|
|
34
|
+
Reflect.get(value, "collection") === "users" &&
|
|
35
|
+
Reflect.get(value, "encoding") === "none"
|
|
36
|
+
);
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
export const assertNoAmbiguousExternalIdsArgument = ({
|
|
40
|
+
argument,
|
|
41
|
+
options,
|
|
42
|
+
commandName,
|
|
43
|
+
valueArgumentName,
|
|
44
|
+
}: {
|
|
45
|
+
argument: unknown;
|
|
46
|
+
options: unknown;
|
|
47
|
+
commandName: ExternalIdArgumentCommandName;
|
|
48
|
+
valueArgumentName: ExternalIdArgumentValueName;
|
|
49
|
+
}): void => {
|
|
50
|
+
if (options !== undefined || !isAmbiguousExternalIdsArgument(argument)) {
|
|
51
|
+
return;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
throw new Error(
|
|
55
|
+
`${commandName} received externalIds in the ${valueArgumentName} argument. Pass undefined for ${valueArgumentName} and provide externalIds as options instead.`,
|
|
56
|
+
);
|
|
57
|
+
};
|