@keak/sdk 1.0.9 → 2.0.0

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/dist/index.d.ts CHANGED
@@ -11,8 +11,9 @@ export type ExperimentProps = {
11
11
  active?: boolean;
12
12
  };
13
13
  export interface KeakConfig {
14
- apiKey: string;
15
- apiUrl?: string;
14
+ projectRoot?: string;
15
+ editor?: 'vscode' | 'cursor' | 'webstorm' | 'intellij' | 'atom' | 'sublime' | 'windsurf';
16
+ showToolbar?: boolean;
16
17
  userId?: string;
17
18
  sessionId?: string;
18
19
  debug?: boolean;
@@ -56,30 +57,62 @@ export interface ConversionSnapshot {
56
57
  visitorMetadata: VisitorMetadata;
57
58
  additionalData: Record<string, any>;
58
59
  }
59
- export declare function KeakProvider({ config, children, showToolbar, // Changed to false - users should add <KeakToolbar /> manually
60
- toolbarConfig }: {
61
- config?: Partial<KeakConfig>;
62
- children: ReactNode;
63
- showToolbar?: boolean;
64
- toolbarConfig?: {
65
- position?: 'top-center' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
66
- theme?: 'light' | 'dark' | 'auto';
67
- };
68
- }): import("react/jsx-runtime").JSX.Element;
69
- export declare function useKeak(): {
70
- config?: KeakConfig;
60
+ declare class KeakSDK {
61
+ config: KeakConfig;
71
62
  assignments: Record<string, string>;
72
- trackEvent: (eventName: string, properties?: EventProperties) => void;
73
- };
74
- export declare function useExperiment(experimentKey: string): {
75
- variant: string;
76
- track: (eventName: string, properties?: EventProperties) => void;
77
- isInExperiment: boolean;
78
- };
63
+ private eventQueue;
64
+ private initialized;
65
+ private userId;
66
+ private sessionId;
67
+ private deviceId;
68
+ private liveExperiments;
69
+ private impressions;
70
+ constructor(config: KeakConfig);
71
+ init(): Promise<void>;
72
+ getVariant(experimentKey: string, availableVariants?: string[]): string;
73
+ trackEvent(eventName: string, properties?: EventProperties): void;
74
+ trackClick(elementId: string, text?: string): void;
75
+ trackConversion(conversionName: string, value?: number, additionalData?: Record<string, any>): void;
76
+ private takeVariantSnapshot;
77
+ private storeConversionLocally;
78
+ private setupAutoTracking;
79
+ private flushEvents;
80
+ private generateUserId;
81
+ private generateSessionId;
82
+ private generateDeviceId;
83
+ private captureVisitorMetadata;
84
+ private simpleHash;
85
+ private assignVariant;
86
+ private loadImpressions;
87
+ private saveImpressions;
88
+ trackImpression(experimentId: string, variantName: string): void;
89
+ private storeImpressionWithMetadata;
90
+ getImpressions(experimentId: string): Record<string, number>;
91
+ getAllImpressions(): Record<string, Record<string, number>>;
92
+ registerLiveExperiment(experimentData: any): void;
93
+ getAllLiveExperiments(): any[];
94
+ setExperimentVariant(experimentId: string, variant: string): void;
95
+ }
96
+ /**
97
+ * Main Keak hook - initializes the SDK with minimal configuration
98
+ * Similar to react-source-lens's useReactSourceLens() hook
99
+ *
100
+ * @example
101
+ * // Minimal usage (no config needed)
102
+ * useKeak();
103
+ *
104
+ * @example
105
+ * // With IDE integration
106
+ * useKeak({
107
+ * projectRoot: '/absolute/path/to/project',
108
+ * editor: 'vscode'
109
+ * });
110
+ */
111
+ export declare function useKeak(config?: KeakConfig): KeakSDK | null;
79
112
  export declare const Variant: ({ children }: VariantProps) => import("react/jsx-runtime").JSX.Element;
80
113
  export declare const Experiment: ({ name, children, active }: ExperimentProps) => import("react/jsx-runtime").JSX.Element | null;
81
114
  export declare const keak: {
82
- init: (config: KeakConfig) => Promise<void>;
115
+ init: (config?: KeakConfig) => Promise<void>;
83
116
  getVariant: (experimentKey: string, availableVariants?: string[]) => string;
84
117
  track: (eventName: string, properties?: EventProperties) => void;
85
118
  trackClick: (elementId: string, text?: string) => void;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAEA,OAAO,cAAc,CAAC;AACtB,OAAO,0BAA0B,CAAC;AAClC,OAAc,EAGZ,SAAS,EAOV,MAAM,OAAO,CAAC;AAGf,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC1C;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE;QACR,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC;AAqaD,wBAAgB,YAAY,CAAC,EAC3B,MAAW,EACX,QAAQ,EACR,WAAmB,EAAE,+DAA+D;AACpF,aAAa,EACd,EAAE;IACD,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7B,QAAQ,EAAE,SAAS,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE;QACd,QAAQ,CAAC,EAAE,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,CAAC;QACpF,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;KACnC,CAAC;CACH,2CAmKA;AAGD,wBAAgB,OAAO;aAplBZ,UAAU;iBACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;gBACvB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,eAAe,KAAK,IAAI;EAwlBtE;AAGD,wBAAgB,aAAa,CAAC,aAAa,EAAE,MAAM;;uBAIX,MAAM,eAAe,eAAe;;EAa3E;AAGD,eAAO,MAAM,OAAO,GAAI,cAAc,YAAY,4CAEjD,CAAC;AAwDF,eAAO,MAAM,UAAU,GAAI,4BAAmC,eAAe,mDA4L5E,CAAC;AAGF,eAAO,MAAM,IAAI;mBACA,UAAU;gCAmBG,MAAM,sBAAsB,MAAM,EAAE;uBAQ7C,MAAM,eAAe,eAAe;4BAO/B,MAAM,SAAS,MAAM;sCAOX,MAAM,UAAU,MAAM,mBAAmB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;yCAiBzD,MAAM,WAAW,MAAM;oCAK5B,MAAM,eAAe,MAAM;mCAI5B,MAAM;;CAetC,CAAC;AAGF,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE;IACzC,QAAQ,CAAC,EAAE,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,CAAC;IACpF,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;CACnC,QAoDA;AAED,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAEA,OAAO,cAAc,CAAC;AACtB,OAAO,0BAA0B,CAAC;AAClC,OAAc,EAGZ,SAAS,EAGV,MAAM,OAAO,CAAC;AAGf,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;IACzF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC1C;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE;QACR,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC;AAMD,cAAM,OAAO;IACJ,MAAM,EAAE,UAAU,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAChD,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,eAAe,CAA+B;IACtD,OAAO,CAAC,WAAW,CAA+C;gBAEtD,MAAM,EAAE,UAAU;IAQxB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB3B,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM;IAWvE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,GAAE,eAAoB,GAAG,IAAI;IAOrE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAOlD,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAanG,OAAO,CAAC,mBAAmB;IAwC3B,OAAO,CAAC,sBAAsB;IAmB9B,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,sBAAsB;IA0D9B,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,eAAe;IAmBvB,OAAO,CAAC,eAAe;IAcvB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAehE,OAAO,CAAC,2BAA2B;IA8BnC,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAK5D,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAS3D,sBAAsB,CAAC,cAAc,EAAE,GAAG,GAAG,IAAI;IAiBjD,qBAAqB,IAAI,GAAG,EAAE;IAK9B,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;CAoBlE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CAAC,MAAM,GAAE,UAAe,kBAwJ9C;AAGD,eAAO,MAAM,OAAO,GAAI,cAAc,YAAY,4CAEjD,CAAC;AAwDF,eAAO,MAAM,UAAU,GAAI,4BAAmC,eAAe,mDAkM5E,CAAC;AAGF,eAAO,MAAM,IAAI;oBACA,UAAU;gCAaG,MAAM,sBAAsB,MAAM,EAAE;uBAQ7C,MAAM,eAAe,eAAe;4BAO/B,MAAM,SAAS,MAAM;sCAOX,MAAM,UAAU,MAAM,mBAAmB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;yCAiBzD,MAAM,WAAW,MAAM;oCAK5B,MAAM,eAAe,MAAM;mCAI5B,MAAM;;CAetC,CAAC;AAGF,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE;IACzC,QAAQ,CAAC,EAAE,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,CAAC;IACpF,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;CACnC,QA4CA;AAED,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC"}