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

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,7 +6,6 @@ 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
@@ -17,8 +15,6 @@ 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> = {
@@ -46,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
@@ -60,194 +58,192 @@ export declare type FieldPluginConfig = {
  */
 export declare function flattenSchemaType(schemaType: SchemaType): ObjectFieldWithPath[]
 
-export declare const launchDarklyFieldLevel: Plugin_2<LaunchDarklyFieldLevelConfig>
-
-export declare type LaunchDarklyFieldLevelConfig = {
-  fields: (string | FieldDefinition)[]
-  projectKey: string
-  tags?: string[]
-}
-
-export declare type LaunchDarklyFlagItem = {
+export declare 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
         }
-        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
+      },
+    ]
+    secondaryMetrics: [
+      {
+        metricId: string
+        overrides: {
+          delayHours: 0
+          windowHours: 0
+          window: string
+          winRiskThreshold: 0
+          loseRiskThreshold: 0
         }
-        category: string
-        isNumeric: boolean
-        percentileValue: number
+      },
+    ]
+    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
       }
-    }>
-  }
-  customProperties: {
-    key: {
-      name: string
-      value: string[]
     }
   }
+  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
-  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: {
+        value: string
         variations: {
-          [key: string]: {
-            rules: number
-            nullRules: number
-            targets: number
-            contextTargets: number
-            isFallthrough?: boolean
-            isOff?: boolean
-          }
-        }
-        prerequisites: number
+          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
+  }
 }
 
 export declare type ObjectFieldWithPath = ObjectField<SchemaType> & {

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"), studioSecrets = require("@sanity/studio-secrets");
+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");
 function _interopDefaultCompat(e) {
   return e && typeof e == "object" && "default" in e ? e : { default: e };
 }
@@ -15,23 +15,20 @@ const CONFIG_DEFAULT = {
   experimentId: "experimentId"
 }, ExperimentContext = react.createContext({
   ...CONFIG_DEFAULT,
-  experiments: [],
-  setSecret: () => {
-  },
-  secret: void 0
+  experiments: []
 });
 function useExperimentContext() {
   return react.useContext(ExperimentContext);
 }
 function ExperimentProvider(props) {
-  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(
+  const { experimentFieldPluginConfig } = props, 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, secret],
+    [workspace],
     { equal: equal__default.default }
   ), context = react.useMemo(
-    () => ({ ...experimentFieldPluginConfig, experiments, secret, setSecret }),
-    [experimentFieldPluginConfig, experiments, secret, setSecret]
+    () => ({ ...experimentFieldPluginConfig, experiments }),
+    [experimentFieldPluginConfig, experiments]
   );
   return /* @__PURE__ */ jsxRuntime.jsx(ExperimentContext.Provider, { value: context, children: props.renderDefault(props) });
 }
@@ -6408,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",
@@ -6419,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",
@@ -6433,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 {
@@ -6494,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) => {
@@ -6508,7 +6519,11 @@ const useAddExperimentAction = (props) => {
     },
     [patch, subValues, aditionalChangePath]
   );
-  return experiments.length ? /* @__PURE__ */ jsxRuntime.jsx(Select, { ...props, listOptions: formatlistOptions(experiments), handleChange }) : /* @__PURE__ */ jsxRuntime.jsx(jsxRuntime.Fragment, {});
+  return experiments.length ? /* @__PURE__ */ jsxRuntime.jsx(Select, { ...props, listOptions: formatlistOptions(experiments), handleChange }) : /* @__PURE__ */ jsxRuntime.jsx(ui.Card, { padding: [3, 3, 4], radius: 2, shadow: 1, tone: "caution", children: /* @__PURE__ */ jsxRuntime.jsxs(ui.Text, { align: "center", size: [2, 2, 3], children: [
+    "There are no defined ",
+    props.experimentNameOverride,
+    "s"
+  ] }) });
 }, VariantInput = (props) => {
   const defaultValue = sanity.useFormValue([props.path[0], "default"]), handleClick = () => {
     props.onChange(sanity.set(defaultValue, ["value"]));
@@ -6582,7 +6597,8 @@ const createExperimentType = ({
         {
           ...props,
           experimentId,
-          experimentNameOverride
+          experimentNameOverride,
+          variantNameOverride
         }
       )
     },
@@ -6609,7 +6625,14 @@ const createExperimentType = ({
         name: experimentId,
         type: "string",
         components: {
-          input: (props) => /* @__PURE__ */ jsxRuntime.jsx(ExperimentInput, { ...props, variantNameOverride })
+          input: (props) => /* @__PURE__ */ jsxRuntime.jsx(
+            ExperimentInput,
+            {
+              ...props,
+              experimentNameOverride,
+              variantNameOverride
+            }
+          )
         },
         hidden: ({ parent }) => !parent?.active
       }),
@@ -6745,79 +6768,7 @@ const createExperimentType = ({
       }
     }
   };
-}), pluginConfigKeys = [
-  {
-    key: "apiKey",
-    title: "Your secret API key"
-  }
-], Secrets = (props, namespace) => {
-  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: `${namespace} api key`,
-        namespace,
-        keys: pluginConfigKeys,
-        onClose: () => {
-          setShowSettings(!1);
-        }
-      }
-    ),
-    props.renderDefault(props)
-  ] }) : props.renderDefault(props);
-}, getExperiments = async ({
-  client,
-  projectKey,
-  tags
-}) => {
-  const secret = await client.fetch("*[_id == 'secrets.launchdarkly'][0].secrets.apiKey");
-  if (!secret) return [];
-  const url = new URL(`https://app.launchdarkly.com/api/v2/flags/${projectKey}`);
-  tags && url.searchParams.set("filter", `tags:${tags.join("+")}`);
-  const featureExperiments = [];
-  let hasMore = !0;
-  const offset = 0, limit = 10;
-  for (; hasMore; ) {
-    url.searchParams.set("offset", offset.toString()), url.searchParams.set("limit", limit.toString());
-    const responseFlags = await fetch(url, {
-      headers: {
-        Authorization: secret
-      }
-    }), { items } = await responseFlags.json(), experiments = items.map((flag) => ({
-      id: flag.key,
-      label: flag.name,
-      variants: flag.variations.map((variation) => ({
-        id: variation.value,
-        label: variation.name
-      }))
-    }));
-    featureExperiments.push(...experiments), items.length !== limit && (hasMore = !1);
-  }
-  return featureExperiments;
-}, launchDarklyFieldLevel = sanity.definePlugin((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) => !(props.id === "root" && sanity.isObjectInputProps(props)) || !flattenSchemaType(props.schemaType).map(
-          (field) => field.type.name
-        ).some((name) => name.startsWith("experiment")) ? props.renderDefault(props) : Secrets(props, "launchdarkly")
-      }
-    }
-  };
 });
 exports.fieldLevelExperiments = fieldLevelExperiments;
 exports.flattenSchemaType = flattenSchemaType;
-exports.launchDarklyFieldLevel = launchDarklyFieldLevel;
 //# sourceMappingURL=index.js.map