@picked/client 0.0.1-dev.1788925875333 → 0.0.1-next.1

package/dist/docs/how-to/server-render-a-page.md

@@ -1,81 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to server-render a page
-
-This guide shows you how to render a Picked Page on your server and hydrate it in the
-browser. You need a published Page and a server that renders React or Svelte.
-
-## 1. Make the snapshot
-
-Create one client for each request, then call `serialize()`:
-
-```ts
-import { createClient } from 'picked'
-import { serialize } from '@picked/client/server'
-
-const client = createClient(options)
-
-const snapshot = await serialize(client, {
-  projectConfig,
-  attributes: { location: { pathname: url.pathname } },
-})
-```
-
-:::warning
-Give `serialize()` one client for each request. It does not support two calls at the same
-time on one client.
-:::
-
-## 2. Embed the snapshot
-
-```ts
-const html = `
-  <div id="root">${appHtml}</div>
-  <script>window.__PICKED__ = ${JSON.stringify(snapshot)}</script>
-`
-```
-
-## 3. Seed the client and render the slot
-
-:::code-group
-
-```tsx [React]
-import { PickedProvider, ExperienceSlot } from '@picked/react'
-
-export function Page({ snapshot }) {
-  return (
-    <PickedProvider options={options} snapshot={snapshot}>
-      <ExperienceSlot name="page" />
-    </PickedProvider>
-  )
-}
-```
-
-```svelte [Svelte]
-<script lang="ts">
-  import { ExperienceSlot, setPickedContext } from '@picked/svelte'
-
-  const { snapshot } = $props()
-  setPickedContext({ options, snapshot })
-</script>
-
-<ExperienceSlot name="page" />
-```
-
-:::
-
-The provider seeds the client at once, so the server HTML and the first paint match.
-
-## 4. Point the experience at the slot
-
-Set the target selector of your Page experience to `.picked-slot-page`, then publish.
-
-## Related
-
-- [About server-side rendering](/explanation/why-server-side-rendering) — why the
-  snapshot carries condition results.
-- [Server snapshot](/reference/sdk/ssr/serialize) — every parameter.
-- [Your first server-rendered page](/tutorials/first-server-rendered-page).

package/dist/docs/how-to/set-a-content-security-policy.md

@@ -1,32 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to set a Content Security Policy
-
-This guide shows you how to let the Picked SDK load its resources under a CSP.
-
-## Steps
-
-Add the Picked domains to your policy.
-
-As an HTTP header:
-
-```
-Content-Security-Policy: connect-src 'self' https://api.picked.app https://evnts.pckd.dev; img-src 'self' https://img.picked-content.com;
-```
-
-Or as a `<meta>` tag:
-
-```html
-<meta
-  http-equiv="Content-Security-Policy"
-  content="connect-src 'self' https://api.picked.app https://evnts.pckd.dev; img-src 'self' https://img.picked-content.com;"
-/>
-```
-
-## Related
-
-- [Content Security Policy](/reference/sdk/content-security-policy) — what each domain is
-  for.

package/dist/docs/how-to/set-up-mfa.md

@@ -1,69 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to set up MFA
-
-This guide shows you how to add a second factor to an account. Every MFA mutation needs
-authentication.
-
-## 1. Add a factor
-
-```graphql
-mutation {
-  mfaFactorEnroll(input: {
-    factorType: PHONE
-    phone: "+15551234567"
-    friendlyName: "My Phone"
-  }) {
-    factor { id factorType status }
-  }
-}
-```
-
-A new factor has the status `UNVERIFIED`.
-
-## 2. Send a challenge
-
-```graphql
-mutation {
-  mfaChallengeSend(input: { factorId: "factor-id" }) {
-    challengeId
-  }
-}
-```
-
-This sends a code to the telephone number of the factor.
-
-## 3. Verify the challenge
-
-```graphql
-mutation {
-  mfaChallengeVerify(input: {
-    factorId: "factor-id"
-    challengeId: "challenge-id"
-    code: "123456"
-  }) {
-    session { accessToken refreshToken aal }
-  }
-}
-```
-
-The session moves to `AAL2`, and the factor status changes to `VERIFIED`.
-
-## Remove a factor
-
-```graphql
-mutation {
-  mfaFactorUnenroll(input: { factorId: "factor-id" }) {
-    success
-  }
-}
-```
-
-## Related
-
-- [Authorization and scopes](/reference/management-api/authorization-and-scopes) — which
-  operations need `AAL2`.
-- [Authentication](/reference/management-api/authentication) — every mutation.

package/dist/docs/how-to/switch-workspaces.md

@@ -1,122 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to switch workspaces
-
-This guide shows you how to point your local tooling at a different project or workspace.
-Your application then renders that workspace's content and types on your machine. It expects
-a `picked.config.ts` and the [CLI](/reference/tools/cli).
-
-Your tooling reads the project and surface named in the committed `picked.config.ts`. The
-CLI writes your choice to `.picked/settings.json` instead. That file is per-developer and
-Git ignores it, so the committed default stays as it is and one command puts it back.
-
-See [Workspaces](/reference/dashboard/workspaces) for what Live, Draft, and Archived mean.
-
-## 1. Sign in
-
-```bash
-picked login
-```
-
-This opens your browser for a one-time OAuth sign-in and stores a session under
-`~/.picked/`. Confirm it with `picked whoami`. See
-[CLI authentication](/how-to/authenticate-the-cli).
-
-## 2. Find a workspace
-
-```bash
-picked workspace list
-```
-
-```
-Acme Corp. (acme-corporation)
-  Storefront [proj_a1b2]
-    Default Storefront [LIVE] (live)
-    Checkout rework [DRAFT]
-```
-
-Note the **project id** (`proj_a1b2`) and the name or the id of the workspace you want.
-
-## 3. Switch to the draft
-
-```bash
-picked workspace use --project proj_a1b2 --workspace ws_draft
-```
-
-```
-Active workspace: Checkout rework [DRAFT] in project proj_a1b2 (source: preview)
-Generated types at /app/src/picked-env.d.ts
-```
-
-A command that names **one specific workspace** (draft, live, or archived):
-
-- writes the selection (and its [preview token](/reference/delivery-api/preview-caching-crawling)) to
-  `.picked/settings.json`,
-- switches the resolved `source` to `preview` for that project, and
-- regenerates `picked-env.d.ts` from that workspace's schema (skip with `--no-generate`).
-
-To browse instead, run `picked workspace use` with no flags. The interactive picker lists
-every project, with **Published (live version)** and each of its workspaces.
-
-## 4. See the draft in your app
-
-Both readers of the selection use `.picked/settings.json` with no change to your
-configuration:
-
-- **Type generation** now reads the draft schema. Rerun `picked generate types` after more
-  edits.
-- The **[Vite plugin](/reference/tools/vite-plugin)** reads the draft's configuration and
-  content in development and in a build. It sends the preview token to the
-  [Delivery API](/reference/delivery-api). Restart the dev server to apply a switch.
-
-Your application renders the unpublished draft on your machine, with types.
-
-## 5. Switch back to live
-
-```bash
-picked workspace use --project proj_a1b2
-```
-
-A command that names a project with no `--workspace`, or **Published (live version)** in the
-picker, discards the preview token and returns `source` to `published`. To confirm what is
-active:
-
-```bash
-picked status
-```
-
-```
-Config default: project proj_a1b2 (source: published)
-Active selection: none (using the config default).
-```
-
-## CI and headless runs
-
-`.picked/settings.json` is a local, per-developer file. Do not commit it. To choose one
-workspace in CI with no selection file, set the environment directly:
-
-```bash
-PICKED_PROJECT_ID=proj_a1b2 \
-PICKED_PREVIEW_TOKEN="$DRAFT_TOKEN" \
-  picked generate types --check
-```
-
-`PICKED_PREVIEW_TOKEN` applies only when the resolved `source` is `preview`. See the
-[CLI environment variables](/reference/tools/cli#environment-variables) for the full
-precedence order.
-
-:::note
-A preview token is a long-lived credential for one workspace. Keep it out of the version
-control system, as you do with each other credential. Git ignores `.picked/settings.json`
-for this reason, because `picked workspace use` writes a token there.
-:::
-
-## Related
-
-- [CLI](/reference/tools/cli) — every command and flag.
-- [Workspaces](/reference/dashboard/workspaces) — Live, Draft, and Archived states.
-- [Type generation](/reference/sdk/type-generation) — how the schema becomes types.
-- [Preview, cache, and crawlers](/reference/delivery-api/preview-caching-crawling) — preview tokens on the Delivery API.

package/dist/docs/how-to/upload-and-use-an-asset.mdx

@@ -1,73 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-import { Screenshot } from '../../../components/Screenshot'
-
-# How to upload and use an asset
-
-This guide shows you how to put a file in the asset library and point at it from your
-content.
-
-## 1. Add the field to a layout
-
-Two field types point at the library:
-
-- An **Asset** field takes an image, a video, or a document.
-- An **HTML** field takes a `.html` file.
-
-Add one of them to a page layout or a step layout.
-
-## 2. Choose a file
-
-1. Open the content entry.
-2. Click **Choose file** on the asset field. On a field that holds a value already, click
-   **Replace**.
-3. Open the **Upload** tab to add a new file.
-4. Open the **Library** tab to use a file that is there already.
-5. Choose your asset.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/design-systems/new"
-  wait='button:has-text("Upload file")'
-  click='button:has-text("Upload file")'
-  selector="[role=dialog]"
-  alt="The asset picker modal on the Picked dashboard, with the Library tab, its search box, its type filter, and its Sort menu"
-  renderWidth={1072}
-  renderHeight={790}
-/>
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/design-systems/new"
-  wait='button:has-text("Upload file")'
-  click='button:has-text("Upload file")'
-  selector="[role=dialog]"
-  alt="The asset picker modal on the Picked dashboard, with the Library tab, its search box, its type filter, and its Sort menu"
-  renderWidth={1072}
-  renderHeight={790}
-/>
-
-The detail panel on the right shows the kind, the dimensions, the size, and the upload
-date.
-
-## 3. Find an asset in a large library
-
-The **Library** tab has three controls, and the server applies each one across the whole
-library:
-
-- **Search by name** narrows the list by file name while you type.
-- The type filter narrows the list to one media type. **All types** is the default.
-- **Sort** orders the list by **Name**, **Date created**, or **Date updated**.
-
-Click **Load more** at the bottom to read the next page of results.
-
-:::tip
-Each row has an **Open in new tab** control. Use it to check an asset again before you
-choose it. Your choice in the picker stays as it is.
-:::
-
-## Related
-
-- [Asset library](/reference/dashboard/content/asset-library) — the limits, the file
-  types, and how Picked serves an uploaded file.

package/dist/docs/how-to/validate-a-field.md

@@ -1,52 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to validate a field
-
-This guide shows you how to check what a visitor enters. Write the rule in JSON Logic. The
-`$input` variable holds the current value of the field.
-
-## Steps
-
-Add a `validation` rule to `createField()`:
-
-```ts
-import { createField } from '@picked/client/plugins/create-experience'
-
-const quantityField = createField({
-  id: 'quantity',
-  name: 'quantity',
-  type: 'number',
-  label: 'Quantity',
-  multiple: false,
-  required: true,
-  validation: {
-    catch: {
-      or: [
-        {
-          and: [
-            { '>': [{ var: '$input' }, 0] },
-            { '<=': [{ var: '$input' }, 999] },
-          ],
-        },
-        { throw: 'Please enter a value between 1 and 999' },
-      ],
-    },
-  },
-})
-```
-
-:::tip
-The `catch` and `throw` pattern checks that the condition gives `true`. When it does not,
-the SDK shows the `throw` message to your visitor.
-:::
-
-The SDK runs the rule on blur and on submit.
-
-## Related
-
-- [SDK fields](/reference/sdk/fields) — every field option.
-- [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
-  the rule format.

package/dist/docs/how-to/write-a-condition.md

@@ -1,45 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to write a condition
-
-This guide shows you how to build a rule in the visual condition builder. The builder
-appears on a condition node, on an experience condition, on an initialize-open condition,
-and on a field option.
-
-## Steps
-
-1. Choose the node or the field that takes the condition.
-2. Find the **Logic** section in the inspector.
-3. Choose a data source: **Responses**, **Actions**, **Feature flags**, **Conditions**,
-   or **Window Location**.
-4. Choose an operator. The choices include equals, not equals, greater than, and
-   contains.
-5. Enter a value.
-
-## Join more than one rule
-
-1. Create an AND group or an OR group.
-2. Add your rules inside it.
-
-With **AND** every rule must match. With **OR** one rule must match. Put a group inside
-another group to build a larger rule.
-
-## Example
-
-To show a step only to a visitor who is on one page and who accepted marketing:
-
-1. Create an AND group.
-2. Add a rule: **Window Location → pathname** equals `/pricing`.
-3. Add a rule: **Responses → `marketing_opt_in`** equals `true`.
-
-The group matches only when both rules are true.
-
-## Related
-
-- [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
-  what a rule can read.
-- [Condition builder](/reference/dashboard/flow-builder/condition-builder) — the rule
-  structure.

package/dist/docs/how-to/write-a-predicate.md

@@ -1,60 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to write a predicate
-
-This guide shows you how to let a condition read data that only your application holds,
-such as a cart total or an account level.
-
-## 1. Define the predicate
-
-Pass a `predicates` object to `createClient()`:
-
-```ts
-import { createClient } from 'picked'
-
-const client = createClient({
-  projectId: 'your-project-id',
-  predicates: {
-    'is-example-page': ({ location }) => location?.pathname === '/example',
-    'get-account-tier': async () => {
-      const data = await fetch('/api/get-account-tier').then((r) => r.json())
-      return data.result
-    },
-  },
-})
-```
-
-A predicate returns a boolean, a string, an array of strings, or `undefined`. It can also
-return a promise that resolves to one of those.
-
-## 2. Invoke it from a condition
-
-```ts
-condition: {
-  '==': [
-    { invoke: { var: 'predicates.is-example-page' } },
-    true,
-  ],
-}
-```
-
-:::tip
-A predicate also works inside `validation` logic.
-:::
-
-## Keep it pure and fast
-
-- The same snapshot must always give the same result.
-- Check that a response or a field is there before you read its value. Return `undefined`
-  when the data is not available, and do not throw.
-- The SDK can invoke a predicate many times, so keep the logic small.
-- Do not change the snapshot. It is frozen, and a change to it throws in strict mode.
-
-## Related
-
-- [Predicates](/reference/sdk/predicates) — the state snapshot shape.
-- [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
-  why predicates exist.

package/dist/docs/index.md

@@ -1,59 +0,0 @@
----
-type: map
-layout: docs
----
-
-# Picked documentation
-
-Picked lets you build personalized UI flows in a visual editor. The SDK then serves them
-to the visitors on your site.
-
-There are two paths to follow. Choose the one that matches your work.
-
-## Work in the dashboard
-
-Build experiences, write content, and publish.
-
-Start with [build your first experience](/tutorials/first-experience-in-the-dashboard).
-It takes you from an empty project to a survey on your own site, and it needs no
-development tools.
-
-One thing must happen first: a developer adds the Picked SDK to your site one time. After
-that, the dashboard is all you need.
-
-Then:
-
-- **[Build](/how-to/create-an-experience)** — experiences, flows, conditions, and A/B
-  tests.
-- **[Content](/how-to/define-a-page-layout)** — Models, Blocks, entries, pages, and assets.
-- **[Publish](/how-to/publish-a-workspace)** — preview, publish, and roll back.
-- **[Administer and measure](/how-to/invite-and-remove-members)** — members, API keys,
-  analytics, and the tools that connect Picked to Google Tag Manager and to an AI tool.
-- **[Dashboard reference](/reference/dashboard/projects)** — every dashboard screen and
-  every option, plus the [glossary](/reference/glossary).
-- **[How Picked works](/explanation/how-picked-works)** — what happens when you publish.
-
-## Integrate with code
-
-Add Picked to a site or an application. Your code then renders the experiences that the
-dashboard describes.
-
-Start with [add Picked to your application](/tutorials/first-experience). It goes from an
-empty project to a survey that runs in React or in Svelte.
-
-Read the dashboard documents above also. Everything your code renders is described
-there, so the two paths link to each other rather than repeat.
-
-Then:
-
-- **[Integrate the SDK](/how-to/install-the-sdk)** — install, register a component, read
-  a feature flag.
-- **[Build a step form](/how-to/render-a-step-form)** — render fields, act on a
-  submission, validate input.
-- **[Server-side rendering](/how-to/server-render-a-page)** — a page that a search engine
-  can read.
-- **[Authenticate](/how-to/authenticate-with-a-password)** — the management API.
-- **[SDK reference](/reference/sdk)**, **[Delivery API](/reference/delivery-api)**,
-  **[PickedQL](/reference/pickedql)**.
-- **[Why it works this way](/explanation/why-server-side-rendering)** — the design
-  behind the SDK.

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

@@ -1,53 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Actions
-
-An action is a side effect that starts when the flow reaches it. Use an action to
-track an event, to send data to an external service, or to call a webhook.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/actions"
-  alt="The actions list for a workspace on the Picked dashboard"
-/>
-
-## Set up an action
-
-**Name**: The name that the dashboard shows. Your visitors do not see it.
-
-**Key**: The identifier that your application uses for this action. Your visitors do
-not see it.
-
-## Register in your application
-
-Each action key must match a key in the `actions` object that you pass to
-`createClient()`. See
-[How to register an action handler](/how-to/register-an-action-handler) for the code, and
-[SDK actions](/reference/sdk/actions) for what the handler receives and returns.
-
-## Use actions in flows
-
-In the flow builder, drag an action from the library onto the canvas. Connect it to
-the point in the flow where you want it to start.
-
-An action runs when the flow reaches its node. It does not interrupt your visitor. By
-default the flow continues to the next connected node.
-
-An action node can carry a **success** branch and a **failure** branch. Which one the flow
-takes depends on whether your handler throws, and a returned `false` is a success. See
-[How an action decides which way to go](/explanation/how-picked-works#how-an-action-decides-which-way-to-go).
-
-## Reuse actions
-
-An action belongs to the project. Use the same action in more than one experience flow.
-A change to the options of an action applies at every place that uses it.
-
-## Related
-
-- [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
-- [How to register an action handler](/how-to/register-an-action-handler)
-- [SDK actions](/reference/sdk/actions) — what the handler receives and returns.

package/dist/docs/reference/dashboard/api-keys.mdx

@@ -1,38 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# API keys
-
-An API key lets your code reach the Picked API. Use one where your own code calls the API,
-such as a server-side integration. It does not sign the
-[CLI](/reference/tools/cli) in.
-
-<Screenshot
-  route="/{orgSlug}/api-keys"
-  alt="The API keys list for an organization on the Picked dashboard"
-/>
-
-## Use an API key
-
-Put your API key in the `x-api-key` header of each request to the
-[Picked API](/tutorials/first-api-call).
-
-```
-x-api-key: your-api-key
-```
-
-## Scopes
-
-An API key carries scopes, and the scopes limit what the key can reach. Choose the
-scopes that your integration needs when you create the key. A key can do only the
-operations that its scopes permit.
-
-## Related
-
-- [How to create and revoke an API key](/how-to/create-and-revoke-an-api-key)
-- [How to authenticate with an API key](/how-to/authenticate-with-an-api-key) — the API
-  side.