@sanity/personalization-plugin 2.1.0-growthbook.1 → 2.2.0-launch-darkly.1

package/README.md

@@ -25,8 +25,6 @@ Once configured you can query the values using the ids of the experiment and var
     - [Release new version](#release-new-version)
   - [License](#license-1)
 
-For Specific information about the growthbookFieldLevel export see its [readme](/growthbook.md)
-
 ## Installation
 
 ```sh
@@ -85,8 +83,8 @@ export default defineConfig({
 
 This will register two new fields to the schema., based on the setting passed intto `fields:`
 
-- `experimentString` an Object field with `string` field called `default`, a `string` field called `experimentId` and an array field of type:
-- `varirantsString` an object field with a `string` field called `value`, a string field called `variantId`, a `string` field called `experimentId`.
+- `experimentString` an Object field with `string` field called `default`, a `string` field called `experimentId` and an array field called `variants` of type:
+- `variantString` an object field with a `string` field called `value`, a string field called `variantId`, a `string` field called `experimentId`.
 
 Use the experiment field in your schema like this:
 
@@ -202,7 +200,7 @@ export default defineConfig({
 
 This would also create two new fields in your schema.
 
-- `experimentFeaturedProduct` an Object field with `reference` field called `default`, a `string` field called `experimentId` and an array field of type:
+- `experimentFeaturedProduct` an Object field with `reference` field called `default`, a `string` field called `experimentId` and an array field called `variants` of type:
 - `variantFeaturedProduct` an object field with a `reference` field called `value`, a string field called `variandId`, a `string` field called `experimentId`.
 
 Note that the name key in the field gets rewritten to value and is instead used to name the object field.
@@ -242,7 +240,7 @@ The custom input contains buttons which will add new array items with the experi
 ```json
 "title": {
   "default": "asdf",
-  "experimentValue": "test-1",
+  "experimentId": "test-1",
   "variants": [
     {
       "experimentId": "test-1",
@@ -267,6 +265,62 @@ Using GROQ filters you can query for a specific experitment, with a fallback to
 }
 ```
 
+## Overwriting the experiment and variant field names
+
+If your use case does not match exactly with experiments you can overwrite the name field names for experiment and variant in the config.
+
+```ts
+import {defineConfig} from 'sanity'
+import {fieldLevelExperiments} from '@sanity/personalization-plugin'
+
+export default defineConfig({
+  //...
+  plugins: [
+    //...
+    fieldLevelExperiments({
+      fields: ['string'],
+      experiments: [experiment1, experiment2],
+      experimentNameOverride: 'audience',
+      variantNameOverride: 'segment',
+    }),
+  ],
+})
+```
+
+This would also create two new fields in your schema.
+
+- `audienceString` an Object field with `string` field called `default`, a `string` field called `audienceId` and an array field called `segments` of type:
+- `segmentString` an object field with a `string` field called `value`, a string field called `segmentId`, a `string` field called `audienceId`.
+
+the data will be stored as
+
+```json
+"title": {
+  "default": "asdf",
+  "audienceId": "test-1",
+  "segments": [
+    {
+      "audienceId": "test-1",
+      "value": "asdf",
+      "segmentId": "test-1-a"
+    },
+    {
+      "audienceId": "test-1",
+      "segmentId": "test-1-b",
+      "value": "qwer"
+    }
+  ]
+}
+```
+
+This will also affect the query you write to fetch data to be:
+
+```ts
+*[_type == "post"] {
+"title":coalesce(title.segments[audienceId == $audience && segmentId == $segment][0].value, title.default),
+}
+```
+
 ## License
 
 [MIT](LICENSE) © Jon Burbridge

package/dist/index.d.mts

@@ -10,7 +10,9 @@ import {SchemaType} from 'sanity'
 import {SetStateAction} from 'react'
 
 export declare type ArrayInputProps = ArrayOfObjectsInputProps & {
-  objectName: string
+  variantName: string
+  variantId: string
+  experimentId: string
 }
 
 export declare type ExperimentContextProps = Required<FieldPluginConfig> & {
@@ -23,11 +25,15 @@ export declare type ExperimentGeneric<T> = {
   _type: string
   default?: T
   experimentValue?: string
-  variants?: Array<
-    {
-      _key: string
-    } & VariantGeneric<T>
-  >
+  [key: string]:
+    | Array<
+        {
+          _key: string
+        } & VariantGeneric<T>
+      >
+    | string
+    | T
+    | undefined
 }
 
 export declare type ExperimentType = {
@@ -40,10 +46,13 @@ export declare const fieldLevelExperiments: Plugin_2<FieldPluginConfig>
 
 export declare type FieldPluginConfig = {
   fields: (string | FieldDefinition)[]
-  experiments:
-    | ExperimentType[]
-    | ((client: SanityClient, secret?: string) => Promise<ExperimentType[]>)
+  experiments: ExperimentType[] | ((client: SanityClient) => Promise<ExperimentType[]>)
   apiVersion?: string
+  experimentNameOverride?: string
+  variantNameOverride?: string
+  variantId?: string
+  variantArrayName?: string
+  experimentId?: string
 }
 
 /**
@@ -51,218 +60,208 @@ export declare type FieldPluginConfig = {
  */
 export declare function flattenSchemaType(schemaType: SchemaType): ObjectFieldWithPath[]
 
-export declare type GrowthbookABConfig = {
+export declare const launchDarklyFieldLevel: Plugin_2<LaunchDarklyFieldLevelConfig>
+
+export declare type LaunchDarklyFieldLevelConfig = {
   fields: (string | FieldDefinition)[]
-  environment: string
-  baseUrl?: string
-  project?: string
-  convertBooleans?: boolean
+  projectKey: string
+  tags?: string[]
 }
 
-export declare type GrowthbookExperiment = {
-  id: string
-  dateCreated: string
-  dateUpdated: string
+export declare type LaunchDarklyFlagItem = {
   name: string
-  project: string
-  hypothesis: string
-  description: string
-  tags: [string]
-  owner: string
-  archived: boolean
-  status: string
-  autoRefresh: boolean
-  hashAttribute: string
-  fallbackAttribute: string
-  hashVersion: number
-  disableStickyBucketing: boolean
-  bucketVersion: number
-  minBucketVersion: number
-  variations: [
-    {
-      variationId: string
-      key: string
-      name: string
-      description: string
-      screenshots: [string]
-    },
-  ]
-  phases: [
-    {
-      name: string
-      dateStarted: string
-      dateEnded: string
-      reasonForStopping: string
-      seed: string
-      coverage: 0
-      trafficSplit: [
-        {
-          variationId: string
-          weight: 0
-        },
-      ]
-      namespace: {
-        namespaceId: string
-        range: []
-      }
-      targetingCondition: string
-      savedGroupTargeting: [
-        {
-          matchType: string
-          savedGroups: [string]
-        },
-      ]
-    },
-  ]
-  settings: {
-    datasourceId: string
-    assignmentQueryId: string
-    experimentId: string
-    segmentId: string
-    queryFilter: string
-    inProgressConversions: string
-    attributionModel: string
-    statsEngine: string
-    regressionAdjustmentEnabled: boolean
-    goals: [
-      {
-        metricId: string
-        overrides: {
-          delayHours: 0
-          windowHours: 0
-          window: string
-          winRiskThreshold: 0
-          loseRiskThreshold: 0
-        }
-      },
-    ]
-    secondaryMetrics: [
-      {
-        metricId: string
-        overrides: {
-          delayHours: 0
-          windowHours: 0
-          window: string
-          winRiskThreshold: 0
-          loseRiskThreshold: 0
+  kind: string
+  key: string
+  _version: number
+  creationDate: number
+  variations: Array<{
+    value: boolean
+    _id: string
+    name: string
+  }>
+  temporary: boolean
+  tags: string[]
+  _links: {
+    parent: {
+      href: string
+      type: string
+    }
+    self: {
+      href: string
+      type: string
+    }
+  }
+  experiments: {
+    baselineIdx: number
+    items: Array<{
+      metricKey: string
+      _metric: {
+        _id: string
+        _versionId: string
+        key: string
+        name: string
+        kind: string
+        _links: {
+          parent: {
+            href: string
+            type: string
+          }
+          self: {
+            href: string
+            type: string
+          }
         }
-      },
-    ]
-    guardrails: [
-      {
-        metricId: string
-        overrides: {
-          delayHours: 0
-          windowHours: 0
-          window: string
-          winRiskThreshold: 0
-          loseRiskThreshold: 0
+        tags: string[]
+        _creationDate: number
+        experimentCount: number
+        metricGroupCount: number
+        _attachedFlagCount: number
+        maintainerId: string
+        _maintainer: {
+          _links: {
+            self: {
+              href: string
+              type: string
+            }
+          }
+          _id: string
+          role: string
+          email: string
+          firstName: string
+          lastName: string
         }
-      },
-    ]
-    activationMetric: {
-      metricId: string
-      overrides: {
-        delayHours: 0
-        windowHours: 0
-        window: string
-        winRiskThreshold: 0
-        loseRiskThreshold: 0
+        category: string
+        isNumeric: boolean
+        percentileValue: number
       }
-    }
+    }>
   }
-  resultSummary: {
-    status: string
-    winner: string
-    conclusions: string
-    releasedVariationId: string
-    excludeFromPayload: boolean
+  customProperties: {
+    key: {
+      name: string
+      value: string[]
+    }
   }
-}
-
-export declare type GrowthbookFeature = {
-  id: string
-  dateCreated: string
-  dateUpdated: string
   archived: boolean
   description: string
-  owner: string
-  project: string
-  valueType: string
-  defaultValue: string
-  tags: string[]
+  maintainerId: string
+  _maintainer: {
+    _links: {
+      self: {
+        href: string
+        type: string
+      }
+    }
+    _id: string
+    role: string
+    email: string
+    firstName: string
+    lastName: string
+  }
+  maintainerTeamKey: string
+  _maintainerTeam: {
+    key: string
+    name: string
+    _links: {
+      parent: {
+        href: string
+        type: string
+      }
+      roles: {
+        href: string
+        type: string
+      }
+      self: {
+        href: string
+        type: string
+      }
+    }
+  }
+  archivedDate: number
+  deprecated: boolean
+  deprecatedDate: number
+  defaults: {
+    onVariation: number
+    offVariation: number
+  }
+  _purpose: string
+  migrationSettings: {
+    contextKind: string
+    stageCount: number
+  }
   environments: {
     [key: string]: {
-      enabled: boolean
-      defaultValue: string
-      rules: {
-        description: string
-        condition: string
-        savedGroupTargeting: {
-          matchType: string
-          savedGroups: string[]
-        }[]
-        id: string
-        enabled: boolean
+      on: boolean
+      archived: boolean
+      salt: string
+      sel: string
+      lastModified: number
+      version: number
+      _site: {
+        href: string
         type: string
-        value: string
+      }
+      _environmentName: string
+      trackEvents: boolean
+      trackEventsFallthrough: boolean
+      targets: Array<{
+        values: string[]
+        variation: number
+        contextKind: string
+      }>
+      contextTargets: Array<{
+        values: string[]
+        variation: number
+        contextKind: string
+      }>
+      rules: Array<{
+        clauses: Array<{
+          attribute: string
+          op: string
+          values: unknown[]
+          negate: boolean
+        }>
+        trackEvents: boolean
+      }>
+      fallthrough: {
+        variation: number
+      }
+      offVariation: number
+      prerequisites: Array<{
+        key: string
+        variation: number
+      }>
+      _summary: {
         variations: {
-          value: string
-          variationId: string
-        }[]
-      }[]
-      definition: string
-      draft: {
-        enabled: boolean
-        defaultValue: string
-        rules: {
-          description: string
-          condition: string
-          savedGroupTargeting: {
-            matchType: string
-            savedGroups: string[]
-          }[]
-          id: string
-          enabled: boolean
-          type: string
-          value: string
-          variations: {
-            value: string
-            variationId: string
-          }[]
-        }[]
-        definition: string
+          [key: string]: {
+            rules: number
+            nullRules: number
+            targets: number
+            contextTargets: number
+            isFallthrough?: boolean
+            isOff?: boolean
+          }
+        }
+        prerequisites: number
       }
     }
   }
-  prerequisites: {
-    parentId: string
-    parentCondition: string
-  }[]
-  revision: {
-    version: number
-    comment: string
-    date: string
-    publishedBy: string
-  }
+  includeInSnippet: boolean
+  goalIds: string[]
 }
 
-export declare const growthbookFieldLevel: Plugin_2<GrowthbookABConfig>
-
 export declare type ObjectFieldWithPath = ObjectField<SchemaType> & {
   path: Path
 }
 
 export declare type VariantGeneric<T> = {
+  [key: string]: string | T | undefined
   _type: string
-  variantId?: string
-  experimentId?: string
   value?: T
 }
 
 export declare type VariantPreviewProps = Omit<PreviewProps, 'SchemaType'> & {
-  experiment: string
-  variant: string
+  [key: string]: string
   value: any
 }