@sanity/personalization-plugin 2.1.0-growthbook.1 → 2.1.0

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

@@ -1,5 +1,4 @@
 import {ArrayOfObjectsInputProps} from 'sanity'
-import {Dispatch} from 'react'
 import {FieldDefinition} from 'sanity'
 import {ObjectField} from 'sanity'
 import {Path} from 'sanity'
@@ -7,27 +6,30 @@ import {Plugin as Plugin_2} from 'sanity'
 import {PreviewProps} from 'sanity'
 import {SanityClient} from 'sanity'
 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> & {
   experiments: ExperimentType[]
-  setSecret: Dispatch<SetStateAction<string | undefined>>
-  secret: string | undefined
 }
 
 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 +42,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 +56,18 @@ export declare type FieldPluginConfig = {
  */
 export declare function flattenSchemaType(schemaType: SchemaType): ObjectFieldWithPath[]
 
-export declare type GrowthbookABConfig = {
-  fields: (string | FieldDefinition)[]
-  environment: string
-  baseUrl?: string
-  project?: string
-  convertBooleans?: boolean
-}
-
-export declare type GrowthbookExperiment = {
-  id: string
-  dateCreated: string
-  dateUpdated: string
-  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
-        }
-      },
-    ]
-    guardrails: [
-      {
-        metricId: string
-        overrides: {
-          delayHours: 0
-          windowHours: 0
-          window: string
-          winRiskThreshold: 0
-          loseRiskThreshold: 0
-        }
-      },
-    ]
-    activationMetric: {
-      metricId: string
-      overrides: {
-        delayHours: 0
-        windowHours: 0
-        window: string
-        winRiskThreshold: 0
-        loseRiskThreshold: 0
-      }
-    }
-  }
-  resultSummary: {
-    status: string
-    winner: string
-    conclusions: string
-    releasedVariationId: string
-    excludeFromPayload: boolean
-  }
-}
-
-export declare type GrowthbookFeature = {
-  id: string
-  dateCreated: string
-  dateUpdated: string
-  archived: boolean
-  description: string
-  owner: string
-  project: string
-  valueType: string
-  defaultValue: string
-  tags: string[]
-  environments: {
-    [key: string]: {
-      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
-      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
-      }
-    }
-  }
-  prerequisites: {
-    parentId: string
-    parentCondition: string
-  }[]
-  revision: {
-    version: number
-    comment: string
-    date: string
-    publishedBy: 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
 }
 

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import {ArrayOfObjectsInputProps} from 'sanity'
-import {Dispatch} from 'react'
 import {FieldDefinition} from 'sanity'
 import {ObjectField} from 'sanity'
 import {Path} from 'sanity'
@@ -7,27 +6,30 @@ import {Plugin as Plugin_2} from 'sanity'
 import {PreviewProps} from 'sanity'
 import {SanityClient} from 'sanity'
 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> & {
   experiments: ExperimentType[]
-  setSecret: Dispatch<SetStateAction<string | undefined>>
-  secret: string | undefined
 }
 
 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 +42,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 +56,18 @@ export declare type FieldPluginConfig = {
  */
 export declare function flattenSchemaType(schemaType: SchemaType): ObjectFieldWithPath[]
 
-export declare type GrowthbookABConfig = {
-  fields: (string | FieldDefinition)[]
-  environment: string
-  baseUrl?: string
-  project?: string
-  convertBooleans?: boolean
-}
-
-export declare type GrowthbookExperiment = {
-  id: string
-  dateCreated: string
-  dateUpdated: string
-  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
-        }
-      },
-    ]
-    guardrails: [
-      {
-        metricId: string
-        overrides: {
-          delayHours: 0
-          windowHours: 0
-          window: string
-          winRiskThreshold: 0
-          loseRiskThreshold: 0
-        }
-      },
-    ]
-    activationMetric: {
-      metricId: string
-      overrides: {
-        delayHours: 0
-        windowHours: 0
-        window: string
-        winRiskThreshold: 0
-        loseRiskThreshold: 0
-      }
-    }
-  }
-  resultSummary: {
-    status: string
-    winner: string
-    conclusions: string
-    releasedVariationId: string
-    excludeFromPayload: boolean
-  }
-}
-
-export declare type GrowthbookFeature = {
-  id: string
-  dateCreated: string
-  dateUpdated: string
-  archived: boolean
-  description: string
-  owner: string
-  project: string
-  valueType: string
-  defaultValue: string
-  tags: string[]
-  environments: {
-    [key: string]: {
-      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
-      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
-      }
-    }
-  }
-  prerequisites: {
-    parentId: string
-    parentCondition: string
-  }[]
-  revision: {
-    version: number
-    comment: string
-    date: string
-    publishedBy: 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
 }