@disconetwork/core 0.0.17 → 0.0.18

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.
Files changed (120) hide show
  1. package/README.md +14 -12
  2. package/dist/TrackingManager.d.ts +64 -0
  3. package/dist/TrackingManager.d.ts.map +1 -0
  4. package/dist/TrackingManager.js +114 -0
  5. package/dist/TrackingManager.js.map +1 -0
  6. package/dist/api/generated/events/client/client.gen.js +176 -0
  7. package/dist/api/generated/events/client/client.gen.js.map +1 -0
  8. package/dist/api/generated/events/client/utils.gen.js +179 -0
  9. package/dist/api/generated/events/client/utils.gen.js.map +1 -0
  10. package/dist/api/generated/events/client.gen.js +8 -0
  11. package/dist/api/generated/events/client.gen.js.map +1 -0
  12. package/dist/api/generated/events/core/auth.gen.js +12 -0
  13. package/dist/api/generated/events/core/auth.gen.js.map +1 -0
  14. package/dist/api/generated/events/core/bodySerializer.gen.js +6 -0
  15. package/dist/api/generated/events/core/bodySerializer.gen.js.map +1 -0
  16. package/dist/api/generated/events/core/pathSerializer.gen.js +82 -0
  17. package/dist/api/generated/events/core/pathSerializer.gen.js.map +1 -0
  18. package/dist/api/generated/events/core/serverSentEvents.gen.js +95 -0
  19. package/dist/api/generated/events/core/serverSentEvents.gen.js.map +1 -0
  20. package/dist/api/generated/events/core/utils.gen.js +78 -0
  21. package/dist/api/generated/events/core/utils.gen.js.map +1 -0
  22. package/dist/api/generated/events/sdk.gen.js +31 -0
  23. package/dist/api/generated/events/sdk.gen.js.map +1 -0
  24. package/dist/api/generated/events/zod.gen.js +197 -0
  25. package/dist/api/generated/events/zod.gen.js.map +1 -0
  26. package/dist/api/generated/recommendations/client/client.gen.js +176 -0
  27. package/dist/api/generated/recommendations/client/client.gen.js.map +1 -0
  28. package/dist/api/generated/recommendations/client/utils.gen.js +179 -0
  29. package/dist/api/generated/recommendations/client/utils.gen.js.map +1 -0
  30. package/dist/api/generated/recommendations/client.gen.js +8 -0
  31. package/dist/api/generated/recommendations/client.gen.js.map +1 -0
  32. package/dist/api/generated/recommendations/core/auth.gen.js +12 -0
  33. package/dist/api/generated/recommendations/core/auth.gen.js.map +1 -0
  34. package/dist/api/generated/recommendations/core/bodySerializer.gen.js +6 -0
  35. package/dist/api/generated/recommendations/core/bodySerializer.gen.js.map +1 -0
  36. package/dist/api/generated/recommendations/core/pathSerializer.gen.js +82 -0
  37. package/dist/api/generated/recommendations/core/pathSerializer.gen.js.map +1 -0
  38. package/dist/api/generated/recommendations/core/serverSentEvents.gen.js +95 -0
  39. package/dist/api/generated/recommendations/core/serverSentEvents.gen.js.map +1 -0
  40. package/dist/api/generated/recommendations/core/utils.gen.js +78 -0
  41. package/dist/api/generated/recommendations/core/utils.gen.js.map +1 -0
  42. package/dist/api/generated/recommendations/sdk.gen.js +35 -0
  43. package/dist/api/generated/recommendations/sdk.gen.js.map +1 -0
  44. package/dist/api/generated/recommendations/types.gen.d.ts +32 -0
  45. package/dist/api/generated/recommendations/types.gen.d.ts.map +1 -0
  46. package/dist/api/generated/recommendations/zod.gen.js +407 -0
  47. package/dist/api/generated/recommendations/zod.gen.js.map +1 -0
  48. package/dist/api/index.js +60 -0
  49. package/dist/api/index.js.map +1 -0
  50. package/dist/apiKey.js +13 -0
  51. package/dist/apiKey.js.map +1 -0
  52. package/dist/config.js +38 -0
  53. package/dist/config.js.map +1 -0
  54. package/dist/env.d.ts +5 -0
  55. package/dist/env.d.ts.map +1 -0
  56. package/dist/errors.d.ts +56 -0
  57. package/dist/errors.d.ts.map +1 -0
  58. package/dist/errors.js +76 -0
  59. package/dist/errors.js.map +1 -0
  60. package/dist/events/dedupe.d.ts +15 -0
  61. package/dist/events/dedupe.d.ts.map +1 -0
  62. package/dist/events/dedupe.js +34 -0
  63. package/dist/events/dedupe.js.map +1 -0
  64. package/dist/events/eventMapping.js +88 -0
  65. package/dist/events/eventMapping.js.map +1 -0
  66. package/dist/external/DiscoClient.d.ts +88 -0
  67. package/dist/external/DiscoClient.d.ts.map +1 -0
  68. package/dist/external/DiscoClient.js +122 -0
  69. package/dist/external/DiscoClient.js.map +1 -0
  70. package/dist/external/recommendations.d.ts +186 -0
  71. package/dist/external/recommendations.d.ts.map +1 -0
  72. package/dist/external/recommendationsTransforms.js +209 -0
  73. package/dist/external/recommendationsTransforms.js.map +1 -0
  74. package/dist/index.d.ts +8 -97
  75. package/dist/index.js +3 -1769
  76. package/dist/internal/InternalDiscoClient.d.ts +129 -0
  77. package/dist/internal/InternalDiscoClient.d.ts.map +1 -0
  78. package/dist/internal/InternalDiscoClient.js +137 -0
  79. package/dist/internal/InternalDiscoClient.js.map +1 -0
  80. package/dist/internal/denormalize.d.ts +18 -0
  81. package/dist/internal/denormalize.d.ts.map +1 -0
  82. package/dist/internal/denormalize.js +49 -0
  83. package/dist/internal/denormalize.js.map +1 -0
  84. package/dist/internal/recommendations.d.ts +88 -0
  85. package/dist/internal/recommendations.d.ts.map +1 -0
  86. package/dist/internal/recommendationsMapper.js +68 -0
  87. package/dist/internal/recommendationsMapper.js.map +1 -0
  88. package/dist/internal/recommendationsRequestMapper.js +114 -0
  89. package/dist/internal/recommendationsRequestMapper.js.map +1 -0
  90. package/dist/internal/screens.d.ts +77 -0
  91. package/dist/internal/screens.d.ts.map +1 -0
  92. package/dist/internal/screens.js +79 -0
  93. package/dist/internal/screens.js.map +1 -0
  94. package/dist/internal.d.ts +11 -400
  95. package/dist/internal.js +5 -564
  96. package/dist/lib/case.js +26 -0
  97. package/dist/lib/case.js.map +1 -0
  98. package/dist/lib/http.js +21 -0
  99. package/dist/lib/http.js.map +1 -0
  100. package/dist/lib/primitives.js +23 -0
  101. package/dist/lib/primitives.js.map +1 -0
  102. package/dist/lib/schemas.js +25 -0
  103. package/dist/lib/schemas.js.map +1 -0
  104. package/dist/package.js +7 -0
  105. package/dist/package.js.map +1 -0
  106. package/dist/sdkIdentity.d.ts +9 -0
  107. package/dist/sdkIdentity.d.ts.map +1 -0
  108. package/dist/sdkIdentity.js +16 -0
  109. package/dist/sdkIdentity.js.map +1 -0
  110. package/dist/types.d.ts +91 -0
  111. package/dist/types.d.ts.map +1 -0
  112. package/package.json +3 -3
  113. package/dist/errors-DpKOKpT8.d.ts +0 -363
  114. package/dist/errors-DpKOKpT8.d.ts.map +0 -1
  115. package/dist/index.d.ts.map +0 -1
  116. package/dist/index.js.map +0 -1
  117. package/dist/internal.d.ts.map +0 -1
  118. package/dist/internal.js.map +0 -1
  119. package/dist/recommendationsTransforms-D_E4xU1d.js +0 -748
  120. package/dist/recommendationsTransforms-D_E4xU1d.js.map +0 -1
@@ -0,0 +1,7 @@
1
+ //#region package.json
2
+ var name = "@disconetwork/core";
3
+ var version = "0.0.18";
4
+ //#endregion
5
+ export { name, version };
6
+
7
+ //# sourceMappingURL=package.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"package.js","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}
@@ -0,0 +1,9 @@
1
+ //#region src/sdkIdentity.d.ts
2
+ /** Identity of the SDK/renderer using the shared HTTP clients. */
3
+ type SdkIdentity = {
4
+ name: string;
5
+ version: string;
6
+ };
7
+ //#endregion
8
+ export { SdkIdentity };
9
+ //# sourceMappingURL=sdkIdentity.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sdkIdentity.d.ts","names":[],"sources":["../src/sdkIdentity.ts"],"mappings":";;KAGY,WAAA;EACV,IAAA;EACA,OAAO;AAAA"}
@@ -0,0 +1,16 @@
1
+ import { name, version } from "./package.js";
2
+ //#region src/sdkIdentity.ts
3
+ const CORE_SDK_IDENTITY = {
4
+ name,
5
+ version
6
+ };
7
+ function getSdkHeaders(sdk = CORE_SDK_IDENTITY) {
8
+ return {
9
+ "Disco-SDK-Name": sdk.name,
10
+ "Disco-SDK-Version": sdk.version
11
+ };
12
+ }
13
+ //#endregion
14
+ export { getSdkHeaders };
15
+
16
+ //# sourceMappingURL=sdkIdentity.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sdkIdentity.js","names":["packageJson.name","packageJson.version"],"sources":["../src/sdkIdentity.ts"],"sourcesContent":["import packageJson from \"../package.json\" with { type: \"json\" };\n\n/** Identity of the SDK/renderer using the shared HTTP clients. */\nexport type SdkIdentity = {\n name: string;\n version: string;\n};\n\nconst CORE_SDK_IDENTITY = {\n name: packageJson.name,\n version: packageJson.version,\n};\n\nexport function getSdkHeaders(\n sdk: SdkIdentity = CORE_SDK_IDENTITY,\n): Record<string, string> {\n return {\n \"Disco-SDK-Name\": sdk.name,\n \"Disco-SDK-Version\": sdk.version,\n };\n}\n"],"mappings":";;AAQA,MAAM,oBAAoB;CAClBA;CACGC;AACX;AAEA,SAAgB,cACd,MAAmB,mBACK;CACxB,OAAO;EACL,kBAAkB,IAAI;EACtB,qBAAqB,IAAI;CAC3B;AACF"}
@@ -0,0 +1,91 @@
1
+ //#region src/types.d.ts
2
+ /**
3
+ * Targets for `BRAND_CLICK` events — where in the widget the click originated.
4
+ */
5
+ type BrandClickInitiatingTarget = "INLINE_ACTION_BUTTON" | "INLINE_ASSET_TILE" | "SCROLLABLE_SLOT_TILE";
6
+ /**
7
+ * Targets for `ELEMENT_CLICK` events — non-brand UI interactions.
8
+ */
9
+ type ElementClickInitiatingTarget = "INLINE_NAV_FORWARD" | "INLINE_NAV_BACKWARD" | "EXPLICIT_NAV_FORWARD" | "EXPLICIT_NAV_BACKWARD" | "INLINE_FOOTER_DISCO" | "INLINE_FOOTER_PRIVACY" | "CLOSE_BUTTON" | "CLOSE_BACKDROP" | "OPEN_OVERLAY";
10
+ /**
11
+ * Targets for `BRAND_DISPLAY` / `BRAND_VIEW` events.
12
+ */
13
+ type BrandDisplayInitiatingTarget = "INLINE_SLOT" | "SCROLLABLE_SLOT";
14
+ /**
15
+ * Targets for `PRODUCT_DISPLAY` / `PRODUCT_VIEW` / `PRODUCT_CLICK` events.
16
+ */
17
+ type ProductDisplayInitiatingTarget = "INLINE_TILE";
18
+ /**
19
+ * Identifies a brand instance in the recommendations response.
20
+ *
21
+ * `insertionId` is the unique-per-render identifier and is what dedup keys
22
+ * are built from.
23
+ */
24
+ type BrandProperties = {
25
+ offerId: string;
26
+ advertiserId: string;
27
+ insertionId: string;
28
+ };
29
+ type ProductProperties = {
30
+ productId: string;
31
+ };
32
+ type WidgetEventType = "WIDGET_LOAD" | "WIDGET_DISPLAY" | "WIDGET_VIEW";
33
+ type BrandVisibilityEventType = "BRAND_DISPLAY" | "BRAND_VIEW";
34
+ type ProductEventType = "PRODUCT_DISPLAY" | "PRODUCT_VIEW" | "PRODUCT_CLICK";
35
+ /**
36
+ * Optional placement context attached to an event, emitted as
37
+ * `placement_details`. All fields are optional; values are open-ended.
38
+ */
39
+ type EventPlacementDetails = {
40
+ displayMode?: string;
41
+ view?: string;
42
+ layoutId?: string;
43
+ };
44
+ /**
45
+ * Discriminated union of every event the SDK can emit. `session_id` and
46
+ * `event_datetime` are stamped by `TrackingManager`, so callers supply only the
47
+ * event-specific fields.
48
+ *
49
+ * The same union is sent by both the external client (direct to the events
50
+ * service) and the internal/proxy client — the proxy forwards events verbatim,
51
+ * so the contract is identical.
52
+ */
53
+ /**
54
+ * Renderer-agnostic handle for emitting Disco events. Both the SDK-backed
55
+ * external tracker (`DiscoClient.createTrackingManager`) and the proxy
56
+ * `TrackingManager` implement this same interface, so consumers (and the React
57
+ * layer) depend on the interface, not the implementation. `track` is a closure,
58
+ * so it's safe to destructure.
59
+ */
60
+ type EventTracker = {
61
+ track: (event: EventPayload) => void;
62
+ };
63
+ type EventPayload = {
64
+ type: WidgetEventType;
65
+ placement?: EventPlacementDetails;
66
+ } | {
67
+ type: BrandVisibilityEventType;
68
+ brand: BrandProperties;
69
+ target: BrandDisplayInitiatingTarget;
70
+ placement?: EventPlacementDetails;
71
+ } | {
72
+ type: "BRAND_CLICK";
73
+ brand: BrandProperties;
74
+ target: BrandClickInitiatingTarget;
75
+ assetId?: string;
76
+ placement?: EventPlacementDetails;
77
+ } | {
78
+ type: "ELEMENT_CLICK";
79
+ target: ElementClickInitiatingTarget;
80
+ brand?: BrandProperties;
81
+ placement?: EventPlacementDetails;
82
+ } | {
83
+ type: ProductEventType;
84
+ product: ProductProperties;
85
+ brand: BrandProperties;
86
+ target: ProductDisplayInitiatingTarget;
87
+ placement?: EventPlacementDetails;
88
+ };
89
+ //#endregion
90
+ export { BrandClickInitiatingTarget, BrandDisplayInitiatingTarget, BrandProperties, BrandVisibilityEventType, ElementClickInitiatingTarget, EventPayload, EventPlacementDetails, EventTracker, ProductDisplayInitiatingTarget, ProductEventType, ProductProperties, WidgetEventType };
91
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"mappings":";;AAGA;;KAAY,0BAAA;;AAA0B;AAQtC;KAAY,4BAAA;;;AAA4B;KAc5B,4BAAA;;;;KAKA,8BAAA;AAAZ;;;;AAA0C;AAQ1C;AARA,KAQY,eAAA;EACV,OAAA;EACA,YAAA;EACA,WAAA;AAAA;AAAA,KAGU,iBAAA;EACV,SAAS;AAAA;AAAA,KAGC,eAAA;AAAA,KAEA,wBAAA;AAAA,KAEA,gBAAA;;AAPD;AAGX;;KAaY,qBAAA;EACV,WAAA;EACA,IAAA;EACA,QAAA;AAAA;;;AAdkC;AAEpC;;;;AAA4B;AAS5B;;;;;;;;KAsBY,YAAA;EACV,KAAA,GAAQ,KAAA,EAAO,YAAY;AAAA;AAAA,KAGjB,YAAA;EACN,IAAA,EAAM,eAAA;EAAiB,SAAA,GAAY,qBAAA;AAAA;EAEnC,IAAA,EAAM,wBAAA;EACN,KAAA,EAAO,eAAA;EACP,MAAA,EAAQ,4BAAA;EACR,SAAA,GAAY,qBAAA;AAAA;EAGZ,IAAA;EACA,KAAA,EAAO,eAAA;EACP,MAAA,EAAQ,0BAAA;EACR,OAAA;EACA,SAAA,GAAY,qBAAA;AAAA;EAGZ,IAAA;EACA,MAAA,EAAQ,4BAAA;EACR,KAAA,GAAQ,eAAA;EACR,SAAA,GAAY,qBAAA;AAAA;EAGZ,IAAA,EAAM,gBAAA;EACN,OAAA,EAAS,iBAAA;EACT,KAAA,EAAO,eAAA;EACP,MAAA,EAAQ,8BAAA;EACR,SAAA,GAAY,qBAAA;AAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@disconetwork/core",
3
- "version": "0.0.17",
3
+ "version": "0.0.18",
4
4
  "description": "Core package for disco-js.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -38,8 +38,8 @@
38
38
  "tsdown": "^0.22.0",
39
39
  "typescript": "5.9.2",
40
40
  "vitest": "^4.1.7",
41
- "@repo/eslint-config": "0.0.0",
42
- "@repo/typescript-config": "0.0.0"
41
+ "@repo/typescript-config": "0.0.0",
42
+ "@repo/eslint-config": "0.0.0"
43
43
  },
44
44
  "dependencies": {
45
45
  "zod": "^3.25.0 || ^4.0.0"
@@ -1,363 +0,0 @@
1
- //#region src/sdkIdentity.d.ts
2
- /** Identity of the SDK/renderer using the shared HTTP clients. */
3
- type SdkIdentity = {
4
- name: string;
5
- version: string;
6
- };
7
- //#endregion
8
- //#region src/api/generated/recommendations/types.gen.d.ts
9
- /**
10
- * DisplayMode
11
- */
12
- type DisplayMode = "OVERLAY" | "FULLSCREEN" | "PULLUP" | "INLINE";
13
- /**
14
- * Gender
15
- */
16
- type Gender = "MALE" | "FEMALE" | "OTHER" | "UNSPECIFIED";
17
- /**
18
- * PlatformType
19
- */
20
- type PlatformType = "MOBILE" | "WEB";
21
- /**
22
- * SubView
23
- *
24
- * Used to distinguish two different views of the same page type
25
- */
26
- type SubView = "DEFAULT" | "POST_CLAIM" | "BOOKING" | "PURCHASE" | "BOOKING_AND_PURCHASE";
27
- /**
28
- * Title
29
- */
30
- type Title = "MR" | "MRS" | "MS" | "MISS";
31
- /**
32
- * View
33
- *
34
- * deprecated, please use PageType instead
35
- */
36
- type View = "ORDER_STATUS" | "CHECKOUT" | "THANK_YOU" | "POST_ORDER" | "ORDER_TRACKING" | "SUPPORT_CENTER" | "REWARDED";
37
- //#endregion
38
- //#region src/external/recommendations.d.ts
39
- /**
40
- * A running experiment — shared by the request (input) and the response
41
- * (echoed back). Declared here (not inferred) because the response references
42
- * it; the request schema validates the identical `{ name, version }` shape.
43
- */
44
- type RunningExperiment = {
45
- name: string; /** 0 .. 999. */
46
- version: number;
47
- };
48
- /**
49
- * Structured device/session attributes. Only these fields are recognized by the
50
- * backend (`disco_shared` `Attributes`); unknown keys are dropped server-side.
51
- */
52
- type Attributes = {
53
- userAgent?: string;
54
- operatingSystem?: string;
55
- operatingSystemVersion?: string;
56
- ipAddress?: string;
57
- ipAddressHash?: string;
58
- platformType?: PlatformType; /** ISO-639 language code. */
59
- language?: string;
60
- deviceType?: string;
61
- };
62
- type UserProfile = {
63
- title?: Title;
64
- firstName?: string;
65
- lastName?: string;
66
- phone?: string;
67
- gender?: Gender; /** Date of birth, `YYYY-MM-DD`. */
68
- dob?: string; /** Non-negative. */
69
- age?: number;
70
- };
71
- /**
72
- * User details must carry at least one identifier — email, email hash, external
73
- * GUID, or phone. (Enforced by the generated SDK's request validator, not the
74
- * type.)
75
- */
76
- type UserDetails = (UserProfile & {
77
- email: string;
78
- }) | (UserProfile & {
79
- emailHash: string;
80
- }) | (UserProfile & {
81
- externalGuid: string;
82
- }) | (UserProfile & {
83
- phone: string;
84
- });
85
- type CostDetails = {
86
- amount?: number; /** ISO-4217 currency code. */
87
- currencyCode?: string;
88
- };
89
- type PlacementDetails = {
90
- displayMode: DisplayMode;
91
- view: View;
92
- subView?: SubView;
93
- layoutId?: string;
94
- };
95
- type OrderDetails = {
96
- orderId?: string;
97
- paymentType?: string;
98
- costDetails?: CostDetails;
99
- };
100
- type PurchaseAttributes = {
101
- isClearance?: boolean;
102
- isGift?: boolean;
103
- };
104
- type Purchase = {
105
- name?: string;
106
- type?: string; /** A string, or a data-keyed map passed through to the wire verbatim. */
107
- variant?: string | Record<string, string>;
108
- quantity?: number;
109
- description?: string;
110
- productId?: string;
111
- costDetails?: CostDetails;
112
- attributes?: PurchaseAttributes;
113
- };
114
- type Address = {
115
- addressLine1?: string;
116
- addressLine2?: string;
117
- city?: string;
118
- state?: string;
119
- zip?: string;
120
- phone?: string;
121
- countryCode?: string;
122
- };
123
- /**
124
- * Free-form custom metadata. Untyped on purpose: the backend `CustomMetadata`
125
- * model has many fields and churns; keys are recased camelCase → snake_case on
126
- * the way out so callers can stay in the camelCase idiom.
127
- */
128
- type CustomMetadata = Record<string, unknown>;
129
- type RecommendationsRequest = {
130
- userDetails: UserDetails;
131
- placementDetails: PlacementDetails;
132
- orderDetails?: OrderDetails;
133
- purchases?: Purchase[];
134
- attributes?: Attributes;
135
- customMetadata?: CustomMetadata;
136
- shipping?: Address;
137
- billing?: Address;
138
- runningExperiments?: RunningExperiment[];
139
- };
140
- type RecommendationsResponse = {
141
- sessionId: string; /** Offer id → recommendation. */
142
- recommendations: Record<string, Recommendation>; /** Group key → ordered entry list referencing offer ids. */
143
- recommendationGroups: Record<string, RecommendationGroupEntry[]>; /** Group key → display properties. */
144
- recommendationGroupProperties?: Record<string, RecommendationGroupProperty>;
145
- runningExperiments?: RunningExperiment[];
146
- footer: Footer;
147
- };
148
- type Recommendation = {
149
- advertiser: Advertiser;
150
- offer: Offer;
151
- };
152
- type RecommendationGroupEntry = {
153
- insertionOrder: number;
154
- insertionId: string;
155
- offerId: string;
156
- advertiserId: string;
157
- };
158
- type RecommendationGroupProperty = {
159
- heading: string | null;
160
- slotContext: string;
161
- };
162
- type Advertiser = {
163
- id: string;
164
- name: string;
165
- logoUrl: string;
166
- description: string | null;
167
- };
168
- type Offer = {
169
- id: string;
170
- heading: string;
171
- subheading: string | null;
172
- jsonContent: Record<string, unknown> | null;
173
- targetUrl: string;
174
- ctaDetails: OfferCtaDetails;
175
- assets: OfferAsset[];
176
- metadata: OfferMetadata;
177
- disclosureDetails: OfferDisclosureDetails | null;
178
- };
179
- type OfferCtaDetails = {
180
- acceptCopy: string;
181
- declineCopy: string;
182
- transitionCopy: string | null;
183
- claimedAcceptCopy: string | null;
184
- claimedDeclineCopy: string | null;
185
- };
186
- type OfferAsset = {
187
- /** Server-defined asset type (e.g. `PRODUCT`). Open-ended. */assetType: string;
188
- imageUrl: string;
189
- insertionOrder: number;
190
- id: string | null;
191
- targetUrl: string | null;
192
- shouldTriggerClaimFlow: boolean;
193
- };
194
- /** Discriminated on `type`. `layoutType` is a server-defined display format. */
195
- type OfferMetadata = {
196
- type: "PROMO_CODE";
197
- code: string;
198
- layoutType: string;
199
- } | {
200
- type: "NO_PROMO_CODE";
201
- layoutType: string;
202
- };
203
- type OfferDisclosureDetails = {
204
- copy: string;
205
- targetUrl: string | null;
206
- content: string | null;
207
- };
208
- type Footer = {
209
- attributionDetails: {
210
- copy: string;
211
- discoLogoUrl: string;
212
- targetUrl: string;
213
- };
214
- privacyPolicy: {
215
- copy: string;
216
- targetUrl: string;
217
- };
218
- };
219
- //#endregion
220
- //#region src/types.d.ts
221
- /**
222
- * Targets for `BRAND_CLICK` events — where in the widget the click originated.
223
- */
224
- type BrandClickInitiatingTarget = "INLINE_ACTION_BUTTON" | "INLINE_ASSET_TILE" | "SCROLLABLE_SLOT_TILE";
225
- /**
226
- * Targets for `ELEMENT_CLICK` events — non-brand UI interactions.
227
- */
228
- type ElementClickInitiatingTarget = "INLINE_NAV_FORWARD" | "INLINE_NAV_BACKWARD" | "EXPLICIT_NAV_FORWARD" | "EXPLICIT_NAV_BACKWARD" | "INLINE_FOOTER_DISCO" | "INLINE_FOOTER_PRIVACY" | "CLOSE_BUTTON" | "CLOSE_BACKDROP" | "OPEN_OVERLAY";
229
- /**
230
- * Targets for `BRAND_DISPLAY` / `BRAND_VIEW` events.
231
- */
232
- type BrandDisplayInitiatingTarget = "INLINE_SLOT" | "SCROLLABLE_SLOT";
233
- /**
234
- * Targets for `PRODUCT_DISPLAY` / `PRODUCT_VIEW` / `PRODUCT_CLICK` events.
235
- */
236
- type ProductDisplayInitiatingTarget = "INLINE_TILE";
237
- /**
238
- * Identifies a brand instance in the recommendations response.
239
- *
240
- * `insertionId` is the unique-per-render identifier and is what dedup keys
241
- * are built from.
242
- */
243
- type BrandProperties = {
244
- offerId: string;
245
- advertiserId: string;
246
- insertionId: string;
247
- };
248
- type ProductProperties = {
249
- productId: string;
250
- };
251
- type WidgetEventType = "WIDGET_LOAD" | "WIDGET_DISPLAY" | "WIDGET_VIEW";
252
- type BrandVisibilityEventType = "BRAND_DISPLAY" | "BRAND_VIEW";
253
- type ProductEventType = "PRODUCT_DISPLAY" | "PRODUCT_VIEW" | "PRODUCT_CLICK";
254
- /**
255
- * Optional placement context attached to an event, emitted as
256
- * `placement_details`. All fields are optional; values are open-ended.
257
- */
258
- type EventPlacementDetails = {
259
- displayMode?: string;
260
- view?: string;
261
- layoutId?: string;
262
- };
263
- /**
264
- * Discriminated union of every event the SDK can emit. `session_id` and
265
- * `event_datetime` are stamped by `TrackingManager`, so callers supply only the
266
- * event-specific fields.
267
- *
268
- * The same union is sent by both the external client (direct to the events
269
- * service) and the internal/proxy client — the proxy forwards events verbatim,
270
- * so the contract is identical.
271
- */
272
- /**
273
- * Renderer-agnostic handle for emitting Disco events. Both the SDK-backed
274
- * external tracker (`DiscoClient.createTrackingManager`) and the proxy
275
- * `TrackingManager` implement this same interface, so consumers (and the React
276
- * layer) depend on the interface, not the implementation. `track` is a closure,
277
- * so it's safe to destructure.
278
- */
279
- type EventTracker = {
280
- track: (event: EventPayload) => void;
281
- };
282
- type EventPayload = {
283
- type: WidgetEventType;
284
- placement?: EventPlacementDetails;
285
- } | {
286
- type: BrandVisibilityEventType;
287
- brand: BrandProperties;
288
- target: BrandDisplayInitiatingTarget;
289
- placement?: EventPlacementDetails;
290
- } | {
291
- type: "BRAND_CLICK";
292
- brand: BrandProperties;
293
- target: BrandClickInitiatingTarget;
294
- assetId?: string;
295
- placement?: EventPlacementDetails;
296
- } | {
297
- type: "ELEMENT_CLICK";
298
- target: ElementClickInitiatingTarget;
299
- brand?: BrandProperties;
300
- placement?: EventPlacementDetails;
301
- } | {
302
- type: ProductEventType;
303
- product: ProductProperties;
304
- brand: BrandProperties;
305
- target: ProductDisplayInitiatingTarget;
306
- placement?: EventPlacementDetails;
307
- };
308
- //#endregion
309
- //#region src/errors.d.ts
310
- /**
311
- * Base class for every error thrown by the Disco clients. Catch this to handle
312
- * any SDK-originated failure; narrow to a subclass for specifics.
313
- *
314
- * Note: a request aborted via an `AbortSignal` is intentionally *not* a
315
- * `DiscoError` — the native `AbortError` propagates untouched so callers can
316
- * detect cancellation idiomatically (`err.name === "AbortError"`).
317
- */
318
- declare abstract class DiscoError extends Error {}
319
- /**
320
- * Thrown when a recommendations/events request returns a non-2xx status. The
321
- * HTTP status and an optional parsed body are preserved for error UIs and
322
- * retry logic. Shared by both the external and internal clients.
323
- */
324
- declare class DiscoApiError extends DiscoError {
325
- readonly status: number;
326
- readonly statusText: string;
327
- readonly body: unknown;
328
- constructor(message: string, info: {
329
- status: number;
330
- statusText: string;
331
- body?: unknown;
332
- });
333
- }
334
- /**
335
- * Thrown when request or response data fails schema validation.
336
- *
337
- * Wraps the underlying Zod `ZodError` and the offending value for debugging,
338
- * but presents a plain message so consumers never have to import or
339
- * pattern-match on Zod's own types. `cause` is typed as the common `Error`
340
- * base so Zod's types stay out of the public surface; both clients validate
341
- * with `zod/v4`, so narrow `cause` to its `ZodError` for the structured issues,
342
- * or read `rawValue` for what was being validated.
343
- */
344
- declare class DiscoValidationError extends DiscoError {
345
- /** The underlying Zod error (a `ZodError`; narrow to read `.issues`). */
346
- readonly cause: Error;
347
- /** The value that failed validation. */
348
- readonly rawValue: unknown;
349
- constructor(message: string, cause: Error, rawValue: unknown);
350
- }
351
- /**
352
- * Thrown when a request never completes — a network failure, DNS error,
353
- * connection reset, timeout, etc. A cancellation via `AbortSignal` is excluded:
354
- * the native `AbortError` propagates as-is (see {@link isAbortError}).
355
- */
356
- declare class DiscoNetworkError extends DiscoError {
357
- /** The underlying transport error (typically a `TypeError` from `fetch`). */
358
- readonly cause: unknown;
359
- constructor(message: string, cause: unknown);
360
- }
361
- //#endregion
362
- export { DisplayMode as A, OfferMetadata as C, RecommendationsRequest as D, RecommendationGroupProperty as E, View as F, SdkIdentity as I, PlatformType as M, SubView as N, RecommendationsResponse as O, Title as P, OfferDisclosureDetails as S, RecommendationGroupEntry as T, Advertiser as _, BrandClickInitiatingTarget as a, OfferAsset as b, BrandVisibilityEventType as c, EventPlacementDetails as d, EventTracker as f, WidgetEventType as g, ProductProperties as h, DiscoValidationError as i, Gender as j, RunningExperiment as k, ElementClickInitiatingTarget as l, ProductEventType as m, DiscoError as n, BrandDisplayInitiatingTarget as o, ProductDisplayInitiatingTarget as p, DiscoNetworkError as r, BrandProperties as s, DiscoApiError as t, EventPayload as u, Footer as v, Recommendation as w, OfferCtaDetails as x, Offer as y };
363
- //# sourceMappingURL=errors-DpKOKpT8.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"errors-DpKOKpT8.d.ts","names":[],"sources":["../src/sdkIdentity.ts","../src/api/generated/recommendations/types.gen.ts","../src/external/recommendations.ts","../src/types.ts","../src/errors.ts"],"mappings":";;KAGY,WAAA;EACV,IAAA;EACA,OAAO;AAAA;;;;;;KCydG,WAAA;;;;KAyKA,MAAA;;;;KAgMA,YAAA;;;;;;KAiTA,OAAA;;;;KAUA,KAAA;;;;;;KAyBA,IAAA;;;AA7rBW;AAyKvB;;;;AAzKuB,KChcX,iBAAA;EACV,IAAA,UDwyBsB;ECtyBtB,OAAO;AAAA;ADulCT;;;;AAAA,KCtkCK,UAAA;EACH,SAAA;EACA,eAAA;EACA,sBAAA;EACA,SAAA;EACA,aAAA;EACA,YAAA,GAAe,YAAY,EDmmCb;ECjmCd,QAAA;EACA,UAAA;AAAA;AAAA,KAGG,WAAA;EACH,KAAA,GAAQ,KAAA;EACR,SAAA;EACA,QAAA;EACA,KAAA;EACA,MAAA,GAAS,MAAM,EApCf;EAsCA,GAAA,WAnBG;EAqBH,GAAA;AAAA;;;;;;KAQG,WAAA,IACA,WAAA;EAAgB,KAAA;AAAA,MAChB,WAAA;EAAgB,SAAA;AAAA,MAChB,WAAA;EAAgB,YAAA;AAAA,MAChB,WAAA;EAAgB,KAAA;AAAA;AAAA,KAET,WAAA;EACV,MAAA,WAvBA;EAyBA,YAAY;AAAA;AAAA,KAGT,gBAAA;EACH,WAAA,EAAa,WAAA;EACb,IAAA,EAAM,IAAA;EACN,OAAA,GAAU,OAAA;EACV,QAAA;AAAA;AAAA,KAGU,YAAA;EACV,OAAA;EACA,WAAA;EACA,WAAA,GAAc,WAAW;AAAA;AAAA,KAGtB,kBAAA;EACH,WAAA;EACA,MAAM;AAAA;AAAA,KAGI,QAAA;EACV,IAAA;EACA,IAAA,WA/BmB;EAiCnB,OAAA,YAAmB,MAAA;EACnB,QAAA;EACA,WAAA;EACA,SAAA;EACA,WAAA,GAAc,WAAA;EACd,UAAA,GAAa,kBAAA;AAAA;AAAA,KAGV,OAAA;EACH,YAAA;EACA,YAAA;EACA,IAAA;EACA,KAAA;EACA,GAAA;EACA,KAAA;EACA,WAAA;AAAA;;;;;;KAQG,cAAA,GAAiB,MAAM;AAAA,KAEhB,sBAAA;EACV,WAAA,EAAa,WAAA;EACb,gBAAA,EAAkB,gBAAA;EAClB,YAAA,GAAe,YAAA;EACf,SAAA,GAAY,QAAA;EACZ,UAAA,GAAa,UAAA;EACb,cAAA,GAAiB,cAAA;EACjB,QAAA,GAAW,OAAA;EACX,OAAA,GAAU,OAAA;EACV,kBAAA,GAAqB,iBAAA;AAAA;AAAA,KAUX,uBAAA;EACV,SAAA,UA1DA;EA4DA,eAAA,EAAiB,MAAA,SAAe,cAAA,GA3DlB;EA6Dd,oBAAA,EAAsB,MAAA,SAAe,wBAAA,KA7DZ;EA+DzB,6BAAA,GAAgC,MAAA,SAAe,2BAAA;EAC/C,kBAAA,GAAqB,iBAAA;EACrB,MAAA,EAAQ,MAAA;AAAA;AAAA,KAGE,cAAA;EACV,UAAA,EAAY,UAAA;EACZ,KAAA,EAAO,KAAK;AAAA;AAAA,KAGF,wBAAA;EACV,cAAA;EACA,WAAA;EACA,OAAA;EACA,YAAA;AAAA;AAAA,KAGU,2BAAA;EACV,OAAA;EACA,WAAW;AAAA;AAAA,KAGD,UAAA;EACV,EAAA;EACA,IAAA;EACA,OAAA;EACA,WAAA;AAAA;AAAA,KAGU,KAAA;EACV,EAAA;EACA,OAAA;EACA,UAAA;EACA,WAAA,EAAa,MAAA;EACb,SAAA;EACA,UAAA,EAAY,eAAA;EACZ,MAAA,EAAQ,UAAA;EACR,QAAA,EAAU,aAAA;EACV,iBAAA,EAAmB,sBAAA;AAAA;AAAA,KAGT,eAAA;EACV,UAAA;EACA,WAAA;EACA,cAAA;EACA,iBAAA;EACA,kBAAA;AAAA;AAAA,KAGU,UAAA;EA7EgB,8DA+E1B,SAAA;EACA,QAAA;EACA,cAAA;EACA,EAAA;EACA,SAAA;EACA,sBAAA;AAAA;;KAIU,aAAA;EACN,IAAA;EAAoB,IAAA;EAAc,UAAA;AAAA;EAClC,IAAA;EAAuB,UAAA;AAAA;AAAA,KAEjB,sBAAA;EACV,IAAA;EACA,SAAA;EACA,OAAA;AAAA;AAAA,KAGU,MAAA;EACV,kBAAA;IACE,IAAA;IACA,YAAA;IACA,SAAA;EAAA;EAEF,aAAA;IACE,IAAA;IACA,SAAA;EAAA;AAAA;;;;AF/OJ;;KGAY,0BAAA;;AHEH;;KGMG,4BAAA;;AFmdZ;;KErcY,4BAAA;;AFqcW;AAyKvB;KEzmBY,8BAAA;;;AFymBM;AAgMlB;;;KEjyBY,eAAA;EACV,OAAA;EACA,YAAA;EACA,WAAA;AAAA;AAAA,KAGU,iBAAA;EACV,SAAS;AAAA;AAAA,KAGC,eAAA;AAAA,KAEA,wBAAA;AAAA,KAEA,gBAAA;AF8kCK;AAyBjB;;;AAzBiB,KErkCL,qBAAA;EACV,WAAA;EACA,IAAA;EACA,QAAA;AAAA;ADlCF;;;;AAGS;AAW+D;;;;;;;;;;;KCuC5D,YAAA;EACV,KAAA,GAAQ,KAAA,EAAO,YAAY;AAAA;AAAA,KAGjB,YAAA;EACN,IAAA,EAAM,eAAA;EAAiB,SAAA,GAAY,qBAAA;AAAA;EAEnC,IAAA,EAAM,wBAAA;EACN,KAAA,EAAO,eAAA;EACP,MAAA,EAAQ,4BAAA;EACR,SAAA,GAAY,qBAAA;AAAA;EAGZ,IAAA;EACA,KAAA,EAAO,eAAA;EACP,MAAA,EAAQ,0BAAA;EACR,OAAA;EACA,SAAA,GAAY,qBAAA;AAAA;EAGZ,IAAA;EACA,MAAA,EAAQ,4BAAA;EACR,KAAA,GAAQ,eAAA;EACR,SAAA,GAAY,qBAAA;AAAA;EAGZ,IAAA,EAAM,gBAAA;EACN,OAAA,EAAS,iBAAA;EACT,KAAA,EAAO,eAAA;EACP,MAAA,EAAQ,8BAAA;EACR,SAAA,GAAY,qBAAA;AAAA;;;;AH9GlB;;;;AAES;;;uBIGa,UAAA,SAAmB,KAAK;;;;AHsdvB;AAyKvB;cGxnBa,aAAA,SAAsB,UAAU;EAAA,SAClC,MAAA;EAAA,SACA,UAAA;EAAA,SACA,IAAA;cAGP,OAAA,UACA,IAAA;IACE,MAAA;IACA,UAAA;IACA,IAAA;EAAA;AAAA;;;;AH+lCa;AAUnB;;;;AAAiB;AAyBjB;cG7mCa,oBAAA,SAA6B,UAAA;;WAE/B,KAAA,EAAO,KAAA;EH2mCF;EAAA,SGzmCL,QAAA;cAEG,OAAA,UAAiB,KAAA,EAAO,KAAA,EAAO,QAAA;AAAA;AFtB7C;;;;AAGS;AAHT,cEmCa,iBAAA,SAA0B,UAAU;EFflC;EAAA,SEiBJ,KAAA;cAEG,OAAA,UAAiB,KAAA;AAAA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","names":[],"sources":["../src/external/DiscoClient.ts","../src/events/dedupe.ts"],"mappings":";;;AAkCA;;;;;AAAA,KAAY,iBAAA;EACV,MAAA;EAWA;;;;EANA,OAAA;EAQiB;AAGnB;;;EANE,UAAA;EACA,KAAA,UAAe,KAAA,EAUL;EARV,GAAA,GAAM,WAAW;AAAA;AAAA,KAGP,yBAAA;EAOU,uEALpB,MAAA,GAAS,WAAW;AAAA;AAAA,KAGV,4BAAA;EAWW,8EATrB,KAAA,UAAe,KAAK;AAAA;;;;AASC;KAFX,0BAAA;EACV,IAAA,EAAM,uBAAA;EACN,OAAA,EAAS,YAAY;AAAA;;;;;;;;;;;;;;cAgBV,WAAA;EAAA;MAMP,OAAA,CAAA;cAIQ,MAAA,EAAQ,iBAAA;EAAR;;;;;;;;;;EA8BZ,kBAAA,GACE,OAAA,EAAS,sBAAA,EACT,OAAA,GAAU,yBAAA,KACT,OAAA,CAAQ,uBAAA;EAmDC;;;;EAFZ,6BAAA,GACE,OAAA,EAAS,sBAAA,EACT,OAAA,GAAU,yBAAA,GAA4B,4BAAA,KACrC,OAAA,CAAQ,0BAAA;EAqBX;;;;;;AAGe;;;;ACrLjB;EDkLE,qBAAA,GACE,SAAA,UACA,OAAA,GAAU,4BAAA,KACT,YAAA;AAAA;;;;;AAxKL;;;;;;iBCbgB,oBAAA,CAAqB,KAAA,EAAO,YAAA,GAAe,YAAY"}