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

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 & {
   variantName: string
@@ -15,6 +17,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> = {
@@ -56,6 +60,196 @@ 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 = {
+  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
+          }
+        }
+        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
+        }
+        category: string
+        isNumeric: boolean
+        percentileValue: number
+      }
+    }>
+  }
+  customProperties: {
+    key: {
+      name: string
+      value: 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
+  }
+  environments: {
+    [key: string]: {
+      on: boolean
+      archived: boolean
+      salt: string
+      sel: string
+      lastModified: number
+      version: number
+      _site: {
+        href: string
+        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
+      }
+    }
+  }
+  includeInSnippet: boolean
+  goalIds: string[]
+}
+
 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 & {
   variantName: string
@@ -15,6 +17,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> = {
@@ -56,6 +60,196 @@ 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 = {
+  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
+          }
+        }
+        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
+        }
+        category: string
+        isNumeric: boolean
+        percentileValue: number
+      }
+    }>
+  }
+  customProperties: {
+    key: {
+      name: string
+      value: 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
+  }
+  environments: {
+    [key: string]: {
+      on: boolean
+      archived: boolean
+      salt: string
+      sel: string
+      lastModified: number
+      version: number
+      _site: {
+        href: string
+        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
+      }
+    }
+  }
+  includeInSnippet: boolean
+  goalIds: string[]
+}
+
 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 };
 }
@@ -15,20 +15,23 @@ const CONFIG_DEFAULT = {
   experimentId: "experimentId"
 }, 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],
+    [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) });
 }
@@ -6742,7 +6745,79 @@ 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