@clix-so/clix-agent-skills 1.0.1 → 1.1.0
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/llms.txt +29 -0
- package/package.json +9 -3
- package/skills/auditing-deep-link-contracts/LICENSE.txt +203 -0
- package/skills/auditing-deep-link-contracts/SKILL.md +111 -0
- package/skills/auditing-deep-link-contracts/references/deep-link-contract.md +42 -0
- package/skills/auditing-deep-link-contracts/scripts/generate-deep-link-test-vectors.sh +117 -0
- package/skills/auditing-deep-link-contracts/scripts/validate-deep-link-contract.sh +90 -0
- package/skills/auditing-permission-ux/LICENSE.txt +203 -0
- package/skills/auditing-permission-ux/SKILL.md +87 -0
- package/skills/auditing-permission-ux/references/permission-ux-best-practices.md +30 -0
- package/skills/auditing-permission-ux/scripts/generate-permission-ux-audit-report.sh +47 -0
- package/skills/skill-creator/scripts/validate-skill-scaffold.sh +15 -10
package/llms.txt
CHANGED
|
@@ -31,6 +31,35 @@ Each entry includes the file path, type, and description for semantic search.
|
|
|
31
31
|
|
|
32
32
|
---
|
|
33
33
|
|
|
34
|
+
## auditing-deep-link-contracts
|
|
35
|
+
|
|
36
|
+
- [auditing-deep-link-contracts](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/auditing-deep-link-contracts/SKILL.md): Main skill documentation
|
|
37
|
+
|
|
38
|
+
### References
|
|
39
|
+
|
|
40
|
+
- [Deep Link Contract (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/auditing-deep-link-contracts/references/deep-link-contract.md): Reference documentation for auditing-deep-link-contracts skill
|
|
41
|
+
|
|
42
|
+
### Scripts
|
|
43
|
+
|
|
44
|
+
- [Generate Deep Link Test Vectors (Script)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/auditing-deep-link-contracts/scripts/generate-deep-link-test-vectors.sh): Utility script for auditing-deep-link-contracts skill
|
|
45
|
+
- [Validate Deep Link Contract (Script)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/auditing-deep-link-contracts/scripts/validate-deep-link-contract.sh): Utility script for auditing-deep-link-contracts skill
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## auditing-permission-ux
|
|
50
|
+
|
|
51
|
+
- [auditing-permission-ux](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/auditing-permission-ux/SKILL.md): Main skill documentation
|
|
52
|
+
|
|
53
|
+
### References
|
|
54
|
+
|
|
55
|
+
- [Permission Ux Best Practices (Reference)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/auditing-permission-ux/references/permission-ux-best-practices.md): Reference documentation for auditing-permission-ux skill
|
|
56
|
+
|
|
57
|
+
### Scripts
|
|
58
|
+
|
|
59
|
+
- [Generate Permission Ux Audit Report (Script)](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/auditing-permission-ux/scripts/generate-permission-ux-audit-report.sh): Utility script for auditing-permission-ux skill
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
34
63
|
## clix-event-tracking
|
|
35
64
|
|
|
36
65
|
- [clix-event-tracking](https://raw.githubusercontent.com/clix-so/skills/refs/heads/main/skills/event-tracking/SKILL.md): Main skill documentation
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clix-so/clix-agent-skills",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "An open collection of agent skills for Clix.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -28,9 +28,15 @@
|
|
|
28
28
|
},
|
|
29
29
|
"keywords": [
|
|
30
30
|
"clix",
|
|
31
|
+
"agent-skills",
|
|
32
|
+
"ai",
|
|
33
|
+
"llm",
|
|
31
34
|
"mcp",
|
|
32
|
-
"
|
|
33
|
-
"
|
|
35
|
+
"mobile",
|
|
36
|
+
"push-notifications",
|
|
37
|
+
"deep-links",
|
|
38
|
+
"skill-creator",
|
|
39
|
+
"skill-installer",
|
|
34
40
|
"cli"
|
|
35
41
|
],
|
|
36
42
|
"author": "Clix",
|
|
@@ -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,111 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: auditing-deep-link-contracts
|
|
3
|
+
display-name: Auditing Deep Link Contracts
|
|
4
|
+
short-description: Deep link contract audit
|
|
5
|
+
description: Audits deep link contracts and routing behavior. Use when validating
|
|
6
|
+
supported routes, required parameters, and cold or warm start handling.
|
|
7
|
+
user-invocable: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Auditing Deep Link Contracts
|
|
11
|
+
|
|
12
|
+
Use this skill to define and audit deep link behavior so links open the correct
|
|
13
|
+
screen with correct parameters across cold and warm starts.
|
|
14
|
+
|
|
15
|
+
## What this skill does
|
|
16
|
+
|
|
17
|
+
- Defines a deep link contract for supported routes
|
|
18
|
+
- Checks required and optional parameters
|
|
19
|
+
- Generates cold and warm start test vectors
|
|
20
|
+
- Produces a concise audit report with fixes
|
|
21
|
+
|
|
22
|
+
## Workflow
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
Deep link contract audit progress:
|
|
26
|
+
|
|
27
|
+
- [ ] 1) Confirm minimum inputs (platforms, routes, entry points)
|
|
28
|
+
- [ ] 2) Draft a deep-link contract (JSON)
|
|
29
|
+
- [ ] 3) Validate the contract (script)
|
|
30
|
+
- [ ] 4) Generate test vectors (script)
|
|
31
|
+
- [ ] 5) Audit routing behavior (findings + fixes)
|
|
32
|
+
- [ ] 6) Verify fixes (cold and warm start)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## 1) Confirm the minimum inputs
|
|
36
|
+
|
|
37
|
+
Ask only what is needed:
|
|
38
|
+
|
|
39
|
+
- **Platforms**: iOS, Android, or both
|
|
40
|
+
- **Entry points**: push, email, web, in-app, marketing campaigns
|
|
41
|
+
- **Routes**: list of deep link routes that must be supported
|
|
42
|
+
- **Auth rules**: which routes require login
|
|
43
|
+
- **Fallbacks**: where to send users if data is missing
|
|
44
|
+
|
|
45
|
+
## 2) Draft a deep-link contract
|
|
46
|
+
|
|
47
|
+
Create `deep-link-contract.json` in `.mobile/` (recommended) or project root.
|
|
48
|
+
|
|
49
|
+
Recommended location: `.mobile/deep-link-contract.json`
|
|
50
|
+
|
|
51
|
+
Example:
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"base": "myapp://",
|
|
56
|
+
"routes": [
|
|
57
|
+
{
|
|
58
|
+
"name": "order_detail",
|
|
59
|
+
"path": "/orders/{order_id}",
|
|
60
|
+
"required_params": ["order_id"],
|
|
61
|
+
"optional_params": ["ref"],
|
|
62
|
+
"auth_required": true,
|
|
63
|
+
"supported_states": ["cold", "warm"]
|
|
64
|
+
}
|
|
65
|
+
]
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## 3) Validate the contract
|
|
70
|
+
|
|
71
|
+
Run:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
bash skills/auditing-deep-link-contracts/scripts/validate-deep-link-contract.sh \
|
|
75
|
+
.mobile/deep-link-contract.json
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 4) Generate test vectors
|
|
79
|
+
|
|
80
|
+
Run:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
bash skills/auditing-deep-link-contracts/scripts/generate-deep-link-test-vectors.sh \
|
|
84
|
+
.mobile/deep-link-contract.json \
|
|
85
|
+
.mobile/deep-link-test-vectors.json
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## 5) Audit routing behavior
|
|
89
|
+
|
|
90
|
+
For each test vector, confirm:
|
|
91
|
+
|
|
92
|
+
- The app opens the expected screen
|
|
93
|
+
- Required parameters are present and parsed
|
|
94
|
+
- Missing parameters trigger the expected fallback
|
|
95
|
+
- Auth-required routes handle logged-out users
|
|
96
|
+
- Cold start and warm start behave consistently
|
|
97
|
+
|
|
98
|
+
## 6) Verify fixes
|
|
99
|
+
|
|
100
|
+
Re-run the test vectors after changes and confirm all expected behaviors.
|
|
101
|
+
|
|
102
|
+
## Progressive Disclosure
|
|
103
|
+
|
|
104
|
+
- **Level 1**: This `SKILL.md`
|
|
105
|
+
- **Level 2**: `references/`
|
|
106
|
+
- **Level 3**: `examples/` (optional)
|
|
107
|
+
- **Level 4**: `scripts/` (execute; do not load)
|
|
108
|
+
|
|
109
|
+
## References
|
|
110
|
+
|
|
111
|
+
- `references/deep-link-contract.md`
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Deep Link Contract (Reference)
|
|
2
|
+
|
|
3
|
+
Use a deep link contract to define which routes your app supports, what
|
|
4
|
+
parameters are required, and how routing should behave across app states.
|
|
5
|
+
|
|
6
|
+
## What the contract should cover
|
|
7
|
+
|
|
8
|
+
- **Routes**: canonical list of supported paths
|
|
9
|
+
- **Required params**: which identifiers must be present
|
|
10
|
+
- **Optional params**: tracking or attribution keys
|
|
11
|
+
- **Auth rules**: whether login is required
|
|
12
|
+
- **Fallbacks**: where to send users if data is missing
|
|
13
|
+
- **States**: cold start vs warm start behavior
|
|
14
|
+
|
|
15
|
+
## Contract example
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"base": "myapp://",
|
|
20
|
+
"routes": [
|
|
21
|
+
{
|
|
22
|
+
"name": "order_detail",
|
|
23
|
+
"path": "/orders/{order_id}",
|
|
24
|
+
"required_params": ["order_id"],
|
|
25
|
+
"optional_params": ["ref"],
|
|
26
|
+
"auth_required": true,
|
|
27
|
+
"supported_states": ["cold", "warm"],
|
|
28
|
+
"fallback": "orders_list"
|
|
29
|
+
}
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Audit checklist
|
|
35
|
+
|
|
36
|
+
- **Route exists**: the route opens a real screen
|
|
37
|
+
- **Params parsed**: required params are extracted correctly
|
|
38
|
+
- **Missing data**: fallback is consistent and safe
|
|
39
|
+
- **Auth gate**: logged-out users see login or safe fallback
|
|
40
|
+
- **Cold start**: link opens the same screen after a cold start
|
|
41
|
+
- **Warm start**: link works when app is already open
|
|
42
|
+
- **Tracking params**: optional params do not break routing
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
#
|
|
3
|
+
# Generate deep link test vectors from a contract JSON.
|
|
4
|
+
#
|
|
5
|
+
# Usage:
|
|
6
|
+
# bash skills/auditing-deep-link-contracts/scripts/generate-deep-link-test-vectors.sh \
|
|
7
|
+
# path/to/deep-link-contract.json \
|
|
8
|
+
# path/to/deep-link-test-vectors.json
|
|
9
|
+
#
|
|
10
|
+
set -euo pipefail
|
|
11
|
+
|
|
12
|
+
contract_path="${1:-}"
|
|
13
|
+
output_path="${2:-}"
|
|
14
|
+
|
|
15
|
+
if [[ -z "$contract_path" || -z "$output_path" ]]; then
|
|
16
|
+
echo "Usage: bash skills/auditing-deep-link-contracts/scripts/generate-deep-link-test-vectors.sh path/to/deep-link-contract.json path/to/deep-link-test-vectors.json" >&2
|
|
17
|
+
exit 2
|
|
18
|
+
fi
|
|
19
|
+
|
|
20
|
+
if [[ ! -f "$contract_path" ]]; then
|
|
21
|
+
echo "Error: contract file not found: $contract_path" >&2
|
|
22
|
+
exit 2
|
|
23
|
+
fi
|
|
24
|
+
|
|
25
|
+
python3 - "$contract_path" "$output_path" <<'PY'
|
|
26
|
+
import json
|
|
27
|
+
import sys
|
|
28
|
+
from urllib.parse import urlencode
|
|
29
|
+
|
|
30
|
+
contract_path = sys.argv[1]
|
|
31
|
+
output_path = sys.argv[2]
|
|
32
|
+
|
|
33
|
+
with open(contract_path, "r", encoding="utf-8") as f:
|
|
34
|
+
data = json.load(f)
|
|
35
|
+
|
|
36
|
+
base = data.get("base", "").rstrip("/")
|
|
37
|
+
routes = data.get("routes", [])
|
|
38
|
+
|
|
39
|
+
def build_path(path_template, params):
|
|
40
|
+
path = path_template
|
|
41
|
+
for key, value in params.items():
|
|
42
|
+
path = path.replace("{" + key + "}", value)
|
|
43
|
+
return path
|
|
44
|
+
|
|
45
|
+
test_vectors = []
|
|
46
|
+
|
|
47
|
+
for route in routes:
|
|
48
|
+
name = route.get("name", "route")
|
|
49
|
+
path_template = route.get("path", "/")
|
|
50
|
+
required = route.get("required_params", [])
|
|
51
|
+
optional = route.get("optional_params", [])
|
|
52
|
+
auth_required = bool(route.get("auth_required", False))
|
|
53
|
+
states = route.get("supported_states", ["cold", "warm"])
|
|
54
|
+
|
|
55
|
+
required_values = {k: f"sample_{k}" for k in required}
|
|
56
|
+
optional_values = {k: f"sample_{k}" for k in optional}
|
|
57
|
+
|
|
58
|
+
# Valid minimal
|
|
59
|
+
url = base + build_path(path_template, required_values)
|
|
60
|
+
test_vectors.append({
|
|
61
|
+
"name": f"{name}_valid_minimal",
|
|
62
|
+
"url": url,
|
|
63
|
+
"state": "cold",
|
|
64
|
+
"auth": "logged_in",
|
|
65
|
+
"expected": "open_target_screen"
|
|
66
|
+
})
|
|
67
|
+
|
|
68
|
+
# Valid with optional params
|
|
69
|
+
if optional_values:
|
|
70
|
+
url_with_optional = url + "?" + urlencode(optional_values)
|
|
71
|
+
test_vectors.append({
|
|
72
|
+
"name": f"{name}_valid_with_optional",
|
|
73
|
+
"url": url_with_optional,
|
|
74
|
+
"state": "warm",
|
|
75
|
+
"auth": "logged_in",
|
|
76
|
+
"expected": "open_target_screen"
|
|
77
|
+
})
|
|
78
|
+
|
|
79
|
+
# Missing required param
|
|
80
|
+
if required:
|
|
81
|
+
missing_params = required_values.copy()
|
|
82
|
+
missing_params.pop(required[0], None)
|
|
83
|
+
url_missing = base + build_path(path_template, missing_params)
|
|
84
|
+
test_vectors.append({
|
|
85
|
+
"name": f"{name}_missing_required",
|
|
86
|
+
"url": url_missing,
|
|
87
|
+
"state": "cold",
|
|
88
|
+
"auth": "logged_in",
|
|
89
|
+
"expected": "fallback_or_error"
|
|
90
|
+
})
|
|
91
|
+
|
|
92
|
+
# Logged out behavior
|
|
93
|
+
if auth_required:
|
|
94
|
+
url_auth = url
|
|
95
|
+
test_vectors.append({
|
|
96
|
+
"name": f"{name}_logged_out",
|
|
97
|
+
"url": url_auth,
|
|
98
|
+
"state": "warm",
|
|
99
|
+
"auth": "logged_out",
|
|
100
|
+
"expected": "login_or_fallback"
|
|
101
|
+
})
|
|
102
|
+
|
|
103
|
+
# State coverage
|
|
104
|
+
for state in states:
|
|
105
|
+
test_vectors.append({
|
|
106
|
+
"name": f"{name}_state_{state}",
|
|
107
|
+
"url": url,
|
|
108
|
+
"state": state,
|
|
109
|
+
"auth": "logged_in",
|
|
110
|
+
"expected": "open_target_screen"
|
|
111
|
+
})
|
|
112
|
+
|
|
113
|
+
with open(output_path, "w", encoding="utf-8") as f:
|
|
114
|
+
json.dump({"vectors": test_vectors}, f, indent=2)
|
|
115
|
+
|
|
116
|
+
print(f"Wrote {len(test_vectors)} test vectors to {output_path}")
|
|
117
|
+
PY
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
#
|
|
3
|
+
# Validate a deep link contract JSON file.
|
|
4
|
+
#
|
|
5
|
+
# Usage:
|
|
6
|
+
# bash skills/auditing-deep-link-contracts/scripts/validate-deep-link-contract.sh \
|
|
7
|
+
# path/to/deep-link-contract.json
|
|
8
|
+
#
|
|
9
|
+
set -euo pipefail
|
|
10
|
+
|
|
11
|
+
contract_path="${1:-}"
|
|
12
|
+
if [[ -z "$contract_path" ]]; then
|
|
13
|
+
echo "Usage: bash skills/auditing-deep-link-contracts/scripts/validate-deep-link-contract.sh path/to/deep-link-contract.json" >&2
|
|
14
|
+
exit 2
|
|
15
|
+
fi
|
|
16
|
+
|
|
17
|
+
if [[ ! -f "$contract_path" ]]; then
|
|
18
|
+
echo "Error: contract file not found: $contract_path" >&2
|
|
19
|
+
exit 2
|
|
20
|
+
fi
|
|
21
|
+
|
|
22
|
+
python3 - "$contract_path" <<'PY'
|
|
23
|
+
import json
|
|
24
|
+
import sys
|
|
25
|
+
|
|
26
|
+
path = sys.argv[1]
|
|
27
|
+
|
|
28
|
+
with open(path, "r", encoding="utf-8") as f:
|
|
29
|
+
data = json.load(f)
|
|
30
|
+
|
|
31
|
+
errors = []
|
|
32
|
+
|
|
33
|
+
base = data.get("base")
|
|
34
|
+
routes = data.get("routes")
|
|
35
|
+
|
|
36
|
+
if not isinstance(base, str) or not base.strip():
|
|
37
|
+
errors.append("base must be a non-empty string")
|
|
38
|
+
|
|
39
|
+
if not isinstance(routes, list) or not routes:
|
|
40
|
+
errors.append("routes must be a non-empty array")
|
|
41
|
+
else:
|
|
42
|
+
seen_names = set()
|
|
43
|
+
for i, route in enumerate(routes):
|
|
44
|
+
if not isinstance(route, dict):
|
|
45
|
+
errors.append(f"routes[{i}] must be an object")
|
|
46
|
+
continue
|
|
47
|
+
|
|
48
|
+
name = route.get("name")
|
|
49
|
+
if not isinstance(name, str) or not name.strip():
|
|
50
|
+
errors.append(f"routes[{i}].name must be a non-empty string")
|
|
51
|
+
elif name in seen_names:
|
|
52
|
+
errors.append(f"routes[{i}].name is duplicated: '{name}'")
|
|
53
|
+
else:
|
|
54
|
+
seen_names.add(name)
|
|
55
|
+
|
|
56
|
+
path_template = route.get("path")
|
|
57
|
+
if not isinstance(path_template, str) or not path_template.strip():
|
|
58
|
+
errors.append(f"routes[{i}].path must be a non-empty string")
|
|
59
|
+
|
|
60
|
+
required = route.get("required_params", [])
|
|
61
|
+
optional = route.get("optional_params", [])
|
|
62
|
+
if required is None:
|
|
63
|
+
required = []
|
|
64
|
+
if optional is None:
|
|
65
|
+
optional = []
|
|
66
|
+
if not isinstance(required, list):
|
|
67
|
+
errors.append(f"routes[{i}].required_params must be an array")
|
|
68
|
+
if not isinstance(optional, list):
|
|
69
|
+
errors.append(f"routes[{i}].optional_params must be an array")
|
|
70
|
+
|
|
71
|
+
auth_required = route.get("auth_required")
|
|
72
|
+
if auth_required is not None and not isinstance(auth_required, bool):
|
|
73
|
+
errors.append(f"routes[{i}].auth_required must be boolean if present")
|
|
74
|
+
|
|
75
|
+
states = route.get("supported_states", ["cold", "warm"])
|
|
76
|
+
if not isinstance(states, list) or not states:
|
|
77
|
+
errors.append(f"routes[{i}].supported_states must be a non-empty array")
|
|
78
|
+
else:
|
|
79
|
+
bad = [s for s in states if s not in ("cold", "warm")]
|
|
80
|
+
if bad:
|
|
81
|
+
errors.append(f"routes[{i}].supported_states must be ['cold','warm']")
|
|
82
|
+
|
|
83
|
+
if errors:
|
|
84
|
+
print("Validation failed:")
|
|
85
|
+
for e in errors:
|
|
86
|
+
print(f"- {e}")
|
|
87
|
+
sys.exit(1)
|
|
88
|
+
|
|
89
|
+
print("Validation passed")
|
|
90
|
+
PY
|
|
@@ -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,87 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: auditing-permission-ux
|
|
3
|
+
display-name: Auditing Permission UX
|
|
4
|
+
short-description: Permission UX audit
|
|
5
|
+
description: Audits notification permission request flows. Use when reviewing or improving permission prompts, settings paths, or denial handling.
|
|
6
|
+
user-invocable: true
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Auditing Permission UX
|
|
10
|
+
|
|
11
|
+
Use this skill to audit how a mobile app requests notification permission and guides
|
|
12
|
+
users to settings, then produce actionable improvements based on Apple and Android
|
|
13
|
+
best practices.
|
|
14
|
+
|
|
15
|
+
## What this skill does
|
|
16
|
+
|
|
17
|
+
- Reviews permission timing, context, and explanation quality
|
|
18
|
+
- Checks denial handling and settings recovery paths
|
|
19
|
+
- Flags platform-specific risks (iOS vs Android)
|
|
20
|
+
- Produces a structured audit report with fixes
|
|
21
|
+
|
|
22
|
+
## Workflow
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
Permission UX audit progress:
|
|
26
|
+
|
|
27
|
+
- [ ] 1) Confirm minimum inputs (platforms, flow, current UX)
|
|
28
|
+
- [ ] 2) Audit current flow (map prompts, copy, and settings paths)
|
|
29
|
+
- [ ] 3) Produce audit report (findings + fixes)
|
|
30
|
+
- [ ] 4) Verify improvements (ensure UX changes align with platform rules)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## 1) Confirm the minimum inputs
|
|
34
|
+
|
|
35
|
+
Ask only what is needed:
|
|
36
|
+
|
|
37
|
+
- **Platforms**: iOS, Android, or both
|
|
38
|
+
- **Entry points**: where the app asks for permission
|
|
39
|
+
- **Prompt timing**: first launch, after action, onboarding step, etc.
|
|
40
|
+
- **Primer**: is there an in-app explanation before the system prompt
|
|
41
|
+
- **Settings path**: how users enable later after denial
|
|
42
|
+
- **Denial handling**: how the app behaves if permission is denied
|
|
43
|
+
|
|
44
|
+
## 2) Audit the current flow
|
|
45
|
+
|
|
46
|
+
Document the current permission flow directly from the app:
|
|
47
|
+
|
|
48
|
+
- Where the permission prompt appears and what precedes it
|
|
49
|
+
- What copy is shown to explain value
|
|
50
|
+
- How the app behaves after deny or dismiss
|
|
51
|
+
- How users can enable notifications later
|
|
52
|
+
|
|
53
|
+
## 3) Produce the audit report
|
|
54
|
+
|
|
55
|
+
Output a concise report in markdown with:
|
|
56
|
+
|
|
57
|
+
- **Findings**: each gap mapped to best practice
|
|
58
|
+
- **Risk**: what the user impact is
|
|
59
|
+
- **Fix**: concrete UX change
|
|
60
|
+
- **Platform notes**: iOS-only or Android-only specifics
|
|
61
|
+
|
|
62
|
+
Optional: generate a report template:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
bash skills/auditing-permission-ux/scripts/generate-permission-ux-audit-report.sh .mobile/permission-ux-audit.md
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## 4) Verify improvements
|
|
69
|
+
|
|
70
|
+
Confirm:
|
|
71
|
+
|
|
72
|
+
- Prompt timing is contextual (not forced on first launch)
|
|
73
|
+
- Primer explains value clearly and is dismissible
|
|
74
|
+
- Denied users can still use the app
|
|
75
|
+
- Settings path is discoverable and clear
|
|
76
|
+
- Android importance/channel strategy is not misleading
|
|
77
|
+
|
|
78
|
+
## Progressive Disclosure
|
|
79
|
+
|
|
80
|
+
- **Level 1**: This `SKILL.md`
|
|
81
|
+
- **Level 2**: `references/`
|
|
82
|
+
- **Level 3**: `examples/` (optional)
|
|
83
|
+
- **Level 4**: `scripts/` (execute; do not load)
|
|
84
|
+
|
|
85
|
+
## References
|
|
86
|
+
|
|
87
|
+
- `references/permission-ux-best-practices.md`
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Permission UX Best Practices (iOS and Android)
|
|
2
|
+
|
|
3
|
+
This reference summarizes official guidance for notification permission UX.
|
|
4
|
+
It is intended to support audits and improvement recommendations.
|
|
5
|
+
|
|
6
|
+
## iOS Application
|
|
7
|
+
|
|
8
|
+
What the platform docs emphasize (high-signal):
|
|
9
|
+
|
|
10
|
+
- **Consent first**: get permission before sending notifications.
|
|
11
|
+
- **Contextual timing**: ask after a clear user action, not at first launch.
|
|
12
|
+
- **Value primer**: explain the benefit in-app, then show the system prompt.
|
|
13
|
+
- **Denial handling**: avoid repeated prompts; provide a clear settings path.
|
|
14
|
+
- **System prompt**: it cannot be customized.
|
|
15
|
+
- **Trust and safety**: keep content concise and avoid repeated, low-value, or
|
|
16
|
+
sensitive information.
|
|
17
|
+
|
|
18
|
+
## Android Application
|
|
19
|
+
|
|
20
|
+
What the platform docs emphasize (high-signal):
|
|
21
|
+
|
|
22
|
+
- **Contextual timing**: ask after a user action that implies value.
|
|
23
|
+
- **Education UI**: use a short, dismissible explainer when needed.
|
|
24
|
+
- **No forced prompt**: if education is dismissed, do not immediately show the
|
|
25
|
+
system dialog.
|
|
26
|
+
- **Graceful denial**: keep core flows usable and be specific about what is
|
|
27
|
+
unavailable.
|
|
28
|
+
- **Respect intent**: avoid repeated prompts after multiple denials.
|
|
29
|
+
- **Channels and importance**: choose the lowest appropriate importance.
|
|
30
|
+
- **Target SDK 33+**: control prompt timing on Android 13+.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
#
|
|
3
|
+
# Generate a permission UX audit report template.
|
|
4
|
+
#
|
|
5
|
+
# Usage:
|
|
6
|
+
# bash skills/permission-settings-ux-auditor/scripts/generate-permission-ux-audit-report.sh path/to/report.md
|
|
7
|
+
#
|
|
8
|
+
set -euo pipefail
|
|
9
|
+
|
|
10
|
+
output_path="${1:-}"
|
|
11
|
+
if [[ -z "$output_path" ]]; then
|
|
12
|
+
echo "Usage: bash skills/permission-settings-ux-auditor/scripts/generate-permission-ux-audit-report.sh path/to/report.md" >&2
|
|
13
|
+
exit 2
|
|
14
|
+
fi
|
|
15
|
+
|
|
16
|
+
cat >"$output_path" <<'MD'
|
|
17
|
+
# Permission Settings UX Audit
|
|
18
|
+
|
|
19
|
+
## Scope
|
|
20
|
+
- Platforms:
|
|
21
|
+
- Entry points:
|
|
22
|
+
- Current prompt timing:
|
|
23
|
+
- Primer present:
|
|
24
|
+
- Settings path:
|
|
25
|
+
|
|
26
|
+
## Findings
|
|
27
|
+
|
|
28
|
+
### 1) Finding title
|
|
29
|
+
- **Issue**:
|
|
30
|
+
- **Impact**:
|
|
31
|
+
- **Recommendation**:
|
|
32
|
+
- **Platform notes**:
|
|
33
|
+
|
|
34
|
+
### 2) Finding title
|
|
35
|
+
- **Issue**:
|
|
36
|
+
- **Impact**:
|
|
37
|
+
- **Recommendation**:
|
|
38
|
+
- **Platform notes**:
|
|
39
|
+
|
|
40
|
+
## Fix checklist
|
|
41
|
+
- [ ] Update prompt timing to match a user action
|
|
42
|
+
- [ ] Add or improve in-app primer copy
|
|
43
|
+
- [ ] Add clear settings path for denied users
|
|
44
|
+
- [ ] Validate denial handling and fallback UX
|
|
45
|
+
MD
|
|
46
|
+
|
|
47
|
+
echo "Report template written to: $output_path"
|
|
@@ -31,6 +31,7 @@ import re
|
|
|
31
31
|
import sys
|
|
32
32
|
|
|
33
33
|
skill_dir = sys.argv[1]
|
|
34
|
+
skill_name = None
|
|
34
35
|
|
|
35
36
|
errors = []
|
|
36
37
|
|
|
@@ -87,9 +88,7 @@ else:
|
|
|
87
88
|
|
|
88
89
|
name_match = re.search(r"^name:\s*(.+)$", frontmatter, re.M)
|
|
89
90
|
if name_match:
|
|
90
|
-
|
|
91
|
-
if not name.startswith("clix-"):
|
|
92
|
-
errors.append("frontmatter name should start with 'clix-'")
|
|
91
|
+
skill_name = name_match.group(1).strip()
|
|
93
92
|
|
|
94
93
|
inv_match = re.search(r"^user-invocable:\s*(.+)$", frontmatter, re.M)
|
|
95
94
|
if inv_match:
|
|
@@ -97,8 +96,9 @@ else:
|
|
|
97
96
|
if val not in ("true", "false"):
|
|
98
97
|
errors.append("frontmatter user-invocable must be true or false")
|
|
99
98
|
|
|
100
|
-
if "clix-
|
|
101
|
-
|
|
99
|
+
if skill_name and skill_name.startswith("clix-"):
|
|
100
|
+
if "clix-mcp-server" not in content:
|
|
101
|
+
errors.append("SKILL.md must reference 'clix-mcp-server' (MCP-first requirement)")
|
|
102
102
|
|
|
103
103
|
if errors:
|
|
104
104
|
print("ERROR: skill scaffold validation failed:")
|
|
@@ -160,6 +160,8 @@ try {
|
|
|
160
160
|
errors.push(`failed to read SKILL.md: ${String(e)}`);
|
|
161
161
|
}
|
|
162
162
|
|
|
163
|
+
let skillName = null;
|
|
164
|
+
|
|
163
165
|
// Frontmatter validation (best-effort; mirrors Python validator behavior).
|
|
164
166
|
if (!content.startsWith("---\n")) {
|
|
165
167
|
errors.push("SKILL.md must start with YAML frontmatter (---)");
|
|
@@ -178,8 +180,7 @@ if (!content.startsWith("---\n")) {
|
|
|
178
180
|
|
|
179
181
|
const nameMatch = frontmatter.match(/^name:\s*(.+)$/m);
|
|
180
182
|
if (nameMatch) {
|
|
181
|
-
|
|
182
|
-
if (!name.startsWith("clix-")) errors.push("frontmatter name should start with 'clix-'");
|
|
183
|
+
skillName = (nameMatch[1] || "").trim();
|
|
183
184
|
}
|
|
184
185
|
|
|
185
186
|
const invMatch = frontmatter.match(/^user-invocable:\s*(.+)$/m);
|
|
@@ -189,11 +190,15 @@ if (!content.startsWith("---\n")) {
|
|
|
189
190
|
}
|
|
190
191
|
}
|
|
191
192
|
}
|
|
192
|
-
if (
|
|
193
|
+
if (skillName && skillName.startsWith("clix-")) {
|
|
194
|
+
if (!content.includes("clix-mcp-server")) {
|
|
195
|
+
errors.push("SKILL.md must reference 'clix-mcp-server'");
|
|
196
|
+
}
|
|
197
|
+
}
|
|
193
198
|
|
|
194
199
|
if (errors.length) {
|
|
195
|
-
console.
|
|
196
|
-
for (const e of errors) console.
|
|
200
|
+
console.log("ERROR: skill scaffold validation failed:");
|
|
201
|
+
for (const e of errors) console.log(`- ${e}`);
|
|
197
202
|
process.exit(1);
|
|
198
203
|
}
|
|
199
204
|
|