@amplitude/unified 1.0.0-beta.0 → 1.0.0-beta.10

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 (52) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +122 -0
  3. package/lib/cjs/index.d.ts +1 -1
  4. package/lib/cjs/index.d.ts.map +1 -1
  5. package/lib/cjs/index.js +3 -3
  6. package/lib/cjs/index.js.map +1 -1
  7. package/lib/cjs/library.d.ts +3 -0
  8. package/lib/cjs/library.d.ts.map +1 -0
  9. package/lib/cjs/library.js +23 -0
  10. package/lib/cjs/library.js.map +1 -0
  11. package/lib/cjs/unified-client-factory.d.ts.map +1 -1
  12. package/lib/cjs/unified-client-factory.js +5 -2
  13. package/lib/cjs/unified-client-factory.js.map +1 -1
  14. package/lib/cjs/unified.d.ts +13 -13
  15. package/lib/cjs/unified.d.ts.map +1 -1
  16. package/lib/cjs/unified.js +38 -23
  17. package/lib/cjs/unified.js.map +1 -1
  18. package/lib/cjs/version.d.ts +2 -0
  19. package/lib/cjs/version.d.ts.map +1 -0
  20. package/lib/cjs/version.js +6 -0
  21. package/lib/cjs/version.js.map +1 -0
  22. package/lib/esm/index.d.ts +1 -1
  23. package/lib/esm/index.d.ts.map +1 -1
  24. package/lib/esm/index.js +2 -2
  25. package/lib/esm/index.js.map +1 -1
  26. package/lib/esm/library.d.ts +3 -0
  27. package/lib/esm/library.d.ts.map +1 -0
  28. package/lib/esm/library.js +19 -0
  29. package/lib/esm/library.js.map +1 -0
  30. package/lib/esm/unified-client-factory.d.ts.map +1 -1
  31. package/lib/esm/unified-client-factory.js +5 -2
  32. package/lib/esm/unified-client-factory.js.map +1 -1
  33. package/lib/esm/unified.d.ts +13 -13
  34. package/lib/esm/unified.d.ts.map +1 -1
  35. package/lib/esm/unified.js +38 -23
  36. package/lib/esm/unified.js.map +1 -1
  37. package/lib/esm/version.d.ts +2 -0
  38. package/lib/esm/version.d.ts.map +1 -0
  39. package/lib/esm/version.js +3 -0
  40. package/lib/esm/version.js.map +1 -0
  41. package/lib/scripts/amplitude-min.umd.js +1 -1
  42. package/lib/scripts/amplitude-min.umd.js.gz +0 -0
  43. package/lib/scripts/index.d.ts +1 -1
  44. package/lib/scripts/index.d.ts.map +1 -1
  45. package/lib/scripts/library.d.ts +3 -0
  46. package/lib/scripts/library.d.ts.map +1 -0
  47. package/lib/scripts/unified-client-factory.d.ts.map +1 -1
  48. package/lib/scripts/unified.d.ts +13 -13
  49. package/lib/scripts/unified.d.ts.map +1 -1
  50. package/lib/scripts/version.d.ts +2 -0
  51. package/lib/scripts/version.d.ts.map +1 -0
  52. package/package.json +15 -5
Binary file
@@ -1,4 +1,4 @@
1
1
  export { createInstance } from './unified-client-factory';
2
- export declare const initAll: (apiKey: string, unifiedOptions?: import("./unified").UnifiedOptions | undefined) => Promise<void>, experiment: import("@amplitude/experiment-js-client").Client, sr: import("@amplitude/session-replay-browser").AmplitudeSessionReplay, add: (plugin: import("@amplitude/analytics-core").Plugin<import("@amplitude/analytics-core").BrowserClient, import("@amplitude/analytics-core").BrowserConfig>) => import("@amplitude/analytics-core").AmplitudeReturn<void>, extendSession: () => void, flush: () => import("@amplitude/analytics-core").AmplitudeReturn<void>, getDeviceId: () => string | undefined, getSessionId: () => number | undefined, getUserId: () => string | undefined, groupIdentify: (groupType: string, groupName: string | string[], identify: import("@amplitude/analytics-core").IIdentify, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, identify: (identify: import("@amplitude/analytics-core").IIdentify, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, logEvent: (eventInput: string | import("@amplitude/analytics-core").BaseEvent, eventProperties?: Record<string, any> | undefined, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, remove: (pluginName: string) => import("@amplitude/analytics-core").AmplitudeReturn<void>, reset: () => void, revenue: (revenue: import("@amplitude/analytics-core").IRevenue, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, setDeviceId: (deviceId: string) => void, setGroup: (groupType: string, groupName: string | string[], eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, setOptOut: (optOut: boolean) => void, setSessionId: (sessionId: number) => void, setTransport: (transport: import("@amplitude/analytics-core").TransportType) => void, setUserId: (userId: string | undefined) => void, track: (eventInput: string | import("@amplitude/analytics-core").BaseEvent, eventProperties?: Record<string, any> | undefined, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>;
2
+ export declare const _setDiagnosticsSampleRate: (sampleRate: number) => void, initAll: (apiKey: string, unifiedOptions?: import("./unified").UnifiedOptions | undefined) => Promise<void>, experiment: () => import("@amplitude/experiment-js-client").Client | undefined, sessionReplay: () => import("@amplitude/session-replay-browser").AmplitudeSessionReplay, add: (plugin: import("@amplitude/analytics-core").Plugin<import("@amplitude/analytics-core").BrowserClient, import("@amplitude/analytics-core").BrowserConfig>) => import("@amplitude/analytics-core").AmplitudeReturn<void>, extendSession: () => void, flush: () => import("@amplitude/analytics-core").AmplitudeReturn<void>, getDeviceId: () => string | undefined, getSessionId: () => number | undefined, getUserId: () => string | undefined, groupIdentify: (groupType: string, groupName: string | string[], identify: import("@amplitude/analytics-core").IIdentify, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, identify: (identify: import("@amplitude/analytics-core").IIdentify, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, logEvent: (eventInput: string | import("@amplitude/analytics-core").BaseEvent, eventProperties?: Record<string, any> | undefined, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, remove: (pluginName: string) => import("@amplitude/analytics-core").AmplitudeReturn<void>, reset: () => void, revenue: (revenue: import("@amplitude/analytics-core").IRevenue, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, setDeviceId: (deviceId: string) => void, setGroup: (groupType: string, groupName: string | string[], eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>, setOptOut: (optOut: boolean) => void, setSessionId: (sessionId: number) => void, setTransport: (transport: import("@amplitude/analytics-core").TransportType) => void, setUserId: (userId: string | undefined) => void, track: (eventInput: string | import("@amplitude/analytics-core").BaseEvent, eventProperties?: Record<string, any> | undefined, eventOptions?: import("@amplitude/analytics-core").EventOptions | undefined) => import("@amplitude/analytics-core").AmplitudeReturn<import("@amplitude/analytics-core").Result>;
3
3
  export { Types } from '@amplitude/analytics-browser';
4
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,eAAO,MACL,OAAO,sGACP,UAAU,oDACV,EAAE,sEACF,GAAG,2NACH,aAAa,cACb,KAAK,mEACL,WAAW,4BACX,YAAY,4BACZ,SAAS,4BACT,aAAa,8RACb,QAAQ,6OACR,QAAQ,2SACR,MAAM,qFACN,KAAK,cACL,OAAO,2OACP,WAAW,8BACX,QAAQ,qOACR,SAAS,6BACT,YAAY,+BACZ,YAAY,0EACZ,SAAS,wCACT,KAAK,ySACG,CAAC;AACX,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,eAAO,MACL,yBAAyB,gCACzB,OAAO,sGACP,UAAU,sEACV,aAAa,4EACb,GAAG,2NACH,aAAa,cACb,KAAK,mEACL,WAAW,4BACX,YAAY,4BACZ,SAAS,4BACT,aAAa,8RACb,QAAQ,6OACR,QAAQ,2SACR,MAAM,qFACN,KAAK,cACL,OAAO,2OACP,WAAW,8BACX,QAAQ,qOACR,SAAS,6BACT,YAAY,+BACZ,YAAY,0EACZ,SAAS,wCACT,KAAK,ySACG,CAAC;AACX,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { Types } from '@amplitude/analytics-browser';
2
+ export declare const libraryPlugin: () => Types.EnrichmentPlugin;
3
+ //# sourceMappingURL=library.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"library.d.ts","sourceRoot":"","sources":["../../src/library.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAKrD,eAAO,MAAM,aAAa,QAAO,MAAM,gBAStC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"unified-client-factory.d.ts","sourceRoot":"","sources":["../../src/unified-client-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,aAAa,EAAE,MAAM,WAAW,CAAC;AAG5D,eAAO,MAAM,cAAc,QAAO,aAoIjC,CAAC;;AAEF,wBAAgC"}
1
+ {"version":3,"file":"unified-client-factory.d.ts","sourceRoot":"","sources":["../../src/unified-client-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,aAAa,EAAE,MAAM,WAAW,CAAC;AAG5D,eAAO,MAAM,cAAc,QAAO,aAgKjC,CAAC;;AAEF,wBAAgC"}
@@ -1,6 +1,7 @@
1
1
  import { AmplitudeBrowser } from '@amplitude/analytics-browser';
2
2
  import { AmplitudeSessionReplay, SessionReplayOptions } from '@amplitude/plugin-session-replay-browser';
3
- import { IExperimentClient, ExperimentConfig } from '@amplitude/plugin-experiment-browser';
3
+ import { IExperimentClient, ExperimentPluginConfig } from '@amplitude/plugin-experiment-browser';
4
+ import { InitOptions } from '@amplitude/engagement-browser';
4
5
  import { BrowserClient, BrowserOptions } from '@amplitude/analytics-core';
5
6
  export interface UnifiedSharedOptions {
6
7
  serverZone?: 'US' | 'EU';
@@ -8,31 +9,30 @@ export interface UnifiedSharedOptions {
8
9
  }
9
10
  export type UnifiedOptions = UnifiedSharedOptions & {
10
11
  analytics?: BrowserOptions;
11
- sr?: Omit<SessionReplayOptions, keyof UnifiedSharedOptions> | boolean;
12
- experiment?: Omit<ExperimentConfig, keyof UnifiedSharedOptions> | boolean;
12
+ sessionReplay?: Omit<SessionReplayOptions, keyof UnifiedSharedOptions>;
13
+ experiment?: Omit<ExperimentPluginConfig, keyof UnifiedSharedOptions>;
14
+ engagement?: Omit<InitOptions, keyof UnifiedSharedOptions>;
13
15
  };
14
16
  export interface UnifiedClient extends BrowserClient {
15
17
  initAll(apiKey: string, unifiedOptions?: UnifiedOptions): Promise<void>;
16
- sr: AmplitudeSessionReplay;
17
- experiment: IExperimentClient;
18
+ sessionReplay(): AmplitudeSessionReplay;
19
+ experiment(): IExperimentClient | undefined;
18
20
  }
19
21
  export declare class AmplitudeUnified extends AmplitudeBrowser implements UnifiedClient {
20
- experiment: IExperimentClient;
21
- sr: AmplitudeSessionReplay;
22
+ private _sessionReplay;
23
+ sessionReplay(): AmplitudeSessionReplay;
24
+ experiment(): IExperimentClient | undefined;
22
25
  /**
23
26
  * Initialize SDKs with configuration options.
24
- * Note that shared configuration in unifiedOptions will override the value in analyticsOptions.
25
- *
26
- * For example, the serverZone will be 'EU' for all SDKs.
27
- * ```
28
- * init('API_KEY', {serverZone: 'US'}, {serverZone: 'EU'});
29
- * ```
30
27
  *
31
28
  * @param apiKey Amplitude API key.
32
29
  * @param analyticsOptions Analytics configuration options. Refer to {@link https://amplitude.com/docs/sdks/analytics/browser/browser-sdk-2#configure-the-sdk here} for more info.
33
30
  * @param unifiedOptions Shared configuration for all SDKs and for blade SDKs.
34
31
  */
35
32
  initAll(apiKey: string, unifiedOptions?: UnifiedOptions): Promise<void>;
33
+ /**
34
+ * Only analytics SDK is initialized. Use initAll() instead to initialize all blade SDKs.
35
+ */
36
36
  init(apiKey?: string, userIdOrOptions?: string | BrowserOptions, maybeOptions?: BrowserOptions): import("@amplitude/analytics-core").AmplitudeReturn<void>;
37
37
  }
38
38
  //# sourceMappingURL=unified.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"unified.d.ts","sourceRoot":"","sources":["../../src/unified.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EAGrB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE1E,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG;IAClD,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,EAAE,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,oBAAoB,CAAC,GAAG,OAAO,CAAC;IACtE,UAAU,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,oBAAoB,CAAC,GAAG,OAAO,CAAC;CAC3E,CAAC;AAEF,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,EAAE,EAAE,sBAAsB,CAAC;IAC3B,UAAU,EAAE,iBAAiB,CAAC;CAC/B;AAED,qBAAa,gBAAiB,SAAQ,gBAAiB,YAAW,aAAa;IAG7E,UAAU,EAAE,iBAAiB,CAAC;IAG9B,EAAE,EAAE,sBAAsB,CAAC;IAE3B;;;;;;;;;;;;OAYG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,cAAc;IAsC7D,IAAI,CAAC,MAAM,SAAK,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE,YAAY,CAAC,EAAE,cAAc;CAO3F"}
1
+ {"version":3,"file":"unified.d.ts","sourceRoot":"","sources":["../../src/unified.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EAGrB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EAGvB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,WAAW,EAA8B,MAAM,+BAA+B,CAAC;AACxF,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAG1E,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG;IAClD,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,aAAa,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,oBAAoB,CAAC,CAAC;IACvE,UAAU,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,MAAM,oBAAoB,CAAC,CAAC;IACtE,UAAU,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,oBAAoB,CAAC,CAAC;CAC5D,CAAC;AAEF,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,aAAa,IAAI,sBAAsB,CAAC;IACxC,UAAU,IAAI,iBAAiB,GAAG,SAAS,CAAC;CAC7C;AAED,qBAAa,gBAAiB,SAAQ,gBAAiB,YAAW,aAAa;IAG7E,OAAO,CAAC,cAAc,CAAyB;IAE/C,aAAa,IAAI,sBAAsB;IAIvC,UAAU,IAAI,iBAAiB,GAAG,SAAS;IAkB3C;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,cAAc;IA4B7D;;OAEG;IAEH,IAAI,CAAC,MAAM,SAAK,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE,YAAY,CAAC,EAAE,cAAc;CAI3F"}
@@ -0,0 +1,2 @@
1
+ export declare const VERSION = "1.0.0-beta.10";
2
+ //# sourceMappingURL=version.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amplitude/unified",
3
- "version": "1.0.0-beta.0",
3
+ "version": "1.0.0-beta.10",
4
4
  "description": "Official Amplitude SDK for Web analytics, experiment, session replay, and more.",
5
5
  "keywords": [
6
6
  "amplitude",
@@ -21,7 +21,10 @@
21
21
  "bugs": {
22
22
  "url": "https://github.com/amplitude/Amplitude-TypeScript/issues"
23
23
  },
24
- "private": false,
24
+ "publishConfig": {
25
+ "access": "public",
26
+ "tag": "latest"
27
+ },
25
28
  "files": [
26
29
  "lib"
27
30
  ],
@@ -30,6 +33,7 @@
30
33
  "bundle": "rollup --config rollup.config.js",
31
34
  "build:es5": "tsc -p ./tsconfig.es5.json",
32
35
  "build:esm": "tsc -p ./tsconfig.esm.json",
36
+ "watch": "tsc -p ./tsconfig.esm.json --watch",
33
37
  "clean": "rimraf node_modules lib coverage",
34
38
  "fix": "yarn fix:eslint & yarn fix:prettier",
35
39
  "fix:eslint": "eslint '{src,test}/**/*.ts' --fix",
@@ -43,8 +47,14 @@
43
47
  "version-file": "echo '// Autogenerated by `yarn version-file`. DO NOT EDIT' > src/version.ts && node -p \"'export const VERSION = \\'' + require('./package.json').version + '\\';'\" >> src/version.ts"
44
48
  },
45
49
  "dependencies": {
46
- "@amplitude/analytics-browser": "^2.15.0",
50
+ "@amplitude/analytics-browser": "^2.27.0",
51
+ "@amplitude/analytics-core": "^2.28.0",
52
+ "@amplitude/engagement-browser": "^1.0.3",
47
53
  "@amplitude/plugin-experiment-browser": "^1.0.0-beta.0",
48
- "@amplitude/plugin-session-replay-browser": "^1.15.0"
49
- }
54
+ "@amplitude/plugin-session-replay-browser": "^1.22.25"
55
+ },
56
+ "devDependencies": {
57
+ "rollup": "^2.79.1"
58
+ },
59
+ "gitHead": "af0b100912ccf2e7923558e8a92944238ec493bc"
50
60
  }