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

package/README.md

@@ -25,6 +25,8 @@ 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
@@ -143,23 +145,21 @@ experiments: async () => {
   const response = await fetch('https://example.com/experiments')
   const {externalExperiments} = await response.json()
 
-  const experiments: ExperimentType[] = externalExperiments?.map(
-    (experiment) => {
-      const experimentId = experiment.id
-      const experimentLabel = experiment.name
-      const variants = experiment.variations?.map((variant) => {
-        return {
-          id: variant.variationId,
-          label: variant.name,
-        }
-      })
+  const experiments: ExperimentType[] = externalExperiments?.map((experiment) => {
+    const experimentId = experiment.id
+    const experimentLabel = experiment.name
+    const variants = experiment.variations?.map((variant) => {
       return {
-        id: experimentId,
-        label: experimentLabel,
-        variants,
+        id: variant.variationId,
+        label: variant.name,
       }
-    },
-  )
+    })
+    return {
+      id: experimentId,
+      label: experimentLabel,
+      variants,
+    }
+  })
   return experiments
 }
 ```

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import {ArrayOfObjectsInputProps} from 'sanity'
+import {Dispatch} from 'react'
 import {FieldDefinition} from 'sanity'
 import {ObjectField} from 'sanity'
 import {Path} from 'sanity'
@@ -6,30 +7,27 @@ 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 & {
-  variantName: string
-  variantId: string
-  experimentId: string
+  objectName: 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
-  [key: string]:
-    | Array<
-        {
-          _key: string
-        } & VariantGeneric<T>
-      >
-    | string
-    | T
-    | undefined
+  variants?: Array<
+    {
+      _key: string
+    } & VariantGeneric<T>
+  >
 }
 
 export declare type ExperimentType = {
@@ -42,13 +40,10 @@ export declare const fieldLevelExperiments: Plugin_2<FieldPluginConfig>
 
 export declare type FieldPluginConfig = {
   fields: (string | FieldDefinition)[]
-  experiments: ExperimentType[] | ((client: SanityClient) => Promise<ExperimentType[]>)
+  experiments:
+    | ExperimentType[]
+    | ((client: SanityClient, secret?: string) => Promise<ExperimentType[]>)
   apiVersion?: string
-  experimentNameOverride?: string
-  variantNameOverride?: string
-  variantId?: string
-  variantArrayName?: string
-  experimentId?: string
 }
 
 /**
@@ -56,18 +51,218 @@ 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'> & {
-  [key: string]: string
+  experiment: string
+  variant: string
   value: any
 }
 

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import {ArrayOfObjectsInputProps} from 'sanity'
+import {Dispatch} from 'react'
 import {FieldDefinition} from 'sanity'
 import {ObjectField} from 'sanity'
 import {Path} from 'sanity'
@@ -6,30 +7,27 @@ 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 & {
-  variantName: string
-  variantId: string
-  experimentId: string
+  objectName: 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
-  [key: string]:
-    | Array<
-        {
-          _key: string
-        } & VariantGeneric<T>
-      >
-    | string
-    | T
-    | undefined
+  variants?: Array<
+    {
+      _key: string
+    } & VariantGeneric<T>
+  >
 }
 
 export declare type ExperimentType = {
@@ -42,13 +40,10 @@ export declare const fieldLevelExperiments: Plugin_2<FieldPluginConfig>
 
 export declare type FieldPluginConfig = {
   fields: (string | FieldDefinition)[]
-  experiments: ExperimentType[] | ((client: SanityClient) => Promise<ExperimentType[]>)
+  experiments:
+    | ExperimentType[]
+    | ((client: SanityClient, secret?: string) => Promise<ExperimentType[]>)
   apiVersion?: string
-  experimentNameOverride?: string
-  variantNameOverride?: string
-  variantId?: string
-  variantArrayName?: string
-  experimentId?: string
 }
 
 /**
@@ -56,18 +51,218 @@ 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'> & {
-  [key: string]: string
+  experiment: string
+  variant: string
   value: any
 }