@clix-so/clix-agent-skills 0.1.3 → 0.1.5

package/skills/event-tracking/SKILL.md

@@ -0,0 +1,126 @@
+---
+name: clix-event-tracking
+description:
+  Implements Clix event tracking (Clix.trackEvent) with consistent naming, safe
+  property schemas, and campaign-ready validation. Use when adding, reviewing,
+  or debugging event tracking; when configuring event-triggered campaigns; or
+  when the user mentions events, tracking, funnels, or properties.
+---
+
+# Tracking Clix Events
+
+Use this skill to help developers design and implement **Clix event tracking**
+via `Clix.trackEvent(...)` so events can drive **event-triggered campaigns**,
+**audience filters**, and **personalization**.
+
+## What the official docs guarantee (high-signal)
+
+- **When to track**: identify the user action/system event, then attach
+  meaningful properties (funnel checkpoints, milestones, button taps).
+- **Property normalization**: booleans/numbers/strings map directly; date-like
+  values serialize to ISO 8601; unsupported objects become strings.
+- **Error handling**: event tracking calls can throw—always handle errors so the
+  app stays robust.
+
+## MCP-first (source of truth)
+
+If Clix MCP tools are available, treat them as the **source of truth**:
+
+- `clix-mcp-server:search_docs` for conceptual behavior (campaign triggers,
+  personalization)
+- `clix-mcp-server:search_sdk` for exact SDK signatures per platform
+
+If MCP tools are not available, use the bundled references:
+
+- Event API contract + pitfalls → `references/trackevent-contract.md`
+- Naming + schemas + privacy → `references/naming-and-schema.md`
+- Implementation patterns → `references/implementation-patterns.md`
+- Campaign mapping → `references/campaign-mapping.md`
+- Debugging checklist → `references/debugging.md`
+
+## Workflow (copy + check off)
+
+```
+Event tracking progress:
+- [ ] 1) Confirm platform(s) and goals (analytics vs campaign triggers)
+- [ ] 2) Propose event plan (names, when fired, properties, where in code)
+- [ ] 3) Validate plan (names, keys, types, PII constraints)
+- [ ] 4) Implement trackEvent calls (platform-correct)
+- [ ] 5) Verify: events fire once, serialize cleanly, match campaign configs
+```
+
+## 1) Confirm the minimum inputs
+
+Ask only what’s needed:
+
+- **Platform**: iOS / Android / React Native / Flutter
+- **Goal**: analytics only, event-triggered campaigns, or both
+- **Top flows** (1–3): e.g., onboarding, checkout, subscription
+- **PII policy**: what must never be sent (email/phone/name/free-text, etc.)
+
+## 2) Propose an “Event Plan” (before touching code)
+
+Return a compact table the user can approve:
+
+- **event_name** (stable, `snake_case`)
+- **when** (exact moment the event fires)
+- **properties** (key + type, mark required vs optional)
+- **location** (file/function/UI handler/network response)
+- **purpose** (campaign trigger / analytics / both)
+
+If campaigns are involved, remind: **event names and property keys must match
+exactly** in the Clix console.
+
+## 3) Validate the plan (fast feedback loop)
+
+Create `event-plan.json` in `.clix/` directory (recommended) or project root:
+
+**Recommended location**: `.clix/event-plan.json`
+
+- Organized: keeps tooling configs together
+- Hidden: doesn't clutter project root
+- Committable: planning document for team review
+
+**Alternative**: `event-plan.json` in project root (simpler, but less organized)
+
+**For agents**: Locate `scripts/validate-event-plan.sh` in the installed skill
+directory, then run it:
+
+```bash
+# From project root:
+bash <skill-dir>/scripts/validate-event-plan.sh .clix/event-plan.json
+# Or if in root:
+bash <skill-dir>/scripts/validate-event-plan.sh event-plan.json
+```
+
+The skill directory is typically:
+
+- `.cursor/skills/event-tracking/` (Cursor)
+- `.claude/skills/event-tracking/` (Claude Desktop)
+- `.vscode/skills/event-tracking/` (VS Code/Amp)
+- Or check where this skill was installed
+
+If validation fails: fix the plan first, then implement.
+
+## 4) Implement tracking (platform-correct)
+
+Use MCP to fetch the exact `trackEvent` signature for the platform; then:
+
+- **Place calls at stable boundaries** (action confirmed, request succeeded,
+  state updated)
+- **Avoid duplicates** (don’t fire on every render; debounce where needed)
+- **Avoid null/complex values** (prefer primitives; serialize dates to ISO)
+- **Do not track PII by default**
+
+See `references/implementation-patterns.md` for placement heuristics and code
+patterns.
+
+## 5) Verify
+
+Minimum verification:
+
+- Event fires **exactly once** per user action (or the intended cadence)
+- Properties are **primitive + stable** (no null surprises)
+- For campaigns: console trigger conditions match **exact names/keys**
+
+For troubleshooting steps, see `references/debugging.md`.

package/skills/event-tracking/references/campaign-mapping.md

@@ -0,0 +1,29 @@
+# Campaign Mapping (Event-triggered)
+
+## Contents
+
+- What matters for event-triggered campaigns
+- Mapping checklist
+- Common mistakes
+
+## What matters
+
+- Triggers only apply to **new incoming events**
+- Campaign trigger config must match:
+  - **event name** exactly
+  - **property keys** exactly
+  - (often) **property types** as expected
+
+## Mapping checklist
+
+- Confirm the app sends `event_name` with the exact spelling used in the console
+- Confirm property keys are stable and `snake_case` (recommended)
+- If filtering on properties in the console, ensure:
+  - values are present (not null)
+  - value types are consistent (number vs string)
+
+## Common mistakes
+
+- Tracking `productId` but filtering on `product_id`
+- Sending numbers as strings (`"14"` vs `14`)
+- Tracking too early (before the action is truly completed)

package/skills/event-tracking/references/debugging.md

@@ -0,0 +1,30 @@
+# Debugging Event Tracking
+
+## Contents
+
+- Quick triage
+- Common causes
+- Verification checklist
+
+## Quick triage
+
+1. Confirm `Clix.initialize(...)` is called before any tracking.
+2. Confirm the event is fired exactly once (no render loops).
+3. Confirm properties are primitive and non-null.
+4. If using campaigns: confirm console trigger matches event name + property
+   keys exactly.
+
+## Common causes
+
+- **Not initialized**: tracking called before init completes.
+- **Duplicate events**: track call placed in render/recomposition or repeated
+  listeners.
+- **Bad property types**: objects/arrays, inconsistent types, nulls.
+- **Mismatch with campaigns**: name/key mismatch, different casing.
+
+## Verification checklist
+
+- Add temporary logs around the tracking call (and remove after verification)
+- Use a stable test flow to reproduce (single tap, single request)
+- Verify in Clix console that events appear (and that campaigns fire when
+  expected)

package/skills/event-tracking/references/implementation-patterns.md

@@ -0,0 +1,45 @@
+# Implementation Patterns
+
+## Contents
+
+- Where to place trackEvent calls
+- De-duplication guidance
+- Property hygiene
+- Platform notes
+
+## Where to place trackEvent calls
+
+Prefer stable boundaries (low risk of duplicate firing):
+
+- **User action confirmed**: button tap handler, after local validation passes
+- **Network success**: after API responds 2xx / mutation completes
+- **State change**: after the app updates state that the user can observe
+
+Avoid:
+
+- Render functions / recompositions
+- Generic “screen mounted” hooks without guards
+
+## De-duplication guidance
+
+Ensure “once per action”:
+
+- Debounce rapid taps where relevant
+- Track on success callbacks rather than optimistic UI (unless intentional)
+- For navigation-based events, ensure one event per screen transition
+
+## Property hygiene
+
+- Remove `null` values before sending (recommended across platforms)
+- Keep property values small and stable
+- Prefer enums/known strings over arbitrary user text
+
+## Platform notes (what the skill should remember)
+
+- **iOS**: properties are coerced to primitives; `Date` → ISO; other objects →
+  string.
+- **Android**: unknown objects become ISO (if recognized) else string; avoid
+  nulls.
+- **React Native**: `Date` is serialized to ISO; other values pass through.
+- **Flutter**: null properties are filtered out; supports `messageId` in event
+  API.

package/skills/event-tracking/references/naming-and-schema.md

@@ -0,0 +1,67 @@
+# Naming and Schema
+
+## Contents
+
+- Naming rules
+- Property rules
+- Privacy / PII guardrails
+- Event Plan template
+
+## Naming rules
+
+- **Event names**: `snake_case` (recommended)
+  - Good: `signup_completed`, `purchase_completed`, `screen_viewed`
+  - Avoid: spaces, mixed casing, unstable suffixes (timestamps, random IDs)
+- **Property keys**: also `snake_case`
+  - Good: `screen_name`, `payment_method`
+  - Avoid: `camelCase` mixed with `snake_case` in the same project
+
+## Property rules
+
+- Prefer JSON primitives:
+  - `string`, `number`, `boolean`
+- Datetimes:
+  - Prefer ISO 8601 strings or native date types supported by the platform SDK
+- Avoid:
+  - `null` (inconsistent across platforms)
+  - nested objects/arrays unless you intentionally stringify them
+
+## Privacy / PII guardrails
+
+Default stance: **do not track PII** unless the user explicitly approves.
+
+## Event Plan template
+
+Create `event-plan.json` in `.clix/` directory (recommended) or project root:
+
+**Recommended**: `.clix/event-plan.json` (organized, hidden, committable)
+**Alternative**: `event-plan.json` in project root (simpler)
+
+```json
+{
+  "conventions": {
+    "event_name_case": "snake_case",
+    "property_key_case": "snake_case"
+  },
+  "pii": {
+    "allowed": [],
+    "blocked": ["email", "phone", "name", "free_text"]
+  },
+  "events": [
+    {
+      "name": "signup_completed",
+      "when": "after backend confirms account creation",
+      "purpose": ["analytics", "campaigns"],
+      "properties": {
+        "method": { "type": "string", "required": true },
+        "trial_days": { "type": "number", "required": false }
+      }
+    }
+  ]
+}
+```
+
+**Note**: The `conventions` and `pii` fields are optional metadata for
+documentation purposes. The validation script only validates the `events` array
+structure. These fields help document your team's naming conventions and PII
+policies but are not enforced by the validator.

package/skills/event-tracking/references/trackevent-contract.md

@@ -0,0 +1,68 @@
+# Clix.trackEvent Contract
+
+## Contents
+
+- Contract summary
+- Payload shape (conceptual)
+- Property serialization rules
+- Platform differences (practical)
+- Pitfalls (what breaks campaigns)
+
+## Contract summary
+
+- **Event name**: a stable string (recommended `snake_case`)
+- **Properties**: a key/value map; prefer JSON primitives
+- **Initialization**: tracking requires the SDK to be initialized first
+- **Campaign usage**: event-triggered campaigns require **exact matches** for
+  event name + property keys
+
+## Payload shape (conceptual)
+
+SDKs send events to the Clix API as an array under `events`:
+
+- `device_id`
+- `name`
+- `event_property.custom_properties` (your properties)
+- Optional metadata fields used by the SDK (varies by platform):
+  - `message_id`
+  - `user_journey_id`
+  - `user_journey_node_id`
+
+## Property serialization rules
+
+Keep properties simple:
+
+- **Allowed**: `string`, `number`, `boolean`, ISO datetime strings
+- **Avoid**: nested objects/arrays, large blobs, free-text user content, PII
+- **Avoid nulls**: some SDKs drop nulls; others may stringify or encode null →
+  inconsistent analytics
+
+Dates:
+
+- Prefer passing a native date type (SDK will serialize) or an ISO string you
+  control.
+
+## Platform differences (practical)
+
+- **iOS**:
+  - Drops `nil` properties.
+  - Serializes `Date` to ISO.
+  - Supports extra metadata params in the internal event layer.
+- **Android**:
+  - Converts unknown objects to ISO (if recognized) else string.
+  - Null handling can be inconsistent; avoid null values.
+- **React Native**:
+  - Serializes `Date` properties to ISO strings.
+  - Supports `messageId` + journey IDs at the API layer.
+- **Flutter**:
+  - Drops null properties.
+  - Supports `messageId` (journey IDs may not be exposed in the Dart event API
+    layer).
+
+## Pitfalls (what breaks campaigns)
+
+- Event-triggered campaign never fires because:
+  - Event name mismatch (`signup_completed` vs `sign_up_completed`)
+  - Property key mismatch (`productId` vs `product_id`)
+  - Property type mismatch (number sent as string)
+  - Event fired too early / too often (duplicates)

package/skills/event-tracking/scripts/validate-event-plan.sh

@@ -0,0 +1,115 @@
+#!/usr/bin/env bash
+#
+# Validate a Clix event tracking plan (event-plan.json).
+#
+# Usage:
+#   bash skills/event-tracking/scripts/validate-event-plan.sh path/to/event-plan.json
+#
+# What it validates:
+# - JSON is valid
+# - event names and property keys are snake_case
+# - required fields exist (name/when/purpose/properties)
+#
+set -euo pipefail
+
+plan_path="${1:-}"
+if [[ -z "$plan_path" ]]; then
+  echo "Usage: bash skills/event-tracking/scripts/validate-event-plan.sh path/to/event-plan.json" >&2
+  exit 2
+fi
+
+if [[ ! -f "$plan_path" ]]; then
+  echo "Error: file not found: $plan_path" >&2
+  exit 2
+fi
+
+validate_with_python() {
+  python3 - "$plan_path" <<'PY'
+import json
+import re
+import sys
+
+path = sys.argv[1]
+
+snake = re.compile(r"^[a-z][a-z0-9_]*$")
+
+with open(path, "r", encoding="utf-8") as f:
+  data = json.load(f)
+
+errors = []
+
+events = data.get("events")
+if not isinstance(events, list) or not events:
+  errors.append("events must be a non-empty array")
+else:
+  seen_names = set()
+  for i, ev in enumerate(events):
+    name = ev.get("name")
+    if not isinstance(name, str) or not snake.match(name):
+      errors.append(f"events[{i}].name must be snake_case string")
+    elif name in seen_names:
+      errors.append(f"events[{i}].name is duplicated: '{name}'")
+    else:
+      seen_names.add(name)
+
+    when = ev.get("when")
+    if not isinstance(when, str) or not when.strip():
+      errors.append(f"events[{i}].when must be a non-empty string")
+
+    purpose = ev.get("purpose")
+    if not isinstance(purpose, list) or not purpose:
+      errors.append(f"events[{i}].purpose must be a non-empty array")
+    else:
+      allowed = {"analytics", "campaigns"}
+      bad = [p for p in purpose if not isinstance(p, str) or p not in allowed]
+      if bad:
+        errors.append(
+          f"events[{i}].purpose entries must be one of: analytics, campaigns"
+        )
+
+    props = ev.get("properties", {})
+    if props is None:
+      props = {}
+    if not isinstance(props, dict):
+      errors.append(f"events[{i}].properties must be an object")
+    else:
+      for key, spec in props.items():
+        if not isinstance(key, str) or not snake.match(key):
+          errors.append(f"events[{i}].properties key '{key}' must be snake_case")
+        if not isinstance(spec, dict):
+          errors.append(f"events[{i}].properties['{key}'] must be an object")
+          continue
+        t = spec.get("type")
+        if t is None:
+          errors.append(f"events[{i}].properties['{key}'].type is required")
+        elif t not in ("string", "number", "boolean", "datetime"):
+          errors.append(
+            f"events[{i}].properties['{key}'].type must be one of: string, number, boolean, datetime"
+          )
+        req = spec.get("required")
+        if req is not None and not isinstance(req, bool):
+          errors.append(f"events[{i}].properties['{key}'].required must be boolean if present")
+
+if errors:
+  print("❌ event-plan validation failed:")
+  for e in errors:
+    print(f"- {e}")
+  sys.exit(1)
+
+print("✅ event-plan validation passed")
+PY
+}
+
+if command -v python3 >/dev/null 2>&1; then
+  validate_with_python
+  exit 0
+fi
+
+echo "Warning: python3 not found; only checking JSON validity with node if available." >&2
+if command -v node >/dev/null 2>&1; then
+  node -e "JSON.parse(require('fs').readFileSync(process.argv[1], 'utf8')); console.log('✅ JSON is valid');" "$plan_path"
+  exit 0
+fi
+
+echo "Error: neither python3 nor node found; cannot validate." >&2
+exit 2

package/skills/integration/LICENSE.txt

@@ -1,3 +1,4 @@
+Copyright (c) 2026 Clix (https://clix.so/)
 
                                  Apache License
                            Version 2.0, January 2004
@@ -187,7 +188,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright (c) 2026 Clix (https://clix.so/)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.