@picked/client 0.0.1-dev.1788925875333 → 0.0.1-dev.1793753513002

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 (226) hide show
  1. package/LICENSE +1 -0
  2. package/README.md +34 -158
  3. package/dist/.tsbuildinfo +1 -1
  4. package/dist/api-ZkaFvphK.cjs +1 -0
  5. package/dist/{api-DbMJli3H.js → api-nJ3O-8r5.js} +1 -1
  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 +576 -615
  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 +47 -43
  28. package/dist/esm/storage.js +1 -0
  29. package/dist/experience-instance-4D6Yk-h0.js +774 -0
  30. package/dist/experience-instance-D2FAkiPx.cjs +1 -0
  31. package/dist/plugin-B1kexnbX.js +256 -0
  32. package/dist/plugin-Bnmk8pN8.cjs +1 -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/{version-VvasRUfR.js → preview-unavailable-BaHYVZQD.js} +100 -61
  36. package/dist/preview-unavailable-ClBw_DDY.cjs +1 -0
  37. package/dist/provider-BFdnIgeH.cjs +1 -0
  38. package/dist/provider-C98VWkEj.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/experience.d.ts +8 -0
  50. package/dist/types/entities/experience/experience.d.ts.map +1 -1
  51. package/dist/types/entities/experience-instance/experience-instance.d.ts +14 -1
  52. package/dist/types/entities/experience-instance/experience-instance.d.ts.map +1 -1
  53. package/dist/types/exports.d.ts +1 -0
  54. package/dist/types/exports.d.ts.map +1 -1
  55. package/dist/types/index.d.ts +2 -2
  56. package/dist/types/index.d.ts.map +1 -1
  57. package/dist/types/lifecycle/rules-logic.d.ts.map +1 -1
  58. package/dist/types/logic-engine.d.ts +9 -0
  59. package/dist/types/logic-engine.d.ts.map +1 -1
  60. package/dist/types/picked.d.ts +38 -8
  61. package/dist/types/picked.d.ts.map +1 -1
  62. package/dist/types/plugins/dynamic-experiences/index.d.ts +1 -0
  63. package/dist/types/plugins/dynamic-experiences/index.d.ts.map +1 -1
  64. package/dist/types/plugins/dynamic-experiences/plugin.d.ts.map +1 -1
  65. package/dist/types/plugins/dynamic-experiences/types.d.ts +5 -2
  66. package/dist/types/plugins/dynamic-experiences/types.d.ts.map +1 -1
  67. package/dist/types/plugins/experience-browser-storage/plugin.d.ts.map +1 -1
  68. package/dist/types/plugins/telemetry/plugin.d.ts +2 -0
  69. package/dist/types/plugins/telemetry/plugin.d.ts.map +1 -1
  70. package/dist/types/schema-registry.d.ts +34 -0
  71. package/dist/types/schema-registry.d.ts.map +1 -1
  72. package/dist/types/server/serialize.d.ts +1 -0
  73. package/dist/types/server/serialize.d.ts.map +1 -1
  74. package/dist/types/storage.d.ts +6 -0
  75. package/dist/types/storage.d.ts.map +1 -0
  76. package/dist/types/typed-content.d.ts +14 -1
  77. package/dist/types/typed-content.d.ts.map +1 -1
  78. package/dist/types/utils/events.d.ts +4 -0
  79. package/dist/types/utils/events.d.ts.map +1 -1
  80. package/dist/types/utils/node-tree/min-max-steps-to-leaf.d.ts +16 -6
  81. package/dist/types/utils/node-tree/min-max-steps-to-leaf.d.ts.map +1 -1
  82. package/dist/types/utils/node-tree/min-max-steps-to-origin.d.ts +18 -7
  83. package/dist/types/utils/node-tree/min-max-steps-to-origin.d.ts.map +1 -1
  84. package/dist/types/utils/node-tree/next-reachable-step-nodes.d.ts +30 -6
  85. package/dist/types/utils/node-tree/next-reachable-step-nodes.d.ts.map +1 -1
  86. package/dist/types/utils/node-tree/node-adjacency.d.ts +50 -0
  87. package/dist/types/utils/node-tree/node-adjacency.d.ts.map +1 -0
  88. package/dist/types/utils/node-tree/node-tree-index.d.ts +57 -0
  89. package/dist/types/utils/node-tree/node-tree-index.d.ts.map +1 -0
  90. package/dist/types/utils/rules-logic.d.ts +3 -2
  91. package/dist/types/utils/rules-logic.d.ts.map +1 -1
  92. package/dist/types/utils/search-params.d.ts +20 -0
  93. package/dist/types/utils/search-params.d.ts.map +1 -1
  94. package/package.json +39 -13
  95. package/dist/api-qiqq8lgz.cjs +0 -1
  96. package/dist/docs/_root.css +0 -101
  97. package/dist/docs/explanation/conditions-and-the-logic-engine.md +0 -94
  98. package/dist/docs/explanation/content-references.md +0 -99
  99. package/dist/docs/explanation/feature-flag-allocation.md +0 -218
  100. package/dist/docs/explanation/how-picked-works.md +0 -124
  101. package/dist/docs/explanation/how-pickedql-works.md +0 -76
  102. package/dist/docs/explanation/pages-and-flows.md +0 -64
  103. package/dist/docs/explanation/the-content-model.md +0 -87
  104. package/dist/docs/explanation/the-two-apis.md +0 -68
  105. package/dist/docs/explanation/why-server-side-rendering.md +0 -76
  106. package/dist/docs/explanation/workspaces-and-versions.md +0 -71
  107. package/dist/docs/how-to/add-a-step-field-or-action.md +0 -43
  108. package/dist/docs/how-to/analytics/index.md +0 -316
  109. package/dist/docs/how-to/archive-or-delete-a-workspace.md +0 -46
  110. package/dist/docs/how-to/authenticate-the-cli.md +0 -97
  111. package/dist/docs/how-to/authenticate-with-a-magic-link.md +0 -40
  112. package/dist/docs/how-to/authenticate-with-a-password.md +0 -51
  113. package/dist/docs/how-to/authenticate-with-an-api-key.md +0 -51
  114. package/dist/docs/how-to/authenticate-with-oauth.md +0 -40
  115. package/dist/docs/how-to/build-a-flow.md +0 -83
  116. package/dist/docs/how-to/connect-the-mcp-server.md +0 -38
  117. package/dist/docs/how-to/create-a-content-entry.md +0 -48
  118. package/dist/docs/how-to/create-a-project.md +0 -29
  119. package/dist/docs/how-to/create-an-experience.md +0 -42
  120. package/dist/docs/how-to/create-and-revoke-an-api-key.md +0 -42
  121. package/dist/docs/how-to/debug-with-the-chrome-extension.md +0 -57
  122. package/dist/docs/how-to/define-a-page-layout.md +0 -46
  123. package/dist/docs/how-to/fill-and-publish-a-page.md +0 -66
  124. package/dist/docs/how-to/install-the-gtm-template.md +0 -84
  125. package/dist/docs/how-to/install-the-sdk.md +0 -93
  126. package/dist/docs/how-to/install-the-vite-plugin.md +0 -69
  127. package/dist/docs/how-to/invite-and-remove-members.md +0 -34
  128. package/dist/docs/how-to/point-one-entry-at-another.md +0 -61
  129. package/dist/docs/how-to/preview-a-workspace.md +0 -28
  130. package/dist/docs/how-to/publish-a-workspace.md +0 -30
  131. package/dist/docs/how-to/read-a-feature-flag.md +0 -113
  132. package/dist/docs/how-to/read-a-referenced-entry.md +0 -109
  133. package/dist/docs/how-to/register-a-component.md +0 -55
  134. package/dist/docs/how-to/register-an-action-handler.md +0 -67
  135. package/dist/docs/how-to/render-a-step-form.md +0 -131
  136. package/dist/docs/how-to/render-an-unpublished-preview.md +0 -41
  137. package/dist/docs/how-to/reuse-a-section.md +0 -53
  138. package/dist/docs/how-to/reuse-a-step-field-or-action.md +0 -28
  139. package/dist/docs/how-to/roll-back-a-published-version.md +0 -26
  140. package/dist/docs/how-to/run-an-ab-test.md +0 -49
  141. package/dist/docs/how-to/run-code-on-a-form-submission.md +0 -125
  142. package/dist/docs/how-to/server-render-a-page.md +0 -81
  143. package/dist/docs/how-to/set-a-content-security-policy.md +0 -32
  144. package/dist/docs/how-to/set-up-mfa.md +0 -69
  145. package/dist/docs/how-to/switch-workspaces.md +0 -122
  146. package/dist/docs/how-to/upload-and-use-an-asset.mdx +0 -73
  147. package/dist/docs/how-to/validate-a-field.md +0 -52
  148. package/dist/docs/how-to/write-a-condition.md +0 -45
  149. package/dist/docs/how-to/write-a-predicate.md +0 -60
  150. package/dist/docs/index.md +0 -59
  151. package/dist/docs/reference/dashboard/actions.mdx +0 -53
  152. package/dist/docs/reference/dashboard/api-keys.mdx +0 -38
  153. package/dist/docs/reference/dashboard/conditions.mdx +0 -42
  154. package/dist/docs/reference/dashboard/content/asset-library.mdx +0 -63
  155. package/dist/docs/reference/dashboard/content/blocks.mdx +0 -57
  156. package/dist/docs/reference/dashboard/content/content-entries.mdx +0 -95
  157. package/dist/docs/reference/dashboard/content/models.mdx +0 -108
  158. package/dist/docs/reference/dashboard/content/pages.mdx +0 -61
  159. package/dist/docs/reference/dashboard/experiences.mdx +0 -51
  160. package/dist/docs/reference/dashboard/features.mdx +0 -154
  161. package/dist/docs/reference/dashboard/fields.mdx +0 -106
  162. package/dist/docs/reference/dashboard/flow-builder/canvas.mdx +0 -58
  163. package/dist/docs/reference/dashboard/flow-builder/condition-builder.md +0 -57
  164. package/dist/docs/reference/dashboard/flow-builder/keyboard-shortcuts.md +0 -72
  165. package/dist/docs/reference/dashboard/flow-builder/nodes.md +0 -63
  166. package/dist/docs/reference/dashboard/projects.mdx +0 -44
  167. package/dist/docs/reference/dashboard/reports.mdx +0 -43
  168. package/dist/docs/reference/dashboard/steps.mdx +0 -37
  169. package/dist/docs/reference/dashboard/team-management.md +0 -29
  170. package/dist/docs/reference/dashboard/workspace-versioning.mdx +0 -30
  171. package/dist/docs/reference/dashboard/workspaces.mdx +0 -76
  172. package/dist/docs/reference/delivery-api/experience-content.md +0 -152
  173. package/dist/docs/reference/delivery-api/index.md +0 -45
  174. package/dist/docs/reference/delivery-api/preview-caching-crawling.md +0 -79
  175. package/dist/docs/reference/delivery-api/project-config.md +0 -65
  176. package/dist/docs/reference/delivery-api/workspace-schema.md +0 -85
  177. package/dist/docs/reference/glossary.md +0 -181
  178. package/dist/docs/reference/management-api/authentication.md +0 -74
  179. package/dist/docs/reference/management-api/authorization-and-scopes.md +0 -285
  180. package/dist/docs/reference/management-api/error-handling.md +0 -233
  181. package/dist/docs/reference/management-api/pagination.md +0 -192
  182. package/dist/docs/reference/pickedql/data-sources.md +0 -174
  183. package/dist/docs/reference/pickedql/dimensions.md +0 -103
  184. package/dist/docs/reference/pickedql/filtering.md +0 -64
  185. package/dist/docs/reference/pickedql/index.md +0 -18
  186. package/dist/docs/reference/pickedql/schema.md +0 -172
  187. package/dist/docs/reference/pickedql/virtual-functions.md +0 -248
  188. package/dist/docs/reference/sdk/actions.md +0 -30
  189. package/dist/docs/reference/sdk/analytics-events.md +0 -445
  190. package/dist/docs/reference/sdk/conditions.md +0 -147
  191. package/dist/docs/reference/sdk/content-security-policy.md +0 -21
  192. package/dist/docs/reference/sdk/content.md +0 -213
  193. package/dist/docs/reference/sdk/experiences.md +0 -51
  194. package/dist/docs/reference/sdk/features.md +0 -256
  195. package/dist/docs/reference/sdk/fields.md +0 -255
  196. package/dist/docs/reference/sdk/index.md +0 -68
  197. package/dist/docs/reference/sdk/plugins/create-experience.md +0 -123
  198. package/dist/docs/reference/sdk/plugins/dynamic-experiences.md +0 -74
  199. package/dist/docs/reference/sdk/plugins/index.md +0 -29
  200. package/dist/docs/reference/sdk/plugins/window-object.md +0 -25
  201. package/dist/docs/reference/sdk/predicates.md +0 -43
  202. package/dist/docs/reference/sdk/ssr/index.md +0 -33
  203. package/dist/docs/reference/sdk/ssr/rendering-and-hydration.md +0 -103
  204. package/dist/docs/reference/sdk/ssr/serialize.md +0 -80
  205. package/dist/docs/reference/sdk/ssr/slots-and-placements.md +0 -59
  206. package/dist/docs/reference/sdk/steps.md +0 -86
  207. package/dist/docs/reference/sdk/type-generation.md +0 -196
  208. package/dist/docs/reference/tools/chrome-extension.md +0 -16
  209. package/dist/docs/reference/tools/cli.md +0 -146
  210. package/dist/docs/reference/tools/image-optimisation-service.md +0 -104
  211. package/dist/docs/reference/tools/mcp.md +0 -90
  212. package/dist/docs/reference/tools/vite-plugin.md +0 -163
  213. package/dist/docs/tutorials/first-api-call.md +0 -228
  214. package/dist/docs/tutorials/first-experience-in-the-dashboard.mdx +0 -143
  215. package/dist/docs/tutorials/first-experience.mdx +0 -254
  216. package/dist/docs/tutorials/first-server-rendered-page.mdx +0 -186
  217. package/dist/dom-DlLH3FxV.cjs +0 -1
  218. package/dist/experience-instance-DGk11d8a.js +0 -563
  219. package/dist/experience-instance-Dej3P1sE.cjs +0 -1
  220. package/dist/plugin-BcLaCLm1.cjs +0 -1
  221. package/dist/plugin-De_BJSwE.js +0 -194
  222. package/dist/preview-channel-Cx0e6fye.cjs +0 -1
  223. package/dist/provider-C_9u0yGJ.cjs +0 -1
  224. package/dist/provider-ovM-CBX_.js +0 -98
  225. package/dist/rules-logic-CGZIYgAI.cjs +0 -1
  226. package/dist/version-BvLZaTMC.cjs +0 -1
@@ -1,61 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../../components/Screenshot'
7
-
8
- # Pages
9
-
10
- A Page is a standalone, server-rendered experience backed by CMS content, built for SEO-critical landing pages.
11
-
12
- <Screenshot
13
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences"
14
- alt="The experiences list, where Pages and Flows are created on the Picked dashboard"
15
- />
16
-
17
- ## Edit page content
18
-
19
- The Page editor has two tabs. The **Properties** tab holds the content of the page.
20
- The **Settings** tab holds its name, its condition, and its layout. Fill in the
21
- fields on the **Properties** tab. The inspector on the right edits the field that you
22
- choose, and the preview panel shows the page while it fills in.
23
-
24
- ## Status
25
-
26
- The **Settings** tab has a status control. It has two values.
27
-
28
- | Value | Effect |
29
- | --- | --- |
30
- | **Active** | Picked serves the page to everyone. |
31
- | **Draft** | Picked keeps the page out of the published site. |
32
-
33
- A draft page is absent from the published payload. Picked also holds back the
34
- steps, fields and actions that only that page uses, and it does not serve the
35
- page content. A visitor and a search-engine crawler receive nothing.
36
-
37
- To see a draft page, open it with a preview link. See
38
- [How to see a preview of a workspace](/how-to/preview-a-workspace). One preview
39
- link opens every draft page in the workspace.
40
-
41
- Status applies to Flows and to Pages. It is not the same as the status of the
42
- workspace: a draft page can be in a live workspace.
43
-
44
- :::warning
45
- Status is part of the published version. Change the value, then publish the
46
- workspace to apply the change to the live site.
47
- :::
48
-
49
- ## Change or remove the layout
50
-
51
- Use the change-layout control on the **Settings** tab to move the page to another
52
- [Page Layout](/reference/dashboard/content/models#category). When you unlink a layout,
53
- Picked separates the content entry from the page. It deletes no entry, but the page then
54
- has no content to render until you attach a layout again.
55
-
56
- ## Related
57
-
58
- - [About pages and flows](/explanation/pages-and-flows) — when to choose a Page.
59
- - [How to fill and publish a page](/how-to/fill-and-publish-a-page)
60
- - [How to server-render a page](/how-to/server-render-a-page)
61
- - [Models](/reference/dashboard/content/models) — the schema behind a Page.
@@ -1,51 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Experiences
9
-
10
- An experience is personalized content that Picked serves to the visitors on your
11
- site. Each experience points at a component that you register in your application.
12
-
13
- An experience is either a **Flow** or a **Page**. A **Flow** is an interactive
14
- experience of more than one step, and the browser renders it. This page covers the
15
- flow. A **Page** is a standalone experience that the server renders from CMS content,
16
- for a landing page where the search rank matters. See [Pages](/reference/dashboard/content/pages) for
17
- that kind.
18
-
19
- <Screenshot
20
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences"
21
- alt="The experiences list for a workspace on the Picked dashboard"
22
- />
23
-
24
- ## Experience settings
25
-
26
- Choose no node on the canvas, or click the canvas background, to open the experience
27
- inspector in the right panel.
28
-
29
- **Name**: The name that the dashboard shows. Your visitors do not see it.
30
-
31
- **Component Name**: The identifier that points this experience at a component in your
32
- application.
33
-
34
- **Condition**: An optional condition. When you set it, the experience starts only for
35
- a visitor who matches the condition. See
36
- [Condition Builder](/reference/dashboard/flow-builder/condition-builder) for how to write one. Keep it
37
- blank to start the experience for every visitor.
38
-
39
- **Initialize Open**: An optional condition that controls whether the experience opens
40
- by itself when the page loads. When it is blank, the experience loads but stays
41
- closed until something opens it.
42
-
43
- ## Experience list
44
-
45
- The experiences list shows every experience in the current project. Click an
46
- experience to open it in the flow builder.
47
-
48
- ## Related
49
-
50
- - [About pages and flows](/explanation/pages-and-flows) — Page or Flow.
51
- - [How to create an experience](/how-to/create-an-experience)
@@ -1,154 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Feature flags
9
-
10
- A feature flag lets you run an A/B test and roll a change out in stages. It controls
11
- which visitors see a change to your site, and you deploy no code.
12
-
13
- <Screenshot
14
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/features"
15
- alt="The feature flags list for a workspace on the Picked dashboard"
16
- />
17
-
18
- ## Keys
19
-
20
- Each feature flag has a unique key. Your application uses this key to check whether
21
- Picked allocates a visitor to the feature flag. You set the key when you create the
22
- feature flag, and you cannot change it later.
23
-
24
- ## Types
25
-
26
- Each feature flag has a type. You set the type when you create the feature flag, and you
27
- cannot change it later.
28
-
29
- | Type | What your site receives | Groups |
30
- | --- | --- | --- |
31
- | **Boolean** | `true` or `false` | Two |
32
- | **Text** | A string that you write, or `false` for the control group | Two or more |
33
-
34
- Choose **Boolean** for one change against no change. Choose **Text** when you must test
35
- several changes at the same time, and each change needs its own group.
36
-
37
- ## Set the allocation
38
-
39
- Set the allocation from the detail page of the feature flag:
40
-
41
- | Control | What it does |
42
- | --- | --- |
43
- | **Enabled** | Whether Picked allocates a visitor to the feature flag. A disabled feature flag allocates nobody, and it records nothing. See [Disable a feature flag](#disable-a-feature-flag). |
44
- | **Weight** | The percentage of visitors that Picked allocates to a Boolean feature flag, from 0 to 100. |
45
- | **Variants** | The groups of a Text feature flag, and the traffic that each one receives. See [Variants](#variants). |
46
- | **Description** | An internal note about what the feature flag tests. |
47
-
48
- A Boolean feature flag has one weight. For each visitor it gives one of two outcomes:
49
- allocated, or not allocated. A weight of 30 allocates 30% of your visitors. The other
50
- 70% stay unallocated. A weight of 0 allocates nobody. A weight of 100 allocates
51
- everybody.
52
-
53
- ## Variants
54
-
55
- A Text feature flag has a table of variants. Each row is one group of visitors:
56
-
57
- | Column | What it does |
58
- | --- | --- |
59
- | **Name** | A label for the variant. It appears in your reports. You can change it at any time. |
60
- | **Value** | The string that your site receives for a visitor in this variant. |
61
- | **Weight** | The share of traffic for this variant, against the other rows. |
62
-
63
- The first row is **Control**. Picked always sends `false` to a visitor in the control
64
- group, and you cannot remove the row, move it, or change its value. It takes a weight like
65
- any other row.
66
-
67
- The weights are shares, and not percentages. Picked reduces them to their smallest whole
68
- numbers, so `10 : 10 : 20` and `1 : 1 : 2` are the same split. The percentage beside each
69
- row shows the traffic that the variant receives.
70
-
71
- Choose **Even split** to give every variant the same weight.
72
-
73
- :::info
74
- The order of the rows is the order that you read them in. It has no effect on the
75
- allocation, so you can move a row and no visitor changes group.
76
- :::
77
-
78
- ## How Picked allocates a visitor
79
-
80
- The allocation is deterministic. It derives from the visitor ID and from the ID of the
81
- feature flag. A Boolean feature flag then compares that value against the weight, and a
82
- Text feature flag compares it against the range of each variant. Each feature flag gets its
83
- own value, so tests that run at the same time are independent. See
84
- [About feature flag allocation](/explanation/feature-flag-allocation).
85
-
86
- ## Disable a feature flag
87
-
88
- A disabled feature flag allocates nobody, and it records nothing. The difference
89
- from a weight of 0 matters for your reports. The visitor is **not in the test at
90
- all**, and the visitor is not in the control group.
91
-
92
- The SDK does not evaluate a disabled feature flag. It stores no decision in the
93
- browser of the visitor, and it reports no decision to your analytics. Such a feature
94
- flag is absent from the feature list on every analytics event.
95
-
96
- An experience whose condition points at a disabled feature flag behaves as though
97
- the visitor is not in the test. The condition reads as not allocated, and Picked
98
- records no assignment.
99
-
100
- This state is temporary, and it discards no decision that Picked made already. A
101
- visitor who was allocated before keeps that decision in the browser. When you enable the
102
- feature flag again, Picked continues from that decision, and the visitor stays in the
103
- group they were already in.
104
-
105
- :::note
106
- Expect a step change in your reports when you disable a feature flag: fewer feature
107
- flags for each visitor, and fewer decision events. That is the feature flag that drops
108
- out, and you lose no data.
109
- :::
110
-
111
- A disabled feature flag stays visible in the developer tools, and a
112
- [URL override](/reference/sdk/features#overrides-in-the-url) still turns one on for QA.
113
-
114
- ## Feature flag versions
115
-
116
- Each feature flag has a version number, and it starts at 1. The SDK caches an
117
- allocation decision in the browser of the visitor under a key, and the version is part
118
- of that key. The version does nothing else, and it is not an input to the allocation
119
- value. When you increment the version, the SDK discards those cached decisions. It
120
- then evaluates every visitor again on the next page load.
121
-
122
- ### What happens when you increment the version
123
-
124
- - **The SDK invalidates the cached decisions.** The cache key holds the version, so the
125
- old entry no longer matches and the feature flag counts as undecided.
126
- - **Picked evaluates each visitor against the current weight.** The allocation is
127
- deterministic and the version is not one of its inputs, so the same visitor against
128
- an unchanged weight gives the same result.
129
- - **You cannot reverse this.** There is no way to decrement a version.
130
-
131
- :::note
132
- The new version does not move your visitors between groups. It clears the cached
133
- decisions and runs the allocation again. With an unchanged weight, everybody lands
134
- where they were before. Change the weight to move your visitors.
135
- :::
136
-
137
- ### When to increment
138
-
139
- Increment the version after you change the weight. Do this when you want Picked to
140
- evaluate an allocated visitor again against the new weight, and not to use the cached
141
- decision.
142
-
143
- ### When not to increment
144
-
145
- To apply a weight change only to a visitor that Picked does not allocate yet, change
146
- the weight and leave the version as it is. An allocated visitor keeps the current
147
- allocation.
148
-
149
- ## Related
150
-
151
- - [About feature flag allocation](/explanation/feature-flag-allocation)
152
- - [How to run an A/B test](/how-to/run-an-ab-test)
153
- - [How to read a feature flag](/how-to/read-a-feature-flag)
154
- - [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
@@ -1,106 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Fields
9
-
10
- A field is a data input that a visitor sees inside a step. A field collects
11
- information such as a name, an email address, a preference, or a choice.
12
-
13
- This page covers the experience field, which collects visitor input. An experience
14
- field is not the same as a content field. A content field is part of the schema of a
15
- CMS layout. See [Models](/reference/dashboard/content/models) for those.
16
-
17
- <Screenshot
18
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/fields"
19
- alt="The fields list for a workspace on the Picked dashboard"
20
- />
21
-
22
- ## Field types
23
-
24
- A field has one of many types. These are the common ones:
25
-
26
- `TEXT`: A string input. Use it for a name, an email address, or free text.
27
-
28
- `NUMBER`: A numeric input. Use it for a quantity, a rating, or an age.
29
-
30
- `BOOLEAN`: A true or false toggle. Use it for a checkbox or for consent.
31
-
32
- `OBJECT`: A structured data input. Use it for data that holds other data.
33
-
34
- ## Options
35
-
36
- **Name**: The name that the dashboard shows. Your visitors do not see it.
37
-
38
- **Key**: The identifier for your application. You set it once and you cannot change
39
- it. Your visitors do not see it.
40
-
41
- **Label**: The label that a visitor sees next to the field.
42
-
43
- **Placeholder**: The hint text that the input shows while it is empty.
44
-
45
- **Description**: A longer description of what the field is for. The dashboard shows
46
- it. Your visitors do not see it.
47
-
48
- **Help Text**: Text below the field that helps your visitors.
49
-
50
- **Default Value**: The value that the field holds when it loads.
51
-
52
- ## Validation
53
-
54
- **Required**: When this is on, a visitor must fill in the field before the flow can
55
- continue.
56
-
57
- **Validation rules**: Conditions for a constraint such as a smallest value, a largest
58
- value, or a pattern. See [Condition Builder](/reference/dashboard/flow-builder/condition-builder) for how
59
- to build a validation rule.
60
-
61
- ## More than one value
62
-
63
- Turn on **Multiple** to let a visitor send more than one value for the field. This is
64
- useful for an input that takes several choices, or for a field of tags.
65
-
66
- ## Choices
67
-
68
- For a field with a fixed set of choices, such as a dropdown or a set of radio
69
- buttons, add options. Each option has a value, and the response carries that value.
70
-
71
- Each option can also carry a condition. When you set one, the option appears only to
72
- a visitor who matches the condition. See
73
- [Condition Builder](/reference/dashboard/flow-builder/condition-builder) for more detail.
74
-
75
- ## Privacy
76
-
77
- A field captures nothing until you permit it. Two checkboxes control where the value of
78
- a field can go. Both start off.
79
-
80
- | Checkbox | What it does when you turn it on |
81
- | --- | --- |
82
- | **Remember in the browser** | The SDK keeps the value on the device of the visitor. The value is available after a page load. |
83
- | **Send to analytics** | Picked puts the value in your analytics events. |
84
-
85
- Each checkbox is independent of the other.
86
-
87
- A new field that you leave alone sends no value to your analytics. It writes no value to
88
- the browser. Keep both checkboxes off for sensitive data such as a password, a tax
89
- number, or a payment detail.
90
-
91
- Never turn on **Send to analytics** for personal data. A name, an email address, a phone
92
- number, a home address, or an identity number must not reach your analytics.
93
-
94
- Neither checkbox stops the flow from the use of the value inside the page. A field that
95
- captures nothing still holds its value there. The flow validates the step with it, and it
96
- evaluates the conditions after the step with it. The checkboxes control what leaves the
97
- page.
98
-
99
- ## Related
100
-
101
- - [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
102
-
103
- - [How to validate a field](/how-to/validate-a-field)
104
- - [How to write a condition](/how-to/write-a-condition) — for a validation rule or an
105
- option condition.
106
- - [SDK fields](/reference/sdk/fields) — the `policies` object.
@@ -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)