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

package/dist/index.js

@@ -1,48 +1,50 @@
 "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 };
 }
 var equal__default = /* @__PURE__ */ _interopDefaultCompat(equal);
 const CONFIG_DEFAULT = {
   fields: [],
-  apiVersion: "2024-11-07"
+  apiVersion: "2024-11-07",
+  experimentNameOverride: "experiment",
+  variantNameOverride: "variant",
+  variantId: "variantId",
+  variantArrayName: "variants",
+  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, secret) : experimentFieldPluginConfig.experiments,
-    [workspace, secret],
+    async () => typeof experimentFieldPluginConfig.experiments == "function" ? experimentFieldPluginConfig.experiments(client) : experimentFieldPluginConfig.experiments,
+    [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) });
 }
 const ArrayInput = (props) => {
-  const fieldPath = props.path.slice(0, -1), experimentId = sanity.useFormValue([...fieldPath, "experimentId"]), { experiments } = useExperimentContext(), { onItemAppend, objectName } = props, handleClick = react.useCallback(
+  const fieldPath = props.path.slice(0, -1), { onItemAppend, variantName, variantId, experimentId } = props, experimentValue = sanity.useFormValue([...fieldPath, experimentId]), { experiments } = useExperimentContext(), handleClick = react.useCallback(
     async (variant) => {
       const item = {
         _key: uuid.uuid(),
-        variantId: variant.id,
-        experimentId,
-        _type: objectName
+        [variantId]: variant.id,
+        [experimentId]: experimentValue,
+        _type: variantName
       };
       onItemAppend(item);
     },
-    [experimentId, objectName, onItemAppend]
-  ), filteredVariants = experiments.find((option) => option.id === experimentId)?.variants || [], usedVariants = props.value?.map((variant) => variant.variantId);
+    [variantId, experimentId, experimentValue, variantName, onItemAppend]
+  ), filteredVariants = experiments.find((option) => option.id === experimentValue)?.variants || [], usedVariants = (props.value || [])?.map((variant) => variant[variantId]);
   return /* @__PURE__ */ jsxRuntime.jsxs(ui.Stack, { space: 3, children: [
     props.renderDefault({ ...props, arrayFunctions: () => null }),
     /* @__PURE__ */ jsxRuntime.jsx(ui.Inline, { space: 1, children: filteredVariants.map((variant) => /* @__PURE__ */ jsxRuntime.jsx(
@@ -53,7 +55,7 @@ const ArrayInput = (props) => {
         disabled: usedVariants?.includes(variant.id),
         onClick: () => handleClick(variant)
       },
-      `${experimentId}-${variant.id}`
+      `${experimentValue}-${variant.id}`
     )) })
   ] });
 }, AccessDeniedIcon = react.forwardRef(function(props, ref) {
@@ -6403,40 +6405,60 @@ const icons = {
 });
 Icon.displayName = "ForwardRef(Icon)";
 const useAddExperimentAction = (props) => {
-  const patchActiveEvent = react.useMemo(() => sanity.set(!0, ["active"]), []), handleAction = react.useCallback(() => {
-    props.onChange([patchActiveEvent]);
-  }, [patchActiveEvent, props]);
+  const { onChange, experimentNameOverride } = props, handleAddAction = () => {
+    onChange([sanity.set(!0, ["active"])]);
+  };
   return {
-    title: "Add experiment",
+    title: `Add ${experimentNameOverride}`,
     type: "action",
     icon: gi.GiSoapExperiment,
-    onAction: handleAction,
+    onAction: handleAddAction,
     renderAsButton: !0
   };
 }, useRemoveExperimentAction = (props) => {
-  const patchActiveEvent = react.useMemo(() => sanity.set(!1, ["active"]), []), patchClearEvent = react.useMemo(() => {
-    const experimentId = ["experimentId"], variants = ["variants"];
-    return [sanity.unset(experimentId), sanity.unset(variants)];
-  }, []), handleAction = react.useCallback(() => {
-    props.onChange([patchActiveEvent, ...patchClearEvent]);
-  }, [patchActiveEvent, patchClearEvent, 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]);
+  };
   return {
-    title: "Remove experiment",
+    title: `Remove ${experimentNameOverride}`,
     type: "action",
     icon: CloseIcon,
-    onAction: handleAction,
+    onAction: handleClearAction,
     renderAsButton: !0
   };
-}, newActions = ({ onChange, inputId, active }) => active ? sanity.defineDocumentFieldAction({
-  name: "Experiment",
-  useAction: (props) => useRemoveExperimentAction({ ...props, onChange, inputId })
-}) : sanity.defineDocumentFieldAction({
-  name: "Experiment",
-  useAction: (props) => useAddExperimentAction({ ...props, onChange, inputId })
-}), ExperimentField = (props) => {
-  const { onChange } = props.inputProps, { inputId } = props, active = props.value?.active, oldActions = props.actions || [], withActionProps = {
+}, newActions = ({
+  onChange,
+  inputId,
+  active,
+  experimentNameOverride,
+  experimentId
+}) => {
+  const removeAction = sanity.defineDocumentFieldAction({
+    name: `Remove ${experimentNameOverride}`,
+    useAction: (props) => useRemoveExperimentAction({
+      onChange,
+      experimentNameOverride,
+      experimentId
+    })
+  }), addAction = sanity.defineDocumentFieldAction({
+    name: `Add ${experimentNameOverride}`,
+    useAction: (props) => useAddExperimentAction({
+      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 }), ...oldActions]
+    actions: [
+      newActions({ onChange, inputId, active, experimentNameOverride, experimentId }),
+      ...oldActions
+    ]
   };
   return props.renderDefault(withActionProps);
 }, Select = (props) => {
@@ -6468,7 +6490,10 @@ const useAddExperimentAction = (props) => {
   title: experiment.label,
   value: experiment.id
 })), ExperimentInput = (props) => {
-  const { experiments } = useExperimentContext(), id = sanity.useFormValue(["_id"]), aditionalChangePath = react.useMemo(() => [...props.path.slice(0, -1), "variants"], [props.path]), subValues = sanity.useFormValue(aditionalChangePath), { patch } = sanity.useDocumentOperation(id.replace("drafts.", ""), props.schemaType.name), handleChange = react.useCallback(
+  const { experiments } = useExperimentContext(), id = sanity.useFormValue(["_id"]), aditionalChangePath = react.useMemo(
+    () => [...props.path.slice(0, -1), props.variantNameOverride],
+    [props.variantNameOverride, props.path]
+  ), subValues = sanity.useFormValue(aditionalChangePath), { patch } = sanity.useDocumentOperation(id.replace("drafts.", ""), props.schemaType.name), handleChange = react.useCallback(
     (event, onChange) => {
       const inputValue = event.currentTarget.value;
       if (onChange(inputValue ? sanity.set(inputValue) : sanity.unset()), subValues) {
@@ -6481,6 +6506,14 @@ const useAddExperimentAction = (props) => {
     [patch, subValues, aditionalChangePath]
   );
   return experiments.length ? /* @__PURE__ */ jsxRuntime.jsx(Select, { ...props, listOptions: formatlistOptions(experiments), handleChange }) : /* @__PURE__ */ jsxRuntime.jsx(jsxRuntime.Fragment, {});
+}, VariantInput = (props) => {
+  const defaultValue = sanity.useFormValue([props.path[0], "default"]), handleClick = () => {
+    props.onChange(sanity.set(defaultValue, ["value"]));
+  };
+  return /* @__PURE__ */ jsxRuntime.jsxs(ui.Stack, { space: 3, children: [
+    props.renderDefault(props),
+    /* @__PURE__ */ jsxRuntime.jsx(ui.Inline, { space: 1, children: /* @__PURE__ */ jsxRuntime.jsx(ui.Button, { text: "Copy default", mode: "ghost", onClick: () => handleClick() }) })
+  ] });
 }, VariantPreview = (props) => {
   const [subtitle, setSubtitle] = react.useState(void 0), [title, setTitle] = react.useState(void 0), [media, setMedia] = react.useState(void 0), client = sanity.useClient({ apiVersion: "2025-01-01" }), { experiments } = useExperimentContext(), { experiment, variant, value } = props, selectedExperiment = experiments.find((experimentItem) => experimentItem.id === experiment), selectedVariant = selectedExperiment?.variants.find((variantItem) => variantItem.id === variant);
   react.useEffect(() => {
@@ -6528,15 +6561,27 @@ function extractInnerFields(fields, path, maxDepth) {
     return [...acc, thisFieldWithPath];
   }, []);
 }
-const createFieldType = ({
-  field
+const createExperimentType = ({
+  field,
+  experimentNameOverride,
+  variantNameOverride,
+  variantId,
+  variantArrayName,
+  experimentId
 }) => {
-  const typeName = typeof field == "string" ? field : field.name, usedName = String(typeName[0]).toUpperCase() + String(typeName).slice(1), objectName = `variant${usedName}`;
+  const typeName = typeof field == "string" ? field : field.name, usedName = String(typeName[0]).toUpperCase() + String(typeName).slice(1), variantName = `${variantNameOverride}${usedName}`;
   return sanity.defineType({
-    name: `experiment${usedName}`,
+    name: `${experimentNameOverride}${usedName}`,
     type: "object",
     components: {
-      field: ExperimentField
+      field: (props) => /* @__PURE__ */ jsxRuntime.jsx(
+        ExperimentField,
+        {
+          ...props,
+          experimentId,
+          experimentNameOverride
+        }
+      )
     },
     fields: [
       typeof field == "string" ? (
@@ -6558,184 +6603,146 @@ const createFieldType = ({
         hidden: !0
       }),
       sanity.defineField({
-        title: "Experiment",
-        name: "experimentId",
+        name: experimentId,
         type: "string",
         components: {
-          input: ExperimentInput
+          input: (props) => /* @__PURE__ */ jsxRuntime.jsx(ExperimentInput, { ...props, variantNameOverride })
         },
         hidden: ({ parent }) => !parent?.active
       }),
       sanity.defineField({
-        name: "variants",
+        name: variantArrayName,
         type: "array",
-        hidden: ({ parent }) => !parent?.experimentId,
+        hidden: ({ parent }) => !parent?.[experimentId],
         components: {
-          input: (props) => /* @__PURE__ */ jsxRuntime.jsx(ArrayInput, { ...props, objectName })
+          input: (props) => /* @__PURE__ */ jsxRuntime.jsx(
+            ArrayInput,
+            {
+              ...props,
+              variantName,
+              variantId,
+              experimentId
+            }
+          )
         },
         of: [
           sanity.defineField({
-            name: objectName,
-            type: objectName
+            name: variantName,
+            type: variantName
           })
         ]
       })
     ]
   });
-}, createFieldObjectType = ({
-  field
+}, createVariantType = ({
+  field,
+  variantNameOverride,
+  variantId,
+  experimentId
 }) => {
   const typeName = typeof field == "string" ? field : field.name, usedName = String(typeName[0]).toUpperCase() + String(typeName).slice(1);
   return sanity.defineType({
-    name: `variant${usedName}`,
-    title: `Experiment array ${usedName}`,
+    name: `${variantNameOverride}${usedName}`,
+    title: `${variantNameOverride} array ${usedName}`,
     type: "object",
     components: {
-      preview: VariantPreview
+      preview: VariantPreview,
+      input: VariantInput
     },
     fields: [
       {
         type: "string",
-        name: "variantId",
+        name: variantId,
         readOnly: !0
       },
       {
         type: "string",
-        name: "experimentId",
+        name: experimentId,
         hidden: !0
       },
       typeof field == "string" ? (
         // Define a simple field if all we have is the name as a string
         sanity.defineField({
           name: "value",
-          type: field,
-          hidden: ({ parent }) => !parent?.variantId
+          type: field
+          // hidden: ({parent}) => !parent?.[`${objectNameOverride}Id`],
         })
       ) : (
         // Pass in the configured options, but overwrite the name
         {
           ...field,
-          name: "value",
-          hidden: ({ parent }) => !parent?.variantId
+          name: "value"
+          // hidden: ({parent}) => !parent?.[`${objectNameOverride}Id`],
         }
       )
     ],
     preview: {
       select: {
-        variant: "variantId",
-        experiment: "experimentId",
+        variant: variantId,
+        experiment: experimentId,
         value: "value"
       }
     }
   });
-}, fieldSchema = ({ fields, experiments }) => [
-  ...fields.map((field) => createFieldObjectType({ field })),
-  ...fields.map((field) => createFieldType({ field }))
+}, fieldSchema = ({
+  fields,
+  experimentNameOverride,
+  variantNameOverride,
+  variantId,
+  variantArrayName,
+  experimentId
+}) => [
+  ...fields.map(
+    (field) => createVariantType({ field, variantNameOverride, variantId, experimentId })
+  ),
+  ...fields.map(
+    (field) => createExperimentType({
+      field,
+      experimentNameOverride,
+      variantNameOverride,
+      variantId,
+      variantArrayName,
+      experimentId
+    })
+  )
 ], fieldLevelExperiments = sanity.definePlugin((config) => {
-  const pluginConfig = { ...CONFIG_DEFAULT, ...config }, { fields, experiments } = pluginConfig;
+  const pluginConfig = { ...CONFIG_DEFAULT, ...config }, { fields, experimentNameOverride, variantNameOverride } = pluginConfig, experimentId = `${experimentNameOverride}Id`, variantArrayName = `${variantNameOverride}s`, variantId = `${variantNameOverride}Id`;
   return {
     name: "sanity-personalistaion-plugin-field-level-experiments",
     schema: {
-      types: fieldSchema({ fields, experiments })
+      types: fieldSchema({
+        fields,
+        experimentNameOverride,
+        variantNameOverride,
+        variantId,
+        variantArrayName,
+        experimentId
+      })
     },
     form: {
       components: {
         input: (props) => {
           if (!(props.id === "root" && sanity.isObjectInputProps(props)) || !flattenSchemaType(props.schemaType).map(
             (field) => field.type.name
-          ).some((name) => name.startsWith("experiment")))
+          ).some(
+            (name) => name.startsWith(experimentNameOverride)
+          ))
             return props.renderDefault(props);
-          const providerProps = { ...props, experimentFieldPluginConfig: pluginConfig };
+          const providerProps = {
+            ...props,
+            experimentFieldPluginConfig: {
+              ...pluginConfig,
+              variantId,
+              variantArrayName,
+              experimentId
+            }
+          };
           return ExperimentProvider(providerProps);
         }
       }
     }
   };
-}), 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