@xyo-network/react-user-events 6.0.0 → 6.1.1

package/dist/browser/index.d.ts

@@ -0,0 +1,127 @@
+import { EmptyObject } from '@xylabs/object';
+import { UserEventHandler, FunnelStartedFields, TestStartedFields, UserClickFields, ViewContentFields, PurchaseFields } from '@xylabs/pixel';
+import { Mixpanel } from 'mixpanel-browser';
+import { Promisable } from '@xylabs/promise';
+
+interface XnsEstimateFields extends EmptyObject {
+    name: string;
+}
+interface XnsEstimateAttemptedFields extends XnsEstimateFields {
+}
+interface XnsEstimateSuccessFields extends XnsEstimateFields {
+    price: number;
+}
+interface XnsEstimateFailureFields extends XnsEstimateFields {
+    error: string;
+}
+interface XnsEstimateEventHandlerInterface<TData extends EmptyObject> extends UserEventHandler<TData> {
+    xnsEstimateAttempted<T extends TData>(fields: XnsEstimateAttemptedFields | T): Promisable<void>;
+    xnsEstimateFailure<T extends TData>(fields: XnsEstimateFailureFields | T): Promisable<void>;
+    xnsEstimateSuccess<T extends TData>(fields: XnsEstimateSuccessFields | T): Promisable<void>;
+}
+
+interface XnsPurchaseFields extends EmptyObject {
+    name: string;
+    price: number;
+}
+interface XnsPurchaseAttemptedFields extends XnsPurchaseFields {
+}
+interface XnsPurchaseSuccessFields extends XnsPurchaseFields {
+    currency?: string;
+    /** Identifier for the purchase - rebilly or payload hash */
+    id: string;
+    quantity?: number;
+    /** price - discount */
+    value: number;
+}
+interface XnsPurchaseFailureFields extends XnsPurchaseFields {
+    error: string;
+}
+interface XnsPurchaseEventHandlerInterface<TData extends EmptyObject> extends UserEventHandler<TData> {
+    xnsPurchaseAttempted<T extends TData>(fields: T | XnsPurchaseAttemptedFields): Promisable<void>;
+    xnsPurchaseFailure<T extends TData>(fields: T | XnsPurchaseFailureFields): Promisable<void>;
+    xnsPurchaseSuccess<T extends TData>(fields: T | XnsPurchaseSuccessFields): Promisable<void>;
+}
+
+interface XnsReservationFields extends EmptyObject {
+    email_hash: string;
+    name: string;
+}
+interface XnsReservationAttemptedFields extends XnsReservationFields {
+}
+interface XnsReservationSuccessFields extends XnsReservationFields {
+}
+interface XnsReservationFailureFields extends XnsReservationFields {
+    error: string;
+}
+interface XnsReservationEventHandlerInterface<TData extends EmptyObject> extends UserEventHandler<TData> {
+    xnsReservationAttempted<T extends TData>(fields: T | XnsReservationAttemptedFields): Promisable<void>;
+    xnsReservationFailure<T extends TData>(fields: T | XnsReservationFailureFields): Promisable<void>;
+    xnsReservationSuccess<T extends TData>(fields: T | XnsReservationSuccessFields): Promisable<void>;
+}
+
+interface XyoNewsletterSignupFields extends Record<string, unknown> {
+    email: string;
+    url: string;
+}
+interface XyoEventHandlerInterface<TData extends EmptyObject> extends UserEventHandler<TData>, XnsEstimateEventHandlerInterface<TData>, XnsReservationEventHandlerInterface<TData>, XnsPurchaseEventHandlerInterface<TData> {
+    funnelStarted<T extends TData>(_fields: T | FunnelStartedFields): Promisable<void>;
+    testStarted<T extends TData>(_fields: T | TestStartedFields): Promisable<void>;
+    userClick<T extends TData>(fields: T | UserClickFields): Promisable<void>;
+    viewContent<T extends TData>(fields: T | ViewContentFields): Promisable<void>;
+    xyoNewsletterSignup<T extends TData>(fields: T | XyoNewsletterSignupFields): Promisable<void>;
+}
+
+declare class XyoUserEvents<TData extends EmptyObject = EmptyObject> extends UserEventHandler<TData> {
+    static instance: XyoUserEvents<EmptyObject>;
+    protected handlers: XyoEventHandlerInterface<TData>[];
+    private constructor();
+    static get<T extends EmptyObject = EmptyObject>(mixpanel?: Mixpanel): XyoUserEvents<object>;
+    funnelStarted<T extends TData>(_fields: T | FunnelStartedFields): Promise<void>;
+    testStarted<T extends TData>(_fields: T | TestStartedFields): Promise<void>;
+    userClick<T extends TData>(fields: T | UserClickFields): Promise<void>;
+    viewContent<T extends TData>(fields: T | ViewContentFields): Promise<void>;
+    xnsEstimateAttempted<T extends TData>(fields: T | XnsEstimateAttemptedFields): Promise<void>;
+    xnsEstimateFailure<T extends TData>(fields: T | XnsEstimateFailureFields): Promise<void>;
+    xnsEstimateSuccess<T extends TData>(fields: T | XnsEstimateSuccessFields): Promise<void>;
+    xnsPurchaseAttempted<T extends TData>(fields: T | XnsPurchaseAttemptedFields): Promise<void>;
+    xnsPurchaseFailure<T extends TData>(fields: T | XnsPurchaseFailureFields): Promise<void>;
+    xnsPurchaseSuccess<T extends TData>(fields: T | XnsPurchaseSuccessFields): Promise<void>;
+    xnsReservationAttempted<T extends TData>(fields: T | XnsReservationAttemptedFields): Promise<void>;
+    xnsReservationFailure<T extends TData>(fields: T | XnsReservationFailureFields): Promise<void>;
+    xnsReservationSuccess<T extends TData>(fields: T | XnsReservationSuccessFields): Promise<void>;
+    xyoNewsletterSignup<T extends TData>(fields: T | XyoNewsletterSignupFields): Promise<void>;
+}
+
+declare const useXyoUserEvents: () => XyoUserEvents;
+
+interface Event<TData extends EmptyObject = EmptyObject> {
+    send<T extends TData>(fields: T, eventId?: string): Promisable<void>;
+}
+interface Events<TData extends EmptyObject = EmptyObject> {
+    custom<T extends TData>(name: string): Event<T>;
+    purchase<T extends TData>(): Event<PurchaseFields | T>;
+    userClick<T extends TData>(): Event<UserClickFields | T>;
+    viewContent<T extends TData>(): Event<ViewContentFields | T>;
+}
+declare class XyoEventHandler<T extends EmptyObject> extends UserEventHandler<T> implements XyoEventHandlerInterface<T> {
+    private _events;
+    get events(): Events<T>;
+    funnelStarted(_fields: T | FunnelStartedFields): Promise<void>;
+    testStarted(_fields: T | TestStartedFields): Promise<void>;
+    userClick(fields: UserClickFields): Promise<void>;
+    viewContent(fields: ViewContentFields): Promise<void>;
+    xnsEstimateAttempted(fields: XnsEstimateAttemptedFields | T): Promise<void>;
+    xnsEstimateFailure(fields: XnsEstimateFailureFields | T): Promise<void>;
+    xnsEstimateSuccess(fields: XnsEstimateSuccessFields | T): Promise<void>;
+    xnsPurchaseAttempted(fields: XnsPurchaseAttemptedFields | T): Promise<void>;
+    xnsPurchaseFailure(fields: XnsPurchaseFailureFields | T): Promise<void>;
+    xnsPurchaseSuccess(fields: XnsPurchaseSuccessFields): Promise<void>;
+    xnsReservationAttempted(fields: XnsReservationAttemptedFields | T): Promise<void>;
+    xnsReservationFailure(fields: XnsReservationFailureFields | T): Promise<void>;
+    xnsReservationSuccess(fields: XnsReservationSuccessFields | T): Promise<void>;
+    xyoNewsletterSignup(fields: XyoNewsletterSignupFields | T): Promise<void>;
+}
+
+export { XyoEventHandler, XyoUserEvents, useXyoUserEvents };
+export type { Event, Events, XyoEventHandlerInterface, XyoNewsletterSignupFields };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-user-events",
-  "version": "6.0.0",
+  "version": "6.1.1",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -28,30 +28,30 @@
   "exports": {
     ".": {
       "import": {
-        "types": "./dist/types/index.d.ts",
+        "types": "./dist/browser/index.d.ts",
         "default": "./dist/browser/index.mjs"
       },
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/browser/index.d.ts",
       "default": "./dist/browser/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/browser/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/object": "^4.12.31",
-    "@xylabs/pixel": "^4.12.31",
-    "@xylabs/promise": "^4.12.31",
-    "@xylabs/react-pixel": "^6.3.7",
-    "mixpanel-browser": "^2.65.0"
+    "@xylabs/object": "^4.13.15",
+    "@xylabs/pixel": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xylabs/react-pixel": "^6.3.10",
+    "mixpanel-browser": "^2.66.0"
   },
   "devDependencies": {
     "@mui/icons-material": "^7.2.0",
     "@mui/material": "^7.2.0",
     "@types/mixpanel-browser": "^2.60.0",
     "@types/react": "^19.1.8",
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig-react": "^6.5.12",
+    "@xylabs/ts-scripts-yarn3": "next",
+    "@xylabs/tsconfig-react": "next",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "react-router-dom": "^7.6.3",

package/dist/types/index.d.ts

@@ -1,5 +0,0 @@
-export * from './hooks/index.ts';
-export * from './XyoEventHandler.ts';
-export * from './XyoEventHandlerInterface.ts';
-export { XyoUserEvents } from './XyoUserEvents.ts';
-//# sourceMappingURL=index.d.ts.map