Add typings instructions from snippet users and export Snippet type (#541)

Author: silesky

.changeset/red-falcons-worry.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-next': minor
+---
+
+Export AnalyticsSnippet type and add directions (for snippet users).

README.md

@@ -158,6 +158,41 @@ export default defineComponent({
 </script>
 ```
 
+
+
+### For snippet users only: How to add typescript support
+
+1. Install npm package `@segment/analytics-next`
+
+2. Create `./typings/analytics.d.ts`
+```ts
+// ./typings/analytics.d.ts
+import type { AnalyticsSnippet } from "@segment/analytics-next";
+
+declare global {
+  interface Window {
+    analytics: AnalyticsSnippet;
+  }
+}
+
+```
+3. Configure typescript to read from the custom `./typings` folder
+```jsonc
+// tsconfig.json
+{
+  ...
+  "compilerOptions": {
+    ....
+    "typeRoots": [
+      "./node_modules/@types",
+      "./typings"
+    ]
+  }
+  ....
+}
+```
+
+
 # 🐒 Development
 
 First, clone the repo and then startup our local dev environment:

packages/browser/README.md

@@ -158,6 +158,41 @@ export default defineComponent({
 </script>
 ```
 
+
+
+### For snippet users only: How to add typescript support
+
+1. Install npm package `@segment/analytics-next`
+
+2. Create `./typings/analytics.d.ts`
+```ts
+// ./typings/analytics.d.ts
+import type { AnalyticsSnippet } from "@segment/analytics-next";
+
+declare global {
+  interface Window {
+    analytics: AnalyticsSnippet;
+  }
+}
+
+```
+3. Configure typescript to read from the custom `./typings` folder
+```jsonc
+// tsconfig.json
+{
+  ...
+  "compilerOptions": {
+    ....
+    "typeRoots": [
+      "./node_modules/@types",
+      "./typings"
+    ]
+  }
+  ....
+}
+```
+
+
 # 🐒 Development
 
 First, clone the repo and then startup our local dev environment:

packages/browser/src/index.ts

@@ -6,3 +6,5 @@ export * from './core/context'
 export * from './core/events'
 export * from './core/plugin'
 export * from './core/user'
+
+export type { AnalyticsSnippet } from './browser/standalone-analytics'