@picked/client 0.0.1-dev.1789541668638 → 0.0.1-dev.1793756239746

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.
Files changed (213) hide show
  1. package/LICENSE +1 -0
  2. package/README.md +34 -158
  3. package/dist/.tsbuildinfo +1 -1
  4. package/dist/{api-C7q_7vxn.js → api-B5i4XuCs.js} +1 -1
  5. package/dist/api-DMYLC1At.cjs +1 -0
  6. package/dist/cjs/form/index.js +1 -1
  7. package/dist/cjs/index.js +2 -2
  8. package/dist/cjs/logic-engine.js +1 -0
  9. package/dist/cjs/plugins/dom-observer/index.js +1 -1
  10. package/dist/cjs/plugins/dynamic-experiences/index.js +1 -1
  11. package/dist/cjs/plugins/experience-browser-storage/index.js +1 -1
  12. package/dist/cjs/plugins/responses-browser-storage/index.js +1 -1
  13. package/dist/cjs/plugins/telemetry/index.js +1 -1
  14. package/dist/cjs/server/index.js +1 -1
  15. package/dist/cjs/storage.js +1 -0
  16. package/dist/dom-7g2LZCIp.cjs +1 -0
  17. package/dist/{dom-BqcToNL0.js → dom-v6ulxr_z.js} +1 -5
  18. package/dist/esm/form/index.js +5 -16
  19. package/dist/esm/index.js +465 -505
  20. package/dist/esm/logic-engine.js +208 -0
  21. package/dist/esm/plugins/dom-observer/index.js +1 -1
  22. package/dist/esm/plugins/dynamic-experiences/index.js +4 -4
  23. package/dist/esm/plugins/experience-browser-storage/index.js +12 -10
  24. package/dist/esm/plugins/responses-browser-storage/index.js +2 -6
  25. package/dist/esm/plugins/telemetry/index.js +26 -15
  26. package/dist/esm/preview/index.js +1 -2
  27. package/dist/esm/server/index.js +40 -36
  28. package/dist/esm/storage.js +1 -0
  29. package/dist/{experience-instance-B9S6Yf0N.js → experience-instance-4D6Yk-h0.js} +323 -260
  30. package/dist/experience-instance-D2FAkiPx.cjs +1 -0
  31. package/dist/plugin-CVLK5ZLV.cjs +1 -0
  32. package/dist/plugin-C_cLCzXK.js +256 -0
  33. package/dist/preview-channel-BMOEreho.cjs +1 -0
  34. package/dist/{preview-channel-CSr96XAo.js → preview-channel-CLXVoL_j.js} +2 -5
  35. package/dist/preview-unavailable-BAhTGDAp.cjs +1 -0
  36. package/dist/{version-CPKulHMH.js → preview-unavailable-OHRfSIId.js} +100 -61
  37. package/dist/provider-BFZgizAt.cjs +1 -0
  38. package/dist/provider-dD92LNPP.js +115 -0
  39. package/dist/{rules-logic-HesIUCu6.js → rules-logic-9hh8y_1b.js} +1 -1
  40. package/dist/rules-logic-VUbvWqdi.cjs +1 -0
  41. package/dist/types/data-source/preview-unavailable.d.ts +18 -0
  42. package/dist/types/data-source/preview-unavailable.d.ts.map +1 -0
  43. package/dist/types/data-source/provider.d.ts +5 -0
  44. package/dist/types/data-source/provider.d.ts.map +1 -1
  45. package/dist/types/data-source/request-observer.d.ts +21 -8
  46. package/dist/types/data-source/request-observer.d.ts.map +1 -1
  47. package/dist/types/entities/action/action.d.ts +94 -23
  48. package/dist/types/entities/action/action.d.ts.map +1 -1
  49. package/dist/types/entities/experience-instance/experience-instance.d.ts +14 -1
  50. package/dist/types/entities/experience-instance/experience-instance.d.ts.map +1 -1
  51. package/dist/types/exports.d.ts +1 -0
  52. package/dist/types/exports.d.ts.map +1 -1
  53. package/dist/types/index.d.ts +2 -2
  54. package/dist/types/index.d.ts.map +1 -1
  55. package/dist/types/lifecycle/rules-logic.d.ts.map +1 -1
  56. package/dist/types/logic-engine.d.ts +9 -0
  57. package/dist/types/logic-engine.d.ts.map +1 -1
  58. package/dist/types/picked.d.ts +38 -8
  59. package/dist/types/picked.d.ts.map +1 -1
  60. package/dist/types/plugins/dynamic-experiences/index.d.ts +1 -0
  61. package/dist/types/plugins/dynamic-experiences/index.d.ts.map +1 -1
  62. package/dist/types/plugins/dynamic-experiences/plugin.d.ts.map +1 -1
  63. package/dist/types/plugins/dynamic-experiences/types.d.ts +5 -2
  64. package/dist/types/plugins/dynamic-experiences/types.d.ts.map +1 -1
  65. package/dist/types/plugins/experience-browser-storage/plugin.d.ts.map +1 -1
  66. package/dist/types/plugins/telemetry/plugin.d.ts +2 -0
  67. package/dist/types/plugins/telemetry/plugin.d.ts.map +1 -1
  68. package/dist/types/schema-registry.d.ts +34 -0
  69. package/dist/types/schema-registry.d.ts.map +1 -1
  70. package/dist/types/server/serialize.d.ts +1 -0
  71. package/dist/types/server/serialize.d.ts.map +1 -1
  72. package/dist/types/storage.d.ts +6 -0
  73. package/dist/types/storage.d.ts.map +1 -0
  74. package/dist/types/typed-content.d.ts +14 -1
  75. package/dist/types/typed-content.d.ts.map +1 -1
  76. package/dist/types/utils/events.d.ts +4 -0
  77. package/dist/types/utils/events.d.ts.map +1 -1
  78. package/dist/types/utils/rules-logic.d.ts +3 -2
  79. package/dist/types/utils/rules-logic.d.ts.map +1 -1
  80. package/dist/types/utils/search-params.d.ts +20 -0
  81. package/dist/types/utils/search-params.d.ts.map +1 -1
  82. package/package.json +39 -13
  83. package/dist/api-Ctvh1qkk.cjs +0 -1
  84. package/dist/docs/_root.css +0 -101
  85. package/dist/docs/explanation/conditions-and-the-logic-engine.md +0 -94
  86. package/dist/docs/explanation/content-references.md +0 -99
  87. package/dist/docs/explanation/feature-flag-allocation.md +0 -218
  88. package/dist/docs/explanation/how-picked-works.md +0 -124
  89. package/dist/docs/explanation/how-pickedql-works.md +0 -76
  90. package/dist/docs/explanation/pages-and-flows.md +0 -64
  91. package/dist/docs/explanation/the-content-model.md +0 -87
  92. package/dist/docs/explanation/the-two-apis.md +0 -68
  93. package/dist/docs/explanation/why-server-side-rendering.md +0 -76
  94. package/dist/docs/explanation/workspaces-and-versions.md +0 -71
  95. package/dist/docs/how-to/add-a-step-field-or-action.md +0 -43
  96. package/dist/docs/how-to/analytics/index.md +0 -316
  97. package/dist/docs/how-to/archive-or-delete-a-workspace.md +0 -46
  98. package/dist/docs/how-to/authenticate-the-cli.md +0 -97
  99. package/dist/docs/how-to/authenticate-with-a-magic-link.md +0 -40
  100. package/dist/docs/how-to/authenticate-with-a-password.md +0 -51
  101. package/dist/docs/how-to/authenticate-with-an-api-key.md +0 -51
  102. package/dist/docs/how-to/authenticate-with-oauth.md +0 -40
  103. package/dist/docs/how-to/build-a-flow.md +0 -83
  104. package/dist/docs/how-to/connect-the-mcp-server.md +0 -38
  105. package/dist/docs/how-to/create-a-content-entry.md +0 -48
  106. package/dist/docs/how-to/create-a-project.md +0 -29
  107. package/dist/docs/how-to/create-an-experience.md +0 -42
  108. package/dist/docs/how-to/create-and-revoke-an-api-key.md +0 -42
  109. package/dist/docs/how-to/debug-with-the-chrome-extension.md +0 -57
  110. package/dist/docs/how-to/define-a-page-layout.md +0 -46
  111. package/dist/docs/how-to/fill-and-publish-a-page.md +0 -66
  112. package/dist/docs/how-to/install-the-gtm-template.md +0 -84
  113. package/dist/docs/how-to/install-the-sdk.md +0 -93
  114. package/dist/docs/how-to/install-the-vite-plugin.md +0 -69
  115. package/dist/docs/how-to/invite-and-remove-members.md +0 -35
  116. package/dist/docs/how-to/point-one-entry-at-another.md +0 -61
  117. package/dist/docs/how-to/preview-a-workspace.md +0 -28
  118. package/dist/docs/how-to/publish-a-workspace.md +0 -30
  119. package/dist/docs/how-to/read-a-feature-flag.md +0 -113
  120. package/dist/docs/how-to/read-a-referenced-entry.md +0 -109
  121. package/dist/docs/how-to/register-a-component.md +0 -55
  122. package/dist/docs/how-to/register-an-action-handler.md +0 -67
  123. package/dist/docs/how-to/render-a-step-form.md +0 -131
  124. package/dist/docs/how-to/render-an-unpublished-preview.md +0 -41
  125. package/dist/docs/how-to/reuse-a-section.md +0 -53
  126. package/dist/docs/how-to/reuse-a-step-field-or-action.md +0 -28
  127. package/dist/docs/how-to/roll-back-a-published-version.md +0 -26
  128. package/dist/docs/how-to/run-an-ab-test.md +0 -49
  129. package/dist/docs/how-to/run-code-on-a-form-submission.md +0 -125
  130. package/dist/docs/how-to/server-render-a-page.md +0 -81
  131. package/dist/docs/how-to/set-a-content-security-policy.md +0 -32
  132. package/dist/docs/how-to/set-up-mfa.md +0 -69
  133. package/dist/docs/how-to/switch-workspaces.md +0 -122
  134. package/dist/docs/how-to/upload-and-use-an-asset.mdx +0 -73
  135. package/dist/docs/how-to/validate-a-field.md +0 -52
  136. package/dist/docs/how-to/write-a-condition.md +0 -45
  137. package/dist/docs/how-to/write-a-predicate.md +0 -60
  138. package/dist/docs/index.md +0 -59
  139. package/dist/docs/reference/dashboard/actions.mdx +0 -53
  140. package/dist/docs/reference/dashboard/api-keys.mdx +0 -38
  141. package/dist/docs/reference/dashboard/conditions.mdx +0 -42
  142. package/dist/docs/reference/dashboard/content/asset-library.mdx +0 -63
  143. package/dist/docs/reference/dashboard/content/blocks.mdx +0 -57
  144. package/dist/docs/reference/dashboard/content/content-entries.mdx +0 -95
  145. package/dist/docs/reference/dashboard/content/models.mdx +0 -108
  146. package/dist/docs/reference/dashboard/content/pages.mdx +0 -61
  147. package/dist/docs/reference/dashboard/experiences.mdx +0 -51
  148. package/dist/docs/reference/dashboard/features.mdx +0 -154
  149. package/dist/docs/reference/dashboard/fields.mdx +0 -106
  150. package/dist/docs/reference/dashboard/flow-builder/canvas.mdx +0 -58
  151. package/dist/docs/reference/dashboard/flow-builder/condition-builder.md +0 -57
  152. package/dist/docs/reference/dashboard/flow-builder/keyboard-shortcuts.md +0 -72
  153. package/dist/docs/reference/dashboard/flow-builder/nodes.md +0 -63
  154. package/dist/docs/reference/dashboard/projects.mdx +0 -44
  155. package/dist/docs/reference/dashboard/reports.mdx +0 -43
  156. package/dist/docs/reference/dashboard/steps.mdx +0 -37
  157. package/dist/docs/reference/dashboard/team-management.md +0 -29
  158. package/dist/docs/reference/dashboard/workspace-versioning.mdx +0 -30
  159. package/dist/docs/reference/dashboard/workspaces.mdx +0 -76
  160. package/dist/docs/reference/delivery-api/experience-content.md +0 -152
  161. package/dist/docs/reference/delivery-api/index.md +0 -45
  162. package/dist/docs/reference/delivery-api/preview-caching-crawling.md +0 -79
  163. package/dist/docs/reference/delivery-api/project-config.md +0 -65
  164. package/dist/docs/reference/delivery-api/workspace-schema.md +0 -85
  165. package/dist/docs/reference/glossary.md +0 -181
  166. package/dist/docs/reference/management-api/authentication.md +0 -74
  167. package/dist/docs/reference/management-api/authorization-and-scopes.md +0 -285
  168. package/dist/docs/reference/management-api/error-handling.md +0 -233
  169. package/dist/docs/reference/management-api/pagination.md +0 -192
  170. package/dist/docs/reference/pickedql/data-sources.md +0 -174
  171. package/dist/docs/reference/pickedql/dimensions.md +0 -103
  172. package/dist/docs/reference/pickedql/filtering.md +0 -64
  173. package/dist/docs/reference/pickedql/index.md +0 -18
  174. package/dist/docs/reference/pickedql/schema.md +0 -172
  175. package/dist/docs/reference/pickedql/virtual-functions.md +0 -248
  176. package/dist/docs/reference/sdk/actions.md +0 -30
  177. package/dist/docs/reference/sdk/analytics-events.md +0 -445
  178. package/dist/docs/reference/sdk/conditions.md +0 -147
  179. package/dist/docs/reference/sdk/content-security-policy.md +0 -21
  180. package/dist/docs/reference/sdk/content.md +0 -213
  181. package/dist/docs/reference/sdk/experiences.md +0 -51
  182. package/dist/docs/reference/sdk/features.md +0 -256
  183. package/dist/docs/reference/sdk/fields.md +0 -255
  184. package/dist/docs/reference/sdk/index.md +0 -68
  185. package/dist/docs/reference/sdk/plugins/create-experience.md +0 -123
  186. package/dist/docs/reference/sdk/plugins/dynamic-experiences.md +0 -74
  187. package/dist/docs/reference/sdk/plugins/index.md +0 -29
  188. package/dist/docs/reference/sdk/plugins/window-object.md +0 -25
  189. package/dist/docs/reference/sdk/predicates.md +0 -43
  190. package/dist/docs/reference/sdk/ssr/index.md +0 -33
  191. package/dist/docs/reference/sdk/ssr/rendering-and-hydration.md +0 -103
  192. package/dist/docs/reference/sdk/ssr/serialize.md +0 -80
  193. package/dist/docs/reference/sdk/ssr/slots-and-placements.md +0 -59
  194. package/dist/docs/reference/sdk/steps.md +0 -86
  195. package/dist/docs/reference/sdk/type-generation.md +0 -196
  196. package/dist/docs/reference/tools/chrome-extension.md +0 -16
  197. package/dist/docs/reference/tools/cli.md +0 -146
  198. package/dist/docs/reference/tools/image-optimisation-service.md +0 -104
  199. package/dist/docs/reference/tools/mcp.md +0 -90
  200. package/dist/docs/reference/tools/vite-plugin.md +0 -163
  201. package/dist/docs/tutorials/first-api-call.md +0 -228
  202. package/dist/docs/tutorials/first-experience-in-the-dashboard.mdx +0 -143
  203. package/dist/docs/tutorials/first-experience.mdx +0 -254
  204. package/dist/docs/tutorials/first-server-rendered-page.mdx +0 -186
  205. package/dist/dom-DlLH3FxV.cjs +0 -1
  206. package/dist/experience-instance-D8rOg6We.cjs +0 -1
  207. package/dist/plugin-ChafFq6S.js +0 -194
  208. package/dist/plugin-Dn25Gffy.cjs +0 -1
  209. package/dist/preview-channel-Cx0e6fye.cjs +0 -1
  210. package/dist/provider-B8wvmeC8.js +0 -98
  211. package/dist/provider-BBLlQOjV.cjs +0 -1
  212. package/dist/rules-logic-CGZIYgAI.cjs +0 -1
  213. package/dist/version-CLjPfmxk.cjs +0 -1
@@ -1,58 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../../components/Screenshot'
7
-
8
- # Flow builder
9
-
10
- The flow builder is a visual editor for an experience flow. You drag a block onto a
11
- canvas, connect the blocks with arrows, and set the options of each node in an
12
- inspector panel.
13
-
14
- <Screenshot
15
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences/{experienceId}"
16
- alt="The flow builder with the library, canvas, and inspector panels"
17
- />
18
-
19
- ## Layout
20
-
21
- The flow builder has three panels, from left to right.
22
-
23
- **Library**, on the left: it lists every step, action, condition, and field in
24
- your project. Drag an item from here onto the canvas.
25
-
26
- **Canvas**, in the middle: the area where you build your flow. A node stands for a
27
- block. An arrow stands for a connection between two blocks.
28
-
29
- **Inspector**, on the right: it shows the options of the node that you choose. When
30
- you choose no node, it shows the settings of the experience.
31
-
32
- ## Panel controls
33
-
34
- Drag a divider between two panels to change their size. Press `Cmd/Ctrl+\` to turn
35
- both side panels on and off. Press `Cmd/Ctrl+Shift+\` to turn the inspector on and
36
- off.
37
-
38
- ## Move around the canvas
39
-
40
- **Zoom**: scroll to make the view larger or smaller.
41
-
42
- **Pan**: choose the hand tool with `H`, then drag. You can also hold `Space` and
43
- drag. A drag with the middle mouse button also pans.
44
-
45
- **Choose tool**: press `V` to go back to the default tool.
46
- Click to choose a node. Drag on empty space to choose every node inside a rectangle.
47
-
48
- ## Auto-layout
49
-
50
- Click the auto-layout button in the toolbar. The flow builder then arranges every
51
- node into a clean hierarchy. This is useful after you add many nodes, and when the
52
- canvas becomes messy.
53
-
54
- ## Related
55
-
56
- - [How to build a flow](/how-to/build-a-flow) — add, connect, and branch.
57
- - [Keyboard shortcuts](/reference/dashboard/flow-builder/keyboard-shortcuts)
58
- - [Nodes](/reference/dashboard/flow-builder/nodes)
@@ -1,57 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- # Condition builder
7
-
8
- The condition builder is a visual rule editor, and the dashboard uses it in several
9
- places. With it you define a rule and you write no code.
10
-
11
- ## Where it appears
12
-
13
- The dashboard uses the condition builder here:
14
-
15
- - **Condition nodes** — they set which branch the flow takes in the
16
- [flow builder](/reference/dashboard/flow-builder/canvas).
17
- - **Experience conditions** — they control when an experience starts for a visitor.
18
- - **Initialize open conditions** — they control when an experience opens by itself as
19
- the page loads.
20
- - **Field option conditions** — they show or hide one option, and the state of the
21
- visitor decides which.
22
-
23
- ## Rule structure
24
-
25
- The builder holds your rules in groups. Each group uses **AND** or **OR**. With
26
- **AND**, every rule must match. With **OR**, one rule must match.
27
-
28
- A single rule has three parts:
29
-
30
- 1. **Field** — the data source to evaluate.
31
- 2. **Operator** — how to compare. Examples are equals, not equals, greater than, and
32
- contains.
33
- 3. **Value** — the value to compare against.
34
-
35
- You can put a group inside another group to build a larger rule. An example is an AND
36
- group that holds two OR groups.
37
-
38
- ## Data sources
39
-
40
- A rule can point at these data sources:
41
-
42
- **Responses** — the values that your visitors send through the form fields of the
43
- current experience. Each field that you create in your project appears here under its
44
- name.
45
-
46
- **Actions** — the actions that ran during the flow.
47
-
48
- **Feature flags** — the state of each feature flag in your project. Use it to take a
49
- branch on whether Picked allocates a visitor to a flag.
50
-
51
- **Location** — the parts of the current page URL of the visitor. These are the
52
- pathname, the search parameters, the hostname, and the hash.
53
-
54
- ## Related
55
-
56
- - [How to write a condition](/how-to/write-a-condition) — a worked example.
57
- - [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine)
@@ -1,72 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- # Keyboard shortcuts
7
-
8
- These shortcuts work when the canvas of the flow builder holds the keyboard input.
9
-
10
- ## Canvas tools
11
-
12
- | Shortcut (Mac) | Shortcut (PC) | Action |
13
- | --- | --- | --- |
14
- | `V` | `V` | The choose tool |
15
- | `H` | `H` | The hand tool, which pans the view |
16
- | `Space`, held | `Space`, held | The hand tool, while you hold the key |
17
-
18
- ## Layout
19
-
20
- | Shortcut (Mac) | Shortcut (PC) | Action |
21
- | --- | --- | --- |
22
- | `Shift+L` | `Shift+L` | Auto-layout |
23
-
24
- ## Choice
25
-
26
- | Shortcut (Mac) | Shortcut (PC) | Action |
27
- | --- | --- | --- |
28
- | `Cmd+A` | `Ctrl+A` | Choose every node |
29
- | `Escape` | `Escape` | Choose no node |
30
-
31
- ## Edits
32
-
33
- | Shortcut (Mac) | Shortcut (PC) | Action |
34
- | --- | --- | --- |
35
- | `Cmd+D` | `Ctrl+D` | Make a copy of each chosen node |
36
- | `Delete` or `Backspace` | `Delete` or `Backspace` | Delete each chosen node |
37
- | `Cmd+Z` | `Ctrl+Z` | Undo |
38
- | `Cmd+Shift+Z` | `Ctrl+Shift+Z` | Redo |
39
-
40
- ## Movement
41
-
42
- | Shortcut (Mac) | Shortcut (PC) | Action |
43
- | --- | --- | --- |
44
- | Arrow keys | Arrow keys | Move each chosen node a small distance |
45
- | `Shift` and an arrow key | `Shift` and an arrow key | Move each chosen node further |
46
-
47
- ## Zoom
48
-
49
- | Shortcut (Mac) | Shortcut (PC) | Action |
50
- | --- | --- | --- |
51
- | Scroll | Scroll | Zoom in or out |
52
- | Pinch | Pinch | Zoom in or out, on a trackpad |
53
- | `Cmd+=` | `Ctrl+=` | Zoom in |
54
- | `Cmd+-` | `Ctrl+-` | Zoom out |
55
- | `Shift+1` | `Shift+1` | Fit the flow to the view |
56
- | `Shift+0` | `Shift+0` | Zoom to 100% |
57
-
58
- ## Panels
59
-
60
- | Shortcut (Mac) | Shortcut (PC) | Action |
61
- | --- | --- | --- |
62
- | `Cmd+\` | `Ctrl+\` | Turn both side panels on or off |
63
- | `?` | `?` | Turn this shortcut list on or off |
64
-
65
- ---
66
-
67
- [Overview](/reference/dashboard/flow-builder/canvas) · [Nodes](/reference/dashboard/flow-builder/nodes) · [Build Flows](/how-to/build-a-flow) · **Keyboard Shortcuts** · [Condition Builder](/reference/dashboard/flow-builder/condition-builder)
68
-
69
- ## Related
70
-
71
- - [How to build a flow](/how-to/build-a-flow)
72
- - [Canvas](/reference/dashboard/flow-builder/canvas) — the panels and the view controls.
@@ -1,63 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- # Nodes
7
-
8
- A node is one part of a flow. Each node stands for a block in your experience. There
9
- are four node types.
10
-
11
- ## Origin
12
-
13
- Every flow starts with an origin node. It is a gray circle on the left side of the
14
- canvas, and it has one output handle on its right side.
15
-
16
- You cannot move the origin, delete it, or make a copy of it. It is always there.
17
-
18
- ## Step
19
-
20
- A step node stands for a screen that a visitor sees. It appears as a blue rectangle
21
- on the canvas.
22
-
23
- A step holds fields. Drag a field from the library onto a step node to assign
24
- it. The subtitle of the node gives the number of assigned fields.
25
-
26
- Each step has a `layoutName`. It tells the SDK which visual layout to use for this
27
- step. Set the layout name in the inspector.
28
-
29
- ## Action
30
-
31
- An action node stands for a side effect. A side effect happens where the visitor
32
- cannot see it. The node appears as a green rectangle.
33
-
34
- An action runs when the flow reaches it. Use an action to record an event, to send
35
- data, or to start an integration.
36
-
37
- ## Condition
38
-
39
- A condition node stands for a point where the flow splits. It appears as an amber
40
- rectangle.
41
-
42
- A condition node has two output handles, and not one. The green handle at the top
43
- right connects to the path for a true result. The red handle at the bottom right
44
- connects to the path for a false result.
45
-
46
- Define the rule in the inspector, with the visual condition builder. See
47
- [Conditions](/reference/dashboard/conditions) for more detail.
48
-
49
- ## Handles
50
-
51
- A handle is a connection point on a node. An input handle is on the left. An output
52
- handle is on the right. Drag from an output handle to an input handle to connect two
53
- nodes.
54
-
55
- ---
56
-
57
- [Overview](/reference/dashboard/flow-builder/canvas) · **Nodes** · [Build Flows](/how-to/build-a-flow) · [Keyboard Shortcuts](/reference/dashboard/flow-builder/keyboard-shortcuts) · [Condition Builder](/reference/dashboard/flow-builder/condition-builder)
58
-
59
- ## Related
60
-
61
- - [How to build a flow](/how-to/build-a-flow)
62
- - [Canvas](/reference/dashboard/flow-builder/canvas)
63
- - [About how Picked works](/explanation/how-picked-works) — why a flow is a graph.
@@ -1,44 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Projects
9
-
10
- A project is one site or one application that you want to measure with Picked. Each
11
- project has its own experiences, content, and options.
12
-
13
- <Screenshot
14
- route="/{orgSlug}"
15
- alt="The organization home page on the Picked dashboard, with the projects in an organization"
16
- />
17
-
18
- ## Workspaces
19
-
20
- Each project holds one or more [Workspaces](/reference/dashboard/workspaces). In a workspace you set the
21
- options for an experience and you see a preview of it before you make it live.
22
-
23
- ## Project home
24
-
25
- When you open a project, you land on the project home page. It shows your SDK
26
- snippet and a list of the setup tasks that are still open.
27
-
28
- Copy the snippet and add it to your site. The snippet connects your site to the
29
- project and lets Picked serve experiences to it. See
30
- [SDK Installation](/reference/sdk) for the setup detail.
31
-
32
- ## Project navigation
33
-
34
- The sidebar shows the sections of your project: **Feature flags**, **Fields**, **Flows**,
35
- **Pages**, and **Workspace settings**. **Flows** holds **Step Layouts**, and **Pages**
36
- holds **Page Layouts** and **Sections**.
37
-
38
- A step, an action, and a condition have no sidebar entry. You reach all three from the
39
- library in the flow builder, because each one belongs to a flow.
40
-
41
- ## Related
42
-
43
- - [How to create a project](/how-to/create-a-project)
44
- - [How to install the SDK](/how-to/install-the-sdk)
@@ -1,43 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Reports
9
-
10
- A report is an embedded Metabase dashboard or question, attached to a Picked project. Use
11
- a report to see how your visitors move through your experiences and your feature flags.
12
-
13
- <Screenshot
14
- route="/{orgSlug}/{projectId}/reports"
15
- alt="The reports list for a project on the Picked dashboard"
16
- />
17
-
18
- ## Report options
19
-
20
- | Option | Description |
21
- | --- | --- |
22
- | **Report name** | The name that the reports list shows. |
23
- | **Description** | An optional note about what the report shows. |
24
- | **Metabase report type** | `Dashboard` or `Question`. |
25
- | **Metabase report ID** | The numeric ID from the Metabase URL. |
26
- | **Display order** | Optional. It controls the position of the report in the list. |
27
-
28
- The create form has a link that opens the report, so you can check that the ID is
29
- correct before you save.
30
-
31
- ## Permissions
32
-
33
- A member needs permission in the organization to create, edit, or delete a report. The
34
- dashboard hides those actions from a member without it.
35
-
36
- ## Delete a report
37
-
38
- Open the report settings page and click **Delete report**. You cannot reverse a delete.
39
-
40
- ## Related
41
-
42
- - [Analytics queries](/how-to/analytics) — query the same data with SQL.
43
- - [About PickedQL](/explanation/how-pickedql-works) — what the query layer expands.
@@ -1,37 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Steps
9
-
10
- A step is one screen or card that a visitor sees during an experience. Each step
11
- holds one or more fields. A field collects data or shows content.
12
-
13
- <Screenshot
14
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/steps"
15
- alt="The steps list for a workspace on the Picked dashboard"
16
- />
17
-
18
- ## Set up a step
19
-
20
- **Name**: The name that the dashboard shows. Your visitors do not see it.
21
-
22
- **Key**: The identifier that your application uses for this step. Your
23
- visitors do not see it.
24
-
25
- **Layout Name**: The name of the component layout that renders this step. Examples
26
- are `card`, `modal`, and `fullscreen`.
27
-
28
- A step can also carry a **Step Layout**. A step layout is a reusable CMS schema, and
29
- it gives the step a Content Entry. See [Models](/reference/dashboard/content/models).
30
-
31
- ## Related
32
-
33
- - [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
34
-
35
- - [How to build a flow](/how-to/build-a-flow) — add a step and assign fields to it.
36
- - [How to reuse a step, a field, or an action](/how-to/reuse-a-step-field-or-action)
37
- - [Models](/reference/dashboard/content/models) — the step layout schema.
@@ -1,29 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- # Team management
7
-
8
- Control who can reach your organization and what each person can do. An organization
9
- is the top-level container for your projects and members.
10
-
11
- ## Organizations
12
-
13
- An organization groups your projects, your members, and your settings. You can belong
14
- to more than one organization.
15
-
16
- To move between organizations, use the organization control at the top of the
17
- sidebar.
18
-
19
- ## Roles and permissions
20
-
21
- Each member holds a role, and the role controls what the member can reach. A role
22
- decides whether a member can create a project, edit an experience, control other
23
- members, or read a report.
24
-
25
- Give each member the smallest role that the work of that member needs.
26
-
27
- ## Related
28
-
29
- - [How to invite and remove members](/how-to/invite-and-remove-members)
@@ -1,30 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Workspace versioning
9
-
10
- When you publish, Picked makes an immutable snapshot of your workspace. A project
11
- always serves exactly one version, the *live* version. A roll-back moves the live
12
- pointer of the project to an earlier snapshot. It changes no data.
13
-
14
- <Screenshot
15
- route="/{orgSlug}/{projectId}/publish-history"
16
- alt="The Publish history page with published workspace versions and the Live and Restore actions"
17
- hide={['[data-testid="version-row-relative-time"]']}
18
- />
19
-
20
- ## Publish history
21
-
22
- The **Publish history** page lists each published version of every workspace in the
23
- project, the newest first. The version that Picked serves now carries a **Live**
24
- badge.
25
-
26
- ## Related
27
-
28
- - [About workspaces and versions](/explanation/workspaces-and-versions) — why a roll-back
29
- changes no data.
30
- - [How to roll back a published version](/how-to/roll-back-a-published-version)
@@ -1,76 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Workspaces
9
-
10
- A workspace is one version of the configuration of your project. Use a workspace to hold
11
- a change, to see a preview of it, and to publish it when it is ready.
12
-
13
- <Screenshot
14
- route="/{orgSlug}/{projectId}/workspaces"
15
- alt="The workspaces list inside a project on the Picked dashboard"
16
- hide={['[data-testid="workspace-row-relative-time"]']}
17
- />
18
-
19
- ## How workspaces work
20
-
21
- Each project has a workspace that holds your experiences, feature flags, steps, fields,
22
- actions, and conditions. When you make a change in the dashboard, that change stays in
23
- the workspace until you publish it. A change to a flow, to a feature flag, or to a step
24
- all behave the same way.
25
-
26
- A workspace is in one of three states:
27
-
28
- - **Live** — the workspace that the SDK serves to your visitors. Each project has
29
- exactly one live workspace.
30
- - **Draft** — a workspace that no visitor sees. You can edit a draft, see a preview
31
- of it, and publish it to make it live.
32
- - **Archived** — a draft that you put to one side. An archived workspace is still
33
- editable, but it does not appear in the default workspaces list.
34
-
35
- ## Change previews
36
-
37
- The publish modal shows a side-by-side change preview. It compares the current
38
- workspace against the last published snapshot. Use it to see exactly what your
39
- visitors get after you publish.
40
-
41
- <Screenshot
42
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences?action=publish"
43
- alt="The publish modal with a change preview of added experiences, steps, and conditions"
44
- selector='[role="dialog"]'
45
- wait='[role="dialog"]'
46
- hide={['[data-testid="publish-diff-replaces-version"]']}
47
- renderWidth={720}
48
- renderHeight={579}
49
- />
50
-
51
- The preview puts the changes into groups: experiences, feature flags, steps, fields,
52
- actions, and conditions. Each row shows whether the record was **added**, **removed**,
53
- or **modified**. For a modified record, expand the row to see which properties changed.
54
-
55
- Some changes break other records. An example is a field that you remove while other
56
- steps still point at it. The change preview shows a banner above the diff for these
57
- entries, so that you can look at them again before you publish.
58
-
59
- The first publish of a workspace has no earlier snapshot to compare against. The
60
- publish modal shows the contents of the workspace as the first publish, with no diff.
61
-
62
- ## Unpublished changes
63
-
64
- The workspace records whether anything changed since the last publish. The toolbar then
65
- shows a warning badge. It counts a change to any of these:
66
-
67
- - An experience or a feature flag.
68
- - A step, a field, an action, or a condition.
69
-
70
- ## Related
71
-
72
- - [About workspaces and versions](/explanation/workspaces-and-versions) — why a draft and
73
- a version are separate.
74
- - [How to see a preview of a workspace](/how-to/preview-a-workspace)
75
- - [How to publish a workspace](/how-to/publish-a-workspace)
76
- - [How to archive or delete a workspace](/how-to/archive-or-delete-a-workspace)
@@ -1,152 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- # Experience Content Endpoint
7
-
8
- Fetch the content entries that back the steps of a single experience.
9
-
10
- ## Request
11
-
12
- ```
13
- GET /api/v1/projects/:projectId/experiences/:id/content
14
- ```
15
-
16
- | Parameter | In | Description |
17
- | --- | --- | --- |
18
- | `projectId` | path | The project the experience belongs to. |
19
- | `id` | path | The experience to fetch content for. |
20
- | `preview_token` | query | Optional. With it, the endpoint returns preview content, which is unpublished. |
21
-
22
- ## Response
23
-
24
- ```json
25
- {
26
- "experienceId": "exp_123",
27
- "versionId": "ver_456",
28
- "content": [
29
- {
30
- "id": "entry_789",
31
- "contentModelKey": "page-hero",
32
- "data": {
33
- "title": "Spring sale",
34
- "category": { "contentEntryId": "entry_42", "contentModelKey": "category" }
35
- }
36
- }
37
- ],
38
- "references": [
39
- {
40
- "id": "entry_42",
41
- "contentModelKey": "category",
42
- "data": { "name": "Outerwear" }
43
- }
44
- ]
45
- }
46
- ```
47
-
48
- | Field | Type | Description |
49
- | --- | --- | --- |
50
- | `experienceId` | `string` | The experience the content belongs to. |
51
- | `versionId` | `string \| null` | The published version id, or `null` on preview. |
52
- | `content[]` | `array` | The entries that the steps of the experience point at. |
53
- | `content[].id` | `string` | The content entry id. |
54
- | `content[].contentModelKey` | `string \| null` | The Key of the Model, or `null` when it cannot be resolved. |
55
- | `content[].data` | `object` | The entry data. It matches the schema of the Model. |
56
- | `references[]` | `array` | Every entry that a `reference` field reaches, in the same blob shape as `content[]`. |
57
-
58
- The published response and the preview response hold the same fields, and the same
59
- values, for the same content.
60
-
61
- ## A reference field points at a separate blob
62
-
63
- A [Reference field](/reference/dashboard/content/models#reference-fields) arrives as a
64
- pointer, and not as the entry:
65
-
66
- ```json
67
- { "contentEntryId": "entry_42", "contentModelKey": "category" }
68
- ```
69
-
70
- A repeatable Reference field arrives as an array of such pointers.
71
-
72
- The entry itself arrives in `references[]` under its own `id`. Look the pointer up
73
- there. The SDK does this for you, through
74
- [`useReference` and `getReference`](/reference/sdk/content).
75
-
76
- `references[]` holds each entry one time, for any number of fields that point at it. It
77
- omits the entries that are in `content[]` already.
78
-
79
- ### What `references[]` omits
80
-
81
- Picked resolves a chain of references to a maximum depth of 5. It counts the depth from
82
- the entries in `content[]`. An entry is absent from `references[]` when Picked cannot
83
- resolve it:
84
-
85
- | Cause | Result |
86
- | --- | --- |
87
- | The target was deleted | The pointer stays. The entry is absent. |
88
- | The target is in another workspace | The pointer stays. The entry is absent. |
89
- | The chain makes a cycle | The pointer stays. The entry is absent. |
90
- | The chain is deeper than 5 | The pointer stays, with its `contentModelKey`. The entry is absent. |
91
-
92
- A pointer with no entry in `references[]` means that there is no such entry. Picked sends
93
- no empty blob for it.
94
-
95
- :::warning
96
- A reference pointer also carries a `data` field with the content of the target inlined.
97
- This is for the SDK versions that came before `references[]`. Read `references[]`
98
- instead. A later release removes the inline copy.
99
- :::
100
-
101
- ## An HTML asset comes back in the response
102
-
103
- A Model can have an [HTML asset](/reference/dashboard/content/asset-library) field. The
104
- value of that field arrives inside the response. The endpoint changes the reference to
105
- `{ id, content }`. There, `content` holds the HTML that you uploaded, as a string. It
106
- is `null` when the endpoint cannot resolve it:
107
-
108
- ```json
109
- {
110
- "id": "entry_789",
111
- "contentModelKey": "page-hero",
112
- "data": {
113
- "markup": { "id": "asset_42", "content": "<section>...</section>" }
114
- }
115
- }
116
- ```
117
-
118
- The SDK renders the inlined HTML directly, with no extra storage fetch.
119
-
120
- ## Status codes
121
-
122
- | Code | Meaning |
123
- | --- | --- |
124
- | `200` | Success. |
125
- | `401` | Invalid `preview_token`. |
126
- | `404` | The experience has no published content. |
127
-
128
- ## Example
129
-
130
- ```bash
131
- curl https://api.picked.app/api/v1/projects/proj_123/experiences/exp_123/content
132
- ```
133
-
134
- ```json
135
- {
136
- "experienceId": "exp_123",
137
- "versionId": "ver_456",
138
- "content": [
139
- { "id": "entry_789", "contentModelKey": "page-hero", "data": { "title": "Spring sale" } }
140
- ],
141
- "references": []
142
- }
143
- ```
144
-
145
- ## Related
146
-
147
- - [About the two APIs](/explanation/the-two-apis)
148
- - [About content references](/explanation/content-references) — why a reference is a pointer.
149
- - [Content](/reference/sdk/content) — how the SDK resolves a pointer.
150
- - [Project config](/reference/delivery-api/project-config) — the endpoint that links a step to an entry.
151
- - [Server Snapshot](/reference/sdk/ssr/serialize) — how the SDK reads this content.
152
- - [Preview, cache, and crawlers](/reference/delivery-api/preview-caching-crawling)