@lowdefy/docs-content 6.1.0 → 7.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/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +7 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +43 -7
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +154 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +8 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +136 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +2 -0
- package/content/connections/smtp.md +3 -1
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +24 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +1 -0
- package/content/controls/try.md +4 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +10 -7
- package/content/deployment/docker.md +22 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +17 -6
- package/content/display-blocks/aggrid.md +36 -19
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +24 -1
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +44 -0
- package/index.json +3691 -14
- package/package.json +11 -1
- package/scripts/collectImportedFiles.js +80 -0
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +100 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
|
@@ -0,0 +1,359 @@
|
|
|
1
|
+
# PostHog
|
|
2
|
+
|
|
3
|
+
The `@lowdefy/plugin-posthog` plugin adds [PostHog](https://posthog.com) product analytics to a Lowdefy app. It wraps the `posthog-js` browser SDK in a set of actions: initialise PostHog, capture events, identify people and groups, manage consent and read feature flags.
|
|
4
|
+
|
|
5
|
+
The plugin bundles `posthog-js` as a module, so no script tag, snippet or reverse proxy configuration is needed.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
The `@lowdefy/plugin-posthog` package is included by default, so no `plugins` entry is needed in `lowdefy.yaml`. The `posthog-js` SDK is loaded lazily: it is downloaded the first time [`PostHogInit`](/PostHogInit) runs with PostHog enabled, so an app with analytics switched off never downloads or runs it.
|
|
10
|
+
|
|
11
|
+
## Initialise PostHog
|
|
12
|
+
|
|
13
|
+
The [`PostHogInit`](/PostHogInit) action loads and configures `posthog-js`. Every other action in this package does nothing until it has run. Run it from the app's root `events.onInitAsync` in `lowdefy.yaml`: app events run once per app load, on whichever page a user opens first, including public pages outside a layout, and `onInitAsync` does not hold the first render. Keep the actions in one file:
|
|
14
|
+
|
|
15
|
+
```yaml
|
|
16
|
+
# lowdefy.yaml
|
|
17
|
+
events:
|
|
18
|
+
onInitAsync:
|
|
19
|
+
_ref: shared/posthog_init.yaml
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
```yaml
|
|
23
|
+
# shared/posthog_init.yaml
|
|
24
|
+
- id: init_posthog
|
|
25
|
+
type: PostHogInit
|
|
26
|
+
params:
|
|
27
|
+
apiKey:
|
|
28
|
+
_build.env: POSTHOG_API_KEY
|
|
29
|
+
enabled:
|
|
30
|
+
_build.ne:
|
|
31
|
+
- _build.env: POSTHOG_API_KEY
|
|
32
|
+
- null
|
|
33
|
+
options:
|
|
34
|
+
capture_pageview: history_change
|
|
35
|
+
person_profiles: identified_only
|
|
36
|
+
- id: identify_person
|
|
37
|
+
type: PostHogIdentify
|
|
38
|
+
params:
|
|
39
|
+
id:
|
|
40
|
+
_user: id
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
A user who signs in later is identified on the reload that follows sign in.
|
|
44
|
+
|
|
45
|
+
`PostHogInit` is idempotent. The first call downloads and initialises `posthog-js`; later calls with the same `apiKey` do nothing, so an app that runs it from every page's `onInit` instead still loads PostHog once and captures each failure once. Calling it with a different `apiKey` throws, because a second PostHog instance would split the session.
|
|
46
|
+
|
|
47
|
+
The PostHog project API key is a public, write only key that is meant to ship in the browser bundle, so [`_build.env`](/_build) is the right operator for it. Never use a personal API key here.
|
|
48
|
+
|
|
49
|
+
###### Turning analytics off
|
|
50
|
+
|
|
51
|
+
With `enabled: false`, `PostHogInit` does not load `posthog-js` and every other action in this package becomes a silent no-op, so `apiKey` is not required. The example above sets `enabled` from the key itself: leave `POSTHOG_API_KEY` unset in local development and set it in the deployments that should send data. Any other build time switch works too, for example a `POSTHOG_ENABLED` environment variable:
|
|
52
|
+
|
|
53
|
+
```yaml
|
|
54
|
+
enabled:
|
|
55
|
+
_build.eq:
|
|
56
|
+
- _build.env: POSTHOG_ENABLED
|
|
57
|
+
- 'true'
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
A later `PostHogInit` call with `enabled: true` and an `apiKey` still loads PostHog after a disabled call. The reverse throws: once PostHog is running, use [`PostHogOptOut`](/PostHogOptOut) to stop capturing for a person.
|
|
61
|
+
|
|
62
|
+
## Lowdefy semantics on every event
|
|
63
|
+
|
|
64
|
+
Autocapture records the DOM: which element was clicked, and its text. The plugin adds what that element means in the Lowdefy app, so analysis can work in pages, blocks and events instead of CSS selectors:
|
|
65
|
+
|
|
66
|
+
- __Autocaptured clicks, rage clicks and dead clicks__ get `lowdefy_page_id`, `lowdefy_block_id` (the block clicked), `lowdefy_block_type` (for example `Button`), `lowdefy_block_ids` (every enclosing block, innermost first, so a click on a title inside a clickable card also names the card), `lowdefy_option: true` when a dropdown option was picked, `lowdefy_text` (the text of the control the click reached, such as a button or menu item, even when the click landed on its icon or a wrapper, where `$el_text` holds only the clicked element's own text) and, inside a grid, `lowdefy_row` (the displayed row index) and `lowdefy_column` (the column id).
|
|
67
|
+
- __Every other event__, pageviews and [`PostHogCapture`](/PostHogCapture) events included, gets `lowdefy_page_id`, read from the URL it was captured on, and `lowdefy_path_params`, the path values of a page with a `path` pattern (`{}` otherwise).
|
|
68
|
+
- __Super properties__: `lowdefy_build_id` and `lowdefy_app_version` (the app's `version`) on every event, beside `environment`.
|
|
69
|
+
|
|
70
|
+
Null, false and empty values are left out. The enrichment adds properties, never events, so it costs nothing in billing, and it has no switch. A block with the `ph-no-capture` class is not autocaptured, so it is never enriched.
|
|
71
|
+
|
|
72
|
+
###### Failed events
|
|
73
|
+
|
|
74
|
+
When a block or app event fails, for example a `Validate` that finds invalid fields or a `CallAPI` that times out, the plugin captures one `lowdefy_event_failed` event. It is the one event the plugin adds. It carries ids only, never error messages or values:
|
|
75
|
+
|
|
76
|
+
| Property | Value |
|
|
77
|
+
| --- | --- |
|
|
78
|
+
| `lowdefy_event_scope` | `page`, or `app` for the app's root events |
|
|
79
|
+
| `lowdefy_page_id` | the page the event ran on |
|
|
80
|
+
| `lowdefy_path_params` | the path values of the page the event ran on |
|
|
81
|
+
| `lowdefy_block_id` | the block, or `app` for an app event |
|
|
82
|
+
| `lowdefy_block_type` | the block type, left out for an app event |
|
|
83
|
+
| `lowdefy_event_name` | for example `onClick` or `onInit` |
|
|
84
|
+
| `lowdefy_debounce_ms` | the event's debounce, or `0` |
|
|
85
|
+
| `lowdefy_action_id` | the id of the action that failed |
|
|
86
|
+
| `lowdefy_action_type` | for example `Validate` or `CallAPI` |
|
|
87
|
+
| `lowdefy_error_name` | for example `UserError` or `RequestError` |
|
|
88
|
+
| `lowdefy_config_key` | the config key of the action, resolvable with `lowdefy_build_id` |
|
|
89
|
+
| `lowdefy_invalid_blocks` | the blocks a `Validate` found invalid, left out when empty |
|
|
90
|
+
|
|
91
|
+
The event is timestamped when the failed event's actions started, so it lines up with the click that caused it. A failure in the app's `onInit`, such as a startup `CallAPI` that times out, is captured too, although `PostHogInit` runs later in `onInitAsync`: Lowdefy holds up to 20 failures until PostHog starts. At most 50 are captured per app load. Set `captureEventFailures: false` on `PostHogInit` to turn it off.
|
|
92
|
+
|
|
93
|
+
###### Querying
|
|
94
|
+
|
|
95
|
+
In a PostHog SQL insight, the properties read like any other:
|
|
96
|
+
|
|
97
|
+
```sql
|
|
98
|
+
select properties.lowdefy_page_id as page, properties.lowdefy_block_id as block, count() as clicks
|
|
99
|
+
from events
|
|
100
|
+
where event = '$autocapture' and properties.lowdefy_block_id is not null
|
|
101
|
+
and timestamp > now() - interval 7 day
|
|
102
|
+
group by page, block
|
|
103
|
+
order by clicks desc
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
```sql
|
|
107
|
+
select properties.lowdefy_page_id as page, properties.lowdefy_block_id as block,
|
|
108
|
+
properties.lowdefy_action_type as action, count() as failures
|
|
109
|
+
from events
|
|
110
|
+
where event = 'lowdefy_event_failed' and timestamp > now() - interval 7 day
|
|
111
|
+
group by page, block, action
|
|
112
|
+
order by failures desc
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
###### Journeys from production
|
|
116
|
+
|
|
117
|
+
`lowdefy journeys pull posthog` reads these events back to your machine over PostHog's query API, so [journeys can be mined from production](/config-tests#production-journeys): compiled into candidate tests, checked for how much real use backs each journey, and compared with what users do that no journey covers. It needs `POSTHOG_PROJECT_ID`, `POSTHOG_API_HOST` and your own personal API key with the Query Read scope in `POSTHOG_PERSONAL_API_KEY`; see the [CLI reference](/cli#journeys-pull-posthog).
|
|
118
|
+
|
|
119
|
+
What reaches your machine, in `.lowdefy/traces/production/`, which is not committed: no typed values (PostHog never captured them), person and organisation ids hashed with a salt that stays on your machine, URL query parameter names without their values, and no clicked text. The clicked element's text is stored only as a token, a hash under the same salt; the journey commands turn a token back into text only when it is text from the app's own config, such as a button label or a menu item. The element chain is read in memory and never written. PostHog itself only holds the clicked text the app's config spells out, unless `maskDataText` is `false` (see [Click text masking](#click-text-masking)), so a production record of a click on data carries its page, block, row and column but no text. Events from before the Lowdefy properties above were added still count: the pull reads the block ids from the element chain instead.
|
|
120
|
+
|
|
121
|
+
Every event the plugin enriches names its page in `lowdefy_page_id`, so the pull never guesses it. A failed app event names the page the app loaded on, including a configured home page served at the app root (`/`). Events from before the Lowdefy properties were added carry no page id, so the pull reads the page from the URL path. That reading assumes the app is served at the root and that `/` only redirects: older events from an app with a `basePath`, or from a home page served at `/`, are dropped.
|
|
122
|
+
|
|
123
|
+
## Click text masking
|
|
124
|
+
|
|
125
|
+
By default, `posthog-js` sends the text of every element a person clicks. In a business app that text is often data: a customer's name in a grid row, an account picked from a dropdown filled by a request. The plugin masks that text in the browser, before any event is sent, and keeps the text the app's config spells out.
|
|
126
|
+
|
|
127
|
+
###### What is masked
|
|
128
|
+
|
|
129
|
+
On every event, whatever its name (autocaptured clicks, rage clicks, dead clicks and swipes, copy events and any event `posthog-js` adds later):
|
|
130
|
+
|
|
131
|
+
- __Text that is not config text.__ Each clicked text (`$el_text`, `lowdefy_text`, the `text` entries of `$elements_chain` and `$elements`, `$selected_content` and link targets) is kept only when it equals, after whitespace is collapsed, a string in the config of the page the event was captured on, in the app's menus, in the i18n messages or in the antd locale. Everything else is removed: grid and table cell values, options and menu items a request fills, labels built from records, and anything a `Dynamic` block's endpoint returned. A link whose target is not config text keeps its `href` attribute, emptied, so the click still reads as a link click.
|
|
132
|
+
- __Element attributes outside a structural allow-list.__ Only the tag, classes, `class`, `role`, `type`, `row-index`, `col-id`, `nth-child` and `nth-of-type` are kept, and `id` only when it is a block's wrapper id (`bl-<blockId>`). Other ids are removed, because ids that libraries generate can embed runtime keys: an antd tab is `rc-tabs-<n>-tab-<key>`, so a `Tabs` block keyed by record would send the record. Every other attribute is removed, including `title` (antd select options carry their label there), `aria-label`, `value`, `placeholder`, `alt` and every `data-*` attribute.
|
|
133
|
+
|
|
134
|
+
###### What stays
|
|
135
|
+
|
|
136
|
+
- Config labels: button titles, menu and tab labels, column headers, card titles, literal option labels, and antd's own strings such as modal __OK__ and __Cancel__ or pagination.
|
|
137
|
+
- Every other `lowdefy_*` property, so a click on data still records its page, block, row, column and whether it picked an option.
|
|
138
|
+
|
|
139
|
+
A data value that happens to equal a config string, such as a status `Active` that is also a literal option, is kept: that string is already in config shipped to every visitor of the page.
|
|
140
|
+
|
|
141
|
+
###### What is not masked
|
|
142
|
+
|
|
143
|
+
URLs. `$current_url`, `$pathname`, URL query values and `lowdefy_path_params` still reach PostHog unchanged, so keep names and other personal data out of page paths and query parameters.
|
|
144
|
+
|
|
145
|
+
###### Changing it
|
|
146
|
+
|
|
147
|
+
- `maskDataText: false` on [`PostHogInit`](/PostHogInit) sends full click text and every attribute, as `posthog-js` does by default.
|
|
148
|
+
- `options.mask_all_text: true` sends no click text at all, config labels included.
|
|
149
|
+
- A block `class` of `ph-sensitive` masks that block's config text too. It covers only the block's own DOM: popups a block renders into the page body, such as `Dropdown` and `DropdownButton` items, table and grid `MenuCell` menus, `Modal` and `Drawer`, are outside it.
|
|
150
|
+
|
|
151
|
+
Two things are left to the app:
|
|
152
|
+
|
|
153
|
+
- Classes are sent as they are, so never build a block's `class` from data.
|
|
154
|
+
- A `data-ph-capture-attribute-<name>` attribute is how `posthog-js` lets an app add a property to a click: its value is sent unmasked as property `<name>`. Only put config values in it.
|
|
155
|
+
|
|
156
|
+
###### Session replay
|
|
157
|
+
|
|
158
|
+
Session replay is separate from click events and is not covered by this masking. When the PostHog project turns recordings on, replay records the page's text (inputs are masked by `posthog-js` by default). Set `options.session_recording.maskTextSelector: '*'` to mask all text in recordings, or give a block a `class` of `ph-mask` to mask one block.
|
|
159
|
+
|
|
160
|
+
## Analytics never breaks the app
|
|
161
|
+
|
|
162
|
+
Every action in this package, except `PostHogInit`, does nothing and returns `null` when PostHog is disabled or `posthog-js` could not be downloaded. A disabled environment or a flaky network can never throw from an analytics action and can never stop an event chain. [`PostHogFeatureFlag`](/PostHogFeatureFlag) returns its configured `default` instead of `null`, so flag driven config keeps working with PostHog switched off, and [`PostHogReloadFeatureFlags`](/PostHogReloadFeatureFlags) returns `{ flags: [], variants: {} }`.
|
|
163
|
+
|
|
164
|
+
Two kinds of config mistake are still reported:
|
|
165
|
+
|
|
166
|
+
- __Invalid params__ always throw, whether PostHog is enabled or not, so a mistake shows up in development even when analytics is switched off there.
|
|
167
|
+
- __A PostHog action that runs before `PostHogInit`__ does nothing, and logs a warning to the browser console once.
|
|
168
|
+
|
|
169
|
+
An action that runs while `PostHogInit` is still downloading `posthog-js` waits for it to finish.
|
|
170
|
+
|
|
171
|
+
## Never send personal data
|
|
172
|
+
|
|
173
|
+
Never send personally identifiable information to PostHog: no names, no email addresses, no phone numbers, and no free text a user typed into a form. Send stable ids and low cardinality attributes such as a plan name, a role, a locale or an organization id.
|
|
174
|
+
|
|
175
|
+
## Pageviews
|
|
176
|
+
|
|
177
|
+
A Lowdefy app routes on the client without a page load, so the `posthog-js` default, `capture_pageview: true`, only captures the first page. Set `capture_pageview: history_change` in the `PostHogInit` options, as in the example above, and `posthog-js` captures a `$pageview` every time the path changes. It also captures a `$pageleave` when the tab is closed, which PostHog needs for bounce rate and time on page.
|
|
178
|
+
|
|
179
|
+
To capture pageviews by hand instead, for example to add properties to them, set `capture_pageview: false` and run [`PostHogPageview`](/PostHogPageview) from each page's `onMountAsync` event, which runs every time the page is shown without holding it in a loading state:
|
|
180
|
+
|
|
181
|
+
```yaml
|
|
182
|
+
# pages/reports.yaml
|
|
183
|
+
id: reports
|
|
184
|
+
type: PageHeaderMenu
|
|
185
|
+
events:
|
|
186
|
+
onMountAsync:
|
|
187
|
+
- id: capture_pageview
|
|
188
|
+
type: PostHogPageview
|
|
189
|
+
params:
|
|
190
|
+
properties:
|
|
191
|
+
section: reports
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
With automatic pageviews off, `posthog-js` also stops capturing pageleaves, because `capture_pageleave` defaults to `if_capture_pageview`. Set `capture_pageleave: true` in the options to keep them, or capture one by hand with [`PostHogCapturePageLeave`](/PostHogCapturePageLeave), for example before a `Link` or `Logout` action. The page `onHidden` event is not a page leave: it also fires when the browser window loses focus.
|
|
195
|
+
|
|
196
|
+
## Identify a person
|
|
197
|
+
|
|
198
|
+
[`PostHogIdentify`](/PostHogIdentify) ties the current browser session to a person. Run it once the user is known, usually right after `PostHogInit` in the app's `onInitAsync` actions, as in the example above, or after a successful login.
|
|
199
|
+
|
|
200
|
+
```yaml
|
|
201
|
+
- id: identify_person
|
|
202
|
+
type: PostHogIdentify
|
|
203
|
+
params:
|
|
204
|
+
id:
|
|
205
|
+
_user: id
|
|
206
|
+
properties:
|
|
207
|
+
role:
|
|
208
|
+
_user: role
|
|
209
|
+
locale:
|
|
210
|
+
_locale: active
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
A missing or empty `id` is a no-op, so on a public page the anonymous session is left alone. That anonymous session is what a later `PostHogIdentify` merges into the person, which is what makes signup funnels work. `null` and `undefined` property values are dropped, so an absent value never overwrites one PostHog already has.
|
|
214
|
+
|
|
215
|
+
The action is safe to run on every page. It reads the identity `posthog-js` already holds:
|
|
216
|
+
|
|
217
|
+
- __Same person__: when the id is already the current `distinct_id`, it only updates the person properties, if any are given. `posthog-js` skips a property update identical to the previous one.
|
|
218
|
+
- __Person swap__: PostHog refuses to move an identified `distinct_id` onto a different person, so when the browser is identified as someone else, `PostHogIdentify` calls `reset()` before identifying the new person.
|
|
219
|
+
- __Anonymous visitor__: identified without a reset, so the anonymous session merges into the person.
|
|
220
|
+
|
|
221
|
+
Use [`PostHogSetPersonProperties`](/PostHogSetPersonProperties) to update a person's properties on their own, and [`PostHogAlias`](/PostHogAlias) to point a second id at the person PostHog already knows.
|
|
222
|
+
|
|
223
|
+
## Sign out
|
|
224
|
+
|
|
225
|
+
[`PostHogReset`](/PostHogReset) forgets the current person and starts a fresh anonymous session. Run it on sign out so the next person on a shared browser is not merged into this one.
|
|
226
|
+
|
|
227
|
+
```yaml
|
|
228
|
+
- id: reset_posthog
|
|
229
|
+
type: PostHogReset
|
|
230
|
+
- id: logout
|
|
231
|
+
type: Logout
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
## Capture events
|
|
235
|
+
|
|
236
|
+
[`PostHogCapture`](/PostHogCapture) captures a named product event.
|
|
237
|
+
|
|
238
|
+
```yaml
|
|
239
|
+
- id: submit_report
|
|
240
|
+
type: Button
|
|
241
|
+
properties:
|
|
242
|
+
title: Submit report
|
|
243
|
+
events:
|
|
244
|
+
onClick:
|
|
245
|
+
- id: submit
|
|
246
|
+
type: Request
|
|
247
|
+
params: submit_report
|
|
248
|
+
- id: capture_event
|
|
249
|
+
type: PostHogCapture
|
|
250
|
+
params:
|
|
251
|
+
event: report_submitted
|
|
252
|
+
properties:
|
|
253
|
+
report_type:
|
|
254
|
+
_state: report_type
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
Autocapture already records clicks and pageviews, so keep the set of named events small. Every event is billable, and a funnel of thirty near identical events tells you less than one of five.
|
|
258
|
+
|
|
259
|
+
## Groups
|
|
260
|
+
|
|
261
|
+
[`PostHogGroup`](/PostHogGroup) associates the current person with a group, so events can be analysed per organization, team or account. The association sticks until `PostHogReset` is called, so run it after `PostHogIdentify`.
|
|
262
|
+
|
|
263
|
+
```yaml
|
|
264
|
+
- id: set_group
|
|
265
|
+
type: PostHogGroup
|
|
266
|
+
params:
|
|
267
|
+
type: organization
|
|
268
|
+
key:
|
|
269
|
+
_user: organizationId
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
## Feature flags
|
|
273
|
+
|
|
274
|
+
[`PostHogFeatureFlag`](/PostHogFeatureFlag) reads a feature flag and returns its value, so it can be used further down the action chain with the [`_actions`](/_actions) operator. The value is whatever PostHog resolved for this person when flags were last loaded; the action does not wait for a network call. When the person or their groups just changed, reload the flags first with [`PostHogReloadFeatureFlags`](/PostHogReloadFeatureFlags), which resolves once the new flags have arrived.
|
|
275
|
+
|
|
276
|
+
```yaml
|
|
277
|
+
events:
|
|
278
|
+
onMount:
|
|
279
|
+
- id: read_flag
|
|
280
|
+
type: PostHogFeatureFlag
|
|
281
|
+
params:
|
|
282
|
+
key: new-checkout
|
|
283
|
+
default: control
|
|
284
|
+
- id: store_flag
|
|
285
|
+
type: SetState
|
|
286
|
+
params:
|
|
287
|
+
checkout_variant:
|
|
288
|
+
_actions: read_flag.response
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
After a change that affects flag targeting, reload before reading:
|
|
292
|
+
|
|
293
|
+
```yaml
|
|
294
|
+
- id: switch_organization
|
|
295
|
+
type: Button
|
|
296
|
+
events:
|
|
297
|
+
onClick:
|
|
298
|
+
- id: set_group
|
|
299
|
+
type: PostHogGroup
|
|
300
|
+
params:
|
|
301
|
+
type: organization
|
|
302
|
+
key:
|
|
303
|
+
_state: organization_id
|
|
304
|
+
- id: reload_flags
|
|
305
|
+
type: PostHogReloadFeatureFlags
|
|
306
|
+
- id: store_flags
|
|
307
|
+
type: SetState
|
|
308
|
+
params:
|
|
309
|
+
feature_flags:
|
|
310
|
+
_actions: reload_flags.response.variants
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
## Consent
|
|
314
|
+
|
|
315
|
+
When consent is required before any data is sent, initialise PostHog with capturing switched off, and turn it on with [`PostHogOptIn`](/PostHogOptIn) when the user accepts, or keep it off with [`PostHogOptOut`](/PostHogOptOut):
|
|
316
|
+
|
|
317
|
+
```yaml
|
|
318
|
+
# shared/posthog_init.yaml
|
|
319
|
+
- id: init_posthog
|
|
320
|
+
type: PostHogInit
|
|
321
|
+
params:
|
|
322
|
+
apiKey:
|
|
323
|
+
_build.env: POSTHOG_API_KEY
|
|
324
|
+
options:
|
|
325
|
+
capture_pageview: history_change
|
|
326
|
+
opt_out_capturing_by_default: true
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
```yaml
|
|
330
|
+
# the consent banner
|
|
331
|
+
- id: accept_analytics
|
|
332
|
+
type: Button
|
|
333
|
+
properties:
|
|
334
|
+
title: Accept
|
|
335
|
+
events:
|
|
336
|
+
onClick:
|
|
337
|
+
- id: opt_in
|
|
338
|
+
type: PostHogOptIn
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
The choice is remembered in the persistence store configured on `PostHogInit`.
|
|
342
|
+
|
|
343
|
+
## Actions
|
|
344
|
+
|
|
345
|
+
| Action | Params | Response |
|
|
346
|
+
| --- | --- | --- |
|
|
347
|
+
| [`PostHogInit`](/PostHogInit) | `apiKey`, `apiHost`, `options`, `debug`, `enabled`, `captureEventFailures`, `maskDataText` | `null` |
|
|
348
|
+
| [`PostHogCapture`](/PostHogCapture) | `event`, `properties`, `groups` | `null` |
|
|
349
|
+
| [`PostHogPageview`](/PostHogPageview) | `properties` | `null` |
|
|
350
|
+
| [`PostHogCapturePageLeave`](/PostHogCapturePageLeave) | `properties` | `null` |
|
|
351
|
+
| [`PostHogIdentify`](/PostHogIdentify) | `id`, `properties`, `propertiesOnce` | `null` |
|
|
352
|
+
| [`PostHogSetPersonProperties`](/PostHogSetPersonProperties) | `set`, `setOnce` | `null` |
|
|
353
|
+
| [`PostHogAlias`](/PostHogAlias) | `alias` | `null` |
|
|
354
|
+
| [`PostHogGroup`](/PostHogGroup) | `type`, `key`, `properties` | `null` |
|
|
355
|
+
| [`PostHogReset`](/PostHogReset) | `resetDeviceId` | `null` |
|
|
356
|
+
| [`PostHogOptIn`](/PostHogOptIn) | none | `null` |
|
|
357
|
+
| [`PostHogOptOut`](/PostHogOptOut) | none | `null` |
|
|
358
|
+
| [`PostHogFeatureFlag`](/PostHogFeatureFlag) | `key`, `default`, `enabled`, `payload` | the flag value, or `default` |
|
|
359
|
+
| [`PostHogReloadFeatureFlags`](/PostHogReloadFeatureFlags) | `timeout` | `{ flags, variants }` |
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Auth.js Providers
|
|
2
|
+
|
|
3
|
+
All Auth.js preconfigured OAuth providers can be used in a Lowdefy app. The provider properties are mapped through directly, so the Auth.js documentation can be used as reference. They usually only need a few configuration properties to be used. Since these properties include secrets, the [`_secret`](/_secret) operator should be used to configure these properties.
|
|
4
|
+
|
|
5
|
+
For most OAuth providers, a callback URL must be configured with the provider for security reasons. This URL is the URL to which the user will be redirected to complete the login flow. This URL should be set to `<app-domain>/api/auth/callback/<providerId>` where the `providerId` is the Lowdefy providerId.
|
|
6
|
+
|
|
7
|
+
> This is not the same as the callback URL specified in the Login action, which is where the user is redirected by the Lowdefy app once login is complete.
|
|
8
|
+
|
|
9
|
+
The providers that can be used are:
|
|
10
|
+
|
|
11
|
+
- [FortyTwoProvider](https://authjs.dev/reference/core/providers/42-school)
|
|
12
|
+
- [AppleProvider](https://authjs.dev/reference/core/providers/apple)
|
|
13
|
+
- [AtlassianProvider](https://authjs.dev/reference/core/providers/atlassian)
|
|
14
|
+
- [Auth0Provider](https://authjs.dev/reference/core/providers/auth0)
|
|
15
|
+
- [AuthentikProvider](https://authjs.dev/reference/core/providers/authentik)
|
|
16
|
+
- [AzureADB2CProvider](https://authjs.dev/reference/core/providers/azure-ad-b2c)
|
|
17
|
+
- [AzureADProvider](https://authjs.dev/reference/core/providers/azure-ad)
|
|
18
|
+
- [BattleNetProvider](https://authjs.dev/reference/core/providers/battlenet)
|
|
19
|
+
- [BoxProvider](https://authjs.dev/reference/core/providers/box)
|
|
20
|
+
- [BoxyHQSAMLProvider](https://authjs.dev/reference/core/providers/boxyhq-saml)
|
|
21
|
+
- [BungieProvider](https://authjs.dev/reference/core/providers/bungie)
|
|
22
|
+
- [CognitoProvider](https://authjs.dev/reference/core/providers/cognito)
|
|
23
|
+
- [CoinbaseProvider](https://authjs.dev/reference/core/providers/coinbase)
|
|
24
|
+
- [DiscordProvider](https://authjs.dev/reference/core/providers/discord)
|
|
25
|
+
- [DropboxProvider](https://authjs.dev/reference/core/providers/dropbox)
|
|
26
|
+
- [EVEOnlineProvider](https://authjs.dev/reference/core/providers/eveonline)
|
|
27
|
+
- [FacebookProvider](https://authjs.dev/reference/core/providers/facebook)
|
|
28
|
+
- [FaceItProvider](https://authjs.dev/reference/core/providers/faceit)
|
|
29
|
+
- [FourSquareProvider](https://authjs.dev/reference/core/providers/foursquare)
|
|
30
|
+
- [FreshbooksProvider](https://authjs.dev/reference/core/providers/freshbooks)
|
|
31
|
+
- [FusionAuthProvider](https://authjs.dev/reference/core/providers/fusionauth)
|
|
32
|
+
- [GitHubProvider](https://authjs.dev/reference/core/providers/github)
|
|
33
|
+
- [GitlabProvider](https://authjs.dev/reference/core/providers/gitlab)
|
|
34
|
+
- [GoogleProvider](https://authjs.dev/reference/core/providers/google)
|
|
35
|
+
- [HubspotProvider](https://authjs.dev/reference/core/providers/hubspot)
|
|
36
|
+
- [InstagramProvider](https://authjs.dev/reference/core/providers/instagram)
|
|
37
|
+
- [KakaoProvider](https://authjs.dev/reference/core/providers/kakao)
|
|
38
|
+
- [KeycloakProvider](https://authjs.dev/reference/core/providers/keycloak)
|
|
39
|
+
- [LineProvider](https://authjs.dev/reference/core/providers/line)
|
|
40
|
+
- [LinkedInProvider](https://authjs.dev/reference/core/providers/linkedin)
|
|
41
|
+
- [MailchimpProvider](https://authjs.dev/reference/core/providers/mailchimp)
|
|
42
|
+
- [MailRuProvider](https://authjs.dev/reference/core/providers/mailru)
|
|
43
|
+
- [MediumProvider](https://authjs.dev/reference/core/providers/medium)
|
|
44
|
+
- [NaverProvider](https://authjs.dev/reference/core/providers/naver)
|
|
45
|
+
- [NetlifyProvider](https://authjs.dev/reference/core/providers/netlify)
|
|
46
|
+
- [OktaProvider](https://authjs.dev/reference/core/providers/okta)
|
|
47
|
+
- [OneLoginProvider](https://authjs.dev/reference/core/providers/onelogin)
|
|
48
|
+
- [OssoProvider](https://authjs.dev/reference/core/providers/osso)
|
|
49
|
+
- [OsuProvider](https://authjs.dev/reference/core/providers/osu)
|
|
50
|
+
- [PassageProvider](https://authjs.dev/reference/core/providers/passage)
|
|
51
|
+
- [PatreonProvider](https://authjs.dev/reference/core/providers/patreon)
|
|
52
|
+
- [PinterestProvider](https://authjs.dev/reference/core/providers/pinterest)
|
|
53
|
+
- [PipedriveProvider](https://authjs.dev/reference/core/providers/pipedrive)
|
|
54
|
+
- [RedditProvider](https://authjs.dev/reference/core/providers/reddit)
|
|
55
|
+
- [SalesforceProvider](https://authjs.dev/reference/core/providers/salesforce)
|
|
56
|
+
- [SlackProvider](https://authjs.dev/reference/core/providers/slack)
|
|
57
|
+
- [SpotifyProvider](https://authjs.dev/reference/core/providers/spotify)
|
|
58
|
+
- [StravaProvider](https://authjs.dev/reference/core/providers/strava)
|
|
59
|
+
- [TodoistProvider](https://authjs.dev/reference/core/providers/todoist)
|
|
60
|
+
- [TraktProvider](https://authjs.dev/reference/core/providers/trakt)
|
|
61
|
+
- [TwitchProvider](https://authjs.dev/reference/core/providers/twitch)
|
|
62
|
+
- [TwitterProvider](https://authjs.dev/reference/core/providers/twitter)
|
|
63
|
+
- [UnitedEffects](https://authjs.dev/reference/core/providers/united-effects)
|
|
64
|
+
- [VkProvider](https://authjs.dev/reference/core/providers/vk)
|
|
65
|
+
- [WikimediaProvider](https://authjs.dev/reference/core/providers/wikimedia)
|
|
66
|
+
- [WordpressProvider](https://authjs.dev/reference/core/providers/wordpress)
|
|
67
|
+
- [WorkOSProvider](https://authjs.dev/reference/core/providers/workos)
|
|
68
|
+
- [YandexProvider](https://authjs.dev/reference/core/providers/yandex)
|
|
69
|
+
- [ZitadelProvider](https://authjs.dev/reference/core/providers/zitadel)
|
|
70
|
+
- [ZohoProvider](https://authjs.dev/reference/core/providers/zoho)
|
|
71
|
+
- [ZoomProvider](https://authjs.dev/reference/core/providers/zoom)
|
|
72
|
+
|
|
73
|
+
#### Examples
|
|
74
|
+
|
|
75
|
+
###### Auth0 configuration:
|
|
76
|
+
|
|
77
|
+
```yaml
|
|
78
|
+
lowdefy: 7.0.0
|
|
79
|
+
auth:
|
|
80
|
+
providers:
|
|
81
|
+
- id: auth0
|
|
82
|
+
type: Auth0Provider
|
|
83
|
+
properties:
|
|
84
|
+
clientId:
|
|
85
|
+
_secret: AUTH0_CLIENT_ID
|
|
86
|
+
clientSecret:
|
|
87
|
+
_secret: AUTH0_CLIENT_SECRET
|
|
88
|
+
issuer:
|
|
89
|
+
_secret: AUTH0_ISSUER
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
In Auth0, the callback URL should be configured to `https://example.com/api/auth/callback/auth0` for production and `http://localhost:3000/api/auth/callback/auth0` for development.
|
|
93
|
+
|
|
94
|
+
###### GitHub configuration:
|
|
95
|
+
|
|
96
|
+
```yaml
|
|
97
|
+
lowdefy: 7.0.0
|
|
98
|
+
auth:
|
|
99
|
+
providers:
|
|
100
|
+
- id: github
|
|
101
|
+
type: GitHubProvider
|
|
102
|
+
properties:
|
|
103
|
+
clientId:
|
|
104
|
+
_secret: GITHUB_CLIENT_ID
|
|
105
|
+
clientSecret:
|
|
106
|
+
_secret: GITHUB_CLIENT_SECRET
|
|
107
|
+
```
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# OpenIDConnectProvider
|
|
2
|
+
|
|
3
|
+
The OpenIDConnectProvider can be used to authenticate with a OpenID Connect compliant identity provider that is not already included as a default Auth.js provider, without the need to develop a custom provider plugin.
|
|
4
|
+
|
|
5
|
+
#### Properties
|
|
6
|
+
|
|
7
|
+
###### object
|
|
8
|
+
- `wellKnown: string`
|
|
9
|
+
- `authorization: string | object`: The default is `{ params: { scope: 'openid email profile' } }`.
|
|
10
|
+
- `token: string | object`
|
|
11
|
+
- `userinfo: string | object`
|
|
12
|
+
- `version: string`
|
|
13
|
+
- `checks: string | string[]`: The default is `['pkce', 'state']`
|
|
14
|
+
- `clientId: string`
|
|
15
|
+
- `clientSecret: string`
|
|
16
|
+
- `idToken: boolean`: The default is `true`.
|
|
17
|
+
- `region: string`
|
|
18
|
+
- `issuer: string`
|
|
19
|
+
- `allowDangerousEmailAccountLinking: boolean`
|
|
20
|
+
- `style: object`
|
|
21
|
+
|
|
22
|
+
###### See the [Auth.js OAuth provider guide](https://authjs.dev/guides/configuring-oauth-providers) for more details on provider properties.
|
|
23
|
+
|
|
24
|
+
#### Examples
|
|
25
|
+
|
|
26
|
+
###### Simple configuration.
|
|
27
|
+
|
|
28
|
+
Usually only the `wellKnown`, `clientId` and `clientSecret` properties need to be configured:
|
|
29
|
+
|
|
30
|
+
```yaml
|
|
31
|
+
lowdefy: 7.0.0
|
|
32
|
+
providers:
|
|
33
|
+
- id: my_provider
|
|
34
|
+
type: OpenIDConnectProvider
|
|
35
|
+
properties:
|
|
36
|
+
wellKnown:
|
|
37
|
+
_secret: OPENID_CONNECT_WELLKNOWN
|
|
38
|
+
clientId:
|
|
39
|
+
_secret: OPENID_CONNECT_CLIENT_ID
|
|
40
|
+
clientSecret:
|
|
41
|
+
_secret: OPENID_CONNECT_CLIENT_SECRET
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
where `LOWDEFY_SECRET_OPENID_CONNECT_WELLKNOWN` usually has the format `https://my-provider.com/.well-known/openid-configuration`
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Recipes
|
|
2
|
+
|
|
3
|
+
Recipes are end-to-end compositions — complete, copyable examples that show how
|
|
4
|
+
blocks, operators, actions, and connections work together to solve a real problem.
|
|
5
|
+
|
|
6
|
+
The first recipes are on their way:
|
|
7
|
+
|
|
8
|
+
- Login flow with protected pages
|
|
9
|
+
- CRUD table with edit modal
|
|
10
|
+
- File upload with live preview
|
|
11
|
+
- Multi-step form with validation
|
|
12
|
+
- Dashboard with filters, KPIs, and a chart
|
|
13
|
+
|
|
14
|
+
Until they land, the [tutorial](/tutorial-start) builds a complete app step by step,
|
|
15
|
+
and the [example repositories](https://github.com/lowdefy?q=example) on GitHub cover
|
|
16
|
+
common patterns like CRUD, surveys, and authentication.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Actions
|
|
2
|
+
|
|
3
|
+
Actions run in response to events — a button click, a page load, an input change. All 24 actions, grouped by purpose. See [Events and Actions](/events-and-actions) for how event chains work.
|
|
4
|
+
|
|
5
|
+
State & validation
|
|
6
|
+
|
|
7
|
+
Write state and validate user input.
|
|
8
|
+
|
|
9
|
+
Navigation & focus
|
|
10
|
+
|
|
11
|
+
Move users around the app.
|
|
12
|
+
|
|
13
|
+
Data
|
|
14
|
+
|
|
15
|
+
Call requests and APIs.
|
|
16
|
+
|
|
17
|
+
UI & preferences
|
|
18
|
+
|
|
19
|
+
Messages and user preferences.
|
|
20
|
+
|
|
21
|
+
Files & device
|
|
22
|
+
|
|
23
|
+
Files, clipboard, and device APIs.
|
|
24
|
+
|
|
25
|
+
Flow
|
|
26
|
+
|
|
27
|
+
Control the action chain.
|
|
28
|
+
|
|
29
|
+
Auth & session
|
|
30
|
+
|
|
31
|
+
Sign users in and out.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Blocks
|
|
2
|
+
|
|
3
|
+
Blocks are the visual building parts of every page. Browse by what you are building — the sidebar groups the same blocks by technical type (Input / Display / Container / List).
|
|
4
|
+
|
|
5
|
+
Forms
|
|
6
|
+
|
|
7
|
+
Capture input with validated form controls.
|
|
8
|
+
|
|
9
|
+
Data display
|
|
10
|
+
|
|
11
|
+
Tables, charts, and stats.
|
|
12
|
+
|
|
13
|
+
Layout
|
|
14
|
+
|
|
15
|
+
Arrange content on the page.
|
|
16
|
+
|
|
17
|
+
Feedback
|
|
18
|
+
|
|
19
|
+
Alerts, modals, and loading states.
|
|
20
|
+
|
|
21
|
+
Navigation
|
|
22
|
+
|
|
23
|
+
Menus, steps, and wayfinding.
|
|
24
|
+
|
|
25
|
+
Media
|
|
26
|
+
|
|
27
|
+
Images, maps, and files.
|
|
28
|
+
|
|
29
|
+
Text
|
|
30
|
+
|
|
31
|
+
Titles, prose, and rich content.
|
|
32
|
+
|
|
33
|
+
AI
|
|
34
|
+
|
|
35
|
+
Agent chat interfaces, documented under Learn › AI Agents.
|