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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,14 +1,17 @@
1
1
  # Agent Skills for Clix
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/%40clix-so%2Fclix-agent-skills.svg?logo=npm&label=npm)](https://www.npmjs.com/package/@clix-so/clix-agent-skills)
4
+ [![npm downloads](https://img.shields.io/npm/dm/%40clix-so%2Fclix-agent-skills.svg)](https://www.npmjs.com/package/@clix-so/clix-agent-skills)
5
+
3
6
  This repository contains a collection of **Agent Skills for Clix**. Each skill
4
7
  is a self-contained package that can be loaded and executed by AI clients.
5
8
 
6
9
  ## Installing Skills
7
10
 
8
- Agents skills on this repository are built on the
11
+ Agent skills in this repository are built on the
9
12
  [open agent skills standard](https://agentskills.io/home). Please refer to the
10
13
  [official documentation](https://agentskills.io/home#adoption) for up-to-date
11
- information of support AI clients. Depending on the AI client you are using, you
14
+ information on supported AI clients. Depending on the AI client you are using, you
12
15
  can install skills in different ways.
13
16
 
14
17
  ### Universal CLI (Recommended)
@@ -18,11 +21,24 @@ For **Cursor**, **VS Code**, **Claude Desktop**, **OpenCode**, **Goose**,
18
21
  and configure the Clix MCP Server automatically:
19
22
 
20
23
  ```bash
24
+ # Install a specific skill
21
25
  npx @clix-so/clix-agent-skills@latest install <skill-name> --client <your-client>
22
- # For example, to install integration skill on Cursor:
23
- # npx @clix-so/clix-agent-skills@latest install integration --client cursor
26
+ # For example, to install a skill on Cursor:
27
+ npx @clix-so/clix-agent-skills@latest install integration --client cursor
28
+
29
+ # Install all available skills at once
30
+ npx @clix-so/clix-agent-skills@latest install --all --client cursor
31
+ # This will install: integration, event-tracking, user-management
24
32
  ```
25
33
 
34
+ ### Available Skills
35
+
36
+ - **clix-integration**: Integrate Clix Mobile SDK and MCP server setup
37
+ - **clix-event-tracking**: Implement `Clix.trackEvent` with naming/schema best
38
+ practices and campaign-ready validation
39
+ - **clix-user-management**: Implement `Clix.setUserId` + user properties with
40
+ logout best practices, personalization (`user.*`), and audience targeting
41
+
26
42
  **Supported Clients:**
27
43
 
28
44
  | Client | Flag | Default Path |
@@ -47,17 +63,19 @@ following command:
47
63
 
48
64
  To install specific skills:
49
65
 
50
- 1. Select `Browse and install plugins`
51
- 2. Select `clix-agent-skills` from the list
66
+ 1. Visit the Marketplace section in `/plugin`
67
+ 2. Select `Browse plugins`
52
68
  3. Choose the skills you wish to install
53
- 4. Click `Install` to proceed
69
+ 4. Install skill
54
70
 
55
71
  Alternatively, you can install a single skill directly by running:
56
72
 
57
73
  ```bash
58
74
  /plugin install <plugin-name>@<marketplace-name>
59
75
  # For example
60
- # /plugin install clix-integration@clix-agent-skills
76
+ /plugin install clix-integration@clix-agent-skills
77
+ /plugin install clix-event-tracking@clix-agent-skills
78
+ /plugin install clix-user-management@clix-agent-skills
61
79
  ```
62
80
 
63
81
  Remember to restart Claude Code after installation to load the new skills.
@@ -70,7 +88,9 @@ configuration directory:
70
88
 
71
89
  Or install a specific skill using the command line:
72
90
 
73
- ```
91
+ ```bash
92
+ $skill-installer install <link-to-skill-folder>
93
+ # For example
74
94
  $skill-installer install https://github.com/clix-so/skills/tree/main/skills/integration
75
95
  ```
76
96
 
@@ -78,12 +98,11 @@ Ensure you restart Codex after installation to detect the new skills.
78
98
 
79
99
  ## Disclaimer
80
100
 
81
- Please be aware that **these skills may occasionally fail or execute
82
- incorrectly** due to the non-deterministic nature of AI.
83
-
84
- It is critical that you **carefully review and verify all actions** performed by
85
- these skills. While they are designed to be helpful, you remain responsible for
86
- checking their output before use. Please use them with caution and supervision.
101
+ Please be aware that these skills may occasionally fail or execute incorrectly
102
+ due to the non-deterministic nature of AI. It is critical that you carefully
103
+ review and verify all actions performed by these skills. While they are designed
104
+ to be helpful, you remain responsible for checking their output before use.
105
+ Please use them with caution and supervision.
87
106
 
88
107
  ## License
89
108
 
package/dist/bin/cli.js CHANGED
@@ -23,16 +23,26 @@ program
23
23
  .description("CLI to manage and install Clix Agent Skills")
24
24
  .version(package_json_1.version);
25
25
  program
26
- .command("install <skill>")
27
- .description("Install a specific agent skill")
26
+ .command("install [skill]")
27
+ .description("Install agent skill(s)")
28
28
  .option("-c, --client <client>", "Target AI client (cursor, claude, vscode, amp, kiro, amazonq, codex, opencode, manual)")
29
29
  .option("-p, --path <path>", "Custom installation path (default: .clix/skills)")
30
+ .option("-a, --all", "Install all available skills")
30
31
  .action(async (skill, options) => {
31
32
  try {
32
- await (0, install_1.installSkill)(skill, options);
33
+ if (options.all) {
34
+ await (0, install_1.installAllSkills)(options);
35
+ }
36
+ else if (skill) {
37
+ await (0, install_1.installSkill)(skill, options);
38
+ }
39
+ else {
40
+ console.error(chalk_1.default.red("Error: Please specify a skill name or use --all flag"));
41
+ process.exit(1);
42
+ }
33
43
  }
34
44
  catch (error) {
35
- console.error(chalk_1.default.red("Error installing skill:"), getErrorMessage(error));
45
+ console.error(chalk_1.default.red("Error installing skill(s):"), getErrorMessage(error));
36
46
  process.exit(1);
37
47
  }
38
48
  });
@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.installSkill = installSkill;
7
+ exports.installAllSkills = installAllSkills;
7
8
  const path_1 = __importDefault(require("path"));
8
9
  const fs_extra_1 = __importDefault(require("fs-extra"));
9
10
  const chalk_1 = __importDefault(require("chalk"));
@@ -121,3 +122,59 @@ async function installSkill(skillName, options) {
121
122
  console.log(` - Docs: ${path_1.default.join(destPath, "SKILL.md")}`);
122
123
  console.log(` - Instruct your agent to read these docs to start working.`);
123
124
  }
125
+ /**
126
+ * Find all available skills in the skills directory
127
+ */
128
+ async function findAllSkills() {
129
+ // Find package root (same logic as installSkill)
130
+ let packageRoot = __dirname;
131
+ while (!fs_extra_1.default.existsSync(path_1.default.join(packageRoot, "package.json"))) {
132
+ const parent = path_1.default.dirname(packageRoot);
133
+ if (parent === packageRoot) {
134
+ packageRoot = process.cwd();
135
+ break;
136
+ }
137
+ packageRoot = parent;
138
+ }
139
+ const skillsDir = path_1.default.join(packageRoot, "skills");
140
+ if (!fs_extra_1.default.existsSync(skillsDir)) {
141
+ return [];
142
+ }
143
+ const entries = await fs_extra_1.default.readdir(skillsDir, { withFileTypes: true });
144
+ return entries
145
+ .filter((entry) => entry.isDirectory())
146
+ .filter((entry) => fs_extra_1.default.existsSync(path_1.default.join(skillsDir, entry.name, "SKILL.md")))
147
+ .map((entry) => entry.name);
148
+ }
149
+ /**
150
+ * Install all available skills
151
+ */
152
+ async function installAllSkills(options) {
153
+ const spinner = (0, ora_1.default)("Discovering available skills...").start();
154
+ const skills = await findAllSkills();
155
+ if (skills.length === 0) {
156
+ spinner.fail("No skills found to install.");
157
+ return;
158
+ }
159
+ spinner.succeed(`Found ${chalk_1.default.bold(skills.length)} skill(s): ${skills.join(", ")}`);
160
+ console.log();
161
+ let successCount = 0;
162
+ let failCount = 0;
163
+ for (const skillName of skills) {
164
+ try {
165
+ await installSkill(skillName, options);
166
+ successCount++;
167
+ }
168
+ catch (error) {
169
+ console.error(chalk_1.default.red(`\n✗ Failed to install ${chalk_1.default.bold(skillName)}: ${getErrorMessage(error)}`));
170
+ failCount++;
171
+ }
172
+ }
173
+ console.log();
174
+ if (failCount === 0) {
175
+ console.log(chalk_1.default.green(`\n✔ Successfully installed all ${chalk_1.default.bold(successCount)} skill(s)!`));
176
+ }
177
+ else {
178
+ console.log(chalk_1.default.yellow(`\n⚠ Installed ${chalk_1.default.bold(successCount)} skill(s), ${chalk_1.default.bold(failCount)} failed.`));
179
+ }
180
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clix-so/clix-agent-skills",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "An open collection of agent skills for Clix.",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
@@ -0,0 +1,203 @@
1
+ Copyright (c) 2026 Clix (https://clix.so/)
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright (c) 2026 Clix (https://clix.so/)
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,126 @@
1
+ ---
2
+ name: clix-event-tracking
3
+ description:
4
+ Implements Clix event tracking (Clix.trackEvent) with consistent naming, safe
5
+ property schemas, and campaign-ready validation. Use when adding, reviewing,
6
+ or debugging event tracking; when configuring event-triggered campaigns; or
7
+ when the user mentions events, tracking, funnels, or properties.
8
+ ---
9
+
10
+ # Tracking Clix Events
11
+
12
+ Use this skill to help developers design and implement **Clix event tracking**
13
+ via `Clix.trackEvent(...)` so events can drive **event-triggered campaigns**,
14
+ **audience filters**, and **personalization**.
15
+
16
+ ## What the official docs guarantee (high-signal)
17
+
18
+ - **When to track**: identify the user action/system event, then attach
19
+ meaningful properties (funnel checkpoints, milestones, button taps).
20
+ - **Property normalization**: booleans/numbers/strings map directly; date-like
21
+ values serialize to ISO 8601; unsupported objects become strings.
22
+ - **Error handling**: event tracking calls can throw—always handle errors so the
23
+ app stays robust.
24
+
25
+ ## MCP-first (source of truth)
26
+
27
+ If Clix MCP tools are available, treat them as the **source of truth**:
28
+
29
+ - `clix-mcp-server:search_docs` for conceptual behavior (campaign triggers,
30
+ personalization)
31
+ - `clix-mcp-server:search_sdk` for exact SDK signatures per platform
32
+
33
+ If MCP tools are not available, use the bundled references:
34
+
35
+ - Event API contract + pitfalls → `references/trackevent-contract.md`
36
+ - Naming + schemas + privacy → `references/naming-and-schema.md`
37
+ - Implementation patterns → `references/implementation-patterns.md`
38
+ - Campaign mapping → `references/campaign-mapping.md`
39
+ - Debugging checklist → `references/debugging.md`
40
+
41
+ ## Workflow (copy + check off)
42
+
43
+ ```
44
+ Event tracking progress:
45
+ - [ ] 1) Confirm platform(s) and goals (analytics vs campaign triggers)
46
+ - [ ] 2) Propose event plan (names, when fired, properties, where in code)
47
+ - [ ] 3) Validate plan (names, keys, types, PII constraints)
48
+ - [ ] 4) Implement trackEvent calls (platform-correct)
49
+ - [ ] 5) Verify: events fire once, serialize cleanly, match campaign configs
50
+ ```
51
+
52
+ ## 1) Confirm the minimum inputs
53
+
54
+ Ask only what’s needed:
55
+
56
+ - **Platform**: iOS / Android / React Native / Flutter
57
+ - **Goal**: analytics only, event-triggered campaigns, or both
58
+ - **Top flows** (1–3): e.g., onboarding, checkout, subscription
59
+ - **PII policy**: what must never be sent (email/phone/name/free-text, etc.)
60
+
61
+ ## 2) Propose an “Event Plan” (before touching code)
62
+
63
+ Return a compact table the user can approve:
64
+
65
+ - **event_name** (stable, `snake_case`)
66
+ - **when** (exact moment the event fires)
67
+ - **properties** (key + type, mark required vs optional)
68
+ - **location** (file/function/UI handler/network response)
69
+ - **purpose** (campaign trigger / analytics / both)
70
+
71
+ If campaigns are involved, remind: **event names and property keys must match
72
+ exactly** in the Clix console.
73
+
74
+ ## 3) Validate the plan (fast feedback loop)
75
+
76
+ Create `event-plan.json` in `.clix/` directory (recommended) or project root:
77
+
78
+ **Recommended location**: `.clix/event-plan.json`
79
+
80
+ - Organized: keeps tooling configs together
81
+ - Hidden: doesn't clutter project root
82
+ - Committable: planning document for team review
83
+
84
+ **Alternative**: `event-plan.json` in project root (simpler, but less organized)
85
+
86
+ **For agents**: Locate `scripts/validate-event-plan.sh` in the installed skill
87
+ directory, then run it:
88
+
89
+ ```bash
90
+ # From project root:
91
+ bash <skill-dir>/scripts/validate-event-plan.sh .clix/event-plan.json
92
+ # Or if in root:
93
+ bash <skill-dir>/scripts/validate-event-plan.sh event-plan.json
94
+ ```
95
+
96
+ The skill directory is typically:
97
+
98
+ - `.cursor/skills/event-tracking/` (Cursor)
99
+ - `.claude/skills/event-tracking/` (Claude Desktop)
100
+ - `.vscode/skills/event-tracking/` (VS Code/Amp)
101
+ - Or check where this skill was installed
102
+
103
+ If validation fails: fix the plan first, then implement.
104
+
105
+ ## 4) Implement tracking (platform-correct)
106
+
107
+ Use MCP to fetch the exact `trackEvent` signature for the platform; then:
108
+
109
+ - **Place calls at stable boundaries** (action confirmed, request succeeded,
110
+ state updated)
111
+ - **Avoid duplicates** (don’t fire on every render; debounce where needed)
112
+ - **Avoid null/complex values** (prefer primitives; serialize dates to ISO)
113
+ - **Do not track PII by default**
114
+
115
+ See `references/implementation-patterns.md` for placement heuristics and code
116
+ patterns.
117
+
118
+ ## 5) Verify
119
+
120
+ Minimum verification:
121
+
122
+ - Event fires **exactly once** per user action (or the intended cadence)
123
+ - Properties are **primitive + stable** (no null surprises)
124
+ - For campaigns: console trigger conditions match **exact names/keys**
125
+
126
+ For troubleshooting steps, see `references/debugging.md`.
@@ -0,0 +1,29 @@
1
+ # Campaign Mapping (Event-triggered)
2
+
3
+ ## Contents
4
+
5
+ - What matters for event-triggered campaigns
6
+ - Mapping checklist
7
+ - Common mistakes
8
+
9
+ ## What matters
10
+
11
+ - Triggers only apply to **new incoming events**
12
+ - Campaign trigger config must match:
13
+ - **event name** exactly
14
+ - **property keys** exactly
15
+ - (often) **property types** as expected
16
+
17
+ ## Mapping checklist
18
+
19
+ - Confirm the app sends `event_name` with the exact spelling used in the console
20
+ - Confirm property keys are stable and `snake_case` (recommended)
21
+ - If filtering on properties in the console, ensure:
22
+ - values are present (not null)
23
+ - value types are consistent (number vs string)
24
+
25
+ ## Common mistakes
26
+
27
+ - Tracking `productId` but filtering on `product_id`
28
+ - Sending numbers as strings (`"14"` vs `14`)
29
+ - Tracking too early (before the action is truly completed)
@@ -0,0 +1,30 @@
1
+ # Debugging Event Tracking
2
+
3
+ ## Contents
4
+
5
+ - Quick triage
6
+ - Common causes
7
+ - Verification checklist
8
+
9
+ ## Quick triage
10
+
11
+ 1. Confirm `Clix.initialize(...)` is called before any tracking.
12
+ 2. Confirm the event is fired exactly once (no render loops).
13
+ 3. Confirm properties are primitive and non-null.
14
+ 4. If using campaigns: confirm console trigger matches event name + property
15
+ keys exactly.
16
+
17
+ ## Common causes
18
+
19
+ - **Not initialized**: tracking called before init completes.
20
+ - **Duplicate events**: track call placed in render/recomposition or repeated
21
+ listeners.
22
+ - **Bad property types**: objects/arrays, inconsistent types, nulls.
23
+ - **Mismatch with campaigns**: name/key mismatch, different casing.
24
+
25
+ ## Verification checklist
26
+
27
+ - Add temporary logs around the tracking call (and remove after verification)
28
+ - Use a stable test flow to reproduce (single tap, single request)
29
+ - Verify in Clix console that events appear (and that campaigns fire when
30
+ expected)
@@ -0,0 +1,45 @@
1
+ # Implementation Patterns
2
+
3
+ ## Contents
4
+
5
+ - Where to place trackEvent calls
6
+ - De-duplication guidance
7
+ - Property hygiene
8
+ - Platform notes
9
+
10
+ ## Where to place trackEvent calls
11
+
12
+ Prefer stable boundaries (low risk of duplicate firing):
13
+
14
+ - **User action confirmed**: button tap handler, after local validation passes
15
+ - **Network success**: after API responds 2xx / mutation completes
16
+ - **State change**: after the app updates state that the user can observe
17
+
18
+ Avoid:
19
+
20
+ - Render functions / recompositions
21
+ - Generic “screen mounted” hooks without guards
22
+
23
+ ## De-duplication guidance
24
+
25
+ Ensure “once per action”:
26
+
27
+ - Debounce rapid taps where relevant
28
+ - Track on success callbacks rather than optimistic UI (unless intentional)
29
+ - For navigation-based events, ensure one event per screen transition
30
+
31
+ ## Property hygiene
32
+
33
+ - Remove `null` values before sending (recommended across platforms)
34
+ - Keep property values small and stable
35
+ - Prefer enums/known strings over arbitrary user text
36
+
37
+ ## Platform notes (what the skill should remember)
38
+
39
+ - **iOS**: properties are coerced to primitives; `Date` → ISO; other objects →
40
+ string.
41
+ - **Android**: unknown objects become ISO (if recognized) else string; avoid
42
+ nulls.
43
+ - **React Native**: `Date` is serialized to ISO; other values pass through.
44
+ - **Flutter**: null properties are filtered out; supports `messageId` in event
45
+ API.