@leather.io/analytics 0.0.1 → 2.0.0

package/README.md

@@ -13,43 +13,34 @@ pnpm install @leather/analytics
 Before making any analytics calls, you must configure the analytics client with your write key.
 
 ```ts
-import { configureAnalyticsClient } from '@leather.io/analytics';
+import { AnalyticsClientType, configureAnalyticsClient } from '@leather.io/analytics';
 
-configureAnalyticsClient({
-  writeKey: 'YOUR_WRITE_KEY',
+export const analytics: AnalyticsClientType = configureAnalyticsClient({
+  client: segmentClient,
   defaultProperties: {
-    platform: 'web',
+    platform: 'mobile',
   },
 });
 ```
 
-Now you can make analytics calls.
+Now you can make analytics calls with your configured client.
 
 ```ts
-import { analyticsClient } from '@leather/analytics';
+import { analytics } from 'path/to/analytics';
 
-analyticsClient.track('My Event', {
+analytics.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
+```sh
 pnpm build
-````
+```
 
 or
 
-```bash
+```sh
 pnpm build:watch
 ```

package/dist/index.d.ts

@@ -1,111 +1,205 @@
-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>;
+interface Events extends HistoricalEvents {
+    test_event_submitted: undefined;
 }
-type Json = Json[] | {
-    [index: number]: Json;
-} | {
-    [key: string]: Json;
-};
-interface EventProperties {
-    background_analytics_schema_fail: undefined;
-    schema_fail: {
-        query: unknown;
-        hash: string;
-        error: string;
+interface HistoricalEvents {
+    add_network: undefined;
+    bitcoin_rbf_fee_increase_error: {
+        outputDiff: number;
     };
-    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_retrieve_taproot_to_native_segwit: undefined;
+    broadcast_ordinal_transaction: undefined;
+    broadcast_ordinal_error: {
+        error: any;
     };
     broadcast_transaction: {
         symbol: string;
+        amount?: number;
+        fee?: number;
+        inputs?: number;
+        outputs?: number;
     };
     broadcast_btc_error: {
-        symbol: string;
-        error: {
-            errorMessage: string;
-            errorName: string;
-        };
+        error: any;
+    };
+    copy_btc_address_to_clipboard: {
+        type: string;
     };
+    copy_secret_key_to_clipboard: undefined;
+    copy_address_to_add_new_inscription: undefined;
+    copy_stx_address_to_clipboard: undefined;
+    copy_recipient_bns_address_to_clipboard: undefined;
+    create_new_account: undefined;
+    change_network: {
+        id: string;
+    };
+    click_open_in_new_tab_menu_item: undefined;
+    click_change_network_menu_item: undefined;
+    click_change_theme_menu_item: undefined;
+    click_toggle_privacy: undefined;
+    request_psbt_cancel: undefined;
+    request_sign_psbt_submit: undefined;
+    request_update_profile_submit: undefined;
+    request_update_profile_cancel: undefined;
     request_signature_cancel: undefined;
-    view_transaction_signing: undefined;
+    requesting_origin_tab_closed_with_pending_action: undefined;
+    select_add_new_collectible: undefined;
+    select_buy_option: {
+        provider: string;
+    };
+    select_theme: {
+        theme: string;
+    };
+    select_inscription_to_add_new_collectible: undefined;
+    select_maximum_amount_for_send: undefined;
+    submit_valid_password: undefined;
+    submit_invalid_password: undefined;
     submit_fee_for_transaction: {
         calculation: string;
         fee: number | string;
         type: string;
     };
-    request_update_profile_submit: {
-        requestType: 'update' | 'cancel';
+    user_approved_send_transfer: {
+        origin: string;
+    };
+    user_approved_sign_and_broadcast_psbt: {
+        origin: string;
+    };
+    user_clicked_feedback_button: undefined;
+    unable_to_read_fee_in_stx_validator: undefined;
+    unable_to_read_available_balance_in_stx_validator: undefined;
+    view_bitcoin_transaction: undefined;
+    view_transaction: undefined;
+    view_collectibles: {
+        ordinals_count?: number;
+        stamps_count?: number;
+        stacks_nfts_count?: number;
+    };
+    view_rpc_send_transfer_confirmation: {
+        symbol: string;
+    };
+    view_rpc_sign_and_broadcast_psbt_confirmation: {
+        symbol: string;
+    };
+    view_transaction_confirmation: {
+        symbol: string;
+    };
+    view_transaction_signing: undefined;
+    view_transaction_signing_error: {
+        reason: string;
+    };
+    start_unlock: undefined;
+    complete_unlock: {
+        durationMs: number;
+    };
+    background_analytics_schema_fail: undefined;
+    new_brand_reveal_name: undefined;
+    new_brand_accept_terms: undefined;
+    new_brand_reject_terms: undefined;
+    lock_session: undefined;
+    remove_network: undefined;
+    generate_new_secret_key: undefined;
+    bitcoin_contract_error: {
+        msg: string;
+    };
+    ordinals_dot_com_unavailable: {
+        error: any;
     };
-    request_update_profile_cancel: {
-        requestType: 'update' | 'cancel';
+    schema_fail: {
+        query: any;
+        hash: string;
+        error: string;
+    };
+    request_signature_cannot_sign_message_no_account: undefined;
+    request_signature_sign: {
+        type: 'software' | 'ledger';
+    };
+    switch_account: {
+        index: number;
+        hasStxBalance: boolean;
     };
     non_compliant_entity_detected: {
-        address: string;
+        address: string | string[];
     };
-    requesting_origin_tab_closed_with_pending_action: {
-        status: 'action_pending';
+    ledger_transaction_publish_error: {
+        error: {
+            message: string;
+            error: any;
+        };
     };
     native_segwit_tx_hex_to_ledger_tx: {
         success: boolean;
     };
-    psbt_sign_request: {
-        status: 'missing_taproot_internal_key';
-    };
+    psbt_sign_request_p2tr_missing_taproot_internal_key: undefined;
     ledger_nativesegwit_add_nonwitnessutxo: {
         action: 'add_nonwitness_utxo' | 'skip_add_nonwitness_utxo';
     };
+    submit_invalid_secret_key: undefined;
+    submit_valid_secret_key: undefined;
+    increase_fee_transaction: {
+        symbol: string;
+        txid: string;
+    };
+    finalize_tx_signature_error_thrown: {
+        data: unknown;
+    };
+    auth_response_with_illegal_redirect_uri: undefined;
     redux_persist_migration_to_no_serialization: undefined;
+    sign_out: undefined;
+    ledger_app_version_info: {
+        info: object;
+    };
+    ledger_transaction_signed_approved: undefined;
+    ledger_transaction_signed_rejected: undefined;
+    ledger_message_signed_approved: undefined;
+    ledger_message_signed_rejected: undefined;
+    ledger_public_keys_pulled_from_device: undefined;
+    user_clicked_requested_by_link: {
+        endpoint: string;
+    };
+    user_approved_get_addresses: {
+        origin: string;
+    };
+    user_approved_message_signing: {
+        origin: string;
+    };
 }
+type EventName = keyof Events;
 
-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>;
-};
+interface DefaultProperties {
+    platform: 'web' | 'extension' | 'mobile';
+}
+interface AnalyticsClientInterface {
+    screen: (name: string, ...args: any[]) => Promise<any>;
+    track: (event: string, ...args: any[]) => Promise<any>;
+    group: (groupId: string, traits?: any, ...args: any[]) => Promise<any>;
+    identify: (...args: any[]) => Promise<any>;
+    page?: (name: string, ...args: any[]) => Promise<any>;
+}
+interface AnalyticsClientConfig<T extends AnalyticsClientInterface> {
+    client: T;
+    defaultProperties?: DefaultProperties;
+    defaultTraits?: JsonMap;
+}
+type JsonList = JsonValue[];
+type JsonValue = boolean | number | string | null | JsonList | JsonMap | undefined | unknown | Error;
+interface JsonMap {
+    [key: string]: JsonValue;
+    [index: number]: JsonValue;
+}
+type OptionalIfUndefined<T> = T extends undefined ? undefined : T;
 
-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>;
+declare function configureAnalyticsClient<T extends AnalyticsClientInterface>({ client, defaultProperties, defaultTraits, }: {
+    client: T;
+    defaultProperties: DefaultProperties;
+    defaultTraits?: JsonMap;
+}): {
+    track<K extends keyof Events>(event: K, ...properties: undefined extends Events[K] ? [] : [param: Events[K]]): Promise<any>;
+    untypedTrack(event: string, properties?: JsonMap): Promise<any>;
+    screen: (name: string, ...args: any[]) => Promise<any>;
+    group: (groupId: string, traits?: any, ...args: any[]) => Promise<any>;
+    identify: (...args: any[]) => Promise<any>;
+    page: (name: string, ...args: any[]) => Promise<any>;
+    client: T;
 };
 
-export { analyticsClient, configureAnalyticsClient };
+export { type AnalyticsClientConfig, type AnalyticsClientInterface, type DefaultProperties, type EventName, type Events, type JsonList, type JsonMap, type JsonValue, type OptionalIfUndefined, configureAnalyticsClient };

package/dist/index.js

@@ -1,35 +1,32 @@
 // src/client.ts
-function AnalyticsClient(client, options) {
+function AnalyticsClient(analyticsClient, options) {
   return {
-    async track(event, properties) {
-      return client.track(event, { ...properties, ...options.defaultProperties });
+    async track(event, ...properties) {
+      return analyticsClient.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 });
+      return analyticsClient.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 });
-    }
+    screen: analyticsClient.screen,
+    group: analyticsClient.group,
+    identify: analyticsClient.identify,
+    page: analyticsClient.page ? analyticsClient.page : () => Promise.resolve(),
+    client: analyticsClient
   };
 }
 
 // src/index.ts
-var analyticsClient;
-function configureAnalyticsClient({ client, defaultProperties }) {
-  analyticsClient = AnalyticsClient(client, { defaultProperties });
-  return analyticsClient;
+function configureAnalyticsClient({
+  client,
+  defaultProperties,
+  defaultTraits
+}) {
+  return AnalyticsClient(client, { defaultProperties, defaultTraits });
 }
 export {
-  analyticsClient,
   configureAnalyticsClient
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +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":[]}
+{"version":3,"sources":["../src/client.ts","../src/index.ts"],"sourcesContent":["import { AnalyticsClientConfig, AnalyticsClientInterface, Events, JsonMap } from './types';\n\nexport function AnalyticsClient<T extends AnalyticsClientInterface>(\n  analyticsClient: T,\n  options: Pick<AnalyticsClientConfig<T>, 'defaultProperties' | 'defaultTraits'>\n) {\n  return {\n    async track<K extends keyof Events>(\n      event: K,\n      ...properties: undefined extends Events[K] ? [] : [param: Events[K]]\n    ) {\n      return analyticsClient.track(event, { ...properties, ...options.defaultProperties });\n    },\n    async untypedTrack(event: string, properties?: JsonMap) {\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 analyticsClient.track(event as any, { ...properties, ...options.defaultProperties });\n    },\n    screen: analyticsClient.screen,\n    group: analyticsClient.group,\n    identify: analyticsClient.identify,\n    page: analyticsClient.page ? analyticsClient.page : () => Promise.resolve(),\n    client: analyticsClient,\n  };\n}\n","import { AnalyticsClient } from './client';\nimport { AnalyticsClientInterface, DefaultProperties, JsonMap } from './types';\n\nexport * from './types';\n\nexport function configureAnalyticsClient<T extends AnalyticsClientInterface>({\n  client,\n  defaultProperties,\n  defaultTraits,\n}: {\n  client: T;\n  defaultProperties: DefaultProperties;\n  defaultTraits?: JsonMap;\n}) {\n  return AnalyticsClient<T>(client, { defaultProperties, defaultTraits });\n}\n"],"mappings":";AAEO,SAAS,gBACd,iBACA,SACA;AACA,SAAO;AAAA,IACL,MAAM,MACJ,UACG,YACH;AACA,aAAO,gBAAgB,MAAM,OAAO,EAAE,GAAG,YAAY,GAAG,QAAQ,kBAAkB,CAAC;AAAA,IACrF;AAAA,IACA,MAAM,aAAa,OAAe,YAAsB;AACtD,UAAI,MAAM,MAAM,+BAA+B,GAAG;AAChD,cAAM,IAAI,MAAM,0BAA0B;AAAA,MAC5C;AACA,aAAO,gBAAgB,MAAM,OAAc,EAAE,GAAG,YAAY,GAAG,QAAQ,kBAAkB,CAAC;AAAA,IAC5F;AAAA,IACA,QAAQ,gBAAgB;AAAA,IACxB,OAAO,gBAAgB;AAAA,IACvB,UAAU,gBAAgB;AAAA,IAC1B,MAAM,gBAAgB,OAAO,gBAAgB,OAAO,MAAM,QAAQ,QAAQ;AAAA,IAC1E,QAAQ;AAAA,EACV;AACF;;;ACpBO,SAAS,yBAA6D;AAAA,EAC3E;AAAA,EACA;AAAA,EACA;AACF,GAIG;AACD,SAAO,gBAAmB,QAAQ,EAAE,mBAAmB,cAAc,CAAC;AACxE;","names":[]}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@leather.io/analytics",
-  "author": "leather.io",
+  "author": "Leather.io contact@leather.io",
   "description": "Analytics package for Leather using Segment",
-  "version": "0.0.1",
+  "version": "2.0.0",
   "license": "MIT",
   "homepage": "https://github.com/leather.io/mono/tree/dev/packages/analytics",
   "repository": {
@@ -13,9 +13,9 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js",
-      "require": "./index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     }
   },
   "devDependencies": {
@@ -32,6 +32,11 @@
   "files": [
     "dist"
   ],
+  "keywords": [
+    "bitcoin",
+    "leather",
+    "leather wallet"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -42,6 +47,6 @@
     "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"
+    "typecheck": "tsc --noEmit"
   }
 }