@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,69 +0,0 @@
1
- ---
2
- type: how-to
3
- layout: docs
4
- ---
5
-
6
- # How to set up MFA
7
-
8
- This guide shows you how to add a second factor to an account. Every MFA mutation needs
9
- authentication.
10
-
11
- ## 1. Add a factor
12
-
13
- ```graphql
14
- mutation {
15
- mfaFactorEnroll(input: {
16
- factorType: PHONE
17
- phone: "+15551234567"
18
- friendlyName: "My Phone"
19
- }) {
20
- factor { id factorType status }
21
- }
22
- }
23
- ```
24
-
25
- A new factor has the status `UNVERIFIED`.
26
-
27
- ## 2. Send a challenge
28
-
29
- ```graphql
30
- mutation {
31
- mfaChallengeSend(input: { factorId: "factor-id" }) {
32
- challengeId
33
- }
34
- }
35
- ```
36
-
37
- This sends a code to the telephone number of the factor.
38
-
39
- ## 3. Verify the challenge
40
-
41
- ```graphql
42
- mutation {
43
- mfaChallengeVerify(input: {
44
- factorId: "factor-id"
45
- challengeId: "challenge-id"
46
- code: "123456"
47
- }) {
48
- session { accessToken refreshToken aal }
49
- }
50
- }
51
- ```
52
-
53
- The session moves to `AAL2`, and the factor status changes to `VERIFIED`.
54
-
55
- ## Remove a factor
56
-
57
- ```graphql
58
- mutation {
59
- mfaFactorUnenroll(input: { factorId: "factor-id" }) {
60
- success
61
- }
62
- }
63
- ```
64
-
65
- ## Related
66
-
67
- - [Authorization and scopes](/reference/management-api/authorization-and-scopes) — which
68
- operations need `AAL2`.
69
- - [Authentication](/reference/management-api/authentication) — every mutation.
@@ -1,122 +0,0 @@
1
- ---
2
- type: how-to
3
- layout: docs
4
- ---
5
-
6
- # How to switch workspaces
7
-
8
- This guide shows you how to point your local tooling at a different project or workspace.
9
- Your application then renders that workspace's content and types on your machine. It expects
10
- a `picked.config.ts` and the [CLI](/reference/tools/cli).
11
-
12
- Your tooling reads the project and surface named in the committed `picked.config.ts`. The
13
- CLI writes your choice to `.picked/settings.json` instead. That file is per-developer and
14
- Git ignores it, so the committed default stays as it is and one command puts it back.
15
-
16
- See [Workspaces](/reference/dashboard/workspaces) for what Live, Draft, and Archived mean.
17
-
18
- ## 1. Sign in
19
-
20
- ```bash
21
- picked login
22
- ```
23
-
24
- This opens your browser for a one-time OAuth sign-in and stores a session under
25
- `~/.picked/`. Confirm it with `picked whoami`. See
26
- [CLI authentication](/how-to/authenticate-the-cli).
27
-
28
- ## 2. Find a workspace
29
-
30
- ```bash
31
- picked workspace list
32
- ```
33
-
34
- ```
35
- Acme Corp. (acme-corporation)
36
- Storefront [proj_a1b2]
37
- Default Storefront [LIVE] (live)
38
- Checkout rework [DRAFT]
39
- ```
40
-
41
- Note the **project id** (`proj_a1b2`) and the name or the id of the workspace you want.
42
-
43
- ## 3. Switch to the draft
44
-
45
- ```bash
46
- picked workspace use --project proj_a1b2 --workspace ws_draft
47
- ```
48
-
49
- ```
50
- Active workspace: Checkout rework [DRAFT] in project proj_a1b2 (source: preview)
51
- Generated types at /app/src/picked-env.d.ts
52
- ```
53
-
54
- A command that names **one specific workspace** (draft, live, or archived):
55
-
56
- - writes the selection (and its [preview token](/reference/delivery-api/preview-caching-crawling)) to
57
- `.picked/settings.json`,
58
- - switches the resolved `source` to `preview` for that project, and
59
- - regenerates `picked-env.d.ts` from that workspace's schema (skip with `--no-generate`).
60
-
61
- To browse instead, run `picked workspace use` with no flags. The interactive picker lists
62
- every project, with **Published (live version)** and each of its workspaces.
63
-
64
- ## 4. See the draft in your app
65
-
66
- Both readers of the selection use `.picked/settings.json` with no change to your
67
- configuration:
68
-
69
- - **Type generation** now reads the draft schema. Rerun `picked generate types` after more
70
- edits.
71
- - The **[Vite plugin](/reference/tools/vite-plugin)** reads the draft's configuration and
72
- content in development and in a build. It sends the preview token to the
73
- [Delivery API](/reference/delivery-api). Restart the dev server to apply a switch.
74
-
75
- Your application renders the unpublished draft on your machine, with types.
76
-
77
- ## 5. Switch back to live
78
-
79
- ```bash
80
- picked workspace use --project proj_a1b2
81
- ```
82
-
83
- A command that names a project with no `--workspace`, or **Published (live version)** in the
84
- picker, discards the preview token and returns `source` to `published`. To confirm what is
85
- active:
86
-
87
- ```bash
88
- picked status
89
- ```
90
-
91
- ```
92
- Config default: project proj_a1b2 (source: published)
93
- Active selection: none (using the config default).
94
- ```
95
-
96
- ## CI and headless runs
97
-
98
- `.picked/settings.json` is a local, per-developer file. Do not commit it. To choose one
99
- workspace in CI with no selection file, set the environment directly:
100
-
101
- ```bash
102
- PICKED_PROJECT_ID=proj_a1b2 \
103
- PICKED_PREVIEW_TOKEN="$DRAFT_TOKEN" \
104
- picked generate types --check
105
- ```
106
-
107
- `PICKED_PREVIEW_TOKEN` applies only when the resolved `source` is `preview`. See the
108
- [CLI environment variables](/reference/tools/cli#environment-variables) for the full
109
- precedence order.
110
-
111
- :::note
112
- A preview token is a long-lived credential for one workspace. Keep it out of the version
113
- control system, as you do with each other credential. Git ignores `.picked/settings.json`
114
- for this reason, because `picked workspace use` writes a token there.
115
- :::
116
-
117
- ## Related
118
-
119
- - [CLI](/reference/tools/cli) — every command and flag.
120
- - [Workspaces](/reference/dashboard/workspaces) — Live, Draft, and Archived states.
121
- - [Type generation](/reference/sdk/type-generation) — how the schema becomes types.
122
- - [Preview, cache, and crawlers](/reference/delivery-api/preview-caching-crawling) — preview tokens on the Delivery API.
@@ -1,73 +0,0 @@
1
- ---
2
- type: how-to
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../components/Screenshot'
7
-
8
- # How to upload and use an asset
9
-
10
- This guide shows you how to put a file in the asset library and point at it from your
11
- content.
12
-
13
- ## 1. Add the field to a layout
14
-
15
- Two field types point at the library:
16
-
17
- - An **Asset** field takes an image, a video, or a document.
18
- - An **HTML** field takes a `.html` file.
19
-
20
- Add one of them to a page layout or a step layout.
21
-
22
- ## 2. Choose a file
23
-
24
- 1. Open the content entry.
25
- 2. Click **Choose file** on the asset field. On a field that holds a value already, click
26
- **Replace**.
27
- 3. Open the **Upload** tab to add a new file.
28
- 4. Open the **Library** tab to use a file that is there already.
29
- 5. Choose your asset.
30
-
31
- <Screenshot
32
- route="/{orgSlug}/{projectId}/design-systems/new"
33
- wait='button:has-text("Upload file")'
34
- click='button:has-text("Upload file")'
35
- selector="[role=dialog]"
36
- alt="The asset picker modal on the Picked dashboard, with the Library tab, its search box, its type filter, and its Sort menu"
37
- renderWidth={1072}
38
- renderHeight={790}
39
- />
40
-
41
- <Screenshot
42
- route="/{orgSlug}/{projectId}/design-systems/new"
43
- wait='button:has-text("Upload file")'
44
- click='button:has-text("Upload file")'
45
- selector="[role=dialog]"
46
- alt="The asset picker modal on the Picked dashboard, with the Library tab, its search box, its type filter, and its Sort menu"
47
- renderWidth={1072}
48
- renderHeight={790}
49
- />
50
-
51
- The detail panel on the right shows the kind, the dimensions, the size, and the upload
52
- date.
53
-
54
- ## 3. Find an asset in a large library
55
-
56
- The **Library** tab has three controls, and the server applies each one across the whole
57
- library:
58
-
59
- - **Search by name** narrows the list by file name while you type.
60
- - The type filter narrows the list to one media type. **All types** is the default.
61
- - **Sort** orders the list by **Name**, **Date created**, or **Date updated**.
62
-
63
- Click **Load more** at the bottom to read the next page of results.
64
-
65
- :::tip
66
- Each row has an **Open in new tab** control. Use it to check an asset again before you
67
- choose it. Your choice in the picker stays as it is.
68
- :::
69
-
70
- ## Related
71
-
72
- - [Asset library](/reference/dashboard/content/asset-library) — the limits, the file
73
- types, and how Picked serves an uploaded file.
@@ -1,52 +0,0 @@
1
- ---
2
- type: how-to
3
- layout: docs
4
- ---
5
-
6
- # How to validate a field
7
-
8
- This guide shows you how to check what a visitor enters. Write the rule in JSON Logic. The
9
- `$input` variable holds the current value of the field.
10
-
11
- ## Steps
12
-
13
- Add a `validation` rule to `createField()`:
14
-
15
- ```ts
16
- import { createField } from '@picked/client/plugins/create-experience'
17
-
18
- const quantityField = createField({
19
- id: 'quantity',
20
- name: 'quantity',
21
- type: 'number',
22
- label: 'Quantity',
23
- multiple: false,
24
- required: true,
25
- validation: {
26
- catch: {
27
- or: [
28
- {
29
- and: [
30
- { '>': [{ var: '$input' }, 0] },
31
- { '<=': [{ var: '$input' }, 999] },
32
- ],
33
- },
34
- { throw: 'Please enter a value between 1 and 999' },
35
- ],
36
- },
37
- },
38
- })
39
- ```
40
-
41
- :::tip
42
- The `catch` and `throw` pattern checks that the condition gives `true`. When it does not,
43
- the SDK shows the `throw` message to your visitor.
44
- :::
45
-
46
- The SDK runs the rule on blur and on submit.
47
-
48
- ## Related
49
-
50
- - [SDK fields](/reference/sdk/fields) — every field option.
51
- - [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
52
- the rule format.
@@ -1,45 +0,0 @@
1
- ---
2
- type: how-to
3
- layout: docs
4
- ---
5
-
6
- # How to write a condition
7
-
8
- This guide shows you how to build a rule in the visual condition builder. The builder
9
- appears on a condition node, on an experience condition, on an initialize-open condition,
10
- and on a field option.
11
-
12
- ## Steps
13
-
14
- 1. Choose the node or the field that takes the condition.
15
- 2. Find the **Logic** section in the inspector.
16
- 3. Choose a data source: **Responses**, **Actions**, **Feature flags**, **Conditions**,
17
- or **Window Location**.
18
- 4. Choose an operator. The choices include equals, not equals, greater than, and
19
- contains.
20
- 5. Enter a value.
21
-
22
- ## Join more than one rule
23
-
24
- 1. Create an AND group or an OR group.
25
- 2. Add your rules inside it.
26
-
27
- With **AND** every rule must match. With **OR** one rule must match. Put a group inside
28
- another group to build a larger rule.
29
-
30
- ## Example
31
-
32
- To show a step only to a visitor who is on one page and who accepted marketing:
33
-
34
- 1. Create an AND group.
35
- 2. Add a rule: **Window Location → pathname** equals `/pricing`.
36
- 3. Add a rule: **Responses → `marketing_opt_in`** equals `true`.
37
-
38
- The group matches only when both rules are true.
39
-
40
- ## Related
41
-
42
- - [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
43
- what a rule can read.
44
- - [Condition builder](/reference/dashboard/flow-builder/condition-builder) — the rule
45
- structure.
@@ -1,60 +0,0 @@
1
- ---
2
- type: how-to
3
- layout: docs
4
- ---
5
-
6
- # How to write a predicate
7
-
8
- This guide shows you how to let a condition read data that only your application holds,
9
- such as a cart total or an account level.
10
-
11
- ## 1. Define the predicate
12
-
13
- Pass a `predicates` object to `createClient()`:
14
-
15
- ```ts
16
- import { createClient } from 'picked'
17
-
18
- const client = createClient({
19
- projectId: 'your-project-id',
20
- predicates: {
21
- 'is-example-page': ({ location }) => location?.pathname === '/example',
22
- 'get-account-tier': async () => {
23
- const data = await fetch('/api/get-account-tier').then((r) => r.json())
24
- return data.result
25
- },
26
- },
27
- })
28
- ```
29
-
30
- A predicate returns a boolean, a string, an array of strings, or `undefined`. It can also
31
- return a promise that resolves to one of those.
32
-
33
- ## 2. Invoke it from a condition
34
-
35
- ```ts
36
- condition: {
37
- '==': [
38
- { invoke: { var: 'predicates.is-example-page' } },
39
- true,
40
- ],
41
- }
42
- ```
43
-
44
- :::tip
45
- A predicate also works inside `validation` logic.
46
- :::
47
-
48
- ## Keep it pure and fast
49
-
50
- - The same snapshot must always give the same result.
51
- - Check that a response or a field is there before you read its value. Return `undefined`
52
- when the data is not available, and do not throw.
53
- - The SDK can invoke a predicate many times, so keep the logic small.
54
- - Do not change the snapshot. It is frozen, and a change to it throws in strict mode.
55
-
56
- ## Related
57
-
58
- - [Predicates](/reference/sdk/predicates) — the state snapshot shape.
59
- - [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
60
- why predicates exist.
@@ -1,59 +0,0 @@
1
- ---
2
- type: map
3
- layout: docs
4
- ---
5
-
6
- # Picked documentation
7
-
8
- Picked lets you build personalized UI flows in a visual editor. The SDK then serves them
9
- to the visitors on your site.
10
-
11
- There are two paths to follow. Choose the one that matches your work.
12
-
13
- ## Work in the dashboard
14
-
15
- Build experiences, write content, and publish.
16
-
17
- Start with [build your first experience](/tutorials/first-experience-in-the-dashboard).
18
- It takes you from an empty project to a survey on your own site, and it needs no
19
- development tools.
20
-
21
- One thing must happen first: a developer adds the Picked SDK to your site one time. After
22
- that, the dashboard is all you need.
23
-
24
- Then:
25
-
26
- - **[Build](/how-to/create-an-experience)** — experiences, flows, conditions, and A/B
27
- tests.
28
- - **[Content](/how-to/define-a-page-layout)** — Models, Blocks, entries, pages, and assets.
29
- - **[Publish](/how-to/publish-a-workspace)** — preview, publish, and roll back.
30
- - **[Administer and measure](/how-to/invite-and-remove-members)** — members, API keys,
31
- analytics, and the tools that connect Picked to Google Tag Manager and to an AI tool.
32
- - **[Dashboard reference](/reference/dashboard/projects)** — every dashboard screen and
33
- every option, plus the [glossary](/reference/glossary).
34
- - **[How Picked works](/explanation/how-picked-works)** — what happens when you publish.
35
-
36
- ## Integrate with code
37
-
38
- Add Picked to a site or an application. Your code then renders the experiences that the
39
- dashboard describes.
40
-
41
- Start with [add Picked to your application](/tutorials/first-experience). It goes from an
42
- empty project to a survey that runs in React or in Svelte.
43
-
44
- Read the dashboard documents above also. Everything your code renders is described
45
- there, so the two paths link to each other rather than repeat.
46
-
47
- Then:
48
-
49
- - **[Integrate the SDK](/how-to/install-the-sdk)** — install, register a component, read
50
- a feature flag.
51
- - **[Build a step form](/how-to/render-a-step-form)** — render fields, act on a
52
- submission, validate input.
53
- - **[Server-side rendering](/how-to/server-render-a-page)** — a page that a search engine
54
- can read.
55
- - **[Authenticate](/how-to/authenticate-with-a-password)** — the management API.
56
- - **[SDK reference](/reference/sdk)**, **[Delivery API](/reference/delivery-api)**,
57
- **[PickedQL](/reference/pickedql)**.
58
- - **[Why it works this way](/explanation/why-server-side-rendering)** — the design
59
- behind the SDK.
@@ -1,53 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Actions
9
-
10
- An action is a side effect that starts when the flow reaches it. Use an action to
11
- track an event, to send data to an external service, or to call a webhook.
12
-
13
- <Screenshot
14
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/actions"
15
- alt="The actions list for a workspace on the Picked dashboard"
16
- />
17
-
18
- ## Set up an action
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 action. Your visitors do
23
- not see it.
24
-
25
- ## Register in your application
26
-
27
- Each action key must match a key in the `actions` object that you pass to
28
- `createClient()`. See
29
- [How to register an action handler](/how-to/register-an-action-handler) for the code, and
30
- [SDK actions](/reference/sdk/actions) for what the handler receives and returns.
31
-
32
- ## Use actions in flows
33
-
34
- In the flow builder, drag an action from the library onto the canvas. Connect it to
35
- the point in the flow where you want it to start.
36
-
37
- An action runs when the flow reaches its node. It does not interrupt your visitor. By
38
- default the flow continues to the next connected node.
39
-
40
- An action node can carry a **success** branch and a **failure** branch. Which one the flow
41
- takes depends on whether your handler throws, and a returned `false` is a success. See
42
- [How an action decides which way to go](/explanation/how-picked-works#how-an-action-decides-which-way-to-go).
43
-
44
- ## Reuse actions
45
-
46
- An action belongs to the project. Use the same action in more than one experience flow.
47
- A change to the options of an action applies at every place that uses it.
48
-
49
- ## Related
50
-
51
- - [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
52
- - [How to register an action handler](/how-to/register-an-action-handler)
53
- - [SDK actions](/reference/sdk/actions) — what the handler receives and returns.
@@ -1,38 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # API keys
9
-
10
- An API key lets your code reach the Picked API. Use one where your own code calls the API,
11
- such as a server-side integration. It does not sign the
12
- [CLI](/reference/tools/cli) in.
13
-
14
- <Screenshot
15
- route="/{orgSlug}/api-keys"
16
- alt="The API keys list for an organization on the Picked dashboard"
17
- />
18
-
19
- ## Use an API key
20
-
21
- Put your API key in the `x-api-key` header of each request to the
22
- [Picked API](/tutorials/first-api-call).
23
-
24
- ```
25
- x-api-key: your-api-key
26
- ```
27
-
28
- ## Scopes
29
-
30
- An API key carries scopes, and the scopes limit what the key can reach. Choose the
31
- scopes that your integration needs when you create the key. A key can do only the
32
- operations that its scopes permit.
33
-
34
- ## Related
35
-
36
- - [How to create and revoke an API key](/how-to/create-and-revoke-an-api-key)
37
- - [How to authenticate with an API key](/how-to/authenticate-with-an-api-key) — the API
38
- side.
@@ -1,42 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../components/Screenshot'
7
-
8
- # Conditions
9
-
10
- A condition evaluates a rule and splits the flow into two paths. One path is for a
11
- true result, the other for a false result.
12
-
13
- <Screenshot
14
- route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/conditions"
15
- alt="The conditions list for a workspace on the Picked dashboard"
16
- />
17
-
18
- ## Set up a condition
19
-
20
- **Name**: The name that the dashboard shows. Your visitors do not see it.
21
-
22
- **Key**: The identifier for your application. You set it once and you cannot change
23
- it. Your visitors do not see it.
24
-
25
- ## Branches
26
-
27
- In the flow builder, a condition node has two output handles. The green handle, for a
28
- true result, leads to the path for a match. The red handle, for a false result, leads
29
- to the other path.
30
-
31
- You can chain conditions. Connect the output of one condition to the input of another
32
- to build a decision tree.
33
-
34
- ## Related
35
-
36
- - [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
37
-
38
- - [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
39
- what a rule can read.
40
- - [How to write a condition](/how-to/write-a-condition)
41
- - [Condition builder](/reference/dashboard/flow-builder/condition-builder) — the data
42
- sources and the rule structure.
@@ -1,63 +0,0 @@
1
- ---
2
- type: reference
3
- layout: docs
4
- ---
5
-
6
- import { Screenshot } from '../../../../../components/Screenshot'
7
-
8
- # Asset Library
9
-
10
- The Asset Library holds the files that your content points at. These are images,
11
- video, documents, and HTML.
12
-
13
- <Screenshot
14
- route="/{orgSlug}/{projectId}/assets"
15
- alt="The asset library on the Picked dashboard"
16
- />
17
-
18
- ## Upload and control your assets
19
-
20
- The Asset Library is a project-level store. Upload a file, then point at it from any
21
- Content Entry in the project.
22
-
23
- - **Size limit:** 50 MB for each file.
24
- - **Allowed types:** an image in PNG, JPEG, WebP, AVIF, GIF, or SVG. A video in MP4
25
- or WebM. A common document format. HTML, as `text/html`.
26
-
27
- Picked rejects a file of another type. It also rejects a file above the size limit.
28
-
29
- ## HTML assets
30
-
31
- Upload a `.html` file and point at it from an **HTML asset** field. Picked then scans
32
- the file. The scan is advisory: it helps you, and it never stops you. It
33
- reports findings about speed, about search rank, and about accessibility, so that you
34
- can improve the file before you publish it:
35
-
36
- - **File size:** a warning at 100 KB, and a stronger one at 250 KB.
37
- - **Inline images:** a note when inline `base64` image data adds about 50 KB or more.
38
- - **Image dimensions:** an image with no width and no height. Such an image can move
39
- the content around it while the page loads.
40
- - **Lazy load:** an image with no `loading="lazy"` attribute.
41
- - **Link safety:** an external link with `target="_blank"` and no `rel="noopener"`.
42
- - **Link search rank:** an external link with no `rel="nofollow"`.
43
- - **Accessibility:** a pass by `axe-core`. It covers alt text, heading order,
44
- contrast, and more.
45
-
46
- Every finding is advisory. You can always upload the file as it is.
47
-
48
- ## How assets are served
49
-
50
- Picked serves each asset from a sandboxed storage origin. That origin is separate
51
- from the trusted origin of your application. HTML therefore comes from its own
52
- origin, so a document that you upload runs in isolation and cannot reach the page
53
- that holds it. A script in that document cannot read a session, a token, or the DOM
54
- around it, because each of those needs same-origin access.
55
-
56
- An [Experience Content](/reference/delivery-api/experience-content) response can hold an HTML
57
- asset. The response then carries the content of that asset, and the SDK renders it
58
- with no second request to storage.
59
-
60
- ## Related
61
-
62
- - [How to upload and use an asset](/how-to/upload-and-use-an-asset)
63
- - [Fields](/reference/dashboard/fields) — the field type for an HTML asset.