@picked/analytics 0.0.1-dev.1789541668638 → 0.0.1-next.2
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 +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/plugins/analytics/index.js +1 -1
- package/dist/esm/index.js +277 -2
- package/dist/esm/plugins/analytics/index.js +122 -127
- package/dist/types/events/app_close.d.ts +3 -3
- package/dist/types/events/app_close.d.ts.map +1 -1
- package/dist/types/events/app_load.d.ts +3 -3
- package/dist/types/events/app_load.d.ts.map +1 -1
- package/dist/types/events/app_open.d.ts +3 -3
- package/dist/types/events/app_open.d.ts.map +1 -1
- package/dist/types/events/cart_add.d.ts +3 -4
- package/dist/types/events/cart_add.d.ts.map +1 -1
- package/dist/types/events/cart_remove.d.ts +3 -4
- package/dist/types/events/cart_remove.d.ts.map +1 -1
- package/dist/types/events/checkout_complete.d.ts +3 -4
- package/dist/types/events/checkout_complete.d.ts.map +1 -1
- package/dist/types/events/checkout_start.d.ts +3 -4
- package/dist/types/events/checkout_start.d.ts.map +1 -1
- package/dist/types/events/experience_load.d.ts +3 -3
- package/dist/types/events/experience_load.d.ts.map +1 -1
- package/dist/types/events/field_validation_error.d.ts +3 -3
- package/dist/types/events/field_validation_error.d.ts.map +1 -1
- package/dist/types/events/form_submit.d.ts +3 -3
- package/dist/types/events/form_submit.d.ts.map +1 -1
- package/dist/types/events/form_submit_error.d.ts +3 -3
- package/dist/types/events/form_submit_error.d.ts.map +1 -1
- package/dist/types/events/form_submit_success.d.ts +3 -3
- package/dist/types/events/form_submit_success.d.ts.map +1 -1
- package/dist/types/events/index.d.ts +13 -20
- package/dist/types/events/index.d.ts.map +1 -1
- package/dist/types/events/interaction/back.d.ts +3 -3
- package/dist/types/events/interaction/back.d.ts.map +1 -1
- package/dist/types/events/interaction/backspace.d.ts +3 -3
- package/dist/types/events/interaction/backspace.d.ts.map +1 -1
- package/dist/types/events/interaction/click.d.ts +3 -3
- package/dist/types/events/interaction/click.d.ts.map +1 -1
- package/dist/types/events/interaction/copy.d.ts +3 -3
- package/dist/types/events/interaction/copy.d.ts.map +1 -1
- package/dist/types/events/interaction/drag.d.ts +3 -3
- package/dist/types/events/interaction/drag.d.ts.map +1 -1
- package/dist/types/events/interaction/forward.d.ts +3 -3
- package/dist/types/events/interaction/forward.d.ts.map +1 -1
- package/dist/types/events/interaction/mouse_shake.d.ts +3 -3
- package/dist/types/events/interaction/mouse_shake.d.ts.map +1 -1
- package/dist/types/events/interaction/offline.d.ts +3 -3
- package/dist/types/events/interaction/offline.d.ts.map +1 -1
- package/dist/types/events/interaction/online.d.ts +3 -3
- package/dist/types/events/interaction/online.d.ts.map +1 -1
- package/dist/types/events/interaction/page_hidden.d.ts +3 -3
- package/dist/types/events/interaction/page_hidden.d.ts.map +1 -1
- package/dist/types/events/interaction/page_hide.d.ts +3 -3
- package/dist/types/events/interaction/page_hide.d.ts.map +1 -1
- package/dist/types/events/interaction/page_show.d.ts +3 -3
- package/dist/types/events/interaction/page_show.d.ts.map +1 -1
- package/dist/types/events/interaction/page_visible.d.ts +3 -3
- package/dist/types/events/interaction/page_visible.d.ts.map +1 -1
- package/dist/types/events/interaction/paste.d.ts +3 -3
- package/dist/types/events/interaction/paste.d.ts.map +1 -1
- package/dist/types/events/interaction/rapid_click.d.ts +3 -3
- package/dist/types/events/interaction/rapid_click.d.ts.map +1 -1
- package/dist/types/events/interaction/rapid_scroll.d.ts +3 -3
- package/dist/types/events/interaction/rapid_scroll.d.ts.map +1 -1
- package/dist/types/events/interaction/resize.d.ts +3 -3
- package/dist/types/events/interaction/resize.d.ts.map +1 -1
- package/dist/types/events/interaction/right_click.d.ts +3 -3
- package/dist/types/events/interaction/right_click.d.ts.map +1 -1
- package/dist/types/events/interaction/scroll.d.ts +3 -3
- package/dist/types/events/interaction/scroll.d.ts.map +1 -1
- package/dist/types/events/interaction/unload.d.ts +3 -3
- package/dist/types/events/interaction/unload.d.ts.map +1 -1
- package/dist/types/events/interaction/video_pause.d.ts +3 -4
- package/dist/types/events/interaction/video_pause.d.ts.map +1 -1
- package/dist/types/events/interaction/video_play.d.ts +3 -4
- package/dist/types/events/interaction/video_play.d.ts.map +1 -1
- package/dist/types/events/lead_capture.d.ts +3 -3
- package/dist/types/events/lead_capture.d.ts.map +1 -1
- package/dist/types/events/modal_close.d.ts +3 -3
- package/dist/types/events/modal_close.d.ts.map +1 -1
- package/dist/types/events/modal_open.d.ts +3 -3
- package/dist/types/events/modal_open.d.ts.map +1 -1
- package/dist/types/events/page_view.d.ts +3 -4
- package/dist/types/events/page_view.d.ts.map +1 -1
- package/dist/types/events/product_list_view.d.ts +3 -4
- package/dist/types/events/product_list_view.d.ts.map +1 -1
- package/dist/types/events/product_select.d.ts +3 -3
- package/dist/types/events/product_select.d.ts.map +1 -1
- package/dist/types/events/product_view_details.d.ts +3 -4
- package/dist/types/events/product_view_details.d.ts.map +1 -1
- package/dist/types/events/recommendation_present.d.ts +3 -3
- package/dist/types/events/recommendation_present.d.ts.map +1 -1
- package/dist/types/events/search_results_list_view.d.ts +3 -3
- package/dist/types/events/search_results_list_view.d.ts.map +1 -1
- package/dist/types/events/step_complete.d.ts +3 -3
- package/dist/types/events/step_complete.d.ts.map +1 -1
- package/dist/types/events/step_enter.d.ts +3 -3
- package/dist/types/events/step_enter.d.ts.map +1 -1
- package/dist/types/events/step_submit.d.ts +3 -3
- package/dist/types/events/step_submit.d.ts.map +1 -1
- package/dist/types/events/step_submit_error.d.ts +3 -3
- package/dist/types/events/step_submit_error.d.ts.map +1 -1
- package/dist/types/events/step_submit_success.d.ts +3 -3
- package/dist/types/events/step_submit_success.d.ts.map +1 -1
- package/dist/types/events/wishlist_add.d.ts +3 -3
- package/dist/types/events/wishlist_add.d.ts.map +1 -1
- package/dist/types/fixtures/analytics-event.d.ts +16 -0
- package/dist/types/fixtures/analytics-event.d.ts.map +1 -0
- package/dist/types/helpers/element.d.ts +0 -26
- package/dist/types/helpers/element.d.ts.map +1 -1
- package/dist/types/index.d.ts +0 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/listeners/backspace.d.ts +1 -1
- package/dist/types/listeners/click.d.ts +1 -1
- package/dist/types/listeners/click.d.ts.map +1 -1
- package/dist/types/listeners/copy.d.ts +1 -1
- package/dist/types/listeners/drag.d.ts +1 -1
- package/dist/types/listeners/drag.d.ts.map +1 -1
- package/dist/types/listeners/mouse_shake.d.ts +1 -1
- package/dist/types/listeners/mouse_shake.d.ts.map +1 -1
- package/dist/types/listeners/offline.d.ts +1 -1
- package/dist/types/listeners/online.d.ts +1 -1
- package/dist/types/listeners/pagehide.d.ts +1 -1
- package/dist/types/listeners/pageshow.d.ts +1 -1
- package/dist/types/listeners/paste.d.ts +1 -1
- package/dist/types/listeners/rapid_click.d.ts +1 -1
- package/dist/types/listeners/rapid_click.d.ts.map +1 -1
- package/dist/types/listeners/rapid_scroll.d.ts +1 -1
- package/dist/types/listeners/rapid_scroll.d.ts.map +1 -1
- package/dist/types/listeners/resize.d.ts +1 -1
- package/dist/types/listeners/right_click.d.ts +1 -1
- package/dist/types/listeners/right_click.d.ts.map +1 -1
- package/dist/types/listeners/scroll.d.ts +1 -1
- package/dist/types/listeners/scroll.d.ts.map +1 -1
- package/dist/types/listeners/unload.d.ts +1 -1
- package/dist/types/listeners/video_pause.d.ts +1 -1
- package/dist/types/listeners/video_play.d.ts +1 -1
- package/dist/types/listeners/visibility.d.ts +1 -1
- package/dist/types/plugins/analytics/index.d.ts +0 -6
- package/dist/types/plugins/analytics/index.d.ts.map +1 -1
- package/dist/types/plugins/analytics/plugin.d.ts +5 -7
- package/dist/types/plugins/analytics/plugin.d.ts.map +1 -1
- package/dist/types/schemas/answer_list/1-0-0.d.ts +27 -27
- package/dist/types/schemas/answer_list/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/answer_list/index.d.ts +28 -28
- package/dist/types/schemas/answer_list/index.d.ts.map +1 -1
- package/dist/types/schemas/app/1-0-0.d.ts +15 -15
- package/dist/types/schemas/app/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/app/index.d.ts +18 -45
- package/dist/types/schemas/app/index.d.ts.map +1 -1
- package/dist/types/schemas/cvly_funnel/1-0-0.d.ts +13 -13
- package/dist/types/schemas/cvly_funnel/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/cvly_funnel/index.d.ts +14 -14
- package/dist/types/schemas/cvly_funnel/index.d.ts.map +1 -1
- package/dist/types/schemas/cvly_x/1-0-0.d.ts +19 -19
- package/dist/types/schemas/cvly_x/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/cvly_x/1-0-1.d.ts +19 -19
- package/dist/types/schemas/cvly_x/1-0-1.d.ts.map +1 -1
- package/dist/types/schemas/cvly_x/index.d.ts +38 -38
- package/dist/types/schemas/cvly_x/index.d.ts.map +1 -1
- package/dist/types/schemas/element/1-0-0.d.ts +19 -19
- package/dist/types/schemas/element/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/element/index.d.ts +20 -20
- package/dist/types/schemas/element/index.d.ts.map +1 -1
- package/dist/types/schemas/event/1-0-0.d.ts +13 -13
- package/dist/types/schemas/event/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/event/index.d.ts +14 -14
- package/dist/types/schemas/event/index.d.ts.map +1 -1
- package/dist/types/schemas/exception/1-0-0.d.ts +13 -13
- package/dist/types/schemas/exception/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/exception/index.d.ts +14 -14
- package/dist/types/schemas/exception/index.d.ts.map +1 -1
- package/dist/types/schemas/experience/1-0-0.d.ts +17 -17
- package/dist/types/schemas/experience/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/experience/index.d.ts +20 -56
- package/dist/types/schemas/experience/index.d.ts.map +1 -1
- package/dist/types/schemas/feature_list/1-0-0.d.ts +26 -26
- package/dist/types/schemas/feature_list/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/feature_list/2-0-0.d.ts +26 -26
- package/dist/types/schemas/feature_list/2-0-0.d.ts.map +1 -1
- package/dist/types/schemas/feature_list/index.d.ts +52 -52
- package/dist/types/schemas/feature_list/index.d.ts.map +1 -1
- package/dist/types/schemas/field_list/1-0-0.d.ts +37 -37
- package/dist/types/schemas/field_list/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/field_list/index.d.ts +38 -38
- package/dist/types/schemas/field_list/index.d.ts.map +1 -1
- package/dist/types/schemas/form/1-0-0.d.ts +15 -15
- package/dist/types/schemas/form/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/form/index.d.ts +16 -16
- package/dist/types/schemas/form/index.d.ts.map +1 -1
- package/dist/types/schemas/index.d.ts +0 -4
- package/dist/types/schemas/index.d.ts.map +1 -1
- package/dist/types/schemas/modal/1-0-0.d.ts +15 -15
- package/dist/types/schemas/modal/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/modal/index.d.ts +16 -16
- package/dist/types/schemas/modal/index.d.ts.map +1 -1
- package/dist/types/schemas/picked/1-0-0.d.ts +13 -13
- package/dist/types/schemas/picked/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/picked/index.d.ts +14 -14
- package/dist/types/schemas/picked/index.d.ts.map +1 -1
- package/dist/types/schemas/product_list/1-0-0.d.ts +34 -34
- package/dist/types/schemas/product_list/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/product_list/2-0-0.d.ts +65 -65
- package/dist/types/schemas/product_list/2-0-0.d.ts.map +1 -1
- package/dist/types/schemas/product_list/index.d.ts +101 -265
- package/dist/types/schemas/product_list/index.d.ts.map +1 -1
- package/dist/types/schemas/question_list/1-0-0.d.ts +37 -37
- package/dist/types/schemas/question_list/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/question_list/index.d.ts +38 -38
- package/dist/types/schemas/question_list/index.d.ts.map +1 -1
- package/dist/types/schemas/recommendation_list/1-0-0.d.ts +24 -24
- package/dist/types/schemas/recommendation_list/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/recommendation_list/index.d.ts +25 -25
- package/dist/types/schemas/recommendation_list/index.d.ts.map +1 -1
- package/dist/types/schemas/response_list/1-0-0.d.ts +27 -27
- package/dist/types/schemas/response_list/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/response_list/index.d.ts +28 -28
- package/dist/types/schemas/response_list/index.d.ts.map +1 -1
- package/dist/types/schemas/session/1-0-0.d.ts +13 -13
- package/dist/types/schemas/session/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/session/1-0-1.d.ts +14 -14
- package/dist/types/schemas/session/1-0-1.d.ts.map +1 -1
- package/dist/types/schemas/session/index.d.ts +29 -167
- package/dist/types/schemas/session/index.d.ts.map +1 -1
- package/dist/types/schemas/step/1-0-0.d.ts +15 -15
- package/dist/types/schemas/step/1-0-0.d.ts.map +1 -1
- package/dist/types/schemas/step/index.d.ts +18 -55
- package/dist/types/schemas/step/index.d.ts.map +1 -1
- package/dist/types/tracker.d.ts +2 -14
- package/dist/types/tracker.d.ts.map +1 -1
- package/dist/types/types.d.ts +29 -96
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/user-interaction.d.ts +2 -33
- package/dist/types/user-interaction.d.ts.map +1 -1
- package/dist/types/utils.d.ts +6 -217
- package/dist/types/utils.d.ts.map +1 -1
- package/dist/user-interaction-BTJxIHbv.cjs +1 -0
- package/dist/user-interaction-CZQT4H3Z.js +1131 -0
- package/package.json +25 -47
- package/dist/.tsbuildinfo +0 -1
- package/dist/src-Bg5baSBO.js +0 -1318
- package/dist/src-XGiRLTMI.cjs +0 -1
- package/dist/types/events/app_initialize.d.ts +0 -4
- package/dist/types/events/app_initialize.d.ts.map +0 -1
- package/dist/types/events/custom.d.ts +0 -29
- package/dist/types/events/custom.d.ts.map +0 -1
- package/dist/types/events/feature_decide.d.ts +0 -4
- package/dist/types/events/feature_decide.d.ts.map +0 -1
- package/dist/types/events/identify.d.ts +0 -5
- package/dist/types/events/identify.d.ts.map +0 -1
- package/dist/types/events/order_create.d.ts +0 -5
- package/dist/types/events/order_create.d.ts.map +0 -1
- package/dist/types/events/waitlist_join.d.ts +0 -4
- package/dist/types/events/waitlist_join.d.ts.map +0 -1
- package/dist/types/interaction-events.d.ts +0 -22
- package/dist/types/interaction-events.d.ts.map +0 -1
- package/dist/types/schemas/app/1-1-0.d.ts +0 -31
- package/dist/types/schemas/app/1-1-0.d.ts.map +0 -1
- package/dist/types/schemas/deployment/1-0-0.d.ts +0 -45
- package/dist/types/schemas/deployment/1-0-0.d.ts.map +0 -1
- package/dist/types/schemas/deployment/1-0-1.d.ts +0 -45
- package/dist/types/schemas/deployment/1-0-1.d.ts.map +0 -1
- package/dist/types/schemas/deployment/index.d.ts +0 -91
- package/dist/types/schemas/deployment/index.d.ts.map +0 -1
- package/dist/types/schemas/experience/1-0-1.d.ts +0 -40
- package/dist/types/schemas/experience/1-0-1.d.ts.map +0 -1
- package/dist/types/schemas/order/1-0-0.d.ts +0 -45
- package/dist/types/schemas/order/1-0-0.d.ts.map +0 -1
- package/dist/types/schemas/order/index.d.ts +0 -50
- package/dist/types/schemas/order/index.d.ts.map +0 -1
- package/dist/types/schemas/product_list/2-0-1.d.ts +0 -168
- package/dist/types/schemas/product_list/2-0-1.d.ts.map +0 -1
- package/dist/types/schemas/session/1-0-2.d.ts +0 -39
- package/dist/types/schemas/session/1-0-2.d.ts.map +0 -1
- package/dist/types/schemas/session/1-0-3.d.ts +0 -53
- package/dist/types/schemas/session/1-0-3.d.ts.map +0 -1
- package/dist/types/schemas/session/1-0-4.d.ts +0 -58
- package/dist/types/schemas/session/1-0-4.d.ts.map +0 -1
- package/dist/types/schemas/step/1-0-1.d.ts +0 -41
- package/dist/types/schemas/step/1-0-1.d.ts.map +0 -1
- package/dist/types/snowplow-plugins/url-scrub.d.ts +0 -84
- package/dist/types/snowplow-plugins/url-scrub.d.ts.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tracker.d.ts","sourceRoot":"","sources":["../../src/tracker.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"tracker.d.ts","sourceRoot":"","sources":["../../src/tracker.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAEV,oBAAoB,EAIrB,MAAM,SAAS,CAAA;AAkEhB,wBAAgB,aAAa,CAAC,EAC5B,cAAc,EACd,SAAS,EACT,KAAK,EACL,YAA+B,EAC/B,KAA0B,EAC1B,WAAkB,EAClB,gBAAuB,EACvB,YAAmB,EACnB,aAAoB,EACpB,YAAmB,EACnB,aAAoB,EACpB,WAAkB,EAClB,qBAAqB,EACrB,yBAAyB,GAC1B,EAAE,oBAAoB,yEAkCtB"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import type { AppSchema, AppUrl, CvlyFunnelSchema, CvlyFunnelUrl, CvlyXSchema, CvlyXUrl, DeploymentSchema, DeploymentUrl, ElementSchema, ElementUrl, EventSchema, EventUrl, ExceptionSchema, ExceptionUrl, ExperienceSchema, ExperienceUrl, FeatureListSchema, FeatureListUrl, FieldListSchema, FieldListUrl, FormSchema, FormUrl, ModalSchema, ModalUrl, OrderSchema, OrderUrl, PickedSchema, PickedUrl, ProductListSchema, ProductListUrl, ResponseListSchema, ResponseListUrl, SessionSchema, SessionUrl, StepSchema, StepUrl } from './schemas';
|
|
1
|
+
import { ActivityCallbackData, CommonEventProperties, SelfDescribingEvent } from '@snowplow/browser-tracker';
|
|
2
|
+
import { ExperienceStep, Field, ValidationError as FieldValidationError, FieldValue } from '@picked/client';
|
|
3
|
+
import { AnswerListSchema, AnswerListUrl, AppSchema, AppUrl, CvlyFunnelSchema, CvlyFunnelUrl, CvlyXSchema, CvlyXUrl, ElementSchema, ElementUrl, EventSchema, EventUrl, ExceptionSchema, ExceptionUrl, ExperienceSchema, ExperienceUrl, FeatureListSchema, FeatureListUrl, FieldListSchema, FieldListUrl, FormSchema, FormUrl, ModalSchema, ModalUrl, PickedSchema, PickedUrl, ProductListSchema, ProductListUrl, QuestionListSchema, QuestionListUrl, ResponseListSchema, ResponseListUrl, SessionSchema, SessionUrl, StepSchema, StepUrl } from './schemas';
|
|
5
4
|
export type SnowplowSelfDescribingEvent = SelfDescribingEvent & CommonEventProperties;
|
|
6
5
|
export type SchemaUrl<Schema extends string, Version extends string> = `iglu:dev.pckd/${Schema}/jsonschema/${Version}`;
|
|
7
6
|
export interface Context<Url extends string, Schema extends Record<string, unknown>> {
|
|
@@ -26,6 +25,7 @@ export interface SnowplowEventWithContext<EventType extends string, RequiredCont
|
|
|
26
25
|
event: TopLevelEvent<EventType>;
|
|
27
26
|
context: ConditionalContext extends ContextArray ? [...RequiredContext, ...Partial<ConditionalContext>[number][]] : RequiredContext;
|
|
28
27
|
}
|
|
28
|
+
export type AnswerListContext = Context<AnswerListUrl, AnswerListSchema>;
|
|
29
29
|
export type AppContext = Context<AppUrl, AppSchema>;
|
|
30
30
|
export type CvlyFunnelContext = Context<CvlyFunnelUrl, CvlyFunnelSchema>;
|
|
31
31
|
export type CvlyXContext = Context<CvlyXUrl, CvlyXSchema>;
|
|
@@ -36,17 +36,15 @@ export type FeatureListContext = Context<FeatureListUrl, FeatureListSchema>;
|
|
|
36
36
|
export type FieldListContext = Context<FieldListUrl, FieldListSchema>;
|
|
37
37
|
export type FormContext = Context<FormUrl, FormSchema>;
|
|
38
38
|
export type ModalContext = Context<ModalUrl, ModalSchema>;
|
|
39
|
-
export type OrderContext = Context<OrderUrl, OrderSchema>;
|
|
40
39
|
export type PickedContext = Context<PickedUrl, PickedSchema>;
|
|
41
40
|
export type ProductListContext = Context<ProductListUrl, ProductListSchema>;
|
|
41
|
+
export type QuestionListContext = Context<QuestionListUrl, QuestionListSchema>;
|
|
42
42
|
export type ResponseListContext = Context<ResponseListUrl, ResponseListSchema>;
|
|
43
43
|
export type SessionContext = Context<SessionUrl, SessionSchema>;
|
|
44
44
|
export type StepContext = Context<StepUrl, StepSchema>;
|
|
45
|
-
export type DeploymentContext = Context<DeploymentUrl, DeploymentSchema>;
|
|
46
45
|
export interface CreateTrackerOptions {
|
|
47
46
|
/**
|
|
48
|
-
*
|
|
49
|
-
* field is accepted for backwards compatibility but the value is ignored.
|
|
47
|
+
* The organization ID.
|
|
50
48
|
*/
|
|
51
49
|
organizationId?: string;
|
|
52
50
|
/**
|
|
@@ -54,137 +52,90 @@ export interface CreateTrackerOptions {
|
|
|
54
52
|
*/
|
|
55
53
|
projectId?: string;
|
|
56
54
|
/**
|
|
57
|
-
* The application ID. Defaults to
|
|
58
|
-
*
|
|
55
|
+
* The application ID. Defaults to the value of VITE_SNOWPLOW_APP_ID.
|
|
59
56
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracker-setup/initialization-options/
|
|
60
57
|
*/
|
|
61
58
|
appId?: string;
|
|
62
59
|
/**
|
|
63
|
-
* The collector
|
|
64
|
-
* collector. The host is resolved by the caller — `createTracker` reads no
|
|
65
|
-
* environment variables — so an embedder that must not reach production passes
|
|
66
|
-
* its own value.
|
|
67
|
-
*
|
|
60
|
+
* The collector URL. Defaults to the value of VITE_SNOWPLOW_COLLECTOR_URL.
|
|
68
61
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracker-setup/initialization-options/
|
|
69
62
|
*/
|
|
70
63
|
collectorUrl?: string;
|
|
71
64
|
/**
|
|
72
|
-
*
|
|
73
|
-
* `/com.snowplowanalytics.snowplow/tp2`. Set it when `collectorUrl` is the site's own
|
|
74
|
-
* origin fronting the collector through a reverse proxy, which re-attaches the canonical
|
|
75
|
-
* path upstream. Supplying a path also pins the transport to POST, since a GET would
|
|
76
|
-
* address the collector's `/i` endpoint, which the proxy does not carry.
|
|
77
|
-
*
|
|
78
|
-
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracker-setup/initialization-options/
|
|
79
|
-
*/
|
|
80
|
-
collectorPath?: string;
|
|
81
|
-
/**
|
|
82
|
-
* Enable activity tracking page pings.
|
|
83
|
-
*
|
|
65
|
+
* Enable activity tracking page pings
|
|
84
66
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/previous-versions/javascript-tracker-v3/tracking-events/#activity-tracking-page-pings
|
|
85
67
|
*/
|
|
86
68
|
trackActivity?: boolean;
|
|
87
69
|
/**
|
|
88
|
-
* Callback for activity tracking
|
|
89
|
-
*
|
|
70
|
+
* Callback for activity tracking
|
|
90
71
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/previous-versions/javascript-tracker-v3/tracking-events/#enableactivitytrackingcallback
|
|
91
72
|
*/
|
|
92
73
|
trackActivityCallback?: (data: ActivityCallbackData) => void;
|
|
93
74
|
/**
|
|
94
|
-
* Attach the page view ID to all events
|
|
95
|
-
*
|
|
75
|
+
* Attach the page view ID to all events
|
|
96
76
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/page-views/#webpage-page-view-id-context-entity
|
|
97
77
|
*/
|
|
98
78
|
trackWebPage?: boolean;
|
|
99
79
|
/**
|
|
100
|
-
* Attach the session to all events
|
|
101
|
-
*
|
|
80
|
+
* Attach the session to all events
|
|
102
81
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/session/
|
|
103
82
|
*/
|
|
104
83
|
trackSessions?: boolean;
|
|
105
84
|
/**
|
|
106
|
-
* Attach the browser context to all events
|
|
107
|
-
*
|
|
85
|
+
* Attach the browser context to all events
|
|
108
86
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/browsers/
|
|
109
87
|
*/
|
|
110
88
|
trackBrowser?: boolean;
|
|
111
89
|
/**
|
|
112
|
-
* Enable the error tracking plugin
|
|
113
|
-
*
|
|
90
|
+
* Enable the error tracking plugin
|
|
114
91
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/errors/
|
|
115
92
|
*/
|
|
116
93
|
trackErrors?: boolean;
|
|
117
94
|
/**
|
|
118
|
-
* Enable the core web vitals tracking plugin
|
|
119
|
-
*
|
|
95
|
+
* Enable the core web vitals tracking plugin
|
|
120
96
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/web-vitals/
|
|
121
97
|
*/
|
|
122
98
|
trackVitals?: boolean;
|
|
123
99
|
/**
|
|
124
|
-
* Enable the navigation performance tracking plugin
|
|
125
|
-
*
|
|
100
|
+
* Enable the navigation performance tracking plugin
|
|
126
101
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/timings/
|
|
127
102
|
*/
|
|
128
103
|
trackPerformance?: boolean;
|
|
129
104
|
/**
|
|
130
|
-
* CSS selector allowlist for button click tracking
|
|
131
|
-
*
|
|
105
|
+
* CSS selector allowlist for button click tracking
|
|
132
106
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/timings/
|
|
133
107
|
*/
|
|
134
108
|
trackButtonClickAllowList?: string[];
|
|
135
109
|
/**
|
|
136
|
-
* Filter function for button click tracking
|
|
137
|
-
*
|
|
110
|
+
* Filter function for button click tracking
|
|
138
111
|
* @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/button-click/#filter-function
|
|
139
112
|
*/
|
|
140
113
|
trackButtonClickFilter?: (element: HTMLElement) => boolean;
|
|
141
114
|
/**
|
|
142
|
-
* Parameters related to the CVLY-X environment
|
|
143
|
-
*
|
|
144
|
-
* @deprecated
|
|
115
|
+
* Parameters related to the CVLY-X environment
|
|
145
116
|
*/
|
|
146
117
|
cvlyX?: {
|
|
147
118
|
/**
|
|
148
|
-
* The Git commit SHA of the current deployment (GIT_COMMIT_SHA)
|
|
119
|
+
* The Git commit SHA of the current deployment (GIT_COMMIT_SHA)
|
|
149
120
|
*/
|
|
150
121
|
gitCommitSha?: string;
|
|
151
122
|
/**
|
|
152
|
-
* The Vercel deployment ID (VERCEL_DEPLOYMENT_ID)
|
|
123
|
+
* The Vercel deployment ID (VERCEL_DEPLOYMENT_ID)
|
|
153
124
|
*/
|
|
154
125
|
vercelDeploymentId: string;
|
|
155
126
|
/**
|
|
156
|
-
* The Vercel environment in which the application is running (e.g., production, preview, development) (VERCEL_ENV)
|
|
127
|
+
* The Vercel environment in which the application is running (e.g., production, preview, development) (VERCEL_ENV)
|
|
157
128
|
*/
|
|
158
129
|
vercelEnv: string;
|
|
159
130
|
/**
|
|
160
|
-
* The Vercel URL of the current deployment (VERCEL_URL)
|
|
131
|
+
* The Vercel URL of the current deployment (VERCEL_URL)
|
|
161
132
|
*/
|
|
162
133
|
vercelUrl: string;
|
|
163
134
|
};
|
|
164
|
-
/**
|
|
165
|
-
* Parameters related to the application deployment environment.
|
|
166
|
-
*/
|
|
167
|
-
deployment: {
|
|
168
|
-
/**
|
|
169
|
-
* The deployment environment.
|
|
170
|
-
*/
|
|
171
|
-
env: string;
|
|
172
|
-
/**
|
|
173
|
-
* The Git commit SHA of the current deployment.
|
|
174
|
-
*/
|
|
175
|
-
sha?: string;
|
|
176
|
-
/**
|
|
177
|
-
* The deployment ID.
|
|
178
|
-
*/
|
|
179
|
-
id?: string;
|
|
180
|
-
/**
|
|
181
|
-
* The host address for the deployment.
|
|
182
|
-
*/
|
|
183
|
-
host?: string;
|
|
184
|
-
};
|
|
185
135
|
}
|
|
186
136
|
export interface AnalyticsExperience {
|
|
187
137
|
id: string;
|
|
138
|
+
type: string;
|
|
188
139
|
title: string;
|
|
189
140
|
}
|
|
190
141
|
export interface AnalyticsStep {
|
|
@@ -212,7 +163,7 @@ export interface AnalyticsQuestion {
|
|
|
212
163
|
}
|
|
213
164
|
export type AnalyticsField = Field;
|
|
214
165
|
export interface AnalyticsResponse {
|
|
215
|
-
|
|
166
|
+
fieldId: string;
|
|
216
167
|
value: FieldValue | undefined;
|
|
217
168
|
}
|
|
218
169
|
export interface AnalyticsFeature {
|
|
@@ -221,13 +172,8 @@ export interface AnalyticsFeature {
|
|
|
221
172
|
key: string;
|
|
222
173
|
bucket: boolean | string;
|
|
223
174
|
}
|
|
224
|
-
export type
|
|
225
|
-
export
|
|
226
|
-
id: string;
|
|
227
|
-
checkoutToken?: string;
|
|
228
|
-
customerId?: string;
|
|
229
|
-
cartToken?: string;
|
|
230
|
-
}
|
|
175
|
+
export type FormValidationError = string;
|
|
176
|
+
export type AnalyticsException = FieldValidationError | FormValidationError;
|
|
231
177
|
export interface AnalyticsProduct {
|
|
232
178
|
itemId?: string;
|
|
233
179
|
itemName?: string;
|
|
@@ -252,21 +198,11 @@ export interface AnalyticsProduct {
|
|
|
252
198
|
promotionId?: string;
|
|
253
199
|
promotionName?: string;
|
|
254
200
|
quantity?: number | string;
|
|
255
|
-
inStock?: boolean;
|
|
256
|
-
}
|
|
257
|
-
export type AnalyticsProductList = AnalyticsProduct[] | {
|
|
258
|
-
title?: string;
|
|
259
|
-
items: AnalyticsProduct[];
|
|
260
|
-
};
|
|
261
|
-
export interface AnalyticsShopifySession {
|
|
262
|
-
clientId?: string;
|
|
263
|
-
customerId?: string;
|
|
264
|
-
checkoutToken?: string;
|
|
265
201
|
}
|
|
266
202
|
export interface AnalyticsContext {
|
|
267
203
|
sessionId?: string;
|
|
268
|
-
isUser?: boolean;
|
|
269
204
|
projectId: string;
|
|
205
|
+
organizationId: string;
|
|
270
206
|
features?: AnalyticsFeature[];
|
|
271
207
|
experience?: AnalyticsExperience;
|
|
272
208
|
step?: ExperienceStep;
|
|
@@ -274,11 +210,8 @@ export interface AnalyticsContext {
|
|
|
274
210
|
fields?: AnalyticsField[];
|
|
275
211
|
responses?: AnalyticsResponse[];
|
|
276
212
|
modal?: AnalyticsModal;
|
|
277
|
-
productList?:
|
|
213
|
+
productList?: AnalyticsProduct[];
|
|
278
214
|
exception?: AnalyticsException;
|
|
279
|
-
shopifySession?: AnalyticsShopifySession;
|
|
280
|
-
order?: AnalyticsOrder;
|
|
281
|
-
identifiers?: Record<string, string>;
|
|
282
215
|
}
|
|
283
216
|
export {};
|
|
284
217
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,cAAc,EACd,KAAK,EACL,eAAe,IAAI,oBAAoB,EACvC,UAAU,EACX,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,QAAQ,EACR,aAAa,EACb,UAAU,EACV,WAAW,EACX,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,UAAU,EACV,OAAO,EACP,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,UAAU,EACV,UAAU,EACV,OAAO,EACR,MAAM,WAAW,CAAA;AAElB,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,GAAG,qBAAqB,CAAA;AAErF,MAAM,MAAM,SAAS,CACnB,MAAM,SAAS,MAAM,EACrB,OAAO,SAAS,MAAM,IACpB,iBAAiB,MAAM,eAAe,OAAO,EAAE,CAAA;AAEnD,MAAM,WAAW,OAAO,CAAC,GAAG,SAAS,MAAM,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjF,MAAM,EAAE,GAAG,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb;AAED,KAAK,YAAY,CAAC,CAAC,SAAS,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;AAE/D,KAAK,aAAa,CAAC,IAAI,SAAS,MAAM,IAAI,YAAY,CAAC;IACrD,IAAI,EAAE,IAAI,CAAA;IACV,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAC1B,CAAC,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,WAAW,EAAE,CAAA;AAExC;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB,CACvC,SAAS,SAAS,MAAM,EACxB,eAAe,SAAS,YAAY,EACpC,kBAAkB,SAAS,YAAY,GAAG,EAAE;IAE5C,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,CAAA;IAC/B,OAAO,EAAE,kBAAkB,SAAS,YAAY,GAC5C,CAAC,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,GAC9D,eAAe,CAAA;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;AACxE,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AACnD,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;AACxE,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;AACzD,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;AAC/D,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;AACrE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;AACxE,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAA;AAC3E,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;AACrE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AACtD,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;AACzD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;AAC5D,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAA;AAC3E,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAA;AAE9E,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAA;AAC9E,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;AAC/D,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AAEtD,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAE5D;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAA;IAE1D;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAA;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAED,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAA;CAC3D;AAED,UAAU,cAAc;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,OAAO,GAAG,iBAAiB,GAAG,MAAM,CAAA;IAC1C,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;CACpC;AAED,MAAM,MAAM,cAAc,GAAG,KAAK,CAAA;AAElC,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,UAAU,GAAG,SAAS,CAAA;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,OAAO,GAAG,MAAM,CAAA;CACzB;AAED,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAA;AACxC,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,mBAAmB,CAAA;AAE3E,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC7B,UAAU,CAAC,EAAE,mBAAmB,CAAA;IAChC,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,MAAM,CAAC,EAAE,cAAc,EAAE,CAAA;IACzB,SAAS,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC/B,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAChC,SAAS,CAAC,EAAE,kBAAkB,CAAA;CAC/B"}
|
|
@@ -1,35 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
* window/document level listeners.
|
|
4
|
-
*/
|
|
5
|
-
import { type InteractionEventName } from './interaction-events';
|
|
6
|
-
import type { AnalyticsContext } from './types';
|
|
7
|
-
/**
|
|
8
|
-
* Bind the listed DOM interaction listeners to the given target. Listeners not
|
|
9
|
-
* named in `enabledEvents` are not bound; the empty list is a no-op.
|
|
10
|
-
*
|
|
11
|
-
* @param {() => AnalyticsContext} createAnalyticsContext - Factory the bound
|
|
12
|
-
* listeners call to read the current analytics context at the moment an
|
|
13
|
-
* event fires.
|
|
14
|
-
* @param {EventTarget | null} target - Event target the listeners attach to
|
|
15
|
-
* (typically an experience shadow root). When `null`, no listeners are bound.
|
|
16
|
-
* @param {readonly InteractionEventName[]} enabledEvents - Names of interaction
|
|
17
|
-
* events to enable. Defaults to every known event for backwards compatibility
|
|
18
|
-
* with direct callers that pre-date the opt-in plugin option.
|
|
19
|
-
* @example
|
|
20
|
-
* bindUserInteractionListeners(createCtx, shadowRoot, ['click', 'scroll'])
|
|
21
|
-
*/
|
|
22
|
-
export declare function bindUserInteractionListeners(createAnalyticsContext: () => AnalyticsContext, target: EventTarget | null, enabledEvents?: readonly InteractionEventName[]): void;
|
|
23
|
-
/**
|
|
24
|
-
* Bind window/document-level listeners (page visibility, online/offline, resize,
|
|
25
|
-
* unload, etc.). Caller decides when to invoke this; it is gated by the plugin's
|
|
26
|
-
* `enableDocumentListeners` option.
|
|
27
|
-
*
|
|
28
|
-
* @param {() => AnalyticsContext} createAnalyticsContext - Factory the
|
|
29
|
-
* listeners call to read the current analytics context at the moment an
|
|
30
|
-
* event fires.
|
|
31
|
-
* @example
|
|
32
|
-
* bindGlobalEventListeners(createCtx)
|
|
33
|
-
*/
|
|
1
|
+
import { AnalyticsContext } from './types';
|
|
2
|
+
export declare function bindUserInteractionListeners(createAnalyticsContext: () => AnalyticsContext, target: EventTarget | null): void;
|
|
34
3
|
export declare function bindGlobalEventListeners(createAnalyticsContext: () => AnalyticsContext): void;
|
|
35
4
|
//# sourceMappingURL=user-interaction.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"user-interaction.d.ts","sourceRoot":"","sources":["../../src/user-interaction.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"user-interaction.d.ts","sourceRoot":"","sources":["../../src/user-interaction.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C,wBAAgB,4BAA4B,CAC1C,sBAAsB,EAAE,MAAM,gBAAgB,EAC9C,MAAM,EAAE,WAAW,GAAG,IAAI,QAc3B;AAED,wBAAgB,wBAAwB,CAAC,sBAAsB,EAAE,MAAM,gBAAgB,QAQtF"}
|
package/dist/types/utils.d.ts
CHANGED
|
@@ -1,250 +1,39 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
/**
|
|
4
|
-
* Builds the Iglu URI that identifies a Snowplow schema and version.
|
|
5
|
-
*
|
|
6
|
-
* @param {string} schema - Schema name, such as `event` or `response_list`.
|
|
7
|
-
* @param {string} version - Schema version in Iglu's dash form, such as `1-0-0`.
|
|
8
|
-
* @returns {SchemaUrl} The fully qualified Iglu schema URI.
|
|
9
|
-
* @example schemaUrl('event', '1-0-0') // 'iglu:dev.pckd/event/jsonschema/1-0-0'
|
|
10
|
-
*/
|
|
1
|
+
import { AnalyticsContext, AppContext, Context, ContextArray, ExceptionContext, ExperienceContext, FeatureListContext, FieldListContext, FormContext, ModalContext, ProductListContext, ResponseListContext, SchemaUrl, SessionContext, SnowplowEventWithContext, SnowplowSelfDescribingEvent, StepContext } from './types';
|
|
2
|
+
import { EventSchema } from './schemas';
|
|
11
3
|
export declare function schemaUrl<T extends string, U extends string>(schema: T, version: U): SchemaUrl<T, U>;
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
* @param {string} _message - The message to record.
|
|
16
|
-
* @param {...unknown} _data - Values to record alongside the message.
|
|
17
|
-
* @example log('tracked', event)
|
|
18
|
-
*/
|
|
19
|
-
export declare function log(_message: string, ..._data: unknown[]): void;
|
|
20
|
-
/**
|
|
21
|
-
* Records a warning. The body is a stub until debug mode is wired up.
|
|
22
|
-
*
|
|
23
|
-
* @param {string} _message - The message to record.
|
|
24
|
-
* @param {...unknown} _data - Values to record alongside the message.
|
|
25
|
-
* @example warn('"form" is required for this event', event)
|
|
26
|
-
*/
|
|
27
|
-
export declare function warn(_message: string, ..._data: unknown[]): void;
|
|
28
|
-
/**
|
|
29
|
-
* Records an error. The body is a stub until debug mode is wired up.
|
|
30
|
-
*
|
|
31
|
-
* @param {string} _message - The message to record.
|
|
32
|
-
* @param {...unknown} _data - Values to record alongside the message.
|
|
33
|
-
* @example error('tracker failed', reason)
|
|
34
|
-
*/
|
|
35
|
-
export declare function error(_message: string, ..._data: unknown[]): void;
|
|
36
|
-
/**
|
|
37
|
-
* Assembles a self-describing Snowplow event from a type, its contexts and its meta.
|
|
38
|
-
* Contexts that resolved to `undefined` are dropped, so a caller can pass an optional
|
|
39
|
-
* context inline.
|
|
40
|
-
*
|
|
41
|
-
* @param {string} type - The event type carried in the event's `data`.
|
|
42
|
-
* @param {ContextArray} context - The contexts to attach, `undefined` entries included.
|
|
43
|
-
* @param {EventSchema['meta']} [meta] - Event meta; defaults to an empty object.
|
|
44
|
-
* @returns {SnowplowSelfDescribingEvent} The event ready to hand to the tracker.
|
|
45
|
-
* @example createEvent('step_submit', [createContext('step', '1-0-1', step)])
|
|
46
|
-
*/
|
|
4
|
+
export declare function log(message: string, ...data: any[]): void;
|
|
5
|
+
export declare function warn(message: string, ...data: any[]): void;
|
|
6
|
+
export declare function error(message: string, ...data: any[]): void;
|
|
47
7
|
export declare function createEvent<E extends SnowplowEventWithContext<string, ContextArray, ContextArray>>(type: E['event']['data']['type'], context: E['context'], meta?: E['event']['data']['meta']): SnowplowSelfDescribingEvent;
|
|
48
|
-
/**
|
|
49
|
-
* Wraps context data in its Iglu schema envelope.
|
|
50
|
-
*
|
|
51
|
-
* @param {string} schema - Schema name for the context.
|
|
52
|
-
* @param {string} version - Schema version in Iglu's dash form.
|
|
53
|
-
* @param {Record<string, unknown>} data - The context payload.
|
|
54
|
-
* @returns {Context} The context with its `schema` and `data` members.
|
|
55
|
-
* @example createContext('app', '1-0-0', { project_id: 'proj1' })
|
|
56
|
-
*/
|
|
57
8
|
export declare function createContext<S extends string, V extends string, D extends Record<string, unknown>>(schema: S, version: V, data: D): Context<SchemaUrl<S, V>, D>;
|
|
58
|
-
/**
|
|
59
|
-
* Builds a tracking function for one event type. The returned function formats its
|
|
60
|
-
* payload through `formatter` and hands the result to the Snowplow tracker.
|
|
61
|
-
*
|
|
62
|
-
* @param {string} eventName - The event type the returned function tracks.
|
|
63
|
-
* @param {(payload: never, meta?: EventSchema['meta']) => SnowplowSelfDescribingEvent} formatter - Formats a payload into a self-describing event.
|
|
64
|
-
* @returns {(payload: never, meta?: EventSchema['meta']) => void} A function that formats and tracks one event.
|
|
65
|
-
* @example const trackStepSubmit = createTrackEvent('step_submit', formatEvent)
|
|
66
|
-
*/
|
|
67
9
|
export declare function createTrackEvent(eventName: string, formatter: (_: null, eventMeta?: EventSchema['meta']) => SnowplowSelfDescribingEvent): (eventMeta?: EventSchema['meta']) => void;
|
|
68
10
|
export declare function createTrackEvent<P>(eventName: string, formatter: (eventPayload: P, eventMeta?: EventSchema['meta']) => SnowplowSelfDescribingEvent): (eventPayload: P, eventMeta?: EventSchema['meta']) => void;
|
|
69
|
-
/**
|
|
70
|
-
* Builds a binder for one DOM event type. The returned function attaches the handler to
|
|
71
|
-
* a target at most once per type, and reads a fresh analytics context on every
|
|
72
|
-
* interaction.
|
|
73
|
-
*
|
|
74
|
-
* @param {string} type - The DOM event type to listen for.
|
|
75
|
-
* @param {(interaction: { analyticsContext: AnalyticsContext; event: Event }) => void} handler - Receives the event and the analytics context read at interaction time.
|
|
76
|
-
* @param {AddEventListenerOptions | boolean} [options] - Listener options; defaults to `{ passive: true }`.
|
|
77
|
-
* @returns {(target: EventTarget, createAnalyticsContext: () => AnalyticsContext) => void} A binder taking the target and a context factory.
|
|
78
|
-
* @example const bindClick = createBindListener('click', onClick)
|
|
79
|
-
*/
|
|
80
11
|
export declare function createBindListener<T extends Event = Event>(type: string, handler: (interaction: {
|
|
81
12
|
analyticsContext: AnalyticsContext;
|
|
82
13
|
event: T;
|
|
83
14
|
}) => void, options?: AddEventListenerOptions | boolean): (target: EventTarget, createAnalyticsContext: () => AnalyticsContext) => void;
|
|
84
|
-
/**
|
|
85
|
-
* Builds a binder that attaches the handler to `document` at most once per event type.
|
|
86
|
-
* The binder is inert where there is no document.
|
|
87
|
-
*
|
|
88
|
-
* @param {string} type - The DOM event type to listen for.
|
|
89
|
-
* @param {(interaction: { analyticsContext: AnalyticsContext; event: Event }) => void} handler - Receives the event and the analytics context read at interaction time.
|
|
90
|
-
* @returns {(createAnalyticsContext: () => AnalyticsContext) => void} A binder taking a context factory.
|
|
91
|
-
* @example const bindVisibility = createDocumentBindListener('visibilitychange', onHide)
|
|
92
|
-
*/
|
|
93
15
|
export declare function createDocumentBindListener<T extends Event = Event>(type: string, handler: (interaction: {
|
|
94
16
|
analyticsContext: AnalyticsContext;
|
|
95
17
|
event: T;
|
|
96
18
|
}) => void): (createAnalyticsContext: () => AnalyticsContext) => void;
|
|
97
|
-
/**
|
|
98
|
-
* Builds a binder that attaches the handler to `window` at most once per event type.
|
|
99
|
-
* The binder is inert where there is no window.
|
|
100
|
-
*
|
|
101
|
-
* @param {string} type - The DOM event type to listen for.
|
|
102
|
-
* @param {(interaction: { analyticsContext: AnalyticsContext; event: Event }) => void} handler - Receives the event and the analytics context read at interaction time.
|
|
103
|
-
* @returns {(createAnalyticsContext: () => AnalyticsContext) => void} A binder taking a context factory.
|
|
104
|
-
* @example const bindUnload = createWindowBindListener('beforeunload', onLeave)
|
|
105
|
-
*/
|
|
106
19
|
export declare function createWindowBindListener<T extends Event = Event>(type: string, handler: (interaction: {
|
|
107
20
|
analyticsContext: AnalyticsContext;
|
|
108
21
|
event: T;
|
|
109
22
|
}) => void): (createAnalyticsContext: () => AnalyticsContext) => void;
|
|
110
|
-
/**
|
|
111
|
-
* Builds the Snowplow `feature_list` context from the features the session resolved.
|
|
112
|
-
* A context with no features carries an empty list.
|
|
113
|
-
*
|
|
114
|
-
* @param {AnalyticsContext} event - Analytics context carrying the resolved features.
|
|
115
|
-
* @returns {FeatureListContext['data']} The feature list context data.
|
|
116
|
-
* @example formatFeatureListContextData({ projectId: 'p', features: [] }) // { items: [] }
|
|
117
|
-
*/
|
|
118
23
|
export declare function formatFeatureListContextData(event: AnalyticsContext): FeatureListContext['data'];
|
|
119
|
-
/**
|
|
120
|
-
* Builds the Snowplow `app` context. A missing project id is reported and replaced with
|
|
121
|
-
* an `unknown` placeholder, so the event still reaches the collector.
|
|
122
|
-
*
|
|
123
|
-
* @param {AnalyticsContext} event - Analytics context carrying the project id.
|
|
124
|
-
* @returns {AppContext['data']} The app context data.
|
|
125
|
-
* @example formatAppContextData({ projectId: 'proj1' }) // { project_id: 'proj1' }
|
|
126
|
-
*/
|
|
127
24
|
export declare function formatAppContextData(event: AnalyticsContext): AppContext['data'];
|
|
128
|
-
/**
|
|
129
|
-
* Builds the Snowplow `session` context, folding in the session identifiers, the Google
|
|
130
|
-
* Analytics client id read from the `_ga` cookie, and any Shopify session tokens.
|
|
131
|
-
*
|
|
132
|
-
* @param {AnalyticsContext} event - Analytics context carrying the session.
|
|
133
|
-
* @returns {SessionContext['data']} The session context data.
|
|
134
|
-
* @example formatSessionContextData({ projectId: 'p', sessionId: 's1' }) // { id: 's1' }
|
|
135
|
-
*/
|
|
136
25
|
export declare function formatSessionContextData(event: AnalyticsContext): SessionContext['data'];
|
|
137
|
-
/**
|
|
138
|
-
* Builds the Snowplow `field_list` context from the fields on the current step. The
|
|
139
|
-
* context describes the fields themselves — their type, label and options — and carries
|
|
140
|
-
* no captured value.
|
|
141
|
-
*
|
|
142
|
-
* @param {AnalyticsContext} event - Analytics context carrying the fields.
|
|
143
|
-
* @returns {FieldListContext['data'] | undefined} The field list context data, or `undefined` when no fields are present.
|
|
144
|
-
* @example formatFieldListContextData({ projectId: 'p', fields }) // { items: [...] }
|
|
145
|
-
*/
|
|
146
26
|
export declare function formatFieldListContextData(event: AnalyticsContext): FieldListContext['data'] | undefined;
|
|
147
|
-
/**
|
|
148
|
-
* Builds the Snowplow `response_list` context from the responses whose fields carry
|
|
149
|
-
* `policies.trackValue`. Every event that carries this context passes through here, so
|
|
150
|
-
* this is the single point at which a field's tracking policy is enforced. The context
|
|
151
|
-
* is omitted when no response survives the filter.
|
|
152
|
-
*
|
|
153
|
-
* @param {AnalyticsContext} event - Analytics context carrying the responses and the fields they belong to.
|
|
154
|
-
* @returns {ResponseListContext['data'] | undefined} The response list context data, or `undefined` when nothing is trackable.
|
|
155
|
-
* @example
|
|
156
|
-
* const fields = [{ key: 'colour', policies: { trackValue: true }, ... }]
|
|
157
|
-
* formatResponseListContextData({ projectId: 'p', fields, responses: [{ fieldKey: 'colour', value: 'blue' }] })
|
|
158
|
-
* // { items: [{ field_id: 'colour', values: [{ value: 'blue' }] }] }
|
|
159
|
-
*/
|
|
160
27
|
export declare function formatResponseListContextData(event: AnalyticsContext): ResponseListContext['data'] | undefined;
|
|
161
|
-
/**
|
|
162
|
-
* Builds the Snowplow `step` context, emitting the stable `key` alongside the
|
|
163
|
-
* workspace-specific `id` so steps stay correlatable across workspaces.
|
|
164
|
-
*
|
|
165
|
-
* @param {AnalyticsContext} event - Analytics context carrying the current step.
|
|
166
|
-
* @param {boolean} [required] - When `true`, returns `unknown` placeholders instead of `undefined` if no step is present.
|
|
167
|
-
* @returns {StepContext['data'] | undefined} The step context data, or `undefined` when no step is present and not required.
|
|
168
|
-
* @example
|
|
169
|
-
* const step = { id: 'uuid', key: 'welcome', name: 'Welcome', fieldKeys: [] }
|
|
170
|
-
* formatStepContextData({ projectId: 'p', step }, true) // { id: 'uuid', title: 'Welcome', key: 'welcome' }
|
|
171
|
-
*/
|
|
172
28
|
export declare function formatStepContextData(event: AnalyticsContext, required: true): StepContext['data'];
|
|
173
29
|
export declare function formatStepContextData(event: AnalyticsContext, required?: false): StepContext['data'] | undefined;
|
|
174
|
-
/**
|
|
175
|
-
* Builds the Snowplow `product_list` context, accepting either a bare item array or an
|
|
176
|
-
* object carrying a title alongside its items. When the list is absent and `required` is
|
|
177
|
-
* set, the absence is reported and an `unknown` placeholder is returned.
|
|
178
|
-
*
|
|
179
|
-
* @param {AnalyticsContext} event - Analytics context carrying the product list.
|
|
180
|
-
* @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
|
|
181
|
-
* @returns {ProductListContext['data'] | undefined} The product list context data, or `undefined` when absent and not required.
|
|
182
|
-
* @example formatProductListContextData({ projectId: 'p', productList: [] }, true)
|
|
183
|
-
*/
|
|
184
30
|
export declare function formatProductListContextData(event: AnalyticsContext, required: true): ProductListContext['data'];
|
|
185
31
|
export declare function formatProductListContextData(event: AnalyticsContext, required?: false): ProductListContext['data'] | undefined;
|
|
186
|
-
/**
|
|
187
|
-
* Builds the Snowplow `order` context. When the order is absent and `required` is set,
|
|
188
|
-
* the absence is reported and an `unknown` placeholder is returned.
|
|
189
|
-
*
|
|
190
|
-
* @param {AnalyticsContext} event - Analytics context carrying the order.
|
|
191
|
-
* @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
|
|
192
|
-
* @returns {OrderContext['data'] | undefined} The order context data, or `undefined` when absent and not required.
|
|
193
|
-
* @example formatOrderContextData({ projectId: 'p', order: { id: 'o1' } })
|
|
194
|
-
*/
|
|
195
|
-
export declare function formatOrderContextData(event: AnalyticsContext, required: true): OrderContext['data'];
|
|
196
|
-
export declare function formatOrderContextData(event: AnalyticsContext, required?: false): OrderContext['data'] | undefined;
|
|
197
|
-
/**
|
|
198
|
-
* Builds the Snowplow `experience` context. When the experience is absent and `required`
|
|
199
|
-
* is set, the absence is reported and an `unknown` placeholder is returned.
|
|
200
|
-
*
|
|
201
|
-
* @param {AnalyticsContext} event - Analytics context carrying the experience.
|
|
202
|
-
* @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
|
|
203
|
-
* @returns {ExperienceContext['data'] | undefined} The experience context data, or `undefined` when absent and not required.
|
|
204
|
-
* @example formatExperienceContextData({ projectId: 'p', experience })
|
|
205
|
-
*/
|
|
206
32
|
export declare function formatExperienceContextData(event: AnalyticsContext, required: true): ExperienceContext['data'];
|
|
207
33
|
export declare function formatExperienceContextData(event: AnalyticsContext, required?: false): ExperienceContext['data'] | undefined;
|
|
208
|
-
/**
|
|
209
|
-
* Builds the Snowplow `exception` context from either a bare reason string or a field
|
|
210
|
-
* validation error. When the exception is absent and `required` is set, the absence is
|
|
211
|
-
* reported and an `unknown` placeholder is returned.
|
|
212
|
-
*
|
|
213
|
-
* @param {AnalyticsContext} event - Analytics context carrying the exception.
|
|
214
|
-
* @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
|
|
215
|
-
* @returns {ExceptionContext['data'] | undefined} The exception context data, or `undefined` when absent and not required.
|
|
216
|
-
* @example formatExceptionContextData({ projectId: 'p', exception: 'timeout' })
|
|
217
|
-
*/
|
|
218
34
|
export declare function formatExceptionContextData(event: AnalyticsContext, required: true): ExceptionContext['data'];
|
|
219
35
|
export declare function formatExceptionContextData(event: AnalyticsContext, required?: false): ExceptionContext['data'] | undefined;
|
|
220
|
-
/**
|
|
221
|
-
* Builds the Snowplow `form` context. A missing form is reported and replaced with an
|
|
222
|
-
* `unknown` placeholder, because every event carrying this context requires one.
|
|
223
|
-
*
|
|
224
|
-
* @param {AnalyticsContext} event - Analytics context carrying the form.
|
|
225
|
-
* @returns {FormContext['data']} The form context data.
|
|
226
|
-
* @example formatFormContextData({ projectId: 'p', form: { id: 'f1', title: 'Quote' } })
|
|
227
|
-
*/
|
|
228
36
|
export declare function formatFormContextData(event: AnalyticsContext): FormContext['data'];
|
|
229
|
-
/**
|
|
230
|
-
* Builds the Snowplow `modal` context. A missing modal is reported and replaced with an
|
|
231
|
-
* `unknown` placeholder, because every event carrying this context requires one.
|
|
232
|
-
*
|
|
233
|
-
* @param {AnalyticsContext} event - Analytics context carrying the modal.
|
|
234
|
-
* @returns {ModalContext['data']} The modal context data.
|
|
235
|
-
* @example formatModalContextData({ projectId: 'p', modal: { id: 'm1', title: 'Offer' } })
|
|
236
|
-
*/
|
|
237
37
|
export declare function formatModalContextData(event: AnalyticsContext): ModalContext['data'];
|
|
238
|
-
|
|
239
|
-
* Creates a debounced version of the supplied function that will only invoke
|
|
240
|
-
* the original after `ms` milliseconds have elapsed since the last call.
|
|
241
|
-
*
|
|
242
|
-
* @template Fn
|
|
243
|
-
* @param {Fn} fn - The function to debounce.
|
|
244
|
-
* @param {number} ms - The debounce window in milliseconds.
|
|
245
|
-
* @returns {(...args: Parameters<Fn>) => void} A debounced wrapper around `fn`.
|
|
246
|
-
* @example
|
|
247
|
-
* const log = debounce((value: string) => console.log(value), 200)
|
|
248
|
-
*/
|
|
249
|
-
export declare function debounce<Fn extends (...args: never[]) => unknown>(fn: Fn, ms?: number): (...args: Parameters<Fn>) => void;
|
|
38
|
+
export declare function debounce(fn: Function, ms?: number): (this: unknown, ...args: unknown[]) => void;
|
|
250
39
|
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,gBAAgB,EAChB,UAAU,EACV,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,EACnB,SAAS,EACT,cAAc,EACd,wBAAwB,EACxB,2BAA2B,EAC3B,WAAW,EACZ,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAM5C,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC1D,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,CAAC,GACT,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAEjB;AAGD,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,QAIlD;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,QAInD;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,QAIpD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,wBAAwB,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,EAChG,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAChC,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,EACrB,IAAI,GAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAM,GACpC,2BAA2B,CAa7B;AAED,wBAAgB,aAAa,CAC3B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAK7D;AAED,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,2BAA2B,GACnF,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,IAAI,CAAA;AAC5C,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,CAAC,YAAY,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,2BAA2B,GAC3F,CAAC,YAAY,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,IAAI,CAAA;AAY7D,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,EACxD,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,CAAC,WAAW,EAAE;IAAE,gBAAgB,EAAE,gBAAgB,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,KAAK,IAAI,EAChF,OAAO,GAAE,uBAAuB,GAAG,OAA2B,GAC7D,CAAC,MAAM,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,KAAK,IAAI,CAwB/E;AAED,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,CAAC,WAAW,EAAE;IAAE,gBAAgB,EAAE,gBAAgB,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,KAAK,IAAI,GAC/E,CAAC,sBAAsB,EAAE,MAAM,gBAAgB,KAAK,IAAI,CAgB1D;AAED,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,EAC9D,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,CAAC,WAAW,EAAE;IAAE,gBAAgB,EAAE,gBAAgB,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,KAAK,IAAI,GAC/E,CAAC,sBAAsB,EAAE,MAAM,gBAAgB,KAAK,IAAI,CAgB1D;AAED,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,gBAAgB,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAUhG;AAID,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,CAYhF;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,gBAAgB,GAAG,cAAc,CAAC,MAAM,CAAC,CAOxF;AAED,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,gBAAgB,GACtB,gBAAgB,CAAC,MAAM,CAAC,GAAG,SAAS,CAatC;AAYD,wBAAgB,6BAA6B,CAC3C,KAAK,EAAE,gBAAgB,GACtB,mBAAmB,CAAC,MAAM,CAAC,GAAG,SAAS,CAiBzC;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;AACnG,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,CAAC,EAAE,KAAK,GACf,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;AAuBlC,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,gBAAgB,EACvB,QAAQ,EAAE,IAAI,GACb,kBAAkB,CAAC,MAAM,CAAC,CAAA;AAC7B,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,gBAAgB,EACvB,QAAQ,CAAC,EAAE,KAAK,GACf,kBAAkB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;AA6CzC,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,EAAE,IAAI,GACb,iBAAiB,CAAC,MAAM,CAAC,CAAA;AAC5B,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,CAAC,EAAE,KAAK,GACf,iBAAiB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;AAwBxC,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,EAAE,IAAI,GACb,gBAAgB,CAAC,MAAM,CAAC,CAAA;AAC3B,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,CAAC,EAAE,KAAK,GACf,gBAAgB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;AAyBvC,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CAAC,MAAM,CAAC,CAgBlF;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC,CAgBpF;AAGD,wBAAgB,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,SAAM,IAG5B,MAAM,OAAO,EAAE,GAAG,MAAM,OAAO,EAAE,UAInD"}
|