From 4f992f641b485638e00f28388d8ef243f318cdc3 Mon Sep 17 00:00:00 2001 From: Vitor Luiz Cavalcanti Date: Wed, 26 Jan 2022 17:43:38 -0300 Subject: [PATCH] feat: add type declarations for @analytics/segment --- packages/analytics-plugin-segment/index.d.ts | 22 +++++++++++++++++++ .../analytics-plugin-segment/package.json | 9 ++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 packages/analytics-plugin-segment/index.d.ts diff --git a/packages/analytics-plugin-segment/index.d.ts b/packages/analytics-plugin-segment/index.d.ts new file mode 100644 index 00000000..9cdcb69b --- /dev/null +++ b/packages/analytics-plugin-segment/index.d.ts @@ -0,0 +1,22 @@ +import type { AnalyticsPlugin } from 'analytics'; + +export type AnalyticsSegmentOptions = { + /** Your segment write key */ + writeKey: string; + + flushAt?: number; + + /* Segment sdk config options. Docs https://bit.ly/2H2jJMb */ + flushInterval?: number; + + /** Disable loading segment for anonymous visitors */ + disableAnonymousTraffic?: boolean; + + /** Override the Segment snippet url, for loading via custom CDN proxy */ + customScriptSrc?: boolean; + + /** Enable/disable segment destinations https://bit.ly/38nRBj3 */ + integrations?: Record; +}; + +export default function AnalyticsSegment(options: AnalyticsSegmentOptions): AnalyticsPlugin; diff --git a/packages/analytics-plugin-segment/package.json b/packages/analytics-plugin-segment/package.json index 817e5cbc..18422ad9 100644 --- a/packages/analytics-plugin-segment/package.json +++ b/packages/analytics-plugin-segment/package.json @@ -34,6 +34,7 @@ "globalName": "analyticsSegment", "jsnext:main": "lib/analytics-plugin-segment.es.js", "module": "lib/analytics-plugin-segment.es.js", + "typings": "index.d.ts", "browser": { "./lib/analytics-plugin-segment.cjs.js": "./lib/analytics-plugin-segment.browser.cjs.js", "./lib/analytics-plugin-segment.es.js": "./lib/analytics-plugin-segment.browser.es.js" @@ -41,7 +42,7 @@ "files": [ "dist", "lib", - "README.md" + "index.d.ts" ], "homepage": "https://github.com/DavidWells/analytics#readme", "repository": { @@ -50,9 +51,13 @@ }, "devDependencies": { "@babel/core": "^7.2.2", - "@babel/preset-env": "^7.3.1" + "@babel/preset-env": "^7.3.1", + "analytics": "^0.7.21" }, "dependencies": { "analytics-node": "^3.5.0" + }, + "peerDependencies": { + "analytics": "^0.7.21" } }