@contractspec/lib.feature-flags 1.44.0

package/dist/contracts/index.d.ts

@@ -0,0 +1,1010 @@
+import { FieldType } from "../schema/src/FieldType.js";
+import { SchemaModel } from "../schema/src/SchemaModel.js";
+import "../schema/src/index.js";
+import { OperationSpec } from "./src/operations/operation.js";
+import "./src/index.js";
+
+//#region src/contracts/index.d.ts
+declare const FeatureFlagModel: SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  defaultValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>;
+declare const TargetingRuleModel: SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  priority: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  enabled: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  attribute: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  operator: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  value: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  rolloutPercentage: {
+    type: FieldType<number, number>;
+    isOptional: true;
+  };
+  serveValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  serveVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>;
+declare const ExperimentModel: SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  hypothesis: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  metrics: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  audiencePercentage: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  startedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  endedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  winningVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  results: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>;
+declare const EvaluationResultModel: SchemaModel<{
+  enabled: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  reason: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  ruleId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>;
+/**
+ * Create a feature flag.
+ */
+declare const CreateFlagContract: OperationSpec<SchemaModel<{
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  defaultValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  defaultValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Update a feature flag.
+ */
+declare const UpdateFlagContract: OperationSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  defaultValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  defaultValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Delete a feature flag.
+ */
+declare const DeleteFlagContract: OperationSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  success: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Toggle a feature flag status.
+ */
+declare const ToggleFlagContract: OperationSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  defaultValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Get a feature flag by key.
+ */
+declare const GetFlagContract: OperationSpec<SchemaModel<{
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  defaultValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+  updatedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * List feature flags.
+ */
+declare const ListFlagsContract: OperationSpec<SchemaModel<{
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  tags: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  limit: {
+    type: FieldType<number, number>;
+    isOptional: true;
+  };
+  offset: {
+    type: FieldType<number, number>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  flags: {
+    type: SchemaModel<{
+      id: {
+        type: FieldType<string, string>;
+        isOptional: false;
+      };
+      key: {
+        type: FieldType<string, string>;
+        isOptional: false;
+      };
+      name: {
+        type: FieldType<string, string>;
+        isOptional: false;
+      };
+      description: {
+        type: FieldType<string, string>;
+        isOptional: true;
+      };
+      status: {
+        type: FieldType<string, string>;
+        isOptional: false;
+      };
+      defaultValue: {
+        type: FieldType<boolean, boolean>;
+        isOptional: false;
+      };
+      variants: {
+        type: FieldType<unknown, unknown>;
+        isOptional: true;
+      };
+      orgId: {
+        type: FieldType<string, string>;
+        isOptional: true;
+      };
+      tags: {
+        type: FieldType<unknown, unknown>;
+        isOptional: true;
+      };
+      createdAt: {
+        type: FieldType<Date, string>;
+        isOptional: false;
+      };
+      updatedAt: {
+        type: FieldType<Date, string>;
+        isOptional: false;
+      };
+    }>;
+    isArray: true;
+    isOptional: false;
+  };
+  total: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Evaluate a feature flag.
+ */
+declare const EvaluateFlagContract: OperationSpec<SchemaModel<{
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  context: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  enabled: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  reason: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  ruleId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>, undefined>;
+/**
+ * Create a targeting rule.
+ */
+declare const CreateRuleContract: OperationSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  priority: {
+    type: FieldType<number, number>;
+    isOptional: true;
+  };
+  attribute: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  operator: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  value: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  rolloutPercentage: {
+    type: FieldType<number, number>;
+    isOptional: true;
+  };
+  serveValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  serveVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  priority: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  enabled: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  attribute: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  operator: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  value: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  rolloutPercentage: {
+    type: FieldType<number, number>;
+    isOptional: true;
+  };
+  serveValue: {
+    type: FieldType<boolean, boolean>;
+    isOptional: true;
+  };
+  serveVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>, undefined>;
+/**
+ * Delete a targeting rule.
+ */
+declare const DeleteRuleContract: OperationSpec<SchemaModel<{
+  ruleId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  success: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Create an experiment.
+ */
+declare const CreateExperimentContract: OperationSpec<SchemaModel<{
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  hypothesis: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  metrics: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  audiencePercentage: {
+    type: FieldType<number, number>;
+    isOptional: true;
+  };
+  scheduledStartAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  scheduledEndAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  hypothesis: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  metrics: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  audiencePercentage: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  startedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  endedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  winningVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  results: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Start an experiment.
+ */
+declare const StartExperimentContract: OperationSpec<SchemaModel<{
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  hypothesis: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  metrics: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  audiencePercentage: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  startedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  endedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  winningVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  results: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Stop an experiment.
+ */
+declare const StopExperimentContract: OperationSpec<SchemaModel<{
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  reason: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  winningVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  hypothesis: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  metrics: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  audiencePercentage: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  startedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  endedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  winningVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  results: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Get an experiment.
+ */
+declare const GetExperimentContract: OperationSpec<SchemaModel<{
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  id: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  hypothesis: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  metrics: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  audiencePercentage: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  startedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  endedAt: {
+    type: FieldType<Date, string>;
+    isOptional: true;
+  };
+  winningVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  results: {
+    type: FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+//#endregion
+export { CreateExperimentContract, CreateFlagContract, CreateRuleContract, DeleteFlagContract, DeleteRuleContract, EvaluateFlagContract, EvaluationResultModel, ExperimentModel, FeatureFlagModel, GetExperimentContract, GetFlagContract, ListFlagsContract, StartExperimentContract, StopExperimentContract, TargetingRuleModel, ToggleFlagContract, UpdateFlagContract };
+//# sourceMappingURL=index.d.ts.map