@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.
- package/README.md +14 -12
- package/dist/TrackingManager.d.ts +64 -0
- package/dist/TrackingManager.d.ts.map +1 -0
- package/dist/TrackingManager.js +114 -0
- package/dist/TrackingManager.js.map +1 -0
- package/dist/api/generated/events/client/client.gen.js +176 -0
- package/dist/api/generated/events/client/client.gen.js.map +1 -0
- package/dist/api/generated/events/client/utils.gen.js +179 -0
- package/dist/api/generated/events/client/utils.gen.js.map +1 -0
- package/dist/api/generated/events/client.gen.js +8 -0
- package/dist/api/generated/events/client.gen.js.map +1 -0
- package/dist/api/generated/events/core/auth.gen.js +12 -0
- package/dist/api/generated/events/core/auth.gen.js.map +1 -0
- package/dist/api/generated/events/core/bodySerializer.gen.js +6 -0
- package/dist/api/generated/events/core/bodySerializer.gen.js.map +1 -0
- package/dist/api/generated/events/core/pathSerializer.gen.js +82 -0
- package/dist/api/generated/events/core/pathSerializer.gen.js.map +1 -0
- package/dist/api/generated/events/core/serverSentEvents.gen.js +95 -0
- package/dist/api/generated/events/core/serverSentEvents.gen.js.map +1 -0
- package/dist/api/generated/events/core/utils.gen.js +78 -0
- package/dist/api/generated/events/core/utils.gen.js.map +1 -0
- package/dist/api/generated/events/sdk.gen.js +31 -0
- package/dist/api/generated/events/sdk.gen.js.map +1 -0
- package/dist/api/generated/events/zod.gen.js +197 -0
- package/dist/api/generated/events/zod.gen.js.map +1 -0
- package/dist/api/generated/recommendations/client/client.gen.js +176 -0
- package/dist/api/generated/recommendations/client/client.gen.js.map +1 -0
- package/dist/api/generated/recommendations/client/utils.gen.js +179 -0
- package/dist/api/generated/recommendations/client/utils.gen.js.map +1 -0
- package/dist/api/generated/recommendations/client.gen.js +8 -0
- package/dist/api/generated/recommendations/client.gen.js.map +1 -0
- package/dist/api/generated/recommendations/core/auth.gen.js +12 -0
- package/dist/api/generated/recommendations/core/auth.gen.js.map +1 -0
- package/dist/api/generated/recommendations/core/bodySerializer.gen.js +6 -0
- package/dist/api/generated/recommendations/core/bodySerializer.gen.js.map +1 -0
- package/dist/api/generated/recommendations/core/pathSerializer.gen.js +82 -0
- package/dist/api/generated/recommendations/core/pathSerializer.gen.js.map +1 -0
- package/dist/api/generated/recommendations/core/serverSentEvents.gen.js +95 -0
- package/dist/api/generated/recommendations/core/serverSentEvents.gen.js.map +1 -0
- package/dist/api/generated/recommendations/core/utils.gen.js +78 -0
- package/dist/api/generated/recommendations/core/utils.gen.js.map +1 -0
- package/dist/api/generated/recommendations/sdk.gen.js +35 -0
- package/dist/api/generated/recommendations/sdk.gen.js.map +1 -0
- package/dist/api/generated/recommendations/types.gen.d.ts +32 -0
- package/dist/api/generated/recommendations/types.gen.d.ts.map +1 -0
- package/dist/api/generated/recommendations/zod.gen.js +407 -0
- package/dist/api/generated/recommendations/zod.gen.js.map +1 -0
- package/dist/api/index.js +60 -0
- package/dist/api/index.js.map +1 -0
- package/dist/apiKey.js +13 -0
- package/dist/apiKey.js.map +1 -0
- package/dist/config.js +38 -0
- package/dist/config.js.map +1 -0
- package/dist/env.d.ts +5 -0
- package/dist/env.d.ts.map +1 -0
- package/dist/errors.d.ts +56 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +76 -0
- package/dist/errors.js.map +1 -0
- package/dist/events/dedupe.d.ts +15 -0
- package/dist/events/dedupe.d.ts.map +1 -0
- package/dist/events/dedupe.js +34 -0
- package/dist/events/dedupe.js.map +1 -0
- package/dist/events/eventMapping.js +88 -0
- package/dist/events/eventMapping.js.map +1 -0
- package/dist/external/DiscoClient.d.ts +88 -0
- package/dist/external/DiscoClient.d.ts.map +1 -0
- package/dist/external/DiscoClient.js +122 -0
- package/dist/external/DiscoClient.js.map +1 -0
- package/dist/external/recommendations.d.ts +186 -0
- package/dist/external/recommendations.d.ts.map +1 -0
- package/dist/external/recommendationsTransforms.js +209 -0
- package/dist/external/recommendationsTransforms.js.map +1 -0
- package/dist/index.d.ts +8 -97
- package/dist/index.js +3 -1769
- package/dist/internal/InternalDiscoClient.d.ts +129 -0
- package/dist/internal/InternalDiscoClient.d.ts.map +1 -0
- package/dist/internal/InternalDiscoClient.js +137 -0
- package/dist/internal/InternalDiscoClient.js.map +1 -0
- package/dist/internal/denormalize.d.ts +18 -0
- package/dist/internal/denormalize.d.ts.map +1 -0
- package/dist/internal/denormalize.js +49 -0
- package/dist/internal/denormalize.js.map +1 -0
- package/dist/internal/recommendations.d.ts +88 -0
- package/dist/internal/recommendations.d.ts.map +1 -0
- package/dist/internal/recommendationsMapper.js +68 -0
- package/dist/internal/recommendationsMapper.js.map +1 -0
- package/dist/internal/recommendationsRequestMapper.js +114 -0
- package/dist/internal/recommendationsRequestMapper.js.map +1 -0
- package/dist/internal/screens.d.ts +77 -0
- package/dist/internal/screens.d.ts.map +1 -0
- package/dist/internal/screens.js +79 -0
- package/dist/internal/screens.js.map +1 -0
- package/dist/internal.d.ts +11 -400
- package/dist/internal.js +5 -564
- package/dist/lib/case.js +26 -0
- package/dist/lib/case.js.map +1 -0
- package/dist/lib/http.js +21 -0
- package/dist/lib/http.js.map +1 -0
- package/dist/lib/primitives.js +23 -0
- package/dist/lib/primitives.js.map +1 -0
- package/dist/lib/schemas.js +25 -0
- package/dist/lib/schemas.js.map +1 -0
- package/dist/package.js +7 -0
- package/dist/package.js.map +1 -0
- package/dist/sdkIdentity.d.ts +9 -0
- package/dist/sdkIdentity.d.ts.map +1 -0
- package/dist/sdkIdentity.js +16 -0
- package/dist/sdkIdentity.js.map +1 -0
- package/dist/types.d.ts +91 -0
- package/dist/types.d.ts.map +1 -0
- package/package.json +3 -3
- package/dist/errors-DpKOKpT8.d.ts +0 -363
- package/dist/errors-DpKOKpT8.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/internal.d.ts.map +0 -1
- package/dist/internal.js.map +0 -1
- package/dist/recommendationsTransforms-D_E4xU1d.js +0 -748
- package/dist/recommendationsTransforms-D_E4xU1d.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,97 +1,8 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
type DiscoClientConfig = {
|
|
10
|
-
apiKey: string;
|
|
11
|
-
/**
|
|
12
|
-
* Absolute HTTP(S) gateway root, without a query or fragment. The SDK appends
|
|
13
|
-
* `/recommendations` and `/events`. Defaults to `https://partners.disconetwork.com`.
|
|
14
|
-
*/
|
|
15
|
-
baseUrl?: string;
|
|
16
|
-
/**
|
|
17
|
-
* Value for the required `X-API-Version` header. Defaults to
|
|
18
|
-
* `DEFAULT_API_VERSION` (see `config.ts`).
|
|
19
|
-
*/
|
|
20
|
-
apiVersion?: string;
|
|
21
|
-
fetch?: typeof fetch; /** SDK/renderer identity. Defaults to this core package's name and version. */
|
|
22
|
-
sdk?: SdkIdentity;
|
|
23
|
-
};
|
|
24
|
-
type GetRecommendationsOptions = {
|
|
25
|
-
/** Forwarded to `fetch` so consumers can cancel in-flight requests. */signal?: AbortSignal;
|
|
26
|
-
};
|
|
27
|
-
type CreateTrackingManagerOptions = {
|
|
28
|
-
/** Override the fetch used by the tracker. Defaults to the client's fetch. */fetch?: typeof fetch;
|
|
29
|
-
};
|
|
30
|
-
/**
|
|
31
|
-
* Result of `getRecommendationsWithTracker`: the mapped response plus a tracker
|
|
32
|
-
* already bound to its session.
|
|
33
|
-
*/
|
|
34
|
-
type RecommendationsWithTracker = {
|
|
35
|
-
data: RecommendationsResponse;
|
|
36
|
-
tracker: EventTracker;
|
|
37
|
-
};
|
|
38
|
-
/**
|
|
39
|
-
* Typed client for the Disco recommendations API — calls
|
|
40
|
-
* `disco-recommendations-api` **directly** (no proxy) at
|
|
41
|
-
* `/recommendations` on the configured gateway (production by default).
|
|
42
|
-
*
|
|
43
|
-
* This is the recommended, partner-facing client. It maps the friendly
|
|
44
|
-
* camelCase request into the rec-api wire body (sending `x-api-key` +
|
|
45
|
-
* `X-API-Version`) and recases the response into camelCase.
|
|
46
|
-
* Validation is performed by the generated SDK. The wire
|
|
47
|
-
* format is fully encapsulated.
|
|
48
|
-
*
|
|
49
|
-
* Renderer-agnostic: plain HTTP, no React dependency.
|
|
50
|
-
*/
|
|
51
|
-
declare class DiscoClient {
|
|
52
|
-
#private;
|
|
53
|
-
get baseUrl(): string;
|
|
54
|
-
constructor(config: DiscoClientConfig);
|
|
55
|
-
/**
|
|
56
|
-
* Fetch recommendations for the given request.
|
|
57
|
-
*
|
|
58
|
-
* Maps the request to the wire body, POSTs it, then recases the response to
|
|
59
|
-
* camelCase (keeping the API's normalized shape). The generated SDK validates
|
|
60
|
-
* both sides. Throws `DiscoValidationError` on a request/response schema
|
|
61
|
-
* failure, `DiscoApiError` on a non-2xx response, and `DiscoNetworkError` if
|
|
62
|
-
* the request can't reach the server. An aborted request rejects with the
|
|
63
|
-
* native `AbortError`.
|
|
64
|
-
*/
|
|
65
|
-
getRecommendations: (request: RecommendationsRequest, options?: GetRecommendationsOptions) => Promise<RecommendationsResponse>;
|
|
66
|
-
/**
|
|
67
|
-
* Fetch recommendations and create a session-bound events tracker in one
|
|
68
|
-
* call. The tracker inherits this client's API key and base URL.
|
|
69
|
-
*/
|
|
70
|
-
getRecommendationsWithTracker: (request: RecommendationsRequest, options?: GetRecommendationsOptions & CreateTrackingManagerOptions) => Promise<RecommendationsWithTracker>;
|
|
71
|
-
/**
|
|
72
|
-
* Create an events tracker bound to a recommendations session (the
|
|
73
|
-
* `sessionId` from a `getRecommendations` response). Posts to the external
|
|
74
|
-
* `/events` endpoint with this client's `x-api-key`, via the generated events
|
|
75
|
-
* SDK (`eventsPost`).
|
|
76
|
-
*
|
|
77
|
-
* This is the **raw** tracker — it sends every call, fire-and-forget (never
|
|
78
|
-
* throws; failures are logged). Impression dedup is a render-lifecycle policy
|
|
79
|
-
* applied a layer up (the React layer wraps this with `withImpressionDedupe`),
|
|
80
|
-
* not baked into the core client.
|
|
81
|
-
*/
|
|
82
|
-
createTrackingManager: (sessionId: string, options?: CreateTrackingManagerOptions) => EventTracker;
|
|
83
|
-
}
|
|
84
|
-
//#endregion
|
|
85
|
-
//#region src/events/dedupe.d.ts
|
|
86
|
-
/**
|
|
87
|
-
* Wrap an {@link EventTracker} so repeat impressions are suppressed within the
|
|
88
|
-
* session: a given (event type, insertionId) is forwarded once, then dropped.
|
|
89
|
-
*
|
|
90
|
-
* Dedup is a delivery *policy*, not transport — kept as an explicit, opt-in
|
|
91
|
-
* decorator so suppression is never a surprise. State (the seen-set) lives in
|
|
92
|
-
* the wrapper; create one per session-bound tracker to scope dedup per session.
|
|
93
|
-
*/
|
|
94
|
-
declare function withImpressionDedupe(inner: EventTracker): EventTracker;
|
|
95
|
-
//#endregion
|
|
96
|
-
export { type Advertiser, type BrandClickInitiatingTarget, type BrandDisplayInitiatingTarget, type BrandProperties, type BrandVisibilityEventType, DiscoApiError, DiscoClient, type DiscoClientConfig, DiscoError, DiscoNetworkError, DiscoValidationError, type DisplayMode, type ElementClickInitiatingTarget, type EventPayload, type EventPlacementDetails, type EventTracker, type Footer, type Gender, type Offer, type OfferAsset, type OfferCtaDetails, type OfferDisclosureDetails, type OfferMetadata, type PlatformType, type ProductDisplayInitiatingTarget, type ProductEventType, type Recommendation, type RecommendationGroupEntry, type RecommendationGroupProperty, type RecommendationsRequest, type RecommendationsResponse, type RunningExperiment, type SdkIdentity, type SubView, type Title, type View, type WidgetEventType, withImpressionDedupe };
|
|
97
|
-
//# sourceMappingURL=index.d.ts.map
|
|
1
|
+
import { SdkIdentity } from "./sdkIdentity.js";
|
|
2
|
+
import { DisplayMode, Gender, PlatformType, SubView, Title, View } from "./api/generated/recommendations/types.gen.js";
|
|
3
|
+
import { Advertiser, Footer, Offer, OfferAsset, OfferCtaDetails, OfferDisclosureDetails, OfferMetadata, Recommendation, RecommendationGroupEntry, RecommendationGroupProperty, RecommendationsRequest, RecommendationsResponse, RunningExperiment } from "./external/recommendations.js";
|
|
4
|
+
import { BrandClickInitiatingTarget, BrandDisplayInitiatingTarget, BrandProperties, BrandVisibilityEventType, ElementClickInitiatingTarget, EventPayload, EventPlacementDetails, EventTracker, ProductDisplayInitiatingTarget, ProductEventType, WidgetEventType } from "./types.js";
|
|
5
|
+
import { DiscoClient, DiscoClientConfig } from "./external/DiscoClient.js";
|
|
6
|
+
import { DiscoApiError, DiscoError, DiscoNetworkError, DiscoValidationError } from "./errors.js";
|
|
7
|
+
import { withImpressionDedupe } from "./events/dedupe.js";
|
|
8
|
+
export { type Advertiser, type BrandClickInitiatingTarget, type BrandDisplayInitiatingTarget, type BrandProperties, type BrandVisibilityEventType, DiscoApiError, DiscoClient, type DiscoClientConfig, DiscoError, DiscoNetworkError, DiscoValidationError, type DisplayMode, type ElementClickInitiatingTarget, type EventPayload, type EventPlacementDetails, type EventTracker, type Footer, type Gender, type Offer, type OfferAsset, type OfferCtaDetails, type OfferDisclosureDetails, type OfferMetadata, type PlatformType, type ProductDisplayInitiatingTarget, type ProductEventType, type Recommendation, type RecommendationGroupEntry, type RecommendationGroupProperty, type RecommendationsRequest, type RecommendationsResponse, type RunningExperiment, type SdkIdentity, type SubView, type Title, type View, type WidgetEventType, withImpressionDedupe };
|