@sanity/personalization-plugin 2.0.0 → 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,6 +7,7 @@ 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
@@ -13,6 +15,8 @@ export declare type ArrayInputProps = ArrayOfObjectsInputProps & {
 
 export declare type ExperimentContextProps = Required<FieldPluginConfig> & {
   experiments: ExperimentType[]
+  setSecret: Dispatch<SetStateAction<string | undefined>>
+  secret: string | undefined
 }
 
 export declare type ExperimentGeneric<T> = {
@@ -36,7 +40,9 @@ 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
 }
 
@@ -45,6 +51,204 @@ 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
 }

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,6 +7,7 @@ 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
@@ -13,6 +15,8 @@ export declare type ArrayInputProps = ArrayOfObjectsInputProps & {
 
 export declare type ExperimentContextProps = Required<FieldPluginConfig> & {
   experiments: ExperimentType[]
+  setSecret: Dispatch<SetStateAction<string | undefined>>
+  secret: string | undefined
 }
 
 export declare type ExperimentGeneric<T> = {
@@ -36,7 +40,9 @@ 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
 }
 
@@ -45,6 +51,204 @@ 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
 }

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: !0 });
-var jsxRuntime = require("react/jsx-runtime"), sanity = require("sanity"), ui = require("@sanity/ui"), uuid = require("@sanity/uuid"), react = require("react"), equal = require("fast-deep-equal"), suspendReact = require("suspend-react"), gi = require("react-icons/gi");
+var jsxRuntime = require("react/jsx-runtime"), sanity = require("sanity"), ui = require("@sanity/ui"), uuid = require("@sanity/uuid"), react = require("react"), equal = require("fast-deep-equal"), suspendReact = require("suspend-react"), gi = require("react-icons/gi"), studioSecrets = require("@sanity/studio-secrets");
 function _interopDefaultCompat(e) {
   return e && typeof e == "object" && "default" in e ? e : { default: e };
 }
@@ -10,20 +10,23 @@ const CONFIG_DEFAULT = {
   apiVersion: "2024-11-07"
 }, ExperimentContext = react.createContext({
   ...CONFIG_DEFAULT,
-  experiments: []
+  experiments: [],
+  setSecret: () => {
+  },
+  secret: void 0
 });
 function useExperimentContext() {
   return react.useContext(ExperimentContext);
 }
 function ExperimentProvider(props) {
-  const { experimentFieldPluginConfig } = props, client = sanity.useClient({ apiVersion: experimentFieldPluginConfig.apiVersion }), workspace = sanity.useWorkspace(), experiments = Array.isArray(experimentFieldPluginConfig.experiments) ? experimentFieldPluginConfig.experiments : suspendReact.suspend(
+  const { experimentFieldPluginConfig } = props, [secret, setSecret] = react.useState(), client = sanity.useClient({ apiVersion: experimentFieldPluginConfig.apiVersion }), workspace = sanity.useWorkspace(), experiments = Array.isArray(experimentFieldPluginConfig.experiments) ? experimentFieldPluginConfig.experiments : suspendReact.suspend(
     // eslint-disable-next-line require-await
-    async () => typeof experimentFieldPluginConfig.experiments == "function" ? experimentFieldPluginConfig.experiments(client) : experimentFieldPluginConfig.experiments,
-    [workspace],
+    async () => typeof experimentFieldPluginConfig.experiments == "function" ? experimentFieldPluginConfig.experiments(client, secret) : experimentFieldPluginConfig.experiments,
+    [workspace, secret],
     { equal: equal__default.default }
   ), context = react.useMemo(
-    () => ({ ...experimentFieldPluginConfig, experiments }),
-    [experimentFieldPluginConfig, experiments]
+    () => ({ ...experimentFieldPluginConfig, experiments, secret, setSecret }),
+    [experimentFieldPluginConfig, experiments, secret, setSecret]
   );
   return /* @__PURE__ */ jsxRuntime.jsx(ExperimentContext.Provider, { value: context, children: props.renderDefault(props) });
 }
@@ -6648,7 +6651,91 @@ const createFieldType = ({
       }
     }
   };
+}), namespace = "growthbook", pluginConfigKeys = [
+  {
+    key: "apiKey",
+    title: "Your secret API key"
+  }
+], Secrets = (props) => {
+  const { secrets, loading } = studioSecrets.useSecrets(namespace), { setSecret } = useExperimentContext(), [showSettings, setShowSettings] = react.useState(!1);
+  return react.useEffect(() => {
+    if (!loading)
+      return !secrets && !loading ? (setSecret(void 0), setShowSettings(!0)) : (setSecret(secrets.apiKey), setShowSettings(!1));
+  }, [secrets, loading, setSecret]), showSettings ? /* @__PURE__ */ jsxRuntime.jsxs(jsxRuntime.Fragment, { children: [
+    /* @__PURE__ */ jsxRuntime.jsx(
+      studioSecrets.SettingsView,
+      {
+        title: "Growthbook secret",
+        namespace,
+        keys: pluginConfigKeys,
+        onClose: () => {
+          setShowSettings(!1);
+        }
+      }
+    ),
+    props.renderDefault(props)
+  ] }) : props.renderDefault(props);
+}, getBooleanConversion = (value) => value === "true" ? "variant" : value === "false" ? "control" : value, getExperiments = async ({
+  client,
+  environment,
+  baseUrl,
+  project,
+  convertBooleans
+}) => {
+  const secret = await client.fetch("*[_id == 'secrets.growthbook'][0].secrets.apiKey");
+  if (!secret) return [];
+  const featureExperiments = [];
+  let hasMore = !0, offset = 0;
+  const url = new URL(baseUrl ?? "https://api.growthbook.io/api/v1/features");
+  for (project && url.searchParams.set("projectId", project); hasMore; ) {
+    url.searchParams.set("offset", offset.toString());
+    const response = await fetch(url, {
+      headers: {
+        Authorization: `Bearer ${secret}`
+      }
+    }), { features, hasMore: responseHasMore, nextOffset } = await response.json();
+    hasMore = responseHasMore, offset = nextOffset, features && features.forEach((feature) => {
+      if (feature.archived)
+        return;
+      const experiments = feature.environments[environment]?.rules.filter(
+        (experiment) => experiment.type === "experiment-ref" || experiment.type === "experiment"
+      );
+      if (!experiments)
+        return;
+      const variations = /* @__PURE__ */ new Set();
+      experiments.forEach((experiment) => {
+        experiment?.variations.forEach((variant) => {
+          variations.add({
+            id: convertBooleans ? getBooleanConversion(variant.value) : variant.value,
+            label: convertBooleans ? getBooleanConversion(variant.value) : variant.value
+          });
+        });
+      });
+      const value = { id: feature.id, label: feature.id, variants: [...variations] };
+      featureExperiments.push(value);
+    });
+  }
+  return featureExperiments;
+}, growthbookFieldLevel = sanity.definePlugin((config) => {
+  const { fields, environment, project, convertBooleans, baseUrl } = config;
+  return {
+    name: "sanity-growthbook-personalistaion-plugin-field-level-experiments",
+    plugins: [
+      fieldLevelExperiments({
+        fields,
+        experiments: (client) => getExperiments({ client, environment, baseUrl, project, convertBooleans })
+      })
+    ],
+    form: {
+      components: {
+        input: (props) => !(props.id === "root" && sanity.isObjectInputProps(props)) || !flattenSchemaType(props.schemaType).map(
+          (field) => field.type.name
+        ).some((name) => name.startsWith("experiment")) ? props.renderDefault(props) : Secrets(props)
+      }
+    }
+  };
 });
 exports.fieldLevelExperiments = fieldLevelExperiments;
 exports.flattenSchemaType = flattenSchemaType;
+exports.growthbookFieldLevel = growthbookFieldLevel;
 //# sourceMappingURL=index.js.map