@sanity/personalization-plugin 2.5.0-launch-darkly.1 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/personalization-plugin",
-  "version": "2.5.0-launch-darkly.1",
+  "version": "2.5.0",
   "description": "Plugin to help with personalization, a/b testing when using Sanity",
   "keywords": [
     "sanity",
@@ -54,43 +54,43 @@
     "prepare": "husky"
   },
   "dependencies": {
-    "@sanity/incompatible-plugin": "^1.0.4",
-    "@sanity/studio-secrets": "^3.0.1",
-    "@sanity/ui": "^2.8.19",
+    "@sanity/incompatible-plugin": "^1.0.5",
+    "@sanity/studio-secrets": "^3.0.2",
+    "@sanity/ui": "^2.16.12",
     "@sanity/uuid": "^3.0.2",
     "fast-deep-equal": "^3.1.3",
-    "react-icons": "^5.4.0",
+    "react-icons": "^5.5.0",
     "suspend-react": "^0.1.3"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.7.1",
-    "@commitlint/config-conventional": "^19.7.1",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@sanity/pkg-utils": "^6.13.4",
     "@sanity/plugin-kit": "^4.0.19",
     "@sanity/semantic-release-preset": "^5.0.0",
-    "@types/react": "^18.3.18",
-    "@typescript-eslint/eslint-plugin": "^8.23.0",
-    "@typescript-eslint/parser": "^8.23.0",
+    "@types/react": "^18.3.23",
+    "@typescript-eslint/eslint-plugin": "^8.39.1",
+    "@typescript-eslint/parser": "^8.39.1",
     "eslint": "^8.57.1",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-prettier": "^9.1.2",
     "eslint-config-sanity": "^7.1.4",
-    "eslint-plugin-prettier": "^5.2.3",
-    "eslint-plugin-react": "^7.37.4",
-    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.2.0",
     "husky": "^9.1.7",
     "lint-staged": "^15.2.10",
-    "prettier": "^3.4.2",
-    "prettier-plugin-packagejson": "^2.5.8",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "sanity": "^3.74.1",
-    "semantic-release": "^24.2.1",
-    "styled-components": "^6.1.15",
-    "typescript": "^5.7.3"
+    "prettier": "^3.6.2",
+    "prettier-plugin-packagejson": "^2.5.19",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "sanity": "^5.0.1",
+    "semantic-release": "^24.2.7",
+    "styled-components": "^6.1.19",
+    "typescript": "^5.9.2"
   },
   "peerDependencies": {
     "react": "^18 || ^19",
-    "sanity": "^3 || ^4.0.0-0"
+    "sanity": "^3 || ^4.0.0-0 || ^5.0.0"
   },
   "engines": {
     "node": ">=18"

package/src/components/ExperimentItem.tsx

@@ -0,0 +1,10 @@
+import {ObjectItem, ObjectItemProps, set} from 'sanity'
+
+export const ExperimentItem = (props: ObjectItemProps) => {
+  const {active} = props.value as ObjectItem & {active: boolean}
+  if (!active) {
+    props.inputProps.onChange(set(true, ['active']))
+  }
+
+  return props.renderDefault(props)
+}

package/src/components/VariantInput.tsx

@@ -2,7 +2,8 @@ import {Button, Inline, Stack} from '@sanity/ui'
 import {ObjectInputProps, set, useFormValue} from 'sanity'
 
 export const VariantInput = (props: ObjectInputProps) => {
-  const defaultValue = useFormValue([props.path[0], 'default'])
+  const experimentPath = props.path.slice(0, -2)
+  const defaultValue = useFormValue([...experimentPath, 'default'])
   const handleClick = () => {
     props.onChange(set(defaultValue, ['value']))
   }

package/src/fieldExperiments.tsx

@@ -11,6 +11,7 @@ import {ArrayInput} from './components/Array'
 import {CONFIG_DEFAULT, ExperimentProvider} from './components/ExperimentContext'
 import {ExperimentField} from './components/ExperimentField'
 import {ExperimentInput} from './components/ExperimentInput'
+import {ExperimentItem} from './components/ExperimentItem'
 import {VariantInput} from './components/VariantInput'
 import {VariantPreview} from './components/VariantPreview'
 import {FieldPluginConfig} from './types'
@@ -47,6 +48,7 @@ const createExperimentType = ({
           variantNameOverride={variantNameOverride}
         />
       ),
+      item: ExperimentItem,
     },
     fields: [
       typeof field === `string`
@@ -112,7 +114,7 @@ const createExperimentType = ({
         experiment: experimentId,
       },
       prepare: ({base, experiment}) => {
-        const title = base?.title || base?.name || ''
+        const title = base?.title || base?.name || typeof base === 'string' ? base : ''
         const experimentTitle = experiment ? `Experiment: ${experiment}` : ''
         const media = base?.image || base?.photo || base?.media || ''
         return {

package/src/launchDarkly/launchdarkly.md

@@ -1,76 +0,0 @@
-# @sanity/personalization-plugin - launchDarklyFieldLevel
-
-## Previously know as @sanity/personalisation-plugin
-
-> This is a **Sanity Studio v3** plugin.
-
-This plugin allows users to add a/b/n testing experiments to individual fields connecting to the [LaunchDarkly](https://launchdarkly.com//) A/B testing service.
-
-- [@sanity/personalization-plugin - launchDarklyFieldLevel](#sanitypersonalization-plugin---launchDarklyFieldLevel)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [Loading Experiments](#loading-experiments)
-
-This plugin is built on top of the `fieldLevelExperiments` export so see the main readme for details of:
-
-- [Using complex field configurations](/#using-complex-field-configurations)
-- [Validation of individual array items](/#validation-of-individual-array-items)
-- [Shape of stored data](/#shape-of-stored-data)
-- [Querying data](/#querying-data)
-- [License](#license)
-- [Develop \& test](#develop--test)
-  - [Release new version](#release-new-version)
-- [License](#license-1)
-
-## Installation
-
-```sh
-npm install @sanity/personalization-plugin
-```
-
-## Usage
-
-Add it as a plugin in `sanity.config.ts` (or .js):
-
-```ts
-import {defineConfig} from 'sanity'
-import {fieldLevelExperiments} from '@sanity/personalization-plugin/launchDarkly'
-
-export default defineConfig({
-  //...
-  plugins: [
-    //...
-    launchDarklyFieldLevel({
-      fields: ['string'],
-      projectKey: 'string', // required filter parameter for fetching features/variants
-      tags: ['string'] //optional parameter that filters the list to flags that have all of the tags in the list
-    }),
-  ],
-})
-```
-
-This will register two new fields to the schema., based on the setting passed into `fields:`
-
-- `flagString` an Object field with `string` field called `default`, a `string` field called `flagId` and an array field of type:
-- `variantsString` an object field with a `string` field called `value`, a string field called `variantId`, a `string` field called `flagId`.
-
-Use the flag field in your schema like this:
-
-```ts
-//for Example in post.ts
-
-fields: [
-  defineField({
-    name: 'title',
-    type: 'flagString',
-  }),
-]
-```
-
-## Loading Experiments
-
-This plugin uses [@sanity/studio-secrets](https://www.npmjs.com/package/@sanity/studio-secrets) for storing your Launch Darkly API key. The first time you open a document that has an experiment you will be asked to provide your API key. This is stored in a private document on the dataset.
-
-Once you have entered you API key the plugin will fetch feature flags and variants flags. If features/variants are updated on LaunchDarkly you will need to refresh the page.
-
-The values stored for an flag will be the Feature Key amd the variants will stored the variation value.