@leather.io/analytics 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Leather Wallet LLC [a subsidiary of Nassau Machines]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# @leather/analytics
+
+This package provides a client for sending analytics events to various analytics services. Currently, it supports Segment but could be extended to support other services in the future.
+
+## Installation
+
+```bash
+pnpm install @leather/analytics
+```
+
+## Usage
+
+Before making any analytics calls, you must configure the analytics client with your write key.
+
+```ts
+import { configureAnalyticsClient } from '@leather.io/analytics';
+
+configureAnalyticsClient({
+  writeKey: 'YOUR_WRITE_KEY',
+  defaultProperties: {
+    platform: 'web',
+  },
+});
+```
+
+Now you can make analytics calls.
+
+```ts
+import { analyticsClient } from '@leather/analytics';
+
+analyticsClient.track('My Event', {
+  property: 'value',
+});
+```
+
+You can also inject your own analytics client if you are using a custom analytics service or want to use a stubbed client for testing.
+
+````ts
+import { configureAnalyticsClient } from '@leather/analytics';
+
+configureAnalyticsClient({
+  client: myAnalyticsClient,
+});
+
+## Development
+
+```bash
+pnpm build
+````
+
+or
+
+```bash
+pnpm build:watch
+```

package/dist/index.d.ts

@@ -0,0 +1,111 @@
+interface DefaultProperties {
+    platform: 'web' | 'extension' | 'mobile';
+}
+interface ExternalAnalyticsClientInterface {
+    track: (event: string, properties?: Json) => Promise<void>;
+    screen: (name: string, properties?: Json) => Promise<void>;
+    group: (groupId: string, traits?: Json) => Promise<void>;
+    identify: (userId: string, traits?: Json) => Promise<void>;
+}
+interface AnalyticsClientConfig {
+    writeKey: string;
+    client: ExternalAnalyticsClientInterface;
+    defaultProperties?: DefaultProperties;
+    defaultTraits?: Record<string, Json>;
+}
+type Json = Json[] | {
+    [index: number]: Json;
+} | {
+    [key: string]: Json;
+};
+interface EventProperties {
+    background_analytics_schema_fail: undefined;
+    schema_fail: {
+        query: unknown;
+        hash: string;
+        error: string;
+    };
+    switch_account: {
+        index: number;
+        hasStxBalance: boolean;
+    };
+    view_transaction_confirmation: {
+        symbol: string;
+    };
+    ordinals_dot_com_unavailable: {
+        error: {
+            errorMessage: string;
+            errorName: string;
+        };
+    };
+    select_maximum_amount_for_send: {
+        maximum: boolean;
+    };
+    copy_recipient_bns_address_to_clipboard: {
+        value: 'thing' | 'other-thing';
+    };
+    broadcast_transaction: {
+        symbol: string;
+    };
+    broadcast_btc_error: {
+        symbol: string;
+        error: {
+            errorMessage: string;
+            errorName: string;
+        };
+    };
+    request_signature_cancel: undefined;
+    view_transaction_signing: undefined;
+    submit_fee_for_transaction: {
+        calculation: string;
+        fee: number | string;
+        type: string;
+    };
+    request_update_profile_submit: {
+        requestType: 'update' | 'cancel';
+    };
+    request_update_profile_cancel: {
+        requestType: 'update' | 'cancel';
+    };
+    non_compliant_entity_detected: {
+        address: string;
+    };
+    requesting_origin_tab_closed_with_pending_action: {
+        status: 'action_pending';
+    };
+    native_segwit_tx_hex_to_ledger_tx: {
+        success: boolean;
+    };
+    psbt_sign_request: {
+        status: 'missing_taproot_internal_key';
+    };
+    ledger_nativesegwit_add_nonwitnessutxo: {
+        action: 'add_nonwitness_utxo' | 'skip_add_nonwitness_utxo';
+    };
+    redux_persist_migration_to_no_serialization: undefined;
+}
+
+type AnalyticsClientOptions = Pick<AnalyticsClientConfig, 'defaultProperties' | 'defaultTraits'>;
+declare function AnalyticsClient<T extends ExternalAnalyticsClientInterface>(client: T, options: AnalyticsClientOptions): {
+    track<K extends keyof EventProperties>(event: K, properties: EventProperties[K]): Promise<void>;
+    untypedTrack(event: string, properties?: Json): Promise<void>;
+    screen(name: string, properties?: Json): Promise<void>;
+    group(groupId: string, traits?: Json): Promise<void>;
+    identify(userId: string, traits?: Json): Promise<void>;
+};
+
+declare let analyticsClient: ReturnType<typeof AnalyticsClient<ExternalAnalyticsClientInterface>>;
+/**
+ * Configures the analytics client for the web environment. Must be called before any analytics functions are used.
+ * @param {AnalyticsClientConfig} config - The configuration for the analytics client.
+ * @returns {AnalyticsClient<AnalyticsClientInterface>} The configured analytics client.
+ */
+declare function configureAnalyticsClient({ client, defaultProperties }: AnalyticsClientConfig): {
+    track<K extends keyof EventProperties>(event: K, properties: EventProperties[K]): Promise<void>;
+    untypedTrack(event: string, properties?: Json): Promise<void>;
+    screen(name: string, properties?: Json): Promise<void>;
+    group(groupId: string, traits?: Json): Promise<void>;
+    identify(userId: string, traits?: Json): Promise<void>;
+};
+
+export { analyticsClient, configureAnalyticsClient };

package/dist/index.js

@@ -0,0 +1,35 @@
+// src/client.ts
+function AnalyticsClient(client, options) {
+  return {
+    async track(event, properties) {
+      return client.track(event, { ...properties, ...options.defaultProperties });
+    },
+    async untypedTrack(event, properties) {
+      if (event.match(/^[a-zA-Z0-9\s][a-zA-Z0-9\s]*$/)) {
+        throw new Error("Event must be snake_case");
+      }
+      return client.track(event, { ...properties, ...options.defaultProperties });
+    },
+    async screen(name, properties) {
+      return client.screen(name, { ...properties, ...options.defaultProperties });
+    },
+    async group(groupId, traits) {
+      return client.group(groupId, { ...traits, ...options.defaultTraits });
+    },
+    async identify(userId, traits) {
+      return client.identify(userId, { ...traits, ...options.defaultTraits });
+    }
+  };
+}
+
+// src/index.ts
+var analyticsClient;
+function configureAnalyticsClient({ client, defaultProperties }) {
+  analyticsClient = AnalyticsClient(client, { defaultProperties });
+  return analyticsClient;
+}
+export {
+  analyticsClient,
+  configureAnalyticsClient
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts","../src/index.ts"],"sourcesContent":["import {\n  AnalyticsClientConfig,\n  EventProperties,\n  ExternalAnalyticsClientInterface,\n  Json,\n} from './types';\n\nexport type AnalyticsClientOptions = Pick<\n  AnalyticsClientConfig,\n  'defaultProperties' | 'defaultTraits'\n>;\n\nexport function AnalyticsClient<T extends ExternalAnalyticsClientInterface>(\n  client: T,\n  options: AnalyticsClientOptions\n) {\n  return {\n    async track<K extends keyof EventProperties>(event: K, properties: EventProperties[K]) {\n      return client.track(event, { ...properties, ...options.defaultProperties });\n    },\n\n    async untypedTrack(event: string, properties?: Json) {\n      if (event.match(/^[a-zA-Z0-9\\s][a-zA-Z0-9\\s]*$/)) {\n        throw new Error('Event must be snake_case');\n      }\n      return client.track(event as any, { ...properties, ...options.defaultProperties });\n    },\n\n    async screen(name: string, properties?: Json) {\n      return client.screen(name, { ...properties, ...options.defaultProperties });\n    },\n\n    async group(groupId: string, traits?: Json) {\n      return client.group(groupId, { ...traits, ...options.defaultTraits });\n    },\n\n    async identify(userId: string, traits?: Json) {\n      return client.identify(userId, { ...traits, ...options.defaultTraits });\n    },\n  };\n}\n","import { AnalyticsClientConfig, ExternalAnalyticsClientInterface } from 'types';\n\nimport { AnalyticsClient } from './client';\n\nlet analyticsClient: ReturnType<typeof AnalyticsClient<ExternalAnalyticsClientInterface>>;\n\n/**\n * Configures the analytics client for the web environment. Must be called before any analytics functions are used.\n * @param {AnalyticsClientConfig} config - The configuration for the analytics client.\n * @returns {AnalyticsClient<AnalyticsClientInterface>} The configured analytics client.\n */\nexport function configureAnalyticsClient({ client, defaultProperties }: AnalyticsClientConfig) {\n  analyticsClient = AnalyticsClient(client, { defaultProperties });\n\n  return analyticsClient;\n}\n\nexport { analyticsClient };\n"],"mappings":";AAYO,SAAS,gBACd,QACA,SACA;AACA,SAAO;AAAA,IACL,MAAM,MAAuC,OAAU,YAAgC;AACrF,aAAO,OAAO,MAAM,OAAO,EAAE,GAAG,YAAY,GAAG,QAAQ,kBAAkB,CAAC;AAAA,IAC5E;AAAA,IAEA,MAAM,aAAa,OAAe,YAAmB;AACnD,UAAI,MAAM,MAAM,+BAA+B,GAAG;AAChD,cAAM,IAAI,MAAM,0BAA0B;AAAA,MAC5C;AACA,aAAO,OAAO,MAAM,OAAc,EAAE,GAAG,YAAY,GAAG,QAAQ,kBAAkB,CAAC;AAAA,IACnF;AAAA,IAEA,MAAM,OAAO,MAAc,YAAmB;AAC5C,aAAO,OAAO,OAAO,MAAM,EAAE,GAAG,YAAY,GAAG,QAAQ,kBAAkB,CAAC;AAAA,IAC5E;AAAA,IAEA,MAAM,MAAM,SAAiB,QAAe;AAC1C,aAAO,OAAO,MAAM,SAAS,EAAE,GAAG,QAAQ,GAAG,QAAQ,cAAc,CAAC;AAAA,IACtE;AAAA,IAEA,MAAM,SAAS,QAAgB,QAAe;AAC5C,aAAO,OAAO,SAAS,QAAQ,EAAE,GAAG,QAAQ,GAAG,QAAQ,cAAc,CAAC;AAAA,IACxE;AAAA,EACF;AACF;;;ACpCA,IAAI;AAOG,SAAS,yBAAyB,EAAE,QAAQ,kBAAkB,GAA0B;AAC7F,oBAAkB,gBAAgB,QAAQ,EAAE,kBAAkB,CAAC;AAE/D,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@leather.io/analytics",
+  "author": "leather.io",
+  "description": "Analytics package for Leather using Segment",
+  "version": "0.0.1",
+  "license": "MIT",
+  "homepage": "https://github.com/leather.io/mono/tree/dev/packages/analytics",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:leather.io/mono.git",
+    "directory": "packages/analytics"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.js"
+    }
+  },
+  "devDependencies": {
+    "@types/node": "20.14.0",
+    "concurrently": "8.2.2",
+    "eslint": "8.53.0",
+    "eslint-config-universe": "12.0.0",
+    "prettier": "3.3.3",
+    "tsup": "8.1.0",
+    "typescript": "5.5.4",
+    "vitest": "2.0.5",
+    "@leather.io/eslint-config": "0.7.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch --onSuccess 'tsup --dts-only'",
+    "format": "prettier . --write \"src/**/*.ts\" --ignore-path ../../.prettierignore",
+    "format:check": "prettier . --check \"src/**/*.ts\" --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ignore-path ../../.eslintignore",
+    "lint:fix": "eslint . --fix --ignore-path ../../.eslintignore",
+    "typecheck": "tsc --noEmit --project ./tsconfig.json"
+  }
+}