@picked/client 0.0.1-dev.1789541668638 → 0.0.1-next.2

package/dist/docs/reference/dashboard/fields.mdx

@@ -1,106 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Fields
-
-A field is a data input that a visitor sees inside a step. A field collects
-information such as a name, an email address, a preference, or a choice.
-
-This page covers the experience field, which collects visitor input. An experience
-field is not the same as a content field. A content field is part of the schema of a
-CMS layout. See [Models](/reference/dashboard/content/models) for those.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/fields"
-  alt="The fields list for a workspace on the Picked dashboard"
-/>
-
-## Field types
-
-A field has one of many types. These are the common ones:
-
-`TEXT`: A string input. Use it for a name, an email address, or free text.
-
-`NUMBER`: A numeric input. Use it for a quantity, a rating, or an age.
-
-`BOOLEAN`: A true or false toggle. Use it for a checkbox or for consent.
-
-`OBJECT`: A structured data input. Use it for data that holds other data.
-
-## Options
-
-**Name**: The name that the dashboard shows. Your visitors do not see it.
-
-**Key**: The identifier for your application. You set it once and you cannot change
-it. Your visitors do not see it.
-
-**Label**: The label that a visitor sees next to the field.
-
-**Placeholder**: The hint text that the input shows while it is empty.
-
-**Description**: A longer description of what the field is for. The dashboard shows
-it. Your visitors do not see it.
-
-**Help Text**: Text below the field that helps your visitors.
-
-**Default Value**: The value that the field holds when it loads.
-
-## Validation
-
-**Required**: When this is on, a visitor must fill in the field before the flow can
-continue.
-
-**Validation rules**: Conditions for a constraint such as a smallest value, a largest
-value, or a pattern. See [Condition Builder](/reference/dashboard/flow-builder/condition-builder) for how
-to build a validation rule.
-
-## More than one value
-
-Turn on **Multiple** to let a visitor send more than one value for the field. This is
-useful for an input that takes several choices, or for a field of tags.
-
-## Choices
-
-For a field with a fixed set of choices, such as a dropdown or a set of radio
-buttons, add options. Each option has a value, and the response carries that value.
-
-Each option can also carry a condition. When you set one, the option appears only to
-a visitor who matches the condition. See
-[Condition Builder](/reference/dashboard/flow-builder/condition-builder) for more detail.
-
-## Privacy
-
-A field captures nothing until you permit it. Two checkboxes control where the value of
-a field can go. Both start off.
-
-| Checkbox | What it does when you turn it on |
-| --- | --- |
-| **Remember in the browser** | The SDK keeps the value on the device of the visitor. The value is available after a page load. |
-| **Send to analytics** | Picked puts the value in your analytics events. |
-
-Each checkbox is independent of the other.
-
-A new field that you leave alone sends no value to your analytics. It writes no value to
-the browser. Keep both checkboxes off for sensitive data such as a password, a tax
-number, or a payment detail.
-
-Never turn on **Send to analytics** for personal data. A name, an email address, a phone
-number, a home address, or an identity number must not reach your analytics.
-
-Neither checkbox stops the flow from the use of the value inside the page. A field that
-captures nothing still holds its value there. The flow validates the step with it, and it
-evaluates the conditions after the step with it. The checkboxes control what leaves the
-page.
-
-## Related
-
-- [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
-
-- [How to validate a field](/how-to/validate-a-field)
-- [How to write a condition](/how-to/write-a-condition) — for a validation rule or an
-  option condition.
-- [SDK fields](/reference/sdk/fields) — the `policies` object.

package/dist/docs/reference/dashboard/flow-builder/canvas.mdx

@@ -1,58 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../../components/Screenshot'
-
-# Flow builder
-
-The flow builder is a visual editor for an experience flow. You drag a block onto a
-canvas, connect the blocks with arrows, and set the options of each node in an
-inspector panel.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences/{experienceId}"
-  alt="The flow builder with the library, canvas, and inspector panels"
-/>
-
-## Layout
-
-The flow builder has three panels, from left to right.
-
-**Library**, on the left: it lists every step, action, condition, and field in
-your project. Drag an item from here onto the canvas.
-
-**Canvas**, in the middle: the area where you build your flow. A node stands for a
-block. An arrow stands for a connection between two blocks.
-
-**Inspector**, on the right: it shows the options of the node that you choose. When
-you choose no node, it shows the settings of the experience.
-
-## Panel controls
-
-Drag a divider between two panels to change their size. Press `Cmd/Ctrl+\` to turn
-both side panels on and off. Press `Cmd/Ctrl+Shift+\` to turn the inspector on and
-off.
-
-## Move around the canvas
-
-**Zoom**: scroll to make the view larger or smaller.
-
-**Pan**: choose the hand tool with `H`, then drag. You can also hold `Space` and
-drag. A drag with the middle mouse button also pans.
-
-**Choose tool**: press `V` to go back to the default tool.
-Click to choose a node. Drag on empty space to choose every node inside a rectangle.
-
-## Auto-layout
-
-Click the auto-layout button in the toolbar. The flow builder then arranges every
-node into a clean hierarchy. This is useful after you add many nodes, and when the
-canvas becomes messy.
-
-## Related
-
-- [How to build a flow](/how-to/build-a-flow) — add, connect, and branch.
-- [Keyboard shortcuts](/reference/dashboard/flow-builder/keyboard-shortcuts)
-- [Nodes](/reference/dashboard/flow-builder/nodes)

package/dist/docs/reference/dashboard/flow-builder/condition-builder.md

@@ -1,57 +0,0 @@
----
-type: reference
-layout: docs
----
-
-# Condition builder
-
-The condition builder is a visual rule editor, and the dashboard uses it in several
-places. With it you define a rule and you write no code.
-
-## Where it appears
-
-The dashboard uses the condition builder here:
-
-- **Condition nodes** — they set which branch the flow takes in the
-  [flow builder](/reference/dashboard/flow-builder/canvas).
-- **Experience conditions** — they control when an experience starts for a visitor.
-- **Initialize open conditions** — they control when an experience opens by itself as
-  the page loads.
-- **Field option conditions** — they show or hide one option, and the state of the
-  visitor decides which.
-
-## Rule structure
-
-The builder holds your rules in groups. Each group uses **AND** or **OR**. With
-**AND**, every rule must match. With **OR**, one rule must match.
-
-A single rule has three parts:
-
-1. **Field** — the data source to evaluate.
-2. **Operator** — how to compare. Examples are equals, not equals, greater than, and
-   contains.
-3. **Value** — the value to compare against.
-
-You can put a group inside another group to build a larger rule. An example is an AND
-group that holds two OR groups.
-
-## Data sources
-
-A rule can point at these data sources:
-
-**Responses** — the values that your visitors send through the form fields of the
-current experience. Each field that you create in your project appears here under its
-name.
-
-**Actions** — the actions that ran during the flow.
-
-**Feature flags** — the state of each feature flag in your project. Use it to take a
-branch on whether Picked allocates a visitor to a flag.
-
-**Location** — the parts of the current page URL of the visitor. These are the
-pathname, the search parameters, the hostname, and the hash.
-
-## Related
-
-- [How to write a condition](/how-to/write-a-condition) — a worked example.
-- [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine)

package/dist/docs/reference/dashboard/flow-builder/keyboard-shortcuts.md

@@ -1,72 +0,0 @@
----
-type: reference
-layout: docs
----
-
-# Keyboard shortcuts
-
-These shortcuts work when the canvas of the flow builder holds the keyboard input.
-
-## Canvas tools
-
-| Shortcut (Mac) | Shortcut (PC) | Action |
-| --- | --- | --- |
-| `V` | `V` | The choose tool |
-| `H` | `H` | The hand tool, which pans the view |
-| `Space`, held | `Space`, held | The hand tool, while you hold the key |
-
-## Layout
-
-| Shortcut (Mac) | Shortcut (PC) | Action |
-| --- | --- | --- |
-| `Shift+L` | `Shift+L` | Auto-layout |
-
-## Choice
-
-| Shortcut (Mac) | Shortcut (PC) | Action |
-| --- | --- | --- |
-| `Cmd+A` | `Ctrl+A` | Choose every node |
-| `Escape` | `Escape` | Choose no node |
-
-## Edits
-
-| Shortcut (Mac) | Shortcut (PC) | Action |
-| --- | --- | --- |
-| `Cmd+D` | `Ctrl+D` | Make a copy of each chosen node |
-| `Delete` or `Backspace` | `Delete` or `Backspace` | Delete each chosen node |
-| `Cmd+Z` | `Ctrl+Z` | Undo |
-| `Cmd+Shift+Z` | `Ctrl+Shift+Z` | Redo |
-
-## Movement
-
-| Shortcut (Mac) | Shortcut (PC) | Action |
-| --- | --- | --- |
-| Arrow keys | Arrow keys | Move each chosen node a small distance |
-| `Shift` and an arrow key | `Shift` and an arrow key | Move each chosen node further |
-
-## Zoom
-
-| Shortcut (Mac) | Shortcut (PC) | Action |
-| --- | --- | --- |
-| Scroll | Scroll | Zoom in or out |
-| Pinch | Pinch | Zoom in or out, on a trackpad |
-| `Cmd+=` | `Ctrl+=` | Zoom in |
-| `Cmd+-` | `Ctrl+-` | Zoom out |
-| `Shift+1` | `Shift+1` | Fit the flow to the view |
-| `Shift+0` | `Shift+0` | Zoom to 100% |
-
-## Panels
-
-| Shortcut (Mac) | Shortcut (PC) | Action |
-| --- | --- | --- |
-| `Cmd+\` | `Ctrl+\` | Turn both side panels on or off |
-| `?` | `?` | Turn this shortcut list on or off |
-
----
-
-[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)
-
-## Related
-
-- [How to build a flow](/how-to/build-a-flow)
-- [Canvas](/reference/dashboard/flow-builder/canvas) — the panels and the view controls.

package/dist/docs/reference/dashboard/flow-builder/nodes.md

@@ -1,63 +0,0 @@
----
-type: reference
-layout: docs
----
-
-# Nodes
-
-A node is one part of a flow. Each node stands for a block in your experience. There
-are four node types.
-
-## Origin
-
-Every flow starts with an origin node. It is a gray circle on the left side of the
-canvas, and it has one output handle on its right side.
-
-You cannot move the origin, delete it, or make a copy of it. It is always there.
-
-## Step
-
-A step node stands for a screen that a visitor sees. It appears as a blue rectangle
-on the canvas.
-
-A step holds fields. Drag a field from the library onto a step node to assign
-it. The subtitle of the node gives the number of assigned fields.
-
-Each step has a `layoutName`. It tells the SDK which visual layout to use for this
-step. Set the layout name in the inspector.
-
-## Action
-
-An action node stands for a side effect. A side effect happens where the visitor
-cannot see it. The node appears as a green rectangle.
-
-An action runs when the flow reaches it. Use an action to record an event, to send
-data, or to start an integration.
-
-## Condition
-
-A condition node stands for a point where the flow splits. It appears as an amber
-rectangle.
-
-A condition node has two output handles, and not one. The green handle at the top
-right connects to the path for a true result. The red handle at the bottom right
-connects to the path for a false result.
-
-Define the rule in the inspector, with the visual condition builder. See
-[Conditions](/reference/dashboard/conditions) for more detail.
-
-## Handles
-
-A handle is a connection point on a node. An input handle is on the left. An output
-handle is on the right. Drag from an output handle to an input handle to connect two
-nodes.
-
----
-
-[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)
-
-## Related
-
-- [How to build a flow](/how-to/build-a-flow)
-- [Canvas](/reference/dashboard/flow-builder/canvas)
-- [About how Picked works](/explanation/how-picked-works) — why a flow is a graph.

package/dist/docs/reference/dashboard/projects.mdx

@@ -1,44 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Projects
-
-A project is one site or one application that you want to measure with Picked. Each
-project has its own experiences, content, and options.
-
-<Screenshot
-  route="/{orgSlug}"
-  alt="The organization home page on the Picked dashboard, with the projects in an organization"
-/>
-
-## Workspaces
-
-Each project holds one or more [Workspaces](/reference/dashboard/workspaces). In a workspace you set the
-options for an experience and you see a preview of it before you make it live.
-
-## Project home
-
-When you open a project, you land on the project home page. It shows your SDK
-snippet and a list of the setup tasks that are still open.
-
-Copy the snippet and add it to your site. The snippet connects your site to the
-project and lets Picked serve experiences to it. See
-[SDK Installation](/reference/sdk) for the setup detail.
-
-## Project navigation
-
-The sidebar shows the sections of your project: **Feature flags**, **Fields**, **Flows**,
-**Pages**, and **Workspace settings**. **Flows** holds **Step Layouts**, and **Pages**
-holds **Page Layouts** and **Sections**.
-
-A step, an action, and a condition have no sidebar entry. You reach all three from the
-library in the flow builder, because each one belongs to a flow.
-
-## Related
-
-- [How to create a project](/how-to/create-a-project)
-- [How to install the SDK](/how-to/install-the-sdk)

package/dist/docs/reference/dashboard/reports.mdx

@@ -1,43 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Reports
-
-A report is an embedded Metabase dashboard or question, attached to a Picked project. Use
-a report to see how your visitors move through your experiences and your feature flags.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/reports"
-  alt="The reports list for a project on the Picked dashboard"
-/>
-
-## Report options
-
-| Option | Description |
-| --- | --- |
-| **Report name** | The name that the reports list shows. |
-| **Description** | An optional note about what the report shows. |
-| **Metabase report type** | `Dashboard` or `Question`. |
-| **Metabase report ID** | The numeric ID from the Metabase URL. |
-| **Display order** | Optional. It controls the position of the report in the list. |
-
-The create form has a link that opens the report, so you can check that the ID is
-correct before you save.
-
-## Permissions
-
-A member needs permission in the organization to create, edit, or delete a report. The
-dashboard hides those actions from a member without it.
-
-## Delete a report
-
-Open the report settings page and click **Delete report**. You cannot reverse a delete.
-
-## Related
-
-- [Analytics queries](/how-to/analytics) — query the same data with SQL.
-- [About PickedQL](/explanation/how-pickedql-works) — what the query layer expands.

package/dist/docs/reference/dashboard/steps.mdx

@@ -1,37 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Steps
-
-A step is one screen or card that a visitor sees during an experience. Each step
-holds one or more fields. A field collects data or shows content.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/steps"
-  alt="The steps list for a workspace on the Picked dashboard"
-/>
-
-## Set up a step
-
-**Name**: The name that the dashboard shows. Your visitors do not see it.
-
-**Key**: The identifier that your application uses for this step. Your
-visitors do not see it.
-
-**Layout Name**: The name of the component layout that renders this step. Examples
-are `card`, `modal`, and `fullscreen`.
-
-A step can also carry a **Step Layout**. A step layout is a reusable CMS schema, and
-it gives the step a Content Entry. See [Models](/reference/dashboard/content/models).
-
-## Related
-
-- [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
-
-- [How to build a flow](/how-to/build-a-flow) — add a step and assign fields to it.
-- [How to reuse a step, a field, or an action](/how-to/reuse-a-step-field-or-action)
-- [Models](/reference/dashboard/content/models) — the step layout schema.

package/dist/docs/reference/dashboard/team-management.md

@@ -1,29 +0,0 @@
----
-type: reference
-layout: docs
----
-
-# Team management
-
-Control who can reach your organization and what each person can do. An organization
-is the top-level container for your projects and members.
-
-## Organizations
-
-An organization groups your projects, your members, and your settings. You can belong
-to more than one organization.
-
-To move between organizations, use the organization control at the top of the
-sidebar.
-
-## Roles and permissions
-
-Each member holds a role, and the role controls what the member can reach. A role
-decides whether a member can create a project, edit an experience, control other
-members, or read a report.
-
-Give each member the smallest role that the work of that member needs.
-
-## Related
-
-- [How to invite and remove members](/how-to/invite-and-remove-members)

package/dist/docs/reference/dashboard/workspace-versioning.mdx

@@ -1,30 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Workspace versioning
-
-When you publish, Picked makes an immutable snapshot of your workspace. A project
-always serves exactly one version, the *live* version. A roll-back moves the live
-pointer of the project to an earlier snapshot. It changes no data.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/publish-history"
-  alt="The Publish history page with published workspace versions and the Live and Restore actions"
-  hide={['[data-testid="version-row-relative-time"]']}
-/>
-
-## Publish history
-
-The **Publish history** page lists each published version of every workspace in the
-project, the newest first. The version that Picked serves now carries a **Live**
-badge.
-
-## Related
-
-- [About workspaces and versions](/explanation/workspaces-and-versions) — why a roll-back
-  changes no data.
-- [How to roll back a published version](/how-to/roll-back-a-published-version)

package/dist/docs/reference/dashboard/workspaces.mdx

@@ -1,76 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Workspaces
-
-A workspace is one version of the configuration of your project. Use a workspace to hold
-a change, to see a preview of it, and to publish it when it is ready.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces"
-  alt="The workspaces list inside a project on the Picked dashboard"
-  hide={['[data-testid="workspace-row-relative-time"]']}
-/>
-
-## How workspaces work
-
-Each project has a workspace that holds your experiences, feature flags, steps, fields,
-actions, and conditions. When you make a change in the dashboard, that change stays in
-the workspace until you publish it. A change to a flow, to a feature flag, or to a step
-all behave the same way.
-
-A workspace is in one of three states:
-
-- **Live** — the workspace that the SDK serves to your visitors. Each project has
-  exactly one live workspace.
-- **Draft** — a workspace that no visitor sees. You can edit a draft, see a preview
-  of it, and publish it to make it live.
-- **Archived** — a draft that you put to one side. An archived workspace is still
-  editable, but it does not appear in the default workspaces list.
-
-## Change previews
-
-The publish modal shows a side-by-side change preview. It compares the current
-workspace against the last published snapshot. Use it to see exactly what your
-visitors get after you publish.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences?action=publish"
-  alt="The publish modal with a change preview of added experiences, steps, and conditions"
-  selector='[role="dialog"]'
-  wait='[role="dialog"]'
-  hide={['[data-testid="publish-diff-replaces-version"]']}
-  renderWidth={720}
-  renderHeight={579}
-/>
-
-The preview puts the changes into groups: experiences, feature flags, steps, fields,
-actions, and conditions. Each row shows whether the record was **added**, **removed**,
-or **modified**. For a modified record, expand the row to see which properties changed.
-
-Some changes break other records. An example is a field that you remove while other
-steps still point at it. The change preview shows a banner above the diff for these
-entries, so that you can look at them again before you publish.
-
-The first publish of a workspace has no earlier snapshot to compare against. The
-publish modal shows the contents of the workspace as the first publish, with no diff.
-
-## Unpublished changes
-
-The workspace records whether anything changed since the last publish. The toolbar then
-shows a warning badge. It counts a change to any of these:
-
-- An experience or a feature flag.
-- A step, a field, an action, or a condition.
-
-## Related
-
-- [About workspaces and versions](/explanation/workspaces-and-versions) — why a draft and
-  a version are separate.
-- [How to see a preview of a workspace](/how-to/preview-a-workspace)
-- [How to publish a workspace](/how-to/publish-a-workspace)
-- [How to archive or delete a workspace](/how-to/archive-or-delete-a-workspace)