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

package/src/types.ts

@@ -1,4 +1,3 @@
-import {Dispatch, SetStateAction} from 'react'
 import {
   ArrayOfObjectsInputProps,
   FieldDefinition,
@@ -21,7 +20,9 @@ export type ExperimentType = {
 
 export 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
@@ -38,8 +39,6 @@ export type VariantPreviewProps = Omit<PreviewProps, 'SchemaType'> & {
 
 export type ExperimentContextProps = Required<FieldPluginConfig> & {
   experiments: ExperimentType[]
-  setSecret: Dispatch<SetStateAction<string | undefined>>
-  secret: string | undefined
 }
 
 export type ArrayInputProps = ArrayOfObjectsInputProps & {
@@ -71,184 +70,178 @@ export type ExperimentGeneric<T> = {
     | undefined
 }
 
-export type LaunchDarklyFlagItem = {
+export type GrowthbookExperiment = {
+  id: string
+  dateCreated: string
+  dateUpdated: string
   name: string
-  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
-          }
+  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
         }
-        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
+      },
+    ]
+    guardrails: [
+      {
+        metricId: string
+        overrides: {
+          delayHours: 0
+          windowHours: 0
+          window: string
+          winRiskThreshold: 0
+          loseRiskThreshold: 0
         }
-        category: string
-        isNumeric: boolean
-        percentileValue: number
+      },
+    ]
+    activationMetric: {
+      metricId: string
+      overrides: {
+        delayHours: 0
+        windowHours: 0
+        window: string
+        winRiskThreshold: 0
+        loseRiskThreshold: 0
       }
-    }>
-  }
-  customProperties: {
-    key: {
-      name: string
-      value: string[]
     }
   }
+  resultSummary: {
+    status: string
+    winner: string
+    conclusions: string
+    releasedVariationId: string
+    excludeFromPayload: boolean
+  }
+}
+
+export type GrowthbookFeature = {
+  id: string
+  dateCreated: string
+  dateUpdated: string
   archived: boolean
   description: 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
-  }
+  owner: string
+  project: string
+  valueType: string
+  defaultValue: string
+  tags: string[]
   environments: {
     [key: string]: {
-      on: boolean
-      archived: boolean
-      salt: string
-      sel: string
-      lastModified: number
-      version: number
-      _site: {
-        href: string
+      enabled: boolean
+      defaultValue: string
+      rules: {
+        description: string
+        condition: string
+        savedGroupTargeting: {matchType: string; savedGroups: string[]}[]
+        id: string
+        enabled: boolean
         type: 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: {
-          [key: string]: {
-            rules: number
-            nullRules: number
-            targets: number
-            contextTargets: number
-            isFallthrough?: boolean
-            isOff?: boolean
-          }
-        }
-        prerequisites: number
+        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
       }
     }
   }
-  includeInSnippet: boolean
-  goalIds: string[]
+  prerequisites: {
+    parentId: string
+    parentCondition: string
+  }[]
+  revision: {
+    version: number
+    comment: string
+    date: string
+    publishedBy: string
+  }
 }

package/src/launchDarklyExperiments.tsx

@@ -1,48 +0,0 @@
-import {definePlugin, FieldDefinition, isObjectInputProps} from 'sanity'
-
-import {Secrets} from './components/Secrets'
-import {fieldLevelExperiments} from './fieldExperiments'
-import {flattenSchemaType} from './utils/flattenSchemaType'
-import {getExperiments} from './utils/launchDarkly'
-
-export type LaunchDarklyFieldLevelConfig = {
-  fields: (string | FieldDefinition)[]
-  projectKey: string
-  tags?: string[]
-}
-
-export const launchDarklyFieldLevel = definePlugin<LaunchDarklyFieldLevelConfig>((config) => {
-  const {fields, projectKey, tags} = config
-  return {
-    name: 'sanity-growthbook-personalistaion-plugin-field-level-experiments',
-    plugins: [
-      fieldLevelExperiments({
-        fields,
-        experiments: (client) => getExperiments({client, projectKey, tags}),
-      }),
-    ],
-
-    form: {
-      components: {
-        input: (props) => {
-          const isRootInput = props.id === 'root' && isObjectInputProps(props)
-
-          if (!isRootInput) {
-            return props.renderDefault(props)
-          }
-
-          const flatFieldTypeNames = flattenSchemaType(props.schemaType).map(
-            (field) => field.type.name,
-          )
-
-          const hasExperiment = flatFieldTypeNames.some((name) => name.startsWith('experiment'))
-
-          if (!hasExperiment) {
-            return props.renderDefault(props)
-          }
-          return Secrets(props, 'launchdarkly')
-        },
-      },
-    },
-  }
-})

package/src/utils/launchDarkly.ts

@@ -1,54 +0,0 @@
-import {SanityClient} from 'sanity'
-
-import {LaunchDarklyFieldLevelConfig} from '../launchDarklyExperiments'
-import {ExperimentType, LaunchDarklyFlagItem} from '../types'
-
-export const getExperiments = async ({
-  client,
-  projectKey,
-  tags,
-}: Omit<LaunchDarklyFieldLevelConfig, 'fields'> & {client: SanityClient}): Promise<
-  ExperimentType[]
-> => {
-  const query = `*[_id == 'secrets.launchdarkly'][0].secrets.apiKey`
-
-  const secret = await client.fetch(query) // secret is stored in the content lake using @sanity/studio-secrets
-  if (!secret) return []
-
-  const url = new URL(`https://app.launchdarkly.com/api/v2/flags/${projectKey}`)
-
-  if (tags) {
-    url.searchParams.set('filter', `tags:${tags.join('+')}`)
-  }
-
-  const featureExperiments: ExperimentType[] = []
-  let hasMore = true
-  const offset = 0
-  const limit = 10
-
-  while (hasMore) {
-    url.searchParams.set('offset', offset.toString())
-    url.searchParams.set('limit', limit.toString())
-    const responseFlags = await fetch(url, {
-      headers: {
-        Authorization: secret,
-      },
-    })
-
-    const {items} = await responseFlags.json()
-    const experiments = items.map((flag: LaunchDarklyFlagItem) => ({
-      id: flag.key,
-      label: flag.name,
-      variants: flag.variations.map((variation) => ({
-        id: variation.value,
-        label: variation.name,
-      })),
-    }))
-    featureExperiments.push(...experiments)
-    if (items.length !== limit) {
-      hasMore = false
-    }
-  }
-
-  return featureExperiments
-}