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

package/dist/docs/how-to/archive-or-delete-a-workspace.md

@@ -1,46 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to archive or delete a workspace
-
-This guide shows you how to take a draft workspace out of use. Archive it when you want
-to keep it. Delete it only when you are certain, because you cannot reverse a delete.
-
-You cannot archive or delete a live workspace. Make a different workspace live first.
-
-## Archive a workspace
-
-1. Open the workspace settings page.
-2. Click **Archive workspace** in the page header.
-3. Confirm in the modal.
-
-The workspace leaves the default list. It stays editable.
-
-## Unarchive a workspace
-
-1. Open the workspace settings page.
-2. Click **Unarchive workspace** in the page header.
-
-## Delete a workspace
-
-1. Open the workspace settings page.
-2. Click **Delete workspace**.
-3. Confirm in the modal.
-
-Picked removes the workspace, and everything in it, permanently.
-
-## Rename a workspace
-
-1. Open the workspace settings page.
-2. Change the **Workspace name** field.
-3. Click **Save changes**.
-
-A name is unique inside a project. The dashboard rejects a duplicate name.
-
-## Related
-
-- [About workspaces and versions](/explanation/workspaces-and-versions) — why Picked keeps
-  these two operations separate.
-- [Workspaces](/reference/dashboard/workspaces) — the settings reference.

package/dist/docs/how-to/authenticate-the-cli.md

@@ -1,97 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to authenticate the CLI
-
-This guide shows you how to install the `picked` command and sign it in. Commands that read
-your organizations, projects, and workspaces then know who you are. It expects a Picked
-account and a project directory to work in.
-
-## 1. Install the CLI
-
-:::code-group
-
-```bash [npm]
-npm install picked
-```
-
-```bash [pnpm]
-pnpm add picked
-```
-
-```bash [yarn]
-yarn add picked
-```
-
-:::
-
-The binary is `picked`. Run it from the directory that holds your `picked.config.ts`, so it
-reads your configuration and writes your selection next to it.
-
-## 2. Sign in
-
-```bash
-picked login
-```
-
-The command opens your browser for a one-time sign-in and prints your identity:
-
-```
-Opening your browser to sign in...
-https://api.picked.app/…/oauth/authorize?…
-Logged in as you@example.com (https://api.picked.app)
-```
-
-The CLI stores the session in `~/.picked/auth/<origin>.json`. It refreshes the session as it nears expiry.
-
-## 3. Confirm the session
-
-```bash
-picked whoami
-```
-
-```
-you@example.com (https://api.picked.app)
-```
-
-Each command acts on the API origin your current directory resolves to, and on no other. To
-end the session for that origin:
-
-```bash
-picked logout
-```
-
-```
-Logged out of https://api.picked.app.
-```
-
-## Run the CLI in CI
-
-`picked generate types` reads the workspace schema, not your account, so CI needs no
-session for it. A workspace you read with `source: 'preview'` needs that workspace's token.
-Run `picked workspace use` once on your machine, then give CI the two values it wrote:
-
-```bash
-PICKED_PROJECT_ID=your-project-id \
-PICKED_PREVIEW_TOKEN=$YOUR_CI_SECRET \
-picked generate types --check
-```
-
-`picked workspace list` and `picked workspace use` read your organizations and projects, so
-those two do need a session. Run them on your machine, where a browser can sign you in.
-
-:::note
-This is a developer session for local tooling. It is not the same as an
-[API key](/reference/dashboard/api-keys), which authenticates server-to-server delivery and
-management calls, or [dashboard sign-in](/reference/management-api/authentication). Use an
-API key for an application; use `picked login` for the CLI on your machine.
-:::
-
-## Related
-
-- [CLI](/reference/tools/cli) — every command, flag, and environment variable.
-- [How to switch workspaces](/how-to/switch-workspaces) — the draft-preview workflow.
-- [How to create and revoke an API key](/how-to/create-and-revoke-an-api-key) — credentials
-  for applications.

package/dist/docs/how-to/authenticate-with-a-magic-link.md

@@ -1,40 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to authenticate with a magic link
-
-This guide shows you how to sign a user in through an email address, with no password.
-
-## 1. Send the link
-
-```graphql
-mutation {
-  magicLinkSend(input: {
-    email: "user@example.com"
-    redirectUrl: "https://app.example.com/auth/verify"
-  }) {
-    success
-  }
-}
-```
-
-The user receives an email, and the link in it holds a token.
-
-## 2. Verify the token
-
-```graphql
-mutation {
-  magicLinkVerify(input: {
-    email: "user@example.com"
-    token: "token-from-magic-link"
-  }) {
-    session { accessToken refreshToken }
-  }
-}
-```
-
-## Related
-
-- [Authentication](/reference/management-api/authentication) — every mutation.

package/dist/docs/how-to/authenticate-with-a-password.md

@@ -1,51 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to authenticate with a password
-
-This guide shows you how to get an access token from an email address and a password.
-
-## 1. Create a session
-
-```graphql
-mutation {
-  sessionCreate(input: {
-    email: "user@example.com"
-    password: "secure-password"
-  }) {
-    session { accessToken refreshToken expiresAt }
-    requiresMfa
-  }
-}
-```
-
-When `requiresMfa` is `true`, complete the challenge first. See
-[How to set up MFA](/how-to/set-up-mfa).
-
-## 2. Send the token
-
-```
-Authorization: Bearer <accessToken>
-```
-
-## 3. Refresh before it expires
-
-The `expiresAt` field gives the time at which the access token expires.
-
-```graphql
-mutation {
-  sessionRefresh(input: { refreshToken: "v1.refresh-token..." }) {
-    session { accessToken refreshToken expiresAt }
-  }
-}
-```
-
-The API invalidates the earlier refresh token. This mutation needs no `Authorization`
-header.
-
-## Related
-
-- [Authentication](/reference/management-api/authentication) — every mutation.
-- [Your first API call](/tutorials/first-api-call).

package/dist/docs/how-to/authenticate-with-an-api-key.md

@@ -1,51 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to authenticate with an API key
-
-This guide shows you how to authenticate a server-to-server integration. An API key gives
-access for a long time, inside a set of scopes.
-
-## 1. Create the key
-
-Only a user with a session can create a key. Another API key cannot.
-
-```graphql
-mutation {
-  apiKeyCreate(input: {
-    organizationId: "org-id"
-    name: "CI/CD Pipeline Key"
-    projectId: "project-id"
-    scopes: [ORGANIZATION_READ, ORGANIZATION_PROJECTS_READ]
-  }) {
-    apiKey
-  }
-}
-```
-
-The response holds the full key one time only. Keep it in a secure place.
-
-The scopes that you ask for must all be scopes of the user who creates the key.
-
-## 2. Send the key
-
-```
-x-api-key: pk_live_abc123...
-```
-
-## 3. Revoke the key
-
-```graphql
-mutation {
-  apiKeyRevoke(input: { keyId: "key-id", organizationId: "org-id" })
-}
-```
-
-## Related
-
-- [Authorization and scopes](/reference/management-api/authorization-and-scopes) — every
-  scope.
-- [How to create and revoke an API key](/how-to/create-and-revoke-an-api-key) — the
-  dashboard path.

package/dist/docs/how-to/authenticate-with-oauth.md

@@ -1,40 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to authenticate with OAuth
-
-This guide shows you how to sign a user in through Google.
-
-## 1. Get the authorization URL
-
-```graphql
-mutation {
-  oauthAuthorize(input: {
-    provider: GOOGLE
-    redirectUrl: "https://app.example.com/auth/callback"
-    scopes: ["openid", "email", "profile"]
-  }) {
-    url
-  }
-}
-```
-
-## 2. Send the user to that URL
-
-Google authenticates the user and sends them back with a `code` parameter.
-
-## 3. Exchange the code
-
-```graphql
-mutation {
-  oauthCallback(input: { provider: GOOGLE, code: "auth-code-from-google" }) {
-    session { accessToken refreshToken expiresAt }
-  }
-}
-```
-
-## Related
-
-- [Authentication](/reference/management-api/authentication) — every mutation.

package/dist/docs/how-to/build-a-flow.md

@@ -1,83 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to build a flow
-
-This guide shows you how to put a flow together on the canvas. You need an experience
-first. See [How to create an experience](/how-to/create-an-experience).
-
-## Add nodes
-
-Drag a step, an action, or a condition from the library onto the canvas. A new
-node appears where you drop it.
-
-You can also drop a block directly onto an arrow that is there already. The flow
-builder puts the node into the line. The first arrow splits into two arrows, with the
-new node between them. A **+** indicator appears when you hold the pointer over a
-valid arrow.
-
-## Connect nodes
-
-Click the output handle of a node, on the right side. Drag to the input handle of
-another node, on the left side. An arrow then joins the two nodes.
-
-The flow follows the arrows from left to right, and it starts at the origin. Every
-node after the origin is part of the experience flow.
-
-## Branch with conditions
-
-Connect the origin, or any other node, to a condition node. The condition evaluates
-its rule and sends the flow down one of two paths.
-
-Connect the green handle, for a true result, to the nodes that must run when the
-condition holds. Connect the red handle, for a false result, to the other path. Each
-path can lead to more steps, more actions, and more conditions.
-
-## Assign fields to steps
-
-Drag a field from the library onto a step node and drop it. That step then
-holds the field.
-
-You can assign more than one field to one step. The step node gives the number of
-assigned fields. To see which fields it holds, choose the step. Then read the **Fields**
-section in the inspector.
-
-## Choose nodes
-
-Click a node to choose it. Its inspector opens in the right panel.
-
-Drag on empty canvas to choose every node inside a rectangle. Press `Cmd/Ctrl+A` to
-choose every node.
-
-When you choose more than one node, the inspector gives a count and a list in groups.
-Click an item in that list to open its inspector.
-
-## Move nodes
-
-Drag a node to move it. Each node snaps to the grid.
-
-Use the arrow keys to move a node a small distance. Hold `Shift` to move it further.
-
-## Delete nodes
-
-Choose one or more nodes. Press `Delete` or `Backspace`. The flow builder removes
-those nodes and every arrow that joins them.
-
-## Duplicate nodes
-
-Choose one or more nodes. Press `Cmd/Ctrl+D`. A copy of each node appears next to the
-first one.
-
-## Undo and redo
-
-Press `Cmd/Ctrl+Z` to undo. Press `Cmd/Ctrl+Shift+Z` to redo. The undo stack records
-each node that you add, each node that you delete, each connection, and each move.
-
-## Related
-
-- [Canvas](/reference/dashboard/flow-builder/canvas) — the panels and the view controls.
-- [Nodes](/reference/dashboard/flow-builder/nodes) — every node type.
-- [Keyboard shortcuts](/reference/dashboard/flow-builder/keyboard-shortcuts)
-- [About how Picked works](/explanation/how-picked-works) — why a flow is a graph.

package/dist/docs/how-to/connect-the-mcp-server.md

@@ -1,38 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to connect the MCP server
-
-This guide shows you how to control your Picked workspace from an AI tool that writes
-code. The server URL is `https://api.picked.app/mcp`.
-
-## Claude Desktop
-
-1. Open **Settings > Connectors > Add custom connector**.
-2. Set **Name** to `Picked`.
-3. Set **URL** to `https://api.picked.app/mcp`.
-4. Click **Connect**.
-5. Answer the authorization prompt.
-
-## Claude Code, Cursor, Windsurf, and others
-
-Add `.mcp.json` to the root of your repository:
-
-```json
-{
-  "mcpServers": {
-    "picked": {
-      "type": "http",
-      "url": "https://api.picked.app/mcp"
-    }
-  }
-}
-```
-
-Cursor reads the same content from `.cursor/mcp.json`.
-
-## Related
-
-- [MCP server](/reference/tools/mcp) — every tool that the server gives you.

package/dist/docs/how-to/create-a-content-entry.md

@@ -1,48 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to create a content entry
-
-This guide shows you how to make one instance of a Model and fill it with data. You need
-a Model first. See [How to define a page layout](/how-to/define-a-page-layout).
-
-A Page makes its own entry when you create the page. Use this guide for the content that
-no Page and no Step owns, such as an author or a product.
-
-## 1. Open the entries list
-
-1. Open your workspace.
-2. Click **CMS** in the sidebar.
-3. Click **Content entries**.
-
-## 2. Create the entry
-
-1. Click **New content**.
-2. Choose the **Model** for the entry.
-3. Fill in each field. The form comes from the schema of the Model.
-4. Click **Create entry**.
-
-The Model is fixed when you create the entry. To move content to another Model, make a
-new entry and copy the values across.
-
-## 3. Correct every error
-
-An invalid field shows an error next to it while you edit. The error carries the path to
-the exact field. Correct each one before you publish, because Picked serves valid content
-only.
-
-## Find an entry again
-
-The entries list shows a title for each entry. The title is the first single-line text
-field of the entry. It shows the entry id when no such field holds a value.
-
-Use the **Model** filter to narrow the list to one Model.
-
-## Related
-
-- [Content entries](/reference/dashboard/content/content-entries) — the editor reference.
-- [Models](/reference/dashboard/content/models) — every field type.
-- [How to point one entry at another](/how-to/point-one-entry-at-another)
-- [How to publish a workspace](/how-to/publish-a-workspace)

package/dist/docs/how-to/create-a-project.md

@@ -1,29 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to create a project
-
-This guide shows you how to add a project. A project is one site or one application, and
-it holds its own experiences, content, and options.
-
-## Steps
-
-1. Open your organization.
-2. Click **New project**.
-3. Enter a name.
-4. Click **Create project**.
-
-The project home page opens. It shows your SDK snippet and the setup tasks that are still
-open.
-
-## Next
-
-Copy the snippet and add it to your site. See
-[How to install the SDK](/how-to/install-the-sdk).
-
-## Related
-
-- [Projects](/reference/dashboard/projects) — the project surface.
-- [Add Picked to your application](/tutorials/first-experience) — the whole path.

package/dist/docs/how-to/create-an-experience.md

@@ -1,42 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to create an experience
-
-An experience is a Flow or a Page. This guide adds a **Flow**: the interactive kind, of
-more than one step, which the browser renders. A **Page** is the standalone kind that your
-server renders for a search engine, and
-[How to fill and publish a page](/how-to/fill-and-publish-a-page) covers it.
-
-[About pages and flows](/explanation/pages-and-flows) sets out the difference, and which
-kind a piece of work needs.
-
-## Steps
-
-1. Open your project.
-2. Click **Flows** in the sidebar. The experiences list opens.
-3. Click **New experience**.
-4. Enter a name.
-5. Leave **Type** on the **Flow** option.
-6. Open **Advanced**.
-7. Enter a component name. It must match a component that you register in your
-   application.
-8. Click **Create flow**.
-
-The flow editor opens with an empty canvas.
-
-## Set the options
-
-Click the canvas background to open the experience inspector.
-
-- **Condition** — the experience starts only for a visitor who matches it. Keep it blank
-  to start for every visitor.
-- **Initialize Open** — the experience opens by itself when the page loads.
-
-## Related
-
-- [How to build a flow](/how-to/build-a-flow) — add your first node.
-- [About pages and flows](/explanation/pages-and-flows) — Page or Flow.
-- [Experiences](/reference/dashboard/experiences) — every option.

package/dist/docs/how-to/create-and-revoke-an-api-key.md

@@ -1,42 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to create and revoke an API key
-
-This guide shows you how to give your code access to the Picked API. Use a key where your
-own code calls the API, such as a server-side integration.
-
-An API key does not sign the [CLI](/reference/tools/cli) in. The CLI reads a session, which
-`picked login` writes. See
-[How to authenticate the CLI](/how-to/authenticate-the-cli) for the commands that CI can
-run without one.
-
-## Create a key
-
-1. Open your organization.
-2. Click **API Keys**.
-3. Click **Create API Key**.
-4. Enter a **Name**, such as `Production key`.
-5. Set **Project** to one project. The default, **All projects**, gives the key every
-   project.
-6. Choose the **Permissions** that your integration needs.
-7. Click **Create API Key**.
-
-:::warning
-Copy the key immediately. The dashboard does not show it again.
-:::
-
-## Revoke a key
-
-1. Open the API keys list.
-2. Click **Revoke** next to the key.
-3. Click **Revoke Key** to confirm.
-
-Picked invalidates the key immediately. No later request can use it.
-
-## Related
-
-- [API keys](/reference/dashboard/api-keys) — the scopes.
-- [Authentication](/reference/management-api/authentication) — how to send the key.

package/dist/docs/how-to/debug-with-the-chrome-extension.md

@@ -1,57 +0,0 @@
----
-type: how-to
-layout: docs
----
-
-# How to debug with the Chrome extension
-
-This guide shows you how to add a Picked panel to Chrome DevTools and check your
-integration on any page that runs the SDK.
-
-## 1. Install the extension
-
-Install it from the
-[Chrome Web Store](https://chromewebstore.google.com/detail/picked-developer-tools/nimmdamgnhlhdpngnalkpmnleebngidh).
-
-## 2. Add the devtools plugin
-
-```typescript
-import { createClient } from 'picked'
-import { svelteDevtoolsPlugin } from '@picked/svelte/plugins/devtools'
-
-const picked = createClient({
-  projectId: 'your-project-id',
-  plugins: [svelteDevtoolsPlugin()],
-})
-```
-
-The extension then connects to the SDK.
-
-## 3. Add a tool of your own
-
-A custom tool is a framework-adapted component, and it receives the live Picked client
-exactly as an experience component does.
-
-```typescript
-import { adaptReactComponent } from '@picked/react'
-import { svelteDevtoolsPlugin } from '@picked/svelte/plugins/devtools'
-import MyTool from './MyTool'
-
-const picked = createClient({
-  projectId: 'your-project-id',
-  plugins: [
-    svelteDevtoolsPlugin({
-      customTools: [
-        { id: 'my-tool', label: 'My Tool', component: adaptReactComponent(MyTool) },
-      ],
-    }),
-  ],
-})
-```
-
-Your tools appear under a **Custom Tools** tab. In React use `usePicked()`, and in Svelte
-use `getPicked()`.
-
-## Related
-
-- [Chrome extension](/reference/tools/chrome-extension) — the panel reference.