@sanity/personalization-plugin 2.5.0 → 3.0.0

package/dist/index.d.ts

@@ -1,267 +1,227 @@
-import {ArrayOfObjectsInputProps} from 'sanity'
-import {FieldDefinition} from 'sanity'
-import {ObjectField} from 'sanity'
-import {Path} from 'sanity'
-import {Plugin as Plugin_2} from 'sanity'
-import {PreviewProps} from 'sanity'
-import {SanityClient} from 'sanity'
-import {SchemaType} from 'sanity'
-
-export declare type ArrayInputProps = ArrayOfObjectsInputProps & {
-  variantName: string
-  variantId: string
-  experimentId: string
-}
-
-export declare type ExperimentContextProps = Required<FieldPluginConfig> & {
-  experiments: ExperimentType[]
-}
-
-export declare type ExperimentGeneric<T> = {
-  _type: string
-  default?: T
-  experimentValue?: string
-  [key: string]:
-    | Array<
-        {
-          _key: string
-        } & VariantGeneric<T>
-      >
-    | string
-    | T
-    | undefined
-}
-
-export declare type ExperimentType = {
-  id: string
-  label: string
-  variants: VariantType[]
-}
-
-export declare const fieldLevelExperiments: Plugin_2<FieldPluginConfig>
-
-export declare type FieldPluginConfig = {
-  fields: (string | FieldDefinition)[]
-  experiments: ExperimentType[] | ((client: SanityClient) => Promise<ExperimentType[]>)
-  apiVersion?: string
-  experimentNameOverride?: string
-  variantNameOverride?: string
-  variantId?: string
-  variantArrayName?: string
-  experimentId?: string
-}
-
-/**
- * Flattens a document's schema type into a flat array of fields and includes their path
- */
-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]
-        },
-      ]
-    },
-  ]
+import { ArrayOfObjectsInputProps, FieldDefinition, ObjectField, Path, PreviewProps, SanityClient, SchemaType } from "sanity";
+type VariantType = {
+  id: string;
+  label: string;
+};
+type ExperimentType = {
+  id: string;
+  label: string;
+  variants: VariantType[];
+};
+type FieldPluginConfig = {
+  fields: (string | FieldDefinition)[];
+  experiments: ExperimentType[] | ((client: SanityClient) => Promise<ExperimentType[]>);
+  apiVersion?: string;
+  experimentNameOverride?: string;
+  variantNameOverride?: string;
+  variantId?: string;
+  variantArrayName?: string;
+  experimentId?: string;
+};
+type VariantPreviewProps = Omit<PreviewProps, 'SchemaType'> & {
+  [key: string]: string;
+  value: any;
+};
+type ExperimentContextProps = Required<FieldPluginConfig> & {
+  experiments: ExperimentType[];
+};
+type ArrayInputProps = ArrayOfObjectsInputProps & {
+  variantName: string;
+  variantId: string;
+  experimentId: string;
+};
+type ObjectFieldWithPath = ObjectField & {
+  path: Path;
+};
+type VariantGeneric<T> = {
+  [key: string]: string | T | undefined;
+  _type: string;
+  value?: T;
+};
+type ExperimentGeneric<T> = {
+  _type: string;
+  default?: T;
+  experimentValue?: string;
+  [key: string]: Array<{
+    _key: string;
+  } & VariantGeneric<T>> | string | T | undefined;
+};
+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
-        }
-      },
-    ]
+    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
+      metricId: string;
       overrides: {
-        delayHours: 0
-        windowHours: 0
-        window: string
-        winRiskThreshold: 0
-        loseRiskThreshold: 0
-      }
-    }
-  }
+        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[]
+    status: string;
+    winner: string;
+    conclusions: string;
+    releasedVariationId: string;
+    excludeFromPayload: boolean;
+  };
+};
+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
+      enabled: boolean;
+      defaultValue: string;
       rules: {
-        description: string
-        condition: string
+        description: string;
+        condition: string;
         savedGroupTargeting: {
-          matchType: string
-          savedGroups: string[]
-        }[]
-        id: string
-        enabled: boolean
-        type: string
-        value: string
+          matchType: string;
+          savedGroups: string[];
+        }[];
+        id: string;
+        enabled: boolean;
+        type: string;
+        value: string;
         variations: {
-          value: string
-          variationId: string
-        }[]
-      }[]
-      definition: string
+          value: string;
+          variationId: string;
+        }[];
+      }[];
+      definition: string;
       draft: {
-        enabled: boolean
-        defaultValue: string
+        enabled: boolean;
+        defaultValue: string;
         rules: {
-          description: string
-          condition: string
+          description: string;
+          condition: string;
           savedGroupTargeting: {
-            matchType: string
-            savedGroups: string[]
-          }[]
-          id: string
-          enabled: boolean
-          type: string
-          value: string
+            matchType: string;
+            savedGroups: string[];
+          }[];
+          id: string;
+          enabled: boolean;
+          type: string;
+          value: string;
           variations: {
-            value: string
-            variationId: string
-          }[]
-        }[]
-        definition: string
-      }
-    }
-  }
+            value: string;
+            variationId: string;
+          }[];
+        }[];
+        definition: string;
+      };
+    };
+  };
   prerequisites: {
-    parentId: string
-    parentCondition: string
-  }[]
+    parentId: string;
+    parentCondition: string;
+  }[];
   revision: {
-    version: number
-    comment: string
-    date: string
-    publishedBy: string
-  }
-}
-
-export declare type ObjectFieldWithPath = ObjectField<SchemaType> & {
-  path: Path
-}
-
-export declare type VariantGeneric<T> = {
-  [key: string]: string | T | undefined
-  _type: string
-  value?: T
-}
-
-export declare type VariantPreviewProps = Omit<PreviewProps, 'SchemaType'> & {
-  [key: string]: string
-  value: any
-}
-
-export declare type VariantType = {
-  id: string
-  label: string
-}
-
-export {}
+    version: number;
+    comment: string;
+    date: string;
+    publishedBy: string;
+  };
+};
+declare const fieldLevelExperiments: import("sanity").Plugin<FieldPluginConfig>;
+/**
+ * Flattens a document's schema type into a flat array of fields and includes their path
+ */
+declare function flattenSchemaType(schemaType: SchemaType): ObjectFieldWithPath[];
+export { ArrayInputProps, ExperimentContextProps, ExperimentGeneric, ExperimentType, FieldPluginConfig, GrowthbookExperiment, GrowthbookFeature, ObjectFieldWithPath, VariantGeneric, VariantPreviewProps, VariantType, fieldLevelExperiments, flattenSchemaType };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/fieldExperiments.tsx","../src/utils/flattenSchemaType.ts"],"mappings":";KASY,WAAA;EACV,EAAA;EACA,KAAK;AAAA;AAAA,KAEK,cAAA;EACV,EAAA;EACA,KAAA;EACA,QAAA,EAAU,WAAW;AAAA;AAAA,KAGX,iBAAA;EACV,MAAA,YAAkB,eAAA;EAClB,WAAA,EAAa,cAAA,OAAqB,MAAA,EAAQ,YAAA,KAAiB,OAAA,CAAQ,cAAA;EACnE,UAAA;EACA,sBAAA;EACA,mBAAA;EACA,SAAA;EACA,gBAAA;EACA,YAAA;AAAA;AAAA,KAGU,mBAAA,GAAsB,IAAI,CAAC,YAAA;EAAA,CACpC,GAAA;EACD,KAAA;AAAA;AAAA,KAGU,sBAAA,GAAyB,QAAA,CAAS,iBAAA;EAC5C,WAAA,EAAa,cAAA;AAAA;AAAA,KAGH,eAAA,GAAkB,wBAAwB;EACpD,WAAA;EACA,SAAA;EACA,YAAA;AAAA;AAAA,KAGU,mBAAA,GAAsB,WAAA;EAAe,IAAA,EAAM,IAAI;AAAA;AAAA,KAE/C,cAAA;EAAA,CACT,GAAA,oBAAuB,CAAA;EACxB,KAAA;EACA,KAAA,GAAQ,CAAC;AAAA;AAAA,KAGC,iBAAA;EACV,KAAA;EACA,OAAA,GAAU,CAAA;EACV,eAAA;EAAA,CACC,GAAA,WACG,KAAA;IAEI,IAAA;EAAA,IACE,cAAA,CAAe,CAAA,cAGrB,CAAA;AAAA;AAAA,KAIM,oBAAA;EACV,EAAA;EACA,WAAA;EACA,WAAA;EACA,IAAA;EACA,OAAA;EACA,UAAA;EACA,WAAA;EACA,IAAA;EACA,KAAA;EACA,QAAA;EACA,MAAA;EACA,WAAA;EACA,aAAA;EACA,iBAAA;EACA,WAAA;EACA,sBAAA;EACA,aAAA;EACA,gBAAA;EACA,UAAA;IAEI,WAAA;IACA,GAAA;IACA,IAAA;IACA,WAAA;IACA,WAAA;EAAA;EAGJ,MAAA;IAEI,IAAA;IACA,WAAA;IACA,SAAA;IACA,iBAAA;IACA,IAAA;IACA,QAAA;IACA,YAAA;MAEI,WAAA;MACA,MAAA;IAAA;IAGJ,SAAA;MACE,WAAA;MACA,KAAA;IAAA;IAEF,kBAAA;IACA,mBAAA;MAEI,SAAA;MACA,WAAA;IAAA;EAAA;EAKR,QAAA;IACE,YAAA;IACA,iBAAA;IACA,YAAA;IACA,SAAA;IACA,WAAA;IACA,qBAAA;IACA,gBAAA;IACA,WAAA;IACA,2BAAA;IACA,KAAA;MAEI,QAAA;MACA,SAAA;QACE,UAAA;QACA,WAAA;QACA,MAAA;QACA,gBAAA;QACA,iBAAA;MAAA;IAAA;IAIN,gBAAA;MAEI,QAAA;MACA,SAAA;QACE,UAAA;QACA,WAAA;QACA,MAAA;QACA,gBAAA;QACA,iBAAA;MAAA;IAAA;IAIN,UAAA;MAEI,QAAA;MACA,SAAA;QACE,UAAA;QACA,WAAA;QACA,MAAA;QACA,gBAAA;QACA,iBAAA;MAAA;IAAA;IAIN,gBAAA;MACE,QAAA;MACA,SAAA;QACE,UAAA;QACA,WAAA;QACA,MAAA;QACA,gBAAA;QACA,iBAAA;MAAA;IAAA;EAAA;EAIN,aAAA;IACE,MAAA;IACA,MAAA;IACA,WAAA;IACA,mBAAA;IACA,kBAAA;EAAA;AAAA;AAAA,KAIQ,iBAAA;EACV,EAAA;EACA,WAAA;EACA,WAAA;EACA,QAAA;EACA,WAAA;EACA,KAAA;EACA,OAAA;EACA,SAAA;EACA,YAAA;EACA,IAAA;EACA,YAAA;IAAA,CACG,GAAA;MACC,OAAA;MACA,YAAA;MACA,KAAA;QACE,WAAA;QACA,SAAA;QACA,mBAAA;UAAsB,SAAA;UAAmB,WAAA;QAAA;QACzC,EAAA;QACA,OAAA;QACA,IAAA;QACA,KAAA;QACA,UAAA;UAAa,KAAA;UAAe,WAAA;QAAA;MAAA;MAE9B,UAAA;MACA,KAAA;QACE,OAAA;QACA,YAAA;QACA,KAAA;UACE,WAAA;UACA,SAAA;UACA,mBAAA;YAAsB,SAAA;YAAmB,WAAA;UAAA;UACzC,EAAA;UACA,OAAA;UACA,IAAA;UACA,KAAA;UACA,UAAA;YAAa,KAAA;YAAe,WAAA;UAAA;QAAA;QAE9B,UAAA;MAAA;IAAA;EAAA;EAIN,aAAA;IACE,QAAA;IACA,eAAA;EAAA;EAEF,QAAA;IACE,OAAA;IACA,OAAA;IACA,IAAA;IACA,WAAA;EAAA;AAAA;AAAA,cC9BS,qBAAA,mBAAqB,MAAA,CAAA,iBAAA;ADzMlC;;;AAAA,iBEFgB,iBAAA,CAAkB,UAAA,EAAY,UAAA,GAAa,mBAAmB"}