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

package/dist/index.d.ts

@@ -42,7 +42,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
   experimentNameOverride?: string
   variantNameOverride?: string
@@ -56,6 +58,194 @@ export declare type FieldPluginConfig = {
  */
 export declare function flattenSchemaType(schemaType: SchemaType): ObjectFieldWithPath[]
 
+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 type ObjectFieldWithPath = ObjectField<SchemaType> & {
   path: Path
 }

package/dist/index.js

@@ -6405,9 +6405,9 @@ const icons = {
 });
 Icon.displayName = "ForwardRef(Icon)";
 const useAddExperimentAction = (props) => {
-  const { onChange, experimentNameOverride } = props, handleAddAction = () => {
-    onChange([sanity.set(!0, ["active"])]);
-  };
+  const { onChange, active, experimentNameOverride } = props, handleAddAction = react.useCallback(() => {
+    onChange([sanity.set(!active, ["active"])]);
+  }, [onChange, active]);
   return {
     title: `Add ${experimentNameOverride}`,
     type: "action",
@@ -6416,13 +6416,10 @@ const useAddExperimentAction = (props) => {
     renderAsButton: !0
   };
 }, useRemoveExperimentAction = (props) => {
-  const { onChange, experimentId, experimentNameOverride } = props, patchActiveFalseEvent = () => sanity.set(!1, ["active"]), patchClearEvent = () => {
-    const experiment = [experimentId], variants = [experimentNameOverride];
-    return [sanity.unset(experiment), sanity.unset(variants)];
-  }, handleClearAction = () => {
-    const clearEvents = patchClearEvent(), activeEvent = patchActiveFalseEvent();
-    onChange([activeEvent, ...clearEvents]);
-  };
+  const { onChange, active, experimentId, experimentNameOverride, variantNameOverride } = props, handleClearAction = react.useCallback(() => {
+    const activeId = ["active"], experiment = [experimentId], variants = [`${variantNameOverride}s`];
+    onChange([sanity.set(!active, activeId), sanity.unset(experiment), sanity.unset(variants)]);
+  }, [onChange, active, experimentId, variantNameOverride]);
   return {
     title: `Remove ${experimentNameOverride}`,
     type: "action",
@@ -6430,36 +6427,53 @@ const useAddExperimentAction = (props) => {
     onAction: handleClearAction,
     renderAsButton: !0
   };
-}, newActions = ({
+}, createActions = ({
   onChange,
   inputId,
   active,
   experimentNameOverride,
-  experimentId
+  experimentId,
+  variantNameOverride
 }) => {
   const removeAction = sanity.defineDocumentFieldAction({
     name: `Remove ${experimentNameOverride}`,
     useAction: (props) => useRemoveExperimentAction({
+      active: !0,
       onChange,
       experimentNameOverride,
-      experimentId
+      experimentId,
+      variantNameOverride
     })
   }), addAction = sanity.defineDocumentFieldAction({
     name: `Add ${experimentNameOverride}`,
     useAction: (props) => useAddExperimentAction({
+      active: !1,
       onChange,
       experimentNameOverride
     })
   });
   return active ? removeAction : addAction;
 }, ExperimentField = (props) => {
-  const { onChange } = props.inputProps, { inputId, experimentNameOverride, experimentId } = props, active = props.value?.active, oldActions = props.actions || [], withActionProps = {
-    ...props,
-    actions: [
-      newActions({ onChange, inputId, active, experimentNameOverride, experimentId }),
-      ...oldActions
-    ]
-  };
+  const { onChange } = props.inputProps, { inputId, experimentNameOverride, experimentId, variantNameOverride } = props, active = props.value?.active, actionProps = react.useMemo(
+    () => ({
+      onChange,
+      inputId,
+      active,
+      experimentNameOverride,
+      experimentId,
+      variantNameOverride
+    }),
+    [onChange, inputId, active, experimentNameOverride, experimentId, variantNameOverride]
+  ), memoizedActions = react.useMemo(() => {
+    const oldActions = props.actions || [];
+    return [createActions(actionProps), ...oldActions];
+  }, [actionProps, props.actions]), withActionProps = react.useMemo(
+    () => ({
+      ...props,
+      actions: memoizedActions
+    }),
+    [props, memoizedActions]
+  );
   return props.renderDefault(withActionProps);
 }, Select = (props) => {
   const {
@@ -6491,7 +6505,7 @@ const useAddExperimentAction = (props) => {
   value: experiment.id
 })), ExperimentInput = (props) => {
   const { experiments } = useExperimentContext(), id = sanity.useFormValue(["_id"]), aditionalChangePath = react.useMemo(
-    () => [...props.path.slice(0, -1), props.variantNameOverride],
+    () => [...props.path.slice(0, -1), `${props.variantNameOverride}s`],
     [props.variantNameOverride, props.path]
   ), subValues = sanity.useFormValue(aditionalChangePath), { patch } = sanity.useDocumentOperation(id.replace("drafts.", ""), props.schemaType.name), handleChange = react.useCallback(
     (event, onChange) => {
@@ -6583,7 +6597,8 @@ const createExperimentType = ({
         {
           ...props,
           experimentId,
-          experimentNameOverride
+          experimentNameOverride,
+          variantNameOverride
         }
       )
     },