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

package/skills/user-management/references/personalization-and-audience.md

@@ -0,0 +1,34 @@
+# Personalization + Audience Mapping
+
+## Contents
+
+- How user properties are used
+- Personalization (`user.*`)
+- Audience filters
+- Common mistakes
+
+## How user properties are used
+
+User properties power:
+
+- **Message personalization** via `user.*`
+- **Audience targeting** (filters on user/custom attributes)
+
+## Personalization (`user.*`)
+
+Use `user.*` variables in templates to personalize message content and links.
+Missing values render as empty string.
+
+## Audience filters
+
+Audience builder can filter on:
+
+- user id
+- built-in attributes (like last session)
+- custom attributes (your user properties)
+
+## Common mistakes
+
+- Storing PII (email/phone/name) as user properties by default.
+- Sending inconsistent types for the same property (e.g., `"25"` vs `25`).
+- Renaming keys without migrating campaign filters.

package/skills/user-management/references/property-schema.md

@@ -0,0 +1,65 @@
+# User Property Schema + PII Guardrails
+
+## Contents
+
+- Naming rules
+- Allowed types
+- PII guardrails
+- User Plan template
+
+## Naming rules
+
+- **Property keys**: `snake_case` recommended.
+- Prefer stable keys that won’t be renamed every sprint.
+
+## Allowed types
+
+- `string`
+- `number`
+- `boolean`
+
+If you must send complex objects: stringify intentionally and document it.
+
+## PII guardrails
+
+Default stance: **do not store PII in user properties** unless explicitly
+approved.
+
+Common PII/sensitive values to avoid:
+
+- email, phone number, full name
+- free-text fields (notes, messages)
+- government IDs, payment card details
+
+Prefer stable internal IDs:
+
+- `user_id` (your system’s id) instead of email/phone
+
+## User Plan template
+
+Create `.clix/user-plan.json` (recommended) or `user-plan.json` in project root:
+
+```json
+{
+  "conventions": {
+    "property_key_case": "snake_case"
+  },
+  "pii": {
+    "allowed": [],
+    "blocked": ["email", "phone", "name", "free_text"]
+  },
+  "user_id": {
+    "source": "auth response",
+    "example": "user_12345"
+  },
+  "logout_policy": "do_not_set_user_id_null",
+  "properties": {
+    "subscription_tier": { "type": "string", "required": false },
+    "premium": { "type": "boolean", "required": false },
+    "age": { "type": "number", "required": false }
+  }
+}
+```
+
+**Note**: The validation script validates `logout_policy`, `user_id`, and
+`properties`. The `conventions` and `pii` fields are optional metadata.

package/skills/user-management/references/user-management-contract.md

@@ -0,0 +1,56 @@
+# Clix User Management Contract
+
+## Contents
+
+- Core concepts
+- SDK surface (conceptual)
+- User properties types
+- Platform notes
+- Pitfalls
+
+## Core concepts
+
+- **Anonymous user**: default when no user ID is set.
+- **Identified user**: after setting user ID; historical activity is linked.
+- **Multi-device**: user identity can be consistent across devices when using
+  the same user ID.
+
+## SDK surface (conceptual)
+
+- `setUserId(userId)`
+- `removeUserId()`
+- `setUserProperty(key, value)`
+- `setUserProperties(map)`
+- `removeUserProperty(key)`
+- `removeUserProperties(keys)`
+
+## User properties types
+
+Prefer JSON primitives:
+
+- **string**
+- **number**
+- **boolean**
+
+Avoid:
+
+- `null` (inconsistent behavior)
+- nested objects/arrays unless you intentionally stringify them
+- PII unless explicitly approved
+
+## Platform notes
+
+- **iOS**: async + sync APIs exist; async is recommended.
+- **Android**: suspend functions; internal device service maps user ID to a user
+  property on the device backend.
+- **React Native**: Promise-based APIs.
+- **Flutter**: async APIs; user property model infers type and stringifies
+  unsupported values.
+
+## Pitfalls
+
+- Calling `setUserId(null)` on logout (don’t).
+- Setting user ID before login is confirmed (causes wrong attribution).
+- Sending PII as user properties by default.
+- Using unstable identifiers (email/phone) as user ID when an internal ID
+  exists.

package/skills/user-management/scripts/validate-user-plan.sh

@@ -0,0 +1,92 @@
+#!/usr/bin/env bash
+#
+# Validate a Clix user management plan (user-plan.json).
+#
+# Usage:
+#   bash skills/user-management/scripts/validate-user-plan.sh path/to/user-plan.json
+#
+set -euo pipefail
+
+plan_path="${1:-}"
+if [[ -z "$plan_path" ]]; then
+  echo "Usage: bash skills/user-management/scripts/validate-user-plan.sh path/to/user-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 = []
+
+logout_policy = data.get("logout_policy")
+if logout_policy not in (None, "do_not_set_user_id_null"):
+  errors.append("logout_policy must be 'do_not_set_user_id_null' if present")
+
+user_id = data.get("user_id")
+if not isinstance(user_id, dict):
+  errors.append("user_id must be an object")
+else:
+  src = user_id.get("source")
+  ex = user_id.get("example")
+  if not isinstance(src, str) or not src.strip():
+    errors.append("user_id.source must be a non-empty string")
+  if ex is not None and (not isinstance(ex, str) or not ex.strip()):
+    errors.append("user_id.example must be a non-empty string if present")
+
+props = data.get("properties")
+if not isinstance(props, dict) or not props:
+  errors.append("properties must be a non-empty object")
+else:
+  for key, spec in props.items():
+    if not isinstance(key, str) or not snake.match(key):
+      errors.append(f"properties key '{key}' must be snake_case")
+      continue
+    if not isinstance(spec, dict):
+      errors.append(f"properties['{key}'] must be an object")
+      continue
+    t = spec.get("type")
+    if t is None:
+      errors.append(f"properties['{key}'].type is required")
+    elif t not in ("string", "number", "boolean"):
+      errors.append(f"properties['{key}'].type must be one of: string, number, boolean")
+    req = spec.get("required")
+    if req is not None and not isinstance(req, bool):
+      errors.append(f"properties['{key}'].required must be boolean if present")
+
+if errors:
+  print("❌ user-plan validation failed:")
+  for e in errors:
+    print(f"- {e}")
+  sys.exit(1)
+
+print("✅ user-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