@shware/analytics 11.5.0 → 11.7.0

package/dist/setup/index.d.mts

@@ -5,6 +5,17 @@ export interface Storage {
   getItem: (key: string) => string | null;
   setItem: (key: string, value: string) => void;
 }
+/**
+ * The link that opened the current visit of an app — a universal link, an app link, a custom
+ * scheme — whose URL, utm and click ids land the visit as a web page's URL does.
+ * `@shware/analytics/native` provides one (`deepLink`).
+ */
+export interface DeepLink {
+  /** Starts following the links that open the app; `setupAnalytics` calls it once. */
+  listen: () => void;
+  /** The opening link's tags (`page_location`, utm, click ids); empty without one. */
+  getTags: () => TrackTags | Promise<TrackTags>;
+}
 export interface Options {
   release: string;
   storage: Storage;
@@ -16,6 +27,8 @@ export interface Options {
   getHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
   thirdPartyTrackers?: ThirdPartyTracker[];
   thirdPartyUserSetters?: ThirdPartyUserSetter[];
+  /** An app's opening link, which native's `getTags` merges into every event's tags. */
+  deepLink?: DeepLink;
 }
 interface Config {
   release: string;
@@ -28,6 +41,7 @@ interface Config {
   getHeaders: () => Record<string, string> | Promise<Record<string, string>>;
   thirdPartyTrackers: ThirdPartyTracker[];
   thirdPartyUserSetters: ThirdPartyUserSetter[];
+  deepLink: DeepLink | undefined;
 }
 interface Cache {
   tags: TrackTags | null;

package/dist/setup/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/setup/index.ts"],"mappings":";;;iBAGiB;EACf,UAAU;EACV,UAAU,aAAa;;iBAGR;EACf;EACA,SAAS;EACT;EACA,UAAU;EACV,aAAa;EACb,eAAe,YAAY,QAAQ;EACnC,4BAA4B;EAC5B,mBAAmB,yBAAyB,QAAQ;EACpD,qBAAqB;EACrB,wBAAwB;;UAGhB;EACR;EACA;EACA,SAAS;EACT,UAAU;EACV,aAAa;EACb,eAAe,YAAY,QAAQ;EACnC,4BAA4B;EAC5B,kBAAkB,yBAAyB,QAAQ;EACnD,oBAAoB;EACpB,uBAAuB;;UAGf;EACR,MAAM;;qBAGK,OAAO;qBAKP,QAAQ;wBAcL,eAAe,MAAM"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/setup/index.ts"],"mappings":";;;iBAGiB;EACf,UAAU;EACV,UAAU,aAAa;;;;;;;iBAQR;;EAEf;;EAEA,eAAe,YAAY,QAAQ;;iBAGpB;EACf;EACA,SAAS;EACT;EACA,UAAU;EACV,aAAa;EACb,eAAe,YAAY,QAAQ;EACnC,4BAA4B;EAC5B,mBAAmB,yBAAyB,QAAQ;EACpD,qBAAqB;EACrB,wBAAwB;;EAExB,WAAW;;UAGH;EACR;EACA;EACA,SAAS;EACT,UAAU;EACV,aAAa;EACb,eAAe,YAAY,QAAQ;EACnC,4BAA4B;EAC5B,kBAAkB,yBAAyB,QAAQ;EACnD,oBAAoB;EACpB,uBAAuB;EACvB,UAAU;;UAGF;EACR,MAAM;;qBAGK,OAAO;qBAKP,QAAQ;wBAeL,eAAe,MAAM"}

package/dist/setup/index.mjs

@@ -10,7 +10,8 @@ const config = {
 	getDeviceId: null,
 	getHeaders: null,
 	thirdPartyTrackers: [],
-	thirdPartyUserSetters: []
+	thirdPartyUserSetters: [],
+	deepLink: void 0
 };
 function setupAnalytics(init) {
 	config.release = init.release;
@@ -26,6 +27,12 @@ function setupAnalytics(init) {
 	});
 	config.thirdPartyTrackers = init.thirdPartyTrackers ?? [];
 	config.thirdPartyUserSetters = init.thirdPartyUserSetters ?? [];
+	config.deepLink = init.deepLink;
+	try {
+		init.deepLink?.listen();
+	} catch (error) {
+		console.error("analytics deepLink.listen failed", error);
+	}
 }
 //#endregion
 export { cache, config, setupAnalytics };

package/dist/setup/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../src/setup/index.ts"],"sourcesContent":["import type { Environment, Platform, ThirdPartyTracker, TrackTags } from '../track/types';\nimport type { ThirdPartyUserSetter } from '../visitor/types';\n\nexport interface Storage {\n  getItem: (key: string) => string | null;\n  setItem: (key: string, value: string) => void;\n}\n\nexport interface Options {\n  release: string;\n  storage: Storage;\n  endpoint: string;\n  platform: Platform;\n  environment: Environment;\n  getTags: () => TrackTags | Promise<TrackTags>;\n  getDeviceId: () => string | Promise<string>;\n  getHeaders?: () => Record<string, string> | Promise<Record<string, string>>;\n  thirdPartyTrackers?: ThirdPartyTracker[];\n  thirdPartyUserSetters?: ThirdPartyUserSetter[];\n}\n\ninterface Config {\n  release: string;\n  endpoint: string;\n  storage: Storage;\n  platform: Platform;\n  environment: Environment;\n  getTags: () => TrackTags | Promise<TrackTags>;\n  getDeviceId: () => string | Promise<string>;\n  getHeaders: () => Record<string, string> | Promise<Record<string, string>>;\n  thirdPartyTrackers: ThirdPartyTracker[];\n  thirdPartyUserSetters: ThirdPartyUserSetter[];\n}\n\ninterface Cache {\n  tags: TrackTags | null;\n}\n\nexport const cache: Cache = {\n  tags: null,\n};\n\n// oxlint-disable typescript/no-non-null-assertion\nexport const config: Config = {\n  endpoint: '',\n  release: '0.0.0',\n  storage: null!,\n  platform: null!,\n  environment: null!,\n  getTags: null!,\n  getDeviceId: null!,\n  getHeaders: null!,\n  thirdPartyTrackers: [],\n  thirdPartyUserSetters: [],\n};\n// oxlint-enable typescript/no-non-null-assertion\n\nexport function setupAnalytics(init: Options) {\n  config.release = init.release;\n  config.storage = init.storage;\n  config.platform = init.platform;\n  config.environment = init.environment;\n  config.endpoint = init.endpoint.endsWith('/') ? init.endpoint.slice(0, -1) : init.endpoint;\n  config.getTags = init.getTags;\n  config.getDeviceId = init.getDeviceId;\n  config.getHeaders = async () => ({\n    'Content-Type': 'application/json',\n    ...(await init.getHeaders?.()),\n  });\n  config.thirdPartyTrackers = init.thirdPartyTrackers ?? [];\n  config.thirdPartyUserSetters = init.thirdPartyUserSetters ?? [];\n}\n"],"mappings":";AAsCA,MAAa,QAAe,EAC1B,MAAM,KACR;AAGA,MAAa,SAAiB;CAC5B,UAAU;CACV,SAAS;CACT,SAAS;CACT,UAAU;CACV,aAAa;CACb,SAAS;CACT,aAAa;CACb,YAAY;CACZ,oBAAoB,CAAC;CACrB,uBAAuB,CAAC;AAC1B;AAGA,SAAgB,eAAe,MAAe;CAC5C,OAAO,UAAU,KAAK;CACtB,OAAO,UAAU,KAAK;CACtB,OAAO,WAAW,KAAK;CACvB,OAAO,cAAc,KAAK;CAC1B,OAAO,WAAW,KAAK,SAAS,SAAS,GAAG,IAAI,KAAK,SAAS,MAAM,GAAG,EAAE,IAAI,KAAK;CAClF,OAAO,UAAU,KAAK;CACtB,OAAO,cAAc,KAAK;CAC1B,OAAO,aAAa,aAAa;EAC/B,gBAAgB;EAChB,GAAI,MAAM,KAAK,aAAa;CAC9B;CACA,OAAO,qBAAqB,KAAK,sBAAsB,CAAC;CACxD,OAAO,wBAAwB,KAAK,yBAAyB,CAAC;AAChE"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/setup/index.ts"],"sourcesContent":["import type { Environment, Platform, ThirdPartyTracker, TrackTags } from '../track/types';\nimport type { ThirdPartyUserSetter } from '../visitor/types';\n\nexport interface Storage {\n  getItem: (key: string) => string | null;\n  setItem: (key: string, value: string) => void;\n}\n\n/**\n * The link that opened the current visit of an app — a universal link, an app link, a custom\n * scheme — whose URL, utm and click ids land the visit as a web page's URL does.\n * `@shware/analytics/native` provides one (`deepLink`).\n */\nexport interface DeepLink {\n  /** Starts following the links that open the app; `setupAnalytics` calls it once. */\n  listen: () => void;\n  /** The opening link's tags (`page_location`, utm, click ids); empty without one. */\n  getTags: () => TrackTags | Promise<TrackTags>;\n}\n\nexport interface Options {\n  release: string;\n  storage: Storage;\n  endpoint: string;\n  platform: Platform;\n  environment: Environment;\n  getTags: () => TrackTags | Promise<TrackTags>;\n  getDeviceId: () => string | Promise<string>;\n  getHeaders?: () => Record<string, string> | Promise<Record<string, string>>;\n  thirdPartyTrackers?: ThirdPartyTracker[];\n  thirdPartyUserSetters?: ThirdPartyUserSetter[];\n  /** An app's opening link, which native's `getTags` merges into every event's tags. */\n  deepLink?: DeepLink;\n}\n\ninterface Config {\n  release: string;\n  endpoint: string;\n  storage: Storage;\n  platform: Platform;\n  environment: Environment;\n  getTags: () => TrackTags | Promise<TrackTags>;\n  getDeviceId: () => string | Promise<string>;\n  getHeaders: () => Record<string, string> | Promise<Record<string, string>>;\n  thirdPartyTrackers: ThirdPartyTracker[];\n  thirdPartyUserSetters: ThirdPartyUserSetter[];\n  deepLink: DeepLink | undefined;\n}\n\ninterface Cache {\n  tags: TrackTags | null;\n}\n\nexport const cache: Cache = {\n  tags: null,\n};\n\n// oxlint-disable typescript/no-non-null-assertion\nexport const config: Config = {\n  endpoint: '',\n  release: '0.0.0',\n  storage: null!,\n  platform: null!,\n  environment: null!,\n  getTags: null!,\n  getDeviceId: null!,\n  getHeaders: null!,\n  thirdPartyTrackers: [],\n  thirdPartyUserSetters: [],\n  deepLink: undefined,\n};\n// oxlint-enable typescript/no-non-null-assertion\n\nexport function setupAnalytics(init: Options) {\n  config.release = init.release;\n  config.storage = init.storage;\n  config.platform = init.platform;\n  config.environment = init.environment;\n  config.endpoint = init.endpoint.endsWith('/') ? init.endpoint.slice(0, -1) : init.endpoint;\n  config.getTags = init.getTags;\n  config.getDeviceId = init.getDeviceId;\n  config.getHeaders = async () => ({\n    'Content-Type': 'application/json',\n    ...(await init.getHeaders?.()),\n  });\n  config.thirdPartyTrackers = init.thirdPartyTrackers ?? [];\n  config.thirdPartyUserSetters = init.thirdPartyUserSetters ?? [];\n  config.deepLink = init.deepLink;\n  // Logged, not thrown: the links are worth less than the setup they would break.\n  try {\n    init.deepLink?.listen();\n  } catch (error) {\n    console.error('analytics deepLink.listen failed', error);\n  }\n}\n"],"mappings":";AAqDA,MAAa,QAAe,EAC1B,MAAM,KACR;AAGA,MAAa,SAAiB;CAC5B,UAAU;CACV,SAAS;CACT,SAAS;CACT,UAAU;CACV,aAAa;CACb,SAAS;CACT,aAAa;CACb,YAAY;CACZ,oBAAoB,CAAC;CACrB,uBAAuB,CAAC;CACxB,UAAU,KAAA;AACZ;AAGA,SAAgB,eAAe,MAAe;CAC5C,OAAO,UAAU,KAAK;CACtB,OAAO,UAAU,KAAK;CACtB,OAAO,WAAW,KAAK;CACvB,OAAO,cAAc,KAAK;CAC1B,OAAO,WAAW,KAAK,SAAS,SAAS,GAAG,IAAI,KAAK,SAAS,MAAM,GAAG,EAAE,IAAI,KAAK;CAClF,OAAO,UAAU,KAAK;CACtB,OAAO,cAAc,KAAK;CAC1B,OAAO,aAAa,aAAa;EAC/B,gBAAgB;EAChB,GAAI,MAAM,KAAK,aAAa;CAC9B;CACA,OAAO,qBAAqB,KAAK,sBAAsB,CAAC;CACxD,OAAO,wBAAwB,KAAK,yBAAyB,CAAC;CAC9D,OAAO,WAAW,KAAK;CAEvB,IAAI;EACF,KAAK,UAAU,OAAO;CACxB,SAAS,OAAO;EACd,QAAQ,MAAM,oCAAoC,KAAK;CACzD;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shware/analytics",
-  "version": "11.5.0",
+  "version": "11.7.0",
   "private": false,
   "repository": {
     "type": "git",