@picked/client 0.0.71-next.1 → 0.0.71-next.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/.tsbuildinfo +1 -1
- package/dist/{api-CH2FNa6S.cjs → api-CnjBi6JG.cjs} +1 -1
- package/dist/{api-CgqRvuKL.js → api-vBVGLtvU.js} +1 -1
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/plugins/dynamic-experiences/index.js +1 -1
- package/dist/cjs/server/index.js +1 -1
- package/dist/docs/explanation/conditions-and-the-logic-engine.md +94 -0
- package/dist/docs/explanation/feature-flag-allocation.md +176 -0
- package/dist/docs/explanation/how-picked-works.md +102 -0
- package/dist/docs/explanation/how-pickedql-works.md +76 -0
- package/dist/docs/explanation/pages-and-flows.md +64 -0
- package/dist/docs/explanation/the-content-model.md +77 -0
- package/dist/docs/explanation/the-two-apis.md +68 -0
- package/dist/docs/explanation/why-server-side-rendering.md +76 -0
- package/dist/docs/explanation/workspaces-and-versions.md +71 -0
- package/dist/docs/how-to/add-a-step-field-or-action.md +43 -0
- package/dist/docs/{pickedql/examples.md → how-to/analytics/index.md} +19 -6
- package/dist/docs/how-to/archive-or-delete-a-workspace.md +46 -0
- package/dist/docs/how-to/authenticate-with-a-magic-link.md +40 -0
- package/dist/docs/how-to/authenticate-with-a-password.md +51 -0
- package/dist/docs/how-to/authenticate-with-an-api-key.md +51 -0
- package/dist/docs/how-to/authenticate-with-oauth.md +40 -0
- package/dist/docs/{flow-builder/building-flows.md → how-to/build-a-flow.md} +13 -9
- package/dist/docs/how-to/connect-the-mcp-server.md +38 -0
- package/dist/docs/how-to/create-a-project.md +29 -0
- package/dist/docs/how-to/create-an-experience.md +42 -0
- package/dist/docs/how-to/create-and-revoke-an-api-key.md +37 -0
- package/dist/docs/how-to/debug-with-the-chrome-extension.md +57 -0
- package/dist/docs/how-to/define-a-page-layout.md +39 -0
- package/dist/docs/how-to/fill-and-publish-a-page.md +50 -0
- package/dist/docs/{gtm-template.md → how-to/install-the-gtm-template.md} +9 -3
- package/dist/docs/how-to/install-the-sdk.md +68 -0
- package/dist/docs/how-to/install-the-vite-plugin.md +56 -0
- package/dist/docs/how-to/invite-and-remove-members.md +34 -0
- package/dist/docs/how-to/preview-a-workspace.md +28 -0
- package/dist/docs/how-to/publish-a-workspace.md +30 -0
- package/dist/docs/how-to/read-a-feature-flag.md +101 -0
- package/dist/docs/how-to/register-a-component.md +55 -0
- package/dist/docs/how-to/register-an-action-handler.md +67 -0
- package/dist/docs/how-to/render-a-step-form.md +132 -0
- package/dist/docs/how-to/render-an-unpublished-preview.md +41 -0
- package/dist/docs/how-to/reuse-a-section.md +37 -0
- package/dist/docs/how-to/reuse-a-step-field-or-action.md +28 -0
- package/dist/docs/how-to/roll-back-a-published-version.md +26 -0
- package/dist/docs/how-to/run-an-ab-test.md +49 -0
- package/dist/docs/how-to/run-code-on-a-form-submission.md +125 -0
- package/dist/docs/how-to/server-render-a-page.md +81 -0
- package/dist/docs/how-to/set-a-content-security-policy.md +32 -0
- package/dist/docs/how-to/set-up-mfa.md +69 -0
- package/dist/docs/how-to/upload-and-use-an-asset.mdx +73 -0
- package/dist/docs/how-to/validate-a-field.md +52 -0
- package/dist/docs/how-to/write-a-condition.md +45 -0
- package/dist/docs/how-to/write-a-predicate.md +60 -0
- package/dist/docs/index.md +41 -70
- package/dist/docs/reference/dashboard/actions.mdx +53 -0
- package/dist/docs/{api-keys.mdx → reference/dashboard/api-keys.mdx} +7 -15
- package/dist/docs/reference/dashboard/conditions.mdx +42 -0
- package/dist/docs/reference/dashboard/content/asset-library.mdx +63 -0
- package/dist/docs/{content → reference/dashboard/content}/content-entries.mdx +11 -3
- package/dist/docs/{content → reference/dashboard/content}/layouts.mdx +11 -35
- package/dist/docs/reference/dashboard/content/pages.mdx +35 -0
- package/dist/docs/reference/dashboard/content/sections.mdx +28 -0
- package/dist/docs/{experiences.mdx → reference/dashboard/experiences.mdx} +9 -16
- package/dist/docs/{features.mdx → reference/dashboard/features.mdx} +26 -41
- package/dist/docs/{fields.mdx → reference/dashboard/fields.mdx} +26 -20
- package/dist/docs/{flow-builder/overview.mdx → reference/dashboard/flow-builder/canvas.mdx} +8 -13
- package/dist/docs/{flow-builder → reference/dashboard/flow-builder}/condition-builder.md +5 -13
- package/dist/docs/{flow-builder → reference/dashboard/flow-builder}/keyboard-shortcuts.md +7 -1
- package/dist/docs/{flow-builder → reference/dashboard/flow-builder}/nodes.md +10 -3
- package/dist/docs/reference/dashboard/projects.mdx +44 -0
- package/dist/docs/reference/dashboard/reports.mdx +43 -0
- package/dist/docs/reference/dashboard/steps.mdx +37 -0
- package/dist/docs/{team-management.md → reference/dashboard/team-management.md} +5 -22
- package/dist/docs/{workspace-versioning.mdx → reference/dashboard/workspace-versioning.mdx} +6 -10
- package/dist/docs/reference/dashboard/workspaces.mdx +76 -0
- package/dist/docs/{delivery-api → reference/delivery-api}/experience-content.md +11 -4
- package/dist/docs/reference/delivery-api/index.md +45 -0
- package/dist/docs/{delivery-api → reference/delivery-api}/preview-caching-crawling.md +12 -5
- package/dist/docs/{delivery-api → reference/delivery-api}/project-config.md +11 -4
- package/dist/docs/reference/glossary.md +173 -0
- package/dist/docs/reference/management-api/authentication.md +74 -0
- package/dist/docs/{api → reference/management-api}/authorization-and-scopes.md +10 -3
- package/dist/docs/{api → reference/management-api}/error-handling.md +9 -3
- package/dist/docs/{api → reference/management-api}/pagination.md +6 -0
- package/dist/docs/{pickedql → reference/pickedql}/data-sources.md +16 -9
- package/dist/docs/{pickedql → reference/pickedql}/dimensions.md +7 -0
- package/dist/docs/{pickedql → reference/pickedql}/filtering.md +7 -0
- package/dist/docs/reference/pickedql/index.md +18 -0
- package/dist/docs/{pickedql → reference/pickedql}/schema.md +13 -6
- package/dist/docs/{pickedql → reference/pickedql}/virtual-functions.md +7 -0
- package/dist/docs/reference/sdk/actions.md +30 -0
- package/dist/docs/{sdk → reference/sdk}/conditions.md +8 -1
- package/dist/docs/reference/sdk/content-security-policy.md +21 -0
- package/dist/docs/reference/sdk/experiences.md +51 -0
- package/dist/docs/{sdk → reference/sdk}/features.md +30 -117
- package/dist/docs/{sdk → reference/sdk}/fields.md +10 -88
- package/dist/docs/reference/sdk/index.md +68 -0
- package/dist/docs/{sdk → reference/sdk}/plugins/create-experience.md +10 -22
- package/dist/docs/reference/sdk/plugins/dynamic-experiences.md +26 -0
- package/dist/docs/reference/sdk/plugins/index.md +29 -0
- package/dist/docs/{sdk → reference/sdk}/plugins/window-object.md +6 -0
- package/dist/docs/reference/sdk/predicates.md +43 -0
- package/dist/docs/reference/sdk/ssr/index.md +33 -0
- package/dist/docs/{sdk → reference/sdk}/ssr/rendering-and-hydration.md +4 -63
- package/dist/docs/{sdk → reference/sdk}/ssr/serialize.md +6 -33
- package/dist/docs/{sdk → reference/sdk}/ssr/slots-and-placements.md +7 -1
- package/dist/docs/reference/sdk/steps.md +87 -0
- package/dist/docs/reference/tools/chrome-extension.md +16 -0
- package/dist/docs/{image-optimisation-service.md → reference/tools/image-optimisation-service.md} +8 -0
- package/dist/docs/{mcp.md → reference/tools/mcp.md} +5 -45
- package/dist/docs/{vite-plugin.md → reference/tools/vite-plugin.md} +8 -38
- package/dist/docs/{api/index.md → tutorials/first-api-call.md} +27 -15
- package/dist/docs/tutorials/first-experience-in-the-dashboard.mdx +143 -0
- package/dist/docs/tutorials/first-experience.mdx +255 -0
- package/dist/docs/tutorials/first-server-rendered-page.mdx +186 -0
- package/dist/esm/index.js +468 -426
- package/dist/esm/plugins/dynamic-experiences/index.js +2 -2
- package/dist/esm/server/index.js +1 -1
- package/dist/{plugin-DCW-tnjO.cjs → plugin-CSmD1gPl.cjs} +1 -1
- package/dist/{plugin-D2UqFikQ.js → plugin-GOTtoDlC.js} +1 -1
- package/dist/types/entities/feature/feature.d.ts +25 -2
- package/dist/types/entities/feature/feature.d.ts.map +1 -1
- package/dist/types/picked.d.ts +2 -1
- package/dist/types/picked.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/docs/actions.mdx +0 -98
- package/dist/docs/api/authentication.md +0 -403
- package/dist/docs/chrome-extension.md +0 -68
- package/dist/docs/conditions.mdx +0 -72
- package/dist/docs/content/asset-library.mdx +0 -124
- package/dist/docs/content/pages.mdx +0 -82
- package/dist/docs/content/sections.mdx +0 -44
- package/dist/docs/delivery-api/index.md +0 -53
- package/dist/docs/guides/build-a-personalized-page.mdx +0 -161
- package/dist/docs/pickedql/index.md +0 -54
- package/dist/docs/projects.mdx +0 -44
- package/dist/docs/reports.mdx +0 -20
- package/dist/docs/sdk/actions.md +0 -82
- package/dist/docs/sdk/content-security-policy.md +0 -33
- package/dist/docs/sdk/experiences.md +0 -64
- package/dist/docs/sdk/feature-allocation.md +0 -161
- package/dist/docs/sdk/index.md +0 -98
- package/dist/docs/sdk/plugins/dynamic-experiences.md +0 -84
- package/dist/docs/sdk/plugins/index.md +0 -9
- package/dist/docs/sdk/predicates.md +0 -128
- package/dist/docs/sdk/ssr/index.md +0 -79
- package/dist/docs/sdk/steps.md +0 -479
- package/dist/docs/steps.mdx +0 -53
- package/dist/docs/workspaces.mdx +0 -133
package/dist/docs/steps.mdx
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
layout: docs
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
import { Screenshot } from '../../components/Screenshot'
|
|
6
|
-
|
|
7
|
-
# Steps
|
|
8
|
-
|
|
9
|
-
A step is one screen or card that a visitor sees during an experience. Each step
|
|
10
|
-
holds one or more fields. A field collects data or shows content.
|
|
11
|
-
|
|
12
|
-
<Screenshot
|
|
13
|
-
route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/steps"
|
|
14
|
-
alt="The steps list for a workspace on the Picked dashboard"
|
|
15
|
-
/>
|
|
16
|
-
|
|
17
|
-
## Create a step
|
|
18
|
-
|
|
19
|
-
1. Open your project.
|
|
20
|
-
2. Click **Steps** in the sidebar.
|
|
21
|
-
3. Click **New Step**.
|
|
22
|
-
4. Enter a name and a key.
|
|
23
|
-
5. Click **Create**.
|
|
24
|
-
|
|
25
|
-
The key is a unique identifier for your application. You set it once, and you cannot
|
|
26
|
-
change it later.
|
|
27
|
-
|
|
28
|
-
## Set up a step
|
|
29
|
-
|
|
30
|
-
**Name**: The name that the dashboard shows. Your visitors do not see it.
|
|
31
|
-
|
|
32
|
-
**Key**: The identifier that your application uses for this step. Your
|
|
33
|
-
visitors do not see it.
|
|
34
|
-
|
|
35
|
-
**Layout Name**: The name of the component layout that renders this step. Examples
|
|
36
|
-
are `card`, `modal`, and `fullscreen`.
|
|
37
|
-
|
|
38
|
-
A step can also carry a **Step Layout**. A step layout is a reusable CMS schema, and
|
|
39
|
-
it gives the step a Content Entry. See [Page and Step Layouts](/content/layouts).
|
|
40
|
-
|
|
41
|
-
## Assign fields
|
|
42
|
-
|
|
43
|
-
In the flow builder, drag a field from the entity browser onto a step node. The field
|
|
44
|
-
appears in the **Assigned Fields** list of the step, in the inspector.
|
|
45
|
-
|
|
46
|
-
You can also choose the step node and expand the **Assigned Fields** section to see
|
|
47
|
-
and control the assigned fields. Click a field to open its inspector.
|
|
48
|
-
|
|
49
|
-
## Reuse steps
|
|
50
|
-
|
|
51
|
-
A step is a project-level entity. You can drag the same step into more than one
|
|
52
|
-
experience flow. A change to the options of a step applies at every place that uses
|
|
53
|
-
it.
|
package/dist/docs/workspaces.mdx
DELETED
|
@@ -1,133 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
layout: docs
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
import { Screenshot } from '../../components/Screenshot'
|
|
6
|
-
|
|
7
|
-
# Workspaces
|
|
8
|
-
|
|
9
|
-
A workspace is one version of the options for your project. Use a workspace to hold
|
|
10
|
-
a change, to see a preview of it, and to publish it when it is ready.
|
|
11
|
-
|
|
12
|
-
<Screenshot
|
|
13
|
-
route="/{orgSlug}/{projectId}/workspaces"
|
|
14
|
-
alt="The workspaces list inside a project on the Picked dashboard"
|
|
15
|
-
hide={['[data-testid="workspace-row-relative-time"]']}
|
|
16
|
-
/>
|
|
17
|
-
|
|
18
|
-
## How workspaces work
|
|
19
|
-
|
|
20
|
-
Each project has a workspace that holds your experiences, feature flags, and entity
|
|
21
|
-
options. When you make a change in the dashboard, that change stays in the workspace
|
|
22
|
-
until you publish it. A change to a flow, to a feature flag, or to an entity all
|
|
23
|
-
behave the same way.
|
|
24
|
-
|
|
25
|
-
A workspace is in one of three states:
|
|
26
|
-
|
|
27
|
-
- **Live** — the workspace that the SDK serves to your visitors. Each project has
|
|
28
|
-
exactly one live workspace.
|
|
29
|
-
- **Draft** — a workspace that no visitor sees. You can edit a draft, see a preview
|
|
30
|
-
of it, and publish it to make it live.
|
|
31
|
-
- **Archived** — a draft that you put to one side. An archived workspace is still
|
|
32
|
-
editable, but it does not appear in the default workspaces list.
|
|
33
|
-
|
|
34
|
-
## Preview
|
|
35
|
-
|
|
36
|
-
See a preview of your workspace to learn how a change looks before you publish it.
|
|
37
|
-
|
|
38
|
-
1. Click **Preview** in the workspace toolbar.
|
|
39
|
-
2. Enter the URL of your site.
|
|
40
|
-
3. Set each feature flag to the **Default**, **On**, or **Off** value. This step is
|
|
41
|
-
optional.
|
|
42
|
-
4. Click **Open Preview**.
|
|
43
|
-
|
|
44
|
-
Your site opens in a new tab with the unpublished workspace applied. The preview
|
|
45
|
-
sends the workspace state to the SDK in the query parameters, so the visitors on
|
|
46
|
-
your live site see no change.
|
|
47
|
-
|
|
48
|
-
## Publish
|
|
49
|
-
|
|
50
|
-
When you publish, Picked makes an immutable snapshot of your workspace. The SDK then
|
|
51
|
-
serves the new options to your visitors.
|
|
52
|
-
|
|
53
|
-
1. Click **Publish** in the workspace toolbar.
|
|
54
|
-
2. Read the change preview in the publish modal.
|
|
55
|
-
3. Click **Publish** to confirm.
|
|
56
|
-
|
|
57
|
-
The publish button is active only when the workspace has an unpublished change. A
|
|
58
|
-
status badge in the toolbar shows whether the workspace has an unpublished change or
|
|
59
|
-
is up to date.
|
|
60
|
-
|
|
61
|
-
## Change previews
|
|
62
|
-
|
|
63
|
-
The publish modal shows a side-by-side change preview. It compares the current
|
|
64
|
-
workspace against the last published snapshot. Use it to see exactly what your
|
|
65
|
-
visitors get after you publish.
|
|
66
|
-
|
|
67
|
-
<Screenshot
|
|
68
|
-
route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences?action=publish"
|
|
69
|
-
alt="The publish modal with a change preview of added experiences, steps, and conditions"
|
|
70
|
-
selector='[role="dialog"]'
|
|
71
|
-
wait='[role="dialog"]'
|
|
72
|
-
hide={['[data-testid="publish-diff-replaces-version"]']}
|
|
73
|
-
renderWidth={720}
|
|
74
|
-
renderHeight={579}
|
|
75
|
-
/>
|
|
76
|
-
|
|
77
|
-
The preview puts the changes into groups by entity type: experiences, feature flags,
|
|
78
|
-
steps, fields, actions, and conditions. Each row shows whether the entity was
|
|
79
|
-
**added**, **removed**, or **modified**. For a modified entity, expand the row to see
|
|
80
|
-
which properties changed.
|
|
81
|
-
|
|
82
|
-
Some changes break other records. An example is a field that you remove while other
|
|
83
|
-
steps still point at it. The change preview shows a banner above the diff for these
|
|
84
|
-
entries, so that you can look at them again before you publish.
|
|
85
|
-
|
|
86
|
-
The first publish of a workspace has no earlier snapshot to compare against. The
|
|
87
|
-
publish modal shows the contents of the workspace as the first publish, with no diff.
|
|
88
|
-
|
|
89
|
-
## Unpublished changes
|
|
90
|
-
|
|
91
|
-
The workspace records whether anything changed since the last publish. If you create
|
|
92
|
-
or update an experience, a feature flag, or an entity after the last publish, the
|
|
93
|
-
toolbar shows a warning badge.
|
|
94
|
-
|
|
95
|
-
## Workspace settings
|
|
96
|
-
|
|
97
|
-
The workspace settings page (**Settings** in the workspace navigation) covers how to
|
|
98
|
-
rename, archive, and delete a workspace.
|
|
99
|
-
|
|
100
|
-
### Rename
|
|
101
|
-
|
|
102
|
-
Change the workspace name in the **Name** field and click **Save**. A name is unique
|
|
103
|
-
inside a project. The dashboard rejects a duplicate name with a validation error.
|
|
104
|
-
|
|
105
|
-
### Archive
|
|
106
|
-
|
|
107
|
-
To archive a draft workspace is to move it out of the default workspaces list, but
|
|
108
|
-
not to delete it. Use it for a draft that you want to put to one side and keep.
|
|
109
|
-
|
|
110
|
-
1. Open the workspace settings page.
|
|
111
|
-
2. Click **Archive** in the page header.
|
|
112
|
-
3. Confirm in the modal.
|
|
113
|
-
|
|
114
|
-
You cannot archive a live workspace directly. Make a different workspace live first,
|
|
115
|
-
then archive the earlier one.
|
|
116
|
-
|
|
117
|
-
### Unarchive
|
|
118
|
-
|
|
119
|
-
You can unarchive a workspace from the same page to make it a draft again. The
|
|
120
|
-
settings page finds the archived state and changes the toolbar button to
|
|
121
|
-
**Unarchive**.
|
|
122
|
-
|
|
123
|
-
### Delete
|
|
124
|
-
|
|
125
|
-
To delete a workspace is to remove it and its entities permanently. This action is
|
|
126
|
-
destructive and you cannot reverse it. Archive the workspace instead when you are not
|
|
127
|
-
certain.
|
|
128
|
-
|
|
129
|
-
1. Open the workspace settings page.
|
|
130
|
-
2. In the **Danger zone** card at the bottom, click **Delete**.
|
|
131
|
-
3. Confirm in the modal.
|
|
132
|
-
|
|
133
|
-
You cannot delete a live workspace. Publish or archive a different workspace first.
|