@clix-so/clix-agent-skills 0.1.3 → 0.1.5
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 +60 -16
- package/dist/bin/cli.js +15 -4
- package/dist/bin/commands/install.js +66 -3
- package/dist/bin/utils/mcp.js +8 -10
- package/llms.txt +77 -0
- package/package.json +5 -3
- package/skills/event-tracking/LICENSE.txt +203 -0
- package/skills/event-tracking/SKILL.md +126 -0
- package/skills/event-tracking/references/campaign-mapping.md +29 -0
- package/skills/event-tracking/references/debugging.md +30 -0
- package/skills/event-tracking/references/implementation-patterns.md +45 -0
- package/skills/event-tracking/references/naming-and-schema.md +67 -0
- package/skills/event-tracking/references/trackevent-contract.md +68 -0
- package/skills/event-tracking/scripts/validate-event-plan.sh +115 -0
- package/skills/integration/LICENSE.txt +2 -1
- package/skills/user-management/LICENSE.txt +203 -0
- package/skills/user-management/SKILL.md +114 -0
- package/skills/user-management/references/debugging.md +29 -0
- package/skills/user-management/references/implementation-patterns.md +37 -0
- package/skills/user-management/references/logout-and-switching.md +32 -0
- package/skills/user-management/references/personalization-and-audience.md +34 -0
- package/skills/user-management/references/property-schema.md +65 -0
- package/skills/user-management/references/user-management-contract.md +56 -0
- package/skills/user-management/scripts/validate-user-plan.sh +92 -0
|
@@ -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,114 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: clix-user-management
|
|
3
|
+
description:
|
|
4
|
+
Implements Clix user identification and user properties (setUserId,
|
|
5
|
+
removeUserId, setUserProperty/setUserProperties,
|
|
6
|
+
removeUserProperty/removeUserProperties) with safe schemas, logout best
|
|
7
|
+
practices, and campaign-ready personalization/audience usage. Use when the
|
|
8
|
+
user mentions login/logout, userId, user properties, personalization, or
|
|
9
|
+
audience targeting.
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Clix User Management
|
|
13
|
+
|
|
14
|
+
Use this skill to help developers implement **Clix user identification** and
|
|
15
|
+
**user properties** so campaigns can use `user.*` variables and audience
|
|
16
|
+
filters, and so user identity is consistent across devices and sessions.
|
|
17
|
+
|
|
18
|
+
## What the official docs guarantee (high-signal)
|
|
19
|
+
|
|
20
|
+
- **Anonymous vs identified**: if no user ID is set, Clix treats the user as
|
|
21
|
+
anonymous; setting a user ID converts the anonymous user into an identified
|
|
22
|
+
user and links prior activity.
|
|
23
|
+
- **Logout**: **do not** call `setUserId(null)` on logout; handle logout in app
|
|
24
|
+
logic only; when a different user logs in, call `setUserId(newUserId)` to
|
|
25
|
+
switch.
|
|
26
|
+
- **User properties**: values are strings, numbers, or booleans; user operations
|
|
27
|
+
can throw—handle errors.
|
|
28
|
+
|
|
29
|
+
## MCP-first (source of truth)
|
|
30
|
+
|
|
31
|
+
If Clix MCP tools are available, treat them as the **source of truth**:
|
|
32
|
+
|
|
33
|
+
- `clix-mcp-server:search_docs` for conceptual behavior and logout guidance
|
|
34
|
+
- `clix-mcp-server:search_sdk` for exact SDK signatures per platform
|
|
35
|
+
|
|
36
|
+
If MCP tools are not available, use the bundled references:
|
|
37
|
+
|
|
38
|
+
- Contract + pitfalls → `references/user-management-contract.md`
|
|
39
|
+
- Logout + switching rules → `references/logout-and-switching.md`
|
|
40
|
+
- Property schema + PII → `references/property-schema.md`
|
|
41
|
+
- Implementation patterns → `references/implementation-patterns.md`
|
|
42
|
+
- Personalization + audience mapping →
|
|
43
|
+
`references/personalization-and-audience.md`
|
|
44
|
+
- Debugging checklist → `references/debugging.md`
|
|
45
|
+
|
|
46
|
+
## Workflow (copy + check off)
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
User management progress:
|
|
50
|
+
- [ ] 1) Confirm platform(s) and auth model (anonymous browsing? login? shared devices?)
|
|
51
|
+
- [ ] 2) Propose user plan (when setUserId/removeUserId, properties, logout policy)
|
|
52
|
+
- [ ] 3) Validate plan (PII, property types, logout rules)
|
|
53
|
+
- [ ] 4) Implement (platform-correct calls + error handling)
|
|
54
|
+
- [ ] 5) Verify (switching works, properties appear, campaigns can target/personalize)
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 1) Confirm the minimum inputs
|
|
58
|
+
|
|
59
|
+
Ask only what’s needed:
|
|
60
|
+
|
|
61
|
+
- **Platform**: iOS / Android / React Native / Flutter
|
|
62
|
+
- **Auth events**: where login success and logout happen in code
|
|
63
|
+
- **User identifier**: what stable ID to use (prefer internal user id, not
|
|
64
|
+
email)
|
|
65
|
+
- **PII policy**: what must never be stored as user properties
|
|
66
|
+
- **Campaign goals**: personalization, audience filters, or both
|
|
67
|
+
|
|
68
|
+
## 2) Propose a “User Plan” (before touching code)
|
|
69
|
+
|
|
70
|
+
Return a compact table:
|
|
71
|
+
|
|
72
|
+
- **user_id source**: where it comes from (auth response, local db)
|
|
73
|
+
- **setUserId timing**: exact point (after login success / token saved)
|
|
74
|
+
- **logout behavior**: explicitly “no call to setUserId(null)”
|
|
75
|
+
- **properties**: key + type, required vs optional
|
|
76
|
+
- **purpose**: personalization / audience / analytics
|
|
77
|
+
|
|
78
|
+
## 3) Validate the plan (fast feedback loop)
|
|
79
|
+
|
|
80
|
+
Create `user-plan.json` in `.clix/` (recommended) or project root.
|
|
81
|
+
|
|
82
|
+
**For agents**: locate `scripts/validate-user-plan.sh` in the installed skill
|
|
83
|
+
directory and run:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
# From project root:
|
|
87
|
+
bash <skill-dir>/scripts/validate-user-plan.sh .clix/user-plan.json
|
|
88
|
+
# Or if in root:
|
|
89
|
+
bash <skill-dir>/scripts/validate-user-plan.sh user-plan.json
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
If validation fails: fix the plan first, then implement.
|
|
93
|
+
|
|
94
|
+
## 4) Implement (platform-correct)
|
|
95
|
+
|
|
96
|
+
Use MCP to fetch the exact signatures per platform, then:
|
|
97
|
+
|
|
98
|
+
- Place `setUserId(...)` **after** login/signup is confirmed.
|
|
99
|
+
- On logout: **do nothing with Clix** (no `setUserId(null)`).
|
|
100
|
+
- When switching users: call `setUserId(newUserId)` after the new login
|
|
101
|
+
succeeds.
|
|
102
|
+
- Set user properties only from controlled sources; avoid free-text/PII.
|
|
103
|
+
- Always handle errors (async calls can throw).
|
|
104
|
+
|
|
105
|
+
## 5) Verify
|
|
106
|
+
|
|
107
|
+
- Identity:
|
|
108
|
+
- Anonymous flow works without calling `setUserId`
|
|
109
|
+
- After login, `setUserId` is called once and stable
|
|
110
|
+
- Switching accounts updates the active profile
|
|
111
|
+
- Properties:
|
|
112
|
+
- Properties are primitives (string/number/boolean) and consistent
|
|
113
|
+
- Campaign audiences can filter on them
|
|
114
|
+
- Messages can use `user.*` personalization
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Debugging User Management
|
|
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 user operations.
|
|
12
|
+
2. Confirm `setUserId(...)` is called only after login success.
|
|
13
|
+
3. Confirm logout does **not** call `setUserId(null)`.
|
|
14
|
+
4. Confirm user properties are primitives and stable.
|
|
15
|
+
|
|
16
|
+
## Common causes
|
|
17
|
+
|
|
18
|
+
- **Not initialized**: calls before init completes.
|
|
19
|
+
- **Wrong timing**: calling `setUserId` before auth success.
|
|
20
|
+
- **Bad property values**: objects/arrays, inconsistent types.
|
|
21
|
+
- **PII leakage**: sending email/phone/name.
|
|
22
|
+
|
|
23
|
+
## Verification checklist
|
|
24
|
+
|
|
25
|
+
- Add temporary logs around login success and user calls (remove after).
|
|
26
|
+
- Verify in Clix dashboard:
|
|
27
|
+
- user id shows as expected
|
|
28
|
+
- properties appear and are filterable
|
|
29
|
+
- message templates can resolve `user.*`
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Implementation Patterns
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
|
|
5
|
+
- When to call setUserId
|
|
6
|
+
- When to remove user id
|
|
7
|
+
- Property update patterns
|
|
8
|
+
- Error handling
|
|
9
|
+
|
|
10
|
+
## When to call setUserId
|
|
11
|
+
|
|
12
|
+
Call `setUserId(userId)`:
|
|
13
|
+
|
|
14
|
+
- after login/signup succeeds (not on button tap)
|
|
15
|
+
- after you have a stable identifier (prefer internal user id)
|
|
16
|
+
- ideally once per session change (dedupe repeated calls)
|
|
17
|
+
|
|
18
|
+
## When to remove user id
|
|
19
|
+
|
|
20
|
+
Prefer the docs-recommended logout behavior:
|
|
21
|
+
|
|
22
|
+
- On logout: **do nothing with Clix**.
|
|
23
|
+
|
|
24
|
+
Only use `removeUserId()` if you have a strong reason and you understand the
|
|
25
|
+
impact on shared devices and re-engagement.
|
|
26
|
+
|
|
27
|
+
## Property update patterns
|
|
28
|
+
|
|
29
|
+
- Set properties from controlled sources (backend flags, billing state).
|
|
30
|
+
- Use small, stable values (enums/known strings).
|
|
31
|
+
- Avoid frequent writes in tight loops.
|
|
32
|
+
|
|
33
|
+
## Error handling
|
|
34
|
+
|
|
35
|
+
- Treat user management operations as potentially failing:
|
|
36
|
+
- wrap async calls in try/catch
|
|
37
|
+
- log enough context to debug (user id, property keys—not values if sensitive)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Logout and User Switching
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
|
|
5
|
+
- Golden rule
|
|
6
|
+
- Recommended patterns
|
|
7
|
+
- What to avoid
|
|
8
|
+
|
|
9
|
+
## Golden rule
|
|
10
|
+
|
|
11
|
+
**Do not call `setUserId(null)` on logout.**
|
|
12
|
+
|
|
13
|
+
Instead:
|
|
14
|
+
|
|
15
|
+
- On logout: do nothing with Clix (only clear your app session).
|
|
16
|
+
- On next login: call `setUserId(newUserId)` to switch profiles.
|
|
17
|
+
|
|
18
|
+
## Recommended patterns
|
|
19
|
+
|
|
20
|
+
- **Login success boundary**:
|
|
21
|
+
- after auth succeeds (and you have a stable user id)
|
|
22
|
+
- after tokens/session are stored (if applicable)
|
|
23
|
+
- then call `setUserId(userId)`
|
|
24
|
+
|
|
25
|
+
- **Shared device**:
|
|
26
|
+
- keep an internal notion of “current user”
|
|
27
|
+
- do not try to “reset” Clix user on logout
|
|
28
|
+
|
|
29
|
+
## What to avoid
|
|
30
|
+
|
|
31
|
+
- `setUserId(null)` or “clear user” calls on logout.
|
|
32
|
+
- setting user ID based on unverified inputs (typed email in login form).
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Personalization + Audience Mapping
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
|
|
5
|
+
- How user properties are used
|
|
6
|
+
- Personalization (`user.*`)
|
|
7
|
+
- Audience filters
|
|
8
|
+
- Common mistakes
|
|
9
|
+
|
|
10
|
+
## How user properties are used
|
|
11
|
+
|
|
12
|
+
User properties power:
|
|
13
|
+
|
|
14
|
+
- **Message personalization** via `user.*`
|
|
15
|
+
- **Audience targeting** (filters on user/custom attributes)
|
|
16
|
+
|
|
17
|
+
## Personalization (`user.*`)
|
|
18
|
+
|
|
19
|
+
Use `user.*` variables in templates to personalize message content and links.
|
|
20
|
+
Missing values render as empty string.
|
|
21
|
+
|
|
22
|
+
## Audience filters
|
|
23
|
+
|
|
24
|
+
Audience builder can filter on:
|
|
25
|
+
|
|
26
|
+
- user id
|
|
27
|
+
- built-in attributes (like last session)
|
|
28
|
+
- custom attributes (your user properties)
|
|
29
|
+
|
|
30
|
+
## Common mistakes
|
|
31
|
+
|
|
32
|
+
- Storing PII (email/phone/name) as user properties by default.
|
|
33
|
+
- Sending inconsistent types for the same property (e.g., `"25"` vs `25`).
|
|
34
|
+
- Renaming keys without migrating campaign filters.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# User Property Schema + PII Guardrails
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
|
|
5
|
+
- Naming rules
|
|
6
|
+
- Allowed types
|
|
7
|
+
- PII guardrails
|
|
8
|
+
- User Plan template
|
|
9
|
+
|
|
10
|
+
## Naming rules
|
|
11
|
+
|
|
12
|
+
- **Property keys**: `snake_case` recommended.
|
|
13
|
+
- Prefer stable keys that won’t be renamed every sprint.
|
|
14
|
+
|
|
15
|
+
## Allowed types
|
|
16
|
+
|
|
17
|
+
- `string`
|
|
18
|
+
- `number`
|
|
19
|
+
- `boolean`
|
|
20
|
+
|
|
21
|
+
If you must send complex objects: stringify intentionally and document it.
|
|
22
|
+
|
|
23
|
+
## PII guardrails
|
|
24
|
+
|
|
25
|
+
Default stance: **do not store PII in user properties** unless explicitly
|
|
26
|
+
approved.
|
|
27
|
+
|
|
28
|
+
Common PII/sensitive values to avoid:
|
|
29
|
+
|
|
30
|
+
- email, phone number, full name
|
|
31
|
+
- free-text fields (notes, messages)
|
|
32
|
+
- government IDs, payment card details
|
|
33
|
+
|
|
34
|
+
Prefer stable internal IDs:
|
|
35
|
+
|
|
36
|
+
- `user_id` (your system’s id) instead of email/phone
|
|
37
|
+
|
|
38
|
+
## User Plan template
|
|
39
|
+
|
|
40
|
+
Create `.clix/user-plan.json` (recommended) or `user-plan.json` in project root:
|
|
41
|
+
|
|
42
|
+
```json
|
|
43
|
+
{
|
|
44
|
+
"conventions": {
|
|
45
|
+
"property_key_case": "snake_case"
|
|
46
|
+
},
|
|
47
|
+
"pii": {
|
|
48
|
+
"allowed": [],
|
|
49
|
+
"blocked": ["email", "phone", "name", "free_text"]
|
|
50
|
+
},
|
|
51
|
+
"user_id": {
|
|
52
|
+
"source": "auth response",
|
|
53
|
+
"example": "user_12345"
|
|
54
|
+
},
|
|
55
|
+
"logout_policy": "do_not_set_user_id_null",
|
|
56
|
+
"properties": {
|
|
57
|
+
"subscription_tier": { "type": "string", "required": false },
|
|
58
|
+
"premium": { "type": "boolean", "required": false },
|
|
59
|
+
"age": { "type": "number", "required": false }
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Note**: The validation script validates `logout_policy`, `user_id`, and
|
|
65
|
+
`properties`. The `conventions` and `pii` fields are optional metadata.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Clix User Management Contract
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
|
|
5
|
+
- Core concepts
|
|
6
|
+
- SDK surface (conceptual)
|
|
7
|
+
- User properties types
|
|
8
|
+
- Platform notes
|
|
9
|
+
- Pitfalls
|
|
10
|
+
|
|
11
|
+
## Core concepts
|
|
12
|
+
|
|
13
|
+
- **Anonymous user**: default when no user ID is set.
|
|
14
|
+
- **Identified user**: after setting user ID; historical activity is linked.
|
|
15
|
+
- **Multi-device**: user identity can be consistent across devices when using
|
|
16
|
+
the same user ID.
|
|
17
|
+
|
|
18
|
+
## SDK surface (conceptual)
|
|
19
|
+
|
|
20
|
+
- `setUserId(userId)`
|
|
21
|
+
- `removeUserId()`
|
|
22
|
+
- `setUserProperty(key, value)`
|
|
23
|
+
- `setUserProperties(map)`
|
|
24
|
+
- `removeUserProperty(key)`
|
|
25
|
+
- `removeUserProperties(keys)`
|
|
26
|
+
|
|
27
|
+
## User properties types
|
|
28
|
+
|
|
29
|
+
Prefer JSON primitives:
|
|
30
|
+
|
|
31
|
+
- **string**
|
|
32
|
+
- **number**
|
|
33
|
+
- **boolean**
|
|
34
|
+
|
|
35
|
+
Avoid:
|
|
36
|
+
|
|
37
|
+
- `null` (inconsistent behavior)
|
|
38
|
+
- nested objects/arrays unless you intentionally stringify them
|
|
39
|
+
- PII unless explicitly approved
|
|
40
|
+
|
|
41
|
+
## Platform notes
|
|
42
|
+
|
|
43
|
+
- **iOS**: async + sync APIs exist; async is recommended.
|
|
44
|
+
- **Android**: suspend functions; internal device service maps user ID to a user
|
|
45
|
+
property on the device backend.
|
|
46
|
+
- **React Native**: Promise-based APIs.
|
|
47
|
+
- **Flutter**: async APIs; user property model infers type and stringifies
|
|
48
|
+
unsupported values.
|
|
49
|
+
|
|
50
|
+
## Pitfalls
|
|
51
|
+
|
|
52
|
+
- Calling `setUserId(null)` on logout (don’t).
|
|
53
|
+
- Setting user ID before login is confirmed (causes wrong attribution).
|
|
54
|
+
- Sending PII as user properties by default.
|
|
55
|
+
- Using unstable identifiers (email/phone) as user ID when an internal ID
|
|
56
|
+
exists.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
#
|
|
3
|
+
# Validate a Clix user management plan (user-plan.json).
|
|
4
|
+
#
|
|
5
|
+
# Usage:
|
|
6
|
+
# bash skills/user-management/scripts/validate-user-plan.sh path/to/user-plan.json
|
|
7
|
+
#
|
|
8
|
+
set -euo pipefail
|
|
9
|
+
|
|
10
|
+
plan_path="${1:-}"
|
|
11
|
+
if [[ -z "$plan_path" ]]; then
|
|
12
|
+
echo "Usage: bash skills/user-management/scripts/validate-user-plan.sh path/to/user-plan.json" >&2
|
|
13
|
+
exit 2
|
|
14
|
+
fi
|
|
15
|
+
|
|
16
|
+
if [[ ! -f "$plan_path" ]]; then
|
|
17
|
+
echo "Error: file not found: $plan_path" >&2
|
|
18
|
+
exit 2
|
|
19
|
+
fi
|
|
20
|
+
|
|
21
|
+
validate_with_python() {
|
|
22
|
+
python3 - "$plan_path" <<'PY'
|
|
23
|
+
import json
|
|
24
|
+
import re
|
|
25
|
+
import sys
|
|
26
|
+
|
|
27
|
+
path = sys.argv[1]
|
|
28
|
+
snake = re.compile(r"^[a-z][a-z0-9_]*$")
|
|
29
|
+
|
|
30
|
+
with open(path, "r", encoding="utf-8") as f:
|
|
31
|
+
data = json.load(f)
|
|
32
|
+
|
|
33
|
+
errors = []
|
|
34
|
+
|
|
35
|
+
logout_policy = data.get("logout_policy")
|
|
36
|
+
if logout_policy not in (None, "do_not_set_user_id_null"):
|
|
37
|
+
errors.append("logout_policy must be 'do_not_set_user_id_null' if present")
|
|
38
|
+
|
|
39
|
+
user_id = data.get("user_id")
|
|
40
|
+
if not isinstance(user_id, dict):
|
|
41
|
+
errors.append("user_id must be an object")
|
|
42
|
+
else:
|
|
43
|
+
src = user_id.get("source")
|
|
44
|
+
ex = user_id.get("example")
|
|
45
|
+
if not isinstance(src, str) or not src.strip():
|
|
46
|
+
errors.append("user_id.source must be a non-empty string")
|
|
47
|
+
if ex is not None and (not isinstance(ex, str) or not ex.strip()):
|
|
48
|
+
errors.append("user_id.example must be a non-empty string if present")
|
|
49
|
+
|
|
50
|
+
props = data.get("properties")
|
|
51
|
+
if not isinstance(props, dict) or not props:
|
|
52
|
+
errors.append("properties must be a non-empty object")
|
|
53
|
+
else:
|
|
54
|
+
for key, spec in props.items():
|
|
55
|
+
if not isinstance(key, str) or not snake.match(key):
|
|
56
|
+
errors.append(f"properties key '{key}' must be snake_case")
|
|
57
|
+
continue
|
|
58
|
+
if not isinstance(spec, dict):
|
|
59
|
+
errors.append(f"properties['{key}'] must be an object")
|
|
60
|
+
continue
|
|
61
|
+
t = spec.get("type")
|
|
62
|
+
if t is None:
|
|
63
|
+
errors.append(f"properties['{key}'].type is required")
|
|
64
|
+
elif t not in ("string", "number", "boolean"):
|
|
65
|
+
errors.append(f"properties['{key}'].type must be one of: string, number, boolean")
|
|
66
|
+
req = spec.get("required")
|
|
67
|
+
if req is not None and not isinstance(req, bool):
|
|
68
|
+
errors.append(f"properties['{key}'].required must be boolean if present")
|
|
69
|
+
|
|
70
|
+
if errors:
|
|
71
|
+
print("❌ user-plan validation failed:")
|
|
72
|
+
for e in errors:
|
|
73
|
+
print(f"- {e}")
|
|
74
|
+
sys.exit(1)
|
|
75
|
+
|
|
76
|
+
print("✅ user-plan validation passed")
|
|
77
|
+
PY
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
if command -v python3 >/dev/null 2>&1; then
|
|
81
|
+
validate_with_python
|
|
82
|
+
exit 0
|
|
83
|
+
fi
|
|
84
|
+
|
|
85
|
+
echo "Warning: python3 not found; only checking JSON validity with node if available." >&2
|
|
86
|
+
if command -v node >/dev/null 2>&1; then
|
|
87
|
+
node -e "JSON.parse(require('fs').readFileSync(process.argv[1], 'utf8')); console.log('✅ JSON is valid');" "$plan_path"
|
|
88
|
+
exit 0
|
|
89
|
+
fi
|
|
90
|
+
|
|
91
|
+
echo "Error: neither python3 nor node found; cannot validate." >&2
|
|
92
|
+
exit 2
|