@artisan-commerce/analytics-rn 0.1.1-canary.3 → 0.1.1-canary.5

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 (106) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/build/{config → analytics-rn/src/config}/constants.d.ts +0 -0
  3. package/build/{index.d.ts → analytics-rn/src/index.d.ts} +0 -0
  4. package/build/analytics-rn/src/lib/events/auth/changePasswordAttempt/changePasswordAttempt.d.ts +11 -0
  5. package/build/{lib/initAnalytics/initAnalytics.test.d.ts → analytics-rn/src/lib/events/auth/changePasswordAttempt/changePasswordAttempt.test.d.ts} +0 -0
  6. package/build/analytics-rn/src/lib/events/auth/changePasswordAttempt/changePasswordAttempt.types.d.ts +18 -0
  7. package/build/analytics-rn/src/lib/events/auth/changePasswordFail/changePasswordFail.d.ts +11 -0
  8. package/build/{setupTests.d.ts → analytics-rn/src/lib/events/auth/changePasswordFail/changePasswordFail.test.d.ts} +0 -0
  9. package/build/analytics-rn/src/lib/events/auth/changePasswordFail/changePasswordFail.types.d.ts +21 -0
  10. package/build/analytics-rn/src/lib/events/auth/changePasswordSuccess/changePasswordSuccess.d.ts +11 -0
  11. package/build/analytics-rn/src/lib/events/auth/changePasswordSuccess/changePasswordSuccess.test.d.ts +1 -0
  12. package/build/analytics-rn/src/lib/events/auth/changePasswordSuccess/changePasswordSuccess.types.d.ts +17 -0
  13. package/build/analytics-rn/src/lib/events/auth/index.d.ts +10 -0
  14. package/build/analytics-rn/src/lib/events/auth/index.test.d.ts +1 -0
  15. package/build/analytics-rn/src/lib/events/auth/signIn/signIn.d.ts +11 -0
  16. package/build/analytics-rn/src/lib/events/auth/signIn/signIn.test.d.ts +1 -0
  17. package/build/analytics-rn/src/lib/events/auth/signIn/signIn.types.d.ts +20 -0
  18. package/build/analytics-rn/src/lib/events/auth/signOut/signOut.d.ts +11 -0
  19. package/build/analytics-rn/src/lib/events/auth/signOut/signOut.test.d.ts +1 -0
  20. package/build/analytics-rn/src/lib/events/auth/signOut/signOut.types.d.ts +17 -0
  21. package/build/analytics-rn/src/lib/events/auth/signUp/signUp.d.ts +11 -0
  22. package/build/analytics-rn/src/lib/events/auth/signUp/signUp.test.d.ts +1 -0
  23. package/build/analytics-rn/src/lib/events/auth/signUp/signUp.types.d.ts +20 -0
  24. package/build/analytics-rn/src/lib/events/auth/signUpAttempt/signUpAttempt.d.ts +12 -0
  25. package/build/analytics-rn/src/lib/events/auth/signUpAttempt/signUpAttempt.test.d.ts +1 -0
  26. package/build/analytics-rn/src/lib/events/auth/signUpAttempt/signUpAttempt.types.d.ts +20 -0
  27. package/build/analytics-rn/src/lib/events/events.d.ts +12 -0
  28. package/build/analytics-rn/src/lib/events/events.test.d.ts +1 -0
  29. package/build/analytics-rn/src/lib/events/events.types.d.ts +24 -0
  30. package/build/analytics-rn/src/lib/initAnalytics/initAnalytics.d.ts +8 -0
  31. package/build/analytics-rn/src/lib/initAnalytics/initAnalytics.helpers.d.ts +9 -0
  32. package/build/analytics-rn/src/lib/initAnalytics/initAnalytics.test.d.ts +1 -0
  33. package/build/{lib → analytics-rn/src/lib}/initAnalytics/initAnalytics.types.d.ts +0 -1
  34. package/build/analytics-rn/src/lib/providers/AnalyticsProvider/AnalyticsProvider.d.ts +36 -0
  35. package/build/analytics-rn/src/lib/providers/AnalyticsProvider/AnalyticsProvider.test.d.ts +1 -0
  36. package/build/analytics-rn/src/lib/providers/AnalyticsProvider/AnalyticsProvider.types.d.ts +28 -0
  37. package/build/analytics-rn/src/lib/providers/FacebookPixel/FacebookPixel.d.ts +30 -0
  38. package/build/analytics-rn/src/lib/providers/FacebookPixel/FacebookPixel.test.d.ts +1 -0
  39. package/build/analytics-rn/src/lib/providers/FacebookPixel/FacebookPixel.types.d.ts +58 -0
  40. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordAttempt/changePasswordAttempt.d.ts +11 -0
  41. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordAttempt/changePasswordAttempt.test.d.ts +1 -0
  42. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordAttempt/changePasswordAttempt.types.d.ts +14 -0
  43. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordFail/changePasswordFail.d.ts +11 -0
  44. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordFail/changePasswordFail.test.d.ts +1 -0
  45. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordFail/changePasswordFail.types.d.ts +14 -0
  46. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordSuccess/changePasswordSuccess.d.ts +11 -0
  47. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordSuccess/changePasswordSuccess.test.d.ts +1 -0
  48. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/changePasswordSuccess/changePasswordSuccess.types.d.ts +14 -0
  49. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/index.d.ts +10 -0
  50. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/index.test.d.ts +1 -0
  51. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signIn/signIn.d.ts +11 -0
  52. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signIn/signIn.test.d.ts +1 -0
  53. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signIn/signIn.types.d.ts +14 -0
  54. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signOut/signOut.d.ts +11 -0
  55. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signOut/signOut.test.d.ts +1 -0
  56. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signOut/signOut.types.d.ts +14 -0
  57. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signUp/signUp.d.ts +11 -0
  58. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signUp/signUp.test.d.ts +1 -0
  59. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signUp/signUp.types.d.ts +14 -0
  60. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signUpAttempt/signUpAttempt.d.ts +11 -0
  61. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signUpAttempt/signUpAttempt.test.d.ts +1 -0
  62. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/auth/signUpAttempt/signUpAttempt.types.d.ts +14 -0
  63. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/events.d.ts +1 -0
  64. package/build/analytics-rn/src/lib/providers/FacebookPixel/events/events.test.d.ts +1 -0
  65. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/GoogleAnalytics.d.ts +34 -0
  66. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/GoogleAnalytics.test.d.ts +1 -0
  67. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/GoogleAnalytics.types.d.ts +114 -0
  68. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordAttempt/changePasswordAttempt.d.ts +11 -0
  69. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordAttempt/changePasswordAttempt.test.d.ts +1 -0
  70. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordAttempt/changePasswordAttempt.types.d.ts +16 -0
  71. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordFail/changePasswordFail.d.ts +11 -0
  72. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordFail/changePasswordFail.test.d.ts +1 -0
  73. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordFail/changePasswordFail.types.d.ts +16 -0
  74. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordSuccess/changePasswordSuccess.d.ts +11 -0
  75. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordSuccess/changePasswordSuccess.test.d.ts +1 -0
  76. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/changePasswordSuccess/changePasswordSuccess.types.d.ts +16 -0
  77. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/index.d.ts +10 -0
  78. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/index.test.d.ts +1 -0
  79. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signIn/signIn.d.ts +11 -0
  80. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signIn/signIn.test.d.ts +1 -0
  81. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signIn/signIn.types.d.ts +14 -0
  82. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signOut/signOut.d.ts +11 -0
  83. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signOut/signOut.test.d.ts +1 -0
  84. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signOut/signOut.types.d.ts +16 -0
  85. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signUp/signUp.d.ts +11 -0
  86. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signUp/signUp.test.d.ts +1 -0
  87. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signUp/signUp.types.d.ts +14 -0
  88. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signUpAttempt/signUpAttempt.d.ts +11 -0
  89. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signUpAttempt/signUpAttempt.test.d.ts +1 -0
  90. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/auth/signUpAttempt/signUpAttempt.types.d.ts +14 -0
  91. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/events.d.ts +1 -0
  92. package/build/analytics-rn/src/lib/providers/GoogleAnalytics/events/events.test.d.ts +1 -0
  93. package/build/analytics-rn/src/lib/providers/providers.d.ts +7 -0
  94. package/build/analytics-rn/src/setupTests.d.ts +2 -0
  95. package/build/{types → analytics-rn/src/types}/common.types.d.ts +0 -0
  96. package/build/analytics-rn/src/types/event.types.d.ts +212 -0
  97. package/build/analytics-rn/src/types/state.types.d.ts +22 -0
  98. package/build/analytics-rn/src/utils/common.utils.d.ts +8 -0
  99. package/build/analytics-rn/src/utils/events.utils.d.ts +55 -0
  100. package/build/analytics-rn/src/utils/logs.utils.d.ts +49 -0
  101. package/build/analytics-rn/src/utils/state.utils.d.ts +4 -0
  102. package/build/analytics-rn/src/utils/validations.utils.d.ts +10 -0
  103. package/build/main.bundle.js +1 -1
  104. package/build/report.json +1 -1
  105. package/package.json +4 -4
  106. package/build/lib/initAnalytics/initAnalytics.d.ts +0 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,22 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ### [0.1.1-canary.5](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.1.1-canary.4...@artisan-commerce/analytics-rn@0.1.1-canary.5) (2021-04-14)
7
+
8
+ **Note:** Version bump only for package @artisan-commerce/analytics-rn
9
+
10
+
11
+
12
+
13
+
14
+ ### [0.1.1-canary.4](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.1.1-canary.3...@artisan-commerce/analytics-rn@0.1.1-canary.4) (2021-04-13)
15
+
16
+ **Note:** Version bump only for package @artisan-commerce/analytics-rn
17
+
18
+
19
+
20
+
21
+
6
22
  ### [0.1.1-canary.3](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.1.1-canary.2...@artisan-commerce/analytics-rn@0.1.1-canary.3) (2021-04-12)
7
23
 
8
24
  **Note:** Version bump only for package @artisan-commerce/analytics-rn
@@ -0,0 +1,11 @@
1
+ import { ChangePasswordAttemptParams } from "./changePasswordAttempt.types";
2
+ /**
3
+ * Emits a changePasswordAttempt event to every configured provider.
4
+ *
5
+ * Log this event when users show an intention to change their password.
6
+ *
7
+ * @since 0.5.14
8
+ * @param {ChangePasswordAttemptParams} params ChangePasswordAttempt event parameters
9
+ */
10
+ declare const logChangePasswordAttempt: (params: ChangePasswordAttemptParams) => void;
11
+ export default logChangePasswordAttempt;
@@ -0,0 +1,18 @@
1
+ import { ChangePasswordAttemptParams as GoogleChangePasswordAttemptParams } from "../../../providers/GoogleAnalytics/events/auth/changePasswordAttempt/changePasswordAttempt.types";
2
+ import { ChangePasswordAttemptParams as FacebookChangePasswordAttemptParams } from "../../../providers/FacebookPixel/events/auth/changePasswordAttempt/changePasswordAttempt.types";
3
+ /**
4
+ * ChangePasswordAttempt event interface
5
+ *
6
+ * @interface ChangePasswordAttemptCommonParams
7
+ * @since 0.5.14
8
+ *
9
+ */
10
+ export interface ChangePasswordAttemptCommonParams {
11
+ }
12
+ /**
13
+ * ChangePasswordAttempt event params.
14
+ *
15
+ * @typedef ChangePasswordAttemptParams
16
+ * @since 0.5.14
17
+ */
18
+ export declare type ChangePasswordAttemptParams = GoogleChangePasswordAttemptParams & FacebookChangePasswordAttemptParams;
@@ -0,0 +1,11 @@
1
+ import { ChangePasswordFailParams } from "./changePasswordFail.types";
2
+ /**
3
+ * Emits a changePasswordFail event to every configured provider.
4
+ *
5
+ * Log this event when your change password request has failed.
6
+ *
7
+ * @since 0.5.14
8
+ * @param {ChangePasswordFailParams} params ChangePasswordFail event parameters
9
+ */
10
+ declare const logChangePasswordFail: (params: ChangePasswordFailParams) => void;
11
+ export default logChangePasswordFail;
@@ -0,0 +1,21 @@
1
+ import { ChangePasswordFailParams as GoogleChangePasswordFailParams } from "../../../providers/GoogleAnalytics/events/auth/changePasswordFail/changePasswordFail.types";
2
+ import { ChangePasswordFailParams as FacebookChangePasswordFailParams } from "../../../providers/FacebookPixel/events/auth/changePasswordFail/changePasswordFail.types";
3
+ /**
4
+ * changePasswordFail event interface
5
+ *
6
+ * @interface ChangePasswordFailCommonParams
7
+ * @since 0.5.14
8
+ * @property {string} errorMessage Server error message
9
+ * @property {number} statusCode Server response status code
10
+ */
11
+ export interface ChangePasswordFailCommonParams {
12
+ errorMessage: string;
13
+ statusCode: number;
14
+ }
15
+ /**
16
+ * changePasswordFail event params.
17
+ *
18
+ * @typedef ChangePasswordFailParams
19
+ * @since 0.5.14
20
+ */
21
+ export declare type ChangePasswordFailParams = GoogleChangePasswordFailParams & FacebookChangePasswordFailParams;
@@ -0,0 +1,11 @@
1
+ import { ChangePasswordSuccessParams } from "./changePasswordSuccess.types";
2
+ /**
3
+ * Emits a changePasswordSuccess event to every configured provider.
4
+ *
5
+ * Log this event when your change password request has resolved successfully.
6
+ *
7
+ * @since 0.5.14
8
+ * @param {ChangePasswordSuccessParams} params ChangePasswordSuccess event parameters
9
+ */
10
+ declare const logChangePasswordSuccess: (params: ChangePasswordSuccessParams) => void;
11
+ export default logChangePasswordSuccess;
@@ -0,0 +1,17 @@
1
+ import { ChangePasswordSuccessParams as GoogleChangePasswordSuccessParams } from "../../../providers/GoogleAnalytics/events/auth/changePasswordSuccess/changePasswordSuccess.types";
2
+ import { ChangePasswordSuccessParams as FacebookChangePasswordSuccessParams } from "../../../providers/FacebookPixel/events/auth/changePasswordSuccess/changePasswordSuccess.types";
3
+ /**
4
+ * changePasswordSuccess event interface
5
+ *
6
+ * @interface ChangePasswordSuccessCommonParams
7
+ * @since 0.5.14
8
+ */
9
+ export interface ChangePasswordSuccessCommonParams {
10
+ }
11
+ /**
12
+ * changePasswordSuccess event params.
13
+ *
14
+ * @typedef ChangePasswordSuccessParams
15
+ * @since 0.5.14
16
+ */
17
+ export declare type ChangePasswordSuccessParams = GoogleChangePasswordSuccessParams & FacebookChangePasswordSuccessParams;
@@ -0,0 +1,10 @@
1
+ declare const events: {
2
+ logChangePasswordAttempt: (params: import("./changePasswordAttempt/changePasswordAttempt.types").ChangePasswordAttemptParams) => void;
3
+ logSignUpAttempt: (params: import("./signUpAttempt/signUpAttempt.types").SignUpAttemptParams) => void;
4
+ logChangePasswordFail: (params: import("./changePasswordFail/changePasswordFail.types").ChangePasswordFailParams) => void;
5
+ logChangePasswordSuccess: (params: import("./changePasswordSuccess/changePasswordSuccess.types").ChangePasswordSuccessParams) => void;
6
+ logSignIn: (params: import("./signIn/signIn.types").SignInParams) => void;
7
+ logSignOut: (params: import("./signOut/signOut.types").SignOutParams) => void;
8
+ logSignUp: (params: import("./signUp/signUp.types").SignUpParams) => void;
9
+ };
10
+ export default events;
@@ -0,0 +1,11 @@
1
+ import { SignInParams } from "./signIn.types";
2
+ /**
3
+ * Emits a signIn event to every configured provider.
4
+ *
5
+ * Log this event when your sign in request has resolved successfully.
6
+ *
7
+ * @since 0.5.14
8
+ * @param {SignInParams} params SingIn event parameters
9
+ */
10
+ declare const logSignIn: (params: SignInParams) => void;
11
+ export default logSignIn;
@@ -0,0 +1,20 @@
1
+ import { SignInParams as GoogleSignInParams } from "../../../providers/GoogleAnalytics/events/auth/signIn/signIn.types";
2
+ import { SignInParams as FacebookSignInParams } from "../../../providers/FacebookPixel/events/auth/signIn/signIn.types";
3
+ import { AuthProviderMethods } from "../../../../types/common.types";
4
+ /**
5
+ * signIn event interface
6
+ *
7
+ * @interface SignInCommonParams
8
+ * @since 0.5.14
9
+ * @property {AuthProviderMethods} method Supported auth providers methods
10
+ */
11
+ export interface SignInCommonParams {
12
+ method: AuthProviderMethods;
13
+ }
14
+ /**
15
+ * signIn event params.
16
+ *
17
+ * @typedef SignInParams
18
+ * @since 0.5.14
19
+ */
20
+ export declare type SignInParams = GoogleSignInParams & FacebookSignInParams;
@@ -0,0 +1,11 @@
1
+ import { SignOutParams } from "./signOut.types";
2
+ /**
3
+ * Emits a signOut event to every configured provider.
4
+ *
5
+ * Log this event when your sign out request has resolved successfully.
6
+ *
7
+ * @since 0.5.14
8
+ * @param {SignOutParams} params SignOut event parameters
9
+ */
10
+ declare const logSignOut: (params: SignOutParams) => void;
11
+ export default logSignOut;
@@ -0,0 +1,17 @@
1
+ import { SignOutParams as GoogleSignOutParams } from "../../../providers/GoogleAnalytics/events/auth/signOut/signOut.types";
2
+ import { SignOutParams as FacebookSignOutParams } from "../../../providers/FacebookPixel/events/auth/signOut/signOut.types";
3
+ /**
4
+ * signOut event interface
5
+ *
6
+ * @interface SignOutCommonParams
7
+ * @since 0.5.14
8
+ */
9
+ export interface SignOutCommonParams {
10
+ }
11
+ /**
12
+ * signOut event params.
13
+ *
14
+ * @typedef SignOutParams
15
+ * @since 0.5.14
16
+ */
17
+ export declare type SignOutParams = GoogleSignOutParams & FacebookSignOutParams;
@@ -0,0 +1,11 @@
1
+ import { SignUpParams } from "./signUp.types";
2
+ /**
3
+ * Emits a signUp event to every configured provider.
4
+ *
5
+ * Log this event when your sign up request has resolved successfully.
6
+ *
7
+ * @since 0.5.14
8
+ * @param {SignUpParams} params SignUp event parameters
9
+ */
10
+ declare const logSignUp: (params: SignUpParams) => void;
11
+ export default logSignUp;
@@ -0,0 +1,20 @@
1
+ import { SignUpParams as GoogleSignUpParams } from "../../../providers/GoogleAnalytics/events/auth/signUp/signUp.types";
2
+ import { SignUpParams as FacebookSignUpParams } from "../../../providers/FacebookPixel/events/auth/signUp/signUp.types";
3
+ import { AuthProviderMethods } from "../../../../types/common.types";
4
+ /**
5
+ * signUp event interface
6
+ *
7
+ * @interface SignUpCommonParams
8
+ * @since 0.5.14
9
+ * @property {AuthProviderMethods} method Supported auth providers methods
10
+ */
11
+ export interface SignUpCommonParams {
12
+ method: AuthProviderMethods;
13
+ }
14
+ /**
15
+ * signUp event params.
16
+ *
17
+ * @typedef SignUpParams
18
+ * @since 0.5.14
19
+ */
20
+ export declare type SignUpParams = GoogleSignUpParams & FacebookSignUpParams;
@@ -0,0 +1,12 @@
1
+ import { SignUpAttemptParams } from "./signUpAttempt.types";
2
+ /**
3
+ * Emits a signUpAttempt event to every configured provider.
4
+ *
5
+ * Log this event when submitting the sign up action. It should not be triggered
6
+ * after the sign up action has resolved.
7
+ *
8
+ * @since 0.5.14
9
+ * @param {SignUpAttemptParams} params SignUpAttempt event parameters
10
+ */
11
+ declare const logSignUpAttempt: (params: SignUpAttemptParams) => void;
12
+ export default logSignUpAttempt;
@@ -0,0 +1,20 @@
1
+ import { SignUpAttemptParams as GoogleSignUpAttemptParams } from "../../../providers/GoogleAnalytics/events/auth/signUpAttempt/signUpAttempt.types";
2
+ import { SignUpAttemptParams as FacebookSignUpAttemptParams } from "../../../providers/FacebookPixel/events/auth/signUpAttempt/signUpAttempt.types";
3
+ import { AuthProviderMethods } from "../../../../types/common.types";
4
+ /**
5
+ * signUpAttempt event interface
6
+ *
7
+ * @interface SignUpAttemptCommonParams
8
+ * @since 0.5.14
9
+ * @property {AuthProviderMethods} method Supported auth providers methods
10
+ */
11
+ export interface SignUpAttemptCommonParams {
12
+ method: AuthProviderMethods;
13
+ }
14
+ /**
15
+ * signUpAttempt event params.
16
+ *
17
+ * @typedef SignUpAttemptParams
18
+ * @since 0.5.14
19
+ */
20
+ export declare type SignUpAttemptParams = GoogleSignUpAttemptParams & FacebookSignUpAttemptParams;
@@ -0,0 +1,12 @@
1
+ declare const events: {
2
+ auth: {
3
+ logChangePasswordAttempt: (params: import("./auth/changePasswordAttempt/changePasswordAttempt.types").ChangePasswordAttemptParams) => void;
4
+ logSignUpAttempt: (params: import("./auth/signUpAttempt/signUpAttempt.types").SignUpAttemptParams) => void;
5
+ logChangePasswordFail: (params: import("./auth/changePasswordFail/changePasswordFail.types").ChangePasswordFailParams) => void;
6
+ logChangePasswordSuccess: (params: import("./auth/changePasswordSuccess/changePasswordSuccess.types").ChangePasswordSuccessParams) => void;
7
+ logSignIn: (params: import("./auth/signIn/signIn.types").SignInParams) => void;
8
+ logSignOut: (params: import("./auth/signOut/signOut.types").SignOutParams) => void;
9
+ logSignUp: (params: import("./auth/signUp/signUp.types").SignUpParams) => void;
10
+ };
11
+ };
12
+ export default events;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Google Analytics event shared parameters.
3
+ *
4
+ * @interface ArtisanCommonEventParams
5
+ * @since 0.5.14
6
+ * @property {string} userId The user's unique identifier between platforms
7
+ */
8
+ export interface ArtisanCommonEventParams {
9
+ artisanName?: string;
10
+ }
11
+ /**
12
+ * Workflow types.
13
+ *
14
+ * @typedef Workflow
15
+ * @since 0.5.14
16
+ */
17
+ export declare type Workflow = "Delivery" | "Pickup" | "Other";
18
+ /**
19
+ * PaymentType types
20
+ *
21
+ * @typedef PaymentType
22
+ * @since 0.5.14
23
+ */
24
+ export declare type PaymentType = "Credit" | "Debit" | "Cash" | "Dataphone" | "Other";
@@ -0,0 +1,8 @@
1
+ import { InitAnalyticsConfig } from "./initAnalytics.types";
2
+ /**
3
+ * Initializes the analytics module, connects to every provider.
4
+ *
5
+ * @since 0.5.14
6
+ * @param {InitAnalyticsConfig} config Initialization configuration.
7
+ */
8
+ export declare const initAnalytics: (config: InitAnalyticsConfig) => void;
@@ -0,0 +1,9 @@
1
+ import AnalyticsProvider from "../providers/AnalyticsProvider/AnalyticsProvider";
2
+ /**
3
+ * Check if the given providers are unique.
4
+ *
5
+ * @since 0.5.14
6
+ * @param {AnalyticsProvider[]} providers Providers list
7
+ * @returns {boolean} true if no provider clashes with another
8
+ */
9
+ export declare const checkUniqueProvider: (providers: AnalyticsProvider[]) => boolean;
@@ -5,7 +5,6 @@ export interface InitAnalyticsConfig {
5
5
  activeVendor?: Vendor["id"];
6
6
  vendors: Vendor["id"][];
7
7
  debug?: boolean;
8
- shareArtisanAnalytics?: boolean;
9
8
  meta: InitAnalyticsConfigMeta;
10
9
  }
11
10
  export interface InitAnalyticsConfigMeta extends Omit<AnalyticsMeta, "vendorId" | "versionSDK" | "platform" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName"> {
@@ -0,0 +1,36 @@
1
+ import { AnalyticsProviderConstructor as Config } from "./AnalyticsProvider.types";
2
+ import { IAnaliticsProvider } from "./AnalyticsProvider.types";
3
+ /**
4
+ * Represents the base properties all AnalyticsProviders have.
5
+ *
6
+ * @abstract
7
+ * @since 0.5.14
8
+ */
9
+ declare abstract class AnalyticsProvider implements IAnaliticsProvider {
10
+ readonly type: Config["type"];
11
+ readonly name: Config["name"];
12
+ private readonly _vendors;
13
+ /**
14
+ * Representation of a Customer Account
15
+ *
16
+ * @constructs
17
+ * @since 0.5.14
18
+ * @param {Config} config artisan's account unique identifier.
19
+ */
20
+ constructor(config: Config);
21
+ /**
22
+ * Gets the allowed vendors of the Analytics Provider.
23
+ *
24
+ * @since 0.5.14
25
+ * @returns Analytics Provider vendors, if not specified it fallsback to the global vendors
26
+ */
27
+ get vendors(): number[];
28
+ /**
29
+ * Updates the provider instance config for the next events.
30
+ *
31
+ * @since 0.5.14
32
+ * @param {Partial<unknown>} config Analyticis provider configurable options
33
+ */
34
+ updateConfig(config: Partial<unknown>): void;
35
+ }
36
+ export default AnalyticsProvider;
@@ -0,0 +1,28 @@
1
+ import { Vendor } from "@artisan-commerce/types";
2
+ import { SupportedProviders } from "../../../types/common.types";
3
+ /**
4
+ * Analytics Provider base intance config.
5
+ *
6
+ * @interface AnalyticsProviderConstructor
7
+ * @since 0.5.14
8
+ * @property {SupportedProviders} type Type of analytics provider
9
+ * @property {string} name Analytics provider name
10
+ * @property {number[]} vendors List of vendors that can emit this provider events if active (defaults to all vendors)
11
+ */
12
+ export interface AnalyticsProviderConstructor {
13
+ type: SupportedProviders;
14
+ name: string;
15
+ vendors?: Vendor["id"][];
16
+ }
17
+ /**
18
+ * AnalyticsProvider Class interface.
19
+ *
20
+ * @interface IAnaliticsProvider
21
+ * @since 0.5.14
22
+ * @property {Function} updateConfig Updates the initial config of the provider
23
+ * @property {Function} getVendors Return the provider selected vendors
24
+ */
25
+ export interface IAnaliticsProvider {
26
+ updateConfig: (config: Partial<unknown>) => void;
27
+ vendors: Vendor["id"][];
28
+ }
@@ -0,0 +1,30 @@
1
+ import AnalyticsProvider from "../AnalyticsProvider/AnalyticsProvider";
2
+ import { FacebookPixelProvider as Config } from "./FacebookPixel.types";
3
+ import { FacebookPixelProviderConfig } from "./FacebookPixel.types";
4
+ /**
5
+ * Create a Facebook Pixel provider instance.
6
+ *
7
+ * @class
8
+ * @since 0.5.14
9
+ * @extends AnalyticsProvider
10
+ */
11
+ declare class FacebookPixel extends AnalyticsProvider {
12
+ private readonly _version;
13
+ private _currency;
14
+ /**
15
+ * Contructs a Facebook Pixel Provider
16
+ *
17
+ * @constructs
18
+ * @since 0.5.14
19
+ * @param {Config} config provider configuration
20
+ */
21
+ constructor(config: Config);
22
+ get version(): Config["version"];
23
+ get currency(): Config["currency"];
24
+ /**
25
+ * @override
26
+ * @since 0.5.14
27
+ */
28
+ updateConfig(config?: Partial<FacebookPixelProviderConfig>): void;
29
+ }
30
+ export default FacebookPixel;
@@ -0,0 +1,58 @@
1
+ import { CurrencyCodes } from "@artisan-commerce/types";
2
+ import { EventCommonParams } from "../../../types/event.types";
3
+ import { AnalyticsProviderConstructor } from "../AnalyticsProvider/AnalyticsProvider.types";
4
+ /**
5
+ * Facebook Pixel Provider constructor configuration.
6
+ *
7
+ * @interface FacebookPixelProvider
8
+ * @since 0.5.14
9
+ * @implements AnalyticsProviderConstructor, FacebookPixelProviderConfig
10
+ * @property {string} version Facebook Pixel SDK version
11
+ */
12
+ export interface FacebookPixelProvider extends Omit<AnalyticsProviderConstructor, "type">, FacebookPixelProviderConfig {
13
+ version?: string;
14
+ }
15
+ /**
16
+ * Facebook Pixel Provider after instantiated configurable options.
17
+ *
18
+ * @interface FacebookPixelProvider
19
+ * @since 0.5.14
20
+ * @property {CurrencyCodes} currency user's country monetary code
21
+ */
22
+ export interface FacebookPixelProviderConfig {
23
+ currency?: CurrencyCodes;
24
+ }
25
+ /**
26
+ * Facebook Pixel event shared parameters.
27
+ *
28
+ * @interface FacebookPixelCommonEventParams
29
+ * @since 0.5.14
30
+ * @extends EventCommonParams
31
+ */
32
+ export interface FacebookPixelCommonEventParams extends EventCommonParams {
33
+ }
34
+ /**
35
+ * Facebook Pixel custom event shared parameters.
36
+ *
37
+ * @interface FacebookPixelCustomEventParams
38
+ * @since 0.5.14
39
+ */
40
+ export interface FacebookPixelCustomEventParams {
41
+ [key: string]: any;
42
+ }
43
+ export declare namespace Fbq {
44
+ interface Fbq {
45
+ (command: "trackSingle", targetId: string, eventName: EventNames, eventParams?: ControlParams | EventParams | CustomParams): void;
46
+ (command: "trackSingleCustom", targetId: string, eventName: string, eventParams?: ControlParams | EventParams | CustomParams): void;
47
+ }
48
+ interface CustomParams {
49
+ [key: string]: any;
50
+ }
51
+ interface ControlParams {
52
+ }
53
+ type EventNames = "PageView" | "CompleteRegistration" | "FindLocation" | "Search" | "CustomizeProduct" | "InitiateCheckout" | "AddPaymentInfo" | "Schedule" | "Purchase" | "Lead" | "AddToCart" | "AddToWishlist" | "Contact";
54
+ interface EventParams {
55
+ currency?: string;
56
+ value?: number;
57
+ }
58
+ }
@@ -0,0 +1,11 @@
1
+ import { FacebookPixelProvider } from "../../../FacebookPixel.types";
2
+ import { ChangePasswordAttemptParams } from "./changePasswordAttempt.types";
3
+ /**
4
+ * Emits a changePasswordAttempt event to a Facebook Pixel Provider.
5
+ *
6
+ * @since 0.5.14
7
+ * @param {FacebookPixelProvider} provider The provider instance that will emit the event
8
+ * @param {ChangePasswordAttemptParams} params Event configuration parameters
9
+ */
10
+ declare const changePasswordAttempt: (provider: FacebookPixelProvider, params: ChangePasswordAttemptParams) => void;
11
+ export default changePasswordAttempt;
@@ -0,0 +1,14 @@
1
+ import { ChangePasswordAttemptCommonParams } from "../../../../../events/auth/changePasswordAttempt/changePasswordAttempt.types";
2
+ import { FacebookPixelCommonEventParams } from "../../../../FacebookPixel/FacebookPixel.types";
3
+ import { FacebookPixelCustomEventParams } from "../../../../FacebookPixel/FacebookPixel.types";
4
+ /**
5
+ * Event allowed parameters.
6
+ *
7
+ * @interface ChangePasswordAttemptParams
8
+ * @since 0.5.14
9
+ * @extends FacebookPixelCommonEventParams
10
+ * @extends FacebookPixelCustomEventParams
11
+ * @extends ChangePasswordAttemptCommonParams
12
+ */
13
+ export interface ChangePasswordAttemptParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ChangePasswordAttemptCommonParams {
14
+ }
@@ -0,0 +1,11 @@
1
+ import { FacebookPixelProvider } from "../../../FacebookPixel.types";
2
+ import { ChangePasswordFailParams } from "./changePasswordFail.types";
3
+ /**
4
+ * Emits a changePasswordFail event to a Facebook Pixel Provider.
5
+ *
6
+ * @since 0.5.14
7
+ * @param {FacebookPixelProvider} provider The provider instance that will emit the event
8
+ * @param {ChangePasswordFailParams} params Event configuration parameters
9
+ */
10
+ declare const changePasswordFail: (provider: FacebookPixelProvider, params: ChangePasswordFailParams) => void;
11
+ export default changePasswordFail;
@@ -0,0 +1,14 @@
1
+ import { ChangePasswordFailCommonParams } from "../../../../../events/auth/changePasswordFail/changePasswordFail.types";
2
+ import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
3
+ import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
4
+ /**
5
+ * Event allowed parameters.
6
+ *
7
+ * @interface ChangePasswordFailParams
8
+ * @since 0.5.14
9
+ * @extends FacebookPixelCommonEventParams
10
+ * @extends FacebookPixelCustomEventParams
11
+ * @extends ChangePasswordFailCommonParams
12
+ */
13
+ export interface ChangePasswordFailParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ChangePasswordFailCommonParams {
14
+ }
@@ -0,0 +1,11 @@
1
+ import { FacebookPixelProvider } from "../../../FacebookPixel.types";
2
+ import { ChangePasswordSuccessParams } from "./changePasswordSuccess.types";
3
+ /**
4
+ * Emits a changePasswordSuccess event to a Facebook Pixel Provider.
5
+ *
6
+ * @since 0.5.14
7
+ * @param {FacebookPixelProvider} provider The provider instance that will emit the event
8
+ * @param {ChangePasswordSuccessParams} params Event configuration parameters
9
+ */
10
+ declare const changePasswordSuccess: (provider: FacebookPixelProvider, params: ChangePasswordSuccessParams) => void;
11
+ export default changePasswordSuccess;
@@ -0,0 +1,14 @@
1
+ import { ChangePasswordSuccessCommonParams } from "../../../../../events/auth/changePasswordSuccess/changePasswordSuccess.types";
2
+ import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
3
+ import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
4
+ /**
5
+ * Event allowed parameters.
6
+ *
7
+ * @interface ChangePasswordSuccessParams
8
+ * @since 0.5.14
9
+ * @extends FacebookPixelCommonEventParams
10
+ * @extends FacebookPixelCustomEventParams
11
+ * @extends ChangePasswordSuccessCommonParams
12
+ */
13
+ export interface ChangePasswordSuccessParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ChangePasswordSuccessCommonParams {
14
+ }