@ginger-ai/ginger-react 0.0.3

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 (37) hide show
  1. package/dist/client/index.d.ts +16 -0
  2. package/dist/client/index.d.ts.map +1 -0
  3. package/dist/constants.d.ts +5 -0
  4. package/dist/constants.d.ts.map +1 -0
  5. package/dist/contexts/index.d.ts +3 -0
  6. package/dist/contexts/index.d.ts.map +1 -0
  7. package/dist/helper.d.ts +4 -0
  8. package/dist/helper.d.ts.map +1 -0
  9. package/dist/hooks/index.d.ts +3 -0
  10. package/dist/hooks/index.d.ts.map +1 -0
  11. package/dist/hooks/useEvent/computeFieldMetrics.d.ts +9 -0
  12. package/dist/hooks/useEvent/computeFieldMetrics.d.ts.map +1 -0
  13. package/dist/hooks/useEvent/fieldUpdater.d.ts +15 -0
  14. package/dist/hooks/useEvent/fieldUpdater.d.ts.map +1 -0
  15. package/dist/hooks/useEvent/helper.d.ts +5 -0
  16. package/dist/hooks/useEvent/helper.d.ts.map +1 -0
  17. package/dist/hooks/useEvent/index.d.ts +12 -0
  18. package/dist/hooks/useEvent/index.d.ts.map +1 -0
  19. package/dist/hooks/useEvent/submit.d.ts +10 -0
  20. package/dist/hooks/useEvent/submit.d.ts.map +1 -0
  21. package/dist/hooks/useGinger.d.ts +6 -0
  22. package/dist/hooks/useGinger.d.ts.map +1 -0
  23. package/dist/http/index.d.ts +19 -0
  24. package/dist/http/index.d.ts.map +1 -0
  25. package/dist/http/request.d.ts +9 -0
  26. package/dist/http/request.d.ts.map +1 -0
  27. package/dist/index.cjs.js +558 -0
  28. package/dist/index.cjs.js.map +1 -0
  29. package/dist/index.d.ts +3 -0
  30. package/dist/index.d.ts.map +1 -0
  31. package/dist/index.esm.js +554 -0
  32. package/dist/index.esm.js.map +1 -0
  33. package/dist/provider/index.d.ts +4 -0
  34. package/dist/provider/index.d.ts.map +1 -0
  35. package/dist/types.d.ts +101 -0
  36. package/dist/types.d.ts.map +1 -0
  37. package/package.json +47 -0
@@ -0,0 +1,16 @@
1
+ import { Event, PayloadResponse } from "../types";
2
+ interface Store {
3
+ request_id: string;
4
+ fingerprint_id: string;
5
+ }
6
+ export declare class GingerClient {
7
+ private static readonly instance;
8
+ private store;
9
+ static getInstance(): GingerClient;
10
+ initialize(apikey: string): Promise<PayloadResponse>;
11
+ submitEvent(apikey: string, payload: Event.Payload): Promise<Event.Response>;
12
+ updateStore(params: Store | undefined): void;
13
+ getStoreData(): Store | undefined;
14
+ }
15
+ export {};
16
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAGlD,UAAU,KAAK;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAoC;IACpE,OAAO,CAAC,KAAK,CAAgC;WAE/B,WAAW,IAAI,YAAY;IAInC,UAAU,CAAC,MAAM,EAAE,MAAM;IAkBzB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO;IAajD,WAAW,CAAC,MAAM,EAAE,KAAK,GAAG,SAAS,GAAG,IAAI;IAI5C,YAAY,IAAI,KAAK,GAAG,SAAS;CAGzC"}
@@ -0,0 +1,5 @@
1
+ export declare const CONSTANTS: {
2
+ LIVE_URL: string;
3
+ TEST_URL: string;
4
+ };
5
+ //# sourceMappingURL=constants.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;CAGrB,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { ConfigurationProps } from "../types";
2
+ export declare const GingerClientContext: import("react").Context<ConfigurationProps | undefined>;
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/contexts/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD,eAAO,MAAM,mBAAmB,yDAEpB,CAAC"}
@@ -0,0 +1,4 @@
1
+ export default function getBasePath(apikey: string): string;
2
+ export declare const encode: (apikey: string, payload: unknown) => string;
3
+ export declare const decode: (apikey: string, encoded: string) => unknown;
4
+ //# sourceMappingURL=helper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,MAAM,EAAE,MAAM,UAKjD;AAQD,eAAO,MAAM,MAAM,GAAI,QAAQ,MAAM,EAAE,SAAS,OAAO,KAAG,MAiBzD,CAAC;AAEF,eAAO,MAAM,MAAM,GAAI,QAAQ,MAAM,EAAE,SAAS,MAAM,KAAG,OAaxD,CAAC"}
@@ -0,0 +1,3 @@
1
+ export { useEvent } from "./useEvent";
2
+ export { useGinger } from "./useGinger";
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}
@@ -0,0 +1,9 @@
1
+ interface computeFieldParams {
2
+ id: string;
3
+ e: any;
4
+ currentField: any;
5
+ focusInputFields: any;
6
+ }
7
+ export declare const computeFieldInputMetrics: ({ id, e, currentField, focusInputFields, }: computeFieldParams) => any;
8
+ export {};
9
+ //# sourceMappingURL=computeFieldMetrics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"computeFieldMetrics.d.ts","sourceRoot":"","sources":["../../../src/hooks/useEvent/computeFieldMetrics.ts"],"names":[],"mappings":"AAEA,UAAU,kBAAkB;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,GAAG,CAAC;IACP,YAAY,EAAE,GAAG,CAAC;IAClB,gBAAgB,EAAE,GAAG,CAAC;CACvB;AAED,eAAO,MAAM,wBAAwB,GAAI,4CAKtC,kBAAkB,QAsCpB,CAAC"}
@@ -0,0 +1,15 @@
1
+ import { Event } from "../../types";
2
+ export declare const FieldUpdater: (id: string, currentField: any, e: any, focusFields: Event.FocusMetrics) => {
3
+ field_name: string;
4
+ started_at: any;
5
+ ended_at: number;
6
+ interaction_count: any;
7
+ characters_count: any;
8
+ fill_method: Event.InputFillType;
9
+ paste_count: any;
10
+ corrections_count: any;
11
+ pauses: any;
12
+ hesitation_time: number;
13
+ pause_durations: number[];
14
+ };
15
+ //# sourceMappingURL=fieldUpdater.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fieldUpdater.d.ts","sourceRoot":"","sources":["../../../src/hooks/useEvent/fieldUpdater.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,cAAc,GAAG,EACjB,GAAG,GAAG,EACN,aAAa,KAAK,CAAC,YAAY;;;;;;;;;;;;CAyChC,CAAC"}
@@ -0,0 +1,5 @@
1
+ import { Event } from "../../types";
2
+ export declare const getDeviceTimeOrigin: () => number;
3
+ export declare const createDefaultMetrics: (fieldName: string, ltm: boolean) => Event.FieldMetrics;
4
+ export declare const MODIFIER_KEYS: string[];
5
+ //# sourceMappingURL=helper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../../src/hooks/useEvent/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,eAAO,MAAM,mBAAmB,QAAO,MAEtC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,WAAW,MAAM,EACjB,KAAK,OAAO,KACX,KAAK,CAAC,YAcP,CAAC;AAEH,eAAO,MAAM,aAAa,UAwBzB,CAAC"}
@@ -0,0 +1,12 @@
1
+ import { Event } from "../../types";
2
+ type UseEventReturn = {
3
+ register: (id: string, extraHandler?: any) => {
4
+ onChange: (e: React.ChangeEvent<any>) => void;
5
+ onFocus?: (e: React.FocusEvent<any>) => void;
6
+ } | {};
7
+ fieldFocusMetricsRef: Event.FocusMetrics;
8
+ submitEvent: () => Promise<any>;
9
+ };
10
+ export declare const useEvent: ({ event_type, track_fields, request_id, }: Event.Params) => UseEventReturn;
11
+ export {};
12
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useEvent/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAMpC,KAAK,cAAc,GAAG;IACpB,QAAQ,EAAE,CACR,EAAE,EAAE,MAAM,EACV,YAAY,CAAC,EAAE,GAAG,KAEhB;QACE,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;QAC9C,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;KAC9C,GACD,EAAE,CAAC;IACP,oBAAoB,EAAE,KAAK,CAAC,YAAY,CAAC;IACzC,WAAW,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;CACjC,CAAC;AAWF,eAAO,MAAM,QAAQ,GAAI,2CAItB,KAAK,CAAC,MAAM,KAAG,cA2SjB,CAAC"}
@@ -0,0 +1,10 @@
1
+ interface Params {
2
+ event_type: any;
3
+ request_id: string | undefined;
4
+ fieldsMetrics: any;
5
+ distractions_count: number;
6
+ device_time_origin: number;
7
+ }
8
+ export declare const submitTrackedData: (apikey: string, { event_type, request_id, fieldsMetrics, distractions_count, device_time_origin }: Params) => Promise<import("../../types").Event.Response>;
9
+ export {};
10
+ //# sourceMappingURL=submit.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"submit.d.ts","sourceRoot":"","sources":["../../../src/hooks/useEvent/submit.ts"],"names":[],"mappings":"AAEA,UAAU,MAAM;IACd,UAAU,EAAE,GAAG,CAAC;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,aAAa,EAAE,GAAG,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,MAAM,EACd,mFAAmF,MAAM,kDA8B1F,CAAC"}
@@ -0,0 +1,6 @@
1
+ export declare const useGinger: () => {
2
+ loading: boolean;
3
+ error: string | null;
4
+ initialize: () => Promise<import("../types").PayloadResponse>;
5
+ };
6
+ //# sourceMappingURL=useGinger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useGinger.d.ts","sourceRoot":"","sources":["../../src/hooks/useGinger.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,SAAS;;;;CA8CrB,CAAC"}
@@ -0,0 +1,19 @@
1
+ declare enum METHOD {
2
+ POST = "POST"
3
+ }
4
+ interface HTTPOptions<T> {
5
+ url: string;
6
+ payload: T;
7
+ method?: METHOD;
8
+ }
9
+ export interface HTTPClient {
10
+ post<T, U>(options: HTTPOptions<T>): Promise<U>;
11
+ }
12
+ export declare class GingerHttpClient implements HTTPClient {
13
+ readonly baseUrl: string;
14
+ readonly apikey: string;
15
+ constructor(apikey: string);
16
+ post<T, U>(options: HTTPOptions<T>): Promise<U>;
17
+ }
18
+ export {};
19
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/http/index.ts"],"names":[],"mappings":"AAGA,aAAK,MAAM;IACT,IAAI,SAAS;CACd;AAED,UAAU,WAAW,CAAC,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACjD;AAED,qBAAa,gBAAiB,YAAW,UAAU;IACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,MAAM,EAAE,MAAM;IAKpB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAiBtD"}
@@ -0,0 +1,9 @@
1
+ type METHOD = 'POST' | 'GET' | 'PUT' | 'DELETE';
2
+ export declare const sendRequest: <T, U>({ url, payload, apikey, method, }: {
3
+ url: string;
4
+ payload: T;
5
+ apikey: string;
6
+ method: METHOD;
7
+ }) => Promise<U>;
8
+ export {};
9
+ //# sourceMappingURL=request.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/http/request.ts"],"names":[],"mappings":"AACA,KAAK,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEhD,eAAO,MAAM,WAAW,GAAU,CAAC,EAAE,CAAC,EAAE,mCAKrC;IACD,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,KAAG,OAAO,CAAC,CAAC,CAsBZ,CAAC"}