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

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.

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

@@ -1,51 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Experiences
-
-An experience is personalized content that Picked serves to the visitors on your
-site. Each experience points at a component that you register in your application.
-
-An experience is either a **Flow** or a **Page**. A **Flow** is an interactive
-experience of more than one step, and the browser renders it. This page covers the
-flow. A **Page** is a standalone experience that the server renders from CMS content,
-for a landing page where the search rank matters. See [Pages](/reference/dashboard/content/pages) for
-that kind.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences"
-  alt="The experiences list for a workspace on the Picked dashboard"
-/>
-
-## Experience settings
-
-Choose no node on the canvas, or click the canvas background, to open the experience
-inspector in the right panel.
-
-**Name**: The name that the dashboard shows. Your visitors do not see it.
-
-**Component Name**: The identifier that points this experience at a component in your
-application.
-
-**Condition**: An optional condition. When you set it, the experience starts only for
-a visitor who matches the condition. See
-[Condition Builder](/reference/dashboard/flow-builder/condition-builder) for how to write one. Keep it
-blank to start the experience for every visitor.
-
-**Initialize Open**: An optional condition that controls whether the experience opens
-by itself when the page loads. When it is blank, the experience loads but stays
-closed until something opens it.
-
-## Experience list
-
-The experiences list shows every experience in the current project. Click an
-experience to open it in the flow builder.
-
-## Related
-
-- [About pages and flows](/explanation/pages-and-flows) — Page or Flow.
-- [How to create an experience](/how-to/create-an-experience)

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

@@ -1,154 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Feature flags
-
-A feature flag lets you run an A/B test and roll a change out in stages. It controls
-which visitors see a change to your site, and you deploy no code.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/features"
-  alt="The feature flags list for a workspace on the Picked dashboard"
-/>
-
-## Keys
-
-Each feature flag has a unique key. Your application uses this key to check whether
-Picked allocates a visitor to the feature flag. You set the key when you create the
-feature flag, and you cannot change it later.
-
-## Types
-
-Each feature flag has a type. You set the type when you create the feature flag, and you
-cannot change it later.
-
-| Type | What your site receives | Groups |
-| --- | --- | --- |
-| **Boolean** | `true` or `false` | Two |
-| **Text** | A string that you write, or `false` for the control group | Two or more |
-
-Choose **Boolean** for one change against no change. Choose **Text** when you must test
-several changes at the same time, and each change needs its own group.
-
-## Set the allocation
-
-Set the allocation from the detail page of the feature flag:
-
-| Control | What it does |
-| --- | --- |
-| **Enabled** | Whether Picked allocates a visitor to the feature flag. A disabled feature flag allocates nobody, and it records nothing. See [Disable a feature flag](#disable-a-feature-flag). |
-| **Weight** | The percentage of visitors that Picked allocates to a Boolean feature flag, from 0 to 100. |
-| **Variants** | The groups of a Text feature flag, and the traffic that each one receives. See [Variants](#variants). |
-| **Description** | An internal note about what the feature flag tests. |
-
-A Boolean feature flag has one weight. For each visitor it gives one of two outcomes:
-allocated, or not allocated. A weight of 30 allocates 30% of your visitors. The other
-70% stay unallocated. A weight of 0 allocates nobody. A weight of 100 allocates
-everybody.
-
-## Variants
-
-A Text feature flag has a table of variants. Each row is one group of visitors:
-
-| Column | What it does |
-| --- | --- |
-| **Name** | A label for the variant. It appears in your reports. You can change it at any time. |
-| **Value** | The string that your site receives for a visitor in this variant. |
-| **Weight** | The share of traffic for this variant, against the other rows. |
-
-The first row is **Control**. Picked always sends `false` to a visitor in the control
-group, and you cannot remove the row, move it, or change its value. It takes a weight like
-any other row.
-
-The weights are shares, and not percentages. Picked reduces them to their smallest whole
-numbers, so `10 : 10 : 20` and `1 : 1 : 2` are the same split. The percentage beside each
-row shows the traffic that the variant receives.
-
-Choose **Even split** to give every variant the same weight.
-
-:::info
-The order of the rows is the order that you read them in. It has no effect on the
-allocation, so you can move a row and no visitor changes group.
-:::
-
-## How Picked allocates a visitor
-
-The allocation is deterministic. It derives from the visitor ID and from the ID of the
-feature flag. A Boolean feature flag then compares that value against the weight, and a
-Text feature flag compares it against the range of each variant. Each feature flag gets its
-own value, so tests that run at the same time are independent. See
-[About feature flag allocation](/explanation/feature-flag-allocation).
-
-## Disable a feature flag
-
-A disabled feature flag allocates nobody, and it records nothing. The difference
-from a weight of 0 matters for your reports. The visitor is **not in the test at
-all**, and the visitor is not in the control group.
-
-The SDK does not evaluate a disabled feature flag. It stores no decision in the
-browser of the visitor, and it reports no decision to your analytics. Such a feature
-flag is absent from the feature list on every analytics event.
-
-An experience whose condition points at a disabled feature flag behaves as though
-the visitor is not in the test. The condition reads as not allocated, and Picked
-records no assignment.
-
-This state is temporary, and it discards no decision that Picked made already. A
-visitor who was allocated before keeps that decision in the browser. When you enable the
-feature flag again, Picked continues from that decision, and the visitor stays in the
-group they were already in.
-
-:::note
-Expect a step change in your reports when you disable a feature flag: fewer feature
-flags for each visitor, and fewer decision events. That is the feature flag that drops
-out, and you lose no data.
-:::
-
-A disabled feature flag stays visible in the developer tools, and a
-[URL override](/reference/sdk/features#overrides-in-the-url) still turns one on for QA.
-
-## Feature flag versions
-
-Each feature flag has a version number, and it starts at 1. The SDK caches an
-allocation decision in the browser of the visitor under a key, and the version is part
-of that key. The version does nothing else, and it is not an input to the allocation
-value. When you increment the version, the SDK discards those cached decisions. It
-then evaluates every visitor again on the next page load.
-
-### What happens when you increment the version
-
-- **The SDK invalidates the cached decisions.** The cache key holds the version, so the
-  old entry no longer matches and the feature flag counts as undecided.
-- **Picked evaluates each visitor against the current weight.** The allocation is
-  deterministic and the version is not one of its inputs, so the same visitor against
-  an unchanged weight gives the same result.
-- **You cannot reverse this.** There is no way to decrement a version.
-
-:::note
-The new version does not move your visitors between groups. It clears the cached
-decisions and runs the allocation again. With an unchanged weight, everybody lands
-where they were before. Change the weight to move your visitors.
-:::
-
-### When to increment
-
-Increment the version after you change the weight. Do this when you want Picked to
-evaluate an allocated visitor again against the new weight, and not to use the cached
-decision.
-
-### When not to increment
-
-To apply a weight change only to a visitor that Picked does not allocate yet, change
-the weight and leave the version as it is. An allocated visitor keeps the current
-allocation.
-
-## Related
-
-- [About feature flag allocation](/explanation/feature-flag-allocation)
-- [How to run an A/B test](/how-to/run-an-ab-test)
-- [How to read a feature flag](/how-to/read-a-feature-flag)
-- [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)