picked 0.0.1-dev.1789541668638 → 0.0.1-dev.1793753513002

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. package/LICENSE +1 -0
  2. package/README.md +27 -12
  3. package/dist/.tsbuildinfo +1 -1
  4. package/docs/explanation/conditions-and-the-logic-engine.md +94 -0
  5. package/docs/explanation/content-references.md +99 -0
  6. package/docs/explanation/feature-flag-allocation.md +218 -0
  7. package/docs/explanation/how-picked-works.md +124 -0
  8. package/docs/explanation/how-pickedql-works.md +76 -0
  9. package/docs/explanation/pages-and-flows.md +64 -0
  10. package/docs/explanation/the-content-model.md +87 -0
  11. package/docs/explanation/the-two-apis.md +68 -0
  12. package/docs/explanation/why-server-side-rendering.md +76 -0
  13. package/docs/explanation/workspaces-and-versions.md +71 -0
  14. package/docs/how-to/add-a-step-field-or-action.md +56 -0
  15. package/docs/how-to/analytics/index.md +324 -0
  16. package/docs/how-to/archive-or-delete-a-workspace.md +59 -0
  17. package/docs/how-to/authenticate-the-cli.md +101 -0
  18. package/docs/how-to/authenticate-with-a-magic-link.md +56 -0
  19. package/docs/how-to/authenticate-with-a-password.md +68 -0
  20. package/docs/how-to/authenticate-with-an-api-key.md +60 -0
  21. package/docs/how-to/authenticate-with-oauth.md +49 -0
  22. package/docs/how-to/build-a-flow.md +106 -0
  23. package/docs/how-to/build-from-a-snapshot.md +67 -0
  24. package/docs/how-to/call-an-external-api-from-a-workflow.md +116 -0
  25. package/docs/how-to/connect-the-mcp-server.md +46 -0
  26. package/docs/how-to/create-a-content-entry.md +58 -0
  27. package/docs/how-to/create-a-project.md +40 -0
  28. package/docs/how-to/create-an-experience.md +51 -0
  29. package/docs/how-to/create-and-revoke-an-api-key.md +54 -0
  30. package/docs/how-to/debug-with-the-chrome-extension.md +57 -0
  31. package/docs/how-to/define-a-page-layout.md +54 -0
  32. package/docs/how-to/fill-and-publish-a-page.md +82 -0
  33. package/docs/how-to/install-the-gtm-template.md +84 -0
  34. package/docs/how-to/install-the-sdk.md +93 -0
  35. package/docs/how-to/install-the-vite-plugin.md +69 -0
  36. package/docs/how-to/invite-and-remove-members.md +45 -0
  37. package/docs/how-to/point-one-entry-at-another.md +73 -0
  38. package/docs/how-to/preview-a-workspace.md +39 -0
  39. package/docs/how-to/publish-a-workspace.md +42 -0
  40. package/docs/how-to/read-a-feature-flag.md +113 -0
  41. package/docs/how-to/read-a-referenced-entry.md +109 -0
  42. package/docs/how-to/register-a-component.md +55 -0
  43. package/docs/how-to/register-an-action-handler.md +85 -0
  44. package/docs/how-to/register-an-api-that-uses-oauth2.md +107 -0
  45. package/docs/how-to/render-a-step-form.md +131 -0
  46. package/docs/how-to/render-an-unpublished-preview.md +41 -0
  47. package/docs/how-to/retry-a-failed-call-with-a-loop.md +81 -0
  48. package/docs/how-to/reuse-a-section.md +64 -0
  49. package/docs/how-to/reuse-a-step-field-or-action.md +39 -0
  50. package/docs/how-to/roll-back-a-published-version.md +39 -0
  51. package/docs/how-to/run-an-ab-test.md +59 -0
  52. package/docs/how-to/run-code-on-a-form-submission.md +125 -0
  53. package/docs/how-to/server-render-a-page.md +81 -0
  54. package/docs/how-to/set-a-content-security-policy.md +32 -0
  55. package/docs/how-to/set-up-mfa.md +126 -0
  56. package/docs/how-to/switch-workspaces.md +122 -0
  57. package/docs/how-to/upload-and-use-an-asset.mdx +87 -0
  58. package/docs/how-to/validate-a-field.md +52 -0
  59. package/docs/how-to/wait-for-an-action-response.md +182 -0
  60. package/docs/how-to/write-a-condition.md +57 -0
  61. package/docs/how-to/write-a-predicate.md +60 -0
  62. package/docs/index.md +59 -0
  63. package/docs/reference/dashboard/actions.mdx +65 -0
  64. package/docs/reference/dashboard/api-keys.mdx +47 -0
  65. package/docs/reference/dashboard/conditions.mdx +51 -0
  66. package/docs/reference/dashboard/content/asset-library.mdx +74 -0
  67. package/docs/reference/dashboard/content/blocks.mdx +66 -0
  68. package/docs/reference/dashboard/content/content-entries.mdx +120 -0
  69. package/docs/reference/dashboard/content/models.mdx +119 -0
  70. package/docs/reference/dashboard/content/pages.mdx +72 -0
  71. package/docs/reference/dashboard/experiences.mdx +61 -0
  72. package/docs/reference/dashboard/external-apis.md +186 -0
  73. package/docs/reference/dashboard/features.mdx +165 -0
  74. package/docs/reference/dashboard/fields.mdx +120 -0
  75. package/docs/reference/dashboard/flow-builder/canvas.mdx +58 -0
  76. package/docs/reference/dashboard/flow-builder/condition-builder.md +69 -0
  77. package/docs/reference/dashboard/flow-builder/keyboard-shortcuts.md +72 -0
  78. package/docs/reference/dashboard/flow-builder/nodes.md +74 -0
  79. package/docs/reference/dashboard/labels.md +321 -0
  80. package/docs/reference/dashboard/lead-search.md +239 -0
  81. package/docs/reference/dashboard/leads.md +133 -0
  82. package/docs/reference/dashboard/projects.mdx +53 -0
  83. package/docs/reference/dashboard/reports.mdx +53 -0
  84. package/docs/reference/dashboard/steps.mdx +47 -0
  85. package/docs/reference/dashboard/team-management.md +38 -0
  86. package/docs/reference/dashboard/workflow-runs.md +157 -0
  87. package/docs/reference/dashboard/workflow-templates.md +182 -0
  88. package/docs/reference/dashboard/workflow-test-runs.md +108 -0
  89. package/docs/reference/dashboard/workflow-tools.md +90 -0
  90. package/docs/reference/dashboard/workspace-versioning.mdx +42 -0
  91. package/docs/reference/dashboard/workspaces.mdx +91 -0
  92. package/docs/reference/delivery-api/experience-content.md +152 -0
  93. package/docs/reference/delivery-api/index.md +45 -0
  94. package/docs/reference/delivery-api/preview-caching-crawling.md +79 -0
  95. package/docs/reference/delivery-api/project-config.md +65 -0
  96. package/docs/reference/delivery-api/workspace-schema.md +107 -0
  97. package/docs/reference/glossary.md +201 -0
  98. package/docs/reference/management-api/authentication.md +87 -0
  99. package/docs/reference/management-api/authorization-and-scopes.md +303 -0
  100. package/docs/reference/management-api/error-handling.md +232 -0
  101. package/docs/reference/management-api/pagination.md +192 -0
  102. package/docs/reference/management-api/schema/action.md +249 -0
  103. package/docs/reference/management-api/schema/analytics-session.md +376 -0
  104. package/docs/reference/management-api/schema/analytics-sign-in.md +110 -0
  105. package/docs/reference/management-api/schema/analytics.md +75 -0
  106. package/docs/reference/management-api/schema/api-key.md +162 -0
  107. package/docs/reference/management-api/schema/auth.md +1044 -0
  108. package/docs/reference/management-api/schema/cms-fields.md +1057 -0
  109. package/docs/reference/management-api/schema/cms-models.md +1146 -0
  110. package/docs/reference/management-api/schema/common.md +308 -0
  111. package/docs/reference/management-api/schema/condition.md +243 -0
  112. package/docs/reference/management-api/schema/design-system.md +207 -0
  113. package/docs/reference/management-api/schema/experience.md +1122 -0
  114. package/docs/reference/management-api/schema/external-api.md +654 -0
  115. package/docs/reference/management-api/schema/feature.md +332 -0
  116. package/docs/reference/management-api/schema/feedback.md +99 -0
  117. package/docs/reference/management-api/schema/field.md +382 -0
  118. package/docs/reference/management-api/schema/index.md +248 -0
  119. package/docs/reference/management-api/schema/integration.md +266 -0
  120. package/docs/reference/management-api/schema/label.md +293 -0
  121. package/docs/reference/management-api/schema/lead.md +318 -0
  122. package/docs/reference/management-api/schema/mcp-server.md +301 -0
  123. package/docs/reference/management-api/schema/metric.md +220 -0
  124. package/docs/reference/management-api/schema/operation.md +87 -0
  125. package/docs/reference/management-api/schema/organization.md +727 -0
  126. package/docs/reference/management-api/schema/project.md +653 -0
  127. package/docs/reference/management-api/schema/report.md +247 -0
  128. package/docs/reference/management-api/schema/saved-view.md +288 -0
  129. package/docs/reference/management-api/schema/shopify.md +922 -0
  130. package/docs/reference/management-api/schema/step.md +265 -0
  131. package/docs/reference/management-api/schema/tenant-branding.md +163 -0
  132. package/docs/reference/management-api/schema/workbench.md +234 -0
  133. package/docs/reference/management-api/schema/workflow-run.md +423 -0
  134. package/docs/reference/management-api/schema/workflow.md +1085 -0
  135. package/docs/reference/management-api/schema/workspace-version.md +774 -0
  136. package/docs/reference/management-api/schema/workspace.md +864 -0
  137. package/docs/reference/pickedql/data-sources.md +174 -0
  138. package/docs/reference/pickedql/dimensions.md +103 -0
  139. package/docs/reference/pickedql/filtering.md +64 -0
  140. package/docs/reference/pickedql/index.md +18 -0
  141. package/docs/reference/pickedql/schema.md +172 -0
  142. package/docs/reference/pickedql/virtual-functions.md +248 -0
  143. package/docs/reference/sdk/actions.md +154 -0
  144. package/docs/reference/sdk/analytics-events.md +454 -0
  145. package/docs/reference/sdk/conditions.md +147 -0
  146. package/docs/reference/sdk/content-security-policy.md +21 -0
  147. package/docs/reference/sdk/content.md +253 -0
  148. package/docs/reference/sdk/experiences.md +51 -0
  149. package/docs/reference/sdk/features.md +256 -0
  150. package/docs/reference/sdk/fields.md +255 -0
  151. package/docs/reference/sdk/index.md +68 -0
  152. package/docs/reference/sdk/plugins/create-experience.md +123 -0
  153. package/docs/reference/sdk/plugins/dynamic-experiences.md +77 -0
  154. package/docs/reference/sdk/plugins/fingerprintjs.md +39 -0
  155. package/docs/reference/sdk/plugins/hotjar.md +60 -0
  156. package/docs/reference/sdk/plugins/index.md +33 -0
  157. package/docs/reference/sdk/plugins/sentry.md +51 -0
  158. package/docs/reference/sdk/plugins/shopify.md +109 -0
  159. package/docs/reference/sdk/plugins/window-object.md +25 -0
  160. package/docs/reference/sdk/predicates.md +43 -0
  161. package/docs/reference/sdk/react.md +61 -0
  162. package/docs/reference/sdk/ssr/index.md +33 -0
  163. package/docs/reference/sdk/ssr/rendering-and-hydration.md +103 -0
  164. package/docs/reference/sdk/ssr/serialize.md +80 -0
  165. package/docs/reference/sdk/ssr/slots-and-placements.md +113 -0
  166. package/docs/reference/sdk/steps.md +86 -0
  167. package/docs/reference/sdk/svelte.md +74 -0
  168. package/docs/reference/sdk/type-generation.md +266 -0
  169. package/docs/reference/tools/admin-api-client.md +89 -0
  170. package/docs/reference/tools/chrome-extension.md +16 -0
  171. package/docs/reference/tools/cli.md +344 -0
  172. package/docs/reference/tools/delivery-api-client.md +60 -0
  173. package/docs/reference/tools/image-optimisation-service.md +104 -0
  174. package/docs/reference/tools/mcp-run.md +121 -0
  175. package/docs/reference/tools/mcp.md +524 -0
  176. package/docs/reference/tools/vite-plugin.md +193 -0
  177. package/docs/tutorials/first-api-call.md +253 -0
  178. package/docs/tutorials/first-experience-in-the-dashboard.mdx +160 -0
  179. package/docs/tutorials/first-experience.mdx +254 -0
  180. package/docs/tutorials/first-server-rendered-page.mdx +186 -0
  181. package/package.json +16 -9
package/LICENSE ADDED
@@ -0,0 +1 @@
1
+ Copyright (c) Picked. All rights reserved. Contact Picked for a usage licence.
package/README.md CHANGED
@@ -1,23 +1,18 @@
1
1
  # picked
2
2
 
3
- The Picked SDK front door. One install gives you the client, the `picked.config` helpers,
4
- and the `picked` command.
3
+ The Picked SDK in one install: the client, the `picked.config` helpers, and the `picked`
4
+ command.
5
5
 
6
- ## Installation
6
+ ## Install
7
7
 
8
8
  ```bash
9
- npm install picked
9
+ npm install picked @picked/react # or @picked/svelte
10
10
  ```
11
11
 
12
- `@picked/client` is a peer dependency and carries the runtime. Your package manager
13
- installs it for you.
12
+ `@picked/client`, which carries the runtime, installs with it as a peer dependency.
14
13
 
15
14
  ## Usage
16
15
 
17
- ```typescript
18
- import { createClient } from 'picked'
19
- ```
20
-
21
16
  ```typescript
22
17
  // picked.config.ts
23
18
  import { defineConfig } from 'picked/config'
@@ -27,10 +22,30 @@ export default defineConfig({
27
22
  })
28
23
  ```
29
24
 
25
+ ```tsx
26
+ import { createClient } from 'picked'
27
+ import { dynamicExperiencesPlugin } from '@picked/client/plugins/dynamic-experiences'
28
+ import { reactFrameworkPlugin } from '@picked/react/plugins/framework'
29
+
30
+ export const picked = createClient({
31
+ projectId: 'your-project-id',
32
+ plugins: [reactFrameworkPlugin({ components: {} }), dynamicExperiencesPlugin()],
33
+ })
34
+
35
+ picked.start()
36
+ ```
37
+
30
38
  ```bash
31
- npx picked generate types
39
+ npx picked generate types # Types for your fields, features and steps
40
+ npx picked docs list # Every documentation page; `npx picked docs read <path>` prints one
32
41
  ```
33
42
 
43
+ `picked` re-exports everything from `@picked/client`; deeper entry points such as
44
+ `@picked/client/plugins/dynamic-experiences` keep their own names.
45
+
34
46
  ## Docs
35
47
 
36
- See the [documentation](https://docs.picked.app) for the full reference.
48
+ - **Web:** [How to install the SDK](https://docs.picked.app/how-to/install-the-sdk)
49
+ - **Local:** `node_modules/picked/docs/how-to/install-the-sdk.md`. The `picked` package carries every page under `node_modules/picked/docs/`.
50
+ - **CLI:** `npx picked docs read /how-to/install-the-sdk`. `npx picked docs list [words]` lists the pages.
51
+ - **MCP:** call `read_picked_doc` with `{ "path": "/how-to/install-the-sdk" }`; `list_picked_docs` lists the pages. Add the server with `claude mcp add --transport http picked https://api.picked.app/mcp`, or see [How to connect the MCP server](https://docs.picked.app/how-to/connect-the-mcp-server) for other tools.