@lowdefy/plugin-posthog 0.0.0-experimental-20260925135632
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/LICENSE +201 -0
- package/README.md +81 -0
- package/dist/actions/PostHogAlias.js +31 -0
- package/dist/actions/PostHogAlias.schema.js +31 -0
- package/dist/actions/PostHogCapture.js +48 -0
- package/dist/actions/PostHogCapture.schema.js +42 -0
- package/dist/actions/PostHogCapturePageLeave.js +33 -0
- package/dist/actions/PostHogCapturePageLeave.schema.js +27 -0
- package/dist/actions/PostHogFeatureFlag.js +51 -0
- package/dist/actions/PostHogFeatureFlag.schema.js +42 -0
- package/dist/actions/PostHogGroup.js +38 -0
- package/dist/actions/PostHogGroup.schema.js +41 -0
- package/dist/actions/PostHogIdentify.js +61 -0
- package/dist/actions/PostHogIdentify.schema.js +38 -0
- package/dist/actions/PostHogInit.js +66 -0
- package/dist/actions/PostHogInit.schema.js +70 -0
- package/dist/actions/PostHogOptIn.js +28 -0
- package/dist/actions/PostHogOptIn.schema.js +17 -0
- package/dist/actions/PostHogOptOut.js +27 -0
- package/dist/actions/PostHogOptOut.schema.js +17 -0
- package/dist/actions/PostHogPageview.js +35 -0
- package/dist/actions/PostHogPageview.schema.js +27 -0
- package/dist/actions/PostHogReloadFeatureFlags.js +61 -0
- package/dist/actions/PostHogReloadFeatureFlags.schema.js +28 -0
- package/dist/actions/PostHogReset.js +31 -0
- package/dist/actions/PostHogReset.schema.js +27 -0
- package/dist/actions/PostHogSetPersonProperties.js +39 -0
- package/dist/actions/PostHogSetPersonProperties.schema.js +43 -0
- package/dist/actions.js +27 -0
- package/dist/lib/cleanProperties.js +22 -0
- package/dist/lib/getPostHog.js +35 -0
- package/dist/lib/initPostHog.js +45 -0
- package/dist/lib/loadPostHog.js +37 -0
- package/dist/lib/postHogState.js +32 -0
- package/dist/lib/warnUninitialized.js +25 -0
- package/dist/schemas.js +27 -0
- package/dist/test/resetPostHogState.js +25 -0
- package/dist/types.js +31 -0
- package/package.json +60 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# @lowdefy/plugin-posthog
|
|
2
|
+
|
|
3
|
+
PostHog product analytics for Lowdefy apps: initialise `posthog-js`, capture events, identify people and groups, manage consent and read feature flags.
|
|
4
|
+
|
|
5
|
+
This package is included in Lowdefy by default. `posthog-js` is bundled with the app, so no script tag or reverse proxy setup is needed, and it is loaded lazily: it is only downloaded when `PostHogInit` runs with PostHog enabled.
|
|
6
|
+
|
|
7
|
+
## Initialising
|
|
8
|
+
|
|
9
|
+
`PostHogInit` must run before any other action in this package. A user can open the app on any page, so run it from the `onInit` event of every page, sharing the actions with `_ref`. `PostHogInit` is idempotent, so this is safe: later calls with the same `apiKey` do nothing.
|
|
10
|
+
|
|
11
|
+
```yaml
|
|
12
|
+
# shared/posthog_init.yaml
|
|
13
|
+
- id: init_posthog
|
|
14
|
+
type: PostHogInit
|
|
15
|
+
params:
|
|
16
|
+
apiKey:
|
|
17
|
+
_build.env: POSTHOG_API_KEY
|
|
18
|
+
enabled:
|
|
19
|
+
_build.ne:
|
|
20
|
+
- _build.env: POSTHOG_API_KEY
|
|
21
|
+
- null
|
|
22
|
+
options:
|
|
23
|
+
capture_pageview: history_change
|
|
24
|
+
person_profiles: identified_only
|
|
25
|
+
- id: identify_person
|
|
26
|
+
type: PostHogIdentify
|
|
27
|
+
params:
|
|
28
|
+
id:
|
|
29
|
+
_user: id
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
```yaml
|
|
33
|
+
# pages/reports.yaml
|
|
34
|
+
id: reports
|
|
35
|
+
type: PageHeaderMenu
|
|
36
|
+
events:
|
|
37
|
+
onInit:
|
|
38
|
+
_ref: shared/posthog_init.yaml
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
The PostHog project API key is a public, write only key that is meant to ship in the browser bundle, so `_build.env` is the right operator for it. Never use a personal API key here.
|
|
42
|
+
|
|
43
|
+
With `enabled: false`, `posthog-js` is never downloaded and every other action in this package becomes a silent no-op. In the example above, leaving `POSTHOG_API_KEY` unset, for example in local development, turns analytics off.
|
|
44
|
+
|
|
45
|
+
`capture_pageview: history_change` makes `posthog-js` capture a pageview on every client side navigation. Without it, only the first page of a session is captured. `PostHogPageview` and `PostHogCapturePageLeave` are there for apps that capture pageviews by hand.
|
|
46
|
+
|
|
47
|
+
When the app declares `config.environments`, `PostHogInit` registers the current environment's name as the `environment` super property on every event, so one PostHog project can hold staging and production.
|
|
48
|
+
|
|
49
|
+
## Never breaks the app
|
|
50
|
+
|
|
51
|
+
Analytics must never break an app. Every action other than `PostHogInit` does nothing and returns `null` when PostHog is disabled or `posthog-js` could not be downloaded. `PostHogFeatureFlag` returns its configured `default` instead, and `PostHogReloadFeatureFlags` returns `{ flags: [], variants: {} }`.
|
|
52
|
+
|
|
53
|
+
Config mistakes are still reported: invalid params always throw, even with PostHog disabled, and an action that runs before `PostHogInit` logs a warning to the browser console once. An action that runs while `PostHogInit` is still loading `posthog-js` waits for it.
|
|
54
|
+
|
|
55
|
+
## No personal data
|
|
56
|
+
|
|
57
|
+
Never send personally identifiable information to PostHog: no names, email addresses, phone numbers, or free text a user typed. Send stable ids and low cardinality attributes such as a plan name, a role, or a locale.
|
|
58
|
+
|
|
59
|
+
## Actions
|
|
60
|
+
|
|
61
|
+
| Action | Params | Returns |
|
|
62
|
+
| ---------------------------- | -------------------------------------------------- | ------------------------------ |
|
|
63
|
+
| `PostHogInit` | `apiKey`, `apiHost`, `options`, `debug`, `enabled` | `null` |
|
|
64
|
+
| `PostHogCapture` | `event`, `properties`, `groups` | `null` |
|
|
65
|
+
| `PostHogPageview` | `properties` | `null` |
|
|
66
|
+
| `PostHogCapturePageLeave` | `properties` | `null` |
|
|
67
|
+
| `PostHogIdentify` | `id`, `properties`, `propertiesOnce` | `null` |
|
|
68
|
+
| `PostHogSetPersonProperties` | `set`, `setOnce` | `null` |
|
|
69
|
+
| `PostHogAlias` | `alias` | `null` |
|
|
70
|
+
| `PostHogGroup` | `type`, `key`, `properties` | `null` |
|
|
71
|
+
| `PostHogReset` | `resetDeviceId` | `null` |
|
|
72
|
+
| `PostHogOptIn` | none | `null` |
|
|
73
|
+
| `PostHogOptOut` | none | `null` |
|
|
74
|
+
| `PostHogFeatureFlag` | `key`, `default`, `enabled`, `payload` | the flag value, or `default` |
|
|
75
|
+
| `PostHogReloadFeatureFlags` | `timeout` | `Promise<{ flags, variants }>` |
|
|
76
|
+
|
|
77
|
+
Full documentation, including examples, is at [docs.lowdefy.com/PostHog](https://docs.lowdefy.com/PostHog).
|
|
78
|
+
|
|
79
|
+
## Person swaps on a shared browser
|
|
80
|
+
|
|
81
|
+
PostHog refuses to move an already identified `distinct_id` onto a different person, so a shared browser needs a `reset()` between people. `PostHogIdentify` reads the identity `posthog-js` already holds: when the id is already the current `distinct_id` it only updates person properties; when the browser is identified as someone else (`$user_state` is `identified`) it resets first; and an anonymous visitor is identified without a reset, so the anonymous session merges into the person, which is what makes signup funnels work.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ import { type } from '@lowdefy/helpers';
|
|
16
|
+
import getPostHog from '../lib/getPostHog.js';
|
|
17
|
+
// Point a second id at the person PostHog already knows, for example when an
|
|
18
|
+
// app has its own identifier alongside the one used by PostHogIdentify.
|
|
19
|
+
async function PostHogAlias({ params }) {
|
|
20
|
+
const { alias } = params ?? {};
|
|
21
|
+
if (!type.isString(alias) || alias.trim() === '') {
|
|
22
|
+
throw new Error(`PostHogAlias "alias" must be a non-empty string. Received ${JSON.stringify(alias)}.`);
|
|
23
|
+
}
|
|
24
|
+
const posthog = await getPostHog({
|
|
25
|
+
action: 'PostHogAlias'
|
|
26
|
+
});
|
|
27
|
+
if (type.isNone(posthog)) return null;
|
|
28
|
+
posthog.alias(alias);
|
|
29
|
+
return null;
|
|
30
|
+
}
|
|
31
|
+
export default PostHogAlias;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ export default {
|
|
16
|
+
type: 'object',
|
|
17
|
+
params: {
|
|
18
|
+
type: 'object',
|
|
19
|
+
required: [
|
|
20
|
+
'alias'
|
|
21
|
+
],
|
|
22
|
+
properties: {
|
|
23
|
+
alias: {
|
|
24
|
+
type: 'string',
|
|
25
|
+
minLength: 1,
|
|
26
|
+
description: 'A second id to point at the person PostHog already knows.'
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
additionalProperties: false
|
|
30
|
+
}
|
|
31
|
+
};
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ import { type } from '@lowdefy/helpers';
|
|
16
|
+
import getPostHog from '../lib/getPostHog.js';
|
|
17
|
+
// Capture a named product event. Autocapture already records clicks and
|
|
18
|
+
// pageviews, so this is for the moments that deserve a funnel step of their
|
|
19
|
+
// own and that no DOM event names well. Keep the set small: every event is
|
|
20
|
+
// billable, and a funnel of thirty near identical events tells you less than
|
|
21
|
+
// one of five.
|
|
22
|
+
//
|
|
23
|
+
// Never pass personally identifiable information as a property.
|
|
24
|
+
async function PostHogCapture({ params }) {
|
|
25
|
+
const { event, groups, properties } = params ?? {};
|
|
26
|
+
if (!type.isString(event) || event.trim() === '') {
|
|
27
|
+
throw new Error(`PostHogCapture "event" must be a non-empty string. Received ${JSON.stringify(event)}.`);
|
|
28
|
+
}
|
|
29
|
+
if (!type.isNone(properties) && !type.isObject(properties)) {
|
|
30
|
+
throw new Error(`PostHogCapture "properties" must be an object. Received ${JSON.stringify(properties)}.`);
|
|
31
|
+
}
|
|
32
|
+
if (!type.isNone(groups) && !type.isObject(groups)) {
|
|
33
|
+
throw new Error(`PostHogCapture "groups" must be an object. Received ${JSON.stringify(groups)}.`);
|
|
34
|
+
}
|
|
35
|
+
const posthog = await getPostHog({
|
|
36
|
+
action: 'PostHogCapture'
|
|
37
|
+
});
|
|
38
|
+
if (type.isNone(posthog)) return null;
|
|
39
|
+
const eventProperties = {
|
|
40
|
+
...properties ?? {}
|
|
41
|
+
};
|
|
42
|
+
if (type.isObject(groups)) {
|
|
43
|
+
eventProperties.$groups = groups;
|
|
44
|
+
}
|
|
45
|
+
posthog.capture(event, eventProperties);
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
export default PostHogCapture;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ export default {
|
|
16
|
+
type: 'object',
|
|
17
|
+
params: {
|
|
18
|
+
type: 'object',
|
|
19
|
+
required: [
|
|
20
|
+
'event'
|
|
21
|
+
],
|
|
22
|
+
properties: {
|
|
23
|
+
event: {
|
|
24
|
+
type: 'string',
|
|
25
|
+
minLength: 1,
|
|
26
|
+
description: 'The event name, for example report_submitted.'
|
|
27
|
+
},
|
|
28
|
+
properties: {
|
|
29
|
+
type: 'object',
|
|
30
|
+
description: 'Event properties. Never include personally identifiable information.'
|
|
31
|
+
},
|
|
32
|
+
groups: {
|
|
33
|
+
type: 'object',
|
|
34
|
+
description: 'Groups to attach to this one event, as { groupType: groupKey }. Sent to PostHog as the $groups property.',
|
|
35
|
+
additionalProperties: {
|
|
36
|
+
type: 'string'
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
additionalProperties: false
|
|
41
|
+
}
|
|
42
|
+
};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ import { type } from '@lowdefy/helpers';
|
|
16
|
+
import getPostHog from '../lib/getPostHog.js';
|
|
17
|
+
// Capture a pageleave by hand, the counterpart to PostHogPageview. posthog-js
|
|
18
|
+
// captures pageleaves itself when the tab closes, as long as automatic
|
|
19
|
+
// pageviews are on (capture_pageleave defaults to 'if_capture_pageview'). This
|
|
20
|
+
// action is for apps that turned those off and capture pageviews by hand.
|
|
21
|
+
async function PostHogCapturePageLeave({ params }) {
|
|
22
|
+
const { properties } = params ?? {};
|
|
23
|
+
if (!type.isNone(properties) && !type.isObject(properties)) {
|
|
24
|
+
throw new Error(`PostHogCapturePageLeave "properties" must be an object. Received ${JSON.stringify(properties)}.`);
|
|
25
|
+
}
|
|
26
|
+
const posthog = await getPostHog({
|
|
27
|
+
action: 'PostHogCapturePageLeave'
|
|
28
|
+
});
|
|
29
|
+
if (type.isNone(posthog)) return null;
|
|
30
|
+
posthog.capture('$pageleave', properties ?? undefined);
|
|
31
|
+
return null;
|
|
32
|
+
}
|
|
33
|
+
export default PostHogCapturePageLeave;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ export default {
|
|
16
|
+
type: 'object',
|
|
17
|
+
params: {
|
|
18
|
+
type: 'object',
|
|
19
|
+
properties: {
|
|
20
|
+
properties: {
|
|
21
|
+
type: 'object',
|
|
22
|
+
description: 'Properties to add to the $pageleave event.'
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
additionalProperties: false
|
|
26
|
+
}
|
|
27
|
+
};
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ import { type } from '@lowdefy/helpers';
|
|
16
|
+
import getPostHog from '../lib/getPostHog.js';
|
|
17
|
+
// Read a feature flag and return its value, so it can be used further down the
|
|
18
|
+
// action chain with the _actions operator.
|
|
19
|
+
//
|
|
20
|
+
// The flag value is whatever PostHog resolved for this person when flags were
|
|
21
|
+
// last loaded; it does not wait for a network call. Use
|
|
22
|
+
// PostHogReloadFeatureFlags first when the person or their groups just changed.
|
|
23
|
+
async function PostHogFeatureFlag({ params }) {
|
|
24
|
+
const { key, default: defaultValue, enabled, payload } = params ?? {};
|
|
25
|
+
if (!type.isString(key) || key.trim() === '') {
|
|
26
|
+
throw new Error(`PostHogFeatureFlag "key" must be a non-empty string. Received ${JSON.stringify(key)}.`);
|
|
27
|
+
}
|
|
28
|
+
if (!type.isNone(enabled) && !type.isBoolean(enabled)) {
|
|
29
|
+
throw new Error(`PostHogFeatureFlag "enabled" must be a boolean. Received ${JSON.stringify(enabled)}.`);
|
|
30
|
+
}
|
|
31
|
+
if (!type.isNone(payload) && !type.isBoolean(payload)) {
|
|
32
|
+
throw new Error(`PostHogFeatureFlag "payload" must be a boolean. Received ${JSON.stringify(payload)}.`);
|
|
33
|
+
}
|
|
34
|
+
const fallback = defaultValue ?? null;
|
|
35
|
+
// Not initialised or disabled - the app still needs an answer, and the
|
|
36
|
+
// configured default is a better one than null.
|
|
37
|
+
const posthog = await getPostHog({
|
|
38
|
+
action: 'PostHogFeatureFlag'
|
|
39
|
+
});
|
|
40
|
+
if (type.isNone(posthog)) return fallback;
|
|
41
|
+
let value;
|
|
42
|
+
if (payload === true) {
|
|
43
|
+
value = posthog.getFeatureFlagPayload(key);
|
|
44
|
+
} else if (enabled === true) {
|
|
45
|
+
value = posthog.isFeatureEnabled(key);
|
|
46
|
+
} else {
|
|
47
|
+
value = posthog.getFeatureFlag(key);
|
|
48
|
+
}
|
|
49
|
+
return value ?? fallback;
|
|
50
|
+
}
|
|
51
|
+
export default PostHogFeatureFlag;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ export default {
|
|
16
|
+
type: 'object',
|
|
17
|
+
params: {
|
|
18
|
+
type: 'object',
|
|
19
|
+
required: [
|
|
20
|
+
'key'
|
|
21
|
+
],
|
|
22
|
+
properties: {
|
|
23
|
+
key: {
|
|
24
|
+
type: 'string',
|
|
25
|
+
minLength: 1,
|
|
26
|
+
description: 'The feature flag key.'
|
|
27
|
+
},
|
|
28
|
+
default: {
|
|
29
|
+
description: 'Returned when the flag has no value for this person, and when PostHog is not initialised or is disabled. Defaults to null.'
|
|
30
|
+
},
|
|
31
|
+
enabled: {
|
|
32
|
+
type: 'boolean',
|
|
33
|
+
description: 'Return a boolean, using isFeatureEnabled, instead of the variant value. Ignored when payload is true.'
|
|
34
|
+
},
|
|
35
|
+
payload: {
|
|
36
|
+
type: 'boolean',
|
|
37
|
+
description: 'Return the flag payload, using getFeatureFlagPayload, instead of the flag value. Takes precedence over enabled.'
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
additionalProperties: false
|
|
41
|
+
}
|
|
42
|
+
};
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020-2026 Lowdefy, Inc
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
|
15
|
+
*/ import { type } from '@lowdefy/helpers';
|
|
16
|
+
import getPostHog from '../lib/getPostHog.js';
|
|
17
|
+
// Associate the current person with a group, so events can be analysed per
|
|
18
|
+
// organisation, team or account. The association sticks until reset() is
|
|
19
|
+
// called, so run it after PostHogIdentify.
|
|
20
|
+
async function PostHogGroup({ params }) {
|
|
21
|
+
const { type: groupType, key, properties } = params ?? {};
|
|
22
|
+
if (!type.isString(groupType) || groupType.trim() === '') {
|
|
23
|
+
throw new Error(`PostHogGroup "type" must be a non-empty string. Received ${JSON.stringify(groupType)}.`);
|
|
24
|
+
}
|
|
25
|
+
if (!type.isString(key) || key.trim() === '') {
|
|
26
|
+
throw new Error(`PostHogGroup "key" must be a non-empty string. Received ${JSON.stringify(key)}.`);
|
|
27
|
+
}
|
|
28
|
+
if (!type.isNone(properties) && !type.isObject(properties)) {
|
|
29
|
+
throw new Error(`PostHogGroup "properties" must be an object. Received ${JSON.stringify(properties)}.`);
|
|
30
|
+
}
|
|
31
|
+
const posthog = await getPostHog({
|
|
32
|
+
action: 'PostHogGroup'
|
|
33
|
+
});
|
|
34
|
+
if (type.isNone(posthog)) return null;
|
|
35
|
+
posthog.group(groupType, key, properties ?? undefined);
|
|
36
|
+
return null;
|
|
37
|
+
}
|
|
38
|
+
export default PostHogGroup;
|