Add load type to snippet (#615)

* add load type to snippet * add changeset
segmentio · Oct 6, 2022 · 6d51d38 · 6d51d38
1 parent 29c3bd7
commit 6d51d38
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/.changeset/clean-pandas-peel.md b/.changeset/clean-pandas-peel.md
@@ -0,0 +1,5 @@
+---
+'@segment/analytics-next': patch
+---
+
+Add the load function type to AnalyticsSnippet
diff --git a/packages/browser/src/browser/__tests__/standalone-analytics.test.ts b/packages/browser/src/browser/__tests__/standalone-analytics.test.ts
@@ -2,7 +2,7 @@ import jsdom, { JSDOM } from 'jsdom'
 import { InitOptions } from '../../'
 import { AnalyticsBrowser, loadLegacySettings } from '../../browser'
 import { snippet } from '../../tester/__fixtures__/segment-snippet'
-import { install, AnalyticsSnippet } from '../standalone-analytics'
+import { install, AnalyticsStandalone } from '../standalone-analytics'
 import unfetch from 'unfetch'
 import { PersistedPriorityQueue } from '../../lib/priority-queue/persisted'
 import { sleep } from '../../test-helpers/sleep'
@@ -99,7 +99,7 @@ describe('standalone bundle', () => {
 
     const spy = jest
       .spyOn(AnalyticsBrowser, 'standalone')
-      .mockResolvedValueOnce(fakeAjs as AnalyticsSnippet)
+      .mockResolvedValueOnce(fakeAjs as AnalyticsStandalone)
 
     await install()
 
@@ -114,7 +114,7 @@ describe('standalone bundle', () => {
     }
     const spy = jest
       .spyOn(AnalyticsBrowser, 'standalone')
-      .mockResolvedValueOnce(fakeAjs as AnalyticsSnippet)
+      .mockResolvedValueOnce(fakeAjs as AnalyticsStandalone)
 
     await install()
 

diff --git a/packages/browser/src/browser/standalone-analytics.ts b/packages/browser/src/browser/standalone-analytics.ts
@@ -2,15 +2,19 @@ import { Analytics, InitOptions } from '../core/analytics'
 import { AnalyticsBrowser } from '.'
 import { embeddedWriteKey } from '../lib/embedded-write-key'
 
-export type AnalyticsSnippet = Analytics & {
+export interface AnalyticsSnippet extends AnalyticsStandalone {
+  load: (writeKey: string, options?: InitOptions) => void
+}
+
+export interface AnalyticsStandalone extends Analytics {
   _loadOptions?: InitOptions
   _writeKey?: string
   _cdn?: string
 }
 
 declare global {
   interface Window {
-    analytics: AnalyticsSnippet
+    analytics: AnalyticsStandalone
   }
 }