@tinkerlandai/indiana-sdk 0.1.0 → 0.3.0

package/dist/growth-rules-D64pEvg9.d.ts

@@ -0,0 +1,166 @@
+/** A condition object: operator keys ($and, $or, …) or attribute paths. */
+type ConditionInterface = {
+    [key: string]: unknown;
+};
+type ParentConditionInterface = {
+    id: string;
+    condition: ConditionInterface;
+    gate?: boolean;
+};
+/** Current saved group representation. Lists always use their declared attribute. */
+type SavedGroupPayloadEntry = {
+    type: "list";
+    attributeKey: string;
+    values: (string | number)[];
+} | {
+    type: "hashed";
+    attributeKey: string;
+    values: string[];
+} | {
+    type: "condition";
+    condition: ConditionInterface;
+};
+type SavedGroupsPayload = Record<string, SavedGroupPayloadEntry>;
+type VariationRange = [number, number];
+type VariationMeta = {
+    passthrough?: boolean;
+    key?: string;
+    name?: string;
+};
+interface Filter {
+    attribute?: string;
+    seed: string;
+    hashVersion: number;
+    ranges: VariationRange[];
+}
+type UrlTargetType = "regex" | "simple";
+type UrlTarget = {
+    include: boolean;
+    type: UrlTargetType;
+    pattern: string;
+};
+type Experiment<T> = {
+    key: string;
+    variations: [T, T, ...T[]];
+    ranges?: VariationRange[];
+    meta?: VariationMeta[];
+    filters?: Filter[];
+    seed?: string;
+    name?: string;
+    phase?: string;
+    urlPatterns?: UrlTarget[];
+    weights?: number[];
+    condition?: ConditionInterface;
+    parentConditions?: ParentConditionInterface[];
+    coverage?: number;
+    include?: () => boolean;
+    force?: number;
+    hashAttribute?: string;
+    fallbackAttribute?: string;
+    hashVersion?: number;
+    disableStickyBucketing?: boolean;
+    bucketVersion?: number;
+    minBucketVersion?: number;
+    active?: boolean;
+    persistQueryString?: boolean;
+};
+interface Result<T> {
+    value: T;
+    variationId: number;
+    key: string;
+    name?: string;
+    bucket?: number;
+    passthrough?: boolean;
+    inExperiment: boolean;
+    hashUsed?: boolean;
+    hashAttribute: string;
+    hashValue: string;
+    featureId: string | null;
+    stickyBucketUsed?: boolean;
+}
+type FeatureRule<T = unknown> = {
+    id?: string;
+    condition?: ConditionInterface;
+    parentConditions?: ParentConditionInterface[];
+    force?: T;
+    variations?: T[];
+    weights?: number[];
+    key?: string;
+    hashAttribute?: string;
+    fallbackAttribute?: string;
+    hashVersion?: number;
+    disableStickyBucketing?: boolean;
+    bucketVersion?: number;
+    minBucketVersion?: number;
+    range?: VariationRange;
+    coverage?: number;
+    ranges?: VariationRange[];
+    meta?: VariationMeta[];
+    filters?: Filter[];
+    seed?: string;
+    name?: string;
+    phase?: string;
+    tracks?: Array<{
+        experiment: Experiment<T>;
+        result: Result<T>;
+    }>;
+};
+interface FeatureDefinition<T = unknown> {
+    defaultValue?: T;
+    rules?: FeatureRule<T>[];
+}
+type FeatureResultSource = "unknownFeature" | "defaultValue" | "force" | "override" | "experiment" | "prerequisite" | "cyclicPrerequisite";
+interface FeatureResult<T = unknown> {
+    value: T | null;
+    source: FeatureResultSource;
+    on: boolean;
+    off: boolean;
+    ruleId: string;
+    experiment?: Experiment<T>;
+    experimentResult?: Result<T>;
+}
+/** `${attributeName}||${attributeValue}` */
+type StickyAttributeKey = string;
+/** `${experimentKey}__${bucketVersion}` */
+type StickyExperimentKey = string;
+type StickyAssignments = Record<StickyExperimentKey, string>;
+interface StickyAssignmentsDocument {
+    attributeName: string;
+    attributeValue: string;
+    assignments: StickyAssignments;
+}
+type Attributes = Record<string, unknown>;
+/**
+ * Everything one evaluation needs. Replaces the GrowthBook class plus its
+ * global/user context split; fields keep the upstream names and meaning.
+ */
+type EvaluationContext = {
+    attributes?: Attributes;
+    attributeOverrides?: Attributes;
+    url?: string;
+    enabled?: boolean;
+    qaMode?: boolean;
+    features?: Record<string, FeatureDefinition>;
+    savedGroups?: SavedGroupsPayload;
+    forcedVariations?: Record<string, number>;
+    forcedFeatureValues?: Map<string, unknown>;
+    /** Sticky docs already loaded for this user; updated in place on assignment. */
+    stickyBucketAssignmentDocs?: Record<StickyAttributeKey, StickyAssignmentsDocument>;
+    /** Enables sticky bucketing; receives each changed document. */
+    saveStickyBucketAssignmentDoc?: (doc: StickyAssignmentsDocument) => unknown;
+    /** Dedupes onExperimentViewed per hash value, experiment and variation. */
+    trackedExperiments?: Set<string>;
+    /** Dedupes onFeatureUsage per feature value. */
+    trackedFeatureUsage?: Record<string, string>;
+    onExperimentViewed?: (experiment: Experiment<unknown>, result: Result<unknown>) => unknown;
+    onFeatureUsage?: (key: string, result: FeatureResult<unknown>) => unknown;
+    onExperimentEval?: (experiment: Experiment<unknown>, result: Result<unknown>) => void;
+    /** Receives the same diagnostic messages the upstream SDK logs. */
+    log?: (message: string, details: Record<string, unknown>) => void;
+};
+
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+
+export type { EvaluationContext as E, FeatureResult as F, JsonValue as J, Result as R };