@flisk/analyze-tracking 0.7.0 → 0.7.2

package/README.md

@@ -1,8 +1,8 @@
 # @flisk/analyze-tracking
 
-Automatically document your analytics setup by analyzing tracking code and generating data schemas from tools like Segment, Amplitude, Mixpanel, and more 🚀.
+Automatically document your analytics setup by analyzing tracking code and generating data schemas from tools like Segment, Amplitude, Mixpanel, and more 🚀
 
-[![NPM version](https://img.shields.io/npm/v/@flisk/analyze-tracking.svg)](https://www.npmjs.com/package/@flisk/analyze-tracking)
+[![NPM version](https://img.shields.io/npm/v/@flisk/analyze-tracking.svg)](https://www.npmjs.com/package/@flisk/analyze-tracking) [![Tests](https://github.com/fliskdata/analyze-tracking/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/fliskdata/analyze-tracking/actions/workflows/tests.yml)
 
 
 ## Why Use @flisk/analyze-tracking?
@@ -30,7 +30,7 @@ npx @flisk/analyze-tracking /path/to/project [options]
 - `-o, --output <output_file>`: Name of the output file (default: `tracking-schema.yaml`)
 - `-c, --customFunction <function_name>`: Specify a custom tracking function
 
-🔑&nbsp; **Important:** If you are using `generateDescription`, you must set the appropriate credentials for the provider you are using as an environment variable. OpenAI uses `OPENAI_API_KEY` and Google Vertex AI uses `GOOGLE_APPLICATION_CREDENTIALS`.
+🔑&nbsp; **Important:** If you are using `generateDescription`, you must set the appropriate credentials for the LLM provider you are using as an environment variable. OpenAI uses `OPENAI_API_KEY` and Google Vertex AI uses `GOOGLE_APPLICATION_CREDENTIALS`.
 
 <details>
   <summary>Note on Custom Functions 💡</summary>
@@ -96,10 +96,10 @@ See [schema.json](schema.json) for a JSON Schema of the output.
 | Mixpanel          | ✅ | ✅ | ✅ | ✅ |
 | Amplitude         | ✅ | ✅ | ❌ | ✅ |
 | Rudderstack       | ✅ | ✅ | ✳️ | ✳️ |
-| mParticle         | ✅ | ✅ | ❌ | ❌ |
+| mParticle         | ✅ | ❌ | ❌ | ❌ |
 | PostHog           | ✅ | ✅ | ✅ | ✅ |
-| Pendo             | ✅ | ✅ | ❌ | ❌ |
-| Heap              | ✅ | ✅ | ❌ | ❌ |
+| Pendo             | ✅ | ❌ | ❌ | ❌ |
+| Heap              | ✅ | ❌ | ❌ | ❌ |
 | Snowplow          | ✅ | ✅ | ✅ | ✅ |
 | Custom Function   | ✅ | ✅ | ✅ | ✅ |
 
@@ -198,16 +198,22 @@ See [schema.json](schema.json) for a JSON Schema of the output.
 
   **JavaScript/TypeScript**
   ```js
-  amplitude.logEvent('<event_name>', {
+  amplitude.track('<event_name>', {
     <event_parameters>
   });
   ```
 
   **Python**
   ```python
-  amplitude.track('<event_name>', {
-    '<property_name>': '<property_value>'
-  })
+  client.track(
+    BaseEvent(
+      event_type="<event_name>",
+      user_id="<user_id>",
+      event_properties={
+        "<property_name>": "<property_value>",
+      },
+    )
+  )
   ```
 
   **Go**
@@ -266,19 +272,10 @@ See [schema.json](schema.json) for a JSON Schema of the output.
 
   **JavaScript/TypeScript**
   ```js
-  mParticle.logEvent('<event_name>', {
+  mParticle.logEvent('<event_name>', mParticle.EventType.<event_type>, {
     '<property_name>': '<property_value>'
   });
   ```
-
-  **Python**
-  ```python
-  mParticle.logEvent('<event_name>', {
-    '<property_name>': '<property_value>'
-  })
-  ```
-
-
 </details>
 
 <details>
@@ -293,13 +290,9 @@ See [schema.json](schema.json) for a JSON Schema of the output.
 
   **Python**
   ```python
-  posthog.capture(
-    'distinct_id',
-    '<event_name>',
-    {
-      '<property_name>': '<property_value>'
-    }
-  )
+  posthog.capture('distinct_id', '<event_name>', {
+    '<property_name>': '<property_value>'
+  })
   # Or
   posthog.capture(
     'distinct_id',
@@ -377,61 +370,42 @@ See [schema.json](schema.json) for a JSON Schema of the output.
 
   **JavaScript/TypeScript**
   ```js
-  snowplow('trackStructEvent', {
+  tracker.track(buildStructEvent({
+    action: '<event_name>',
     category: '<category>',
-    action: '<action>',
     label: '<label>',
     property: '<property>',
-    value: '<value>'
-  });
+    value: <value>
+  }));
   ```
 
   **Python**
   ```python
-  # Direct tracking
-  trackStructEvent({
-    'category': '<category>',
-    'action': '<action>',
-    'label': '<label>',
-    'property': '<property>',
-    'value': '<value>'
-  })
-  
-  # Builder pattern
-  buildStructEvent({
-    'category': '<category>',
-    'action': '<action>',
-    'label': '<label>',
-    'property': '<property>',
-    'value': '<value>'
-  })
-  
-  # Function call pattern
-  snowplow('trackStructEvent', {
-    'category': '<category>',
-    'action': '<action>',
-    'label': '<label>',
-    'property': '<property>',
-    'value': '<value>'
-  })
+  tracker.track(StructuredEvent(
+    action="<event_name>",
+    category="<category>",
+    label="<label>",
+    property_="<property>",
+    value=<value>,
+  ))
   ```
 
   **Ruby**
   ```ruby
   tracker.track_struct_event(
+    action: '<event_name>',
     category: '<category>',
-    action: '<action>',
     label: '<label>',
     property: '<property>',
-    value: '<value>'
+    value: <value>
   )
   ```
 
   **Go**
   ```go
   tracker.TrackStructEvent(sp.StructuredEvent{
+		Action:   sp.NewString("<event_name>"),
 		Category: sp.NewString("<category>"),
-		Action:   sp.NewString("<action>"),
 		Label:    sp.NewString("<label>"),
 		Property: sp.NewString("<property>"),
 		Value:    sp.NewFloat64(<value>),
@@ -441,4 +415,4 @@ See [schema.json](schema.json) for a JSON Schema of the output.
 
 
 ## Contribute
-We're actively improving this package. Found a bug? Want to request a feature? Open an issue or contribute directly!
+We're actively improving this package. Found a bug? Have a feature request? Open an issue or submit a pull request!

package/package.json

@@ -1,14 +1,26 @@
 {
   "name": "@flisk/analyze-tracking",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "Analyzes tracking code in a project and generates data schemas",
   "main": "src/index.js",
   "bin": {
     "analyze-tracking": "bin/cli.js"
   },
   "scripts": {
-    "test": "jest"
+    "test": "node tests",
+    "test:js": "node --test tests/analyzeJsFile.test.js",
+    "test:ts": "node --test tests/analyzeTsFile.test.js",
+    "test:python": "node --experimental-vm-modules --test tests/analyzePythonFile.test.js",
+    "test:ruby": "node --experimental-vm-modules --test tests/analyzeRubyFile.test.js",
+    "test:go": "node --test tests/analyzeGoFile.test.js",
+    "test:cli": "node --test tests/cli.test.js",
+    "test:schema": "node --test tests/schema.test.js"
   },
+  "files": [
+    "bin",
+    "src",
+    "schema.json"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fliskdata/analyze-tracking.git"
@@ -38,6 +50,7 @@
     "zod": "^3.24.4"
   },
   "devDependencies": {
-    "jest": "^29.7.0"
+    "ajv": "^8.17.1",
+    "lodash": "^4.17.21"
   }
 }

package/schema.json

@@ -136,6 +136,10 @@
               "$ref": "#/definitions/property"
             }
           }
+        },
+        "items": {
+          "$ref": "#/definitions/property",
+          "description": "Schema for array items when type is 'array'"
         }
       },
       "required": [