@picked/client 0.0.101-next.1 → 0.0.101-next.3

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,56 +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
-
-A published action that starts a workflow needs no code in your application. The SDK
-sends the request to Picked, and the workflow runs there.
-
-To run your own code, pass a handler under the action key in `createClient()`. That handler
-replaces the workflow for this key. 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.

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

@@ -1,42 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Conditions
-
-A condition evaluates a rule and splits the flow into two paths. One path is for a
-true result, the other for a false result.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/conditions"
-  alt="The conditions list for a workspace on the Picked dashboard"
-/>
-
-## Set up a condition
-
-**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.
-
-## Branches
-
-In the flow builder, a condition node has two output handles. The green handle, for a
-true result, leads to the path for a match. The red handle, for a false result, leads
-to the other path.
-
-You can chain conditions. Connect the output of one condition to the input of another
-to build a decision tree.
-
-## Related
-
-- [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
-
-- [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine) —
-  what a rule can read.
-- [How to write a condition](/how-to/write-a-condition)
-- [Condition builder](/reference/dashboard/flow-builder/condition-builder) — the data
-  sources and the rule structure.

package/dist/docs/reference/dashboard/content/asset-library.mdx

@@ -1,63 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../../components/Screenshot'
-
-# Asset Library
-
-The Asset Library holds the files that your content points at. These are images,
-video, documents, and HTML.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/assets"
-  alt="The asset library on the Picked dashboard"
-/>
-
-## Upload and control your assets
-
-The Asset Library is a project-level store. Upload a file, then point at it from any
-Content Entry in the project.
-
-- **Size limit:** 50 MB for each file.
-- **Allowed types:** an image in PNG, JPEG, WebP, AVIF, GIF, or SVG. A video in MP4
-  or WebM. A common document format. HTML, as `text/html`.
-
-Picked rejects a file of another type. It also rejects a file above the size limit.
-
-## HTML assets
-
-Upload a `.html` file and point at it from an **HTML asset** field. Picked then scans
-the file. The scan is advisory: it helps you, and it never stops you. It
-reports findings about speed, about search rank, and about accessibility, so that you
-can improve the file before you publish it:
-
-- **File size:** a warning at 100 KB, and a stronger one at 250 KB.
-- **Inline images:** a note when inline `base64` image data adds about 50 KB or more.
-- **Image dimensions:** an image with no width and no height. Such an image can move
-  the content around it while the page loads.
-- **Lazy load:** an image with no `loading="lazy"` attribute.
-- **Link safety:** an external link with `target="_blank"` and no `rel="noopener"`.
-- **Link search rank:** an external link with no `rel="nofollow"`.
-- **Accessibility:** a pass by `axe-core`. It covers alt text, heading order,
-  contrast, and more.
-
-Every finding is advisory. You can always upload the file as it is.
-
-## How assets are served
-
-Picked serves each asset from a sandboxed storage origin. That origin is separate
-from the trusted origin of your application. HTML therefore comes from its own
-origin, so a document that you upload runs in isolation and cannot reach the page
-that holds it. A script in that document cannot read a session, a token, or the DOM
-around it, because each of those needs same-origin access.
-
-An [Experience Content](/reference/delivery-api/experience-content) response can hold an HTML
-asset. The response then carries the content of that asset, and the SDK renders it
-with no second request to storage.
-
-## Related
-
-- [How to upload and use an asset](/how-to/upload-and-use-an-asset)
-- [Fields](/reference/dashboard/fields) — the field type for an HTML asset.

package/dist/docs/reference/dashboard/content/blocks.mdx

@@ -1,57 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../../components/Screenshot'
-
-# Blocks
-
-A Block is a reusable schema fragment that you embed inside a Model, so that a common structure is defined one time.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/blocks"
-  alt="The blocks list in the schema builder on the Picked dashboard"
-/>
-
-## What a Block is
-
-A Block is a schema fragment with its own **Key**. A
-[Model](/reference/dashboard/content/models) gives its shape to a whole Page or Step. A
-Block is a part that you put into one or more Models. Define the shape one time, then
-reuse it everywhere.
-
-A Block holds no data of its own. The content that fills a Block sits inside the entry
-of the Model that embeds it.
-
-## Where a Block appears
-
-**CMS** in the sidebar holds **Blocks**, and that list shows every Block in the
-workspace. **Pages** holds **Page Sections**, which is the same list limited to the
-Section category.
-
-## Category
-
-| Category | What it does |
-| --- | --- |
-| **Section** | Marks the Block as a page section. A **Page Sections** field accepts it. |
-| **None (general content)** | Gives the Block no layout role. |
-
-The category is fixed when you create the Block. You cannot change it later.
-
-A **Content block** field holds the category of the Blocks that it accepts. Give that
-field the **Section** category to build a page section list.
-
-A field set to **Any category** accepts every Block in the workspace. This is the only
-kind of field that can hold a Block with no category.
-
-## Field types
-
-A Block holds the same field types as a Model. See
-[Field types](/reference/dashboard/content/models#field-types).
-
-## Related
-
-- [About the content model](/explanation/the-content-model) — why Blocks exist.
-- [How to reuse a section](/how-to/reuse-a-section)
-- [Models](/reference/dashboard/content/models)

package/dist/docs/reference/dashboard/content/content-entries.mdx

@@ -1,95 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../../components/Screenshot'
-
-# Content Entries
-
-A content entry is one instance of a Model, filled with real data. A Page renders one entry, and a Flow Step can render one too.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/content"
-  alt="The content entries list on the Picked dashboard"
-/>
-
-## What a content entry is
-
-A content entry is an instance of the schema of a
-[Model](/reference/dashboard/content/models). The Model sets the fields, and the entry
-holds the values. One Model backs many entries, and each entry holds its own data.
-
-The Model of an entry is fixed when you create the entry.
-
-## The entries list
-
-**CMS** in the sidebar holds **Content entries**, with a count of every entry in the
-workspace.
-
-| Column | What it shows |
-| --- | --- |
-| Title | The value of the first single-line text field of the entry. It falls back to the entry id when no such field holds a value. |
-| Model | The Model that the entry belongs to. |
-| Entry ID | The stable id of the entry. |
-| Last updated | When somebody last saved the entry. |
-
-The **Model** filter narrows the list to one Model. The list has no search, because the
-title is derived at read time and is not a column that Picked can search.
-
-## How entries bind to pages and steps
-
-A [Page](/reference/dashboard/content/pages) has a single Step, and that Step links to
-its entry through the layout content link. A Flow [Step](/reference/dashboard/steps)
-with a Step Layout binds an entry the same way. When the SDK renders the Page or the
-Step, it resolves the linked entry and gives the data to your component.
-
-## Edit entry data
-
-The entry editor renders a form from the schema of the Model. There is one input for
-each field, in the order that the schema sets. A repeatable field shows as a sortable
-list. You can add to that list and put it into a new order. A group field holds its
-inputs under one heading.
-
-## Reference fields
-
-A [Reference field](/reference/dashboard/content/models#reference-fields) holds a pointer
-at another entry, and not a copy of it.
-
-| Control | What it does |
-| --- | --- |
-| **Choose entry** | Opens the entry picker. |
-| **Change entry** | Opens the entry picker on a field that holds a target already. |
-| **Clear** | Removes the pointer. It does not delete the entry. |
-
-The entry picker lists the entries that the **Target Model** of the field allows, and it
-has a search box. **Open model** opens the Model of an entry in a new tab.
-
-## Validation
-
-Invalid data shows as an error on each field. The error carries a path in the JSON style,
-and it points at the exact place in the entry, for example `sections[0].data.title`.
-
-A reference field reports an error when its target does not exist, or when the target
-belongs to the wrong Model. Fix every error before you publish, because Picked serves
-valid content only.
-
-## Delete rules
-
-Picked does not delete an entry while something still points at it.
-
-| Condition | Result |
-| --- | --- |
-| A Step uses the entry as its layout | The delete stops. |
-| Another entry points at it through a Reference field | The delete stops. |
-
-Clear the reference on the other entry first, then delete the target.
-
-## Related
-
-- [About the content model](/explanation/the-content-model) — why the schema and the data
-  are separate.
-- [About content references](/explanation/content-references) — why a delete stops.
-- [How to create a content entry](/how-to/create-a-content-entry)
-- [How to point one entry at another](/how-to/point-one-entry-at-another)
-- [Models](/reference/dashboard/content/models)

package/dist/docs/reference/dashboard/content/models.mdx

@@ -1,108 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../../components/Screenshot'
-
-# Models
-
-A Model is a reusable schema. It sets which fields a piece of content can hold, and it holds no data itself.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/models"
-  alt="The models list in the schema builder on the Picked dashboard"
-/>
-
-## Where a Model appears
-
-**CMS** in the sidebar holds **Models**, and that list shows every Model in the
-workspace. The list shows the **Key** below the name, because the key is the value that
-a schema holds.
-
-Two shortcuts open a filtered subset of the same list. **Flows** holds **Step Layouts**,
-and **Pages** holds **Page Layouts**.
-
-## Category
-
-A category gives a Model a role. It decides where the Model appears, and what renders an
-entry that comes from it.
-
-| Category | It gives its shape to | What renders it |
-| --- | --- | --- |
-| **Page layout** | A standalone [Page](/reference/dashboard/content/pages). | The SDK renders the entry on your server. |
-| **Step layout** | One [Step](/reference/dashboard/steps) inside a Flow. | The Step renders the entry in the browser. |
-| **None (general content)** | Content with no layout role. | Nothing renders it directly. A [reference field](#reference-fields) reaches it. |
-
-A Model with no category holds content that other content points at, such as a product
-or a category. It appears under **CMS** only.
-
-:::warning
-The category is fixed when you create the Model. You cannot change it later.
-:::
-
-## Field types
-
-A Model is built from fields. Each field has a type. The type decides the editor for the
-field, and the shape of the value that the field holds.
-
-| Type | Holds | Use it for |
-| --- | --- | --- |
-| **Single line text** | A short string. | A title, a label, or a short headline. |
-| **Multi-line text** | A longer plain string. | A description, or a paragraph with no format marks. |
-| **Markdown** | A Markdown string. | Body copy with format marks. |
-| **Slug** | A URL-safe string. | A part of a path, or an identifier. |
-| **Number** | A numeric value. | A price, a count, or a rating. |
-| **Boolean** | A true or false value. | A toggle or a flag. |
-| **Date** | A date value. | A publish date or a deadline. |
-| **Color** | A color value. | A theme accent or a swatch. |
-| **JSON** | Any JSON value. | Structured data with no editor of its own. |
-| **Group** | An object of fields inside the Model. | A set of related fields, held together. |
-| **Content block** | A [Block](/reference/dashboard/content/blocks) schema inside the Model. | A shared schema fragment that you reuse. |
-| **Page Sections** | A repeatable Content block field, limited to the Section category. | The section list of a page. |
-| **Reference** | A pointer at another [content entry](/reference/dashboard/content/content-entries). | A product that points at its category. |
-| **Asset** | A link to an [Asset Library](/reference/dashboard/content/asset-library) item. | An image, a video, or a document. |
-| **HTML** | A link to a `.html` file in your library. | HTML that you wrote before, held inside the content. |
-
-## Reference fields
-
-A **Reference** field points at another content entry. The entry that you point at keeps
-its own data, and many fields can point at the same entry.
-
-| Option | Values | What it does |
-| --- | --- | --- |
-| **Target Model** | A Model, or **Any Model** | Limits which entries an editor can choose. |
-| **Repeatable** | On or off | On gives an ordered list of entries. Off gives one entry. |
-
-**Target Model** holds the `key` of the Model, and not its id. A duplicate of the
-workspace therefore keeps the constraint.
-
-A reference stays inside one workspace. A field cannot point at an entry in another
-workspace, and Picked reports such a target as unknown.
-
-## Repeatable and grouped fields
-
-You can make any field **repeatable**. It then shows as a sortable list of values, and
-not as one value. Use it for a gallery, for a list of features, or for any collection.
-
-A **Group** field holds a set of fields under one key, and it gives a structured object.
-Make a group repeatable to describe a list of objects, such as a list of feature cards.
-
-## Delete rules
-
-Picked does not delete a Model while something still needs it.
-
-| Condition | Result |
-| --- | --- |
-| Content entries still belong to the Model | The delete stops. |
-| A Reference field still holds the Model as its **Target Model** | The delete stops. |
-
-## Related
-
-- [About the content model](/explanation/the-content-model) — why a schema change does not
-  migrate your data.
-- [About content references](/explanation/content-references) — why a reference is a pointer.
-- [How to define a page layout](/how-to/define-a-page-layout)
-- [How to create a content entry](/how-to/create-a-content-entry)
-- [How to point one entry at another](/how-to/point-one-entry-at-another)
-- [Blocks](/reference/dashboard/content/blocks)

package/dist/docs/reference/dashboard/content/pages.mdx

@@ -1,61 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../../components/Screenshot'
-
-# Pages
-
-A Page is a standalone, server-rendered experience backed by CMS content, built for SEO-critical landing pages.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences"
-  alt="The experiences list, where Pages and Flows are created on the Picked dashboard"
-/>
-
-## Edit page content
-
-The Page editor has two tabs. The **Properties** tab holds the content of the page.
-The **Settings** tab holds its name, its condition, and its layout. Fill in the
-fields on the **Properties** tab. The inspector on the right edits the field that you
-choose, and the preview panel shows the page while it fills in.
-
-## Status
-
-The **Settings** tab has a status control. It has two values.
-
-| Value | Effect |
-| --- | --- |
-| **Active** | Picked serves the page to everyone. |
-| **Draft** | Picked keeps the page out of the published site. |
-
-A draft page is absent from the published payload. Picked also holds back the
-steps, fields and actions that only that page uses, and it does not serve the
-page content. A visitor and a search-engine crawler receive nothing.
-
-To see a draft page, open it with a preview link. See
-[How to see a preview of a workspace](/how-to/preview-a-workspace). One preview
-link opens every draft page in the workspace.
-
-Status applies to Flows and to Pages. It is not the same as the status of the
-workspace: a draft page can be in a live workspace.
-
-:::warning
-Status is part of the published version. Change the value, then publish the
-workspace to apply the change to the live site.
-:::
-
-## Change or remove the layout
-
-Use the change-layout control on the **Settings** tab to move the page to another
-[Page Layout](/reference/dashboard/content/models#category). When you unlink a layout,
-Picked separates the content entry from the page. It deletes no entry, but the page then
-has no content to render until you attach a layout again.
-
-## Related
-
-- [About pages and flows](/explanation/pages-and-flows) — when to choose a Page.
-- [How to fill and publish a page](/how-to/fill-and-publish-a-page)
-- [How to server-render a page](/how-to/server-render-a-page)
-- [Models](/reference/dashboard/content/models) — the schema behind a Page.